5 ## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ##
6 ## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ##
7 ## Copyright (C) 2001 Simon Huggins ##
8 ## Copyright (C) 2005-2012 Randy Dunlap ##
9 ## Copyright (C) 2012 Dan Luedtke ##
11 ## #define enhancements by Armin Kuster <akuster@mvista.com> ##
12 ## Copyright (c) 2000 MontaVista Software, Inc. ##
14 ## This software falls under the GNU General Public License. ##
15 ## Please read the COPYING file for more information ##
17 # 18/01/2001 - Cleanups
18 # Functions prototyped as foo(void) same as foo()
19 # Stop eval'ing where we don't need to.
22 # 27/06/2001 - Allowed whitespace after initial "/**" and
23 # allowed comments before function declarations.
24 # -- Christian Kreibich <ck@whoop.org>
27 # - add perldoc documentation
28 # - Look more closely at some of the scarier bits :)
30 # 26/05/2001 - Support for separate source and object trees.
32 # Keith Owens <kaos@ocs.com.au>
34 # 23/09/2001 - Added support for typedefs, structs, enums and unions
35 # Support for Context section; can be terminated using empty line
36 # Small fixes (like spaces vs. \s in regex)
37 # -- Tim Jansen <tim@tjansen.de>
39 # 25/07/2012 - Added support for HTML5
40 # -- Dan Luedtke <mail@danrl.de>
43 my $message = <<"EOF";
44 Usage: $0 [OPTION ...] FILE ...
46 Read C language source or header FILEs, extract embedded documentation comments,
47 and print formatted documentation to standard output.
49 The documentation comments are identified by "/**" opening comment mark. See
50 Documentation/kernel-doc-nano-HOWTO.txt for the documentation comment syntax.
52 Output format selection (mutually exclusive):
53 -docbook Output DocBook format.
54 -html Output HTML format.
55 -html5 Output HTML5 format.
56 -list Output symbol list format. This is for use by docproc.
57 -man Output troff manual page format. This is the default.
58 -rst Output reStructuredText format.
59 -text Output plain text format.
61 Output selection (mutually exclusive):
62 -export Only output documentation for symbols that have been
63 exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
64 in any input FILE or -export-file FILE.
65 -internal Only output documentation for symbols that have NOT been
66 exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
67 in any input FILE or -export-file FILE.
68 -function NAME Only output documentation for the given function(s)
69 or DOC: section title(s). All other functions and DOC:
70 sections are ignored. May be specified multiple times.
71 -nofunction NAME Do NOT output documentation for the given function(s);
72 only output documentation for the other functions and
73 DOC: sections. May be specified multiple times.
75 Output selection modifiers:
76 -no-doc-sections Do not output DOC: sections.
77 -enable-lineno Enable output of #define LINENO lines. Only works with
78 reStructuredText format.
79 -export-file FILE Specify an additional FILE in which to look for
80 EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be used with
81 -export or -internal. May be specified multiple times.
84 -v Verbose output, more warnings and other information.
94 # In the following table, (...)? signifies optional structure.
95 # (...)* signifies 0 or more structure elements
97 # * function_name(:)? (- short description)?
98 # (* @parameterx: (description of parameter x)?)*
100 # * (Description:)? (Description of function)?
101 # * (section header: (section description)? )*
104 # So .. the trivial example would be:
110 # If the Description: header tag is omitted, then there must be a blank line
111 # after the last parameter specification.
114 # * my_function - does my stuff
115 # * @my_arg: its mine damnit
117 # * Does my stuff explained.
120 # or, could also use:
122 # * my_function - does my stuff
123 # * @my_arg: its mine damnit
124 # * Description: Does my stuff explained.
128 # Besides functions you can also write documentation for structs, unions,
129 # enums and typedefs. Instead of the function name you must write the name
130 # of the declaration; the struct/union/enum/typedef must always precede
131 # the name. Nesting of declarations is not supported.
132 # Use the argument mechanism to document members or constants.
135 # * struct my_struct - short description
137 # * @b: second member
139 # * Longer description
148 # All descriptions can be multiline, except the short function description.
150 # For really longs structs, you can also describe arguments inside the
151 # body of the struct.
154 # * struct my_struct - short description
156 # * @b: second member
158 # * Longer description
164 # * @c: This is longer description of C
166 # * You can use paragraphs to describe arguments
167 # * using this method.
172 # This should be use only for struct/enum members.
174 # You can also add additional sections. When documenting kernel functions you
175 # should document the "Context:" of the function, e.g. whether the functions
176 # can be called form interrupts. Unlike other sections you can end it with an
178 # A non-void function should have a "Return:" section describing the return
180 # Example-sections should contain the string EXAMPLE so that they are marked
181 # appropriately in DocBook.
185 # * user_function - function that can only be called in user context
186 # * @a: some argument
187 # * Context: !in_interrupt()
191 # * user_function(22);
196 # All descriptive text is further processed, scanning for the following special
197 # patterns, which are highlighted appropriately.
199 # 'funcname()' - function
200 # '$ENVVAR' - environmental variable
201 # '&struct_name' - name of a structure (up to two words including 'struct')
202 # '&struct_name.member' - name of a structure member
203 # '@parameter' - name of a parameter
204 # '%CONST' - name of a constant.
205 # '``LITERAL``' - literal string without any spaces on it.
211 my $anon_struct_union = 0;
213 # match expressions used to find embedded type information
214 my $type_constant = '\b``([^\`]+)``\b';
215 my $type_constant2 = '\%([-_\w]+)';
216 my $type_func = '(\w+)\(\)';
217 my $type_param = '\@(\w+(\.\.\.)?)';
218 my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params
219 my $type_env = '(\$\w+)';
220 my $type_enum = '\&(enum\s*([_\w]+))';
221 my $type_struct = '\&(struct\s*([_\w]+))';
222 my $type_typedef = '\&(typedef\s*([_\w]+))';
223 my $type_union = '\&(union\s*([_\w]+))';
224 my $type_member = '\&([_\w]+)(\.|->)([_\w]+)';
225 my $type_fallback = '\&([_\w]+)';
226 my $type_enum_xml = '\&(enum\s*([_\w]+))';
227 my $type_struct_xml = '\&(struct\s*([_\w]+))';
228 my $type_typedef_xml = '\&(typedef\s*([_\w]+))';
229 my $type_union_xml = '\&(union\s*([_\w]+))';
230 my $type_member_xml = '\&([_\w]+)(\.|-\>)([_\w]+)';
231 my $type_fallback_xml = '\&([_\w]+)';
232 my $type_member_func = $type_member . '\(\)';
234 # Output conversion substitutions.
235 # One for each output format
237 # these work fairly well
238 my @highlights_html = (
239 [$type_constant, "<i>\$1</i>"],
240 [$type_constant2, "<i>\$1</i>"],
241 [$type_func, "<b>\$1</b>"],
242 [$type_enum_xml, "<i>\$1</i>"],
243 [$type_struct_xml, "<i>\$1</i>"],
244 [$type_typedef_xml, "<i>\$1</i>"],
245 [$type_union_xml, "<i>\$1</i>"],
246 [$type_env, "<b><i>\$1</i></b>"],
247 [$type_param, "<tt><b>\$1</b></tt>"],
248 [$type_member_xml, "<tt><i>\$1</i>\$2\$3</tt>"],
249 [$type_fallback_xml, "<i>\$1</i>"]
251 my $local_lt = "\\\\\\\\lt:";
252 my $local_gt = "\\\\\\\\gt:";
253 my $blankline_html = $local_lt . "p" . $local_gt; # was "<p>"
256 my @highlights_html5 = (
257 [$type_constant, "<span class=\"const\">\$1</span>"],
258 [$type_constant2, "<span class=\"const\">\$1</span>"],
259 [$type_func, "<span class=\"func\">\$1</span>"],
260 [$type_enum_xml, "<span class=\"enum\">\$1</span>"],
261 [$type_struct_xml, "<span class=\"struct\">\$1</span>"],
262 [$type_typedef_xml, "<span class=\"typedef\">\$1</span>"],
263 [$type_union_xml, "<span class=\"union\">\$1</span>"],
264 [$type_env, "<span class=\"env\">\$1</span>"],
265 [$type_param, "<span class=\"param\">\$1</span>]"],
266 [$type_member_xml, "<span class=\"literal\"><span class=\"struct\">\$1</span>\$2<span class=\"member\">\$3</span></span>"],
267 [$type_fallback_xml, "<span class=\"struct\">\$1</span>"]
269 my $blankline_html5 = $local_lt . "br /" . $local_gt;
271 # XML, docbook format
272 my @highlights_xml = (
273 ["([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>"],
274 [$type_constant, "<constant>\$1</constant>"],
275 [$type_constant2, "<constant>\$1</constant>"],
276 [$type_enum_xml, "<type>\$1</type>"],
277 [$type_struct_xml, "<structname>\$1</structname>"],
278 [$type_typedef_xml, "<type>\$1</type>"],
279 [$type_union_xml, "<structname>\$1</structname>"],
280 [$type_param, "<parameter>\$1</parameter>"],
281 [$type_func, "<function>\$1</function>"],
282 [$type_env, "<envar>\$1</envar>"],
283 [$type_member_xml, "<literal><structname>\$1</structname>\$2<structfield>\$3</structfield></literal>"],
284 [$type_fallback_xml, "<structname>\$1</structname>"]
286 my $blankline_xml = $local_lt . "/para" . $local_gt . $local_lt . "para" . $local_gt . "\n";
288 # gnome, docbook format
289 my @highlights_gnome = (
290 [$type_constant, "<replaceable class=\"option\">\$1</replaceable>"],
291 [$type_constant2, "<replaceable class=\"option\">\$1</replaceable>"],
292 [$type_func, "<function>\$1</function>"],
293 [$type_enum, "<type>\$1</type>"],
294 [$type_struct, "<structname>\$1</structname>"],
295 [$type_typedef, "<type>\$1</type>"],
296 [$type_union, "<structname>\$1</structname>"],
297 [$type_env, "<envar>\$1</envar>"],
298 [$type_param, "<parameter>\$1</parameter>" ],
299 [$type_member, "<literal><structname>\$1</structname>\$2<structfield>\$3</structfield></literal>"],
300 [$type_fallback, "<structname>\$1</structname>"]
302 my $blankline_gnome = "</para><para>\n";
304 # these are pretty rough
305 my @highlights_man = (
306 [$type_constant, "\$1"],
307 [$type_constant2, "\$1"],
308 [$type_func, "\\\\fB\$1\\\\fP"],
309 [$type_enum, "\\\\fI\$1\\\\fP"],
310 [$type_struct, "\\\\fI\$1\\\\fP"],
311 [$type_typedef, "\\\\fI\$1\\\\fP"],
312 [$type_union, "\\\\fI\$1\\\\fP"],
313 [$type_param, "\\\\fI\$1\\\\fP"],
314 [$type_member, "\\\\fI\$1\$2\$3\\\\fP"],
315 [$type_fallback, "\\\\fI\$1\\\\fP"]
317 my $blankline_man = "";
320 my @highlights_text = (
321 [$type_constant, "\$1"],
322 [$type_constant2, "\$1"],
325 [$type_struct, "\$1"],
326 [$type_typedef, "\$1"],
327 [$type_union, "\$1"],
328 [$type_param, "\$1"],
329 [$type_member, "\$1\$2\$3"],
330 [$type_fallback, "\$1"]
332 my $blankline_text = "";
335 my @highlights_rst = (
336 [$type_constant, "``\$1``"],
337 [$type_constant2, "``\$1``"],
338 # Note: need to escape () to avoid func matching later
339 [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\\\\) <\$1>`"],
340 [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"],
341 [$type_fp_param, "**\$1\\\\(\\\\)**"],
342 [$type_func, "\\:c\\:func\\:`\$1()`"],
343 [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"],
344 [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"],
345 [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"],
346 [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"],
347 # in rst this can refer to any type
348 [$type_fallback, "\\:c\\:type\\:`\$1`"],
349 [$type_param, "**\$1**"]
351 my $blankline_rst = "\n";
354 my @highlights_list = (
355 [$type_constant, "\$1"],
356 [$type_constant2, "\$1"],
359 [$type_struct, "\$1"],
360 [$type_typedef, "\$1"],
361 [$type_union, "\$1"],
362 [$type_param, "\$1"],
363 [$type_member, "\$1"],
364 [$type_fallback, "\$1"]
366 my $blankline_list = "";
374 my $dohighlight = "";
377 my $output_mode = "man";
378 my $output_preformatted = 0;
379 my $no_doc_sections = 0;
380 my $enable_lineno = 0;
381 my @highlights = @highlights_man;
382 my $blankline = $blankline_man;
383 my $modulename = "Kernel API";
386 OUTPUT_ALL => 0, # output all symbols and doc sections
387 OUTPUT_INCLUDE => 1, # output only specified symbols
388 OUTPUT_EXCLUDE => 2, # output everything except specified symbols
389 OUTPUT_EXPORTED => 3, # output exported symbols
390 OUTPUT_INTERNAL => 4, # output non-exported symbols
392 my $output_selection = OUTPUT_ALL;
393 my $show_not_found = 0;
395 my @export_file_list;
398 if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) &&
399 (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') {
400 @build_time = gmtime($seconds);
402 @build_time = localtime;
405 my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
406 'July', 'August', 'September', 'October',
407 'November', 'December')[$build_time[4]] .
408 " " . ($build_time[5]+1900);
410 # Essentially these are globals.
411 # They probably want to be tidied up, made more localised or something.
412 # CAVEAT EMPTOR! Some of the others I localised may not want to be, which
413 # could cause "use of undefined value" or other bugs.
414 my ($function, %function_table, %parametertypes, $declaration_purpose);
415 my $declaration_start_line;
416 my ($type, $declaration_name, $return_type);
417 my ($newsection, $newcontents, $prototype, $brcount, %source_map);
419 if (defined($ENV{'KBUILD_VERBOSE'})) {
420 $verbose = "$ENV{'KBUILD_VERBOSE'}";
423 # Generated docbook code is inserted in a template at a point where
424 # docbook v3.1 requires a non-zero sequence of RefEntry's; see:
425 # http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
426 # We keep track of number of generated entries and generate a dummy
427 # if needs be to ensure the expanded template can be postprocessed
429 my $section_counter = 0;
435 STATE_NORMAL => 0, # normal code
436 STATE_NAME => 1, # looking for function name
437 STATE_FIELD => 2, # scanning field start
438 STATE_PROTO => 3, # scanning prototype
439 STATE_DOCBLOCK => 4, # documentation block
440 STATE_INLINE => 5, # gathering documentation outside main block
445 # Inline documentation state
447 STATE_INLINE_NA => 0, # not applicable ($state != STATE_INLINE)
448 STATE_INLINE_NAME => 1, # looking for member name (@foo:)
449 STATE_INLINE_TEXT => 2, # looking for member documentation
450 STATE_INLINE_END => 3, # done
451 STATE_INLINE_ERROR => 4, # error - Comment without header was found.
452 # Spit a warning as it's not
453 # proper kernel-doc and ignore the rest.
455 my $inline_doc_state;
457 #declaration types: can be
458 # 'function', 'struct', 'union', 'enum', 'typedef'
461 my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
463 my $doc_com = '\s*\*\s*';
464 my $doc_com_body = '\s*\* ?';
465 my $doc_decl = $doc_com . '(\w+)';
466 # @params and a strictly limited set of supported section names
467 my $doc_sect = $doc_com .
468 '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:(.*)';
469 my $doc_content = $doc_com_body . '(.*)';
470 my $doc_block = $doc_com . 'DOC:\s*(.*)?';
471 my $doc_inline_start = '^\s*/\*\*\s*$';
472 my $doc_inline_sect = '\s*\*\s*(@[\w\s]+):(.*)';
473 my $doc_inline_end = '^\s*\*/\s*$';
474 my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$';
475 my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';
478 my %parameterdesc_start_lines;
482 my %section_start_lines;
487 my $new_start_line = 0;
489 # the canonical section names. see also $doc_sect above.
490 my $section_default = "Description"; # default section
491 my $section_intro = "Introduction";
492 my $section = $section_default;
493 my $section_context = "Context";
494 my $section_return = "Return";
496 my $undescribed = "-- undescribed --";
500 while ($ARGV[0] =~ m/^-(.*)/) {
501 my $cmd = shift @ARGV;
502 if ($cmd eq "-html") {
503 $output_mode = "html";
504 @highlights = @highlights_html;
505 $blankline = $blankline_html;
506 } elsif ($cmd eq "-html5") {
507 $output_mode = "html5";
508 @highlights = @highlights_html5;
509 $blankline = $blankline_html5;
510 } elsif ($cmd eq "-man") {
511 $output_mode = "man";
512 @highlights = @highlights_man;
513 $blankline = $blankline_man;
514 } elsif ($cmd eq "-text") {
515 $output_mode = "text";
516 @highlights = @highlights_text;
517 $blankline = $blankline_text;
518 } elsif ($cmd eq "-rst") {
519 $output_mode = "rst";
520 @highlights = @highlights_rst;
521 $blankline = $blankline_rst;
522 } elsif ($cmd eq "-docbook") {
523 $output_mode = "xml";
524 @highlights = @highlights_xml;
525 $blankline = $blankline_xml;
526 } elsif ($cmd eq "-list") {
527 $output_mode = "list";
528 @highlights = @highlights_list;
529 $blankline = $blankline_list;
530 } elsif ($cmd eq "-gnome") {
531 $output_mode = "gnome";
532 @highlights = @highlights_gnome;
533 $blankline = $blankline_gnome;
534 } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document
535 $modulename = shift @ARGV;
536 } elsif ($cmd eq "-function") { # to only output specific functions
537 $output_selection = OUTPUT_INCLUDE;
538 $function = shift @ARGV;
539 $function_table{$function} = 1;
540 } elsif ($cmd eq "-nofunction") { # output all except specific functions
541 $output_selection = OUTPUT_EXCLUDE;
542 $function = shift @ARGV;
543 $function_table{$function} = 1;
544 } elsif ($cmd eq "-export") { # only exported symbols
545 $output_selection = OUTPUT_EXPORTED;
546 %function_table = ();
547 } elsif ($cmd eq "-internal") { # only non-exported symbols
548 $output_selection = OUTPUT_INTERNAL;
549 %function_table = ();
550 } elsif ($cmd eq "-export-file") {
551 my $file = shift @ARGV;
552 push(@export_file_list, $file);
553 } elsif ($cmd eq "-v") {
555 } elsif (($cmd eq "-h") || ($cmd eq "--help")) {
557 } elsif ($cmd eq '-no-doc-sections') {
558 $no_doc_sections = 1;
559 } elsif ($cmd eq '-enable-lineno') {
561 } elsif ($cmd eq '-show-not-found') {
566 # continue execution near EOF;
568 # get kernel version from env
569 sub get_kernel_version() {
570 my $version = 'unknown kernel version';
572 if (defined($ENV{'KERNELVERSION'})) {
573 $version = $ENV{'KERNELVERSION'};
581 if ($enable_lineno && defined($lineno)) {
582 print "#define LINENO " . $lineno . "\n";
586 # dumps section contents to arrays/hashes intended for that purpose.
591 my $contents = join "\n", @_;
593 if ($name =~ m/$type_param/) {
595 $parameterdescs{$name} = $contents;
596 $sectcheck = $sectcheck . $name . " ";
597 $parameterdesc_start_lines{$name} = $new_start_line;
599 } elsif ($name eq "@\.\.\.") {
601 $parameterdescs{$name} = $contents;
602 $sectcheck = $sectcheck . $name . " ";
603 $parameterdesc_start_lines{$name} = $new_start_line;
606 if (defined($sections{$name}) && ($sections{$name} ne "")) {
607 # Only warn on user specified duplicate section names.
608 if ($name ne $section_default) {
609 print STDERR "${file}:$.: warning: duplicate section name '$name'\n";
612 $sections{$name} .= $contents;
614 $sections{$name} = $contents;
615 push @sectionlist, $name;
616 $section_start_lines{$name} = $new_start_line;
623 # dump DOC: section after checking that it should go out
625 sub dump_doc_section {
628 my $contents = join "\n", @_;
630 if ($no_doc_sections) {
634 if (($output_selection == OUTPUT_ALL) ||
635 ($output_selection == OUTPUT_INCLUDE &&
636 defined($function_table{$name})) ||
637 ($output_selection == OUTPUT_EXCLUDE &&
638 !defined($function_table{$name})))
640 dump_section($file, $name, $contents);
641 output_blockhead({'sectionlist' => \@sectionlist,
642 'sections' => \%sections,
643 'module' => $modulename,
644 'content-only' => ($output_selection != OUTPUT_ALL), });
651 # parameterdescs, a hash.
652 # function => "function name"
653 # parameterlist => @list of parameters
654 # parameterdescs => %parameter descriptions
655 # sectionlist => @list of sections
656 # sections => %section descriptions
659 sub output_highlight {
660 my $contents = join "\n",@_;
664 # if (!defined $contents) {
666 # confess "output_highlight got called with no args?\n";
669 if ($output_mode eq "html" || $output_mode eq "html5" ||
670 $output_mode eq "xml") {
671 $contents = local_unescape($contents);
672 # convert data read & converted thru xml_escape() into &xyz; format:
673 $contents =~ s/\\\\\\/\&/g;
675 # print STDERR "contents b4:$contents\n";
678 # print STDERR "contents af:$contents\n";
680 # strip whitespaces when generating html5
681 if ($output_mode eq "html5") {
682 $contents =~ s/^\s+//;
683 $contents =~ s/\s+$//;
685 foreach $line (split "\n", $contents) {
686 if (! $output_preformatted) {
690 if (! $output_preformatted) {
691 print $lineprefix, local_unescape($blankline);
694 $line =~ s/\\\\\\/\&/g;
695 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
698 print $lineprefix, $line;
705 # output sections in html
706 sub output_section_html(%) {
710 foreach $section (@{$args{'sectionlist'}}) {
711 print "<h3>$section</h3>\n";
712 print "<blockquote>\n";
713 output_highlight($args{'sections'}{$section});
714 print "</blockquote>\n";
718 # output enum in html
719 sub output_enum_html(%) {
723 print "<h2>enum " . $args{'enum'} . "</h2>\n";
725 print "<b>enum " . $args{'enum'} . "</b> {<br>\n";
727 foreach $parameter (@{$args{'parameterlist'}}) {
728 print " <b>" . $parameter . "</b>";
729 if ($count != $#{$args{'parameterlist'}}) {
737 print "<h3>Constants</h3>\n";
739 foreach $parameter (@{$args{'parameterlist'}}) {
740 print "<dt><b>" . $parameter . "</b>\n";
742 output_highlight($args{'parameterdescs'}{$parameter});
745 output_section_html(@_);
749 # output typedef in html
750 sub output_typedef_html(%) {
754 print "<h2>typedef " . $args{'typedef'} . "</h2>\n";
756 print "<b>typedef " . $args{'typedef'} . "</b>\n";
757 output_section_html(@_);
761 # output struct in html
762 sub output_struct_html(%) {
766 print "<h2>" . $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "</h2>\n";
767 print "<b>" . $args{'type'} . " " . $args{'struct'} . "</b> {<br>\n";
768 foreach $parameter (@{$args{'parameterlist'}}) {
769 if ($parameter =~ /^#/) {
770 print "$parameter<br>\n";
773 my $parameter_name = $parameter;
774 $parameter_name =~ s/\[.*//;
776 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
777 $type = $args{'parametertypes'}{$parameter};
778 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
779 # pointer-to-function
780 print " <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>\n";
781 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
783 print " <i>$1</i> <b>$parameter</b>$2;<br>\n";
785 print " <i>$type</i> <b>$parameter</b>;<br>\n";
790 print "<h3>Members</h3>\n";
792 foreach $parameter (@{$args{'parameterlist'}}) {
793 ($parameter =~ /^#/) && next;
795 my $parameter_name = $parameter;
796 $parameter_name =~ s/\[.*//;
798 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
799 print "<dt><b>" . $parameter . "</b>\n";
801 output_highlight($args{'parameterdescs'}{$parameter_name});
804 output_section_html(@_);
808 # output function in html
809 sub output_function_html(%) {
811 my ($parameter, $section);
814 print "<h2>" . $args{'function'} . " - " . $args{'purpose'} . "</h2>\n";
815 print "<i>" . $args{'functiontype'} . "</i>\n";
816 print "<b>" . $args{'function'} . "</b>\n";
819 foreach $parameter (@{$args{'parameterlist'}}) {
820 $type = $args{'parametertypes'}{$parameter};
821 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
822 # pointer-to-function
823 print "<i>$1</i><b>$parameter</b>) <i>($2)</i>";
825 print "<i>" . $type . "</i> <b>" . $parameter . "</b>";
827 if ($count != $#{$args{'parameterlist'}}) {
834 print "<h3>Arguments</h3>\n";
836 foreach $parameter (@{$args{'parameterlist'}}) {
837 my $parameter_name = $parameter;
838 $parameter_name =~ s/\[.*//;
840 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
841 print "<dt><b>" . $parameter . "</b>\n";
843 output_highlight($args{'parameterdescs'}{$parameter_name});
846 output_section_html(@_);
850 # output DOC: block header in html
851 sub output_blockhead_html(%) {
853 my ($parameter, $section);
856 foreach $section (@{$args{'sectionlist'}}) {
857 print "<h3>$section</h3>\n";
859 output_highlight($args{'sections'}{$section});
865 # output sections in html5
866 sub output_section_html5(%) {
870 foreach $section (@{$args{'sectionlist'}}) {
872 print "<h1>$section</h1>\n";
874 output_highlight($args{'sections'}{$section});
876 print "</section>\n";
880 # output enum in html5
881 sub output_enum_html5(%) {
887 $html5id = $args{'enum'};
888 $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
889 print "<article class=\"enum\" id=\"enum:". $html5id . "\">";
890 print "<h1>enum " . $args{'enum'} . "</h1>\n";
891 print "<ol class=\"code\">\n";
893 print "<span class=\"keyword\">enum</span> ";
894 print "<span class=\"identifier\">" . $args{'enum'} . "</span> {";
897 foreach $parameter (@{$args{'parameterlist'}}) {
898 print "<li class=\"indent\">";
899 print "<span class=\"param\">" . $parameter . "</span>";
900 if ($count != $#{$args{'parameterlist'}}) {
906 print "<li>};</li>\n";
910 print "<h1>Constants</h1>\n";
912 foreach $parameter (@{$args{'parameterlist'}}) {
913 print "<dt>" . $parameter . "</dt>\n";
915 output_highlight($args{'parameterdescs'}{$parameter});
919 print "</section>\n";
920 output_section_html5(@_);
921 print "</article>\n";
924 # output typedef in html5
925 sub output_typedef_html5(%) {
931 $html5id = $args{'typedef'};
932 $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
933 print "<article class=\"typedef\" id=\"typedef:" . $html5id . "\">\n";
934 print "<h1>typedef " . $args{'typedef'} . "</h1>\n";
936 print "<ol class=\"code\">\n";
938 print "<span class=\"keyword\">typedef</span> ";
939 print "<span class=\"identifier\">" . $args{'typedef'} . "</span>";
942 output_section_html5(@_);
943 print "</article>\n";
946 # output struct in html5
947 sub output_struct_html5(%) {
952 $html5id = $args{'struct'};
953 $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
954 print "<article class=\"struct\" id=\"struct:" . $html5id . "\">\n";
956 print "<h1>" . $args{'type'} . " " . $args{'struct'} . "</h1>";
957 print "<h2>". $args{'purpose'} . "</h2>\n";
959 print "<ol class=\"code\">\n";
961 print "<span class=\"type\">" . $args{'type'} . "</span> ";
962 print "<span class=\"identifier\">" . $args{'struct'} . "</span> {";
964 foreach $parameter (@{$args{'parameterlist'}}) {
965 print "<li class=\"indent\">";
966 if ($parameter =~ /^#/) {
967 print "<span class=\"param\">" . $parameter ."</span>\n";
971 my $parameter_name = $parameter;
972 $parameter_name =~ s/\[.*//;
974 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
975 $type = $args{'parametertypes'}{$parameter};
976 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
977 # pointer-to-function
978 print "<span class=\"type\">$1</span> ";
979 print "<span class=\"param\">$parameter</span>";
980 print "<span class=\"type\">)</span> ";
981 print "(<span class=\"args\">$2</span>);";
982 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
984 print "<span class=\"type\">$1</span> ";
985 print "<span class=\"param\">$parameter</span>";
986 print "<span class=\"bits\">$2</span>;";
988 print "<span class=\"type\">$type</span> ";
989 print "<span class=\"param\">$parameter</span>;";
993 print "<li>};</li>\n";
997 print "<h1>Members</h1>\n";
999 foreach $parameter (@{$args{'parameterlist'}}) {
1000 ($parameter =~ /^#/) && next;
1002 my $parameter_name = $parameter;
1003 $parameter_name =~ s/\[.*//;
1005 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1006 print "<dt>" . $parameter . "</dt>\n";
1008 output_highlight($args{'parameterdescs'}{$parameter_name});
1012 print "</section>\n";
1013 output_section_html5(@_);
1014 print "</article>\n";
1017 # output function in html5
1018 sub output_function_html5(%) {
1019 my %args = %{$_[0]};
1020 my ($parameter, $section);
1024 $html5id = $args{'function'};
1025 $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
1026 print "<article class=\"function\" id=\"func:". $html5id . "\">\n";
1028 print "<h1>" . $args{'function'} . "</h1>";
1029 print "<h2>" . $args{'purpose'} . "</h2>\n";
1030 print "</hgroup>\n";
1031 print "<ol class=\"code\">\n";
1033 print "<span class=\"type\">" . $args{'functiontype'} . "</span> ";
1034 print "<span class=\"identifier\">" . $args{'function'} . "</span> (";
1037 foreach $parameter (@{$args{'parameterlist'}}) {
1038 print "<li class=\"indent\">";
1039 $type = $args{'parametertypes'}{$parameter};
1040 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1041 # pointer-to-function
1042 print "<span class=\"type\">$1</span> ";
1043 print "<span class=\"param\">$parameter</span>";
1044 print "<span class=\"type\">)</span> ";
1045 print "(<span class=\"args\">$2</span>)";
1047 print "<span class=\"type\">$type</span> ";
1048 print "<span class=\"param\">$parameter</span>";
1050 if ($count != $#{$args{'parameterlist'}}) {
1056 print "<li>)</li>\n";
1059 print "<section>\n";
1060 print "<h1>Arguments</h1>\n";
1063 foreach $parameter (@{$args{'parameterlist'}}) {
1064 my $parameter_name = $parameter;
1065 $parameter_name =~ s/\[.*//;
1067 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1068 print "<dt>" . $parameter . "</dt>\n";
1070 output_highlight($args{'parameterdescs'}{$parameter_name});
1074 print "</section>\n";
1075 output_section_html5(@_);
1076 print "</article>\n";
1079 # output DOC: block header in html5
1080 sub output_blockhead_html5(%) {
1081 my %args = %{$_[0]};
1082 my ($parameter, $section);
1086 foreach $section (@{$args{'sectionlist'}}) {
1087 $html5id = $section;
1088 $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
1089 print "<article class=\"doc\" id=\"doc:". $html5id . "\">\n";
1090 print "<h1>$section</h1>\n";
1092 output_highlight($args{'sections'}{$section});
1095 print "</article>\n";
1098 sub output_section_xml(%) {
1099 my %args = %{$_[0]};
1101 # print out each section
1103 foreach $section (@{$args{'sectionlist'}}) {
1104 print "<refsect1>\n";
1105 print "<title>$section</title>\n";
1106 if ($section =~ m/EXAMPLE/i) {
1107 print "<informalexample><programlisting>\n";
1108 $output_preformatted = 1;
1112 output_highlight($args{'sections'}{$section});
1113 $output_preformatted = 0;
1114 if ($section =~ m/EXAMPLE/i) {
1115 print "</programlisting></informalexample>\n";
1119 print "</refsect1>\n";
1123 # output function in XML DocBook
1124 sub output_function_xml(%) {
1125 my %args = %{$_[0]};
1126 my ($parameter, $section);
1130 $id = "API-" . $args{'function'};
1131 $id =~ s/[^A-Za-z0-9]/-/g;
1133 print "<refentry id=\"$id\">\n";
1134 print "<refentryinfo>\n";
1135 print " <title>LINUX</title>\n";
1136 print " <productname>Kernel Hackers Manual</productname>\n";
1137 print " <date>$man_date</date>\n";
1138 print "</refentryinfo>\n";
1139 print "<refmeta>\n";
1140 print " <refentrytitle><phrase>" . $args{'function'} . "</phrase></refentrytitle>\n";
1141 print " <manvolnum>9</manvolnum>\n";
1142 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
1143 print "</refmeta>\n";
1144 print "<refnamediv>\n";
1145 print " <refname>" . $args{'function'} . "</refname>\n";
1146 print " <refpurpose>\n";
1148 output_highlight ($args{'purpose'});
1149 print " </refpurpose>\n";
1150 print "</refnamediv>\n";
1152 print "<refsynopsisdiv>\n";
1153 print " <title>Synopsis</title>\n";
1154 print " <funcsynopsis><funcprototype>\n";
1155 print " <funcdef>" . $args{'functiontype'} . " ";
1156 print "<function>" . $args{'function'} . " </function></funcdef>\n";
1159 if ($#{$args{'parameterlist'}} >= 0) {
1160 foreach $parameter (@{$args{'parameterlist'}}) {
1161 $type = $args{'parametertypes'}{$parameter};
1162 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1163 # pointer-to-function
1164 print " <paramdef>$1<parameter>$parameter</parameter>)\n";
1165 print " <funcparams>$2</funcparams></paramdef>\n";
1167 print " <paramdef>" . $type;
1168 print " <parameter>$parameter</parameter></paramdef>\n";
1174 print " </funcprototype></funcsynopsis>\n";
1175 print "</refsynopsisdiv>\n";
1178 print "<refsect1>\n <title>Arguments</title>\n";
1179 if ($#{$args{'parameterlist'}} >= 0) {
1180 print " <variablelist>\n";
1181 foreach $parameter (@{$args{'parameterlist'}}) {
1182 my $parameter_name = $parameter;
1183 $parameter_name =~ s/\[.*//;
1184 $type = $args{'parametertypes'}{$parameter};
1186 print " <varlistentry>\n <term><parameter>$type $parameter</parameter></term>\n";
1187 print " <listitem>\n <para>\n";
1189 output_highlight($args{'parameterdescs'}{$parameter_name});
1190 print " </para>\n </listitem>\n </varlistentry>\n";
1192 print " </variablelist>\n";
1194 print " <para>\n None\n </para>\n";
1196 print "</refsect1>\n";
1198 output_section_xml(@_);
1199 print "</refentry>\n\n";
1202 # output struct in XML DocBook
1203 sub output_struct_xml(%) {
1204 my %args = %{$_[0]};
1205 my ($parameter, $section);
1208 $id = "API-struct-" . $args{'struct'};
1209 $id =~ s/[^A-Za-z0-9]/-/g;
1211 print "<refentry id=\"$id\">\n";
1212 print "<refentryinfo>\n";
1213 print " <title>LINUX</title>\n";
1214 print " <productname>Kernel Hackers Manual</productname>\n";
1215 print " <date>$man_date</date>\n";
1216 print "</refentryinfo>\n";
1217 print "<refmeta>\n";
1218 print " <refentrytitle><phrase>" . $args{'type'} . " " . $args{'struct'} . "</phrase></refentrytitle>\n";
1219 print " <manvolnum>9</manvolnum>\n";
1220 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
1221 print "</refmeta>\n";
1222 print "<refnamediv>\n";
1223 print " <refname>" . $args{'type'} . " " . $args{'struct'} . "</refname>\n";
1224 print " <refpurpose>\n";
1226 output_highlight ($args{'purpose'});
1227 print " </refpurpose>\n";
1228 print "</refnamediv>\n";
1230 print "<refsynopsisdiv>\n";
1231 print " <title>Synopsis</title>\n";
1232 print " <programlisting>\n";
1233 print $args{'type'} . " " . $args{'struct'} . " {\n";
1234 foreach $parameter (@{$args{'parameterlist'}}) {
1235 if ($parameter =~ /^#/) {
1236 my $prm = $parameter;
1237 # convert data read & converted thru xml_escape() into &xyz; format:
1238 # This allows us to have #define macros interspersed in a struct.
1239 $prm =~ s/\\\\\\/\&/g;
1244 my $parameter_name = $parameter;
1245 $parameter_name =~ s/\[.*//;
1247 defined($args{'parameterdescs'}{$parameter_name}) || next;
1248 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1249 $type = $args{'parametertypes'}{$parameter};
1250 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1251 # pointer-to-function
1252 print " $1 $parameter) ($2);\n";
1253 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1255 print " $1 $parameter$2;\n";
1257 print " " . $type . " " . $parameter . ";\n";
1261 print " </programlisting>\n";
1262 print "</refsynopsisdiv>\n";
1264 print " <refsect1>\n";
1265 print " <title>Members</title>\n";
1267 if ($#{$args{'parameterlist'}} >= 0) {
1268 print " <variablelist>\n";
1269 foreach $parameter (@{$args{'parameterlist'}}) {
1270 ($parameter =~ /^#/) && next;
1272 my $parameter_name = $parameter;
1273 $parameter_name =~ s/\[.*//;
1275 defined($args{'parameterdescs'}{$parameter_name}) || next;
1276 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1277 $type = $args{'parametertypes'}{$parameter};
1278 print " <varlistentry>";
1279 print " <term><literal>$type $parameter</literal></term>\n";
1280 print " <listitem><para>\n";
1281 output_highlight($args{'parameterdescs'}{$parameter_name});
1282 print " </para></listitem>\n";
1283 print " </varlistentry>\n";
1285 print " </variablelist>\n";
1287 print " <para>\n None\n </para>\n";
1289 print " </refsect1>\n";
1291 output_section_xml(@_);
1293 print "</refentry>\n\n";
1296 # output enum in XML DocBook
1297 sub output_enum_xml(%) {
1298 my %args = %{$_[0]};
1299 my ($parameter, $section);
1303 $id = "API-enum-" . $args{'enum'};
1304 $id =~ s/[^A-Za-z0-9]/-/g;
1306 print "<refentry id=\"$id\">\n";
1307 print "<refentryinfo>\n";
1308 print " <title>LINUX</title>\n";
1309 print " <productname>Kernel Hackers Manual</productname>\n";
1310 print " <date>$man_date</date>\n";
1311 print "</refentryinfo>\n";
1312 print "<refmeta>\n";
1313 print " <refentrytitle><phrase>enum " . $args{'enum'} . "</phrase></refentrytitle>\n";
1314 print " <manvolnum>9</manvolnum>\n";
1315 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
1316 print "</refmeta>\n";
1317 print "<refnamediv>\n";
1318 print " <refname>enum " . $args{'enum'} . "</refname>\n";
1319 print " <refpurpose>\n";
1321 output_highlight ($args{'purpose'});
1322 print " </refpurpose>\n";
1323 print "</refnamediv>\n";
1325 print "<refsynopsisdiv>\n";
1326 print " <title>Synopsis</title>\n";
1327 print " <programlisting>\n";
1328 print "enum " . $args{'enum'} . " {\n";
1330 foreach $parameter (@{$args{'parameterlist'}}) {
1331 print " $parameter";
1332 if ($count != $#{$args{'parameterlist'}}) {
1339 print " </programlisting>\n";
1340 print "</refsynopsisdiv>\n";
1342 print "<refsect1>\n";
1343 print " <title>Constants</title>\n";
1344 print " <variablelist>\n";
1345 foreach $parameter (@{$args{'parameterlist'}}) {
1346 my $parameter_name = $parameter;
1347 $parameter_name =~ s/\[.*//;
1349 print " <varlistentry>";
1350 print " <term>$parameter</term>\n";
1351 print " <listitem><para>\n";
1352 output_highlight($args{'parameterdescs'}{$parameter_name});
1353 print " </para></listitem>\n";
1354 print " </varlistentry>\n";
1356 print " </variablelist>\n";
1357 print "</refsect1>\n";
1359 output_section_xml(@_);
1361 print "</refentry>\n\n";
1364 # output typedef in XML DocBook
1365 sub output_typedef_xml(%) {
1366 my %args = %{$_[0]};
1367 my ($parameter, $section);
1370 $id = "API-typedef-" . $args{'typedef'};
1371 $id =~ s/[^A-Za-z0-9]/-/g;
1373 print "<refentry id=\"$id\">\n";
1374 print "<refentryinfo>\n";
1375 print " <title>LINUX</title>\n";
1376 print " <productname>Kernel Hackers Manual</productname>\n";
1377 print " <date>$man_date</date>\n";
1378 print "</refentryinfo>\n";
1379 print "<refmeta>\n";
1380 print " <refentrytitle><phrase>typedef " . $args{'typedef'} . "</phrase></refentrytitle>\n";
1381 print " <manvolnum>9</manvolnum>\n";
1382 print "</refmeta>\n";
1383 print "<refnamediv>\n";
1384 print " <refname>typedef " . $args{'typedef'} . "</refname>\n";
1385 print " <refpurpose>\n";
1387 output_highlight ($args{'purpose'});
1388 print " </refpurpose>\n";
1389 print "</refnamediv>\n";
1391 print "<refsynopsisdiv>\n";
1392 print " <title>Synopsis</title>\n";
1393 print " <synopsis>typedef " . $args{'typedef'} . ";</synopsis>\n";
1394 print "</refsynopsisdiv>\n";
1396 output_section_xml(@_);
1398 print "</refentry>\n\n";
1401 # output in XML DocBook
1402 sub output_blockhead_xml(%) {
1403 my %args = %{$_[0]};
1404 my ($parameter, $section);
1407 my $id = $args{'module'};
1408 $id =~ s/[^A-Za-z0-9]/-/g;
1410 # print out each section
1412 foreach $section (@{$args{'sectionlist'}}) {
1413 if (!$args{'content-only'}) {
1414 print "<refsect1>\n <title>$section</title>\n";
1416 if ($section =~ m/EXAMPLE/i) {
1417 print "<example><para>\n";
1418 $output_preformatted = 1;
1422 output_highlight($args{'sections'}{$section});
1423 $output_preformatted = 0;
1424 if ($section =~ m/EXAMPLE/i) {
1425 print "</para></example>\n";
1429 if (!$args{'content-only'}) {
1430 print "\n</refsect1>\n";
1437 # output in XML DocBook
1438 sub output_function_gnome {
1439 my %args = %{$_[0]};
1440 my ($parameter, $section);
1444 $id = $args{'module'} . "-" . $args{'function'};
1445 $id =~ s/[^A-Za-z0-9]/-/g;
1448 print " <title id=\"$id\">" . $args{'function'} . "</title>\n";
1450 print " <funcsynopsis>\n";
1451 print " <funcdef>" . $args{'functiontype'} . " ";
1452 print "<function>" . $args{'function'} . " ";
1453 print "</function></funcdef>\n";
1456 if ($#{$args{'parameterlist'}} >= 0) {
1457 foreach $parameter (@{$args{'parameterlist'}}) {
1458 $type = $args{'parametertypes'}{$parameter};
1459 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1460 # pointer-to-function
1461 print " <paramdef>$1 <parameter>$parameter</parameter>)\n";
1462 print " <funcparams>$2</funcparams></paramdef>\n";
1464 print " <paramdef>" . $type;
1465 print " <parameter>$parameter</parameter></paramdef>\n";
1471 print " </funcsynopsis>\n";
1472 if ($#{$args{'parameterlist'}} >= 0) {
1473 print " <informaltable pgwide=\"1\" frame=\"none\" role=\"params\">\n";
1474 print "<tgroup cols=\"2\">\n";
1475 print "<colspec colwidth=\"2*\">\n";
1476 print "<colspec colwidth=\"8*\">\n";
1478 foreach $parameter (@{$args{'parameterlist'}}) {
1479 my $parameter_name = $parameter;
1480 $parameter_name =~ s/\[.*//;
1482 print " <row><entry align=\"right\"><parameter>$parameter</parameter></entry>\n";
1485 output_highlight($args{'parameterdescs'}{$parameter_name});
1486 print " </entry></row>\n";
1488 print " </tbody></tgroup></informaltable>\n";
1490 print " <para>\n None\n </para>\n";
1493 # print out each section
1495 foreach $section (@{$args{'sectionlist'}}) {
1496 print "<simplesect>\n <title>$section</title>\n";
1497 if ($section =~ m/EXAMPLE/i) {
1498 print "<example><programlisting>\n";
1499 $output_preformatted = 1;
1503 output_highlight($args{'sections'}{$section});
1504 $output_preformatted = 0;
1506 if ($section =~ m/EXAMPLE/i) {
1507 print "</programlisting></example>\n";
1510 print " </simplesect>\n";
1513 print "</sect2>\n\n";
1517 # output function in man
1518 sub output_function_man(%) {
1519 my %args = %{$_[0]};
1520 my ($parameter, $section);
1523 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
1526 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
1528 print ".SH SYNOPSIS\n";
1529 if ($args{'functiontype'} ne "") {
1530 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
1532 print ".B \"" . $args{'function'} . "\n";
1537 foreach my $parameter (@{$args{'parameterlist'}}) {
1538 if ($count == $#{$args{'parameterlist'}}) {
1541 $type = $args{'parametertypes'}{$parameter};
1542 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1543 # pointer-to-function
1544 print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n";
1546 $type =~ s/([^\*])$/$1 /;
1547 print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n";
1553 print ".SH ARGUMENTS\n";
1554 foreach $parameter (@{$args{'parameterlist'}}) {
1555 my $parameter_name = $parameter;
1556 $parameter_name =~ s/\[.*//;
1558 print ".IP \"" . $parameter . "\" 12\n";
1559 output_highlight($args{'parameterdescs'}{$parameter_name});
1561 foreach $section (@{$args{'sectionlist'}}) {
1562 print ".SH \"", uc $section, "\"\n";
1563 output_highlight($args{'sections'}{$section});
1568 # output enum in man
1569 sub output_enum_man(%) {
1570 my %args = %{$_[0]};
1571 my ($parameter, $section);
1574 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
1577 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
1579 print ".SH SYNOPSIS\n";
1580 print "enum " . $args{'enum'} . " {\n";
1582 foreach my $parameter (@{$args{'parameterlist'}}) {
1583 print ".br\n.BI \" $parameter\"\n";
1584 if ($count == $#{$args{'parameterlist'}}) {
1594 print ".SH Constants\n";
1595 foreach $parameter (@{$args{'parameterlist'}}) {
1596 my $parameter_name = $parameter;
1597 $parameter_name =~ s/\[.*//;
1599 print ".IP \"" . $parameter . "\" 12\n";
1600 output_highlight($args{'parameterdescs'}{$parameter_name});
1602 foreach $section (@{$args{'sectionlist'}}) {
1603 print ".SH \"$section\"\n";
1604 output_highlight($args{'sections'}{$section});
1609 # output struct in man
1610 sub output_struct_man(%) {
1611 my %args = %{$_[0]};
1612 my ($parameter, $section);
1614 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
1617 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
1619 print ".SH SYNOPSIS\n";
1620 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
1622 foreach my $parameter (@{$args{'parameterlist'}}) {
1623 if ($parameter =~ /^#/) {
1624 print ".BI \"$parameter\"\n.br\n";
1627 my $parameter_name = $parameter;
1628 $parameter_name =~ s/\[.*//;
1630 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1631 $type = $args{'parametertypes'}{$parameter};
1632 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1633 # pointer-to-function
1634 print ".BI \" " . $1 . "\" " . $parameter . " \") (" . $2 . ")" . "\"\n;\n";
1635 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1637 print ".BI \" " . $1 . "\ \" " . $parameter . $2 . " \"" . "\"\n;\n";
1639 $type =~ s/([^\*])$/$1 /;
1640 print ".BI \" " . $type . "\" " . $parameter . " \"" . "\"\n;\n";
1646 print ".SH Members\n";
1647 foreach $parameter (@{$args{'parameterlist'}}) {
1648 ($parameter =~ /^#/) && next;
1650 my $parameter_name = $parameter;
1651 $parameter_name =~ s/\[.*//;
1653 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1654 print ".IP \"" . $parameter . "\" 12\n";
1655 output_highlight($args{'parameterdescs'}{$parameter_name});
1657 foreach $section (@{$args{'sectionlist'}}) {
1658 print ".SH \"$section\"\n";
1659 output_highlight($args{'sections'}{$section});
1664 # output typedef in man
1665 sub output_typedef_man(%) {
1666 my %args = %{$_[0]};
1667 my ($parameter, $section);
1669 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
1672 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
1674 foreach $section (@{$args{'sectionlist'}}) {
1675 print ".SH \"$section\"\n";
1676 output_highlight($args{'sections'}{$section});
1680 sub output_blockhead_man(%) {
1681 my %args = %{$_[0]};
1682 my ($parameter, $section);
1685 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
1687 foreach $section (@{$args{'sectionlist'}}) {
1688 print ".SH \"$section\"\n";
1689 output_highlight($args{'sections'}{$section});
1695 sub output_function_text(%) {
1696 my %args = %{$_[0]};
1697 my ($parameter, $section);
1701 print $args{'function'} . " - " . $args{'purpose'} . "\n";
1703 print "\nSynopsis:\n\n";
1704 if ($args{'functiontype'} ne "") {
1705 $start = $args{'functiontype'} . " " . $args{'function'} . " (";
1707 $start = $args{'function'} . " (";
1712 foreach my $parameter (@{$args{'parameterlist'}}) {
1713 $type = $args{'parametertypes'}{$parameter};
1714 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1715 # pointer-to-function
1716 print $1 . $parameter . ") (" . $2;
1718 print $type . " " . $parameter;
1720 if ($count != $#{$args{'parameterlist'}}) {
1723 print " " x length($start);
1729 print "Arguments:\n\n";
1730 foreach $parameter (@{$args{'parameterlist'}}) {
1731 my $parameter_name = $parameter;
1732 $parameter_name =~ s/\[.*//;
1734 print $parameter . "\n\t" . $args{'parameterdescs'}{$parameter_name} . "\n";
1736 output_section_text(@_);
1739 #output sections in text
1740 sub output_section_text(%) {
1741 my %args = %{$_[0]};
1745 foreach $section (@{$args{'sectionlist'}}) {
1746 print "$section:\n\n";
1747 output_highlight($args{'sections'}{$section});
1752 # output enum in text
1753 sub output_enum_text(%) {
1754 my %args = %{$_[0]};
1759 print "enum " . $args{'enum'} . " - " . $args{'purpose'} . "\n\n";
1760 print "enum " . $args{'enum'} . " {\n";
1762 foreach $parameter (@{$args{'parameterlist'}}) {
1763 print "\t$parameter";
1764 if ($count != $#{$args{'parameterlist'}}) {
1772 print "Constants:\n\n";
1773 foreach $parameter (@{$args{'parameterlist'}}) {
1774 print "$parameter\n\t";
1775 print $args{'parameterdescs'}{$parameter} . "\n";
1778 output_section_text(@_);
1781 # output typedef in text
1782 sub output_typedef_text(%) {
1783 my %args = %{$_[0]};
1786 print "Typedef:\n\n";
1788 print "typedef " . $args{'typedef'} . " - " . $args{'purpose'} . "\n";
1789 output_section_text(@_);
1792 # output struct as text
1793 sub output_struct_text(%) {
1794 my %args = %{$_[0]};
1797 print $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "\n\n";
1798 print $args{'type'} . " " . $args{'struct'} . " {\n";
1799 foreach $parameter (@{$args{'parameterlist'}}) {
1800 if ($parameter =~ /^#/) {
1801 print "$parameter\n";
1805 my $parameter_name = $parameter;
1806 $parameter_name =~ s/\[.*//;
1808 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1809 $type = $args{'parametertypes'}{$parameter};
1810 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1811 # pointer-to-function
1812 print "\t$1 $parameter) ($2);\n";
1813 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1815 print "\t$1 $parameter$2;\n";
1817 print "\t" . $type . " " . $parameter . ";\n";
1822 print "Members:\n\n";
1823 foreach $parameter (@{$args{'parameterlist'}}) {
1824 ($parameter =~ /^#/) && next;
1826 my $parameter_name = $parameter;
1827 $parameter_name =~ s/\[.*//;
1829 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1830 print "$parameter\n\t";
1831 print $args{'parameterdescs'}{$parameter_name} . "\n";
1834 output_section_text(@_);
1837 sub output_blockhead_text(%) {
1838 my %args = %{$_[0]};
1839 my ($parameter, $section);
1841 foreach $section (@{$args{'sectionlist'}}) {
1842 print " $section:\n";
1844 output_highlight($args{'sections'}{$section});
1849 # output in restructured text
1853 # This could use some work; it's used to output the DOC: sections, and
1854 # starts by putting out the name of the doc section itself, but that tends
1855 # to duplicate a header already in the template file.
1857 sub output_blockhead_rst(%) {
1858 my %args = %{$_[0]};
1859 my ($parameter, $section);
1861 foreach $section (@{$args{'sectionlist'}}) {
1862 if ($output_selection != OUTPUT_INCLUDE) {
1863 print "**$section**\n\n";
1865 print_lineno($section_start_lines{$section});
1866 output_highlight_rst($args{'sections'}{$section});
1871 sub output_highlight_rst {
1872 my $contents = join "\n",@_;
1875 # undo the evil effects of xml_escape() earlier
1876 $contents = xml_unescape($contents);
1881 foreach $line (split "\n", $contents) {
1882 print $lineprefix . $line . "\n";
1886 sub output_function_rst(%) {
1887 my %args = %{$_[0]};
1888 my ($parameter, $section);
1889 my $oldprefix = $lineprefix;
1892 if ($args{'typedef'}) {
1893 print ".. c:type:: ". $args{'function'} . "\n\n";
1894 print_lineno($declaration_start_line);
1895 print " **Typedef**: ";
1897 output_highlight_rst($args{'purpose'});
1898 $start = "\n\n**Syntax**\n\n ``";
1900 print ".. c:function:: ";
1902 if ($args{'functiontype'} ne "") {
1903 $start .= $args{'functiontype'} . " " . $args{'function'} . " (";
1905 $start .= $args{'function'} . " (";
1910 foreach my $parameter (@{$args{'parameterlist'}}) {
1915 $type = $args{'parametertypes'}{$parameter};
1917 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1918 # pointer-to-function
1919 print $1 . $parameter . ") (" . $2;
1921 print $type . " " . $parameter;
1924 if ($args{'typedef'}) {
1928 print_lineno($declaration_start_line);
1930 output_highlight_rst($args{'purpose'});
1934 print "**Parameters**\n\n";
1936 foreach $parameter (@{$args{'parameterlist'}}) {
1937 my $parameter_name = $parameter;
1938 $parameter_name =~ s/\[.*//;
1939 $type = $args{'parametertypes'}{$parameter};
1942 print "``$type $parameter``\n";
1944 print "``$parameter``\n";
1947 print_lineno($parameterdesc_start_lines{$parameter_name});
1949 if (defined($args{'parameterdescs'}{$parameter_name}) &&
1950 $args{'parameterdescs'}{$parameter_name} ne $undescribed) {
1951 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1953 print " *undescribed*\n";
1958 $lineprefix = $oldprefix;
1959 output_section_rst(@_);
1962 sub output_section_rst(%) {
1963 my %args = %{$_[0]};
1965 my $oldprefix = $lineprefix;
1968 foreach $section (@{$args{'sectionlist'}}) {
1969 print "**$section**\n\n";
1970 print_lineno($section_start_lines{$section});
1971 output_highlight_rst($args{'sections'}{$section});
1975 $lineprefix = $oldprefix;
1978 sub output_enum_rst(%) {
1979 my %args = %{$_[0]};
1981 my $oldprefix = $lineprefix;
1983 my $name = "enum " . $args{'enum'};
1985 print "\n\n.. c:type:: " . $name . "\n\n";
1986 print_lineno($declaration_start_line);
1988 output_highlight_rst($args{'purpose'});
1991 print "**Constants**\n\n";
1993 foreach $parameter (@{$args{'parameterlist'}}) {
1994 print "``$parameter``\n";
1995 if ($args{'parameterdescs'}{$parameter} ne $undescribed) {
1996 output_highlight_rst($args{'parameterdescs'}{$parameter});
1998 print " *undescribed*\n";
2003 $lineprefix = $oldprefix;
2004 output_section_rst(@_);
2007 sub output_typedef_rst(%) {
2008 my %args = %{$_[0]};
2010 my $oldprefix = $lineprefix;
2011 my $name = "typedef " . $args{'typedef'};
2013 print "\n\n.. c:type:: " . $name . "\n\n";
2014 print_lineno($declaration_start_line);
2016 output_highlight_rst($args{'purpose'});
2019 $lineprefix = $oldprefix;
2020 output_section_rst(@_);
2023 sub output_struct_rst(%) {
2024 my %args = %{$_[0]};
2026 my $oldprefix = $lineprefix;
2027 my $name = $args{'type'} . " " . $args{'struct'};
2029 print "\n\n.. c:type:: " . $name . "\n\n";
2030 print_lineno($declaration_start_line);
2032 output_highlight_rst($args{'purpose'});
2035 print "**Definition**\n\n";
2037 print " " . $args{'type'} . " " . $args{'struct'} . " {\n";
2038 foreach $parameter (@{$args{'parameterlist'}}) {
2039 if ($parameter =~ /^#/) {
2040 print " " . "$parameter\n";
2044 my $parameter_name = $parameter;
2045 $parameter_name =~ s/\[.*//;
2047 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
2048 $type = $args{'parametertypes'}{$parameter};
2049 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
2050 # pointer-to-function
2051 print " $1 $parameter) ($2);\n";
2052 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
2054 print " $1 $parameter$2;\n";
2056 print " " . $type . " " . $parameter . ";\n";
2061 print "**Members**\n\n";
2063 foreach $parameter (@{$args{'parameterlist'}}) {
2064 ($parameter =~ /^#/) && next;
2066 my $parameter_name = $parameter;
2067 $parameter_name =~ s/\[.*//;
2069 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
2070 $type = $args{'parametertypes'}{$parameter};
2071 print_lineno($parameterdesc_start_lines{$parameter_name});
2072 print "``" . $parameter . "``\n";
2073 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
2078 $lineprefix = $oldprefix;
2079 output_section_rst(@_);
2083 ## list mode output functions
2085 sub output_function_list(%) {
2086 my %args = %{$_[0]};
2088 print $args{'function'} . "\n";
2091 # output enum in list
2092 sub output_enum_list(%) {
2093 my %args = %{$_[0]};
2094 print $args{'enum'} . "\n";
2097 # output typedef in list
2098 sub output_typedef_list(%) {
2099 my %args = %{$_[0]};
2100 print $args{'typedef'} . "\n";
2103 # output struct as list
2104 sub output_struct_list(%) {
2105 my %args = %{$_[0]};
2107 print $args{'struct'} . "\n";
2110 sub output_blockhead_list(%) {
2111 my %args = %{$_[0]};
2112 my ($parameter, $section);
2114 foreach $section (@{$args{'sectionlist'}}) {
2115 print "DOC: $section\n";
2120 # generic output function for all types (function, struct/union, typedef, enum);
2121 # calls the generated, variable output_ function name based on
2122 # functype and output_mode
2123 sub output_declaration {
2126 my $functype = shift;
2127 my $func = "output_${functype}_$output_mode";
2128 if (($output_selection == OUTPUT_ALL) ||
2129 (($output_selection == OUTPUT_INCLUDE ||
2130 $output_selection == OUTPUT_EXPORTED) &&
2131 defined($function_table{$name})) ||
2132 (($output_selection == OUTPUT_EXCLUDE ||
2133 $output_selection == OUTPUT_INTERNAL) &&
2134 !($functype eq "function" && defined($function_table{$name}))))
2142 # generic output function - calls the right one based on current output mode.
2143 sub output_blockhead {
2145 my $func = "output_blockhead_" . $output_mode;
2151 # takes a declaration (struct, union, enum, typedef) and
2152 # invokes the right handler. NOT called for functions.
2153 sub dump_declaration($$) {
2155 my ($prototype, $file) = @_;
2156 my $func = "dump_" . $decl_type;
2160 sub dump_union($$) {
2164 sub dump_struct($$) {
2169 if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) {
2170 #my $decl_type = $1;
2171 $declaration_name = $2;
2174 # ignore embedded structs or unions
2175 $members =~ s/({.*})//g;
2178 # ignore members marked private:
2179 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
2180 $members =~ s/\/\*\s*private:.*//gosi;
2182 $members =~ s/\/\*.*?\*\///gos;
2183 $nested =~ s/\/\*.*?\*\///gos;
2184 # strip kmemcheck_bitfield_{begin,end}.*;
2185 $members =~ s/kmemcheck_bitfield_.*?;//gos;
2187 $members =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;
2188 $members =~ s/__aligned\s*\([^;]*\)//gos;
2189 $members =~ s/\s*CRYPTO_MINALIGN_ATTR//gos;
2190 # replace DECLARE_BITMAP
2191 $members =~ s/DECLARE_BITMAP\s*\(([^,)]+), ([^,)]+)\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
2192 # replace DECLARE_HASHTABLE
2193 $members =~ s/DECLARE_HASHTABLE\s*\(([^,)]+), ([^,)]+)\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
2195 create_parameterlist($members, ';', $file);
2196 check_sections($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested);
2198 output_declaration($declaration_name,
2200 {'struct' => $declaration_name,
2201 'module' => $modulename,
2202 'parameterlist' => \@parameterlist,
2203 'parameterdescs' => \%parameterdescs,
2204 'parametertypes' => \%parametertypes,
2205 'sectionlist' => \@sectionlist,
2206 'sections' => \%sections,
2207 'purpose' => $declaration_purpose,
2208 'type' => $decl_type
2212 print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
2221 $x =~ s@/\*.*?\*/@@gos; # strip comments.
2222 # strip #define macros inside enums
2223 $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;
2225 if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
2226 $declaration_name = $1;
2229 foreach my $arg (split ',', $members) {
2230 $arg =~ s/^\s*(\w+).*/$1/;
2231 push @parameterlist, $arg;
2232 if (!$parameterdescs{$arg}) {
2233 $parameterdescs{$arg} = $undescribed;
2234 print STDERR "${file}:$.: warning: Enum value '$arg' ".
2235 "not described in enum '$declaration_name'\n";
2240 output_declaration($declaration_name,
2242 {'enum' => $declaration_name,
2243 'module' => $modulename,
2244 'parameterlist' => \@parameterlist,
2245 'parameterdescs' => \%parameterdescs,
2246 'sectionlist' => \@sectionlist,
2247 'sections' => \%sections,
2248 'purpose' => $declaration_purpose
2252 print STDERR "${file}:$.: error: Cannot parse enum!\n";
2257 sub dump_typedef($$) {
2261 $x =~ s@/\*.*?\*/@@gos; # strip comments.
2263 # Parse function prototypes
2264 if ($x =~ /typedef\s+(\w+)\s*\(\*\s*(\w\S+)\s*\)\s*\((.*)\);/ ||
2265 $x =~ /typedef\s+(\w+)\s*(\w\S+)\s*\s*\((.*)\);/) {
2269 $declaration_name = $2;
2272 create_parameterlist($args, ',', $file);
2274 output_declaration($declaration_name,
2276 {'function' => $declaration_name,
2278 'module' => $modulename,
2279 'functiontype' => $return_type,
2280 'parameterlist' => \@parameterlist,
2281 'parameterdescs' => \%parameterdescs,
2282 'parametertypes' => \%parametertypes,
2283 'sectionlist' => \@sectionlist,
2284 'sections' => \%sections,
2285 'purpose' => $declaration_purpose
2290 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
2291 $x =~ s/\(*.\)\s*;$/;/;
2292 $x =~ s/\[*.\]\s*;$/;/;
2295 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
2296 $declaration_name = $1;
2298 output_declaration($declaration_name,
2300 {'typedef' => $declaration_name,
2301 'module' => $modulename,
2302 'sectionlist' => \@sectionlist,
2303 'sections' => \%sections,
2304 'purpose' => $declaration_purpose
2308 print STDERR "${file}:$.: error: Cannot parse typedef!\n";
2313 sub save_struct_actual($) {
2316 # strip all spaces from the actual param so that it looks like one string item
2317 $actual =~ s/\s*//g;
2318 $struct_actual = $struct_actual . $actual . " ";
2321 sub create_parameterlist($$$) {
2323 my $splitter = shift;
2328 # temporarily replace commas inside function pointer definition
2329 while ($args =~ /(\([^\),]+),/) {
2330 $args =~ s/(\([^\),]+),/$1#/g;
2333 foreach my $arg (split($splitter, $args)) {
2335 $arg =~ s/\/\*.*\*\///;
2336 # strip leading/trailing spaces
2342 # Treat preprocessor directive as a typeless variable just to fill
2343 # corresponding data structures "correctly". Catch it later in
2345 push_parameter($arg, "", $file);
2346 } elsif ($arg =~ m/\(.+\)\s*\(/) {
2347 # pointer-to-function
2349 $arg =~ m/[^\(]+\(\*?\s*(\w*)\s*\)/;
2352 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
2353 save_struct_actual($param);
2354 push_parameter($param, $type, $file);
2356 $arg =~ s/\s*:\s*/:/g;
2357 $arg =~ s/\s*\[/\[/g;
2359 my @args = split('\s*,\s*', $arg);
2360 if ($args[0] =~ m/\*/) {
2361 $args[0] =~ s/(\*+)\s*/ $1/;
2365 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
2367 push(@first_arg, split('\s+', $1));
2368 push(@first_arg, $2);
2370 @first_arg = split('\s+', shift @args);
2373 unshift(@args, pop @first_arg);
2374 $type = join " ", @first_arg;
2376 foreach $param (@args) {
2377 if ($param =~ m/^(\*+)\s*(.*)/) {
2378 save_struct_actual($2);
2379 push_parameter($2, "$type $1", $file);
2381 elsif ($param =~ m/(.*?):(\d+)/) {
2382 if ($type ne "") { # skip unnamed bit-fields
2383 save_struct_actual($1);
2384 push_parameter($1, "$type:$2", $file)
2388 save_struct_actual($param);
2389 push_parameter($param, $type, $file);
2396 sub push_parameter($$$) {
2401 if (($anon_struct_union == 1) && ($type eq "") &&
2403 return; # ignore the ending }; from anon. struct/union
2406 $anon_struct_union = 0;
2407 $param =~ s/[\[\)].*//;
2409 if ($type eq "" && $param =~ /\.\.\.$/)
2411 if (!$param =~ /\w\.\.\.$/) {
2412 # handles unnamed variable parameters
2415 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
2416 $parameterdescs{$param} = "variable arguments";
2419 elsif ($type eq "" && ($param eq "" or $param eq "void"))
2422 $parameterdescs{void} = "no arguments";
2424 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
2425 # handle unnamed (anonymous) union or struct:
2428 $param = "{unnamed_" . $param . "}";
2429 $parameterdescs{$param} = "anonymous\n";
2430 $anon_struct_union = 1;
2433 # warn if parameter has no description
2434 # (but ignore ones starting with # as these are not parameters
2435 # but inline preprocessor statements);
2436 # also ignore unnamed structs/unions;
2437 if (!$anon_struct_union) {
2438 if (!defined $parameterdescs{$param} && $param !~ /^#/) {
2440 $parameterdescs{$param} = $undescribed;
2442 if (($type eq 'function') || ($type eq 'enum')) {
2443 print STDERR "${file}:$.: warning: Function parameter ".
2444 "or member '$param' not " .
2445 "described in '$declaration_name'\n";
2447 print STDERR "${file}:$.: warning:" .
2448 " No description found for parameter '$param'\n";
2453 $param = xml_escape($param);
2455 # strip spaces from $param so that it is one continuous string
2456 # on @parameterlist;
2457 # this fixes a problem where check_sections() cannot find
2458 # a parameter like "addr[6 + 2]" because it actually appears
2459 # as "addr[6", "+", "2]" on the parameter list;
2460 # but it's better to maintain the param string unchanged for output,
2461 # so just weaken the string compare in check_sections() to ignore
2462 # "[blah" in a parameter string;
2463 ###$param =~ s/\s*//g;
2464 push @parameterlist, $param;
2465 $type =~ s/\s\s+/ /g;
2466 $parametertypes{$param} = $type;
2469 sub check_sections($$$$$$) {
2470 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck, $nested) = @_;
2471 my @sects = split ' ', $sectcheck;
2472 my @prms = split ' ', $prmscheck;
2475 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
2477 foreach $sx (0 .. $#sects) {
2479 foreach $px (0 .. $#prms) {
2480 $prm_clean = $prms[$px];
2481 $prm_clean =~ s/\[.*\]//;
2482 $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;
2483 # ignore array size in a parameter string;
2484 # however, the original param string may contain
2485 # spaces, e.g.: addr[6 + 2]
2486 # and this appears in @prms as "addr[6" since the
2487 # parameter list is split at spaces;
2488 # hence just ignore "[..." for the sections check;
2489 $prm_clean =~ s/\[.*//;
2491 ##$prm_clean =~ s/^\**//;
2492 if ($prm_clean eq $sects[$sx]) {
2498 if ($decl_type eq "function") {
2499 print STDERR "${file}:$.: warning: " .
2500 "Excess function parameter " .
2502 "description in '$decl_name'\n";
2505 if ($nested !~ m/\Q$sects[$sx]\E/) {
2506 print STDERR "${file}:$.: warning: " .
2507 "Excess struct/union/enum/typedef member " .
2509 "description in '$decl_name'\n";
2518 # Checks the section describing the return value of a function.
2519 sub check_return_section {
2521 my $declaration_name = shift;
2522 my $return_type = shift;
2524 # Ignore an empty return type (It's a macro)
2525 # Ignore functions with a "void" return type. (But don't ignore "void *")
2526 if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
2530 if (!defined($sections{$section_return}) ||
2531 $sections{$section_return} eq "") {
2532 print STDERR "${file}:$.: warning: " .
2533 "No description found for return value of " .
2534 "'$declaration_name'\n";
2540 # takes a function prototype and the name of the current file being
2541 # processed and spits out all the details stored in the global
2543 sub dump_function($$) {
2544 my $prototype = shift;
2548 $prototype =~ s/^static +//;
2549 $prototype =~ s/^extern +//;
2550 $prototype =~ s/^asmlinkage +//;
2551 $prototype =~ s/^inline +//;
2552 $prototype =~ s/^__inline__ +//;
2553 $prototype =~ s/^__inline +//;
2554 $prototype =~ s/^__always_inline +//;
2555 $prototype =~ s/^noinline +//;
2556 $prototype =~ s/__init +//;
2557 $prototype =~ s/__init_or_module +//;
2558 $prototype =~ s/__meminit +//;
2559 $prototype =~ s/__must_check +//;
2560 $prototype =~ s/__weak +//;
2561 my $define = $prototype =~ s/^#\s*define\s+//; #ak added
2562 $prototype =~ s/__attribute__\s*\(\(
2564 [\w\s]++ # attribute name
2565 (?:\([^)]*+\))? # attribute arguments
2566 \s*+,? # optional comma at the end
2570 # Yes, this truly is vile. We are looking for:
2571 # 1. Return type (may be nothing if we're looking at a macro)
2573 # 3. Function parameters.
2575 # All the while we have to watch out for function pointer parameters
2576 # (which IIRC is what the two sections are for), C types (these
2577 # regexps don't even start to express all the possibilities), and
2580 # If you mess with these regexps, it's a good idea to check that
2581 # the following functions' documentation still comes out right:
2582 # - parport_register_device (function pointer parameters)
2583 # - atomic_set (macro)
2584 # - pci_match_device, __copy_to_user (long return type)
2586 if ($define && $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s+/) {
2587 # This is an object-like macro, it has no return type and no parameter
2589 # Function-like macros are not allowed to have spaces between
2590 # declaration_name and opening parenthesis (notice the \s+).
2592 $declaration_name = $2;
2594 } elsif ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
2595 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
2596 $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
2597 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
2598 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
2599 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
2600 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
2601 $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2602 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2603 $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2604 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2605 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2606 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2607 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2608 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2609 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2610 $prototype =~ m/^(\w+\s+\w+\s*\*+\s*\w+\s*\*+\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) {
2612 $declaration_name = $2;
2615 create_parameterlist($args, ',', $file);
2617 print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype'\n";
2621 my $prms = join " ", @parameterlist;
2622 check_sections($file, $declaration_name, "function", $sectcheck, $prms, "");
2624 # This check emits a lot of warnings at the moment, because many
2625 # functions don't have a 'Return' doc section. So until the number
2626 # of warnings goes sufficiently down, the check is only performed in
2628 # TODO: always perform the check.
2629 if ($verbose && !$noret) {
2630 check_return_section($file, $declaration_name, $return_type);
2633 output_declaration($declaration_name,
2635 {'function' => $declaration_name,
2636 'module' => $modulename,
2637 'functiontype' => $return_type,
2638 'parameterlist' => \@parameterlist,
2639 'parameterdescs' => \%parameterdescs,
2640 'parametertypes' => \%parametertypes,
2641 'sectionlist' => \@sectionlist,
2642 'sections' => \%sections,
2643 'purpose' => $declaration_purpose
2649 %parameterdescs = ();
2650 %parametertypes = ();
2651 @parameterlist = ();
2655 $struct_actual = "";
2658 $state = STATE_NORMAL;
2659 $inline_doc_state = STATE_INLINE_NA;
2662 sub tracepoint_munge($) {
2664 my $tracepointname = 0;
2665 my $tracepointargs = 0;
2667 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
2668 $tracepointname = $1;
2670 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
2671 $tracepointname = $1;
2673 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
2674 $tracepointname = $2;
2676 $tracepointname =~ s/^\s+//; #strip leading whitespace
2677 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
2678 $tracepointargs = $1;
2680 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
2681 print STDERR "${file}:$.: warning: Unrecognized tracepoint format: \n".
2684 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
2688 sub syscall_munge() {
2691 $prototype =~ s@[\r\n\t]+@ @gos; # strip newlines/CR's/tabs
2692 ## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
2693 if ($prototype =~ m/SYSCALL_DEFINE0/) {
2695 ## $prototype = "long sys_$1(void)";
2698 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
2699 if ($prototype =~ m/long (sys_.*?),/) {
2700 $prototype =~ s/,/\(/;
2702 $prototype =~ s/\)/\(void\)/;
2705 # now delete all of the odd-number commas in $prototype
2706 # so that arg types & arg names don't have a comma between them
2708 my $len = length($prototype);
2710 $len = 0; # skip the for-loop
2712 for (my $ix = 0; $ix < $len; $ix++) {
2713 if (substr($prototype, $ix, 1) eq ',') {
2715 if ($count % 2 == 1) {
2716 substr($prototype, $ix, 1) = ' ';
2722 sub process_proto_function($$) {
2726 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
2728 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
2731 elsif ($x =~ /([^\{]*)/) {
2735 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
2736 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
2737 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
2738 $prototype =~ s@^\s+@@gos; # strip leading spaces
2739 if ($prototype =~ /SYSCALL_DEFINE/) {
2742 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
2743 $prototype =~ /DEFINE_SINGLE_EVENT/)
2745 tracepoint_munge($file);
2747 dump_function($prototype, $file);
2752 sub process_proto_type($$) {
2756 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
2757 $x =~ s@^\s+@@gos; # strip leading spaces
2758 $x =~ s@\s+$@@gos; # strip trailing spaces
2759 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
2762 # To distinguish preprocessor directive from regular declaration later.
2767 if ( $x =~ /([^{};]*)([{};])(.*)/ ) {
2768 $prototype .= $1 . $2;
2769 ($2 eq '{') && $brcount++;
2770 ($2 eq '}') && $brcount--;
2771 if (($2 eq ';') && ($brcount == 0)) {
2772 dump_declaration($prototype, $file);
2784 # xml_escape: replace <, >, and & in the text stream;
2786 # however, formatting controls that are generated internally/locally in the
2787 # kernel-doc script are not escaped here; instead, they begin life like
2788 # $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings
2789 # are converted to their mnemonic-expected output, without the 4 * '\' & ':',
2790 # just before actual output; (this is done by local_unescape())
2793 if (($output_mode eq "text") || ($output_mode eq "man")) {
2796 $text =~ s/\&/\\\\\\amp;/g;
2797 $text =~ s/\</\\\\\\lt;/g;
2798 $text =~ s/\>/\\\\\\gt;/g;
2802 # xml_unescape: reverse the effects of xml_escape
2803 sub xml_unescape($) {
2805 if (($output_mode eq "text") || ($output_mode eq "man")) {
2808 $text =~ s/\\\\\\amp;/\&/g;
2809 $text =~ s/\\\\\\lt;/</g;
2810 $text =~ s/\\\\\\gt;/>/g;
2814 # convert local escape strings to html
2815 # local escape strings look like: '\\\\menmonic:' (that's 4 backslashes)
2816 sub local_unescape($) {
2818 if (($output_mode eq "text") || ($output_mode eq "man")) {
2821 $text =~ s/\\\\\\\\lt:/</g;
2822 $text =~ s/\\\\\\\\gt:/>/g;
2826 sub map_filename($) {
2828 my ($orig_file) = @_;
2830 if (defined($ENV{'SRCTREE'})) {
2831 $file = "$ENV{'SRCTREE'}" . "/" . $orig_file;
2836 if (defined($source_map{$file})) {
2837 $file = $source_map{$file};
2843 sub process_export_file($) {
2844 my ($orig_file) = @_;
2845 my $file = map_filename($orig_file);
2847 if (!open(IN,"<$file")) {
2848 print STDERR "Error: Cannot open file $file\n";
2854 if (/$export_symbol/) {
2855 $function_table{$2} = 1;
2862 sub process_file($) {
2868 my $initial_section_counter = $section_counter;
2869 my ($orig_file) = @_;
2872 $file = map_filename($orig_file);
2874 if (!open(IN,"<$file")) {
2875 print STDERR "Error: Cannot open file $file\n";
2882 $section_counter = 0;
2884 while (s/\\\s*$//) {
2887 if ($state == STATE_NORMAL) {
2888 if (/$doc_start/o) {
2889 $state = STATE_NAME; # next line is always the function name
2891 $declaration_start_line = $. + 1;
2893 } elsif ($state == STATE_NAME) {# this line is the function name (always)
2894 if (/$doc_block/o) {
2895 $state = STATE_DOCBLOCK;
2897 $new_start_line = $. + 1;
2900 $section = $section_intro;
2905 elsif (/$doc_decl/o) {
2907 if (/\s*([\w\s]+?)\s*-/) {
2911 $state = STATE_FIELD;
2912 # if there's no @param blocks need to set up default section
2915 $section = $section_default;
2916 $new_start_line = $. + 1;
2918 # strip leading/trailing/multiple spaces
2922 $descr =~ s/\s+/ /g;
2923 $declaration_purpose = xml_escape($descr);
2926 $declaration_purpose = "";
2929 if (($declaration_purpose eq "") && $verbose) {
2930 print STDERR "${file}:$.: warning: missing initial short description on line:\n";
2935 if ($identifier =~ m/^struct/) {
2936 $decl_type = 'struct';
2937 } elsif ($identifier =~ m/^union/) {
2938 $decl_type = 'union';
2939 } elsif ($identifier =~ m/^enum/) {
2940 $decl_type = 'enum';
2941 } elsif ($identifier =~ m/^typedef/) {
2942 $decl_type = 'typedef';
2944 $decl_type = 'function';
2948 print STDERR "${file}:$.: info: Scanning doc for $identifier\n";
2951 print STDERR "${file}:$.: warning: Cannot understand $_ on line $.",
2952 " - I thought it was a doc line\n";
2954 $state = STATE_NORMAL;
2956 } elsif ($state == STATE_FIELD) { # look for head: lines, and include content
2957 if (/$doc_sect/i) { # case insensitive for supported section names
2961 # map the supported section names to the canonical names
2962 if ($newsection =~ m/^description$/i) {
2963 $newsection = $section_default;
2964 } elsif ($newsection =~ m/^context$/i) {
2965 $newsection = $section_context;
2966 } elsif ($newsection =~ m/^returns?$/i) {
2967 $newsection = $section_return;
2968 } elsif ($newsection =~ m/^\@return$/) {
2969 # special: @return is a section, not a param description
2970 $newsection = $section_return;
2973 if (($contents ne "") && ($contents ne "\n")) {
2974 if (!$in_doc_sect && $verbose) {
2975 print STDERR "${file}:$.: warning: contents before sections\n";
2978 dump_section($file, $section, xml_escape($contents));
2979 $section = $section_default;
2984 $contents = $newcontents;
2985 $new_start_line = $.;
2986 while ((substr($contents, 0, 1) eq " ") ||
2987 substr($contents, 0, 1) eq "\t") {
2988 $contents = substr($contents, 1);
2990 if ($contents ne "") {
2993 $section = $newsection;
2994 $leading_space = undef;
2995 } elsif (/$doc_end/) {
2996 if (($contents ne "") && ($contents ne "\n")) {
2997 dump_section($file, $section, xml_escape($contents));
2998 $section = $section_default;
3001 # look for doc_com + <text> + doc_end:
3002 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
3003 print STDERR "${file}:$.: warning: suspicious ending line: $_";
3008 $state = STATE_PROTO;
3010 # print STDERR "end of doc comment, looking for prototype\n";
3011 } elsif (/$doc_content/) {
3012 # miguel-style comment kludge, look for blank lines after
3013 # @parameter line to signify start of description
3015 if ($section =~ m/^@/ || $section eq $section_context) {
3016 dump_section($file, $section, xml_escape($contents));
3017 $section = $section_default;
3019 $new_start_line = $.;
3024 } elsif ($in_purpose == 1) {
3025 # Continued declaration purpose
3026 chomp($declaration_purpose);
3027 $declaration_purpose .= " " . xml_escape($1);
3028 $declaration_purpose =~ s/\s+/ /g;
3031 if ($section =~ m/^@/ || $section eq $section_context) {
3032 if (!defined $leading_space) {
3033 if ($cont =~ m/^(\s+)/) {
3034 $leading_space = $1;
3036 $leading_space = "";
3040 $cont =~ s/^$leading_space//;
3042 $contents .= $cont . "\n";
3045 # i dont know - bad line? ignore.
3046 print STDERR "${file}:$.: warning: bad line: $_";
3049 } elsif ($state == STATE_INLINE) { # scanning for inline parameters
3050 # First line (state 1) needs to be a @parameter
3051 if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) {
3054 $new_start_line = $.;
3055 if ($contents ne "") {
3056 while ((substr($contents, 0, 1) eq " ") ||
3057 substr($contents, 0, 1) eq "\t") {
3058 $contents = substr($contents, 1);
3062 $inline_doc_state = STATE_INLINE_TEXT;
3063 # Documentation block end */
3064 } elsif (/$doc_inline_end/) {
3065 if (($contents ne "") && ($contents ne "\n")) {
3066 dump_section($file, $section, xml_escape($contents));
3067 $section = $section_default;
3070 $state = STATE_PROTO;
3071 $inline_doc_state = STATE_INLINE_NA;
3073 } elsif (/$doc_content/) {
3074 if ($inline_doc_state == STATE_INLINE_TEXT) {
3075 $contents .= $1 . "\n";
3076 # nuke leading blank lines
3077 if ($contents =~ /^\s*$/) {
3080 } elsif ($inline_doc_state == STATE_INLINE_NAME) {
3081 $inline_doc_state = STATE_INLINE_ERROR;
3082 print STDERR "${file}:$.: warning: ";
3083 print STDERR "Incorrect use of kernel-doc format: $_";
3087 } elsif ($state == STATE_PROTO) { # scanning for function '{' (end of prototype)
3088 if (/$doc_inline_oneline/) {
3091 if ($contents ne "") {
3093 dump_section($file, $section, xml_escape($contents));
3094 $section = $section_default;
3097 } elsif (/$doc_inline_start/) {
3098 $state = STATE_INLINE;
3099 $inline_doc_state = STATE_INLINE_NAME;
3100 } elsif ($decl_type eq 'function') {
3101 process_proto_function($_, $file);
3103 process_proto_type($_, $file);
3105 } elsif ($state == STATE_DOCBLOCK) {
3108 dump_doc_section($file, $section, xml_escape($contents));
3109 $section = $section_default;
3112 %parameterdescs = ();
3113 %parametertypes = ();
3114 @parameterlist = ();
3118 $state = STATE_NORMAL;
3120 elsif (/$doc_content/)
3124 $contents .= $blankline;
3128 $contents .= $1 . "\n";
3133 if ($initial_section_counter == $section_counter) {
3134 print STDERR "${file}:1: warning: no structured comments found\n";
3135 if (($output_selection == OUTPUT_INCLUDE) && ($show_not_found == 1)) {
3136 print STDERR " Was looking for '$_'.\n" for keys %function_table;
3138 if ($output_mode eq "xml") {
3139 # The template wants at least one RefEntry here; make one.
3140 print "<refentry>\n";
3141 print " <refnamediv>\n";
3142 print " <refname>\n";
3143 print " ${orig_file}\n";
3144 print " </refname>\n";
3145 print " <refpurpose>\n";
3146 print " Document generation inconsistency\n";
3147 print " </refpurpose>\n";
3148 print " </refnamediv>\n";
3149 print " <refsect1>\n";
3152 print " </title>\n";
3153 print " <warning>\n";
3155 print " The template for this document tried to insert\n";
3156 print " the structured comment from the file\n";
3157 print " <filename>${orig_file}</filename> at this point,\n";
3158 print " but none was found.\n";
3159 print " This dummy section is inserted to allow\n";
3160 print " generation to continue.\n";
3162 print " </warning>\n";
3163 print " </refsect1>\n";
3164 print "</refentry>\n";
3170 $kernelversion = get_kernel_version();
3172 # generate a sequence of code that will splice in highlighting information
3173 # using the s// operator.
3174 for (my $k = 0; $k < @highlights; $k++) {
3175 my $pattern = $highlights[$k][0];
3176 my $result = $highlights[$k][1];
3177 # print STDERR "scanning pattern:$pattern, highlight:($result)\n";
3178 $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n";
3181 # Read the file that maps relative names to absolute names for
3182 # separate source and object directories and for shadow trees.
3183 if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
3184 my ($relname, $absname);
3185 while(<SOURCE_MAP>) {
3187 ($relname, $absname) = (split())[0..1];
3188 $relname =~ s:^/+::;
3189 $source_map{$relname} = $absname;
3194 if ($output_selection == OUTPUT_EXPORTED ||
3195 $output_selection == OUTPUT_INTERNAL) {
3197 push(@export_file_list, @ARGV);
3199 foreach (@export_file_list) {
3201 process_export_file($_);
3209 if ($verbose && $errors) {
3210 print STDERR "$errors errors\n";
3212 if ($verbose && $warnings) {
3213 print STDERR "$warnings warnings\n";