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). All 61# other functions are ignored. Cannot be used with -function together 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 ommitted, 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 ]+):(.*)'; 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 => %descriont 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>\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 id=\"$id\">".$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>\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 id=\"$id\">".$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>\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 id=\"$id\">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>\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 id=\"$id\">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 print ".B \"".$args{'functiontype'}."\" ".$args{'function'}."\n"; 957 $count = 0; 958 my $parenth = "("; 959 my $post = ","; 960 foreach my $parameter (@{$args{'parameterlist'}}) { 961 if ($count == $#{$args{'parameterlist'}}) { 962 $post = ");"; 963 } 964 $type = $args{'parametertypes'}{$parameter}; 965 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 966 # pointer-to-function 967 print ".BI \"".$parenth.$1."\" ".$parameter." \") (".$2.")".$post."\"\n"; 968 } else { 969 $type =~ s/([^\*])$/$1 /; 970 print ".BI \"".$parenth.$type."\" ".$parameter." \"".$post."\"\n"; 971 } 972 $count++; 973 $parenth = ""; 974 } 975 976 print ".SH ARGUMENTS\n"; 977 foreach $parameter (@{$args{'parameterlist'}}) { 978 my $parameter_name = $parameter; 979 $parameter_name =~ s/\[.*//; 980 981 print ".IP \"".$parameter."\" 12\n"; 982 output_highlight($args{'parameterdescs'}{$parameter_name}); 983 } 984 foreach $section (@{$args{'sectionlist'}}) { 985 print ".SH \"", uc $section, "\"\n"; 986 output_highlight($args{'sections'}{$section}); 987 } 988} 989 990## 991# output enum in man 992sub output_enum_man(%) { 993 my %args = %{$_[0]}; 994 my ($parameter, $section); 995 my $count; 996 997 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n"; 998 999 print ".SH NAME\n"; 1000 print "enum ".$args{'enum'}." \\- ".$args{'purpose'}."\n"; 1001 1002 print ".SH SYNOPSIS\n"; 1003 print "enum ".$args{'enum'}." {\n"; 1004 $count = 0; 1005 foreach my $parameter (@{$args{'parameterlist'}}) { 1006 print ".br\n.BI \" $parameter\"\n"; 1007 if ($count == $#{$args{'parameterlist'}}) { 1008 print "\n};\n"; 1009 last; 1010 } 1011 else { 1012 print ", \n.br\n"; 1013 } 1014 $count++; 1015 } 1016 1017 print ".SH Constants\n"; 1018 foreach $parameter (@{$args{'parameterlist'}}) { 1019 my $parameter_name = $parameter; 1020 $parameter_name =~ s/\[.*//; 1021 1022 print ".IP \"".$parameter."\" 12\n"; 1023 output_highlight($args{'parameterdescs'}{$parameter_name}); 1024 } 1025 foreach $section (@{$args{'sectionlist'}}) { 1026 print ".SH \"$section\"\n"; 1027 output_highlight($args{'sections'}{$section}); 1028 } 1029} 1030 1031## 1032# output struct in man 1033sub output_struct_man(%) { 1034 my %args = %{$_[0]}; 1035 my ($parameter, $section); 1036 1037 print ".TH \"$args{'module'}\" 9 \"".$args{'type'}." ".$args{'struct'}."\" \"$man_date\" \"API Manual\" LINUX\n"; 1038 1039 print ".SH NAME\n"; 1040 print $args{'type'}." ".$args{'struct'}." \\- ".$args{'purpose'}."\n"; 1041 1042 print ".SH SYNOPSIS\n"; 1043 print $args{'type'}." ".$args{'struct'}." {\n.br\n"; 1044 1045 foreach my $parameter (@{$args{'parameterlist'}}) { 1046 if ($parameter =~ /^#/) { 1047 print ".BI \"$parameter\"\n.br\n"; 1048 next; 1049 } 1050 my $parameter_name = $parameter; 1051 $parameter_name =~ s/\[.*//; 1052 1053 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 1054 $type = $args{'parametertypes'}{$parameter}; 1055 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 1056 # pointer-to-function 1057 print ".BI \" ".$1."\" ".$parameter." \") (".$2.")"."\"\n;\n"; 1058 } elsif ($type =~ m/^(.*?)\s*(:.*)/) { 1059 print ".BI \" ".$1."\" ".$parameter.$2." \""."\"\n;\n"; 1060 } else { 1061 $type =~ s/([^\*])$/$1 /; 1062 print ".BI \" ".$type."\" ".$parameter." \""."\"\n;\n"; 1063 } 1064 print "\n.br\n"; 1065 } 1066 print "};\n.br\n"; 1067 1068 print ".SH Arguments\n"; 1069 foreach $parameter (@{$args{'parameterlist'}}) { 1070 ($parameter =~ /^#/) && next; 1071 1072 my $parameter_name = $parameter; 1073 $parameter_name =~ s/\[.*//; 1074 1075 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 1076 print ".IP \"".$parameter."\" 12\n"; 1077 output_highlight($args{'parameterdescs'}{$parameter_name}); 1078 } 1079 foreach $section (@{$args{'sectionlist'}}) { 1080 print ".SH \"$section\"\n"; 1081 output_highlight($args{'sections'}{$section}); 1082 } 1083} 1084 1085## 1086# output typedef in man 1087sub output_typedef_man(%) { 1088 my %args = %{$_[0]}; 1089 my ($parameter, $section); 1090 1091 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n"; 1092 1093 print ".SH NAME\n"; 1094 print "typedef ".$args{'typedef'}." \\- ".$args{'purpose'}."\n"; 1095 1096 foreach $section (@{$args{'sectionlist'}}) { 1097 print ".SH \"$section\"\n"; 1098 output_highlight($args{'sections'}{$section}); 1099 } 1100} 1101 1102sub output_intro_man(%) { 1103 my %args = %{$_[0]}; 1104 my ($parameter, $section); 1105 my $count; 1106 1107 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n"; 1108 1109 foreach $section (@{$args{'sectionlist'}}) { 1110 print ".SH \"$section\"\n"; 1111 output_highlight($args{'sections'}{$section}); 1112 } 1113} 1114 1115## 1116# output in text 1117sub output_function_text(%) { 1118 my %args = %{$_[0]}; 1119 my ($parameter, $section); 1120 1121 print "Function:\n\n"; 1122 my $start=$args{'functiontype'}." ".$args{'function'}." ("; 1123 print $start; 1124 my $count = 0; 1125 foreach my $parameter (@{$args{'parameterlist'}}) { 1126 $type = $args{'parametertypes'}{$parameter}; 1127 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 1128 # pointer-to-function 1129 print $1.$parameter.") (".$2; 1130 } else { 1131 print $type." ".$parameter; 1132 } 1133 if ($count != $#{$args{'parameterlist'}}) { 1134 $count++; 1135 print ",\n"; 1136 print " " x length($start); 1137 } else { 1138 print ");\n\n"; 1139 } 1140 } 1141 1142 print "Arguments:\n\n"; 1143 foreach $parameter (@{$args{'parameterlist'}}) { 1144 my $parameter_name = $parameter; 1145 $parameter_name =~ s/\[.*//; 1146 1147 print $parameter."\n\t".$args{'parameterdescs'}{$parameter_name}."\n"; 1148 } 1149 output_section_text(@_); 1150} 1151 1152#output sections in text 1153sub output_section_text(%) { 1154 my %args = %{$_[0]}; 1155 my $section; 1156 1157 print "\n"; 1158 foreach $section (@{$args{'sectionlist'}}) { 1159 print "$section:\n\n"; 1160 output_highlight($args{'sections'}{$section}); 1161 } 1162 print "\n\n"; 1163} 1164 1165# output enum in text 1166sub output_enum_text(%) { 1167 my %args = %{$_[0]}; 1168 my ($parameter); 1169 my $count; 1170 print "Enum:\n\n"; 1171 1172 print "enum ".$args{'enum'}." {\n"; 1173 $count = 0; 1174 foreach $parameter (@{$args{'parameterlist'}}) { 1175 print "\t$parameter"; 1176 if ($count != $#{$args{'parameterlist'}}) { 1177 $count++; 1178 print ","; 1179 } 1180 print "\n"; 1181 } 1182 print "};\n\n"; 1183 1184 print "Constants:\n\n"; 1185 foreach $parameter (@{$args{'parameterlist'}}) { 1186 print "$parameter\n\t"; 1187 print $args{'parameterdescs'}{$parameter}."\n"; 1188 } 1189 1190 output_section_text(@_); 1191} 1192 1193# output typedef in text 1194sub output_typedef_text(%) { 1195 my %args = %{$_[0]}; 1196 my ($parameter); 1197 my $count; 1198 print "Typedef:\n\n"; 1199 1200 print "typedef ".$args{'typedef'}."\n"; 1201 output_section_text(@_); 1202} 1203 1204# output struct as text 1205sub output_struct_text(%) { 1206 my %args = %{$_[0]}; 1207 my ($parameter); 1208 1209 print $args{'type'}." ".$args{'struct'}.":\n\n"; 1210 print $args{'type'}." ".$args{'struct'}." {\n"; 1211 foreach $parameter (@{$args{'parameterlist'}}) { 1212 if ($parameter =~ /^#/) { 1213 print "$parameter\n"; 1214 next; 1215 } 1216 1217 my $parameter_name = $parameter; 1218 $parameter_name =~ s/\[.*//; 1219 1220 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 1221 $type = $args{'parametertypes'}{$parameter}; 1222 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 1223 # pointer-to-function 1224 print "\t$1 $parameter) ($2);\n"; 1225 } elsif ($type =~ m/^(.*?)\s*(:.*)/) { 1226 print "\t$1 $parameter$2;\n"; 1227 } else { 1228 print "\t".$type." ".$parameter.";\n"; 1229 } 1230 } 1231 print "};\n\n"; 1232 1233 print "Members:\n\n"; 1234 foreach $parameter (@{$args{'parameterlist'}}) { 1235 ($parameter =~ /^#/) && next; 1236 1237 my $parameter_name = $parameter; 1238 $parameter_name =~ s/\[.*//; 1239 1240 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 1241 print "$parameter\n\t"; 1242 print $args{'parameterdescs'}{$parameter_name}."\n"; 1243 } 1244 print "\n"; 1245 output_section_text(@_); 1246} 1247 1248sub output_intro_text(%) { 1249 my %args = %{$_[0]}; 1250 my ($parameter, $section); 1251 1252 foreach $section (@{$args{'sectionlist'}}) { 1253 print " $section:\n"; 1254 print " -> "; 1255 output_highlight($args{'sections'}{$section}); 1256 } 1257} 1258 1259## 1260# generic output function for typedefs 1261sub output_declaration { 1262 no strict 'refs'; 1263 my $name = shift; 1264 my $functype = shift; 1265 my $func = "output_${functype}_$output_mode"; 1266 if (($function_only==0) || 1267 ( $function_only == 1 && defined($function_table{$name})) || 1268 ( $function_only == 2 && !defined($function_table{$name}))) 1269 { 1270 &$func(@_); 1271 $section_counter++; 1272 } 1273} 1274 1275## 1276# generic output function - calls the right one based 1277# on current output mode. 1278sub output_intro { 1279 no strict 'refs'; 1280 my $func = "output_intro_".$output_mode; 1281 &$func(@_); 1282 $section_counter++; 1283} 1284 1285## 1286# takes a declaration (struct, union, enum, typedef) and 1287# invokes the right handler. NOT called for functions. 1288sub dump_declaration($$) { 1289 no strict 'refs'; 1290 my ($prototype, $file) = @_; 1291 my $func = "dump_".$decl_type; 1292 &$func(@_); 1293} 1294 1295sub dump_union($$) { 1296 dump_struct(@_); 1297} 1298 1299sub dump_struct($$) { 1300 my $x = shift; 1301 my $file = shift; 1302 1303 if ($x =~/(struct|union)\s+(\w+)\s*{(.*)}/) { 1304 $declaration_name = $2; 1305 my $members = $3; 1306 1307 # ignore embedded structs or unions 1308 $members =~ s/{.*?}//g; 1309 1310 # ignore members marked private: 1311 $members =~ s/\/\*.*?private:.*?public:.*?\*\///gos; 1312 $members =~ s/\/\*.*?private:.*//gos; 1313 # strip comments: 1314 $members =~ s/\/\*.*?\*\///gos; 1315 1316 create_parameterlist($members, ';', $file); 1317 1318 output_declaration($declaration_name, 1319 'struct', 1320 {'struct' => $declaration_name, 1321 'module' => $modulename, 1322 'parameterlist' => \@parameterlist, 1323 'parameterdescs' => \%parameterdescs, 1324 'parametertypes' => \%parametertypes, 1325 'sectionlist' => \@sectionlist, 1326 'sections' => \%sections, 1327 'purpose' => $declaration_purpose, 1328 'type' => $decl_type 1329 }); 1330 } 1331 else { 1332 print STDERR "Error(${file}:$.): Cannot parse struct or union!\n"; 1333 ++$errors; 1334 } 1335} 1336 1337sub dump_enum($$) { 1338 my $x = shift; 1339 my $file = shift; 1340 1341 $x =~ s@/\*.*?\*/@@gos; # strip comments. 1342 if ($x =~ /enum\s+(\w+)\s*{(.*)}/) { 1343 $declaration_name = $1; 1344 my $members = $2; 1345 1346 foreach my $arg (split ',', $members) { 1347 $arg =~ s/^\s*(\w+).*/$1/; 1348 push @parameterlist, $arg; 1349 if (!$parameterdescs{$arg}) { 1350 $parameterdescs{$arg} = $undescribed; 1351 print STDERR "Warning(${file}:$.): Enum value '$arg' ". 1352 "not described in enum '$declaration_name'\n"; 1353 } 1354 1355 } 1356 1357 output_declaration($declaration_name, 1358 'enum', 1359 {'enum' => $declaration_name, 1360 'module' => $modulename, 1361 'parameterlist' => \@parameterlist, 1362 'parameterdescs' => \%parameterdescs, 1363 'sectionlist' => \@sectionlist, 1364 'sections' => \%sections, 1365 'purpose' => $declaration_purpose 1366 }); 1367 } 1368 else { 1369 print STDERR "Error(${file}:$.): Cannot parse enum!\n"; 1370 ++$errors; 1371 } 1372} 1373 1374sub dump_typedef($$) { 1375 my $x = shift; 1376 my $file = shift; 1377 1378 $x =~ s@/\*.*?\*/@@gos; # strip comments. 1379 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) { 1380 $x =~ s/\(*.\)\s*;$/;/; 1381 $x =~ s/\[*.\]\s*;$/;/; 1382 } 1383 1384 if ($x =~ /typedef.*\s+(\w+)\s*;/) { 1385 $declaration_name = $1; 1386 1387 output_declaration($declaration_name, 1388 'typedef', 1389 {'typedef' => $declaration_name, 1390 'module' => $modulename, 1391 'sectionlist' => \@sectionlist, 1392 'sections' => \%sections, 1393 'purpose' => $declaration_purpose 1394 }); 1395 } 1396 else { 1397 print STDERR "Error(${file}:$.): Cannot parse typedef!\n"; 1398 ++$errors; 1399 } 1400} 1401 1402sub create_parameterlist($$$) { 1403 my $args = shift; 1404 my $splitter = shift; 1405 my $file = shift; 1406 my $type; 1407 my $param; 1408 1409 # temporarily replace commas inside function pointer definition 1410 while ($args =~ /(\([^\),]+),/) { 1411 $args =~ s/(\([^\),]+),/$1#/g; 1412 } 1413 1414 foreach my $arg (split($splitter, $args)) { 1415 # strip comments 1416 $arg =~ s/\/\*.*\*\///; 1417 # strip leading/trailing spaces 1418 $arg =~ s/^\s*//; 1419 $arg =~ s/\s*$//; 1420 $arg =~ s/\s+/ /; 1421 1422 if ($arg =~ /^#/) { 1423 # Treat preprocessor directive as a typeless variable just to fill 1424 # corresponding data structures "correctly". Catch it later in 1425 # output_* subs. 1426 push_parameter($arg, "", $file); 1427 } elsif ($arg =~ m/\(/) { 1428 # pointer-to-function 1429 $arg =~ tr/#/,/; 1430 $arg =~ m/[^\(]+\(\*([^\)]+)\)/; 1431 $param = $1; 1432 $type = $arg; 1433 $type =~ s/([^\(]+\(\*)$param/$1/; 1434 push_parameter($param, $type, $file); 1435 } elsif ($arg) { 1436 $arg =~ s/\s*:\s*/:/g; 1437 $arg =~ s/\s*\[/\[/g; 1438 1439 my @args = split('\s*,\s*', $arg); 1440 if ($args[0] =~ m/\*/) { 1441 $args[0] =~ s/(\*+)\s*/ $1/; 1442 } 1443 my @first_arg = split('\s+', shift @args); 1444 unshift(@args, pop @first_arg); 1445 $type = join " ", @first_arg; 1446 1447 foreach $param (@args) { 1448 if ($param =~ m/^(\*+)\s*(.*)/) { 1449 push_parameter($2, "$type $1", $file); 1450 } 1451 elsif ($param =~ m/(.*?):(\d+)/) { 1452 push_parameter($1, "$type:$2", $file) 1453 } 1454 else { 1455 push_parameter($param, $type, $file); 1456 } 1457 } 1458 } 1459 } 1460} 1461 1462sub push_parameter($$$) { 1463 my $param = shift; 1464 my $type = shift; 1465 my $file = shift; 1466 1467 my $param_name = $param; 1468 $param_name =~ s/\[.*//; 1469 1470 if ($type eq "" && $param =~ /\.\.\.$/) 1471 { 1472 $type=""; 1473 $parameterdescs{$param} = "variable arguments"; 1474 } 1475 elsif ($type eq "" && ($param eq "" or $param eq "void")) 1476 { 1477 $type=""; 1478 $param="void"; 1479 $parameterdescs{void} = "no arguments"; 1480 } 1481 # warn if parameter has no description 1482 # (but ignore ones starting with # as these are no parameters 1483 # but inline preprocessor statements 1484 if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) { 1485 1486 $parameterdescs{$param_name} = $undescribed; 1487 1488 if (($type eq 'function') || ($type eq 'enum')) { 1489 print STDERR "Warning(${file}:$.): Function parameter ". 1490 "or member '$param' not " . 1491 "described in '$declaration_name'\n"; 1492 } 1493 print STDERR "Warning(${file}:$.):". 1494 " No description found for parameter '$param'\n"; 1495 ++$warnings; 1496 } 1497 1498 push @parameterlist, $param; 1499 $parametertypes{$param} = $type; 1500} 1501 1502## 1503# takes a function prototype and the name of the current file being 1504# processed and spits out all the details stored in the global 1505# arrays/hashes. 1506sub dump_function($$) { 1507 my $prototype = shift; 1508 my $file = shift; 1509 1510 $prototype =~ s/^static +//; 1511 $prototype =~ s/^extern +//; 1512 $prototype =~ s/^fastcall +//; 1513 $prototype =~ s/^asmlinkage +//; 1514 $prototype =~ s/^inline +//; 1515 $prototype =~ s/^__inline__ +//; 1516 $prototype =~ s/^#define +//; #ak added 1517 $prototype =~ s/__attribute__ \(\([a-z,]*\)\)//; 1518 1519 # Yes, this truly is vile. We are looking for: 1520 # 1. Return type (may be nothing if we're looking at a macro) 1521 # 2. Function name 1522 # 3. Function parameters. 1523 # 1524 # All the while we have to watch out for function pointer parameters 1525 # (which IIRC is what the two sections are for), C types (these 1526 # regexps don't even start to express all the possibilities), and 1527 # so on. 1528 # 1529 # If you mess with these regexps, it's a good idea to check that 1530 # the following functions' documentation still comes out right: 1531 # - parport_register_device (function pointer parameters) 1532 # - atomic_set (macro) 1533 # - pci_match_device, __copy_to_user (long return type) 1534 1535 if ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1536 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1537 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1538 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1539 $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1540 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1541 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1542 $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1543 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1544 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1545 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1546 $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1547 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1548 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1549 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1550 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) { 1551 $return_type = $1; 1552 $declaration_name = $2; 1553 my $args = $3; 1554 1555 create_parameterlist($args, ',', $file); 1556 } else { 1557 print STDERR "Error(${file}:$.): cannot understand prototype: '$prototype'\n"; 1558 ++$errors; 1559 return; 1560 } 1561 1562 output_declaration($declaration_name, 1563 'function', 1564 {'function' => $declaration_name, 1565 'module' => $modulename, 1566 'functiontype' => $return_type, 1567 'parameterlist' => \@parameterlist, 1568 'parameterdescs' => \%parameterdescs, 1569 'parametertypes' => \%parametertypes, 1570 'sectionlist' => \@sectionlist, 1571 'sections' => \%sections, 1572 'purpose' => $declaration_purpose 1573 }); 1574} 1575 1576sub process_file($); 1577 1578# Read the file that maps relative names to absolute names for 1579# separate source and object directories and for shadow trees. 1580if (open(SOURCE_MAP, "<.tmp_filelist.txt")) { 1581 my ($relname, $absname); 1582 while(<SOURCE_MAP>) { 1583 chop(); 1584 ($relname, $absname) = (split())[0..1]; 1585 $relname =~ s:^/+::; 1586 $source_map{$relname} = $absname; 1587 } 1588 close(SOURCE_MAP); 1589} 1590 1591if ($filelist) { 1592 open(FLIST,"<$filelist") or die "Can't open file list $filelist"; 1593 while(<FLIST>) { 1594 chop; 1595 process_file($_); 1596 } 1597} 1598 1599foreach (@ARGV) { 1600 chomp; 1601 process_file($_); 1602} 1603if ($verbose && $errors) { 1604 print STDERR "$errors errors\n"; 1605} 1606if ($verbose && $warnings) { 1607 print STDERR "$warnings warnings\n"; 1608} 1609 1610exit($errors); 1611 1612sub reset_state { 1613 $function = ""; 1614 %constants = (); 1615 %parameterdescs = (); 1616 %parametertypes = (); 1617 @parameterlist = (); 1618 %sections = (); 1619 @sectionlist = (); 1620 $prototype = ""; 1621 1622 $state = 0; 1623} 1624 1625sub process_state3_function($$) { 1626 my $x = shift; 1627 my $file = shift; 1628 1629 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#define/)) { 1630 # do nothing 1631 } 1632 elsif ($x =~ /([^\{]*)/) { 1633 $prototype .= $1; 1634 } 1635 if (($x =~ /\{/) || ($x =~ /\#define/) || ($x =~ /;/)) { 1636 $prototype =~ s@/\*.*?\*/@@gos; # strip comments. 1637 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's. 1638 $prototype =~ s@^\s+@@gos; # strip leading spaces 1639 dump_function($prototype,$file); 1640 reset_state(); 1641 } 1642} 1643 1644sub process_state3_type($$) { 1645 my $x = shift; 1646 my $file = shift; 1647 1648 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's. 1649 $x =~ s@^\s+@@gos; # strip leading spaces 1650 $x =~ s@\s+$@@gos; # strip trailing spaces 1651 if ($x =~ /^#/) { 1652 # To distinguish preprocessor directive from regular declaration later. 1653 $x .= ";"; 1654 } 1655 1656 while (1) { 1657 if ( $x =~ /([^{};]*)([{};])(.*)/ ) { 1658 $prototype .= $1 . $2; 1659 ($2 eq '{') && $brcount++; 1660 ($2 eq '}') && $brcount--; 1661 if (($2 eq ';') && ($brcount == 0)) { 1662 dump_declaration($prototype,$file); 1663 reset_state(); 1664 last; 1665 } 1666 $x = $3; 1667 } else { 1668 $prototype .= $x; 1669 last; 1670 } 1671 } 1672} 1673 1674# replace <, >, and & 1675sub xml_escape($) { 1676 my $text = shift; 1677 $text =~ s/\&/\\\\\\amp;/g; 1678 $text =~ s/\</\\\\\\lt;/g; 1679 $text =~ s/\>/\\\\\\gt;/g; 1680 return $text; 1681} 1682 1683sub process_file($) { 1684 my $file; 1685 my $identifier; 1686 my $func; 1687 my $initial_section_counter = $section_counter; 1688 1689 if (defined($ENV{'SRCTREE'})) { 1690 $file = "$ENV{'SRCTREE'}" . "/" . "@_"; 1691 } 1692 else { 1693 $file = "@_"; 1694 } 1695 if (defined($source_map{$file})) { 1696 $file = $source_map{$file}; 1697 } 1698 1699 if (!open(IN,"<$file")) { 1700 print STDERR "Error: Cannot open file $file\n"; 1701 ++$errors; 1702 return; 1703 } 1704 1705 $section_counter = 0; 1706 while (<IN>) { 1707 if ($state == 0) { 1708 if (/$doc_start/o) { 1709 $state = 1; # next line is always the function name 1710 $in_doc_sect = 0; 1711 } 1712 } elsif ($state == 1) { # this line is the function name (always) 1713 if (/$doc_block/o) { 1714 $state = 4; 1715 $contents = ""; 1716 if ( $1 eq "" ) { 1717 $section = $section_intro; 1718 } else { 1719 $section = $1; 1720 } 1721 } 1722 elsif (/$doc_decl/o) { 1723 $identifier = $1; 1724 if (/\s*([\w\s]+?)\s*-/) { 1725 $identifier = $1; 1726 } 1727 1728 $state = 2; 1729 if (/-(.*)/) { 1730 $declaration_purpose = xml_escape($1); 1731 } else { 1732 $declaration_purpose = ""; 1733 } 1734 if ($identifier =~ m/^struct/) { 1735 $decl_type = 'struct'; 1736 } elsif ($identifier =~ m/^union/) { 1737 $decl_type = 'union'; 1738 } elsif ($identifier =~ m/^enum/) { 1739 $decl_type = 'enum'; 1740 } elsif ($identifier =~ m/^typedef/) { 1741 $decl_type = 'typedef'; 1742 } else { 1743 $decl_type = 'function'; 1744 } 1745 1746 if ($verbose) { 1747 print STDERR "Info(${file}:$.): Scanning doc for $identifier\n"; 1748 } 1749 } else { 1750 print STDERR "Warning(${file}:$.): Cannot understand $_ on line $.", 1751 " - I thought it was a doc line\n"; 1752 ++$warnings; 1753 $state = 0; 1754 } 1755 } elsif ($state == 2) { # look for head: lines, and include content 1756 if (/$doc_sect/o) { 1757 $newsection = $1; 1758 $newcontents = $2; 1759 1760 if ($contents ne "") { 1761 if (!$in_doc_sect && $verbose) { 1762 print STDERR "Warning(${file}:$.): contents before sections\n"; 1763 ++$warnings; 1764 } 1765 dump_section($section, xml_escape($contents)); 1766 $section = $section_default; 1767 } 1768 1769 $in_doc_sect = 1; 1770 $contents = $newcontents; 1771 if ($contents ne "") { 1772 if (substr($contents, 0, 1) eq " ") { 1773 $contents = substr($contents, 1); 1774 } 1775 $contents .= "\n"; 1776 } 1777 $section = $newsection; 1778 } elsif (/$doc_end/) { 1779 1780 if ($contents ne "") { 1781 dump_section($section, xml_escape($contents)); 1782 $section = $section_default; 1783 $contents = ""; 1784 } 1785 1786 $prototype = ""; 1787 $state = 3; 1788 $brcount = 0; 1789# print STDERR "end of doc comment, looking for prototype\n"; 1790 } elsif (/$doc_content/) { 1791 # miguel-style comment kludge, look for blank lines after 1792 # @parameter line to signify start of description 1793 if ($1 eq "" && 1794 ($section =~ m/^@/ || $section eq $section_context)) { 1795 dump_section($section, xml_escape($contents)); 1796 $section = $section_default; 1797 $contents = ""; 1798 } else { 1799 $contents .= $1."\n"; 1800 } 1801 } else { 1802 # i dont know - bad line? ignore. 1803 print STDERR "Warning(${file}:$.): bad line: $_"; 1804 ++$warnings; 1805 } 1806 } elsif ($state == 3) { # scanning for function '{' (end of prototype) 1807 if ($decl_type eq 'function') { 1808 process_state3_function($_, $file); 1809 } else { 1810 process_state3_type($_, $file); 1811 } 1812 } elsif ($state == 4) { 1813 # Documentation block 1814 if (/$doc_block/) { 1815 dump_section($section, $contents); 1816 output_intro({'sectionlist' => \@sectionlist, 1817 'sections' => \%sections }); 1818 $contents = ""; 1819 $function = ""; 1820 %constants = (); 1821 %parameterdescs = (); 1822 %parametertypes = (); 1823 @parameterlist = (); 1824 %sections = (); 1825 @sectionlist = (); 1826 $prototype = ""; 1827 if ( $1 eq "" ) { 1828 $section = $section_intro; 1829 } else { 1830 $section = $1; 1831 } 1832 } 1833 elsif (/$doc_end/) 1834 { 1835 dump_section($section, $contents); 1836 output_intro({'sectionlist' => \@sectionlist, 1837 'sections' => \%sections }); 1838 $contents = ""; 1839 $function = ""; 1840 %constants = (); 1841 %parameterdescs = (); 1842 %parametertypes = (); 1843 @parameterlist = (); 1844 %sections = (); 1845 @sectionlist = (); 1846 $prototype = ""; 1847 $state = 0; 1848 } 1849 elsif (/$doc_content/) 1850 { 1851 if ( $1 eq "" ) 1852 { 1853 $contents .= $blankline; 1854 } 1855 else 1856 { 1857 $contents .= $1 . "\n"; 1858 } 1859 } 1860 } 1861 } 1862 if ($initial_section_counter == $section_counter) { 1863 print STDERR "Warning(${file}): no structured comments found\n"; 1864 if ($output_mode eq "xml") { 1865 # The template wants at least one RefEntry here; make one. 1866 print "<refentry>\n"; 1867 print " <refnamediv>\n"; 1868 print " <refname>\n"; 1869 print " ${file}\n"; 1870 print " </refname>\n"; 1871 print " <refpurpose>\n"; 1872 print " Document generation inconsistency\n"; 1873 print " </refpurpose>\n"; 1874 print " </refnamediv>\n"; 1875 print " <refsect1>\n"; 1876 print " <title>\n"; 1877 print " Oops\n"; 1878 print " </title>\n"; 1879 print " <warning>\n"; 1880 print " <para>\n"; 1881 print " The template for this document tried to insert\n"; 1882 print " the structured comment from the file\n"; 1883 print " <filename>${file}</filename> at this point,\n"; 1884 print " but none was found.\n"; 1885 print " This dummy section is inserted to allow\n"; 1886 print " generation to continue.\n"; 1887 print " </para>\n"; 1888 print " </warning>\n"; 1889 print " </refsect1>\n"; 1890 print "</refentry>\n"; 1891 } 1892 } 1893} 1894