kernel-doc: ignore kmemcheck_bitfield_begin/end
[linux-2.6.git] / scripts / kernel-doc
1 #!/usr/bin/perl -w
2
3 use strict;
4
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-2009  Randy Dunlap                         ##
9 ##                                                               ##
10 ## #define enhancements by Armin Kuster <akuster@mvista.com>     ##
11 ## Copyright (c) 2000 MontaVista Software, Inc.                  ##
12 ##                                                               ##
13 ## This software falls under the GNU General Public License.     ##
14 ## Please read the COPYING file for more information             ##
15
16 # w.o. 03-11-2000: added the '-filelist' option.
17
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
40
41 #
42 # This will read a 'c' file and scan for embedded comments in the
43 # style of gnome comments (+minor extensions - see below).
44 #
45
46 # Note: This only supports 'c'.
47
48 # usage:
49 # kernel-doc [ -docbook | -html | -text | -man ] [ -no-doc-sections ]
50 #           [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile
51 # or
52 #           [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile
53 #
54 #  Set output format using one of -docbook -html -text or -man.  Default is man.
55 #
56 #  -no-doc-sections
57 #       Do not output DOC: sections
58 #
59 #  -function funcname
60 #       If set, then only generate documentation for the given function(s) or
61 #       DOC: section titles.  All other functions and DOC: sections are ignored.
62 #
63 #  -nofunction funcname
64 #       If set, then only generate documentation for the other function(s)/DOC:
65 #       sections. Cannot be used together with -function (yes, that's a bug --
66 #       perl hackers can fix it 8))
67 #
68 #  c files - list of 'c' files to process
69 #
70 #  All output goes to stdout, with errors to stderr.
71
72 #
73 # format of comments.
74 # In the following table, (...)? signifies optional structure.
75 #                         (...)* signifies 0 or more structure elements
76 # /**
77 #  * function_name(:)? (- short description)?
78 # (* @parameterx: (description of parameter x)?)*
79 # (* a blank line)?
80 #  * (Description:)? (Description of function)?
81 #  * (section header: (section description)? )*
82 #  (*)?*/
83 #
84 # So .. the trivial example would be:
85 #
86 # /**
87 #  * my_function
88 #  */
89 #
90 # If the Description: header tag is omitted, then there must be a blank line
91 # after the last parameter specification.
92 # e.g.
93 # /**
94 #  * my_function - does my stuff
95 #  * @my_arg: its mine damnit
96 #  *
97 #  * Does my stuff explained.
98 #  */
99 #
100 #  or, could also use:
101 # /**
102 #  * my_function - does my stuff
103 #  * @my_arg: its mine damnit
104 #  * Description: Does my stuff explained.
105 #  */
106 # etc.
107 #
108 # Besides functions you can also write documentation for structs, unions,
109 # enums and typedefs. Instead of the function name you must write the name
110 # of the declaration;  the struct/union/enum/typedef must always precede
111 # the name. Nesting of declarations is not supported.
112 # Use the argument mechanism to document members or constants.
113 # e.g.
114 # /**
115 #  * struct my_struct - short description
116 #  * @a: first member
117 #  * @b: second member
118 #  *
119 #  * Longer description
120 #  */
121 # struct my_struct {
122 #     int a;
123 #     int b;
124 # /* private: */
125 #     int c;
126 # };
127 #
128 # All descriptions can be multiline, except the short function description.
129 #
130 # You can also add additional sections. When documenting kernel functions you
131 # should document the "Context:" of the function, e.g. whether the functions
132 # can be called form interrupts. Unlike other sections you can end it with an
133 # empty line.
134 # Example-sections should contain the string EXAMPLE so that they are marked
135 # appropriately in DocBook.
136 #
137 # Example:
138 # /**
139 #  * user_function - function that can only be called in user context
140 #  * @a: some argument
141 #  * Context: !in_interrupt()
142 #  *
143 #  * Some description
144 #  * Example:
145 #  *    user_function(22);
146 #  */
147 # ...
148 #
149 #
150 # All descriptive text is further processed, scanning for the following special
151 # patterns, which are highlighted appropriately.
152 #
153 # 'funcname()' - function
154 # '$ENVVAR' - environmental variable
155 # '&struct_name' - name of a structure (up to two words including 'struct')
156 # '@parameter' - name of a parameter
157 # '%CONST' - name of a constant.
158
159 my $errors = 0;
160 my $warnings = 0;
161 my $anon_struct_union = 0;
162
163 # match expressions used to find embedded type information
164 my $type_constant = '\%([-_\w]+)';
165 my $type_func = '(\w+)\(\)';
166 my $type_param = '\@(\w+)';
167 my $type_struct = '\&((struct\s*)*[_\w]+)';
168 my $type_struct_xml = '\\&amp;((struct\s*)*[_\w]+)';
169 my $type_env = '(\$\w+)';
170
171 # Output conversion substitutions.
172 #  One for each output format
173
174 # these work fairly well
175 my %highlights_html = ( $type_constant, "<i>\$1</i>",
176                         $type_func, "<b>\$1</b>",
177                         $type_struct_xml, "<i>\$1</i>",
178                         $type_env, "<b><i>\$1</i></b>",
179                         $type_param, "<tt><b>\$1</b></tt>" );
180 my $local_lt = "\\\\\\\\lt:";
181 my $local_gt = "\\\\\\\\gt:";
182 my $blankline_html = $local_lt . "p" . $local_gt;       # was "<p>"
183
184 # XML, docbook format
185 my %highlights_xml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>",
186                         $type_constant, "<constant>\$1</constant>",
187                         $type_func, "<function>\$1</function>",
188                         $type_struct_xml, "<structname>\$1</structname>",
189                         $type_env, "<envar>\$1</envar>",
190                         $type_param, "<parameter>\$1</parameter>" );
191 my $blankline_xml = $local_lt . "/para" . $local_gt . $local_lt . "para" . $local_gt . "\n";
192
193 # gnome, docbook format
194 my %highlights_gnome = ( $type_constant, "<replaceable class=\"option\">\$1</replaceable>",
195                          $type_func, "<function>\$1</function>",
196                          $type_struct, "<structname>\$1</structname>",
197                          $type_env, "<envar>\$1</envar>",
198                          $type_param, "<parameter>\$1</parameter>" );
199 my $blankline_gnome = "</para><para>\n";
200
201 # these are pretty rough
202 my %highlights_man = ( $type_constant, "\$1",
203                        $type_func, "\\\\fB\$1\\\\fP",
204                        $type_struct, "\\\\fI\$1\\\\fP",
205                        $type_param, "\\\\fI\$1\\\\fP" );
206 my $blankline_man = "";
207
208 # text-mode
209 my %highlights_text = ( $type_constant, "\$1",
210                         $type_func, "\$1",
211                         $type_struct, "\$1",
212                         $type_param, "\$1" );
213 my $blankline_text = "";
214
215
216 sub usage {
217     print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man ] [ -no-doc-sections ]\n";
218     print "         [ -function funcname [ -function funcname ...] ]\n";
219     print "         [ -nofunction funcname [ -nofunction funcname ...] ]\n";
220     print "         c source file(s) > outputfile\n";
221     print "         -v : verbose output, more warnings & other info listed\n";
222     exit 1;
223 }
224
225 # read arguments
226 if ($#ARGV == -1) {
227     usage();
228 }
229
230 my $verbose = 0;
231 my $output_mode = "man";
232 my $no_doc_sections = 0;
233 my %highlights = %highlights_man;
234 my $blankline = $blankline_man;
235 my $modulename = "Kernel API";
236 my $function_only = 0;
237 my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
238                 'July', 'August', 'September', 'October',
239                 'November', 'December')[(localtime)[4]] .
240   " " . ((localtime)[5]+1900);
241
242 # Essentially these are globals
243 # They probably want to be tidied up, made more localised or something.
244 # CAVEAT EMPTOR!  Some of the others I localised may not want to be, which
245 # could cause "use of undefined value" or other bugs.
246 my ($function, %function_table, %parametertypes, $declaration_purpose);
247 my ($type, $declaration_name, $return_type);
248 my ($newsection, $newcontents, $prototype, $filelist, $brcount, %source_map);
249
250 if (defined($ENV{'KBUILD_VERBOSE'})) {
251         $verbose = "$ENV{'KBUILD_VERBOSE'}";
252 }
253
254 # Generated docbook code is inserted in a template at a point where
255 # docbook v3.1 requires a non-zero sequence of RefEntry's; see:
256 # http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
257 # We keep track of number of generated entries and generate a dummy
258 # if needs be to ensure the expanded template can be postprocessed
259 # into html.
260 my $section_counter = 0;
261
262 my $lineprefix="";
263
264 # states
265 # 0 - normal code
266 # 1 - looking for function name
267 # 2 - scanning field start.
268 # 3 - scanning prototype.
269 # 4 - documentation block
270 my $state;
271 my $in_doc_sect;
272
273 #declaration types: can be
274 # 'function', 'struct', 'union', 'enum', 'typedef'
275 my $decl_type;
276
277 my $doc_special = "\@\%\$\&";
278
279 my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
280 my $doc_end = '\*/';
281 my $doc_com = '\s*\*\s*';
282 my $doc_decl = $doc_com . '(\w+)';
283 my $doc_sect = $doc_com . '([' . $doc_special . ']?[\w\s]+):(.*)';
284 my $doc_content = $doc_com . '(.*)';
285 my $doc_block = $doc_com . 'DOC:\s*(.*)?';
286
287 my %constants;
288 my %parameterdescs;
289 my @parameterlist;
290 my %sections;
291 my @sectionlist;
292 my $sectcheck;
293 my $struct_actual;
294
295 my $contents = "";
296 my $section_default = "Description";    # default section
297 my $section_intro = "Introduction";
298 my $section = $section_default;
299 my $section_context = "Context";
300
301 my $undescribed = "-- undescribed --";
302
303 reset_state();
304
305 while ($ARGV[0] =~ m/^-(.*)/) {
306     my $cmd = shift @ARGV;
307     if ($cmd eq "-html") {
308         $output_mode = "html";
309         %highlights = %highlights_html;
310         $blankline = $blankline_html;
311     } elsif ($cmd eq "-man") {
312         $output_mode = "man";
313         %highlights = %highlights_man;
314         $blankline = $blankline_man;
315     } elsif ($cmd eq "-text") {
316         $output_mode = "text";
317         %highlights = %highlights_text;
318         $blankline = $blankline_text;
319     } elsif ($cmd eq "-docbook") {
320         $output_mode = "xml";
321         %highlights = %highlights_xml;
322         $blankline = $blankline_xml;
323     } elsif ($cmd eq "-gnome") {
324         $output_mode = "gnome";
325         %highlights = %highlights_gnome;
326         $blankline = $blankline_gnome;
327     } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document
328         $modulename = shift @ARGV;
329     } elsif ($cmd eq "-function") { # to only output specific functions
330         $function_only = 1;
331         $function = shift @ARGV;
332         $function_table{$function} = 1;
333     } elsif ($cmd eq "-nofunction") { # to only output specific functions
334         $function_only = 2;
335         $function = shift @ARGV;
336         $function_table{$function} = 1;
337     } elsif ($cmd eq "-v") {
338         $verbose = 1;
339     } elsif (($cmd eq "-h") || ($cmd eq "--help")) {
340         usage();
341     } elsif ($cmd eq '-filelist') {
342             $filelist = shift @ARGV;
343     } elsif ($cmd eq '-no-doc-sections') {
344             $no_doc_sections = 1;
345     }
346 }
347
348 # get kernel version from env
349 sub get_kernel_version() {
350     my $version = 'unknown kernel version';
351
352     if (defined($ENV{'KERNELVERSION'})) {
353         $version = $ENV{'KERNELVERSION'};
354     }
355     return $version;
356 }
357 my $kernelversion = get_kernel_version();
358
359 # generate a sequence of code that will splice in highlighting information
360 # using the s// operator.
361 my $dohighlight = "";
362 foreach my $pattern (keys %highlights) {
363 #   print STDERR "scanning pattern:$pattern, highlight:($highlights{$pattern})\n";
364     $dohighlight .=  "\$contents =~ s:$pattern:$highlights{$pattern}:gs;\n";
365 }
366
367 ##
368 # dumps section contents to arrays/hashes intended for that purpose.
369 #
370 sub dump_section {
371     my $file = shift;
372     my $name = shift;
373     my $contents = join "\n", @_;
374
375     if ($name =~ m/$type_constant/) {
376         $name = $1;
377 #       print STDERR "constant section '$1' = '$contents'\n";
378         $constants{$name} = $contents;
379     } elsif ($name =~ m/$type_param/) {
380 #       print STDERR "parameter def '$1' = '$contents'\n";
381         $name = $1;
382         $parameterdescs{$name} = $contents;
383         $sectcheck = $sectcheck . $name . " ";
384     } elsif ($name eq "@\.\.\.") {
385 #       print STDERR "parameter def '...' = '$contents'\n";
386         $name = "...";
387         $parameterdescs{$name} = $contents;
388         $sectcheck = $sectcheck . $name . " ";
389     } else {
390 #       print STDERR "other section '$name' = '$contents'\n";
391         if (defined($sections{$name}) && ($sections{$name} ne "")) {
392                 print STDERR "Error(${file}:$.): duplicate section name '$name'\n";
393                 ++$errors;
394         }
395         $sections{$name} = $contents;
396         push @sectionlist, $name;
397     }
398 }
399
400 ##
401 # dump DOC: section after checking that it should go out
402 #
403 sub dump_doc_section {
404     my $file = shift;
405     my $name = shift;
406     my $contents = join "\n", @_;
407
408     if ($no_doc_sections) {
409         return;
410     }
411
412     if (($function_only == 0) ||
413         ( $function_only == 1 && defined($function_table{$name})) ||
414         ( $function_only == 2 && !defined($function_table{$name})))
415     {
416         dump_section($file, $name, $contents);
417         output_blockhead({'sectionlist' => \@sectionlist,
418                           'sections' => \%sections,
419                           'module' => $modulename,
420                           'content-only' => ($function_only != 0), });
421     }
422 }
423
424 ##
425 # output function
426 #
427 # parameterdescs, a hash.
428 #  function => "function name"
429 #  parameterlist => @list of parameters
430 #  parameterdescs => %parameter descriptions
431 #  sectionlist => @list of sections
432 #  sections => %section descriptions
433 #
434
435 sub output_highlight {
436     my $contents = join "\n",@_;
437     my $line;
438
439 #   DEBUG
440 #   if (!defined $contents) {
441 #       use Carp;
442 #       confess "output_highlight got called with no args?\n";
443 #   }
444
445     if ($output_mode eq "html" || $output_mode eq "xml") {
446         $contents = local_unescape($contents);
447         # convert data read & converted thru xml_escape() into &xyz; format:
448         $contents =~ s/\\\\\\/&/g;
449     }
450 #   print STDERR "contents b4:$contents\n";
451     eval $dohighlight;
452     die $@ if $@;
453 #   print STDERR "contents af:$contents\n";
454
455     foreach $line (split "\n", $contents) {
456         if ($line eq ""){
457             print $lineprefix, local_unescape($blankline);
458         } else {
459             $line =~ s/\\\\\\/\&/g;
460             if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
461                 print "\\&$line";
462             } else {
463                 print $lineprefix, $line;
464             }
465         }
466         print "\n";
467     }
468 }
469
470 #output sections in html
471 sub output_section_html(%) {
472     my %args = %{$_[0]};
473     my $section;
474
475     foreach $section (@{$args{'sectionlist'}}) {
476         print "<h3>$section</h3>\n";
477         print "<blockquote>\n";
478         output_highlight($args{'sections'}{$section});
479         print "</blockquote>\n";
480     }
481 }
482
483 # output enum in html
484 sub output_enum_html(%) {
485     my %args = %{$_[0]};
486     my ($parameter);
487     my $count;
488     print "<h2>enum " . $args{'enum'} . "</h2>\n";
489
490     print "<b>enum " . $args{'enum'} . "</b> {<br>\n";
491     $count = 0;
492     foreach $parameter (@{$args{'parameterlist'}}) {
493         print " <b>" . $parameter . "</b>";
494         if ($count != $#{$args{'parameterlist'}}) {
495             $count++;
496             print ",\n";
497         }
498         print "<br>";
499     }
500     print "};<br>\n";
501
502     print "<h3>Constants</h3>\n";
503     print "<dl>\n";
504     foreach $parameter (@{$args{'parameterlist'}}) {
505         print "<dt><b>" . $parameter . "</b>\n";
506         print "<dd>";
507         output_highlight($args{'parameterdescs'}{$parameter});
508     }
509     print "</dl>\n";
510     output_section_html(@_);
511     print "<hr>\n";
512 }
513
514 # output typedef in html
515 sub output_typedef_html(%) {
516     my %args = %{$_[0]};
517     my ($parameter);
518     my $count;
519     print "<h2>typedef " . $args{'typedef'} . "</h2>\n";
520
521     print "<b>typedef " . $args{'typedef'} . "</b>\n";
522     output_section_html(@_);
523     print "<hr>\n";
524 }
525
526 # output struct in html
527 sub output_struct_html(%) {
528     my %args = %{$_[0]};
529     my ($parameter);
530
531     print "<h2>" . $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "</h2>\n";
532     print "<b>" . $args{'type'} . " " . $args{'struct'} . "</b> {<br>\n";
533     foreach $parameter (@{$args{'parameterlist'}}) {
534         if ($parameter =~ /^#/) {
535                 print "$parameter<br>\n";
536                 next;
537         }
538         my $parameter_name = $parameter;
539         $parameter_name =~ s/\[.*//;
540
541         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
542         $type = $args{'parametertypes'}{$parameter};
543         if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
544             # pointer-to-function
545             print "&nbsp; &nbsp; <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>\n";
546         } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
547             # bitfield
548             print "&nbsp; &nbsp; <i>$1</i> <b>$parameter</b>$2;<br>\n";
549         } else {
550             print "&nbsp; &nbsp; <i>$type</i> <b>$parameter</b>;<br>\n";
551         }
552     }
553     print "};<br>\n";
554
555     print "<h3>Members</h3>\n";
556     print "<dl>\n";
557     foreach $parameter (@{$args{'parameterlist'}}) {
558         ($parameter =~ /^#/) && next;
559
560         my $parameter_name = $parameter;
561         $parameter_name =~ s/\[.*//;
562
563         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
564         print "<dt><b>" . $parameter . "</b>\n";
565         print "<dd>";
566         output_highlight($args{'parameterdescs'}{$parameter_name});
567     }
568     print "</dl>\n";
569     output_section_html(@_);
570     print "<hr>\n";
571 }
572
573 # output function in html
574 sub output_function_html(%) {
575     my %args = %{$_[0]};
576     my ($parameter, $section);
577     my $count;
578
579     print "<h2>" . $args{'function'} . " - " . $args{'purpose'} . "</h2>\n";
580     print "<i>" . $args{'functiontype'} . "</i>\n";
581     print "<b>" . $args{'function'} . "</b>\n";
582     print "(";
583     $count = 0;
584     foreach $parameter (@{$args{'parameterlist'}}) {
585         $type = $args{'parametertypes'}{$parameter};
586         if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
587             # pointer-to-function
588             print "<i>$1</i><b>$parameter</b>) <i>($2)</i>";
589         } else {
590             print "<i>" . $type . "</i> <b>" . $parameter . "</b>";
591         }
592         if ($count != $#{$args{'parameterlist'}}) {
593             $count++;
594             print ",\n";
595         }
596     }
597     print ")\n";
598
599     print "<h3>Arguments</h3>\n";
600     print "<dl>\n";
601     foreach $parameter (@{$args{'parameterlist'}}) {
602         my $parameter_name = $parameter;
603         $parameter_name =~ s/\[.*//;
604
605         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
606         print "<dt><b>" . $parameter . "</b>\n";
607         print "<dd>";
608         output_highlight($args{'parameterdescs'}{$parameter_name});
609     }
610     print "</dl>\n";
611     output_section_html(@_);
612     print "<hr>\n";
613 }
614
615 # output DOC: block header in html
616 sub output_blockhead_html(%) {
617     my %args = %{$_[0]};
618     my ($parameter, $section);
619     my $count;
620
621     foreach $section (@{$args{'sectionlist'}}) {
622         print "<h3>$section</h3>\n";
623         print "<ul>\n";
624         output_highlight($args{'sections'}{$section});
625         print "</ul>\n";
626     }
627     print "<hr>\n";
628 }
629
630 sub output_section_xml(%) {
631     my %args = %{$_[0]};
632     my $section;
633     # print out each section
634     $lineprefix="   ";
635     foreach $section (@{$args{'sectionlist'}}) {
636         print "<refsect1>\n";
637         print "<title>$section</title>\n";
638         if ($section =~ m/EXAMPLE/i) {
639             print "<informalexample><programlisting>\n";
640         } else {
641             print "<para>\n";
642         }
643         output_highlight($args{'sections'}{$section});
644         if ($section =~ m/EXAMPLE/i) {
645             print "</programlisting></informalexample>\n";
646         } else {
647             print "</para>\n";
648         }
649         print "</refsect1>\n";
650     }
651 }
652
653 # output function in XML DocBook
654 sub output_function_xml(%) {
655     my %args = %{$_[0]};
656     my ($parameter, $section);
657     my $count;
658     my $id;
659
660     $id = "API-" . $args{'function'};
661     $id =~ s/[^A-Za-z0-9]/-/g;
662
663     print "<refentry id=\"$id\">\n";
664     print "<refentryinfo>\n";
665     print " <title>LINUX</title>\n";
666     print " <productname>Kernel Hackers Manual</productname>\n";
667     print " <date>$man_date</date>\n";
668     print "</refentryinfo>\n";
669     print "<refmeta>\n";
670     print " <refentrytitle><phrase>" . $args{'function'} . "</phrase></refentrytitle>\n";
671     print " <manvolnum>9</manvolnum>\n";
672     print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
673     print "</refmeta>\n";
674     print "<refnamediv>\n";
675     print " <refname>" . $args{'function'} . "</refname>\n";
676     print " <refpurpose>\n";
677     print "  ";
678     output_highlight ($args{'purpose'});
679     print " </refpurpose>\n";
680     print "</refnamediv>\n";
681
682     print "<refsynopsisdiv>\n";
683     print " <title>Synopsis</title>\n";
684     print "  <funcsynopsis><funcprototype>\n";
685     print "   <funcdef>" . $args{'functiontype'} . " ";
686     print "<function>" . $args{'function'} . " </function></funcdef>\n";
687
688     $count = 0;
689     if ($#{$args{'parameterlist'}} >= 0) {
690         foreach $parameter (@{$args{'parameterlist'}}) {
691             $type = $args{'parametertypes'}{$parameter};
692             if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
693                 # pointer-to-function
694                 print "   <paramdef>$1<parameter>$parameter</parameter>)\n";
695                 print "     <funcparams>$2</funcparams></paramdef>\n";
696             } else {
697                 print "   <paramdef>" . $type;
698                 print " <parameter>$parameter</parameter></paramdef>\n";
699             }
700         }
701     } else {
702         print "  <void/>\n";
703     }
704     print "  </funcprototype></funcsynopsis>\n";
705     print "</refsynopsisdiv>\n";
706
707     # print parameters
708     print "<refsect1>\n <title>Arguments</title>\n";
709     if ($#{$args{'parameterlist'}} >= 0) {
710         print " <variablelist>\n";
711         foreach $parameter (@{$args{'parameterlist'}}) {
712             my $parameter_name = $parameter;
713             $parameter_name =~ s/\[.*//;
714
715             print "  <varlistentry>\n   <term><parameter>$parameter</parameter></term>\n";
716             print "   <listitem>\n    <para>\n";
717             $lineprefix="     ";
718             output_highlight($args{'parameterdescs'}{$parameter_name});
719             print "    </para>\n   </listitem>\n  </varlistentry>\n";
720         }
721         print " </variablelist>\n";
722     } else {
723         print " <para>\n  None\n </para>\n";
724     }
725     print "</refsect1>\n";
726
727     output_section_xml(@_);
728     print "</refentry>\n\n";
729 }
730
731 # output struct in XML DocBook
732 sub output_struct_xml(%) {
733     my %args = %{$_[0]};
734     my ($parameter, $section);
735     my $id;
736
737     $id = "API-struct-" . $args{'struct'};
738     $id =~ s/[^A-Za-z0-9]/-/g;
739
740     print "<refentry id=\"$id\">\n";
741     print "<refentryinfo>\n";
742     print " <title>LINUX</title>\n";
743     print " <productname>Kernel Hackers Manual</productname>\n";
744     print " <date>$man_date</date>\n";
745     print "</refentryinfo>\n";
746     print "<refmeta>\n";
747     print " <refentrytitle><phrase>" . $args{'type'} . " " . $args{'struct'} . "</phrase></refentrytitle>\n";
748     print " <manvolnum>9</manvolnum>\n";
749     print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
750     print "</refmeta>\n";
751     print "<refnamediv>\n";
752     print " <refname>" . $args{'type'} . " " . $args{'struct'} . "</refname>\n";
753     print " <refpurpose>\n";
754     print "  ";
755     output_highlight ($args{'purpose'});
756     print " </refpurpose>\n";
757     print "</refnamediv>\n";
758
759     print "<refsynopsisdiv>\n";
760     print " <title>Synopsis</title>\n";
761     print "  <programlisting>\n";
762     print $args{'type'} . " " . $args{'struct'} . " {\n";
763     foreach $parameter (@{$args{'parameterlist'}}) {
764         if ($parameter =~ /^#/) {
765             print "$parameter\n";
766             next;
767         }
768
769         my $parameter_name = $parameter;
770         $parameter_name =~ s/\[.*//;
771
772         defined($args{'parameterdescs'}{$parameter_name}) || next;
773         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
774         $type = $args{'parametertypes'}{$parameter};
775         if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
776             # pointer-to-function
777             print "  $1 $parameter) ($2);\n";
778         } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
779             # bitfield
780             print "  $1 $parameter$2;\n";
781         } else {
782             print "  " . $type . " " . $parameter . ";\n";
783         }
784     }
785     print "};";
786     print "  </programlisting>\n";
787     print "</refsynopsisdiv>\n";
788
789     print " <refsect1>\n";
790     print "  <title>Members</title>\n";
791
792     if ($#{$args{'parameterlist'}} >= 0) {
793     print "  <variablelist>\n";
794     foreach $parameter (@{$args{'parameterlist'}}) {
795       ($parameter =~ /^#/) && next;
796
797       my $parameter_name = $parameter;
798       $parameter_name =~ s/\[.*//;
799
800       defined($args{'parameterdescs'}{$parameter_name}) || next;
801       ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
802       print "    <varlistentry>";
803       print "      <term>$parameter</term>\n";
804       print "      <listitem><para>\n";
805       output_highlight($args{'parameterdescs'}{$parameter_name});
806       print "      </para></listitem>\n";
807       print "    </varlistentry>\n";
808     }
809     print "  </variablelist>\n";
810     } else {
811         print " <para>\n  None\n </para>\n";
812     }
813     print " </refsect1>\n";
814
815     output_section_xml(@_);
816
817     print "</refentry>\n\n";
818 }
819
820 # output enum in XML DocBook
821 sub output_enum_xml(%) {
822     my %args = %{$_[0]};
823     my ($parameter, $section);
824     my $count;
825     my $id;
826
827     $id = "API-enum-" . $args{'enum'};
828     $id =~ s/[^A-Za-z0-9]/-/g;
829
830     print "<refentry id=\"$id\">\n";
831     print "<refentryinfo>\n";
832     print " <title>LINUX</title>\n";
833     print " <productname>Kernel Hackers Manual</productname>\n";
834     print " <date>$man_date</date>\n";
835     print "</refentryinfo>\n";
836     print "<refmeta>\n";
837     print " <refentrytitle><phrase>enum " . $args{'enum'} . "</phrase></refentrytitle>\n";
838     print " <manvolnum>9</manvolnum>\n";
839     print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
840     print "</refmeta>\n";
841     print "<refnamediv>\n";
842     print " <refname>enum " . $args{'enum'} . "</refname>\n";
843     print " <refpurpose>\n";
844     print "  ";
845     output_highlight ($args{'purpose'});
846     print " </refpurpose>\n";
847     print "</refnamediv>\n";
848
849     print "<refsynopsisdiv>\n";
850     print " <title>Synopsis</title>\n";
851     print "  <programlisting>\n";
852     print "enum " . $args{'enum'} . " {\n";
853     $count = 0;
854     foreach $parameter (@{$args{'parameterlist'}}) {
855         print "  $parameter";
856         if ($count != $#{$args{'parameterlist'}}) {
857             $count++;
858             print ",";
859         }
860         print "\n";
861     }
862     print "};";
863     print "  </programlisting>\n";
864     print "</refsynopsisdiv>\n";
865
866     print "<refsect1>\n";
867     print " <title>Constants</title>\n";
868     print "  <variablelist>\n";
869     foreach $parameter (@{$args{'parameterlist'}}) {
870       my $parameter_name = $parameter;
871       $parameter_name =~ s/\[.*//;
872
873       print "    <varlistentry>";
874       print "      <term>$parameter</term>\n";
875       print "      <listitem><para>\n";
876       output_highlight($args{'parameterdescs'}{$parameter_name});
877       print "      </para></listitem>\n";
878       print "    </varlistentry>\n";
879     }
880     print "  </variablelist>\n";
881     print "</refsect1>\n";
882
883     output_section_xml(@_);
884
885     print "</refentry>\n\n";
886 }
887
888 # output typedef in XML DocBook
889 sub output_typedef_xml(%) {
890     my %args = %{$_[0]};
891     my ($parameter, $section);
892     my $id;
893
894     $id = "API-typedef-" . $args{'typedef'};
895     $id =~ s/[^A-Za-z0-9]/-/g;
896
897     print "<refentry id=\"$id\">\n";
898     print "<refentryinfo>\n";
899     print " <title>LINUX</title>\n";
900     print " <productname>Kernel Hackers Manual</productname>\n";
901     print " <date>$man_date</date>\n";
902     print "</refentryinfo>\n";
903     print "<refmeta>\n";
904     print " <refentrytitle><phrase>typedef " . $args{'typedef'} . "</phrase></refentrytitle>\n";
905     print " <manvolnum>9</manvolnum>\n";
906     print "</refmeta>\n";
907     print "<refnamediv>\n";
908     print " <refname>typedef " . $args{'typedef'} . "</refname>\n";
909     print " <refpurpose>\n";
910     print "  ";
911     output_highlight ($args{'purpose'});
912     print " </refpurpose>\n";
913     print "</refnamediv>\n";
914
915     print "<refsynopsisdiv>\n";
916     print " <title>Synopsis</title>\n";
917     print "  <synopsis>typedef " . $args{'typedef'} . ";</synopsis>\n";
918     print "</refsynopsisdiv>\n";
919
920     output_section_xml(@_);
921
922     print "</refentry>\n\n";
923 }
924
925 # output in XML DocBook
926 sub output_blockhead_xml(%) {
927     my %args = %{$_[0]};
928     my ($parameter, $section);
929     my $count;
930
931     my $id = $args{'module'};
932     $id =~ s/[^A-Za-z0-9]/-/g;
933
934     # print out each section
935     $lineprefix="   ";
936     foreach $section (@{$args{'sectionlist'}}) {
937         if (!$args{'content-only'}) {
938                 print "<refsect1>\n <title>$section</title>\n";
939         }
940         if ($section =~ m/EXAMPLE/i) {
941             print "<example><para>\n";
942         } else {
943             print "<para>\n";
944         }
945         output_highlight($args{'sections'}{$section});
946         if ($section =~ m/EXAMPLE/i) {
947             print "</para></example>\n";
948         } else {
949             print "</para>";
950         }
951         if (!$args{'content-only'}) {
952                 print "\n</refsect1>\n";
953         }
954     }
955
956     print "\n\n";
957 }
958
959 # output in XML DocBook
960 sub output_function_gnome {
961     my %args = %{$_[0]};
962     my ($parameter, $section);
963     my $count;
964     my $id;
965
966     $id = $args{'module'} . "-" . $args{'function'};
967     $id =~ s/[^A-Za-z0-9]/-/g;
968
969     print "<sect2>\n";
970     print " <title id=\"$id\">" . $args{'function'} . "</title>\n";
971
972     print "  <funcsynopsis>\n";
973     print "   <funcdef>" . $args{'functiontype'} . " ";
974     print "<function>" . $args{'function'} . " ";
975     print "</function></funcdef>\n";
976
977     $count = 0;
978     if ($#{$args{'parameterlist'}} >= 0) {
979         foreach $parameter (@{$args{'parameterlist'}}) {
980             $type = $args{'parametertypes'}{$parameter};
981             if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
982                 # pointer-to-function
983                 print "   <paramdef>$1 <parameter>$parameter</parameter>)\n";
984                 print "     <funcparams>$2</funcparams></paramdef>\n";
985             } else {
986                 print "   <paramdef>" . $type;
987                 print " <parameter>$parameter</parameter></paramdef>\n";
988             }
989         }
990     } else {
991         print "  <void>\n";
992     }
993     print "  </funcsynopsis>\n";
994     if ($#{$args{'parameterlist'}} >= 0) {
995         print " <informaltable pgwide=\"1\" frame=\"none\" role=\"params\">\n";
996         print "<tgroup cols=\"2\">\n";
997         print "<colspec colwidth=\"2*\">\n";
998         print "<colspec colwidth=\"8*\">\n";
999         print "<tbody>\n";
1000         foreach $parameter (@{$args{'parameterlist'}}) {
1001             my $parameter_name = $parameter;
1002             $parameter_name =~ s/\[.*//;
1003
1004             print "  <row><entry align=\"right\"><parameter>$parameter</parameter></entry>\n";
1005             print "   <entry>\n";
1006             $lineprefix="     ";
1007             output_highlight($args{'parameterdescs'}{$parameter_name});
1008             print "    </entry></row>\n";
1009         }
1010         print " </tbody></tgroup></informaltable>\n";
1011     } else {
1012         print " <para>\n  None\n </para>\n";
1013     }
1014
1015     # print out each section
1016     $lineprefix="   ";
1017     foreach $section (@{$args{'sectionlist'}}) {
1018         print "<simplesect>\n <title>$section</title>\n";
1019         if ($section =~ m/EXAMPLE/i) {
1020             print "<example><programlisting>\n";
1021         } else {
1022         }
1023         print "<para>\n";
1024         output_highlight($args{'sections'}{$section});
1025         print "</para>\n";
1026         if ($section =~ m/EXAMPLE/i) {
1027             print "</programlisting></example>\n";
1028         } else {
1029         }
1030         print " </simplesect>\n";
1031     }
1032
1033     print "</sect2>\n\n";
1034 }
1035
1036 ##
1037 # output function in man
1038 sub output_function_man(%) {
1039     my %args = %{$_[0]};
1040     my ($parameter, $section);
1041     my $count;
1042
1043     print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
1044
1045     print ".SH NAME\n";
1046     print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
1047
1048     print ".SH SYNOPSIS\n";
1049     if ($args{'functiontype'} ne "") {
1050         print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
1051     } else {
1052         print ".B \"" . $args{'function'} . "\n";
1053     }
1054     $count = 0;
1055     my $parenth = "(";
1056     my $post = ",";
1057     foreach my $parameter (@{$args{'parameterlist'}}) {
1058         if ($count == $#{$args{'parameterlist'}}) {
1059             $post = ");";
1060         }
1061         $type = $args{'parametertypes'}{$parameter};
1062         if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1063             # pointer-to-function
1064             print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n";
1065         } else {
1066             $type =~ s/([^\*])$/$1 /;
1067             print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n";
1068         }
1069         $count++;
1070         $parenth = "";
1071     }
1072
1073     print ".SH ARGUMENTS\n";
1074     foreach $parameter (@{$args{'parameterlist'}}) {
1075         my $parameter_name = $parameter;
1076         $parameter_name =~ s/\[.*//;
1077
1078         print ".IP \"" . $parameter . "\" 12\n";
1079         output_highlight($args{'parameterdescs'}{$parameter_name});
1080     }
1081     foreach $section (@{$args{'sectionlist'}}) {
1082         print ".SH \"", uc $section, "\"\n";
1083         output_highlight($args{'sections'}{$section});
1084     }
1085 }
1086
1087 ##
1088 # output enum in man
1089 sub output_enum_man(%) {
1090     my %args = %{$_[0]};
1091     my ($parameter, $section);
1092     my $count;
1093
1094     print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
1095
1096     print ".SH NAME\n";
1097     print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
1098
1099     print ".SH SYNOPSIS\n";
1100     print "enum " . $args{'enum'} . " {\n";
1101     $count = 0;
1102     foreach my $parameter (@{$args{'parameterlist'}}) {
1103         print ".br\n.BI \"    $parameter\"\n";
1104         if ($count == $#{$args{'parameterlist'}}) {
1105             print "\n};\n";
1106             last;
1107         }
1108         else {
1109             print ", \n.br\n";
1110         }
1111         $count++;
1112     }
1113
1114     print ".SH Constants\n";
1115     foreach $parameter (@{$args{'parameterlist'}}) {
1116         my $parameter_name = $parameter;
1117         $parameter_name =~ s/\[.*//;
1118
1119         print ".IP \"" . $parameter . "\" 12\n";
1120         output_highlight($args{'parameterdescs'}{$parameter_name});
1121     }
1122     foreach $section (@{$args{'sectionlist'}}) {
1123         print ".SH \"$section\"\n";
1124         output_highlight($args{'sections'}{$section});
1125     }
1126 }
1127
1128 ##
1129 # output struct in man
1130 sub output_struct_man(%) {
1131     my %args = %{$_[0]};
1132     my ($parameter, $section);
1133
1134     print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
1135
1136     print ".SH NAME\n";
1137     print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
1138
1139     print ".SH SYNOPSIS\n";
1140     print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
1141
1142     foreach my $parameter (@{$args{'parameterlist'}}) {
1143         if ($parameter =~ /^#/) {
1144             print ".BI \"$parameter\"\n.br\n";
1145             next;
1146         }
1147         my $parameter_name = $parameter;
1148         $parameter_name =~ s/\[.*//;
1149
1150         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1151         $type = $args{'parametertypes'}{$parameter};
1152         if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1153             # pointer-to-function
1154             print ".BI \"    " . $1 . "\" " . $parameter . " \") (" . $2 . ")" . "\"\n;\n";
1155         } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1156             # bitfield
1157             print ".BI \"    " . $1 . "\ \" " . $parameter . $2 . " \"" . "\"\n;\n";
1158         } else {
1159             $type =~ s/([^\*])$/$1 /;
1160             print ".BI \"    " . $type . "\" " . $parameter . " \"" . "\"\n;\n";
1161         }
1162         print "\n.br\n";
1163     }
1164     print "};\n.br\n";
1165
1166     print ".SH Members\n";
1167     foreach $parameter (@{$args{'parameterlist'}}) {
1168         ($parameter =~ /^#/) && next;
1169
1170         my $parameter_name = $parameter;
1171         $parameter_name =~ s/\[.*//;
1172
1173         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1174         print ".IP \"" . $parameter . "\" 12\n";
1175         output_highlight($args{'parameterdescs'}{$parameter_name});
1176     }
1177     foreach $section (@{$args{'sectionlist'}}) {
1178         print ".SH \"$section\"\n";
1179         output_highlight($args{'sections'}{$section});
1180     }
1181 }
1182
1183 ##
1184 # output typedef in man
1185 sub output_typedef_man(%) {
1186     my %args = %{$_[0]};
1187     my ($parameter, $section);
1188
1189     print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
1190
1191     print ".SH NAME\n";
1192     print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
1193
1194     foreach $section (@{$args{'sectionlist'}}) {
1195         print ".SH \"$section\"\n";
1196         output_highlight($args{'sections'}{$section});
1197     }
1198 }
1199
1200 sub output_blockhead_man(%) {
1201     my %args = %{$_[0]};
1202     my ($parameter, $section);
1203     my $count;
1204
1205     print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
1206
1207     foreach $section (@{$args{'sectionlist'}}) {
1208         print ".SH \"$section\"\n";
1209         output_highlight($args{'sections'}{$section});
1210     }
1211 }
1212
1213 ##
1214 # output in text
1215 sub output_function_text(%) {
1216     my %args = %{$_[0]};
1217     my ($parameter, $section);
1218     my $start;
1219
1220     print "Name:\n\n";
1221     print $args{'function'} . " - " . $args{'purpose'} . "\n";
1222
1223     print "\nSynopsis:\n\n";
1224     if ($args{'functiontype'} ne "") {
1225         $start = $args{'functiontype'} . " " . $args{'function'} . " (";
1226     } else {
1227         $start = $args{'function'} . " (";
1228     }
1229     print $start;
1230
1231     my $count = 0;
1232     foreach my $parameter (@{$args{'parameterlist'}}) {
1233         $type = $args{'parametertypes'}{$parameter};
1234         if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1235             # pointer-to-function
1236             print $1 . $parameter . ") (" . $2;
1237         } else {
1238             print $type . " " . $parameter;
1239         }
1240         if ($count != $#{$args{'parameterlist'}}) {
1241             $count++;
1242             print ",\n";
1243             print " " x length($start);
1244         } else {
1245             print ");\n\n";
1246         }
1247     }
1248
1249     print "Arguments:\n\n";
1250     foreach $parameter (@{$args{'parameterlist'}}) {
1251         my $parameter_name = $parameter;
1252         $parameter_name =~ s/\[.*//;
1253
1254         print $parameter . "\n\t" . $args{'parameterdescs'}{$parameter_name} . "\n";
1255     }
1256     output_section_text(@_);
1257 }
1258
1259 #output sections in text
1260 sub output_section_text(%) {
1261     my %args = %{$_[0]};
1262     my $section;
1263
1264     print "\n";
1265     foreach $section (@{$args{'sectionlist'}}) {
1266         print "$section:\n\n";
1267         output_highlight($args{'sections'}{$section});
1268     }
1269     print "\n\n";
1270 }
1271
1272 # output enum in text
1273 sub output_enum_text(%) {
1274     my %args = %{$_[0]};
1275     my ($parameter);
1276     my $count;
1277     print "Enum:\n\n";
1278
1279     print "enum " . $args{'enum'} . " - " . $args{'purpose'} . "\n\n";
1280     print "enum " . $args{'enum'} . " {\n";
1281     $count = 0;
1282     foreach $parameter (@{$args{'parameterlist'}}) {
1283         print "\t$parameter";
1284         if ($count != $#{$args{'parameterlist'}}) {
1285             $count++;
1286             print ",";
1287         }
1288         print "\n";
1289     }
1290     print "};\n\n";
1291
1292     print "Constants:\n\n";
1293     foreach $parameter (@{$args{'parameterlist'}}) {
1294         print "$parameter\n\t";
1295         print $args{'parameterdescs'}{$parameter} . "\n";
1296     }
1297
1298     output_section_text(@_);
1299 }
1300
1301 # output typedef in text
1302 sub output_typedef_text(%) {
1303     my %args = %{$_[0]};
1304     my ($parameter);
1305     my $count;
1306     print "Typedef:\n\n";
1307
1308     print "typedef " . $args{'typedef'} . " - " . $args{'purpose'} . "\n";
1309     output_section_text(@_);
1310 }
1311
1312 # output struct as text
1313 sub output_struct_text(%) {
1314     my %args = %{$_[0]};
1315     my ($parameter);
1316
1317     print $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "\n\n";
1318     print $args{'type'} . " " . $args{'struct'} . " {\n";
1319     foreach $parameter (@{$args{'parameterlist'}}) {
1320         if ($parameter =~ /^#/) {
1321             print "$parameter\n";
1322             next;
1323         }
1324
1325         my $parameter_name = $parameter;
1326         $parameter_name =~ s/\[.*//;
1327
1328         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1329         $type = $args{'parametertypes'}{$parameter};
1330         if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1331             # pointer-to-function
1332             print "\t$1 $parameter) ($2);\n";
1333         } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1334             # bitfield
1335             print "\t$1 $parameter$2;\n";
1336         } else {
1337             print "\t" . $type . " " . $parameter . ";\n";
1338         }
1339     }
1340     print "};\n\n";
1341
1342     print "Members:\n\n";
1343     foreach $parameter (@{$args{'parameterlist'}}) {
1344         ($parameter =~ /^#/) && next;
1345
1346         my $parameter_name = $parameter;
1347         $parameter_name =~ s/\[.*//;
1348
1349         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1350         print "$parameter\n\t";
1351         print $args{'parameterdescs'}{$parameter_name} . "\n";
1352     }
1353     print "\n";
1354     output_section_text(@_);
1355 }
1356
1357 sub output_blockhead_text(%) {
1358     my %args = %{$_[0]};
1359     my ($parameter, $section);
1360
1361     foreach $section (@{$args{'sectionlist'}}) {
1362         print " $section:\n";
1363         print "    -> ";
1364         output_highlight($args{'sections'}{$section});
1365     }
1366 }
1367
1368 ##
1369 # generic output function for all types (function, struct/union, typedef, enum);
1370 # calls the generated, variable output_ function name based on
1371 # functype and output_mode
1372 sub output_declaration {
1373     no strict 'refs';
1374     my $name = shift;
1375     my $functype = shift;
1376     my $func = "output_${functype}_$output_mode";
1377     if (($function_only==0) ||
1378         ( $function_only == 1 && defined($function_table{$name})) ||
1379         ( $function_only == 2 && !defined($function_table{$name})))
1380     {
1381         &$func(@_);
1382         $section_counter++;
1383     }
1384 }
1385
1386 ##
1387 # generic output function - calls the right one based on current output mode.
1388 sub output_blockhead {
1389     no strict 'refs';
1390     my $func = "output_blockhead_" . $output_mode;
1391     &$func(@_);
1392     $section_counter++;
1393 }
1394
1395 ##
1396 # takes a declaration (struct, union, enum, typedef) and
1397 # invokes the right handler. NOT called for functions.
1398 sub dump_declaration($$) {
1399     no strict 'refs';
1400     my ($prototype, $file) = @_;
1401     my $func = "dump_" . $decl_type;
1402     &$func(@_);
1403 }
1404
1405 sub dump_union($$) {
1406     dump_struct(@_);
1407 }
1408
1409 sub dump_struct($$) {
1410     my $x = shift;
1411     my $file = shift;
1412     my $nested;
1413
1414     if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) {
1415         #my $decl_type = $1;
1416         $declaration_name = $2;
1417         my $members = $3;
1418
1419         # ignore embedded structs or unions
1420         $members =~ s/({.*})//g;
1421         $nested = $1;
1422
1423         # ignore members marked private:
1424         $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gos;
1425         $members =~ s/\/\*\s*private:.*//gos;
1426         # strip comments:
1427         $members =~ s/\/\*.*?\*\///gos;
1428         $nested =~ s/\/\*.*?\*\///gos;
1429
1430         create_parameterlist($members, ';', $file);
1431         check_sections($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested);
1432
1433         output_declaration($declaration_name,
1434                            'struct',
1435                            {'struct' => $declaration_name,
1436                             'module' => $modulename,
1437                             'parameterlist' => \@parameterlist,
1438                             'parameterdescs' => \%parameterdescs,
1439                             'parametertypes' => \%parametertypes,
1440                             'sectionlist' => \@sectionlist,
1441                             'sections' => \%sections,
1442                             'purpose' => $declaration_purpose,
1443                             'type' => $decl_type
1444                            });
1445     }
1446     else {
1447         print STDERR "Error(${file}:$.): Cannot parse struct or union!\n";
1448         ++$errors;
1449     }
1450 }
1451
1452 sub dump_enum($$) {
1453     my $x = shift;
1454     my $file = shift;
1455
1456     $x =~ s@/\*.*?\*/@@gos;     # strip comments.
1457     if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
1458         $declaration_name = $1;
1459         my $members = $2;
1460
1461         foreach my $arg (split ',', $members) {
1462             $arg =~ s/^\s*(\w+).*/$1/;
1463             push @parameterlist, $arg;
1464             if (!$parameterdescs{$arg}) {
1465                 $parameterdescs{$arg} = $undescribed;
1466                 print STDERR "Warning(${file}:$.): Enum value '$arg' ".
1467                     "not described in enum '$declaration_name'\n";
1468             }
1469
1470         }
1471         # strip kmemcheck_bitfield_{begin,end}.*;
1472         $members =~ s/kmemcheck_bitfield_.*?;//gos;
1473
1474         output_declaration($declaration_name,
1475                            'enum',
1476                            {'enum' => $declaration_name,
1477                             'module' => $modulename,
1478                             'parameterlist' => \@parameterlist,
1479                             'parameterdescs' => \%parameterdescs,
1480                             'sectionlist' => \@sectionlist,
1481                             'sections' => \%sections,
1482                             'purpose' => $declaration_purpose
1483                            });
1484     }
1485     else {
1486         print STDERR "Error(${file}:$.): Cannot parse enum!\n";
1487         ++$errors;
1488     }
1489 }
1490
1491 sub dump_typedef($$) {
1492     my $x = shift;
1493     my $file = shift;
1494
1495     $x =~ s@/\*.*?\*/@@gos;     # strip comments.
1496     while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1497         $x =~ s/\(*.\)\s*;$/;/;
1498         $x =~ s/\[*.\]\s*;$/;/;
1499     }
1500
1501     if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1502         $declaration_name = $1;
1503
1504         output_declaration($declaration_name,
1505                            'typedef',
1506                            {'typedef' => $declaration_name,
1507                             'module' => $modulename,
1508                             'sectionlist' => \@sectionlist,
1509                             'sections' => \%sections,
1510                             'purpose' => $declaration_purpose
1511                            });
1512     }
1513     else {
1514         print STDERR "Error(${file}:$.): Cannot parse typedef!\n";
1515         ++$errors;
1516     }
1517 }
1518
1519 sub save_struct_actual($) {
1520     my $actual = shift;
1521
1522     # strip all spaces from the actual param so that it looks like one string item
1523     $actual =~ s/\s*//g;
1524     $struct_actual = $struct_actual . $actual . " ";
1525 }
1526
1527 sub create_parameterlist($$$) {
1528     my $args = shift;
1529     my $splitter = shift;
1530     my $file = shift;
1531     my $type;
1532     my $param;
1533
1534     # temporarily replace commas inside function pointer definition
1535     while ($args =~ /(\([^\),]+),/) {
1536         $args =~ s/(\([^\),]+),/$1#/g;
1537     }
1538
1539     foreach my $arg (split($splitter, $args)) {
1540         # strip comments
1541         $arg =~ s/\/\*.*\*\///;
1542         # strip leading/trailing spaces
1543         $arg =~ s/^\s*//;
1544         $arg =~ s/\s*$//;
1545         $arg =~ s/\s+/ /;
1546
1547         if ($arg =~ /^#/) {
1548             # Treat preprocessor directive as a typeless variable just to fill
1549             # corresponding data structures "correctly". Catch it later in
1550             # output_* subs.
1551             push_parameter($arg, "", $file);
1552         } elsif ($arg =~ m/\(.+\)\s*\(/) {
1553             # pointer-to-function
1554             $arg =~ tr/#/,/;
1555             $arg =~ m/[^\(]+\(\*?\s*(\w*)\s*\)/;
1556             $param = $1;
1557             $type = $arg;
1558             $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1559             save_struct_actual($param);
1560             push_parameter($param, $type, $file);
1561         } elsif ($arg) {
1562             $arg =~ s/\s*:\s*/:/g;
1563             $arg =~ s/\s*\[/\[/g;
1564
1565             my @args = split('\s*,\s*', $arg);
1566             if ($args[0] =~ m/\*/) {
1567                 $args[0] =~ s/(\*+)\s*/ $1/;
1568             }
1569
1570             my @first_arg;
1571             if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1572                     shift @args;
1573                     push(@first_arg, split('\s+', $1));
1574                     push(@first_arg, $2);
1575             } else {
1576                     @first_arg = split('\s+', shift @args);
1577             }
1578
1579             unshift(@args, pop @first_arg);
1580             $type = join " ", @first_arg;
1581
1582             foreach $param (@args) {
1583                 if ($param =~ m/^(\*+)\s*(.*)/) {
1584                     save_struct_actual($2);
1585                     push_parameter($2, "$type $1", $file);
1586                 }
1587                 elsif ($param =~ m/(.*?):(\d+)/) {
1588                     if ($type ne "") { # skip unnamed bit-fields
1589                         save_struct_actual($1);
1590                         push_parameter($1, "$type:$2", $file)
1591                     }
1592                 }
1593                 else {
1594                     save_struct_actual($param);
1595                     push_parameter($param, $type, $file);
1596                 }
1597             }
1598         }
1599     }
1600 }
1601
1602 sub push_parameter($$$) {
1603         my $param = shift;
1604         my $type = shift;
1605         my $file = shift;
1606
1607         if (($anon_struct_union == 1) && ($type eq "") &&
1608             ($param eq "}")) {
1609                 return;         # ignore the ending }; from anon. struct/union
1610         }
1611
1612         $anon_struct_union = 0;
1613         my $param_name = $param;
1614         $param_name =~ s/\[.*//;
1615
1616         if ($type eq "" && $param =~ /\.\.\.$/)
1617         {
1618             if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1619                 $parameterdescs{$param} = "variable arguments";
1620             }
1621         }
1622         elsif ($type eq "" && ($param eq "" or $param eq "void"))
1623         {
1624             $param="void";
1625             $parameterdescs{void} = "no arguments";
1626         }
1627         elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1628         # handle unnamed (anonymous) union or struct:
1629         {
1630                 $type = $param;
1631                 $param = "{unnamed_" . $param . "}";
1632                 $parameterdescs{$param} = "anonymous\n";
1633                 $anon_struct_union = 1;
1634         }
1635
1636         # warn if parameter has no description
1637         # (but ignore ones starting with # as these are not parameters
1638         # but inline preprocessor statements);
1639         # also ignore unnamed structs/unions;
1640         if (!$anon_struct_union) {
1641         if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) {
1642
1643             $parameterdescs{$param_name} = $undescribed;
1644
1645             if (($type eq 'function') || ($type eq 'enum')) {
1646                 print STDERR "Warning(${file}:$.): Function parameter ".
1647                     "or member '$param' not " .
1648                     "described in '$declaration_name'\n";
1649             }
1650             print STDERR "Warning(${file}:$.):" .
1651                          " No description found for parameter '$param'\n";
1652             ++$warnings;
1653         }
1654         }
1655
1656         push @parameterlist, $param;
1657         $parametertypes{$param} = $type;
1658 }
1659
1660 sub check_sections($$$$$$) {
1661         my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck, $nested) = @_;
1662         my @sects = split ' ', $sectcheck;
1663         my @prms = split ' ', $prmscheck;
1664         my $err;
1665         my ($px, $sx);
1666         my $prm_clean;          # strip trailing "[array size]" and/or beginning "*"
1667
1668         foreach $sx (0 .. $#sects) {
1669                 $err = 1;
1670                 foreach $px (0 .. $#prms) {
1671                         $prm_clean = $prms[$px];
1672                         $prm_clean =~ s/\[.*\]//;
1673                         $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//;
1674                         ##$prm_clean =~ s/^\**//;
1675                         if ($prm_clean eq $sects[$sx]) {
1676                                 $err = 0;
1677                                 last;
1678                         }
1679                 }
1680                 if ($err) {
1681                         if ($decl_type eq "function") {
1682                                 print STDERR "Warning(${file}:$.): " .
1683                                         "Excess function parameter " .
1684                                         "'$sects[$sx]' " .
1685                                         "description in '$decl_name'\n";
1686                                 ++$warnings;
1687                         } else {
1688                                 if ($nested !~ m/\Q$sects[$sx]\E/) {
1689                                     print STDERR "Warning(${file}:$.): " .
1690                                         "Excess struct/union/enum/typedef member " .
1691                                         "'$sects[$sx]' " .
1692                                         "description in '$decl_name'\n";
1693                                     ++$warnings;
1694                                 }
1695                         }
1696                 }
1697         }
1698 }
1699
1700 ##
1701 # takes a function prototype and the name of the current file being
1702 # processed and spits out all the details stored in the global
1703 # arrays/hashes.
1704 sub dump_function($$) {
1705     my $prototype = shift;
1706     my $file = shift;
1707
1708     $prototype =~ s/^static +//;
1709     $prototype =~ s/^extern +//;
1710     $prototype =~ s/^asmlinkage +//;
1711     $prototype =~ s/^inline +//;
1712     $prototype =~ s/^__inline__ +//;
1713     $prototype =~ s/^__inline +//;
1714     $prototype =~ s/^__always_inline +//;
1715     $prototype =~ s/^noinline +//;
1716     $prototype =~ s/__devinit +//;
1717     $prototype =~ s/__init +//;
1718     $prototype =~ s/^#\s*define\s+//; #ak added
1719     $prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//;
1720
1721     # Yes, this truly is vile.  We are looking for:
1722     # 1. Return type (may be nothing if we're looking at a macro)
1723     # 2. Function name
1724     # 3. Function parameters.
1725     #
1726     # All the while we have to watch out for function pointer parameters
1727     # (which IIRC is what the two sections are for), C types (these
1728     # regexps don't even start to express all the possibilities), and
1729     # so on.
1730     #
1731     # If you mess with these regexps, it's a good idea to check that
1732     # the following functions' documentation still comes out right:
1733     # - parport_register_device (function pointer parameters)
1734     # - atomic_set (macro)
1735     # - pci_match_device, __copy_to_user (long return type)
1736
1737     if ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1738         $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1739         $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1740         $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1741         $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1742         $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1743         $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1744         $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1745         $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1746         $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1747         $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1748         $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1749         $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1750         $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1751         $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1752         $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1753         $prototype =~ m/^(\w+\s+\w+\s*\*\s*\w+\s*\*\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/)  {
1754         $return_type = $1;
1755         $declaration_name = $2;
1756         my $args = $3;
1757
1758         create_parameterlist($args, ',', $file);
1759     } else {
1760         print STDERR "Error(${file}:$.): cannot understand prototype: '$prototype'\n";
1761         ++$errors;
1762         return;
1763     }
1764
1765         my $prms = join " ", @parameterlist;
1766         check_sections($file, $declaration_name, "function", $sectcheck, $prms, "");
1767
1768     output_declaration($declaration_name,
1769                        'function',
1770                        {'function' => $declaration_name,
1771                         'module' => $modulename,
1772                         'functiontype' => $return_type,
1773                         'parameterlist' => \@parameterlist,
1774                         'parameterdescs' => \%parameterdescs,
1775                         'parametertypes' => \%parametertypes,
1776                         'sectionlist' => \@sectionlist,
1777                         'sections' => \%sections,
1778                         'purpose' => $declaration_purpose
1779                        });
1780 }
1781
1782 sub process_file($);
1783
1784 # Read the file that maps relative names to absolute names for
1785 # separate source and object directories and for shadow trees.
1786 if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
1787         my ($relname, $absname);
1788         while(<SOURCE_MAP>) {
1789                 chop();
1790                 ($relname, $absname) = (split())[0..1];
1791                 $relname =~ s:^/+::;
1792                 $source_map{$relname} = $absname;
1793         }
1794         close(SOURCE_MAP);
1795 }
1796
1797 if ($filelist) {
1798         open(FLIST,"<$filelist") or die "Can't open file list $filelist";
1799         while(<FLIST>) {
1800                 chop;
1801                 process_file($_);
1802         }
1803 }
1804
1805 foreach (@ARGV) {
1806     chomp;
1807     process_file($_);
1808 }
1809 if ($verbose && $errors) {
1810   print STDERR "$errors errors\n";
1811 }
1812 if ($verbose && $warnings) {
1813   print STDERR "$warnings warnings\n";
1814 }
1815
1816 exit($errors);
1817
1818 sub reset_state {
1819     $function = "";
1820     %constants = ();
1821     %parameterdescs = ();
1822     %parametertypes = ();
1823     @parameterlist = ();
1824     %sections = ();
1825     @sectionlist = ();
1826     $sectcheck = "";
1827     $struct_actual = "";
1828     $prototype = "";
1829
1830     $state = 0;
1831 }
1832
1833 sub tracepoint_munge($) {
1834         my $file = shift;
1835         my $tracepointname = 0;
1836         my $tracepointargs = 0;
1837
1838         if($prototype =~ m/TRACE_EVENT\((.*?),/) {
1839                 $tracepointname = $1;
1840         }
1841         if($prototype =~ m/TP_PROTO\((.*?)\)/) {
1842                 $tracepointargs = $1;
1843         }
1844         if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1845                 print STDERR "Warning(${file}:$.): Unrecognized tracepoint format: \n".
1846                              "$prototype\n";
1847         } else {
1848                 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1849         }
1850 }
1851
1852 sub syscall_munge() {
1853         my $void = 0;
1854
1855         $prototype =~ s@[\r\n\t]+@ @gos; # strip newlines/CR's/tabs
1856 ##      if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1857         if ($prototype =~ m/SYSCALL_DEFINE0/) {
1858                 $void = 1;
1859 ##              $prototype = "long sys_$1(void)";
1860         }
1861
1862         $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1863         if ($prototype =~ m/long (sys_.*?),/) {
1864                 $prototype =~ s/,/\(/;
1865         } elsif ($void) {
1866                 $prototype =~ s/\)/\(void\)/;
1867         }
1868
1869         # now delete all of the odd-number commas in $prototype
1870         # so that arg types & arg names don't have a comma between them
1871         my $count = 0;
1872         my $len = length($prototype);
1873         if ($void) {
1874                 $len = 0;       # skip the for-loop
1875         }
1876         for (my $ix = 0; $ix < $len; $ix++) {
1877                 if (substr($prototype, $ix, 1) eq ',') {
1878                         $count++;
1879                         if ($count % 2 == 1) {
1880                                 substr($prototype, $ix, 1) = ' ';
1881                         }
1882                 }
1883         }
1884 }
1885
1886 sub process_state3_function($$) {
1887     my $x = shift;
1888     my $file = shift;
1889
1890     $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1891
1892     if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
1893         # do nothing
1894     }
1895     elsif ($x =~ /([^\{]*)/) {
1896         $prototype .= $1;
1897     }
1898
1899     if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1900         $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1901         $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1902         $prototype =~ s@^\s+@@gos; # strip leading spaces
1903         if ($prototype =~ /SYSCALL_DEFINE/) {
1904                 syscall_munge();
1905         }
1906         if ($prototype =~ /TRACE_EVENT/) {
1907                 tracepoint_munge($file);
1908         }
1909         dump_function($prototype, $file);
1910         reset_state();
1911     }
1912 }
1913
1914 sub process_state3_type($$) {
1915     my $x = shift;
1916     my $file = shift;
1917
1918     $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1919     $x =~ s@^\s+@@gos; # strip leading spaces
1920     $x =~ s@\s+$@@gos; # strip trailing spaces
1921     $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1922
1923     if ($x =~ /^#/) {
1924         # To distinguish preprocessor directive from regular declaration later.
1925         $x .= ";";
1926     }
1927
1928     while (1) {
1929         if ( $x =~ /([^{};]*)([{};])(.*)/ ) {
1930             $prototype .= $1 . $2;
1931             ($2 eq '{') && $brcount++;
1932             ($2 eq '}') && $brcount--;
1933             if (($2 eq ';') && ($brcount == 0)) {
1934                 dump_declaration($prototype, $file);
1935                 reset_state();
1936                 last;
1937             }
1938             $x = $3;
1939         } else {
1940             $prototype .= $x;
1941             last;
1942         }
1943     }
1944 }
1945
1946 # xml_escape: replace <, >, and & in the text stream;
1947 #
1948 # however, formatting controls that are generated internally/locally in the
1949 # kernel-doc script are not escaped here; instead, they begin life like
1950 # $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings
1951 # are converted to their mnemonic-expected output, without the 4 * '\' & ':',
1952 # just before actual output; (this is done by local_unescape())
1953 sub xml_escape($) {
1954         my $text = shift;
1955         if (($output_mode eq "text") || ($output_mode eq "man")) {
1956                 return $text;
1957         }
1958         $text =~ s/\&/\\\\\\amp;/g;
1959         $text =~ s/\</\\\\\\lt;/g;
1960         $text =~ s/\>/\\\\\\gt;/g;
1961         return $text;
1962 }
1963
1964 # convert local escape strings to html
1965 # local escape strings look like:  '\\\\menmonic:' (that's 4 backslashes)
1966 sub local_unescape($) {
1967         my $text = shift;
1968         if (($output_mode eq "text") || ($output_mode eq "man")) {
1969                 return $text;
1970         }
1971         $text =~ s/\\\\\\\\lt:/</g;
1972         $text =~ s/\\\\\\\\gt:/>/g;
1973         return $text;
1974 }
1975
1976 sub process_file($) {
1977     my $file;
1978     my $identifier;
1979     my $func;
1980     my $descr;
1981     my $initial_section_counter = $section_counter;
1982
1983     if (defined($ENV{'SRCTREE'})) {
1984         $file = "$ENV{'SRCTREE'}" . "/" . "@_";
1985     }
1986     else {
1987         $file = "@_";
1988     }
1989     if (defined($source_map{$file})) {
1990         $file = $source_map{$file};
1991     }
1992
1993     if (!open(IN,"<$file")) {
1994         print STDERR "Error: Cannot open file $file\n";
1995         ++$errors;
1996         return;
1997     }
1998
1999     $section_counter = 0;
2000     while (<IN>) {
2001         if ($state == 0) {
2002             if (/$doc_start/o) {
2003                 $state = 1;             # next line is always the function name
2004                 $in_doc_sect = 0;
2005             }
2006         } elsif ($state == 1) { # this line is the function name (always)
2007             if (/$doc_block/o) {
2008                 $state = 4;
2009                 $contents = "";
2010                 if ( $1 eq "" ) {
2011                         $section = $section_intro;
2012                 } else {
2013                         $section = $1;
2014                 }
2015             }
2016             elsif (/$doc_decl/o) {
2017                 $identifier = $1;
2018                 if (/\s*([\w\s]+?)\s*-/) {
2019                     $identifier = $1;
2020                 }
2021
2022                 $state = 2;
2023                 if (/-(.*)/) {
2024                     # strip leading/trailing/multiple spaces
2025                     $descr= $1;
2026                     $descr =~ s/^\s*//;
2027                     $descr =~ s/\s*$//;
2028                     $descr =~ s/\s+/ /;
2029                     $declaration_purpose = xml_escape($descr);
2030                 } else {
2031                     $declaration_purpose = "";
2032                 }
2033
2034                 if (($declaration_purpose eq "") && $verbose) {
2035                         print STDERR "Warning(${file}:$.): missing initial short description on line:\n";
2036                         print STDERR $_;
2037                         ++$warnings;
2038                 }
2039
2040                 if ($identifier =~ m/^struct/) {
2041                     $decl_type = 'struct';
2042                 } elsif ($identifier =~ m/^union/) {
2043                     $decl_type = 'union';
2044                 } elsif ($identifier =~ m/^enum/) {
2045                     $decl_type = 'enum';
2046                 } elsif ($identifier =~ m/^typedef/) {
2047                     $decl_type = 'typedef';
2048                 } else {
2049                     $decl_type = 'function';
2050                 }
2051
2052                 if ($verbose) {
2053                     print STDERR "Info(${file}:$.): Scanning doc for $identifier\n";
2054                 }
2055             } else {
2056                 print STDERR "Warning(${file}:$.): Cannot understand $_ on line $.",
2057                 " - I thought it was a doc line\n";
2058                 ++$warnings;
2059                 $state = 0;
2060             }
2061         } elsif ($state == 2) { # look for head: lines, and include content
2062             if (/$doc_sect/o) {
2063                 $newsection = $1;
2064                 $newcontents = $2;
2065
2066                 if (($contents ne "") && ($contents ne "\n")) {
2067                     if (!$in_doc_sect && $verbose) {
2068                         print STDERR "Warning(${file}:$.): contents before sections\n";
2069                         ++$warnings;
2070                     }
2071                     dump_section($file, $section, xml_escape($contents));
2072                     $section = $section_default;
2073                 }
2074
2075                 $in_doc_sect = 1;
2076                 $contents = $newcontents;
2077                 if ($contents ne "") {
2078                     while ((substr($contents, 0, 1) eq " ") ||
2079                         substr($contents, 0, 1) eq "\t") {
2080                             $contents = substr($contents, 1);
2081                     }
2082                     $contents .= "\n";
2083                 }
2084                 $section = $newsection;
2085             } elsif (/$doc_end/) {
2086
2087                 if ($contents ne "") {
2088                     dump_section($file, $section, xml_escape($contents));
2089                     $section = $section_default;
2090                     $contents = "";
2091                 }
2092                 # look for doc_com + <text> + doc_end:
2093                 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2094                     print STDERR "Warning(${file}:$.): suspicious ending line: $_";
2095                     ++$warnings;
2096                 }
2097
2098                 $prototype = "";
2099                 $state = 3;
2100                 $brcount = 0;
2101 #               print STDERR "end of doc comment, looking for prototype\n";
2102             } elsif (/$doc_content/) {
2103                 # miguel-style comment kludge, look for blank lines after
2104                 # @parameter line to signify start of description
2105                 if ($1 eq "" &&
2106                         ($section =~ m/^@/ || $section eq $section_context)) {
2107                     dump_section($file, $section, xml_escape($contents));
2108                     $section = $section_default;
2109                     $contents = "";
2110                 } else {
2111                     $contents .= $1 . "\n";
2112                 }
2113             } else {
2114                 # i dont know - bad line?  ignore.
2115                 print STDERR "Warning(${file}:$.): bad line: $_";
2116                 ++$warnings;
2117             }
2118         } elsif ($state == 3) { # scanning for function '{' (end of prototype)
2119             if ($decl_type eq 'function') {
2120                 process_state3_function($_, $file);
2121             } else {
2122                 process_state3_type($_, $file);
2123             }
2124         } elsif ($state == 4) {
2125                 # Documentation block
2126                 if (/$doc_block/) {
2127                         dump_doc_section($file, $section, xml_escape($contents));
2128                         $contents = "";
2129                         $function = "";
2130                         %constants = ();
2131                         %parameterdescs = ();
2132                         %parametertypes = ();
2133                         @parameterlist = ();
2134                         %sections = ();
2135                         @sectionlist = ();
2136                         $prototype = "";
2137                         if ( $1 eq "" ) {
2138                                 $section = $section_intro;
2139                         } else {
2140                                 $section = $1;
2141                         }
2142                 }
2143                 elsif (/$doc_end/)
2144                 {
2145                         dump_doc_section($file, $section, xml_escape($contents));
2146                         $contents = "";
2147                         $function = "";
2148                         %constants = ();
2149                         %parameterdescs = ();
2150                         %parametertypes = ();
2151                         @parameterlist = ();
2152                         %sections = ();
2153                         @sectionlist = ();
2154                         $prototype = "";
2155                         $state = 0;
2156                 }
2157                 elsif (/$doc_content/)
2158                 {
2159                         if ( $1 eq "" )
2160                         {
2161                                 $contents .= $blankline;
2162                         }
2163                         else
2164                         {
2165                                 $contents .= $1 . "\n";
2166                         }
2167                 }
2168         }
2169     }
2170     if ($initial_section_counter == $section_counter) {
2171         print STDERR "Warning(${file}): no structured comments found\n";
2172         if ($output_mode eq "xml") {
2173             # The template wants at least one RefEntry here; make one.
2174             print "<refentry>\n";
2175             print " <refnamediv>\n";
2176             print "  <refname>\n";
2177             print "   ${file}\n";
2178             print "  </refname>\n";
2179             print "  <refpurpose>\n";
2180             print "   Document generation inconsistency\n";
2181             print "  </refpurpose>\n";
2182             print " </refnamediv>\n";
2183             print " <refsect1>\n";
2184             print "  <title>\n";
2185             print "   Oops\n";
2186             print "  </title>\n";
2187             print "  <warning>\n";
2188             print "   <para>\n";
2189             print "    The template for this document tried to insert\n";
2190             print "    the structured comment from the file\n";
2191             print "    <filename>${file}</filename> at this point,\n";
2192             print "    but none was found.\n";
2193             print "    This dummy section is inserted to allow\n";
2194             print "    generation to continue.\n";
2195             print "   </para>\n";
2196             print "  </warning>\n";
2197             print " </refsect1>\n";
2198             print "</refentry>\n";
2199         }
2200     }
2201 }