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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
|
local m = require 'lpeglabel'
local re = require 'parser.relabel'
local TokenTypes, TokenStarts, TokenFinishs, TokenContents
local Ci, Offset, pushError
local parseType
local Parser = re.compile([[
Main <- (Token / Sp)*
Sp <- %s+
X16 <- [a-fA-F0-9]
Word <- [a-zA-Z0-9_]
Token <- Name / String / Symbol
Name <- ({} {[a-zA-Z_] [a-zA-Z0-9_.]*} {})
-> Name
String <- ({} StringDef {})
-> String
StringDef <- '"'
{~(Esc / !'"' .)*~} -> 1
('"'?)
/ "'"
{~(Esc / !"'" .)*~} -> 1
("'"?)
/ ('[' {:eq: '='* :} '['
{(!StringClose .)*} -> 1
(StringClose?))
StringClose <- ']' =eq ']'
Esc <- '\' -> ''
EChar
EChar <- 'a' -> ea
/ 'b' -> eb
/ 'f' -> ef
/ 'n' -> en
/ 'r' -> er
/ 't' -> et
/ 'v' -> ev
/ '\'
/ '"'
/ "'"
/ %nl
/ ('z' (%nl / %s)*) -> ''
/ ('x' {X16 X16}) -> Char16
/ ([0-9] [0-9]? [0-9]?) -> Char10
/ ('u{' {Word*} '}') -> CharUtf8
Symbol <- ({} {
':'
/ '|'
/ ','
/ '[]'
/ '<'
/ '>'
/ '('
/ ')'
} {})
-> Symbol
]], {
s = m.S' \t',
ea = '\a',
eb = '\b',
ef = '\f',
en = '\n',
er = '\r',
et = '\t',
ev = '\v',
Char10 = function (char)
char = tonumber(char)
if not char or char < 0 or char > 255 then
return ''
end
return string.char(char)
end,
Char16 = function (char)
return string.char(tonumber(char, 16))
end,
CharUtf8 = function (char)
if #char == 0 then
return ''
end
local v = tonumber(char, 16)
if not v then
return ''
end
if v >= 0 and v <= 0x10FFFF then
return utf8.char(v)
end
return ''
end,
Name = function (start, content, finish)
Ci = Ci + 1
TokenTypes[Ci] = 'name'
TokenStarts[Ci] = start
TokenFinishs[Ci] = finish - 1
TokenContents[Ci] = content
end,
String = function (start, content, finish)
Ci = Ci + 1
TokenTypes[Ci] = 'string'
TokenStarts[Ci] = start
TokenFinishs[Ci] = finish - 1
TokenContents[Ci] = content
end,
Symbol = function (start, content, finish)
Ci = Ci + 1
TokenTypes[Ci] = 'symbol'
TokenStarts[Ci] = start
TokenFinishs[Ci] = finish - 1
TokenContents[Ci] = content
end,
})
local function parseTokens(text)
Ci = 0
TokenTypes = {}
TokenStarts = {}
TokenFinishs = {}
TokenContents = {}
Parser:match(text)
Ci = 0
end
local function peekToken()
return TokenTypes[Ci+1], TokenContents[Ci+1]
end
local function nextToken()
Ci = Ci + 1
if not TokenTypes[Ci] then
Ci = Ci - 1
return nil
end
return TokenTypes[Ci], TokenContents[Ci]
end
local function checkToken(tp, content, offset)
offset = offset or 0
return TokenTypes[Ci + offset] == tp
and TokenContents[Ci + offset] == content
end
local function getStart()
return TokenStarts[Ci] + Offset
end
local function getFinish()
return TokenFinishs[Ci] + Offset
end
local function try(callback)
local savePoint = Ci
-- rollback
local suc = callback()
if not suc then
Ci = savePoint
end
return suc
end
local function parseName(tp, parent)
local nameTp, nameText = peekToken()
if nameTp ~= 'name' then
return nil
end
nextToken()
local class = {
type = tp,
start = getStart(),
finish = getFinish(),
parent = parent,
[1] = nameText,
}
return class
end
local function parseClass(parent)
local result = {
type = 'doc.class',
parent = parent,
}
result.class = parseName('doc.class.name', result)
if not result.class then
pushError {
type = 'LUADOC_MISS_CLASS_NAME',
start = getFinish(),
finish = getFinish(),
}
return nil
end
result.start = getStart()
result.finish = getFinish()
if not peekToken() then
return result
end
nextToken()
if not checkToken('symbol', ':') then
pushError {
type = 'LUADOC_MISS_EXTENSION_SYMBOL',
start = getFinish(),
finish = getFinish(),
}
return result
end
result.extends = parseName('doc.extends.name', result)
if not result.extends then
pushError {
type = 'LUADOC_MISS_EXTENDS_NAME',
start = getFinish(),
finish = getFinish(),
}
return result
end
result.finish = getFinish()
return result
end
local function nextSymbolOrError(symbol)
if checkToken('symbol', symbol, 1) then
nextToken()
return true
end
pushError {
type = 'LUADOC_MISS_SYMBOL',
start = getFinish(),
finish = getFinish(),
info = {
symbol = symbol,
}
}
return false
end
local function parseTypeUnitTable()
if not checkToken('symbol', '<', 1) then
return nil
end
local typeUnit = {
type = 'doc.type.table',
start = getStart(),
}
if not nextSymbolOrError('<') then
return nil
end
local key = parseType(typeUnit)
if not key or not nextSymbolOrError(',') then
return nil
end
local value = parseType(typeUnit)
if not value then
return nil
end
nextSymbolOrError('>')
typeUnit.key = key
typeUnit.value = value
typeUnit.finish = getFinish()
return typeUnit
end
local function parseTypeUnitFunction()
local typeUnit = {
type = 'doc.type.function',
start = getStart(),
args = {},
returns = {},
}
if not nextSymbolOrError('(') then
return nil
end
while true do
if checkToken('symbol', ')', 1) then
nextToken()
break
end
local arg = {
type = 'doc.type.arg',
parent = typeUnit,
}
arg.name = parseName('doc.type.name', arg)
if not arg.name then
pushError {
type = 'LUADOC_MISS_ARG_NAME',
start = getFinish(),
finish = getFinish(),
}
break
end
if not arg.start then
arg.start = arg.name.start
end
arg.finish = getFinish()
if not nextSymbolOrError(':') then
break
end
arg.extends = parseType(arg)
if not arg.extends then
break
end
arg.finish = getFinish()
typeUnit.args[#typeUnit.args+1] = arg
if checkToken('symbol', ',', 1) then
nextToken()
else
nextSymbolOrError(')')
break
end
end
if checkToken('symbol', ':', 1) then
nextToken()
while true do
local rtn = parseType(arg)
if not rtn then
break
end
typeUnit.returns[#typeUnit.returns+1] = rtn
if checkToken('symbol', ',', 1) then
nextToken()
else
break
end
end
end
typeUnit.finish = getFinish()
return typeUnit
end
local function parseTypeUnit(parent, content)
local typeUnit
if content == 'table' then
typeUnit = parseTypeUnitTable()
elseif content == 'fun' then
typeUnit = parseTypeUnitFunction()
end
if not typeUnit then
typeUnit = {
type = 'doc.type.name',
start = getStart(),
finish = getFinish(),
[1] = content,
}
end
if not typeUnit then
return nil
end
typeUnit.parent = parent
if checkToken('symbol', '[]', 1) then
nextToken()
typeUnit.array = true
typeUnit.finish = getFinish()
end
return typeUnit
end
function parseType(parent)
if not peekToken() then
pushError {
type = 'LUADOC_MISS_TYPE_NAME',
start = getFinish(),
finish = getFinish(),
}
return nil
end
local result = {
type = 'doc.type',
parent = parent,
types = {},
enums = {},
}
while true do
local tp, content = peekToken()
if not tp then
break
end
if tp == 'name' then
nextToken()
local typeUnit = parseTypeUnit(result, content)
if not typeUnit then
break
end
result.types[#result.types+1] = typeUnit
if not result.start then
result.start = typeUnit.start
end
elseif tp == 'string' then
nextToken()
local typeEnum = {
type = 'doc.type.enum',
start = getStart(),
finish = getFinish(),
parent = result,
[1] = content,
}
result.enums[#result.enums+1] = typeEnum
if not result.start then
result.start = typeEnum.start
end
end
if not checkToken('symbol', '|', 1) then
break
end
nextToken()
end
result.finish = getFinish()
if #result.types == 0 and #result.enums == 0 then
return nil
end
return result
end
local function parseAlias()
local result = {
type = 'doc.alias',
}
result.alias = parseName('doc.alias.name', result)
if not result.alias then
pushError {
type = 'LUADOC_MISS_ALIAS_NAME',
start = getFinish(),
finish = getFinish(),
}
return nil
end
result.start = getStart()
result.extends = parseType(result)
if not result.extends then
pushError {
type = 'LUADOC_MISS_ALIAS_EXTENDS',
start = getFinish(),
finish = getFinish(),
}
return nil
end
result.finish = getFinish()
return result
end
local function parseParam()
local result = {
type = 'doc.param',
}
result.param = parseName('doc.param.name', result)
if not result.param then
pushError {
type = 'LUADOC_MISS_PARAM_NAME',
start = getFinish(),
finish = getFinish(),
}
return nil
end
result.start = getStart()
result.extends = parseType(result)
if not result.extends then
pushError {
type = 'LUADOC_MISS_PARAM_EXTENDS',
start = getFinish(),
finish = getFinish(),
}
return nil
end
result.finish = getFinish()
return result
end
local function parseReturn()
local result = {
type = 'doc.return',
returns = {},
}
while true do
local docType = parseType(result)
if not docType then
break
end
if not result.start then
result.start = docType.start
end
result.returns[#result.returns+1] = docType
if not checkToken('symbol', ',', 1) then
break
end
nextToken()
end
if #result.returns == 0 then
return nil
end
result.finish = getFinish()
return result
end
local function parseField()
local result = {
type = 'doc.field',
}
try(function ()
local tp, value = nextToken()
if tp == 'name' then
if value == 'public'
or value == 'protected'
or value == 'private' then
result.visible = value
result.start = getStart()
return true
end
end
return false
end)
result.field = parseName('doc.field.name', result)
if not result.field then
pushError {
type = 'LUADOC_MISS_FIELD_NAME',
start = getFinish(),
finish = getFinish(),
}
return nil
end
if not result.start then
result.start = result.field.start
end
result.extends = parseType(result)
if not result.extends then
pushError {
type = 'LUADOC_MISS_FIELD_EXTENDS',
start = getFinish(),
finish = getFinish(),
}
return nil
end
result.finish = getFinish()
return result
end
local function parseGeneric()
local result = {
type = 'doc.generic',
generics = {},
}
while true do
local object = {
type = 'doc.generic.object',
parent = result,
}
object.generic = parseName('doc.generic.name', object)
if not object.generic then
pushError {
type = 'LUADOC_MISS_GENERIC_NAME',
start = getFinish(),
finish = getFinish(),
}
return nil
end
object.start = object.generic.start
if not result.start then
result.start = object.start
end
if checkToken('symbol', ':', 1) then
nextToken()
object.extends = parseName('doc.extends.name', object)
if not object.extends then
pushError {
type = 'LUADOC_MISS_EXTENDS_NAME',
start = getFinish(),
finish = getFinish(),
}
return nil
end
end
object.finish = getFinish()
result.generics[#result.generics+1] = object
if not checkToken('symbol', ',', 1) then
break
end
nextToken()
end
result.finish = getFinish()
return result
end
local function parseVararg()
local result = {
type = 'doc.vararg',
}
result.vararg = parseType(result)
if not result.vararg then
pushError {
type = 'LUADOC_MISS_VARARG_TYPE',
start = getFinish(),
finish = getFinish(),
}
return
end
result.start = result.vararg.start
result.finish = result.vararg.finish
return result
end
local function parseOverload()
local tp, name = peekToken()
if tp ~= 'name' or name ~= 'fun' then
pushError {
type = 'LUADOC_MISS_FUN_AFTER_OVERLOAD',
start = getFinish(),
finish = getFinish(),
}
return nil
end
nextToken()
local result = {
type = 'doc.overload',
}
result.overload = parseTypeUnitFunction()
if not result.overload then
return nil
end
result.overload.parent = result
result.start = result.overload.start
result.finish = result.overload.finish
return result
end
local function convertTokens()
local tp, text = nextToken()
if not tp then
return
end
if tp ~= 'name' then
pushError {
type = 'LUADOC_MISS_CATE_NAME',
start = getStart(),
finish = getFinish(),
}
return nil
end
if text == 'class' then
return parseClass()
elseif text == 'type' then
return parseType()
elseif text == 'alias' then
return parseAlias()
elseif text == 'param' then
return parseParam()
elseif text == 'return' then
return parseReturn()
elseif text == 'field' then
return parseField()
elseif text == 'generic' then
return parseGeneric()
elseif text == 'vararg' then
return parseVararg()
elseif text == 'overload' then
return parseOverload()
end
end
local function buildLuaDoc(comment)
Offset = comment.start + 1
local text = comment.text
if text:sub(1, 2) ~= '-@' then
return
end
local finishPos = text:find('@', 3)
local doc, lastComment
if finishPos then
doc = text:sub(3, finishPos - 1)
lastComment = text:sub(finishPos)
else
doc = text:sub(3)
end
parseTokens(doc)
local result = convertTokens()
if result then
result.comment = lastComment
end
return result
end
return function (_, state)
local ast = state.ast
local comments = state.comms
table.sort(comments, function (a, b)
return a.start < b.start
end)
ast.docs = {
type = 'doc',
parent = ast,
}
pushError = state.pushError
for _, comment in ipairs(comments) do
local doc = buildLuaDoc(comment)
if doc then
ast.docs[#ast.docs+1] = doc
doc.parent = ast.docs
if ast.start > doc.start then
ast.start = doc.start
end
if ast.finish < doc.finish then
ast.finish = doc.finish
end
end
end
end
|