1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
# Copyright 2016-2023 The Khronos Group Inc.
#
# SPDX-License-Identifier: Apache-2.0
require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
include ::Asciidoctor
# This is the generated map of API interfaces in this spec build
require 'apimap.rb'
$apiNames = APInames.new
class SpecInlineMacroBase < Extensions::InlineMacroProcessor
use_dsl
using_format :short
end
class NormativeInlineMacroBase < SpecInlineMacroBase
def text
'normative'
end
def process parent, target, attributes
create_inline parent, :quoted, '<strong class="purple">' + text + '</strong>'
end
end
class LinkInlineMacroBase < SpecInlineMacroBase
# Check if a link macro target exists - overridden by specific macros
# Default assumption is that it does exist
def exists? target
return true
end
def process parent, target, attributes
if not exists? target
# If the macro target is not in this build, but has an alias,
# substitute that alias as the argument.
# Otherwise, turn the (attempted) link into text, and complain.
if $apiNames.nonexistent.has_key? target
oldtarget = target
target = $apiNames.nonexistent[oldtarget]
msg = 'Rewriting nonexistent link macro target: ' + @name.to_s + ':' + oldtarget + ' to ' + target
Asciidoctor::LoggerManager.logger.info msg
# Fall through
else
# Suppress warnings for apiext: macros as this is such a common case
if @name.to_s != 'apiext'
msg = 'Textifying unknown link macro target: ' + @name.to_s + ':' + target
Asciidoctor::LoggerManager.logger.warn msg
end
return create_inline parent, :quoted, '<code>' + target + '</code>'
end
end
if parent.document.attributes['cross-file-links']
return Inline.new(parent, :anchor, target, :type => :link, :target => (target + '.html'))
else
return Inline.new(parent, :anchor, target, :type => :xref, :target => ('#' + target), :attributes => {'fragment' => target, 'refid' => target})
end
end
end
class CodeInlineMacroBase < SpecInlineMacroBase
def process parent, target, attributes
if $apiNames.nonexistent.has_key? target
oldtarget = target
target = $apiNames.nonexistent[oldtarget]
msg = 'Rewriting nonexistent name macro target: ' + @name.to_s + ':' + oldtarget + ' to ' + target
Asciidoctor::LoggerManager.logger.info msg
end
create_inline parent, :quoted, '<code>' + target.gsub('→', '->') + '</code>'
end
end
class StrongInlineMacroBase < SpecInlineMacroBase
def process parent, target, attributes
create_inline parent, :quoted, '<code>' + target.gsub('→', '->') + '</code>'
end
end
class ParamInlineMacroBase < SpecInlineMacroBase
def process parent, target, attributes
create_inline parent, :quoted, '<code>' + target.gsub('→', '->') + '</code>'
end
end
class CanInlineMacro < NormativeInlineMacroBase
named :can
match /can:(\w*)/
def text
'can'
end
end
class CannotInlineMacro < NormativeInlineMacroBase
named :cannot
match /cannot:(\w*)/
def text
'cannot'
end
end
class MayInlineMacro < NormativeInlineMacroBase
named :may
match /may:(\w*)/
def text
'may'
end
end
class MustInlineMacro < NormativeInlineMacroBase
named :must
match /must:(\w*)/
def text
'must'
end
end
class OptionalInlineMacro < NormativeInlineMacroBase
named :optional
match /optional:(\w*)/
def text
'optional'
end
end
class OptionallyInlineMacro < NormativeInlineMacroBase
named :optionally
match /optionally:(\w*)/
def text
'optionally'
end
end
class RequiredInlineMacro < NormativeInlineMacroBase
named :required
match /required:(\w*)/
def text
'required'
end
end
class ShouldInlineMacro < NormativeInlineMacroBase
named :should
match /should:(\w*)/
def text
'should'
end
end
# Generic reference page link to any entity with an anchor/refpage
class ReflinkInlineMacro < LinkInlineMacroBase
named :reflink
match /reflink:([-\w]+)/
end
# Link to an extension appendix/refpage
class ApiextInlineMacro < LinkInlineMacroBase
named :apiext
match /apiext:(\w+)/
def exists? target
$apiNames.features.has_key? target
end
end
class FlinkInlineMacro < LinkInlineMacroBase
named :flink
match /flink:(\w+)/
def exists? target
$apiNames.protos.has_key? target
end
end
class FnameInlineMacro < CodeInlineMacroBase
named :fname
match /fname:(\w+)/
end
class FtextInlineMacro < CodeInlineMacroBase
named :ftext
match /ftext:([\w\*]+)/
end
class SnameInlineMacro < CodeInlineMacroBase
named :sname
match /sname:(\w+)/
end
class SlinkInlineMacro < LinkInlineMacroBase
named :slink
match /slink:(\w+)/
def exists? target
$apiNames.structs.has_key? target or $apiNames.handles.has_key? target
end
end
class StextInlineMacro < CodeInlineMacroBase
named :stext
match /stext:([\w\*]+)/
end
class EnameInlineMacro < CodeInlineMacroBase
named :ename
match /ename:(\w+)/
def exists? target
$apiNames.consts.has_key? target
end
end
class ElinkInlineMacro < LinkInlineMacroBase
named :elink
match /elink:(\w+)/
def exists? target
$apiNames.enums.has_key? target
end
end
class EtextInlineMacro < CodeInlineMacroBase
named :etext
match /etext:([\w\*]+)/
end
# this does not handle any [] at the moment
class PnameInlineMacro < ParamInlineMacroBase
named :pname
match /pname:(\w+((\.|→)\w+)*)/
end
class PtextInlineMacro < ParamInlineMacroBase
named :ptext
match /ptext:([\w\*]+((\.|→)[\w\*]+)*)/
end
class DnameInlineMacro < CodeInlineMacroBase
named :dname
match /dname:(\w+)/
end
class DlinkInlineMacro < LinkInlineMacroBase
named :dlink
match /dlink:(\w+)/
def exists? target
$apiNames.defines.has_key? target
end
end
class TnameInlineMacro < CodeInlineMacroBase
named :tname
match /tname:(\w+)/
end
class TlinkInlineMacro < LinkInlineMacroBase
named :tlink
match /tlink:(\w+)/
def exists? target
$apiNames.flags.has_key? target or
$apiNames.funcpointers.has_key? target or
$apiNames.defines.has_key? target
end
end
class BasetypeInlineMacro < LinkInlineMacroBase
named :basetype
match /basetype:(\w+)/
def exists? target
$apiNames.basetypes.has_key? target
end
end
# This does not include the full range of code: use
# It allows imbedded periods (field separators) and wildcards if followed by
# another word, and an ending wildcard.
class CodeInlineMacro < CodeInlineMacroBase
named :code
match /code:(\w+([.*]\w+)*\**)/
end
# The tag: and attr: macros are only used in registry.adoc
class TagInlineMacro < StrongInlineMacroBase
named :tag
match /tag:(\w+)/
end
class AttrInlineMacro < StrongInlineMacroBase
named :attr
match /attr:(\w+)/
end
# Does nothing - just markup that we have considered the use case
class UndefinedInlineMacro < SpecInlineMacroBase
named :undefined
match /undefined:/
def process parent, target, attributes
create_inline parent, :quoted, 'undefined'
end
end
|