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