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