xref: /openbmc/linux/scripts/kernel-doc (revision fc6d7af8)
11da177e4SLinus Torvalds#!/usr/bin/perl -w
21da177e4SLinus Torvalds
31da177e4SLinus Torvaldsuse strict;
41da177e4SLinus Torvalds
51da177e4SLinus Torvalds## Copyright (c) 1998 Michael Zucchi, All Rights Reserved        ##
61da177e4SLinus Torvalds## Copyright (C) 2000, 1  Tim Waugh <twaugh@redhat.com>          ##
71da177e4SLinus Torvalds## Copyright (C) 2001  Simon Huggins                             ##
870c95b00SRandy Dunlap## Copyright (C) 2005-2012  Randy Dunlap                         ##
91b40c194SDan Luedtke## Copyright (C) 2012  Dan Luedtke                               ##
101da177e4SLinus Torvalds## 								 ##
111da177e4SLinus Torvalds## #define enhancements by Armin Kuster <akuster@mvista.com>	 ##
121da177e4SLinus Torvalds## Copyright (c) 2000 MontaVista Software, Inc.			 ##
131da177e4SLinus Torvalds## 								 ##
141da177e4SLinus Torvalds## This software falls under the GNU General Public License.     ##
151da177e4SLinus Torvalds## Please read the COPYING file for more information             ##
161da177e4SLinus Torvalds
171da177e4SLinus Torvalds# 18/01/2001 - 	Cleanups
181da177e4SLinus Torvalds# 		Functions prototyped as foo(void) same as foo()
191da177e4SLinus Torvalds# 		Stop eval'ing where we don't need to.
201da177e4SLinus Torvalds# -- huggie@earth.li
211da177e4SLinus Torvalds
221da177e4SLinus Torvalds# 27/06/2001 -  Allowed whitespace after initial "/**" and
231da177e4SLinus Torvalds#               allowed comments before function declarations.
241da177e4SLinus Torvalds# -- Christian Kreibich <ck@whoop.org>
251da177e4SLinus Torvalds
261da177e4SLinus Torvalds# Still to do:
271da177e4SLinus Torvalds# 	- add perldoc documentation
281da177e4SLinus Torvalds# 	- Look more closely at some of the scarier bits :)
291da177e4SLinus Torvalds
301da177e4SLinus Torvalds# 26/05/2001 - 	Support for separate source and object trees.
311da177e4SLinus Torvalds#		Return error code.
321da177e4SLinus Torvalds# 		Keith Owens <kaos@ocs.com.au>
331da177e4SLinus Torvalds
341da177e4SLinus Torvalds# 23/09/2001 - Added support for typedefs, structs, enums and unions
351da177e4SLinus Torvalds#              Support for Context section; can be terminated using empty line
361da177e4SLinus Torvalds#              Small fixes (like spaces vs. \s in regex)
371da177e4SLinus Torvalds# -- Tim Jansen <tim@tjansen.de>
381da177e4SLinus Torvalds
391b40c194SDan Luedtke# 25/07/2012 - Added support for HTML5
401b40c194SDan Luedtke# -- Dan Luedtke <mail@danrl.de>
411da177e4SLinus Torvalds
42fadc0b31SJani Nikulasub usage {
43fadc0b31SJani Nikula    my $message = <<"EOF";
44fadc0b31SJani NikulaUsage: $0 [OPTION ...] FILE ...
451da177e4SLinus Torvalds
46fadc0b31SJani NikulaRead C language source or header FILEs, extract embedded documentation comments,
47fadc0b31SJani Nikulaand print formatted documentation to standard output.
481da177e4SLinus Torvalds
49fadc0b31SJani NikulaThe documentation comments are identified by "/**" opening comment mark. See
50fadc0b31SJani NikulaDocumentation/kernel-doc-nano-HOWTO.txt for the documentation comment syntax.
51fadc0b31SJani Nikula
52fadc0b31SJani NikulaOutput format selection (mutually exclusive):
53fadc0b31SJani Nikula  -docbook		Output DocBook format.
54fadc0b31SJani Nikula  -html			Output HTML format.
55fadc0b31SJani Nikula  -html5		Output HTML5 format.
56fadc0b31SJani Nikula  -list			Output symbol list format. This is for use by docproc.
57fadc0b31SJani Nikula  -man			Output troff manual page format. This is the default.
58c0d1b6eeSJonathan Corbet  -rst			Output reStructuredText format.
59fadc0b31SJani Nikula  -text			Output plain text format.
60fadc0b31SJani Nikula
61fadc0b31SJani NikulaOutput selection (mutually exclusive):
6286ae2e38SJani Nikula  -export		Only output documentation for symbols that have been
6386ae2e38SJani Nikula			exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
64c9b2cfb3SJani Nikula                        in any input FILE or -export-file FILE.
6586ae2e38SJani Nikula  -internal		Only output documentation for symbols that have NOT been
6686ae2e38SJani Nikula			exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
67c9b2cfb3SJani Nikula                        in any input FILE or -export-file FILE.
68fadc0b31SJani Nikula  -function NAME	Only output documentation for the given function(s)
69fadc0b31SJani Nikula			or DOC: section title(s). All other functions and DOC:
70fadc0b31SJani Nikula			sections are ignored. May be specified multiple times.
71fadc0b31SJani Nikula  -nofunction NAME	Do NOT output documentation for the given function(s);
72fadc0b31SJani Nikula			only output documentation for the other functions and
73fadc0b31SJani Nikula			DOC: sections. May be specified multiple times.
74fadc0b31SJani Nikula
75fadc0b31SJani NikulaOutput selection modifiers:
76fadc0b31SJani Nikula  -no-doc-sections	Do not output DOC: sections.
770b0f5f29SDaniel Vetter  -enable-lineno        Enable output of #define LINENO lines. Only works with
780b0f5f29SDaniel Vetter                        reStructuredText format.
7988c2b57dSJani Nikula  -export-file FILE     Specify an additional FILE in which to look for
8088c2b57dSJani Nikula                        EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be used with
8188c2b57dSJani Nikula                        -export or -internal. May be specified multiple times.
82fadc0b31SJani Nikula
83fadc0b31SJani NikulaOther parameters:
84fadc0b31SJani Nikula  -v			Verbose output, more warnings and other information.
85fadc0b31SJani Nikula  -h			Print this help.
86fadc0b31SJani Nikula
87fadc0b31SJani NikulaEOF
88fadc0b31SJani Nikula    print $message;
89fadc0b31SJani Nikula    exit 1;
90fadc0b31SJani Nikula}
911da177e4SLinus Torvalds
921da177e4SLinus Torvalds#
931da177e4SLinus Torvalds# format of comments.
941da177e4SLinus Torvalds# In the following table, (...)? signifies optional structure.
951da177e4SLinus Torvalds#                         (...)* signifies 0 or more structure elements
961da177e4SLinus Torvalds# /**
971da177e4SLinus Torvalds#  * function_name(:)? (- short description)?
981da177e4SLinus Torvalds# (* @parameterx: (description of parameter x)?)*
991da177e4SLinus Torvalds# (* a blank line)?
1001da177e4SLinus Torvalds#  * (Description:)? (Description of function)?
1011da177e4SLinus Torvalds#  * (section header: (section description)? )*
1021da177e4SLinus Torvalds#  (*)?*/
1031da177e4SLinus Torvalds#
1041da177e4SLinus Torvalds# So .. the trivial example would be:
1051da177e4SLinus Torvalds#
1061da177e4SLinus Torvalds# /**
1071da177e4SLinus Torvalds#  * my_function
108b9d97328SRandy Dunlap#  */
1091da177e4SLinus Torvalds#
110891dcd2fSRandy Dunlap# If the Description: header tag is omitted, then there must be a blank line
1111da177e4SLinus Torvalds# after the last parameter specification.
1121da177e4SLinus Torvalds# e.g.
1131da177e4SLinus Torvalds# /**
1141da177e4SLinus Torvalds#  * my_function - does my stuff
1151da177e4SLinus Torvalds#  * @my_arg: its mine damnit
1161da177e4SLinus Torvalds#  *
1171da177e4SLinus Torvalds#  * Does my stuff explained.
1181da177e4SLinus Torvalds#  */
1191da177e4SLinus Torvalds#
1201da177e4SLinus Torvalds#  or, could also use:
1211da177e4SLinus Torvalds# /**
1221da177e4SLinus Torvalds#  * my_function - does my stuff
1231da177e4SLinus Torvalds#  * @my_arg: its mine damnit
1241da177e4SLinus Torvalds#  * Description: Does my stuff explained.
1251da177e4SLinus Torvalds#  */
1261da177e4SLinus Torvalds# etc.
1271da177e4SLinus Torvalds#
128b9d97328SRandy Dunlap# Besides functions you can also write documentation for structs, unions,
1291da177e4SLinus Torvalds# enums and typedefs. Instead of the function name you must write the name
1301da177e4SLinus Torvalds# of the declaration;  the struct/union/enum/typedef must always precede
1311da177e4SLinus Torvalds# the name. Nesting of declarations is not supported.
1321da177e4SLinus Torvalds# Use the argument mechanism to document members or constants.
1331da177e4SLinus Torvalds# e.g.
1341da177e4SLinus Torvalds# /**
1351da177e4SLinus Torvalds#  * struct my_struct - short description
1361da177e4SLinus Torvalds#  * @a: first member
1371da177e4SLinus Torvalds#  * @b: second member
1381da177e4SLinus Torvalds#  *
1391da177e4SLinus Torvalds#  * Longer description
1401da177e4SLinus Torvalds#  */
1411da177e4SLinus Torvalds# struct my_struct {
1421da177e4SLinus Torvalds#     int a;
1431da177e4SLinus Torvalds#     int b;
144aeec46b9SMartin Waitz# /* private: */
145aeec46b9SMartin Waitz#     int c;
1461da177e4SLinus Torvalds# };
1471da177e4SLinus Torvalds#
1481da177e4SLinus Torvalds# All descriptions can be multiline, except the short function description.
1491da177e4SLinus Torvalds#
150a4c6ebedSDanilo Cesar Lemes de Paula# For really longs structs, you can also describe arguments inside the
151a4c6ebedSDanilo Cesar Lemes de Paula# body of the struct.
152a4c6ebedSDanilo Cesar Lemes de Paula# eg.
153a4c6ebedSDanilo Cesar Lemes de Paula# /**
154a4c6ebedSDanilo Cesar Lemes de Paula#  * struct my_struct - short description
155a4c6ebedSDanilo Cesar Lemes de Paula#  * @a: first member
156a4c6ebedSDanilo Cesar Lemes de Paula#  * @b: second member
157a4c6ebedSDanilo Cesar Lemes de Paula#  *
158a4c6ebedSDanilo Cesar Lemes de Paula#  * Longer description
159a4c6ebedSDanilo Cesar Lemes de Paula#  */
160a4c6ebedSDanilo Cesar Lemes de Paula# struct my_struct {
161a4c6ebedSDanilo Cesar Lemes de Paula#     int a;
162a4c6ebedSDanilo Cesar Lemes de Paula#     int b;
163a4c6ebedSDanilo Cesar Lemes de Paula#     /**
164a4c6ebedSDanilo Cesar Lemes de Paula#      * @c: This is longer description of C
165a4c6ebedSDanilo Cesar Lemes de Paula#      *
166a4c6ebedSDanilo Cesar Lemes de Paula#      * You can use paragraphs to describe arguments
167a4c6ebedSDanilo Cesar Lemes de Paula#      * using this method.
168a4c6ebedSDanilo Cesar Lemes de Paula#      */
169a4c6ebedSDanilo Cesar Lemes de Paula#     int c;
170a4c6ebedSDanilo Cesar Lemes de Paula# };
171a4c6ebedSDanilo Cesar Lemes de Paula#
172a4c6ebedSDanilo Cesar Lemes de Paula# This should be use only for struct/enum members.
173a4c6ebedSDanilo Cesar Lemes de Paula#
1741da177e4SLinus Torvalds# You can also add additional sections. When documenting kernel functions you
1751da177e4SLinus Torvalds# should document the "Context:" of the function, e.g. whether the functions
1761da177e4SLinus Torvalds# can be called form interrupts. Unlike other sections you can end it with an
1771da177e4SLinus Torvalds# empty line.
1784092bac7SYacine Belkadi# A non-void function should have a "Return:" section describing the return
1794092bac7SYacine Belkadi# value(s).
1801da177e4SLinus Torvalds# Example-sections should contain the string EXAMPLE so that they are marked
1811da177e4SLinus Torvalds# appropriately in DocBook.
1821da177e4SLinus Torvalds#
1831da177e4SLinus Torvalds# Example:
1841da177e4SLinus Torvalds# /**
1851da177e4SLinus Torvalds#  * user_function - function that can only be called in user context
1861da177e4SLinus Torvalds#  * @a: some argument
1871da177e4SLinus Torvalds#  * Context: !in_interrupt()
1881da177e4SLinus Torvalds#  *
1891da177e4SLinus Torvalds#  * Some description
1901da177e4SLinus Torvalds#  * Example:
1911da177e4SLinus Torvalds#  *    user_function(22);
1921da177e4SLinus Torvalds#  */
1931da177e4SLinus Torvalds# ...
1941da177e4SLinus Torvalds#
1951da177e4SLinus Torvalds#
1961da177e4SLinus Torvalds# All descriptive text is further processed, scanning for the following special
1971da177e4SLinus Torvalds# patterns, which are highlighted appropriately.
1981da177e4SLinus Torvalds#
1991da177e4SLinus Torvalds# 'funcname()' - function
2001da177e4SLinus Torvalds# '$ENVVAR' - environmental variable
2011da177e4SLinus Torvalds# '&struct_name' - name of a structure (up to two words including 'struct')
2021da177e4SLinus Torvalds# '@parameter' - name of a parameter
2031da177e4SLinus Torvalds# '%CONST' - name of a constant.
2041da177e4SLinus Torvalds
2058484baaaSRandy Dunlap## init lots of data
2068484baaaSRandy Dunlap
207c950a173SSilvio Fricke
2081da177e4SLinus Torvaldsmy $errors = 0;
2091da177e4SLinus Torvaldsmy $warnings = 0;
2105f8c7c98SRandy Dunlapmy $anon_struct_union = 0;
2111da177e4SLinus Torvalds
2121da177e4SLinus Torvalds# match expressions used to find embedded type information
2131da177e4SLinus Torvaldsmy $type_constant = '\%([-_\w]+)';
2141da177e4SLinus Torvaldsmy $type_func = '(\w+)\(\)';
215c950a173SSilvio Frickemy $type_param = '\@(\w+(\.\.\.)?)';
2165219f18aSJonathan Corbetmy $type_fp_param = '\@(\w+)\(\)';  # Special RST handling for func ptr params
2173eb014a1SRandy Dunlapmy $type_struct = '\&((struct\s*)*[_\w]+)';
2186b5b55f6SRandy Dunlapmy $type_struct_xml = '\\&amp;((struct\s*)*[_\w]+)';
2191da177e4SLinus Torvaldsmy $type_env = '(\$\w+)';
220c0d1b6eeSJonathan Corbetmy $type_enum_full = '\&(enum)\s*([_\w]+)';
221c0d1b6eeSJonathan Corbetmy $type_struct_full = '\&(struct)\s*([_\w]+)';
22247ae7aedSJani Nikulamy $type_typedef_full = '\&(typedef)\s*([_\w]+)';
22347ae7aedSJani Nikulamy $type_union_full = '\&(union)\s*([_\w]+)';
224f3341dcfSJani Nikulamy $type_member = '\&([_\w]+)((\.|->)[_\w]+)';
225f3341dcfSJani Nikulamy $type_member_func = $type_member . '\(\)';
2261da177e4SLinus Torvalds
2271da177e4SLinus Torvalds# Output conversion substitutions.
2281da177e4SLinus Torvalds#  One for each output format
2291da177e4SLinus Torvalds
2301da177e4SLinus Torvalds# these work fairly well
2314d732701SDanilo Cesar Lemes de Paulamy @highlights_html = (
2324d732701SDanilo Cesar Lemes de Paula                       [$type_constant, "<i>\$1</i>"],
2334d732701SDanilo Cesar Lemes de Paula                       [$type_func, "<b>\$1</b>"],
2344d732701SDanilo Cesar Lemes de Paula                       [$type_struct_xml, "<i>\$1</i>"],
2354d732701SDanilo Cesar Lemes de Paula                       [$type_env, "<b><i>\$1</i></b>"],
2364d732701SDanilo Cesar Lemes de Paula                       [$type_param, "<tt><b>\$1</b></tt>"]
2374d732701SDanilo Cesar Lemes de Paula                      );
2386b5b55f6SRandy Dunlapmy $local_lt = "\\\\\\\\lt:";
2396b5b55f6SRandy Dunlapmy $local_gt = "\\\\\\\\gt:";
2406b5b55f6SRandy Dunlapmy $blankline_html = $local_lt . "p" . $local_gt;	# was "<p>"
2411da177e4SLinus Torvalds
2421b40c194SDan Luedtke# html version 5
2434d732701SDanilo Cesar Lemes de Paulamy @highlights_html5 = (
2444d732701SDanilo Cesar Lemes de Paula                        [$type_constant, "<span class=\"const\">\$1</span>"],
2454d732701SDanilo Cesar Lemes de Paula                        [$type_func, "<span class=\"func\">\$1</span>"],
2464d732701SDanilo Cesar Lemes de Paula                        [$type_struct_xml, "<span class=\"struct\">\$1</span>"],
2474d732701SDanilo Cesar Lemes de Paula                        [$type_env, "<span class=\"env\">\$1</span>"],
2484d732701SDanilo Cesar Lemes de Paula                        [$type_param, "<span class=\"param\">\$1</span>]"]
2494d732701SDanilo Cesar Lemes de Paula		       );
2501b40c194SDan Luedtkemy $blankline_html5 = $local_lt . "br /" . $local_gt;
2511b40c194SDan Luedtke
2521da177e4SLinus Torvalds# XML, docbook format
2534d732701SDanilo Cesar Lemes de Paulamy @highlights_xml = (
2544d732701SDanilo Cesar Lemes de Paula                      ["([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>"],
2554d732701SDanilo Cesar Lemes de Paula                      [$type_constant, "<constant>\$1</constant>"],
2564d732701SDanilo Cesar Lemes de Paula                      [$type_struct_xml, "<structname>\$1</structname>"],
2574d732701SDanilo Cesar Lemes de Paula                      [$type_param, "<parameter>\$1</parameter>"],
2584d732701SDanilo Cesar Lemes de Paula                      [$type_func, "<function>\$1</function>"],
2594d732701SDanilo Cesar Lemes de Paula                      [$type_env, "<envar>\$1</envar>"]
2604d732701SDanilo Cesar Lemes de Paula		     );
2615c98fc03SJohannes Bergmy $blankline_xml = $local_lt . "/para" . $local_gt . $local_lt . "para" . $local_gt . "\n";
2621da177e4SLinus Torvalds
2631da177e4SLinus Torvalds# gnome, docbook format
2644d732701SDanilo Cesar Lemes de Paulamy @highlights_gnome = (
2654d732701SDanilo Cesar Lemes de Paula                        [$type_constant, "<replaceable class=\"option\">\$1</replaceable>"],
2664d732701SDanilo Cesar Lemes de Paula                        [$type_func, "<function>\$1</function>"],
2674d732701SDanilo Cesar Lemes de Paula                        [$type_struct, "<structname>\$1</structname>"],
2684d732701SDanilo Cesar Lemes de Paula                        [$type_env, "<envar>\$1</envar>"],
2694d732701SDanilo Cesar Lemes de Paula                        [$type_param, "<parameter>\$1</parameter>" ]
2704d732701SDanilo Cesar Lemes de Paula		       );
2711da177e4SLinus Torvaldsmy $blankline_gnome = "</para><para>\n";
2721da177e4SLinus Torvalds
2731da177e4SLinus Torvalds# these are pretty rough
2744d732701SDanilo Cesar Lemes de Paulamy @highlights_man = (
2754d732701SDanilo Cesar Lemes de Paula                      [$type_constant, "\$1"],
2764d732701SDanilo Cesar Lemes de Paula                      [$type_func, "\\\\fB\$1\\\\fP"],
2774d732701SDanilo Cesar Lemes de Paula                      [$type_struct, "\\\\fI\$1\\\\fP"],
2784d732701SDanilo Cesar Lemes de Paula                      [$type_param, "\\\\fI\$1\\\\fP"]
2794d732701SDanilo Cesar Lemes de Paula		     );
2801da177e4SLinus Torvaldsmy $blankline_man = "";
2811da177e4SLinus Torvalds
2821da177e4SLinus Torvalds# text-mode
2834d732701SDanilo Cesar Lemes de Paulamy @highlights_text = (
2844d732701SDanilo Cesar Lemes de Paula                       [$type_constant, "\$1"],
2854d732701SDanilo Cesar Lemes de Paula                       [$type_func, "\$1"],
2864d732701SDanilo Cesar Lemes de Paula                       [$type_struct, "\$1"],
2874d732701SDanilo Cesar Lemes de Paula                       [$type_param, "\$1"]
2884d732701SDanilo Cesar Lemes de Paula		      );
2891da177e4SLinus Torvaldsmy $blankline_text = "";
2901da177e4SLinus Torvalds
291c0d1b6eeSJonathan Corbet# rst-mode
292c0d1b6eeSJonathan Corbetmy @highlights_rst = (
293c0d1b6eeSJonathan Corbet                       [$type_constant, "``\$1``"],
294f3341dcfSJani Nikula                       # Note: need to escape () to avoid func matching later
295f3341dcfSJani Nikula                       [$type_member_func, "\\:c\\:type\\:`\$1\$2\\\\(\\\\) <\$1>`"],
296f3341dcfSJani Nikula                       [$type_member, "\\:c\\:type\\:`\$1\$2 <\$1>`"],
2975219f18aSJonathan Corbet		       [$type_fp_param, "**\$1\\\\(\\\\)**"],
298a19bce64SJani Nikula                       [$type_func, "\\:c\\:func\\:`\$1()`"],
29962850976SJani Nikula                       [$type_struct_full, "\\:c\\:type\\:`\$1 \$2 <\$2>`"],
30062850976SJani Nikula                       [$type_enum_full, "\\:c\\:type\\:`\$1 \$2 <\$2>`"],
30147ae7aedSJani Nikula                       [$type_typedef_full, "\\:c\\:type\\:`\$1 \$2 <\$2>`"],
30247ae7aedSJani Nikula                       [$type_union_full, "\\:c\\:type\\:`\$1 \$2 <\$2>`"],
303a7291e7eSJani Nikula                       # in rst this can refer to any type
304a7291e7eSJani Nikula                       [$type_struct, "\\:c\\:type\\:`\$1`"],
305c0d1b6eeSJonathan Corbet                       [$type_param, "**\$1**"]
306c0d1b6eeSJonathan Corbet		      );
307c0d1b6eeSJonathan Corbetmy $blankline_rst = "\n";
308c0d1b6eeSJonathan Corbet
309eda603f6SJohannes Berg# list mode
3104d732701SDanilo Cesar Lemes de Paulamy @highlights_list = (
3114d732701SDanilo Cesar Lemes de Paula                       [$type_constant, "\$1"],
3124d732701SDanilo Cesar Lemes de Paula                       [$type_func, "\$1"],
3134d732701SDanilo Cesar Lemes de Paula                       [$type_struct, "\$1"],
3144d732701SDanilo Cesar Lemes de Paula                       [$type_param, "\$1"]
3154d732701SDanilo Cesar Lemes de Paula		      );
316eda603f6SJohannes Bergmy $blankline_list = "";
3171da177e4SLinus Torvalds
3181da177e4SLinus Torvalds# read arguments
3191da177e4SLinus Torvaldsif ($#ARGV == -1) {
3201da177e4SLinus Torvalds    usage();
3211da177e4SLinus Torvalds}
3221da177e4SLinus Torvalds
3238484baaaSRandy Dunlapmy $kernelversion;
3248484baaaSRandy Dunlapmy $dohighlight = "";
3258484baaaSRandy Dunlap
3261da177e4SLinus Torvaldsmy $verbose = 0;
3271da177e4SLinus Torvaldsmy $output_mode = "man";
328e314ba31SDaniel Santosmy $output_preformatted = 0;
3294b44595aSJohannes Bergmy $no_doc_sections = 0;
3300b0f5f29SDaniel Vettermy $enable_lineno = 0;
3314d732701SDanilo Cesar Lemes de Paulamy @highlights = @highlights_man;
3321da177e4SLinus Torvaldsmy $blankline = $blankline_man;
3331da177e4SLinus Torvaldsmy $modulename = "Kernel API";
334b6c3f456SJani Nikula
335b6c3f456SJani Nikulause constant {
336b6c3f456SJani Nikula    OUTPUT_ALL          => 0, # output all symbols and doc sections
337b6c3f456SJani Nikula    OUTPUT_INCLUDE      => 1, # output only specified symbols
338b6c3f456SJani Nikula    OUTPUT_EXCLUDE      => 2, # output everything except specified symbols
339b6c3f456SJani Nikula    OUTPUT_EXPORTED     => 3, # output exported symbols
340b6c3f456SJani Nikula    OUTPUT_INTERNAL     => 4, # output non-exported symbols
341b6c3f456SJani Nikula};
342b6c3f456SJani Nikulamy $output_selection = OUTPUT_ALL;
343b2c4105bSBen Hutchingsmy $show_not_found = 0;
344b2c4105bSBen Hutchings
34588c2b57dSJani Nikulamy @export_file_list;
34688c2b57dSJani Nikula
347b2c4105bSBen Hutchingsmy @build_time;
348b2c4105bSBen Hutchingsif (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) &&
349b2c4105bSBen Hutchings    (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') {
350b2c4105bSBen Hutchings    @build_time = gmtime($seconds);
351b2c4105bSBen Hutchings} else {
352b2c4105bSBen Hutchings    @build_time = localtime;
353b2c4105bSBen Hutchings}
354b2c4105bSBen Hutchings
3551da177e4SLinus Torvaldsmy $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
3561da177e4SLinus Torvalds		'July', 'August', 'September', 'October',
357b2c4105bSBen Hutchings		'November', 'December')[$build_time[4]] .
358b2c4105bSBen Hutchings  " " . ($build_time[5]+1900);
3591da177e4SLinus Torvalds
3608484baaaSRandy Dunlap# Essentially these are globals.
361b9d97328SRandy Dunlap# They probably want to be tidied up, made more localised or something.
362b9d97328SRandy Dunlap# CAVEAT EMPTOR!  Some of the others I localised may not want to be, which
3631da177e4SLinus Torvalds# could cause "use of undefined value" or other bugs.
3641da177e4SLinus Torvaldsmy ($function, %function_table, %parametertypes, $declaration_purpose);
3650b0f5f29SDaniel Vettermy $declaration_start_line;
3661da177e4SLinus Torvaldsmy ($type, $declaration_name, $return_type);
3671c32fd0cSIlya Dryomovmy ($newsection, $newcontents, $prototype, $brcount, %source_map);
3681da177e4SLinus Torvalds
369bd0e88e5SRandy Dunlapif (defined($ENV{'KBUILD_VERBOSE'})) {
370bd0e88e5SRandy Dunlap	$verbose = "$ENV{'KBUILD_VERBOSE'}";
371bd0e88e5SRandy Dunlap}
372bd0e88e5SRandy Dunlap
3731da177e4SLinus Torvalds# Generated docbook code is inserted in a template at a point where
3741da177e4SLinus Torvalds# docbook v3.1 requires a non-zero sequence of RefEntry's; see:
3751da177e4SLinus Torvalds# http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
3761da177e4SLinus Torvalds# We keep track of number of generated entries and generate a dummy
3771da177e4SLinus Torvalds# if needs be to ensure the expanded template can be postprocessed
3781da177e4SLinus Torvalds# into html.
3791da177e4SLinus Torvaldsmy $section_counter = 0;
3801da177e4SLinus Torvalds
3811da177e4SLinus Torvaldsmy $lineprefix="";
3821da177e4SLinus Torvalds
38348af606aSJani Nikula# Parser states
38448af606aSJani Nikulause constant {
38548af606aSJani Nikula    STATE_NORMAL        => 0, # normal code
38648af606aSJani Nikula    STATE_NAME          => 1, # looking for function name
38748af606aSJani Nikula    STATE_FIELD         => 2, # scanning field start
38848af606aSJani Nikula    STATE_PROTO         => 3, # scanning prototype
38948af606aSJani Nikula    STATE_DOCBLOCK      => 4, # documentation block
39048af606aSJani Nikula    STATE_INLINE        => 5, # gathering documentation outside main block
39148af606aSJani Nikula};
3921da177e4SLinus Torvaldsmy $state;
393850622dfSRandy Dunlapmy $in_doc_sect;
3941da177e4SLinus Torvalds
39548af606aSJani Nikula# Inline documentation state
39648af606aSJani Nikulause constant {
39748af606aSJani Nikula    STATE_INLINE_NA     => 0, # not applicable ($state != STATE_INLINE)
39848af606aSJani Nikula    STATE_INLINE_NAME   => 1, # looking for member name (@foo:)
39948af606aSJani Nikula    STATE_INLINE_TEXT   => 2, # looking for member documentation
40048af606aSJani Nikula    STATE_INLINE_END    => 3, # done
40148af606aSJani Nikula    STATE_INLINE_ERROR  => 4, # error - Comment without header was found.
40248af606aSJani Nikula                              # Spit a warning as it's not
403a4c6ebedSDanilo Cesar Lemes de Paula                              # proper kernel-doc and ignore the rest.
40448af606aSJani Nikula};
40548af606aSJani Nikulamy $inline_doc_state;
406a4c6ebedSDanilo Cesar Lemes de Paula
4071da177e4SLinus Torvalds#declaration types: can be
4081da177e4SLinus Torvalds# 'function', 'struct', 'union', 'enum', 'typedef'
4091da177e4SLinus Torvaldsmy $decl_type;
4101da177e4SLinus Torvalds
4111da177e4SLinus Torvaldsmy $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
4121da177e4SLinus Torvaldsmy $doc_end = '\*/';
4131da177e4SLinus Torvaldsmy $doc_com = '\s*\*\s*';
41412ae6779SDaniel Santosmy $doc_com_body = '\s*\* ?';
4151da177e4SLinus Torvaldsmy $doc_decl = $doc_com . '(\w+)';
416f624adefSJani Nikula# @params and a strictly limited set of supported section names
4178569de68SJonathan Corbetmy $doc_sect = $doc_com .
418ef00028bSJonathan Corbet    '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:(.*)';
41912ae6779SDaniel Santosmy $doc_content = $doc_com_body . '(.*)';
4201da177e4SLinus Torvaldsmy $doc_block = $doc_com . 'DOC:\s*(.*)?';
42148af606aSJani Nikulamy $doc_inline_start = '^\s*/\*\*\s*$';
42248af606aSJani Nikulamy $doc_inline_sect = '\s*\*\s*(@[\w\s]+):(.*)';
42348af606aSJani Nikulamy $doc_inline_end = '^\s*\*/\s*$';
4240c9aa209SJani Nikulamy $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$';
42586ae2e38SJani Nikulamy $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';
4261da177e4SLinus Torvalds
4271da177e4SLinus Torvaldsmy %parameterdescs;
4280b0f5f29SDaniel Vettermy %parameterdesc_start_lines;
4291da177e4SLinus Torvaldsmy @parameterlist;
4301da177e4SLinus Torvaldsmy %sections;
4311da177e4SLinus Torvaldsmy @sectionlist;
4320b0f5f29SDaniel Vettermy %section_start_lines;
433a1d94aa5SRandy Dunlapmy $sectcheck;
434a1d94aa5SRandy Dunlapmy $struct_actual;
4351da177e4SLinus Torvalds
4361da177e4SLinus Torvaldsmy $contents = "";
4370b0f5f29SDaniel Vettermy $new_start_line = 0;
438f624adefSJani Nikula
439f624adefSJani Nikula# the canonical section names. see also $doc_sect above.
4401da177e4SLinus Torvaldsmy $section_default = "Description";	# default section
4411da177e4SLinus Torvaldsmy $section_intro = "Introduction";
4421da177e4SLinus Torvaldsmy $section = $section_default;
4431da177e4SLinus Torvaldsmy $section_context = "Context";
4444092bac7SYacine Belkadimy $section_return = "Return";
4451da177e4SLinus Torvalds
4461da177e4SLinus Torvaldsmy $undescribed = "-- undescribed --";
4471da177e4SLinus Torvalds
4481da177e4SLinus Torvaldsreset_state();
4491da177e4SLinus Torvalds
4501da177e4SLinus Torvaldswhile ($ARGV[0] =~ m/^-(.*)/) {
4511da177e4SLinus Torvalds    my $cmd = shift @ARGV;
4521da177e4SLinus Torvalds    if ($cmd eq "-html") {
4531da177e4SLinus Torvalds	$output_mode = "html";
4544d732701SDanilo Cesar Lemes de Paula	@highlights = @highlights_html;
4551da177e4SLinus Torvalds	$blankline = $blankline_html;
4561b40c194SDan Luedtke    } elsif ($cmd eq "-html5") {
4571b40c194SDan Luedtke	$output_mode = "html5";
4584d732701SDanilo Cesar Lemes de Paula	@highlights = @highlights_html5;
4591b40c194SDan Luedtke	$blankline = $blankline_html5;
4601da177e4SLinus Torvalds    } elsif ($cmd eq "-man") {
4611da177e4SLinus Torvalds	$output_mode = "man";
4624d732701SDanilo Cesar Lemes de Paula	@highlights = @highlights_man;
4631da177e4SLinus Torvalds	$blankline = $blankline_man;
4641da177e4SLinus Torvalds    } elsif ($cmd eq "-text") {
4651da177e4SLinus Torvalds	$output_mode = "text";
4664d732701SDanilo Cesar Lemes de Paula	@highlights = @highlights_text;
4671da177e4SLinus Torvalds	$blankline = $blankline_text;
468c0d1b6eeSJonathan Corbet    } elsif ($cmd eq "-rst") {
469c0d1b6eeSJonathan Corbet	$output_mode = "rst";
470c0d1b6eeSJonathan Corbet	@highlights = @highlights_rst;
471c0d1b6eeSJonathan Corbet	$blankline = $blankline_rst;
4721da177e4SLinus Torvalds    } elsif ($cmd eq "-docbook") {
4731da177e4SLinus Torvalds	$output_mode = "xml";
4744d732701SDanilo Cesar Lemes de Paula	@highlights = @highlights_xml;
4751da177e4SLinus Torvalds	$blankline = $blankline_xml;
476eda603f6SJohannes Berg    } elsif ($cmd eq "-list") {
477eda603f6SJohannes Berg	$output_mode = "list";
4784d732701SDanilo Cesar Lemes de Paula	@highlights = @highlights_list;
479eda603f6SJohannes Berg	$blankline = $blankline_list;
4801da177e4SLinus Torvalds    } elsif ($cmd eq "-gnome") {
4811da177e4SLinus Torvalds	$output_mode = "gnome";
4824d732701SDanilo Cesar Lemes de Paula	@highlights = @highlights_gnome;
4831da177e4SLinus Torvalds	$blankline = $blankline_gnome;
4841da177e4SLinus Torvalds    } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document
4851da177e4SLinus Torvalds	$modulename = shift @ARGV;
4861da177e4SLinus Torvalds    } elsif ($cmd eq "-function") { # to only output specific functions
487b6c3f456SJani Nikula	$output_selection = OUTPUT_INCLUDE;
4881da177e4SLinus Torvalds	$function = shift @ARGV;
4891da177e4SLinus Torvalds	$function_table{$function} = 1;
490b6c3f456SJani Nikula    } elsif ($cmd eq "-nofunction") { # output all except specific functions
491b6c3f456SJani Nikula	$output_selection = OUTPUT_EXCLUDE;
4921da177e4SLinus Torvalds	$function = shift @ARGV;
4931da177e4SLinus Torvalds	$function_table{$function} = 1;
49486ae2e38SJani Nikula    } elsif ($cmd eq "-export") { # only exported symbols
495b6c3f456SJani Nikula	$output_selection = OUTPUT_EXPORTED;
496da9726ecSJani Nikula	%function_table = ();
49786ae2e38SJani Nikula    } elsif ($cmd eq "-internal") { # only non-exported symbols
498b6c3f456SJani Nikula	$output_selection = OUTPUT_INTERNAL;
499da9726ecSJani Nikula	%function_table = ();
50088c2b57dSJani Nikula    } elsif ($cmd eq "-export-file") {
50188c2b57dSJani Nikula	my $file = shift @ARGV;
50288c2b57dSJani Nikula	push(@export_file_list, $file);
5031da177e4SLinus Torvalds    } elsif ($cmd eq "-v") {
5041da177e4SLinus Torvalds	$verbose = 1;
5051da177e4SLinus Torvalds    } elsif (($cmd eq "-h") || ($cmd eq "--help")) {
5061da177e4SLinus Torvalds	usage();
5074b44595aSJohannes Berg    } elsif ($cmd eq '-no-doc-sections') {
5084b44595aSJohannes Berg	    $no_doc_sections = 1;
5090b0f5f29SDaniel Vetter    } elsif ($cmd eq '-enable-lineno') {
5100b0f5f29SDaniel Vetter	    $enable_lineno = 1;
511e946c43aSJohannes Berg    } elsif ($cmd eq '-show-not-found') {
512e946c43aSJohannes Berg	$show_not_found = 1;
5131da177e4SLinus Torvalds    }
5141da177e4SLinus Torvalds}
5151da177e4SLinus Torvalds
5168484baaaSRandy Dunlap# continue execution near EOF;
5178484baaaSRandy Dunlap
51853f049faSBorislav Petkov# get kernel version from env
51953f049faSBorislav Petkovsub get_kernel_version() {
5201b9bc22dSJohannes Berg    my $version = 'unknown kernel version';
52153f049faSBorislav Petkov
52253f049faSBorislav Petkov    if (defined($ENV{'KERNELVERSION'})) {
52353f049faSBorislav Petkov	$version = $ENV{'KERNELVERSION'};
52453f049faSBorislav Petkov    }
52553f049faSBorislav Petkov    return $version;
52653f049faSBorislav Petkov}
5271da177e4SLinus Torvalds
5280b0f5f29SDaniel Vetter#
5290b0f5f29SDaniel Vettersub print_lineno {
5300b0f5f29SDaniel Vetter    my $lineno = shift;
5310b0f5f29SDaniel Vetter    if ($enable_lineno && defined($lineno)) {
5320b0f5f29SDaniel Vetter        print "#define LINENO " . $lineno . "\n";
5330b0f5f29SDaniel Vetter    }
5340b0f5f29SDaniel Vetter}
5351da177e4SLinus Torvalds##
5361da177e4SLinus Torvalds# dumps section contents to arrays/hashes intended for that purpose.
5371da177e4SLinus Torvalds#
5381da177e4SLinus Torvaldssub dump_section {
53994dc7ad5SRandy Dunlap    my $file = shift;
5401da177e4SLinus Torvalds    my $name = shift;
5411da177e4SLinus Torvalds    my $contents = join "\n", @_;
5421da177e4SLinus Torvalds
54313901ef2SJani Nikula    if ($name =~ m/$type_param/) {
5441da177e4SLinus Torvalds	$name = $1;
5451da177e4SLinus Torvalds	$parameterdescs{$name} = $contents;
546a1d94aa5SRandy Dunlap	$sectcheck = $sectcheck . $name . " ";
5470b0f5f29SDaniel Vetter        $parameterdesc_start_lines{$name} = $new_start_line;
5480b0f5f29SDaniel Vetter        $new_start_line = 0;
549ced69090SRandy Dunlap    } elsif ($name eq "@\.\.\.") {
550ced69090SRandy Dunlap	$name = "...";
551ced69090SRandy Dunlap	$parameterdescs{$name} = $contents;
552a1d94aa5SRandy Dunlap	$sectcheck = $sectcheck . $name . " ";
5530b0f5f29SDaniel Vetter        $parameterdesc_start_lines{$name} = $new_start_line;
5540b0f5f29SDaniel Vetter        $new_start_line = 0;
5551da177e4SLinus Torvalds    } else {
55694dc7ad5SRandy Dunlap	if (defined($sections{$name}) && ($sections{$name} ne "")) {
55795b6be9dSJani Nikula	    # Only warn on user specified duplicate section names.
55895b6be9dSJani Nikula	    if ($name ne $section_default) {
55932217761SJani Nikula		print STDERR "${file}:$.: warning: duplicate section name '$name'\n";
56032217761SJani Nikula		++$warnings;
56195b6be9dSJani Nikula	    }
56232217761SJani Nikula	    $sections{$name} .= $contents;
56332217761SJani Nikula	} else {
5641da177e4SLinus Torvalds	    $sections{$name} = $contents;
5651da177e4SLinus Torvalds	    push @sectionlist, $name;
5660b0f5f29SDaniel Vetter            $section_start_lines{$name} = $new_start_line;
5670b0f5f29SDaniel Vetter            $new_start_line = 0;
5681da177e4SLinus Torvalds	}
5691da177e4SLinus Torvalds    }
57032217761SJani Nikula}
5711da177e4SLinus Torvalds
5721da177e4SLinus Torvalds##
573b112e0f7SJohannes Berg# dump DOC: section after checking that it should go out
574b112e0f7SJohannes Berg#
575b112e0f7SJohannes Bergsub dump_doc_section {
57694dc7ad5SRandy Dunlap    my $file = shift;
577b112e0f7SJohannes Berg    my $name = shift;
578b112e0f7SJohannes Berg    my $contents = join "\n", @_;
579b112e0f7SJohannes Berg
5804b44595aSJohannes Berg    if ($no_doc_sections) {
5814b44595aSJohannes Berg        return;
5824b44595aSJohannes Berg    }
5834b44595aSJohannes Berg
584b6c3f456SJani Nikula    if (($output_selection == OUTPUT_ALL) ||
585b6c3f456SJani Nikula	($output_selection == OUTPUT_INCLUDE &&
586b6c3f456SJani Nikula	 defined($function_table{$name})) ||
587b6c3f456SJani Nikula	($output_selection == OUTPUT_EXCLUDE &&
588b6c3f456SJani Nikula	 !defined($function_table{$name})))
589b112e0f7SJohannes Berg    {
59094dc7ad5SRandy Dunlap	dump_section($file, $name, $contents);
591b112e0f7SJohannes Berg	output_blockhead({'sectionlist' => \@sectionlist,
592b112e0f7SJohannes Berg			  'sections' => \%sections,
593b112e0f7SJohannes Berg			  'module' => $modulename,
594b6c3f456SJani Nikula			  'content-only' => ($output_selection != OUTPUT_ALL), });
595b112e0f7SJohannes Berg    }
596b112e0f7SJohannes Berg}
597b112e0f7SJohannes Berg
598b112e0f7SJohannes Berg##
5991da177e4SLinus Torvalds# output function
6001da177e4SLinus Torvalds#
6011da177e4SLinus Torvalds# parameterdescs, a hash.
6021da177e4SLinus Torvalds#  function => "function name"
6031da177e4SLinus Torvalds#  parameterlist => @list of parameters
6041da177e4SLinus Torvalds#  parameterdescs => %parameter descriptions
6051da177e4SLinus Torvalds#  sectionlist => @list of sections
606a21217daSRandy Dunlap#  sections => %section descriptions
6071da177e4SLinus Torvalds#
6081da177e4SLinus Torvalds
6091da177e4SLinus Torvaldssub output_highlight {
6101da177e4SLinus Torvalds    my $contents = join "\n",@_;
6111da177e4SLinus Torvalds    my $line;
6121da177e4SLinus Torvalds
6131da177e4SLinus Torvalds#   DEBUG
6141da177e4SLinus Torvalds#   if (!defined $contents) {
6151da177e4SLinus Torvalds#	use Carp;
6161da177e4SLinus Torvalds#	confess "output_highlight got called with no args?\n";
6171da177e4SLinus Torvalds#   }
6181da177e4SLinus Torvalds
6191b40c194SDan Luedtke    if ($output_mode eq "html" || $output_mode eq "html5" ||
6201b40c194SDan Luedtke	$output_mode eq "xml") {
6216b5b55f6SRandy Dunlap	$contents = local_unescape($contents);
6226b5b55f6SRandy Dunlap	# convert data read & converted thru xml_escape() into &xyz; format:
6232b35f4d9SRandy Dunlap	$contents =~ s/\\\\\\/\&/g;
6246b5b55f6SRandy Dunlap    }
6253eb014a1SRandy Dunlap#   print STDERR "contents b4:$contents\n";
6261da177e4SLinus Torvalds    eval $dohighlight;
6271da177e4SLinus Torvalds    die $@ if $@;
6283eb014a1SRandy Dunlap#   print STDERR "contents af:$contents\n";
6293eb014a1SRandy Dunlap
6301b40c194SDan Luedtke#   strip whitespaces when generating html5
6311b40c194SDan Luedtke    if ($output_mode eq "html5") {
6321b40c194SDan Luedtke	$contents =~ s/^\s+//;
6331b40c194SDan Luedtke	$contents =~ s/\s+$//;
6341b40c194SDan Luedtke    }
6351da177e4SLinus Torvalds    foreach $line (split "\n", $contents) {
63612ae6779SDaniel Santos	if (! $output_preformatted) {
63712ae6779SDaniel Santos	    $line =~ s/^\s*//;
63812ae6779SDaniel Santos	}
6391da177e4SLinus Torvalds	if ($line eq ""){
640e314ba31SDaniel Santos	    if (! $output_preformatted) {
6416b5b55f6SRandy Dunlap		print $lineprefix, local_unescape($blankline);
642e314ba31SDaniel Santos	    }
6431da177e4SLinus Torvalds	} else {
6441da177e4SLinus Torvalds	    $line =~ s/\\\\\\/\&/g;
645cdccb316SRandy Dunlap	    if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
646cdccb316SRandy Dunlap		print "\\&$line";
647cdccb316SRandy Dunlap	    } else {
6481da177e4SLinus Torvalds		print $lineprefix, $line;
6491da177e4SLinus Torvalds	    }
650cdccb316SRandy Dunlap	}
6511da177e4SLinus Torvalds	print "\n";
6521da177e4SLinus Torvalds    }
6531da177e4SLinus Torvalds}
6541da177e4SLinus Torvalds
6551da177e4SLinus Torvalds# output sections in html
6561da177e4SLinus Torvaldssub output_section_html(%) {
6571da177e4SLinus Torvalds    my %args = %{$_[0]};
6581da177e4SLinus Torvalds    my $section;
6591da177e4SLinus Torvalds
6601da177e4SLinus Torvalds    foreach $section (@{$args{'sectionlist'}}) {
6611da177e4SLinus Torvalds	print "<h3>$section</h3>\n";
6621da177e4SLinus Torvalds	print "<blockquote>\n";
6631da177e4SLinus Torvalds	output_highlight($args{'sections'}{$section});
6641da177e4SLinus Torvalds	print "</blockquote>\n";
6651da177e4SLinus Torvalds    }
6661da177e4SLinus Torvalds}
6671da177e4SLinus Torvalds
6681da177e4SLinus Torvalds# output enum in html
6691da177e4SLinus Torvaldssub output_enum_html(%) {
6701da177e4SLinus Torvalds    my %args = %{$_[0]};
6711da177e4SLinus Torvalds    my ($parameter);
6721da177e4SLinus Torvalds    my $count;
6731da177e4SLinus Torvalds    print "<h2>enum " . $args{'enum'} . "</h2>\n";
6741da177e4SLinus Torvalds
6751da177e4SLinus Torvalds    print "<b>enum " . $args{'enum'} . "</b> {<br>\n";
6761da177e4SLinus Torvalds    $count = 0;
6771da177e4SLinus Torvalds    foreach $parameter (@{$args{'parameterlist'}}) {
6781da177e4SLinus Torvalds	print " <b>" . $parameter . "</b>";
6791da177e4SLinus Torvalds	if ($count != $#{$args{'parameterlist'}}) {
6801da177e4SLinus Torvalds	    $count++;
6811da177e4SLinus Torvalds	    print ",\n";
6821da177e4SLinus Torvalds	}
6831da177e4SLinus Torvalds	print "<br>";
6841da177e4SLinus Torvalds    }
6851da177e4SLinus Torvalds    print "};<br>\n";
6861da177e4SLinus Torvalds
6871da177e4SLinus Torvalds    print "<h3>Constants</h3>\n";
6881da177e4SLinus Torvalds    print "<dl>\n";
6891da177e4SLinus Torvalds    foreach $parameter (@{$args{'parameterlist'}}) {
6901da177e4SLinus Torvalds	print "<dt><b>" . $parameter . "</b>\n";
6911da177e4SLinus Torvalds	print "<dd>";
6921da177e4SLinus Torvalds	output_highlight($args{'parameterdescs'}{$parameter});
6931da177e4SLinus Torvalds    }
6941da177e4SLinus Torvalds    print "</dl>\n";
6951da177e4SLinus Torvalds    output_section_html(@_);
6961da177e4SLinus Torvalds    print "<hr>\n";
6971da177e4SLinus Torvalds}
6981da177e4SLinus Torvalds
699d28bee0cSRandy Dunlap# output typedef in html
7001da177e4SLinus Torvaldssub output_typedef_html(%) {
7011da177e4SLinus Torvalds    my %args = %{$_[0]};
7021da177e4SLinus Torvalds    my ($parameter);
7031da177e4SLinus Torvalds    my $count;
7041da177e4SLinus Torvalds    print "<h2>typedef " . $args{'typedef'} . "</h2>\n";
7051da177e4SLinus Torvalds
7061da177e4SLinus Torvalds    print "<b>typedef " . $args{'typedef'} . "</b>\n";
7071da177e4SLinus Torvalds    output_section_html(@_);
7081da177e4SLinus Torvalds    print "<hr>\n";
7091da177e4SLinus Torvalds}
7101da177e4SLinus Torvalds
7111da177e4SLinus Torvalds# output struct in html
7121da177e4SLinus Torvaldssub output_struct_html(%) {
7131da177e4SLinus Torvalds    my %args = %{$_[0]};
7141da177e4SLinus Torvalds    my ($parameter);
7151da177e4SLinus Torvalds
716262d9b01SRandy Dunlap    print "<h2>" . $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "</h2>\n";
7171da177e4SLinus Torvalds    print "<b>" . $args{'type'} . " " . $args{'struct'} . "</b> {<br>\n";
7181da177e4SLinus Torvalds    foreach $parameter (@{$args{'parameterlist'}}) {
7191da177e4SLinus Torvalds	if ($parameter =~ /^#/) {
7201da177e4SLinus Torvalds		print "$parameter<br>\n";
7211da177e4SLinus Torvalds		next;
7221da177e4SLinus Torvalds	}
7231da177e4SLinus Torvalds	my $parameter_name = $parameter;
7241da177e4SLinus Torvalds	$parameter_name =~ s/\[.*//;
7251da177e4SLinus Torvalds
7261da177e4SLinus Torvalds	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
7271da177e4SLinus Torvalds	$type = $args{'parametertypes'}{$parameter};
7281da177e4SLinus Torvalds	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
7291da177e4SLinus Torvalds	    # pointer-to-function
7303eb014a1SRandy Dunlap	    print "&nbsp; &nbsp; <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>\n";
7311da177e4SLinus Torvalds	} elsif ($type =~ m/^(.*?)\s*(:.*)/) {
7323eb014a1SRandy Dunlap	    # bitfield
7333eb014a1SRandy Dunlap	    print "&nbsp; &nbsp; <i>$1</i> <b>$parameter</b>$2;<br>\n";
7341da177e4SLinus Torvalds	} else {
7353eb014a1SRandy Dunlap	    print "&nbsp; &nbsp; <i>$type</i> <b>$parameter</b>;<br>\n";
7361da177e4SLinus Torvalds	}
7371da177e4SLinus Torvalds    }
7381da177e4SLinus Torvalds    print "};<br>\n";
7391da177e4SLinus Torvalds
7401da177e4SLinus Torvalds    print "<h3>Members</h3>\n";
7411da177e4SLinus Torvalds    print "<dl>\n";
7421da177e4SLinus Torvalds    foreach $parameter (@{$args{'parameterlist'}}) {
7431da177e4SLinus Torvalds	($parameter =~ /^#/) && next;
7441da177e4SLinus Torvalds
7451da177e4SLinus Torvalds	my $parameter_name = $parameter;
7461da177e4SLinus Torvalds	$parameter_name =~ s/\[.*//;
7471da177e4SLinus Torvalds
7481da177e4SLinus Torvalds	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
7491da177e4SLinus Torvalds	print "<dt><b>" . $parameter . "</b>\n";
7501da177e4SLinus Torvalds	print "<dd>";
7511da177e4SLinus Torvalds	output_highlight($args{'parameterdescs'}{$parameter_name});
7521da177e4SLinus Torvalds    }
7531da177e4SLinus Torvalds    print "</dl>\n";
7541da177e4SLinus Torvalds    output_section_html(@_);
7551da177e4SLinus Torvalds    print "<hr>\n";
7561da177e4SLinus Torvalds}
7571da177e4SLinus Torvalds
7581da177e4SLinus Torvalds# output function in html
7591da177e4SLinus Torvaldssub output_function_html(%) {
7601da177e4SLinus Torvalds    my %args = %{$_[0]};
7611da177e4SLinus Torvalds    my ($parameter, $section);
7621da177e4SLinus Torvalds    my $count;
7631da177e4SLinus Torvalds
764262d9b01SRandy Dunlap    print "<h2>" . $args{'function'} . " - " . $args{'purpose'} . "</h2>\n";
7651da177e4SLinus Torvalds    print "<i>" . $args{'functiontype'} . "</i>\n";
7661da177e4SLinus Torvalds    print "<b>" . $args{'function'} . "</b>\n";
7671da177e4SLinus Torvalds    print "(";
7681da177e4SLinus Torvalds    $count = 0;
7691da177e4SLinus Torvalds    foreach $parameter (@{$args{'parameterlist'}}) {
7701da177e4SLinus Torvalds	$type = $args{'parametertypes'}{$parameter};
7711da177e4SLinus Torvalds	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
7721da177e4SLinus Torvalds	    # pointer-to-function
7731da177e4SLinus Torvalds	    print "<i>$1</i><b>$parameter</b>) <i>($2)</i>";
7741da177e4SLinus Torvalds	} else {
7751da177e4SLinus Torvalds	    print "<i>" . $type . "</i> <b>" . $parameter . "</b>";
7761da177e4SLinus Torvalds	}
7771da177e4SLinus Torvalds	if ($count != $#{$args{'parameterlist'}}) {
7781da177e4SLinus Torvalds	    $count++;
7791da177e4SLinus Torvalds	    print ",\n";
7801da177e4SLinus Torvalds	}
7811da177e4SLinus Torvalds    }
7821da177e4SLinus Torvalds    print ")\n";
7831da177e4SLinus Torvalds
7841da177e4SLinus Torvalds    print "<h3>Arguments</h3>\n";
7851da177e4SLinus Torvalds    print "<dl>\n";
7861da177e4SLinus Torvalds    foreach $parameter (@{$args{'parameterlist'}}) {
7871da177e4SLinus Torvalds	my $parameter_name = $parameter;
7881da177e4SLinus Torvalds	$parameter_name =~ s/\[.*//;
7891da177e4SLinus Torvalds
7901da177e4SLinus Torvalds	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
7911da177e4SLinus Torvalds	print "<dt><b>" . $parameter . "</b>\n";
7921da177e4SLinus Torvalds	print "<dd>";
7931da177e4SLinus Torvalds	output_highlight($args{'parameterdescs'}{$parameter_name});
7941da177e4SLinus Torvalds    }
7951da177e4SLinus Torvalds    print "</dl>\n";
7961da177e4SLinus Torvalds    output_section_html(@_);
7971da177e4SLinus Torvalds    print "<hr>\n";
7981da177e4SLinus Torvalds}
7991da177e4SLinus Torvalds
800b112e0f7SJohannes Berg# output DOC: block header in html
801b112e0f7SJohannes Bergsub output_blockhead_html(%) {
8021da177e4SLinus Torvalds    my %args = %{$_[0]};
8031da177e4SLinus Torvalds    my ($parameter, $section);
8041da177e4SLinus Torvalds    my $count;
8051da177e4SLinus Torvalds
8061da177e4SLinus Torvalds    foreach $section (@{$args{'sectionlist'}}) {
8071da177e4SLinus Torvalds	print "<h3>$section</h3>\n";
8081da177e4SLinus Torvalds	print "<ul>\n";
8091da177e4SLinus Torvalds	output_highlight($args{'sections'}{$section});
8101da177e4SLinus Torvalds	print "</ul>\n";
8111da177e4SLinus Torvalds    }
8121da177e4SLinus Torvalds    print "<hr>\n";
8131da177e4SLinus Torvalds}
8141da177e4SLinus Torvalds
8151b40c194SDan Luedtke# output sections in html5
8161b40c194SDan Luedtkesub output_section_html5(%) {
8171b40c194SDan Luedtke    my %args = %{$_[0]};
8181b40c194SDan Luedtke    my $section;
8191b40c194SDan Luedtke
8201b40c194SDan Luedtke    foreach $section (@{$args{'sectionlist'}}) {
8211b40c194SDan Luedtke	print "<section>\n";
8221b40c194SDan Luedtke	print "<h1>$section</h1>\n";
8231b40c194SDan Luedtke	print "<p>\n";
8241b40c194SDan Luedtke	output_highlight($args{'sections'}{$section});
8251b40c194SDan Luedtke	print "</p>\n";
8261b40c194SDan Luedtke	print "</section>\n";
8271b40c194SDan Luedtke    }
8281b40c194SDan Luedtke}
8291b40c194SDan Luedtke
8301b40c194SDan Luedtke# output enum in html5
8311b40c194SDan Luedtkesub output_enum_html5(%) {
8321b40c194SDan Luedtke    my %args = %{$_[0]};
8331b40c194SDan Luedtke    my ($parameter);
8341b40c194SDan Luedtke    my $count;
8351b40c194SDan Luedtke    my $html5id;
8361b40c194SDan Luedtke
8371b40c194SDan Luedtke    $html5id = $args{'enum'};
8381b40c194SDan Luedtke    $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
8391b40c194SDan Luedtke    print "<article class=\"enum\" id=\"enum:". $html5id . "\">";
8401b40c194SDan Luedtke    print "<h1>enum " . $args{'enum'} . "</h1>\n";
8411b40c194SDan Luedtke    print "<ol class=\"code\">\n";
8421b40c194SDan Luedtke    print "<li>";
8431b40c194SDan Luedtke    print "<span class=\"keyword\">enum</span> ";
8441b40c194SDan Luedtke    print "<span class=\"identifier\">" . $args{'enum'} . "</span> {";
8451b40c194SDan Luedtke    print "</li>\n";
8461b40c194SDan Luedtke    $count = 0;
8471b40c194SDan Luedtke    foreach $parameter (@{$args{'parameterlist'}}) {
8481b40c194SDan Luedtke	print "<li class=\"indent\">";
8491b40c194SDan Luedtke	print "<span class=\"param\">" . $parameter . "</span>";
8501b40c194SDan Luedtke	if ($count != $#{$args{'parameterlist'}}) {
8511b40c194SDan Luedtke	    $count++;
8521b40c194SDan Luedtke	    print ",";
8531b40c194SDan Luedtke	}
8541b40c194SDan Luedtke	print "</li>\n";
8551b40c194SDan Luedtke    }
8561b40c194SDan Luedtke    print "<li>};</li>\n";
8571b40c194SDan Luedtke    print "</ol>\n";
8581b40c194SDan Luedtke
8591b40c194SDan Luedtke    print "<section>\n";
8601b40c194SDan Luedtke    print "<h1>Constants</h1>\n";
8611b40c194SDan Luedtke    print "<dl>\n";
8621b40c194SDan Luedtke    foreach $parameter (@{$args{'parameterlist'}}) {
8631b40c194SDan Luedtke	print "<dt>" . $parameter . "</dt>\n";
8641b40c194SDan Luedtke	print "<dd>";
8651b40c194SDan Luedtke	output_highlight($args{'parameterdescs'}{$parameter});
8661b40c194SDan Luedtke	print "</dd>\n";
8671b40c194SDan Luedtke    }
8681b40c194SDan Luedtke    print "</dl>\n";
8691b40c194SDan Luedtke    print "</section>\n";
8701b40c194SDan Luedtke    output_section_html5(@_);
8711b40c194SDan Luedtke    print "</article>\n";
8721b40c194SDan Luedtke}
8731b40c194SDan Luedtke
8741b40c194SDan Luedtke# output typedef in html5
8751b40c194SDan Luedtkesub output_typedef_html5(%) {
8761b40c194SDan Luedtke    my %args = %{$_[0]};
8771b40c194SDan Luedtke    my ($parameter);
8781b40c194SDan Luedtke    my $count;
8791b40c194SDan Luedtke    my $html5id;
8801b40c194SDan Luedtke
8811b40c194SDan Luedtke    $html5id = $args{'typedef'};
8821b40c194SDan Luedtke    $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
8831b40c194SDan Luedtke    print "<article class=\"typedef\" id=\"typedef:" . $html5id . "\">\n";
8841b40c194SDan Luedtke    print "<h1>typedef " . $args{'typedef'} . "</h1>\n";
8851b40c194SDan Luedtke
8861b40c194SDan Luedtke    print "<ol class=\"code\">\n";
8871b40c194SDan Luedtke    print "<li>";
8881b40c194SDan Luedtke    print "<span class=\"keyword\">typedef</span> ";
8891b40c194SDan Luedtke    print "<span class=\"identifier\">" . $args{'typedef'} . "</span>";
8901b40c194SDan Luedtke    print "</li>\n";
8911b40c194SDan Luedtke    print "</ol>\n";
8921b40c194SDan Luedtke    output_section_html5(@_);
8931b40c194SDan Luedtke    print "</article>\n";
8941b40c194SDan Luedtke}
8951b40c194SDan Luedtke
8961b40c194SDan Luedtke# output struct in html5
8971b40c194SDan Luedtkesub output_struct_html5(%) {
8981b40c194SDan Luedtke    my %args = %{$_[0]};
8991b40c194SDan Luedtke    my ($parameter);
9001b40c194SDan Luedtke    my $html5id;
9011b40c194SDan Luedtke
9021b40c194SDan Luedtke    $html5id = $args{'struct'};
9031b40c194SDan Luedtke    $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
9041b40c194SDan Luedtke    print "<article class=\"struct\" id=\"struct:" . $html5id . "\">\n";
9051b40c194SDan Luedtke    print "<hgroup>\n";
9061b40c194SDan Luedtke    print "<h1>" . $args{'type'} . " " . $args{'struct'} . "</h1>";
9071b40c194SDan Luedtke    print "<h2>". $args{'purpose'} . "</h2>\n";
9081b40c194SDan Luedtke    print "</hgroup>\n";
9091b40c194SDan Luedtke    print "<ol class=\"code\">\n";
9101b40c194SDan Luedtke    print "<li>";
9111b40c194SDan Luedtke    print "<span class=\"type\">" . $args{'type'} . "</span> ";
9121b40c194SDan Luedtke    print "<span class=\"identifier\">" . $args{'struct'} . "</span> {";
9131b40c194SDan Luedtke    print "</li>\n";
9141b40c194SDan Luedtke    foreach $parameter (@{$args{'parameterlist'}}) {
9151b40c194SDan Luedtke	print "<li class=\"indent\">";
9161b40c194SDan Luedtke	if ($parameter =~ /^#/) {
9171b40c194SDan Luedtke		print "<span class=\"param\">" . $parameter ."</span>\n";
9181b40c194SDan Luedtke		print "</li>\n";
9191b40c194SDan Luedtke		next;
9201b40c194SDan Luedtke	}
9211b40c194SDan Luedtke	my $parameter_name = $parameter;
9221b40c194SDan Luedtke	$parameter_name =~ s/\[.*//;
9231b40c194SDan Luedtke
9241b40c194SDan Luedtke	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
9251b40c194SDan Luedtke	$type = $args{'parametertypes'}{$parameter};
9261b40c194SDan Luedtke	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
9271b40c194SDan Luedtke	    # pointer-to-function
9281b40c194SDan Luedtke	    print "<span class=\"type\">$1</span> ";
9291b40c194SDan Luedtke	    print "<span class=\"param\">$parameter</span>";
9301b40c194SDan Luedtke	    print "<span class=\"type\">)</span> ";
9311b40c194SDan Luedtke	    print "(<span class=\"args\">$2</span>);";
9321b40c194SDan Luedtke	} elsif ($type =~ m/^(.*?)\s*(:.*)/) {
9331b40c194SDan Luedtke	    # bitfield
9341b40c194SDan Luedtke	    print "<span class=\"type\">$1</span> ";
9351b40c194SDan Luedtke	    print "<span class=\"param\">$parameter</span>";
9361b40c194SDan Luedtke	    print "<span class=\"bits\">$2</span>;";
9371b40c194SDan Luedtke	} else {
9381b40c194SDan Luedtke	    print "<span class=\"type\">$type</span> ";
9391b40c194SDan Luedtke	    print "<span class=\"param\">$parameter</span>;";
9401b40c194SDan Luedtke	}
9411b40c194SDan Luedtke	print "</li>\n";
9421b40c194SDan Luedtke    }
9431b40c194SDan Luedtke    print "<li>};</li>\n";
9441b40c194SDan Luedtke    print "</ol>\n";
9451b40c194SDan Luedtke
9461b40c194SDan Luedtke    print "<section>\n";
9471b40c194SDan Luedtke    print "<h1>Members</h1>\n";
9481b40c194SDan Luedtke    print "<dl>\n";
9491b40c194SDan Luedtke    foreach $parameter (@{$args{'parameterlist'}}) {
9501b40c194SDan Luedtke	($parameter =~ /^#/) && next;
9511b40c194SDan Luedtke
9521b40c194SDan Luedtke	my $parameter_name = $parameter;
9531b40c194SDan Luedtke	$parameter_name =~ s/\[.*//;
9541b40c194SDan Luedtke
9551b40c194SDan Luedtke	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
9561b40c194SDan Luedtke	print "<dt>" . $parameter . "</dt>\n";
9571b40c194SDan Luedtke	print "<dd>";
9581b40c194SDan Luedtke	output_highlight($args{'parameterdescs'}{$parameter_name});
9591b40c194SDan Luedtke	print "</dd>\n";
9601b40c194SDan Luedtke    }
9611b40c194SDan Luedtke    print "</dl>\n";
9621b40c194SDan Luedtke    print "</section>\n";
9631b40c194SDan Luedtke    output_section_html5(@_);
9641b40c194SDan Luedtke    print "</article>\n";
9651b40c194SDan Luedtke}
9661b40c194SDan Luedtke
9671b40c194SDan Luedtke# output function in html5
9681b40c194SDan Luedtkesub output_function_html5(%) {
9691b40c194SDan Luedtke    my %args = %{$_[0]};
9701b40c194SDan Luedtke    my ($parameter, $section);
9711b40c194SDan Luedtke    my $count;
9721b40c194SDan Luedtke    my $html5id;
9731b40c194SDan Luedtke
9741b40c194SDan Luedtke    $html5id = $args{'function'};
9751b40c194SDan Luedtke    $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
9761b40c194SDan Luedtke    print "<article class=\"function\" id=\"func:". $html5id . "\">\n";
9771b40c194SDan Luedtke    print "<hgroup>\n";
9781b40c194SDan Luedtke    print "<h1>" . $args{'function'} . "</h1>";
9791b40c194SDan Luedtke    print "<h2>" . $args{'purpose'} . "</h2>\n";
9801b40c194SDan Luedtke    print "</hgroup>\n";
9811b40c194SDan Luedtke    print "<ol class=\"code\">\n";
9821b40c194SDan Luedtke    print "<li>";
9831b40c194SDan Luedtke    print "<span class=\"type\">" . $args{'functiontype'} . "</span> ";
9841b40c194SDan Luedtke    print "<span class=\"identifier\">" . $args{'function'} . "</span> (";
9851b40c194SDan Luedtke    print "</li>";
9861b40c194SDan Luedtke    $count = 0;
9871b40c194SDan Luedtke    foreach $parameter (@{$args{'parameterlist'}}) {
9881b40c194SDan Luedtke	print "<li class=\"indent\">";
9891b40c194SDan Luedtke	$type = $args{'parametertypes'}{$parameter};
9901b40c194SDan Luedtke	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
9911b40c194SDan Luedtke	    # pointer-to-function
9921b40c194SDan Luedtke	    print "<span class=\"type\">$1</span> ";
9931b40c194SDan Luedtke	    print "<span class=\"param\">$parameter</span>";
9941b40c194SDan Luedtke	    print "<span class=\"type\">)</span> ";
9951b40c194SDan Luedtke	    print "(<span class=\"args\">$2</span>)";
9961b40c194SDan Luedtke	} else {
9971b40c194SDan Luedtke	    print "<span class=\"type\">$type</span> ";
9981b40c194SDan Luedtke	    print "<span class=\"param\">$parameter</span>";
9991b40c194SDan Luedtke	}
10001b40c194SDan Luedtke	if ($count != $#{$args{'parameterlist'}}) {
10011b40c194SDan Luedtke	    $count++;
10021b40c194SDan Luedtke	    print ",";
10031b40c194SDan Luedtke	}
10041b40c194SDan Luedtke	print "</li>\n";
10051b40c194SDan Luedtke    }
10061b40c194SDan Luedtke    print "<li>)</li>\n";
10071b40c194SDan Luedtke    print "</ol>\n";
10081b40c194SDan Luedtke
10091b40c194SDan Luedtke    print "<section>\n";
10101b40c194SDan Luedtke    print "<h1>Arguments</h1>\n";
10111b40c194SDan Luedtke    print "<p>\n";
10121b40c194SDan Luedtke    print "<dl>\n";
10131b40c194SDan Luedtke    foreach $parameter (@{$args{'parameterlist'}}) {
10141b40c194SDan Luedtke	my $parameter_name = $parameter;
10151b40c194SDan Luedtke	$parameter_name =~ s/\[.*//;
10161b40c194SDan Luedtke
10171b40c194SDan Luedtke	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
10181b40c194SDan Luedtke	print "<dt>" . $parameter . "</dt>\n";
10191b40c194SDan Luedtke	print "<dd>";
10201b40c194SDan Luedtke	output_highlight($args{'parameterdescs'}{$parameter_name});
10211b40c194SDan Luedtke	print "</dd>\n";
10221b40c194SDan Luedtke    }
10231b40c194SDan Luedtke    print "</dl>\n";
10241b40c194SDan Luedtke    print "</section>\n";
10251b40c194SDan Luedtke    output_section_html5(@_);
10261b40c194SDan Luedtke    print "</article>\n";
10271b40c194SDan Luedtke}
10281b40c194SDan Luedtke
10291b40c194SDan Luedtke# output DOC: block header in html5
10301b40c194SDan Luedtkesub output_blockhead_html5(%) {
10311b40c194SDan Luedtke    my %args = %{$_[0]};
10321b40c194SDan Luedtke    my ($parameter, $section);
10331b40c194SDan Luedtke    my $count;
10341b40c194SDan Luedtke    my $html5id;
10351b40c194SDan Luedtke
10361b40c194SDan Luedtke    foreach $section (@{$args{'sectionlist'}}) {
10371b40c194SDan Luedtke	$html5id = $section;
10381b40c194SDan Luedtke	$html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
10391b40c194SDan Luedtke	print "<article class=\"doc\" id=\"doc:". $html5id . "\">\n";
10401b40c194SDan Luedtke	print "<h1>$section</h1>\n";
10411b40c194SDan Luedtke	print "<p>\n";
10421b40c194SDan Luedtke	output_highlight($args{'sections'}{$section});
10431b40c194SDan Luedtke	print "</p>\n";
10441b40c194SDan Luedtke    }
10451b40c194SDan Luedtke    print "</article>\n";
10461b40c194SDan Luedtke}
10471b40c194SDan Luedtke
10481da177e4SLinus Torvaldssub output_section_xml(%) {
10491da177e4SLinus Torvalds    my %args = %{$_[0]};
10501da177e4SLinus Torvalds    my $section;
10511da177e4SLinus Torvalds    # print out each section
10521da177e4SLinus Torvalds    $lineprefix="   ";
10531da177e4SLinus Torvalds    foreach $section (@{$args{'sectionlist'}}) {
1054c73894c1SRich Walker	print "<refsect1>\n";
1055c73894c1SRich Walker	print "<title>$section</title>\n";
10561da177e4SLinus Torvalds	if ($section =~ m/EXAMPLE/i) {
1057c73894c1SRich Walker	    print "<informalexample><programlisting>\n";
1058e314ba31SDaniel Santos	    $output_preformatted = 1;
1059c73894c1SRich Walker	} else {
1060c73894c1SRich Walker	    print "<para>\n";
10611da177e4SLinus Torvalds	}
10621da177e4SLinus Torvalds	output_highlight($args{'sections'}{$section});
1063e314ba31SDaniel Santos	$output_preformatted = 0;
10641da177e4SLinus Torvalds	if ($section =~ m/EXAMPLE/i) {
1065c73894c1SRich Walker	    print "</programlisting></informalexample>\n";
1066c73894c1SRich Walker	} else {
1067c73894c1SRich Walker	    print "</para>\n";
10681da177e4SLinus Torvalds	}
1069c73894c1SRich Walker	print "</refsect1>\n";
10701da177e4SLinus Torvalds    }
10711da177e4SLinus Torvalds}
10721da177e4SLinus Torvalds
10731da177e4SLinus Torvalds# output function in XML DocBook
10741da177e4SLinus Torvaldssub output_function_xml(%) {
10751da177e4SLinus Torvalds    my %args = %{$_[0]};
10761da177e4SLinus Torvalds    my ($parameter, $section);
10771da177e4SLinus Torvalds    my $count;
10781da177e4SLinus Torvalds    my $id;
10791da177e4SLinus Torvalds
10801da177e4SLinus Torvalds    $id = "API-" . $args{'function'};
10811da177e4SLinus Torvalds    $id =~ s/[^A-Za-z0-9]/-/g;
10821da177e4SLinus Torvalds
10835449bc94SPavel Pisa    print "<refentry id=\"$id\">\n";
10848b0c2d98SMartin Waitz    print "<refentryinfo>\n";
10858b0c2d98SMartin Waitz    print " <title>LINUX</title>\n";
10868b0c2d98SMartin Waitz    print " <productname>Kernel Hackers Manual</productname>\n";
10878b0c2d98SMartin Waitz    print " <date>$man_date</date>\n";
10888b0c2d98SMartin Waitz    print "</refentryinfo>\n";
10891da177e4SLinus Torvalds    print "<refmeta>\n";
10905449bc94SPavel Pisa    print " <refentrytitle><phrase>" . $args{'function'} . "</phrase></refentrytitle>\n";
10918b0c2d98SMartin Waitz    print " <manvolnum>9</manvolnum>\n";
10920366299bSBorislav Petkov    print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
10931da177e4SLinus Torvalds    print "</refmeta>\n";
10941da177e4SLinus Torvalds    print "<refnamediv>\n";
10951da177e4SLinus Torvalds    print " <refname>" . $args{'function'} . "</refname>\n";
10961da177e4SLinus Torvalds    print " <refpurpose>\n";
10971da177e4SLinus Torvalds    print "  ";
10981da177e4SLinus Torvalds    output_highlight ($args{'purpose'});
10991da177e4SLinus Torvalds    print " </refpurpose>\n";
11001da177e4SLinus Torvalds    print "</refnamediv>\n";
11011da177e4SLinus Torvalds
11021da177e4SLinus Torvalds    print "<refsynopsisdiv>\n";
11031da177e4SLinus Torvalds    print " <title>Synopsis</title>\n";
11041da177e4SLinus Torvalds    print "  <funcsynopsis><funcprototype>\n";
11051da177e4SLinus Torvalds    print "   <funcdef>" . $args{'functiontype'} . " ";
11061da177e4SLinus Torvalds    print "<function>" . $args{'function'} . " </function></funcdef>\n";
11071da177e4SLinus Torvalds
11081da177e4SLinus Torvalds    $count = 0;
11091da177e4SLinus Torvalds    if ($#{$args{'parameterlist'}} >= 0) {
11101da177e4SLinus Torvalds	foreach $parameter (@{$args{'parameterlist'}}) {
11111da177e4SLinus Torvalds	    $type = $args{'parametertypes'}{$parameter};
11121da177e4SLinus Torvalds	    if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
11131da177e4SLinus Torvalds		# pointer-to-function
11141da177e4SLinus Torvalds		print "   <paramdef>$1<parameter>$parameter</parameter>)\n";
11151da177e4SLinus Torvalds		print "     <funcparams>$2</funcparams></paramdef>\n";
11161da177e4SLinus Torvalds	    } else {
11171da177e4SLinus Torvalds		print "   <paramdef>" . $type;
11181da177e4SLinus Torvalds		print " <parameter>$parameter</parameter></paramdef>\n";
11191da177e4SLinus Torvalds	    }
11201da177e4SLinus Torvalds	}
11211da177e4SLinus Torvalds    } else {
11226013d544SMartin Waitz	print "  <void/>\n";
11231da177e4SLinus Torvalds    }
11241da177e4SLinus Torvalds    print "  </funcprototype></funcsynopsis>\n";
11251da177e4SLinus Torvalds    print "</refsynopsisdiv>\n";
11261da177e4SLinus Torvalds
11271da177e4SLinus Torvalds    # print parameters
11281da177e4SLinus Torvalds    print "<refsect1>\n <title>Arguments</title>\n";
11291da177e4SLinus Torvalds    if ($#{$args{'parameterlist'}} >= 0) {
11301da177e4SLinus Torvalds	print " <variablelist>\n";
11311da177e4SLinus Torvalds	foreach $parameter (@{$args{'parameterlist'}}) {
11321da177e4SLinus Torvalds	    my $parameter_name = $parameter;
11331da177e4SLinus Torvalds	    $parameter_name =~ s/\[.*//;
1134fc6d7af8SPaolo Bonzini	    $type = $args{'parametertypes'}{$parameter};
11351da177e4SLinus Torvalds
1136fc6d7af8SPaolo Bonzini	    print "  <varlistentry>\n   <term><parameter>$type $parameter</parameter></term>\n";
11371da177e4SLinus Torvalds	    print "   <listitem>\n    <para>\n";
11381da177e4SLinus Torvalds	    $lineprefix="     ";
11391da177e4SLinus Torvalds	    output_highlight($args{'parameterdescs'}{$parameter_name});
11401da177e4SLinus Torvalds	    print "    </para>\n   </listitem>\n  </varlistentry>\n";
11411da177e4SLinus Torvalds	}
11421da177e4SLinus Torvalds	print " </variablelist>\n";
11431da177e4SLinus Torvalds    } else {
11441da177e4SLinus Torvalds	print " <para>\n  None\n </para>\n";
11451da177e4SLinus Torvalds    }
11461da177e4SLinus Torvalds    print "</refsect1>\n";
11471da177e4SLinus Torvalds
11481da177e4SLinus Torvalds    output_section_xml(@_);
11491da177e4SLinus Torvalds    print "</refentry>\n\n";
11501da177e4SLinus Torvalds}
11511da177e4SLinus Torvalds
11521da177e4SLinus Torvalds# output struct in XML DocBook
11531da177e4SLinus Torvaldssub output_struct_xml(%) {
11541da177e4SLinus Torvalds    my %args = %{$_[0]};
11551da177e4SLinus Torvalds    my ($parameter, $section);
11561da177e4SLinus Torvalds    my $id;
11571da177e4SLinus Torvalds
11581da177e4SLinus Torvalds    $id = "API-struct-" . $args{'struct'};
11591da177e4SLinus Torvalds    $id =~ s/[^A-Za-z0-9]/-/g;
11601da177e4SLinus Torvalds
11615449bc94SPavel Pisa    print "<refentry id=\"$id\">\n";
11628b0c2d98SMartin Waitz    print "<refentryinfo>\n";
11638b0c2d98SMartin Waitz    print " <title>LINUX</title>\n";
11648b0c2d98SMartin Waitz    print " <productname>Kernel Hackers Manual</productname>\n";
11658b0c2d98SMartin Waitz    print " <date>$man_date</date>\n";
11668b0c2d98SMartin Waitz    print "</refentryinfo>\n";
11671da177e4SLinus Torvalds    print "<refmeta>\n";
11685449bc94SPavel Pisa    print " <refentrytitle><phrase>" . $args{'type'} . " " . $args{'struct'} . "</phrase></refentrytitle>\n";
11698b0c2d98SMartin Waitz    print " <manvolnum>9</manvolnum>\n";
11700366299bSBorislav Petkov    print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
11711da177e4SLinus Torvalds    print "</refmeta>\n";
11721da177e4SLinus Torvalds    print "<refnamediv>\n";
11731da177e4SLinus Torvalds    print " <refname>" . $args{'type'} . " " . $args{'struct'} . "</refname>\n";
11741da177e4SLinus Torvalds    print " <refpurpose>\n";
11751da177e4SLinus Torvalds    print "  ";
11761da177e4SLinus Torvalds    output_highlight ($args{'purpose'});
11771da177e4SLinus Torvalds    print " </refpurpose>\n";
11781da177e4SLinus Torvalds    print "</refnamediv>\n";
11791da177e4SLinus Torvalds
11801da177e4SLinus Torvalds    print "<refsynopsisdiv>\n";
11811da177e4SLinus Torvalds    print " <title>Synopsis</title>\n";
11821da177e4SLinus Torvalds    print "  <programlisting>\n";
11831da177e4SLinus Torvalds    print $args{'type'} . " " . $args{'struct'} . " {\n";
11841da177e4SLinus Torvalds    foreach $parameter (@{$args{'parameterlist'}}) {
11851da177e4SLinus Torvalds	if ($parameter =~ /^#/) {
11862b35f4d9SRandy Dunlap	    my $prm = $parameter;
11872b35f4d9SRandy Dunlap	    # convert data read & converted thru xml_escape() into &xyz; format:
11882b35f4d9SRandy Dunlap	    # This allows us to have #define macros interspersed in a struct.
11892b35f4d9SRandy Dunlap	    $prm =~ s/\\\\\\/\&/g;
11902b35f4d9SRandy Dunlap	    print "$prm\n";
11911da177e4SLinus Torvalds	    next;
11921da177e4SLinus Torvalds	}
11931da177e4SLinus Torvalds
11941da177e4SLinus Torvalds	my $parameter_name = $parameter;
11951da177e4SLinus Torvalds	$parameter_name =~ s/\[.*//;
11961da177e4SLinus Torvalds
11971da177e4SLinus Torvalds	defined($args{'parameterdescs'}{$parameter_name}) || next;
11981da177e4SLinus Torvalds	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
11991da177e4SLinus Torvalds	$type = $args{'parametertypes'}{$parameter};
12001da177e4SLinus Torvalds	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
12011da177e4SLinus Torvalds	    # pointer-to-function
12021da177e4SLinus Torvalds	    print "  $1 $parameter) ($2);\n";
12031da177e4SLinus Torvalds	} elsif ($type =~ m/^(.*?)\s*(:.*)/) {
120451f5a0c8SRandy Dunlap	    # bitfield
12051da177e4SLinus Torvalds	    print "  $1 $parameter$2;\n";
12061da177e4SLinus Torvalds	} else {
12071da177e4SLinus Torvalds	    print "  " . $type . " " . $parameter . ";\n";
12081da177e4SLinus Torvalds	}
12091da177e4SLinus Torvalds    }
12101da177e4SLinus Torvalds    print "};";
12111da177e4SLinus Torvalds    print "  </programlisting>\n";
12121da177e4SLinus Torvalds    print "</refsynopsisdiv>\n";
12131da177e4SLinus Torvalds
12141da177e4SLinus Torvalds    print " <refsect1>\n";
12151da177e4SLinus Torvalds    print "  <title>Members</title>\n";
12161da177e4SLinus Torvalds
121739f00c08SRandy Dunlap    if ($#{$args{'parameterlist'}} >= 0) {
12181da177e4SLinus Torvalds    print "  <variablelist>\n";
12191da177e4SLinus Torvalds    foreach $parameter (@{$args{'parameterlist'}}) {
12201da177e4SLinus Torvalds      ($parameter =~ /^#/) && next;
12211da177e4SLinus Torvalds
12221da177e4SLinus Torvalds      my $parameter_name = $parameter;
12231da177e4SLinus Torvalds      $parameter_name =~ s/\[.*//;
12241da177e4SLinus Torvalds
12251da177e4SLinus Torvalds      defined($args{'parameterdescs'}{$parameter_name}) || next;
12261da177e4SLinus Torvalds      ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1227fc6d7af8SPaolo Bonzini      $type = $args{'parametertypes'}{$parameter};
12281da177e4SLinus Torvalds      print "    <varlistentry>";
1229fc6d7af8SPaolo Bonzini      print "      <term><literal>$type $parameter</literal></term>\n";
12301da177e4SLinus Torvalds      print "      <listitem><para>\n";
12311da177e4SLinus Torvalds      output_highlight($args{'parameterdescs'}{$parameter_name});
12321da177e4SLinus Torvalds      print "      </para></listitem>\n";
12331da177e4SLinus Torvalds      print "    </varlistentry>\n";
12341da177e4SLinus Torvalds    }
12351da177e4SLinus Torvalds    print "  </variablelist>\n";
123639f00c08SRandy Dunlap    } else {
123739f00c08SRandy Dunlap	print " <para>\n  None\n </para>\n";
123839f00c08SRandy Dunlap    }
12391da177e4SLinus Torvalds    print " </refsect1>\n";
12401da177e4SLinus Torvalds
12411da177e4SLinus Torvalds    output_section_xml(@_);
12421da177e4SLinus Torvalds
12431da177e4SLinus Torvalds    print "</refentry>\n\n";
12441da177e4SLinus Torvalds}
12451da177e4SLinus Torvalds
12461da177e4SLinus Torvalds# output enum in XML DocBook
12471da177e4SLinus Torvaldssub output_enum_xml(%) {
12481da177e4SLinus Torvalds    my %args = %{$_[0]};
12491da177e4SLinus Torvalds    my ($parameter, $section);
12501da177e4SLinus Torvalds    my $count;
12511da177e4SLinus Torvalds    my $id;
12521da177e4SLinus Torvalds
12531da177e4SLinus Torvalds    $id = "API-enum-" . $args{'enum'};
12541da177e4SLinus Torvalds    $id =~ s/[^A-Za-z0-9]/-/g;
12551da177e4SLinus Torvalds
12565449bc94SPavel Pisa    print "<refentry id=\"$id\">\n";
12578b0c2d98SMartin Waitz    print "<refentryinfo>\n";
12588b0c2d98SMartin Waitz    print " <title>LINUX</title>\n";
12598b0c2d98SMartin Waitz    print " <productname>Kernel Hackers Manual</productname>\n";
12608b0c2d98SMartin Waitz    print " <date>$man_date</date>\n";
12618b0c2d98SMartin Waitz    print "</refentryinfo>\n";
12621da177e4SLinus Torvalds    print "<refmeta>\n";
12635449bc94SPavel Pisa    print " <refentrytitle><phrase>enum " . $args{'enum'} . "</phrase></refentrytitle>\n";
12648b0c2d98SMartin Waitz    print " <manvolnum>9</manvolnum>\n";
12650366299bSBorislav Petkov    print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
12661da177e4SLinus Torvalds    print "</refmeta>\n";
12671da177e4SLinus Torvalds    print "<refnamediv>\n";
12681da177e4SLinus Torvalds    print " <refname>enum " . $args{'enum'} . "</refname>\n";
12691da177e4SLinus Torvalds    print " <refpurpose>\n";
12701da177e4SLinus Torvalds    print "  ";
12711da177e4SLinus Torvalds    output_highlight ($args{'purpose'});
12721da177e4SLinus Torvalds    print " </refpurpose>\n";
12731da177e4SLinus Torvalds    print "</refnamediv>\n";
12741da177e4SLinus Torvalds
12751da177e4SLinus Torvalds    print "<refsynopsisdiv>\n";
12761da177e4SLinus Torvalds    print " <title>Synopsis</title>\n";
12771da177e4SLinus Torvalds    print "  <programlisting>\n";
12781da177e4SLinus Torvalds    print "enum " . $args{'enum'} . " {\n";
12791da177e4SLinus Torvalds    $count = 0;
12801da177e4SLinus Torvalds    foreach $parameter (@{$args{'parameterlist'}}) {
12811da177e4SLinus Torvalds	print "  $parameter";
12821da177e4SLinus Torvalds	if ($count != $#{$args{'parameterlist'}}) {
12831da177e4SLinus Torvalds	    $count++;
12841da177e4SLinus Torvalds	    print ",";
12851da177e4SLinus Torvalds	}
12861da177e4SLinus Torvalds	print "\n";
12871da177e4SLinus Torvalds    }
12881da177e4SLinus Torvalds    print "};";
12891da177e4SLinus Torvalds    print "  </programlisting>\n";
12901da177e4SLinus Torvalds    print "</refsynopsisdiv>\n";
12911da177e4SLinus Torvalds
12921da177e4SLinus Torvalds    print "<refsect1>\n";
12931da177e4SLinus Torvalds    print " <title>Constants</title>\n";
12941da177e4SLinus Torvalds    print "  <variablelist>\n";
12951da177e4SLinus Torvalds    foreach $parameter (@{$args{'parameterlist'}}) {
12961da177e4SLinus Torvalds      my $parameter_name = $parameter;
12971da177e4SLinus Torvalds      $parameter_name =~ s/\[.*//;
12981da177e4SLinus Torvalds
12991da177e4SLinus Torvalds      print "    <varlistentry>";
13001da177e4SLinus Torvalds      print "      <term>$parameter</term>\n";
13011da177e4SLinus Torvalds      print "      <listitem><para>\n";
13021da177e4SLinus Torvalds      output_highlight($args{'parameterdescs'}{$parameter_name});
13031da177e4SLinus Torvalds      print "      </para></listitem>\n";
13041da177e4SLinus Torvalds      print "    </varlistentry>\n";
13051da177e4SLinus Torvalds    }
13061da177e4SLinus Torvalds    print "  </variablelist>\n";
13071da177e4SLinus Torvalds    print "</refsect1>\n";
13081da177e4SLinus Torvalds
13091da177e4SLinus Torvalds    output_section_xml(@_);
13101da177e4SLinus Torvalds
13111da177e4SLinus Torvalds    print "</refentry>\n\n";
13121da177e4SLinus Torvalds}
13131da177e4SLinus Torvalds
13141da177e4SLinus Torvalds# output typedef in XML DocBook
13151da177e4SLinus Torvaldssub output_typedef_xml(%) {
13161da177e4SLinus Torvalds    my %args = %{$_[0]};
13171da177e4SLinus Torvalds    my ($parameter, $section);
13181da177e4SLinus Torvalds    my $id;
13191da177e4SLinus Torvalds
13201da177e4SLinus Torvalds    $id = "API-typedef-" . $args{'typedef'};
13211da177e4SLinus Torvalds    $id =~ s/[^A-Za-z0-9]/-/g;
13221da177e4SLinus Torvalds
13235449bc94SPavel Pisa    print "<refentry id=\"$id\">\n";
13248b0c2d98SMartin Waitz    print "<refentryinfo>\n";
13258b0c2d98SMartin Waitz    print " <title>LINUX</title>\n";
13268b0c2d98SMartin Waitz    print " <productname>Kernel Hackers Manual</productname>\n";
13278b0c2d98SMartin Waitz    print " <date>$man_date</date>\n";
13288b0c2d98SMartin Waitz    print "</refentryinfo>\n";
13291da177e4SLinus Torvalds    print "<refmeta>\n";
13305449bc94SPavel Pisa    print " <refentrytitle><phrase>typedef " . $args{'typedef'} . "</phrase></refentrytitle>\n";
13318b0c2d98SMartin Waitz    print " <manvolnum>9</manvolnum>\n";
13321da177e4SLinus Torvalds    print "</refmeta>\n";
13331da177e4SLinus Torvalds    print "<refnamediv>\n";
13341da177e4SLinus Torvalds    print " <refname>typedef " . $args{'typedef'} . "</refname>\n";
13351da177e4SLinus Torvalds    print " <refpurpose>\n";
13361da177e4SLinus Torvalds    print "  ";
13371da177e4SLinus Torvalds    output_highlight ($args{'purpose'});
13381da177e4SLinus Torvalds    print " </refpurpose>\n";
13391da177e4SLinus Torvalds    print "</refnamediv>\n";
13401da177e4SLinus Torvalds
13411da177e4SLinus Torvalds    print "<refsynopsisdiv>\n";
13421da177e4SLinus Torvalds    print " <title>Synopsis</title>\n";
13431da177e4SLinus Torvalds    print "  <synopsis>typedef " . $args{'typedef'} . ";</synopsis>\n";
13441da177e4SLinus Torvalds    print "</refsynopsisdiv>\n";
13451da177e4SLinus Torvalds
13461da177e4SLinus Torvalds    output_section_xml(@_);
13471da177e4SLinus Torvalds
13481da177e4SLinus Torvalds    print "</refentry>\n\n";
13491da177e4SLinus Torvalds}
13501da177e4SLinus Torvalds
13511da177e4SLinus Torvalds# output in XML DocBook
1352b112e0f7SJohannes Bergsub output_blockhead_xml(%) {
13531da177e4SLinus Torvalds    my %args = %{$_[0]};
13541da177e4SLinus Torvalds    my ($parameter, $section);
13551da177e4SLinus Torvalds    my $count;
13561da177e4SLinus Torvalds
13571da177e4SLinus Torvalds    my $id = $args{'module'};
13581da177e4SLinus Torvalds    $id =~ s/[^A-Za-z0-9]/-/g;
13591da177e4SLinus Torvalds
13601da177e4SLinus Torvalds    # print out each section
13611da177e4SLinus Torvalds    $lineprefix="   ";
13621da177e4SLinus Torvalds    foreach $section (@{$args{'sectionlist'}}) {
1363b112e0f7SJohannes Berg	if (!$args{'content-only'}) {
1364b112e0f7SJohannes Berg		print "<refsect1>\n <title>$section</title>\n";
1365b112e0f7SJohannes Berg	}
13661da177e4SLinus Torvalds	if ($section =~ m/EXAMPLE/i) {
13671da177e4SLinus Torvalds	    print "<example><para>\n";
1368e314ba31SDaniel Santos	    $output_preformatted = 1;
1369b112e0f7SJohannes Berg	} else {
1370b112e0f7SJohannes Berg	    print "<para>\n";
13711da177e4SLinus Torvalds	}
13721da177e4SLinus Torvalds	output_highlight($args{'sections'}{$section});
1373e314ba31SDaniel Santos	$output_preformatted = 0;
13741da177e4SLinus Torvalds	if ($section =~ m/EXAMPLE/i) {
13751da177e4SLinus Torvalds	    print "</para></example>\n";
1376b112e0f7SJohannes Berg	} else {
1377b112e0f7SJohannes Berg	    print "</para>";
13781da177e4SLinus Torvalds	}
1379b112e0f7SJohannes Berg	if (!$args{'content-only'}) {
1380b112e0f7SJohannes Berg		print "\n</refsect1>\n";
1381b112e0f7SJohannes Berg	}
13821da177e4SLinus Torvalds    }
13831da177e4SLinus Torvalds
13841da177e4SLinus Torvalds    print "\n\n";
13851da177e4SLinus Torvalds}
13861da177e4SLinus Torvalds
13871da177e4SLinus Torvalds# output in XML DocBook
13881da177e4SLinus Torvaldssub output_function_gnome {
13891da177e4SLinus Torvalds    my %args = %{$_[0]};
13901da177e4SLinus Torvalds    my ($parameter, $section);
13911da177e4SLinus Torvalds    my $count;
13921da177e4SLinus Torvalds    my $id;
13931da177e4SLinus Torvalds
13941da177e4SLinus Torvalds    $id = $args{'module'} . "-" . $args{'function'};
13951da177e4SLinus Torvalds    $id =~ s/[^A-Za-z0-9]/-/g;
13961da177e4SLinus Torvalds
13971da177e4SLinus Torvalds    print "<sect2>\n";
13981da177e4SLinus Torvalds    print " <title id=\"$id\">" . $args{'function'} . "</title>\n";
13991da177e4SLinus Torvalds
14001da177e4SLinus Torvalds    print "  <funcsynopsis>\n";
14011da177e4SLinus Torvalds    print "   <funcdef>" . $args{'functiontype'} . " ";
14021da177e4SLinus Torvalds    print "<function>" . $args{'function'} . " ";
14031da177e4SLinus Torvalds    print "</function></funcdef>\n";
14041da177e4SLinus Torvalds
14051da177e4SLinus Torvalds    $count = 0;
14061da177e4SLinus Torvalds    if ($#{$args{'parameterlist'}} >= 0) {
14071da177e4SLinus Torvalds	foreach $parameter (@{$args{'parameterlist'}}) {
14081da177e4SLinus Torvalds	    $type = $args{'parametertypes'}{$parameter};
14091da177e4SLinus Torvalds	    if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
14101da177e4SLinus Torvalds		# pointer-to-function
14111da177e4SLinus Torvalds		print "   <paramdef>$1 <parameter>$parameter</parameter>)\n";
14121da177e4SLinus Torvalds		print "     <funcparams>$2</funcparams></paramdef>\n";
14131da177e4SLinus Torvalds	    } else {
14141da177e4SLinus Torvalds		print "   <paramdef>" . $type;
14151da177e4SLinus Torvalds		print " <parameter>$parameter</parameter></paramdef>\n";
14161da177e4SLinus Torvalds	    }
14171da177e4SLinus Torvalds	}
14181da177e4SLinus Torvalds    } else {
14191da177e4SLinus Torvalds	print "  <void>\n";
14201da177e4SLinus Torvalds    }
14211da177e4SLinus Torvalds    print "  </funcsynopsis>\n";
14221da177e4SLinus Torvalds    if ($#{$args{'parameterlist'}} >= 0) {
14231da177e4SLinus Torvalds	print " <informaltable pgwide=\"1\" frame=\"none\" role=\"params\">\n";
14241da177e4SLinus Torvalds	print "<tgroup cols=\"2\">\n";
14251da177e4SLinus Torvalds	print "<colspec colwidth=\"2*\">\n";
14261da177e4SLinus Torvalds	print "<colspec colwidth=\"8*\">\n";
14271da177e4SLinus Torvalds	print "<tbody>\n";
14281da177e4SLinus Torvalds	foreach $parameter (@{$args{'parameterlist'}}) {
14291da177e4SLinus Torvalds	    my $parameter_name = $parameter;
14301da177e4SLinus Torvalds	    $parameter_name =~ s/\[.*//;
14311da177e4SLinus Torvalds
14321da177e4SLinus Torvalds	    print "  <row><entry align=\"right\"><parameter>$parameter</parameter></entry>\n";
14331da177e4SLinus Torvalds	    print "   <entry>\n";
14341da177e4SLinus Torvalds	    $lineprefix="     ";
14351da177e4SLinus Torvalds	    output_highlight($args{'parameterdescs'}{$parameter_name});
14361da177e4SLinus Torvalds	    print "    </entry></row>\n";
14371da177e4SLinus Torvalds	}
14381da177e4SLinus Torvalds	print " </tbody></tgroup></informaltable>\n";
14391da177e4SLinus Torvalds    } else {
14401da177e4SLinus Torvalds	print " <para>\n  None\n </para>\n";
14411da177e4SLinus Torvalds    }
14421da177e4SLinus Torvalds
14431da177e4SLinus Torvalds    # print out each section
14441da177e4SLinus Torvalds    $lineprefix="   ";
14451da177e4SLinus Torvalds    foreach $section (@{$args{'sectionlist'}}) {
14461da177e4SLinus Torvalds	print "<simplesect>\n <title>$section</title>\n";
14471da177e4SLinus Torvalds	if ($section =~ m/EXAMPLE/i) {
14481da177e4SLinus Torvalds	    print "<example><programlisting>\n";
1449e314ba31SDaniel Santos	    $output_preformatted = 1;
14501da177e4SLinus Torvalds	} else {
14511da177e4SLinus Torvalds	}
14521da177e4SLinus Torvalds	print "<para>\n";
14531da177e4SLinus Torvalds	output_highlight($args{'sections'}{$section});
1454e314ba31SDaniel Santos	$output_preformatted = 0;
14551da177e4SLinus Torvalds	print "</para>\n";
14561da177e4SLinus Torvalds	if ($section =~ m/EXAMPLE/i) {
14571da177e4SLinus Torvalds	    print "</programlisting></example>\n";
14581da177e4SLinus Torvalds	} else {
14591da177e4SLinus Torvalds	}
14601da177e4SLinus Torvalds	print " </simplesect>\n";
14611da177e4SLinus Torvalds    }
14621da177e4SLinus Torvalds
14631da177e4SLinus Torvalds    print "</sect2>\n\n";
14641da177e4SLinus Torvalds}
14651da177e4SLinus Torvalds
14661da177e4SLinus Torvalds##
14671da177e4SLinus Torvalds# output function in man
14681da177e4SLinus Torvaldssub output_function_man(%) {
14691da177e4SLinus Torvalds    my %args = %{$_[0]};
14701da177e4SLinus Torvalds    my ($parameter, $section);
14711da177e4SLinus Torvalds    my $count;
14721da177e4SLinus Torvalds
14731da177e4SLinus Torvalds    print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
14741da177e4SLinus Torvalds
14751da177e4SLinus Torvalds    print ".SH NAME\n";
14761da177e4SLinus Torvalds    print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
14771da177e4SLinus Torvalds
14781da177e4SLinus Torvalds    print ".SH SYNOPSIS\n";
1479a21217daSRandy Dunlap    if ($args{'functiontype'} ne "") {
14801da177e4SLinus Torvalds	print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
1481a21217daSRandy Dunlap    } else {
1482a21217daSRandy Dunlap	print ".B \"" . $args{'function'} . "\n";
1483a21217daSRandy Dunlap    }
14841da177e4SLinus Torvalds    $count = 0;
14851da177e4SLinus Torvalds    my $parenth = "(";
14861da177e4SLinus Torvalds    my $post = ",";
14871da177e4SLinus Torvalds    foreach my $parameter (@{$args{'parameterlist'}}) {
14881da177e4SLinus Torvalds	if ($count == $#{$args{'parameterlist'}}) {
14891da177e4SLinus Torvalds	    $post = ");";
14901da177e4SLinus Torvalds	}
14911da177e4SLinus Torvalds	$type = $args{'parametertypes'}{$parameter};
14921da177e4SLinus Torvalds	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
14931da177e4SLinus Torvalds	    # pointer-to-function
14941da177e4SLinus Torvalds	    print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n";
14951da177e4SLinus Torvalds	} else {
14961da177e4SLinus Torvalds	    $type =~ s/([^\*])$/$1 /;
14971da177e4SLinus Torvalds	    print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n";
14981da177e4SLinus Torvalds	}
14991da177e4SLinus Torvalds	$count++;
15001da177e4SLinus Torvalds	$parenth = "";
15011da177e4SLinus Torvalds    }
15021da177e4SLinus Torvalds
15031da177e4SLinus Torvalds    print ".SH ARGUMENTS\n";
15041da177e4SLinus Torvalds    foreach $parameter (@{$args{'parameterlist'}}) {
15051da177e4SLinus Torvalds	my $parameter_name = $parameter;
15061da177e4SLinus Torvalds	$parameter_name =~ s/\[.*//;
15071da177e4SLinus Torvalds
15081da177e4SLinus Torvalds	print ".IP \"" . $parameter . "\" 12\n";
15091da177e4SLinus Torvalds	output_highlight($args{'parameterdescs'}{$parameter_name});
15101da177e4SLinus Torvalds    }
15111da177e4SLinus Torvalds    foreach $section (@{$args{'sectionlist'}}) {
15121da177e4SLinus Torvalds	print ".SH \"", uc $section, "\"\n";
15131da177e4SLinus Torvalds	output_highlight($args{'sections'}{$section});
15141da177e4SLinus Torvalds    }
15151da177e4SLinus Torvalds}
15161da177e4SLinus Torvalds
15171da177e4SLinus Torvalds##
15181da177e4SLinus Torvalds# output enum in man
15191da177e4SLinus Torvaldssub output_enum_man(%) {
15201da177e4SLinus Torvalds    my %args = %{$_[0]};
15211da177e4SLinus Torvalds    my ($parameter, $section);
15221da177e4SLinus Torvalds    my $count;
15231da177e4SLinus Torvalds
15241da177e4SLinus Torvalds    print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
15251da177e4SLinus Torvalds
15261da177e4SLinus Torvalds    print ".SH NAME\n";
15271da177e4SLinus Torvalds    print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
15281da177e4SLinus Torvalds
15291da177e4SLinus Torvalds    print ".SH SYNOPSIS\n";
15301da177e4SLinus Torvalds    print "enum " . $args{'enum'} . " {\n";
15311da177e4SLinus Torvalds    $count = 0;
15321da177e4SLinus Torvalds    foreach my $parameter (@{$args{'parameterlist'}}) {
15331da177e4SLinus Torvalds	print ".br\n.BI \"    $parameter\"\n";
15341da177e4SLinus Torvalds	if ($count == $#{$args{'parameterlist'}}) {
15351da177e4SLinus Torvalds	    print "\n};\n";
15361da177e4SLinus Torvalds	    last;
15371da177e4SLinus Torvalds	}
15381da177e4SLinus Torvalds	else {
15391da177e4SLinus Torvalds	    print ", \n.br\n";
15401da177e4SLinus Torvalds	}
15411da177e4SLinus Torvalds	$count++;
15421da177e4SLinus Torvalds    }
15431da177e4SLinus Torvalds
15441da177e4SLinus Torvalds    print ".SH Constants\n";
15451da177e4SLinus Torvalds    foreach $parameter (@{$args{'parameterlist'}}) {
15461da177e4SLinus Torvalds	my $parameter_name = $parameter;
15471da177e4SLinus Torvalds	$parameter_name =~ s/\[.*//;
15481da177e4SLinus Torvalds
15491da177e4SLinus Torvalds	print ".IP \"" . $parameter . "\" 12\n";
15501da177e4SLinus Torvalds	output_highlight($args{'parameterdescs'}{$parameter_name});
15511da177e4SLinus Torvalds    }
15521da177e4SLinus Torvalds    foreach $section (@{$args{'sectionlist'}}) {
15531da177e4SLinus Torvalds	print ".SH \"$section\"\n";
15541da177e4SLinus Torvalds	output_highlight($args{'sections'}{$section});
15551da177e4SLinus Torvalds    }
15561da177e4SLinus Torvalds}
15571da177e4SLinus Torvalds
15581da177e4SLinus Torvalds##
15591da177e4SLinus Torvalds# output struct in man
15601da177e4SLinus Torvaldssub output_struct_man(%) {
15611da177e4SLinus Torvalds    my %args = %{$_[0]};
15621da177e4SLinus Torvalds    my ($parameter, $section);
15631da177e4SLinus Torvalds
15641da177e4SLinus Torvalds    print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
15651da177e4SLinus Torvalds
15661da177e4SLinus Torvalds    print ".SH NAME\n";
15671da177e4SLinus Torvalds    print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
15681da177e4SLinus Torvalds
15691da177e4SLinus Torvalds    print ".SH SYNOPSIS\n";
15701da177e4SLinus Torvalds    print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
15711da177e4SLinus Torvalds
15721da177e4SLinus Torvalds    foreach my $parameter (@{$args{'parameterlist'}}) {
15731da177e4SLinus Torvalds	if ($parameter =~ /^#/) {
15741da177e4SLinus Torvalds	    print ".BI \"$parameter\"\n.br\n";
15751da177e4SLinus Torvalds	    next;
15761da177e4SLinus Torvalds	}
15771da177e4SLinus Torvalds	my $parameter_name = $parameter;
15781da177e4SLinus Torvalds	$parameter_name =~ s/\[.*//;
15791da177e4SLinus Torvalds
15801da177e4SLinus Torvalds	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
15811da177e4SLinus Torvalds	$type = $args{'parametertypes'}{$parameter};
15821da177e4SLinus Torvalds	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
15831da177e4SLinus Torvalds	    # pointer-to-function
15841da177e4SLinus Torvalds	    print ".BI \"    " . $1 . "\" " . $parameter . " \") (" . $2 . ")" . "\"\n;\n";
15851da177e4SLinus Torvalds	} elsif ($type =~ m/^(.*?)\s*(:.*)/) {
15861d7e1d45SRandy.Dunlap	    # bitfield
15871d7e1d45SRandy.Dunlap	    print ".BI \"    " . $1 . "\ \" " . $parameter . $2 . " \"" . "\"\n;\n";
15881da177e4SLinus Torvalds	} else {
15891da177e4SLinus Torvalds	    $type =~ s/([^\*])$/$1 /;
15901da177e4SLinus Torvalds	    print ".BI \"    " . $type . "\" " . $parameter . " \"" . "\"\n;\n";
15911da177e4SLinus Torvalds	}
15921da177e4SLinus Torvalds	print "\n.br\n";
15931da177e4SLinus Torvalds    }
15941da177e4SLinus Torvalds    print "};\n.br\n";
15951da177e4SLinus Torvalds
1596c51d3dacSRandy Dunlap    print ".SH Members\n";
15971da177e4SLinus Torvalds    foreach $parameter (@{$args{'parameterlist'}}) {
15981da177e4SLinus Torvalds	($parameter =~ /^#/) && next;
15991da177e4SLinus Torvalds
16001da177e4SLinus Torvalds	my $parameter_name = $parameter;
16011da177e4SLinus Torvalds	$parameter_name =~ s/\[.*//;
16021da177e4SLinus Torvalds
16031da177e4SLinus Torvalds	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
16041da177e4SLinus Torvalds	print ".IP \"" . $parameter . "\" 12\n";
16051da177e4SLinus Torvalds	output_highlight($args{'parameterdescs'}{$parameter_name});
16061da177e4SLinus Torvalds    }
16071da177e4SLinus Torvalds    foreach $section (@{$args{'sectionlist'}}) {
16081da177e4SLinus Torvalds	print ".SH \"$section\"\n";
16091da177e4SLinus Torvalds	output_highlight($args{'sections'}{$section});
16101da177e4SLinus Torvalds    }
16111da177e4SLinus Torvalds}
16121da177e4SLinus Torvalds
16131da177e4SLinus Torvalds##
16141da177e4SLinus Torvalds# output typedef in man
16151da177e4SLinus Torvaldssub output_typedef_man(%) {
16161da177e4SLinus Torvalds    my %args = %{$_[0]};
16171da177e4SLinus Torvalds    my ($parameter, $section);
16181da177e4SLinus Torvalds
16191da177e4SLinus Torvalds    print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
16201da177e4SLinus Torvalds
16211da177e4SLinus Torvalds    print ".SH NAME\n";
16221da177e4SLinus Torvalds    print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
16231da177e4SLinus Torvalds
16241da177e4SLinus Torvalds    foreach $section (@{$args{'sectionlist'}}) {
16251da177e4SLinus Torvalds	print ".SH \"$section\"\n";
16261da177e4SLinus Torvalds	output_highlight($args{'sections'}{$section});
16271da177e4SLinus Torvalds    }
16281da177e4SLinus Torvalds}
16291da177e4SLinus Torvalds
1630b112e0f7SJohannes Bergsub output_blockhead_man(%) {
16311da177e4SLinus Torvalds    my %args = %{$_[0]};
16321da177e4SLinus Torvalds    my ($parameter, $section);
16331da177e4SLinus Torvalds    my $count;
16341da177e4SLinus Torvalds
16351da177e4SLinus Torvalds    print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
16361da177e4SLinus Torvalds
16371da177e4SLinus Torvalds    foreach $section (@{$args{'sectionlist'}}) {
16381da177e4SLinus Torvalds	print ".SH \"$section\"\n";
16391da177e4SLinus Torvalds	output_highlight($args{'sections'}{$section});
16401da177e4SLinus Torvalds    }
16411da177e4SLinus Torvalds}
16421da177e4SLinus Torvalds
16431da177e4SLinus Torvalds##
16441da177e4SLinus Torvalds# output in text
16451da177e4SLinus Torvaldssub output_function_text(%) {
16461da177e4SLinus Torvalds    my %args = %{$_[0]};
16471da177e4SLinus Torvalds    my ($parameter, $section);
1648a21217daSRandy Dunlap    my $start;
16491da177e4SLinus Torvalds
1650f47634b2SRandy Dunlap    print "Name:\n\n";
1651f47634b2SRandy Dunlap    print $args{'function'} . " - " . $args{'purpose'} . "\n";
1652f47634b2SRandy Dunlap
1653f47634b2SRandy Dunlap    print "\nSynopsis:\n\n";
1654a21217daSRandy Dunlap    if ($args{'functiontype'} ne "") {
1655a21217daSRandy Dunlap	$start = $args{'functiontype'} . " " . $args{'function'} . " (";
1656a21217daSRandy Dunlap    } else {
1657a21217daSRandy Dunlap	$start = $args{'function'} . " (";
1658a21217daSRandy Dunlap    }
16591da177e4SLinus Torvalds    print $start;
1660a21217daSRandy Dunlap
16611da177e4SLinus Torvalds    my $count = 0;
16621da177e4SLinus Torvalds    foreach my $parameter (@{$args{'parameterlist'}}) {
16631da177e4SLinus Torvalds	$type = $args{'parametertypes'}{$parameter};
16641da177e4SLinus Torvalds	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
16651da177e4SLinus Torvalds	    # pointer-to-function
16661da177e4SLinus Torvalds	    print $1 . $parameter . ") (" . $2;
16671da177e4SLinus Torvalds	} else {
16681da177e4SLinus Torvalds	    print $type . " " . $parameter;
16691da177e4SLinus Torvalds	}
16701da177e4SLinus Torvalds	if ($count != $#{$args{'parameterlist'}}) {
16711da177e4SLinus Torvalds	    $count++;
16721da177e4SLinus Torvalds	    print ",\n";
16731da177e4SLinus Torvalds	    print " " x length($start);
16741da177e4SLinus Torvalds	} else {
16751da177e4SLinus Torvalds	    print ");\n\n";
16761da177e4SLinus Torvalds	}
16771da177e4SLinus Torvalds    }
16781da177e4SLinus Torvalds
16791da177e4SLinus Torvalds    print "Arguments:\n\n";
16801da177e4SLinus Torvalds    foreach $parameter (@{$args{'parameterlist'}}) {
16811da177e4SLinus Torvalds	my $parameter_name = $parameter;
16821da177e4SLinus Torvalds	$parameter_name =~ s/\[.*//;
16831da177e4SLinus Torvalds
16841da177e4SLinus Torvalds	print $parameter . "\n\t" . $args{'parameterdescs'}{$parameter_name} . "\n";
16851da177e4SLinus Torvalds    }
16861da177e4SLinus Torvalds    output_section_text(@_);
16871da177e4SLinus Torvalds}
16881da177e4SLinus Torvalds
16891da177e4SLinus Torvalds#output sections in text
16901da177e4SLinus Torvaldssub output_section_text(%) {
16911da177e4SLinus Torvalds    my %args = %{$_[0]};
16921da177e4SLinus Torvalds    my $section;
16931da177e4SLinus Torvalds
16941da177e4SLinus Torvalds    print "\n";
16951da177e4SLinus Torvalds    foreach $section (@{$args{'sectionlist'}}) {
16961da177e4SLinus Torvalds	print "$section:\n\n";
16971da177e4SLinus Torvalds	output_highlight($args{'sections'}{$section});
16981da177e4SLinus Torvalds    }
16991da177e4SLinus Torvalds    print "\n\n";
17001da177e4SLinus Torvalds}
17011da177e4SLinus Torvalds
17021da177e4SLinus Torvalds# output enum in text
17031da177e4SLinus Torvaldssub output_enum_text(%) {
17041da177e4SLinus Torvalds    my %args = %{$_[0]};
17051da177e4SLinus Torvalds    my ($parameter);
17061da177e4SLinus Torvalds    my $count;
17071da177e4SLinus Torvalds    print "Enum:\n\n";
17081da177e4SLinus Torvalds
17091d7e1d45SRandy.Dunlap    print "enum " . $args{'enum'} . " - " . $args{'purpose'} . "\n\n";
17101da177e4SLinus Torvalds    print "enum " . $args{'enum'} . " {\n";
17111da177e4SLinus Torvalds    $count = 0;
17121da177e4SLinus Torvalds    foreach $parameter (@{$args{'parameterlist'}}) {
17131da177e4SLinus Torvalds	print "\t$parameter";
17141da177e4SLinus Torvalds	if ($count != $#{$args{'parameterlist'}}) {
17151da177e4SLinus Torvalds	    $count++;
17161da177e4SLinus Torvalds	    print ",";
17171da177e4SLinus Torvalds	}
17181da177e4SLinus Torvalds	print "\n";
17191da177e4SLinus Torvalds    }
17201da177e4SLinus Torvalds    print "};\n\n";
17211da177e4SLinus Torvalds
17221da177e4SLinus Torvalds    print "Constants:\n\n";
17231da177e4SLinus Torvalds    foreach $parameter (@{$args{'parameterlist'}}) {
17241da177e4SLinus Torvalds	print "$parameter\n\t";
17251da177e4SLinus Torvalds	print $args{'parameterdescs'}{$parameter} . "\n";
17261da177e4SLinus Torvalds    }
17271da177e4SLinus Torvalds
17281da177e4SLinus Torvalds    output_section_text(@_);
17291da177e4SLinus Torvalds}
17301da177e4SLinus Torvalds
17311da177e4SLinus Torvalds# output typedef in text
17321da177e4SLinus Torvaldssub output_typedef_text(%) {
17331da177e4SLinus Torvalds    my %args = %{$_[0]};
17341da177e4SLinus Torvalds    my ($parameter);
17351da177e4SLinus Torvalds    my $count;
17361da177e4SLinus Torvalds    print "Typedef:\n\n";
17371da177e4SLinus Torvalds
17381d7e1d45SRandy.Dunlap    print "typedef " . $args{'typedef'} . " - " . $args{'purpose'} . "\n";
17391da177e4SLinus Torvalds    output_section_text(@_);
17401da177e4SLinus Torvalds}
17411da177e4SLinus Torvalds
17421da177e4SLinus Torvalds# output struct as text
17431da177e4SLinus Torvaldssub output_struct_text(%) {
17441da177e4SLinus Torvalds    my %args = %{$_[0]};
17451da177e4SLinus Torvalds    my ($parameter);
17461da177e4SLinus Torvalds
17471d7e1d45SRandy.Dunlap    print $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "\n\n";
17481da177e4SLinus Torvalds    print $args{'type'} . " " . $args{'struct'} . " {\n";
17491da177e4SLinus Torvalds    foreach $parameter (@{$args{'parameterlist'}}) {
17501da177e4SLinus Torvalds	if ($parameter =~ /^#/) {
17511da177e4SLinus Torvalds	    print "$parameter\n";
17521da177e4SLinus Torvalds	    next;
17531da177e4SLinus Torvalds	}
17541da177e4SLinus Torvalds
17551da177e4SLinus Torvalds	my $parameter_name = $parameter;
17561da177e4SLinus Torvalds	$parameter_name =~ s/\[.*//;
17571da177e4SLinus Torvalds
17581da177e4SLinus Torvalds	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
17591da177e4SLinus Torvalds	$type = $args{'parametertypes'}{$parameter};
17601da177e4SLinus Torvalds	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
17611da177e4SLinus Torvalds	    # pointer-to-function
17621da177e4SLinus Torvalds	    print "\t$1 $parameter) ($2);\n";
17631da177e4SLinus Torvalds	} elsif ($type =~ m/^(.*?)\s*(:.*)/) {
176451f5a0c8SRandy Dunlap	    # bitfield
17651da177e4SLinus Torvalds	    print "\t$1 $parameter$2;\n";
17661da177e4SLinus Torvalds	} else {
17671da177e4SLinus Torvalds	    print "\t" . $type . " " . $parameter . ";\n";
17681da177e4SLinus Torvalds	}
17691da177e4SLinus Torvalds    }
17701da177e4SLinus Torvalds    print "};\n\n";
17711da177e4SLinus Torvalds
17721da177e4SLinus Torvalds    print "Members:\n\n";
17731da177e4SLinus Torvalds    foreach $parameter (@{$args{'parameterlist'}}) {
17741da177e4SLinus Torvalds	($parameter =~ /^#/) && next;
17751da177e4SLinus Torvalds
17761da177e4SLinus Torvalds	my $parameter_name = $parameter;
17771da177e4SLinus Torvalds	$parameter_name =~ s/\[.*//;
17781da177e4SLinus Torvalds
17791da177e4SLinus Torvalds	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
17801da177e4SLinus Torvalds	print "$parameter\n\t";
17811da177e4SLinus Torvalds	print $args{'parameterdescs'}{$parameter_name} . "\n";
17821da177e4SLinus Torvalds    }
17831da177e4SLinus Torvalds    print "\n";
17841da177e4SLinus Torvalds    output_section_text(@_);
17851da177e4SLinus Torvalds}
17861da177e4SLinus Torvalds
1787b112e0f7SJohannes Bergsub output_blockhead_text(%) {
17881da177e4SLinus Torvalds    my %args = %{$_[0]};
17891da177e4SLinus Torvalds    my ($parameter, $section);
17901da177e4SLinus Torvalds
17911da177e4SLinus Torvalds    foreach $section (@{$args{'sectionlist'}}) {
17921da177e4SLinus Torvalds	print " $section:\n";
17931da177e4SLinus Torvalds	print "    -> ";
17941da177e4SLinus Torvalds	output_highlight($args{'sections'}{$section});
17951da177e4SLinus Torvalds    }
17961da177e4SLinus Torvalds}
17971da177e4SLinus Torvalds
1798c0d1b6eeSJonathan Corbet##
1799c0d1b6eeSJonathan Corbet# output in restructured text
1800c0d1b6eeSJonathan Corbet#
1801c0d1b6eeSJonathan Corbet
1802c0d1b6eeSJonathan Corbet#
1803c0d1b6eeSJonathan Corbet# This could use some work; it's used to output the DOC: sections, and
1804c0d1b6eeSJonathan Corbet# starts by putting out the name of the doc section itself, but that tends
1805c0d1b6eeSJonathan Corbet# to duplicate a header already in the template file.
1806c0d1b6eeSJonathan Corbet#
1807c0d1b6eeSJonathan Corbetsub output_blockhead_rst(%) {
1808c0d1b6eeSJonathan Corbet    my %args = %{$_[0]};
1809c0d1b6eeSJonathan Corbet    my ($parameter, $section);
1810c0d1b6eeSJonathan Corbet
1811c0d1b6eeSJonathan Corbet    foreach $section (@{$args{'sectionlist'}}) {
18129e72184bSJani Nikula	if ($output_selection != OUTPUT_INCLUDE) {
1813c0d1b6eeSJonathan Corbet	    print "**$section**\n\n";
18149e72184bSJani Nikula	}
18150b0f5f29SDaniel Vetter        print_lineno($section_start_lines{$section});
1816c0d1b6eeSJonathan Corbet	output_highlight_rst($args{'sections'}{$section});
1817c0d1b6eeSJonathan Corbet	print "\n";
1818c0d1b6eeSJonathan Corbet    }
1819c0d1b6eeSJonathan Corbet}
1820c0d1b6eeSJonathan Corbet
1821c0d1b6eeSJonathan Corbetsub output_highlight_rst {
1822c0d1b6eeSJonathan Corbet    my $contents = join "\n",@_;
1823c0d1b6eeSJonathan Corbet    my $line;
1824c0d1b6eeSJonathan Corbet
1825c0d1b6eeSJonathan Corbet    # undo the evil effects of xml_escape() earlier
1826c0d1b6eeSJonathan Corbet    $contents = xml_unescape($contents);
1827c0d1b6eeSJonathan Corbet
1828c0d1b6eeSJonathan Corbet    eval $dohighlight;
1829c0d1b6eeSJonathan Corbet    die $@ if $@;
1830c0d1b6eeSJonathan Corbet
1831c0d1b6eeSJonathan Corbet    foreach $line (split "\n", $contents) {
1832830066a7SJani Nikula	print $lineprefix . $line . "\n";
1833c0d1b6eeSJonathan Corbet    }
1834c0d1b6eeSJonathan Corbet}
1835c0d1b6eeSJonathan Corbet
1836c0d1b6eeSJonathan Corbetsub output_function_rst(%) {
1837c0d1b6eeSJonathan Corbet    my %args = %{$_[0]};
1838c0d1b6eeSJonathan Corbet    my ($parameter, $section);
1839c099ff69SJani Nikula    my $oldprefix = $lineprefix;
184082801d06SMauro Carvalho Chehab    my $start = "";
1841c0d1b6eeSJonathan Corbet
184282801d06SMauro Carvalho Chehab    if ($args{'typedef'}) {
184382801d06SMauro Carvalho Chehab	print ".. c:type:: ". $args{'function'} . "\n\n";
184482801d06SMauro Carvalho Chehab	print_lineno($declaration_start_line);
184582801d06SMauro Carvalho Chehab	print "   **Typedef**: ";
184682801d06SMauro Carvalho Chehab	$lineprefix = "";
184782801d06SMauro Carvalho Chehab	output_highlight_rst($args{'purpose'});
184882801d06SMauro Carvalho Chehab	$start = "\n\n**Syntax**\n\n  ``";
1849c0d1b6eeSJonathan Corbet    } else {
185082801d06SMauro Carvalho Chehab	print ".. c:function:: ";
185182801d06SMauro Carvalho Chehab    }
185282801d06SMauro Carvalho Chehab    if ($args{'functiontype'} ne "") {
185382801d06SMauro Carvalho Chehab	$start .= $args{'functiontype'} . " " . $args{'function'} . " (";
185482801d06SMauro Carvalho Chehab    } else {
185582801d06SMauro Carvalho Chehab	$start .= $args{'function'} . " (";
1856c0d1b6eeSJonathan Corbet    }
1857c0d1b6eeSJonathan Corbet    print $start;
1858c0d1b6eeSJonathan Corbet
1859c0d1b6eeSJonathan Corbet    my $count = 0;
1860c0d1b6eeSJonathan Corbet    foreach my $parameter (@{$args{'parameterlist'}}) {
1861c0d1b6eeSJonathan Corbet	if ($count ne 0) {
1862c0d1b6eeSJonathan Corbet	    print ", ";
1863c0d1b6eeSJonathan Corbet	}
1864c0d1b6eeSJonathan Corbet	$count++;
1865c0d1b6eeSJonathan Corbet	$type = $args{'parametertypes'}{$parameter};
1866a88b1672SMauro Carvalho Chehab
1867c0d1b6eeSJonathan Corbet	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1868c0d1b6eeSJonathan Corbet	    # pointer-to-function
1869c0d1b6eeSJonathan Corbet	    print $1 . $parameter . ") (" . $2;
1870c0d1b6eeSJonathan Corbet	} else {
1871c0d1b6eeSJonathan Corbet	    print $type . " " . $parameter;
1872c0d1b6eeSJonathan Corbet	}
1873c0d1b6eeSJonathan Corbet    }
187482801d06SMauro Carvalho Chehab    if ($args{'typedef'}) {
187582801d06SMauro Carvalho Chehab	print ");``\n\n";
187682801d06SMauro Carvalho Chehab    } else {
1877c099ff69SJani Nikula	print ")\n\n";
18780b0f5f29SDaniel Vetter	print_lineno($declaration_start_line);
1879c099ff69SJani Nikula	$lineprefix = "   ";
1880c099ff69SJani Nikula	output_highlight_rst($args{'purpose'});
1881c099ff69SJani Nikula	print "\n";
188282801d06SMauro Carvalho Chehab    }
1883c0d1b6eeSJonathan Corbet
1884ecbcfba1SJani Nikula    print "**Parameters**\n\n";
1885c099ff69SJani Nikula    $lineprefix = "  ";
1886c0d1b6eeSJonathan Corbet    foreach $parameter (@{$args{'parameterlist'}}) {
1887c0d1b6eeSJonathan Corbet	my $parameter_name = $parameter;
1888c0d1b6eeSJonathan Corbet	#$parameter_name =~ s/\[.*//;
1889c0d1b6eeSJonathan Corbet	$type = $args{'parametertypes'}{$parameter};
1890c0d1b6eeSJonathan Corbet
1891c0d1b6eeSJonathan Corbet	if ($type ne "") {
1892c0d1b6eeSJonathan Corbet	    print "``$type $parameter``\n";
1893c0d1b6eeSJonathan Corbet	} else {
1894c0d1b6eeSJonathan Corbet	    print "``$parameter``\n";
1895c0d1b6eeSJonathan Corbet	}
18960b0f5f29SDaniel Vetter
18970b0f5f29SDaniel Vetter        print_lineno($parameterdesc_start_lines{$parameter_name});
18980b0f5f29SDaniel Vetter
18995e64fa9cSJani Nikula	if (defined($args{'parameterdescs'}{$parameter_name}) &&
19005e64fa9cSJani Nikula	    $args{'parameterdescs'}{$parameter_name} ne $undescribed) {
1901c0d1b6eeSJonathan Corbet	    output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1902c0d1b6eeSJonathan Corbet	} else {
1903d4b08e0cSJani Nikula	    print "  *undescribed*\n";
1904c0d1b6eeSJonathan Corbet	}
1905c0d1b6eeSJonathan Corbet	print "\n";
1906c0d1b6eeSJonathan Corbet    }
1907c099ff69SJani Nikula
1908c099ff69SJani Nikula    $lineprefix = $oldprefix;
1909c0d1b6eeSJonathan Corbet    output_section_rst(@_);
1910c0d1b6eeSJonathan Corbet}
1911c0d1b6eeSJonathan Corbet
1912c0d1b6eeSJonathan Corbetsub output_section_rst(%) {
1913c0d1b6eeSJonathan Corbet    my %args = %{$_[0]};
1914c0d1b6eeSJonathan Corbet    my $section;
1915c0d1b6eeSJonathan Corbet    my $oldprefix = $lineprefix;
1916c0d1b6eeSJonathan Corbet    $lineprefix = "";
1917c0d1b6eeSJonathan Corbet
1918c0d1b6eeSJonathan Corbet    foreach $section (@{$args{'sectionlist'}}) {
1919ecbcfba1SJani Nikula	print "**$section**\n\n";
19200b0f5f29SDaniel Vetter        print_lineno($section_start_lines{$section});
1921c0d1b6eeSJonathan Corbet	output_highlight_rst($args{'sections'}{$section});
1922c0d1b6eeSJonathan Corbet	print "\n";
1923c0d1b6eeSJonathan Corbet    }
1924c0d1b6eeSJonathan Corbet    print "\n";
1925c0d1b6eeSJonathan Corbet    $lineprefix = $oldprefix;
1926c0d1b6eeSJonathan Corbet}
1927c0d1b6eeSJonathan Corbet
1928c0d1b6eeSJonathan Corbetsub output_enum_rst(%) {
1929c0d1b6eeSJonathan Corbet    my %args = %{$_[0]};
1930c0d1b6eeSJonathan Corbet    my ($parameter);
1931c099ff69SJani Nikula    my $oldprefix = $lineprefix;
1932c0d1b6eeSJonathan Corbet    my $count;
1933c0d1b6eeSJonathan Corbet    my $name = "enum " . $args{'enum'};
193462850976SJani Nikula
193562850976SJani Nikula    print "\n\n.. c:type:: " . $name . "\n\n";
19360b0f5f29SDaniel Vetter    print_lineno($declaration_start_line);
1937c099ff69SJani Nikula    $lineprefix = "   ";
1938c099ff69SJani Nikula    output_highlight_rst($args{'purpose'});
1939c099ff69SJani Nikula    print "\n";
1940c0d1b6eeSJonathan Corbet
1941ecbcfba1SJani Nikula    print "**Constants**\n\n";
1942c0d1b6eeSJonathan Corbet    $lineprefix = "  ";
1943c0d1b6eeSJonathan Corbet    foreach $parameter (@{$args{'parameterlist'}}) {
1944ecbcfba1SJani Nikula	print "``$parameter``\n";
1945c0d1b6eeSJonathan Corbet	if ($args{'parameterdescs'}{$parameter} ne $undescribed) {
1946c0d1b6eeSJonathan Corbet	    output_highlight_rst($args{'parameterdescs'}{$parameter});
1947c0d1b6eeSJonathan Corbet	} else {
1948d4b08e0cSJani Nikula	    print "  *undescribed*\n";
1949c0d1b6eeSJonathan Corbet	}
1950c0d1b6eeSJonathan Corbet	print "\n";
1951c0d1b6eeSJonathan Corbet    }
1952c099ff69SJani Nikula
1953c0d1b6eeSJonathan Corbet    $lineprefix = $oldprefix;
1954c0d1b6eeSJonathan Corbet    output_section_rst(@_);
1955c0d1b6eeSJonathan Corbet}
1956c0d1b6eeSJonathan Corbet
1957c0d1b6eeSJonathan Corbetsub output_typedef_rst(%) {
1958c0d1b6eeSJonathan Corbet    my %args = %{$_[0]};
1959c0d1b6eeSJonathan Corbet    my ($parameter);
1960c099ff69SJani Nikula    my $oldprefix = $lineprefix;
1961c0d1b6eeSJonathan Corbet    my $name = "typedef " . $args{'typedef'};
1962c0d1b6eeSJonathan Corbet
196362850976SJani Nikula    print "\n\n.. c:type:: " . $name . "\n\n";
19640b0f5f29SDaniel Vetter    print_lineno($declaration_start_line);
1965c099ff69SJani Nikula    $lineprefix = "   ";
1966c099ff69SJani Nikula    output_highlight_rst($args{'purpose'});
1967c099ff69SJani Nikula    print "\n";
1968c0d1b6eeSJonathan Corbet
1969c099ff69SJani Nikula    $lineprefix = $oldprefix;
1970c0d1b6eeSJonathan Corbet    output_section_rst(@_);
1971c0d1b6eeSJonathan Corbet}
1972c0d1b6eeSJonathan Corbet
1973c0d1b6eeSJonathan Corbetsub output_struct_rst(%) {
1974c0d1b6eeSJonathan Corbet    my %args = %{$_[0]};
1975c0d1b6eeSJonathan Corbet    my ($parameter);
1976c099ff69SJani Nikula    my $oldprefix = $lineprefix;
1977c0d1b6eeSJonathan Corbet    my $name = $args{'type'} . " " . $args{'struct'};
1978c0d1b6eeSJonathan Corbet
197962850976SJani Nikula    print "\n\n.. c:type:: " . $name . "\n\n";
19800b0f5f29SDaniel Vetter    print_lineno($declaration_start_line);
1981c099ff69SJani Nikula    $lineprefix = "   ";
1982c099ff69SJani Nikula    output_highlight_rst($args{'purpose'});
1983c099ff69SJani Nikula    print "\n";
1984c0d1b6eeSJonathan Corbet
1985ecbcfba1SJani Nikula    print "**Definition**\n\n";
1986c0d1b6eeSJonathan Corbet    print "::\n\n";
1987c0d1b6eeSJonathan Corbet    print "  " . $args{'type'} . " " . $args{'struct'} . " {\n";
1988c0d1b6eeSJonathan Corbet    foreach $parameter (@{$args{'parameterlist'}}) {
1989c0d1b6eeSJonathan Corbet	if ($parameter =~ /^#/) {
1990c0d1b6eeSJonathan Corbet	    print "  " . "$parameter\n";
1991c0d1b6eeSJonathan Corbet	    next;
1992c0d1b6eeSJonathan Corbet	}
1993c0d1b6eeSJonathan Corbet
1994c0d1b6eeSJonathan Corbet	my $parameter_name = $parameter;
1995c0d1b6eeSJonathan Corbet	$parameter_name =~ s/\[.*//;
1996c0d1b6eeSJonathan Corbet
1997c0d1b6eeSJonathan Corbet	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1998c0d1b6eeSJonathan Corbet	$type = $args{'parametertypes'}{$parameter};
1999c0d1b6eeSJonathan Corbet	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
2000c0d1b6eeSJonathan Corbet	    # pointer-to-function
2001c0d1b6eeSJonathan Corbet	    print "    $1 $parameter) ($2);\n";
2002c0d1b6eeSJonathan Corbet	} elsif ($type =~ m/^(.*?)\s*(:.*)/) {
2003c0d1b6eeSJonathan Corbet	    # bitfield
2004c0d1b6eeSJonathan Corbet	    print "    $1 $parameter$2;\n";
2005c0d1b6eeSJonathan Corbet	} else {
2006c0d1b6eeSJonathan Corbet	    print "    " . $type . " " . $parameter . ";\n";
2007c0d1b6eeSJonathan Corbet	}
2008c0d1b6eeSJonathan Corbet    }
2009c0d1b6eeSJonathan Corbet    print "  };\n\n";
2010c0d1b6eeSJonathan Corbet
2011ecbcfba1SJani Nikula    print "**Members**\n\n";
2012c099ff69SJani Nikula    $lineprefix = "  ";
2013c0d1b6eeSJonathan Corbet    foreach $parameter (@{$args{'parameterlist'}}) {
2014c0d1b6eeSJonathan Corbet	($parameter =~ /^#/) && next;
2015c0d1b6eeSJonathan Corbet
2016c0d1b6eeSJonathan Corbet	my $parameter_name = $parameter;
2017c0d1b6eeSJonathan Corbet	$parameter_name =~ s/\[.*//;
2018c0d1b6eeSJonathan Corbet
2019c0d1b6eeSJonathan Corbet	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
2020c0d1b6eeSJonathan Corbet	$type = $args{'parametertypes'}{$parameter};
20210b0f5f29SDaniel Vetter        print_lineno($parameterdesc_start_lines{$parameter_name});
20226d232c80SMauro Carvalho Chehab	print "``" . $parameter . "``\n";
2023c0d1b6eeSJonathan Corbet	output_highlight_rst($args{'parameterdescs'}{$parameter_name});
2024c0d1b6eeSJonathan Corbet	print "\n";
2025c0d1b6eeSJonathan Corbet    }
2026c0d1b6eeSJonathan Corbet    print "\n";
2027c099ff69SJani Nikula
2028c099ff69SJani Nikula    $lineprefix = $oldprefix;
2029c0d1b6eeSJonathan Corbet    output_section_rst(@_);
2030c0d1b6eeSJonathan Corbet}
2031c0d1b6eeSJonathan Corbet
2032c0d1b6eeSJonathan Corbet
2033eda603f6SJohannes Berg## list mode output functions
2034eda603f6SJohannes Berg
2035eda603f6SJohannes Bergsub output_function_list(%) {
2036eda603f6SJohannes Berg    my %args = %{$_[0]};
2037eda603f6SJohannes Berg
2038eda603f6SJohannes Berg    print $args{'function'} . "\n";
2039eda603f6SJohannes Berg}
2040eda603f6SJohannes Berg
2041eda603f6SJohannes Berg# output enum in list
2042eda603f6SJohannes Bergsub output_enum_list(%) {
2043eda603f6SJohannes Berg    my %args = %{$_[0]};
2044eda603f6SJohannes Berg    print $args{'enum'} . "\n";
2045eda603f6SJohannes Berg}
2046eda603f6SJohannes Berg
2047eda603f6SJohannes Berg# output typedef in list
2048eda603f6SJohannes Bergsub output_typedef_list(%) {
2049eda603f6SJohannes Berg    my %args = %{$_[0]};
2050eda603f6SJohannes Berg    print $args{'typedef'} . "\n";
2051eda603f6SJohannes Berg}
2052eda603f6SJohannes Berg
2053eda603f6SJohannes Berg# output struct as list
2054eda603f6SJohannes Bergsub output_struct_list(%) {
2055eda603f6SJohannes Berg    my %args = %{$_[0]};
2056eda603f6SJohannes Berg
2057eda603f6SJohannes Berg    print $args{'struct'} . "\n";
2058eda603f6SJohannes Berg}
2059eda603f6SJohannes Berg
2060eda603f6SJohannes Bergsub output_blockhead_list(%) {
2061eda603f6SJohannes Berg    my %args = %{$_[0]};
2062eda603f6SJohannes Berg    my ($parameter, $section);
2063eda603f6SJohannes Berg
2064eda603f6SJohannes Berg    foreach $section (@{$args{'sectionlist'}}) {
2065eda603f6SJohannes Berg	print "DOC: $section\n";
2066eda603f6SJohannes Berg    }
2067eda603f6SJohannes Berg}
2068eda603f6SJohannes Berg
20691da177e4SLinus Torvalds##
207027205744SRandy Dunlap# generic output function for all types (function, struct/union, typedef, enum);
207127205744SRandy Dunlap# calls the generated, variable output_ function name based on
207227205744SRandy Dunlap# functype and output_mode
20731da177e4SLinus Torvaldssub output_declaration {
20741da177e4SLinus Torvalds    no strict 'refs';
20751da177e4SLinus Torvalds    my $name = shift;
20761da177e4SLinus Torvalds    my $functype = shift;
20771da177e4SLinus Torvalds    my $func = "output_${functype}_$output_mode";
2078b6c3f456SJani Nikula    if (($output_selection == OUTPUT_ALL) ||
2079b6c3f456SJani Nikula	(($output_selection == OUTPUT_INCLUDE ||
2080b6c3f456SJani Nikula	  $output_selection == OUTPUT_EXPORTED) &&
208186ae2e38SJani Nikula	 defined($function_table{$name})) ||
2082b6c3f456SJani Nikula	(($output_selection == OUTPUT_EXCLUDE ||
2083b6c3f456SJani Nikula	  $output_selection == OUTPUT_INTERNAL) &&
208486ae2e38SJani Nikula	 !($functype eq "function" && defined($function_table{$name}))))
20851da177e4SLinus Torvalds    {
20861da177e4SLinus Torvalds	&$func(@_);
20871da177e4SLinus Torvalds	$section_counter++;
20881da177e4SLinus Torvalds    }
20891da177e4SLinus Torvalds}
20901da177e4SLinus Torvalds
20911da177e4SLinus Torvalds##
209227205744SRandy Dunlap# generic output function - calls the right one based on current output mode.
2093b112e0f7SJohannes Bergsub output_blockhead {
20941da177e4SLinus Torvalds    no strict 'refs';
2095b112e0f7SJohannes Berg    my $func = "output_blockhead_" . $output_mode;
20961da177e4SLinus Torvalds    &$func(@_);
20971da177e4SLinus Torvalds    $section_counter++;
20981da177e4SLinus Torvalds}
20991da177e4SLinus Torvalds
21001da177e4SLinus Torvalds##
21011da177e4SLinus Torvalds# takes a declaration (struct, union, enum, typedef) and
21021da177e4SLinus Torvalds# invokes the right handler. NOT called for functions.
21031da177e4SLinus Torvaldssub dump_declaration($$) {
21041da177e4SLinus Torvalds    no strict 'refs';
21051da177e4SLinus Torvalds    my ($prototype, $file) = @_;
21061da177e4SLinus Torvalds    my $func = "dump_" . $decl_type;
21071da177e4SLinus Torvalds    &$func(@_);
21081da177e4SLinus Torvalds}
21091da177e4SLinus Torvalds
21101da177e4SLinus Torvaldssub dump_union($$) {
21111da177e4SLinus Torvalds    dump_struct(@_);
21121da177e4SLinus Torvalds}
21131da177e4SLinus Torvalds
21141da177e4SLinus Torvaldssub dump_struct($$) {
21151da177e4SLinus Torvalds    my $x = shift;
21161da177e4SLinus Torvalds    my $file = shift;
2117a1d94aa5SRandy Dunlap    my $nested;
21181da177e4SLinus Torvalds
21191da177e4SLinus Torvalds    if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) {
212052dc5aecSRandy Dunlap	#my $decl_type = $1;
21211da177e4SLinus Torvalds	$declaration_name = $2;
21221da177e4SLinus Torvalds	my $members = $3;
21231da177e4SLinus Torvalds
21241da177e4SLinus Torvalds	# ignore embedded structs or unions
2125a1d94aa5SRandy Dunlap	$members =~ s/({.*})//g;
2126a1d94aa5SRandy Dunlap	$nested = $1;
21271da177e4SLinus Torvalds
2128aeec46b9SMartin Waitz	# ignore members marked private:
21290d8c39e6SMauro Carvalho Chehab	$members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
21300d8c39e6SMauro Carvalho Chehab	$members =~ s/\/\*\s*private:.*//gosi;
2131aeec46b9SMartin Waitz	# strip comments:
2132aeec46b9SMartin Waitz	$members =~ s/\/\*.*?\*\///gos;
2133a1d94aa5SRandy Dunlap	$nested =~ s/\/\*.*?\*\///gos;
2134d960eea9SRandy Dunlap	# strip kmemcheck_bitfield_{begin,end}.*;
2135d960eea9SRandy Dunlap	$members =~ s/kmemcheck_bitfield_.*?;//gos;
2136ef5da59fSRandy Dunlap	# strip attributes
2137f0074929SJonathan Corbet	$members =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;
21387b990789SJohannes Berg	$members =~ s/__aligned\s*\([^;]*\)//gos;
2139f0074929SJonathan Corbet	$members =~ s/\s*CRYPTO_MINALIGN_ATTR//gos;
2140b22b5a9eSConchúr Navid	# replace DECLARE_BITMAP
2141b22b5a9eSConchúr Navid	$members =~ s/DECLARE_BITMAP\s*\(([^,)]+), ([^,)]+)\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
2142aeec46b9SMartin Waitz
21431da177e4SLinus Torvalds	create_parameterlist($members, ';', $file);
2144a1d94aa5SRandy Dunlap	check_sections($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested);
21451da177e4SLinus Torvalds
21461da177e4SLinus Torvalds	output_declaration($declaration_name,
21471da177e4SLinus Torvalds			   'struct',
21481da177e4SLinus Torvalds			   {'struct' => $declaration_name,
21491da177e4SLinus Torvalds			    'module' => $modulename,
21501da177e4SLinus Torvalds			    'parameterlist' => \@parameterlist,
21511da177e4SLinus Torvalds			    'parameterdescs' => \%parameterdescs,
21521da177e4SLinus Torvalds			    'parametertypes' => \%parametertypes,
21531da177e4SLinus Torvalds			    'sectionlist' => \@sectionlist,
21541da177e4SLinus Torvalds			    'sections' => \%sections,
21551da177e4SLinus Torvalds			    'purpose' => $declaration_purpose,
21561da177e4SLinus Torvalds			    'type' => $decl_type
21571da177e4SLinus Torvalds			   });
21581da177e4SLinus Torvalds    }
21591da177e4SLinus Torvalds    else {
2160d40e1e65SBart Van Assche	print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
21611da177e4SLinus Torvalds	++$errors;
21621da177e4SLinus Torvalds    }
21631da177e4SLinus Torvalds}
21641da177e4SLinus Torvalds
21651da177e4SLinus Torvaldssub dump_enum($$) {
21661da177e4SLinus Torvalds    my $x = shift;
21671da177e4SLinus Torvalds    my $file = shift;
21681da177e4SLinus Torvalds
2169aeec46b9SMartin Waitz    $x =~ s@/\*.*?\*/@@gos;	# strip comments.
21704468e21eSConchúr Navid    # strip #define macros inside enums
21714468e21eSConchúr Navid    $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;
2172b6d676dbSRandy Dunlap
21731da177e4SLinus Torvalds    if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
21741da177e4SLinus Torvalds	$declaration_name = $1;
21751da177e4SLinus Torvalds	my $members = $2;
21761da177e4SLinus Torvalds
21771da177e4SLinus Torvalds	foreach my $arg (split ',', $members) {
21781da177e4SLinus Torvalds	    $arg =~ s/^\s*(\w+).*/$1/;
21791da177e4SLinus Torvalds	    push @parameterlist, $arg;
21801da177e4SLinus Torvalds	    if (!$parameterdescs{$arg}) {
21811da177e4SLinus Torvalds		$parameterdescs{$arg} = $undescribed;
2182d40e1e65SBart Van Assche		print STDERR "${file}:$.: warning: Enum value '$arg' ".
21831da177e4SLinus Torvalds		    "not described in enum '$declaration_name'\n";
21841da177e4SLinus Torvalds	    }
21851da177e4SLinus Torvalds
21861da177e4SLinus Torvalds	}
21871da177e4SLinus Torvalds
21881da177e4SLinus Torvalds	output_declaration($declaration_name,
21891da177e4SLinus Torvalds			   'enum',
21901da177e4SLinus Torvalds			   {'enum' => $declaration_name,
21911da177e4SLinus Torvalds			    'module' => $modulename,
21921da177e4SLinus Torvalds			    'parameterlist' => \@parameterlist,
21931da177e4SLinus Torvalds			    'parameterdescs' => \%parameterdescs,
21941da177e4SLinus Torvalds			    'sectionlist' => \@sectionlist,
21951da177e4SLinus Torvalds			    'sections' => \%sections,
21961da177e4SLinus Torvalds			    'purpose' => $declaration_purpose
21971da177e4SLinus Torvalds			   });
21981da177e4SLinus Torvalds    }
21991da177e4SLinus Torvalds    else {
2200d40e1e65SBart Van Assche	print STDERR "${file}:$.: error: Cannot parse enum!\n";
22011da177e4SLinus Torvalds	++$errors;
22021da177e4SLinus Torvalds    }
22031da177e4SLinus Torvalds}
22041da177e4SLinus Torvalds
22051da177e4SLinus Torvaldssub dump_typedef($$) {
22061da177e4SLinus Torvalds    my $x = shift;
22071da177e4SLinus Torvalds    my $file = shift;
22081da177e4SLinus Torvalds
2209aeec46b9SMartin Waitz    $x =~ s@/\*.*?\*/@@gos;	# strip comments.
221083766452SMauro Carvalho Chehab
221183766452SMauro Carvalho Chehab    # Parse function prototypes
2212d37c43ceSMauro Carvalho Chehab    if ($x =~ /typedef\s+(\w+)\s*\(\*\s*(\w\S+)\s*\)\s*\((.*)\);/ ||
2213d37c43ceSMauro Carvalho Chehab	$x =~ /typedef\s+(\w+)\s*(\w\S+)\s*\s*\((.*)\);/) {
2214d37c43ceSMauro Carvalho Chehab
221583766452SMauro Carvalho Chehab	# Function typedefs
221683766452SMauro Carvalho Chehab	$return_type = $1;
221783766452SMauro Carvalho Chehab	$declaration_name = $2;
221883766452SMauro Carvalho Chehab	my $args = $3;
221983766452SMauro Carvalho Chehab
222083766452SMauro Carvalho Chehab	create_parameterlist($args, ',', $file);
222183766452SMauro Carvalho Chehab
222283766452SMauro Carvalho Chehab	output_declaration($declaration_name,
222383766452SMauro Carvalho Chehab			   'function',
222483766452SMauro Carvalho Chehab			   {'function' => $declaration_name,
222582801d06SMauro Carvalho Chehab			    'typedef' => 1,
222683766452SMauro Carvalho Chehab			    'module' => $modulename,
222783766452SMauro Carvalho Chehab			    'functiontype' => $return_type,
222883766452SMauro Carvalho Chehab			    'parameterlist' => \@parameterlist,
222983766452SMauro Carvalho Chehab			    'parameterdescs' => \%parameterdescs,
223083766452SMauro Carvalho Chehab			    'parametertypes' => \%parametertypes,
223183766452SMauro Carvalho Chehab			    'sectionlist' => \@sectionlist,
223283766452SMauro Carvalho Chehab			    'sections' => \%sections,
223383766452SMauro Carvalho Chehab			    'purpose' => $declaration_purpose
223483766452SMauro Carvalho Chehab			   });
223583766452SMauro Carvalho Chehab	return;
223683766452SMauro Carvalho Chehab    }
223783766452SMauro Carvalho Chehab
22381da177e4SLinus Torvalds    while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
22391da177e4SLinus Torvalds	$x =~ s/\(*.\)\s*;$/;/;
22401da177e4SLinus Torvalds	$x =~ s/\[*.\]\s*;$/;/;
22411da177e4SLinus Torvalds    }
22421da177e4SLinus Torvalds
22431da177e4SLinus Torvalds    if ($x =~ /typedef.*\s+(\w+)\s*;/) {
22441da177e4SLinus Torvalds	$declaration_name = $1;
22451da177e4SLinus Torvalds
22461da177e4SLinus Torvalds	output_declaration($declaration_name,
22471da177e4SLinus Torvalds			   'typedef',
22481da177e4SLinus Torvalds			   {'typedef' => $declaration_name,
22491da177e4SLinus Torvalds			    'module' => $modulename,
22501da177e4SLinus Torvalds			    'sectionlist' => \@sectionlist,
22511da177e4SLinus Torvalds			    'sections' => \%sections,
22521da177e4SLinus Torvalds			    'purpose' => $declaration_purpose
22531da177e4SLinus Torvalds			   });
22541da177e4SLinus Torvalds    }
22551da177e4SLinus Torvalds    else {
2256d40e1e65SBart Van Assche	print STDERR "${file}:$.: error: Cannot parse typedef!\n";
22571da177e4SLinus Torvalds	++$errors;
22581da177e4SLinus Torvalds    }
22591da177e4SLinus Torvalds}
22601da177e4SLinus Torvalds
2261a1d94aa5SRandy Dunlapsub save_struct_actual($) {
2262a1d94aa5SRandy Dunlap    my $actual = shift;
2263a1d94aa5SRandy Dunlap
2264a1d94aa5SRandy Dunlap    # strip all spaces from the actual param so that it looks like one string item
2265a1d94aa5SRandy Dunlap    $actual =~ s/\s*//g;
2266a1d94aa5SRandy Dunlap    $struct_actual = $struct_actual . $actual . " ";
2267a1d94aa5SRandy Dunlap}
2268a1d94aa5SRandy Dunlap
22691da177e4SLinus Torvaldssub create_parameterlist($$$) {
22701da177e4SLinus Torvalds    my $args = shift;
22711da177e4SLinus Torvalds    my $splitter = shift;
22721da177e4SLinus Torvalds    my $file = shift;
22731da177e4SLinus Torvalds    my $type;
22741da177e4SLinus Torvalds    my $param;
22751da177e4SLinus Torvalds
2276a6d3fe77SMartin Waitz    # temporarily replace commas inside function pointer definition
22771da177e4SLinus Torvalds    while ($args =~ /(\([^\),]+),/) {
22781da177e4SLinus Torvalds	$args =~ s/(\([^\),]+),/$1#/g;
22791da177e4SLinus Torvalds    }
22801da177e4SLinus Torvalds
22811da177e4SLinus Torvalds    foreach my $arg (split($splitter, $args)) {
22821da177e4SLinus Torvalds	# strip comments
22831da177e4SLinus Torvalds	$arg =~ s/\/\*.*\*\///;
22841da177e4SLinus Torvalds	# strip leading/trailing spaces
22851da177e4SLinus Torvalds	$arg =~ s/^\s*//;
22861da177e4SLinus Torvalds	$arg =~ s/\s*$//;
22871da177e4SLinus Torvalds	$arg =~ s/\s+/ /;
22881da177e4SLinus Torvalds
22891da177e4SLinus Torvalds	if ($arg =~ /^#/) {
22901da177e4SLinus Torvalds	    # Treat preprocessor directive as a typeless variable just to fill
22911da177e4SLinus Torvalds	    # corresponding data structures "correctly". Catch it later in
22921da177e4SLinus Torvalds	    # output_* subs.
22931da177e4SLinus Torvalds	    push_parameter($arg, "", $file);
229400d62961SRichard Kennedy	} elsif ($arg =~ m/\(.+\)\s*\(/) {
22951da177e4SLinus Torvalds	    # pointer-to-function
22961da177e4SLinus Torvalds	    $arg =~ tr/#/,/;
229700d62961SRichard Kennedy	    $arg =~ m/[^\(]+\(\*?\s*(\w*)\s*\)/;
22981da177e4SLinus Torvalds	    $param = $1;
22991da177e4SLinus Torvalds	    $type = $arg;
230000d62961SRichard Kennedy	    $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
2301a1d94aa5SRandy Dunlap	    save_struct_actual($param);
23021da177e4SLinus Torvalds	    push_parameter($param, $type, $file);
2303aeec46b9SMartin Waitz	} elsif ($arg) {
23041da177e4SLinus Torvalds	    $arg =~ s/\s*:\s*/:/g;
23051da177e4SLinus Torvalds	    $arg =~ s/\s*\[/\[/g;
23061da177e4SLinus Torvalds
23071da177e4SLinus Torvalds	    my @args = split('\s*,\s*', $arg);
23081da177e4SLinus Torvalds	    if ($args[0] =~ m/\*/) {
23091da177e4SLinus Torvalds		$args[0] =~ s/(\*+)\s*/ $1/;
23101da177e4SLinus Torvalds	    }
2311884f2810SBorislav Petkov
2312884f2810SBorislav Petkov	    my @first_arg;
2313884f2810SBorislav Petkov	    if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
2314884f2810SBorislav Petkov		    shift @args;
2315884f2810SBorislav Petkov		    push(@first_arg, split('\s+', $1));
2316884f2810SBorislav Petkov		    push(@first_arg, $2);
2317884f2810SBorislav Petkov	    } else {
2318884f2810SBorislav Petkov		    @first_arg = split('\s+', shift @args);
2319884f2810SBorislav Petkov	    }
2320884f2810SBorislav Petkov
23211da177e4SLinus Torvalds	    unshift(@args, pop @first_arg);
23221da177e4SLinus Torvalds	    $type = join " ", @first_arg;
23231da177e4SLinus Torvalds
23241da177e4SLinus Torvalds	    foreach $param (@args) {
23251da177e4SLinus Torvalds		if ($param =~ m/^(\*+)\s*(.*)/) {
2326a1d94aa5SRandy Dunlap		    save_struct_actual($2);
23271da177e4SLinus Torvalds		    push_parameter($2, "$type $1", $file);
23281da177e4SLinus Torvalds		}
23291da177e4SLinus Torvalds		elsif ($param =~ m/(.*?):(\d+)/) {
23307b97887eSRandy Dunlap		    if ($type ne "") { # skip unnamed bit-fields
2331a1d94aa5SRandy Dunlap			save_struct_actual($1);
23321da177e4SLinus Torvalds			push_parameter($1, "$type:$2", $file)
23331da177e4SLinus Torvalds		    }
23347b97887eSRandy Dunlap		}
23351da177e4SLinus Torvalds		else {
2336a1d94aa5SRandy Dunlap		    save_struct_actual($param);
23371da177e4SLinus Torvalds		    push_parameter($param, $type, $file);
23381da177e4SLinus Torvalds		}
23391da177e4SLinus Torvalds	    }
23401da177e4SLinus Torvalds	}
23411da177e4SLinus Torvalds    }
23421da177e4SLinus Torvalds}
23431da177e4SLinus Torvalds
23441da177e4SLinus Torvaldssub push_parameter($$$) {
23451da177e4SLinus Torvalds	my $param = shift;
23461da177e4SLinus Torvalds	my $type = shift;
23471da177e4SLinus Torvalds	my $file = shift;
23481da177e4SLinus Torvalds
23495f8c7c98SRandy Dunlap	if (($anon_struct_union == 1) && ($type eq "") &&
23505f8c7c98SRandy Dunlap	    ($param eq "}")) {
23515f8c7c98SRandy Dunlap		return;		# ignore the ending }; from anon. struct/union
23525f8c7c98SRandy Dunlap	}
23535f8c7c98SRandy Dunlap
23545f8c7c98SRandy Dunlap	$anon_struct_union = 0;
23551da177e4SLinus Torvalds	my $param_name = $param;
23561da177e4SLinus Torvalds	$param_name =~ s/\[.*//;
23571da177e4SLinus Torvalds
2358a6d3fe77SMartin Waitz	if ($type eq "" && $param =~ /\.\.\.$/)
23591da177e4SLinus Torvalds	{
2360c950a173SSilvio Fricke	    if (!$param =~ /\w\.\.\.$/) {
2361c950a173SSilvio Fricke	      # handles unnamed variable parameters
2362ef00028bSJonathan Corbet	      $param = "...";
2363c950a173SSilvio Fricke	    }
2364ced69090SRandy Dunlap	    if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
2365a6d3fe77SMartin Waitz		$parameterdescs{$param} = "variable arguments";
23661da177e4SLinus Torvalds	    }
2367ced69090SRandy Dunlap	}
23681da177e4SLinus Torvalds	elsif ($type eq "" && ($param eq "" or $param eq "void"))
23691da177e4SLinus Torvalds	{
23701da177e4SLinus Torvalds	    $param="void";
23711da177e4SLinus Torvalds	    $parameterdescs{void} = "no arguments";
23721da177e4SLinus Torvalds	}
2373134fe01bSRandy Dunlap	elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
2374134fe01bSRandy Dunlap	# handle unnamed (anonymous) union or struct:
2375134fe01bSRandy Dunlap	{
2376134fe01bSRandy Dunlap		$type = $param;
2377134fe01bSRandy Dunlap		$param = "{unnamed_" . $param . "}";
2378134fe01bSRandy Dunlap		$parameterdescs{$param} = "anonymous\n";
23795f8c7c98SRandy Dunlap		$anon_struct_union = 1;
2380134fe01bSRandy Dunlap	}
2381134fe01bSRandy Dunlap
2382a6d3fe77SMartin Waitz	# warn if parameter has no description
2383134fe01bSRandy Dunlap	# (but ignore ones starting with # as these are not parameters
2384134fe01bSRandy Dunlap	# but inline preprocessor statements);
2385134fe01bSRandy Dunlap	# also ignore unnamed structs/unions;
23865f8c7c98SRandy Dunlap	if (!$anon_struct_union) {
2387a6d3fe77SMartin Waitz	if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) {
2388a6d3fe77SMartin Waitz
23891da177e4SLinus Torvalds	    $parameterdescs{$param_name} = $undescribed;
23901da177e4SLinus Torvalds
23911da177e4SLinus Torvalds	    if (($type eq 'function') || ($type eq 'enum')) {
2392d40e1e65SBart Van Assche		print STDERR "${file}:$.: warning: Function parameter ".
23931da177e4SLinus Torvalds		    "or member '$param' not " .
23941da177e4SLinus Torvalds		    "described in '$declaration_name'\n";
23951da177e4SLinus Torvalds	    }
2396d40e1e65SBart Van Assche	    print STDERR "${file}:$.: warning:" .
23971da177e4SLinus Torvalds			 " No description found for parameter '$param'\n";
23981da177e4SLinus Torvalds	    ++$warnings;
23991da177e4SLinus Torvalds	}
2400134fe01bSRandy Dunlap	}
24011da177e4SLinus Torvalds
24022b35f4d9SRandy Dunlap	$param = xml_escape($param);
24032b35f4d9SRandy Dunlap
240425985edcSLucas De Marchi	# strip spaces from $param so that it is one continuous string
2405e34e7dbbSRandy Dunlap	# on @parameterlist;
2406e34e7dbbSRandy Dunlap	# this fixes a problem where check_sections() cannot find
2407e34e7dbbSRandy Dunlap	# a parameter like "addr[6 + 2]" because it actually appears
2408e34e7dbbSRandy Dunlap	# as "addr[6", "+", "2]" on the parameter list;
2409e34e7dbbSRandy Dunlap	# but it's better to maintain the param string unchanged for output,
2410e34e7dbbSRandy Dunlap	# so just weaken the string compare in check_sections() to ignore
2411e34e7dbbSRandy Dunlap	# "[blah" in a parameter string;
2412e34e7dbbSRandy Dunlap	###$param =~ s/\s*//g;
24131da177e4SLinus Torvalds	push @parameterlist, $param;
241402a4f4feSPaolo Bonzini	$type =~ s/\s\s+/ /g;
24151da177e4SLinus Torvalds	$parametertypes{$param} = $type;
24161da177e4SLinus Torvalds}
24171da177e4SLinus Torvalds
2418a1d94aa5SRandy Dunlapsub check_sections($$$$$$) {
2419a1d94aa5SRandy Dunlap	my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck, $nested) = @_;
2420a1d94aa5SRandy Dunlap	my @sects = split ' ', $sectcheck;
2421a1d94aa5SRandy Dunlap	my @prms = split ' ', $prmscheck;
2422a1d94aa5SRandy Dunlap	my $err;
2423a1d94aa5SRandy Dunlap	my ($px, $sx);
2424a1d94aa5SRandy Dunlap	my $prm_clean;		# strip trailing "[array size]" and/or beginning "*"
2425a1d94aa5SRandy Dunlap
2426a1d94aa5SRandy Dunlap	foreach $sx (0 .. $#sects) {
2427a1d94aa5SRandy Dunlap		$err = 1;
2428a1d94aa5SRandy Dunlap		foreach $px (0 .. $#prms) {
2429a1d94aa5SRandy Dunlap			$prm_clean = $prms[$px];
2430a1d94aa5SRandy Dunlap			$prm_clean =~ s/\[.*\]//;
24311f3a6688SJohannes Berg			$prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;
2432e34e7dbbSRandy Dunlap			# ignore array size in a parameter string;
2433e34e7dbbSRandy Dunlap			# however, the original param string may contain
2434e34e7dbbSRandy Dunlap			# spaces, e.g.:  addr[6 + 2]
2435e34e7dbbSRandy Dunlap			# and this appears in @prms as "addr[6" since the
2436e34e7dbbSRandy Dunlap			# parameter list is split at spaces;
2437e34e7dbbSRandy Dunlap			# hence just ignore "[..." for the sections check;
2438e34e7dbbSRandy Dunlap			$prm_clean =~ s/\[.*//;
2439e34e7dbbSRandy Dunlap
2440a1d94aa5SRandy Dunlap			##$prm_clean =~ s/^\**//;
2441a1d94aa5SRandy Dunlap			if ($prm_clean eq $sects[$sx]) {
2442a1d94aa5SRandy Dunlap				$err = 0;
2443a1d94aa5SRandy Dunlap				last;
2444a1d94aa5SRandy Dunlap			}
2445a1d94aa5SRandy Dunlap		}
2446a1d94aa5SRandy Dunlap		if ($err) {
2447a1d94aa5SRandy Dunlap			if ($decl_type eq "function") {
2448d40e1e65SBart Van Assche				print STDERR "${file}:$.: warning: " .
2449a1d94aa5SRandy Dunlap					"Excess function parameter " .
2450a1d94aa5SRandy Dunlap					"'$sects[$sx]' " .
2451a1d94aa5SRandy Dunlap					"description in '$decl_name'\n";
2452a1d94aa5SRandy Dunlap				++$warnings;
2453a1d94aa5SRandy Dunlap			} else {
2454a1d94aa5SRandy Dunlap				if ($nested !~ m/\Q$sects[$sx]\E/) {
2455d40e1e65SBart Van Assche				    print STDERR "${file}:$.: warning: " .
2456a1d94aa5SRandy Dunlap					"Excess struct/union/enum/typedef member " .
2457a1d94aa5SRandy Dunlap					"'$sects[$sx]' " .
2458a1d94aa5SRandy Dunlap					"description in '$decl_name'\n";
2459a1d94aa5SRandy Dunlap				    ++$warnings;
2460a1d94aa5SRandy Dunlap				}
2461a1d94aa5SRandy Dunlap			}
2462a1d94aa5SRandy Dunlap		}
2463a1d94aa5SRandy Dunlap	}
2464a1d94aa5SRandy Dunlap}
2465a1d94aa5SRandy Dunlap
24661da177e4SLinus Torvalds##
24674092bac7SYacine Belkadi# Checks the section describing the return value of a function.
24684092bac7SYacine Belkadisub check_return_section {
24694092bac7SYacine Belkadi        my $file = shift;
24704092bac7SYacine Belkadi        my $declaration_name = shift;
24714092bac7SYacine Belkadi        my $return_type = shift;
24724092bac7SYacine Belkadi
24734092bac7SYacine Belkadi        # Ignore an empty return type (It's a macro)
24744092bac7SYacine Belkadi        # Ignore functions with a "void" return type. (But don't ignore "void *")
24754092bac7SYacine Belkadi        if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
24764092bac7SYacine Belkadi                return;
24774092bac7SYacine Belkadi        }
24784092bac7SYacine Belkadi
24794092bac7SYacine Belkadi        if (!defined($sections{$section_return}) ||
24804092bac7SYacine Belkadi            $sections{$section_return} eq "") {
2481d40e1e65SBart Van Assche                print STDERR "${file}:$.: warning: " .
24824092bac7SYacine Belkadi                        "No description found for return value of " .
24834092bac7SYacine Belkadi                        "'$declaration_name'\n";
24844092bac7SYacine Belkadi                ++$warnings;
24854092bac7SYacine Belkadi        }
24864092bac7SYacine Belkadi}
24874092bac7SYacine Belkadi
24884092bac7SYacine Belkadi##
24891da177e4SLinus Torvalds# takes a function prototype and the name of the current file being
24901da177e4SLinus Torvalds# processed and spits out all the details stored in the global
24911da177e4SLinus Torvalds# arrays/hashes.
24921da177e4SLinus Torvaldssub dump_function($$) {
24931da177e4SLinus Torvalds    my $prototype = shift;
24941da177e4SLinus Torvalds    my $file = shift;
2495cbb4d3e6SHoria Geanta    my $noret = 0;
24961da177e4SLinus Torvalds
24971da177e4SLinus Torvalds    $prototype =~ s/^static +//;
24981da177e4SLinus Torvalds    $prototype =~ s/^extern +//;
24994dc3b16bSPavel Pisa    $prototype =~ s/^asmlinkage +//;
25001da177e4SLinus Torvalds    $prototype =~ s/^inline +//;
25011da177e4SLinus Torvalds    $prototype =~ s/^__inline__ +//;
250232e79401SRandy Dunlap    $prototype =~ s/^__inline +//;
250332e79401SRandy Dunlap    $prototype =~ s/^__always_inline +//;
250432e79401SRandy Dunlap    $prototype =~ s/^noinline +//;
250574fc5c65SRandy Dunlap    $prototype =~ s/__init +//;
250620072205SRandy Dunlap    $prototype =~ s/__init_or_module +//;
2507270a0096SRandy Dunlap    $prototype =~ s/__meminit +//;
250870c95b00SRandy Dunlap    $prototype =~ s/__must_check +//;
25090df7c0e3SRandy Dunlap    $prototype =~ s/__weak +//;
2510cbb4d3e6SHoria Geanta    my $define = $prototype =~ s/^#\s*define\s+//; #ak added
2511b1aaa546SPaolo Bonzini    $prototype =~ s/__attribute__\s*\(\(
2512b1aaa546SPaolo Bonzini            (?:
2513b1aaa546SPaolo Bonzini                 [\w\s]++          # attribute name
2514b1aaa546SPaolo Bonzini                 (?:\([^)]*+\))?   # attribute arguments
2515b1aaa546SPaolo Bonzini                 \s*+,?            # optional comma at the end
2516b1aaa546SPaolo Bonzini            )+
2517b1aaa546SPaolo Bonzini          \)\)\s+//x;
25181da177e4SLinus Torvalds
25191da177e4SLinus Torvalds    # Yes, this truly is vile.  We are looking for:
25201da177e4SLinus Torvalds    # 1. Return type (may be nothing if we're looking at a macro)
25211da177e4SLinus Torvalds    # 2. Function name
25221da177e4SLinus Torvalds    # 3. Function parameters.
25231da177e4SLinus Torvalds    #
25241da177e4SLinus Torvalds    # All the while we have to watch out for function pointer parameters
25251da177e4SLinus Torvalds    # (which IIRC is what the two sections are for), C types (these
25261da177e4SLinus Torvalds    # regexps don't even start to express all the possibilities), and
25271da177e4SLinus Torvalds    # so on.
25281da177e4SLinus Torvalds    #
25291da177e4SLinus Torvalds    # If you mess with these regexps, it's a good idea to check that
25301da177e4SLinus Torvalds    # the following functions' documentation still comes out right:
25311da177e4SLinus Torvalds    # - parport_register_device (function pointer parameters)
25321da177e4SLinus Torvalds    # - atomic_set (macro)
25339598f91fSMartin Waitz    # - pci_match_device, __copy_to_user (long return type)
25341da177e4SLinus Torvalds
2535cbb4d3e6SHoria Geanta    if ($define && $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s+/) {
2536cbb4d3e6SHoria Geanta        # This is an object-like macro, it has no return type and no parameter
2537cbb4d3e6SHoria Geanta        # list.
2538cbb4d3e6SHoria Geanta        # Function-like macros are not allowed to have spaces between
2539cbb4d3e6SHoria Geanta        # declaration_name and opening parenthesis (notice the \s+).
2540cbb4d3e6SHoria Geanta        $return_type = $1;
2541cbb4d3e6SHoria Geanta        $declaration_name = $2;
2542cbb4d3e6SHoria Geanta        $noret = 1;
2543cbb4d3e6SHoria Geanta    } elsif ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
25441da177e4SLinus Torvalds	$prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
25451da177e4SLinus Torvalds	$prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
25461da177e4SLinus Torvalds	$prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
254794b3e03cSRandy Dunlap	$prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
25481da177e4SLinus Torvalds	$prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
25491da177e4SLinus Torvalds	$prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
25501da177e4SLinus Torvalds	$prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
25511da177e4SLinus Torvalds	$prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
25521da177e4SLinus Torvalds	$prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
25531da177e4SLinus Torvalds	$prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
25541da177e4SLinus Torvalds	$prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
25551da177e4SLinus Torvalds	$prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
25569598f91fSMartin Waitz	$prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
25579598f91fSMartin Waitz	$prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2558412ecd77SRandy Dunlap	$prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2559412ecd77SRandy Dunlap	$prototype =~ m/^(\w+\s+\w+\s*\*\s*\w+\s*\*\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/)  {
25601da177e4SLinus Torvalds	$return_type = $1;
25611da177e4SLinus Torvalds	$declaration_name = $2;
25621da177e4SLinus Torvalds	my $args = $3;
25631da177e4SLinus Torvalds
25641da177e4SLinus Torvalds	create_parameterlist($args, ',', $file);
25651da177e4SLinus Torvalds    } else {
2566d40e1e65SBart Van Assche	print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype'\n";
25671da177e4SLinus Torvalds	return;
25681da177e4SLinus Torvalds    }
25691da177e4SLinus Torvalds
2570a1d94aa5SRandy Dunlap	my $prms = join " ", @parameterlist;
2571a1d94aa5SRandy Dunlap	check_sections($file, $declaration_name, "function", $sectcheck, $prms, "");
2572a1d94aa5SRandy Dunlap
25734092bac7SYacine Belkadi        # This check emits a lot of warnings at the moment, because many
25744092bac7SYacine Belkadi        # functions don't have a 'Return' doc section. So until the number
25754092bac7SYacine Belkadi        # of warnings goes sufficiently down, the check is only performed in
25764092bac7SYacine Belkadi        # verbose mode.
25774092bac7SYacine Belkadi        # TODO: always perform the check.
2578cbb4d3e6SHoria Geanta        if ($verbose && !$noret) {
25794092bac7SYacine Belkadi                check_return_section($file, $declaration_name, $return_type);
25804092bac7SYacine Belkadi        }
25814092bac7SYacine Belkadi
25821da177e4SLinus Torvalds    output_declaration($declaration_name,
25831da177e4SLinus Torvalds		       'function',
25841da177e4SLinus Torvalds		       {'function' => $declaration_name,
25851da177e4SLinus Torvalds			'module' => $modulename,
25861da177e4SLinus Torvalds			'functiontype' => $return_type,
25871da177e4SLinus Torvalds			'parameterlist' => \@parameterlist,
25881da177e4SLinus Torvalds			'parameterdescs' => \%parameterdescs,
25891da177e4SLinus Torvalds			'parametertypes' => \%parametertypes,
25901da177e4SLinus Torvalds			'sectionlist' => \@sectionlist,
25911da177e4SLinus Torvalds			'sections' => \%sections,
25921da177e4SLinus Torvalds			'purpose' => $declaration_purpose
25931da177e4SLinus Torvalds		       });
25941da177e4SLinus Torvalds}
25951da177e4SLinus Torvalds
25961da177e4SLinus Torvaldssub reset_state {
25971da177e4SLinus Torvalds    $function = "";
25981da177e4SLinus Torvalds    %parameterdescs = ();
25991da177e4SLinus Torvalds    %parametertypes = ();
26001da177e4SLinus Torvalds    @parameterlist = ();
26011da177e4SLinus Torvalds    %sections = ();
26021da177e4SLinus Torvalds    @sectionlist = ();
2603a1d94aa5SRandy Dunlap    $sectcheck = "";
2604a1d94aa5SRandy Dunlap    $struct_actual = "";
26051da177e4SLinus Torvalds    $prototype = "";
26061da177e4SLinus Torvalds
260748af606aSJani Nikula    $state = STATE_NORMAL;
260848af606aSJani Nikula    $inline_doc_state = STATE_INLINE_NA;
26091da177e4SLinus Torvalds}
26101da177e4SLinus Torvalds
261156afb0f8SJason Baronsub tracepoint_munge($) {
261256afb0f8SJason Baron	my $file = shift;
261356afb0f8SJason Baron	my $tracepointname = 0;
261456afb0f8SJason Baron	my $tracepointargs = 0;
261556afb0f8SJason Baron
261656afb0f8SJason Baron	if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
261756afb0f8SJason Baron		$tracepointname = $1;
261856afb0f8SJason Baron	}
26193a9089fdSJason Baron	if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
26203a9089fdSJason Baron		$tracepointname = $1;
26213a9089fdSJason Baron	}
26223a9089fdSJason Baron	if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
26233a9089fdSJason Baron		$tracepointname = $2;
26243a9089fdSJason Baron	}
26253a9089fdSJason Baron	$tracepointname =~ s/^\s+//; #strip leading whitespace
262656afb0f8SJason Baron	if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
262756afb0f8SJason Baron		$tracepointargs = $1;
262856afb0f8SJason Baron	}
262956afb0f8SJason Baron	if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
2630d40e1e65SBart Van Assche		print STDERR "${file}:$.: warning: Unrecognized tracepoint format: \n".
263156afb0f8SJason Baron			     "$prototype\n";
263256afb0f8SJason Baron	} else {
263356afb0f8SJason Baron		$prototype = "static inline void trace_$tracepointname($tracepointargs)";
263456afb0f8SJason Baron	}
263556afb0f8SJason Baron}
263656afb0f8SJason Baron
2637b4870bc5SRandy Dunlapsub syscall_munge() {
2638b4870bc5SRandy Dunlap	my $void = 0;
2639b4870bc5SRandy Dunlap
2640b4870bc5SRandy Dunlap	$prototype =~ s@[\r\n\t]+@ @gos; # strip newlines/CR's/tabs
2641b4870bc5SRandy Dunlap##	if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
2642b4870bc5SRandy Dunlap	if ($prototype =~ m/SYSCALL_DEFINE0/) {
2643b4870bc5SRandy Dunlap		$void = 1;
2644b4870bc5SRandy Dunlap##		$prototype = "long sys_$1(void)";
2645b4870bc5SRandy Dunlap	}
2646b4870bc5SRandy Dunlap
2647b4870bc5SRandy Dunlap	$prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
2648b4870bc5SRandy Dunlap	if ($prototype =~ m/long (sys_.*?),/) {
2649b4870bc5SRandy Dunlap		$prototype =~ s/,/\(/;
2650b4870bc5SRandy Dunlap	} elsif ($void) {
2651b4870bc5SRandy Dunlap		$prototype =~ s/\)/\(void\)/;
2652b4870bc5SRandy Dunlap	}
2653b4870bc5SRandy Dunlap
2654b4870bc5SRandy Dunlap	# now delete all of the odd-number commas in $prototype
2655b4870bc5SRandy Dunlap	# so that arg types & arg names don't have a comma between them
2656b4870bc5SRandy Dunlap	my $count = 0;
2657b4870bc5SRandy Dunlap	my $len = length($prototype);
2658b4870bc5SRandy Dunlap	if ($void) {
2659b4870bc5SRandy Dunlap		$len = 0;	# skip the for-loop
2660b4870bc5SRandy Dunlap	}
2661b4870bc5SRandy Dunlap	for (my $ix = 0; $ix < $len; $ix++) {
2662b4870bc5SRandy Dunlap		if (substr($prototype, $ix, 1) eq ',') {
2663b4870bc5SRandy Dunlap			$count++;
2664b4870bc5SRandy Dunlap			if ($count % 2 == 1) {
2665b4870bc5SRandy Dunlap				substr($prototype, $ix, 1) = ' ';
2666b4870bc5SRandy Dunlap			}
2667b4870bc5SRandy Dunlap		}
2668b4870bc5SRandy Dunlap	}
2669b4870bc5SRandy Dunlap}
2670b4870bc5SRandy Dunlap
2671b7afa92bSDaniel Vettersub process_proto_function($$) {
26721da177e4SLinus Torvalds    my $x = shift;
26731da177e4SLinus Torvalds    my $file = shift;
26741da177e4SLinus Torvalds
267551f5a0c8SRandy Dunlap    $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
267651f5a0c8SRandy Dunlap
2677890c78c2SRandy Dunlap    if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
26781da177e4SLinus Torvalds	# do nothing
26791da177e4SLinus Torvalds    }
26801da177e4SLinus Torvalds    elsif ($x =~ /([^\{]*)/) {
26811da177e4SLinus Torvalds	$prototype .= $1;
26821da177e4SLinus Torvalds    }
2683b4870bc5SRandy Dunlap
2684890c78c2SRandy Dunlap    if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
26851da177e4SLinus Torvalds	$prototype =~ s@/\*.*?\*/@@gos;	# strip comments.
26861da177e4SLinus Torvalds	$prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
26871da177e4SLinus Torvalds	$prototype =~ s@^\s+@@gos; # strip leading spaces
2688b4870bc5SRandy Dunlap	if ($prototype =~ /SYSCALL_DEFINE/) {
2689b4870bc5SRandy Dunlap		syscall_munge();
2690b4870bc5SRandy Dunlap	}
26913a9089fdSJason Baron	if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
26923a9089fdSJason Baron	    $prototype =~ /DEFINE_SINGLE_EVENT/)
26933a9089fdSJason Baron	{
269456afb0f8SJason Baron		tracepoint_munge($file);
269556afb0f8SJason Baron	}
26961da177e4SLinus Torvalds	dump_function($prototype, $file);
26971da177e4SLinus Torvalds	reset_state();
26981da177e4SLinus Torvalds    }
26991da177e4SLinus Torvalds}
27001da177e4SLinus Torvalds
2701b7afa92bSDaniel Vettersub process_proto_type($$) {
27021da177e4SLinus Torvalds    my $x = shift;
27031da177e4SLinus Torvalds    my $file = shift;
27041da177e4SLinus Torvalds
27051da177e4SLinus Torvalds    $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
27061da177e4SLinus Torvalds    $x =~ s@^\s+@@gos; # strip leading spaces
27071da177e4SLinus Torvalds    $x =~ s@\s+$@@gos; # strip trailing spaces
270851f5a0c8SRandy Dunlap    $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
270951f5a0c8SRandy Dunlap
27101da177e4SLinus Torvalds    if ($x =~ /^#/) {
27111da177e4SLinus Torvalds	# To distinguish preprocessor directive from regular declaration later.
27121da177e4SLinus Torvalds	$x .= ";";
27131da177e4SLinus Torvalds    }
27141da177e4SLinus Torvalds
27151da177e4SLinus Torvalds    while (1) {
27161da177e4SLinus Torvalds	if ( $x =~ /([^{};]*)([{};])(.*)/ ) {
27171da177e4SLinus Torvalds	    $prototype .= $1 . $2;
27181da177e4SLinus Torvalds	    ($2 eq '{') && $brcount++;
27191da177e4SLinus Torvalds	    ($2 eq '}') && $brcount--;
27201da177e4SLinus Torvalds	    if (($2 eq ';') && ($brcount == 0)) {
27211da177e4SLinus Torvalds		dump_declaration($prototype, $file);
27221da177e4SLinus Torvalds		reset_state();
27231da177e4SLinus Torvalds		last;
27241da177e4SLinus Torvalds	    }
27251da177e4SLinus Torvalds	    $x = $3;
27261da177e4SLinus Torvalds	} else {
27271da177e4SLinus Torvalds	    $prototype .= $x;
27281da177e4SLinus Torvalds	    last;
27291da177e4SLinus Torvalds	}
27301da177e4SLinus Torvalds    }
27311da177e4SLinus Torvalds}
27321da177e4SLinus Torvalds
27336b5b55f6SRandy Dunlap# xml_escape: replace <, >, and & in the text stream;
27346b5b55f6SRandy Dunlap#
27356b5b55f6SRandy Dunlap# however, formatting controls that are generated internally/locally in the
27366b5b55f6SRandy Dunlap# kernel-doc script are not escaped here; instead, they begin life like
27376b5b55f6SRandy Dunlap# $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings
27386b5b55f6SRandy Dunlap# are converted to their mnemonic-expected output, without the 4 * '\' & ':',
27396b5b55f6SRandy Dunlap# just before actual output; (this is done by local_unescape())
27401da177e4SLinus Torvaldssub xml_escape($) {
27411da177e4SLinus Torvalds	my $text = shift;
2742ecfb251aSRandy Dunlap	if (($output_mode eq "text") || ($output_mode eq "man")) {
2743ecfb251aSRandy Dunlap		return $text;
2744ecfb251aSRandy Dunlap	}
27451da177e4SLinus Torvalds	$text =~ s/\&/\\\\\\amp;/g;
27461da177e4SLinus Torvalds	$text =~ s/\</\\\\\\lt;/g;
27471da177e4SLinus Torvalds	$text =~ s/\>/\\\\\\gt;/g;
27481da177e4SLinus Torvalds	return $text;
27491da177e4SLinus Torvalds}
27501da177e4SLinus Torvalds
2751c0d1b6eeSJonathan Corbet# xml_unescape: reverse the effects of xml_escape
2752c0d1b6eeSJonathan Corbetsub xml_unescape($) {
2753c0d1b6eeSJonathan Corbet	my $text = shift;
2754c0d1b6eeSJonathan Corbet	if (($output_mode eq "text") || ($output_mode eq "man")) {
2755c0d1b6eeSJonathan Corbet		return $text;
2756c0d1b6eeSJonathan Corbet	}
2757c0d1b6eeSJonathan Corbet	$text =~ s/\\\\\\amp;/\&/g;
2758c0d1b6eeSJonathan Corbet	$text =~ s/\\\\\\lt;/</g;
2759c0d1b6eeSJonathan Corbet	$text =~ s/\\\\\\gt;/>/g;
2760c0d1b6eeSJonathan Corbet	return $text;
2761c0d1b6eeSJonathan Corbet}
2762c0d1b6eeSJonathan Corbet
27636b5b55f6SRandy Dunlap# convert local escape strings to html
27646b5b55f6SRandy Dunlap# local escape strings look like:  '\\\\menmonic:' (that's 4 backslashes)
27656b5b55f6SRandy Dunlapsub local_unescape($) {
27666b5b55f6SRandy Dunlap	my $text = shift;
27676b5b55f6SRandy Dunlap	if (($output_mode eq "text") || ($output_mode eq "man")) {
27686b5b55f6SRandy Dunlap		return $text;
27696b5b55f6SRandy Dunlap	}
27706b5b55f6SRandy Dunlap	$text =~ s/\\\\\\\\lt:/</g;
27716b5b55f6SRandy Dunlap	$text =~ s/\\\\\\\\gt:/>/g;
27726b5b55f6SRandy Dunlap	return $text;
27736b5b55f6SRandy Dunlap}
27746b5b55f6SRandy Dunlap
27751ad560e4SJani Nikulasub map_filename($) {
27761ad560e4SJani Nikula    my $file;
27771ad560e4SJani Nikula    my ($orig_file) = @_;
27781ad560e4SJani Nikula
27791ad560e4SJani Nikula    if (defined($ENV{'SRCTREE'})) {
27801ad560e4SJani Nikula	$file = "$ENV{'SRCTREE'}" . "/" . $orig_file;
27811ad560e4SJani Nikula    } else {
27821ad560e4SJani Nikula	$file = $orig_file;
27831ad560e4SJani Nikula    }
27841ad560e4SJani Nikula
27851ad560e4SJani Nikula    if (defined($source_map{$file})) {
27861ad560e4SJani Nikula	$file = $source_map{$file};
27871ad560e4SJani Nikula    }
27881ad560e4SJani Nikula
27891ad560e4SJani Nikula    return $file;
27901ad560e4SJani Nikula}
27911ad560e4SJani Nikula
279288c2b57dSJani Nikulasub process_export_file($) {
279388c2b57dSJani Nikula    my ($orig_file) = @_;
279488c2b57dSJani Nikula    my $file = map_filename($orig_file);
279588c2b57dSJani Nikula
279688c2b57dSJani Nikula    if (!open(IN,"<$file")) {
279788c2b57dSJani Nikula	print STDERR "Error: Cannot open file $file\n";
279888c2b57dSJani Nikula	++$errors;
279988c2b57dSJani Nikula	return;
280088c2b57dSJani Nikula    }
280188c2b57dSJani Nikula
280288c2b57dSJani Nikula    while (<IN>) {
280388c2b57dSJani Nikula	if (/$export_symbol/) {
280488c2b57dSJani Nikula	    $function_table{$2} = 1;
280588c2b57dSJani Nikula	}
280688c2b57dSJani Nikula    }
280788c2b57dSJani Nikula
280888c2b57dSJani Nikula    close(IN);
280988c2b57dSJani Nikula}
281088c2b57dSJani Nikula
28111da177e4SLinus Torvaldssub process_file($) {
28122283a117SRandy Dunlap    my $file;
28131da177e4SLinus Torvalds    my $identifier;
28141da177e4SLinus Torvalds    my $func;
2815a21217daSRandy Dunlap    my $descr;
28166423133bSJohannes Weiner    my $in_purpose = 0;
28171da177e4SLinus Torvalds    my $initial_section_counter = $section_counter;
281868f86662SBen Hutchings    my ($orig_file) = @_;
2819b7886de4SJani Nikula    my $leading_space;
28201da177e4SLinus Torvalds
28211ad560e4SJani Nikula    $file = map_filename($orig_file);
28221da177e4SLinus Torvalds
28231da177e4SLinus Torvalds    if (!open(IN,"<$file")) {
28241da177e4SLinus Torvalds	print STDERR "Error: Cannot open file $file\n";
28251da177e4SLinus Torvalds	++$errors;
28261da177e4SLinus Torvalds	return;
28271da177e4SLinus Torvalds    }
28281da177e4SLinus Torvalds
2829a9e7314bSIlya Dryomov    $. = 1;
2830a9e7314bSIlya Dryomov
28311da177e4SLinus Torvalds    $section_counter = 0;
28321da177e4SLinus Torvalds    while (<IN>) {
283365478428SDaniel Santos	while (s/\\\s*$//) {
283465478428SDaniel Santos	    $_ .= <IN>;
283565478428SDaniel Santos	}
283648af606aSJani Nikula	if ($state == STATE_NORMAL) {
28371da177e4SLinus Torvalds	    if (/$doc_start/o) {
283848af606aSJani Nikula		$state = STATE_NAME;	# next line is always the function name
2839850622dfSRandy Dunlap		$in_doc_sect = 0;
28400b0f5f29SDaniel Vetter		$declaration_start_line = $. + 1;
28411da177e4SLinus Torvalds	    }
284248af606aSJani Nikula	} elsif ($state == STATE_NAME) {# this line is the function name (always)
28431da177e4SLinus Torvalds	    if (/$doc_block/o) {
284448af606aSJani Nikula		$state = STATE_DOCBLOCK;
28451da177e4SLinus Torvalds		$contents = "";
28460b0f5f29SDaniel Vetter                $new_start_line = $. + 1;
28470b0f5f29SDaniel Vetter
28481da177e4SLinus Torvalds		if ( $1 eq "" ) {
28491da177e4SLinus Torvalds			$section = $section_intro;
28501da177e4SLinus Torvalds		} else {
28511da177e4SLinus Torvalds			$section = $1;
28521da177e4SLinus Torvalds		}
28531da177e4SLinus Torvalds	    }
28541da177e4SLinus Torvalds	    elsif (/$doc_decl/o) {
28551da177e4SLinus Torvalds		$identifier = $1;
28561da177e4SLinus Torvalds		if (/\s*([\w\s]+?)\s*-/) {
28571da177e4SLinus Torvalds		    $identifier = $1;
28581da177e4SLinus Torvalds		}
28591da177e4SLinus Torvalds
286048af606aSJani Nikula		$state = STATE_FIELD;
28610b0f5f29SDaniel Vetter		# if there's no @param blocks need to set up default section
28620b0f5f29SDaniel Vetter		# here
28632f4ad40aSJani Nikula		$contents = "";
28642f4ad40aSJani Nikula		$section = $section_default;
28650b0f5f29SDaniel Vetter		$new_start_line = $. + 1;
28661da177e4SLinus Torvalds		if (/-(.*)/) {
286751f5a0c8SRandy Dunlap		    # strip leading/trailing/multiple spaces
2868a21217daSRandy Dunlap		    $descr= $1;
2869a21217daSRandy Dunlap		    $descr =~ s/^\s*//;
2870a21217daSRandy Dunlap		    $descr =~ s/\s*$//;
287112ae6779SDaniel Santos		    $descr =~ s/\s+/ /g;
2872a21217daSRandy Dunlap		    $declaration_purpose = xml_escape($descr);
28736423133bSJohannes Weiner		    $in_purpose = 1;
28741da177e4SLinus Torvalds		} else {
28751da177e4SLinus Torvalds		    $declaration_purpose = "";
28761da177e4SLinus Torvalds		}
287777cc23b8SRandy Dunlap
287877cc23b8SRandy Dunlap		if (($declaration_purpose eq "") && $verbose) {
2879d40e1e65SBart Van Assche			print STDERR "${file}:$.: warning: missing initial short description on line:\n";
288077cc23b8SRandy Dunlap			print STDERR $_;
288177cc23b8SRandy Dunlap			++$warnings;
288277cc23b8SRandy Dunlap		}
288377cc23b8SRandy Dunlap
28841da177e4SLinus Torvalds		if ($identifier =~ m/^struct/) {
28851da177e4SLinus Torvalds		    $decl_type = 'struct';
28861da177e4SLinus Torvalds		} elsif ($identifier =~ m/^union/) {
28871da177e4SLinus Torvalds		    $decl_type = 'union';
28881da177e4SLinus Torvalds		} elsif ($identifier =~ m/^enum/) {
28891da177e4SLinus Torvalds		    $decl_type = 'enum';
28901da177e4SLinus Torvalds		} elsif ($identifier =~ m/^typedef/) {
28911da177e4SLinus Torvalds		    $decl_type = 'typedef';
28921da177e4SLinus Torvalds		} else {
28931da177e4SLinus Torvalds		    $decl_type = 'function';
28941da177e4SLinus Torvalds		}
28951da177e4SLinus Torvalds
28961da177e4SLinus Torvalds		if ($verbose) {
2897d40e1e65SBart Van Assche		    print STDERR "${file}:$.: info: Scanning doc for $identifier\n";
28981da177e4SLinus Torvalds		}
28991da177e4SLinus Torvalds	    } else {
2900d40e1e65SBart Van Assche		print STDERR "${file}:$.: warning: Cannot understand $_ on line $.",
29011da177e4SLinus Torvalds		" - I thought it was a doc line\n";
29021da177e4SLinus Torvalds		++$warnings;
290348af606aSJani Nikula		$state = STATE_NORMAL;
29041da177e4SLinus Torvalds	    }
290548af606aSJani Nikula	} elsif ($state == STATE_FIELD) {	# look for head: lines, and include content
2906f624adefSJani Nikula	    if (/$doc_sect/i) { # case insensitive for supported section names
29071da177e4SLinus Torvalds		$newsection = $1;
29081da177e4SLinus Torvalds		$newcontents = $2;
29091da177e4SLinus Torvalds
2910f624adefSJani Nikula		# map the supported section names to the canonical names
2911f624adefSJani Nikula		if ($newsection =~ m/^description$/i) {
2912f624adefSJani Nikula		    $newsection = $section_default;
2913f624adefSJani Nikula		} elsif ($newsection =~ m/^context$/i) {
2914f624adefSJani Nikula		    $newsection = $section_context;
2915f624adefSJani Nikula		} elsif ($newsection =~ m/^returns?$/i) {
2916f624adefSJani Nikula		    $newsection = $section_return;
2917f624adefSJani Nikula		} elsif ($newsection =~ m/^\@return$/) {
2918f624adefSJani Nikula		    # special: @return is a section, not a param description
2919f624adefSJani Nikula		    $newsection = $section_return;
2920f624adefSJani Nikula		}
2921f624adefSJani Nikula
2922792aa2f2SRandy Dunlap		if (($contents ne "") && ($contents ne "\n")) {
2923850622dfSRandy Dunlap		    if (!$in_doc_sect && $verbose) {
2924d40e1e65SBart Van Assche			print STDERR "${file}:$.: warning: contents before sections\n";
2925850622dfSRandy Dunlap			++$warnings;
2926850622dfSRandy Dunlap		    }
292794dc7ad5SRandy Dunlap		    dump_section($file, $section, xml_escape($contents));
29281da177e4SLinus Torvalds		    $section = $section_default;
29291da177e4SLinus Torvalds		}
29301da177e4SLinus Torvalds
2931850622dfSRandy Dunlap		$in_doc_sect = 1;
29326423133bSJohannes Weiner		$in_purpose = 0;
29331da177e4SLinus Torvalds		$contents = $newcontents;
29340b0f5f29SDaniel Vetter                $new_start_line = $.;
293527205744SRandy Dunlap		while ((substr($contents, 0, 1) eq " ") ||
293627205744SRandy Dunlap		       substr($contents, 0, 1) eq "\t") {
293705189497SRandy Dunlap		    $contents = substr($contents, 1);
293805189497SRandy Dunlap		}
29390a726301SJani Nikula		if ($contents ne "") {
29401da177e4SLinus Torvalds		    $contents .= "\n";
29411da177e4SLinus Torvalds		}
29421da177e4SLinus Torvalds		$section = $newsection;
2943b7886de4SJani Nikula		$leading_space = undef;
29441da177e4SLinus Torvalds	    } elsif (/$doc_end/) {
29454c98ecafSRandy Dunlap		if (($contents ne "") && ($contents ne "\n")) {
294694dc7ad5SRandy Dunlap		    dump_section($file, $section, xml_escape($contents));
29471da177e4SLinus Torvalds		    $section = $section_default;
29481da177e4SLinus Torvalds		    $contents = "";
29491da177e4SLinus Torvalds		}
295046b958ebSRandy Dunlap		# look for doc_com + <text> + doc_end:
295146b958ebSRandy Dunlap		if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2952d40e1e65SBart Van Assche		    print STDERR "${file}:$.: warning: suspicious ending line: $_";
295346b958ebSRandy Dunlap		    ++$warnings;
295446b958ebSRandy Dunlap		}
29551da177e4SLinus Torvalds
29561da177e4SLinus Torvalds		$prototype = "";
295748af606aSJani Nikula		$state = STATE_PROTO;
29581da177e4SLinus Torvalds		$brcount = 0;
29591da177e4SLinus Torvalds#		print STDERR "end of doc comment, looking for prototype\n";
29601da177e4SLinus Torvalds	    } elsif (/$doc_content/) {
29611da177e4SLinus Torvalds		# miguel-style comment kludge, look for blank lines after
29621da177e4SLinus Torvalds		# @parameter line to signify start of description
29636423133bSJohannes Weiner		if ($1 eq "") {
29646423133bSJohannes Weiner		    if ($section =~ m/^@/ || $section eq $section_context) {
296594dc7ad5SRandy Dunlap			dump_section($file, $section, xml_escape($contents));
29661da177e4SLinus Torvalds			$section = $section_default;
29671da177e4SLinus Torvalds			$contents = "";
29680b0f5f29SDaniel Vetter                        $new_start_line = $.;
29691da177e4SLinus Torvalds		    } else {
29706423133bSJohannes Weiner			$contents .= "\n";
29716423133bSJohannes Weiner		    }
29726423133bSJohannes Weiner		    $in_purpose = 0;
29736423133bSJohannes Weiner		} elsif ($in_purpose == 1) {
29746423133bSJohannes Weiner		    # Continued declaration purpose
29756423133bSJohannes Weiner		    chomp($declaration_purpose);
29766423133bSJohannes Weiner		    $declaration_purpose .= " " . xml_escape($1);
297712ae6779SDaniel Santos		    $declaration_purpose =~ s/\s+/ /g;
29786423133bSJohannes Weiner		} else {
2979b7886de4SJani Nikula		    my $cont = $1;
2980b7886de4SJani Nikula		    if ($section =~ m/^@/ || $section eq $section_context) {
2981b7886de4SJani Nikula			if (!defined $leading_space) {
2982b7886de4SJani Nikula			    if ($cont =~ m/^(\s+)/) {
2983b7886de4SJani Nikula				$leading_space = $1;
2984b7886de4SJani Nikula			    } else {
2985b7886de4SJani Nikula				$leading_space = "";
2986b7886de4SJani Nikula			    }
2987b7886de4SJani Nikula			}
2988b7886de4SJani Nikula
2989b7886de4SJani Nikula			$cont =~ s/^$leading_space//;
2990b7886de4SJani Nikula		    }
2991b7886de4SJani Nikula		    $contents .= $cont . "\n";
29921da177e4SLinus Torvalds		}
29931da177e4SLinus Torvalds	    } else {
29941da177e4SLinus Torvalds		# i dont know - bad line?  ignore.
2995d40e1e65SBart Van Assche		print STDERR "${file}:$.: warning: bad line: $_";
29961da177e4SLinus Torvalds		++$warnings;
29971da177e4SLinus Torvalds	    }
299848af606aSJani Nikula	} elsif ($state == STATE_INLINE) { # scanning for inline parameters
2999a4c6ebedSDanilo Cesar Lemes de Paula	    # First line (state 1) needs to be a @parameter
300048af606aSJani Nikula	    if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) {
3001a4c6ebedSDanilo Cesar Lemes de Paula		$section = $1;
3002a4c6ebedSDanilo Cesar Lemes de Paula		$contents = $2;
30030b0f5f29SDaniel Vetter                $new_start_line = $.;
3004a4c6ebedSDanilo Cesar Lemes de Paula		if ($contents ne "") {
3005a4c6ebedSDanilo Cesar Lemes de Paula		    while ((substr($contents, 0, 1) eq " ") ||
3006a4c6ebedSDanilo Cesar Lemes de Paula		           substr($contents, 0, 1) eq "\t") {
3007a4c6ebedSDanilo Cesar Lemes de Paula			$contents = substr($contents, 1);
3008a4c6ebedSDanilo Cesar Lemes de Paula		    }
3009a4c6ebedSDanilo Cesar Lemes de Paula		    $contents .= "\n";
3010a4c6ebedSDanilo Cesar Lemes de Paula		}
301148af606aSJani Nikula		$inline_doc_state = STATE_INLINE_TEXT;
3012a4c6ebedSDanilo Cesar Lemes de Paula	    # Documentation block end */
301348af606aSJani Nikula	    } elsif (/$doc_inline_end/) {
3014a4c6ebedSDanilo Cesar Lemes de Paula		if (($contents ne "") && ($contents ne "\n")) {
3015a4c6ebedSDanilo Cesar Lemes de Paula		    dump_section($file, $section, xml_escape($contents));
3016a4c6ebedSDanilo Cesar Lemes de Paula		    $section = $section_default;
3017a4c6ebedSDanilo Cesar Lemes de Paula		    $contents = "";
3018a4c6ebedSDanilo Cesar Lemes de Paula		}
301948af606aSJani Nikula		$state = STATE_PROTO;
302048af606aSJani Nikula		$inline_doc_state = STATE_INLINE_NA;
3021a4c6ebedSDanilo Cesar Lemes de Paula	    # Regular text
3022a4c6ebedSDanilo Cesar Lemes de Paula	    } elsif (/$doc_content/) {
302348af606aSJani Nikula		if ($inline_doc_state == STATE_INLINE_TEXT) {
3024a4c6ebedSDanilo Cesar Lemes de Paula		    $contents .= $1 . "\n";
30256450c895SJani Nikula		    # nuke leading blank lines
30266450c895SJani Nikula		    if ($contents =~ /^\s*$/) {
30276450c895SJani Nikula			$contents = "";
30286450c895SJani Nikula		    }
302948af606aSJani Nikula		} elsif ($inline_doc_state == STATE_INLINE_NAME) {
303048af606aSJani Nikula		    $inline_doc_state = STATE_INLINE_ERROR;
3031e7ca311eSDaniel Vetter		    print STDERR "${file}:$.: warning: ";
3032a4c6ebedSDanilo Cesar Lemes de Paula		    print STDERR "Incorrect use of kernel-doc format: $_";
3033a4c6ebedSDanilo Cesar Lemes de Paula		    ++$warnings;
3034a4c6ebedSDanilo Cesar Lemes de Paula		}
3035a4c6ebedSDanilo Cesar Lemes de Paula	    }
303648af606aSJani Nikula	} elsif ($state == STATE_PROTO) {	# scanning for function '{' (end of prototype)
30370c9aa209SJani Nikula	    if (/$doc_inline_oneline/) {
30380c9aa209SJani Nikula		$section = $1;
30390c9aa209SJani Nikula		$contents = $2;
30400c9aa209SJani Nikula		if ($contents ne "") {
30410c9aa209SJani Nikula		    $contents .= "\n";
30420c9aa209SJani Nikula		    dump_section($file, $section, xml_escape($contents));
30430c9aa209SJani Nikula		    $section = $section_default;
30440c9aa209SJani Nikula		    $contents = "";
30450c9aa209SJani Nikula		}
30460c9aa209SJani Nikula	    } elsif (/$doc_inline_start/) {
304748af606aSJani Nikula		$state = STATE_INLINE;
304848af606aSJani Nikula		$inline_doc_state = STATE_INLINE_NAME;
3049a4c6ebedSDanilo Cesar Lemes de Paula	    } elsif ($decl_type eq 'function') {
3050b7afa92bSDaniel Vetter		process_proto_function($_, $file);
30511da177e4SLinus Torvalds	    } else {
3052b7afa92bSDaniel Vetter		process_proto_type($_, $file);
30531da177e4SLinus Torvalds	    }
305448af606aSJani Nikula	} elsif ($state == STATE_DOCBLOCK) {
3055ebff7f92SDaniel Vetter		if (/$doc_end/)
30561da177e4SLinus Torvalds		{
305794dc7ad5SRandy Dunlap			dump_doc_section($file, $section, xml_escape($contents));
30582f4ad40aSJani Nikula			$section = $section_default;
30591da177e4SLinus Torvalds			$contents = "";
30601da177e4SLinus Torvalds			$function = "";
30611da177e4SLinus Torvalds			%parameterdescs = ();
30621da177e4SLinus Torvalds			%parametertypes = ();
30631da177e4SLinus Torvalds			@parameterlist = ();
30641da177e4SLinus Torvalds			%sections = ();
30651da177e4SLinus Torvalds			@sectionlist = ();
30661da177e4SLinus Torvalds			$prototype = "";
306748af606aSJani Nikula			$state = STATE_NORMAL;
30681da177e4SLinus Torvalds		}
30691da177e4SLinus Torvalds		elsif (/$doc_content/)
30701da177e4SLinus Torvalds		{
30711da177e4SLinus Torvalds			if ( $1 eq "" )
30721da177e4SLinus Torvalds			{
30731da177e4SLinus Torvalds				$contents .= $blankline;
30741da177e4SLinus Torvalds			}
30751da177e4SLinus Torvalds			else
30761da177e4SLinus Torvalds			{
30771da177e4SLinus Torvalds				$contents .= $1 . "\n";
30781da177e4SLinus Torvalds			}
30791da177e4SLinus Torvalds		}
30801da177e4SLinus Torvalds	}
30811da177e4SLinus Torvalds    }
30821da177e4SLinus Torvalds    if ($initial_section_counter == $section_counter) {
3083d40e1e65SBart Van Assche	print STDERR "${file}:1: warning: no structured comments found\n";
3084b6c3f456SJani Nikula	if (($output_selection == OUTPUT_INCLUDE) && ($show_not_found == 1)) {
3085e946c43aSJohannes Berg	    print STDERR "    Was looking for '$_'.\n" for keys %function_table;
3086e946c43aSJohannes Berg	}
30871da177e4SLinus Torvalds	if ($output_mode eq "xml") {
30881da177e4SLinus Torvalds	    # The template wants at least one RefEntry here; make one.
30891da177e4SLinus Torvalds	    print "<refentry>\n";
30901da177e4SLinus Torvalds	    print " <refnamediv>\n";
30911da177e4SLinus Torvalds	    print "  <refname>\n";
309268f86662SBen Hutchings	    print "   ${orig_file}\n";
30931da177e4SLinus Torvalds	    print "  </refname>\n";
30941da177e4SLinus Torvalds	    print "  <refpurpose>\n";
30951da177e4SLinus Torvalds	    print "   Document generation inconsistency\n";
30961da177e4SLinus Torvalds	    print "  </refpurpose>\n";
30971da177e4SLinus Torvalds	    print " </refnamediv>\n";
30981da177e4SLinus Torvalds	    print " <refsect1>\n";
30991da177e4SLinus Torvalds	    print "  <title>\n";
31001da177e4SLinus Torvalds	    print "   Oops\n";
31011da177e4SLinus Torvalds	    print "  </title>\n";
31021da177e4SLinus Torvalds	    print "  <warning>\n";
31031da177e4SLinus Torvalds	    print "   <para>\n";
31041da177e4SLinus Torvalds	    print "    The template for this document tried to insert\n";
31051da177e4SLinus Torvalds	    print "    the structured comment from the file\n";
310668f86662SBen Hutchings	    print "    <filename>${orig_file}</filename> at this point,\n";
31071da177e4SLinus Torvalds	    print "    but none was found.\n";
31081da177e4SLinus Torvalds	    print "    This dummy section is inserted to allow\n";
31091da177e4SLinus Torvalds	    print "    generation to continue.\n";
31101da177e4SLinus Torvalds	    print "   </para>\n";
31111da177e4SLinus Torvalds	    print "  </warning>\n";
31121da177e4SLinus Torvalds	    print " </refsect1>\n";
31131da177e4SLinus Torvalds	    print "</refentry>\n";
31141da177e4SLinus Torvalds	}
31151da177e4SLinus Torvalds    }
31161da177e4SLinus Torvalds}
31178484baaaSRandy Dunlap
31188484baaaSRandy Dunlap
31198484baaaSRandy Dunlap$kernelversion = get_kernel_version();
31208484baaaSRandy Dunlap
31218484baaaSRandy Dunlap# generate a sequence of code that will splice in highlighting information
31228484baaaSRandy Dunlap# using the s// operator.
31231ef06233SMauro Carvalho Chehabfor (my $k = 0; $k < @highlights; $k++) {
31244d732701SDanilo Cesar Lemes de Paula    my $pattern = $highlights[$k][0];
31254d732701SDanilo Cesar Lemes de Paula    my $result = $highlights[$k][1];
31264d732701SDanilo Cesar Lemes de Paula#   print STDERR "scanning pattern:$pattern, highlight:($result)\n";
31274d732701SDanilo Cesar Lemes de Paula    $dohighlight .=  "\$contents =~ s:$pattern:$result:gs;\n";
31288484baaaSRandy Dunlap}
31298484baaaSRandy Dunlap
31308484baaaSRandy Dunlap# Read the file that maps relative names to absolute names for
31318484baaaSRandy Dunlap# separate source and object directories and for shadow trees.
31328484baaaSRandy Dunlapif (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
31338484baaaSRandy Dunlap	my ($relname, $absname);
31348484baaaSRandy Dunlap	while(<SOURCE_MAP>) {
31358484baaaSRandy Dunlap		chop();
31368484baaaSRandy Dunlap		($relname, $absname) = (split())[0..1];
31378484baaaSRandy Dunlap		$relname =~ s:^/+::;
31388484baaaSRandy Dunlap		$source_map{$relname} = $absname;
31398484baaaSRandy Dunlap	}
31408484baaaSRandy Dunlap	close(SOURCE_MAP);
31418484baaaSRandy Dunlap}
31428484baaaSRandy Dunlap
314388c2b57dSJani Nikulaif ($output_selection == OUTPUT_EXPORTED ||
314488c2b57dSJani Nikula    $output_selection == OUTPUT_INTERNAL) {
3145c9b2cfb3SJani Nikula
3146c9b2cfb3SJani Nikula    push(@export_file_list, @ARGV);
3147c9b2cfb3SJani Nikula
314888c2b57dSJani Nikula    foreach (@export_file_list) {
314988c2b57dSJani Nikula	chomp;
315088c2b57dSJani Nikula	process_export_file($_);
315188c2b57dSJani Nikula    }
315288c2b57dSJani Nikula}
315388c2b57dSJani Nikula
31548484baaaSRandy Dunlapforeach (@ARGV) {
31558484baaaSRandy Dunlap    chomp;
31568484baaaSRandy Dunlap    process_file($_);
31578484baaaSRandy Dunlap}
31588484baaaSRandy Dunlapif ($verbose && $errors) {
31598484baaaSRandy Dunlap  print STDERR "$errors errors\n";
31608484baaaSRandy Dunlap}
31618484baaaSRandy Dunlapif ($verbose && $warnings) {
31628484baaaSRandy Dunlap  print STDERR "$warnings warnings\n";
31638484baaaSRandy Dunlap}
31648484baaaSRandy Dunlap
31658484baaaSRandy Dunlapexit($errors);
3166