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