-
Notifications
You must be signed in to change notification settings - Fork 9
/
kernel_doc.py
executable file
·3080 lines (2497 loc) · 115 KB
/
kernel_doc.py
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
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
# -*- coding: utf-8; mode: python -*-
# pylint: disable=C0103,C0302,C0325,R0912,R0914,R0915,W0221
u"""
kernel_doc
~~~~~~~~~~
Implementation of the ``kernel-doc`` parser.
:copyright: Copyright (C) 2016 Markus Heiser
:license: GPL Version 2, June 1991 see Linux/COPYING for details.
The kernel-doc parser extracts documentation from Linux kernel's source code
comments. This implements the :ref:`kernel-doc markup <kernel-doc-intro>`.
This module provides an API -- which could be used by a sphinx-doc generator
extension -- and a command-line interface, see ``--help``::
$ kernel-doc --help
But, the command-line is only for test, normally you don't need it.
Compared with the Perl kernel-doc script, this implementation has additional
features like *parse options* for a smooth integration of reStructuredText
(reST) markup in the kernel's source code comments. In addition, this
rewrite brings the functionalities, which has been spread in *docproc* and
make files (e.g. working with *EXPORTED_SYMBOLS*) back to the kernel-doc
parse process. In combination with a (separate) *kernel-doc* reST directive
(which uses this module), the documentation generation becomes more clear
and flexible.
The architecture is simple and consists of three types of objects (three
classes).
* class Parser: The parser parses the source-file and dumps extracted
kernel-doc data.
* subclasses of class TranslatorAPI: to translate the dumped kernel-doc data
into output formats. There exists two implementations:
- class NullTranslator: translates nothing, just parse
- class ReSTTranslator(TranslatorAPI): translates dumped kernel-doc data
to reST markup.
* class ParseOptions: a container full with options to control parsing an
translation.
With the NullTranslator a source file is parsed only once while different
output could be generated (multiple times) just by changing the Translator
(e.g. with the ReSTTranslator) and the option container.
With parsing the source files only once, the building time is reduced n-times.
"""
# ==============================================================================
# imports
# ==============================================================================
import argparse
import codecs
import collections
import copy
import os
import re
import sys
import textwrap
import six
from fspath import OS_ENV
# ==============================================================================
# common globals
# ==============================================================================
# The version numbering follows numbering of the specification
# (Documentation/books/kernel-doc-HOWTO).
__version__ = '1.0'
# ==============================================================================
# regular expresssions and helper used by the parser and the translator
# ==============================================================================
class RE(object):
u"""regular expression that stores last match (like Perl's ``=~`` operator)"""
def __init__(self, *args, **kwargs):
self.re = re.compile(*args, **kwargs)
self.last_match = None
def match(self, *args, **kwargs):
self.last_match = self.re.match(*args, **kwargs)
return self.last_match
def search(self, *args, **kwargs):
self.last_match = self.re.search(*args, **kwargs)
return self.last_match
def __getattr__(self, attr):
return getattr(self.re, attr)
def __getitem__(self, group):
if group < 0 or group > self.groups - 1:
raise IndexError("group index out of range (max %s groups)" % self.groups )
if self.last_match is None:
raise IndexError("nothing has matched / no groups")
return self.last_match.group(group + 1)
# these regular expresions has been *stolen* from the kernel-doc perl script.
doc_start = RE(r"^/\*\*\s*$") # Allow whitespace at end of comment start.
doc_end = RE(r"\s*\*+/")
doc_com = RE(r"\s*\*\s*")
doc_com_section = RE(r"\s*\*\s{1,8}") # more than 8 spaces (one tab) as prefix is not a new section comment
doc_com_body = RE(r"\s*\* ?")
doc_decl = RE(doc_com.pattern + r"(\w+)")
#doc_decl_ident = RE(r"\s*([\w\s]+?)\s*[\(\)]\s*[-:]")
doc_decl_ident = RE(doc_com.pattern + r"(struct|union|enum|typedef|function)\s*(\w+)(\(\))?")
doc_decl_purpose = RE(r"[-:](.*)$")
# except pattern like "http://", a whitespace is required after the colon
doc_sect_except = RE(doc_com.pattern + r"[^\s@](.*)?:[^\s]")
#doc_sect = RE(doc_com.pattern + r"([" + doc_special.pattern + r"]?[\w\s]+):(.*)")
# "section header:" names must be unique per function (or struct,union, typedef,
# enum). Additional condition: the header name should have 3 characters at least!
doc_sect = RE(
doc_com_section.pattern
+ r"("
+ r"@\w[^:]*" # "@foo: lorem" or
+ r"|" + r"@\w[.\w]+[^:]*" # "@foo.bar: lorem" or
+ r"|" + r"\@\.\.\." # ellipsis "@...: lorem" or
+ r"|" + r"\w[\w\s]+\w" # e.g. "Return: lorem"
+ r")"
+ r":(.*?)\s*$") # this matches also strings like "http://..." (doc_sect_except)
doc_sect_reST = RE(
doc_com_section.pattern
+ r"("
+ r"@\w[^:]*" # "@foo: lorem" or
+ r"|" + r"@\w[.\w]+[^:]*" # "@foo.bar: lorem" or
+ r"|" + r"\@\.\.\." # ellipsis "@...: lorem" or
# a tribute to vintage markups, when in reST mode ...
+ r"|description|context|returns?|notes?|examples?|introduction|intro"
+ r")"
+ r":(.*?)\s*$" # this matches also strings like "http://..." (doc_sect_except)
, flags = re.IGNORECASE)
reST_sect = RE(
doc_com_section.pattern
+ r"("
r"\w[\w\s]+\w"
+ r")"
+ r":\s*$")
doc_content = RE(doc_com_body.pattern + r"(.*)")
doc_block = RE(doc_com.pattern + r"DOC:\s*(.*)?")
# state: 5 - gathering documentation outside main block
doc_state5_start = RE(r"^\s*/\*\*\s*$")
doc_state5_sect = RE(r"\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)")
doc_state5_end = RE(r"^\s*\*/\s*$")
doc_state5_oneline = RE(r"^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$")
# match expressions used to find embedded type information
type_enum_full = RE(r"(?<=\s)\&(enum)\s*([_\w]+)")
type_struct_full = RE(r"(?<=\s)\&(struct)\s*([_\w]+)")
type_typedef_full = RE(r"(?<=\s)\&(typedef)\s*([_\w]+)")
type_union_full = RE(r"(?<=\s)\&(union)\s*([_\w]+)")
type_member = RE(r"(?<=\s)\&([_\w]+)((\.|->)[_\w]+)")
type_member_func = RE(type_member.pattern + r"\(\)")
type_func = RE(r"(?<=\s)(\w+)(?<!\\)\(\)")
type_constant = RE(r"(?<=\s)\%([-_\w]+)")
type_param = RE(r"(?<=\s)\@(\w*(\.\w+)*(\.\.\.)?)")
type_env = RE(r"(?<=\s)(\$\w+)")
type_struct = RE(r"(?<=\s)\&((struct\s*)*[_\w]+)")
esc_type_prefix = RE(r"\\([\@\%\&\$\(])")
CR_NL = RE(r"[\r\n]")
C99_comments = RE(r"//.*$")
C89_comments = RE(r"/\*.*?\*/")
C_STRUCT = RE(r"struct\s+(\w+)\s*{(.*)}")
C_UNION = RE(r"union\s+(\w+)\s*{(.*)}")
C_STRUCT_UNION = RE(r"(struct|union)\s+(\w+)\s*{(.*)}")
C_ENUM = RE(r"enum\s+(\w+)\s*{(.*)}")
C_TYPEDEF = RE(r"typedef.*\s+(\w+)\s*;")
# typedef of a function pointer
C_FUNC_TYPEDEF = RE(r"typedef\s+(\w+)\s*\(\*\s*(\w\S+)\s*\)\s*\((.*)\);")
C_FUNC_TYPEDEF_2 = RE(r"typedef\s+(\w+)\s+(\w\S+)\s*\((.*)\);")
MACRO = RE(r"^#")
MACRO_define = RE(r"^#\s*define\s+")
SYSCALL_DEFINE = RE(r"^\s*SYSCALL_DEFINE.*\(")
SYSCALL_DEFINE0 = RE(r"^\s*SYSCALL_DEFINE0")
TP_PROTO = RE(r"TP_PROTO\((.*?)\)")
TRACE_EVENT = RE(r"TRACE_EVENT")
TRACE_EVENT_name = RE(r"TRACE_EVENT\((.*?),")
DEFINE_EVENT = RE(r"DEFINE_EVENT")
DEFINE_EVENT_name = RE(r"DEFINE_EVENT\((.*?),(.*?),")
DEFINE_SINGLE_EVENT = RE(r"DEFINE_SINGLE_EVENT")
DEFINE_SINGLE_EVENT_name = RE(r"DEFINE_SINGLE_EVENT\((.*?),")
FUNC_PROTOTYPES = [
# RE(r"^(\w+)\s+\(\*([a-zA-Z0-9_]+)\)\s*\(([^\(]*)\)") # match: void (*foo) (int bar);
RE(r"^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)")
, RE(r"^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)")
, RE(r"^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)")
, RE(r"^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)")
, RE(r"^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)")
, RE(r"^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)")
, RE(r"^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)")
, RE(r"^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)")
, RE(r"^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)")
, RE(r"^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)")
, RE(r"^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)")
, RE(r"^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)")
, RE(r"^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)")
, RE(r"^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)")
, RE(r"^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)")
, RE(r"^(\w+\s+\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)")
, RE(r"^(\w+\s+\w+\s*\*\s*\w+\s*\*+\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)")
]
# MODULE_AUTHOR("..."); / MODULE_DESCRIPTION("..."); / MODULE_LICENSE("...");
#
MODULE_INFO = RE(r'^\s*(MODULE_)(AUTHOR|DESCRIPTION|LICENSE)\s*\(\s*"([^"]+)"', flags=re.M)
WHITESPACE = RE(r"\s+", flags=re.UNICODE)
def normalize_ws(string):
u"""strip needles whitespaces.
Substitute consecutive whitespaces with one single space and strip
trailing/leading whitespaces"""
string = WHITESPACE.sub(" ", string)
return string.strip()
ID_CHARS = RE(r"[^A-Za-z0-9\._]")
def normalize_id(ID):
u"""substitude invalid chars of the ID with ``-`` and mak it lowercase"""
return ID_CHARS.sub("-", ID).lower()
RST_DIRECTIVE_PATTERN = r"""
\.\.[ ]+ # explicit markup start
(%s) # directive name
[ ]? # optional space
:: # directive delimiter
([ ]+|$) # whitespace or end of line
"""
RST_CODE_BLOCK = RE(RST_DIRECTIVE_PATTERN % 'code-block', re.VERBOSE | re.UNICODE)
RST_LITERAL_BLOCK = RE(r'(?<!\\)(\\\\)*::$')
RST_INDENT = RE(r"^(\s*)[^\s]")
def map_row(row, map_table):
for regexpr, substitute in map_table:
if substitute is not None:
# python has only fixed width lookbehind: add temporarily leading space
row = regexpr.sub(substitute, " " + row)[1:]
return row
def highlight_parser(text, map_table):
# FIXME: document this
block_indent = 0
row_indent = 0
state = 'highlight' # [highlight|literal]
out = []
in_rows = text.splitlines()
while in_rows:
row = in_rows.pop(0)
if not row.strip(): # pass-through empty lines & continue
out.append(row)
continue
RST_INDENT.search(row)
indent = len(RST_INDENT[0].expandtabs())
if state == 'highlight':
out.append(map_row(row, map_table))
# prepare next state
if (RST_LITERAL_BLOCK.search(row) or RST_CODE_BLOCK.search(row)):
state = 'literal'
block_indent = row_indent + 1
continue
if state == 'literal':
if indent < block_indent:
# this is a new block, push row back onto the stack and repeat
# the loop
state = 'highlight'
block_indent = indent
in_rows.insert(0, row)
continue
else:
out.append(row)
return "\n".join(out)
# ==============================================================================
# helper
# ==============================================================================
def openTextFile(fname, mode="r", encoding="utf-8", errors="strict", buffering=1):
return codecs.open(
fname, mode=mode, encoding=encoding
, errors=errors, buffering=buffering)
def readFile(fname, encoding="utf-8", errors="strict"):
with openTextFile(fname, encoding=encoding, errors=errors) as f:
return f.read()
class Container(dict):
@property
def __dict__(self):
return self
def __getattr__(self, attr):
return self[attr]
def __setattr__(self, attr, val):
self[attr] = val
class DevNull(object):
"""A dev/null file descriptor."""
def write(self, *args, **kwargs):
pass
DevNull = DevNull()
KBUILD_VERBOSE = int(OS_ENV.get("KBUILD_VERBOSE", "0"))
KERNELVERSION = OS_ENV.get("KERNELVERSION", "unknown kernel version")
SRCTREE = OS_ENV.get("srctree", "")
GIT_REF = ("Linux kernel source tree:"
" `%(rel_fname)s <https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/"
"%(rel_fname)s>`__")
DEFAULT_EXP_METHOD = "macro"
DEFAULT_EXP_IDS = ['EXPORT_SYMBOL', 'EXPORT_SYMBOL_GPL', 'EXPORT_SYMBOL_GPL_FUTURE']
# ==============================================================================
# Logging stuff
# ==============================================================================
STREAM = Container(
# pipes used by the application & logger
appl_out = sys.__stdout__
, log_out = sys.__stderr__
, )
VERBOSE = bool(KBUILD_VERBOSE)
DEBUG = False
INSPECT = False
QUIET = False
class SimpleLog(object):
LOG_FORMAT = "%(logclass)s: %(message)s\n"
def error(self, message, **replace):
message = message % replace
replace.update(dict(message = message, logclass = "ERROR"))
STREAM.log_out.write(self.LOG_FORMAT % replace)
def warn(self, message, **replace):
if QUIET:
return
message = message % replace
replace.update(dict(message = message, logclass = "WARN"))
STREAM.log_out.write(self.LOG_FORMAT % replace)
def info(self, message, **replace):
if not VERBOSE:
return
message = message % replace
replace.update(dict(message = message, logclass = "INFO"))
STREAM.log_out.write(self.LOG_FORMAT % replace)
def debug(self, message, **replace):
if not DEBUG:
return
message = message % replace
replace.update(dict(message = message, logclass = "DEBUG"))
STREAM.log_out.write(self.LOG_FORMAT % replace)
LOG = SimpleLog()
# ==============================================================================
def main():
# ==============================================================================
global VERBOSE, DEBUG # pylint: disable=W0603
epilog = (u"This implementation of uses the kernel-doc parser"
" from the linuxdoc extension, for detail informations read"
" http://return42.github.io/sphkerneldoc/books/kernel-doc-HOWTO")
CLI = argparse.ArgumentParser(
description = (
"Parse *kernel-doc* comments from source code"
" and print them (with reST markup) to stdout." )
, epilog = epilog
, formatter_class=argparse.ArgumentDefaultsHelpFormatter)
CLI.add_argument(
"files"
, nargs = "+"
, help = "source file(s) to parse.")
CLI.add_argument(
"--id-prefix"
, default = ""
, help = (
"A prefix for generated IDs. IDs are used as anchors by cross"
" references. They are automaticly gernerated based on the declaration"
" and / or section names. Declartions like 'open' or section names"
" like 'Intro' are very common, to make them unique, a prefix is needed."
" Mostly you will choose the *module* or *include filename* as prefix." ))
CLI.add_argument(
"--verbose", "-v"
, action = "store_true"
, help = "verbose output with log messages to stderr" )
CLI.add_argument(
"--sloppy"
, action = "store_true"
, help = "Sloppy linting, reports only severe errors.")
CLI.add_argument(
"--debug"
, action = "store_true"
, help = "debug messages to stderr" )
CLI.add_argument(
"--quiet", "-q"
, action = "store_true"
, help = "no messages to stderr" )
CLI.add_argument(
"--skip-preamble"
, action = "store_true"
, help = "skip preamble in the output" )
CLI.add_argument(
"--skip-epilog"
, action = "store_true"
, help = "skip epilog in the output" )
CLI.add_argument(
"--list-internals"
, choices = Parser.DOC_TYPES + ["all"]
, nargs = "+"
, help = "list symbols, titles or whatever is documented, but *not* exported" )
CLI.add_argument(
"--list-exports"
, action = "store_true"
, help = "list all exported symbols" )
CLI.add_argument(
"--use-names"
, nargs = "+"
, help = "print documentation of functions, structs or whatever title/object")
CLI.add_argument(
"--exported"
, action = "store_true"
, help = "print documentation of all exported symbols")
CLI.add_argument(
"--internal"
, action = "store_true"
, help = ("print documentation of all symbols that are documented,"
" but not exported" ))
CLI.add_argument(
"--markup"
, choices = ["reST", "kernel-doc"]
, default = "reST"
, help = (
"Markup of the comments. Change this option only if you know"
" what you do. New comments must be marked up with reST!"))
CLI.add_argument(
"--symbols-exported-method"
, default = DEFAULT_EXP_METHOD
, help = (
"Indicate the way by which an exported symbol an exported symbol"
" is exported. Must be either 'macro' or 'attribute'."))
CLI.add_argument(
"--symbols-exported-identifiers"
, nargs = "+"
, default = DEFAULT_EXP_IDS
, help = "identifiers list that specifies an exported symbol")
CLI.add_argument(
"--known-attrs"
, default = ""
, nargs = "+"
, help = ("provides a list of known attributes that has to be"
" hidden when displaying function prototypes"))
CMD = CLI.parse_args()
VERBOSE = CMD.verbose
DEBUG = CMD.debug
if CMD.quiet:
STREAM.log_out = DevNull # pylint: disable=W0201
LOG.debug(u"CMD: %(CMD)s", CMD=CMD)
retVal = 0
for fname in CMD.files:
translator = ReSTTranslator()
opts = ParseOptions(
fname = fname
, id_prefix = CMD.id_prefix
, skip_preamble = CMD.skip_preamble
, skip_epilog = CMD.skip_epilog
, out = STREAM.appl_out
, markup = CMD.markup
, verbose_warn = not (CMD.sloppy)
, exp_method = CMD.symbols_exported_method
, exp_ids = CMD.symbols_exported_identifiers
, known_attrs = CMD.known_attrs
,)
opts.set_defaults()
if CMD.list_exports or CMD.list_internals:
translator = ListTranslator(CMD.list_exports, CMD.list_internals)
opts.gather_context = True
elif CMD.use_names:
opts.use_names = CMD.use_names
elif CMD.exported or CMD.internal:
# gather exported symbols ...
src = readFile(opts.fname)
ctx = ParserContext()
Parser.gather_context(src, ctx, opts)
opts.error_missing = False
opts.use_names = ctx.exported_symbols
opts.skip_names = []
if CMD.internal:
opts.use_names = []
opts.skip_names = ctx.exported_symbols
else:
# if non section is choosen by use-name, internal or exclude, then
# use all DOC: sections
opts.use_all_docs = True
parser = Parser(opts, translator)
parser.parse()
parser.close()
if parser.errors:
retVal = 1
return retVal
# ==============================================================================
# API
# ==============================================================================
# ------------------------------------------------------------------------------
class TranslatorAPI(object):
# ------------------------------------------------------------------------------
u"""
Abstract kernel-doc translator.
:cvar list cls.HIGHLIGHT_MAP: highlight mapping
:cvar tuple cls.LINE_COMMENT: tuple with start-/end- comment tags
"""
HIGHLIGHT_MAP = [
( type_constant , None )
, ( type_func , None )
, ( type_param , None )
, ( type_struct_full , None )
, ( type_struct , None )
, ( type_enum_full , None )
, ( type_env , None )
, ( type_member_func , None )
, ( type_member , None )
, ]
LINE_COMMENT = ("# ", "")
def __init__(self):
self.options = None
self.parser = None
self.dumped_names = []
self.translated_names = set()
def setParser(self, parser):
self.parser = parser
self.dumped_names = []
def setOptions(self, options):
self.options = options
def highlight(self, cont):
u"""returns *highlighted* text"""
if self.options.highlight:
return highlight_parser(cont, self.HIGHLIGHT_MAP)
return cont
def get_preamble(self):
retVal = ""
if self.options.preamble == "":
retVal = self.comment("src-file: %s" % (self.options.rel_fname or self.options.fname))
elif self.options.preamble:
retVal = self.options.preamble % self
return retVal
def get_epilog(self):
retVal = ""
if self.options.epilog == "":
retVal = self.comment(
"\nThis file was automatic generated / don't edit.")
elif self.options.epilog:
retVal = self.options.epilog % self
return retVal
@classmethod
def comment(cls, cont):
u"""returns *commented* text"""
start, end = cls.LINE_COMMENT
if not start and not end:
return cont
retVal = []
for line in cont.split("\n"):
if line.strip():
retVal.append(start + line + end)
else:
retVal.append("")
return "\n".join(retVal)
def write(self, *objects):
u"""Write *objects* to stream.
Write Unicode-values of the *objects* to :py:attr:``self.options.out``.
:param objects: The positional arguments are the objects with the
content to write.
"""
for obj in objects:
cont = six.text_type(obj)
self.options.out.write(cont)
def write_comment(self, *objects):
u"""Write *objects* as comments to stream."""
for obj in objects:
cont = six.text_type(obj)
self.write(self.comment(cont))
def eof(self):
if self.options.eof_newline:
self.write("\n")
# API
# ---
def output_preamble(self):
raise NotImplementedError
def output_epilog(self):
raise NotImplementedError
def output_DOC(
self
, sections = None # ctx.sections
, ):
raise NotImplementedError
def output_function_decl(
self
, function = None # ctx.decl_name
, return_type = None # ctx.return_type
, parameterlist = None # ctx.parameterlist
, parameterdescs = None # ctx.parameterdescs
, parametertypes = None # ctx.parametertypes
, sections = None # ctx.sections
, purpose = None # ctx.decl_purpose
, ):
raise NotImplementedError
def output_struct_decl(
self
, decl_name = None # ctx.decl_name
, decl_type = None # ctx.decl_type
, parameterlist = None # ctx.parameterlist
, parameterdescs = None # ctx.parameterdescs
, parametertypes = None # ctx.parametertypes
, sections = None # ctx.sections
, purpose = None # ctx.decl_purpose
, definition = None # ctx.definition
, ):
raise NotImplementedError
def output_union_decl(self, *args, **kwargs):
self.output_struct_decl(*args, **kwargs)
def output_enum_decl(
self
, enum = None # ctx.decl_name
, parameterlist = None # ctx.parameterlist
, parameterdescs = None # ctx.parameterdescs
, sections = None # ctx.sections
, purpose = None # ctx.decl_purpose
, ):
raise NotImplementedError
def output_typedef_decl(
self
, typedef = None # ctx.decl_name
, sections = None # ctx.sections
, purpose = None # ctx.decl_purpose
, ):
raise NotImplementedError
# ------------------------------------------------------------------------------
class NullTranslator(TranslatorAPI):
# ------------------------------------------------------------------------------
u"""
Null translator, translates nothing, just parse.
"""
HIGHLIGHT_MAP = []
LINE_COMMENT = ("", "")
def output_preamble(self, *args, **kwargs):
pass
def output_epilog(self, *args, **kwargs):
pass
def output_DOC(self, *args, **kwargs):
pass
def output_function_decl(self, *args, **kwargs):
pass
def output_struct_decl(self, *args, **kwargs):
pass
def output_union_decl(self, *args, **kwargs):
pass
def output_enum_decl(self, *args, **kwargs):
pass
def output_typedef_decl(self, *args, **kwargs):
pass
def eof(self):
pass
# ------------------------------------------------------------------------------
class ListTranslator(TranslatorAPI):
# ------------------------------------------------------------------------------
u"""
Generates a list of kernel-doc symbols.
"""
def __init__(self, list_exported, list_internal_types
, *args, **kwargs):
super(ListTranslator, self).__init__(*args, **kwargs)
self.list_exported = list_exported
self.list_internal_types = list_internal_types
self.names = dict()
for t in Parser.DOC_TYPES:
self.names[t] = []
def get_type(self, name):
for t, l in self.names.items():
if name in l:
return t
return None
def output_preamble(self):
pass
def output_epilog(self):
pass
def output_DOC(self, sections = None):
for header in sections.keys():
self.names["DOC"].append(header)
def output_function_decl(self, **kwargs):
self.names["function"].append(kwargs["function"])
def output_struct_decl(self, **kwargs):
self.names["struct"].append(kwargs["decl_name"])
def output_union_decl(self, **kwargs):
self.names["union"].append(kwargs["decl_name"])
def output_enum_decl(self, **kwargs):
self.names["enum"].append(kwargs["enum"])
def output_typedef_decl(self, **kwargs):
self.names["typedef"].append(kwargs["typedef"])
def eof(self):
if self.list_exported:
self.parser.info("list exported symbols")
for name in self.parser.ctx.exported_symbols:
t = self.get_type(name)
if t is None:
self.parser.warn("exported symbol '%(name)s' is undocumented"
, name = name)
t = "undocumented"
self.write("[exported %-14s] %s \n" % (t, name))
if self.list_internal_types:
self.parser.info("list internal names")
for t, l in self.names.items():
if not ("all" in self.list_internal_types
or t in self.list_internal_types):
continue
for name in l:
if name not in self.parser.ctx.exported_symbols:
self.write("[internal %-10s] %s \n" % (t, name))
# ------------------------------------------------------------------------------
class ReSTTranslator(TranslatorAPI):
# ------------------------------------------------------------------------------
u"""
Translate kernel-doc to reST markup.
:cvar list HIGHLIGHT_map: Escape common reST (in-line) markups. Classic
kernel-doc comments contain characters and strings like ``*`` or
trailing ``_``, which are in-line markups in reST. These special strings
has to be masked in reST.
"""
INDENT = " "
LINE_COMMENT = (".. ", "")
HIGHLIGHT_MAP = [
# the regexpr are partial *overlapping*, mind the order!
( type_enum_full , r"\ :c:type:`\1 \2 <\2>`\ " )
, ( type_struct_full , r"\ :c:type:`\1 \2 <\2>`\ " )
, ( type_typedef_full, r"\ :c:type:`\1 \2 <\2>`\ " )
, ( type_union_full , r"\ :c:type:`\1 \2 <\2>`\ " )
, ( type_member_func , r"\ :c:type:`\1\2() <\1>`\ " )
, ( type_member , r"\ :c:type:`\1\2 <\1>`\ " )
, ( type_func , r"\ :c:func:`\1`\ ")
, ( type_constant , r"\ ``\1``\ " )
, ( type_param , r"\ ``\1``\ " )
, ( type_env , r"\ ``\1``\ " )
, ( type_struct , r"\ :c:type:`struct \1 <\1>`\ ")
# at least replace escaped %, & and $
, ( esc_type_prefix , r"\1")
, ]
MASK_REST_INLINES = [
(RE(r"(\w)_([\s\*])") , r"\1\\_\2") # trailing underline
, (RE(r"([\s\*])_(\w)"), r"\1\\_\2") # leading underline
, (RE(r"(\*)") , r"\\\1") # emphasis
, (RE(r"(`)") , r"\\\1") # interpreted text & inline literals
, (RE(r"(\|)") , r"\\\1") # substitution references
, ]
FUNC_PTR = RE(r"([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)")
BITFIELD = RE(r"^(.*?)\s*(:.*)")
def highlight(self, text):
if self.options.markup == "kernel-doc":
text = highlight_parser(text, self.MASK_REST_INLINES + self.HIGHLIGHT_MAP )
elif self.options.markup == "reST":
text = highlight_parser(text, self.HIGHLIGHT_MAP )
return text
def format_block(self, content):
u"""format the content (string)"""
lines = []
if self.options.markup == "kernel-doc":
lines = [ l.strip() for l in content.split("\n")]
elif self.options.markup == "reST":
lines = [ l.rstrip() for l in content.split("\n")]
return "\n".join(lines)
def write_anchor(self, refname):
ID = refname
if self.options.id_prefix:
ID = self.options.id_prefix + "." + ID
ID = normalize_id(ID)
self.write("\n.. _`%s`:\n" % ID)
HEADER_TAGS = (
"#" # level 0 / part with overline
"=" # level 1 / chapter with overline
"=" # level 2 / sec
"-" # level 3 / subsec
"-" # level 4 / subsubsec
'"' ) # level 5 / para
def write_header(self, header, sec_level=2):
header = self.highlight(header)
sectag = self.HEADER_TAGS[sec_level]
if sec_level < 2:
self.write("\n", (sectag * len(header)))
self.write("\n%s" % header)
self.write("\n", (sectag * len(header)), "\n")
def write_section(self, header, content, sec_level=2, ID=None):
if not self.options.no_header:
if ID:
self.write_anchor(ID)
self.write_header(header, sec_level=sec_level)
if header.lower() == "example":
self.write("\n.. code-block:: c\n\n")
for l in textwrap.dedent(content).split("\n"):
if not l.strip():
self.write("\n")
else:
self.write(self.INDENT, l, "\n")
else:
content = self.format_block(content)
content = self.highlight(content)
self.write("\n" + content)
self.write("\n")
def write_definition(self, term, definition, prefix=""):
term = normalize_ws(term) # term has to be a "one-liner"
term = self.highlight(term)
if definition != Parser.undescribed:
definition = self.format_block(definition)
definition = self.highlight(definition)
self.write("\n", prefix, term)
for l in textwrap.dedent(definition).split("\n"):
self.write("\n", prefix)
if l.strip():
self.write(self.INDENT, l)
self.write("\n")
def write_func_param(self, param, descr):
param = param.replace("*", r"\*")
self.write("\n", self.INDENT, param)
if descr != Parser.undescribed:
descr = self.format_block(descr)
descr = self.highlight(descr)
for l in textwrap.dedent(descr).split("\n"):
self.write("\n")
if l.strip():
self.write(self.INDENT * 2, l)
self.write("\n")
def output_preamble(self):
self.parser.ctx.offset = 0
if self.options.mode_line:
self.write_comment(
"-*- coding: %s; mode: rst -*-\n"
% (getattr(self.options.out, "encoding", "utf-8") or "utf-8").lower())
preamble = self.get_preamble()
if preamble:
self.write(preamble, "\n")
if self.options.top_title:
self.write_anchor(self.options.top_title)
self.write_header(self.options.top_title, 0)
if self.options.top_link:
self.write("\n", self.options.top_link % self.options, "\n")
def output_epilog(self):
self.parser.ctx.offset = 0
epilog = self.get_epilog()
if epilog:
self.write(epilog, "\n")
def output_DOC(self, sections = None):
self.parser.ctx.offset = self.parser.ctx.decl_offset
for header, content in sections.items():
self.write_section(header, content, sec_level=2, ID=header)
def output_function_decl(
self
, function = None # ctx.decl_name
, return_type = None # ctx.return_type
, parameterlist = None # ctx.parameterlist