Blame view
scripts/kernel-doc
66.2 KB
cb77f0d62
|
1 |
#!/usr/bin/env perl |
384763784
|
2 |
# SPDX-License-Identifier: GPL-2.0 |
1da177e4c
|
3 |
|
cb77f0d62
|
4 |
use warnings; |
1da177e4c
|
5 6 7 8 9 |
use strict; ## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## ## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ## ## Copyright (C) 2001 Simon Huggins ## |
70c95b00b
|
10 |
## Copyright (C) 2005-2012 Randy Dunlap ## |
1b40c1944
|
11 |
## Copyright (C) 2012 Dan Luedtke ## |
1da177e4c
|
12 13 14 15 16 17 |
## ## ## #define enhancements by Armin Kuster <akuster@mvista.com> ## ## Copyright (c) 2000 MontaVista Software, Inc. ## ## ## ## This software falls under the GNU General Public License. ## ## Please read the COPYING file for more information ## |
1da177e4c
|
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
# 18/01/2001 - Cleanups # Functions prototyped as foo(void) same as foo() # Stop eval'ing where we don't need to. # -- huggie@earth.li # 27/06/2001 - Allowed whitespace after initial "/**" and # allowed comments before function declarations. # -- Christian Kreibich <ck@whoop.org> # Still to do: # - add perldoc documentation # - Look more closely at some of the scarier bits :) # 26/05/2001 - Support for separate source and object trees. # Return error code. # Keith Owens <kaos@ocs.com.au> # 23/09/2001 - Added support for typedefs, structs, enums and unions # Support for Context section; can be terminated using empty line # Small fixes (like spaces vs. \s in regex) # -- Tim Jansen <tim@tjansen.de> |
1b40c1944
|
39 40 |
# 25/07/2012 - Added support for HTML5 # -- Dan Luedtke <mail@danrl.de> |
1da177e4c
|
41 |
|
fadc0b31c
|
42 43 44 45 46 47 48 49 |
sub usage { my $message = <<"EOF"; Usage: $0 [OPTION ...] FILE ... Read C language source or header FILEs, extract embedded documentation comments, and print formatted documentation to standard output. The documentation comments are identified by "/**" opening comment mark. See |
857af3b77
|
50 |
Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax. |
fadc0b31c
|
51 52 |
Output format selection (mutually exclusive): |
fadc0b31c
|
53 |
-man Output troff manual page format. This is the default. |
c0d1b6ee7
|
54 |
-rst Output reStructuredText format. |
3a025e1d1
|
55 |
-none Do not output documentation, only warnings. |
fadc0b31c
|
56 |
|
93351d419
|
57 58 59 60 61 62 |
Output format selection modifier (affects only ReST output): -sphinx-version Use the ReST C domain dialect compatible with an specific Sphinx Version. If not specified, kernel-doc will auto-detect using the sphinx-build version found on PATH. |
fadc0b31c
|
63 |
Output selection (mutually exclusive): |
86ae2e38d
|
64 65 |
-export Only output documentation for symbols that have been exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() |
c9b2cfb3f
|
66 |
in any input FILE or -export-file FILE. |
86ae2e38d
|
67 68 |
-internal Only output documentation for symbols that have NOT been exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() |
c9b2cfb3f
|
69 |
in any input FILE or -export-file FILE. |
fadc0b31c
|
70 71 72 |
-function NAME Only output documentation for the given function(s) or DOC: section title(s). All other functions and DOC: sections are ignored. May be specified multiple times. |
eab795ddd
|
73 74 |
-nosymbol NAME Exclude the specified symbols from the output documentation. May be specified multiple times. |
fadc0b31c
|
75 76 77 |
Output selection modifiers: -no-doc-sections Do not output DOC: sections. |
0b0f5f29b
|
78 79 |
-enable-lineno Enable output of #define LINENO lines. Only works with reStructuredText format. |
88c2b57da
|
80 81 82 |
-export-file FILE Specify an additional FILE in which to look for EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be used with -export or -internal. May be specified multiple times. |
fadc0b31c
|
83 84 85 86 |
Other parameters: -v Verbose output, more warnings and other information. -h Print this help. |
2c12c8103
|
87 |
-Werror Treat warnings as errors. |
fadc0b31c
|
88 89 90 91 92 |
EOF print $message; exit 1; } |
1da177e4c
|
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# # format of comments. # In the following table, (...)? signifies optional structure. # (...)* signifies 0 or more structure elements # /** # * function_name(:)? (- short description)? # (* @parameterx: (description of parameter x)?)* # (* a blank line)? # * (Description:)? (Description of function)? # * (section header: (section description)? )* # (*)?*/ # # So .. the trivial example would be: # # /** # * my_function |
b9d97328e
|
110 |
# */ |
1da177e4c
|
111 |
# |
891dcd2f7
|
112 |
# If the Description: header tag is omitted, then there must be a blank line |
1da177e4c
|
113 114 115 116 117 118 |
# after the last parameter specification. # e.g. # /** # * my_function - does my stuff # * @my_arg: its mine damnit # * |
3c3b809e2
|
119 |
# * Does my stuff explained. |
1da177e4c
|
120 121 122 123 124 125 |
# */ # # or, could also use: # /** # * my_function - does my stuff # * @my_arg: its mine damnit |
3c3b809e2
|
126 |
# * Description: Does my stuff explained. |
1da177e4c
|
127 128 129 |
# */ # etc. # |
b9d97328e
|
130 |
# Besides functions you can also write documentation for structs, unions, |
3c3b809e2
|
131 132 133 |
# enums and typedefs. Instead of the function name you must write the name # of the declaration; the struct/union/enum/typedef must always precede # the name. Nesting of declarations is not supported. |
1da177e4c
|
134 135 136 137 138 139 |
# Use the argument mechanism to document members or constants. # e.g. # /** # * struct my_struct - short description # * @a: first member # * @b: second member |
3c3b809e2
|
140 |
# * |
1da177e4c
|
141 142 143 144 145 |
# * Longer description # */ # struct my_struct { # int a; # int b; |
aeec46b97
|
146 147 |
# /* private: */ # int c; |
1da177e4c
|
148 149 150 |
# }; # # All descriptions can be multiline, except the short function description. |
3c3b809e2
|
151 |
# |
a4c6ebede
|
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# For really longs structs, you can also describe arguments inside the # body of the struct. # eg. # /** # * struct my_struct - short description # * @a: first member # * @b: second member # * # * Longer description # */ # struct my_struct { # int a; # int b; # /** # * @c: This is longer description of C # * # * You can use paragraphs to describe arguments # * using this method. # */ # int c; # }; # # This should be use only for struct/enum members. # |
3c3b809e2
|
176 177 |
# You can also add additional sections. When documenting kernel functions you # should document the "Context:" of the function, e.g. whether the functions |
1da177e4c
|
178 |
# can be called form interrupts. Unlike other sections you can end it with an |
3c3b809e2
|
179 |
# empty line. |
4092bac77
|
180 181 |
# A non-void function should have a "Return:" section describing the return # value(s). |
3c3b809e2
|
182 |
# Example-sections should contain the string EXAMPLE so that they are marked |
1da177e4c
|
183 184 185 186 187 188 189 |
# appropriately in DocBook. # # Example: # /** # * user_function - function that can only be called in user context # * @a: some argument # * Context: !in_interrupt() |
3c3b809e2
|
190 |
# * |
1da177e4c
|
191 192 193 194 195 196 197 198 199 200 201 202 203 |
# * Some description # * Example: # * user_function(22); # */ # ... # # # All descriptive text is further processed, scanning for the following special # patterns, which are highlighted appropriately. # # 'funcname()' - function # '$ENVVAR' - environmental variable # '&struct_name' - name of a structure (up to two words including 'struct') |
5267dd354
|
204 |
# '&struct_name.member' - name of a structure member |
1da177e4c
|
205 206 |
# '@parameter' - name of a parameter # '%CONST' - name of a constant. |
b97f193ab
|
207 |
# '``LITERAL``' - literal string without any spaces on it. |
1da177e4c
|
208 |
|
8484baaa5
|
209 |
## init lots of data |
1da177e4c
|
210 211 |
my $errors = 0; my $warnings = 0; |
5f8c7c98a
|
212 |
my $anon_struct_union = 0; |
1da177e4c
|
213 214 |
# match expressions used to find embedded type information |
b97f193ab
|
215 216 |
my $type_constant = '\b``([^\`]+)``\b'; my $type_constant2 = '\%([-_\w]+)'; |
1da177e4c
|
217 |
my $type_func = '(\w+)\(\)'; |
bfd228c73
|
218 |
my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; |
ee2aa7590
|
219 |
my $type_param_ref = '([\!]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; |
5219f18aa
|
220 |
my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params |
346282db9
|
221 |
my $type_fp_param2 = '\@(\w+->\S+)\(\)'; # Special RST handling for structs with func ptr params |
1da177e4c
|
222 |
my $type_env = '(\$\w+)'; |
df31175bb
|
223 224 225 226 |
my $type_enum = '\&(enum\s*([_\w]+))'; my $type_struct = '\&(struct\s*([_\w]+))'; my $type_typedef = '\&(typedef\s*([_\w]+))'; my $type_union = '\&(union\s*([_\w]+))'; |
5267dd354
|
227 |
my $type_member = '\&([_\w]+)(\.|->)([_\w]+)'; |
df31175bb
|
228 |
my $type_fallback = '\&([_\w]+)'; |
f3341dcf3
|
229 |
my $type_member_func = $type_member . '\(\)'; |
1da177e4c
|
230 231 232 |
# Output conversion substitutions. # One for each output format |
1da177e4c
|
233 |
# these are pretty rough |
4d7327019
|
234 235 |
my @highlights_man = ( [$type_constant, "\$1"], |
b97f193ab
|
236 |
[$type_constant2, "\$1"], |
4d7327019
|
237 |
[$type_func, "\\\\fB\$1\\\\fP"], |
df31175bb
|
238 |
[$type_enum, "\\\\fI\$1\\\\fP"], |
4d7327019
|
239 |
[$type_struct, "\\\\fI\$1\\\\fP"], |
df31175bb
|
240 241 |
[$type_typedef, "\\\\fI\$1\\\\fP"], [$type_union, "\\\\fI\$1\\\\fP"], |
5267dd354
|
242 |
[$type_param, "\\\\fI\$1\\\\fP"], |
ee2aa7590
|
243 |
[$type_param_ref, "\\\\fI\$1\$2\\\\fP"], |
df31175bb
|
244 245 |
[$type_member, "\\\\fI\$1\$2\$3\\\\fP"], [$type_fallback, "\\\\fI\$1\\\\fP"] |
4d7327019
|
246 |
); |
1da177e4c
|
247 |
my $blankline_man = ""; |
c0d1b6ee7
|
248 249 250 |
# rst-mode my @highlights_rst = ( [$type_constant, "``\$1``"], |
b97f193ab
|
251 |
[$type_constant2, "``\$1``"], |
f3341dcf3
|
252 |
# Note: need to escape () to avoid func matching later |
5267dd354
|
253 254 |
[$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\\\\) <\$1>`"], [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"], |
5219f18aa
|
255 |
[$type_fp_param, "**\$1\\\\(\\\\)**"], |
346282db9
|
256 |
[$type_fp_param2, "**\$1\\\\(\\\\)**"], |
344fdb28a
|
257 |
[$type_func, "\$1()"], |
df31175bb
|
258 259 260 261 |
[$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"], [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"], [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"], [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"], |
a7291e7e0
|
262 |
# in rst this can refer to any type |
df31175bb
|
263 |
[$type_fallback, "\\:c\\:type\\:`\$1`"], |
ee2aa7590
|
264 |
[$type_param_ref, "**\$1\$2**"] |
c0d1b6ee7
|
265 266 267 |
); my $blankline_rst = " "; |
1da177e4c
|
268 |
# read arguments |
b9d97328e
|
269 |
if ($#ARGV == -1) { |
1da177e4c
|
270 271 |
usage(); } |
8484baaa5
|
272 |
my $kernelversion; |
93351d419
|
273 |
my ($sphinx_major, $sphinx_minor, $sphinx_patch); |
efa44475b
|
274 |
|
8484baaa5
|
275 |
my $dohighlight = ""; |
1da177e4c
|
276 |
my $verbose = 0; |
2c12c8103
|
277 |
my $Werror = 0; |
bdfe2be34
|
278 |
my $output_mode = "rst"; |
e314ba313
|
279 |
my $output_preformatted = 0; |
4b44595a7
|
280 |
my $no_doc_sections = 0; |
0b0f5f29b
|
281 |
my $enable_lineno = 0; |
bdfe2be34
|
282 283 |
my @highlights = @highlights_rst; my $blankline = $blankline_rst; |
1da177e4c
|
284 |
my $modulename = "Kernel API"; |
b6c3f456c
|
285 286 287 288 |
use constant { OUTPUT_ALL => 0, # output all symbols and doc sections OUTPUT_INCLUDE => 1, # output only specified symbols |
eab795ddd
|
289 290 |
OUTPUT_EXPORTED => 2, # output exported symbols OUTPUT_INTERNAL => 3, # output non-exported symbols |
b6c3f456c
|
291 292 |
}; my $output_selection = OUTPUT_ALL; |
b0d60bfbb
|
293 |
my $show_not_found = 0; # No longer used |
b2c4105b0
|
294 |
|
88c2b57da
|
295 |
my @export_file_list; |
b2c4105b0
|
296 297 298 299 300 301 302 |
my @build_time; if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) && (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') { @build_time = gmtime($seconds); } else { @build_time = localtime; } |
3c3b809e2
|
303 304 |
my $man_date = ('January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', |
b2c4105b0
|
305 306 |
'November', 'December')[$build_time[4]] . " " . ($build_time[5]+1900); |
1da177e4c
|
307 |
|
8484baaa5
|
308 |
# Essentially these are globals. |
b9d97328e
|
309 310 |
# They probably want to be tidied up, made more localised or something. # CAVEAT EMPTOR! Some of the others I localised may not want to be, which |
1da177e4c
|
311 |
# could cause "use of undefined value" or other bugs. |
b9d97328e
|
312 |
my ($function, %function_table, %parametertypes, $declaration_purpose); |
eab795ddd
|
313 |
my %nosymbol_table = (); |
0b0f5f29b
|
314 |
my $declaration_start_line; |
b9d97328e
|
315 |
my ($type, $declaration_name, $return_type); |
1c32fd0c5
|
316 |
my ($newsection, $newcontents, $prototype, $brcount, %source_map); |
1da177e4c
|
317 |
|
bd0e88e51
|
318 319 320 |
if (defined($ENV{'KBUILD_VERBOSE'})) { $verbose = "$ENV{'KBUILD_VERBOSE'}"; } |
2c12c8103
|
321 322 323 324 325 326 327 328 329 330 331 |
if (defined($ENV{'KDOC_WERROR'})) { $Werror = "$ENV{'KDOC_WERROR'}"; } if (defined($ENV{'KCFLAGS'})) { my $kcflags = "$ENV{'KCFLAGS'}"; if ($kcflags =~ /Werror/) { $Werror = 1; } } |
3c3b809e2
|
332 |
# Generated docbook code is inserted in a template at a point where |
1da177e4c
|
333 |
# docbook v3.1 requires a non-zero sequence of RefEntry's; see: |
93431e060
|
334 |
# https://www.oasis-open.org/docbook/documentation/reference/html/refentry.html |
1da177e4c
|
335 336 337 338 339 340 |
# We keep track of number of generated entries and generate a dummy # if needs be to ensure the expanded template can be postprocessed # into html. my $section_counter = 0; my $lineprefix=""; |
48af606ad
|
341 342 |
# Parser states use constant { |
0d55d48b1
|
343 344 345 346 347 348 349 350 |
STATE_NORMAL => 0, # normal code STATE_NAME => 1, # looking for function name STATE_BODY_MAYBE => 2, # body - or maybe more description STATE_BODY => 3, # the body of the comment STATE_BODY_WITH_BLANK_LINE => 4, # the body, which has a blank line STATE_PROTO => 5, # scanning prototype STATE_DOCBLOCK => 6, # documentation block STATE_INLINE => 7, # gathering doc outside main block |
48af606ad
|
351 |
}; |
1da177e4c
|
352 |
my $state; |
850622dfa
|
353 |
my $in_doc_sect; |
d742f24d6
|
354 |
my $leading_space; |
1da177e4c
|
355 |
|
48af606ad
|
356 357 358 359 360 361 362 363 364 365 366 |
# Inline documentation state use constant { STATE_INLINE_NA => 0, # not applicable ($state != STATE_INLINE) STATE_INLINE_NAME => 1, # looking for member name (@foo:) STATE_INLINE_TEXT => 2, # looking for member documentation STATE_INLINE_END => 3, # done STATE_INLINE_ERROR => 4, # error - Comment without header was found. # Spit a warning as it's not # proper kernel-doc and ignore the rest. }; my $inline_doc_state; |
a4c6ebede
|
367 |
|
1da177e4c
|
368 369 370 |
#declaration types: can be # 'function', 'struct', 'union', 'enum', 'typedef' my $decl_type; |
1da177e4c
|
371 372 373 |
my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start. my $doc_end = '\*/'; my $doc_com = '\s*\*\s*'; |
12ae67793
|
374 |
my $doc_com_body = '\s*\* ?'; |
b9d97328e
|
375 |
my $doc_decl = $doc_com . '(\w+)'; |
f624adef3
|
376 |
# @params and a strictly limited set of supported section names |
76dd3e7b6
|
377 |
my $doc_sect = $doc_com . |
ef00028b2
|
378 |
'\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:(.*)'; |
12ae67793
|
379 |
my $doc_content = $doc_com_body . '(.*)'; |
b9d97328e
|
380 |
my $doc_block = $doc_com . 'DOC:\s*(.*)?'; |
48af606ad
|
381 |
my $doc_inline_start = '^\s*/\*\*\s*$'; |
fe7bc493d
|
382 |
my $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)'; |
48af606ad
|
383 |
my $doc_inline_end = '^\s*\*/\s*$'; |
0c9aa2095
|
384 |
my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$'; |
86ae2e38d
|
385 |
my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;'; |
1da177e4c
|
386 |
|
1da177e4c
|
387 |
my %parameterdescs; |
0b0f5f29b
|
388 |
my %parameterdesc_start_lines; |
1da177e4c
|
389 390 391 |
my @parameterlist; my %sections; my @sectionlist; |
0b0f5f29b
|
392 |
my %section_start_lines; |
a1d94aa55
|
393 394 |
my $sectcheck; my $struct_actual; |
1da177e4c
|
395 396 |
my $contents = ""; |
0b0f5f29b
|
397 |
my $new_start_line = 0; |
f624adef3
|
398 399 |
# the canonical section names. see also $doc_sect above. |
1da177e4c
|
400 401 402 403 |
my $section_default = "Description"; # default section my $section_intro = "Introduction"; my $section = $section_default; my $section_context = "Context"; |
4092bac77
|
404 |
my $section_return = "Return"; |
1da177e4c
|
405 406 407 408 |
my $undescribed = "-- undescribed --"; reset_state(); |
b031ac4e7
|
409 410 411 412 |
while ($ARGV[0] =~ m/^--?(.*)/) { my $cmd = $1; shift @ARGV; if ($cmd eq "man") { |
1da177e4c
|
413 |
$output_mode = "man"; |
4d7327019
|
414 |
@highlights = @highlights_man; |
1da177e4c
|
415 |
$blankline = $blankline_man; |
b031ac4e7
|
416 |
} elsif ($cmd eq "rst") { |
c0d1b6ee7
|
417 418 419 |
$output_mode = "rst"; @highlights = @highlights_rst; $blankline = $blankline_rst; |
b031ac4e7
|
420 |
} elsif ($cmd eq "none") { |
3a025e1d1
|
421 |
$output_mode = "none"; |
b031ac4e7
|
422 |
} elsif ($cmd eq "module") { # not needed for XML, inherits from calling document |
1da177e4c
|
423 |
$modulename = shift @ARGV; |
b031ac4e7
|
424 |
} elsif ($cmd eq "function") { # to only output specific functions |
b6c3f456c
|
425 |
$output_selection = OUTPUT_INCLUDE; |
1da177e4c
|
426 427 |
$function = shift @ARGV; $function_table{$function} = 1; |
eab795ddd
|
428 429 430 |
} elsif ($cmd eq "nosymbol") { # Exclude specific symbols my $symbol = shift @ARGV; $nosymbol_table{$symbol} = 1; |
b031ac4e7
|
431 |
} elsif ($cmd eq "export") { # only exported symbols |
b6c3f456c
|
432 |
$output_selection = OUTPUT_EXPORTED; |
da9726ecf
|
433 |
%function_table = (); |
b031ac4e7
|
434 |
} elsif ($cmd eq "internal") { # only non-exported symbols |
b6c3f456c
|
435 |
$output_selection = OUTPUT_INTERNAL; |
da9726ecf
|
436 |
%function_table = (); |
b031ac4e7
|
437 |
} elsif ($cmd eq "export-file") { |
88c2b57da
|
438 439 |
my $file = shift @ARGV; push(@export_file_list, $file); |
b031ac4e7
|
440 |
} elsif ($cmd eq "v") { |
1da177e4c
|
441 |
$verbose = 1; |
2c12c8103
|
442 443 |
} elsif ($cmd eq "Werror") { $Werror = 1; |
b031ac4e7
|
444 |
} elsif (($cmd eq "h") || ($cmd eq "help")) { |
1da177e4c
|
445 |
usage(); |
b031ac4e7
|
446 |
} elsif ($cmd eq 'no-doc-sections') { |
4b44595a7
|
447 |
$no_doc_sections = 1; |
b031ac4e7
|
448 |
} elsif ($cmd eq 'enable-lineno') { |
0b0f5f29b
|
449 |
$enable_lineno = 1; |
b031ac4e7
|
450 |
} elsif ($cmd eq 'show-not-found') { |
b0d60bfbb
|
451 |
$show_not_found = 1; # A no-op but don't fail |
93351d419
|
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 |
} elsif ($cmd eq "sphinx-version") { my $ver_string = shift @ARGV; if ($ver_string =~ m/^(\d+)(\.\d+)?(\.\d+)?/) { $sphinx_major = $1; if (defined($2)) { $sphinx_minor = substr($2,1); } else { $sphinx_minor = 0; } if (defined($3)) { $sphinx_patch = substr($3,1) } else { $sphinx_patch = 0; } } else { die "Sphinx version should either major.minor or major.minor.patch format "; } |
b031ac4e7
|
470 471 472 |
} else { # Unknown argument usage(); |
1da177e4c
|
473 474 |
} } |
8484baaa5
|
475 |
# continue execution near EOF; |
efa44475b
|
476 477 478 479 480 481 482 483 484 485 486 487 |
# The C domain dialect changed on Sphinx 3. So, we need to check the # version in order to produce the right tags. sub findprog($) { foreach(split(/:/, $ENV{PATH})) { return "$_/$_[0]" if(-x "$_/$_[0]"); } } sub get_sphinx_version() { my $ver; |
efa44475b
|
488 489 490 491 |
my $cmd = "sphinx-build"; if (!findprog($cmd)) { my $cmd = "sphinx-build3"; |
93351d419
|
492 493 494 495 496 497 498 499 500 |
if (!findprog($cmd)) { $sphinx_major = 1; $sphinx_minor = 2; $sphinx_patch = 0; printf STDERR "Warning: Sphinx version not found. Using default (Sphinx version %d.%d.%d) ", $sphinx_major, $sphinx_minor, $sphinx_patch; return; } |
efa44475b
|
501 502 503 504 505 |
} open IN, "$cmd --version 2>&1 |"; while (<IN>) { if (m/^\s*sphinx-build\s+([\d]+)\.([\d\.]+)(\+\/[\da-f]+)?$/) { |
93351d419
|
506 507 508 |
$sphinx_major = $1; $sphinx_minor = $2; $sphinx_patch = $3; |
efa44475b
|
509 510 511 512 |
last; } # Sphinx 1.2.x uses a different format if (m/^\s*Sphinx.*\s+([\d]+)\.([\d\.]+)$/) { |
93351d419
|
513 514 515 |
$sphinx_major = $1; $sphinx_minor = $2; $sphinx_patch = $3; |
efa44475b
|
516 517 518 519 |
last; } } close IN; |
efa44475b
|
520 |
} |
53f049fa5
|
521 522 |
# get kernel version from env sub get_kernel_version() { |
1b9bc22d7
|
523 |
my $version = 'unknown kernel version'; |
53f049fa5
|
524 525 526 527 528 529 |
if (defined($ENV{'KERNELVERSION'})) { $version = $ENV{'KERNELVERSION'}; } return $version; } |
1da177e4c
|
530 |
|
0b0f5f29b
|
531 532 533 534 535 536 537 538 |
# sub print_lineno { my $lineno = shift; if ($enable_lineno && defined($lineno)) { print "#define LINENO " . $lineno . " "; } } |
1da177e4c
|
539 540 541 542 |
## # dumps section contents to arrays/hashes intended for that purpose. # sub dump_section { |
94dc7ad55
|
543 |
my $file = shift; |
1da177e4c
|
544 545 546 |
my $name = shift; my $contents = join " ", @_; |
13901ef27
|
547 |
if ($name =~ m/$type_param/) { |
1da177e4c
|
548 549 |
$name = $1; $parameterdescs{$name} = $contents; |
a1d94aa55
|
550 |
$sectcheck = $sectcheck . $name . " "; |
0b0f5f29b
|
551 552 |
$parameterdesc_start_lines{$name} = $new_start_line; $new_start_line = 0; |
ced69090c
|
553 |
} elsif ($name eq "@\.\.\.") { |
ced69090c
|
554 555 |
$name = "..."; $parameterdescs{$name} = $contents; |
a1d94aa55
|
556 |
$sectcheck = $sectcheck . $name . " "; |
0b0f5f29b
|
557 558 |
$parameterdesc_start_lines{$name} = $new_start_line; $new_start_line = 0; |
1da177e4c
|
559 |
} else { |
94dc7ad55
|
560 |
if (defined($sections{$name}) && ($sections{$name} ne "")) { |
95b6be9d1
|
561 562 563 564 565 566 |
# Only warn on user specified duplicate section names. if ($name ne $section_default) { print STDERR "${file}:$.: warning: duplicate section name '$name' "; ++$warnings; } |
32217761e
|
567 568 569 570 |
$sections{$name} .= $contents; } else { $sections{$name} = $contents; push @sectionlist, $name; |
0b0f5f29b
|
571 572 |
$section_start_lines{$name} = $new_start_line; $new_start_line = 0; |
94dc7ad55
|
573 |
} |
1da177e4c
|
574 575 576 577 |
} } ## |
b112e0f73
|
578 579 580 |
# dump DOC: section after checking that it should go out # sub dump_doc_section { |
94dc7ad55
|
581 |
my $file = shift; |
b112e0f73
|
582 583 584 |
my $name = shift; my $contents = join " ", @_; |
4b44595a7
|
585 586 587 |
if ($no_doc_sections) { return; } |
eab795ddd
|
588 |
return if (defined($nosymbol_table{$name})); |
b6c3f456c
|
589 |
if (($output_selection == OUTPUT_ALL) || |
eab795ddd
|
590 591 |
(($output_selection == OUTPUT_INCLUDE) && defined($function_table{$name}))) |
b112e0f73
|
592 |
{ |
94dc7ad55
|
593 |
dump_section($file, $name, $contents); |
b112e0f73
|
594 595 596 |
output_blockhead({'sectionlist' => \@sectionlist, 'sections' => \%sections, 'module' => $modulename, |
b6c3f456c
|
597 |
'content-only' => ($output_selection != OUTPUT_ALL), }); |
b112e0f73
|
598 599 600 601 |
} } ## |
1da177e4c
|
602 603 604 605 606 607 608 |
# output function # # parameterdescs, a hash. # function => "function name" # parameterlist => @list of parameters # parameterdescs => %parameter descriptions # sectionlist => @list of sections |
a21217daa
|
609 |
# sections => %section descriptions |
3c3b809e2
|
610 |
# |
1da177e4c
|
611 612 613 614 615 616 617 618 619 620 621 622 |
sub output_highlight { my $contents = join " ",@_; my $line; # DEBUG # if (!defined $contents) { # use Carp; # confess "output_highlight got called with no args? "; # } |
3eb014a10
|
623 624 |
# print STDERR "contents b4:$contents "; |
1da177e4c
|
625 626 |
eval $dohighlight; die $@ if $@; |
3eb014a10
|
627 628 |
# print STDERR "contents af:$contents "; |
1da177e4c
|
629 630 |
foreach $line (split " ", $contents) { |
12ae67793
|
631 632 633 |
if (! $output_preformatted) { $line =~ s/^\s*//; } |
3c308798a
|
634 |
if ($line eq ""){ |
e314ba313
|
635 |
if (! $output_preformatted) { |
0bba924ce
|
636 |
print $lineprefix, $blankline; |
e314ba313
|
637 |
} |
1da177e4c
|
638 |
} else { |
cdccb316c
|
639 640 641 642 643 |
if ($output_mode eq "man" && substr($line, 0, 1) eq ".") { print "\\&$line"; } else { print $lineprefix, $line; } |
1da177e4c
|
644 645 646 647 648 |
} print " "; } } |
1da177e4c
|
649 650 651 652 653 654 655 656 657 658 659 660 |
## # output function in man sub output_function_man(%) { my %args = %{$_[0]}; my ($parameter, $section); my $count; print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX "; print ".SH NAME "; |
b9d97328e
|
661 662 |
print $args{'function'} . " \\- " . $args{'purpose'} . " "; |
1da177e4c
|
663 664 665 |
print ".SH SYNOPSIS "; |
a21217daa
|
666 |
if ($args{'functiontype'} ne "") { |
b9d97328e
|
667 668 |
print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . " "; |
a21217daa
|
669 |
} else { |
b9d97328e
|
670 671 |
print ".B \"" . $args{'function'} . " "; |
a21217daa
|
672 |
} |
1da177e4c
|
673 674 675 676 677 678 679 680 681 682 |
$count = 0; my $parenth = "("; my $post = ","; foreach my $parameter (@{$args{'parameterlist'}}) { if ($count == $#{$args{'parameterlist'}}) { $post = ");"; } $type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function |
ed8348e23
|
683 684 |
print ".BI \"" . $parenth . $1 . "\" " . " \") (" . $2 . ")" . $post . "\" "; |
1da177e4c
|
685 686 |
} else { $type =~ s/([^\*])$/$1 /; |
ed8348e23
|
687 688 |
print ".BI \"" . $parenth . $type . "\" " . " \"" . $post . "\" "; |
1da177e4c
|
689 690 691 692 693 694 695 696 697 698 |
} $count++; $parenth = ""; } print ".SH ARGUMENTS "; foreach $parameter (@{$args{'parameterlist'}}) { my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
b9d97328e
|
699 700 |
print ".IP \"" . $parameter . "\" 12 "; |
1da177e4c
|
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 |
output_highlight($args{'parameterdescs'}{$parameter_name}); } foreach $section (@{$args{'sectionlist'}}) { print ".SH \"", uc $section, "\" "; output_highlight($args{'sections'}{$section}); } } ## # output enum in man sub output_enum_man(%) { my %args = %{$_[0]}; my ($parameter, $section); my $count; print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX "; print ".SH NAME "; |
b9d97328e
|
722 723 |
print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . " "; |
1da177e4c
|
724 725 726 |
print ".SH SYNOPSIS "; |
b9d97328e
|
727 728 |
print "enum " . $args{'enum'} . " { "; |
1da177e4c
|
729 730 |
$count = 0; foreach my $parameter (@{$args{'parameterlist'}}) { |
3c308798a
|
731 732 733 |
print ".br .BI \" $parameter\" "; |
1da177e4c
|
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 |
if ($count == $#{$args{'parameterlist'}}) { print " }; "; last; } else { print ", .br "; } $count++; } print ".SH Constants "; foreach $parameter (@{$args{'parameterlist'}}) { my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
b9d97328e
|
753 754 |
print ".IP \"" . $parameter . "\" 12 "; |
1da177e4c
|
755 756 757 758 759 760 761 762 763 764 765 766 767 768 |
output_highlight($args{'parameterdescs'}{$parameter_name}); } foreach $section (@{$args{'sectionlist'}}) { print ".SH \"$section\" "; output_highlight($args{'sections'}{$section}); } } ## # output struct in man sub output_struct_man(%) { my %args = %{$_[0]}; my ($parameter, $section); |
b9d97328e
|
769 770 |
print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX "; |
1da177e4c
|
771 772 773 |
print ".SH NAME "; |
b9d97328e
|
774 775 |
print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . " "; |
1da177e4c
|
776 |
|
8ad721631
|
777 778 779 780 781 782 |
my $declaration = $args{'definition'}; $declaration =~ s/\t/ /g; $declaration =~ s/ /" .br .BI \"/g; |
1da177e4c
|
783 784 |
print ".SH SYNOPSIS "; |
b9d97328e
|
785 786 787 |
print $args{'type'} . " " . $args{'struct'} . " { .br "; |
8ad721631
|
788 789 790 791 792 |
print ".BI \"$declaration }; .br "; |
1da177e4c
|
793 |
|
c51d3dac3
|
794 795 |
print ".SH Members "; |
1da177e4c
|
796 797 798 799 800 |
foreach $parameter (@{$args{'parameterlist'}}) { ($parameter =~ /^#/) && next; my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
3c308798a
|
801 |
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
b9d97328e
|
802 803 |
print ".IP \"" . $parameter . "\" 12 "; |
1da177e4c
|
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 |
output_highlight($args{'parameterdescs'}{$parameter_name}); } foreach $section (@{$args{'sectionlist'}}) { print ".SH \"$section\" "; output_highlight($args{'sections'}{$section}); } } ## # output typedef in man sub output_typedef_man(%) { my %args = %{$_[0]}; my ($parameter, $section); print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX "; print ".SH NAME "; |
b9d97328e
|
824 825 |
print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . " "; |
1da177e4c
|
826 827 828 829 830 831 832 |
foreach $section (@{$args{'sectionlist'}}) { print ".SH \"$section\" "; output_highlight($args{'sections'}{$section}); } } |
b112e0f73
|
833 |
sub output_blockhead_man(%) { |
1da177e4c
|
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 |
my %args = %{$_[0]}; my ($parameter, $section); my $count; print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX "; foreach $section (@{$args{'sectionlist'}}) { print ".SH \"$section\" "; output_highlight($args{'sections'}{$section}); } } ## |
c0d1b6ee7
|
849 850 851 852 853 854 855 856 857 858 859 860 861 |
# output in restructured text # # # This could use some work; it's used to output the DOC: sections, and # starts by putting out the name of the doc section itself, but that tends # to duplicate a header already in the template file. # sub output_blockhead_rst(%) { my %args = %{$_[0]}; my ($parameter, $section); foreach $section (@{$args{'sectionlist'}}) { |
eab795ddd
|
862 |
next if (defined($nosymbol_table{$section})); |
9e72184b5
|
863 864 865 866 867 |
if ($output_selection != OUTPUT_INCLUDE) { print "**$section** "; } |
0b0f5f29b
|
868 |
print_lineno($section_start_lines{$section}); |
c0d1b6ee7
|
869 870 871 872 873 |
output_highlight_rst($args{'sections'}{$section}); print " "; } } |
af2502904
|
874 875 |
# # Apply the RST highlights to a sub-block of text. |
76dd3e7b6
|
876 |
# |
af2502904
|
877 878 879 |
sub highlight_block($) { # The dohighlight kludge requires the text be called $contents my $contents = shift; |
c0d1b6ee7
|
880 881 |
eval $dohighlight; die $@ if $@; |
af2502904
|
882 883 |
return $contents; } |
c0d1b6ee7
|
884 |
|
af2502904
|
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 |
# # Regexes used only here. # my $sphinx_literal = '^[^.].*::$'; my $sphinx_cblock = '^\.\.\ +code-block::'; sub output_highlight_rst { my $input = join " ",@_; my $output = ""; my $line; my $in_literal = 0; my $litprefix; my $block = ""; foreach $line (split " ",$input) { # # If we're in a literal block, see if we should drop out # of it. Otherwise pass the line straight through unmunged. # if ($in_literal) { if (! ($line =~ /^\s*$/)) { # # If this is the first non-blank line in a literal # block we need to figure out what the proper indent is. # if ($litprefix eq "") { $line =~ /^(\s*)/; $litprefix = '^' . $1; $output .= $line . " "; } elsif (! ($line =~ /$litprefix/)) { $in_literal = 0; } else { $output .= $line . " "; } } else { $output .= $line . " "; } } # # Not in a literal block (or just dropped out) # if (! $in_literal) { $block .= $line . " "; if (($line =~ /$sphinx_literal/) || ($line =~ /$sphinx_cblock/)) { $in_literal = 1; $litprefix = ""; $output .= highlight_block($block); $block = "" } } } if ($block) { $output .= highlight_block($block); } foreach $line (split " ", $output) { |
830066a7a
|
948 949 |
print $lineprefix . $line . " "; |
c0d1b6ee7
|
950 951 952 953 954 955 |
} } sub output_function_rst(%) { my %args = %{$_[0]}; my ($parameter, $section); |
c099ff698
|
956 |
my $oldprefix = $lineprefix; |
82801d065
|
957 |
my $start = ""; |
6e9e41585
|
958 |
my $is_macro = 0; |
82801d065
|
959 |
|
e3ad05fe6
|
960 961 |
if ($sphinx_major < 3) { if ($args{'typedef'}) { |
efa44475b
|
962 963 964 |
print ".. c:type:: ". $args{'function'} . " "; |
e3ad05fe6
|
965 966 967 968 969 970 971 972 973 |
print_lineno($declaration_start_line); print " **Typedef**: "; $lineprefix = ""; output_highlight_rst($args{'purpose'}); $start = " **Syntax** ``"; |
6e9e41585
|
974 |
$is_macro = 1; |
efa44475b
|
975 |
} else { |
e3ad05fe6
|
976 |
print ".. c:function:: "; |
efa44475b
|
977 |
} |
82801d065
|
978 |
} else { |
6e9e41585
|
979 980 981 982 983 984 985 986 |
if ($args{'typedef'} || $args{'functiontype'} eq "") { $is_macro = 1; print ".. c:macro:: ". $args{'function'} . " "; } else { print ".. c:function:: "; } |
e3ad05fe6
|
987 988 989 990 991 992 993 994 995 996 997 998 |
if ($args{'typedef'}) { print_lineno($declaration_start_line); print " **Typedef**: "; $lineprefix = ""; output_highlight_rst($args{'purpose'}); $start = " **Syntax** ``"; } else { |
6e9e41585
|
999 |
print "``" if ($is_macro); |
e3ad05fe6
|
1000 |
} |
82801d065
|
1001 |
} |
c0d1b6ee7
|
1002 |
if ($args{'functiontype'} ne "") { |
82801d065
|
1003 |
$start .= $args{'functiontype'} . " " . $args{'function'} . " ("; |
c0d1b6ee7
|
1004 |
} else { |
82801d065
|
1005 |
$start .= $args{'function'} . " ("; |
c0d1b6ee7
|
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 |
} print $start; my $count = 0; foreach my $parameter (@{$args{'parameterlist'}}) { if ($count ne 0) { print ", "; } $count++; $type = $args{'parametertypes'}{$parameter}; |
a88b1672d
|
1016 |
|
c0d1b6ee7
|
1017 1018 |
if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function |
e8f4ba833
|
1019 |
print $1 . $parameter . ") (" . $2 . ")"; |
c0d1b6ee7
|
1020 |
} else { |
ed8348e23
|
1021 |
print $type; |
c0d1b6ee7
|
1022 1023 |
} } |
6e9e41585
|
1024 1025 1026 1027 |
if ($is_macro) { print ")`` "; |
82801d065
|
1028 |
} else { |
6e9e41585
|
1029 1030 1031 1032 1033 |
print ") "; } if (!$args{'typedef'}) { |
82801d065
|
1034 1035 1036 1037 1038 1039 |
print_lineno($declaration_start_line); $lineprefix = " "; output_highlight_rst($args{'purpose'}); print " "; } |
c0d1b6ee7
|
1040 |
|
ecbcfba12
|
1041 1042 1043 1044 |
print "**Parameters** "; $lineprefix = " "; |
c0d1b6ee7
|
1045 1046 |
foreach $parameter (@{$args{'parameterlist'}}) { my $parameter_name = $parameter; |
ada5f446b
|
1047 |
$parameter_name =~ s/\[.*//; |
c0d1b6ee7
|
1048 1049 1050 |
$type = $args{'parametertypes'}{$parameter}; if ($type ne "") { |
ed8348e23
|
1051 1052 |
print "``$type`` "; |
c0d1b6ee7
|
1053 |
} else { |
ecbcfba12
|
1054 1055 |
print "``$parameter`` "; |
c0d1b6ee7
|
1056 |
} |
0b0f5f29b
|
1057 1058 |
print_lineno($parameterdesc_start_lines{$parameter_name}); |
5e64fa9c4
|
1059 1060 |
if (defined($args{'parameterdescs'}{$parameter_name}) && $args{'parameterdescs'}{$parameter_name} ne $undescribed) { |
c0d1b6ee7
|
1061 |
output_highlight_rst($args{'parameterdescs'}{$parameter_name}); |
c0d1b6ee7
|
1062 |
} else { |
d4b08e0cd
|
1063 1064 |
print " *undescribed* "; |
c0d1b6ee7
|
1065 1066 1067 1068 |
} print " "; } |
c099ff698
|
1069 1070 |
$lineprefix = $oldprefix; |
c0d1b6ee7
|
1071 1072 1073 1074 1075 1076 1077 |
output_section_rst(@_); } sub output_section_rst(%) { my %args = %{$_[0]}; my $section; my $oldprefix = $lineprefix; |
ecbcfba12
|
1078 |
$lineprefix = ""; |
c0d1b6ee7
|
1079 1080 |
foreach $section (@{$args{'sectionlist'}}) { |
ecbcfba12
|
1081 1082 1083 |
print "**$section** "; |
0b0f5f29b
|
1084 |
print_lineno($section_start_lines{$section}); |
c0d1b6ee7
|
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 |
output_highlight_rst($args{'sections'}{$section}); print " "; } print " "; $lineprefix = $oldprefix; } sub output_enum_rst(%) { my %args = %{$_[0]}; my ($parameter); |
c099ff698
|
1097 |
my $oldprefix = $lineprefix; |
c0d1b6ee7
|
1098 |
my $count; |
628509765
|
1099 |
|
efa44475b
|
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 |
if ($sphinx_major < 3) { my $name = "enum " . $args{'enum'}; print " .. c:type:: " . $name . " "; } else { my $name = $args{'enum'}; print " .. c:enum:: " . $name . " "; } |
0b0f5f29b
|
1115 |
print_lineno($declaration_start_line); |
c099ff698
|
1116 1117 1118 1119 |
$lineprefix = " "; output_highlight_rst($args{'purpose'}); print " "; |
c0d1b6ee7
|
1120 |
|
ecbcfba12
|
1121 1122 1123 1124 |
print "**Constants** "; $lineprefix = " "; |
c0d1b6ee7
|
1125 |
foreach $parameter (@{$args{'parameterlist'}}) { |
ecbcfba12
|
1126 1127 |
print "``$parameter`` "; |
c0d1b6ee7
|
1128 1129 1130 |
if ($args{'parameterdescs'}{$parameter} ne $undescribed) { output_highlight_rst($args{'parameterdescs'}{$parameter}); } else { |
d4b08e0cd
|
1131 1132 |
print " *undescribed* "; |
c0d1b6ee7
|
1133 1134 1135 1136 |
} print " "; } |
c099ff698
|
1137 |
|
c0d1b6ee7
|
1138 1139 1140 1141 1142 1143 1144 |
$lineprefix = $oldprefix; output_section_rst(@_); } sub output_typedef_rst(%) { my %args = %{$_[0]}; my ($parameter); |
c099ff698
|
1145 |
my $oldprefix = $lineprefix; |
efa44475b
|
1146 |
my $name; |
c0d1b6ee7
|
1147 |
|
efa44475b
|
1148 1149 1150 1151 1152 |
if ($sphinx_major < 3) { $name = "typedef " . $args{'typedef'}; } else { $name = $args{'typedef'}; } |
628509765
|
1153 1154 1155 1156 1157 |
print " .. c:type:: " . $name . " "; |
0b0f5f29b
|
1158 |
print_lineno($declaration_start_line); |
c099ff698
|
1159 1160 1161 1162 |
$lineprefix = " "; output_highlight_rst($args{'purpose'}); print " "; |
c0d1b6ee7
|
1163 |
|
c099ff698
|
1164 |
$lineprefix = $oldprefix; |
c0d1b6ee7
|
1165 1166 1167 1168 1169 1170 |
output_section_rst(@_); } sub output_struct_rst(%) { my %args = %{$_[0]}; my ($parameter); |
c099ff698
|
1171 |
my $oldprefix = $lineprefix; |
c0d1b6ee7
|
1172 |
|
efa44475b
|
1173 1174 1175 1176 1177 1178 1179 1180 1181 |
if ($sphinx_major < 3) { my $name = $args{'type'} . " " . $args{'struct'}; print " .. c:type:: " . $name . " "; } else { my $name = $args{'struct'}; |
72b97d0b9
|
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 |
if ($args{'type'} eq 'union') { print " .. c:union:: " . $name . " "; } else { print " .. c:struct:: " . $name . " "; } |
efa44475b
|
1195 |
} |
0b0f5f29b
|
1196 |
print_lineno($declaration_start_line); |
c099ff698
|
1197 1198 1199 1200 |
$lineprefix = " "; output_highlight_rst($args{'purpose'}); print " "; |
c0d1b6ee7
|
1201 |
|
ecbcfba12
|
1202 1203 1204 1205 1206 1207 |
print "**Definition** "; print ":: "; |
8ad721631
|
1208 1209 1210 1211 1212 1213 |
my $declaration = $args{'definition'}; $declaration =~ s/\t/ /g; print " " . $args{'type'} . " " . $args{'struct'} . " { $declaration }; "; |
c0d1b6ee7
|
1214 |
|
ecbcfba12
|
1215 1216 1217 1218 |
print "**Members** "; $lineprefix = " "; |
c0d1b6ee7
|
1219 1220 1221 1222 1223 1224 1225 1226 |
foreach $parameter (@{$args{'parameterlist'}}) { ($parameter =~ /^#/) && next; my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; $type = $args{'parametertypes'}{$parameter}; |
0b0f5f29b
|
1227 |
print_lineno($parameterdesc_start_lines{$parameter_name}); |
6d232c801
|
1228 1229 |
print "``" . $parameter . "`` "; |
c0d1b6ee7
|
1230 |
output_highlight_rst($args{'parameterdescs'}{$parameter_name}); |
c0d1b6ee7
|
1231 1232 1233 1234 1235 |
print " "; } print " "; |
c099ff698
|
1236 1237 |
$lineprefix = $oldprefix; |
c0d1b6ee7
|
1238 1239 |
output_section_rst(@_); } |
3a025e1d1
|
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 |
## none mode output functions sub output_function_none(%) { } sub output_enum_none(%) { } sub output_typedef_none(%) { } sub output_struct_none(%) { } sub output_blockhead_none(%) { } |
1da177e4c
|
1256 |
## |
272057447
|
1257 1258 1259 |
# generic output function for all types (function, struct/union, typedef, enum); # calls the generated, variable output_ function name based on # functype and output_mode |
1da177e4c
|
1260 1261 1262 1263 1264 |
sub output_declaration { no strict 'refs'; my $name = shift; my $functype = shift; my $func = "output_${functype}_$output_mode"; |
eab795ddd
|
1265 1266 |
return if (defined($nosymbol_table{$name})); |
b6c3f456c
|
1267 1268 1269 1270 |
if (($output_selection == OUTPUT_ALL) || (($output_selection == OUTPUT_INCLUDE || $output_selection == OUTPUT_EXPORTED) && defined($function_table{$name})) || |
eab795ddd
|
1271 |
($output_selection == OUTPUT_INTERNAL && |
b6c3f456c
|
1272 |
!($functype eq "function" && defined($function_table{$name})))) |
1da177e4c
|
1273 |
{ |
3c308798a
|
1274 |
&$func(@_); |
1da177e4c
|
1275 1276 1277 1278 1279 |
$section_counter++; } } ## |
272057447
|
1280 |
# generic output function - calls the right one based on current output mode. |
b112e0f73
|
1281 |
sub output_blockhead { |
1da177e4c
|
1282 |
no strict 'refs'; |
b9d97328e
|
1283 |
my $func = "output_blockhead_" . $output_mode; |
1da177e4c
|
1284 1285 1286 1287 1288 |
&$func(@_); $section_counter++; } ## |
3c3b809e2
|
1289 |
# takes a declaration (struct, union, enum, typedef) and |
1da177e4c
|
1290 1291 1292 1293 |
# invokes the right handler. NOT called for functions. sub dump_declaration($$) { no strict 'refs'; my ($prototype, $file) = @_; |
b9d97328e
|
1294 |
my $func = "dump_" . $decl_type; |
1da177e4c
|
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 |
&$func(@_); } sub dump_union($$) { dump_struct(@_); } sub dump_struct($$) { my $x = shift; my $file = shift; |
a070991fe
|
1305 |
if ($x =~ /(struct|union)\s+(\w+)\s*\{(.*)\}(\s*(__packed|__aligned|____cacheline_aligned_in_smp|____cacheline_aligned|__attribute__\s*\(\([a-z0-9,_\s\(\)]*\)\)))*/) { |
5cb5c31cd
|
1306 |
my $decl_type = $1; |
3c308798a
|
1307 1308 |
$declaration_name = $2; my $members = $3; |
1da177e4c
|
1309 |
|
aeec46b97
|
1310 |
# ignore members marked private: |
0d8c39e6c
|
1311 1312 |
$members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi; $members =~ s/\/\*\s*private:.*//gosi; |
aeec46b97
|
1313 1314 |
# strip comments: $members =~ s/\/\*.*?\*\///gos; |
ef5da59f1
|
1315 |
# strip attributes |
2b5f78e5e
|
1316 1317 1318 1319 |
$members =~ s/\s*__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)/ /gi; $members =~ s/\s*__aligned\s*\([^;]*\)/ /gos; $members =~ s/\s*__packed\s*/ /gos; $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos; |
f861537d5
|
1320 |
$members =~ s/\s*____cacheline_aligned_in_smp/ /gos; |
a070991fe
|
1321 |
$members =~ s/\s*____cacheline_aligned/ /gos; |
3556108eb
|
1322 |
|
b22b5a9ef
|
1323 |
# replace DECLARE_BITMAP |
3556108eb
|
1324 |
$members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos; |
45005b27c
|
1325 |
$members =~ s/DECLARE_BITMAP\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos; |
1cb566ba5
|
1326 |
# replace DECLARE_HASHTABLE |
45005b27c
|
1327 1328 1329 1330 1331 |
$members =~ s/DECLARE_HASHTABLE\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[1 << (($2) - 1)\]/gos; # replace DECLARE_KFIFO $members =~ s/DECLARE_KFIFO\s*\(([^,)]+),\s*([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos; # replace DECLARE_KFIFO_PTR $members =~ s/DECLARE_KFIFO_PTR\s*\(([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos; |
aeec46b97
|
1332 |
|
8ad721631
|
1333 1334 1335 |
my $declaration = $members; # Split nested struct/union elements as newer ones |
84ce5b987
|
1336 1337 1338 1339 1340 1341 1342 |
while ($members =~ m/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/) { my $newmember; my $maintype = $1; my $ids = $4; my $content = $3; foreach my $id(split /,/, $ids) { $newmember .= "$maintype $id; "; |
8ad721631
|
1343 |
$id =~ s/[:\[].*//; |
84ce5b987
|
1344 |
$id =~ s/^\s*\**(\S+)\s*/$1/; |
8ad721631
|
1345 1346 |
foreach my $arg (split /;/, $content) { next if ($arg =~ m/^\s*$/); |
7c0d7e87a
|
1347 1348 1349 1350 1351 1352 1353 1354 |
if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) { # pointer-to-function my $type = $1; my $name = $2; my $extra = $3; next if (!$name); if ($id =~ m/^\s*$/) { # anonymous struct/union |
84ce5b987
|
1355 |
$newmember .= "$type$name$extra; "; |
7c0d7e87a
|
1356 |
} else { |
84ce5b987
|
1357 |
$newmember .= "$type$id.$name$extra; "; |
7c0d7e87a
|
1358 |
} |
8ad721631
|
1359 |
} else { |
84ce5b987
|
1360 1361 1362 1363 1364 1365 1366 |
my $type; my $names; $arg =~ s/^\s+//; $arg =~ s/\s+$//; # Handle bitmaps $arg =~ s/:\s*\d+\s*//g; # Handle arrays |
d404d5795
|
1367 |
$arg =~ s/\[.*\]//g; |
84ce5b987
|
1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 |
# The type may have multiple words, # and multiple IDs can be defined, like: # const struct foo, *bar, foobar # So, we remove spaces when parsing the # names, in order to match just names # and commas for the names $arg =~ s/\s*,\s*/,/g; if ($arg =~ m/(.*)\s+([\S+,]+)/) { $type = $1; $names = $2; |
7c0d7e87a
|
1378 |
} else { |
84ce5b987
|
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 |
$newmember .= "$arg; "; next; } foreach my $name (split /,/, $names) { $name =~ s/^\s*\**(\S+)\s*/$1/; next if (($name =~ m/^\s*$/)); if ($id =~ m/^\s*$/) { # anonymous struct/union $newmember .= "$type $name; "; } else { $newmember .= "$type $id.$name; "; } |
7c0d7e87a
|
1391 |
} |
8ad721631
|
1392 1393 |
} } |
84ce5b987
|
1394 |
} |
673bb2dfc
|
1395 |
$members =~ s/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/$newmember/; |
84ce5b987
|
1396 |
} |
8ad721631
|
1397 1398 |
# Ignore other nested elements, like enums |
673bb2dfc
|
1399 |
$members =~ s/(\{[^\{\}]*\})//g; |
8ad721631
|
1400 |
|
151c468b4
|
1401 |
create_parameterlist($members, ';', $file, $declaration_name); |
1081de2d2
|
1402 |
check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual); |
1da177e4c
|
1403 |
|
8ad721631
|
1404 |
# Adjust declaration for better display |
673bb2dfc
|
1405 1406 1407 |
$declaration =~ s/([\{;])/$1 /g; $declaration =~ s/\}\s+;/};/g; |
8ad721631
|
1408 |
# Better handle inlined enums |
673bb2dfc
|
1409 1410 1411 |
do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^ ])/$1, $2/); |
8ad721631
|
1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 |
my @def_args = split / /, $declaration; my $level = 1; $declaration = ""; foreach my $clause (@def_args) { $clause =~ s/^\s+//; $clause =~ s/\s+$//; $clause =~ s/\s+/ /; next if (!$clause); |
673bb2dfc
|
1422 |
$level-- if ($clause =~ m/(\})/ && $level > 1); |
8ad721631
|
1423 1424 1425 1426 1427 |
if (!($clause =~ m/^\s*#/)) { $declaration .= "\t" x $level; } $declaration .= "\t" . $clause . " "; |
673bb2dfc
|
1428 |
$level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/)); |
8ad721631
|
1429 |
} |
1da177e4c
|
1430 1431 1432 1433 |
output_declaration($declaration_name, 'struct', {'struct' => $declaration_name, 'module' => $modulename, |
8ad721631
|
1434 |
'definition' => $declaration, |
1da177e4c
|
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 |
'parameterlist' => \@parameterlist, 'parameterdescs' => \%parameterdescs, 'parametertypes' => \%parametertypes, 'sectionlist' => \@sectionlist, 'sections' => \%sections, 'purpose' => $declaration_purpose, 'type' => $decl_type }); } else { |
d40e1e653
|
1445 1446 |
print STDERR "${file}:$.: error: Cannot parse struct or union! "; |
1da177e4c
|
1447 1448 1449 |
++$errors; } } |
85afe608f
|
1450 1451 1452 1453 |
sub show_warnings($$) { my $functype = shift; my $name = shift; |
eab795ddd
|
1454 |
return 0 if (defined($nosymbol_table{$name})); |
85afe608f
|
1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 |
return 1 if ($output_selection == OUTPUT_ALL); if ($output_selection == OUTPUT_EXPORTED) { if (defined($function_table{$name})) { return 1; } else { return 0; } } if ($output_selection == OUTPUT_INTERNAL) { if (!($functype eq "function" && defined($function_table{$name}))) { return 1; } else { return 0; } } if ($output_selection == OUTPUT_INCLUDE) { if (defined($function_table{$name})) { return 1; } else { return 0; } } |
85afe608f
|
1478 1479 |
die("Please add the new output type at show_warnings()"); } |
1da177e4c
|
1480 1481 1482 |
sub dump_enum($$) { my $x = shift; my $file = shift; |
d38c8cfb0
|
1483 |
my $members; |
1da177e4c
|
1484 |
|
aeec46b97
|
1485 |
$x =~ s@/\*.*?\*/@@gos; # strip comments. |
4468e21ee
|
1486 1487 |
# strip #define macros inside enums $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos; |
b6d676db3
|
1488 |
|
d38c8cfb0
|
1489 1490 1491 1492 |
if ($x =~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) { $declaration_name = $2; $members = $1; } elsif ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) { |
3c308798a
|
1493 |
$declaration_name = $1; |
d38c8cfb0
|
1494 1495 |
$members = $2; } |
5c0aa48d0
|
1496 |
if ($members) { |
5cb5c31cd
|
1497 |
my %_members; |
463a0fdc3
|
1498 |
$members =~ s/\s+$//; |
1da177e4c
|
1499 1500 1501 1502 1503 |
foreach my $arg (split ',', $members) { $arg =~ s/^\s*(\w+).*/$1/; push @parameterlist, $arg; if (!$parameterdescs{$arg}) { |
3c308798a
|
1504 |
$parameterdescs{$arg} = $undescribed; |
85afe608f
|
1505 |
if (show_warnings("enum", $declaration_name)) { |
2defb2729
|
1506 1507 1508 |
print STDERR "${file}:$.: warning: Enum value '$arg' not described in enum '$declaration_name' "; } |
1da177e4c
|
1509 |
} |
5cb5c31cd
|
1510 |
$_members{$arg} = 1; |
1da177e4c
|
1511 |
} |
3c3b809e2
|
1512 |
|
5cb5c31cd
|
1513 1514 |
while (my ($k, $v) = each %parameterdescs) { if (!exists($_members{$k})) { |
85afe608f
|
1515 |
if (show_warnings("enum", $declaration_name)) { |
2defb2729
|
1516 1517 1518 |
print STDERR "${file}:$.: warning: Excess enum value '$k' description in '$declaration_name' "; } |
5cb5c31cd
|
1519 1520 |
} } |
1da177e4c
|
1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 |
output_declaration($declaration_name, 'enum', {'enum' => $declaration_name, 'module' => $modulename, 'parameterlist' => \@parameterlist, 'parameterdescs' => \%parameterdescs, 'sectionlist' => \@sectionlist, 'sections' => \%sections, 'purpose' => $declaration_purpose }); |
d38c8cfb0
|
1531 |
} else { |
d40e1e653
|
1532 1533 |
print STDERR "${file}:$.: error: Cannot parse enum! "; |
1da177e4c
|
1534 1535 1536 |
++$errors; } } |
9cee26031
|
1537 |
my $typedef_type = qr { ((?:\s+[\w\*]+\b){1,8})\s* }x; |
7efc6c429
|
1538 1539 1540 1541 1542 |
my $typedef_ident = qr { \*?\s*(\w\S+)\s* }x; my $typedef_args = qr { \s*\((.*)\); }x; my $typedef1 = qr { typedef$typedef_type\($typedef_ident\)$typedef_args }x; my $typedef2 = qr { typedef$typedef_type$typedef_ident$typedef_args }x; |
1da177e4c
|
1543 1544 1545 |
sub dump_typedef($$) { my $x = shift; my $file = shift; |
aeec46b97
|
1546 |
$x =~ s@/\*.*?\*/@@gos; # strip comments. |
1da177e4c
|
1547 |
|
7efc6c429
|
1548 1549 |
# Parse function typedef prototypes if ($x =~ $typedef1 || $x =~ $typedef2) { |
837664528
|
1550 1551 1552 |
$return_type = $1; $declaration_name = $2; my $args = $3; |
6b80975c6
|
1553 |
$return_type =~ s/^\s+//; |
837664528
|
1554 |
|
151c468b4
|
1555 |
create_parameterlist($args, ',', $file, $declaration_name); |
1da177e4c
|
1556 1557 |
output_declaration($declaration_name, |
837664528
|
1558 1559 |
'function', {'function' => $declaration_name, |
82801d065
|
1560 |
'typedef' => 1, |
1da177e4c
|
1561 |
'module' => $modulename, |
837664528
|
1562 1563 1564 1565 |
'functiontype' => $return_type, 'parameterlist' => \@parameterlist, 'parameterdescs' => \%parameterdescs, 'parametertypes' => \%parametertypes, |
1da177e4c
|
1566 1567 1568 1569 |
'sectionlist' => \@sectionlist, 'sections' => \%sections, 'purpose' => $declaration_purpose }); |
837664528
|
1570 1571 1572 1573 1574 1575 |
return; } while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) { $x =~ s/\(*.\)\s*;$/;/; $x =~ s/\[*.\]\s*;$/;/; |
1da177e4c
|
1576 |
} |
837664528
|
1577 1578 |
if ($x =~ /typedef.*\s+(\w+)\s*;/) { |
3a80a7663
|
1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 |
$declaration_name = $1; output_declaration($declaration_name, 'typedef', {'typedef' => $declaration_name, 'module' => $modulename, 'sectionlist' => \@sectionlist, 'sections' => \%sections, 'purpose' => $declaration_purpose }); } |
1da177e4c
|
1590 |
else { |
d40e1e653
|
1591 1592 |
print STDERR "${file}:$.: error: Cannot parse typedef! "; |
1da177e4c
|
1593 1594 1595 |
++$errors; } } |
a1d94aa55
|
1596 1597 1598 1599 1600 1601 1602 |
sub save_struct_actual($) { my $actual = shift; # strip all spaces from the actual param so that it looks like one string item $actual =~ s/\s*//g; $struct_actual = $struct_actual . $actual . " "; } |
151c468b4
|
1603 |
sub create_parameterlist($$$$) { |
1da177e4c
|
1604 1605 1606 |
my $args = shift; my $splitter = shift; my $file = shift; |
151c468b4
|
1607 |
my $declaration_name = shift; |
1da177e4c
|
1608 1609 |
my $type; my $param; |
a6d3fe77d
|
1610 |
# temporarily replace commas inside function pointer definition |
1da177e4c
|
1611 |
while ($args =~ /(\([^\),]+),/) { |
3c308798a
|
1612 |
$args =~ s/(\([^\),]+),/$1#/g; |
1da177e4c
|
1613 |
} |
3c3b809e2
|
1614 |
|
1da177e4c
|
1615 1616 1617 |
foreach my $arg (split($splitter, $args)) { # strip comments $arg =~ s/\/\*.*\*\///; |
3c308798a
|
1618 1619 |
# strip leading/trailing spaces $arg =~ s/^\s*//; |
1da177e4c
|
1620 1621 1622 1623 1624 1625 1626 |
$arg =~ s/\s*$//; $arg =~ s/\s+/ /; if ($arg =~ /^#/) { # Treat preprocessor directive as a typeless variable just to fill # corresponding data structures "correctly". Catch it later in # output_* subs. |
ed8348e23
|
1627 |
push_parameter($arg, "", "", $file); |
00d629614
|
1628 |
} elsif ($arg =~ m/\(.+\)\s*\(/) { |
1da177e4c
|
1629 1630 |
# pointer-to-function $arg =~ tr/#/,/; |
7c0d7e87a
|
1631 |
$arg =~ m/[^\(]+\(\*?\s*([\w\.]*)\s*\)/; |
1da177e4c
|
1632 1633 |
$param = $1; $type = $arg; |
00d629614
|
1634 |
$type =~ s/([^\(]+\(\*?)\s*$param/$1/; |
a1d94aa55
|
1635 |
save_struct_actual($param); |
ed8348e23
|
1636 |
push_parameter($param, $type, $arg, $file, $declaration_name); |
aeec46b97
|
1637 |
} elsif ($arg) { |
1da177e4c
|
1638 1639 1640 1641 1642 1643 1644 |
$arg =~ s/\s*:\s*/:/g; $arg =~ s/\s*\[/\[/g; my @args = split('\s*,\s*', $arg); if ($args[0] =~ m/\*/) { $args[0] =~ s/(\*+)\s*/ $1/; } |
884f2810b
|
1645 1646 1647 1648 1649 1650 1651 1652 1653 |
my @first_arg; if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) { shift @args; push(@first_arg, split('\s+', $1)); push(@first_arg, $2); } else { @first_arg = split('\s+', shift @args); } |
1da177e4c
|
1654 1655 1656 1657 1658 |
unshift(@args, pop @first_arg); $type = join " ", @first_arg; foreach $param (@args) { if ($param =~ m/^(\*+)\s*(.*)/) { |
a1d94aa55
|
1659 |
save_struct_actual($2); |
ed8348e23
|
1660 1661 |
push_parameter($2, "$type $1", $arg, $file, $declaration_name); |
1da177e4c
|
1662 1663 |
} elsif ($param =~ m/(.*?):(\d+)/) { |
7b97887ea
|
1664 |
if ($type ne "") { # skip unnamed bit-fields |
a1d94aa55
|
1665 |
save_struct_actual($1); |
ed8348e23
|
1666 |
push_parameter($1, "$type:$2", $arg, $file, $declaration_name) |
7b97887ea
|
1667 |
} |
1da177e4c
|
1668 1669 |
} else { |
a1d94aa55
|
1670 |
save_struct_actual($param); |
ed8348e23
|
1671 |
push_parameter($param, $type, $arg, $file, $declaration_name); |
1da177e4c
|
1672 1673 1674 1675 1676 |
} } } } } |
ed8348e23
|
1677 |
sub push_parameter($$$$$) { |
1da177e4c
|
1678 1679 |
my $param = shift; my $type = shift; |
ed8348e23
|
1680 |
my $org_arg = shift; |
1da177e4c
|
1681 |
my $file = shift; |
151c468b4
|
1682 |
my $declaration_name = shift; |
1da177e4c
|
1683 |
|
5f8c7c98a
|
1684 1685 1686 1687 1688 1689 |
if (($anon_struct_union == 1) && ($type eq "") && ($param eq "}")) { return; # ignore the ending }; from anon. struct/union } $anon_struct_union = 0; |
f9b5c5304
|
1690 |
$param =~ s/[\[\)].*//; |
1da177e4c
|
1691 |
|
a6d3fe77d
|
1692 |
if ($type eq "" && $param =~ /\.\.\.$/) |
1da177e4c
|
1693 |
{ |
c950a1739
|
1694 1695 1696 1697 |
if (!$param =~ /\w\.\.\.$/) { # handles unnamed variable parameters $param = "..."; } |
43756e347
|
1698 1699 1700 1701 |
elsif ($param =~ /\w\.\.\.$/) { # for named variable parameters of the form `x...`, remove the dots $param =~ s/\.\.\.$//; } |
ced69090c
|
1702 1703 1704 |
if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") { $parameterdescs{$param} = "variable arguments"; } |
1da177e4c
|
1705 1706 1707 |
} elsif ($type eq "" && ($param eq "" or $param eq "void")) { |
1da177e4c
|
1708 1709 1710 |
$param="void"; $parameterdescs{void} = "no arguments"; } |
134fe01bf
|
1711 1712 1713 1714 |
elsif ($type eq "" && ($param eq "struct" or $param eq "union")) # handle unnamed (anonymous) union or struct: { $type = $param; |
5f8c7c98a
|
1715 |
$param = "{unnamed_" . $param . "}"; |
134fe01bf
|
1716 1717 |
$parameterdescs{$param} = "anonymous "; |
5f8c7c98a
|
1718 |
$anon_struct_union = 1; |
134fe01bf
|
1719 |
} |
a6d3fe77d
|
1720 |
# warn if parameter has no description |
134fe01bf
|
1721 1722 |
# (but ignore ones starting with # as these are not parameters # but inline preprocessor statements); |
151c468b4
|
1723 |
# Note: It will also ignore void params and unnamed structs/unions |
f9b5c5304
|
1724 |
if (!defined $parameterdescs{$param} && $param !~ /^#/) { |
151c468b4
|
1725 |
$parameterdescs{$param} = $undescribed; |
a6d3fe77d
|
1726 |
|
be5cd20c9
|
1727 |
if (show_warnings($type, $declaration_name) && $param !~ /\./) { |
2defb2729
|
1728 1729 1730 1731 1732 |
print STDERR "${file}:$.: warning: Function parameter or member '$param' not described in '$declaration_name' "; ++$warnings; } |
3c308798a
|
1733 |
} |
1da177e4c
|
1734 |
|
25985edce
|
1735 |
# strip spaces from $param so that it is one continuous string |
e34e7dbb3
|
1736 1737 1738 1739 1740 1741 1742 1743 |
# on @parameterlist; # this fixes a problem where check_sections() cannot find # a parameter like "addr[6 + 2]" because it actually appears # as "addr[6", "+", "2]" on the parameter list; # but it's better to maintain the param string unchanged for output, # so just weaken the string compare in check_sections() to ignore # "[blah" in a parameter string; ###$param =~ s/\s*//g; |
1da177e4c
|
1744 |
push @parameterlist, $param; |
ed8348e23
|
1745 1746 |
$org_arg =~ s/\s\s+/ /g; $parametertypes{$param} = $org_arg; |
1da177e4c
|
1747 |
} |
1081de2d2
|
1748 1749 |
sub check_sections($$$$$) { my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_; |
a1d94aa55
|
1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 |
my @sects = split ' ', $sectcheck; my @prms = split ' ', $prmscheck; my $err; my ($px, $sx); my $prm_clean; # strip trailing "[array size]" and/or beginning "*" foreach $sx (0 .. $#sects) { $err = 1; foreach $px (0 .. $#prms) { $prm_clean = $prms[$px]; $prm_clean =~ s/\[.*\]//; |
1f3a66889
|
1761 |
$prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i; |
e34e7dbb3
|
1762 1763 1764 1765 1766 1767 1768 |
# ignore array size in a parameter string; # however, the original param string may contain # spaces, e.g.: addr[6 + 2] # and this appears in @prms as "addr[6" since the # parameter list is split at spaces; # hence just ignore "[..." for the sections check; $prm_clean =~ s/\[.*//; |
a1d94aa55
|
1769 1770 1771 1772 1773 1774 1775 1776 |
##$prm_clean =~ s/^\**//; if ($prm_clean eq $sects[$sx]) { $err = 0; last; } } if ($err) { if ($decl_type eq "function") { |
d40e1e653
|
1777 |
print STDERR "${file}:$.: warning: " . |
a1d94aa55
|
1778 1779 1780 1781 1782 |
"Excess function parameter " . "'$sects[$sx]' " . "description in '$decl_name' "; ++$warnings; |
a1d94aa55
|
1783 1784 1785 1786 |
} } } } |
1da177e4c
|
1787 |
## |
4092bac77
|
1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 |
# Checks the section describing the return value of a function. sub check_return_section { my $file = shift; my $declaration_name = shift; my $return_type = shift; # Ignore an empty return type (It's a macro) # Ignore functions with a "void" return type. (But don't ignore "void *") if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) { return; } if (!defined($sections{$section_return}) || $sections{$section_return} eq "") { |
d40e1e653
|
1802 |
print STDERR "${file}:$.: warning: " . |
4092bac77
|
1803 1804 1805 1806 1807 1808 1809 1810 |
"No description found for return value of " . "'$declaration_name' "; ++$warnings; } } ## |
1da177e4c
|
1811 1812 1813 1814 1815 1816 |
# takes a function prototype and the name of the current file being # processed and spits out all the details stored in the global # arrays/hashes. sub dump_function($$) { my $prototype = shift; my $file = shift; |
cbb4d3e65
|
1817 |
my $noret = 0; |
1da177e4c
|
1818 |
|
5ef09c96d
|
1819 |
print_lineno($new_start_line); |
5eb6b4b3e
|
1820 |
|
1da177e4c
|
1821 1822 |
$prototype =~ s/^static +//; $prototype =~ s/^extern +//; |
4dc3b16ba
|
1823 |
$prototype =~ s/^asmlinkage +//; |
1da177e4c
|
1824 1825 |
$prototype =~ s/^inline +//; $prototype =~ s/^__inline__ +//; |
32e794015
|
1826 1827 1828 |
$prototype =~ s/^__inline +//; $prototype =~ s/^__always_inline +//; $prototype =~ s/^noinline +//; |
74fc5c653
|
1829 |
$prototype =~ s/__init +//; |
20072205f
|
1830 |
$prototype =~ s/__init_or_module +//; |
270a00963
|
1831 |
$prototype =~ s/__meminit +//; |
70c95b00b
|
1832 |
$prototype =~ s/__must_check +//; |
0df7c0e3a
|
1833 |
$prototype =~ s/__weak +//; |
0891f9599
|
1834 |
$prototype =~ s/__sched +//; |
95e760cbf
|
1835 |
$prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//; |
cbb4d3e65
|
1836 |
my $define = $prototype =~ s/^#\s*define\s+//; #ak added |
b1aaa546b
|
1837 1838 1839 1840 1841 1842 1843 |
$prototype =~ s/__attribute__\s*\(\( (?: [\w\s]++ # attribute name (?:\([^)]*+\))? # attribute arguments \s*+,? # optional comma at the end )+ \)\)\s+//x; |
1da177e4c
|
1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 |
# Yes, this truly is vile. We are looking for: # 1. Return type (may be nothing if we're looking at a macro) # 2. Function name # 3. Function parameters. # # All the while we have to watch out for function pointer parameters # (which IIRC is what the two sections are for), C types (these # regexps don't even start to express all the possibilities), and # so on. # # If you mess with these regexps, it's a good idea to check that # the following functions' documentation still comes out right: # - parport_register_device (function pointer parameters) # - atomic_set (macro) |
9598f91f2
|
1859 |
# - pci_match_device, __copy_to_user (long return type) |
1da177e4c
|
1860 |
|
cbb4d3e65
|
1861 1862 1863 1864 1865 1866 1867 1868 1869 |
if ($define && $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s+/) { # This is an object-like macro, it has no return type and no parameter # list. # Function-like macros are not allowed to have spaces between # declaration_name and opening parenthesis (notice the \s+). $return_type = $1; $declaration_name = $2; $noret = 1; } elsif ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || |
1da177e4c
|
1870 |
$prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || |
5a0bc578e
|
1871 |
$prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || |
1da177e4c
|
1872 |
$prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || |
94b3e03c8
|
1873 |
$prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || |
1da177e4c
|
1874 |
$prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || |
5a0bc578e
|
1875 |
$prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || |
1da177e4c
|
1876 1877 |
$prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || |
5a0bc578e
|
1878 |
$prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || |
1da177e4c
|
1879 |
$prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || |
5a0bc578e
|
1880 |
$prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || |
1da177e4c
|
1881 |
$prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || |
5a0bc578e
|
1882 |
$prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || |
9598f91f2
|
1883 |
$prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || |
5a0bc578e
|
1884 1885 |
$prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || $prototype =~ m/^(\w+\s+\w+\s*\*+\s*\w+\s*\*+\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) { |
1da177e4c
|
1886 1887 1888 |
$return_type = $1; $declaration_name = $2; my $args = $3; |
151c468b4
|
1889 |
create_parameterlist($args, ',', $file, $declaration_name); |
1da177e4c
|
1890 |
} else { |
d40e1e653
|
1891 1892 |
print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype' "; |
1da177e4c
|
1893 1894 |
return; } |
47bcacfd2
|
1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 |
my $prms = join " ", @parameterlist; check_sections($file, $declaration_name, "function", $sectcheck, $prms); # This check emits a lot of warnings at the moment, because many # functions don't have a 'Return' doc section. So until the number # of warnings goes sufficiently down, the check is only performed in # verbose mode. # TODO: always perform the check. if ($verbose && !$noret) { check_return_section($file, $declaration_name, $return_type); } |
4092bac77
|
1906 |
|
47bcacfd2
|
1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 |
# The function parser can be called with a typedef parameter. # Handle it. if ($return_type =~ /typedef/) { output_declaration($declaration_name, 'function', {'function' => $declaration_name, 'typedef' => 1, 'module' => $modulename, 'functiontype' => $return_type, 'parameterlist' => \@parameterlist, 'parameterdescs' => \%parameterdescs, 'parametertypes' => \%parametertypes, 'sectionlist' => \@sectionlist, 'sections' => \%sections, 'purpose' => $declaration_purpose }); } else { output_declaration($declaration_name, 'function', {'function' => $declaration_name, 'module' => $modulename, 'functiontype' => $return_type, 'parameterlist' => \@parameterlist, 'parameterdescs' => \%parameterdescs, 'parametertypes' => \%parametertypes, 'sectionlist' => \@sectionlist, 'sections' => \%sections, 'purpose' => $declaration_purpose }); } |
1da177e4c
|
1937 |
} |
1da177e4c
|
1938 1939 |
sub reset_state { $function = ""; |
1da177e4c
|
1940 1941 1942 1943 1944 |
%parameterdescs = (); %parametertypes = (); @parameterlist = (); %sections = (); @sectionlist = (); |
a1d94aa55
|
1945 1946 |
$sectcheck = ""; $struct_actual = ""; |
1da177e4c
|
1947 |
$prototype = ""; |
3c3b809e2
|
1948 |
|
48af606ad
|
1949 1950 |
$state = STATE_NORMAL; $inline_doc_state = STATE_INLINE_NA; |
1da177e4c
|
1951 |
} |
56afb0f88
|
1952 1953 1954 1955 |
sub tracepoint_munge($) { my $file = shift; my $tracepointname = 0; my $tracepointargs = 0; |
3a9089fd7
|
1956 |
if ($prototype =~ m/TRACE_EVENT\((.*?),/) { |
56afb0f88
|
1957 1958 |
$tracepointname = $1; } |
3a9089fd7
|
1959 1960 1961 1962 1963 1964 1965 1966 |
if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) { $tracepointname = $1; } if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) { $tracepointname = $2; } $tracepointname =~ s/^\s+//; #strip leading whitespace if ($prototype =~ m/TP_PROTO\((.*?)\)/) { |
56afb0f88
|
1967 1968 1969 |
$tracepointargs = $1; } if (($tracepointname eq 0) || ($tracepointargs eq 0)) { |
d40e1e653
|
1970 1971 |
print STDERR "${file}:$.: warning: Unrecognized tracepoint format: ". |
56afb0f88
|
1972 1973 1974 1975 1976 1977 |
"$prototype "; } else { $prototype = "static inline void trace_$tracepointname($tracepointargs)"; } } |
b4870bc5e
|
1978 1979 |
sub syscall_munge() { my $void = 0; |
7c9aa0157
|
1980 1981 |
$prototype =~ s@[\r ]+@ @gos; # strip newlines/CR's |
b4870bc5e
|
1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 |
## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) { if ($prototype =~ m/SYSCALL_DEFINE0/) { $void = 1; ## $prototype = "long sys_$1(void)"; } $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name if ($prototype =~ m/long (sys_.*?),/) { $prototype =~ s/,/\(/; } elsif ($void) { $prototype =~ s/\)/\(void\)/; } # now delete all of the odd-number commas in $prototype # so that arg types & arg names don't have a comma between them my $count = 0; my $len = length($prototype); if ($void) { $len = 0; # skip the for-loop } for (my $ix = 0; $ix < $len; $ix++) { if (substr($prototype, $ix, 1) eq ',') { $count++; if ($count % 2 == 1) { substr($prototype, $ix, 1) = ' '; } } } } |
b7afa92b5
|
2011 |
sub process_proto_function($$) { |
1da177e4c
|
2012 2013 |
my $x = shift; my $file = shift; |
51f5a0c8f
|
2014 |
$x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line |
890c78c2d
|
2015 |
if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) { |
1da177e4c
|
2016 2017 2018 |
# do nothing } elsif ($x =~ /([^\{]*)/) { |
3c308798a
|
2019 |
$prototype .= $1; |
1da177e4c
|
2020 |
} |
b4870bc5e
|
2021 |
|
890c78c2d
|
2022 |
if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) { |
3c308798a
|
2023 |
$prototype =~ s@/\*.*?\*/@@gos; # strip comments. |
1da177e4c
|
2024 2025 2026 |
$prototype =~ s@[\r ]+@ @gos; # strip newlines/cr's. $prototype =~ s@^\s+@@gos; # strip leading spaces |
7ae281b05
|
2027 2028 2029 2030 |
# Handle prototypes for function pointers like: # int (*pcs_config)(struct foo) $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos; |
b4870bc5e
|
2031 2032 2033 |
if ($prototype =~ /SYSCALL_DEFINE/) { syscall_munge(); } |
3a9089fd7
|
2034 2035 2036 |
if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ || $prototype =~ /DEFINE_SINGLE_EVENT/) { |
56afb0f88
|
2037 2038 |
tracepoint_munge($file); } |
b4870bc5e
|
2039 |
dump_function($prototype, $file); |
1da177e4c
|
2040 2041 2042 |
reset_state(); } } |
b7afa92b5
|
2043 |
sub process_proto_type($$) { |
1da177e4c
|
2044 2045 |
my $x = shift; my $file = shift; |
1da177e4c
|
2046 2047 2048 2049 |
$x =~ s@[\r ]+@ @gos; # strip newlines/cr's. $x =~ s@^\s+@@gos; # strip leading spaces $x =~ s@\s+$@@gos; # strip trailing spaces |
51f5a0c8f
|
2050 |
$x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line |
1da177e4c
|
2051 2052 2053 2054 2055 2056 |
if ($x =~ /^#/) { # To distinguish preprocessor directive from regular declaration later. $x .= ";"; } while (1) { |
673bb2dfc
|
2057 |
if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) { |
463a0fdc3
|
2058 2059 2060 |
if( length $prototype ) { $prototype .= " " } |
1da177e4c
|
2061 2062 2063 2064 |
$prototype .= $1 . $2; ($2 eq '{') && $brcount++; ($2 eq '}') && $brcount--; if (($2 eq ';') && ($brcount == 0)) { |
b9d97328e
|
2065 |
dump_declaration($prototype, $file); |
1da177e4c
|
2066 |
reset_state(); |
3c308798a
|
2067 |
last; |
1da177e4c
|
2068 2069 |
} $x = $3; |
3c308798a
|
2070 |
} else { |
1da177e4c
|
2071 2072 2073 2074 2075 |
$prototype .= $x; last; } } } |
6b5b55f6c
|
2076 |
|
1ad560e43
|
2077 |
sub map_filename($) { |
2283a117f
|
2078 |
my $file; |
68f866623
|
2079 |
my ($orig_file) = @_; |
1da177e4c
|
2080 |
|
2283a117f
|
2081 |
if (defined($ENV{'SRCTREE'})) { |
68f866623
|
2082 |
$file = "$ENV{'SRCTREE'}" . "/" . $orig_file; |
1ad560e43
|
2083 |
} else { |
68f866623
|
2084 |
$file = $orig_file; |
2283a117f
|
2085 |
} |
1ad560e43
|
2086 |
|
1da177e4c
|
2087 2088 2089 |
if (defined($source_map{$file})) { $file = $source_map{$file}; } |
1ad560e43
|
2090 2091 |
return $file; } |
88c2b57da
|
2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 |
sub process_export_file($) { my ($orig_file) = @_; my $file = map_filename($orig_file); if (!open(IN,"<$file")) { print STDERR "Error: Cannot open file $file "; ++$errors; return; } while (<IN>) { if (/$export_symbol/) { |
eab795ddd
|
2105 |
next if (defined($nosymbol_table{$2})); |
88c2b57da
|
2106 2107 2108 2109 2110 2111 |
$function_table{$2} = 1; } } close(IN); } |
07048d131
|
2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 |
# # Parsers for the various processing states. # # STATE_NORMAL: looking for the /** to begin everything. # sub process_normal() { if (/$doc_start/o) { $state = STATE_NAME; # next line is always the function name $in_doc_sect = 0; $declaration_start_line = $. + 1; } } |
3cac2bc41
|
2124 2125 2126 2127 2128 |
# # STATE_NAME: Looking for the "name - description" line # sub process_name($$) { my $file = shift; |
1ad560e43
|
2129 |
my $identifier; |
1ad560e43
|
2130 |
my $descr; |
3cac2bc41
|
2131 2132 2133 2134 |
if (/$doc_block/o) { $state = STATE_DOCBLOCK; $contents = ""; |
5ef09c96d
|
2135 |
$new_start_line = $.; |
3cac2bc41
|
2136 2137 2138 2139 2140 2141 2142 2143 2144 |
if ( $1 eq "" ) { $section = $section_intro; } else { $section = $1; } } elsif (/$doc_decl/o) { $identifier = $1; |
fcdf1df20
|
2145 |
if (/\s*([\w\s]+?)(\(\))?\s*-/) { |
3cac2bc41
|
2146 2147 |
$identifier = $1; } |
07048d131
|
2148 |
|
3cac2bc41
|
2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 |
$state = STATE_BODY; # if there's no @param blocks need to set up default section # here $contents = ""; $section = $section_default; $new_start_line = $. + 1; if (/-(.*)/) { # strip leading/trailing/multiple spaces $descr= $1; $descr =~ s/^\s*//; $descr =~ s/\s*$//; $descr =~ s/\s+/ /g; $declaration_purpose = $descr; $state = STATE_BODY_MAYBE; } else { $declaration_purpose = ""; } if (($declaration_purpose eq "") && $verbose) { print STDERR "${file}:$.: warning: missing initial short description on line: "; print STDERR $_; ++$warnings; } |
cf419d542
|
2173 |
if ($identifier =~ m/^struct\b/) { |
3cac2bc41
|
2174 |
$decl_type = 'struct'; |
cf419d542
|
2175 |
} elsif ($identifier =~ m/^union\b/) { |
3cac2bc41
|
2176 |
$decl_type = 'union'; |
cf419d542
|
2177 |
} elsif ($identifier =~ m/^enum\b/) { |
3cac2bc41
|
2178 |
$decl_type = 'enum'; |
cf419d542
|
2179 |
} elsif ($identifier =~ m/^typedef\b/) { |
3cac2bc41
|
2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 |
$decl_type = 'typedef'; } else { $decl_type = 'function'; } if ($verbose) { print STDERR "${file}:$.: info: Scanning doc for $identifier "; } } else { print STDERR "${file}:$.: warning: Cannot understand $_ on line $.", " - I thought it was a doc line "; ++$warnings; $state = STATE_NORMAL; } } |
07048d131
|
2197 |
|
d742f24d6
|
2198 2199 2200 2201 2202 2203 |
# # STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment. # sub process_body($$) { my $file = shift; |
43756e347
|
2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 |
# Until all named variable macro parameters are # documented using the bare name (`x`) rather than with # dots (`x...`), strip the dots: if ($section =~ /\w\.\.\.$/) { $section =~ s/\.\.\.$//; if ($verbose) { print STDERR "${file}:$.: warning: Variable macro arguments should be documented without dots "; ++$warnings; } } |
0d55d48b1
|
2216 2217 2218 |
if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) { dump_section($file, $section, $contents); $section = $section_default; |
5ef09c96d
|
2219 |
$new_start_line = $.; |
0d55d48b1
|
2220 2221 |
$contents = ""; } |
d742f24d6
|
2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 |
if (/$doc_sect/i) { # case insensitive for supported section names $newsection = $1; $newcontents = $2; # map the supported section names to the canonical names if ($newsection =~ m/^description$/i) { $newsection = $section_default; } elsif ($newsection =~ m/^context$/i) { $newsection = $section_context; } elsif ($newsection =~ m/^returns?$/i) { $newsection = $section_return; } elsif ($newsection =~ m/^\@return$/) { # special: @return is a section, not a param description $newsection = $section_return; } if (($contents ne "") && ($contents ne " ")) { if (!$in_doc_sect && $verbose) { print STDERR "${file}:$.: warning: contents before sections "; ++$warnings; } dump_section($file, $section, $contents); $section = $section_default; } $in_doc_sect = 1; $state = STATE_BODY; $contents = $newcontents; $new_start_line = $.; while (substr($contents, 0, 1) eq " ") { $contents = substr($contents, 1); } if ($contents ne "") { $contents .= " "; } $section = $newsection; $leading_space = undef; } elsif (/$doc_end/) { if (($contents ne "") && ($contents ne " ")) { dump_section($file, $section, $contents); $section = $section_default; $contents = ""; } # look for doc_com + <text> + doc_end: if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') { print STDERR "${file}:$.: warning: suspicious ending line: $_"; ++$warnings; } $prototype = ""; $state = STATE_PROTO; $brcount = 0; |
5ef09c96d
|
2278 |
$new_start_line = $. + 1; |
d742f24d6
|
2279 |
} elsif (/$doc_content/) { |
d742f24d6
|
2280 |
if ($1 eq "") { |
0d55d48b1
|
2281 |
if ($section eq $section_context) { |
d742f24d6
|
2282 2283 2284 2285 |
dump_section($file, $section, $contents); $section = $section_default; $contents = ""; $new_start_line = $.; |
0d55d48b1
|
2286 |
$state = STATE_BODY; |
d742f24d6
|
2287 |
} else { |
0d55d48b1
|
2288 2289 2290 2291 2292 |
if ($section ne $section_default) { $state = STATE_BODY_WITH_BLANK_LINE; } else { $state = STATE_BODY; } |
d742f24d6
|
2293 2294 2295 |
$contents .= " "; } |
d742f24d6
|
2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 |
} elsif ($state == STATE_BODY_MAYBE) { # Continued declaration purpose chomp($declaration_purpose); $declaration_purpose .= " " . $1; $declaration_purpose =~ s/\s+/ /g; } else { my $cont = $1; if ($section =~ m/^@/ || $section eq $section_context) { if (!defined $leading_space) { if ($cont =~ m/^(\s+)/) { $leading_space = $1; } else { $leading_space = ""; } } $cont =~ s/^$leading_space//; } $contents .= $cont . " "; } } else { # i dont know - bad line? ignore. print STDERR "${file}:$.: warning: bad line: $_"; ++$warnings; } } |
cc794812e
|
2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 |
# # STATE_PROTO: reading a function/whatever prototype. # sub process_proto($$) { my $file = shift; if (/$doc_inline_oneline/) { $section = $1; $contents = $2; if ($contents ne "") { $contents .= " "; dump_section($file, $section, $contents); $section = $section_default; $contents = ""; } } elsif (/$doc_inline_start/) { $state = STATE_INLINE; $inline_doc_state = STATE_INLINE_NAME; } elsif ($decl_type eq 'function') { process_proto_function($_, $file); } else { process_proto_type($_, $file); } } |
c17add56c
|
2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 |
# # STATE_DOCBLOCK: within a DOC: block. # sub process_docblock($$) { my $file = shift; if (/$doc_end/) { dump_doc_section($file, $section, $contents); $section = $section_default; $contents = ""; $function = ""; %parameterdescs = (); %parametertypes = (); @parameterlist = (); %sections = (); @sectionlist = (); $prototype = ""; $state = STATE_NORMAL; } elsif (/$doc_content/) { if ( $1 eq "" ) { $contents .= $blankline; } else { $contents .= $1 . " "; } } } # # STATE_INLINE: docbook comments within a prototype. # sub process_inline($$) { my $file = shift; # First line (state 1) needs to be a @parameter if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) { $section = $1; $contents = $2; $new_start_line = $.; if ($contents ne "") { while (substr($contents, 0, 1) eq " ") { $contents = substr($contents, 1); } $contents .= " "; } $inline_doc_state = STATE_INLINE_TEXT; # Documentation block end */ } elsif (/$doc_inline_end/) { if (($contents ne "") && ($contents ne " ")) { dump_section($file, $section, $contents); $section = $section_default; $contents = ""; } $state = STATE_PROTO; $inline_doc_state = STATE_INLINE_NA; # Regular text } elsif (/$doc_content/) { if ($inline_doc_state == STATE_INLINE_TEXT) { $contents .= $1 . " "; # nuke leading blank lines if ($contents =~ /^\s*$/) { $contents = ""; } } elsif ($inline_doc_state == STATE_INLINE_NAME) { $inline_doc_state = STATE_INLINE_ERROR; print STDERR "${file}:$.: warning: "; print STDERR "Incorrect use of kernel-doc format: $_"; ++$warnings; } } } |
cc794812e
|
2421 |
|
1ad560e43
|
2422 2423 |
sub process_file($) { my $file; |
1ad560e43
|
2424 2425 |
my $initial_section_counter = $section_counter; my ($orig_file) = @_; |
1ad560e43
|
2426 2427 |
$file = map_filename($orig_file); |
dbe8ba00e
|
2428 |
if (!open(IN_FILE,"<$file")) { |
1da177e4c
|
2429 2430 2431 2432 2433 |
print STDERR "Error: Cannot open file $file "; ++$errors; return; } |
a9e7314b7
|
2434 |
$. = 1; |
1da177e4c
|
2435 |
$section_counter = 0; |
dbe8ba00e
|
2436 |
while (<IN_FILE>) { |
654784284
|
2437 |
while (s/\\\s*$//) { |
dbe8ba00e
|
2438 |
$_ .= <IN_FILE>; |
654784284
|
2439 |
} |
7c9aa0157
|
2440 2441 |
# Replace tabs by spaces while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {}; |
c17add56c
|
2442 |
# Hand this line to the appropriate state handler |
48af606ad
|
2443 |
if ($state == STATE_NORMAL) { |
07048d131
|
2444 |
process_normal(); |
3cac2bc41
|
2445 2446 |
} elsif ($state == STATE_NAME) { process_name($file, $_); |
0d55d48b1
|
2447 2448 |
} elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE || $state == STATE_BODY_WITH_BLANK_LINE) { |
d742f24d6
|
2449 |
process_body($file, $_); |
48af606ad
|
2450 |
} elsif ($state == STATE_INLINE) { # scanning for inline parameters |
c17add56c
|
2451 |
process_inline($file, $_); |
cc794812e
|
2452 2453 |
} elsif ($state == STATE_PROTO) { process_proto($file, $_); |
48af606ad
|
2454 |
} elsif ($state == STATE_DOCBLOCK) { |
c17add56c
|
2455 |
process_docblock($file, $_); |
3c308798a
|
2456 |
} |
1da177e4c
|
2457 |
} |
c17add56c
|
2458 2459 |
# Make sure we got something interesting. |
b0d60bfbb
|
2460 2461 2462 2463 2464 2465 |
if ($initial_section_counter == $section_counter && $ output_mode ne "none") { if ($output_selection == OUTPUT_INCLUDE) { print STDERR "${file}:1: warning: '$_' not found " for keys %function_table; |
3a025e1d1
|
2466 |
} |
b0d60bfbb
|
2467 2468 2469 |
else { print STDERR "${file}:1: warning: no structured comments found "; |
e946c43a1
|
2470 |
} |
1da177e4c
|
2471 |
} |
dbe8ba00e
|
2472 |
close IN_FILE; |
1da177e4c
|
2473 |
} |
8484baaa5
|
2474 |
|
93351d419
|
2475 2476 2477 |
if ($output_mode eq "rst") { get_sphinx_version() if (!$sphinx_major); } |
8484baaa5
|
2478 2479 2480 2481 |
$kernelversion = get_kernel_version(); # generate a sequence of code that will splice in highlighting information # using the s// operator. |
1ef062337
|
2482 |
for (my $k = 0; $k < @highlights; $k++) { |
4d7327019
|
2483 2484 2485 2486 2487 2488 |
my $pattern = $highlights[$k][0]; my $result = $highlights[$k][1]; # print STDERR "scanning pattern:$pattern, highlight:($result) "; $dohighlight .= "\$contents =~ s:$pattern:$result:gs; "; |
8484baaa5
|
2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 |
} # Read the file that maps relative names to absolute names for # separate source and object directories and for shadow trees. if (open(SOURCE_MAP, "<.tmp_filelist.txt")) { my ($relname, $absname); while(<SOURCE_MAP>) { chop(); ($relname, $absname) = (split())[0..1]; $relname =~ s:^/+::; $source_map{$relname} = $absname; } close(SOURCE_MAP); } |
88c2b57da
|
2503 2504 |
if ($output_selection == OUTPUT_EXPORTED || $output_selection == OUTPUT_INTERNAL) { |
c9b2cfb3f
|
2505 2506 |
push(@export_file_list, @ARGV); |
88c2b57da
|
2507 2508 2509 2510 2511 |
foreach (@export_file_list) { chomp; process_export_file($_); } } |
8484baaa5
|
2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 |
foreach (@ARGV) { chomp; process_file($_); } if ($verbose && $errors) { print STDERR "$errors errors "; } if ($verbose && $warnings) { print STDERR "$warnings warnings "; } |
2c12c8103
|
2524 2525 2526 2527 2528 2529 2530 |
if ($Werror && $warnings) { print STDERR "$warnings warnings as Errors "; exit($warnings); } else { exit($output_mode eq "none" ? 0 : $errors) } |