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