kernel-doc 60.6 KB
Newer Older
1
#!/usr/bin/env perl
2
# SPDX-License-Identifier: GPL-2.0
Linus Torvalds's avatar
Linus Torvalds committed
3

4
use warnings;
Linus Torvalds's avatar
Linus Torvalds committed
5 6 7 8 9
use strict;

## Copyright (c) 1998 Michael Zucchi, All Rights Reserved        ##
## Copyright (C) 2000, 1  Tim Waugh <twaugh@redhat.com>          ##
## Copyright (C) 2001  Simon Huggins                             ##
10
## Copyright (C) 2005-2012  Randy Dunlap                         ##
11
## Copyright (C) 2012  Dan Luedtke                               ##
Linus Torvalds's avatar
Linus Torvalds committed
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
## 								 ##
## #define enhancements by Armin Kuster <akuster@mvista.com>	 ##
## Copyright (c) 2000 MontaVista Software, Inc.			 ##
## 								 ##
## This software falls under the GNU General Public License.     ##
## Please read the COPYING file for more information             ##

# 18/01/2001 - 	Cleanups
# 		Functions prototyped as foo(void) same as foo()
# 		Stop eval'ing where we don't need to.
# -- huggie@earth.li

# 27/06/2001 -  Allowed whitespace after initial "/**" and
#               allowed comments before function declarations.
# -- Christian Kreibich <ck@whoop.org>

# Still to do:
# 	- add perldoc documentation
# 	- Look more closely at some of the scarier bits :)

# 26/05/2001 - 	Support for separate source and object trees.
#		Return error code.
# 		Keith Owens <kaos@ocs.com.au>

# 23/09/2001 - Added support for typedefs, structs, enums and unions
#              Support for Context section; can be terminated using empty line
#              Small fixes (like spaces vs. \s in regex)
# -- Tim Jansen <tim@tjansen.de>

41 42
# 25/07/2012 - Added support for HTML5
# -- Dan Luedtke <mail@danrl.de>
Linus Torvalds's avatar
Linus Torvalds committed
43

44 45 46 47 48 49 50 51
sub usage {
    my $message = <<"EOF";
Usage: $0 [OPTION ...] FILE ...

Read C language source or header FILEs, extract embedded documentation comments,
and print formatted documentation to standard output.

The documentation comments are identified by "/**" opening comment mark. See
52
Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax.
53 54 55

Output format selection (mutually exclusive):
  -man			Output troff manual page format. This is the default.
56
  -rst			Output reStructuredText format.
57
  -none			Do not output documentation, only warnings.
58 59

Output selection (mutually exclusive):
60 61
  -export		Only output documentation for symbols that have been
			exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
62
                        in any input FILE or -export-file FILE.
63 64
  -internal		Only output documentation for symbols that have NOT been
			exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
65
                        in any input FILE or -export-file FILE.
66 67 68 69 70 71 72 73 74
  -function NAME	Only output documentation for the given function(s)
			or DOC: section title(s). All other functions and DOC:
			sections are ignored. May be specified multiple times.
  -nofunction NAME	Do NOT output documentation for the given function(s);
			only output documentation for the other functions and
			DOC: sections. May be specified multiple times.

Output selection modifiers:
  -no-doc-sections	Do not output DOC: sections.
75 76
  -enable-lineno        Enable output of #define LINENO lines. Only works with
                        reStructuredText format.
77 78 79
  -export-file FILE     Specify an additional FILE in which to look for
                        EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be used with
                        -export or -internal. May be specified multiple times.
80 81 82 83 84 85 86 87 88

Other parameters:
  -v			Verbose output, more warnings and other information.
  -h			Print this help.

EOF
    print $message;
    exit 1;
}
Linus Torvalds's avatar
Linus Torvalds committed
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105

#
# format of comments.
# In the following table, (...)? signifies optional structure.
#                         (...)* signifies 0 or more structure elements
# /**
#  * function_name(:)? (- short description)?
# (* @parameterx: (description of parameter x)?)*
# (* a blank line)?
#  * (Description:)? (Description of function)?
#  * (section header: (section description)? )*
#  (*)?*/
#
# So .. the trivial example would be:
#
# /**
#  * my_function
106
#  */
Linus Torvalds's avatar
Linus Torvalds committed
107
#
108
# If the Description: header tag is omitted, then there must be a blank line
Linus Torvalds's avatar
Linus Torvalds committed
109 110 111 112 113 114
# after the last parameter specification.
# e.g.
# /**
#  * my_function - does my stuff
#  * @my_arg: its mine damnit
#  *
115
#  * Does my stuff explained.
Linus Torvalds's avatar
Linus Torvalds committed
116 117 118 119 120 121
#  */
#
#  or, could also use:
# /**
#  * my_function - does my stuff
#  * @my_arg: its mine damnit
122
#  * Description: Does my stuff explained.
Linus Torvalds's avatar
Linus Torvalds committed
123 124 125
#  */
# etc.
#
126
# Besides functions you can also write documentation for structs, unions,
127 128 129
# enums and typedefs. Instead of the function name you must write the name
# of the declaration;  the struct/union/enum/typedef must always precede
# the name. Nesting of declarations is not supported.
Linus Torvalds's avatar
Linus Torvalds committed
130 131 132 133 134 135
# Use the argument mechanism to document members or constants.
# e.g.
# /**
#  * struct my_struct - short description
#  * @a: first member
#  * @b: second member
136
#  *
Linus Torvalds's avatar
Linus Torvalds committed
137 138 139 140 141
#  * Longer description
#  */
# struct my_struct {
#     int a;
#     int b;
142 143
# /* private: */
#     int c;
Linus Torvalds's avatar
Linus Torvalds committed
144 145 146
# };
#
# All descriptions can be multiline, except the short function description.
147
#
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
# For really longs structs, you can also describe arguments inside the
# body of the struct.
# eg.
# /**
#  * struct my_struct - short description
#  * @a: first member
#  * @b: second member
#  *
#  * Longer description
#  */
# struct my_struct {
#     int a;
#     int b;
#     /**
#      * @c: This is longer description of C
#      *
#      * You can use paragraphs to describe arguments
#      * using this method.
#      */
#     int c;
# };
#
# This should be use only for struct/enum members.
#
172 173
# You can also add additional sections. When documenting kernel functions you
# should document the "Context:" of the function, e.g. whether the functions
Linus Torvalds's avatar
Linus Torvalds committed
174
# can be called form interrupts. Unlike other sections you can end it with an
175
# empty line.
176 177
# A non-void function should have a "Return:" section describing the return
# value(s).
178
# Example-sections should contain the string EXAMPLE so that they are marked
Linus Torvalds's avatar
Linus Torvalds committed
179 180 181 182 183 184 185
# appropriately in DocBook.
#
# Example:
# /**
#  * user_function - function that can only be called in user context
#  * @a: some argument
#  * Context: !in_interrupt()
186
#  *
Linus Torvalds's avatar
Linus Torvalds committed
187 188 189 190 191 192 193 194 195 196 197 198 199
#  * Some description
#  * Example:
#  *    user_function(22);
#  */
# ...
#
#
# All descriptive text is further processed, scanning for the following special
# patterns, which are highlighted appropriately.
#
# 'funcname()' - function
# '$ENVVAR' - environmental variable
# '&struct_name' - name of a structure (up to two words including 'struct')
200
# '&struct_name.member' - name of a structure member
Linus Torvalds's avatar
Linus Torvalds committed
201 202
# '@parameter' - name of a parameter
# '%CONST' - name of a constant.
203
# '``LITERAL``' - literal string without any spaces on it.
Linus Torvalds's avatar
Linus Torvalds committed
204

205 206
## init lots of data

Linus Torvalds's avatar
Linus Torvalds committed
207 208
my $errors = 0;
my $warnings = 0;
209
my $anon_struct_union = 0;
Linus Torvalds's avatar
Linus Torvalds committed
210 211

# match expressions used to find embedded type information
212 213
my $type_constant = '\b``([^\`]+)``\b';
my $type_constant2 = '\%([-_\w]+)';
Linus Torvalds's avatar
Linus Torvalds committed
214
my $type_func = '(\w+)\(\)';
215
my $type_param = '\@(\w*(\.\w+)*(\.\.\.)?)';
216
my $type_fp_param = '\@(\w+)\(\)';  # Special RST handling for func ptr params
Linus Torvalds's avatar
Linus Torvalds committed
217
my $type_env = '(\$\w+)';
218 219 220 221
my $type_enum = '\&(enum\s*([_\w]+))';
my $type_struct = '\&(struct\s*([_\w]+))';
my $type_typedef = '\&(typedef\s*([_\w]+))';
my $type_union = '\&(union\s*([_\w]+))';
222
my $type_member = '\&([_\w]+)(\.|->)([_\w]+)';
223
my $type_fallback = '\&([_\w]+)';
224
my $type_member_func = $type_member . '\(\)';
Linus Torvalds's avatar
Linus Torvalds committed
225 226 227 228 229

# Output conversion substitutions.
#  One for each output format

# these are pretty rough
230 231
my @highlights_man = (
                      [$type_constant, "\$1"],
232
                      [$type_constant2, "\$1"],
233
                      [$type_func, "\\\\fB\$1\\\\fP"],
234
                      [$type_enum, "\\\\fI\$1\\\\fP"],
235
                      [$type_struct, "\\\\fI\$1\\\\fP"],
236 237
                      [$type_typedef, "\\\\fI\$1\\\\fP"],
                      [$type_union, "\\\\fI\$1\\\\fP"],
238
                      [$type_param, "\\\\fI\$1\\\\fP"],
239 240
                      [$type_member, "\\\\fI\$1\$2\$3\\\\fP"],
                      [$type_fallback, "\\\\fI\$1\\\\fP"]
241
		     );
Linus Torvalds's avatar
Linus Torvalds committed
242 243
my $blankline_man = "";

244 245 246
# rst-mode
my @highlights_rst = (
                       [$type_constant, "``\$1``"],
247
                       [$type_constant2, "``\$1``"],
248
                       # Note: need to escape () to avoid func matching later
249 250
                       [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\\\\) <\$1>`"],
                       [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"],
251
		       [$type_fp_param, "**\$1\\\\(\\\\)**"],
252
                       [$type_func, "\\:c\\:func\\:`\$1()`"],
253 254 255 256
                       [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"],
                       [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"],
                       [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"],
                       [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"],
257
                       # in rst this can refer to any type
258
                       [$type_fallback, "\\:c\\:type\\:`\$1`"],
259 260 261 262
                       [$type_param, "**\$1**"]
		      );
my $blankline_rst = "\n";

Linus Torvalds's avatar
Linus Torvalds committed
263
# read arguments
264
if ($#ARGV == -1) {
Linus Torvalds's avatar
Linus Torvalds committed
265 266 267
    usage();
}

268 269 270
my $kernelversion;
my $dohighlight = "";

Linus Torvalds's avatar
Linus Torvalds committed
271
my $verbose = 0;
272
my $output_mode = "rst";
273
my $output_preformatted = 0;
274
my $no_doc_sections = 0;
275
my $enable_lineno = 0;
276 277
my @highlights = @highlights_rst;
my $blankline = $blankline_rst;
Linus Torvalds's avatar
Linus Torvalds committed
278
my $modulename = "Kernel API";
279 280 281 282 283 284 285 286 287

use constant {
    OUTPUT_ALL          => 0, # output all symbols and doc sections
    OUTPUT_INCLUDE      => 1, # output only specified symbols
    OUTPUT_EXCLUDE      => 2, # output everything except specified symbols
    OUTPUT_EXPORTED     => 3, # output exported symbols
    OUTPUT_INTERNAL     => 4, # output non-exported symbols
};
my $output_selection = OUTPUT_ALL;
288 289
my $show_not_found = 0;

290 291
my @export_file_list;

292 293 294 295 296 297 298 299
my @build_time;
if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) &&
    (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') {
    @build_time = gmtime($seconds);
} else {
    @build_time = localtime;
}

300 301
my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
		'July', 'August', 'September', 'October',
302 303
		'November', 'December')[$build_time[4]] .
  " " . ($build_time[5]+1900);
Linus Torvalds's avatar
Linus Torvalds committed
304

305
# Essentially these are globals.
306 307
# They probably want to be tidied up, made more localised or something.
# CAVEAT EMPTOR!  Some of the others I localised may not want to be, which
Linus Torvalds's avatar
Linus Torvalds committed
308
# could cause "use of undefined value" or other bugs.
309
my ($function, %function_table, %parametertypes, $declaration_purpose);
310
my $declaration_start_line;
311
my ($type, $declaration_name, $return_type);
312
my ($newsection, $newcontents, $prototype, $brcount, %source_map);
Linus Torvalds's avatar
Linus Torvalds committed
313

314 315 316 317
if (defined($ENV{'KBUILD_VERBOSE'})) {
	$verbose = "$ENV{'KBUILD_VERBOSE'}";
}

318
# Generated docbook code is inserted in a template at a point where
Linus Torvalds's avatar
Linus Torvalds committed
319 320 321 322 323 324 325 326 327
# docbook v3.1 requires a non-zero sequence of RefEntry's; see:
# http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
# We keep track of number of generated entries and generate a dummy
# if needs be to ensure the expanded template can be postprocessed
# into html.
my $section_counter = 0;

my $lineprefix="";

328 329 330 331
# Parser states
use constant {
    STATE_NORMAL        => 0, # normal code
    STATE_NAME          => 1, # looking for function name
332 333 334 335 336
    STATE_BODY_MAYBE    => 2, # body - or maybe more description
    STATE_BODY          => 3, # the body of the comment
    STATE_PROTO         => 4, # scanning prototype
    STATE_DOCBLOCK      => 5, # documentation block
    STATE_INLINE        => 6, # gathering documentation outside main block
337
};
Linus Torvalds's avatar
Linus Torvalds committed
338
my $state;
339
my $in_doc_sect;
340
my $leading_space;
Linus Torvalds's avatar
Linus Torvalds committed
341

342 343 344 345 346 347 348 349 350 351 352
# Inline documentation state
use constant {
    STATE_INLINE_NA     => 0, # not applicable ($state != STATE_INLINE)
    STATE_INLINE_NAME   => 1, # looking for member name (@foo:)
    STATE_INLINE_TEXT   => 2, # looking for member documentation
    STATE_INLINE_END    => 3, # done
    STATE_INLINE_ERROR  => 4, # error - Comment without header was found.
                              # Spit a warning as it's not
                              # proper kernel-doc and ignore the rest.
};
my $inline_doc_state;
353

Linus Torvalds's avatar
Linus Torvalds committed
354 355 356 357 358 359 360
#declaration types: can be
# 'function', 'struct', 'union', 'enum', 'typedef'
my $decl_type;

my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
my $doc_end = '\*/';
my $doc_com = '\s*\*\s*';
361
my $doc_com_body = '\s*\* ?';
362
my $doc_decl = $doc_com . '(\w+)';
363
# @params and a strictly limited set of supported section names
364
my $doc_sect = $doc_com . 
365
    '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:(.*)';
366
my $doc_content = $doc_com_body . '(.*)';
367
my $doc_block = $doc_com . 'DOC:\s*(.*)?';
368
my $doc_inline_start = '^\s*/\*\*\s*$';
369
my $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)';
370
my $doc_inline_end = '^\s*\*/\s*$';
371
my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$';
372
my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';
Linus Torvalds's avatar
Linus Torvalds committed
373 374

my %parameterdescs;
375
my %parameterdesc_start_lines;
Linus Torvalds's avatar
Linus Torvalds committed
376 377 378
my @parameterlist;
my %sections;
my @sectionlist;
379
my %section_start_lines;
380 381
my $sectcheck;
my $struct_actual;
Linus Torvalds's avatar
Linus Torvalds committed
382 383

my $contents = "";
384
my $new_start_line = 0;
385 386

# the canonical section names. see also $doc_sect above.
Linus Torvalds's avatar
Linus Torvalds committed
387 388 389 390
my $section_default = "Description";	# default section
my $section_intro = "Introduction";
my $section = $section_default;
my $section_context = "Context";
391
my $section_return = "Return";
Linus Torvalds's avatar
Linus Torvalds committed
392 393 394 395 396

my $undescribed = "-- undescribed --";

reset_state();

397 398 399 400
while ($ARGV[0] =~ m/^--?(.*)/) {
    my $cmd = $1;
    shift @ARGV;
    if ($cmd eq "man") {
Linus Torvalds's avatar
Linus Torvalds committed
401
	$output_mode = "man";
402
	@highlights = @highlights_man;
Linus Torvalds's avatar
Linus Torvalds committed
403
	$blankline = $blankline_man;
404
    } elsif ($cmd eq "rst") {
405 406 407
	$output_mode = "rst";
	@highlights = @highlights_rst;
	$blankline = $blankline_rst;
408
    } elsif ($cmd eq "none") {
409
	$output_mode = "none";
410
    } elsif ($cmd eq "module") { # not needed for XML, inherits from calling document
Linus Torvalds's avatar
Linus Torvalds committed
411
	$modulename = shift @ARGV;
412
    } elsif ($cmd eq "function") { # to only output specific functions
413
	$output_selection = OUTPUT_INCLUDE;
Linus Torvalds's avatar
Linus Torvalds committed
414 415
	$function = shift @ARGV;
	$function_table{$function} = 1;
416
    } elsif ($cmd eq "nofunction") { # output all except specific functions
417
	$output_selection = OUTPUT_EXCLUDE;
Linus Torvalds's avatar
Linus Torvalds committed
418 419
	$function = shift @ARGV;
	$function_table{$function} = 1;
420
    } elsif ($cmd eq "export") { # only exported symbols
421
	$output_selection = OUTPUT_EXPORTED;
422
	%function_table = ();
423
    } elsif ($cmd eq "internal") { # only non-exported symbols
424
	$output_selection = OUTPUT_INTERNAL;
425
	%function_table = ();
426
    } elsif ($cmd eq "export-file") {
427 428
	my $file = shift @ARGV;
	push(@export_file_list, $file);
429
    } elsif ($cmd eq "v") {
Linus Torvalds's avatar
Linus Torvalds committed
430
	$verbose = 1;
431
    } elsif (($cmd eq "h") || ($cmd eq "help")) {
Linus Torvalds's avatar
Linus Torvalds committed
432
	usage();
433
    } elsif ($cmd eq 'no-doc-sections') {
434
	    $no_doc_sections = 1;
435
    } elsif ($cmd eq 'enable-lineno') {
436
	    $enable_lineno = 1;
437
    } elsif ($cmd eq 'show-not-found') {
438
	$show_not_found = 1;
439 440 441
    } else {
	# Unknown argument
        usage();
Linus Torvalds's avatar
Linus Torvalds committed
442 443 444
    }
}

445 446
# continue execution near EOF;

447 448
# get kernel version from env
sub get_kernel_version() {
449
    my $version = 'unknown kernel version';
450 451 452 453 454 455

    if (defined($ENV{'KERNELVERSION'})) {
	$version = $ENV{'KERNELVERSION'};
    }
    return $version;
}
Linus Torvalds's avatar
Linus Torvalds committed
456

457 458 459 460 461 462 463
#
sub print_lineno {
    my $lineno = shift;
    if ($enable_lineno && defined($lineno)) {
        print "#define LINENO " . $lineno . "\n";
    }
}
Linus Torvalds's avatar
Linus Torvalds committed
464 465 466 467
##
# dumps section contents to arrays/hashes intended for that purpose.
#
sub dump_section {
468
    my $file = shift;
Linus Torvalds's avatar
Linus Torvalds committed
469 470 471
    my $name = shift;
    my $contents = join "\n", @_;

472
    if ($name =~ m/$type_param/) {
Linus Torvalds's avatar
Linus Torvalds committed
473 474
	$name = $1;
	$parameterdescs{$name} = $contents;
475
	$sectcheck = $sectcheck . $name . " ";
476 477
        $parameterdesc_start_lines{$name} = $new_start_line;
        $new_start_line = 0;
478 479 480
    } elsif ($name eq "@\.\.\.") {
	$name = "...";
	$parameterdescs{$name} = $contents;
481
	$sectcheck = $sectcheck . $name . " ";
482 483
        $parameterdesc_start_lines{$name} = $new_start_line;
        $new_start_line = 0;
Linus Torvalds's avatar
Linus Torvalds committed
484
    } else {
485
	if (defined($sections{$name}) && ($sections{$name} ne "")) {
486 487 488 489 490
	    # Only warn on user specified duplicate section names.
	    if ($name ne $section_default) {
		print STDERR "${file}:$.: warning: duplicate section name '$name'\n";
		++$warnings;
	    }
491 492 493 494
	    $sections{$name} .= $contents;
	} else {
	    $sections{$name} = $contents;
	    push @sectionlist, $name;
495 496
            $section_start_lines{$name} = $new_start_line;
            $new_start_line = 0;
497
	}
Linus Torvalds's avatar
Linus Torvalds committed
498 499 500
    }
}

501 502 503 504
##
# dump DOC: section after checking that it should go out
#
sub dump_doc_section {
505
    my $file = shift;
506 507 508
    my $name = shift;
    my $contents = join "\n", @_;

509 510 511 512
    if ($no_doc_sections) {
        return;
    }

513 514 515 516 517
    if (($output_selection == OUTPUT_ALL) ||
	($output_selection == OUTPUT_INCLUDE &&
	 defined($function_table{$name})) ||
	($output_selection == OUTPUT_EXCLUDE &&
	 !defined($function_table{$name})))
518
    {
519
	dump_section($file, $name, $contents);
520 521 522
	output_blockhead({'sectionlist' => \@sectionlist,
			  'sections' => \%sections,
			  'module' => $modulename,
523
			  'content-only' => ($output_selection != OUTPUT_ALL), });
524 525 526
    }
}

Linus Torvalds's avatar
Linus Torvalds committed
527 528 529 530 531 532 533 534
##
# output function
#
# parameterdescs, a hash.
#  function => "function name"
#  parameterlist => @list of parameters
#  parameterdescs => %parameter descriptions
#  sectionlist => @list of sections
535
#  sections => %section descriptions
536
#
Linus Torvalds's avatar
Linus Torvalds committed
537 538 539 540 541 542 543 544 545 546 547

sub output_highlight {
    my $contents = join "\n",@_;
    my $line;

#   DEBUG
#   if (!defined $contents) {
#	use Carp;
#	confess "output_highlight got called with no args?\n";
#   }

548
#   print STDERR "contents b4:$contents\n";
Linus Torvalds's avatar
Linus Torvalds committed
549 550
    eval $dohighlight;
    die $@ if $@;
551 552
#   print STDERR "contents af:$contents\n";

Linus Torvalds's avatar
Linus Torvalds committed
553
    foreach $line (split "\n", $contents) {
554 555 556
	if (! $output_preformatted) {
	    $line =~ s/^\s*//;
	}
557
	if ($line eq ""){
558
	    if (! $output_preformatted) {
559
		print $lineprefix, $blankline;
560
	    }
Linus Torvalds's avatar
Linus Torvalds committed
561
	} else {
562 563 564 565 566
	    if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
		print "\\&$line";
	    } else {
		print $lineprefix, $line;
	    }
Linus Torvalds's avatar
Linus Torvalds committed
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
	}
	print "\n";
    }
}

##
# output function in man
sub output_function_man(%) {
    my %args = %{$_[0]};
    my ($parameter, $section);
    my $count;

    print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";

    print ".SH NAME\n";
582
    print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
Linus Torvalds's avatar
Linus Torvalds committed
583 584

    print ".SH SYNOPSIS\n";
585
    if ($args{'functiontype'} ne "") {
586
	print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
587
    } else {
588
	print ".B \"" . $args{'function'} . "\n";
589
    }
Linus Torvalds's avatar
Linus Torvalds committed
590 591 592 593 594 595 596 597 598 599
    $count = 0;
    my $parenth = "(";
    my $post = ",";
    foreach my $parameter (@{$args{'parameterlist'}}) {
	if ($count == $#{$args{'parameterlist'}}) {
	    $post = ");";
	}
	$type = $args{'parametertypes'}{$parameter};
	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
	    # pointer-to-function
600
	    print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n";
Linus Torvalds's avatar
Linus Torvalds committed
601 602
	} else {
	    $type =~ s/([^\*])$/$1 /;
603
	    print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n";
Linus Torvalds's avatar
Linus Torvalds committed
604 605 606 607 608 609 610 611 612 613
	}
	$count++;
	$parenth = "";
    }

    print ".SH ARGUMENTS\n";
    foreach $parameter (@{$args{'parameterlist'}}) {
	my $parameter_name = $parameter;
	$parameter_name =~ s/\[.*//;

614
	print ".IP \"" . $parameter . "\" 12\n";
Linus Torvalds's avatar
Linus Torvalds committed
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
	output_highlight($args{'parameterdescs'}{$parameter_name});
    }
    foreach $section (@{$args{'sectionlist'}}) {
	print ".SH \"", uc $section, "\"\n";
	output_highlight($args{'sections'}{$section});
    }
}

##
# output enum in man
sub output_enum_man(%) {
    my %args = %{$_[0]};
    my ($parameter, $section);
    my $count;

    print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";

    print ".SH NAME\n";
633
    print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
Linus Torvalds's avatar
Linus Torvalds committed
634 635

    print ".SH SYNOPSIS\n";
636
    print "enum " . $args{'enum'} . " {\n";
Linus Torvalds's avatar
Linus Torvalds committed
637 638
    $count = 0;
    foreach my $parameter (@{$args{'parameterlist'}}) {
639
	print ".br\n.BI \"    $parameter\"\n";
Linus Torvalds's avatar
Linus Torvalds committed
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
	if ($count == $#{$args{'parameterlist'}}) {
	    print "\n};\n";
	    last;
	}
	else {
	    print ", \n.br\n";
	}
	$count++;
    }

    print ".SH Constants\n";
    foreach $parameter (@{$args{'parameterlist'}}) {
	my $parameter_name = $parameter;
	$parameter_name =~ s/\[.*//;

655
	print ".IP \"" . $parameter . "\" 12\n";
Linus Torvalds's avatar
Linus Torvalds committed
656 657 658 659 660 661 662 663 664 665 666 667 668 669
	output_highlight($args{'parameterdescs'}{$parameter_name});
    }
    foreach $section (@{$args{'sectionlist'}}) {
	print ".SH \"$section\"\n";
	output_highlight($args{'sections'}{$section});
    }
}

##
# output struct in man
sub output_struct_man(%) {
    my %args = %{$_[0]};
    my ($parameter, $section);

670
    print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
Linus Torvalds's avatar
Linus Torvalds committed
671 672

    print ".SH NAME\n";
673
    print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
Linus Torvalds's avatar
Linus Torvalds committed
674

675 676 677
    my $declaration = $args{'definition'};
    $declaration =~ s/\t/  /g;
    $declaration =~ s/\n/"\n.br\n.BI \"/g;
Linus Torvalds's avatar
Linus Torvalds committed
678
    print ".SH SYNOPSIS\n";
679
    print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
680
    print ".BI \"$declaration\n};\n.br\n\n";
Linus Torvalds's avatar
Linus Torvalds committed
681

682
    print ".SH Members\n";
Linus Torvalds's avatar
Linus Torvalds committed
683 684 685 686 687 688
    foreach $parameter (@{$args{'parameterlist'}}) {
	($parameter =~ /^#/) && next;

	my $parameter_name = $parameter;
	$parameter_name =~ s/\[.*//;

689
	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
690
	print ".IP \"" . $parameter . "\" 12\n";
Linus Torvalds's avatar
Linus Torvalds committed
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
	output_highlight($args{'parameterdescs'}{$parameter_name});
    }
    foreach $section (@{$args{'sectionlist'}}) {
	print ".SH \"$section\"\n";
	output_highlight($args{'sections'}{$section});
    }
}

##
# output typedef in man
sub output_typedef_man(%) {
    my %args = %{$_[0]};
    my ($parameter, $section);

    print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";

    print ".SH NAME\n";
708
    print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
Linus Torvalds's avatar
Linus Torvalds committed
709 710 711 712 713 714 715

    foreach $section (@{$args{'sectionlist'}}) {
	print ".SH \"$section\"\n";
	output_highlight($args{'sections'}{$section});
    }
}

716
sub output_blockhead_man(%) {
Linus Torvalds's avatar
Linus Torvalds committed
717 718 719 720 721 722 723 724 725 726 727 728
    my %args = %{$_[0]};
    my ($parameter, $section);
    my $count;

    print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";

    foreach $section (@{$args{'sectionlist'}}) {
	print ".SH \"$section\"\n";
	output_highlight($args{'sections'}{$section});
    }
}

729 730 731 732 733 734 735 736 737 738 739 740 741 742
##
# output in restructured text
#

#
# This could use some work; it's used to output the DOC: sections, and
# starts by putting out the name of the doc section itself, but that tends
# to duplicate a header already in the template file.
#
sub output_blockhead_rst(%) {
    my %args = %{$_[0]};
    my ($parameter, $section);

    foreach $section (@{$args{'sectionlist'}}) {
743 744 745
	if ($output_selection != OUTPUT_INCLUDE) {
	    print "**$section**\n\n";
	}
746
        print_lineno($section_start_lines{$section});
747 748 749 750 751
	output_highlight_rst($args{'sections'}{$section});
	print "\n";
    }
}

752 753 754 755 756 757
#
# Apply the RST highlights to a sub-block of text.
#   
sub highlight_block($) {
    # The dohighlight kludge requires the text be called $contents
    my $contents = shift;
758 759
    eval $dohighlight;
    die $@ if $@;
760 761
    return $contents;
}
762

763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
#
# Regexes used only here.
#
my $sphinx_literal = '^[^.].*::$';
my $sphinx_cblock = '^\.\.\ +code-block::';

sub output_highlight_rst {
    my $input = join "\n",@_;
    my $output = "";
    my $line;
    my $in_literal = 0;
    my $litprefix;
    my $block = "";

    foreach $line (split "\n",$input) {
	#
	# If we're in a literal block, see if we should drop out
	# of it.  Otherwise pass the line straight through unmunged.
	#
	if ($in_literal) {
	    if (! ($line =~ /^\s*$/)) {
		#
		# If this is the first non-blank line in a literal
		# block we need to figure out what the proper indent is.
		#
		if ($litprefix eq "") {
		    $line =~ /^(\s*)/;
		    $litprefix = '^' . $1;
		    $output .= $line . "\n";
		} elsif (! ($line =~ /$litprefix/)) {
		    $in_literal = 0;
		} else {
		    $output .= $line . "\n";
		}
	    } else {
		$output .= $line . "\n";
	    }
	}
	#
	# Not in a literal block (or just dropped out)
	#
	if (! $in_literal) {
	    $block .= $line . "\n";
	    if (($line =~ /$sphinx_literal/) || ($line =~ /$sphinx_cblock/)) {
		$in_literal = 1;
		$litprefix = "";
		$output .= highlight_block($block);
		$block = ""
	    }
	}
    }

    if ($block) {
	$output .= highlight_block($block);
    }
    foreach $line (split "\n", $output) {
819
	print $lineprefix . $line . "\n";
820 821 822 823 824 825
    }
}

sub output_function_rst(%) {
    my %args = %{$_[0]};
    my ($parameter, $section);
826
    my $oldprefix = $lineprefix;
827 828 829 830 831 832 833 834 835 836 837 838
    my $start = "";

    if ($args{'typedef'}) {
	print ".. c:type:: ". $args{'function'} . "\n\n";
	print_lineno($declaration_start_line);
	print "   **Typedef**: ";
	$lineprefix = "";
	output_highlight_rst($args{'purpose'});
	$start = "\n\n**Syntax**\n\n  ``";
    } else {
	print ".. c:function:: ";
    }
839
    if ($args{'functiontype'} ne "") {
840
	$start .= $args{'functiontype'} . " " . $args{'function'} . " (";
841
    } else {
842
	$start .= $args{'function'} . " (";
843 844 845 846 847 848 849 850 851 852
    }
    print $start;

    my $count = 0;
    foreach my $parameter (@{$args{'parameterlist'}}) {
	if ($count ne 0) {
	    print ", ";
	}
	$count++;
	$type = $args{'parametertypes'}{$parameter};
853

854 855 856 857 858 859 860
	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
	    # pointer-to-function
	    print $1 . $parameter . ") (" . $2;
	} else {
	    print $type . " " . $parameter;
	}
    }
861 862 863 864 865 866 867 868 869
    if ($args{'typedef'}) {
	print ");``\n\n";
    } else {
	print ")\n\n";
	print_lineno($declaration_start_line);
	$lineprefix = "   ";
	output_highlight_rst($args{'purpose'});
	print "\n";
    }
870

871 872
    print "**Parameters**\n\n";
    $lineprefix = "  ";
873 874
    foreach $parameter (@{$args{'parameterlist'}}) {
	my $parameter_name = $parameter;
875
	$parameter_name =~ s/\[.*//;
876 877 878
	$type = $args{'parametertypes'}{$parameter};

	if ($type ne "") {
879
	    print "``$type $parameter``\n";
880
	} else {
881
	    print "``$parameter``\n";
882
	}
883 884 885

        print_lineno($parameterdesc_start_lines{$parameter_name});

886 887
	if (defined($args{'parameterdescs'}{$parameter_name}) &&
	    $args{'parameterdescs'}{$parameter_name} ne $undescribed) {
888 889
	    output_highlight_rst($args{'parameterdescs'}{$parameter_name});
	} else {
890
	    print "  *undescribed*\n";
891 892 893
	}
	print "\n";
    }
894 895

    $lineprefix = $oldprefix;
896 897 898 899 900 901 902
    output_section_rst(@_);
}

sub output_section_rst(%) {
    my %args = %{$_[0]};
    my $section;
    my $oldprefix = $lineprefix;
903
    $lineprefix = "";
904 905

    foreach $section (@{$args{'sectionlist'}}) {
906
	print "**$section**\n\n";
907
        print_lineno($section_start_lines{$section});
908 909 910 911 912 913 914 915 916 917
	output_highlight_rst($args{'sections'}{$section});
	print "\n";
    }
    print "\n";
    $lineprefix = $oldprefix;
}

sub output_enum_rst(%) {
    my %args = %{$_[0]};
    my ($parameter);
918
    my $oldprefix = $lineprefix;
919 920
    my $count;
    my $name = "enum " . $args{'enum'};
921 922

    print "\n\n.. c:type:: " . $name . "\n\n";
923
    print_lineno($declaration_start_line);
924 925 926
    $lineprefix = "   ";
    output_highlight_rst($args{'purpose'});
    print "\n";
927

928 929
    print "**Constants**\n\n";
    $lineprefix = "  ";
930
    foreach $parameter (@{$args{'parameterlist'}}) {
931
	print "``$parameter``\n";
932 933 934
	if ($args{'parameterdescs'}{$parameter} ne $undescribed) {
	    output_highlight_rst($args{'parameterdescs'}{$parameter});
	} else {
935
	    print "  *undescribed*\n";
936 937 938
	}
	print "\n";
    }
939

940 941 942 943 944 945 946
    $lineprefix = $oldprefix;
    output_section_rst(@_);
}

sub output_typedef_rst(%) {
    my %args = %{$_[0]};
    my ($parameter);
947
    my $oldprefix = $lineprefix;
948 949
    my $name = "typedef " . $args{'typedef'};

950
    print "\n\n.. c:type:: " . $name . "\n\n";
951
    print_lineno($declaration_start_line);
952 953 954
    $lineprefix = "   ";
    output_highlight_rst($args{'purpose'});
    print "\n";
955

956
    $lineprefix = $oldprefix;
957 958 959 960 961 962
    output_section_rst(@_);
}

sub output_struct_rst(%) {
    my %args = %{$_[0]};
    my ($parameter);
963
    my $oldprefix = $lineprefix;
964 965
    my $name = $args{'type'} . " " . $args{'struct'};

966
    print "\n\n.. c:type:: " . $name . "\n\n";
967
    print_lineno($declaration_start_line);
968 969 970
    $lineprefix = "   ";
    output_highlight_rst($args{'purpose'});
    print "\n";
971

972 973
    print "**Definition**\n\n";
    print "::\n\n";
974 975 976
    my $declaration = $args{'definition'};
    $declaration =~ s/\t/  /g;
    print "  " . $args{'type'} . " " . $args{'struct'} . " {\n$declaration  };\n\n";
977

978 979
    print "**Members**\n\n";
    $lineprefix = "  ";
980 981 982 983 984 985 986 987
    foreach $parameter (@{$args{'parameterlist'}}) {
	($parameter =~ /^#/) && next;

	my $parameter_name = $parameter;
	$parameter_name =~ s/\[.*//;

	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
	$type = $args{'parametertypes'}{$parameter};
988
        print_lineno($parameterdesc_start_lines{$parameter_name});
989
	print "``" . $parameter . "``\n";
990 991 992 993
	output_highlight_rst($args{'parameterdescs'}{$parameter_name});
	print "\n";
    }
    print "\n";
994 995

    $lineprefix = $oldprefix;
996 997 998
    output_section_rst(@_);
}

999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
## none mode output functions

sub output_function_none(%) {
}

sub output_enum_none(%) {
}

sub output_typedef_none(%) {
}

sub output_struct_none(%) {
}

sub output_blockhead_none(%) {
}

Linus Torvalds's avatar
Linus Torvalds committed
1016
##
1017 1018 1019
# generic output function for all types (function, struct/union, typedef, enum);
# calls the generated, variable output_ function name based on
# functype and output_mode
Linus Torvalds's avatar
Linus Torvalds committed
1020 1021 1022 1023 1024
sub output_declaration {
    no strict 'refs';
    my $name = shift;
    my $functype = shift;
    my $func = "output_${functype}_$output_mode";
1025 1026 1027 1028 1029 1030 1031
    if (($output_selection == OUTPUT_ALL) ||
	(($output_selection == OUTPUT_INCLUDE ||
	  $output_selection == OUTPUT_EXPORTED) &&
	 defined($function_table{$name})) ||
	(($output_selection == OUTPUT_EXCLUDE ||
	  $output_selection == OUTPUT_INTERNAL) &&
	 !($functype eq "function" && defined($function_table{$name}))))
Linus Torvalds's avatar
Linus Torvalds committed
1032
    {
1033
	&$func(@_);
Linus Torvalds's avatar
Linus Torvalds committed
1034 1035 1036 1037 1038
	$section_counter++;
    }
}

##
1039
# generic output function - calls the right one based on current output mode.
1040
sub output_blockhead {
Linus Torvalds's avatar
Linus Torvalds committed
1041
    no strict 'refs';
1042
    my $func = "output_blockhead_" . $output_mode;
Linus Torvalds's avatar
Linus Torvalds committed
1043 1044 1045 1046 1047
    &$func(@_);
    $section_counter++;
}

##
1048
# takes a declaration (struct, union, enum, typedef) and
Linus Torvalds's avatar
Linus Torvalds committed
1049 1050 1051 1052
# invokes the right handler. NOT called for functions.
sub dump_declaration($$) {
    no strict 'refs';
    my ($prototype, $file) = @_;
1053
    my $func = "dump_" . $decl_type;
Linus Torvalds's avatar
Linus Torvalds committed
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
    &$func(@_);
}

sub dump_union($$) {
    dump_struct(@_);
}

sub dump_struct($$) {
    my $x = shift;
    my $file = shift;

1065
    if ($x =~ /(struct|union)\s+(\w+)\s*\{(.*)\}/) {
1066
	my $decl_type = $1;
1067 1068
	$declaration_name = $2;
	my $members = $3;
Linus Torvalds's avatar
Linus Torvalds committed
1069

1070
	# ignore members marked private:
1071 1072
	$members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
	$members =~ s/\/\*\s*private:.*//gosi;
1073 1074
	# strip comments:
	$members =~ s/\/\*.*?\*\///gos;
1075
	# strip attributes
1076
	$members =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;
1077
	$members =~ s/__aligned\s*\([^;]*\)//gos;
1078
	$members =~ s/\s*CRYPTO_MINALIGN_ATTR//gos;
1079
	# replace DECLARE_BITMAP
1080
	$members =~ s/DECLARE_BITMAP\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
1081
	# replace DECLARE_HASHTABLE
1082 1083 1084 1085 1086
	$members =~ s/DECLARE_HASHTABLE\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
	# replace DECLARE_KFIFO
	$members =~ s/DECLARE_KFIFO\s*\(([^,)]+),\s*([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos;
	# replace DECLARE_KFIFO_PTR
	$members =~ s/DECLARE_KFIFO_PTR\s*\(([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos;
1087

1088 1089 1090
	my $declaration = $members;

	# Split nested struct/union elements as newer ones
1091 1092 1093 1094 1095 1096 1097 1098
	while ($members =~ m/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/) {
		my $newmember;
		my $maintype = $1;
		my $ids = $4;
		my $content = $3;
		foreach my $id(split /,/, $ids) {
			$newmember .= "$maintype $id; ";

1099
			$id =~ s/[:\[].*//;
1100
			$id =~ s/^\s*\**(\S+)\s*/$1/;
1101 1102
			foreach my $arg (split /;/, $content) {
				next if ($arg =~ m/^\s*$/);
1103 1104 1105 1106 1107 1108 1109 1110
				if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) {
					# pointer-to-function
					my $type = $1;
					my $name = $2;
					my $extra = $3;
					next if (!$name);
					if ($id =~ m/^\s*$/) {
						# anonymous struct/union
1111
						$newmember .= "$type$name$extra; ";
1112
					} else {
1113
						$newmember .= "$type$id.$name$extra; ";
1114
					}
1115
				} else {
1116 1117 1118 1119 1120 1121 1122
					my $type;
					my $names;
					$arg =~ s/^\s+//;
					$arg =~ s/\s+$//;
					# Handle bitmaps
					$arg =~ s/:\s*\d+\s*//g;
					# Handle arrays
1123
					$arg =~ s/\[.*\]//g;
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
					# The type may have multiple words,
					# and multiple IDs can be defined, like:
					#	const struct foo, *bar, foobar
					# So, we remove spaces when parsing the
					# names, in order to match just names
					# and commas for the names
					$arg =~ s/\s*,\s*/,/g;
					if ($arg =~ m/(.*)\s+([\S+,]+)/) {
						$type = $1;
						$names = $2;
1134
					} else {
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146
						$newmember .= "$arg; ";
						next;
					}
					foreach my $name (split /,/, $names) {
						$name =~ s/^\s*\**(\S+)\s*/$1/;
						next if (($name =~ m/^\s*$/));
						if ($id =~ m/^\s*$/) {
							# anonymous struct/union
							$newmember .= "$type $name; ";
						} else {
							$newmember .= "$type $id.$name; ";
						}
1147
					}
1148 1149
				}
			}
1150
		}
1151
		$members =~ s/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/$newmember/;
1152
	}
1153 1154

	# Ignore other nested elements, like enums
1155
	$members =~ s/(\{[^\{\}]*\})//g;
1156

1157
	create_parameterlist($members, ';', $file, $declaration_name);
1158
	check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual);
Linus Torvalds's avatar
Linus Torvalds committed
1159

1160
	# Adjust declaration for better display
1161 1162
	$declaration =~ s/([\{;])/$1\n/g;
	$declaration =~ s/\}\s+;/};/g;
1163
	# Better handle inlined enums
1164
	do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/);
1165 1166 1167 1168 1169 1170 1171 1172 1173

	my @def_args = split /\n/, $declaration;
	my $level = 1;
	$declaration = "";
	foreach my $clause (@def_args) {
		$clause =~ s/^\s+//;
		$clause =~ s/\s+$//;
		$clause =~ s/\s+/ /;
		next if (!$clause);
1174
		$level-- if ($clause =~ m/(\})/ && $level > 1);
1175 1176 1177 1178
		if (!($clause =~ m/^\s*#/)) {
			$declaration .= "\t" x $level;
		}
		$declaration .= "\t" . $clause . "\n";
1179
		$level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/));
1180
	}
Linus Torvalds's avatar
Linus Torvalds committed
1181 1182 1183 1184
	output_declaration($declaration_name,
			   'struct',
			   {'struct' => $declaration_name,
			    'module' => $modulename,
1185
			    'definition' => $declaration,
Linus Torvalds's avatar
Linus Torvalds committed
1186 1187 1188 1189 1190 1191 1192 1193 1194 1195
			    'parameterlist' => \@parameterlist,
			    'parameterdescs' => \%parameterdescs,
			    'parametertypes' => \%parametertypes,
			    'sectionlist' => \@sectionlist,
			    'sections' => \%sections,
			    'purpose' => $declaration_purpose,
			    'type' => $decl_type
			   });
    }
    else {
1196
	print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
Linus Torvalds's avatar
Linus Torvalds committed
1197 1198 1199 1200
	++$errors;
    }
}

1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238

sub show_warnings($$) {
	my $functype = shift;
	my $name = shift;

	return 1 if ($output_selection == OUTPUT_ALL);

	if ($output_selection == OUTPUT_EXPORTED) {
		if (defined($function_table{$name})) {
			return 1;
		} else {
			return 0;
		}
	}
        if ($output_selection == OUTPUT_INTERNAL) {
		if (!($functype eq "function" && defined($function_table{$name}))) {
			return 1;
		} else {
			return 0;
		}
	}
	if ($output_selection == OUTPUT_INCLUDE) {
		if (defined($function_table{$name})) {
			return 1;
		} else {
			return 0;
		}
	}
	if ($output_selection == OUTPUT_EXCLUDE) {
		if (!defined($function_table{$name})) {
			return 1;
		} else {
			return 0;
		}
	}
	die("Please add the new output type at show_warnings()");
}

Linus Torvalds's avatar
Linus Torvalds committed
1239 1240 1241 1242
sub dump_enum($$) {
    my $x = shift;
    my $file = shift;

1243
    $x =~ s@/\*.*?\*/@@gos;	# strip comments.
1244 1245
    # strip #define macros inside enums
    $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;
1246

1247
    if ($x =~ /enum\s+(\w+)\s*\{(.*)\}/) {
1248 1249
	$declaration_name = $1;
	my $members = $2;
1250 1251
	my %_members;

1252
	$members =~ s/\s+$//;
Linus Torvalds's avatar
Linus Torvalds committed
1253 1254 1255 1256 1257

	foreach my $arg (split ',', $members) {
	    $arg =~ s/^\s*(\w+).*/$1/;
	    push @parameterlist, $arg;
	    if (!$parameterdescs{$arg}) {
1258
		$parameterdescs{$arg} = $undescribed;
1259
	        if (show_warnings("enum", $declaration_name)) {
1260 1261
			print STDERR "${file}:$.: warning: Enum value '$arg' not described in enum '$declaration_name'\n";
		}
Linus Torvalds's avatar
Linus Torvalds committed
1262
	    }
1263
	    $_members{$arg} = 1;
Linus Torvalds's avatar
Linus Torvalds committed
1264
	}
1265

1266 1267
	while (my ($k, $v) = each %parameterdescs) {
	    if (!exists($_members{$k})) {
1268
	        if (show_warnings("enum", $declaration_name)) {
1269 1270
		     print STDERR "${file}:$.: warning: Excess enum value '$k' description in '$declaration_name'\n";
		}
1271 1272 1273
	    }
        }

Linus Torvalds's avatar
Linus Torvalds committed
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285
	output_declaration($declaration_name,
			   'enum',
			   {'enum' => $declaration_name,
			    'module' => $modulename,
			    'parameterlist' => \@parameterlist,
			    'parameterdescs' => \%parameterdescs,
			    'sectionlist' => \@sectionlist,
			    'sections' => \%sections,
			    'purpose' => $declaration_purpose
			   });
    }
    else {
1286
	print STDERR "${file}:$.: error: Cannot parse enum!\n";
Linus Torvalds's avatar
Linus Torvalds committed
1287 1288 1289 1290 1291 1292 1293 1294
	++$errors;
    }
}

sub dump_typedef($$) {
    my $x = shift;
    my $file = shift;

1295
    $x =~ s@/\*.*?\*/@@gos;	# strip comments.
Linus Torvalds's avatar
Linus Torvalds committed
1296

1297
    # Parse function prototypes
1298 1299 1300
    if ($x =~ /typedef\s+(\w+)\s*\(\*\s*(\w\S+)\s*\)\s*\((.*)\);/ ||
	$x =~ /typedef\s+(\w+)\s*(\w\S+)\s*\s*\((.*)\);/) {

1301 1302 1303 1304 1305
	# Function typedefs
	$return_type = $1;
	$declaration_name = $2;
	my $args = $3;

1306
	create_parameterlist($args, ',', $file, $declaration_name);
Linus Torvalds's avatar
Linus Torvalds committed
1307 1308

	output_declaration($declaration_name,
1309 1310
			   'function',
			   {'function' => $declaration_name,
1311
			    'typedef' => 1,
Linus Torvalds's avatar
Linus Torvalds committed
1312
			    'module' => $modulename,
1313 1314 1315 1316
			    'functiontype' => $return_type,
			    'parameterlist' => \@parameterlist,
			    'parameterdescs' => \%parameterdescs,
			    'parametertypes' => \%parametertypes,
Linus Torvalds's avatar
Linus Torvalds committed
1317 1318 1319 1320
			    'sectionlist' => \@sectionlist,
			    'sections' => \%sections,
			    'purpose' => $declaration_purpose
			   });
1321 1322 1323 1324 1325 1326
	return;
    }

    while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
	$x =~ s/\(*.\)\s*;$/;/;
	$x =~ s/\[*.\]\s*;$/;/;
Linus Torvalds's avatar
Linus Torvalds committed
1327
    }
1328 1329

    if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340
	$declaration_name = $1;

	output_declaration($declaration_name,
			   'typedef',
			   {'typedef' => $declaration_name,
			    'module' => $modulename,
			    'sectionlist' => \@sectionlist,
			    'sections' => \%sections,
			    'purpose' => $declaration_purpose
			   });
    }
Linus Torvalds's avatar
Linus Torvalds committed
1341
    else {
1342
	print STDERR "${file}:$.: error: Cannot parse typedef!\n";
Linus Torvalds's avatar
Linus Torvalds committed
1343 1344 1345 1346
	++$errors;
    }
}

1347 1348 1349 1350 1351 1352 1353 1354
sub save_struct_actual($) {
    my $actual = shift;

    # strip all spaces from the actual param so that it looks like one string item
    $actual =~ s/\s*//g;
    $struct_actual = $struct_actual . $actual . " ";
}

1355
sub create_parameterlist($$$$) {
Linus Torvalds's avatar
Linus Torvalds committed
1356 1357 1358
    my $args = shift;
    my $splitter = shift;
    my $file = shift;
1359
    my $declaration_name = shift;
Linus Torvalds's avatar
Linus Torvalds committed
1360 1361 1362
    my $type;
    my $param;

1363
    # temporarily replace commas inside function pointer definition
Linus Torvalds's avatar
Linus Torvalds committed
1364
    while ($args =~ /(\([^\),]+),/) {
1365
	$args =~ s/(\([^\),]+),/$1#/g;
Linus Torvalds's avatar
Linus Torvalds committed
1366
    }
1367

Linus Torvalds's avatar
Linus Torvalds committed
1368 1369 1370
    foreach my $arg (split($splitter, $args)) {
	# strip comments
	$arg =~ s/\/\*.*\*\///;
1371 1372
	# strip leading/trailing spaces
	$arg =~ s/^\s*//;
Linus Torvalds's avatar
Linus Torvalds committed
1373 1374 1375 1376 1377 1378 1379 1380
	$arg =~ s/\s*$//;
	$arg =~ s/\s+/ /;

	if ($arg =~ /^#/) {
	    # Treat preprocessor directive as a typeless variable just to fill
	    # corresponding data structures "correctly". Catch it later in
	    # output_* subs.
	    push_parameter($arg, "", $file);
1381
	} elsif ($arg =~ m/\(.+\)\s*\(/) {
Linus Torvalds's avatar
Linus Torvalds committed
1382 1383
	    # pointer-to-function
	    $arg =~ tr/#/,/;