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