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