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+(\.\.\.)?)'; 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 = "man"; 272my $output_preformatted = 0; 273my $no_doc_sections = 0; 274my $enable_lineno = 0; 275my @highlights = @highlights_man; 276my $blankline = $blankline_man; 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 = shift @ARGV; 396 if ($cmd eq "-man") { 397 $output_mode = "man"; 398 @highlights = @highlights_man; 399 $blankline = $blankline_man; 400 } elsif ($cmd eq "-rst") { 401 $output_mode = "rst"; 402 @highlights = @highlights_rst; 403 $blankline = $blankline_rst; 404 } elsif ($cmd eq "-none") { 405 $output_mode = "none"; 406 } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document 407 $modulename = shift @ARGV; 408 } elsif ($cmd eq "-function") { # to only output specific functions 409 $output_selection = OUTPUT_INCLUDE; 410 $function = shift @ARGV; 411 $function_table{$function} = 1; 412 } elsif ($cmd eq "-nofunction") { # output all except specific functions 413 $output_selection = OUTPUT_EXCLUDE; 414 $function = shift @ARGV; 415 $function_table{$function} = 1; 416 } elsif ($cmd eq "-export") { # only exported symbols 417 $output_selection = OUTPUT_EXPORTED; 418 %function_table = (); 419 } elsif ($cmd eq "-internal") { # only non-exported symbols 420 $output_selection = OUTPUT_INTERNAL; 421 %function_table = (); 422 } elsif ($cmd eq "-export-file") { 423 my $file = shift @ARGV; 424 push(@export_file_list, $file); 425 } elsif ($cmd eq "-v") { 426 $verbose = 1; 427 } elsif (($cmd eq "-h") || ($cmd eq "--help")) { 428 usage(); 429 } elsif ($cmd eq '-no-doc-sections') { 430 $no_doc_sections = 1; 431 } elsif ($cmd eq '-enable-lineno') { 432 $enable_lineno = 1; 433 } elsif ($cmd eq '-show-not-found') { 434 $show_not_found = 1; 435 } 436} 437 438# continue execution near EOF; 439 440# get kernel version from env 441sub get_kernel_version() { 442 my $version = 'unknown kernel version'; 443 444 if (defined($ENV{'KERNELVERSION'})) { 445 $version = $ENV{'KERNELVERSION'}; 446 } 447 return $version; 448} 449 450# 451sub print_lineno { 452 my $lineno = shift; 453 if ($enable_lineno && defined($lineno)) { 454 print "#define LINENO " . $lineno . "\n"; 455 } 456} 457## 458# dumps section contents to arrays/hashes intended for that purpose. 459# 460sub dump_section { 461 my $file = shift; 462 my $name = shift; 463 my $contents = join "\n", @_; 464 465 if ($name =~ m/$type_param/) { 466 $name = $1; 467 $parameterdescs{$name} = $contents; 468 $sectcheck = $sectcheck . $name . " "; 469 $parameterdesc_start_lines{$name} = $new_start_line; 470 $new_start_line = 0; 471 } elsif ($name eq "@\.\.\.") { 472 $name = "..."; 473 $parameterdescs{$name} = $contents; 474 $sectcheck = $sectcheck . $name . " "; 475 $parameterdesc_start_lines{$name} = $new_start_line; 476 $new_start_line = 0; 477 } else { 478 if (defined($sections{$name}) && ($sections{$name} ne "")) { 479 # Only warn on user specified duplicate section names. 480 if ($name ne $section_default) { 481 print STDERR "${file}:$.: warning: duplicate section name '$name'\n"; 482 ++$warnings; 483 } 484 $sections{$name} .= $contents; 485 } else { 486 $sections{$name} = $contents; 487 push @sectionlist, $name; 488 $section_start_lines{$name} = $new_start_line; 489 $new_start_line = 0; 490 } 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 (($output_selection == OUTPUT_ALL) || 507 ($output_selection == OUTPUT_INCLUDE && 508 defined($function_table{$name})) || 509 ($output_selection == OUTPUT_EXCLUDE && 510 !defined($function_table{$name}))) 511 { 512 dump_section($file, $name, $contents); 513 output_blockhead({'sectionlist' => \@sectionlist, 514 'sections' => \%sections, 515 'module' => $modulename, 516 'content-only' => ($output_selection != OUTPUT_ALL), }); 517 } 518} 519 520## 521# output function 522# 523# parameterdescs, a hash. 524# function => "function name" 525# parameterlist => @list of parameters 526# parameterdescs => %parameter descriptions 527# sectionlist => @list of sections 528# sections => %section descriptions 529# 530 531sub output_highlight { 532 my $contents = join "\n",@_; 533 my $line; 534 535# DEBUG 536# if (!defined $contents) { 537# use Carp; 538# confess "output_highlight got called with no args?\n"; 539# } 540 541# print STDERR "contents b4:$contents\n"; 542 eval $dohighlight; 543 die $@ if $@; 544# print STDERR "contents af:$contents\n"; 545 546 foreach $line (split "\n", $contents) { 547 if (! $output_preformatted) { 548 $line =~ s/^\s*//; 549 } 550 if ($line eq ""){ 551 if (! $output_preformatted) { 552 print $lineprefix, local_unescape($blankline); 553 } 554 } else { 555 $line =~ s/\\\\\\/\&/g; 556 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") { 557 print "\\&$line"; 558 } else { 559 print $lineprefix, $line; 560 } 561 } 562 print "\n"; 563 } 564} 565 566## 567# output function in man 568sub output_function_man(%) { 569 my %args = %{$_[0]}; 570 my ($parameter, $section); 571 my $count; 572 573 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n"; 574 575 print ".SH NAME\n"; 576 print $args{'function'} . " \\- " . $args{'purpose'} . "\n"; 577 578 print ".SH SYNOPSIS\n"; 579 if ($args{'functiontype'} ne "") { 580 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n"; 581 } else { 582 print ".B \"" . $args{'function'} . "\n"; 583 } 584 $count = 0; 585 my $parenth = "("; 586 my $post = ","; 587 foreach my $parameter (@{$args{'parameterlist'}}) { 588 if ($count == $#{$args{'parameterlist'}}) { 589 $post = ");"; 590 } 591 $type = $args{'parametertypes'}{$parameter}; 592 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 593 # pointer-to-function 594 print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n"; 595 } else { 596 $type =~ s/([^\*])$/$1 /; 597 print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n"; 598 } 599 $count++; 600 $parenth = ""; 601 } 602 603 print ".SH ARGUMENTS\n"; 604 foreach $parameter (@{$args{'parameterlist'}}) { 605 my $parameter_name = $parameter; 606 $parameter_name =~ s/\[.*//; 607 608 print ".IP \"" . $parameter . "\" 12\n"; 609 output_highlight($args{'parameterdescs'}{$parameter_name}); 610 } 611 foreach $section (@{$args{'sectionlist'}}) { 612 print ".SH \"", uc $section, "\"\n"; 613 output_highlight($args{'sections'}{$section}); 614 } 615} 616 617## 618# output enum in man 619sub output_enum_man(%) { 620 my %args = %{$_[0]}; 621 my ($parameter, $section); 622 my $count; 623 624 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n"; 625 626 print ".SH NAME\n"; 627 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n"; 628 629 print ".SH SYNOPSIS\n"; 630 print "enum " . $args{'enum'} . " {\n"; 631 $count = 0; 632 foreach my $parameter (@{$args{'parameterlist'}}) { 633 print ".br\n.BI \" $parameter\"\n"; 634 if ($count == $#{$args{'parameterlist'}}) { 635 print "\n};\n"; 636 last; 637 } 638 else { 639 print ", \n.br\n"; 640 } 641 $count++; 642 } 643 644 print ".SH Constants\n"; 645 foreach $parameter (@{$args{'parameterlist'}}) { 646 my $parameter_name = $parameter; 647 $parameter_name =~ s/\[.*//; 648 649 print ".IP \"" . $parameter . "\" 12\n"; 650 output_highlight($args{'parameterdescs'}{$parameter_name}); 651 } 652 foreach $section (@{$args{'sectionlist'}}) { 653 print ".SH \"$section\"\n"; 654 output_highlight($args{'sections'}{$section}); 655 } 656} 657 658## 659# output struct in man 660sub output_struct_man(%) { 661 my %args = %{$_[0]}; 662 my ($parameter, $section); 663 664 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n"; 665 666 print ".SH NAME\n"; 667 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n"; 668 669 print ".SH SYNOPSIS\n"; 670 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n"; 671 672 foreach my $parameter (@{$args{'parameterlist'}}) { 673 if ($parameter =~ /^#/) { 674 print ".BI \"$parameter\"\n.br\n"; 675 next; 676 } 677 my $parameter_name = $parameter; 678 $parameter_name =~ s/\[.*//; 679 680 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 681 $type = $args{'parametertypes'}{$parameter}; 682 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 683 # pointer-to-function 684 print ".BI \" " . $1 . "\" " . $parameter . " \") (" . $2 . ")" . "\"\n;\n"; 685 } elsif ($type =~ m/^(.*?)\s*(:.*)/) { 686 # bitfield 687 print ".BI \" " . $1 . "\ \" " . $parameter . $2 . " \"" . "\"\n;\n"; 688 } else { 689 $type =~ s/([^\*])$/$1 /; 690 print ".BI \" " . $type . "\" " . $parameter . " \"" . "\"\n;\n"; 691 } 692 print "\n.br\n"; 693 } 694 print "};\n.br\n"; 695 696 print ".SH Members\n"; 697 foreach $parameter (@{$args{'parameterlist'}}) { 698 ($parameter =~ /^#/) && next; 699 700 my $parameter_name = $parameter; 701 $parameter_name =~ s/\[.*//; 702 703 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 704 print ".IP \"" . $parameter . "\" 12\n"; 705 output_highlight($args{'parameterdescs'}{$parameter_name}); 706 } 707 foreach $section (@{$args{'sectionlist'}}) { 708 print ".SH \"$section\"\n"; 709 output_highlight($args{'sections'}{$section}); 710 } 711} 712 713## 714# output typedef in man 715sub output_typedef_man(%) { 716 my %args = %{$_[0]}; 717 my ($parameter, $section); 718 719 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n"; 720 721 print ".SH NAME\n"; 722 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n"; 723 724 foreach $section (@{$args{'sectionlist'}}) { 725 print ".SH \"$section\"\n"; 726 output_highlight($args{'sections'}{$section}); 727 } 728} 729 730sub output_blockhead_man(%) { 731 my %args = %{$_[0]}; 732 my ($parameter, $section); 733 my $count; 734 735 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n"; 736 737 foreach $section (@{$args{'sectionlist'}}) { 738 print ".SH \"$section\"\n"; 739 output_highlight($args{'sections'}{$section}); 740 } 741} 742 743## 744# output in restructured text 745# 746 747# 748# This could use some work; it's used to output the DOC: sections, and 749# starts by putting out the name of the doc section itself, but that tends 750# to duplicate a header already in the template file. 751# 752sub output_blockhead_rst(%) { 753 my %args = %{$_[0]}; 754 my ($parameter, $section); 755 756 foreach $section (@{$args{'sectionlist'}}) { 757 if ($output_selection != OUTPUT_INCLUDE) { 758 print "**$section**\n\n"; 759 } 760 print_lineno($section_start_lines{$section}); 761 output_highlight_rst($args{'sections'}{$section}); 762 print "\n"; 763 } 764} 765 766sub output_highlight_rst { 767 my $contents = join "\n",@_; 768 my $line; 769 770 # undo the evil effects of xml_escape() earlier 771 $contents = xml_unescape($contents); 772 773 eval $dohighlight; 774 die $@ if $@; 775 776 foreach $line (split "\n", $contents) { 777 print $lineprefix . $line . "\n"; 778 } 779} 780 781sub output_function_rst(%) { 782 my %args = %{$_[0]}; 783 my ($parameter, $section); 784 my $oldprefix = $lineprefix; 785 my $start = ""; 786 787 if ($args{'typedef'}) { 788 print ".. c:type:: ". $args{'function'} . "\n\n"; 789 print_lineno($declaration_start_line); 790 print " **Typedef**: "; 791 $lineprefix = ""; 792 output_highlight_rst($args{'purpose'}); 793 $start = "\n\n**Syntax**\n\n ``"; 794 } else { 795 print ".. c:function:: "; 796 } 797 if ($args{'functiontype'} ne "") { 798 $start .= $args{'functiontype'} . " " . $args{'function'} . " ("; 799 } else { 800 $start .= $args{'function'} . " ("; 801 } 802 print $start; 803 804 my $count = 0; 805 foreach my $parameter (@{$args{'parameterlist'}}) { 806 if ($count ne 0) { 807 print ", "; 808 } 809 $count++; 810 $type = $args{'parametertypes'}{$parameter}; 811 812 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 813 # pointer-to-function 814 print $1 . $parameter . ") (" . $2; 815 } else { 816 print $type . " " . $parameter; 817 } 818 } 819 if ($args{'typedef'}) { 820 print ");``\n\n"; 821 } else { 822 print ")\n\n"; 823 print_lineno($declaration_start_line); 824 $lineprefix = " "; 825 output_highlight_rst($args{'purpose'}); 826 print "\n"; 827 } 828 829 print "**Parameters**\n\n"; 830 $lineprefix = " "; 831 foreach $parameter (@{$args{'parameterlist'}}) { 832 my $parameter_name = $parameter; 833 $parameter_name =~ s/\[.*//; 834 $type = $args{'parametertypes'}{$parameter}; 835 836 if ($type ne "") { 837 print "``$type $parameter``\n"; 838 } else { 839 print "``$parameter``\n"; 840 } 841 842 print_lineno($parameterdesc_start_lines{$parameter_name}); 843 844 if (defined($args{'parameterdescs'}{$parameter_name}) && 845 $args{'parameterdescs'}{$parameter_name} ne $undescribed) { 846 output_highlight_rst($args{'parameterdescs'}{$parameter_name}); 847 } else { 848 print " *undescribed*\n"; 849 } 850 print "\n"; 851 } 852 853 $lineprefix = $oldprefix; 854 output_section_rst(@_); 855} 856 857sub output_section_rst(%) { 858 my %args = %{$_[0]}; 859 my $section; 860 my $oldprefix = $lineprefix; 861 $lineprefix = ""; 862 863 foreach $section (@{$args{'sectionlist'}}) { 864 print "**$section**\n\n"; 865 print_lineno($section_start_lines{$section}); 866 output_highlight_rst($args{'sections'}{$section}); 867 print "\n"; 868 } 869 print "\n"; 870 $lineprefix = $oldprefix; 871} 872 873sub output_enum_rst(%) { 874 my %args = %{$_[0]}; 875 my ($parameter); 876 my $oldprefix = $lineprefix; 877 my $count; 878 my $name = "enum " . $args{'enum'}; 879 880 print "\n\n.. c:type:: " . $name . "\n\n"; 881 print_lineno($declaration_start_line); 882 $lineprefix = " "; 883 output_highlight_rst($args{'purpose'}); 884 print "\n"; 885 886 print "**Constants**\n\n"; 887 $lineprefix = " "; 888 foreach $parameter (@{$args{'parameterlist'}}) { 889 print "``$parameter``\n"; 890 if ($args{'parameterdescs'}{$parameter} ne $undescribed) { 891 output_highlight_rst($args{'parameterdescs'}{$parameter}); 892 } else { 893 print " *undescribed*\n"; 894 } 895 print "\n"; 896 } 897 898 $lineprefix = $oldprefix; 899 output_section_rst(@_); 900} 901 902sub output_typedef_rst(%) { 903 my %args = %{$_[0]}; 904 my ($parameter); 905 my $oldprefix = $lineprefix; 906 my $name = "typedef " . $args{'typedef'}; 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 $lineprefix = $oldprefix; 915 output_section_rst(@_); 916} 917 918sub output_struct_rst(%) { 919 my %args = %{$_[0]}; 920 my ($parameter); 921 my $oldprefix = $lineprefix; 922 my $name = $args{'type'} . " " . $args{'struct'}; 923 924 print "\n\n.. c:type:: " . $name . "\n\n"; 925 print_lineno($declaration_start_line); 926 $lineprefix = " "; 927 output_highlight_rst($args{'purpose'}); 928 print "\n"; 929 930 print "**Definition**\n\n"; 931 print "::\n\n"; 932 print " " . $args{'type'} . " " . $args{'struct'} . " {\n"; 933 foreach $parameter (@{$args{'parameterlist'}}) { 934 if ($parameter =~ /^#/) { 935 print " " . "$parameter\n"; 936 next; 937 } 938 939 my $parameter_name = $parameter; 940 $parameter_name =~ s/\[.*//; 941 942 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 943 $type = $args{'parametertypes'}{$parameter}; 944 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 945 # pointer-to-function 946 print " $1 $parameter) ($2);\n"; 947 } elsif ($type =~ m/^(.*?)\s*(:.*)/) { 948 # bitfield 949 print " $1 $parameter$2;\n"; 950 } else { 951 print " " . $type . " " . $parameter . ";\n"; 952 } 953 } 954 print " };\n\n"; 955 956 print "**Members**\n\n"; 957 $lineprefix = " "; 958 foreach $parameter (@{$args{'parameterlist'}}) { 959 ($parameter =~ /^#/) && next; 960 961 my $parameter_name = $parameter; 962 $parameter_name =~ s/\[.*//; 963 964 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 965 $type = $args{'parametertypes'}{$parameter}; 966 print_lineno($parameterdesc_start_lines{$parameter_name}); 967 print "``" . $parameter . "``\n"; 968 output_highlight_rst($args{'parameterdescs'}{$parameter_name}); 969 print "\n"; 970 } 971 print "\n"; 972 973 $lineprefix = $oldprefix; 974 output_section_rst(@_); 975} 976 977## none mode output functions 978 979sub output_function_none(%) { 980} 981 982sub output_enum_none(%) { 983} 984 985sub output_typedef_none(%) { 986} 987 988sub output_struct_none(%) { 989} 990 991sub output_blockhead_none(%) { 992} 993 994## 995# generic output function for all types (function, struct/union, typedef, enum); 996# calls the generated, variable output_ function name based on 997# functype and output_mode 998sub output_declaration { 999 no strict 'refs'; 1000 my $name = shift; 1001 my $functype = shift; 1002 my $func = "output_${functype}_$output_mode"; 1003 if (($output_selection == OUTPUT_ALL) || 1004 (($output_selection == OUTPUT_INCLUDE || 1005 $output_selection == OUTPUT_EXPORTED) && 1006 defined($function_table{$name})) || 1007 (($output_selection == OUTPUT_EXCLUDE || 1008 $output_selection == OUTPUT_INTERNAL) && 1009 !($functype eq "function" && defined($function_table{$name})))) 1010 { 1011 &$func(@_); 1012 $section_counter++; 1013 } 1014} 1015 1016## 1017# generic output function - calls the right one based on current output mode. 1018sub output_blockhead { 1019 no strict 'refs'; 1020 my $func = "output_blockhead_" . $output_mode; 1021 &$func(@_); 1022 $section_counter++; 1023} 1024 1025## 1026# takes a declaration (struct, union, enum, typedef) and 1027# invokes the right handler. NOT called for functions. 1028sub dump_declaration($$) { 1029 no strict 'refs'; 1030 my ($prototype, $file) = @_; 1031 my $func = "dump_" . $decl_type; 1032 &$func(@_); 1033} 1034 1035sub dump_union($$) { 1036 dump_struct(@_); 1037} 1038 1039sub dump_struct($$) { 1040 my $x = shift; 1041 my $file = shift; 1042 my $nested; 1043 1044 if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) { 1045 my $decl_type = $1; 1046 $declaration_name = $2; 1047 my $members = $3; 1048 1049 # ignore embedded structs or unions 1050 $members =~ s/({.*})//g; 1051 $nested = $1; 1052 1053 # ignore members marked private: 1054 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi; 1055 $members =~ s/\/\*\s*private:.*//gosi; 1056 # strip comments: 1057 $members =~ s/\/\*.*?\*\///gos; 1058 $nested =~ s/\/\*.*?\*\///gos; 1059 # strip attributes 1060 $members =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i; 1061 $members =~ s/__aligned\s*\([^;]*\)//gos; 1062 $members =~ s/\s*CRYPTO_MINALIGN_ATTR//gos; 1063 # replace DECLARE_BITMAP 1064 $members =~ s/DECLARE_BITMAP\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos; 1065 # replace DECLARE_HASHTABLE 1066 $members =~ s/DECLARE_HASHTABLE\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[1 << (($2) - 1)\]/gos; 1067 # replace DECLARE_KFIFO 1068 $members =~ s/DECLARE_KFIFO\s*\(([^,)]+),\s*([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos; 1069 # replace DECLARE_KFIFO_PTR 1070 $members =~ s/DECLARE_KFIFO_PTR\s*\(([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos; 1071 1072 create_parameterlist($members, ';', $file); 1073 check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual, $nested); 1074 1075 output_declaration($declaration_name, 1076 'struct', 1077 {'struct' => $declaration_name, 1078 'module' => $modulename, 1079 'parameterlist' => \@parameterlist, 1080 'parameterdescs' => \%parameterdescs, 1081 'parametertypes' => \%parametertypes, 1082 'sectionlist' => \@sectionlist, 1083 'sections' => \%sections, 1084 'purpose' => $declaration_purpose, 1085 'type' => $decl_type 1086 }); 1087 } 1088 else { 1089 print STDERR "${file}:$.: error: Cannot parse struct or union!\n"; 1090 ++$errors; 1091 } 1092} 1093 1094sub dump_enum($$) { 1095 my $x = shift; 1096 my $file = shift; 1097 1098 $x =~ s@/\*.*?\*/@@gos; # strip comments. 1099 # strip #define macros inside enums 1100 $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos; 1101 1102 if ($x =~ /enum\s+(\w+)\s*{(.*)}/) { 1103 $declaration_name = $1; 1104 my $members = $2; 1105 my %_members; 1106 1107 $members =~ s/\s+$//; 1108 1109 foreach my $arg (split ',', $members) { 1110 $arg =~ s/^\s*(\w+).*/$1/; 1111 push @parameterlist, $arg; 1112 if (!$parameterdescs{$arg}) { 1113 $parameterdescs{$arg} = $undescribed; 1114 print STDERR "${file}:$.: warning: Enum value '$arg' ". 1115 "not described in enum '$declaration_name'\n"; 1116 } 1117 $_members{$arg} = 1; 1118 } 1119 1120 while (my ($k, $v) = each %parameterdescs) { 1121 if (!exists($_members{$k})) { 1122 print STDERR "${file}:$.: warning: Excess enum value " . 1123 "'$k' description in '$declaration_name'\n"; 1124 } 1125 } 1126 1127 output_declaration($declaration_name, 1128 'enum', 1129 {'enum' => $declaration_name, 1130 'module' => $modulename, 1131 'parameterlist' => \@parameterlist, 1132 'parameterdescs' => \%parameterdescs, 1133 'sectionlist' => \@sectionlist, 1134 'sections' => \%sections, 1135 'purpose' => $declaration_purpose 1136 }); 1137 } 1138 else { 1139 print STDERR "${file}:$.: error: Cannot parse enum!\n"; 1140 ++$errors; 1141 } 1142} 1143 1144sub dump_typedef($$) { 1145 my $x = shift; 1146 my $file = shift; 1147 1148 $x =~ s@/\*.*?\*/@@gos; # strip comments. 1149 1150 # Parse function prototypes 1151 if ($x =~ /typedef\s+(\w+)\s*\(\*\s*(\w\S+)\s*\)\s*\((.*)\);/ || 1152 $x =~ /typedef\s+(\w+)\s*(\w\S+)\s*\s*\((.*)\);/) { 1153 1154 # Function typedefs 1155 $return_type = $1; 1156 $declaration_name = $2; 1157 my $args = $3; 1158 1159 create_parameterlist($args, ',', $file); 1160 1161 output_declaration($declaration_name, 1162 'function', 1163 {'function' => $declaration_name, 1164 'typedef' => 1, 1165 'module' => $modulename, 1166 'functiontype' => $return_type, 1167 'parameterlist' => \@parameterlist, 1168 'parameterdescs' => \%parameterdescs, 1169 'parametertypes' => \%parametertypes, 1170 'sectionlist' => \@sectionlist, 1171 'sections' => \%sections, 1172 'purpose' => $declaration_purpose 1173 }); 1174 return; 1175 } 1176 1177 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) { 1178 $x =~ s/\(*.\)\s*;$/;/; 1179 $x =~ s/\[*.\]\s*;$/;/; 1180 } 1181 1182 if ($x =~ /typedef.*\s+(\w+)\s*;/) { 1183 $declaration_name = $1; 1184 1185 output_declaration($declaration_name, 1186 'typedef', 1187 {'typedef' => $declaration_name, 1188 'module' => $modulename, 1189 'sectionlist' => \@sectionlist, 1190 'sections' => \%sections, 1191 'purpose' => $declaration_purpose 1192 }); 1193 } 1194 else { 1195 print STDERR "${file}:$.: error: Cannot parse typedef!\n"; 1196 ++$errors; 1197 } 1198} 1199 1200sub save_struct_actual($) { 1201 my $actual = shift; 1202 1203 # strip all spaces from the actual param so that it looks like one string item 1204 $actual =~ s/\s*//g; 1205 $struct_actual = $struct_actual . $actual . " "; 1206} 1207 1208sub create_parameterlist($$$) { 1209 my $args = shift; 1210 my $splitter = shift; 1211 my $file = shift; 1212 my $type; 1213 my $param; 1214 1215 # temporarily replace commas inside function pointer definition 1216 while ($args =~ /(\([^\),]+),/) { 1217 $args =~ s/(\([^\),]+),/$1#/g; 1218 } 1219 1220 foreach my $arg (split($splitter, $args)) { 1221 # strip comments 1222 $arg =~ s/\/\*.*\*\///; 1223 # strip leading/trailing spaces 1224 $arg =~ s/^\s*//; 1225 $arg =~ s/\s*$//; 1226 $arg =~ s/\s+/ /; 1227 1228 if ($arg =~ /^#/) { 1229 # Treat preprocessor directive as a typeless variable just to fill 1230 # corresponding data structures "correctly". Catch it later in 1231 # output_* subs. 1232 push_parameter($arg, "", $file); 1233 } elsif ($arg =~ m/\(.+\)\s*\(/) { 1234 # pointer-to-function 1235 $arg =~ tr/#/,/; 1236 $arg =~ m/[^\(]+\(\*?\s*(\w*)\s*\)/; 1237 $param = $1; 1238 $type = $arg; 1239 $type =~ s/([^\(]+\(\*?)\s*$param/$1/; 1240 save_struct_actual($param); 1241 push_parameter($param, $type, $file); 1242 } elsif ($arg) { 1243 $arg =~ s/\s*:\s*/:/g; 1244 $arg =~ s/\s*\[/\[/g; 1245 1246 my @args = split('\s*,\s*', $arg); 1247 if ($args[0] =~ m/\*/) { 1248 $args[0] =~ s/(\*+)\s*/ $1/; 1249 } 1250 1251 my @first_arg; 1252 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) { 1253 shift @args; 1254 push(@first_arg, split('\s+', $1)); 1255 push(@first_arg, $2); 1256 } else { 1257 @first_arg = split('\s+', shift @args); 1258 } 1259 1260 unshift(@args, pop @first_arg); 1261 $type = join " ", @first_arg; 1262 1263 foreach $param (@args) { 1264 if ($param =~ m/^(\*+)\s*(.*)/) { 1265 save_struct_actual($2); 1266 push_parameter($2, "$type $1", $file); 1267 } 1268 elsif ($param =~ m/(.*?):(\d+)/) { 1269 if ($type ne "") { # skip unnamed bit-fields 1270 save_struct_actual($1); 1271 push_parameter($1, "$type:$2", $file) 1272 } 1273 } 1274 else { 1275 save_struct_actual($param); 1276 push_parameter($param, $type, $file); 1277 } 1278 } 1279 } 1280 } 1281} 1282 1283sub push_parameter($$$) { 1284 my $param = shift; 1285 my $type = shift; 1286 my $file = shift; 1287 1288 if (($anon_struct_union == 1) && ($type eq "") && 1289 ($param eq "}")) { 1290 return; # ignore the ending }; from anon. struct/union 1291 } 1292 1293 $anon_struct_union = 0; 1294 $param =~ s/[\[\)].*//; 1295 1296 if ($type eq "" && $param =~ /\.\.\.$/) 1297 { 1298 if (!$param =~ /\w\.\.\.$/) { 1299 # handles unnamed variable parameters 1300 $param = "..."; 1301 } 1302 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") { 1303 $parameterdescs{$param} = "variable arguments"; 1304 } 1305 } 1306 elsif ($type eq "" && ($param eq "" or $param eq "void")) 1307 { 1308 $param="void"; 1309 $parameterdescs{void} = "no arguments"; 1310 } 1311 elsif ($type eq "" && ($param eq "struct" or $param eq "union")) 1312 # handle unnamed (anonymous) union or struct: 1313 { 1314 $type = $param; 1315 $param = "{unnamed_" . $param . "}"; 1316 $parameterdescs{$param} = "anonymous\n"; 1317 $anon_struct_union = 1; 1318 } 1319 1320 # warn if parameter has no description 1321 # (but ignore ones starting with # as these are not parameters 1322 # but inline preprocessor statements); 1323 # also ignore unnamed structs/unions; 1324 if (!$anon_struct_union) { 1325 if (!defined $parameterdescs{$param} && $param !~ /^#/) { 1326 1327 $parameterdescs{$param} = $undescribed; 1328 1329 if (($type eq 'function') || ($type eq 'enum')) { 1330 print STDERR "${file}:$.: warning: Function parameter ". 1331 "or member '$param' not " . 1332 "described in '$declaration_name'\n"; 1333 } 1334 print STDERR "${file}:$.: warning:" . 1335 " No description found for parameter '$param'\n"; 1336 ++$warnings; 1337 } 1338 } 1339 1340 $param = xml_escape($param); 1341 1342 # strip spaces from $param so that it is one continuous string 1343 # on @parameterlist; 1344 # this fixes a problem where check_sections() cannot find 1345 # a parameter like "addr[6 + 2]" because it actually appears 1346 # as "addr[6", "+", "2]" on the parameter list; 1347 # but it's better to maintain the param string unchanged for output, 1348 # so just weaken the string compare in check_sections() to ignore 1349 # "[blah" in a parameter string; 1350 ###$param =~ s/\s*//g; 1351 push @parameterlist, $param; 1352 $type =~ s/\s\s+/ /g; 1353 $parametertypes{$param} = $type; 1354} 1355 1356sub check_sections($$$$$$) { 1357 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck, $nested) = @_; 1358 my @sects = split ' ', $sectcheck; 1359 my @prms = split ' ', $prmscheck; 1360 my $err; 1361 my ($px, $sx); 1362 my $prm_clean; # strip trailing "[array size]" and/or beginning "*" 1363 1364 foreach $sx (0 .. $#sects) { 1365 $err = 1; 1366 foreach $px (0 .. $#prms) { 1367 $prm_clean = $prms[$px]; 1368 $prm_clean =~ s/\[.*\]//; 1369 $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i; 1370 # ignore array size in a parameter string; 1371 # however, the original param string may contain 1372 # spaces, e.g.: addr[6 + 2] 1373 # and this appears in @prms as "addr[6" since the 1374 # parameter list is split at spaces; 1375 # hence just ignore "[..." for the sections check; 1376 $prm_clean =~ s/\[.*//; 1377 1378 ##$prm_clean =~ s/^\**//; 1379 if ($prm_clean eq $sects[$sx]) { 1380 $err = 0; 1381 last; 1382 } 1383 } 1384 if ($err) { 1385 if ($decl_type eq "function") { 1386 print STDERR "${file}:$.: warning: " . 1387 "Excess function parameter " . 1388 "'$sects[$sx]' " . 1389 "description in '$decl_name'\n"; 1390 ++$warnings; 1391 } else { 1392 if ($nested !~ m/\Q$sects[$sx]\E/) { 1393 print STDERR "${file}:$.: warning: " . 1394 "Excess $decl_type member " . 1395 "'$sects[$sx]' " . 1396 "description in '$decl_name'\n"; 1397 ++$warnings; 1398 } 1399 } 1400 } 1401 } 1402} 1403 1404## 1405# Checks the section describing the return value of a function. 1406sub check_return_section { 1407 my $file = shift; 1408 my $declaration_name = shift; 1409 my $return_type = shift; 1410 1411 # Ignore an empty return type (It's a macro) 1412 # Ignore functions with a "void" return type. (But don't ignore "void *") 1413 if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) { 1414 return; 1415 } 1416 1417 if (!defined($sections{$section_return}) || 1418 $sections{$section_return} eq "") { 1419 print STDERR "${file}:$.: warning: " . 1420 "No description found for return value of " . 1421 "'$declaration_name'\n"; 1422 ++$warnings; 1423 } 1424} 1425 1426## 1427# takes a function prototype and the name of the current file being 1428# processed and spits out all the details stored in the global 1429# arrays/hashes. 1430sub dump_function($$) { 1431 my $prototype = shift; 1432 my $file = shift; 1433 my $noret = 0; 1434 1435 $prototype =~ s/^static +//; 1436 $prototype =~ s/^extern +//; 1437 $prototype =~ s/^asmlinkage +//; 1438 $prototype =~ s/^inline +//; 1439 $prototype =~ s/^__inline__ +//; 1440 $prototype =~ s/^__inline +//; 1441 $prototype =~ s/^__always_inline +//; 1442 $prototype =~ s/^noinline +//; 1443 $prototype =~ s/__init +//; 1444 $prototype =~ s/__init_or_module +//; 1445 $prototype =~ s/__meminit +//; 1446 $prototype =~ s/__must_check +//; 1447 $prototype =~ s/__weak +//; 1448 my $define = $prototype =~ s/^#\s*define\s+//; #ak added 1449 $prototype =~ s/__attribute__\s*\(\( 1450 (?: 1451 [\w\s]++ # attribute name 1452 (?:\([^)]*+\))? # attribute arguments 1453 \s*+,? # optional comma at the end 1454 )+ 1455 \)\)\s+//x; 1456 1457 # Yes, this truly is vile. We are looking for: 1458 # 1. Return type (may be nothing if we're looking at a macro) 1459 # 2. Function name 1460 # 3. Function parameters. 1461 # 1462 # All the while we have to watch out for function pointer parameters 1463 # (which IIRC is what the two sections are for), C types (these 1464 # regexps don't even start to express all the possibilities), and 1465 # so on. 1466 # 1467 # If you mess with these regexps, it's a good idea to check that 1468 # the following functions' documentation still comes out right: 1469 # - parport_register_device (function pointer parameters) 1470 # - atomic_set (macro) 1471 # - pci_match_device, __copy_to_user (long return type) 1472 1473 if ($define && $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s+/) { 1474 # This is an object-like macro, it has no return type and no parameter 1475 # list. 1476 # Function-like macros are not allowed to have spaces between 1477 # declaration_name and opening parenthesis (notice the \s+). 1478 $return_type = $1; 1479 $declaration_name = $2; 1480 $noret = 1; 1481 } elsif ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1482 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1483 $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1484 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1485 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1486 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1487 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1488 $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1489 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1490 $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1491 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1492 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1493 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1494 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1495 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1496 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1497 $prototype =~ m/^(\w+\s+\w+\s*\*+\s*\w+\s*\*+\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) { 1498 $return_type = $1; 1499 $declaration_name = $2; 1500 my $args = $3; 1501 1502 create_parameterlist($args, ',', $file); 1503 } else { 1504 print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype'\n"; 1505 return; 1506 } 1507 1508 my $prms = join " ", @parameterlist; 1509 check_sections($file, $declaration_name, "function", $sectcheck, $prms, ""); 1510 1511 # This check emits a lot of warnings at the moment, because many 1512 # functions don't have a 'Return' doc section. So until the number 1513 # of warnings goes sufficiently down, the check is only performed in 1514 # verbose mode. 1515 # TODO: always perform the check. 1516 if ($verbose && !$noret) { 1517 check_return_section($file, $declaration_name, $return_type); 1518 } 1519 1520 output_declaration($declaration_name, 1521 'function', 1522 {'function' => $declaration_name, 1523 'module' => $modulename, 1524 'functiontype' => $return_type, 1525 'parameterlist' => \@parameterlist, 1526 'parameterdescs' => \%parameterdescs, 1527 'parametertypes' => \%parametertypes, 1528 'sectionlist' => \@sectionlist, 1529 'sections' => \%sections, 1530 'purpose' => $declaration_purpose 1531 }); 1532} 1533 1534sub reset_state { 1535 $function = ""; 1536 %parameterdescs = (); 1537 %parametertypes = (); 1538 @parameterlist = (); 1539 %sections = (); 1540 @sectionlist = (); 1541 $sectcheck = ""; 1542 $struct_actual = ""; 1543 $prototype = ""; 1544 1545 $state = STATE_NORMAL; 1546 $inline_doc_state = STATE_INLINE_NA; 1547} 1548 1549sub tracepoint_munge($) { 1550 my $file = shift; 1551 my $tracepointname = 0; 1552 my $tracepointargs = 0; 1553 1554 if ($prototype =~ m/TRACE_EVENT\((.*?),/) { 1555 $tracepointname = $1; 1556 } 1557 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) { 1558 $tracepointname = $1; 1559 } 1560 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) { 1561 $tracepointname = $2; 1562 } 1563 $tracepointname =~ s/^\s+//; #strip leading whitespace 1564 if ($prototype =~ m/TP_PROTO\((.*?)\)/) { 1565 $tracepointargs = $1; 1566 } 1567 if (($tracepointname eq 0) || ($tracepointargs eq 0)) { 1568 print STDERR "${file}:$.: warning: Unrecognized tracepoint format: \n". 1569 "$prototype\n"; 1570 } else { 1571 $prototype = "static inline void trace_$tracepointname($tracepointargs)"; 1572 } 1573} 1574 1575sub syscall_munge() { 1576 my $void = 0; 1577 1578 $prototype =~ s@[\r\n\t]+@ @gos; # strip newlines/CR's/tabs 1579## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) { 1580 if ($prototype =~ m/SYSCALL_DEFINE0/) { 1581 $void = 1; 1582## $prototype = "long sys_$1(void)"; 1583 } 1584 1585 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name 1586 if ($prototype =~ m/long (sys_.*?),/) { 1587 $prototype =~ s/,/\(/; 1588 } elsif ($void) { 1589 $prototype =~ s/\)/\(void\)/; 1590 } 1591 1592 # now delete all of the odd-number commas in $prototype 1593 # so that arg types & arg names don't have a comma between them 1594 my $count = 0; 1595 my $len = length($prototype); 1596 if ($void) { 1597 $len = 0; # skip the for-loop 1598 } 1599 for (my $ix = 0; $ix < $len; $ix++) { 1600 if (substr($prototype, $ix, 1) eq ',') { 1601 $count++; 1602 if ($count % 2 == 1) { 1603 substr($prototype, $ix, 1) = ' '; 1604 } 1605 } 1606 } 1607} 1608 1609sub process_proto_function($$) { 1610 my $x = shift; 1611 my $file = shift; 1612 1613 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line 1614 1615 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) { 1616 # do nothing 1617 } 1618 elsif ($x =~ /([^\{]*)/) { 1619 $prototype .= $1; 1620 } 1621 1622 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) { 1623 $prototype =~ s@/\*.*?\*/@@gos; # strip comments. 1624 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's. 1625 $prototype =~ s@^\s+@@gos; # strip leading spaces 1626 if ($prototype =~ /SYSCALL_DEFINE/) { 1627 syscall_munge(); 1628 } 1629 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ || 1630 $prototype =~ /DEFINE_SINGLE_EVENT/) 1631 { 1632 tracepoint_munge($file); 1633 } 1634 dump_function($prototype, $file); 1635 reset_state(); 1636 } 1637} 1638 1639sub process_proto_type($$) { 1640 my $x = shift; 1641 my $file = shift; 1642 1643 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's. 1644 $x =~ s@^\s+@@gos; # strip leading spaces 1645 $x =~ s@\s+$@@gos; # strip trailing spaces 1646 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line 1647 1648 if ($x =~ /^#/) { 1649 # To distinguish preprocessor directive from regular declaration later. 1650 $x .= ";"; 1651 } 1652 1653 while (1) { 1654 if ( $x =~ /([^{};]*)([{};])(.*)/ ) { 1655 if( length $prototype ) { 1656 $prototype .= " " 1657 } 1658 $prototype .= $1 . $2; 1659 ($2 eq '{') && $brcount++; 1660 ($2 eq '}') && $brcount--; 1661 if (($2 eq ';') && ($brcount == 0)) { 1662 dump_declaration($prototype, $file); 1663 reset_state(); 1664 last; 1665 } 1666 $x = $3; 1667 } else { 1668 $prototype .= $x; 1669 last; 1670 } 1671 } 1672} 1673 1674# xml_escape: replace <, >, and & in the text stream; 1675# 1676# however, formatting controls that are generated internally/locally in the 1677# kernel-doc script are not escaped here; instead, they begin life like 1678# $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings 1679# are converted to their mnemonic-expected output, without the 4 * '\' & ':', 1680# just before actual output; (this is done by local_unescape()) 1681sub xml_escape($) { 1682 my $text = shift; 1683 if ($output_mode eq "man") { 1684 return $text; 1685 } 1686 $text =~ s/\&/\\\\\\amp;/g; 1687 $text =~ s/\</\\\\\\lt;/g; 1688 $text =~ s/\>/\\\\\\gt;/g; 1689 return $text; 1690} 1691 1692# xml_unescape: reverse the effects of xml_escape 1693sub xml_unescape($) { 1694 my $text = shift; 1695 if ($output_mode eq "man") { 1696 return $text; 1697 } 1698 $text =~ s/\\\\\\amp;/\&/g; 1699 $text =~ s/\\\\\\lt;/</g; 1700 $text =~ s/\\\\\\gt;/>/g; 1701 return $text; 1702} 1703 1704# convert local escape strings to html 1705# local escape strings look like: '\\\\menmonic:' (that's 4 backslashes) 1706sub local_unescape($) { 1707 my $text = shift; 1708 if ($output_mode eq "man") { 1709 return $text; 1710 } 1711 $text =~ s/\\\\\\\\lt:/</g; 1712 $text =~ s/\\\\\\\\gt:/>/g; 1713 return $text; 1714} 1715 1716sub map_filename($) { 1717 my $file; 1718 my ($orig_file) = @_; 1719 1720 if (defined($ENV{'SRCTREE'})) { 1721 $file = "$ENV{'SRCTREE'}" . "/" . $orig_file; 1722 } else { 1723 $file = $orig_file; 1724 } 1725 1726 if (defined($source_map{$file})) { 1727 $file = $source_map{$file}; 1728 } 1729 1730 return $file; 1731} 1732 1733sub process_export_file($) { 1734 my ($orig_file) = @_; 1735 my $file = map_filename($orig_file); 1736 1737 if (!open(IN,"<$file")) { 1738 print STDERR "Error: Cannot open file $file\n"; 1739 ++$errors; 1740 return; 1741 } 1742 1743 while (<IN>) { 1744 if (/$export_symbol/) { 1745 $function_table{$2} = 1; 1746 } 1747 } 1748 1749 close(IN); 1750} 1751 1752sub process_file($) { 1753 my $file; 1754 my $identifier; 1755 my $func; 1756 my $descr; 1757 my $in_purpose = 0; 1758 my $initial_section_counter = $section_counter; 1759 my ($orig_file) = @_; 1760 my $leading_space; 1761 1762 $file = map_filename($orig_file); 1763 1764 if (!open(IN,"<$file")) { 1765 print STDERR "Error: Cannot open file $file\n"; 1766 ++$errors; 1767 return; 1768 } 1769 1770 $. = 1; 1771 1772 $section_counter = 0; 1773 while (<IN>) { 1774 while (s/\\\s*$//) { 1775 $_ .= <IN>; 1776 } 1777 if ($state == STATE_NORMAL) { 1778 if (/$doc_start/o) { 1779 $state = STATE_NAME; # next line is always the function name 1780 $in_doc_sect = 0; 1781 $declaration_start_line = $. + 1; 1782 } 1783 } elsif ($state == STATE_NAME) {# this line is the function name (always) 1784 if (/$doc_block/o) { 1785 $state = STATE_DOCBLOCK; 1786 $contents = ""; 1787 $new_start_line = $. + 1; 1788 1789 if ( $1 eq "" ) { 1790 $section = $section_intro; 1791 } else { 1792 $section = $1; 1793 } 1794 } 1795 elsif (/$doc_decl/o) { 1796 $identifier = $1; 1797 if (/\s*([\w\s]+?)\s*-/) { 1798 $identifier = $1; 1799 } 1800 1801 $state = STATE_FIELD; 1802 # if there's no @param blocks need to set up default section 1803 # here 1804 $contents = ""; 1805 $section = $section_default; 1806 $new_start_line = $. + 1; 1807 if (/-(.*)/) { 1808 # strip leading/trailing/multiple spaces 1809 $descr= $1; 1810 $descr =~ s/^\s*//; 1811 $descr =~ s/\s*$//; 1812 $descr =~ s/\s+/ /g; 1813 $declaration_purpose = xml_escape($descr); 1814 $in_purpose = 1; 1815 } else { 1816 $declaration_purpose = ""; 1817 } 1818 1819 if (($declaration_purpose eq "") && $verbose) { 1820 print STDERR "${file}:$.: warning: missing initial short description on line:\n"; 1821 print STDERR $_; 1822 ++$warnings; 1823 } 1824 1825 if ($identifier =~ m/^struct/) { 1826 $decl_type = 'struct'; 1827 } elsif ($identifier =~ m/^union/) { 1828 $decl_type = 'union'; 1829 } elsif ($identifier =~ m/^enum/) { 1830 $decl_type = 'enum'; 1831 } elsif ($identifier =~ m/^typedef/) { 1832 $decl_type = 'typedef'; 1833 } else { 1834 $decl_type = 'function'; 1835 } 1836 1837 if ($verbose) { 1838 print STDERR "${file}:$.: info: Scanning doc for $identifier\n"; 1839 } 1840 } else { 1841 print STDERR "${file}:$.: warning: Cannot understand $_ on line $.", 1842 " - I thought it was a doc line\n"; 1843 ++$warnings; 1844 $state = STATE_NORMAL; 1845 } 1846 } elsif ($state == STATE_FIELD) { # look for head: lines, and include content 1847 if (/$doc_sect/i) { # case insensitive for supported section names 1848 $newsection = $1; 1849 $newcontents = $2; 1850 1851 # map the supported section names to the canonical names 1852 if ($newsection =~ m/^description$/i) { 1853 $newsection = $section_default; 1854 } elsif ($newsection =~ m/^context$/i) { 1855 $newsection = $section_context; 1856 } elsif ($newsection =~ m/^returns?$/i) { 1857 $newsection = $section_return; 1858 } elsif ($newsection =~ m/^\@return$/) { 1859 # special: @return is a section, not a param description 1860 $newsection = $section_return; 1861 } 1862 1863 if (($contents ne "") && ($contents ne "\n")) { 1864 if (!$in_doc_sect && $verbose) { 1865 print STDERR "${file}:$.: warning: contents before sections\n"; 1866 ++$warnings; 1867 } 1868 dump_section($file, $section, xml_escape($contents)); 1869 $section = $section_default; 1870 } 1871 1872 $in_doc_sect = 1; 1873 $in_purpose = 0; 1874 $contents = $newcontents; 1875 $new_start_line = $.; 1876 while ((substr($contents, 0, 1) eq " ") || 1877 substr($contents, 0, 1) eq "\t") { 1878 $contents = substr($contents, 1); 1879 } 1880 if ($contents ne "") { 1881 $contents .= "\n"; 1882 } 1883 $section = $newsection; 1884 $leading_space = undef; 1885 } elsif (/$doc_end/) { 1886 if (($contents ne "") && ($contents ne "\n")) { 1887 dump_section($file, $section, xml_escape($contents)); 1888 $section = $section_default; 1889 $contents = ""; 1890 } 1891 # look for doc_com + <text> + doc_end: 1892 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') { 1893 print STDERR "${file}:$.: warning: suspicious ending line: $_"; 1894 ++$warnings; 1895 } 1896 1897 $prototype = ""; 1898 $state = STATE_PROTO; 1899 $brcount = 0; 1900# print STDERR "end of doc comment, looking for prototype\n"; 1901 } elsif (/$doc_content/) { 1902 # miguel-style comment kludge, look for blank lines after 1903 # @parameter line to signify start of description 1904 if ($1 eq "") { 1905 if ($section =~ m/^@/ || $section eq $section_context) { 1906 dump_section($file, $section, xml_escape($contents)); 1907 $section = $section_default; 1908 $contents = ""; 1909 $new_start_line = $.; 1910 } else { 1911 $contents .= "\n"; 1912 } 1913 $in_purpose = 0; 1914 } elsif ($in_purpose == 1) { 1915 # Continued declaration purpose 1916 chomp($declaration_purpose); 1917 $declaration_purpose .= " " . xml_escape($1); 1918 $declaration_purpose =~ s/\s+/ /g; 1919 } else { 1920 my $cont = $1; 1921 if ($section =~ m/^@/ || $section eq $section_context) { 1922 if (!defined $leading_space) { 1923 if ($cont =~ m/^(\s+)/) { 1924 $leading_space = $1; 1925 } else { 1926 $leading_space = ""; 1927 } 1928 } 1929 1930 $cont =~ s/^$leading_space//; 1931 } 1932 $contents .= $cont . "\n"; 1933 } 1934 } else { 1935 # i dont know - bad line? ignore. 1936 print STDERR "${file}:$.: warning: bad line: $_"; 1937 ++$warnings; 1938 } 1939 } elsif ($state == STATE_INLINE) { # scanning for inline parameters 1940 # First line (state 1) needs to be a @parameter 1941 if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) { 1942 $section = $1; 1943 $contents = $2; 1944 $new_start_line = $.; 1945 if ($contents ne "") { 1946 while ((substr($contents, 0, 1) eq " ") || 1947 substr($contents, 0, 1) eq "\t") { 1948 $contents = substr($contents, 1); 1949 } 1950 $contents .= "\n"; 1951 } 1952 $inline_doc_state = STATE_INLINE_TEXT; 1953 # Documentation block end */ 1954 } elsif (/$doc_inline_end/) { 1955 if (($contents ne "") && ($contents ne "\n")) { 1956 dump_section($file, $section, xml_escape($contents)); 1957 $section = $section_default; 1958 $contents = ""; 1959 } 1960 $state = STATE_PROTO; 1961 $inline_doc_state = STATE_INLINE_NA; 1962 # Regular text 1963 } elsif (/$doc_content/) { 1964 if ($inline_doc_state == STATE_INLINE_TEXT) { 1965 $contents .= $1 . "\n"; 1966 # nuke leading blank lines 1967 if ($contents =~ /^\s*$/) { 1968 $contents = ""; 1969 } 1970 } elsif ($inline_doc_state == STATE_INLINE_NAME) { 1971 $inline_doc_state = STATE_INLINE_ERROR; 1972 print STDERR "${file}:$.: warning: "; 1973 print STDERR "Incorrect use of kernel-doc format: $_"; 1974 ++$warnings; 1975 } 1976 } 1977 } elsif ($state == STATE_PROTO) { # scanning for function '{' (end of prototype) 1978 if (/$doc_inline_oneline/) { 1979 $section = $1; 1980 $contents = $2; 1981 if ($contents ne "") { 1982 $contents .= "\n"; 1983 dump_section($file, $section, xml_escape($contents)); 1984 $section = $section_default; 1985 $contents = ""; 1986 } 1987 } elsif (/$doc_inline_start/) { 1988 $state = STATE_INLINE; 1989 $inline_doc_state = STATE_INLINE_NAME; 1990 } elsif ($decl_type eq 'function') { 1991 process_proto_function($_, $file); 1992 } else { 1993 process_proto_type($_, $file); 1994 } 1995 } elsif ($state == STATE_DOCBLOCK) { 1996 if (/$doc_end/) 1997 { 1998 dump_doc_section($file, $section, xml_escape($contents)); 1999 $section = $section_default; 2000 $contents = ""; 2001 $function = ""; 2002 %parameterdescs = (); 2003 %parametertypes = (); 2004 @parameterlist = (); 2005 %sections = (); 2006 @sectionlist = (); 2007 $prototype = ""; 2008 $state = STATE_NORMAL; 2009 } 2010 elsif (/$doc_content/) 2011 { 2012 if ( $1 eq "" ) 2013 { 2014 $contents .= $blankline; 2015 } 2016 else 2017 { 2018 $contents .= $1 . "\n"; 2019 } 2020 } 2021 } 2022 } 2023 if ($initial_section_counter == $section_counter) { 2024 if ($output_mode ne "none") { 2025 print STDERR "${file}:1: warning: no structured comments found\n"; 2026 } 2027 if (($output_selection == OUTPUT_INCLUDE) && ($show_not_found == 1)) { 2028 print STDERR " Was looking for '$_'.\n" for keys %function_table; 2029 } 2030 } 2031} 2032 2033 2034$kernelversion = get_kernel_version(); 2035 2036# generate a sequence of code that will splice in highlighting information 2037# using the s// operator. 2038for (my $k = 0; $k < @highlights; $k++) { 2039 my $pattern = $highlights[$k][0]; 2040 my $result = $highlights[$k][1]; 2041# print STDERR "scanning pattern:$pattern, highlight:($result)\n"; 2042 $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n"; 2043} 2044 2045# Read the file that maps relative names to absolute names for 2046# separate source and object directories and for shadow trees. 2047if (open(SOURCE_MAP, "<.tmp_filelist.txt")) { 2048 my ($relname, $absname); 2049 while(<SOURCE_MAP>) { 2050 chop(); 2051 ($relname, $absname) = (split())[0..1]; 2052 $relname =~ s:^/+::; 2053 $source_map{$relname} = $absname; 2054 } 2055 close(SOURCE_MAP); 2056} 2057 2058if ($output_selection == OUTPUT_EXPORTED || 2059 $output_selection == OUTPUT_INTERNAL) { 2060 2061 push(@export_file_list, @ARGV); 2062 2063 foreach (@export_file_list) { 2064 chomp; 2065 process_export_file($_); 2066 } 2067} 2068 2069foreach (@ARGV) { 2070 chomp; 2071 process_file($_); 2072} 2073if ($verbose && $errors) { 2074 print STDERR "$errors errors\n"; 2075} 2076if ($verbose && $warnings) { 2077 print STDERR "$warnings warnings\n"; 2078} 2079 2080exit($output_mode eq "none" ? 0 : $errors); 2081