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