1#!/usr/bin/env perl 2 3use warnings; 4use strict; 5 6## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## 7## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ## 8## Copyright (C) 2001 Simon Huggins ## 9## Copyright (C) 2005-2012 Randy Dunlap ## 10## Copyright (C) 2012 Dan Luedtke ## 11## ## 12## #define enhancements by Armin Kuster <akuster@mvista.com> ## 13## Copyright (c) 2000 MontaVista Software, Inc. ## 14## ## 15## This software falls under the GNU General Public License. ## 16## Please read the COPYING file for more information ## 17 18# 18/01/2001 - Cleanups 19# Functions prototyped as foo(void) same as foo() 20# Stop eval'ing where we don't need to. 21# -- huggie@earth.li 22 23# 27/06/2001 - Allowed whitespace after initial "/**" and 24# allowed comments before function declarations. 25# -- Christian Kreibich <ck@whoop.org> 26 27# Still to do: 28# - add perldoc documentation 29# - Look more closely at some of the scarier bits :) 30 31# 26/05/2001 - Support for separate source and object trees. 32# Return error code. 33# Keith Owens <kaos@ocs.com.au> 34 35# 23/09/2001 - Added support for typedefs, structs, enums and unions 36# Support for Context section; can be terminated using empty line 37# Small fixes (like spaces vs. \s in regex) 38# -- Tim Jansen <tim@tjansen.de> 39 40# 25/07/2012 - Added support for HTML5 41# -- Dan Luedtke <mail@danrl.de> 42 43sub usage { 44 my $message = <<"EOF"; 45Usage: $0 [OPTION ...] FILE ... 46 47Read C language source or header FILEs, extract embedded documentation comments, 48and print formatted documentation to standard output. 49 50The documentation comments are identified by "/**" opening comment mark. See 51Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax. 52 53Output format selection (mutually exclusive): 54 -man Output troff manual page format. This is the default. 55 -rst Output reStructuredText format. 56 -none Do not output documentation, only warnings. 57 58Output selection (mutually exclusive): 59 -export Only output documentation for symbols that have been 60 exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() 61 in any input FILE or -export-file FILE. 62 -internal Only output documentation for symbols that have NOT been 63 exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() 64 in any input FILE or -export-file FILE. 65 -function NAME Only output documentation for the given function(s) 66 or DOC: section title(s). All other functions and DOC: 67 sections are ignored. May be specified multiple times. 68 -nofunction NAME Do NOT output documentation for the given function(s); 69 only output documentation for the other functions and 70 DOC: sections. May be specified multiple times. 71 72Output selection modifiers: 73 -no-doc-sections Do not output DOC: sections. 74 -enable-lineno Enable output of #define LINENO lines. Only works with 75 reStructuredText format. 76 -export-file FILE Specify an additional FILE in which to look for 77 EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be used with 78 -export or -internal. May be specified multiple times. 79 80Other parameters: 81 -v Verbose output, more warnings and other information. 82 -h Print this help. 83 84EOF 85 print $message; 86 exit 1; 87} 88 89# 90# format of comments. 91# In the following table, (...)? signifies optional structure. 92# (...)* signifies 0 or more structure elements 93# /** 94# * function_name(:)? (- short description)? 95# (* @parameterx: (description of parameter x)?)* 96# (* a blank line)? 97# * (Description:)? (Description of function)? 98# * (section header: (section description)? )* 99# (*)?*/ 100# 101# So .. the trivial example would be: 102# 103# /** 104# * my_function 105# */ 106# 107# If the Description: header tag is omitted, then there must be a blank line 108# after the last parameter specification. 109# e.g. 110# /** 111# * my_function - does my stuff 112# * @my_arg: its mine damnit 113# * 114# * Does my stuff explained. 115# */ 116# 117# or, could also use: 118# /** 119# * my_function - does my stuff 120# * @my_arg: its mine damnit 121# * Description: Does my stuff explained. 122# */ 123# etc. 124# 125# Besides functions you can also write documentation for structs, unions, 126# enums and typedefs. Instead of the function name you must write the name 127# of the declaration; the struct/union/enum/typedef must always precede 128# the name. Nesting of declarations is not supported. 129# Use the argument mechanism to document members or constants. 130# e.g. 131# /** 132# * struct my_struct - short description 133# * @a: first member 134# * @b: second member 135# * 136# * Longer description 137# */ 138# struct my_struct { 139# int a; 140# int b; 141# /* private: */ 142# int c; 143# }; 144# 145# All descriptions can be multiline, except the short function description. 146# 147# For really longs structs, you can also describe arguments inside the 148# body of the struct. 149# eg. 150# /** 151# * struct my_struct - short description 152# * @a: first member 153# * @b: second member 154# * 155# * Longer description 156# */ 157# struct my_struct { 158# int a; 159# int b; 160# /** 161# * @c: This is longer description of C 162# * 163# * You can use paragraphs to describe arguments 164# * using this method. 165# */ 166# int c; 167# }; 168# 169# This should be use only for struct/enum members. 170# 171# You can also add additional sections. When documenting kernel functions you 172# should document the "Context:" of the function, e.g. whether the functions 173# can be called form interrupts. Unlike other sections you can end it with an 174# empty line. 175# A non-void function should have a "Return:" section describing the return 176# value(s). 177# Example-sections should contain the string EXAMPLE so that they are marked 178# appropriately in DocBook. 179# 180# Example: 181# /** 182# * user_function - function that can only be called in user context 183# * @a: some argument 184# * Context: !in_interrupt() 185# * 186# * Some description 187# * Example: 188# * user_function(22); 189# */ 190# ... 191# 192# 193# All descriptive text is further processed, scanning for the following special 194# patterns, which are highlighted appropriately. 195# 196# 'funcname()' - function 197# '$ENVVAR' - environmental variable 198# '&struct_name' - name of a structure (up to two words including 'struct') 199# '&struct_name.member' - name of a structure member 200# '@parameter' - name of a parameter 201# '%CONST' - name of a constant. 202# '``LITERAL``' - literal string without any spaces on it. 203 204## init lots of data 205 206my $errors = 0; 207my $warnings = 0; 208my $anon_struct_union = 0; 209 210# match expressions used to find embedded type information 211my $type_constant = '\b``([^\`]+)``\b'; 212my $type_constant2 = '\%([-_\w]+)'; 213my $type_func = '(\w+)\(\)'; 214my $type_param = '\@(\w*(\.\w+)*(\.\.\.)?)'; 215my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params 216my $type_env = '(\$\w+)'; 217my $type_enum = '\&(enum\s*([_\w]+))'; 218my $type_struct = '\&(struct\s*([_\w]+))'; 219my $type_typedef = '\&(typedef\s*([_\w]+))'; 220my $type_union = '\&(union\s*([_\w]+))'; 221my $type_member = '\&([_\w]+)(\.|->)([_\w]+)'; 222my $type_fallback = '\&([_\w]+)'; 223my $type_member_func = $type_member . '\(\)'; 224 225# Output conversion substitutions. 226# One for each output format 227 228# these are pretty rough 229my @highlights_man = ( 230 [$type_constant, "\$1"], 231 [$type_constant2, "\$1"], 232 [$type_func, "\\\\fB\$1\\\\fP"], 233 [$type_enum, "\\\\fI\$1\\\\fP"], 234 [$type_struct, "\\\\fI\$1\\\\fP"], 235 [$type_typedef, "\\\\fI\$1\\\\fP"], 236 [$type_union, "\\\\fI\$1\\\\fP"], 237 [$type_param, "\\\\fI\$1\\\\fP"], 238 [$type_member, "\\\\fI\$1\$2\$3\\\\fP"], 239 [$type_fallback, "\\\\fI\$1\\\\fP"] 240 ); 241my $blankline_man = ""; 242 243# rst-mode 244my @highlights_rst = ( 245 [$type_constant, "``\$1``"], 246 [$type_constant2, "``\$1``"], 247 # Note: need to escape () to avoid func matching later 248 [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\\\\) <\$1>`"], 249 [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"], 250 [$type_fp_param, "**\$1\\\\(\\\\)**"], 251 [$type_func, "\\:c\\:func\\:`\$1()`"], 252 [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"], 253 [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"], 254 [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"], 255 [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"], 256 # in rst this can refer to any type 257 [$type_fallback, "\\:c\\:type\\:`\$1`"], 258 [$type_param, "**\$1**"] 259 ); 260my $blankline_rst = "\n"; 261 262# read arguments 263if ($#ARGV == -1) { 264 usage(); 265} 266 267my $kernelversion; 268my $dohighlight = ""; 269 270my $verbose = 0; 271my $output_mode = "rst"; 272my $output_preformatted = 0; 273my $no_doc_sections = 0; 274my $enable_lineno = 0; 275my @highlights = @highlights_rst; 276my $blankline = $blankline_rst; 277my $modulename = "Kernel API"; 278 279use constant { 280 OUTPUT_ALL => 0, # output all symbols and doc sections 281 OUTPUT_INCLUDE => 1, # output only specified symbols 282 OUTPUT_EXCLUDE => 2, # output everything except specified symbols 283 OUTPUT_EXPORTED => 3, # output exported symbols 284 OUTPUT_INTERNAL => 4, # output non-exported symbols 285}; 286my $output_selection = OUTPUT_ALL; 287my $show_not_found = 0; 288 289my @export_file_list; 290 291my @build_time; 292if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) && 293 (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') { 294 @build_time = gmtime($seconds); 295} else { 296 @build_time = localtime; 297} 298 299my $man_date = ('January', 'February', 'March', 'April', 'May', 'June', 300 'July', 'August', 'September', 'October', 301 'November', 'December')[$build_time[4]] . 302 " " . ($build_time[5]+1900); 303 304# Essentially these are globals. 305# They probably want to be tidied up, made more localised or something. 306# CAVEAT EMPTOR! Some of the others I localised may not want to be, which 307# could cause "use of undefined value" or other bugs. 308my ($function, %function_table, %parametertypes, $declaration_purpose); 309my $declaration_start_line; 310my ($type, $declaration_name, $return_type); 311my ($newsection, $newcontents, $prototype, $brcount, %source_map); 312 313if (defined($ENV{'KBUILD_VERBOSE'})) { 314 $verbose = "$ENV{'KBUILD_VERBOSE'}"; 315} 316 317# Generated docbook code is inserted in a template at a point where 318# docbook v3.1 requires a non-zero sequence of RefEntry's; see: 319# http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html 320# We keep track of number of generated entries and generate a dummy 321# if needs be to ensure the expanded template can be postprocessed 322# into html. 323my $section_counter = 0; 324 325my $lineprefix=""; 326 327# Parser states 328use constant { 329 STATE_NORMAL => 0, # normal code 330 STATE_NAME => 1, # looking for function name 331 STATE_FIELD => 2, # scanning field start 332 STATE_PROTO => 3, # scanning prototype 333 STATE_DOCBLOCK => 4, # documentation block 334 STATE_INLINE => 5, # gathering documentation outside main block 335}; 336my $state; 337my $in_doc_sect; 338 339# Inline documentation state 340use constant { 341 STATE_INLINE_NA => 0, # not applicable ($state != STATE_INLINE) 342 STATE_INLINE_NAME => 1, # looking for member name (@foo:) 343 STATE_INLINE_TEXT => 2, # looking for member documentation 344 STATE_INLINE_END => 3, # done 345 STATE_INLINE_ERROR => 4, # error - Comment without header was found. 346 # Spit a warning as it's not 347 # proper kernel-doc and ignore the rest. 348}; 349my $inline_doc_state; 350 351#declaration types: can be 352# 'function', 'struct', 'union', 'enum', 'typedef' 353my $decl_type; 354 355my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start. 356my $doc_end = '\*/'; 357my $doc_com = '\s*\*\s*'; 358my $doc_com_body = '\s*\* ?'; 359my $doc_decl = $doc_com . '(\w+)'; 360# @params and a strictly limited set of supported section names 361my $doc_sect = $doc_com . 362 '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:(.*)'; 363my $doc_content = $doc_com_body . '(.*)'; 364my $doc_block = $doc_com . 'DOC:\s*(.*)?'; 365my $doc_inline_start = '^\s*/\*\*\s*$'; 366my $doc_inline_sect = '\s*\*\s*(@[\w\s]+):(.*)'; 367my $doc_inline_end = '^\s*\*/\s*$'; 368my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$'; 369my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;'; 370 371my %parameterdescs; 372my %parameterdesc_start_lines; 373my @parameterlist; 374my %sections; 375my @sectionlist; 376my %section_start_lines; 377my $sectcheck; 378my $struct_actual; 379 380my $contents = ""; 381my $new_start_line = 0; 382 383# the canonical section names. see also $doc_sect above. 384my $section_default = "Description"; # default section 385my $section_intro = "Introduction"; 386my $section = $section_default; 387my $section_context = "Context"; 388my $section_return = "Return"; 389 390my $undescribed = "-- undescribed --"; 391 392reset_state(); 393 394while ($ARGV[0] =~ m/^--?(.*)/) { 395 my $cmd = $1; 396 shift @ARGV; 397 if ($cmd eq "man") { 398 $output_mode = "man"; 399 @highlights = @highlights_man; 400 $blankline = $blankline_man; 401 } elsif ($cmd eq "rst") { 402 $output_mode = "rst"; 403 @highlights = @highlights_rst; 404 $blankline = $blankline_rst; 405 } elsif ($cmd eq "none") { 406 $output_mode = "none"; 407 } elsif ($cmd eq "module") { # not needed for XML, inherits from calling document 408 $modulename = shift @ARGV; 409 } elsif ($cmd eq "function") { # to only output specific functions 410 $output_selection = OUTPUT_INCLUDE; 411 $function = shift @ARGV; 412 $function_table{$function} = 1; 413 } elsif ($cmd eq "nofunction") { # output all except specific functions 414 $output_selection = OUTPUT_EXCLUDE; 415 $function = shift @ARGV; 416 $function_table{$function} = 1; 417 } elsif ($cmd eq "export") { # only exported symbols 418 $output_selection = OUTPUT_EXPORTED; 419 %function_table = (); 420 } elsif ($cmd eq "internal") { # only non-exported symbols 421 $output_selection = OUTPUT_INTERNAL; 422 %function_table = (); 423 } elsif ($cmd eq "export-file") { 424 my $file = shift @ARGV; 425 push(@export_file_list, $file); 426 } elsif ($cmd eq "v") { 427 $verbose = 1; 428 } elsif (($cmd eq "h") || ($cmd eq "help")) { 429 usage(); 430 } elsif ($cmd eq 'no-doc-sections') { 431 $no_doc_sections = 1; 432 } elsif ($cmd eq 'enable-lineno') { 433 $enable_lineno = 1; 434 } elsif ($cmd eq 'show-not-found') { 435 $show_not_found = 1; 436 } else { 437 # Unknown argument 438 usage(); 439 } 440} 441 442# continue execution near EOF; 443 444# get kernel version from env 445sub get_kernel_version() { 446 my $version = 'unknown kernel version'; 447 448 if (defined($ENV{'KERNELVERSION'})) { 449 $version = $ENV{'KERNELVERSION'}; 450 } 451 return $version; 452} 453 454# 455sub print_lineno { 456 my $lineno = shift; 457 if ($enable_lineno && defined($lineno)) { 458 print "#define LINENO " . $lineno . "\n"; 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_param/) { 470 $name = $1; 471 $parameterdescs{$name} = $contents; 472 $sectcheck = $sectcheck . $name . " "; 473 $parameterdesc_start_lines{$name} = $new_start_line; 474 $new_start_line = 0; 475 } elsif ($name eq "@\.\.\.") { 476 $name = "..."; 477 $parameterdescs{$name} = $contents; 478 $sectcheck = $sectcheck . $name . " "; 479 $parameterdesc_start_lines{$name} = $new_start_line; 480 $new_start_line = 0; 481 } else { 482 if (defined($sections{$name}) && ($sections{$name} ne "")) { 483 # Only warn on user specified duplicate section names. 484 if ($name ne $section_default) { 485 print STDERR "${file}:$.: warning: duplicate section name '$name'\n"; 486 ++$warnings; 487 } 488 $sections{$name} .= $contents; 489 } else { 490 $sections{$name} = $contents; 491 push @sectionlist, $name; 492 $section_start_lines{$name} = $new_start_line; 493 $new_start_line = 0; 494 } 495 } 496} 497 498## 499# dump DOC: section after checking that it should go out 500# 501sub dump_doc_section { 502 my $file = shift; 503 my $name = shift; 504 my $contents = join "\n", @_; 505 506 if ($no_doc_sections) { 507 return; 508 } 509 510 if (($output_selection == OUTPUT_ALL) || 511 ($output_selection == OUTPUT_INCLUDE && 512 defined($function_table{$name})) || 513 ($output_selection == OUTPUT_EXCLUDE && 514 !defined($function_table{$name}))) 515 { 516 dump_section($file, $name, $contents); 517 output_blockhead({'sectionlist' => \@sectionlist, 518 'sections' => \%sections, 519 'module' => $modulename, 520 'content-only' => ($output_selection != OUTPUT_ALL), }); 521 } 522} 523 524## 525# output function 526# 527# parameterdescs, a hash. 528# function => "function name" 529# parameterlist => @list of parameters 530# parameterdescs => %parameter descriptions 531# sectionlist => @list of sections 532# sections => %section descriptions 533# 534 535sub output_highlight { 536 my $contents = join "\n",@_; 537 my $line; 538 539# DEBUG 540# if (!defined $contents) { 541# use Carp; 542# confess "output_highlight got called with no args?\n"; 543# } 544 545# print STDERR "contents b4:$contents\n"; 546 eval $dohighlight; 547 die $@ if $@; 548# print STDERR "contents af:$contents\n"; 549 550 foreach $line (split "\n", $contents) { 551 if (! $output_preformatted) { 552 $line =~ s/^\s*//; 553 } 554 if ($line eq ""){ 555 if (! $output_preformatted) { 556 print $lineprefix, local_unescape($blankline); 557 } 558 } else { 559 $line =~ s/\\\\\\/\&/g; 560 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") { 561 print "\\&$line"; 562 } else { 563 print $lineprefix, $line; 564 } 565 } 566 print "\n"; 567 } 568} 569 570## 571# output function in man 572sub output_function_man(%) { 573 my %args = %{$_[0]}; 574 my ($parameter, $section); 575 my $count; 576 577 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n"; 578 579 print ".SH NAME\n"; 580 print $args{'function'} . " \\- " . $args{'purpose'} . "\n"; 581 582 print ".SH SYNOPSIS\n"; 583 if ($args{'functiontype'} ne "") { 584 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n"; 585 } else { 586 print ".B \"" . $args{'function'} . "\n"; 587 } 588 $count = 0; 589 my $parenth = "("; 590 my $post = ","; 591 foreach my $parameter (@{$args{'parameterlist'}}) { 592 if ($count == $#{$args{'parameterlist'}}) { 593 $post = ");"; 594 } 595 $type = $args{'parametertypes'}{$parameter}; 596 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 597 # pointer-to-function 598 print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n"; 599 } else { 600 $type =~ s/([^\*])$/$1 /; 601 print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n"; 602 } 603 $count++; 604 $parenth = ""; 605 } 606 607 print ".SH ARGUMENTS\n"; 608 foreach $parameter (@{$args{'parameterlist'}}) { 609 my $parameter_name = $parameter; 610 $parameter_name =~ s/\[.*//; 611 612 print ".IP \"" . $parameter . "\" 12\n"; 613 output_highlight($args{'parameterdescs'}{$parameter_name}); 614 } 615 foreach $section (@{$args{'sectionlist'}}) { 616 print ".SH \"", uc $section, "\"\n"; 617 output_highlight($args{'sections'}{$section}); 618 } 619} 620 621## 622# output enum in man 623sub output_enum_man(%) { 624 my %args = %{$_[0]}; 625 my ($parameter, $section); 626 my $count; 627 628 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n"; 629 630 print ".SH NAME\n"; 631 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n"; 632 633 print ".SH SYNOPSIS\n"; 634 print "enum " . $args{'enum'} . " {\n"; 635 $count = 0; 636 foreach my $parameter (@{$args{'parameterlist'}}) { 637 print ".br\n.BI \" $parameter\"\n"; 638 if ($count == $#{$args{'parameterlist'}}) { 639 print "\n};\n"; 640 last; 641 } 642 else { 643 print ", \n.br\n"; 644 } 645 $count++; 646 } 647 648 print ".SH Constants\n"; 649 foreach $parameter (@{$args{'parameterlist'}}) { 650 my $parameter_name = $parameter; 651 $parameter_name =~ s/\[.*//; 652 653 print ".IP \"" . $parameter . "\" 12\n"; 654 output_highlight($args{'parameterdescs'}{$parameter_name}); 655 } 656 foreach $section (@{$args{'sectionlist'}}) { 657 print ".SH \"$section\"\n"; 658 output_highlight($args{'sections'}{$section}); 659 } 660} 661 662## 663# output struct in man 664sub output_struct_man(%) { 665 my %args = %{$_[0]}; 666 my ($parameter, $section); 667 668 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n"; 669 670 print ".SH NAME\n"; 671 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n"; 672 673 my $declaration = $args{'definition'}; 674 $declaration =~ s/\t/ /g; 675 $declaration =~ s/\n/"\n.br\n.BI \"/g; 676 print ".SH SYNOPSIS\n"; 677 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n"; 678 print ".BI \"$declaration\n};\n.br\n\n"; 679 680 print ".SH Members\n"; 681 foreach $parameter (@{$args{'parameterlist'}}) { 682 ($parameter =~ /^#/) && next; 683 684 my $parameter_name = $parameter; 685 $parameter_name =~ s/\[.*//; 686 687 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 688 print ".IP \"" . $parameter . "\" 12\n"; 689 output_highlight($args{'parameterdescs'}{$parameter_name}); 690 } 691 foreach $section (@{$args{'sectionlist'}}) { 692 print ".SH \"$section\"\n"; 693 output_highlight($args{'sections'}{$section}); 694 } 695} 696 697## 698# output typedef in man 699sub output_typedef_man(%) { 700 my %args = %{$_[0]}; 701 my ($parameter, $section); 702 703 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n"; 704 705 print ".SH NAME\n"; 706 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n"; 707 708 foreach $section (@{$args{'sectionlist'}}) { 709 print ".SH \"$section\"\n"; 710 output_highlight($args{'sections'}{$section}); 711 } 712} 713 714sub output_blockhead_man(%) { 715 my %args = %{$_[0]}; 716 my ($parameter, $section); 717 my $count; 718 719 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n"; 720 721 foreach $section (@{$args{'sectionlist'}}) { 722 print ".SH \"$section\"\n"; 723 output_highlight($args{'sections'}{$section}); 724 } 725} 726 727## 728# output in restructured text 729# 730 731# 732# This could use some work; it's used to output the DOC: sections, and 733# starts by putting out the name of the doc section itself, but that tends 734# to duplicate a header already in the template file. 735# 736sub output_blockhead_rst(%) { 737 my %args = %{$_[0]}; 738 my ($parameter, $section); 739 740 foreach $section (@{$args{'sectionlist'}}) { 741 if ($output_selection != OUTPUT_INCLUDE) { 742 print "**$section**\n\n"; 743 } 744 print_lineno($section_start_lines{$section}); 745 output_highlight_rst($args{'sections'}{$section}); 746 print "\n"; 747 } 748} 749 750sub output_highlight_rst { 751 my $contents = join "\n",@_; 752 my $line; 753 754 # undo the evil effects of xml_escape() earlier 755 $contents = xml_unescape($contents); 756 757 eval $dohighlight; 758 die $@ if $@; 759 760 foreach $line (split "\n", $contents) { 761 print $lineprefix . $line . "\n"; 762 } 763} 764 765sub output_function_rst(%) { 766 my %args = %{$_[0]}; 767 my ($parameter, $section); 768 my $oldprefix = $lineprefix; 769 my $start = ""; 770 771 if ($args{'typedef'}) { 772 print ".. c:type:: ". $args{'function'} . "\n\n"; 773 print_lineno($declaration_start_line); 774 print " **Typedef**: "; 775 $lineprefix = ""; 776 output_highlight_rst($args{'purpose'}); 777 $start = "\n\n**Syntax**\n\n ``"; 778 } else { 779 print ".. c:function:: "; 780 } 781 if ($args{'functiontype'} ne "") { 782 $start .= $args{'functiontype'} . " " . $args{'function'} . " ("; 783 } else { 784 $start .= $args{'function'} . " ("; 785 } 786 print $start; 787 788 my $count = 0; 789 foreach my $parameter (@{$args{'parameterlist'}}) { 790 if ($count ne 0) { 791 print ", "; 792 } 793 $count++; 794 $type = $args{'parametertypes'}{$parameter}; 795 796 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 797 # pointer-to-function 798 print $1 . $parameter . ") (" . $2; 799 } else { 800 print $type . " " . $parameter; 801 } 802 } 803 if ($args{'typedef'}) { 804 print ");``\n\n"; 805 } else { 806 print ")\n\n"; 807 print_lineno($declaration_start_line); 808 $lineprefix = " "; 809 output_highlight_rst($args{'purpose'}); 810 print "\n"; 811 } 812 813 print "**Parameters**\n\n"; 814 $lineprefix = " "; 815 foreach $parameter (@{$args{'parameterlist'}}) { 816 my $parameter_name = $parameter; 817 $parameter_name =~ s/\[.*//; 818 $type = $args{'parametertypes'}{$parameter}; 819 820 if ($type ne "") { 821 print "``$type $parameter``\n"; 822 } else { 823 print "``$parameter``\n"; 824 } 825 826 print_lineno($parameterdesc_start_lines{$parameter_name}); 827 828 if (defined($args{'parameterdescs'}{$parameter_name}) && 829 $args{'parameterdescs'}{$parameter_name} ne $undescribed) { 830 output_highlight_rst($args{'parameterdescs'}{$parameter_name}); 831 } else { 832 print " *undescribed*\n"; 833 } 834 print "\n"; 835 } 836 837 $lineprefix = $oldprefix; 838 output_section_rst(@_); 839} 840 841sub output_section_rst(%) { 842 my %args = %{$_[0]}; 843 my $section; 844 my $oldprefix = $lineprefix; 845 $lineprefix = ""; 846 847 foreach $section (@{$args{'sectionlist'}}) { 848 print "**$section**\n\n"; 849 print_lineno($section_start_lines{$section}); 850 output_highlight_rst($args{'sections'}{$section}); 851 print "\n"; 852 } 853 print "\n"; 854 $lineprefix = $oldprefix; 855} 856 857sub output_enum_rst(%) { 858 my %args = %{$_[0]}; 859 my ($parameter); 860 my $oldprefix = $lineprefix; 861 my $count; 862 my $name = "enum " . $args{'enum'}; 863 864 print "\n\n.. c:type:: " . $name . "\n\n"; 865 print_lineno($declaration_start_line); 866 $lineprefix = " "; 867 output_highlight_rst($args{'purpose'}); 868 print "\n"; 869 870 print "**Constants**\n\n"; 871 $lineprefix = " "; 872 foreach $parameter (@{$args{'parameterlist'}}) { 873 print "``$parameter``\n"; 874 if ($args{'parameterdescs'}{$parameter} ne $undescribed) { 875 output_highlight_rst($args{'parameterdescs'}{$parameter}); 876 } else { 877 print " *undescribed*\n"; 878 } 879 print "\n"; 880 } 881 882 $lineprefix = $oldprefix; 883 output_section_rst(@_); 884} 885 886sub output_typedef_rst(%) { 887 my %args = %{$_[0]}; 888 my ($parameter); 889 my $oldprefix = $lineprefix; 890 my $name = "typedef " . $args{'typedef'}; 891 892 print "\n\n.. c:type:: " . $name . "\n\n"; 893 print_lineno($declaration_start_line); 894 $lineprefix = " "; 895 output_highlight_rst($args{'purpose'}); 896 print "\n"; 897 898 $lineprefix = $oldprefix; 899 output_section_rst(@_); 900} 901 902sub output_struct_rst(%) { 903 my %args = %{$_[0]}; 904 my ($parameter); 905 my $oldprefix = $lineprefix; 906 my $name = $args{'type'} . " " . $args{'struct'}; 907 908 print "\n\n.. c:type:: " . $name . "\n\n"; 909 print_lineno($declaration_start_line); 910 $lineprefix = " "; 911 output_highlight_rst($args{'purpose'}); 912 print "\n"; 913 914 print "**Definition**\n\n"; 915 print "::\n\n"; 916 my $declaration = $args{'definition'}; 917 $declaration =~ s/\t/ /g; 918 print " " . $args{'type'} . " " . $args{'struct'} . " {\n$declaration };\n\n"; 919 920 print "**Members**\n\n"; 921 $lineprefix = " "; 922 foreach $parameter (@{$args{'parameterlist'}}) { 923 ($parameter =~ /^#/) && next; 924 925 my $parameter_name = $parameter; 926 $parameter_name =~ s/\[.*//; 927 928 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 929 $type = $args{'parametertypes'}{$parameter}; 930 print_lineno($parameterdesc_start_lines{$parameter_name}); 931 print "``" . $parameter . "``\n"; 932 output_highlight_rst($args{'parameterdescs'}{$parameter_name}); 933 print "\n"; 934 } 935 print "\n"; 936 937 $lineprefix = $oldprefix; 938 output_section_rst(@_); 939} 940 941## none mode output functions 942 943sub output_function_none(%) { 944} 945 946sub output_enum_none(%) { 947} 948 949sub output_typedef_none(%) { 950} 951 952sub output_struct_none(%) { 953} 954 955sub output_blockhead_none(%) { 956} 957 958## 959# generic output function for all types (function, struct/union, typedef, enum); 960# calls the generated, variable output_ function name based on 961# functype and output_mode 962sub output_declaration { 963 no strict 'refs'; 964 my $name = shift; 965 my $functype = shift; 966 my $func = "output_${functype}_$output_mode"; 967 if (($output_selection == OUTPUT_ALL) || 968 (($output_selection == OUTPUT_INCLUDE || 969 $output_selection == OUTPUT_EXPORTED) && 970 defined($function_table{$name})) || 971 (($output_selection == OUTPUT_EXCLUDE || 972 $output_selection == OUTPUT_INTERNAL) && 973 !($functype eq "function" && defined($function_table{$name})))) 974 { 975 &$func(@_); 976 $section_counter++; 977 } 978} 979 980## 981# generic output function - calls the right one based on current output mode. 982sub output_blockhead { 983 no strict 'refs'; 984 my $func = "output_blockhead_" . $output_mode; 985 &$func(@_); 986 $section_counter++; 987} 988 989## 990# takes a declaration (struct, union, enum, typedef) and 991# invokes the right handler. NOT called for functions. 992sub dump_declaration($$) { 993 no strict 'refs'; 994 my ($prototype, $file) = @_; 995 my $func = "dump_" . $decl_type; 996 &$func(@_); 997} 998 999sub dump_union($$) { 1000 dump_struct(@_); 1001} 1002 1003sub dump_struct($$) { 1004 my $x = shift; 1005 my $file = shift; 1006 1007 if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) { 1008 my $decl_type = $1; 1009 $declaration_name = $2; 1010 my $members = $3; 1011 1012 # ignore members marked private: 1013 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi; 1014 $members =~ s/\/\*\s*private:.*//gosi; 1015 # strip comments: 1016 $members =~ s/\/\*.*?\*\///gos; 1017 # strip attributes 1018 $members =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i; 1019 $members =~ s/__aligned\s*\([^;]*\)//gos; 1020 $members =~ s/\s*CRYPTO_MINALIGN_ATTR//gos; 1021 # replace DECLARE_BITMAP 1022 $members =~ s/DECLARE_BITMAP\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos; 1023 # replace DECLARE_HASHTABLE 1024 $members =~ s/DECLARE_HASHTABLE\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[1 << (($2) - 1)\]/gos; 1025 # replace DECLARE_KFIFO 1026 $members =~ s/DECLARE_KFIFO\s*\(([^,)]+),\s*([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos; 1027 # replace DECLARE_KFIFO_PTR 1028 $members =~ s/DECLARE_KFIFO_PTR\s*\(([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos; 1029 1030 my $declaration = $members; 1031 1032 # Split nested struct/union elements as newer ones 1033 my $cont = 1; 1034 while ($cont) { 1035 $cont = 0; 1036 while ($members =~ m/(struct|union)([^{};]+){([^{}]*)}([^{}\;]*)\;/) { 1037 my $newmember = "$1 $4;"; 1038 my $id = $4; 1039 my $content = $3; 1040 $id =~ s/[:\[].*//; 1041 $id =~ s/^\*+//; 1042 foreach my $arg (split /;/, $content) { 1043 next if ($arg =~ m/^\s*$/); 1044 if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) { 1045 # pointer-to-function 1046 my $type = $1; 1047 my $name = $2; 1048 my $extra = $3; 1049 next if (!$name); 1050 if ($id =~ m/^\s*$/) { 1051 # anonymous struct/union 1052 $newmember .= "$type$name$extra;"; 1053 } else { 1054 $newmember .= "$type$id.$name$extra;"; 1055 } 1056 } else { 1057 my $type = $arg; 1058 my $name = $arg; 1059 $type =~ s/\s\S+$//; 1060 $name =~ s/.*\s+//; 1061 $name =~ s/[:\[].*//; 1062 $name =~ s/^\*+//; 1063 next if (($name =~ m/^\s*$/)); 1064 if ($id =~ m/^\s*$/) { 1065 # anonymous struct/union 1066 $newmember .= "$type $name;"; 1067 } else { 1068 $newmember .= "$type $id.$name;"; 1069 } 1070 } 1071 } 1072 $members =~ s/(struct|union)([^{};]+){([^{}]*)}([^{}\;]*)\;/$newmember/; 1073 $cont = 1; 1074 }; 1075 }; 1076 1077 # Ignore other nested elements, like enums 1078 $members =~ s/({[^\{\}]*})//g; 1079 1080 create_parameterlist($members, ';', $file, $declaration_name); 1081 check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual); 1082 1083 # Adjust declaration for better display 1084 $declaration =~ s/([{;])/$1\n/g; 1085 $declaration =~ s/}\s+;/};/g; 1086 # Better handle inlined enums 1087 do {} while ($declaration =~ s/(enum\s+{[^}]+),([^\n])/$1,\n$2/); 1088 1089 my @def_args = split /\n/, $declaration; 1090 my $level = 1; 1091 $declaration = ""; 1092 foreach my $clause (@def_args) { 1093 $clause =~ s/^\s+//; 1094 $clause =~ s/\s+$//; 1095 $clause =~ s/\s+/ /; 1096 next if (!$clause); 1097 $level-- if ($clause =~ m/(})/ && $level > 1); 1098 if (!($clause =~ m/^\s*#/)) { 1099 $declaration .= "\t" x $level; 1100 } 1101 $declaration .= "\t" . $clause . "\n"; 1102 $level++ if ($clause =~ m/({)/ && !($clause =~m/}/)); 1103 } 1104 output_declaration($declaration_name, 1105 'struct', 1106 {'struct' => $declaration_name, 1107 'module' => $modulename, 1108 'definition' => $declaration, 1109 'parameterlist' => \@parameterlist, 1110 'parameterdescs' => \%parameterdescs, 1111 'parametertypes' => \%parametertypes, 1112 'sectionlist' => \@sectionlist, 1113 'sections' => \%sections, 1114 'purpose' => $declaration_purpose, 1115 'type' => $decl_type 1116 }); 1117 } 1118 else { 1119 print STDERR "${file}:$.: error: Cannot parse struct or union!\n"; 1120 ++$errors; 1121 } 1122} 1123 1124sub dump_enum($$) { 1125 my $x = shift; 1126 my $file = shift; 1127 1128 $x =~ s@/\*.*?\*/@@gos; # strip comments. 1129 # strip #define macros inside enums 1130 $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos; 1131 1132 if ($x =~ /enum\s+(\w+)\s*{(.*)}/) { 1133 $declaration_name = $1; 1134 my $members = $2; 1135 my %_members; 1136 1137 $members =~ s/\s+$//; 1138 1139 foreach my $arg (split ',', $members) { 1140 $arg =~ s/^\s*(\w+).*/$1/; 1141 push @parameterlist, $arg; 1142 if (!$parameterdescs{$arg}) { 1143 $parameterdescs{$arg} = $undescribed; 1144 print STDERR "${file}:$.: warning: Enum value '$arg' ". 1145 "not described in enum '$declaration_name'\n"; 1146 } 1147 $_members{$arg} = 1; 1148 } 1149 1150 while (my ($k, $v) = each %parameterdescs) { 1151 if (!exists($_members{$k})) { 1152 print STDERR "${file}:$.: warning: Excess enum value " . 1153 "'$k' description in '$declaration_name'\n"; 1154 } 1155 } 1156 1157 output_declaration($declaration_name, 1158 'enum', 1159 {'enum' => $declaration_name, 1160 'module' => $modulename, 1161 'parameterlist' => \@parameterlist, 1162 'parameterdescs' => \%parameterdescs, 1163 'sectionlist' => \@sectionlist, 1164 'sections' => \%sections, 1165 'purpose' => $declaration_purpose 1166 }); 1167 } 1168 else { 1169 print STDERR "${file}:$.: error: Cannot parse enum!\n"; 1170 ++$errors; 1171 } 1172} 1173 1174sub dump_typedef($$) { 1175 my $x = shift; 1176 my $file = shift; 1177 1178 $x =~ s@/\*.*?\*/@@gos; # strip comments. 1179 1180 # Parse function prototypes 1181 if ($x =~ /typedef\s+(\w+)\s*\(\*\s*(\w\S+)\s*\)\s*\((.*)\);/ || 1182 $x =~ /typedef\s+(\w+)\s*(\w\S+)\s*\s*\((.*)\);/) { 1183 1184 # Function typedefs 1185 $return_type = $1; 1186 $declaration_name = $2; 1187 my $args = $3; 1188 1189 create_parameterlist($args, ',', $file, $declaration_name); 1190 1191 output_declaration($declaration_name, 1192 'function', 1193 {'function' => $declaration_name, 1194 'typedef' => 1, 1195 'module' => $modulename, 1196 'functiontype' => $return_type, 1197 'parameterlist' => \@parameterlist, 1198 'parameterdescs' => \%parameterdescs, 1199 'parametertypes' => \%parametertypes, 1200 'sectionlist' => \@sectionlist, 1201 'sections' => \%sections, 1202 'purpose' => $declaration_purpose 1203 }); 1204 return; 1205 } 1206 1207 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) { 1208 $x =~ s/\(*.\)\s*;$/;/; 1209 $x =~ s/\[*.\]\s*;$/;/; 1210 } 1211 1212 if ($x =~ /typedef.*\s+(\w+)\s*;/) { 1213 $declaration_name = $1; 1214 1215 output_declaration($declaration_name, 1216 'typedef', 1217 {'typedef' => $declaration_name, 1218 'module' => $modulename, 1219 'sectionlist' => \@sectionlist, 1220 'sections' => \%sections, 1221 'purpose' => $declaration_purpose 1222 }); 1223 } 1224 else { 1225 print STDERR "${file}:$.: error: Cannot parse typedef!\n"; 1226 ++$errors; 1227 } 1228} 1229 1230sub save_struct_actual($) { 1231 my $actual = shift; 1232 1233 # strip all spaces from the actual param so that it looks like one string item 1234 $actual =~ s/\s*//g; 1235 $struct_actual = $struct_actual . $actual . " "; 1236} 1237 1238sub create_parameterlist($$$$) { 1239 my $args = shift; 1240 my $splitter = shift; 1241 my $file = shift; 1242 my $declaration_name = shift; 1243 my $type; 1244 my $param; 1245 1246 # temporarily replace commas inside function pointer definition 1247 while ($args =~ /(\([^\),]+),/) { 1248 $args =~ s/(\([^\),]+),/$1#/g; 1249 } 1250 1251 foreach my $arg (split($splitter, $args)) { 1252 # strip comments 1253 $arg =~ s/\/\*.*\*\///; 1254 # strip leading/trailing spaces 1255 $arg =~ s/^\s*//; 1256 $arg =~ s/\s*$//; 1257 $arg =~ s/\s+/ /; 1258 1259 if ($arg =~ /^#/) { 1260 # Treat preprocessor directive as a typeless variable just to fill 1261 # corresponding data structures "correctly". Catch it later in 1262 # output_* subs. 1263 push_parameter($arg, "", $file); 1264 } elsif ($arg =~ m/\(.+\)\s*\(/) { 1265 # pointer-to-function 1266 $arg =~ tr/#/,/; 1267 $arg =~ m/[^\(]+\(\*?\s*([\w\.]*)\s*\)/; 1268 $param = $1; 1269 $type = $arg; 1270 $type =~ s/([^\(]+\(\*?)\s*$param/$1/; 1271 save_struct_actual($param); 1272 push_parameter($param, $type, $file, $declaration_name); 1273 } elsif ($arg) { 1274 $arg =~ s/\s*:\s*/:/g; 1275 $arg =~ s/\s*\[/\[/g; 1276 1277 my @args = split('\s*,\s*', $arg); 1278 if ($args[0] =~ m/\*/) { 1279 $args[0] =~ s/(\*+)\s*/ $1/; 1280 } 1281 1282 my @first_arg; 1283 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) { 1284 shift @args; 1285 push(@first_arg, split('\s+', $1)); 1286 push(@first_arg, $2); 1287 } else { 1288 @first_arg = split('\s+', shift @args); 1289 } 1290 1291 unshift(@args, pop @first_arg); 1292 $type = join " ", @first_arg; 1293 1294 foreach $param (@args) { 1295 if ($param =~ m/^(\*+)\s*(.*)/) { 1296 save_struct_actual($2); 1297 push_parameter($2, "$type $1", $file, $declaration_name); 1298 } 1299 elsif ($param =~ m/(.*?):(\d+)/) { 1300 if ($type ne "") { # skip unnamed bit-fields 1301 save_struct_actual($1); 1302 push_parameter($1, "$type:$2", $file, $declaration_name) 1303 } 1304 } 1305 else { 1306 save_struct_actual($param); 1307 push_parameter($param, $type, $file, $declaration_name); 1308 } 1309 } 1310 } 1311 } 1312} 1313 1314sub push_parameter($$$$) { 1315 my $param = shift; 1316 my $type = shift; 1317 my $file = shift; 1318 my $declaration_name = shift; 1319 1320 if (($anon_struct_union == 1) && ($type eq "") && 1321 ($param eq "}")) { 1322 return; # ignore the ending }; from anon. struct/union 1323 } 1324 1325 $anon_struct_union = 0; 1326 $param =~ s/[\[\)].*//; 1327 1328 if ($type eq "" && $param =~ /\.\.\.$/) 1329 { 1330 if (!$param =~ /\w\.\.\.$/) { 1331 # handles unnamed variable parameters 1332 $param = "..."; 1333 } 1334 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") { 1335 $parameterdescs{$param} = "variable arguments"; 1336 } 1337 } 1338 elsif ($type eq "" && ($param eq "" or $param eq "void")) 1339 { 1340 $param="void"; 1341 $parameterdescs{void} = "no arguments"; 1342 } 1343 elsif ($type eq "" && ($param eq "struct" or $param eq "union")) 1344 # handle unnamed (anonymous) union or struct: 1345 { 1346 $type = $param; 1347 $param = "{unnamed_" . $param . "}"; 1348 $parameterdescs{$param} = "anonymous\n"; 1349 $anon_struct_union = 1; 1350 } 1351 1352 # warn if parameter has no description 1353 # (but ignore ones starting with # as these are not parameters 1354 # but inline preprocessor statements); 1355 # Note: It will also ignore void params and unnamed structs/unions 1356 if (!defined $parameterdescs{$param} && $param !~ /^#/) { 1357 $parameterdescs{$param} = $undescribed; 1358 1359 print STDERR 1360 "${file}:$.: warning: Function parameter or member '$param' not described in '$declaration_name'\n"; 1361 ++$warnings; 1362 } 1363 1364 $param = xml_escape($param); 1365 1366 # strip spaces from $param so that it is one continuous string 1367 # on @parameterlist; 1368 # this fixes a problem where check_sections() cannot find 1369 # a parameter like "addr[6 + 2]" because it actually appears 1370 # as "addr[6", "+", "2]" on the parameter list; 1371 # but it's better to maintain the param string unchanged for output, 1372 # so just weaken the string compare in check_sections() to ignore 1373 # "[blah" in a parameter string; 1374 ###$param =~ s/\s*//g; 1375 push @parameterlist, $param; 1376 $type =~ s/\s\s+/ /g; 1377 $parametertypes{$param} = $type; 1378} 1379 1380sub check_sections($$$$$) { 1381 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_; 1382 my @sects = split ' ', $sectcheck; 1383 my @prms = split ' ', $prmscheck; 1384 my $err; 1385 my ($px, $sx); 1386 my $prm_clean; # strip trailing "[array size]" and/or beginning "*" 1387 1388 foreach $sx (0 .. $#sects) { 1389 $err = 1; 1390 foreach $px (0 .. $#prms) { 1391 $prm_clean = $prms[$px]; 1392 $prm_clean =~ s/\[.*\]//; 1393 $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i; 1394 # ignore array size in a parameter string; 1395 # however, the original param string may contain 1396 # spaces, e.g.: addr[6 + 2] 1397 # and this appears in @prms as "addr[6" since the 1398 # parameter list is split at spaces; 1399 # hence just ignore "[..." for the sections check; 1400 $prm_clean =~ s/\[.*//; 1401 1402 ##$prm_clean =~ s/^\**//; 1403 if ($prm_clean eq $sects[$sx]) { 1404 $err = 0; 1405 last; 1406 } 1407 } 1408 if ($err) { 1409 if ($decl_type eq "function") { 1410 print STDERR "${file}:$.: warning: " . 1411 "Excess function parameter " . 1412 "'$sects[$sx]' " . 1413 "description in '$decl_name'\n"; 1414 ++$warnings; 1415 } 1416 } 1417 } 1418} 1419 1420## 1421# Checks the section describing the return value of a function. 1422sub check_return_section { 1423 my $file = shift; 1424 my $declaration_name = shift; 1425 my $return_type = shift; 1426 1427 # Ignore an empty return type (It's a macro) 1428 # Ignore functions with a "void" return type. (But don't ignore "void *") 1429 if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) { 1430 return; 1431 } 1432 1433 if (!defined($sections{$section_return}) || 1434 $sections{$section_return} eq "") { 1435 print STDERR "${file}:$.: warning: " . 1436 "No description found for return value of " . 1437 "'$declaration_name'\n"; 1438 ++$warnings; 1439 } 1440} 1441 1442## 1443# takes a function prototype and the name of the current file being 1444# processed and spits out all the details stored in the global 1445# arrays/hashes. 1446sub dump_function($$) { 1447 my $prototype = shift; 1448 my $file = shift; 1449 my $noret = 0; 1450 1451 $prototype =~ s/^static +//; 1452 $prototype =~ s/^extern +//; 1453 $prototype =~ s/^asmlinkage +//; 1454 $prototype =~ s/^inline +//; 1455 $prototype =~ s/^__inline__ +//; 1456 $prototype =~ s/^__inline +//; 1457 $prototype =~ s/^__always_inline +//; 1458 $prototype =~ s/^noinline +//; 1459 $prototype =~ s/__init +//; 1460 $prototype =~ s/__init_or_module +//; 1461 $prototype =~ s/__meminit +//; 1462 $prototype =~ s/__must_check +//; 1463 $prototype =~ s/__weak +//; 1464 my $define = $prototype =~ s/^#\s*define\s+//; #ak added 1465 $prototype =~ s/__attribute__\s*\(\( 1466 (?: 1467 [\w\s]++ # attribute name 1468 (?:\([^)]*+\))? # attribute arguments 1469 \s*+,? # optional comma at the end 1470 )+ 1471 \)\)\s+//x; 1472 1473 # Yes, this truly is vile. We are looking for: 1474 # 1. Return type (may be nothing if we're looking at a macro) 1475 # 2. Function name 1476 # 3. Function parameters. 1477 # 1478 # All the while we have to watch out for function pointer parameters 1479 # (which IIRC is what the two sections are for), C types (these 1480 # regexps don't even start to express all the possibilities), and 1481 # so on. 1482 # 1483 # If you mess with these regexps, it's a good idea to check that 1484 # the following functions' documentation still comes out right: 1485 # - parport_register_device (function pointer parameters) 1486 # - atomic_set (macro) 1487 # - pci_match_device, __copy_to_user (long return type) 1488 1489 if ($define && $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s+/) { 1490 # This is an object-like macro, it has no return type and no parameter 1491 # list. 1492 # Function-like macros are not allowed to have spaces between 1493 # declaration_name and opening parenthesis (notice the \s+). 1494 $return_type = $1; 1495 $declaration_name = $2; 1496 $noret = 1; 1497 } elsif ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1498 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1499 $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1500 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1501 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1502 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1503 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1504 $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1505 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1506 $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1507 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1508 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1509 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1510 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1511 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1512 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1513 $prototype =~ m/^(\w+\s+\w+\s*\*+\s*\w+\s*\*+\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) { 1514 $return_type = $1; 1515 $declaration_name = $2; 1516 my $args = $3; 1517 1518 create_parameterlist($args, ',', $file, $declaration_name); 1519 } else { 1520 print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype'\n"; 1521 return; 1522 } 1523 1524 my $prms = join " ", @parameterlist; 1525 check_sections($file, $declaration_name, "function", $sectcheck, $prms); 1526 1527 # This check emits a lot of warnings at the moment, because many 1528 # functions don't have a 'Return' doc section. So until the number 1529 # of warnings goes sufficiently down, the check is only performed in 1530 # verbose mode. 1531 # TODO: always perform the check. 1532 if ($verbose && !$noret) { 1533 check_return_section($file, $declaration_name, $return_type); 1534 } 1535 1536 output_declaration($declaration_name, 1537 'function', 1538 {'function' => $declaration_name, 1539 'module' => $modulename, 1540 'functiontype' => $return_type, 1541 'parameterlist' => \@parameterlist, 1542 'parameterdescs' => \%parameterdescs, 1543 'parametertypes' => \%parametertypes, 1544 'sectionlist' => \@sectionlist, 1545 'sections' => \%sections, 1546 'purpose' => $declaration_purpose 1547 }); 1548} 1549 1550sub reset_state { 1551 $function = ""; 1552 %parameterdescs = (); 1553 %parametertypes = (); 1554 @parameterlist = (); 1555 %sections = (); 1556 @sectionlist = (); 1557 $sectcheck = ""; 1558 $struct_actual = ""; 1559 $prototype = ""; 1560 1561 $state = STATE_NORMAL; 1562 $inline_doc_state = STATE_INLINE_NA; 1563} 1564 1565sub tracepoint_munge($) { 1566 my $file = shift; 1567 my $tracepointname = 0; 1568 my $tracepointargs = 0; 1569 1570 if ($prototype =~ m/TRACE_EVENT\((.*?),/) { 1571 $tracepointname = $1; 1572 } 1573 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) { 1574 $tracepointname = $1; 1575 } 1576 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) { 1577 $tracepointname = $2; 1578 } 1579 $tracepointname =~ s/^\s+//; #strip leading whitespace 1580 if ($prototype =~ m/TP_PROTO\((.*?)\)/) { 1581 $tracepointargs = $1; 1582 } 1583 if (($tracepointname eq 0) || ($tracepointargs eq 0)) { 1584 print STDERR "${file}:$.: warning: Unrecognized tracepoint format: \n". 1585 "$prototype\n"; 1586 } else { 1587 $prototype = "static inline void trace_$tracepointname($tracepointargs)"; 1588 } 1589} 1590 1591sub syscall_munge() { 1592 my $void = 0; 1593 1594 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's 1595## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) { 1596 if ($prototype =~ m/SYSCALL_DEFINE0/) { 1597 $void = 1; 1598## $prototype = "long sys_$1(void)"; 1599 } 1600 1601 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name 1602 if ($prototype =~ m/long (sys_.*?),/) { 1603 $prototype =~ s/,/\(/; 1604 } elsif ($void) { 1605 $prototype =~ s/\)/\(void\)/; 1606 } 1607 1608 # now delete all of the odd-number commas in $prototype 1609 # so that arg types & arg names don't have a comma between them 1610 my $count = 0; 1611 my $len = length($prototype); 1612 if ($void) { 1613 $len = 0; # skip the for-loop 1614 } 1615 for (my $ix = 0; $ix < $len; $ix++) { 1616 if (substr($prototype, $ix, 1) eq ',') { 1617 $count++; 1618 if ($count % 2 == 1) { 1619 substr($prototype, $ix, 1) = ' '; 1620 } 1621 } 1622 } 1623} 1624 1625sub process_proto_function($$) { 1626 my $x = shift; 1627 my $file = shift; 1628 1629 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line 1630 1631 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) { 1632 # do nothing 1633 } 1634 elsif ($x =~ /([^\{]*)/) { 1635 $prototype .= $1; 1636 } 1637 1638 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) { 1639 $prototype =~ s@/\*.*?\*/@@gos; # strip comments. 1640 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's. 1641 $prototype =~ s@^\s+@@gos; # strip leading spaces 1642 if ($prototype =~ /SYSCALL_DEFINE/) { 1643 syscall_munge(); 1644 } 1645 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ || 1646 $prototype =~ /DEFINE_SINGLE_EVENT/) 1647 { 1648 tracepoint_munge($file); 1649 } 1650 dump_function($prototype, $file); 1651 reset_state(); 1652 } 1653} 1654 1655sub process_proto_type($$) { 1656 my $x = shift; 1657 my $file = shift; 1658 1659 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's. 1660 $x =~ s@^\s+@@gos; # strip leading spaces 1661 $x =~ s@\s+$@@gos; # strip trailing spaces 1662 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line 1663 1664 if ($x =~ /^#/) { 1665 # To distinguish preprocessor directive from regular declaration later. 1666 $x .= ";"; 1667 } 1668 1669 while (1) { 1670 if ( $x =~ /([^{};]*)([{};])(.*)/ ) { 1671 if( length $prototype ) { 1672 $prototype .= " " 1673 } 1674 $prototype .= $1 . $2; 1675 ($2 eq '{') && $brcount++; 1676 ($2 eq '}') && $brcount--; 1677 if (($2 eq ';') && ($brcount == 0)) { 1678 dump_declaration($prototype, $file); 1679 reset_state(); 1680 last; 1681 } 1682 $x = $3; 1683 } else { 1684 $prototype .= $x; 1685 last; 1686 } 1687 } 1688} 1689 1690# xml_escape: replace <, >, and & in the text stream; 1691# 1692# however, formatting controls that are generated internally/locally in the 1693# kernel-doc script are not escaped here; instead, they begin life like 1694# $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings 1695# are converted to their mnemonic-expected output, without the 4 * '\' & ':', 1696# just before actual output; (this is done by local_unescape()) 1697sub xml_escape($) { 1698 my $text = shift; 1699 if ($output_mode eq "man") { 1700 return $text; 1701 } 1702 $text =~ s/\&/\\\\\\amp;/g; 1703 $text =~ s/\</\\\\\\lt;/g; 1704 $text =~ s/\>/\\\\\\gt;/g; 1705 return $text; 1706} 1707 1708# xml_unescape: reverse the effects of xml_escape 1709sub xml_unescape($) { 1710 my $text = shift; 1711 if ($output_mode eq "man") { 1712 return $text; 1713 } 1714 $text =~ s/\\\\\\amp;/\&/g; 1715 $text =~ s/\\\\\\lt;/</g; 1716 $text =~ s/\\\\\\gt;/>/g; 1717 return $text; 1718} 1719 1720# convert local escape strings to html 1721# local escape strings look like: '\\\\menmonic:' (that's 4 backslashes) 1722sub local_unescape($) { 1723 my $text = shift; 1724 if ($output_mode eq "man") { 1725 return $text; 1726 } 1727 $text =~ s/\\\\\\\\lt:/</g; 1728 $text =~ s/\\\\\\\\gt:/>/g; 1729 return $text; 1730} 1731 1732sub map_filename($) { 1733 my $file; 1734 my ($orig_file) = @_; 1735 1736 if (defined($ENV{'SRCTREE'})) { 1737 $file = "$ENV{'SRCTREE'}" . "/" . $orig_file; 1738 } else { 1739 $file = $orig_file; 1740 } 1741 1742 if (defined($source_map{$file})) { 1743 $file = $source_map{$file}; 1744 } 1745 1746 return $file; 1747} 1748 1749sub process_export_file($) { 1750 my ($orig_file) = @_; 1751 my $file = map_filename($orig_file); 1752 1753 if (!open(IN,"<$file")) { 1754 print STDERR "Error: Cannot open file $file\n"; 1755 ++$errors; 1756 return; 1757 } 1758 1759 while (<IN>) { 1760 if (/$export_symbol/) { 1761 $function_table{$2} = 1; 1762 } 1763 } 1764 1765 close(IN); 1766} 1767 1768sub process_file($) { 1769 my $file; 1770 my $identifier; 1771 my $func; 1772 my $descr; 1773 my $in_purpose = 0; 1774 my $initial_section_counter = $section_counter; 1775 my ($orig_file) = @_; 1776 my $leading_space; 1777 1778 $file = map_filename($orig_file); 1779 1780 if (!open(IN,"<$file")) { 1781 print STDERR "Error: Cannot open file $file\n"; 1782 ++$errors; 1783 return; 1784 } 1785 1786 $. = 1; 1787 1788 $section_counter = 0; 1789 while (<IN>) { 1790 while (s/\\\s*$//) { 1791 $_ .= <IN>; 1792 } 1793 # Replace tabs by spaces 1794 while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {}; 1795 if ($state == STATE_NORMAL) { 1796 if (/$doc_start/o) { 1797 $state = STATE_NAME; # next line is always the function name 1798 $in_doc_sect = 0; 1799 $declaration_start_line = $. + 1; 1800 } 1801 } elsif ($state == STATE_NAME) {# this line is the function name (always) 1802 if (/$doc_block/o) { 1803 $state = STATE_DOCBLOCK; 1804 $contents = ""; 1805 $new_start_line = $. + 1; 1806 1807 if ( $1 eq "" ) { 1808 $section = $section_intro; 1809 } else { 1810 $section = $1; 1811 } 1812 } 1813 elsif (/$doc_decl/o) { 1814 $identifier = $1; 1815 if (/\s*([\w\s]+?)\s*-/) { 1816 $identifier = $1; 1817 } 1818 1819 $state = STATE_FIELD; 1820 # if there's no @param blocks need to set up default section 1821 # here 1822 $contents = ""; 1823 $section = $section_default; 1824 $new_start_line = $. + 1; 1825 if (/-(.*)/) { 1826 # strip leading/trailing/multiple spaces 1827 $descr= $1; 1828 $descr =~ s/^\s*//; 1829 $descr =~ s/\s*$//; 1830 $descr =~ s/\s+/ /g; 1831 $declaration_purpose = xml_escape($descr); 1832 $in_purpose = 1; 1833 } else { 1834 $declaration_purpose = ""; 1835 } 1836 1837 if (($declaration_purpose eq "") && $verbose) { 1838 print STDERR "${file}:$.: warning: missing initial short description on line:\n"; 1839 print STDERR $_; 1840 ++$warnings; 1841 } 1842 1843 if ($identifier =~ m/^struct/) { 1844 $decl_type = 'struct'; 1845 } elsif ($identifier =~ m/^union/) { 1846 $decl_type = 'union'; 1847 } elsif ($identifier =~ m/^enum/) { 1848 $decl_type = 'enum'; 1849 } elsif ($identifier =~ m/^typedef/) { 1850 $decl_type = 'typedef'; 1851 } else { 1852 $decl_type = 'function'; 1853 } 1854 1855 if ($verbose) { 1856 print STDERR "${file}:$.: info: Scanning doc for $identifier\n"; 1857 } 1858 } else { 1859 print STDERR "${file}:$.: warning: Cannot understand $_ on line $.", 1860 " - I thought it was a doc line\n"; 1861 ++$warnings; 1862 $state = STATE_NORMAL; 1863 } 1864 } elsif ($state == STATE_FIELD) { # look for head: lines, and include content 1865 if (/$doc_sect/i) { # case insensitive for supported section names 1866 $newsection = $1; 1867 $newcontents = $2; 1868 1869 # map the supported section names to the canonical names 1870 if ($newsection =~ m/^description$/i) { 1871 $newsection = $section_default; 1872 } elsif ($newsection =~ m/^context$/i) { 1873 $newsection = $section_context; 1874 } elsif ($newsection =~ m/^returns?$/i) { 1875 $newsection = $section_return; 1876 } elsif ($newsection =~ m/^\@return$/) { 1877 # special: @return is a section, not a param description 1878 $newsection = $section_return; 1879 } 1880 1881 if (($contents ne "") && ($contents ne "\n")) { 1882 if (!$in_doc_sect && $verbose) { 1883 print STDERR "${file}:$.: warning: contents before sections\n"; 1884 ++$warnings; 1885 } 1886 dump_section($file, $section, xml_escape($contents)); 1887 $section = $section_default; 1888 } 1889 1890 $in_doc_sect = 1; 1891 $in_purpose = 0; 1892 $contents = $newcontents; 1893 $new_start_line = $.; 1894 while (substr($contents, 0, 1) eq " ") { 1895 $contents = substr($contents, 1); 1896 } 1897 if ($contents ne "") { 1898 $contents .= "\n"; 1899 } 1900 $section = $newsection; 1901 $leading_space = undef; 1902 } elsif (/$doc_end/) { 1903 if (($contents ne "") && ($contents ne "\n")) { 1904 dump_section($file, $section, xml_escape($contents)); 1905 $section = $section_default; 1906 $contents = ""; 1907 } 1908 # look for doc_com + <text> + doc_end: 1909 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') { 1910 print STDERR "${file}:$.: warning: suspicious ending line: $_"; 1911 ++$warnings; 1912 } 1913 1914 $prototype = ""; 1915 $state = STATE_PROTO; 1916 $brcount = 0; 1917# print STDERR "end of doc comment, looking for prototype\n"; 1918 } elsif (/$doc_content/) { 1919 # miguel-style comment kludge, look for blank lines after 1920 # @parameter line to signify start of description 1921 if ($1 eq "") { 1922 if ($section =~ m/^@/ || $section eq $section_context) { 1923 dump_section($file, $section, xml_escape($contents)); 1924 $section = $section_default; 1925 $contents = ""; 1926 $new_start_line = $.; 1927 } else { 1928 $contents .= "\n"; 1929 } 1930 $in_purpose = 0; 1931 } elsif ($in_purpose == 1) { 1932 # Continued declaration purpose 1933 chomp($declaration_purpose); 1934 $declaration_purpose .= " " . xml_escape($1); 1935 $declaration_purpose =~ s/\s+/ /g; 1936 } else { 1937 my $cont = $1; 1938 if ($section =~ m/^@/ || $section eq $section_context) { 1939 if (!defined $leading_space) { 1940 if ($cont =~ m/^(\s+)/) { 1941 $leading_space = $1; 1942 } else { 1943 $leading_space = ""; 1944 } 1945 } 1946 1947 $cont =~ s/^$leading_space//; 1948 } 1949 $contents .= $cont . "\n"; 1950 } 1951 } else { 1952 # i dont know - bad line? ignore. 1953 print STDERR "${file}:$.: warning: bad line: $_"; 1954 ++$warnings; 1955 } 1956 } elsif ($state == STATE_INLINE) { # scanning for inline parameters 1957 # First line (state 1) needs to be a @parameter 1958 if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) { 1959 $section = $1; 1960 $contents = $2; 1961 $new_start_line = $.; 1962 if ($contents ne "") { 1963 while (substr($contents, 0, 1) eq " ") { 1964 $contents = substr($contents, 1); 1965 } 1966 $contents .= "\n"; 1967 } 1968 $inline_doc_state = STATE_INLINE_TEXT; 1969 # Documentation block end */ 1970 } elsif (/$doc_inline_end/) { 1971 if (($contents ne "") && ($contents ne "\n")) { 1972 dump_section($file, $section, xml_escape($contents)); 1973 $section = $section_default; 1974 $contents = ""; 1975 } 1976 $state = STATE_PROTO; 1977 $inline_doc_state = STATE_INLINE_NA; 1978 # Regular text 1979 } elsif (/$doc_content/) { 1980 if ($inline_doc_state == STATE_INLINE_TEXT) { 1981 $contents .= $1 . "\n"; 1982 # nuke leading blank lines 1983 if ($contents =~ /^\s*$/) { 1984 $contents = ""; 1985 } 1986 } elsif ($inline_doc_state == STATE_INLINE_NAME) { 1987 $inline_doc_state = STATE_INLINE_ERROR; 1988 print STDERR "${file}:$.: warning: "; 1989 print STDERR "Incorrect use of kernel-doc format: $_"; 1990 ++$warnings; 1991 } 1992 } 1993 } elsif ($state == STATE_PROTO) { # scanning for function '{' (end of prototype) 1994 if (/$doc_inline_oneline/) { 1995 $section = $1; 1996 $contents = $2; 1997 if ($contents ne "") { 1998 $contents .= "\n"; 1999 dump_section($file, $section, xml_escape($contents)); 2000 $section = $section_default; 2001 $contents = ""; 2002 } 2003 } elsif (/$doc_inline_start/) { 2004 $state = STATE_INLINE; 2005 $inline_doc_state = STATE_INLINE_NAME; 2006 } elsif ($decl_type eq 'function') { 2007 process_proto_function($_, $file); 2008 } else { 2009 process_proto_type($_, $file); 2010 } 2011 } elsif ($state == STATE_DOCBLOCK) { 2012 if (/$doc_end/) 2013 { 2014 dump_doc_section($file, $section, xml_escape($contents)); 2015 $section = $section_default; 2016 $contents = ""; 2017 $function = ""; 2018 %parameterdescs = (); 2019 %parametertypes = (); 2020 @parameterlist = (); 2021 %sections = (); 2022 @sectionlist = (); 2023 $prototype = ""; 2024 $state = STATE_NORMAL; 2025 } 2026 elsif (/$doc_content/) 2027 { 2028 if ( $1 eq "" ) 2029 { 2030 $contents .= $blankline; 2031 } 2032 else 2033 { 2034 $contents .= $1 . "\n"; 2035 } 2036 } 2037 } 2038 } 2039 if ($initial_section_counter == $section_counter) { 2040 if ($output_mode ne "none") { 2041 print STDERR "${file}:1: warning: no structured comments found\n"; 2042 } 2043 if (($output_selection == OUTPUT_INCLUDE) && ($show_not_found == 1)) { 2044 print STDERR " Was looking for '$_'.\n" for keys %function_table; 2045 } 2046 } 2047} 2048 2049 2050$kernelversion = get_kernel_version(); 2051 2052# generate a sequence of code that will splice in highlighting information 2053# using the s// operator. 2054for (my $k = 0; $k < @highlights; $k++) { 2055 my $pattern = $highlights[$k][0]; 2056 my $result = $highlights[$k][1]; 2057# print STDERR "scanning pattern:$pattern, highlight:($result)\n"; 2058 $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n"; 2059} 2060 2061# Read the file that maps relative names to absolute names for 2062# separate source and object directories and for shadow trees. 2063if (open(SOURCE_MAP, "<.tmp_filelist.txt")) { 2064 my ($relname, $absname); 2065 while(<SOURCE_MAP>) { 2066 chop(); 2067 ($relname, $absname) = (split())[0..1]; 2068 $relname =~ s:^/+::; 2069 $source_map{$relname} = $absname; 2070 } 2071 close(SOURCE_MAP); 2072} 2073 2074if ($output_selection == OUTPUT_EXPORTED || 2075 $output_selection == OUTPUT_INTERNAL) { 2076 2077 push(@export_file_list, @ARGV); 2078 2079 foreach (@export_file_list) { 2080 chomp; 2081 process_export_file($_); 2082 } 2083} 2084 2085foreach (@ARGV) { 2086 chomp; 2087 process_file($_); 2088} 2089if ($verbose && $errors) { 2090 print STDERR "$errors errors\n"; 2091} 2092if ($verbose && $warnings) { 2093 print STDERR "$warnings warnings\n"; 2094} 2095 2096exit($output_mode eq "none" ? 0 : $errors); 2097