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-2008  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 # Beside 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 summat.
 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         $declaration_name = $2;
1416         my $members = $3;
1417
1418         # ignore embedded structs or unions
1419         $members =~ s/({.*})//g;
1420         $nested = $1;
1421
1422         # ignore members marked private:
1423         $members =~ s/\/\*.*?private:.*?public:.*?\*\///gos;
1424         $members =~ s/\/\*.*?private:.*//gos;
1425         # strip comments:
1426         $members =~ s/\/\*.*?\*\///gos;
1427         $nested =~ s/\/\*.*?\*\///gos;
1428
1429         create_parameterlist($members, ';', $file);
1430         check_sections($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested);
1431
1432         output_declaration($declaration_name,
1433                            'struct',
1434                            {'struct' => $declaration_name,
1435                             'module' => $modulename,
1436                             'parameterlist' => \@parameterlist,
1437                             'parameterdescs' => \%parameterdescs,
1438                             'parametertypes' => \%parametertypes,
1439                             'sectionlist' => \@sectionlist,
1440                             'sections' => \%sections,
1441                             'purpose' => $declaration_purpose,
1442                             'type' => $decl_type
1443                            });
1444     }
1445     else {
1446         print STDERR "Error(${file}:$.): Cannot parse struct or union!\n";
1447         ++$errors;
1448     }
1449 }
1450
1451 sub dump_enum($$) {
1452     my $x = shift;
1453     my $file = shift;
1454
1455     $x =~ s@/\*.*?\*/@@gos;     # strip comments.
1456     if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
1457         $declaration_name = $1;
1458         my $members = $2;
1459
1460         foreach my $arg (split ',', $members) {
1461             $arg =~ s/^\s*(\w+).*/$1/;
1462             push @parameterlist, $arg;
1463             if (!$parameterdescs{$arg}) {
1464                 $parameterdescs{$arg} = $undescribed;
1465                 print STDERR "Warning(${file}:$.): Enum value '$arg' ".
1466                     "not described in enum '$declaration_name'\n";
1467             }
1468
1469         }
1470
1471         output_declaration($declaration_name,
1472                            'enum',
1473                            {'enum' => $declaration_name,
1474                             'module' => $modulename,
1475                             'parameterlist' => \@parameterlist,
1476                             'parameterdescs' => \%parameterdescs,
1477                             'sectionlist' => \@sectionlist,
1478                             'sections' => \%sections,
1479                             'purpose' => $declaration_purpose
1480                            });
1481     }
1482     else {
1483         print STDERR "Error(${file}:$.): Cannot parse enum!\n";
1484         ++$errors;
1485     }
1486 }
1487
1488 sub dump_typedef($$) {
1489     my $x = shift;
1490     my $file = shift;
1491
1492     $x =~ s@/\*.*?\*/@@gos;     # strip comments.
1493     while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1494         $x =~ s/\(*.\)\s*;$/;/;
1495         $x =~ s/\[*.\]\s*;$/;/;
1496     }
1497
1498     if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1499         $declaration_name = $1;
1500
1501         output_declaration($declaration_name,
1502                            'typedef',
1503                            {'typedef' => $declaration_name,
1504                             'module' => $modulename,
1505                             'sectionlist' => \@sectionlist,
1506                             'sections' => \%sections,
1507                             'purpose' => $declaration_purpose
1508                            });
1509     }
1510     else {
1511         print STDERR "Error(${file}:$.): Cannot parse typedef!\n";
1512         ++$errors;
1513     }
1514 }
1515
1516 sub save_struct_actual($) {
1517     my $actual = shift;
1518
1519     # strip all spaces from the actual param so that it looks like one string item
1520     $actual =~ s/\s*//g;
1521     $struct_actual = $struct_actual . $actual . " ";
1522 }
1523
1524 sub create_parameterlist($$$) {
1525     my $args = shift;
1526     my $splitter = shift;
1527     my $file = shift;
1528     my $type;
1529     my $param;
1530
1531     # temporarily replace commas inside function pointer definition
1532     while ($args =~ /(\([^\),]+),/) {
1533         $args =~ s/(\([^\),]+),/$1#/g;
1534     }
1535
1536     foreach my $arg (split($splitter, $args)) {
1537         # strip comments
1538         $arg =~ s/\/\*.*\*\///;
1539         # strip leading/trailing spaces
1540         $arg =~ s/^\s*//;
1541         $arg =~ s/\s*$//;
1542         $arg =~ s/\s+/ /;
1543
1544         if ($arg =~ /^#/) {
1545             # Treat preprocessor directive as a typeless variable just to fill
1546             # corresponding data structures "correctly". Catch it later in
1547             # output_* subs.
1548             push_parameter($arg, "", $file);
1549         } elsif ($arg =~ m/\(.+\)\s*\(/) {
1550             # pointer-to-function
1551             $arg =~ tr/#/,/;
1552             $arg =~ m/[^\(]+\(\*?\s*(\w*)\s*\)/;
1553             $param = $1;
1554             $type = $arg;
1555             $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1556             save_struct_actual($param);
1557             push_parameter($param, $type, $file);
1558         } elsif ($arg) {
1559             $arg =~ s/\s*:\s*/:/g;
1560             $arg =~ s/\s*\[/\[/g;
1561
1562             my @args = split('\s*,\s*', $arg);
1563             if ($args[0] =~ m/\*/) {
1564                 $args[0] =~ s/(\*+)\s*/ $1/;
1565             }
1566
1567             my @first_arg;
1568             if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1569                     shift @args;
1570                     push(@first_arg, split('\s+', $1));
1571                     push(@first_arg, $2);
1572             } else {
1573                     @first_arg = split('\s+', shift @args);
1574             }
1575
1576             unshift(@args, pop @first_arg);
1577             $type = join " ", @first_arg;
1578
1579             foreach $param (@args) {
1580                 if ($param =~ m/^(\*+)\s*(.*)/) {
1581                     save_struct_actual($2);
1582                     push_parameter($2, "$type $1", $file);
1583                 }
1584                 elsif ($param =~ m/(.*?):(\d+)/) {
1585                     if ($type ne "") { # skip unnamed bit-fields
1586                         save_struct_actual($1);
1587                         push_parameter($1, "$type:$2", $file)
1588                     }
1589                 }
1590                 else {
1591                     save_struct_actual($param);
1592                     push_parameter($param, $type, $file);
1593                 }
1594             }
1595         }
1596     }
1597 }
1598
1599 sub push_parameter($$$) {
1600         my $param = shift;
1601         my $type = shift;
1602         my $file = shift;
1603
1604         if (($anon_struct_union == 1) && ($type eq "") &&
1605             ($param eq "}")) {
1606                 return;         # ignore the ending }; from anon. struct/union
1607         }
1608
1609         $anon_struct_union = 0;
1610         my $param_name = $param;
1611         $param_name =~ s/\[.*//;
1612
1613         if ($type eq "" && $param =~ /\.\.\.$/)
1614         {
1615             if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1616                 $parameterdescs{$param} = "variable arguments";
1617             }
1618         }
1619         elsif ($type eq "" && ($param eq "" or $param eq "void"))
1620         {
1621             $param="void";
1622             $parameterdescs{void} = "no arguments";
1623         }
1624         elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1625         # handle unnamed (anonymous) union or struct:
1626         {
1627                 $type = $param;
1628                 $param = "{unnamed_" . $param . "}";
1629                 $parameterdescs{$param} = "anonymous\n";
1630                 $anon_struct_union = 1;
1631         }
1632
1633         # warn if parameter has no description
1634         # (but ignore ones starting with # as these are not parameters
1635         # but inline preprocessor statements);
1636         # also ignore unnamed structs/unions;
1637         if (!$anon_struct_union) {
1638         if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) {
1639
1640             $parameterdescs{$param_name} = $undescribed;
1641
1642             if (($type eq 'function') || ($type eq 'enum')) {
1643                 print STDERR "Warning(${file}:$.): Function parameter ".
1644                     "or member '$param' not " .
1645                     "described in '$declaration_name'\n";
1646             }
1647             print STDERR "Warning(${file}:$.):".
1648                          " No description found for parameter '$param'\n";
1649             ++$warnings;
1650         }
1651         }
1652
1653         push @parameterlist, $param;
1654         $parametertypes{$param} = $type;
1655 }
1656
1657 sub check_sections($$$$$$) {
1658         my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck, $nested) = @_;
1659         my @sects = split ' ', $sectcheck;
1660         my @prms = split ' ', $prmscheck;
1661         my $err;
1662         my ($px, $sx);
1663         my $prm_clean;          # strip trailing "[array size]" and/or beginning "*"
1664
1665         foreach $sx (0 .. $#sects) {
1666                 $err = 1;
1667                 foreach $px (0 .. $#prms) {
1668                         $prm_clean = $prms[$px];
1669                         $prm_clean =~ s/\[.*\]//;
1670                         $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//;
1671                         ##$prm_clean =~ s/^\**//;
1672                         if ($prm_clean eq $sects[$sx]) {
1673                                 $err = 0;
1674                                 last;
1675                         }
1676                 }
1677                 if ($err) {
1678                         if ($decl_type eq "function") {
1679                                 print STDERR "Warning(${file}:$.): " .
1680                                         "Excess function parameter " .
1681                                         "'$sects[$sx]' " .
1682                                         "description in '$decl_name'\n";
1683                                 ++$warnings;
1684                         } else {
1685                                 if ($nested !~ m/\Q$sects[$sx]\E/) {
1686                                     print STDERR "Warning(${file}:$.): " .
1687                                         "Excess struct/union/enum/typedef member " .
1688                                         "'$sects[$sx]' " .
1689                                         "description in '$decl_name'\n";
1690                                     ++$warnings;
1691                                 }
1692                         }
1693                 }
1694         }
1695 }
1696
1697 ##
1698 # takes a function prototype and the name of the current file being
1699 # processed and spits out all the details stored in the global
1700 # arrays/hashes.
1701 sub dump_function($$) {
1702     my $prototype = shift;
1703     my $file = shift;
1704
1705     $prototype =~ s/^static +//;
1706     $prototype =~ s/^extern +//;
1707     $prototype =~ s/^asmlinkage +//;
1708     $prototype =~ s/^inline +//;
1709     $prototype =~ s/^__inline__ +//;
1710     $prototype =~ s/^__inline +//;
1711     $prototype =~ s/^__always_inline +//;
1712     $prototype =~ s/^noinline +//;
1713     $prototype =~ s/__devinit +//;
1714     $prototype =~ s/__init +//;
1715     $prototype =~ s/^#\s*define\s+//; #ak added
1716     $prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//;
1717
1718     # Yes, this truly is vile.  We are looking for:
1719     # 1. Return type (may be nothing if we're looking at a macro)
1720     # 2. Function name
1721     # 3. Function parameters.
1722     #
1723     # All the while we have to watch out for function pointer parameters
1724     # (which IIRC is what the two sections are for), C types (these
1725     # regexps don't even start to express all the possibilities), and
1726     # so on.
1727     #
1728     # If you mess with these regexps, it's a good idea to check that
1729     # the following functions' documentation still comes out right:
1730     # - parport_register_device (function pointer parameters)
1731     # - atomic_set (macro)
1732     # - pci_match_device, __copy_to_user (long return type)
1733
1734     if ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1735         $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1736         $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1737         $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1738         $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1739         $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1740         $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1741         $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1742         $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1743         $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1744         $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1745         $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1746         $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1747         $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1748         $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1749         $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1750         $prototype =~ m/^(\w+\s+\w+\s*\*\s*\w+\s*\*\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/)  {
1751         $return_type = $1;
1752         $declaration_name = $2;
1753         my $args = $3;
1754
1755         create_parameterlist($args, ',', $file);
1756     } else {
1757         print STDERR "Error(${file}:$.): cannot understand prototype: '$prototype'\n";
1758         ++$errors;
1759         return;
1760     }
1761
1762         my $prms = join " ", @parameterlist;
1763         check_sections($file, $declaration_name, "function", $sectcheck, $prms, "");
1764
1765     output_declaration($declaration_name,
1766                        'function',
1767                        {'function' => $declaration_name,
1768                         'module' => $modulename,
1769                         'functiontype' => $return_type,
1770                         'parameterlist' => \@parameterlist,
1771                         'parameterdescs' => \%parameterdescs,
1772                         'parametertypes' => \%parametertypes,
1773                         'sectionlist' => \@sectionlist,
1774                         'sections' => \%sections,
1775                         'purpose' => $declaration_purpose
1776                        });
1777 }
1778
1779 sub process_file($);
1780
1781 # Read the file that maps relative names to absolute names for
1782 # separate source and object directories and for shadow trees.
1783 if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
1784         my ($relname, $absname);
1785         while(<SOURCE_MAP>) {
1786                 chop();
1787                 ($relname, $absname) = (split())[0..1];
1788                 $relname =~ s:^/+::;
1789                 $source_map{$relname} = $absname;
1790         }
1791         close(SOURCE_MAP);
1792 }
1793
1794 if ($filelist) {
1795         open(FLIST,"<$filelist") or die "Can't open file list $filelist";
1796         while(<FLIST>) {
1797                 chop;
1798                 process_file($_);
1799         }
1800 }
1801
1802 foreach (@ARGV) {
1803     chomp;
1804     process_file($_);
1805 }
1806 if ($verbose && $errors) {
1807   print STDERR "$errors errors\n";
1808 }
1809 if ($verbose && $warnings) {
1810   print STDERR "$warnings warnings\n";
1811 }
1812
1813 exit($errors);
1814
1815 sub reset_state {
1816     $function = "";
1817     %constants = ();
1818     %parameterdescs = ();
1819     %parametertypes = ();
1820     @parameterlist = ();
1821     %sections = ();
1822     @sectionlist = ();
1823     $sectcheck = "";
1824     $struct_actual = "";
1825     $prototype = "";
1826
1827     $state = 0;
1828 }
1829
1830 sub syscall_munge() {
1831         my $void = 0;
1832
1833         $prototype =~ s@[\r\n\t]+@ @gos; # strip newlines/CR's/tabs
1834 ##      if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1835         if ($prototype =~ m/SYSCALL_DEFINE0/) {
1836                 $void = 1;
1837 ##              $prototype = "long sys_$1(void)";
1838         }
1839
1840         $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1841         if ($prototype =~ m/long (sys_.*?),/) {
1842                 $prototype =~ s/,/\(/;
1843         } elsif ($void) {
1844                 $prototype =~ s/\)/\(void\)/;
1845         }
1846
1847         # now delete all of the odd-number commas in $prototype
1848         # so that arg types & arg names don't have a comma between them
1849         my $count = 0;
1850         my $len = length($prototype);
1851         if ($void) {
1852                 $len = 0;       # skip the for-loop
1853         }
1854         for (my $ix = 0; $ix < $len; $ix++) {
1855                 if (substr($prototype, $ix, 1) eq ',') {
1856                         $count++;
1857                         if ($count % 2 == 1) {
1858                                 substr($prototype, $ix, 1) = ' ';
1859                         }
1860                 }
1861         }
1862 }
1863
1864 sub process_state3_function($$) {
1865     my $x = shift;
1866     my $file = shift;
1867
1868     $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1869
1870     if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
1871         # do nothing
1872     }
1873     elsif ($x =~ /([^\{]*)/) {
1874         $prototype .= $1;
1875     }
1876
1877     if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1878         $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1879         $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1880         $prototype =~ s@^\s+@@gos; # strip leading spaces
1881         if ($prototype =~ /SYSCALL_DEFINE/) {
1882                 syscall_munge();
1883         }
1884         dump_function($prototype, $file);
1885         reset_state();
1886     }
1887 }
1888
1889 sub process_state3_type($$) {
1890     my $x = shift;
1891     my $file = shift;
1892
1893     $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1894     $x =~ s@^\s+@@gos; # strip leading spaces
1895     $x =~ s@\s+$@@gos; # strip trailing spaces
1896     $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1897
1898     if ($x =~ /^#/) {
1899         # To distinguish preprocessor directive from regular declaration later.
1900         $x .= ";";
1901     }
1902
1903     while (1) {
1904         if ( $x =~ /([^{};]*)([{};])(.*)/ ) {
1905             $prototype .= $1 . $2;
1906             ($2 eq '{') && $brcount++;
1907             ($2 eq '}') && $brcount--;
1908             if (($2 eq ';') && ($brcount == 0)) {
1909                 dump_declaration($prototype,$file);
1910                 reset_state();
1911                 last;
1912             }
1913             $x = $3;
1914         } else {
1915             $prototype .= $x;
1916             last;
1917         }
1918     }
1919 }
1920
1921 # xml_escape: replace <, >, and & in the text stream;
1922 #
1923 # however, formatting controls that are generated internally/locally in the
1924 # kernel-doc script are not escaped here; instead, they begin life like
1925 # $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings
1926 # are converted to their mnemonic-expected output, without the 4 * '\' & ':',
1927 # just before actual output; (this is done by local_unescape())
1928 sub xml_escape($) {
1929         my $text = shift;
1930         if (($output_mode eq "text") || ($output_mode eq "man")) {
1931                 return $text;
1932         }
1933         $text =~ s/\&/\\\\\\amp;/g;
1934         $text =~ s/\</\\\\\\lt;/g;
1935         $text =~ s/\>/\\\\\\gt;/g;
1936         return $text;
1937 }
1938
1939 # convert local escape strings to html
1940 # local escape strings look like:  '\\\\menmonic:' (that's 4 backslashes)
1941 sub local_unescape($) {
1942         my $text = shift;
1943         if (($output_mode eq "text") || ($output_mode eq "man")) {
1944                 return $text;
1945         }
1946         $text =~ s/\\\\\\\\lt:/</g;
1947         $text =~ s/\\\\\\\\gt:/>/g;
1948         return $text;
1949 }
1950
1951 sub process_file($) {
1952     my $file;
1953     my $identifier;
1954     my $func;
1955     my $descr;
1956     my $initial_section_counter = $section_counter;
1957
1958     if (defined($ENV{'SRCTREE'})) {
1959         $file = "$ENV{'SRCTREE'}" . "/" . "@_";
1960     }
1961     else {
1962         $file = "@_";
1963     }
1964     if (defined($source_map{$file})) {
1965         $file = $source_map{$file};
1966     }
1967
1968     if (!open(IN,"<$file")) {
1969         print STDERR "Error: Cannot open file $file\n";
1970         ++$errors;
1971         return;
1972     }
1973
1974     $section_counter = 0;
1975     while (<IN>) {
1976         if ($state == 0) {
1977             if (/$doc_start/o) {
1978                 $state = 1;             # next line is always the function name
1979                 $in_doc_sect = 0;
1980             }
1981         } elsif ($state == 1) { # this line is the function name (always)
1982             if (/$doc_block/o) {
1983                 $state = 4;
1984                 $contents = "";
1985                 if ( $1 eq "" ) {
1986                         $section = $section_intro;
1987                 } else {
1988                         $section = $1;
1989                 }
1990             }
1991             elsif (/$doc_decl/o) {
1992                 $identifier = $1;
1993                 if (/\s*([\w\s]+?)\s*-/) {
1994                     $identifier = $1;
1995                 }
1996
1997                 $state = 2;
1998                 if (/-(.*)/) {
1999                     # strip leading/trailing/multiple spaces
2000                     $descr= $1;
2001                     $descr =~ s/^\s*//;
2002                     $descr =~ s/\s*$//;
2003                     $descr =~ s/\s+/ /;
2004                     $declaration_purpose = xml_escape($descr);
2005                 } else {
2006                     $declaration_purpose = "";
2007                 }
2008
2009                 if (($declaration_purpose eq "") && $verbose) {
2010                         print STDERR "Warning(${file}:$.): missing initial short description on line:\n";
2011                         print STDERR $_;
2012                         ++$warnings;
2013                 }
2014
2015                 if ($identifier =~ m/^struct/) {
2016                     $decl_type = 'struct';
2017                 } elsif ($identifier =~ m/^union/) {
2018                     $decl_type = 'union';
2019                 } elsif ($identifier =~ m/^enum/) {
2020                     $decl_type = 'enum';
2021                 } elsif ($identifier =~ m/^typedef/) {
2022                     $decl_type = 'typedef';
2023                 } else {
2024                     $decl_type = 'function';
2025                 }
2026
2027                 if ($verbose) {
2028                     print STDERR "Info(${file}:$.): Scanning doc for $identifier\n";
2029                 }
2030             } else {
2031                 print STDERR "Warning(${file}:$.): Cannot understand $_ on line $.",
2032                 " - I thought it was a doc line\n";
2033                 ++$warnings;
2034                 $state = 0;
2035             }
2036         } elsif ($state == 2) { # look for head: lines, and include content
2037             if (/$doc_sect/o) {
2038                 $newsection = $1;
2039                 $newcontents = $2;
2040
2041                 if (($contents ne "") && ($contents ne "\n")) {
2042                     if (!$in_doc_sect && $verbose) {
2043                         print STDERR "Warning(${file}:$.): contents before sections\n";
2044                         ++$warnings;
2045                     }
2046                     dump_section($file, $section, xml_escape($contents));
2047                     $section = $section_default;
2048                 }
2049
2050                 $in_doc_sect = 1;
2051                 $contents = $newcontents;
2052                 if ($contents ne "") {
2053                     while ((substr($contents, 0, 1) eq " ") ||
2054                         substr($contents, 0, 1) eq "\t") {
2055                             $contents = substr($contents, 1);
2056                     }
2057                     $contents .= "\n";
2058                 }
2059                 $section = $newsection;
2060             } elsif (/$doc_end/) {
2061
2062                 if ($contents ne "") {
2063                     dump_section($file, $section, xml_escape($contents));
2064                     $section = $section_default;
2065                     $contents = "";
2066                 }
2067                 # look for doc_com + <text> + doc_end:
2068                 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2069                     print STDERR "Warning(${file}:$.): suspicious ending line: $_";
2070                     ++$warnings;
2071                 }
2072
2073                 $prototype = "";
2074                 $state = 3;
2075                 $brcount = 0;
2076 #               print STDERR "end of doc comment, looking for prototype\n";
2077             } elsif (/$doc_content/) {
2078                 # miguel-style comment kludge, look for blank lines after
2079                 # @parameter line to signify start of description
2080                 if ($1 eq "" &&
2081                         ($section =~ m/^@/ || $section eq $section_context)) {
2082                     dump_section($file, $section, xml_escape($contents));
2083                     $section = $section_default;
2084                     $contents = "";
2085                 } else {
2086                     $contents .= $1."\n";
2087                 }
2088             } else {
2089                 # i dont know - bad line?  ignore.
2090                 print STDERR "Warning(${file}:$.): bad line: $_";
2091                 ++$warnings;
2092             }
2093         } elsif ($state == 3) { # scanning for function '{' (end of prototype)
2094             if ($decl_type eq 'function') {
2095                 process_state3_function($_, $file);
2096             } else {
2097                 process_state3_type($_, $file);
2098             }
2099         } elsif ($state == 4) {
2100                 # Documentation block
2101                 if (/$doc_block/) {
2102                         dump_doc_section($file, $section, xml_escape($contents));
2103                         $contents = "";
2104                         $function = "";
2105                         %constants = ();
2106                         %parameterdescs = ();
2107                         %parametertypes = ();
2108                         @parameterlist = ();
2109                         %sections = ();
2110                         @sectionlist = ();
2111                         $prototype = "";
2112                         if ( $1 eq "" ) {
2113                                 $section = $section_intro;
2114                         } else {
2115                                 $section = $1;
2116                         }
2117                 }
2118                 elsif (/$doc_end/)
2119                 {
2120                         dump_doc_section($file, $section, xml_escape($contents));
2121                         $contents = "";
2122                         $function = "";
2123                         %constants = ();
2124                         %parameterdescs = ();
2125                         %parametertypes = ();
2126                         @parameterlist = ();
2127                         %sections = ();
2128                         @sectionlist = ();
2129                         $prototype = "";
2130                         $state = 0;
2131                 }
2132                 elsif (/$doc_content/)
2133                 {
2134                         if ( $1 eq "" )
2135                         {
2136                                 $contents .= $blankline;
2137                         }
2138                         else
2139                         {
2140                                 $contents .= $1 . "\n";
2141                         }
2142                 }
2143         }
2144     }
2145     if ($initial_section_counter == $section_counter) {
2146         print STDERR "Warning(${file}): no structured comments found\n";
2147         if ($output_mode eq "xml") {
2148             # The template wants at least one RefEntry here; make one.
2149             print "<refentry>\n";
2150             print " <refnamediv>\n";
2151             print "  <refname>\n";
2152             print "   ${file}\n";
2153             print "  </refname>\n";
2154             print "  <refpurpose>\n";
2155             print "   Document generation inconsistency\n";
2156             print "  </refpurpose>\n";
2157             print " </refnamediv>\n";
2158             print " <refsect1>\n";
2159             print "  <title>\n";
2160             print "   Oops\n";
2161             print "  </title>\n";
2162             print "  <warning>\n";
2163             print "   <para>\n";
2164             print "    The template for this document tried to insert\n";
2165             print "    the structured comment from the file\n";
2166             print "    <filename>${file}</filename> at this point,\n";
2167             print "    but none was found.\n";
2168             print "    This dummy section is inserted to allow\n";
2169             print "    generation to continue.\n";
2170             print "   </para>\n";
2171             print "  </warning>\n";
2172             print " </refsect1>\n";
2173             print "</refentry>\n";
2174         }
2175     }
2176 }