blob: 0f11870116dc7bbce74d813928b19c36f847796c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#!/usr/bin/perl -w
2
3use strict;
4
5## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ##
6## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ##
7## Copyright (C) 2001 Simon Huggins ##
Randy Dunlap94dc7ad2008-04-28 02:16:34 -07008## Copyright (C) 2005-2008 Randy Dunlap ##
Linus Torvalds1da177e2005-04-16 15:20:36 -07009## ##
10## #define enhancements by Armin Kuster <akuster@mvista.com> ##
11## Copyright (c) 2000 MontaVista Software, Inc. ##
12## ##
13## This software falls under the GNU General Public License. ##
14## Please read the COPYING file for more information ##
15
16# w.o. 03-11-2000: added the '-filelist' option.
17
18# 18/01/2001 - Cleanups
19# Functions prototyped as foo(void) same as foo()
20# Stop eval'ing where we don't need to.
21# -- huggie@earth.li
22
23# 27/06/2001 - Allowed whitespace after initial "/**" and
24# allowed comments before function declarations.
25# -- Christian Kreibich <ck@whoop.org>
26
27# Still to do:
28# - add perldoc documentation
29# - Look more closely at some of the scarier bits :)
30
31# 26/05/2001 - Support for separate source and object trees.
32# Return error code.
33# Keith Owens <kaos@ocs.com.au>
34
35# 23/09/2001 - Added support for typedefs, structs, enums and unions
36# Support for Context section; can be terminated using empty line
37# Small fixes (like spaces vs. \s in regex)
38# -- Tim Jansen <tim@tjansen.de>
39
40
41#
42# This will read a 'c' file and scan for embedded comments in the
43# style of gnome comments (+minor extensions - see below).
44#
45
46# Note: This only supports 'c'.
47
48# usage:
Johannes Berg4b445952007-10-24 15:08:48 -070049# kernel-doc [ -docbook | -html | -text | -man ] [ -no-doc-sections ]
Linus Torvalds1da177e2005-04-16 15:20:36 -070050# [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile
51# or
52# [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile
53#
54# Set output format using one of -docbook -html -text or -man. Default is man.
55#
Johannes Berg4b445952007-10-24 15:08:48 -070056# -no-doc-sections
57# Do not output DOC: sections
58#
Linus Torvalds1da177e2005-04-16 15:20:36 -070059# -function funcname
Johannes Bergb112e0f2007-10-24 15:08:48 -070060# If set, then only generate documentation for the given function(s) or
61# DOC: section titles. All other functions and DOC: sections are ignored.
Linus Torvalds1da177e2005-04-16 15:20:36 -070062#
63# -nofunction funcname
Johannes Bergb112e0f2007-10-24 15:08:48 -070064# If set, then only generate documentation for the other function(s)/DOC:
65# sections. Cannot be used together with -function (yes, that's a bug --
66# perl hackers can fix it 8))
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#
68# c files - list of 'c' files to process
69#
70# All output goes to stdout, with errors to stderr.
71
72#
73# format of comments.
74# In the following table, (...)? signifies optional structure.
75# (...)* signifies 0 or more structure elements
76# /**
77# * function_name(:)? (- short description)?
78# (* @parameterx: (description of parameter x)?)*
79# (* a blank line)?
80# * (Description:)? (Description of function)?
81# * (section header: (section description)? )*
82# (*)?*/
83#
84# So .. the trivial example would be:
85#
86# /**
87# * my_function
88# **/
89#
Randy Dunlap891dcd22007-02-10 01:45:53 -080090# If the Description: header tag is omitted, then there must be a blank line
Linus Torvalds1da177e2005-04-16 15:20:36 -070091# after the last parameter specification.
92# e.g.
93# /**
94# * my_function - does my stuff
95# * @my_arg: its mine damnit
96# *
Randy Dunlap3c3b8092006-02-01 03:06:58 -080097# * Does my stuff explained.
Linus Torvalds1da177e2005-04-16 15:20:36 -070098# */
99#
100# or, could also use:
101# /**
102# * my_function - does my stuff
103# * @my_arg: its mine damnit
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800104# * Description: Does my stuff explained.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105# */
106# etc.
107#
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800108# Beside functions you can also write documentation for structs, unions,
109# enums and typedefs. Instead of the function name you must write the name
110# of the declaration; the struct/union/enum/typedef must always precede
111# the name. Nesting of declarations is not supported.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112# Use the argument mechanism to document members or constants.
113# e.g.
114# /**
115# * struct my_struct - short description
116# * @a: first member
117# * @b: second member
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800118# *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119# * Longer description
120# */
121# struct my_struct {
122# int a;
123# int b;
Martin Waitzaeec46b2005-11-13 16:08:13 -0800124# /* private: */
125# int c;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126# };
127#
128# All descriptions can be multiline, except the short function description.
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800129#
130# You can also add additional sections. When documenting kernel functions you
131# should document the "Context:" of the function, e.g. whether the functions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132# can be called form interrupts. Unlike other sections you can end it with an
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800133# empty line.
134# Example-sections should contain the string EXAMPLE so that they are marked
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135# appropriately in DocBook.
136#
137# Example:
138# /**
139# * user_function - function that can only be called in user context
140# * @a: some argument
141# * Context: !in_interrupt()
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800142# *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143# * Some description
144# * Example:
145# * user_function(22);
146# */
147# ...
148#
149#
150# All descriptive text is further processed, scanning for the following special
151# patterns, which are highlighted appropriately.
152#
153# 'funcname()' - function
154# '$ENVVAR' - environmental variable
155# '&struct_name' - name of a structure (up to two words including 'struct')
156# '@parameter' - name of a parameter
157# '%CONST' - name of a constant.
158
159my $errors = 0;
160my $warnings = 0;
Randy Dunlap5f8c7c92007-07-19 01:48:24 -0700161my $anon_struct_union = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
163# match expressions used to find embedded type information
164my $type_constant = '\%([-_\w]+)';
165my $type_func = '(\w+)\(\)';
166my $type_param = '\@(\w+)';
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700167my $type_struct = '\&((struct\s*)*[_\w]+)';
Randy Dunlap6b5b55f2007-10-16 23:31:20 -0700168my $type_struct_xml = '\\&amp;((struct\s*)*[_\w]+)';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169my $type_env = '(\$\w+)';
170
171# Output conversion substitutions.
172# One for each output format
173
174# these work fairly well
175my %highlights_html = ( $type_constant, "<i>\$1</i>",
176 $type_func, "<b>\$1</b>",
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700177 $type_struct_xml, "<i>\$1</i>",
178 $type_env, "<b><i>\$1</i></b>",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 $type_param, "<tt><b>\$1</b></tt>" );
Randy Dunlap6b5b55f2007-10-16 23:31:20 -0700180my $local_lt = "\\\\\\\\lt:";
181my $local_gt = "\\\\\\\\gt:";
182my $blankline_html = $local_lt . "p" . $local_gt; # was "<p>"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
184# XML, docbook format
185my %highlights_xml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>",
186 $type_constant, "<constant>\$1</constant>",
187 $type_func, "<function>\$1</function>",
Johannes Berg5c98fc02007-10-24 15:08:48 -0700188 $type_struct_xml, "<structname>\$1</structname>",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 $type_env, "<envar>\$1</envar>",
190 $type_param, "<parameter>\$1</parameter>" );
Johannes Berg5c98fc02007-10-24 15:08:48 -0700191my $blankline_xml = $local_lt . "/para" . $local_gt . $local_lt . "para" . $local_gt . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
193# gnome, docbook format
194my %highlights_gnome = ( $type_constant, "<replaceable class=\"option\">\$1</replaceable>",
195 $type_func, "<function>\$1</function>",
196 $type_struct, "<structname>\$1</structname>",
197 $type_env, "<envar>\$1</envar>",
198 $type_param, "<parameter>\$1</parameter>" );
199my $blankline_gnome = "</para><para>\n";
200
201# these are pretty rough
202my %highlights_man = ( $type_constant, "\$1",
203 $type_func, "\\\\fB\$1\\\\fP",
204 $type_struct, "\\\\fI\$1\\\\fP",
205 $type_param, "\\\\fI\$1\\\\fP" );
206my $blankline_man = "";
207
208# text-mode
209my %highlights_text = ( $type_constant, "\$1",
210 $type_func, "\$1",
211 $type_struct, "\$1",
212 $type_param, "\$1" );
213my $blankline_text = "";
214
215
216sub usage {
Johannes Berg4b445952007-10-24 15:08:48 -0700217 print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man ] [ -no-doc-sections ]\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 print " [ -function funcname [ -function funcname ...] ]\n";
219 print " [ -nofunction funcname [ -nofunction funcname ...] ]\n";
220 print " c source file(s) > outputfile\n";
Randy Dunlap77cc23b2008-02-07 00:13:42 -0800221 print " -v : verbose output, more warnings & other info listed\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 exit 1;
223}
224
225# read arguments
226if ($#ARGV==-1) {
227 usage();
228}
229
230my $verbose = 0;
231my $output_mode = "man";
Johannes Berg4b445952007-10-24 15:08:48 -0700232my $no_doc_sections = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233my %highlights = %highlights_man;
234my $blankline = $blankline_man;
235my $modulename = "Kernel API";
236my $function_only = 0;
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800237my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
238 'July', 'August', 'September', 'October',
239 'November', 'December')[(localtime)[4]] .
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 " " . ((localtime)[5]+1900);
241
242# Essentially these are globals
243# They probably want to be tidied up made more localised or summat.
244# CAVEAT EMPTOR! Some of the others I localised may not want to be which
245# could cause "use of undefined value" or other bugs.
246my ($function, %function_table,%parametertypes,$declaration_purpose);
247my ($type,$declaration_name,$return_type);
248my ($newsection,$newcontents,$prototype,$filelist, $brcount, %source_map);
249
Randy Dunlapbd0e88e2008-03-13 12:32:43 -0700250if (defined($ENV{'KBUILD_VERBOSE'})) {
251 $verbose = "$ENV{'KBUILD_VERBOSE'}";
252}
253
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800254# Generated docbook code is inserted in a template at a point where
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255# docbook v3.1 requires a non-zero sequence of RefEntry's; see:
256# http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
257# We keep track of number of generated entries and generate a dummy
258# if needs be to ensure the expanded template can be postprocessed
259# into html.
260my $section_counter = 0;
261
262my $lineprefix="";
263
264# states
265# 0 - normal code
266# 1 - looking for function name
267# 2 - scanning field start.
268# 3 - scanning prototype.
269# 4 - documentation block
270my $state;
Randy Dunlap850622d2006-06-25 05:48:55 -0700271my $in_doc_sect;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
273#declaration types: can be
274# 'function', 'struct', 'union', 'enum', 'typedef'
275my $decl_type;
276
277my $doc_special = "\@\%\$\&";
278
279my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
280my $doc_end = '\*/';
281my $doc_com = '\s*\*\s*';
282my $doc_decl = $doc_com.'(\w+)';
Randy Dunlap891dcd22007-02-10 01:45:53 -0800283my $doc_sect = $doc_com.'(['.$doc_special.']?[\w\s]+):(.*)';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284my $doc_content = $doc_com.'(.*)';
285my $doc_block = $doc_com.'DOC:\s*(.*)?';
286
287my %constants;
288my %parameterdescs;
289my @parameterlist;
290my %sections;
291my @sectionlist;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -0800292my $sectcheck;
293my $struct_actual;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294
295my $contents = "";
296my $section_default = "Description"; # default section
297my $section_intro = "Introduction";
298my $section = $section_default;
299my $section_context = "Context";
300
301my $undescribed = "-- undescribed --";
302
303reset_state();
304
305while ($ARGV[0] =~ m/^-(.*)/) {
306 my $cmd = shift @ARGV;
307 if ($cmd eq "-html") {
308 $output_mode = "html";
309 %highlights = %highlights_html;
310 $blankline = $blankline_html;
311 } elsif ($cmd eq "-man") {
312 $output_mode = "man";
313 %highlights = %highlights_man;
314 $blankline = $blankline_man;
315 } elsif ($cmd eq "-text") {
316 $output_mode = "text";
317 %highlights = %highlights_text;
318 $blankline = $blankline_text;
319 } elsif ($cmd eq "-docbook") {
320 $output_mode = "xml";
321 %highlights = %highlights_xml;
322 $blankline = $blankline_xml;
323 } elsif ($cmd eq "-gnome") {
324 $output_mode = "gnome";
325 %highlights = %highlights_gnome;
326 $blankline = $blankline_gnome;
327 } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document
328 $modulename = shift @ARGV;
329 } elsif ($cmd eq "-function") { # to only output specific functions
330 $function_only = 1;
331 $function = shift @ARGV;
332 $function_table{$function} = 1;
333 } elsif ($cmd eq "-nofunction") { # to only output specific functions
334 $function_only = 2;
335 $function = shift @ARGV;
336 $function_table{$function} = 1;
337 } elsif ($cmd eq "-v") {
338 $verbose = 1;
339 } elsif (($cmd eq "-h") || ($cmd eq "--help")) {
340 usage();
341 } elsif ($cmd eq '-filelist') {
342 $filelist = shift @ARGV;
Johannes Berg4b445952007-10-24 15:08:48 -0700343 } elsif ($cmd eq '-no-doc-sections') {
344 $no_doc_sections = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 }
346}
347
Borislav Petkov53f049f2007-05-08 00:30:54 -0700348# get kernel version from env
349sub get_kernel_version() {
Johannes Berg1b9bc222007-10-24 15:08:48 -0700350 my $version = 'unknown kernel version';
Borislav Petkov53f049f2007-05-08 00:30:54 -0700351
352 if (defined($ENV{'KERNELVERSION'})) {
353 $version = $ENV{'KERNELVERSION'};
354 }
355 return $version;
356}
Borislav Petkov03662992007-05-09 02:33:43 -0700357my $kernelversion = get_kernel_version();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
359# generate a sequence of code that will splice in highlighting information
360# using the s// operator.
361my $dohighlight = "";
362foreach my $pattern (keys %highlights) {
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700363# print STDERR "scanning pattern:$pattern, highlight:($highlights{$pattern})\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 $dohighlight .= "\$contents =~ s:$pattern:$highlights{$pattern}:gs;\n";
365}
366
367##
368# dumps section contents to arrays/hashes intended for that purpose.
369#
370sub dump_section {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -0700371 my $file = shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 my $name = shift;
373 my $contents = join "\n", @_;
374
375 if ($name =~ m/$type_constant/) {
376 $name = $1;
377# print STDERR "constant section '$1' = '$contents'\n";
378 $constants{$name} = $contents;
379 } elsif ($name =~ m/$type_param/) {
380# print STDERR "parameter def '$1' = '$contents'\n";
381 $name = $1;
382 $parameterdescs{$name} = $contents;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -0800383 $sectcheck = $sectcheck . $name . " ";
Randy Dunlapced69092008-12-01 13:14:03 -0800384 } elsif ($name eq "@\.\.\.") {
385# print STDERR "parameter def '...' = '$contents'\n";
386 $name = "...";
387 $parameterdescs{$name} = $contents;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -0800388 $sectcheck = $sectcheck . $name . " ";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 } else {
390# print STDERR "other section '$name' = '$contents'\n";
Randy Dunlap94dc7ad2008-04-28 02:16:34 -0700391 if (defined($sections{$name}) && ($sections{$name} ne "")) {
392 print STDERR "Error(${file}:$.): duplicate section name '$name'\n";
393 ++$errors;
394 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 $sections{$name} = $contents;
396 push @sectionlist, $name;
397 }
398}
399
400##
Johannes Bergb112e0f2007-10-24 15:08:48 -0700401# dump DOC: section after checking that it should go out
402#
403sub dump_doc_section {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -0700404 my $file = shift;
Johannes Bergb112e0f2007-10-24 15:08:48 -0700405 my $name = shift;
406 my $contents = join "\n", @_;
407
Johannes Berg4b445952007-10-24 15:08:48 -0700408 if ($no_doc_sections) {
409 return;
410 }
411
Johannes Bergb112e0f2007-10-24 15:08:48 -0700412 if (($function_only == 0) ||
413 ( $function_only == 1 && defined($function_table{$name})) ||
414 ( $function_only == 2 && !defined($function_table{$name})))
415 {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -0700416 dump_section($file, $name, $contents);
Johannes Bergb112e0f2007-10-24 15:08:48 -0700417 output_blockhead({'sectionlist' => \@sectionlist,
418 'sections' => \%sections,
419 'module' => $modulename,
420 'content-only' => ($function_only != 0), });
421 }
422}
423
424##
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425# output function
426#
427# parameterdescs, a hash.
428# function => "function name"
429# parameterlist => @list of parameters
430# parameterdescs => %parameter descriptions
431# sectionlist => @list of sections
Randy Dunlapa21217d2007-02-10 01:46:04 -0800432# sections => %section descriptions
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800433#
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434
435sub output_highlight {
436 my $contents = join "\n",@_;
437 my $line;
438
439# DEBUG
440# if (!defined $contents) {
441# use Carp;
442# confess "output_highlight got called with no args?\n";
443# }
444
Johannes Berg5c98fc02007-10-24 15:08:48 -0700445 if ($output_mode eq "html" || $output_mode eq "xml") {
Randy Dunlap6b5b55f2007-10-16 23:31:20 -0700446 $contents = local_unescape($contents);
447 # convert data read & converted thru xml_escape() into &xyz; format:
448 $contents =~ s/\\\\\\/&/g;
449 }
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700450# print STDERR "contents b4:$contents\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 eval $dohighlight;
452 die $@ if $@;
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700453# print STDERR "contents af:$contents\n";
454
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 foreach $line (split "\n", $contents) {
Randy Dunlap3c308792007-05-08 00:24:39 -0700456 if ($line eq ""){
Randy Dunlap6b5b55f2007-10-16 23:31:20 -0700457 print $lineprefix, local_unescape($blankline);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 } else {
Randy Dunlap3c308792007-05-08 00:24:39 -0700459 $line =~ s/\\\\\\/\&/g;
Randy Dunlapcdccb312007-07-19 01:48:25 -0700460 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
461 print "\\&$line";
462 } else {
463 print $lineprefix, $line;
464 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 }
466 print "\n";
467 }
468}
469
470#output sections in html
471sub output_section_html(%) {
472 my %args = %{$_[0]};
473 my $section;
474
475 foreach $section (@{$args{'sectionlist'}}) {
476 print "<h3>$section</h3>\n";
477 print "<blockquote>\n";
478 output_highlight($args{'sections'}{$section});
479 print "</blockquote>\n";
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800480 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481}
482
483# output enum in html
484sub output_enum_html(%) {
485 my %args = %{$_[0]};
486 my ($parameter);
487 my $count;
488 print "<h2>enum ".$args{'enum'}."</h2>\n";
489
490 print "<b>enum ".$args{'enum'}."</b> {<br>\n";
491 $count = 0;
492 foreach $parameter (@{$args{'parameterlist'}}) {
Randy Dunlap3c308792007-05-08 00:24:39 -0700493 print " <b>".$parameter."</b>";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 if ($count != $#{$args{'parameterlist'}}) {
495 $count++;
496 print ",\n";
497 }
498 print "<br>";
499 }
500 print "};<br>\n";
501
502 print "<h3>Constants</h3>\n";
503 print "<dl>\n";
504 foreach $parameter (@{$args{'parameterlist'}}) {
505 print "<dt><b>".$parameter."</b>\n";
506 print "<dd>";
507 output_highlight($args{'parameterdescs'}{$parameter});
508 }
509 print "</dl>\n";
510 output_section_html(@_);
511 print "<hr>\n";
512}
513
Randy Dunlapd28bee02006-02-01 03:06:57 -0800514# output typedef in html
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515sub output_typedef_html(%) {
516 my %args = %{$_[0]};
517 my ($parameter);
518 my $count;
519 print "<h2>typedef ".$args{'typedef'}."</h2>\n";
520
521 print "<b>typedef ".$args{'typedef'}."</b>\n";
522 output_section_html(@_);
523 print "<hr>\n";
524}
525
526# output struct in html
527sub output_struct_html(%) {
528 my %args = %{$_[0]};
529 my ($parameter);
530
Randy Dunlap262d9b02007-02-20 13:58:04 -0800531 print "<h2>".$args{'type'}." ".$args{'struct'}. " - " .$args{'purpose'}."</h2>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 print "<b>".$args{'type'}." ".$args{'struct'}."</b> {<br>\n";
533 foreach $parameter (@{$args{'parameterlist'}}) {
534 if ($parameter =~ /^#/) {
535 print "$parameter<br>\n";
536 next;
537 }
538 my $parameter_name = $parameter;
539 $parameter_name =~ s/\[.*//;
540
Randy Dunlap3c308792007-05-08 00:24:39 -0700541 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 $type = $args{'parametertypes'}{$parameter};
543 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
544 # pointer-to-function
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700545 print "&nbsp; &nbsp; <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700547 # bitfield
548 print "&nbsp; &nbsp; <i>$1</i> <b>$parameter</b>$2;<br>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 } else {
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700550 print "&nbsp; &nbsp; <i>$type</i> <b>$parameter</b>;<br>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 }
552 }
553 print "};<br>\n";
554
555 print "<h3>Members</h3>\n";
556 print "<dl>\n";
557 foreach $parameter (@{$args{'parameterlist'}}) {
558 ($parameter =~ /^#/) && next;
559
560 my $parameter_name = $parameter;
561 $parameter_name =~ s/\[.*//;
562
Randy Dunlap3c308792007-05-08 00:24:39 -0700563 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 print "<dt><b>".$parameter."</b>\n";
565 print "<dd>";
566 output_highlight($args{'parameterdescs'}{$parameter_name});
567 }
568 print "</dl>\n";
569 output_section_html(@_);
570 print "<hr>\n";
571}
572
573# output function in html
574sub output_function_html(%) {
575 my %args = %{$_[0]};
576 my ($parameter, $section);
577 my $count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578
Randy Dunlap262d9b02007-02-20 13:58:04 -0800579 print "<h2>" .$args{'function'}." - ".$args{'purpose'}."</h2>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 print "<i>".$args{'functiontype'}."</i>\n";
581 print "<b>".$args{'function'}."</b>\n";
582 print "(";
583 $count = 0;
584 foreach $parameter (@{$args{'parameterlist'}}) {
585 $type = $args{'parametertypes'}{$parameter};
586 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
587 # pointer-to-function
588 print "<i>$1</i><b>$parameter</b>) <i>($2)</i>";
589 } else {
590 print "<i>".$type."</i> <b>".$parameter."</b>";
591 }
592 if ($count != $#{$args{'parameterlist'}}) {
593 $count++;
594 print ",\n";
595 }
596 }
597 print ")\n";
598
599 print "<h3>Arguments</h3>\n";
600 print "<dl>\n";
601 foreach $parameter (@{$args{'parameterlist'}}) {
602 my $parameter_name = $parameter;
603 $parameter_name =~ s/\[.*//;
604
Randy Dunlap3c308792007-05-08 00:24:39 -0700605 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 print "<dt><b>".$parameter."</b>\n";
607 print "<dd>";
608 output_highlight($args{'parameterdescs'}{$parameter_name});
609 }
610 print "</dl>\n";
611 output_section_html(@_);
612 print "<hr>\n";
613}
614
Johannes Bergb112e0f2007-10-24 15:08:48 -0700615# output DOC: block header in html
616sub output_blockhead_html(%) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 my %args = %{$_[0]};
618 my ($parameter, $section);
619 my $count;
620
621 foreach $section (@{$args{'sectionlist'}}) {
622 print "<h3>$section</h3>\n";
623 print "<ul>\n";
624 output_highlight($args{'sections'}{$section});
625 print "</ul>\n";
626 }
627 print "<hr>\n";
628}
629
630sub output_section_xml(%) {
631 my %args = %{$_[0]};
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800632 my $section;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 # print out each section
634 $lineprefix=" ";
635 foreach $section (@{$args{'sectionlist'}}) {
Rich Walkerc73894c2005-05-01 08:59:26 -0700636 print "<refsect1>\n";
637 print "<title>$section</title>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 if ($section =~ m/EXAMPLE/i) {
Rich Walkerc73894c2005-05-01 08:59:26 -0700639 print "<informalexample><programlisting>\n";
640 } else {
641 print "<para>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 }
643 output_highlight($args{'sections'}{$section});
644 if ($section =~ m/EXAMPLE/i) {
Rich Walkerc73894c2005-05-01 08:59:26 -0700645 print "</programlisting></informalexample>\n";
646 } else {
647 print "</para>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 }
Rich Walkerc73894c2005-05-01 08:59:26 -0700649 print "</refsect1>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 }
651}
652
653# output function in XML DocBook
654sub output_function_xml(%) {
655 my %args = %{$_[0]};
656 my ($parameter, $section);
657 my $count;
658 my $id;
659
660 $id = "API-".$args{'function'};
661 $id =~ s/[^A-Za-z0-9]/-/g;
662
Pavel Pisa5449bc92007-02-10 01:45:37 -0800663 print "<refentry id=\"$id\">\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700664 print "<refentryinfo>\n";
665 print " <title>LINUX</title>\n";
666 print " <productname>Kernel Hackers Manual</productname>\n";
667 print " <date>$man_date</date>\n";
668 print "</refentryinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 print "<refmeta>\n";
Pavel Pisa5449bc92007-02-10 01:45:37 -0800670 print " <refentrytitle><phrase>".$args{'function'}."</phrase></refentrytitle>\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700671 print " <manvolnum>9</manvolnum>\n";
Borislav Petkov03662992007-05-09 02:33:43 -0700672 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 print "</refmeta>\n";
674 print "<refnamediv>\n";
675 print " <refname>".$args{'function'}."</refname>\n";
676 print " <refpurpose>\n";
677 print " ";
678 output_highlight ($args{'purpose'});
679 print " </refpurpose>\n";
680 print "</refnamediv>\n";
681
682 print "<refsynopsisdiv>\n";
683 print " <title>Synopsis</title>\n";
684 print " <funcsynopsis><funcprototype>\n";
685 print " <funcdef>".$args{'functiontype'}." ";
686 print "<function>".$args{'function'}." </function></funcdef>\n";
687
688 $count = 0;
689 if ($#{$args{'parameterlist'}} >= 0) {
690 foreach $parameter (@{$args{'parameterlist'}}) {
691 $type = $args{'parametertypes'}{$parameter};
692 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
693 # pointer-to-function
694 print " <paramdef>$1<parameter>$parameter</parameter>)\n";
695 print " <funcparams>$2</funcparams></paramdef>\n";
696 } else {
697 print " <paramdef>".$type;
698 print " <parameter>$parameter</parameter></paramdef>\n";
699 }
700 }
701 } else {
Martin Waitz6013d542005-05-01 08:59:25 -0700702 print " <void/>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 }
704 print " </funcprototype></funcsynopsis>\n";
705 print "</refsynopsisdiv>\n";
706
707 # print parameters
708 print "<refsect1>\n <title>Arguments</title>\n";
709 if ($#{$args{'parameterlist'}} >= 0) {
710 print " <variablelist>\n";
711 foreach $parameter (@{$args{'parameterlist'}}) {
712 my $parameter_name = $parameter;
713 $parameter_name =~ s/\[.*//;
714
715 print " <varlistentry>\n <term><parameter>$parameter</parameter></term>\n";
716 print " <listitem>\n <para>\n";
717 $lineprefix=" ";
718 output_highlight($args{'parameterdescs'}{$parameter_name});
719 print " </para>\n </listitem>\n </varlistentry>\n";
720 }
721 print " </variablelist>\n";
722 } else {
723 print " <para>\n None\n </para>\n";
724 }
725 print "</refsect1>\n";
726
727 output_section_xml(@_);
728 print "</refentry>\n\n";
729}
730
731# output struct in XML DocBook
732sub output_struct_xml(%) {
733 my %args = %{$_[0]};
734 my ($parameter, $section);
735 my $id;
736
737 $id = "API-struct-".$args{'struct'};
738 $id =~ s/[^A-Za-z0-9]/-/g;
739
Pavel Pisa5449bc92007-02-10 01:45:37 -0800740 print "<refentry id=\"$id\">\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700741 print "<refentryinfo>\n";
742 print " <title>LINUX</title>\n";
743 print " <productname>Kernel Hackers Manual</productname>\n";
744 print " <date>$man_date</date>\n";
745 print "</refentryinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 print "<refmeta>\n";
Pavel Pisa5449bc92007-02-10 01:45:37 -0800747 print " <refentrytitle><phrase>".$args{'type'}." ".$args{'struct'}."</phrase></refentrytitle>\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700748 print " <manvolnum>9</manvolnum>\n";
Borislav Petkov03662992007-05-09 02:33:43 -0700749 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 print "</refmeta>\n";
751 print "<refnamediv>\n";
752 print " <refname>".$args{'type'}." ".$args{'struct'}."</refname>\n";
753 print " <refpurpose>\n";
754 print " ";
755 output_highlight ($args{'purpose'});
756 print " </refpurpose>\n";
757 print "</refnamediv>\n";
758
759 print "<refsynopsisdiv>\n";
760 print " <title>Synopsis</title>\n";
761 print " <programlisting>\n";
762 print $args{'type'}." ".$args{'struct'}." {\n";
763 foreach $parameter (@{$args{'parameterlist'}}) {
764 if ($parameter =~ /^#/) {
765 print "$parameter\n";
766 next;
767 }
768
769 my $parameter_name = $parameter;
770 $parameter_name =~ s/\[.*//;
771
772 defined($args{'parameterdescs'}{$parameter_name}) || next;
Randy Dunlap3c308792007-05-08 00:24:39 -0700773 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 $type = $args{'parametertypes'}{$parameter};
775 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
776 # pointer-to-function
777 print " $1 $parameter) ($2);\n";
778 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
Randy Dunlap51f5a0c2007-07-19 01:48:24 -0700779 # bitfield
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 print " $1 $parameter$2;\n";
781 } else {
782 print " ".$type." ".$parameter.";\n";
783 }
784 }
785 print "};";
786 print " </programlisting>\n";
787 print "</refsynopsisdiv>\n";
788
789 print " <refsect1>\n";
790 print " <title>Members</title>\n";
791
Randy Dunlap39f00c02008-09-22 13:57:44 -0700792 if ($#{$args{'parameterlist'}} >= 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 print " <variablelist>\n";
794 foreach $parameter (@{$args{'parameterlist'}}) {
795 ($parameter =~ /^#/) && next;
796
797 my $parameter_name = $parameter;
798 $parameter_name =~ s/\[.*//;
799
800 defined($args{'parameterdescs'}{$parameter_name}) || next;
801 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
802 print " <varlistentry>";
803 print " <term>$parameter</term>\n";
804 print " <listitem><para>\n";
805 output_highlight($args{'parameterdescs'}{$parameter_name});
806 print " </para></listitem>\n";
807 print " </varlistentry>\n";
808 }
809 print " </variablelist>\n";
Randy Dunlap39f00c02008-09-22 13:57:44 -0700810 } else {
811 print " <para>\n None\n </para>\n";
812 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 print " </refsect1>\n";
814
815 output_section_xml(@_);
816
817 print "</refentry>\n\n";
818}
819
820# output enum in XML DocBook
821sub output_enum_xml(%) {
822 my %args = %{$_[0]};
823 my ($parameter, $section);
824 my $count;
825 my $id;
826
827 $id = "API-enum-".$args{'enum'};
828 $id =~ s/[^A-Za-z0-9]/-/g;
829
Pavel Pisa5449bc92007-02-10 01:45:37 -0800830 print "<refentry id=\"$id\">\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700831 print "<refentryinfo>\n";
832 print " <title>LINUX</title>\n";
833 print " <productname>Kernel Hackers Manual</productname>\n";
834 print " <date>$man_date</date>\n";
835 print "</refentryinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 print "<refmeta>\n";
Pavel Pisa5449bc92007-02-10 01:45:37 -0800837 print " <refentrytitle><phrase>enum ".$args{'enum'}."</phrase></refentrytitle>\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700838 print " <manvolnum>9</manvolnum>\n";
Borislav Petkov03662992007-05-09 02:33:43 -0700839 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 print "</refmeta>\n";
841 print "<refnamediv>\n";
842 print " <refname>enum ".$args{'enum'}."</refname>\n";
843 print " <refpurpose>\n";
844 print " ";
845 output_highlight ($args{'purpose'});
846 print " </refpurpose>\n";
847 print "</refnamediv>\n";
848
849 print "<refsynopsisdiv>\n";
850 print " <title>Synopsis</title>\n";
851 print " <programlisting>\n";
852 print "enum ".$args{'enum'}." {\n";
853 $count = 0;
854 foreach $parameter (@{$args{'parameterlist'}}) {
Randy Dunlap3c308792007-05-08 00:24:39 -0700855 print " $parameter";
856 if ($count != $#{$args{'parameterlist'}}) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 $count++;
858 print ",";
Randy Dunlap3c308792007-05-08 00:24:39 -0700859 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 print "\n";
861 }
862 print "};";
863 print " </programlisting>\n";
864 print "</refsynopsisdiv>\n";
865
866 print "<refsect1>\n";
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800867 print " <title>Constants</title>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 print " <variablelist>\n";
869 foreach $parameter (@{$args{'parameterlist'}}) {
870 my $parameter_name = $parameter;
871 $parameter_name =~ s/\[.*//;
872
873 print " <varlistentry>";
874 print " <term>$parameter</term>\n";
875 print " <listitem><para>\n";
876 output_highlight($args{'parameterdescs'}{$parameter_name});
877 print " </para></listitem>\n";
878 print " </varlistentry>\n";
879 }
880 print " </variablelist>\n";
881 print "</refsect1>\n";
882
883 output_section_xml(@_);
884
885 print "</refentry>\n\n";
886}
887
888# output typedef in XML DocBook
889sub output_typedef_xml(%) {
890 my %args = %{$_[0]};
891 my ($parameter, $section);
892 my $id;
893
894 $id = "API-typedef-".$args{'typedef'};
895 $id =~ s/[^A-Za-z0-9]/-/g;
896
Pavel Pisa5449bc92007-02-10 01:45:37 -0800897 print "<refentry id=\"$id\">\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700898 print "<refentryinfo>\n";
899 print " <title>LINUX</title>\n";
900 print " <productname>Kernel Hackers Manual</productname>\n";
901 print " <date>$man_date</date>\n";
902 print "</refentryinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 print "<refmeta>\n";
Pavel Pisa5449bc92007-02-10 01:45:37 -0800904 print " <refentrytitle><phrase>typedef ".$args{'typedef'}."</phrase></refentrytitle>\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700905 print " <manvolnum>9</manvolnum>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 print "</refmeta>\n";
907 print "<refnamediv>\n";
908 print " <refname>typedef ".$args{'typedef'}."</refname>\n";
909 print " <refpurpose>\n";
910 print " ";
911 output_highlight ($args{'purpose'});
912 print " </refpurpose>\n";
913 print "</refnamediv>\n";
914
915 print "<refsynopsisdiv>\n";
916 print " <title>Synopsis</title>\n";
917 print " <synopsis>typedef ".$args{'typedef'}.";</synopsis>\n";
918 print "</refsynopsisdiv>\n";
919
920 output_section_xml(@_);
921
922 print "</refentry>\n\n";
923}
924
925# output in XML DocBook
Johannes Bergb112e0f2007-10-24 15:08:48 -0700926sub output_blockhead_xml(%) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 my %args = %{$_[0]};
928 my ($parameter, $section);
929 my $count;
930
931 my $id = $args{'module'};
932 $id =~ s/[^A-Za-z0-9]/-/g;
933
934 # print out each section
935 $lineprefix=" ";
936 foreach $section (@{$args{'sectionlist'}}) {
Johannes Bergb112e0f2007-10-24 15:08:48 -0700937 if (!$args{'content-only'}) {
938 print "<refsect1>\n <title>$section</title>\n";
939 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 if ($section =~ m/EXAMPLE/i) {
941 print "<example><para>\n";
Johannes Bergb112e0f2007-10-24 15:08:48 -0700942 } else {
943 print "<para>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 }
945 output_highlight($args{'sections'}{$section});
946 if ($section =~ m/EXAMPLE/i) {
947 print "</para></example>\n";
Johannes Bergb112e0f2007-10-24 15:08:48 -0700948 } else {
949 print "</para>";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 }
Johannes Bergb112e0f2007-10-24 15:08:48 -0700951 if (!$args{'content-only'}) {
952 print "\n</refsect1>\n";
953 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 }
955
956 print "\n\n";
957}
958
959# output in XML DocBook
960sub output_function_gnome {
961 my %args = %{$_[0]};
962 my ($parameter, $section);
963 my $count;
964 my $id;
965
966 $id = $args{'module'}."-".$args{'function'};
967 $id =~ s/[^A-Za-z0-9]/-/g;
968
969 print "<sect2>\n";
970 print " <title id=\"$id\">".$args{'function'}."</title>\n";
971
972 print " <funcsynopsis>\n";
973 print " <funcdef>".$args{'functiontype'}." ";
974 print "<function>".$args{'function'}." ";
975 print "</function></funcdef>\n";
976
977 $count = 0;
978 if ($#{$args{'parameterlist'}} >= 0) {
979 foreach $parameter (@{$args{'parameterlist'}}) {
980 $type = $args{'parametertypes'}{$parameter};
981 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
982 # pointer-to-function
983 print " <paramdef>$1 <parameter>$parameter</parameter>)\n";
984 print " <funcparams>$2</funcparams></paramdef>\n";
985 } else {
986 print " <paramdef>".$type;
987 print " <parameter>$parameter</parameter></paramdef>\n";
988 }
989 }
990 } else {
991 print " <void>\n";
992 }
993 print " </funcsynopsis>\n";
994 if ($#{$args{'parameterlist'}} >= 0) {
995 print " <informaltable pgwide=\"1\" frame=\"none\" role=\"params\">\n";
996 print "<tgroup cols=\"2\">\n";
997 print "<colspec colwidth=\"2*\">\n";
998 print "<colspec colwidth=\"8*\">\n";
999 print "<tbody>\n";
1000 foreach $parameter (@{$args{'parameterlist'}}) {
1001 my $parameter_name = $parameter;
1002 $parameter_name =~ s/\[.*//;
1003
1004 print " <row><entry align=\"right\"><parameter>$parameter</parameter></entry>\n";
1005 print " <entry>\n";
1006 $lineprefix=" ";
1007 output_highlight($args{'parameterdescs'}{$parameter_name});
1008 print " </entry></row>\n";
1009 }
1010 print " </tbody></tgroup></informaltable>\n";
1011 } else {
1012 print " <para>\n None\n </para>\n";
1013 }
1014
1015 # print out each section
1016 $lineprefix=" ";
1017 foreach $section (@{$args{'sectionlist'}}) {
1018 print "<simplesect>\n <title>$section</title>\n";
1019 if ($section =~ m/EXAMPLE/i) {
1020 print "<example><programlisting>\n";
1021 } else {
1022 }
1023 print "<para>\n";
1024 output_highlight($args{'sections'}{$section});
1025 print "</para>\n";
1026 if ($section =~ m/EXAMPLE/i) {
1027 print "</programlisting></example>\n";
1028 } else {
1029 }
1030 print " </simplesect>\n";
1031 }
1032
1033 print "</sect2>\n\n";
1034}
1035
1036##
1037# output function in man
1038sub output_function_man(%) {
1039 my %args = %{$_[0]};
1040 my ($parameter, $section);
1041 my $count;
1042
1043 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
1044
1045 print ".SH NAME\n";
1046 print $args{'function'}." \\- ".$args{'purpose'}."\n";
1047
1048 print ".SH SYNOPSIS\n";
Randy Dunlapa21217d2007-02-10 01:46:04 -08001049 if ($args{'functiontype'} ne "") {
1050 print ".B \"".$args{'functiontype'}."\" ".$args{'function'}."\n";
1051 } else {
1052 print ".B \"".$args{'function'}."\n";
1053 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 $count = 0;
1055 my $parenth = "(";
1056 my $post = ",";
1057 foreach my $parameter (@{$args{'parameterlist'}}) {
1058 if ($count == $#{$args{'parameterlist'}}) {
1059 $post = ");";
1060 }
1061 $type = $args{'parametertypes'}{$parameter};
1062 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1063 # pointer-to-function
1064 print ".BI \"".$parenth.$1."\" ".$parameter." \") (".$2.")".$post."\"\n";
1065 } else {
1066 $type =~ s/([^\*])$/$1 /;
1067 print ".BI \"".$parenth.$type."\" ".$parameter." \"".$post."\"\n";
1068 }
1069 $count++;
1070 $parenth = "";
1071 }
1072
1073 print ".SH ARGUMENTS\n";
1074 foreach $parameter (@{$args{'parameterlist'}}) {
1075 my $parameter_name = $parameter;
1076 $parameter_name =~ s/\[.*//;
1077
1078 print ".IP \"".$parameter."\" 12\n";
1079 output_highlight($args{'parameterdescs'}{$parameter_name});
1080 }
1081 foreach $section (@{$args{'sectionlist'}}) {
1082 print ".SH \"", uc $section, "\"\n";
1083 output_highlight($args{'sections'}{$section});
1084 }
1085}
1086
1087##
1088# output enum in man
1089sub output_enum_man(%) {
1090 my %args = %{$_[0]};
1091 my ($parameter, $section);
1092 my $count;
1093
1094 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
1095
1096 print ".SH NAME\n";
1097 print "enum ".$args{'enum'}." \\- ".$args{'purpose'}."\n";
1098
1099 print ".SH SYNOPSIS\n";
1100 print "enum ".$args{'enum'}." {\n";
1101 $count = 0;
1102 foreach my $parameter (@{$args{'parameterlist'}}) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001103 print ".br\n.BI \" $parameter\"\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104 if ($count == $#{$args{'parameterlist'}}) {
1105 print "\n};\n";
1106 last;
1107 }
1108 else {
1109 print ", \n.br\n";
1110 }
1111 $count++;
1112 }
1113
1114 print ".SH Constants\n";
1115 foreach $parameter (@{$args{'parameterlist'}}) {
1116 my $parameter_name = $parameter;
1117 $parameter_name =~ s/\[.*//;
1118
1119 print ".IP \"".$parameter."\" 12\n";
1120 output_highlight($args{'parameterdescs'}{$parameter_name});
1121 }
1122 foreach $section (@{$args{'sectionlist'}}) {
1123 print ".SH \"$section\"\n";
1124 output_highlight($args{'sections'}{$section});
1125 }
1126}
1127
1128##
1129# output struct in man
1130sub output_struct_man(%) {
1131 my %args = %{$_[0]};
1132 my ($parameter, $section);
1133
1134 print ".TH \"$args{'module'}\" 9 \"".$args{'type'}." ".$args{'struct'}."\" \"$man_date\" \"API Manual\" LINUX\n";
1135
1136 print ".SH NAME\n";
1137 print $args{'type'}." ".$args{'struct'}." \\- ".$args{'purpose'}."\n";
1138
1139 print ".SH SYNOPSIS\n";
1140 print $args{'type'}." ".$args{'struct'}." {\n.br\n";
1141
1142 foreach my $parameter (@{$args{'parameterlist'}}) {
1143 if ($parameter =~ /^#/) {
1144 print ".BI \"$parameter\"\n.br\n";
1145 next;
1146 }
1147 my $parameter_name = $parameter;
1148 $parameter_name =~ s/\[.*//;
1149
Randy Dunlap3c308792007-05-08 00:24:39 -07001150 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 $type = $args{'parametertypes'}{$parameter};
1152 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1153 # pointer-to-function
1154 print ".BI \" ".$1."\" ".$parameter." \") (".$2.")"."\"\n;\n";
1155 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
Randy.Dunlap1d7e1d42006-07-01 04:36:34 -07001156 # bitfield
1157 print ".BI \" ".$1."\ \" ".$parameter.$2." \""."\"\n;\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 } else {
1159 $type =~ s/([^\*])$/$1 /;
1160 print ".BI \" ".$type."\" ".$parameter." \""."\"\n;\n";
1161 }
1162 print "\n.br\n";
1163 }
1164 print "};\n.br\n";
1165
Randy Dunlapc51d3da2006-06-25 05:49:14 -07001166 print ".SH Members\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 foreach $parameter (@{$args{'parameterlist'}}) {
1168 ($parameter =~ /^#/) && next;
1169
1170 my $parameter_name = $parameter;
1171 $parameter_name =~ s/\[.*//;
1172
Randy Dunlap3c308792007-05-08 00:24:39 -07001173 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 print ".IP \"".$parameter."\" 12\n";
1175 output_highlight($args{'parameterdescs'}{$parameter_name});
1176 }
1177 foreach $section (@{$args{'sectionlist'}}) {
1178 print ".SH \"$section\"\n";
1179 output_highlight($args{'sections'}{$section});
1180 }
1181}
1182
1183##
1184# output typedef in man
1185sub output_typedef_man(%) {
1186 my %args = %{$_[0]};
1187 my ($parameter, $section);
1188
1189 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
1190
1191 print ".SH NAME\n";
1192 print "typedef ".$args{'typedef'}." \\- ".$args{'purpose'}."\n";
1193
1194 foreach $section (@{$args{'sectionlist'}}) {
1195 print ".SH \"$section\"\n";
1196 output_highlight($args{'sections'}{$section});
1197 }
1198}
1199
Johannes Bergb112e0f2007-10-24 15:08:48 -07001200sub output_blockhead_man(%) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201 my %args = %{$_[0]};
1202 my ($parameter, $section);
1203 my $count;
1204
1205 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
1206
1207 foreach $section (@{$args{'sectionlist'}}) {
1208 print ".SH \"$section\"\n";
1209 output_highlight($args{'sections'}{$section});
1210 }
1211}
1212
1213##
1214# output in text
1215sub output_function_text(%) {
1216 my %args = %{$_[0]};
1217 my ($parameter, $section);
Randy Dunlapa21217d2007-02-10 01:46:04 -08001218 my $start;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219
Randy Dunlapf47634b2006-07-01 04:36:36 -07001220 print "Name:\n\n";
1221 print $args{'function'}." - ".$args{'purpose'}."\n";
1222
1223 print "\nSynopsis:\n\n";
Randy Dunlapa21217d2007-02-10 01:46:04 -08001224 if ($args{'functiontype'} ne "") {
1225 $start = $args{'functiontype'}." ".$args{'function'}." (";
1226 } else {
1227 $start = $args{'function'}." (";
1228 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 print $start;
Randy Dunlapa21217d2007-02-10 01:46:04 -08001230
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 my $count = 0;
1232 foreach my $parameter (@{$args{'parameterlist'}}) {
1233 $type = $args{'parametertypes'}{$parameter};
1234 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1235 # pointer-to-function
1236 print $1.$parameter.") (".$2;
1237 } else {
1238 print $type." ".$parameter;
1239 }
1240 if ($count != $#{$args{'parameterlist'}}) {
1241 $count++;
1242 print ",\n";
1243 print " " x length($start);
1244 } else {
1245 print ");\n\n";
1246 }
1247 }
1248
1249 print "Arguments:\n\n";
1250 foreach $parameter (@{$args{'parameterlist'}}) {
1251 my $parameter_name = $parameter;
1252 $parameter_name =~ s/\[.*//;
1253
1254 print $parameter."\n\t".$args{'parameterdescs'}{$parameter_name}."\n";
1255 }
1256 output_section_text(@_);
1257}
1258
1259#output sections in text
1260sub output_section_text(%) {
1261 my %args = %{$_[0]};
1262 my $section;
1263
1264 print "\n";
1265 foreach $section (@{$args{'sectionlist'}}) {
1266 print "$section:\n\n";
1267 output_highlight($args{'sections'}{$section});
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001268 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 print "\n\n";
1270}
1271
1272# output enum in text
1273sub output_enum_text(%) {
1274 my %args = %{$_[0]};
1275 my ($parameter);
1276 my $count;
1277 print "Enum:\n\n";
1278
Randy.Dunlap1d7e1d42006-07-01 04:36:34 -07001279 print "enum ".$args{'enum'}." - ".$args{'purpose'}."\n\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 print "enum ".$args{'enum'}." {\n";
1281 $count = 0;
1282 foreach $parameter (@{$args{'parameterlist'}}) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001283 print "\t$parameter";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 if ($count != $#{$args{'parameterlist'}}) {
1285 $count++;
1286 print ",";
1287 }
1288 print "\n";
1289 }
1290 print "};\n\n";
1291
1292 print "Constants:\n\n";
1293 foreach $parameter (@{$args{'parameterlist'}}) {
1294 print "$parameter\n\t";
1295 print $args{'parameterdescs'}{$parameter}."\n";
1296 }
1297
1298 output_section_text(@_);
1299}
1300
1301# output typedef in text
1302sub output_typedef_text(%) {
1303 my %args = %{$_[0]};
1304 my ($parameter);
1305 my $count;
1306 print "Typedef:\n\n";
1307
Randy.Dunlap1d7e1d42006-07-01 04:36:34 -07001308 print "typedef ".$args{'typedef'}." - ".$args{'purpose'}."\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 output_section_text(@_);
1310}
1311
1312# output struct as text
1313sub output_struct_text(%) {
1314 my %args = %{$_[0]};
1315 my ($parameter);
1316
Randy.Dunlap1d7e1d42006-07-01 04:36:34 -07001317 print $args{'type'}." ".$args{'struct'}." - ".$args{'purpose'}."\n\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 print $args{'type'}." ".$args{'struct'}." {\n";
1319 foreach $parameter (@{$args{'parameterlist'}}) {
1320 if ($parameter =~ /^#/) {
1321 print "$parameter\n";
1322 next;
1323 }
1324
1325 my $parameter_name = $parameter;
1326 $parameter_name =~ s/\[.*//;
1327
Randy Dunlap3c308792007-05-08 00:24:39 -07001328 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329 $type = $args{'parametertypes'}{$parameter};
1330 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1331 # pointer-to-function
1332 print "\t$1 $parameter) ($2);\n";
1333 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
Randy Dunlap51f5a0c2007-07-19 01:48:24 -07001334 # bitfield
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 print "\t$1 $parameter$2;\n";
1336 } else {
1337 print "\t".$type." ".$parameter.";\n";
1338 }
1339 }
1340 print "};\n\n";
1341
1342 print "Members:\n\n";
1343 foreach $parameter (@{$args{'parameterlist'}}) {
1344 ($parameter =~ /^#/) && next;
1345
1346 my $parameter_name = $parameter;
1347 $parameter_name =~ s/\[.*//;
1348
Randy Dunlap3c308792007-05-08 00:24:39 -07001349 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 print "$parameter\n\t";
1351 print $args{'parameterdescs'}{$parameter_name}."\n";
1352 }
1353 print "\n";
1354 output_section_text(@_);
1355}
1356
Johannes Bergb112e0f2007-10-24 15:08:48 -07001357sub output_blockhead_text(%) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 my %args = %{$_[0]};
1359 my ($parameter, $section);
1360
1361 foreach $section (@{$args{'sectionlist'}}) {
1362 print " $section:\n";
1363 print " -> ";
1364 output_highlight($args{'sections'}{$section});
1365 }
1366}
1367
1368##
Randy Dunlap27205742006-10-11 01:22:12 -07001369# generic output function for all types (function, struct/union, typedef, enum);
1370# calls the generated, variable output_ function name based on
1371# functype and output_mode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372sub output_declaration {
1373 no strict 'refs';
1374 my $name = shift;
1375 my $functype = shift;
1376 my $func = "output_${functype}_$output_mode";
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001377 if (($function_only==0) ||
1378 ( $function_only == 1 && defined($function_table{$name})) ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 ( $function_only == 2 && !defined($function_table{$name})))
1380 {
Randy Dunlap3c308792007-05-08 00:24:39 -07001381 &$func(@_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 $section_counter++;
1383 }
1384}
1385
1386##
Randy Dunlap27205742006-10-11 01:22:12 -07001387# generic output function - calls the right one based on current output mode.
Johannes Bergb112e0f2007-10-24 15:08:48 -07001388sub output_blockhead {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 no strict 'refs';
Johannes Bergb112e0f2007-10-24 15:08:48 -07001390 my $func = "output_blockhead_".$output_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 &$func(@_);
1392 $section_counter++;
1393}
1394
1395##
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001396# takes a declaration (struct, union, enum, typedef) and
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397# invokes the right handler. NOT called for functions.
1398sub dump_declaration($$) {
1399 no strict 'refs';
1400 my ($prototype, $file) = @_;
1401 my $func = "dump_".$decl_type;
1402 &$func(@_);
1403}
1404
1405sub dump_union($$) {
1406 dump_struct(@_);
1407}
1408
1409sub dump_struct($$) {
1410 my $x = shift;
1411 my $file = shift;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001412 my $nested;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413
1414 if ($x =~/(struct|union)\s+(\w+)\s*{(.*)}/) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001415 $declaration_name = $2;
1416 my $members = $3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417
1418 # ignore embedded structs or unions
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001419 $members =~ s/({.*})//g;
1420 $nested = $1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421
Martin Waitzaeec46b2005-11-13 16:08:13 -08001422 # ignore members marked private:
1423 $members =~ s/\/\*.*?private:.*?public:.*?\*\///gos;
1424 $members =~ s/\/\*.*?private:.*//gos;
1425 # strip comments:
1426 $members =~ s/\/\*.*?\*\///gos;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001427 $nested =~ s/\/\*.*?\*\///gos;
Martin Waitzaeec46b2005-11-13 16:08:13 -08001428
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429 create_parameterlist($members, ';', $file);
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001430 check_sections($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431
1432 output_declaration($declaration_name,
1433 'struct',
1434 {'struct' => $declaration_name,
1435 'module' => $modulename,
1436 'parameterlist' => \@parameterlist,
1437 'parameterdescs' => \%parameterdescs,
1438 'parametertypes' => \%parametertypes,
1439 'sectionlist' => \@sectionlist,
1440 'sections' => \%sections,
1441 'purpose' => $declaration_purpose,
1442 'type' => $decl_type
1443 });
1444 }
1445 else {
Randy Dunlap3c308792007-05-08 00:24:39 -07001446 print STDERR "Error(${file}:$.): Cannot parse struct or union!\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447 ++$errors;
1448 }
1449}
1450
1451sub dump_enum($$) {
1452 my $x = shift;
1453 my $file = shift;
1454
Martin Waitzaeec46b2005-11-13 16:08:13 -08001455 $x =~ s@/\*.*?\*/@@gos; # strip comments.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456 if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001457 $declaration_name = $1;
1458 my $members = $2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459
1460 foreach my $arg (split ',', $members) {
1461 $arg =~ s/^\s*(\w+).*/$1/;
1462 push @parameterlist, $arg;
1463 if (!$parameterdescs{$arg}) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001464 $parameterdescs{$arg} = $undescribed;
1465 print STDERR "Warning(${file}:$.): Enum value '$arg' ".
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466 "not described in enum '$declaration_name'\n";
1467 }
1468
1469 }
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001470
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 output_declaration($declaration_name,
1472 'enum',
1473 {'enum' => $declaration_name,
1474 'module' => $modulename,
1475 'parameterlist' => \@parameterlist,
1476 'parameterdescs' => \%parameterdescs,
1477 'sectionlist' => \@sectionlist,
1478 'sections' => \%sections,
1479 'purpose' => $declaration_purpose
1480 });
1481 }
1482 else {
Randy Dunlap3c308792007-05-08 00:24:39 -07001483 print STDERR "Error(${file}:$.): Cannot parse enum!\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 ++$errors;
1485 }
1486}
1487
1488sub dump_typedef($$) {
1489 my $x = shift;
1490 my $file = shift;
1491
Martin Waitzaeec46b2005-11-13 16:08:13 -08001492 $x =~ s@/\*.*?\*/@@gos; # strip comments.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001494 $x =~ s/\(*.\)\s*;$/;/;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495 $x =~ s/\[*.\]\s*;$/;/;
1496 }
1497
1498 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001499 $declaration_name = $1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500
1501 output_declaration($declaration_name,
1502 'typedef',
1503 {'typedef' => $declaration_name,
1504 'module' => $modulename,
1505 'sectionlist' => \@sectionlist,
1506 'sections' => \%sections,
1507 'purpose' => $declaration_purpose
1508 });
1509 }
1510 else {
Randy Dunlap3c308792007-05-08 00:24:39 -07001511 print STDERR "Error(${file}:$.): Cannot parse typedef!\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512 ++$errors;
1513 }
1514}
1515
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001516sub save_struct_actual($) {
1517 my $actual = shift;
1518
1519 # strip all spaces from the actual param so that it looks like one string item
1520 $actual =~ s/\s*//g;
1521 $struct_actual = $struct_actual . $actual . " ";
1522}
1523
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524sub create_parameterlist($$$) {
1525 my $args = shift;
1526 my $splitter = shift;
1527 my $file = shift;
1528 my $type;
1529 my $param;
1530
Martin Waitza6d3fe72006-01-09 20:53:55 -08001531 # temporarily replace commas inside function pointer definition
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532 while ($args =~ /(\([^\),]+),/) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001533 $args =~ s/(\([^\),]+),/$1#/g;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 }
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001535
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536 foreach my $arg (split($splitter, $args)) {
1537 # strip comments
1538 $arg =~ s/\/\*.*\*\///;
Randy Dunlap3c308792007-05-08 00:24:39 -07001539 # strip leading/trailing spaces
1540 $arg =~ s/^\s*//;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541 $arg =~ s/\s*$//;
1542 $arg =~ s/\s+/ /;
1543
1544 if ($arg =~ /^#/) {
1545 # Treat preprocessor directive as a typeless variable just to fill
1546 # corresponding data structures "correctly". Catch it later in
1547 # output_* subs.
1548 push_parameter($arg, "", $file);
Richard Kennedy00d62962008-02-23 15:24:01 -08001549 } elsif ($arg =~ m/\(.+\)\s*\(/) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 # pointer-to-function
1551 $arg =~ tr/#/,/;
Richard Kennedy00d62962008-02-23 15:24:01 -08001552 $arg =~ m/[^\(]+\(\*?\s*(\w*)\s*\)/;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553 $param = $1;
1554 $type = $arg;
Richard Kennedy00d62962008-02-23 15:24:01 -08001555 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001556 save_struct_actual($param);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 push_parameter($param, $type, $file);
Martin Waitzaeec46b2005-11-13 16:08:13 -08001558 } elsif ($arg) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 $arg =~ s/\s*:\s*/:/g;
1560 $arg =~ s/\s*\[/\[/g;
1561
1562 my @args = split('\s*,\s*', $arg);
1563 if ($args[0] =~ m/\*/) {
1564 $args[0] =~ s/(\*+)\s*/ $1/;
1565 }
Borislav Petkov884f2812007-05-08 00:29:05 -07001566
1567 my @first_arg;
1568 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1569 shift @args;
1570 push(@first_arg, split('\s+', $1));
1571 push(@first_arg, $2);
1572 } else {
1573 @first_arg = split('\s+', shift @args);
1574 }
1575
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 unshift(@args, pop @first_arg);
1577 $type = join " ", @first_arg;
1578
1579 foreach $param (@args) {
1580 if ($param =~ m/^(\*+)\s*(.*)/) {
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001581 save_struct_actual($2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 push_parameter($2, "$type $1", $file);
1583 }
1584 elsif ($param =~ m/(.*?):(\d+)/) {
Randy Dunlap7b978872008-05-16 15:45:52 -07001585 if ($type ne "") { # skip unnamed bit-fields
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001586 save_struct_actual($1);
Randy Dunlap7b978872008-05-16 15:45:52 -07001587 push_parameter($1, "$type:$2", $file)
1588 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 }
1590 else {
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001591 save_struct_actual($param);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592 push_parameter($param, $type, $file);
1593 }
1594 }
1595 }
1596 }
1597}
1598
1599sub push_parameter($$$) {
1600 my $param = shift;
1601 my $type = shift;
1602 my $file = shift;
1603
Randy Dunlap5f8c7c92007-07-19 01:48:24 -07001604 if (($anon_struct_union == 1) && ($type eq "") &&
1605 ($param eq "}")) {
1606 return; # ignore the ending }; from anon. struct/union
1607 }
1608
1609 $anon_struct_union = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 my $param_name = $param;
1611 $param_name =~ s/\[.*//;
1612
Martin Waitza6d3fe72006-01-09 20:53:55 -08001613 if ($type eq "" && $param =~ /\.\.\.$/)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 {
Randy Dunlapced69092008-12-01 13:14:03 -08001615 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1616 $parameterdescs{$param} = "variable arguments";
1617 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 }
1619 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1620 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 $param="void";
1622 $parameterdescs{void} = "no arguments";
1623 }
Randy Dunlap134fe012006-12-22 01:10:50 -08001624 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1625 # handle unnamed (anonymous) union or struct:
1626 {
1627 $type = $param;
Randy Dunlap5f8c7c92007-07-19 01:48:24 -07001628 $param = "{unnamed_" . $param . "}";
Randy Dunlap134fe012006-12-22 01:10:50 -08001629 $parameterdescs{$param} = "anonymous\n";
Randy Dunlap5f8c7c92007-07-19 01:48:24 -07001630 $anon_struct_union = 1;
Randy Dunlap134fe012006-12-22 01:10:50 -08001631 }
1632
Martin Waitza6d3fe72006-01-09 20:53:55 -08001633 # warn if parameter has no description
Randy Dunlap134fe012006-12-22 01:10:50 -08001634 # (but ignore ones starting with # as these are not parameters
1635 # but inline preprocessor statements);
1636 # also ignore unnamed structs/unions;
Randy Dunlap5f8c7c92007-07-19 01:48:24 -07001637 if (!$anon_struct_union) {
Martin Waitza6d3fe72006-01-09 20:53:55 -08001638 if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) {
1639
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640 $parameterdescs{$param_name} = $undescribed;
1641
1642 if (($type eq 'function') || ($type eq 'enum')) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001643 print STDERR "Warning(${file}:$.): Function parameter ".
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644 "or member '$param' not " .
1645 "described in '$declaration_name'\n";
1646 }
1647 print STDERR "Warning(${file}:$.):".
Randy Dunlap3c308792007-05-08 00:24:39 -07001648 " No description found for parameter '$param'\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 ++$warnings;
Randy Dunlap3c308792007-05-08 00:24:39 -07001650 }
1651 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652
1653 push @parameterlist, $param;
1654 $parametertypes{$param} = $type;
1655}
1656
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001657sub check_sections($$$$$$) {
1658 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck, $nested) = @_;
1659 my @sects = split ' ', $sectcheck;
1660 my @prms = split ' ', $prmscheck;
1661 my $err;
1662 my ($px, $sx);
1663 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
1664
1665 foreach $sx (0 .. $#sects) {
1666 $err = 1;
1667 foreach $px (0 .. $#prms) {
1668 $prm_clean = $prms[$px];
1669 $prm_clean =~ s/\[.*\]//;
1670 $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//;
1671 ##$prm_clean =~ s/^\**//;
1672 if ($prm_clean eq $sects[$sx]) {
1673 $err = 0;
1674 last;
1675 }
1676 }
1677 if ($err) {
1678 if ($decl_type eq "function") {
1679 print STDERR "Warning(${file}:$.): " .
1680 "Excess function parameter " .
1681 "'$sects[$sx]' " .
1682 "description in '$decl_name'\n";
1683 ++$warnings;
1684 } else {
1685 if ($nested !~ m/\Q$sects[$sx]\E/) {
1686 print STDERR "Warning(${file}:$.): " .
1687 "Excess struct/union/enum/typedef member " .
1688 "'$sects[$sx]' " .
1689 "description in '$decl_name'\n";
1690 ++$warnings;
1691 }
1692 }
1693 }
1694 }
1695}
1696
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697##
1698# takes a function prototype and the name of the current file being
1699# processed and spits out all the details stored in the global
1700# arrays/hashes.
1701sub dump_function($$) {
1702 my $prototype = shift;
1703 my $file = shift;
1704
1705 $prototype =~ s/^static +//;
1706 $prototype =~ s/^extern +//;
Pavel Pisa4dc3b162005-05-01 08:59:25 -07001707 $prototype =~ s/^asmlinkage +//;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708 $prototype =~ s/^inline +//;
1709 $prototype =~ s/^__inline__ +//;
Randy Dunlap32e79402006-10-11 01:22:10 -07001710 $prototype =~ s/^__inline +//;
1711 $prototype =~ s/^__always_inline +//;
1712 $prototype =~ s/^noinline +//;
Randy Dunlap0129a052006-07-30 03:03:41 -07001713 $prototype =~ s/__devinit +//;
Randy Dunlap74fc5c62008-06-19 16:03:29 -07001714 $prototype =~ s/__init +//;
Randy Dunlap890c78c2008-10-25 17:06:43 -07001715 $prototype =~ s/^#\s*define\s+//; #ak added
Randy Dunlap328d2442007-02-28 20:12:10 -08001716 $prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717
1718 # Yes, this truly is vile. We are looking for:
1719 # 1. Return type (may be nothing if we're looking at a macro)
1720 # 2. Function name
1721 # 3. Function parameters.
1722 #
1723 # All the while we have to watch out for function pointer parameters
1724 # (which IIRC is what the two sections are for), C types (these
1725 # regexps don't even start to express all the possibilities), and
1726 # so on.
1727 #
1728 # If you mess with these regexps, it's a good idea to check that
1729 # the following functions' documentation still comes out right:
1730 # - parport_register_device (function pointer parameters)
1731 # - atomic_set (macro)
Martin Waitz9598f912006-02-01 03:06:55 -08001732 # - pci_match_device, __copy_to_user (long return type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733
1734 if ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1735 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1736 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1737 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
Randy Dunlap94b3e032008-02-07 00:13:26 -08001738 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1740 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1741 $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1742 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1743 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1744 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1745 $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1746 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
Martin Waitz9598f912006-02-01 03:06:55 -08001747 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1748 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
Randy Dunlap412ecd72007-02-10 22:47:33 -08001749 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1750 $prototype =~ m/^(\w+\s+\w+\s*\*\s*\w+\s*\*\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 $return_type = $1;
1752 $declaration_name = $2;
1753 my $args = $3;
1754
1755 create_parameterlist($args, ',', $file);
1756 } else {
1757 print STDERR "Error(${file}:$.): cannot understand prototype: '$prototype'\n";
1758 ++$errors;
1759 return;
1760 }
1761
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001762 my $prms = join " ", @parameterlist;
1763 check_sections($file, $declaration_name, "function", $sectcheck, $prms, "");
1764
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001765 output_declaration($declaration_name,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766 'function',
1767 {'function' => $declaration_name,
1768 'module' => $modulename,
1769 'functiontype' => $return_type,
1770 'parameterlist' => \@parameterlist,
1771 'parameterdescs' => \%parameterdescs,
1772 'parametertypes' => \%parametertypes,
1773 'sectionlist' => \@sectionlist,
1774 'sections' => \%sections,
1775 'purpose' => $declaration_purpose
1776 });
1777}
1778
1779sub process_file($);
1780
1781# Read the file that maps relative names to absolute names for
1782# separate source and object directories and for shadow trees.
1783if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
1784 my ($relname, $absname);
1785 while(<SOURCE_MAP>) {
1786 chop();
1787 ($relname, $absname) = (split())[0..1];
1788 $relname =~ s:^/+::;
1789 $source_map{$relname} = $absname;
1790 }
1791 close(SOURCE_MAP);
1792}
1793
1794if ($filelist) {
1795 open(FLIST,"<$filelist") or die "Can't open file list $filelist";
1796 while(<FLIST>) {
1797 chop;
1798 process_file($_);
1799 }
1800}
1801
1802foreach (@ARGV) {
1803 chomp;
1804 process_file($_);
1805}
1806if ($verbose && $errors) {
1807 print STDERR "$errors errors\n";
1808}
1809if ($verbose && $warnings) {
1810 print STDERR "$warnings warnings\n";
1811}
1812
1813exit($errors);
1814
1815sub reset_state {
1816 $function = "";
1817 %constants = ();
1818 %parameterdescs = ();
1819 %parametertypes = ();
1820 @parameterlist = ();
1821 %sections = ();
1822 @sectionlist = ();
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001823 $sectcheck = "";
1824 $struct_actual = "";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825 $prototype = "";
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001826
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827 $state = 0;
1828}
1829
Randy Dunlapb4870bc2009-02-11 13:04:33 -08001830sub syscall_munge() {
1831 my $void = 0;
1832
1833 $prototype =~ s@[\r\n\t]+@ @gos; # strip newlines/CR's/tabs
1834## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1835 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1836 $void = 1;
1837## $prototype = "long sys_$1(void)";
1838 }
1839
1840 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1841 if ($prototype =~ m/long (sys_.*?),/) {
1842 $prototype =~ s/,/\(/;
1843 } elsif ($void) {
1844 $prototype =~ s/\)/\(void\)/;
1845 }
1846
1847 # now delete all of the odd-number commas in $prototype
1848 # so that arg types & arg names don't have a comma between them
1849 my $count = 0;
1850 my $len = length($prototype);
1851 if ($void) {
1852 $len = 0; # skip the for-loop
1853 }
1854 for (my $ix = 0; $ix < $len; $ix++) {
1855 if (substr($prototype, $ix, 1) eq ',') {
1856 $count++;
1857 if ($count % 2 == 1) {
1858 substr($prototype, $ix, 1) = ' ';
1859 }
1860 }
1861 }
1862}
1863
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001864sub process_state3_function($$) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865 my $x = shift;
1866 my $file = shift;
1867
Randy Dunlap51f5a0c2007-07-19 01:48:24 -07001868 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1869
Randy Dunlap890c78c2008-10-25 17:06:43 -07001870 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871 # do nothing
1872 }
1873 elsif ($x =~ /([^\{]*)/) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001874 $prototype .= $1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875 }
Randy Dunlapb4870bc2009-02-11 13:04:33 -08001876
Randy Dunlap890c78c2008-10-25 17:06:43 -07001877 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001878 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1880 $prototype =~ s@^\s+@@gos; # strip leading spaces
Randy Dunlapb4870bc2009-02-11 13:04:33 -08001881 if ($prototype =~ /SYSCALL_DEFINE/) {
1882 syscall_munge();
1883 }
1884 dump_function($prototype, $file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 reset_state();
1886 }
1887}
1888
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001889sub process_state3_type($$) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 my $x = shift;
1891 my $file = shift;
1892
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1894 $x =~ s@^\s+@@gos; # strip leading spaces
1895 $x =~ s@\s+$@@gos; # strip trailing spaces
Randy Dunlap51f5a0c2007-07-19 01:48:24 -07001896 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1897
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898 if ($x =~ /^#/) {
1899 # To distinguish preprocessor directive from regular declaration later.
1900 $x .= ";";
1901 }
1902
1903 while (1) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001904 if ( $x =~ /([^{};]*)([{};])(.*)/ ) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905 $prototype .= $1 . $2;
1906 ($2 eq '{') && $brcount++;
1907 ($2 eq '}') && $brcount--;
1908 if (($2 eq ';') && ($brcount == 0)) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001909 dump_declaration($prototype,$file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 reset_state();
Randy Dunlap3c308792007-05-08 00:24:39 -07001911 last;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 }
1913 $x = $3;
Randy Dunlap3c308792007-05-08 00:24:39 -07001914 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915 $prototype .= $x;
1916 last;
1917 }
1918 }
1919}
1920
Randy Dunlap6b5b55f2007-10-16 23:31:20 -07001921# xml_escape: replace <, >, and & in the text stream;
1922#
1923# however, formatting controls that are generated internally/locally in the
1924# kernel-doc script are not escaped here; instead, they begin life like
1925# $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings
1926# are converted to their mnemonic-expected output, without the 4 * '\' & ':',
1927# just before actual output; (this is done by local_unescape())
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928sub xml_escape($) {
1929 my $text = shift;
Randy Dunlapecfb2512006-06-25 05:49:13 -07001930 if (($output_mode eq "text") || ($output_mode eq "man")) {
1931 return $text;
1932 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933 $text =~ s/\&/\\\\\\amp;/g;
1934 $text =~ s/\</\\\\\\lt;/g;
1935 $text =~ s/\>/\\\\\\gt;/g;
1936 return $text;
1937}
1938
Randy Dunlap6b5b55f2007-10-16 23:31:20 -07001939# convert local escape strings to html
1940# local escape strings look like: '\\\\menmonic:' (that's 4 backslashes)
1941sub local_unescape($) {
1942 my $text = shift;
1943 if (($output_mode eq "text") || ($output_mode eq "man")) {
1944 return $text;
1945 }
1946 $text =~ s/\\\\\\\\lt:/</g;
1947 $text =~ s/\\\\\\\\gt:/>/g;
1948 return $text;
1949}
1950
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951sub process_file($) {
Randy Dunlap2283a112005-07-07 15:39:26 -07001952 my $file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 my $identifier;
1954 my $func;
Randy Dunlapa21217d2007-02-10 01:46:04 -08001955 my $descr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 my $initial_section_counter = $section_counter;
1957
Randy Dunlap2283a112005-07-07 15:39:26 -07001958 if (defined($ENV{'SRCTREE'})) {
1959 $file = "$ENV{'SRCTREE'}" . "/" . "@_";
1960 }
1961 else {
1962 $file = "@_";
1963 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 if (defined($source_map{$file})) {
1965 $file = $source_map{$file};
1966 }
1967
1968 if (!open(IN,"<$file")) {
1969 print STDERR "Error: Cannot open file $file\n";
1970 ++$errors;
1971 return;
1972 }
1973
1974 $section_counter = 0;
1975 while (<IN>) {
1976 if ($state == 0) {
1977 if (/$doc_start/o) {
1978 $state = 1; # next line is always the function name
Randy Dunlap850622d2006-06-25 05:48:55 -07001979 $in_doc_sect = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980 }
1981 } elsif ($state == 1) { # this line is the function name (always)
1982 if (/$doc_block/o) {
1983 $state = 4;
1984 $contents = "";
1985 if ( $1 eq "" ) {
1986 $section = $section_intro;
1987 } else {
1988 $section = $1;
1989 }
Randy Dunlap3c308792007-05-08 00:24:39 -07001990 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991 elsif (/$doc_decl/o) {
1992 $identifier = $1;
1993 if (/\s*([\w\s]+?)\s*-/) {
1994 $identifier = $1;
1995 }
1996
1997 $state = 2;
1998 if (/-(.*)/) {
Randy Dunlap51f5a0c2007-07-19 01:48:24 -07001999 # strip leading/trailing/multiple spaces
Randy Dunlapa21217d2007-02-10 01:46:04 -08002000 $descr= $1;
2001 $descr =~ s/^\s*//;
2002 $descr =~ s/\s*$//;
2003 $descr =~ s/\s+/ /;
2004 $declaration_purpose = xml_escape($descr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005 } else {
2006 $declaration_purpose = "";
2007 }
Randy Dunlap77cc23b2008-02-07 00:13:42 -08002008
2009 if (($declaration_purpose eq "") && $verbose) {
2010 print STDERR "Warning(${file}:$.): missing initial short description on line:\n";
2011 print STDERR $_;
2012 ++$warnings;
2013 }
2014
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015 if ($identifier =~ m/^struct/) {
2016 $decl_type = 'struct';
2017 } elsif ($identifier =~ m/^union/) {
2018 $decl_type = 'union';
2019 } elsif ($identifier =~ m/^enum/) {
2020 $decl_type = 'enum';
2021 } elsif ($identifier =~ m/^typedef/) {
2022 $decl_type = 'typedef';
2023 } else {
2024 $decl_type = 'function';
2025 }
2026
2027 if ($verbose) {
2028 print STDERR "Info(${file}:$.): Scanning doc for $identifier\n";
2029 }
2030 } else {
2031 print STDERR "Warning(${file}:$.): Cannot understand $_ on line $.",
2032 " - I thought it was a doc line\n";
2033 ++$warnings;
2034 $state = 0;
2035 }
2036 } elsif ($state == 2) { # look for head: lines, and include content
2037 if (/$doc_sect/o) {
2038 $newsection = $1;
2039 $newcontents = $2;
2040
Randy Dunlap792aa2f2008-02-07 00:13:41 -08002041 if (($contents ne "") && ($contents ne "\n")) {
Randy Dunlap850622d2006-06-25 05:48:55 -07002042 if (!$in_doc_sect && $verbose) {
2043 print STDERR "Warning(${file}:$.): contents before sections\n";
2044 ++$warnings;
2045 }
Randy Dunlap94dc7ad2008-04-28 02:16:34 -07002046 dump_section($file, $section, xml_escape($contents));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047 $section = $section_default;
2048 }
2049
Randy Dunlap850622d2006-06-25 05:48:55 -07002050 $in_doc_sect = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051 $contents = $newcontents;
2052 if ($contents ne "") {
Randy Dunlap27205742006-10-11 01:22:12 -07002053 while ((substr($contents, 0, 1) eq " ") ||
2054 substr($contents, 0, 1) eq "\t") {
2055 $contents = substr($contents, 1);
Randy Dunlap05189492006-06-25 05:47:47 -07002056 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057 $contents .= "\n";
2058 }
2059 $section = $newsection;
2060 } elsif (/$doc_end/) {
2061
2062 if ($contents ne "") {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -07002063 dump_section($file, $section, xml_escape($contents));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 $section = $section_default;
2065 $contents = "";
2066 }
Randy Dunlap46b958e2008-04-28 02:16:35 -07002067 # look for doc_com + <text> + doc_end:
2068 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2069 print STDERR "Warning(${file}:$.): suspicious ending line: $_";
2070 ++$warnings;
2071 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072
2073 $prototype = "";
2074 $state = 3;
2075 $brcount = 0;
Randy Dunlap232acbc2006-06-25 05:47:48 -07002076# print STDERR "end of doc comment, looking for prototype\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077 } elsif (/$doc_content/) {
2078 # miguel-style comment kludge, look for blank lines after
2079 # @parameter line to signify start of description
Randy Dunlap3c3b8092006-02-01 03:06:58 -08002080 if ($1 eq "" &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 ($section =~ m/^@/ || $section eq $section_context)) {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -07002082 dump_section($file, $section, xml_escape($contents));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 $section = $section_default;
2084 $contents = "";
2085 } else {
2086 $contents .= $1."\n";
2087 }
2088 } else {
2089 # i dont know - bad line? ignore.
Randy Dunlap3c3b8092006-02-01 03:06:58 -08002090 print STDERR "Warning(${file}:$.): bad line: $_";
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091 ++$warnings;
2092 }
Randy Dunlap232acbc2006-06-25 05:47:48 -07002093 } elsif ($state == 3) { # scanning for function '{' (end of prototype)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 if ($decl_type eq 'function') {
Randy Dunlap3c308792007-05-08 00:24:39 -07002095 process_state3_function($_, $file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096 } else {
Randy Dunlap3c308792007-05-08 00:24:39 -07002097 process_state3_type($_, $file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098 }
2099 } elsif ($state == 4) {
2100 # Documentation block
Randy Dunlap3c308792007-05-08 00:24:39 -07002101 if (/$doc_block/) {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -07002102 dump_doc_section($file, $section, xml_escape($contents));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 $contents = "";
2104 $function = "";
2105 %constants = ();
2106 %parameterdescs = ();
2107 %parametertypes = ();
2108 @parameterlist = ();
2109 %sections = ();
2110 @sectionlist = ();
2111 $prototype = "";
2112 if ( $1 eq "" ) {
2113 $section = $section_intro;
2114 } else {
2115 $section = $1;
2116 }
Randy Dunlap3c308792007-05-08 00:24:39 -07002117 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118 elsif (/$doc_end/)
2119 {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -07002120 dump_doc_section($file, $section, xml_escape($contents));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 $contents = "";
2122 $function = "";
2123 %constants = ();
2124 %parameterdescs = ();
2125 %parametertypes = ();
2126 @parameterlist = ();
2127 %sections = ();
2128 @sectionlist = ();
2129 $prototype = "";
2130 $state = 0;
2131 }
2132 elsif (/$doc_content/)
2133 {
2134 if ( $1 eq "" )
2135 {
2136 $contents .= $blankline;
2137 }
2138 else
2139 {
2140 $contents .= $1 . "\n";
Randy Dunlap3c3b8092006-02-01 03:06:58 -08002141 }
Randy Dunlap3c308792007-05-08 00:24:39 -07002142 }
2143 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 }
2145 if ($initial_section_counter == $section_counter) {
2146 print STDERR "Warning(${file}): no structured comments found\n";
2147 if ($output_mode eq "xml") {
2148 # The template wants at least one RefEntry here; make one.
2149 print "<refentry>\n";
2150 print " <refnamediv>\n";
2151 print " <refname>\n";
2152 print " ${file}\n";
2153 print " </refname>\n";
2154 print " <refpurpose>\n";
2155 print " Document generation inconsistency\n";
2156 print " </refpurpose>\n";
2157 print " </refnamediv>\n";
2158 print " <refsect1>\n";
2159 print " <title>\n";
2160 print " Oops\n";
2161 print " </title>\n";
2162 print " <warning>\n";
2163 print " <para>\n";
2164 print " The template for this document tried to insert\n";
2165 print " the structured comment from the file\n";
2166 print " <filename>${file}</filename> at this point,\n";
2167 print " but none was found.\n";
2168 print " This dummy section is inserted to allow\n";
2169 print " generation to continue.\n";
2170 print " </para>\n";
2171 print " </warning>\n";
2172 print " </refsect1>\n";
2173 print "</refentry>\n";
2174 }
2175 }
2176}