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