xref: /openbmc/qemu/scripts/kernel-doc (revision eb4c9775089f355db9cb6292a947aa5cba6c380b)
1 e2c54635SPaolo Bonzini#!/usr/bin/env perl
2 e2c54635SPaolo Bonzini# SPDX-License-Identifier: GPL-2.0
3 e2c54635SPaolo Bonzini
4 e2c54635SPaolo Bonziniuse warnings;
5 e2c54635SPaolo Bonziniuse strict;
6 e2c54635SPaolo Bonzini
7 e2c54635SPaolo Bonzini## Copyright (c) 1998 Michael Zucchi, All Rights Reserved        ##
8 e2c54635SPaolo Bonzini## Copyright (C) 2000, 1  Tim Waugh <twaugh@redhat.com>          ##
9 e2c54635SPaolo Bonzini## Copyright (C) 2001  Simon Huggins                             ##
10 e2c54635SPaolo Bonzini## Copyright (C) 2005-2012  Randy Dunlap                         ##
11 e2c54635SPaolo Bonzini## Copyright (C) 2012  Dan Luedtke                               ##
12 e2c54635SPaolo Bonzini## 								 ##
13 e2c54635SPaolo Bonzini## #define enhancements by Armin Kuster <akuster@mvista.com>	 ##
14 e2c54635SPaolo Bonzini## Copyright (c) 2000 MontaVista Software, Inc.			 ##
15 e2c54635SPaolo Bonzini## 								 ##
16 e2c54635SPaolo Bonzini## This software falls under the GNU General Public License.     ##
17 e2c54635SPaolo Bonzini## Please read the COPYING file for more information             ##
18 e2c54635SPaolo Bonzini
19 e2c54635SPaolo Bonzini# 18/01/2001 - 	Cleanups
20 e2c54635SPaolo Bonzini# 		Functions prototyped as foo(void) same as foo()
21 e2c54635SPaolo Bonzini# 		Stop eval'ing where we don't need to.
22 e2c54635SPaolo Bonzini# -- huggie@earth.li
23 e2c54635SPaolo Bonzini
24 e2c54635SPaolo Bonzini# 27/06/2001 -  Allowed whitespace after initial "/**" and
25 e2c54635SPaolo Bonzini#               allowed comments before function declarations.
26 e2c54635SPaolo Bonzini# -- Christian Kreibich <ck@whoop.org>
27 e2c54635SPaolo Bonzini
28 e2c54635SPaolo Bonzini# Still to do:
29 e2c54635SPaolo Bonzini# 	- add perldoc documentation
30 e2c54635SPaolo Bonzini# 	- Look more closely at some of the scarier bits :)
31 e2c54635SPaolo Bonzini
32 e2c54635SPaolo Bonzini# 26/05/2001 - 	Support for separate source and object trees.
33 e2c54635SPaolo Bonzini#		Return error code.
34 e2c54635SPaolo Bonzini# 		Keith Owens <kaos@ocs.com.au>
35 e2c54635SPaolo Bonzini
36 e2c54635SPaolo Bonzini# 23/09/2001 - Added support for typedefs, structs, enums and unions
37 e2c54635SPaolo Bonzini#              Support for Context section; can be terminated using empty line
38 e2c54635SPaolo Bonzini#              Small fixes (like spaces vs. \s in regex)
39 e2c54635SPaolo Bonzini# -- Tim Jansen <tim@tjansen.de>
40 e2c54635SPaolo Bonzini
41 e2c54635SPaolo Bonzini# 25/07/2012 - Added support for HTML5
42 e2c54635SPaolo Bonzini# -- Dan Luedtke <mail@danrl.de>
43 e2c54635SPaolo Bonzini
44 e2c54635SPaolo Bonzinisub usage {
45 e2c54635SPaolo Bonzini    my $message = <<"EOF";
46 e2c54635SPaolo BonziniUsage: $0 [OPTION ...] FILE ...
47 e2c54635SPaolo Bonzini
48 e2c54635SPaolo BonziniRead C language source or header FILEs, extract embedded documentation comments,
49 e2c54635SPaolo Bonziniand print formatted documentation to standard output.
50 e2c54635SPaolo Bonzini
51 e2c54635SPaolo BonziniThe documentation comments are identified by "/**" opening comment mark. See
52 e2c54635SPaolo BonziniDocumentation/doc-guide/kernel-doc.rst for the documentation comment syntax.
53 e2c54635SPaolo Bonzini
54 e2c54635SPaolo BonziniOutput format selection (mutually exclusive):
55 e2c54635SPaolo Bonzini  -man			Output troff manual page format. This is the default.
56 e2c54635SPaolo Bonzini  -rst			Output reStructuredText format.
57 e2c54635SPaolo Bonzini  -none			Do not output documentation, only warnings.
58 e2c54635SPaolo Bonzini
59 e2c54635SPaolo BonziniOutput selection (mutually exclusive):
60 e2c54635SPaolo Bonzini  -export		Only output documentation for symbols that have been
61 e2c54635SPaolo Bonzini			exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
62 e2c54635SPaolo Bonzini                        in any input FILE or -export-file FILE.
63 e2c54635SPaolo Bonzini  -internal		Only output documentation for symbols that have NOT been
64 e2c54635SPaolo Bonzini			exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
65 e2c54635SPaolo Bonzini                        in any input FILE or -export-file FILE.
66 e2c54635SPaolo Bonzini  -function NAME	Only output documentation for the given function(s)
67 e2c54635SPaolo Bonzini			or DOC: section title(s). All other functions and DOC:
68 e2c54635SPaolo Bonzini			sections are ignored. May be specified multiple times.
69 e2c54635SPaolo Bonzini  -nofunction NAME	Do NOT output documentation for the given function(s);
70 e2c54635SPaolo Bonzini			only output documentation for the other functions and
71 e2c54635SPaolo Bonzini			DOC: sections. May be specified multiple times.
72 e2c54635SPaolo Bonzini
73 e2c54635SPaolo BonziniOutput selection modifiers:
74 152d1967SPeter Maydell  -sphinx-version VER   Generate rST syntax for the specified Sphinx version.
75 152d1967SPeter Maydell                        Only works with reStructuredTextFormat.
76 e2c54635SPaolo Bonzini  -no-doc-sections	Do not output DOC: sections.
77 e2c54635SPaolo Bonzini  -enable-lineno        Enable output of #define LINENO lines. Only works with
78 e2c54635SPaolo Bonzini                        reStructuredText format.
79 e2c54635SPaolo Bonzini  -export-file FILE     Specify an additional FILE in which to look for
80 e2c54635SPaolo Bonzini                        EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be used with
81 e2c54635SPaolo Bonzini                        -export or -internal. May be specified multiple times.
82 e2c54635SPaolo Bonzini
83 e2c54635SPaolo BonziniOther parameters:
84 e2c54635SPaolo Bonzini  -v			Verbose output, more warnings and other information.
85 e2c54635SPaolo Bonzini  -h			Print this help.
86 e2c54635SPaolo Bonzini
87 e2c54635SPaolo BonziniEOF
88 e2c54635SPaolo Bonzini    print $message;
89 e2c54635SPaolo Bonzini    exit 1;
90 e2c54635SPaolo Bonzini}
91 e2c54635SPaolo Bonzini
92 e2c54635SPaolo Bonzini#
93 e2c54635SPaolo Bonzini# format of comments.
94 e2c54635SPaolo Bonzini# In the following table, (...)? signifies optional structure.
95 e2c54635SPaolo Bonzini#                         (...)* signifies 0 or more structure elements
96 e2c54635SPaolo Bonzini# /**
97 e2c54635SPaolo Bonzini#  * function_name(:)? (- short description)?
98 e2c54635SPaolo Bonzini# (* @parameterx: (description of parameter x)?)*
99 e2c54635SPaolo Bonzini# (* a blank line)?
100 e2c54635SPaolo Bonzini#  * (Description:)? (Description of function)?
101 e2c54635SPaolo Bonzini#  * (section header: (section description)? )*
102 e2c54635SPaolo Bonzini#  (*)?*/
103 e2c54635SPaolo Bonzini#
104 e2c54635SPaolo Bonzini# So .. the trivial example would be:
105 e2c54635SPaolo Bonzini#
106 e2c54635SPaolo Bonzini# /**
107 e2c54635SPaolo Bonzini#  * my_function
108 e2c54635SPaolo Bonzini#  */
109 e2c54635SPaolo Bonzini#
110 e2c54635SPaolo Bonzini# If the Description: header tag is omitted, then there must be a blank line
111 e2c54635SPaolo Bonzini# after the last parameter specification.
112 e2c54635SPaolo Bonzini# e.g.
113 e2c54635SPaolo Bonzini# /**
114 e2c54635SPaolo Bonzini#  * my_function - does my stuff
115 e2c54635SPaolo Bonzini#  * @my_arg: its mine damnit
116 e2c54635SPaolo Bonzini#  *
117 e2c54635SPaolo Bonzini#  * Does my stuff explained.
118 e2c54635SPaolo Bonzini#  */
119 e2c54635SPaolo Bonzini#
120 e2c54635SPaolo Bonzini#  or, could also use:
121 e2c54635SPaolo Bonzini# /**
122 e2c54635SPaolo Bonzini#  * my_function - does my stuff
123 e2c54635SPaolo Bonzini#  * @my_arg: its mine damnit
124 e2c54635SPaolo Bonzini#  * Description: Does my stuff explained.
125 e2c54635SPaolo Bonzini#  */
126 e2c54635SPaolo Bonzini# etc.
127 e2c54635SPaolo Bonzini#
128 e2c54635SPaolo Bonzini# Besides functions you can also write documentation for structs, unions,
129 e2c54635SPaolo Bonzini# enums and typedefs. Instead of the function name you must write the name
130 e2c54635SPaolo Bonzini# of the declaration;  the struct/union/enum/typedef must always precede
131 e2c54635SPaolo Bonzini# the name. Nesting of declarations is not supported.
132 e2c54635SPaolo Bonzini# Use the argument mechanism to document members or constants.
133 e2c54635SPaolo Bonzini# e.g.
134 e2c54635SPaolo Bonzini# /**
135 e2c54635SPaolo Bonzini#  * struct my_struct - short description
136 e2c54635SPaolo Bonzini#  * @a: first member
137 e2c54635SPaolo Bonzini#  * @b: second member
138 e2c54635SPaolo Bonzini#  *
139 e2c54635SPaolo Bonzini#  * Longer description
140 e2c54635SPaolo Bonzini#  */
141 e2c54635SPaolo Bonzini# struct my_struct {
142 e2c54635SPaolo Bonzini#     int a;
143 e2c54635SPaolo Bonzini#     int b;
144 e2c54635SPaolo Bonzini# /* private: */
145 e2c54635SPaolo Bonzini#     int c;
146 e2c54635SPaolo Bonzini# };
147 e2c54635SPaolo Bonzini#
148 e2c54635SPaolo Bonzini# All descriptions can be multiline, except the short function description.
149 e2c54635SPaolo Bonzini#
150 e2c54635SPaolo Bonzini# For really longs structs, you can also describe arguments inside the
151 e2c54635SPaolo Bonzini# body of the struct.
152 e2c54635SPaolo Bonzini# eg.
153 e2c54635SPaolo Bonzini# /**
154 e2c54635SPaolo Bonzini#  * struct my_struct - short description
155 e2c54635SPaolo Bonzini#  * @a: first member
156 e2c54635SPaolo Bonzini#  * @b: second member
157 e2c54635SPaolo Bonzini#  *
158 e2c54635SPaolo Bonzini#  * Longer description
159 e2c54635SPaolo Bonzini#  */
160 e2c54635SPaolo Bonzini# struct my_struct {
161 e2c54635SPaolo Bonzini#     int a;
162 e2c54635SPaolo Bonzini#     int b;
163 e2c54635SPaolo Bonzini#     /**
164 e2c54635SPaolo Bonzini#      * @c: This is longer description of C
165 e2c54635SPaolo Bonzini#      *
166 e2c54635SPaolo Bonzini#      * You can use paragraphs to describe arguments
167 e2c54635SPaolo Bonzini#      * using this method.
168 e2c54635SPaolo Bonzini#      */
169 e2c54635SPaolo Bonzini#     int c;
170 e2c54635SPaolo Bonzini# };
171 e2c54635SPaolo Bonzini#
172 e2c54635SPaolo Bonzini# This should be use only for struct/enum members.
173 e2c54635SPaolo Bonzini#
174 e2c54635SPaolo Bonzini# You can also add additional sections. When documenting kernel functions you
175 e2c54635SPaolo Bonzini# should document the "Context:" of the function, e.g. whether the functions
176 e2c54635SPaolo Bonzini# can be called form interrupts. Unlike other sections you can end it with an
177 e2c54635SPaolo Bonzini# empty line.
178 e2c54635SPaolo Bonzini# A non-void function should have a "Return:" section describing the return
179 e2c54635SPaolo Bonzini# value(s).
180 e2c54635SPaolo Bonzini# Example-sections should contain the string EXAMPLE so that they are marked
181 e2c54635SPaolo Bonzini# appropriately in DocBook.
182 e2c54635SPaolo Bonzini#
183 e2c54635SPaolo Bonzini# Example:
184 e2c54635SPaolo Bonzini# /**
185 e2c54635SPaolo Bonzini#  * user_function - function that can only be called in user context
186 e2c54635SPaolo Bonzini#  * @a: some argument
187 e2c54635SPaolo Bonzini#  * Context: !in_interrupt()
188 e2c54635SPaolo Bonzini#  *
189 e2c54635SPaolo Bonzini#  * Some description
190 e2c54635SPaolo Bonzini#  * Example:
191 e2c54635SPaolo Bonzini#  *    user_function(22);
192 e2c54635SPaolo Bonzini#  */
193 e2c54635SPaolo Bonzini# ...
194 e2c54635SPaolo Bonzini#
195 e2c54635SPaolo Bonzini#
196 e2c54635SPaolo Bonzini# All descriptive text is further processed, scanning for the following special
197 e2c54635SPaolo Bonzini# patterns, which are highlighted appropriately.
198 e2c54635SPaolo Bonzini#
199 e2c54635SPaolo Bonzini# 'funcname()' - function
200 e2c54635SPaolo Bonzini# '$ENVVAR' - environmental variable
201 e2c54635SPaolo Bonzini# '&struct_name' - name of a structure (up to two words including 'struct')
202 e2c54635SPaolo Bonzini# '&struct_name.member' - name of a structure member
203 e2c54635SPaolo Bonzini# '@parameter' - name of a parameter
204 e2c54635SPaolo Bonzini# '%CONST' - name of a constant.
205 e2c54635SPaolo Bonzini# '``LITERAL``' - literal string without any spaces on it.
206 e2c54635SPaolo Bonzini
207 e2c54635SPaolo Bonzini## init lots of data
208 e2c54635SPaolo Bonzini
209 e2c54635SPaolo Bonzinimy $errors = 0;
210 e2c54635SPaolo Bonzinimy $warnings = 0;
211 e2c54635SPaolo Bonzinimy $anon_struct_union = 0;
212 e2c54635SPaolo Bonzini
213 e2c54635SPaolo Bonzini# match expressions used to find embedded type information
214 e2c54635SPaolo Bonzinimy $type_constant = '\b``([^\`]+)``\b';
215 e2c54635SPaolo Bonzinimy $type_constant2 = '\%([-_\w]+)';
216 e2c54635SPaolo Bonzinimy $type_func = '(\w+)\(\)';
217 e2c54635SPaolo Bonzinimy $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
218 e2c54635SPaolo Bonzinimy $type_fp_param = '\@(\w+)\(\)';  # Special RST handling for func ptr params
219 e2c54635SPaolo Bonzinimy $type_env = '(\$\w+)';
220 4cf41794SPaolo Bonzinimy $type_enum = '#(enum\s*([_\w]+))';
221 4cf41794SPaolo Bonzinimy $type_struct = '#(struct\s*([_\w]+))';
222 4cf41794SPaolo Bonzinimy $type_typedef = '#(([A-Z][_\w]*))';
223 4cf41794SPaolo Bonzinimy $type_union = '#(union\s*([_\w]+))';
224 4cf41794SPaolo Bonzinimy $type_member = '#([_\w]+)(\.|->)([_\w]+)';
225 4cf41794SPaolo Bonzinimy $type_fallback = '(?!)';    # this never matches
226 e2c54635SPaolo Bonzinimy $type_member_func = $type_member . '\(\)';
227 e2c54635SPaolo Bonzini
228 e2c54635SPaolo Bonzini# Output conversion substitutions.
229 e2c54635SPaolo Bonzini#  One for each output format
230 e2c54635SPaolo Bonzini
231 e2c54635SPaolo Bonzini# these are pretty rough
232 e2c54635SPaolo Bonzinimy @highlights_man = (
233 e2c54635SPaolo Bonzini                      [$type_constant, "\$1"],
234 e2c54635SPaolo Bonzini                      [$type_constant2, "\$1"],
235 e2c54635SPaolo Bonzini                      [$type_func, "\\\\fB\$1\\\\fP"],
236 e2c54635SPaolo Bonzini                      [$type_enum, "\\\\fI\$1\\\\fP"],
237 e2c54635SPaolo Bonzini                      [$type_struct, "\\\\fI\$1\\\\fP"],
238 e2c54635SPaolo Bonzini                      [$type_typedef, "\\\\fI\$1\\\\fP"],
239 e2c54635SPaolo Bonzini                      [$type_union, "\\\\fI\$1\\\\fP"],
240 e2c54635SPaolo Bonzini                      [$type_param, "\\\\fI\$1\\\\fP"],
241 e2c54635SPaolo Bonzini                      [$type_member, "\\\\fI\$1\$2\$3\\\\fP"],
242 e2c54635SPaolo Bonzini                      [$type_fallback, "\\\\fI\$1\\\\fP"]
243 e2c54635SPaolo Bonzini		     );
244 e2c54635SPaolo Bonzinimy $blankline_man = "";
245 e2c54635SPaolo Bonzini
246 e2c54635SPaolo Bonzini# rst-mode
247 e2c54635SPaolo Bonzinimy @highlights_rst = (
248 e2c54635SPaolo Bonzini                       [$type_constant, "``\$1``"],
249 e2c54635SPaolo Bonzini                       [$type_constant2, "``\$1``"],
250 e2c54635SPaolo Bonzini                       # Note: need to escape () to avoid func matching later
251 e2c54635SPaolo Bonzini                       [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\\\\) <\$1>`"],
252 e2c54635SPaolo Bonzini                       [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"],
253 e2c54635SPaolo Bonzini		       [$type_fp_param, "**\$1\\\\(\\\\)**"],
254 e2c54635SPaolo Bonzini                       [$type_func, "\$1()"],
255 e2c54635SPaolo Bonzini                       [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"],
256 e2c54635SPaolo Bonzini                       [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"],
257 e2c54635SPaolo Bonzini                       [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"],
258 e2c54635SPaolo Bonzini                       [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"],
259 e2c54635SPaolo Bonzini                       # in rst this can refer to any type
260 e2c54635SPaolo Bonzini                       [$type_fallback, "\\:c\\:type\\:`\$1`"],
261 e2c54635SPaolo Bonzini                       [$type_param, "**\$1**"]
262 e2c54635SPaolo Bonzini		      );
263 e2c54635SPaolo Bonzinimy $blankline_rst = "\n";
264 e2c54635SPaolo Bonzini
265 e2c54635SPaolo Bonzini# read arguments
266 e2c54635SPaolo Bonziniif ($#ARGV == -1) {
267 e2c54635SPaolo Bonzini    usage();
268 e2c54635SPaolo Bonzini}
269 e2c54635SPaolo Bonzini
270 e2c54635SPaolo Bonzinimy $kernelversion;
271 e2c54635SPaolo Bonzinimy $dohighlight = "";
272 e2c54635SPaolo Bonzini
273 e2c54635SPaolo Bonzinimy $verbose = 0;
274 e2c54635SPaolo Bonzinimy $output_mode = "rst";
275 e2c54635SPaolo Bonzinimy $output_preformatted = 0;
276 e2c54635SPaolo Bonzinimy $no_doc_sections = 0;
277 e2c54635SPaolo Bonzinimy $enable_lineno = 0;
278 e2c54635SPaolo Bonzinimy @highlights = @highlights_rst;
279 e2c54635SPaolo Bonzinimy $blankline = $blankline_rst;
280 e2c54635SPaolo Bonzinimy $modulename = "Kernel API";
281 e2c54635SPaolo Bonzini
282 e2c54635SPaolo Bonziniuse constant {
283 e2c54635SPaolo Bonzini    OUTPUT_ALL          => 0, # output all symbols and doc sections
284 e2c54635SPaolo Bonzini    OUTPUT_INCLUDE      => 1, # output only specified symbols
285 e2c54635SPaolo Bonzini    OUTPUT_EXCLUDE      => 2, # output everything except specified symbols
286 e2c54635SPaolo Bonzini    OUTPUT_EXPORTED     => 3, # output exported symbols
287 e2c54635SPaolo Bonzini    OUTPUT_INTERNAL     => 4, # output non-exported symbols
288 e2c54635SPaolo Bonzini};
289 e2c54635SPaolo Bonzinimy $output_selection = OUTPUT_ALL;
290 e2c54635SPaolo Bonzinimy $show_not_found = 0;	# No longer used
291 152d1967SPeter Maydellmy $sphinx_version = "0.0"; # if not specified, assume old
292 e2c54635SPaolo Bonzini
293 e2c54635SPaolo Bonzinimy @export_file_list;
294 e2c54635SPaolo Bonzini
295 e2c54635SPaolo Bonzinimy @build_time;
296 e2c54635SPaolo Bonziniif (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) &&
297 e2c54635SPaolo Bonzini    (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') {
298 e2c54635SPaolo Bonzini    @build_time = gmtime($seconds);
299 e2c54635SPaolo Bonzini} else {
300 e2c54635SPaolo Bonzini    @build_time = localtime;
301 e2c54635SPaolo Bonzini}
302 e2c54635SPaolo Bonzini
303 e2c54635SPaolo Bonzinimy $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
304 e2c54635SPaolo Bonzini		'July', 'August', 'September', 'October',
305 e2c54635SPaolo Bonzini		'November', 'December')[$build_time[4]] .
306 e2c54635SPaolo Bonzini  " " . ($build_time[5]+1900);
307 e2c54635SPaolo Bonzini
308 e2c54635SPaolo Bonzini# Essentially these are globals.
309 e2c54635SPaolo Bonzini# They probably want to be tidied up, made more localised or something.
310 e2c54635SPaolo Bonzini# CAVEAT EMPTOR!  Some of the others I localised may not want to be, which
311 e2c54635SPaolo Bonzini# could cause "use of undefined value" or other bugs.
312 e2c54635SPaolo Bonzinimy ($function, %function_table, %parametertypes, $declaration_purpose);
313 e2c54635SPaolo Bonzinimy $declaration_start_line;
314 e2c54635SPaolo Bonzinimy ($type, $declaration_name, $return_type);
315 e2c54635SPaolo Bonzinimy ($newsection, $newcontents, $prototype, $brcount, %source_map);
316 e2c54635SPaolo Bonzini
317 e2c54635SPaolo Bonziniif (defined($ENV{'KBUILD_VERBOSE'})) {
318 e2c54635SPaolo Bonzini	$verbose = "$ENV{'KBUILD_VERBOSE'}";
319 e2c54635SPaolo Bonzini}
320 e2c54635SPaolo Bonzini
321 e2c54635SPaolo Bonzini# Generated docbook code is inserted in a template at a point where
322 e2c54635SPaolo Bonzini# docbook v3.1 requires a non-zero sequence of RefEntry's; see:
323 e2c54635SPaolo Bonzini# http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
324 e2c54635SPaolo Bonzini# We keep track of number of generated entries and generate a dummy
325 e2c54635SPaolo Bonzini# if needs be to ensure the expanded template can be postprocessed
326 e2c54635SPaolo Bonzini# into html.
327 e2c54635SPaolo Bonzinimy $section_counter = 0;
328 e2c54635SPaolo Bonzini
329 e2c54635SPaolo Bonzinimy $lineprefix="";
330 e2c54635SPaolo Bonzini
331 e2c54635SPaolo Bonzini# Parser states
332 e2c54635SPaolo Bonziniuse constant {
333 e2c54635SPaolo Bonzini    STATE_NORMAL        => 0, # normal code
334 e2c54635SPaolo Bonzini    STATE_NAME          => 1, # looking for function name
335 e2c54635SPaolo Bonzini    STATE_BODY_MAYBE    => 2, # body - or maybe more description
336 e2c54635SPaolo Bonzini    STATE_BODY          => 3, # the body of the comment
337 e2c54635SPaolo Bonzini    STATE_PROTO         => 4, # scanning prototype
338 e2c54635SPaolo Bonzini    STATE_DOCBLOCK      => 5, # documentation block
339 e2c54635SPaolo Bonzini    STATE_INLINE        => 6, # gathering documentation outside main block
340 e2c54635SPaolo Bonzini};
341 e2c54635SPaolo Bonzinimy $state;
342 e2c54635SPaolo Bonzinimy $in_doc_sect;
343 e2c54635SPaolo Bonzinimy $leading_space;
344 e2c54635SPaolo Bonzini
345 e2c54635SPaolo Bonzini# Inline documentation state
346 e2c54635SPaolo Bonziniuse constant {
347 e2c54635SPaolo Bonzini    STATE_INLINE_NA     => 0, # not applicable ($state != STATE_INLINE)
348 e2c54635SPaolo Bonzini    STATE_INLINE_NAME   => 1, # looking for member name (@foo:)
349 e2c54635SPaolo Bonzini    STATE_INLINE_TEXT   => 2, # looking for member documentation
350 e2c54635SPaolo Bonzini    STATE_INLINE_END    => 3, # done
351 e2c54635SPaolo Bonzini    STATE_INLINE_ERROR  => 4, # error - Comment without header was found.
352 e2c54635SPaolo Bonzini                              # Spit a warning as it's not
353 e2c54635SPaolo Bonzini                              # proper kernel-doc and ignore the rest.
354 e2c54635SPaolo Bonzini};
355 e2c54635SPaolo Bonzinimy $inline_doc_state;
356 e2c54635SPaolo Bonzini
357 e2c54635SPaolo Bonzini#declaration types: can be
358 e2c54635SPaolo Bonzini# 'function', 'struct', 'union', 'enum', 'typedef'
359 e2c54635SPaolo Bonzinimy $decl_type;
360 e2c54635SPaolo Bonzini
361 e2c54635SPaolo Bonzinimy $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
362 e2c54635SPaolo Bonzinimy $doc_end = '\*/';
363 e2c54635SPaolo Bonzinimy $doc_com = '\s*\*\s*';
364 e2c54635SPaolo Bonzinimy $doc_com_body = '\s*\* ?';
365 e2c54635SPaolo Bonzinimy $doc_decl = $doc_com . '(\w+)';
366 e2c54635SPaolo Bonzini# @params and a strictly limited set of supported section names
367 e2c54635SPaolo Bonzinimy $doc_sect = $doc_com .
368 e2c54635SPaolo Bonzini    '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:(.*)';
369 e2c54635SPaolo Bonzinimy $doc_content = $doc_com_body . '(.*)';
370 e2c54635SPaolo Bonzinimy $doc_block = $doc_com . 'DOC:\s*(.*)?';
371 e2c54635SPaolo Bonzinimy $doc_inline_start = '^\s*/\*\*\s*$';
372 e2c54635SPaolo Bonzinimy $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)';
373 e2c54635SPaolo Bonzinimy $doc_inline_end = '^\s*\*/\s*$';
374 e2c54635SPaolo Bonzinimy $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$';
375 e2c54635SPaolo Bonzinimy $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';
376 e2c54635SPaolo Bonzini
377 e2c54635SPaolo Bonzinimy %parameterdescs;
378 e2c54635SPaolo Bonzinimy %parameterdesc_start_lines;
379 e2c54635SPaolo Bonzinimy @parameterlist;
380 e2c54635SPaolo Bonzinimy %sections;
381 e2c54635SPaolo Bonzinimy @sectionlist;
382 e2c54635SPaolo Bonzinimy %section_start_lines;
383 e2c54635SPaolo Bonzinimy $sectcheck;
384 e2c54635SPaolo Bonzinimy $struct_actual;
385 e2c54635SPaolo Bonzini
386 e2c54635SPaolo Bonzinimy $contents = "";
387 e2c54635SPaolo Bonzinimy $new_start_line = 0;
388 e2c54635SPaolo Bonzini
389 e2c54635SPaolo Bonzini# the canonical section names. see also $doc_sect above.
390 e2c54635SPaolo Bonzinimy $section_default = "Description";	# default section
391 e2c54635SPaolo Bonzinimy $section_intro = "Introduction";
392 e2c54635SPaolo Bonzinimy $section = $section_default;
393 e2c54635SPaolo Bonzinimy $section_context = "Context";
394 e2c54635SPaolo Bonzinimy $section_return = "Return";
395 e2c54635SPaolo Bonzini
396 e2c54635SPaolo Bonzinimy $undescribed = "-- undescribed --";
397 e2c54635SPaolo Bonzini
398 e2c54635SPaolo Bonzinireset_state();
399 e2c54635SPaolo Bonzini
400 e2c54635SPaolo Bonziniwhile ($ARGV[0] =~ m/^--?(.*)/) {
401 e2c54635SPaolo Bonzini    my $cmd = $1;
402 e2c54635SPaolo Bonzini    shift @ARGV;
403 e2c54635SPaolo Bonzini    if ($cmd eq "man") {
404 e2c54635SPaolo Bonzini	$output_mode = "man";
405 e2c54635SPaolo Bonzini	@highlights = @highlights_man;
406 e2c54635SPaolo Bonzini	$blankline = $blankline_man;
407 e2c54635SPaolo Bonzini    } elsif ($cmd eq "rst") {
408 e2c54635SPaolo Bonzini	$output_mode = "rst";
409 e2c54635SPaolo Bonzini	@highlights = @highlights_rst;
410 e2c54635SPaolo Bonzini	$blankline = $blankline_rst;
411 e2c54635SPaolo Bonzini    } elsif ($cmd eq "none") {
412 e2c54635SPaolo Bonzini	$output_mode = "none";
413 e2c54635SPaolo Bonzini    } elsif ($cmd eq "module") { # not needed for XML, inherits from calling document
414 e2c54635SPaolo Bonzini	$modulename = shift @ARGV;
415 e2c54635SPaolo Bonzini    } elsif ($cmd eq "function") { # to only output specific functions
416 e2c54635SPaolo Bonzini	$output_selection = OUTPUT_INCLUDE;
417 e2c54635SPaolo Bonzini	$function = shift @ARGV;
418 e2c54635SPaolo Bonzini	$function_table{$function} = 1;
419 e2c54635SPaolo Bonzini    } elsif ($cmd eq "nofunction") { # output all except specific functions
420 e2c54635SPaolo Bonzini	$output_selection = OUTPUT_EXCLUDE;
421 e2c54635SPaolo Bonzini	$function = shift @ARGV;
422 e2c54635SPaolo Bonzini	$function_table{$function} = 1;
423 e2c54635SPaolo Bonzini    } elsif ($cmd eq "export") { # only exported symbols
424 e2c54635SPaolo Bonzini	$output_selection = OUTPUT_EXPORTED;
425 e2c54635SPaolo Bonzini	%function_table = ();
426 e2c54635SPaolo Bonzini    } elsif ($cmd eq "internal") { # only non-exported symbols
427 e2c54635SPaolo Bonzini	$output_selection = OUTPUT_INTERNAL;
428 e2c54635SPaolo Bonzini	%function_table = ();
429 e2c54635SPaolo Bonzini    } elsif ($cmd eq "export-file") {
430 e2c54635SPaolo Bonzini	my $file = shift @ARGV;
431 e2c54635SPaolo Bonzini	push(@export_file_list, $file);
432 e2c54635SPaolo Bonzini    } elsif ($cmd eq "v") {
433 e2c54635SPaolo Bonzini	$verbose = 1;
434 e2c54635SPaolo Bonzini    } elsif (($cmd eq "h") || ($cmd eq "help")) {
435 e2c54635SPaolo Bonzini	usage();
436 e2c54635SPaolo Bonzini    } elsif ($cmd eq 'no-doc-sections') {
437 e2c54635SPaolo Bonzini	    $no_doc_sections = 1;
438 e2c54635SPaolo Bonzini    } elsif ($cmd eq 'enable-lineno') {
439 e2c54635SPaolo Bonzini	    $enable_lineno = 1;
440 e2c54635SPaolo Bonzini    } elsif ($cmd eq 'show-not-found') {
441 e2c54635SPaolo Bonzini	$show_not_found = 1;  # A no-op but don't fail
442 152d1967SPeter Maydell    } elsif ($cmd eq 'sphinx-version') {
443 152d1967SPeter Maydell        $sphinx_version = shift @ARGV;
444 e2c54635SPaolo Bonzini    } else {
445 e2c54635SPaolo Bonzini	# Unknown argument
446 e2c54635SPaolo Bonzini        usage();
447 e2c54635SPaolo Bonzini    }
448 e2c54635SPaolo Bonzini}
449 e2c54635SPaolo Bonzini
450 e2c54635SPaolo Bonzini# continue execution near EOF;
451 e2c54635SPaolo Bonzini
452 e2c54635SPaolo Bonzini# get kernel version from env
453 e2c54635SPaolo Bonzinisub get_kernel_version() {
454 e2c54635SPaolo Bonzini    my $version = 'unknown kernel version';
455 e2c54635SPaolo Bonzini
456 e2c54635SPaolo Bonzini    if (defined($ENV{'KERNELVERSION'})) {
457 e2c54635SPaolo Bonzini	$version = $ENV{'KERNELVERSION'};
458 e2c54635SPaolo Bonzini    }
459 e2c54635SPaolo Bonzini    return $version;
460 e2c54635SPaolo Bonzini}
461 e2c54635SPaolo Bonzini
462 e2c54635SPaolo Bonzini#
463 e2c54635SPaolo Bonzinisub print_lineno {
464 e2c54635SPaolo Bonzini    my $lineno = shift;
465 e2c54635SPaolo Bonzini    if ($enable_lineno && defined($lineno)) {
466 e2c54635SPaolo Bonzini        print "#define LINENO " . $lineno . "\n";
467 e2c54635SPaolo Bonzini    }
468 e2c54635SPaolo Bonzini}
469 e2c54635SPaolo Bonzini##
470 e2c54635SPaolo Bonzini# dumps section contents to arrays/hashes intended for that purpose.
471 e2c54635SPaolo Bonzini#
472 e2c54635SPaolo Bonzinisub dump_section {
473 e2c54635SPaolo Bonzini    my $file = shift;
474 e2c54635SPaolo Bonzini    my $name = shift;
475 e2c54635SPaolo Bonzini    my $contents = join "\n", @_;
476 e2c54635SPaolo Bonzini
477 e2c54635SPaolo Bonzini    if ($name =~ m/$type_param/) {
478 e2c54635SPaolo Bonzini	$name = $1;
479 e2c54635SPaolo Bonzini	$parameterdescs{$name} = $contents;
480 e2c54635SPaolo Bonzini	$sectcheck = $sectcheck . $name . " ";
481 e2c54635SPaolo Bonzini        $parameterdesc_start_lines{$name} = $new_start_line;
482 e2c54635SPaolo Bonzini        $new_start_line = 0;
483 e2c54635SPaolo Bonzini    } elsif ($name eq "@\.\.\.") {
484 e2c54635SPaolo Bonzini	$name = "...";
485 e2c54635SPaolo Bonzini	$parameterdescs{$name} = $contents;
486 e2c54635SPaolo Bonzini	$sectcheck = $sectcheck . $name . " ";
487 e2c54635SPaolo Bonzini        $parameterdesc_start_lines{$name} = $new_start_line;
488 e2c54635SPaolo Bonzini        $new_start_line = 0;
489 e2c54635SPaolo Bonzini    } else {
490 e2c54635SPaolo Bonzini	if (defined($sections{$name}) && ($sections{$name} ne "")) {
491 e2c54635SPaolo Bonzini	    # Only warn on user specified duplicate section names.
492 e2c54635SPaolo Bonzini	    if ($name ne $section_default) {
493 e2c54635SPaolo Bonzini		print STDERR "${file}:$.: warning: duplicate section name '$name'\n";
494 e2c54635SPaolo Bonzini		++$warnings;
495 e2c54635SPaolo Bonzini	    }
496 e2c54635SPaolo Bonzini	    $sections{$name} .= $contents;
497 e2c54635SPaolo Bonzini	} else {
498 e2c54635SPaolo Bonzini	    $sections{$name} = $contents;
499 e2c54635SPaolo Bonzini	    push @sectionlist, $name;
500 e2c54635SPaolo Bonzini            $section_start_lines{$name} = $new_start_line;
501 e2c54635SPaolo Bonzini            $new_start_line = 0;
502 e2c54635SPaolo Bonzini	}
503 e2c54635SPaolo Bonzini    }
504 e2c54635SPaolo Bonzini}
505 e2c54635SPaolo Bonzini
506 e2c54635SPaolo Bonzini##
507 e2c54635SPaolo Bonzini# dump DOC: section after checking that it should go out
508 e2c54635SPaolo Bonzini#
509 e2c54635SPaolo Bonzinisub dump_doc_section {
510 e2c54635SPaolo Bonzini    my $file = shift;
511 e2c54635SPaolo Bonzini    my $name = shift;
512 e2c54635SPaolo Bonzini    my $contents = join "\n", @_;
513 e2c54635SPaolo Bonzini
514 e2c54635SPaolo Bonzini    if ($no_doc_sections) {
515 e2c54635SPaolo Bonzini        return;
516 e2c54635SPaolo Bonzini    }
517 e2c54635SPaolo Bonzini
518 e2c54635SPaolo Bonzini    if (($output_selection == OUTPUT_ALL) ||
519 e2c54635SPaolo Bonzini	($output_selection == OUTPUT_INCLUDE &&
520 e2c54635SPaolo Bonzini	 defined($function_table{$name})) ||
521 e2c54635SPaolo Bonzini	($output_selection == OUTPUT_EXCLUDE &&
522 e2c54635SPaolo Bonzini	 !defined($function_table{$name})))
523 e2c54635SPaolo Bonzini    {
524 e2c54635SPaolo Bonzini	dump_section($file, $name, $contents);
525 e2c54635SPaolo Bonzini	output_blockhead({'sectionlist' => \@sectionlist,
526 e2c54635SPaolo Bonzini			  'sections' => \%sections,
527 e2c54635SPaolo Bonzini			  'module' => $modulename,
528 e2c54635SPaolo Bonzini			  'content-only' => ($output_selection != OUTPUT_ALL), });
529 e2c54635SPaolo Bonzini    }
530 e2c54635SPaolo Bonzini}
531 e2c54635SPaolo Bonzini
532 e2c54635SPaolo Bonzini##
533 e2c54635SPaolo Bonzini# output function
534 e2c54635SPaolo Bonzini#
535 e2c54635SPaolo Bonzini# parameterdescs, a hash.
536 e2c54635SPaolo Bonzini#  function => "function name"
537 e2c54635SPaolo Bonzini#  parameterlist => @list of parameters
538 e2c54635SPaolo Bonzini#  parameterdescs => %parameter descriptions
539 e2c54635SPaolo Bonzini#  sectionlist => @list of sections
540 e2c54635SPaolo Bonzini#  sections => %section descriptions
541 e2c54635SPaolo Bonzini#
542 e2c54635SPaolo Bonzini
543 e2c54635SPaolo Bonzinisub output_highlight {
544 e2c54635SPaolo Bonzini    my $contents = join "\n",@_;
545 e2c54635SPaolo Bonzini    my $line;
546 e2c54635SPaolo Bonzini
547 e2c54635SPaolo Bonzini#   DEBUG
548 e2c54635SPaolo Bonzini#   if (!defined $contents) {
549 e2c54635SPaolo Bonzini#	use Carp;
550 e2c54635SPaolo Bonzini#	confess "output_highlight got called with no args?\n";
551 e2c54635SPaolo Bonzini#   }
552 e2c54635SPaolo Bonzini
553 e2c54635SPaolo Bonzini#   print STDERR "contents b4:$contents\n";
554 e2c54635SPaolo Bonzini    eval $dohighlight;
555 e2c54635SPaolo Bonzini    die $@ if $@;
556 e2c54635SPaolo Bonzini#   print STDERR "contents af:$contents\n";
557 e2c54635SPaolo Bonzini
558 e2c54635SPaolo Bonzini    foreach $line (split "\n", $contents) {
559 e2c54635SPaolo Bonzini	if (! $output_preformatted) {
560 e2c54635SPaolo Bonzini	    $line =~ s/^\s*//;
561 e2c54635SPaolo Bonzini	}
562 e2c54635SPaolo Bonzini	if ($line eq ""){
563 e2c54635SPaolo Bonzini	    if (! $output_preformatted) {
564 e2c54635SPaolo Bonzini		print $lineprefix, $blankline;
565 e2c54635SPaolo Bonzini	    }
566 e2c54635SPaolo Bonzini	} else {
567 e2c54635SPaolo Bonzini	    if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
568 e2c54635SPaolo Bonzini		print "\\&$line";
569 e2c54635SPaolo Bonzini	    } else {
570 e2c54635SPaolo Bonzini		print $lineprefix, $line;
571 e2c54635SPaolo Bonzini	    }
572 e2c54635SPaolo Bonzini	}
573 e2c54635SPaolo Bonzini	print "\n";
574 e2c54635SPaolo Bonzini    }
575 e2c54635SPaolo Bonzini}
576 e2c54635SPaolo Bonzini
577 e2c54635SPaolo Bonzini##
578 e2c54635SPaolo Bonzini# output function in man
579 e2c54635SPaolo Bonzinisub output_function_man(%) {
580 e2c54635SPaolo Bonzini    my %args = %{$_[0]};
581 e2c54635SPaolo Bonzini    my ($parameter, $section);
582 e2c54635SPaolo Bonzini    my $count;
583 e2c54635SPaolo Bonzini
584 e2c54635SPaolo Bonzini    print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
585 e2c54635SPaolo Bonzini
586 e2c54635SPaolo Bonzini    print ".SH NAME\n";
587 e2c54635SPaolo Bonzini    print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
588 e2c54635SPaolo Bonzini
589 e2c54635SPaolo Bonzini    print ".SH SYNOPSIS\n";
590 e2c54635SPaolo Bonzini    if ($args{'functiontype'} ne "") {
591 e2c54635SPaolo Bonzini	print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
592 e2c54635SPaolo Bonzini    } else {
593 e2c54635SPaolo Bonzini	print ".B \"" . $args{'function'} . "\n";
594 e2c54635SPaolo Bonzini    }
595 e2c54635SPaolo Bonzini    $count = 0;
596 e2c54635SPaolo Bonzini    my $parenth = "(";
597 e2c54635SPaolo Bonzini    my $post = ",";
598 e2c54635SPaolo Bonzini    foreach my $parameter (@{$args{'parameterlist'}}) {
599 e2c54635SPaolo Bonzini	if ($count == $#{$args{'parameterlist'}}) {
600 e2c54635SPaolo Bonzini	    $post = ");";
601 e2c54635SPaolo Bonzini	}
602 e2c54635SPaolo Bonzini	$type = $args{'parametertypes'}{$parameter};
603 e2c54635SPaolo Bonzini	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
604 e2c54635SPaolo Bonzini	    # pointer-to-function
605 e2c54635SPaolo Bonzini	    print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n";
606 e2c54635SPaolo Bonzini	} else {
607 e2c54635SPaolo Bonzini	    $type =~ s/([^\*])$/$1 /;
608 e2c54635SPaolo Bonzini	    print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n";
609 e2c54635SPaolo Bonzini	}
610 e2c54635SPaolo Bonzini	$count++;
611 e2c54635SPaolo Bonzini	$parenth = "";
612 e2c54635SPaolo Bonzini    }
613 e2c54635SPaolo Bonzini
614 e2c54635SPaolo Bonzini    print ".SH ARGUMENTS\n";
615 e2c54635SPaolo Bonzini    foreach $parameter (@{$args{'parameterlist'}}) {
616 e2c54635SPaolo Bonzini	my $parameter_name = $parameter;
617 e2c54635SPaolo Bonzini	$parameter_name =~ s/\[.*//;
618 e2c54635SPaolo Bonzini
619 e2c54635SPaolo Bonzini	print ".IP \"" . $parameter . "\" 12\n";
620 e2c54635SPaolo Bonzini	output_highlight($args{'parameterdescs'}{$parameter_name});
621 e2c54635SPaolo Bonzini    }
622 e2c54635SPaolo Bonzini    foreach $section (@{$args{'sectionlist'}}) {
623 e2c54635SPaolo Bonzini	print ".SH \"", uc $section, "\"\n";
624 e2c54635SPaolo Bonzini	output_highlight($args{'sections'}{$section});
625 e2c54635SPaolo Bonzini    }
626 e2c54635SPaolo Bonzini}
627 e2c54635SPaolo Bonzini
628 e2c54635SPaolo Bonzini##
629 e2c54635SPaolo Bonzini# output enum in man
630 e2c54635SPaolo Bonzinisub output_enum_man(%) {
631 e2c54635SPaolo Bonzini    my %args = %{$_[0]};
632 e2c54635SPaolo Bonzini    my ($parameter, $section);
633 e2c54635SPaolo Bonzini    my $count;
634 e2c54635SPaolo Bonzini
635 e2c54635SPaolo Bonzini    print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
636 e2c54635SPaolo Bonzini
637 e2c54635SPaolo Bonzini    print ".SH NAME\n";
638 e2c54635SPaolo Bonzini    print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
639 e2c54635SPaolo Bonzini
640 e2c54635SPaolo Bonzini    print ".SH SYNOPSIS\n";
641 e2c54635SPaolo Bonzini    print "enum " . $args{'enum'} . " {\n";
642 e2c54635SPaolo Bonzini    $count = 0;
643 e2c54635SPaolo Bonzini    foreach my $parameter (@{$args{'parameterlist'}}) {
644 e2c54635SPaolo Bonzini	print ".br\n.BI \"    $parameter\"\n";
645 e2c54635SPaolo Bonzini	if ($count == $#{$args{'parameterlist'}}) {
646 e2c54635SPaolo Bonzini	    print "\n};\n";
647 e2c54635SPaolo Bonzini	    last;
648 e2c54635SPaolo Bonzini	}
649 e2c54635SPaolo Bonzini	else {
650 e2c54635SPaolo Bonzini	    print ", \n.br\n";
651 e2c54635SPaolo Bonzini	}
652 e2c54635SPaolo Bonzini	$count++;
653 e2c54635SPaolo Bonzini    }
654 e2c54635SPaolo Bonzini
655 e2c54635SPaolo Bonzini    print ".SH Constants\n";
656 e2c54635SPaolo Bonzini    foreach $parameter (@{$args{'parameterlist'}}) {
657 e2c54635SPaolo Bonzini	my $parameter_name = $parameter;
658 e2c54635SPaolo Bonzini	$parameter_name =~ s/\[.*//;
659 e2c54635SPaolo Bonzini
660 e2c54635SPaolo Bonzini	print ".IP \"" . $parameter . "\" 12\n";
661 e2c54635SPaolo Bonzini	output_highlight($args{'parameterdescs'}{$parameter_name});
662 e2c54635SPaolo Bonzini    }
663 e2c54635SPaolo Bonzini    foreach $section (@{$args{'sectionlist'}}) {
664 e2c54635SPaolo Bonzini	print ".SH \"$section\"\n";
665 e2c54635SPaolo Bonzini	output_highlight($args{'sections'}{$section});
666 e2c54635SPaolo Bonzini    }
667 e2c54635SPaolo Bonzini}
668 e2c54635SPaolo Bonzini
669 e2c54635SPaolo Bonzini##
670 e2c54635SPaolo Bonzini# output struct in man
671 e2c54635SPaolo Bonzinisub output_struct_man(%) {
672 e2c54635SPaolo Bonzini    my %args = %{$_[0]};
673 e2c54635SPaolo Bonzini    my ($parameter, $section);
674 e2c54635SPaolo Bonzini
675 e2c54635SPaolo Bonzini    print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
676 e2c54635SPaolo Bonzini
677 e2c54635SPaolo Bonzini    print ".SH NAME\n";
678 e2c54635SPaolo Bonzini    print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
679 e2c54635SPaolo Bonzini
680 e2c54635SPaolo Bonzini    my $declaration = $args{'definition'};
681 e2c54635SPaolo Bonzini    $declaration =~ s/\t/  /g;
682 e2c54635SPaolo Bonzini    $declaration =~ s/\n/"\n.br\n.BI \"/g;
683 e2c54635SPaolo Bonzini    print ".SH SYNOPSIS\n";
684 e2c54635SPaolo Bonzini    print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
685 e2c54635SPaolo Bonzini    print ".BI \"$declaration\n};\n.br\n\n";
686 e2c54635SPaolo Bonzini
687 e2c54635SPaolo Bonzini    print ".SH Members\n";
688 e2c54635SPaolo Bonzini    foreach $parameter (@{$args{'parameterlist'}}) {
689 e2c54635SPaolo Bonzini	($parameter =~ /^#/) && next;
690 e2c54635SPaolo Bonzini
691 e2c54635SPaolo Bonzini	my $parameter_name = $parameter;
692 e2c54635SPaolo Bonzini	$parameter_name =~ s/\[.*//;
693 e2c54635SPaolo Bonzini
694 e2c54635SPaolo Bonzini	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
695 e2c54635SPaolo Bonzini	print ".IP \"" . $parameter . "\" 12\n";
696 e2c54635SPaolo Bonzini	output_highlight($args{'parameterdescs'}{$parameter_name});
697 e2c54635SPaolo Bonzini    }
698 e2c54635SPaolo Bonzini    foreach $section (@{$args{'sectionlist'}}) {
699 e2c54635SPaolo Bonzini	print ".SH \"$section\"\n";
700 e2c54635SPaolo Bonzini	output_highlight($args{'sections'}{$section});
701 e2c54635SPaolo Bonzini    }
702 e2c54635SPaolo Bonzini}
703 e2c54635SPaolo Bonzini
704 e2c54635SPaolo Bonzini##
705 e2c54635SPaolo Bonzini# output typedef in man
706 e2c54635SPaolo Bonzinisub output_typedef_man(%) {
707 e2c54635SPaolo Bonzini    my %args = %{$_[0]};
708 e2c54635SPaolo Bonzini    my ($parameter, $section);
709 e2c54635SPaolo Bonzini
710 e2c54635SPaolo Bonzini    print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
711 e2c54635SPaolo Bonzini
712 e2c54635SPaolo Bonzini    print ".SH NAME\n";
713 e2c54635SPaolo Bonzini    print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
714 e2c54635SPaolo Bonzini
715 e2c54635SPaolo Bonzini    foreach $section (@{$args{'sectionlist'}}) {
716 e2c54635SPaolo Bonzini	print ".SH \"$section\"\n";
717 e2c54635SPaolo Bonzini	output_highlight($args{'sections'}{$section});
718 e2c54635SPaolo Bonzini    }
719 e2c54635SPaolo Bonzini}
720 e2c54635SPaolo Bonzini
721 e2c54635SPaolo Bonzinisub output_blockhead_man(%) {
722 e2c54635SPaolo Bonzini    my %args = %{$_[0]};
723 e2c54635SPaolo Bonzini    my ($parameter, $section);
724 e2c54635SPaolo Bonzini    my $count;
725 e2c54635SPaolo Bonzini
726 e2c54635SPaolo Bonzini    print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
727 e2c54635SPaolo Bonzini
728 e2c54635SPaolo Bonzini    foreach $section (@{$args{'sectionlist'}}) {
729 e2c54635SPaolo Bonzini	print ".SH \"$section\"\n";
730 e2c54635SPaolo Bonzini	output_highlight($args{'sections'}{$section});
731 e2c54635SPaolo Bonzini    }
732 e2c54635SPaolo Bonzini}
733 e2c54635SPaolo Bonzini
734 e2c54635SPaolo Bonzini##
735 e2c54635SPaolo Bonzini# output in restructured text
736 e2c54635SPaolo Bonzini#
737 e2c54635SPaolo Bonzini
738 e2c54635SPaolo Bonzini#
739 e2c54635SPaolo Bonzini# This could use some work; it's used to output the DOC: sections, and
740 e2c54635SPaolo Bonzini# starts by putting out the name of the doc section itself, but that tends
741 e2c54635SPaolo Bonzini# to duplicate a header already in the template file.
742 e2c54635SPaolo Bonzini#
743 e2c54635SPaolo Bonzinisub output_blockhead_rst(%) {
744 e2c54635SPaolo Bonzini    my %args = %{$_[0]};
745 e2c54635SPaolo Bonzini    my ($parameter, $section);
746 e2c54635SPaolo Bonzini
747 e2c54635SPaolo Bonzini    foreach $section (@{$args{'sectionlist'}}) {
748 e2c54635SPaolo Bonzini	if ($output_selection != OUTPUT_INCLUDE) {
749 e2c54635SPaolo Bonzini	    print "**$section**\n\n";
750 e2c54635SPaolo Bonzini	}
751 e2c54635SPaolo Bonzini        print_lineno($section_start_lines{$section});
752 e2c54635SPaolo Bonzini	output_highlight_rst($args{'sections'}{$section});
753 e2c54635SPaolo Bonzini	print "\n";
754 e2c54635SPaolo Bonzini    }
755 e2c54635SPaolo Bonzini}
756 e2c54635SPaolo Bonzini
757 e2c54635SPaolo Bonzini#
758 e2c54635SPaolo Bonzini# Apply the RST highlights to a sub-block of text.
759 e2c54635SPaolo Bonzini#
760 e2c54635SPaolo Bonzinisub highlight_block($) {
761 e2c54635SPaolo Bonzini    # The dohighlight kludge requires the text be called $contents
762 e2c54635SPaolo Bonzini    my $contents = shift;
763 e2c54635SPaolo Bonzini    eval $dohighlight;
764 e2c54635SPaolo Bonzini    die $@ if $@;
765 e2c54635SPaolo Bonzini    return $contents;
766 e2c54635SPaolo Bonzini}
767 e2c54635SPaolo Bonzini
768 e2c54635SPaolo Bonzini#
769 e2c54635SPaolo Bonzini# Regexes used only here.
770 e2c54635SPaolo Bonzini#
771 e2c54635SPaolo Bonzinimy $sphinx_literal = '^[^.].*::$';
772 e2c54635SPaolo Bonzinimy $sphinx_cblock = '^\.\.\ +code-block::';
773 e2c54635SPaolo Bonzini
774 e2c54635SPaolo Bonzinisub output_highlight_rst {
775 e2c54635SPaolo Bonzini    my $input = join "\n",@_;
776 e2c54635SPaolo Bonzini    my $output = "";
777 e2c54635SPaolo Bonzini    my $line;
778 e2c54635SPaolo Bonzini    my $in_literal = 0;
779 e2c54635SPaolo Bonzini    my $litprefix;
780 e2c54635SPaolo Bonzini    my $block = "";
781 e2c54635SPaolo Bonzini
782 e2c54635SPaolo Bonzini    foreach $line (split "\n",$input) {
783 e2c54635SPaolo Bonzini	#
784 e2c54635SPaolo Bonzini	# If we're in a literal block, see if we should drop out
785 e2c54635SPaolo Bonzini	# of it.  Otherwise pass the line straight through unmunged.
786 e2c54635SPaolo Bonzini	#
787 e2c54635SPaolo Bonzini	if ($in_literal) {
788 e2c54635SPaolo Bonzini	    if (! ($line =~ /^\s*$/)) {
789 e2c54635SPaolo Bonzini		#
790 e2c54635SPaolo Bonzini		# If this is the first non-blank line in a literal
791 e2c54635SPaolo Bonzini		# block we need to figure out what the proper indent is.
792 e2c54635SPaolo Bonzini		#
793 e2c54635SPaolo Bonzini		if ($litprefix eq "") {
794 e2c54635SPaolo Bonzini		    $line =~ /^(\s*)/;
795 e2c54635SPaolo Bonzini		    $litprefix = '^' . $1;
796 e2c54635SPaolo Bonzini		    $output .= $line . "\n";
797 e2c54635SPaolo Bonzini		} elsif (! ($line =~ /$litprefix/)) {
798 e2c54635SPaolo Bonzini		    $in_literal = 0;
799 e2c54635SPaolo Bonzini		} else {
800 e2c54635SPaolo Bonzini		    $output .= $line . "\n";
801 e2c54635SPaolo Bonzini		}
802 e2c54635SPaolo Bonzini	    } else {
803 e2c54635SPaolo Bonzini		$output .= $line . "\n";
804 e2c54635SPaolo Bonzini	    }
805 e2c54635SPaolo Bonzini	}
806 e2c54635SPaolo Bonzini	#
807 e2c54635SPaolo Bonzini	# Not in a literal block (or just dropped out)
808 e2c54635SPaolo Bonzini	#
809 e2c54635SPaolo Bonzini	if (! $in_literal) {
810 e2c54635SPaolo Bonzini	    $block .= $line . "\n";
811 e2c54635SPaolo Bonzini	    if (($line =~ /$sphinx_literal/) || ($line =~ /$sphinx_cblock/)) {
812 e2c54635SPaolo Bonzini		$in_literal = 1;
813 e2c54635SPaolo Bonzini		$litprefix = "";
814 e2c54635SPaolo Bonzini		$output .= highlight_block($block);
815 e2c54635SPaolo Bonzini		$block = ""
816 e2c54635SPaolo Bonzini	    }
817 e2c54635SPaolo Bonzini	}
818 e2c54635SPaolo Bonzini    }
819 e2c54635SPaolo Bonzini
820 e2c54635SPaolo Bonzini    if ($block) {
821 e2c54635SPaolo Bonzini	$output .= highlight_block($block);
822 e2c54635SPaolo Bonzini    }
823 e2c54635SPaolo Bonzini    foreach $line (split "\n", $output) {
824 e2c54635SPaolo Bonzini	print $lineprefix . $line . "\n";
825 e2c54635SPaolo Bonzini    }
826 e2c54635SPaolo Bonzini}
827 e2c54635SPaolo Bonzini
828 e2c54635SPaolo Bonzinisub output_function_rst(%) {
829 e2c54635SPaolo Bonzini    my %args = %{$_[0]};
830 e2c54635SPaolo Bonzini    my ($parameter, $section);
831 e2c54635SPaolo Bonzini    my $oldprefix = $lineprefix;
832 e2c54635SPaolo Bonzini    my $start = "";
833 e2c54635SPaolo Bonzini
834 e2c54635SPaolo Bonzini    if ($args{'typedef'}) {
835 e2c54635SPaolo Bonzini	print ".. c:type:: ". $args{'function'} . "\n\n";
836 e2c54635SPaolo Bonzini	print_lineno($declaration_start_line);
837 e2c54635SPaolo Bonzini	print "   **Typedef**: ";
838 e2c54635SPaolo Bonzini	$lineprefix = "";
839 e2c54635SPaolo Bonzini	output_highlight_rst($args{'purpose'});
840 e2c54635SPaolo Bonzini	$start = "\n\n**Syntax**\n\n  ``";
841 e2c54635SPaolo Bonzini    } else {
842 e2c54635SPaolo Bonzini	print ".. c:function:: ";
843 e2c54635SPaolo Bonzini    }
844 e2c54635SPaolo Bonzini    if ($args{'functiontype'} ne "") {
845 e2c54635SPaolo Bonzini	$start .= $args{'functiontype'} . " " . $args{'function'} . " (";
846 e2c54635SPaolo Bonzini    } else {
847 e2c54635SPaolo Bonzini	$start .= $args{'function'} . " (";
848 e2c54635SPaolo Bonzini    }
849 e2c54635SPaolo Bonzini    print $start;
850 e2c54635SPaolo Bonzini
851 e2c54635SPaolo Bonzini    my $count = 0;
852 e2c54635SPaolo Bonzini    foreach my $parameter (@{$args{'parameterlist'}}) {
853 e2c54635SPaolo Bonzini	if ($count ne 0) {
854 e2c54635SPaolo Bonzini	    print ", ";
855 e2c54635SPaolo Bonzini	}
856 e2c54635SPaolo Bonzini	$count++;
857 e2c54635SPaolo Bonzini	$type = $args{'parametertypes'}{$parameter};
858 e2c54635SPaolo Bonzini
859 e2c54635SPaolo Bonzini	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
860 e2c54635SPaolo Bonzini	    # pointer-to-function
861 a62d5637SPeter Maydell	    print $1 . $parameter . ") (" . $2 . ")";
862 e2c54635SPaolo Bonzini	} else {
863 e2c54635SPaolo Bonzini	    print $type . " " . $parameter;
864 e2c54635SPaolo Bonzini	}
865 e2c54635SPaolo Bonzini    }
866 e2c54635SPaolo Bonzini    if ($args{'typedef'}) {
867 e2c54635SPaolo Bonzini	print ");``\n\n";
868 e2c54635SPaolo Bonzini    } else {
869 e2c54635SPaolo Bonzini	print ")\n\n";
870 e2c54635SPaolo Bonzini	print_lineno($declaration_start_line);
871 e2c54635SPaolo Bonzini	$lineprefix = "   ";
872 e2c54635SPaolo Bonzini	output_highlight_rst($args{'purpose'});
873 e2c54635SPaolo Bonzini	print "\n";
874 e2c54635SPaolo Bonzini    }
875 e2c54635SPaolo Bonzini
876 e2c54635SPaolo Bonzini    print "**Parameters**\n\n";
877 e2c54635SPaolo Bonzini    $lineprefix = "  ";
878 e2c54635SPaolo Bonzini    foreach $parameter (@{$args{'parameterlist'}}) {
879 e2c54635SPaolo Bonzini	my $parameter_name = $parameter;
880 e2c54635SPaolo Bonzini	$parameter_name =~ s/\[.*//;
881 e2c54635SPaolo Bonzini	$type = $args{'parametertypes'}{$parameter};
882 e2c54635SPaolo Bonzini
883 e2c54635SPaolo Bonzini	if ($type ne "") {
884 e2c54635SPaolo Bonzini	    print "``$type $parameter``\n";
885 e2c54635SPaolo Bonzini	} else {
886 e2c54635SPaolo Bonzini	    print "``$parameter``\n";
887 e2c54635SPaolo Bonzini	}
888 e2c54635SPaolo Bonzini
889 e2c54635SPaolo Bonzini        print_lineno($parameterdesc_start_lines{$parameter_name});
890 e2c54635SPaolo Bonzini
891 e2c54635SPaolo Bonzini	if (defined($args{'parameterdescs'}{$parameter_name}) &&
892 e2c54635SPaolo Bonzini	    $args{'parameterdescs'}{$parameter_name} ne $undescribed) {
893 e2c54635SPaolo Bonzini	    output_highlight_rst($args{'parameterdescs'}{$parameter_name});
894 e2c54635SPaolo Bonzini	} else {
895 e2c54635SPaolo Bonzini	    print "  *undescribed*\n";
896 e2c54635SPaolo Bonzini	}
897 e2c54635SPaolo Bonzini	print "\n";
898 e2c54635SPaolo Bonzini    }
899 e2c54635SPaolo Bonzini
900 e2c54635SPaolo Bonzini    $lineprefix = $oldprefix;
901 e2c54635SPaolo Bonzini    output_section_rst(@_);
902 e2c54635SPaolo Bonzini}
903 e2c54635SPaolo Bonzini
904 e2c54635SPaolo Bonzinisub output_section_rst(%) {
905 e2c54635SPaolo Bonzini    my %args = %{$_[0]};
906 e2c54635SPaolo Bonzini    my $section;
907 e2c54635SPaolo Bonzini    my $oldprefix = $lineprefix;
908 e2c54635SPaolo Bonzini    $lineprefix = "";
909 e2c54635SPaolo Bonzini
910 e2c54635SPaolo Bonzini    foreach $section (@{$args{'sectionlist'}}) {
911 e2c54635SPaolo Bonzini	print "**$section**\n\n";
912 e2c54635SPaolo Bonzini        print_lineno($section_start_lines{$section});
913 e2c54635SPaolo Bonzini	output_highlight_rst($args{'sections'}{$section});
914 e2c54635SPaolo Bonzini	print "\n";
915 e2c54635SPaolo Bonzini    }
916 e2c54635SPaolo Bonzini    print "\n";
917 e2c54635SPaolo Bonzini    $lineprefix = $oldprefix;
918 e2c54635SPaolo Bonzini}
919 e2c54635SPaolo Bonzini
920 e2c54635SPaolo Bonzinisub output_enum_rst(%) {
921 e2c54635SPaolo Bonzini    my %args = %{$_[0]};
922 e2c54635SPaolo Bonzini    my ($parameter);
923 e2c54635SPaolo Bonzini    my $oldprefix = $lineprefix;
924 e2c54635SPaolo Bonzini    my $count;
925 e2c54635SPaolo Bonzini    my $name = "enum " . $args{'enum'};
926 e2c54635SPaolo Bonzini
927 e2c54635SPaolo Bonzini    print "\n\n.. c:type:: " . $name . "\n\n";
928 e2c54635SPaolo Bonzini    print_lineno($declaration_start_line);
929 e2c54635SPaolo Bonzini    $lineprefix = "   ";
930 e2c54635SPaolo Bonzini    output_highlight_rst($args{'purpose'});
931 e2c54635SPaolo Bonzini    print "\n";
932 e2c54635SPaolo Bonzini
933 e2c54635SPaolo Bonzini    print "**Constants**\n\n";
934 e2c54635SPaolo Bonzini    $lineprefix = "  ";
935 e2c54635SPaolo Bonzini    foreach $parameter (@{$args{'parameterlist'}}) {
936 e2c54635SPaolo Bonzini	print "``$parameter``\n";
937 e2c54635SPaolo Bonzini	if ($args{'parameterdescs'}{$parameter} ne $undescribed) {
938 e2c54635SPaolo Bonzini	    output_highlight_rst($args{'parameterdescs'}{$parameter});
939 e2c54635SPaolo Bonzini	} else {
940 e2c54635SPaolo Bonzini	    print "  *undescribed*\n";
941 e2c54635SPaolo Bonzini	}
942 e2c54635SPaolo Bonzini	print "\n";
943 e2c54635SPaolo Bonzini    }
944 e2c54635SPaolo Bonzini
945 e2c54635SPaolo Bonzini    $lineprefix = $oldprefix;
946 e2c54635SPaolo Bonzini    output_section_rst(@_);
947 e2c54635SPaolo Bonzini}
948 e2c54635SPaolo Bonzini
949 e2c54635SPaolo Bonzinisub output_typedef_rst(%) {
950 e2c54635SPaolo Bonzini    my %args = %{$_[0]};
951 e2c54635SPaolo Bonzini    my ($parameter);
952 e2c54635SPaolo Bonzini    my $oldprefix = $lineprefix;
953 e2c54635SPaolo Bonzini    my $name = "typedef " . $args{'typedef'};
954 e2c54635SPaolo Bonzini
955 e2c54635SPaolo Bonzini    print "\n\n.. c:type:: " . $name . "\n\n";
956 e2c54635SPaolo Bonzini    print_lineno($declaration_start_line);
957 e2c54635SPaolo Bonzini    $lineprefix = "   ";
958 e2c54635SPaolo Bonzini    output_highlight_rst($args{'purpose'});
959 e2c54635SPaolo Bonzini    print "\n";
960 e2c54635SPaolo Bonzini
961 e2c54635SPaolo Bonzini    $lineprefix = $oldprefix;
962 e2c54635SPaolo Bonzini    output_section_rst(@_);
963 e2c54635SPaolo Bonzini}
964 e2c54635SPaolo Bonzini
965 e2c54635SPaolo Bonzinisub output_struct_rst(%) {
966 e2c54635SPaolo Bonzini    my %args = %{$_[0]};
967 e2c54635SPaolo Bonzini    my ($parameter);
968 e2c54635SPaolo Bonzini    my $oldprefix = $lineprefix;
969 e2c54635SPaolo Bonzini    my $name = $args{'type'} . " " . $args{'struct'};
970 e2c54635SPaolo Bonzini
971 152d1967SPeter Maydell    # Sphinx 3.0 and up will emit warnings for "c:type:: struct Foo".
972 152d1967SPeter Maydell    # It wants to see "c:struct:: Foo" (and will add the word 'struct' in
973 152d1967SPeter Maydell    # the rendered output).
974 152d1967SPeter Maydell    if ((split(/\./, $sphinx_version))[0] >= 3) {
975 152d1967SPeter Maydell        my $sname = $name;
976 152d1967SPeter Maydell        $sname =~ s/^struct //;
977 152d1967SPeter Maydell        print "\n\n.. c:struct:: " . $sname . "\n\n";
978 152d1967SPeter Maydell    } else {
979 e2c54635SPaolo Bonzini        print "\n\n.. c:type:: " . $name . "\n\n";
980 152d1967SPeter Maydell    }
981 e2c54635SPaolo Bonzini    print_lineno($declaration_start_line);
982 e2c54635SPaolo Bonzini    $lineprefix = "   ";
983 e2c54635SPaolo Bonzini    output_highlight_rst($args{'purpose'});
984 e2c54635SPaolo Bonzini    print "\n";
985 e2c54635SPaolo Bonzini
986 e2c54635SPaolo Bonzini    print "**Definition**\n\n";
987 e2c54635SPaolo Bonzini    print "::\n\n";
988 e2c54635SPaolo Bonzini    my $declaration = $args{'definition'};
989 e2c54635SPaolo Bonzini    $declaration =~ s/\t/  /g;
990 e2c54635SPaolo Bonzini    print "  " . $args{'type'} . " " . $args{'struct'} . " {\n$declaration  };\n\n";
991 e2c54635SPaolo Bonzini
992 e2c54635SPaolo Bonzini    print "**Members**\n\n";
993 e2c54635SPaolo Bonzini    $lineprefix = "  ";
994 e2c54635SPaolo Bonzini    foreach $parameter (@{$args{'parameterlist'}}) {
995 e2c54635SPaolo Bonzini	($parameter =~ /^#/) && next;
996 e2c54635SPaolo Bonzini
997 e2c54635SPaolo Bonzini	my $parameter_name = $parameter;
998 e2c54635SPaolo Bonzini	$parameter_name =~ s/\[.*//;
999 e2c54635SPaolo Bonzini
1000 e2c54635SPaolo Bonzini	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1001 e2c54635SPaolo Bonzini	$type = $args{'parametertypes'}{$parameter};
1002 e2c54635SPaolo Bonzini        print_lineno($parameterdesc_start_lines{$parameter_name});
1003 e2c54635SPaolo Bonzini	print "``" . $parameter . "``\n";
1004 e2c54635SPaolo Bonzini	output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1005 e2c54635SPaolo Bonzini	print "\n";
1006 e2c54635SPaolo Bonzini    }
1007 e2c54635SPaolo Bonzini    print "\n";
1008 e2c54635SPaolo Bonzini
1009 e2c54635SPaolo Bonzini    $lineprefix = $oldprefix;
1010 e2c54635SPaolo Bonzini    output_section_rst(@_);
1011 e2c54635SPaolo Bonzini}
1012 e2c54635SPaolo Bonzini
1013 e2c54635SPaolo Bonzini## none mode output functions
1014 e2c54635SPaolo Bonzini
1015 e2c54635SPaolo Bonzinisub output_function_none(%) {
1016 e2c54635SPaolo Bonzini}
1017 e2c54635SPaolo Bonzini
1018 e2c54635SPaolo Bonzinisub output_enum_none(%) {
1019 e2c54635SPaolo Bonzini}
1020 e2c54635SPaolo Bonzini
1021 e2c54635SPaolo Bonzinisub output_typedef_none(%) {
1022 e2c54635SPaolo Bonzini}
1023 e2c54635SPaolo Bonzini
1024 e2c54635SPaolo Bonzinisub output_struct_none(%) {
1025 e2c54635SPaolo Bonzini}
1026 e2c54635SPaolo Bonzini
1027 e2c54635SPaolo Bonzinisub output_blockhead_none(%) {
1028 e2c54635SPaolo Bonzini}
1029 e2c54635SPaolo Bonzini
1030 e2c54635SPaolo Bonzini##
1031 e2c54635SPaolo Bonzini# generic output function for all types (function, struct/union, typedef, enum);
1032 e2c54635SPaolo Bonzini# calls the generated, variable output_ function name based on
1033 e2c54635SPaolo Bonzini# functype and output_mode
1034 e2c54635SPaolo Bonzinisub output_declaration {
1035 e2c54635SPaolo Bonzini    no strict 'refs';
1036 e2c54635SPaolo Bonzini    my $name = shift;
1037 e2c54635SPaolo Bonzini    my $functype = shift;
1038 e2c54635SPaolo Bonzini    my $func = "output_${functype}_$output_mode";
1039 e2c54635SPaolo Bonzini    if (($output_selection == OUTPUT_ALL) ||
1040 e2c54635SPaolo Bonzini	(($output_selection == OUTPUT_INCLUDE ||
1041 e2c54635SPaolo Bonzini	  $output_selection == OUTPUT_EXPORTED) &&
1042 e2c54635SPaolo Bonzini	 defined($function_table{$name})) ||
1043 e2c54635SPaolo Bonzini	(($output_selection == OUTPUT_EXCLUDE ||
1044 e2c54635SPaolo Bonzini	  $output_selection == OUTPUT_INTERNAL) &&
1045 e2c54635SPaolo Bonzini	 !($functype eq "function" && defined($function_table{$name}))))
1046 e2c54635SPaolo Bonzini    {
1047 e2c54635SPaolo Bonzini	&$func(@_);
1048 e2c54635SPaolo Bonzini	$section_counter++;
1049 e2c54635SPaolo Bonzini    }
1050 e2c54635SPaolo Bonzini}
1051 e2c54635SPaolo Bonzini
1052 e2c54635SPaolo Bonzini##
1053 e2c54635SPaolo Bonzini# generic output function - calls the right one based on current output mode.
1054 e2c54635SPaolo Bonzinisub output_blockhead {
1055 e2c54635SPaolo Bonzini    no strict 'refs';
1056 e2c54635SPaolo Bonzini    my $func = "output_blockhead_" . $output_mode;
1057 e2c54635SPaolo Bonzini    &$func(@_);
1058 e2c54635SPaolo Bonzini    $section_counter++;
1059 e2c54635SPaolo Bonzini}
1060 e2c54635SPaolo Bonzini
1061 e2c54635SPaolo Bonzini##
1062 e2c54635SPaolo Bonzini# takes a declaration (struct, union, enum, typedef) and
1063 e2c54635SPaolo Bonzini# invokes the right handler. NOT called for functions.
1064 e2c54635SPaolo Bonzinisub dump_declaration($$) {
1065 e2c54635SPaolo Bonzini    no strict 'refs';
1066 e2c54635SPaolo Bonzini    my ($prototype, $file) = @_;
1067 e2c54635SPaolo Bonzini    my $func = "dump_" . $decl_type;
1068 e2c54635SPaolo Bonzini    &$func(@_);
1069 e2c54635SPaolo Bonzini}
1070 e2c54635SPaolo Bonzini
1071 e2c54635SPaolo Bonzinisub dump_union($$) {
1072 e2c54635SPaolo Bonzini    dump_struct(@_);
1073 e2c54635SPaolo Bonzini}
1074 e2c54635SPaolo Bonzini
1075 e2c54635SPaolo Bonzinisub dump_struct($$) {
1076 e2c54635SPaolo Bonzini    my $x = shift;
1077 e2c54635SPaolo Bonzini    my $file = shift;
1078 e2c54635SPaolo Bonzini
1079 e2c54635SPaolo Bonzini    if ($x =~ /(struct|union)\s+(\w+)\s*\{(.*)\}(\s*(__packed|__aligned|__attribute__\s*\(\([a-z0-9,_\s\(\)]*\)\)))*/) {
1080 e2c54635SPaolo Bonzini	my $decl_type = $1;
1081 e2c54635SPaolo Bonzini	$declaration_name = $2;
1082 e2c54635SPaolo Bonzini	my $members = $3;
1083 e2c54635SPaolo Bonzini
1084 e2c54635SPaolo Bonzini	# ignore members marked private:
1085 e2c54635SPaolo Bonzini	$members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1086 e2c54635SPaolo Bonzini	$members =~ s/\/\*\s*private:.*//gosi;
1087 e2c54635SPaolo Bonzini	# strip comments:
1088 e2c54635SPaolo Bonzini	$members =~ s/\/\*.*?\*\///gos;
1089 e2c54635SPaolo Bonzini	# strip attributes
1090 e2c54635SPaolo Bonzini	$members =~ s/\s*__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)//gi;
1091 e2c54635SPaolo Bonzini	$members =~ s/\s*__aligned\s*\([^;]*\)//gos;
1092 e2c54635SPaolo Bonzini	$members =~ s/\s*__packed\s*//gos;
1093 e2c54635SPaolo Bonzini	$members =~ s/\s*CRYPTO_MINALIGN_ATTR//gos;
1094 e2c54635SPaolo Bonzini	# replace DECLARE_BITMAP
1095 e2c54635SPaolo Bonzini	$members =~ s/DECLARE_BITMAP\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
1096 e2c54635SPaolo Bonzini	# replace DECLARE_HASHTABLE
1097 e2c54635SPaolo Bonzini	$members =~ s/DECLARE_HASHTABLE\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
1098 e2c54635SPaolo Bonzini	# replace DECLARE_KFIFO
1099 e2c54635SPaolo Bonzini	$members =~ s/DECLARE_KFIFO\s*\(([^,)]+),\s*([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos;
1100 e2c54635SPaolo Bonzini	# replace DECLARE_KFIFO_PTR
1101 e2c54635SPaolo Bonzini	$members =~ s/DECLARE_KFIFO_PTR\s*\(([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos;
1102 e2c54635SPaolo Bonzini
1103 e2c54635SPaolo Bonzini	my $declaration = $members;
1104 e2c54635SPaolo Bonzini
1105 e2c54635SPaolo Bonzini	# Split nested struct/union elements as newer ones
1106 e2c54635SPaolo Bonzini	while ($members =~ m/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/) {
1107 e2c54635SPaolo Bonzini		my $newmember;
1108 e2c54635SPaolo Bonzini		my $maintype = $1;
1109 e2c54635SPaolo Bonzini		my $ids = $4;
1110 e2c54635SPaolo Bonzini		my $content = $3;
1111 e2c54635SPaolo Bonzini		foreach my $id(split /,/, $ids) {
1112 e2c54635SPaolo Bonzini			$newmember .= "$maintype $id; ";
1113 e2c54635SPaolo Bonzini
1114 e2c54635SPaolo Bonzini			$id =~ s/[:\[].*//;
1115 e2c54635SPaolo Bonzini			$id =~ s/^\s*\**(\S+)\s*/$1/;
1116 e2c54635SPaolo Bonzini			foreach my $arg (split /;/, $content) {
1117 e2c54635SPaolo Bonzini				next if ($arg =~ m/^\s*$/);
1118 e2c54635SPaolo Bonzini				if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) {
1119 e2c54635SPaolo Bonzini					# pointer-to-function
1120 e2c54635SPaolo Bonzini					my $type = $1;
1121 e2c54635SPaolo Bonzini					my $name = $2;
1122 e2c54635SPaolo Bonzini					my $extra = $3;
1123 e2c54635SPaolo Bonzini					next if (!$name);
1124 e2c54635SPaolo Bonzini					if ($id =~ m/^\s*$/) {
1125 e2c54635SPaolo Bonzini						# anonymous struct/union
1126 e2c54635SPaolo Bonzini						$newmember .= "$type$name$extra; ";
1127 e2c54635SPaolo Bonzini					} else {
1128 e2c54635SPaolo Bonzini						$newmember .= "$type$id.$name$extra; ";
1129 e2c54635SPaolo Bonzini					}
1130 e2c54635SPaolo Bonzini				} else {
1131 e2c54635SPaolo Bonzini					my $type;
1132 e2c54635SPaolo Bonzini					my $names;
1133 e2c54635SPaolo Bonzini					$arg =~ s/^\s+//;
1134 e2c54635SPaolo Bonzini					$arg =~ s/\s+$//;
1135 e2c54635SPaolo Bonzini					# Handle bitmaps
1136 e2c54635SPaolo Bonzini					$arg =~ s/:\s*\d+\s*//g;
1137 e2c54635SPaolo Bonzini					# Handle arrays
1138 e2c54635SPaolo Bonzini					$arg =~ s/\[.*\]//g;
1139 e2c54635SPaolo Bonzini					# The type may have multiple words,
1140 e2c54635SPaolo Bonzini					# and multiple IDs can be defined, like:
1141 e2c54635SPaolo Bonzini					#	const struct foo, *bar, foobar
1142 e2c54635SPaolo Bonzini					# So, we remove spaces when parsing the
1143 e2c54635SPaolo Bonzini					# names, in order to match just names
1144 e2c54635SPaolo Bonzini					# and commas for the names
1145 e2c54635SPaolo Bonzini					$arg =~ s/\s*,\s*/,/g;
1146 e2c54635SPaolo Bonzini					if ($arg =~ m/(.*)\s+([\S+,]+)/) {
1147 e2c54635SPaolo Bonzini						$type = $1;
1148 e2c54635SPaolo Bonzini						$names = $2;
1149 e2c54635SPaolo Bonzini					} else {
1150 e2c54635SPaolo Bonzini						$newmember .= "$arg; ";
1151 e2c54635SPaolo Bonzini						next;
1152 e2c54635SPaolo Bonzini					}
1153 e2c54635SPaolo Bonzini					foreach my $name (split /,/, $names) {
1154 e2c54635SPaolo Bonzini						$name =~ s/^\s*\**(\S+)\s*/$1/;
1155 e2c54635SPaolo Bonzini						next if (($name =~ m/^\s*$/));
1156 e2c54635SPaolo Bonzini						if ($id =~ m/^\s*$/) {
1157 e2c54635SPaolo Bonzini							# anonymous struct/union
1158 e2c54635SPaolo Bonzini							$newmember .= "$type $name; ";
1159 e2c54635SPaolo Bonzini						} else {
1160 e2c54635SPaolo Bonzini							$newmember .= "$type $id.$name; ";
1161 e2c54635SPaolo Bonzini						}
1162 e2c54635SPaolo Bonzini					}
1163 e2c54635SPaolo Bonzini				}
1164 e2c54635SPaolo Bonzini			}
1165 e2c54635SPaolo Bonzini		}
1166 e2c54635SPaolo Bonzini		$members =~ s/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/$newmember/;
1167 e2c54635SPaolo Bonzini	}
1168 e2c54635SPaolo Bonzini
1169 e2c54635SPaolo Bonzini	# Ignore other nested elements, like enums
1170 e2c54635SPaolo Bonzini	$members =~ s/(\{[^\{\}]*\})//g;
1171 e2c54635SPaolo Bonzini
1172 e2c54635SPaolo Bonzini	create_parameterlist($members, ';', $file, $declaration_name);
1173 e2c54635SPaolo Bonzini	check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual);
1174 e2c54635SPaolo Bonzini
1175 e2c54635SPaolo Bonzini	# Adjust declaration for better display
1176 e2c54635SPaolo Bonzini	$declaration =~ s/([\{;])/$1\n/g;
1177 e2c54635SPaolo Bonzini	$declaration =~ s/\}\s+;/};/g;
1178 e2c54635SPaolo Bonzini	# Better handle inlined enums
1179 e2c54635SPaolo Bonzini	do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/);
1180 e2c54635SPaolo Bonzini
1181 e2c54635SPaolo Bonzini	my @def_args = split /\n/, $declaration;
1182 e2c54635SPaolo Bonzini	my $level = 1;
1183 e2c54635SPaolo Bonzini	$declaration = "";
1184 e2c54635SPaolo Bonzini	foreach my $clause (@def_args) {
1185 e2c54635SPaolo Bonzini		$clause =~ s/^\s+//;
1186 e2c54635SPaolo Bonzini		$clause =~ s/\s+$//;
1187 e2c54635SPaolo Bonzini		$clause =~ s/\s+/ /;
1188 e2c54635SPaolo Bonzini		next if (!$clause);
1189 e2c54635SPaolo Bonzini		$level-- if ($clause =~ m/(\})/ && $level > 1);
1190 e2c54635SPaolo Bonzini		if (!($clause =~ m/^\s*#/)) {
1191 e2c54635SPaolo Bonzini			$declaration .= "\t" x $level;
1192 e2c54635SPaolo Bonzini		}
1193 e2c54635SPaolo Bonzini		$declaration .= "\t" . $clause . "\n";
1194 e2c54635SPaolo Bonzini		$level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/));
1195 e2c54635SPaolo Bonzini	}
1196 e2c54635SPaolo Bonzini	output_declaration($declaration_name,
1197 e2c54635SPaolo Bonzini			   'struct',
1198 e2c54635SPaolo Bonzini			   {'struct' => $declaration_name,
1199 e2c54635SPaolo Bonzini			    'module' => $modulename,
1200 e2c54635SPaolo Bonzini			    'definition' => $declaration,
1201 e2c54635SPaolo Bonzini			    'parameterlist' => \@parameterlist,
1202 e2c54635SPaolo Bonzini			    'parameterdescs' => \%parameterdescs,
1203 e2c54635SPaolo Bonzini			    'parametertypes' => \%parametertypes,
1204 e2c54635SPaolo Bonzini			    'sectionlist' => \@sectionlist,
1205 e2c54635SPaolo Bonzini			    'sections' => \%sections,
1206 e2c54635SPaolo Bonzini			    'purpose' => $declaration_purpose,
1207 e2c54635SPaolo Bonzini			    'type' => $decl_type
1208 e2c54635SPaolo Bonzini			   });
1209 e2c54635SPaolo Bonzini    }
1210 e2c54635SPaolo Bonzini    else {
1211 e2c54635SPaolo Bonzini	print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
1212 e2c54635SPaolo Bonzini	++$errors;
1213 e2c54635SPaolo Bonzini    }
1214 e2c54635SPaolo Bonzini}
1215 e2c54635SPaolo Bonzini
1216 e2c54635SPaolo Bonzini
1217 e2c54635SPaolo Bonzinisub show_warnings($$) {
1218 e2c54635SPaolo Bonzini	my $functype = shift;
1219 e2c54635SPaolo Bonzini	my $name = shift;
1220 e2c54635SPaolo Bonzini
1221 e2c54635SPaolo Bonzini	return 1 if ($output_selection == OUTPUT_ALL);
1222 e2c54635SPaolo Bonzini
1223 e2c54635SPaolo Bonzini	if ($output_selection == OUTPUT_EXPORTED) {
1224 e2c54635SPaolo Bonzini		if (defined($function_table{$name})) {
1225 e2c54635SPaolo Bonzini			return 1;
1226 e2c54635SPaolo Bonzini		} else {
1227 e2c54635SPaolo Bonzini			return 0;
1228 e2c54635SPaolo Bonzini		}
1229 e2c54635SPaolo Bonzini	}
1230 e2c54635SPaolo Bonzini        if ($output_selection == OUTPUT_INTERNAL) {
1231 e2c54635SPaolo Bonzini		if (!($functype eq "function" && defined($function_table{$name}))) {
1232 e2c54635SPaolo Bonzini			return 1;
1233 e2c54635SPaolo Bonzini		} else {
1234 e2c54635SPaolo Bonzini			return 0;
1235 e2c54635SPaolo Bonzini		}
1236 e2c54635SPaolo Bonzini	}
1237 e2c54635SPaolo Bonzini	if ($output_selection == OUTPUT_INCLUDE) {
1238 e2c54635SPaolo Bonzini		if (defined($function_table{$name})) {
1239 e2c54635SPaolo Bonzini			return 1;
1240 e2c54635SPaolo Bonzini		} else {
1241 e2c54635SPaolo Bonzini			return 0;
1242 e2c54635SPaolo Bonzini		}
1243 e2c54635SPaolo Bonzini	}
1244 e2c54635SPaolo Bonzini	if ($output_selection == OUTPUT_EXCLUDE) {
1245 e2c54635SPaolo Bonzini		if (!defined($function_table{$name})) {
1246 e2c54635SPaolo Bonzini			return 1;
1247 e2c54635SPaolo Bonzini		} else {
1248 e2c54635SPaolo Bonzini			return 0;
1249 e2c54635SPaolo Bonzini		}
1250 e2c54635SPaolo Bonzini	}
1251 e2c54635SPaolo Bonzini	die("Please add the new output type at show_warnings()");
1252 e2c54635SPaolo Bonzini}
1253 e2c54635SPaolo Bonzini
1254 e2c54635SPaolo Bonzinisub dump_enum($$) {
1255 e2c54635SPaolo Bonzini    my $x = shift;
1256 e2c54635SPaolo Bonzini    my $file = shift;
1257 e2c54635SPaolo Bonzini
1258 e2c54635SPaolo Bonzini    $x =~ s@/\*.*?\*/@@gos;	# strip comments.
1259 e2c54635SPaolo Bonzini    # strip #define macros inside enums
1260 e2c54635SPaolo Bonzini    $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;
1261 e2c54635SPaolo Bonzini
1262 e2c54635SPaolo Bonzini    if ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) {
1263 e2c54635SPaolo Bonzini	$declaration_name = $1;
1264 e2c54635SPaolo Bonzini	my $members = $2;
1265 e2c54635SPaolo Bonzini	my %_members;
1266 e2c54635SPaolo Bonzini
1267 e2c54635SPaolo Bonzini	$members =~ s/\s+$//;
1268 e2c54635SPaolo Bonzini
1269 e2c54635SPaolo Bonzini	foreach my $arg (split ',', $members) {
1270 e2c54635SPaolo Bonzini	    $arg =~ s/^\s*(\w+).*/$1/;
1271 e2c54635SPaolo Bonzini	    push @parameterlist, $arg;
1272 e2c54635SPaolo Bonzini	    if (!$parameterdescs{$arg}) {
1273 e2c54635SPaolo Bonzini		$parameterdescs{$arg} = $undescribed;
1274 e2c54635SPaolo Bonzini	        if (show_warnings("enum", $declaration_name)) {
1275 e2c54635SPaolo Bonzini			print STDERR "${file}:$.: warning: Enum value '$arg' not described in enum '$declaration_name'\n";
1276 e2c54635SPaolo Bonzini		}
1277 e2c54635SPaolo Bonzini	    }
1278 e2c54635SPaolo Bonzini	    $_members{$arg} = 1;
1279 e2c54635SPaolo Bonzini	}
1280 e2c54635SPaolo Bonzini
1281 e2c54635SPaolo Bonzini	while (my ($k, $v) = each %parameterdescs) {
1282 e2c54635SPaolo Bonzini	    if (!exists($_members{$k})) {
1283 e2c54635SPaolo Bonzini	        if (show_warnings("enum", $declaration_name)) {
1284 e2c54635SPaolo Bonzini		     print STDERR "${file}:$.: warning: Excess enum value '$k' description in '$declaration_name'\n";
1285 e2c54635SPaolo Bonzini		}
1286 e2c54635SPaolo Bonzini	    }
1287 e2c54635SPaolo Bonzini        }
1288 e2c54635SPaolo Bonzini
1289 e2c54635SPaolo Bonzini	output_declaration($declaration_name,
1290 e2c54635SPaolo Bonzini			   'enum',
1291 e2c54635SPaolo Bonzini			   {'enum' => $declaration_name,
1292 e2c54635SPaolo Bonzini			    'module' => $modulename,
1293 e2c54635SPaolo Bonzini			    'parameterlist' => \@parameterlist,
1294 e2c54635SPaolo Bonzini			    'parameterdescs' => \%parameterdescs,
1295 e2c54635SPaolo Bonzini			    'sectionlist' => \@sectionlist,
1296 e2c54635SPaolo Bonzini			    'sections' => \%sections,
1297 e2c54635SPaolo Bonzini			    'purpose' => $declaration_purpose
1298 e2c54635SPaolo Bonzini			   });
1299 e2c54635SPaolo Bonzini    }
1300 e2c54635SPaolo Bonzini    else {
1301 e2c54635SPaolo Bonzini	print STDERR "${file}:$.: error: Cannot parse enum!\n";
1302 e2c54635SPaolo Bonzini	++$errors;
1303 e2c54635SPaolo Bonzini    }
1304 e2c54635SPaolo Bonzini}
1305 e2c54635SPaolo Bonzini
1306 e2c54635SPaolo Bonzinisub dump_typedef($$) {
1307 e2c54635SPaolo Bonzini    my $x = shift;
1308 e2c54635SPaolo Bonzini    my $file = shift;
1309 e2c54635SPaolo Bonzini
1310 e2c54635SPaolo Bonzini    $x =~ s@/\*.*?\*/@@gos;	# strip comments.
1311 e2c54635SPaolo Bonzini
1312 e2c54635SPaolo Bonzini    # Parse function prototypes
1313 3cd3c519SEduardo Habkost    if ($x =~ /typedef\s+(\w+\s*\**)\s*\(\*?\s*(\w\S+)\s*\)\s*\((.*)\);/ ||
1314 19ab6044SEduardo Habkost	$x =~ /typedef\s+(\w+\s*\**)\s*(\w\S+)\s*\s*\((.*)\);/) {
1315 e2c54635SPaolo Bonzini
1316 e2c54635SPaolo Bonzini	# Function typedefs
1317 e2c54635SPaolo Bonzini	$return_type = $1;
1318 e2c54635SPaolo Bonzini	$declaration_name = $2;
1319 e2c54635SPaolo Bonzini	my $args = $3;
1320 e2c54635SPaolo Bonzini
1321 e2c54635SPaolo Bonzini	create_parameterlist($args, ',', $file, $declaration_name);
1322 e2c54635SPaolo Bonzini
1323 e2c54635SPaolo Bonzini	output_declaration($declaration_name,
1324 e2c54635SPaolo Bonzini			   'function',
1325 e2c54635SPaolo Bonzini			   {'function' => $declaration_name,
1326 e2c54635SPaolo Bonzini			    'typedef' => 1,
1327 e2c54635SPaolo Bonzini			    'module' => $modulename,
1328 e2c54635SPaolo Bonzini			    'functiontype' => $return_type,
1329 e2c54635SPaolo Bonzini			    'parameterlist' => \@parameterlist,
1330 e2c54635SPaolo Bonzini			    'parameterdescs' => \%parameterdescs,
1331 e2c54635SPaolo Bonzini			    'parametertypes' => \%parametertypes,
1332 e2c54635SPaolo Bonzini			    'sectionlist' => \@sectionlist,
1333 e2c54635SPaolo Bonzini			    'sections' => \%sections,
1334 e2c54635SPaolo Bonzini			    'purpose' => $declaration_purpose
1335 e2c54635SPaolo Bonzini			   });
1336 e2c54635SPaolo Bonzini	return;
1337 e2c54635SPaolo Bonzini    }
1338 e2c54635SPaolo Bonzini
1339 e2c54635SPaolo Bonzini    while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1340 e2c54635SPaolo Bonzini	$x =~ s/\(*.\)\s*;$/;/;
1341 e2c54635SPaolo Bonzini	$x =~ s/\[*.\]\s*;$/;/;
1342 e2c54635SPaolo Bonzini    }
1343 e2c54635SPaolo Bonzini
1344 e2c54635SPaolo Bonzini    if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1345 e2c54635SPaolo Bonzini	$declaration_name = $1;
1346 e2c54635SPaolo Bonzini
1347 e2c54635SPaolo Bonzini	output_declaration($declaration_name,
1348 e2c54635SPaolo Bonzini			   'typedef',
1349 e2c54635SPaolo Bonzini			   {'typedef' => $declaration_name,
1350 e2c54635SPaolo Bonzini			    'module' => $modulename,
1351 e2c54635SPaolo Bonzini			    'sectionlist' => \@sectionlist,
1352 e2c54635SPaolo Bonzini			    'sections' => \%sections,
1353 e2c54635SPaolo Bonzini			    'purpose' => $declaration_purpose
1354 e2c54635SPaolo Bonzini			   });
1355 e2c54635SPaolo Bonzini    }
1356 e2c54635SPaolo Bonzini    else {
1357 e2c54635SPaolo Bonzini	print STDERR "${file}:$.: error: Cannot parse typedef!\n";
1358 e2c54635SPaolo Bonzini	++$errors;
1359 e2c54635SPaolo Bonzini    }
1360 e2c54635SPaolo Bonzini}
1361 e2c54635SPaolo Bonzini
1362 e2c54635SPaolo Bonzinisub save_struct_actual($) {
1363 e2c54635SPaolo Bonzini    my $actual = shift;
1364 e2c54635SPaolo Bonzini
1365 e2c54635SPaolo Bonzini    # strip all spaces from the actual param so that it looks like one string item
1366 e2c54635SPaolo Bonzini    $actual =~ s/\s*//g;
1367 e2c54635SPaolo Bonzini    $struct_actual = $struct_actual . $actual . " ";
1368 e2c54635SPaolo Bonzini}
1369 e2c54635SPaolo Bonzini
1370 e2c54635SPaolo Bonzinisub create_parameterlist($$$$) {
1371 e2c54635SPaolo Bonzini    my $args = shift;
1372 e2c54635SPaolo Bonzini    my $splitter = shift;
1373 e2c54635SPaolo Bonzini    my $file = shift;
1374 e2c54635SPaolo Bonzini    my $declaration_name = shift;
1375 e2c54635SPaolo Bonzini    my $type;
1376 e2c54635SPaolo Bonzini    my $param;
1377 e2c54635SPaolo Bonzini
1378 e2c54635SPaolo Bonzini    # temporarily replace commas inside function pointer definition
1379 e2c54635SPaolo Bonzini    while ($args =~ /(\([^\),]+),/) {
1380 e2c54635SPaolo Bonzini	$args =~ s/(\([^\),]+),/$1#/g;
1381 e2c54635SPaolo Bonzini    }
1382 e2c54635SPaolo Bonzini
1383 e2c54635SPaolo Bonzini    foreach my $arg (split($splitter, $args)) {
1384 e2c54635SPaolo Bonzini	# strip comments
1385 e2c54635SPaolo Bonzini	$arg =~ s/\/\*.*\*\///;
1386 e2c54635SPaolo Bonzini	# strip leading/trailing spaces
1387 e2c54635SPaolo Bonzini	$arg =~ s/^\s*//;
1388 e2c54635SPaolo Bonzini	$arg =~ s/\s*$//;
1389 e2c54635SPaolo Bonzini	$arg =~ s/\s+/ /;
1390 e2c54635SPaolo Bonzini
1391 e2c54635SPaolo Bonzini	if ($arg =~ /^#/) {
1392 e2c54635SPaolo Bonzini	    # Treat preprocessor directive as a typeless variable just to fill
1393 e2c54635SPaolo Bonzini	    # corresponding data structures "correctly". Catch it later in
1394 e2c54635SPaolo Bonzini	    # output_* subs.
1395 e2c54635SPaolo Bonzini	    push_parameter($arg, "", $file);
1396 e2c54635SPaolo Bonzini	} elsif ($arg =~ m/\(.+\)\s*\(/) {
1397 e2c54635SPaolo Bonzini	    # pointer-to-function
1398 e2c54635SPaolo Bonzini	    $arg =~ tr/#/,/;
1399 e2c54635SPaolo Bonzini	    $arg =~ m/[^\(]+\(\*?\s*([\w\.]*)\s*\)/;
1400 e2c54635SPaolo Bonzini	    $param = $1;
1401 e2c54635SPaolo Bonzini	    $type = $arg;
1402 e2c54635SPaolo Bonzini	    $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1403 e2c54635SPaolo Bonzini	    save_struct_actual($param);
1404 e2c54635SPaolo Bonzini	    push_parameter($param, $type, $file, $declaration_name);
1405 e2c54635SPaolo Bonzini	} elsif ($arg) {
1406 e2c54635SPaolo Bonzini	    $arg =~ s/\s*:\s*/:/g;
1407 e2c54635SPaolo Bonzini	    $arg =~ s/\s*\[/\[/g;
1408 e2c54635SPaolo Bonzini
1409 e2c54635SPaolo Bonzini	    my @args = split('\s*,\s*', $arg);
1410 e2c54635SPaolo Bonzini	    if ($args[0] =~ m/\*/) {
1411 e2c54635SPaolo Bonzini		$args[0] =~ s/(\*+)\s*/ $1/;
1412 e2c54635SPaolo Bonzini	    }
1413 e2c54635SPaolo Bonzini
1414 e2c54635SPaolo Bonzini	    my @first_arg;
1415 e2c54635SPaolo Bonzini	    if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1416 e2c54635SPaolo Bonzini		    shift @args;
1417 e2c54635SPaolo Bonzini		    push(@first_arg, split('\s+', $1));
1418 e2c54635SPaolo Bonzini		    push(@first_arg, $2);
1419 e2c54635SPaolo Bonzini	    } else {
1420 e2c54635SPaolo Bonzini		    @first_arg = split('\s+', shift @args);
1421 e2c54635SPaolo Bonzini	    }
1422 e2c54635SPaolo Bonzini
1423 e2c54635SPaolo Bonzini	    unshift(@args, pop @first_arg);
1424 e2c54635SPaolo Bonzini	    $type = join " ", @first_arg;
1425 e2c54635SPaolo Bonzini
1426 e2c54635SPaolo Bonzini	    foreach $param (@args) {
1427 e2c54635SPaolo Bonzini		if ($param =~ m/^(\*+)\s*(.*)/) {
1428 e2c54635SPaolo Bonzini		    save_struct_actual($2);
1429 e2c54635SPaolo Bonzini		    push_parameter($2, "$type $1", $file, $declaration_name);
1430 e2c54635SPaolo Bonzini		}
1431 e2c54635SPaolo Bonzini		elsif ($param =~ m/(.*?):(\d+)/) {
1432 e2c54635SPaolo Bonzini		    if ($type ne "") { # skip unnamed bit-fields
1433 e2c54635SPaolo Bonzini			save_struct_actual($1);
1434 e2c54635SPaolo Bonzini			push_parameter($1, "$type:$2", $file, $declaration_name)
1435 e2c54635SPaolo Bonzini		    }
1436 e2c54635SPaolo Bonzini		}
1437 e2c54635SPaolo Bonzini		else {
1438 e2c54635SPaolo Bonzini		    save_struct_actual($param);
1439 e2c54635SPaolo Bonzini		    push_parameter($param, $type, $file, $declaration_name);
1440 e2c54635SPaolo Bonzini		}
1441 e2c54635SPaolo Bonzini	    }
1442 e2c54635SPaolo Bonzini	}
1443 e2c54635SPaolo Bonzini    }
1444 e2c54635SPaolo Bonzini}
1445 e2c54635SPaolo Bonzini
1446 e2c54635SPaolo Bonzinisub push_parameter($$$$) {
1447 e2c54635SPaolo Bonzini	my $param = shift;
1448 e2c54635SPaolo Bonzini	my $type = shift;
1449 e2c54635SPaolo Bonzini	my $file = shift;
1450 e2c54635SPaolo Bonzini	my $declaration_name = shift;
1451 e2c54635SPaolo Bonzini
1452 e2c54635SPaolo Bonzini	if (($anon_struct_union == 1) && ($type eq "") &&
1453 e2c54635SPaolo Bonzini	    ($param eq "}")) {
1454 e2c54635SPaolo Bonzini		return;		# ignore the ending }; from anon. struct/union
1455 e2c54635SPaolo Bonzini	}
1456 e2c54635SPaolo Bonzini
1457 e2c54635SPaolo Bonzini	$anon_struct_union = 0;
1458 e2c54635SPaolo Bonzini	$param =~ s/[\[\)].*//;
1459 e2c54635SPaolo Bonzini
1460 e2c54635SPaolo Bonzini	if ($type eq "" && $param =~ /\.\.\.$/)
1461 e2c54635SPaolo Bonzini	{
1462 e2c54635SPaolo Bonzini	    if (!$param =~ /\w\.\.\.$/) {
1463 e2c54635SPaolo Bonzini	      # handles unnamed variable parameters
1464 e2c54635SPaolo Bonzini	      $param = "...";
1465 e2c54635SPaolo Bonzini	    }
1466 e2c54635SPaolo Bonzini	    if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1467 e2c54635SPaolo Bonzini		$parameterdescs{$param} = "variable arguments";
1468 e2c54635SPaolo Bonzini	    }
1469 e2c54635SPaolo Bonzini	}
1470 e2c54635SPaolo Bonzini	elsif ($type eq "" && ($param eq "" or $param eq "void"))
1471 e2c54635SPaolo Bonzini	{
1472 e2c54635SPaolo Bonzini	    $param="void";
1473 e2c54635SPaolo Bonzini	    $parameterdescs{void} = "no arguments";
1474 e2c54635SPaolo Bonzini	}
1475 e2c54635SPaolo Bonzini	elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1476 e2c54635SPaolo Bonzini	# handle unnamed (anonymous) union or struct:
1477 e2c54635SPaolo Bonzini	{
1478 e2c54635SPaolo Bonzini		$type = $param;
1479 e2c54635SPaolo Bonzini		$param = "{unnamed_" . $param . "}";
1480 e2c54635SPaolo Bonzini		$parameterdescs{$param} = "anonymous\n";
1481 e2c54635SPaolo Bonzini		$anon_struct_union = 1;
1482 e2c54635SPaolo Bonzini	}
1483 e2c54635SPaolo Bonzini
1484 e2c54635SPaolo Bonzini	# warn if parameter has no description
1485 e2c54635SPaolo Bonzini	# (but ignore ones starting with # as these are not parameters
1486 e2c54635SPaolo Bonzini	# but inline preprocessor statements);
1487 e2c54635SPaolo Bonzini	# Note: It will also ignore void params and unnamed structs/unions
1488 e2c54635SPaolo Bonzini	if (!defined $parameterdescs{$param} && $param !~ /^#/) {
1489 e2c54635SPaolo Bonzini		$parameterdescs{$param} = $undescribed;
1490 e2c54635SPaolo Bonzini
1491 e2c54635SPaolo Bonzini	        if (show_warnings($type, $declaration_name) && $param !~ /\./) {
1492 e2c54635SPaolo Bonzini			print STDERR
1493 e2c54635SPaolo Bonzini			      "${file}:$.: warning: Function parameter or member '$param' not described in '$declaration_name'\n";
1494 e2c54635SPaolo Bonzini			++$warnings;
1495 e2c54635SPaolo Bonzini		}
1496 e2c54635SPaolo Bonzini	}
1497 e2c54635SPaolo Bonzini
1498 e2c54635SPaolo Bonzini	# strip spaces from $param so that it is one continuous string
1499 e2c54635SPaolo Bonzini	# on @parameterlist;
1500 e2c54635SPaolo Bonzini	# this fixes a problem where check_sections() cannot find
1501 e2c54635SPaolo Bonzini	# a parameter like "addr[6 + 2]" because it actually appears
1502 e2c54635SPaolo Bonzini	# as "addr[6", "+", "2]" on the parameter list;
1503 e2c54635SPaolo Bonzini	# but it's better to maintain the param string unchanged for output,
1504 e2c54635SPaolo Bonzini	# so just weaken the string compare in check_sections() to ignore
1505 e2c54635SPaolo Bonzini	# "[blah" in a parameter string;
1506 e2c54635SPaolo Bonzini	###$param =~ s/\s*//g;
1507 e2c54635SPaolo Bonzini	push @parameterlist, $param;
1508 e2c54635SPaolo Bonzini	$type =~ s/\s\s+/ /g;
1509 e2c54635SPaolo Bonzini	$parametertypes{$param} = $type;
1510 e2c54635SPaolo Bonzini}
1511 e2c54635SPaolo Bonzini
1512 e2c54635SPaolo Bonzinisub check_sections($$$$$) {
1513 e2c54635SPaolo Bonzini	my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_;
1514 e2c54635SPaolo Bonzini	my @sects = split ' ', $sectcheck;
1515 e2c54635SPaolo Bonzini	my @prms = split ' ', $prmscheck;
1516 e2c54635SPaolo Bonzini	my $err;
1517 e2c54635SPaolo Bonzini	my ($px, $sx);
1518 e2c54635SPaolo Bonzini	my $prm_clean;		# strip trailing "[array size]" and/or beginning "*"
1519 e2c54635SPaolo Bonzini
1520 e2c54635SPaolo Bonzini	foreach $sx (0 .. $#sects) {
1521 e2c54635SPaolo Bonzini		$err = 1;
1522 e2c54635SPaolo Bonzini		foreach $px (0 .. $#prms) {
1523 e2c54635SPaolo Bonzini			$prm_clean = $prms[$px];
1524 e2c54635SPaolo Bonzini			$prm_clean =~ s/\[.*\]//;
1525 e2c54635SPaolo Bonzini			$prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;
1526 e2c54635SPaolo Bonzini			# ignore array size in a parameter string;
1527 e2c54635SPaolo Bonzini			# however, the original param string may contain
1528 e2c54635SPaolo Bonzini			# spaces, e.g.:  addr[6 + 2]
1529 e2c54635SPaolo Bonzini			# and this appears in @prms as "addr[6" since the
1530 e2c54635SPaolo Bonzini			# parameter list is split at spaces;
1531 e2c54635SPaolo Bonzini			# hence just ignore "[..." for the sections check;
1532 e2c54635SPaolo Bonzini			$prm_clean =~ s/\[.*//;
1533 e2c54635SPaolo Bonzini
1534 e2c54635SPaolo Bonzini			##$prm_clean =~ s/^\**//;
1535 e2c54635SPaolo Bonzini			if ($prm_clean eq $sects[$sx]) {
1536 e2c54635SPaolo Bonzini				$err = 0;
1537 e2c54635SPaolo Bonzini				last;
1538 e2c54635SPaolo Bonzini			}
1539 e2c54635SPaolo Bonzini		}
1540 e2c54635SPaolo Bonzini		if ($err) {
1541 e2c54635SPaolo Bonzini			if ($decl_type eq "function") {
1542 e2c54635SPaolo Bonzini				print STDERR "${file}:$.: warning: " .
1543 e2c54635SPaolo Bonzini					"Excess function parameter " .
1544 e2c54635SPaolo Bonzini					"'$sects[$sx]' " .
1545 e2c54635SPaolo Bonzini					"description in '$decl_name'\n";
1546 e2c54635SPaolo Bonzini				++$warnings;
1547 e2c54635SPaolo Bonzini			}
1548 e2c54635SPaolo Bonzini		}
1549 e2c54635SPaolo Bonzini	}
1550 e2c54635SPaolo Bonzini}
1551 e2c54635SPaolo Bonzini
1552 e2c54635SPaolo Bonzini##
1553 e2c54635SPaolo Bonzini# Checks the section describing the return value of a function.
1554 e2c54635SPaolo Bonzinisub check_return_section {
1555 e2c54635SPaolo Bonzini        my $file = shift;
1556 e2c54635SPaolo Bonzini        my $declaration_name = shift;
1557 e2c54635SPaolo Bonzini        my $return_type = shift;
1558 e2c54635SPaolo Bonzini
1559 e2c54635SPaolo Bonzini        # Ignore an empty return type (It's a macro)
1560 e2c54635SPaolo Bonzini        # Ignore functions with a "void" return type. (But don't ignore "void *")
1561 e2c54635SPaolo Bonzini        if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
1562 e2c54635SPaolo Bonzini                return;
1563 e2c54635SPaolo Bonzini        }
1564 e2c54635SPaolo Bonzini
1565 e2c54635SPaolo Bonzini        if (!defined($sections{$section_return}) ||
1566 e2c54635SPaolo Bonzini            $sections{$section_return} eq "") {
1567 e2c54635SPaolo Bonzini                print STDERR "${file}:$.: warning: " .
1568 e2c54635SPaolo Bonzini                        "No description found for return value of " .
1569 e2c54635SPaolo Bonzini                        "'$declaration_name'\n";
1570 e2c54635SPaolo Bonzini                ++$warnings;
1571 e2c54635SPaolo Bonzini        }
1572 e2c54635SPaolo Bonzini}
1573 e2c54635SPaolo Bonzini
1574 e2c54635SPaolo Bonzini##
1575 e2c54635SPaolo Bonzini# takes a function prototype and the name of the current file being
1576 e2c54635SPaolo Bonzini# processed and spits out all the details stored in the global
1577 e2c54635SPaolo Bonzini# arrays/hashes.
1578 e2c54635SPaolo Bonzinisub dump_function($$) {
1579 e2c54635SPaolo Bonzini    my $prototype = shift;
1580 e2c54635SPaolo Bonzini    my $file = shift;
1581 e2c54635SPaolo Bonzini    my $noret = 0;
1582 e2c54635SPaolo Bonzini
1583 e2c54635SPaolo Bonzini    $prototype =~ s/^static +//;
1584 e2c54635SPaolo Bonzini    $prototype =~ s/^extern +//;
1585 e2c54635SPaolo Bonzini    $prototype =~ s/^asmlinkage +//;
1586 e2c54635SPaolo Bonzini    $prototype =~ s/^inline +//;
1587 e2c54635SPaolo Bonzini    $prototype =~ s/^__inline__ +//;
1588 e2c54635SPaolo Bonzini    $prototype =~ s/^__inline +//;
1589 e2c54635SPaolo Bonzini    $prototype =~ s/^__always_inline +//;
1590 e2c54635SPaolo Bonzini    $prototype =~ s/^noinline +//;
1591 e2c54635SPaolo Bonzini    $prototype =~ s/__init +//;
1592 e2c54635SPaolo Bonzini    $prototype =~ s/__init_or_module +//;
1593 e2c54635SPaolo Bonzini    $prototype =~ s/__meminit +//;
1594 e2c54635SPaolo Bonzini    $prototype =~ s/__must_check +//;
1595 e2c54635SPaolo Bonzini    $prototype =~ s/__weak +//;
1596 e2c54635SPaolo Bonzini    $prototype =~ s/__sched +//;
1597 e2c54635SPaolo Bonzini    $prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//;
1598 e2c54635SPaolo Bonzini    my $define = $prototype =~ s/^#\s*define\s+//; #ak added
1599 e2c54635SPaolo Bonzini    $prototype =~ s/__attribute__\s*\(\(
1600 e2c54635SPaolo Bonzini            (?:
1601 e2c54635SPaolo Bonzini                 [\w\s]++          # attribute name
1602 e2c54635SPaolo Bonzini                 (?:\([^)]*+\))?   # attribute arguments
1603 e2c54635SPaolo Bonzini                 \s*+,?            # optional comma at the end
1604 e2c54635SPaolo Bonzini            )+
1605 e2c54635SPaolo Bonzini          \)\)\s+//x;
1606 e2c54635SPaolo Bonzini
1607 e2c54635SPaolo Bonzini    # Yes, this truly is vile.  We are looking for:
1608 e2c54635SPaolo Bonzini    # 1. Return type (may be nothing if we're looking at a macro)
1609 e2c54635SPaolo Bonzini    # 2. Function name
1610 e2c54635SPaolo Bonzini    # 3. Function parameters.
1611 e2c54635SPaolo Bonzini    #
1612 e2c54635SPaolo Bonzini    # All the while we have to watch out for function pointer parameters
1613 e2c54635SPaolo Bonzini    # (which IIRC is what the two sections are for), C types (these
1614 e2c54635SPaolo Bonzini    # regexps don't even start to express all the possibilities), and
1615 e2c54635SPaolo Bonzini    # so on.
1616 e2c54635SPaolo Bonzini    #
1617 e2c54635SPaolo Bonzini    # If you mess with these regexps, it's a good idea to check that
1618 e2c54635SPaolo Bonzini    # the following functions' documentation still comes out right:
1619 e2c54635SPaolo Bonzini    # - parport_register_device (function pointer parameters)
1620 d73415a3SStefan Hajnoczi    # - qatomic_set (macro)
1621 e2c54635SPaolo Bonzini    # - pci_match_device, __copy_to_user (long return type)
1622 e2c54635SPaolo Bonzini
1623 e2c54635SPaolo Bonzini    if ($define && $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s+/) {
1624 e2c54635SPaolo Bonzini        # This is an object-like macro, it has no return type and no parameter
1625 e2c54635SPaolo Bonzini        # list.
1626 e2c54635SPaolo Bonzini        # Function-like macros are not allowed to have spaces between
1627 e2c54635SPaolo Bonzini        # declaration_name and opening parenthesis (notice the \s+).
1628 e2c54635SPaolo Bonzini        $return_type = $1;
1629 e2c54635SPaolo Bonzini        $declaration_name = $2;
1630 e2c54635SPaolo Bonzini        $noret = 1;
1631 e2c54635SPaolo Bonzini    } elsif ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1632 e2c54635SPaolo Bonzini	$prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1633 e2c54635SPaolo Bonzini	$prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1634 e2c54635SPaolo Bonzini	$prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1635 e2c54635SPaolo Bonzini	$prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1636 e2c54635SPaolo Bonzini	$prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1637 e2c54635SPaolo Bonzini	$prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1638 e2c54635SPaolo Bonzini	$prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1639 e2c54635SPaolo Bonzini	$prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1640 e2c54635SPaolo Bonzini	$prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1641 e2c54635SPaolo Bonzini	$prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1642 e2c54635SPaolo Bonzini	$prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1643 e2c54635SPaolo Bonzini	$prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1644 e2c54635SPaolo Bonzini	$prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1645 e2c54635SPaolo Bonzini	$prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1646 e2c54635SPaolo Bonzini	$prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1647 e2c54635SPaolo Bonzini	$prototype =~ m/^(\w+\s+\w+\s*\*+\s*\w+\s*\*+\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/)  {
1648 e2c54635SPaolo Bonzini	$return_type = $1;
1649 e2c54635SPaolo Bonzini	$declaration_name = $2;
1650 e2c54635SPaolo Bonzini	my $args = $3;
1651 e2c54635SPaolo Bonzini
1652 e2c54635SPaolo Bonzini	create_parameterlist($args, ',', $file, $declaration_name);
1653 e2c54635SPaolo Bonzini    } else {
1654 e2c54635SPaolo Bonzini	print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype'\n";
1655 e2c54635SPaolo Bonzini	return;
1656 e2c54635SPaolo Bonzini    }
1657 e2c54635SPaolo Bonzini
1658 e2c54635SPaolo Bonzini	my $prms = join " ", @parameterlist;
1659 e2c54635SPaolo Bonzini	check_sections($file, $declaration_name, "function", $sectcheck, $prms);
1660 e2c54635SPaolo Bonzini
1661 e2c54635SPaolo Bonzini        # This check emits a lot of warnings at the moment, because many
1662 e2c54635SPaolo Bonzini        # functions don't have a 'Return' doc section. So until the number
1663 e2c54635SPaolo Bonzini        # of warnings goes sufficiently down, the check is only performed in
1664 e2c54635SPaolo Bonzini        # verbose mode.
1665 e2c54635SPaolo Bonzini        # TODO: always perform the check.
1666 e2c54635SPaolo Bonzini        if ($verbose && !$noret) {
1667 e2c54635SPaolo Bonzini                check_return_section($file, $declaration_name, $return_type);
1668 e2c54635SPaolo Bonzini        }
1669 e2c54635SPaolo Bonzini
1670 e2c54635SPaolo Bonzini    output_declaration($declaration_name,
1671 e2c54635SPaolo Bonzini		       'function',
1672 e2c54635SPaolo Bonzini		       {'function' => $declaration_name,
1673 e2c54635SPaolo Bonzini			'module' => $modulename,
1674 e2c54635SPaolo Bonzini			'functiontype' => $return_type,
1675 e2c54635SPaolo Bonzini			'parameterlist' => \@parameterlist,
1676 e2c54635SPaolo Bonzini			'parameterdescs' => \%parameterdescs,
1677 e2c54635SPaolo Bonzini			'parametertypes' => \%parametertypes,
1678 e2c54635SPaolo Bonzini			'sectionlist' => \@sectionlist,
1679 e2c54635SPaolo Bonzini			'sections' => \%sections,
1680 e2c54635SPaolo Bonzini			'purpose' => $declaration_purpose
1681 e2c54635SPaolo Bonzini		       });
1682 e2c54635SPaolo Bonzini}
1683 e2c54635SPaolo Bonzini
1684 e2c54635SPaolo Bonzinisub reset_state {
1685 e2c54635SPaolo Bonzini    $function = "";
1686 e2c54635SPaolo Bonzini    %parameterdescs = ();
1687 e2c54635SPaolo Bonzini    %parametertypes = ();
1688 e2c54635SPaolo Bonzini    @parameterlist = ();
1689 e2c54635SPaolo Bonzini    %sections = ();
1690 e2c54635SPaolo Bonzini    @sectionlist = ();
1691 e2c54635SPaolo Bonzini    $sectcheck = "";
1692 e2c54635SPaolo Bonzini    $struct_actual = "";
1693 e2c54635SPaolo Bonzini    $prototype = "";
1694 e2c54635SPaolo Bonzini
1695 e2c54635SPaolo Bonzini    $state = STATE_NORMAL;
1696 e2c54635SPaolo Bonzini    $inline_doc_state = STATE_INLINE_NA;
1697 e2c54635SPaolo Bonzini}
1698 e2c54635SPaolo Bonzini
1699 e2c54635SPaolo Bonzinisub tracepoint_munge($) {
1700 e2c54635SPaolo Bonzini	my $file = shift;
1701 e2c54635SPaolo Bonzini	my $tracepointname = 0;
1702 e2c54635SPaolo Bonzini	my $tracepointargs = 0;
1703 e2c54635SPaolo Bonzini
1704 e2c54635SPaolo Bonzini	if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
1705 e2c54635SPaolo Bonzini		$tracepointname = $1;
1706 e2c54635SPaolo Bonzini	}
1707 e2c54635SPaolo Bonzini	if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1708 e2c54635SPaolo Bonzini		$tracepointname = $1;
1709 e2c54635SPaolo Bonzini	}
1710 e2c54635SPaolo Bonzini	if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1711 e2c54635SPaolo Bonzini		$tracepointname = $2;
1712 e2c54635SPaolo Bonzini	}
1713 e2c54635SPaolo Bonzini	$tracepointname =~ s/^\s+//; #strip leading whitespace
1714 e2c54635SPaolo Bonzini	if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
1715 e2c54635SPaolo Bonzini		$tracepointargs = $1;
1716 e2c54635SPaolo Bonzini	}
1717 e2c54635SPaolo Bonzini	if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1718 e2c54635SPaolo Bonzini		print STDERR "${file}:$.: warning: Unrecognized tracepoint format: \n".
1719 e2c54635SPaolo Bonzini			     "$prototype\n";
1720 e2c54635SPaolo Bonzini	} else {
1721 e2c54635SPaolo Bonzini		$prototype = "static inline void trace_$tracepointname($tracepointargs)";
1722 e2c54635SPaolo Bonzini	}
1723 e2c54635SPaolo Bonzini}
1724 e2c54635SPaolo Bonzini
1725 e2c54635SPaolo Bonzinisub syscall_munge() {
1726 e2c54635SPaolo Bonzini	my $void = 0;
1727 e2c54635SPaolo Bonzini
1728 e2c54635SPaolo Bonzini	$prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's
1729 e2c54635SPaolo Bonzini##	if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1730 e2c54635SPaolo Bonzini	if ($prototype =~ m/SYSCALL_DEFINE0/) {
1731 e2c54635SPaolo Bonzini		$void = 1;
1732 e2c54635SPaolo Bonzini##		$prototype = "long sys_$1(void)";
1733 e2c54635SPaolo Bonzini	}
1734 e2c54635SPaolo Bonzini
1735 e2c54635SPaolo Bonzini	$prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1736 e2c54635SPaolo Bonzini	if ($prototype =~ m/long (sys_.*?),/) {
1737 e2c54635SPaolo Bonzini		$prototype =~ s/,/\(/;
1738 e2c54635SPaolo Bonzini	} elsif ($void) {
1739 e2c54635SPaolo Bonzini		$prototype =~ s/\)/\(void\)/;
1740 e2c54635SPaolo Bonzini	}
1741 e2c54635SPaolo Bonzini
1742 e2c54635SPaolo Bonzini	# now delete all of the odd-number commas in $prototype
1743 e2c54635SPaolo Bonzini	# so that arg types & arg names don't have a comma between them
1744 e2c54635SPaolo Bonzini	my $count = 0;
1745 e2c54635SPaolo Bonzini	my $len = length($prototype);
1746 e2c54635SPaolo Bonzini	if ($void) {
1747 e2c54635SPaolo Bonzini		$len = 0;	# skip the for-loop
1748 e2c54635SPaolo Bonzini	}
1749 e2c54635SPaolo Bonzini	for (my $ix = 0; $ix < $len; $ix++) {
1750 e2c54635SPaolo Bonzini		if (substr($prototype, $ix, 1) eq ',') {
1751 e2c54635SPaolo Bonzini			$count++;
1752 e2c54635SPaolo Bonzini			if ($count % 2 == 1) {
1753 e2c54635SPaolo Bonzini				substr($prototype, $ix, 1) = ' ';
1754 e2c54635SPaolo Bonzini			}
1755 e2c54635SPaolo Bonzini		}
1756 e2c54635SPaolo Bonzini	}
1757 e2c54635SPaolo Bonzini}
1758 e2c54635SPaolo Bonzini
1759 e2c54635SPaolo Bonzinisub process_proto_function($$) {
1760 e2c54635SPaolo Bonzini    my $x = shift;
1761 e2c54635SPaolo Bonzini    my $file = shift;
1762 e2c54635SPaolo Bonzini
1763 e2c54635SPaolo Bonzini    $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1764 e2c54635SPaolo Bonzini
1765 e2c54635SPaolo Bonzini    if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
1766 e2c54635SPaolo Bonzini	# do nothing
1767 e2c54635SPaolo Bonzini    }
1768 e2c54635SPaolo Bonzini    elsif ($x =~ /([^\{]*)/) {
1769 e2c54635SPaolo Bonzini	$prototype .= $1;
1770 e2c54635SPaolo Bonzini    }
1771 e2c54635SPaolo Bonzini
1772 e2c54635SPaolo Bonzini    if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1773 e2c54635SPaolo Bonzini	$prototype =~ s@/\*.*?\*/@@gos;	# strip comments.
1774 e2c54635SPaolo Bonzini	$prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1775 e2c54635SPaolo Bonzini	$prototype =~ s@^\s+@@gos; # strip leading spaces
1776 e2c54635SPaolo Bonzini	if ($prototype =~ /SYSCALL_DEFINE/) {
1777 e2c54635SPaolo Bonzini		syscall_munge();
1778 e2c54635SPaolo Bonzini	}
1779 e2c54635SPaolo Bonzini	if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1780 e2c54635SPaolo Bonzini	    $prototype =~ /DEFINE_SINGLE_EVENT/)
1781 e2c54635SPaolo Bonzini	{
1782 e2c54635SPaolo Bonzini		tracepoint_munge($file);
1783 e2c54635SPaolo Bonzini	}
1784 e2c54635SPaolo Bonzini	dump_function($prototype, $file);
1785 e2c54635SPaolo Bonzini	reset_state();
1786 e2c54635SPaolo Bonzini    }
1787 e2c54635SPaolo Bonzini}
1788 e2c54635SPaolo Bonzini
1789 e2c54635SPaolo Bonzinisub process_proto_type($$) {
1790 e2c54635SPaolo Bonzini    my $x = shift;
1791 e2c54635SPaolo Bonzini    my $file = shift;
1792 e2c54635SPaolo Bonzini
1793 e2c54635SPaolo Bonzini    $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1794 e2c54635SPaolo Bonzini    $x =~ s@^\s+@@gos; # strip leading spaces
1795 e2c54635SPaolo Bonzini    $x =~ s@\s+$@@gos; # strip trailing spaces
1796 e2c54635SPaolo Bonzini    $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1797 e2c54635SPaolo Bonzini
1798 e2c54635SPaolo Bonzini    if ($x =~ /^#/) {
1799 e2c54635SPaolo Bonzini	# To distinguish preprocessor directive from regular declaration later.
1800 e2c54635SPaolo Bonzini	$x .= ";";
1801 e2c54635SPaolo Bonzini    }
1802 e2c54635SPaolo Bonzini
1803 e2c54635SPaolo Bonzini    while (1) {
1804 e2c54635SPaolo Bonzini	if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) {
1805 e2c54635SPaolo Bonzini            if( length $prototype ) {
1806 e2c54635SPaolo Bonzini                $prototype .= " "
1807 e2c54635SPaolo Bonzini            }
1808 e2c54635SPaolo Bonzini	    $prototype .= $1 . $2;
1809 e2c54635SPaolo Bonzini	    ($2 eq '{') && $brcount++;
1810 e2c54635SPaolo Bonzini	    ($2 eq '}') && $brcount--;
1811 e2c54635SPaolo Bonzini	    if (($2 eq ';') && ($brcount == 0)) {
1812 e2c54635SPaolo Bonzini		dump_declaration($prototype, $file);
1813 e2c54635SPaolo Bonzini		reset_state();
1814 e2c54635SPaolo Bonzini		last;
1815 e2c54635SPaolo Bonzini	    }
1816 e2c54635SPaolo Bonzini	    $x = $3;
1817 e2c54635SPaolo Bonzini	} else {
1818 e2c54635SPaolo Bonzini	    $prototype .= $x;
1819 e2c54635SPaolo Bonzini	    last;
1820 e2c54635SPaolo Bonzini	}
1821 e2c54635SPaolo Bonzini    }
1822 e2c54635SPaolo Bonzini}
1823 e2c54635SPaolo Bonzini
1824 e2c54635SPaolo Bonzini
1825 e2c54635SPaolo Bonzinisub map_filename($) {
1826 e2c54635SPaolo Bonzini    my $file;
1827 e2c54635SPaolo Bonzini    my ($orig_file) = @_;
1828 e2c54635SPaolo Bonzini
1829 e2c54635SPaolo Bonzini    if (defined($ENV{'SRCTREE'})) {
1830 e2c54635SPaolo Bonzini	$file = "$ENV{'SRCTREE'}" . "/" . $orig_file;
1831 e2c54635SPaolo Bonzini    } else {
1832 e2c54635SPaolo Bonzini	$file = $orig_file;
1833 e2c54635SPaolo Bonzini    }
1834 e2c54635SPaolo Bonzini
1835 e2c54635SPaolo Bonzini    if (defined($source_map{$file})) {
1836 e2c54635SPaolo Bonzini	$file = $source_map{$file};
1837 e2c54635SPaolo Bonzini    }
1838 e2c54635SPaolo Bonzini
1839 e2c54635SPaolo Bonzini    return $file;
1840 e2c54635SPaolo Bonzini}
1841 e2c54635SPaolo Bonzini
1842 e2c54635SPaolo Bonzinisub process_export_file($) {
1843 e2c54635SPaolo Bonzini    my ($orig_file) = @_;
1844 e2c54635SPaolo Bonzini    my $file = map_filename($orig_file);
1845 e2c54635SPaolo Bonzini
1846 e2c54635SPaolo Bonzini    if (!open(IN,"<$file")) {
1847 e2c54635SPaolo Bonzini	print STDERR "Error: Cannot open file $file\n";
1848 e2c54635SPaolo Bonzini	++$errors;
1849 e2c54635SPaolo Bonzini	return;
1850 e2c54635SPaolo Bonzini    }
1851 e2c54635SPaolo Bonzini
1852 e2c54635SPaolo Bonzini    while (<IN>) {
1853 e2c54635SPaolo Bonzini	if (/$export_symbol/) {
1854 e2c54635SPaolo Bonzini	    $function_table{$2} = 1;
1855 e2c54635SPaolo Bonzini	}
1856 e2c54635SPaolo Bonzini    }
1857 e2c54635SPaolo Bonzini
1858 e2c54635SPaolo Bonzini    close(IN);
1859 e2c54635SPaolo Bonzini}
1860 e2c54635SPaolo Bonzini
1861 e2c54635SPaolo Bonzini#
1862 e2c54635SPaolo Bonzini# Parsers for the various processing states.
1863 e2c54635SPaolo Bonzini#
1864 e2c54635SPaolo Bonzini# STATE_NORMAL: looking for the /** to begin everything.
1865 e2c54635SPaolo Bonzini#
1866 e2c54635SPaolo Bonzinisub process_normal() {
1867 e2c54635SPaolo Bonzini    if (/$doc_start/o) {
1868 e2c54635SPaolo Bonzini	$state = STATE_NAME;	# next line is always the function name
1869 e2c54635SPaolo Bonzini	$in_doc_sect = 0;
1870 e2c54635SPaolo Bonzini	$declaration_start_line = $. + 1;
1871 e2c54635SPaolo Bonzini    }
1872 e2c54635SPaolo Bonzini}
1873 e2c54635SPaolo Bonzini
1874 e2c54635SPaolo Bonzini#
1875 e2c54635SPaolo Bonzini# STATE_NAME: Looking for the "name - description" line
1876 e2c54635SPaolo Bonzini#
1877 e2c54635SPaolo Bonzinisub process_name($$) {
1878 e2c54635SPaolo Bonzini    my $file = shift;
1879 e2c54635SPaolo Bonzini    my $identifier;
1880 e2c54635SPaolo Bonzini    my $descr;
1881 e2c54635SPaolo Bonzini
1882 e2c54635SPaolo Bonzini    if (/$doc_block/o) {
1883 e2c54635SPaolo Bonzini	$state = STATE_DOCBLOCK;
1884 e2c54635SPaolo Bonzini	$contents = "";
1885 e2c54635SPaolo Bonzini	$new_start_line = $. + 1;
1886 e2c54635SPaolo Bonzini
1887 e2c54635SPaolo Bonzini	if ( $1 eq "" ) {
1888 e2c54635SPaolo Bonzini	    $section = $section_intro;
1889 e2c54635SPaolo Bonzini	} else {
1890 e2c54635SPaolo Bonzini	    $section = $1;
1891 e2c54635SPaolo Bonzini	}
1892 e2c54635SPaolo Bonzini    }
1893 e2c54635SPaolo Bonzini    elsif (/$doc_decl/o) {
1894 e2c54635SPaolo Bonzini	$identifier = $1;
1895 4cf41794SPaolo Bonzini	if (/\s*([\w\s]+?)(\s*-|:)/) {
1896 e2c54635SPaolo Bonzini	    $identifier = $1;
1897 e2c54635SPaolo Bonzini	}
1898 e2c54635SPaolo Bonzini
1899 e2c54635SPaolo Bonzini	$state = STATE_BODY;
1900 e2c54635SPaolo Bonzini	# if there's no @param blocks need to set up default section
1901 e2c54635SPaolo Bonzini	# here
1902 e2c54635SPaolo Bonzini	$contents = "";
1903 e2c54635SPaolo Bonzini	$section = $section_default;
1904 e2c54635SPaolo Bonzini	$new_start_line = $. + 1;
1905 4cf41794SPaolo Bonzini	if (/[-:](.*)/) {
1906 e2c54635SPaolo Bonzini	    # strip leading/trailing/multiple spaces
1907 e2c54635SPaolo Bonzini	    $descr= $1;
1908 e2c54635SPaolo Bonzini	    $descr =~ s/^\s*//;
1909 e2c54635SPaolo Bonzini	    $descr =~ s/\s*$//;
1910 e2c54635SPaolo Bonzini	    $descr =~ s/\s+/ /g;
1911 e2c54635SPaolo Bonzini	    $declaration_purpose = $descr;
1912 e2c54635SPaolo Bonzini	    $state = STATE_BODY_MAYBE;
1913 e2c54635SPaolo Bonzini	} else {
1914 e2c54635SPaolo Bonzini	    $declaration_purpose = "";
1915 e2c54635SPaolo Bonzini	}
1916 e2c54635SPaolo Bonzini
1917 e2c54635SPaolo Bonzini	if (($declaration_purpose eq "") && $verbose) {
1918 e2c54635SPaolo Bonzini	    print STDERR "${file}:$.: warning: missing initial short description on line:\n";
1919 e2c54635SPaolo Bonzini	    print STDERR $_;
1920 e2c54635SPaolo Bonzini	    ++$warnings;
1921 e2c54635SPaolo Bonzini	}
1922 e2c54635SPaolo Bonzini
1923 *eb4c9775SEduardo Habkost	if ($identifier =~ m/^struct\b/) {
1924 e2c54635SPaolo Bonzini	    $decl_type = 'struct';
1925 e2c54635SPaolo Bonzini	} elsif ($identifier =~ m/^union\b/) {
1926 e2c54635SPaolo Bonzini	    $decl_type = 'union';
1927 e2c54635SPaolo Bonzini	} elsif ($identifier =~ m/^enum\b/) {
1928 e2c54635SPaolo Bonzini	    $decl_type = 'enum';
1929 e2c54635SPaolo Bonzini	} elsif ($identifier =~ m/^typedef\b/) {
1930 e2c54635SPaolo Bonzini	    $decl_type = 'typedef';
1931 e2c54635SPaolo Bonzini	} else {
1932 e2c54635SPaolo Bonzini	    $decl_type = 'function';
1933 e2c54635SPaolo Bonzini	}
1934 e2c54635SPaolo Bonzini
1935 e2c54635SPaolo Bonzini	if ($verbose) {
1936 e2c54635SPaolo Bonzini	    print STDERR "${file}:$.: info: Scanning doc for $identifier\n";
1937 e2c54635SPaolo Bonzini	}
1938 e2c54635SPaolo Bonzini    } else {
1939 e2c54635SPaolo Bonzini	print STDERR "${file}:$.: warning: Cannot understand $_ on line $.",
1940 e2c54635SPaolo Bonzini	    " - I thought it was a doc line\n";
1941 e2c54635SPaolo Bonzini	++$warnings;
1942 e2c54635SPaolo Bonzini	$state = STATE_NORMAL;
1943 e2c54635SPaolo Bonzini    }
1944 e2c54635SPaolo Bonzini}
1945 e2c54635SPaolo Bonzini
1946 e2c54635SPaolo Bonzini
1947 e2c54635SPaolo Bonzini#
1948 e2c54635SPaolo Bonzini# STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment.
1949 e2c54635SPaolo Bonzini#
1950 e2c54635SPaolo Bonzinisub process_body($$) {
1951 e2c54635SPaolo Bonzini    my $file = shift;
1952 e2c54635SPaolo Bonzini
1953 e2c54635SPaolo Bonzini    if (/$doc_sect/i) { # case insensitive for supported section names
1954 e2c54635SPaolo Bonzini	$newsection = $1;
1955 e2c54635SPaolo Bonzini	$newcontents = $2;
1956 e2c54635SPaolo Bonzini
1957 e2c54635SPaolo Bonzini	# map the supported section names to the canonical names
1958 e2c54635SPaolo Bonzini	if ($newsection =~ m/^description$/i) {
1959 e2c54635SPaolo Bonzini	    $newsection = $section_default;
1960 e2c54635SPaolo Bonzini	} elsif ($newsection =~ m/^context$/i) {
1961 e2c54635SPaolo Bonzini	    $newsection = $section_context;
1962 e2c54635SPaolo Bonzini	} elsif ($newsection =~ m/^returns?$/i) {
1963 e2c54635SPaolo Bonzini	    $newsection = $section_return;
1964 e2c54635SPaolo Bonzini	} elsif ($newsection =~ m/^\@return$/) {
1965 e2c54635SPaolo Bonzini	    # special: @return is a section, not a param description
1966 e2c54635SPaolo Bonzini	    $newsection = $section_return;
1967 e2c54635SPaolo Bonzini	}
1968 e2c54635SPaolo Bonzini
1969 e2c54635SPaolo Bonzini	if (($contents ne "") && ($contents ne "\n")) {
1970 e2c54635SPaolo Bonzini	    if (!$in_doc_sect && $verbose) {
1971 e2c54635SPaolo Bonzini		print STDERR "${file}:$.: warning: contents before sections\n";
1972 e2c54635SPaolo Bonzini		++$warnings;
1973 e2c54635SPaolo Bonzini	    }
1974 e2c54635SPaolo Bonzini	    dump_section($file, $section, $contents);
1975 e2c54635SPaolo Bonzini	    $section = $section_default;
1976 e2c54635SPaolo Bonzini	}
1977 e2c54635SPaolo Bonzini
1978 e2c54635SPaolo Bonzini	$in_doc_sect = 1;
1979 e2c54635SPaolo Bonzini	$state = STATE_BODY;
1980 e2c54635SPaolo Bonzini	$contents = $newcontents;
1981 e2c54635SPaolo Bonzini	$new_start_line = $.;
1982 e2c54635SPaolo Bonzini	while (substr($contents, 0, 1) eq " ") {
1983 e2c54635SPaolo Bonzini	    $contents = substr($contents, 1);
1984 e2c54635SPaolo Bonzini	}
1985 e2c54635SPaolo Bonzini	if ($contents ne "") {
1986 e2c54635SPaolo Bonzini	    $contents .= "\n";
1987 e2c54635SPaolo Bonzini	}
1988 e2c54635SPaolo Bonzini	$section = $newsection;
1989 e2c54635SPaolo Bonzini	$leading_space = undef;
1990 e2c54635SPaolo Bonzini    } elsif (/$doc_end/) {
1991 e2c54635SPaolo Bonzini	if (($contents ne "") && ($contents ne "\n")) {
1992 e2c54635SPaolo Bonzini	    dump_section($file, $section, $contents);
1993 e2c54635SPaolo Bonzini	    $section = $section_default;
1994 e2c54635SPaolo Bonzini	    $contents = "";
1995 e2c54635SPaolo Bonzini	}
1996 e2c54635SPaolo Bonzini	# look for doc_com + <text> + doc_end:
1997 e2c54635SPaolo Bonzini	if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
1998 e2c54635SPaolo Bonzini	    print STDERR "${file}:$.: warning: suspicious ending line: $_";
1999 e2c54635SPaolo Bonzini	    ++$warnings;
2000 e2c54635SPaolo Bonzini	}
2001 e2c54635SPaolo Bonzini
2002 e2c54635SPaolo Bonzini	$prototype = "";
2003 e2c54635SPaolo Bonzini	$state = STATE_PROTO;
2004 e2c54635SPaolo Bonzini	$brcount = 0;
2005 e2c54635SPaolo Bonzini    } elsif (/$doc_content/) {
2006 e2c54635SPaolo Bonzini	# miguel-style comment kludge, look for blank lines after
2007 e2c54635SPaolo Bonzini	# @parameter line to signify start of description
2008 e2c54635SPaolo Bonzini	if ($1 eq "") {
2009 e2c54635SPaolo Bonzini	    if ($section =~ m/^@/ || $section eq $section_context) {
2010 e2c54635SPaolo Bonzini		dump_section($file, $section, $contents);
2011 e2c54635SPaolo Bonzini		$section = $section_default;
2012 e2c54635SPaolo Bonzini		$contents = "";
2013 e2c54635SPaolo Bonzini		$new_start_line = $.;
2014 e2c54635SPaolo Bonzini	    } else {
2015 e2c54635SPaolo Bonzini		$contents .= "\n";
2016 e2c54635SPaolo Bonzini	    }
2017 e2c54635SPaolo Bonzini	    $state = STATE_BODY;
2018 e2c54635SPaolo Bonzini	} elsif ($state == STATE_BODY_MAYBE) {
2019 e2c54635SPaolo Bonzini	    # Continued declaration purpose
2020 e2c54635SPaolo Bonzini	    chomp($declaration_purpose);
2021 e2c54635SPaolo Bonzini	    $declaration_purpose .= " " . $1;
2022 e2c54635SPaolo Bonzini	    $declaration_purpose =~ s/\s+/ /g;
2023 e2c54635SPaolo Bonzini	} else {
2024 e2c54635SPaolo Bonzini	    my $cont = $1;
2025 e2c54635SPaolo Bonzini	    if ($section =~ m/^@/ || $section eq $section_context) {
2026 e2c54635SPaolo Bonzini		if (!defined $leading_space) {
2027 e2c54635SPaolo Bonzini		    if ($cont =~ m/^(\s+)/) {
2028 e2c54635SPaolo Bonzini			$leading_space = $1;
2029 e2c54635SPaolo Bonzini		    } else {
2030 e2c54635SPaolo Bonzini			$leading_space = "";
2031 e2c54635SPaolo Bonzini		    }
2032 e2c54635SPaolo Bonzini		}
2033 e2c54635SPaolo Bonzini		$cont =~ s/^$leading_space//;
2034 e2c54635SPaolo Bonzini	    }
2035 e2c54635SPaolo Bonzini	    $contents .= $cont . "\n";
2036 e2c54635SPaolo Bonzini	}
2037 e2c54635SPaolo Bonzini    } else {
2038 e2c54635SPaolo Bonzini	# i dont know - bad line?  ignore.
2039 e2c54635SPaolo Bonzini	print STDERR "${file}:$.: warning: bad line: $_";
2040 e2c54635SPaolo Bonzini	++$warnings;
2041 e2c54635SPaolo Bonzini    }
2042 e2c54635SPaolo Bonzini}
2043 e2c54635SPaolo Bonzini
2044 e2c54635SPaolo Bonzini
2045 e2c54635SPaolo Bonzini#
2046 e2c54635SPaolo Bonzini# STATE_PROTO: reading a function/whatever prototype.
2047 e2c54635SPaolo Bonzini#
2048 e2c54635SPaolo Bonzinisub process_proto($$) {
2049 e2c54635SPaolo Bonzini    my $file = shift;
2050 e2c54635SPaolo Bonzini
2051 e2c54635SPaolo Bonzini    if (/$doc_inline_oneline/) {
2052 e2c54635SPaolo Bonzini	$section = $1;
2053 e2c54635SPaolo Bonzini	$contents = $2;
2054 e2c54635SPaolo Bonzini	if ($contents ne "") {
2055 e2c54635SPaolo Bonzini	    $contents .= "\n";
2056 e2c54635SPaolo Bonzini	    dump_section($file, $section, $contents);
2057 e2c54635SPaolo Bonzini	    $section = $section_default;
2058 e2c54635SPaolo Bonzini	    $contents = "";
2059 e2c54635SPaolo Bonzini	}
2060 e2c54635SPaolo Bonzini    } elsif (/$doc_inline_start/) {
2061 e2c54635SPaolo Bonzini	$state = STATE_INLINE;
2062 e2c54635SPaolo Bonzini	$inline_doc_state = STATE_INLINE_NAME;
2063 e2c54635SPaolo Bonzini    } elsif ($decl_type eq 'function') {
2064 e2c54635SPaolo Bonzini	process_proto_function($_, $file);
2065 e2c54635SPaolo Bonzini    } else {
2066 e2c54635SPaolo Bonzini	process_proto_type($_, $file);
2067 e2c54635SPaolo Bonzini    }
2068 e2c54635SPaolo Bonzini}
2069 e2c54635SPaolo Bonzini
2070 e2c54635SPaolo Bonzini#
2071 e2c54635SPaolo Bonzini# STATE_DOCBLOCK: within a DOC: block.
2072 e2c54635SPaolo Bonzini#
2073 e2c54635SPaolo Bonzinisub process_docblock($$) {
2074 e2c54635SPaolo Bonzini    my $file = shift;
2075 e2c54635SPaolo Bonzini
2076 e2c54635SPaolo Bonzini    if (/$doc_end/) {
2077 e2c54635SPaolo Bonzini	dump_doc_section($file, $section, $contents);
2078 e2c54635SPaolo Bonzini	$section = $section_default;
2079 e2c54635SPaolo Bonzini	$contents = "";
2080 e2c54635SPaolo Bonzini	$function = "";
2081 e2c54635SPaolo Bonzini	%parameterdescs = ();
2082 e2c54635SPaolo Bonzini	%parametertypes = ();
2083 e2c54635SPaolo Bonzini	@parameterlist = ();
2084 e2c54635SPaolo Bonzini	%sections = ();
2085 e2c54635SPaolo Bonzini	@sectionlist = ();
2086 e2c54635SPaolo Bonzini	$prototype = "";
2087 e2c54635SPaolo Bonzini	$state = STATE_NORMAL;
2088 e2c54635SPaolo Bonzini    } elsif (/$doc_content/) {
2089 e2c54635SPaolo Bonzini	if ( $1 eq "" )	{
2090 e2c54635SPaolo Bonzini	    $contents .= $blankline;
2091 e2c54635SPaolo Bonzini	} else {
2092 e2c54635SPaolo Bonzini	    $contents .= $1 . "\n";
2093 e2c54635SPaolo Bonzini	}
2094 e2c54635SPaolo Bonzini    }
2095 e2c54635SPaolo Bonzini}
2096 e2c54635SPaolo Bonzini
2097 e2c54635SPaolo Bonzini#
2098 e2c54635SPaolo Bonzini# STATE_INLINE: docbook comments within a prototype.
2099 e2c54635SPaolo Bonzini#
2100 e2c54635SPaolo Bonzinisub process_inline($$) {
2101 e2c54635SPaolo Bonzini    my $file = shift;
2102 e2c54635SPaolo Bonzini
2103 e2c54635SPaolo Bonzini    # First line (state 1) needs to be a @parameter
2104 e2c54635SPaolo Bonzini    if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) {
2105 e2c54635SPaolo Bonzini	$section = $1;
2106 e2c54635SPaolo Bonzini	$contents = $2;
2107 e2c54635SPaolo Bonzini	$new_start_line = $.;
2108 e2c54635SPaolo Bonzini	if ($contents ne "") {
2109 e2c54635SPaolo Bonzini	    while (substr($contents, 0, 1) eq " ") {
2110 e2c54635SPaolo Bonzini		$contents = substr($contents, 1);
2111 e2c54635SPaolo Bonzini	    }
2112 e2c54635SPaolo Bonzini	    $contents .= "\n";
2113 e2c54635SPaolo Bonzini	}
2114 e2c54635SPaolo Bonzini	$inline_doc_state = STATE_INLINE_TEXT;
2115 e2c54635SPaolo Bonzini	# Documentation block end */
2116 e2c54635SPaolo Bonzini    } elsif (/$doc_inline_end/) {
2117 e2c54635SPaolo Bonzini	if (($contents ne "") && ($contents ne "\n")) {
2118 e2c54635SPaolo Bonzini	    dump_section($file, $section, $contents);
2119 e2c54635SPaolo Bonzini	    $section = $section_default;
2120 e2c54635SPaolo Bonzini	    $contents = "";
2121 e2c54635SPaolo Bonzini	}
2122 e2c54635SPaolo Bonzini	$state = STATE_PROTO;
2123 e2c54635SPaolo Bonzini	$inline_doc_state = STATE_INLINE_NA;
2124 e2c54635SPaolo Bonzini	# Regular text
2125 e2c54635SPaolo Bonzini    } elsif (/$doc_content/) {
2126 e2c54635SPaolo Bonzini	if ($inline_doc_state == STATE_INLINE_TEXT) {
2127 e2c54635SPaolo Bonzini	    $contents .= $1 . "\n";
2128 e2c54635SPaolo Bonzini	    # nuke leading blank lines
2129 e2c54635SPaolo Bonzini	    if ($contents =~ /^\s*$/) {
2130 e2c54635SPaolo Bonzini		$contents = "";
2131 e2c54635SPaolo Bonzini	    }
2132 e2c54635SPaolo Bonzini	} elsif ($inline_doc_state == STATE_INLINE_NAME) {
2133 e2c54635SPaolo Bonzini	    $inline_doc_state = STATE_INLINE_ERROR;
2134 e2c54635SPaolo Bonzini	    print STDERR "${file}:$.: warning: ";
2135 e2c54635SPaolo Bonzini	    print STDERR "Incorrect use of kernel-doc format: $_";
2136 e2c54635SPaolo Bonzini	    ++$warnings;
2137 e2c54635SPaolo Bonzini	}
2138 e2c54635SPaolo Bonzini    }
2139 e2c54635SPaolo Bonzini}
2140 e2c54635SPaolo Bonzini
2141 e2c54635SPaolo Bonzini
2142 e2c54635SPaolo Bonzinisub process_file($) {
2143 e2c54635SPaolo Bonzini    my $file;
2144 e2c54635SPaolo Bonzini    my $initial_section_counter = $section_counter;
2145 e2c54635SPaolo Bonzini    my ($orig_file) = @_;
2146 e2c54635SPaolo Bonzini
2147 e2c54635SPaolo Bonzini    $file = map_filename($orig_file);
2148 e2c54635SPaolo Bonzini
2149 e2c54635SPaolo Bonzini    if (!open(IN,"<$file")) {
2150 e2c54635SPaolo Bonzini	print STDERR "Error: Cannot open file $file\n";
2151 e2c54635SPaolo Bonzini	++$errors;
2152 e2c54635SPaolo Bonzini	return;
2153 e2c54635SPaolo Bonzini    }
2154 e2c54635SPaolo Bonzini
2155 e2c54635SPaolo Bonzini    $. = 1;
2156 e2c54635SPaolo Bonzini
2157 e2c54635SPaolo Bonzini    $section_counter = 0;
2158 e2c54635SPaolo Bonzini    while (<IN>) {
2159 e2c54635SPaolo Bonzini	while (s/\\\s*$//) {
2160 e2c54635SPaolo Bonzini	    $_ .= <IN>;
2161 e2c54635SPaolo Bonzini	}
2162 e2c54635SPaolo Bonzini	# Replace tabs by spaces
2163 e2c54635SPaolo Bonzini        while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {};
2164 e2c54635SPaolo Bonzini	# Hand this line to the appropriate state handler
2165 e2c54635SPaolo Bonzini	if ($state == STATE_NORMAL) {
2166 e2c54635SPaolo Bonzini	    process_normal();
2167 e2c54635SPaolo Bonzini	} elsif ($state == STATE_NAME) {
2168 e2c54635SPaolo Bonzini	    process_name($file, $_);
2169 e2c54635SPaolo Bonzini	} elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE) {
2170 e2c54635SPaolo Bonzini	    process_body($file, $_);
2171 e2c54635SPaolo Bonzini	} elsif ($state == STATE_INLINE) { # scanning for inline parameters
2172 e2c54635SPaolo Bonzini	    process_inline($file, $_);
2173 e2c54635SPaolo Bonzini	} elsif ($state == STATE_PROTO) {
2174 e2c54635SPaolo Bonzini	    process_proto($file, $_);
2175 e2c54635SPaolo Bonzini	} elsif ($state == STATE_DOCBLOCK) {
2176 e2c54635SPaolo Bonzini	    process_docblock($file, $_);
2177 e2c54635SPaolo Bonzini	}
2178 e2c54635SPaolo Bonzini    }
2179 e2c54635SPaolo Bonzini
2180 e2c54635SPaolo Bonzini    # Make sure we got something interesting.
2181 e2c54635SPaolo Bonzini    if ($initial_section_counter == $section_counter && $
2182 e2c54635SPaolo Bonzini	output_mode ne "none") {
2183 e2c54635SPaolo Bonzini	if ($output_selection == OUTPUT_INCLUDE) {
2184 e2c54635SPaolo Bonzini	    print STDERR "${file}:1: warning: '$_' not found\n"
2185 e2c54635SPaolo Bonzini		for keys %function_table;
2186 e2c54635SPaolo Bonzini	}
2187 e2c54635SPaolo Bonzini	else {
2188 e2c54635SPaolo Bonzini	    print STDERR "${file}:1: warning: no structured comments found\n";
2189 e2c54635SPaolo Bonzini	}
2190 e2c54635SPaolo Bonzini    }
2191 e2c54635SPaolo Bonzini}
2192 e2c54635SPaolo Bonzini
2193 e2c54635SPaolo Bonzini
2194 e2c54635SPaolo Bonzini$kernelversion = get_kernel_version();
2195 e2c54635SPaolo Bonzini
2196 e2c54635SPaolo Bonzini# generate a sequence of code that will splice in highlighting information
2197 e2c54635SPaolo Bonzini# using the s// operator.
2198 e2c54635SPaolo Bonzinifor (my $k = 0; $k < @highlights; $k++) {
2199 e2c54635SPaolo Bonzini    my $pattern = $highlights[$k][0];
2200 e2c54635SPaolo Bonzini    my $result = $highlights[$k][1];
2201 e2c54635SPaolo Bonzini#   print STDERR "scanning pattern:$pattern, highlight:($result)\n";
2202 e2c54635SPaolo Bonzini    $dohighlight .=  "\$contents =~ s:$pattern:$result:gs;\n";
2203 e2c54635SPaolo Bonzini}
2204 e2c54635SPaolo Bonzini
2205 e2c54635SPaolo Bonzini# Read the file that maps relative names to absolute names for
2206 e2c54635SPaolo Bonzini# separate source and object directories and for shadow trees.
2207 e2c54635SPaolo Bonziniif (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2208 e2c54635SPaolo Bonzini	my ($relname, $absname);
2209 e2c54635SPaolo Bonzini	while(<SOURCE_MAP>) {
2210 e2c54635SPaolo Bonzini		chop();
2211 e2c54635SPaolo Bonzini		($relname, $absname) = (split())[0..1];
2212 e2c54635SPaolo Bonzini		$relname =~ s:^/+::;
2213 e2c54635SPaolo Bonzini		$source_map{$relname} = $absname;
2214 e2c54635SPaolo Bonzini	}
2215 e2c54635SPaolo Bonzini	close(SOURCE_MAP);
2216 e2c54635SPaolo Bonzini}
2217 e2c54635SPaolo Bonzini
2218 e2c54635SPaolo Bonziniif ($output_selection == OUTPUT_EXPORTED ||
2219 e2c54635SPaolo Bonzini    $output_selection == OUTPUT_INTERNAL) {
2220 e2c54635SPaolo Bonzini
2221 e2c54635SPaolo Bonzini    push(@export_file_list, @ARGV);
2222 e2c54635SPaolo Bonzini
2223 e2c54635SPaolo Bonzini    foreach (@export_file_list) {
2224 e2c54635SPaolo Bonzini	chomp;
2225 e2c54635SPaolo Bonzini	process_export_file($_);
2226 e2c54635SPaolo Bonzini    }
2227 e2c54635SPaolo Bonzini}
2228 e2c54635SPaolo Bonzini
2229 e2c54635SPaolo Bonziniforeach (@ARGV) {
2230 e2c54635SPaolo Bonzini    chomp;
2231 e2c54635SPaolo Bonzini    process_file($_);
2232 e2c54635SPaolo Bonzini}
2233 e2c54635SPaolo Bonziniif ($verbose && $errors) {
2234 e2c54635SPaolo Bonzini  print STDERR "$errors errors\n";
2235 e2c54635SPaolo Bonzini}
2236 e2c54635SPaolo Bonziniif ($verbose && $warnings) {
2237 e2c54635SPaolo Bonzini  print STDERR "$warnings warnings\n";
2238 e2c54635SPaolo Bonzini}
2239 e2c54635SPaolo Bonzini
2240 e2c54635SPaolo Bonziniexit($output_mode eq "none" ? 0 : $errors);
2241