Module: UdbGen::TemplateHelpers
Constant Summary
collapse
- LinkableObj =
T.type_alias { T.any(Udb::Instruction, Udb::Csr, Udb::CsrField, Udb::Extension, Udb::Parameter, Idl::FunctionDefAst) }
Instance Method Summary
collapse
#state_preamble_adoc, #state_revmark
Instance Method Details
#anchor_for(obj) ⇒ Object
41
42
43
|
# File 'lib/udb-gen/template_helpers.rb', line 41
def anchor_for(obj)
"[##{link_name(obj)}]"
end
|
#convert_monospace_to_links(cfg_arch, adoc) ⇒ Object
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
# File 'lib/udb-gen/template_helpers.rb', line 67
def convert_monospace_to_links(cfg_arch, adoc)
adoc.gsub(/`([\w.]+)`/) do |match|
name = T.must(Regexp.last_match(1))
csr_name, field_name = name.split(".")
csr = cfg_arch.not_prohibited_csrs.find { |c| c.name == csr_name }
if !field_name.nil? && !csr.nil? && csr.field?(field_name)
link_to(csr.field(field_name), match)
elsif !csr.nil?
link_to(csr, match)
elsif cfg_arch.not_prohibited_instructions.any? { |inst| inst.name == name }
link_to(T.must(cfg_arch.instruction(name)), match)
elsif cfg_arch.not_prohibited_extensions.any? { |ext| ext.name == name }
link_to(T.must(cfg_arch.extension(name)), match)
else
match
end
end
end
|
#link_name(obj) ⇒ Object
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
# File 'lib/udb-gen/template_helpers.rb', line 47
def link_name(obj)
case obj
when Idl::FunctionDefAst
"udb-function-#{obj.name.gsub(".", "_")}"
when Udb::Csr
"udb-csr-#{obj.name.gsub(".", "_")}"
when Udb::CsrField
"udb-csrfield-#{obj.parent.name.gsub(".", "_")}-#{obj.name.gsub(".", "_")}"
when Udb::Extension
"udb-extension-#{obj.name.gsub(".", "_")}"
when Udb::Instruction
"udb-insn-#{obj.name.gsub(".", "_")}"
when Udb::Parameter
"udb-param-#{obj.name.gsub(".", "_")}"
else
T.absurd(obj)
end
end
|
#link_to(obj, text = obj.name) ⇒ Object
34
35
36
37
|
# File 'lib/udb-gen/template_helpers.rb', line 34
def link_to(obj, text = obj.name)
"xref:##{link_name(obj)}[#{text}]"
end
|
#partial(template_pname, inputs = {}) ⇒ Object
18
19
20
21
22
23
24
25
26
27
28
|
# File 'lib/udb-gen/template_helpers.rb', line 18
def partial(template_pname, inputs = {})
template_path = Pathname.new(__dir__) / ".." / ".." / "templates" / template_pname
raise ArgumentError, "Template '#{template_path} not found" unless template_path.exist?
erb = ERB.new(template_path.read, trim_mode: "-")
erb.filename = template_path.realpath.to_s
context = OpenStruct.new(inputs)
context.singleton_class.include(TemplateHelpers)
erb.result(context.instance_eval { binding })
end
|
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
# File 'lib/udb-gen/template_helpers.rb', line 87
def resolve_intermediate_links(cfg_arch, adoc)
adoc.gsub(/%%UDB_DOC_LINK%([^;%]+)\s*;\s*([^;%]+)\s*;\s*([^%]+)%%/) do |match|
type = T.must(Regexp.last_match(1))
name = T.must(Regexp.last_match(2))
link_text = T.must(Regexp.last_match(3))
case type
when "ext"
ext = cfg_arch.extension(name)
if ext
link_to(ext, link_text)
else
Udb.logger.warn "Attempted link to undefined extension: #{name}"
match
end
when "ext_param"
param = cfg_arch.param(name)
if param
link_to(param, link_text)
else
Udb.logger.warn "Attempted link to undefined parameter: #{name}"
match
end
when "inst"
inst = cfg_arch.instruction(name)
if inst
link_to(inst, link_text)
else
Udb.logger.warn "Attempted link to undefined instruction: #{name}"
match
end
when "csr"
csr = cfg_arch.csr(name)
if csr
link_to(csr, link_text)
else
Udb.logger.warn "Attempted link to undefined CSR: #{name}"
match
end
when "csr_field"
csr_name, field_name = name.split("*")
csr = cfg_arch.csr(T.must(csr_name))
if csr
csr_field = csr.field(field_name)
if csr_field
link_to(csr_field, link_text)
else
Udb.logger.warn "Attempted link to undefined CSR field: #{name}"
match
end
else
Udb.logger.warn "Attempted link to undefined CSR: #{csr_name}"
match
end
when "func"
func = cfg_arch.function(name)
if func
link_to(func, link_text)
else
Udb.logger.warn "Attempted link to undefined function: #{name}"
match
end
else
raise "Unhandled link type of '#{type}' for '#{name}' with link_text '#{link_text}'"
end
end
end
|