blob: cdb6dc1f6458ba4634c0f8584ae3da615ce10696 [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 Dunlapb9d973282009-06-09 08:50:38 -07008## Copyright (C) 2005-2009 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070016# 18/01/2001 - Cleanups
17# Functions prototyped as foo(void) same as foo()
18# Stop eval'ing where we don't need to.
19# -- huggie@earth.li
20
21# 27/06/2001 - Allowed whitespace after initial "/**" and
22# allowed comments before function declarations.
23# -- Christian Kreibich <ck@whoop.org>
24
25# Still to do:
26# - add perldoc documentation
27# - Look more closely at some of the scarier bits :)
28
29# 26/05/2001 - Support for separate source and object trees.
30# Return error code.
31# Keith Owens <kaos@ocs.com.au>
32
33# 23/09/2001 - Added support for typedefs, structs, enums and unions
34# Support for Context section; can be terminated using empty line
35# Small fixes (like spaces vs. \s in regex)
36# -- Tim Jansen <tim@tjansen.de>
37
38
39#
40# This will read a 'c' file and scan for embedded comments in the
41# style of gnome comments (+minor extensions - see below).
42#
43
44# Note: This only supports 'c'.
45
46# usage:
Johannes Bergeda603f2010-09-11 15:55:22 -070047# kernel-doc [ -docbook | -html | -text | -man | -list ] [ -no-doc-sections ]
Linus Torvalds1da177e2005-04-16 15:20:36 -070048# [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile
49# or
50# [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile
51#
52# Set output format using one of -docbook -html -text or -man. Default is man.
Johannes Bergeda603f2010-09-11 15:55:22 -070053# The -list format is for internal use by docproc.
Linus Torvalds1da177e2005-04-16 15:20:36 -070054#
Johannes Berg4b445952007-10-24 15:08:48 -070055# -no-doc-sections
56# Do not output DOC: sections
57#
Linus Torvalds1da177e2005-04-16 15:20:36 -070058# -function funcname
Johannes Bergb112e0f2007-10-24 15:08:48 -070059# If set, then only generate documentation for the given function(s) or
60# DOC: section titles. All other functions and DOC: sections are ignored.
Linus Torvalds1da177e2005-04-16 15:20:36 -070061#
62# -nofunction funcname
Johannes Bergb112e0f2007-10-24 15:08:48 -070063# If set, then only generate documentation for the other function(s)/DOC:
64# sections. Cannot be used together with -function (yes, that's a bug --
65# perl hackers can fix it 8))
Linus Torvalds1da177e2005-04-16 15:20:36 -070066#
67# c files - list of 'c' files to process
68#
69# All output goes to stdout, with errors to stderr.
70
71#
72# format of comments.
73# In the following table, (...)? signifies optional structure.
74# (...)* signifies 0 or more structure elements
75# /**
76# * function_name(:)? (- short description)?
77# (* @parameterx: (description of parameter x)?)*
78# (* a blank line)?
79# * (Description:)? (Description of function)?
80# * (section header: (section description)? )*
81# (*)?*/
82#
83# So .. the trivial example would be:
84#
85# /**
86# * my_function
Randy Dunlapb9d973282009-06-09 08:50:38 -070087# */
Linus Torvalds1da177e2005-04-16 15:20:36 -070088#
Randy Dunlap891dcd22007-02-10 01:45:53 -080089# If the Description: header tag is omitted, then there must be a blank line
Linus Torvalds1da177e2005-04-16 15:20:36 -070090# after the last parameter specification.
91# e.g.
92# /**
93# * my_function - does my stuff
94# * @my_arg: its mine damnit
95# *
Randy Dunlap3c3b8092006-02-01 03:06:58 -080096# * Does my stuff explained.
Linus Torvalds1da177e2005-04-16 15:20:36 -070097# */
98#
99# or, could also use:
100# /**
101# * my_function - does my stuff
102# * @my_arg: its mine damnit
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800103# * Description: Does my stuff explained.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104# */
105# etc.
106#
Randy Dunlapb9d973282009-06-09 08:50:38 -0700107# Besides functions you can also write documentation for structs, unions,
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800108# enums and typedefs. Instead of the function name you must write the name
109# of the declaration; the struct/union/enum/typedef must always precede
110# the name. Nesting of declarations is not supported.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111# Use the argument mechanism to document members or constants.
112# e.g.
113# /**
114# * struct my_struct - short description
115# * @a: first member
116# * @b: second member
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800117# *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118# * Longer description
119# */
120# struct my_struct {
121# int a;
122# int b;
Martin Waitzaeec46b2005-11-13 16:08:13 -0800123# /* private: */
124# int c;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125# };
126#
127# All descriptions can be multiline, except the short function description.
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800128#
129# You can also add additional sections. When documenting kernel functions you
130# should document the "Context:" of the function, e.g. whether the functions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131# can be called form interrupts. Unlike other sections you can end it with an
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800132# empty line.
133# Example-sections should contain the string EXAMPLE so that they are marked
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134# appropriately in DocBook.
135#
136# Example:
137# /**
138# * user_function - function that can only be called in user context
139# * @a: some argument
140# * Context: !in_interrupt()
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800141# *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142# * Some description
143# * Example:
144# * user_function(22);
145# */
146# ...
147#
148#
149# All descriptive text is further processed, scanning for the following special
150# patterns, which are highlighted appropriately.
151#
152# 'funcname()' - function
153# '$ENVVAR' - environmental variable
154# '&struct_name' - name of a structure (up to two words including 'struct')
155# '@parameter' - name of a parameter
156# '%CONST' - name of a constant.
157
158my $errors = 0;
159my $warnings = 0;
Randy Dunlap5f8c7c92007-07-19 01:48:24 -0700160my $anon_struct_union = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
162# match expressions used to find embedded type information
163my $type_constant = '\%([-_\w]+)';
164my $type_func = '(\w+)\(\)';
165my $type_param = '\@(\w+)';
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700166my $type_struct = '\&((struct\s*)*[_\w]+)';
Randy Dunlap6b5b55f2007-10-16 23:31:20 -0700167my $type_struct_xml = '\\&amp;((struct\s*)*[_\w]+)';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168my $type_env = '(\$\w+)';
169
170# Output conversion substitutions.
171# One for each output format
172
173# these work fairly well
174my %highlights_html = ( $type_constant, "<i>\$1</i>",
175 $type_func, "<b>\$1</b>",
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700176 $type_struct_xml, "<i>\$1</i>",
177 $type_env, "<b><i>\$1</i></b>",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 $type_param, "<tt><b>\$1</b></tt>" );
Randy Dunlap6b5b55f2007-10-16 23:31:20 -0700179my $local_lt = "\\\\\\\\lt:";
180my $local_gt = "\\\\\\\\gt:";
181my $blankline_html = $local_lt . "p" . $local_gt; # was "<p>"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
183# XML, docbook format
184my %highlights_xml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>",
185 $type_constant, "<constant>\$1</constant>",
186 $type_func, "<function>\$1</function>",
Johannes Berg5c98fc02007-10-24 15:08:48 -0700187 $type_struct_xml, "<structname>\$1</structname>",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 $type_env, "<envar>\$1</envar>",
189 $type_param, "<parameter>\$1</parameter>" );
Johannes Berg5c98fc02007-10-24 15:08:48 -0700190my $blankline_xml = $local_lt . "/para" . $local_gt . $local_lt . "para" . $local_gt . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
192# gnome, docbook format
193my %highlights_gnome = ( $type_constant, "<replaceable class=\"option\">\$1</replaceable>",
194 $type_func, "<function>\$1</function>",
195 $type_struct, "<structname>\$1</structname>",
196 $type_env, "<envar>\$1</envar>",
197 $type_param, "<parameter>\$1</parameter>" );
198my $blankline_gnome = "</para><para>\n";
199
200# these are pretty rough
201my %highlights_man = ( $type_constant, "\$1",
202 $type_func, "\\\\fB\$1\\\\fP",
203 $type_struct, "\\\\fI\$1\\\\fP",
204 $type_param, "\\\\fI\$1\\\\fP" );
205my $blankline_man = "";
206
207# text-mode
208my %highlights_text = ( $type_constant, "\$1",
209 $type_func, "\$1",
210 $type_struct, "\$1",
211 $type_param, "\$1" );
212my $blankline_text = "";
213
Johannes Bergeda603f2010-09-11 15:55:22 -0700214# list mode
215my %highlights_list = ( $type_constant, "\$1",
216 $type_func, "\$1",
217 $type_struct, "\$1",
218 $type_param, "\$1" );
219my $blankline_list = "";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
221sub usage {
Johannes Bergeda603f2010-09-11 15:55:22 -0700222 print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man | -list ]\n";
223 print " [ -no-doc-sections ]\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 print " [ -function funcname [ -function funcname ...] ]\n";
225 print " [ -nofunction funcname [ -nofunction funcname ...] ]\n";
226 print " c source file(s) > outputfile\n";
Randy Dunlap77cc23b2008-02-07 00:13:42 -0800227 print " -v : verbose output, more warnings & other info listed\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 exit 1;
229}
230
231# read arguments
Randy Dunlapb9d973282009-06-09 08:50:38 -0700232if ($#ARGV == -1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 usage();
234}
235
236my $verbose = 0;
237my $output_mode = "man";
Johannes Berg4b445952007-10-24 15:08:48 -0700238my $no_doc_sections = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239my %highlights = %highlights_man;
240my $blankline = $blankline_man;
241my $modulename = "Kernel API";
242my $function_only = 0;
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800243my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
244 'July', 'August', 'September', 'October',
245 'November', 'December')[(localtime)[4]] .
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 " " . ((localtime)[5]+1900);
247
248# Essentially these are globals
Randy Dunlapb9d973282009-06-09 08:50:38 -0700249# They probably want to be tidied up, made more localised or something.
250# CAVEAT EMPTOR! Some of the others I localised may not want to be, which
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251# could cause "use of undefined value" or other bugs.
Randy Dunlapb9d973282009-06-09 08:50:38 -0700252my ($function, %function_table, %parametertypes, $declaration_purpose);
253my ($type, $declaration_name, $return_type);
Ilya Dryomov1c32fd02010-02-26 13:06:03 -0800254my ($newsection, $newcontents, $prototype, $brcount, %source_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
Randy Dunlapbd0e88e2008-03-13 12:32:43 -0700256if (defined($ENV{'KBUILD_VERBOSE'})) {
257 $verbose = "$ENV{'KBUILD_VERBOSE'}";
258}
259
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800260# Generated docbook code is inserted in a template at a point where
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261# docbook v3.1 requires a non-zero sequence of RefEntry's; see:
262# http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
263# We keep track of number of generated entries and generate a dummy
264# if needs be to ensure the expanded template can be postprocessed
265# into html.
266my $section_counter = 0;
267
268my $lineprefix="";
269
270# states
271# 0 - normal code
272# 1 - looking for function name
273# 2 - scanning field start.
274# 3 - scanning prototype.
275# 4 - documentation block
276my $state;
Randy Dunlap850622d2006-06-25 05:48:55 -0700277my $in_doc_sect;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
279#declaration types: can be
280# 'function', 'struct', 'union', 'enum', 'typedef'
281my $decl_type;
282
283my $doc_special = "\@\%\$\&";
284
285my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
286my $doc_end = '\*/';
287my $doc_com = '\s*\*\s*';
Randy Dunlapb9d973282009-06-09 08:50:38 -0700288my $doc_decl = $doc_com . '(\w+)';
289my $doc_sect = $doc_com . '([' . $doc_special . ']?[\w\s]+):(.*)';
290my $doc_content = $doc_com . '(.*)';
291my $doc_block = $doc_com . 'DOC:\s*(.*)?';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
293my %constants;
294my %parameterdescs;
295my @parameterlist;
296my %sections;
297my @sectionlist;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -0800298my $sectcheck;
299my $struct_actual;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
301my $contents = "";
302my $section_default = "Description"; # default section
303my $section_intro = "Introduction";
304my $section = $section_default;
305my $section_context = "Context";
306
307my $undescribed = "-- undescribed --";
308
309reset_state();
310
311while ($ARGV[0] =~ m/^-(.*)/) {
312 my $cmd = shift @ARGV;
313 if ($cmd eq "-html") {
314 $output_mode = "html";
315 %highlights = %highlights_html;
316 $blankline = $blankline_html;
317 } elsif ($cmd eq "-man") {
318 $output_mode = "man";
319 %highlights = %highlights_man;
320 $blankline = $blankline_man;
321 } elsif ($cmd eq "-text") {
322 $output_mode = "text";
323 %highlights = %highlights_text;
324 $blankline = $blankline_text;
325 } elsif ($cmd eq "-docbook") {
326 $output_mode = "xml";
327 %highlights = %highlights_xml;
328 $blankline = $blankline_xml;
Johannes Bergeda603f2010-09-11 15:55:22 -0700329 } elsif ($cmd eq "-list") {
330 $output_mode = "list";
331 %highlights = %highlights_list;
332 $blankline = $blankline_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 } elsif ($cmd eq "-gnome") {
334 $output_mode = "gnome";
335 %highlights = %highlights_gnome;
336 $blankline = $blankline_gnome;
337 } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document
338 $modulename = shift @ARGV;
339 } elsif ($cmd eq "-function") { # to only output specific functions
340 $function_only = 1;
341 $function = shift @ARGV;
342 $function_table{$function} = 1;
343 } elsif ($cmd eq "-nofunction") { # to only output specific functions
344 $function_only = 2;
345 $function = shift @ARGV;
346 $function_table{$function} = 1;
347 } elsif ($cmd eq "-v") {
348 $verbose = 1;
349 } elsif (($cmd eq "-h") || ($cmd eq "--help")) {
350 usage();
Johannes Berg4b445952007-10-24 15:08:48 -0700351 } elsif ($cmd eq '-no-doc-sections') {
352 $no_doc_sections = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 }
354}
355
Borislav Petkov53f049f2007-05-08 00:30:54 -0700356# get kernel version from env
357sub get_kernel_version() {
Johannes Berg1b9bc222007-10-24 15:08:48 -0700358 my $version = 'unknown kernel version';
Borislav Petkov53f049f2007-05-08 00:30:54 -0700359
360 if (defined($ENV{'KERNELVERSION'})) {
361 $version = $ENV{'KERNELVERSION'};
362 }
363 return $version;
364}
Borislav Petkov03662992007-05-09 02:33:43 -0700365my $kernelversion = get_kernel_version();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
367# generate a sequence of code that will splice in highlighting information
368# using the s// operator.
369my $dohighlight = "";
370foreach my $pattern (keys %highlights) {
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700371# print STDERR "scanning pattern:$pattern, highlight:($highlights{$pattern})\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 $dohighlight .= "\$contents =~ s:$pattern:$highlights{$pattern}:gs;\n";
373}
374
375##
376# dumps section contents to arrays/hashes intended for that purpose.
377#
378sub dump_section {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -0700379 my $file = shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 my $name = shift;
381 my $contents = join "\n", @_;
382
383 if ($name =~ m/$type_constant/) {
384 $name = $1;
385# print STDERR "constant section '$1' = '$contents'\n";
386 $constants{$name} = $contents;
387 } elsif ($name =~ m/$type_param/) {
388# print STDERR "parameter def '$1' = '$contents'\n";
389 $name = $1;
390 $parameterdescs{$name} = $contents;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -0800391 $sectcheck = $sectcheck . $name . " ";
Randy Dunlapced69092008-12-01 13:14:03 -0800392 } elsif ($name eq "@\.\.\.") {
393# print STDERR "parameter def '...' = '$contents'\n";
394 $name = "...";
395 $parameterdescs{$name} = $contents;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -0800396 $sectcheck = $sectcheck . $name . " ";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 } else {
398# print STDERR "other section '$name' = '$contents'\n";
Randy Dunlap94dc7ad2008-04-28 02:16:34 -0700399 if (defined($sections{$name}) && ($sections{$name} ne "")) {
400 print STDERR "Error(${file}:$.): duplicate section name '$name'\n";
401 ++$errors;
402 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 $sections{$name} = $contents;
404 push @sectionlist, $name;
405 }
406}
407
408##
Johannes Bergb112e0f2007-10-24 15:08:48 -0700409# dump DOC: section after checking that it should go out
410#
411sub dump_doc_section {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -0700412 my $file = shift;
Johannes Bergb112e0f2007-10-24 15:08:48 -0700413 my $name = shift;
414 my $contents = join "\n", @_;
415
Johannes Berg4b445952007-10-24 15:08:48 -0700416 if ($no_doc_sections) {
417 return;
418 }
419
Johannes Bergb112e0f2007-10-24 15:08:48 -0700420 if (($function_only == 0) ||
421 ( $function_only == 1 && defined($function_table{$name})) ||
422 ( $function_only == 2 && !defined($function_table{$name})))
423 {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -0700424 dump_section($file, $name, $contents);
Johannes Bergb112e0f2007-10-24 15:08:48 -0700425 output_blockhead({'sectionlist' => \@sectionlist,
426 'sections' => \%sections,
427 'module' => $modulename,
428 'content-only' => ($function_only != 0), });
429 }
430}
431
432##
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433# output function
434#
435# parameterdescs, a hash.
436# function => "function name"
437# parameterlist => @list of parameters
438# parameterdescs => %parameter descriptions
439# sectionlist => @list of sections
Randy Dunlapa21217d2007-02-10 01:46:04 -0800440# sections => %section descriptions
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800441#
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442
443sub output_highlight {
444 my $contents = join "\n",@_;
445 my $line;
446
447# DEBUG
448# if (!defined $contents) {
449# use Carp;
450# confess "output_highlight got called with no args?\n";
451# }
452
Johannes Berg5c98fc02007-10-24 15:08:48 -0700453 if ($output_mode eq "html" || $output_mode eq "xml") {
Randy Dunlap6b5b55f2007-10-16 23:31:20 -0700454 $contents = local_unescape($contents);
455 # convert data read & converted thru xml_escape() into &xyz; format:
456 $contents =~ s/\\\\\\/&/g;
457 }
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700458# print STDERR "contents b4:$contents\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 eval $dohighlight;
460 die $@ if $@;
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700461# print STDERR "contents af:$contents\n";
462
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 foreach $line (split "\n", $contents) {
Randy Dunlap3c308792007-05-08 00:24:39 -0700464 if ($line eq ""){
Randy Dunlap6b5b55f2007-10-16 23:31:20 -0700465 print $lineprefix, local_unescape($blankline);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 } else {
Randy Dunlap3c308792007-05-08 00:24:39 -0700467 $line =~ s/\\\\\\/\&/g;
Randy Dunlapcdccb312007-07-19 01:48:25 -0700468 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
469 print "\\&$line";
470 } else {
471 print $lineprefix, $line;
472 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 }
474 print "\n";
475 }
476}
477
478#output sections in html
479sub output_section_html(%) {
480 my %args = %{$_[0]};
481 my $section;
482
483 foreach $section (@{$args{'sectionlist'}}) {
484 print "<h3>$section</h3>\n";
485 print "<blockquote>\n";
486 output_highlight($args{'sections'}{$section});
487 print "</blockquote>\n";
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800488 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489}
490
491# output enum in html
492sub output_enum_html(%) {
493 my %args = %{$_[0]};
494 my ($parameter);
495 my $count;
Randy Dunlapb9d973282009-06-09 08:50:38 -0700496 print "<h2>enum " . $args{'enum'} . "</h2>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497
Randy Dunlapb9d973282009-06-09 08:50:38 -0700498 print "<b>enum " . $args{'enum'} . "</b> {<br>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 $count = 0;
500 foreach $parameter (@{$args{'parameterlist'}}) {
Randy Dunlapb9d973282009-06-09 08:50:38 -0700501 print " <b>" . $parameter . "</b>";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 if ($count != $#{$args{'parameterlist'}}) {
503 $count++;
504 print ",\n";
505 }
506 print "<br>";
507 }
508 print "};<br>\n";
509
510 print "<h3>Constants</h3>\n";
511 print "<dl>\n";
512 foreach $parameter (@{$args{'parameterlist'}}) {
Randy Dunlapb9d973282009-06-09 08:50:38 -0700513 print "<dt><b>" . $parameter . "</b>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 print "<dd>";
515 output_highlight($args{'parameterdescs'}{$parameter});
516 }
517 print "</dl>\n";
518 output_section_html(@_);
519 print "<hr>\n";
520}
521
Randy Dunlapd28bee02006-02-01 03:06:57 -0800522# output typedef in html
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523sub output_typedef_html(%) {
524 my %args = %{$_[0]};
525 my ($parameter);
526 my $count;
Randy Dunlapb9d973282009-06-09 08:50:38 -0700527 print "<h2>typedef " . $args{'typedef'} . "</h2>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
Randy Dunlapb9d973282009-06-09 08:50:38 -0700529 print "<b>typedef " . $args{'typedef'} . "</b>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 output_section_html(@_);
531 print "<hr>\n";
532}
533
534# output struct in html
535sub output_struct_html(%) {
536 my %args = %{$_[0]};
537 my ($parameter);
538
Randy Dunlapb9d973282009-06-09 08:50:38 -0700539 print "<h2>" . $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "</h2>\n";
540 print "<b>" . $args{'type'} . " " . $args{'struct'} . "</b> {<br>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 foreach $parameter (@{$args{'parameterlist'}}) {
542 if ($parameter =~ /^#/) {
543 print "$parameter<br>\n";
544 next;
545 }
546 my $parameter_name = $parameter;
547 $parameter_name =~ s/\[.*//;
548
Randy Dunlap3c308792007-05-08 00:24:39 -0700549 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 $type = $args{'parametertypes'}{$parameter};
551 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
552 # pointer-to-function
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700553 print "&nbsp; &nbsp; <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700555 # bitfield
556 print "&nbsp; &nbsp; <i>$1</i> <b>$parameter</b>$2;<br>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 } else {
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700558 print "&nbsp; &nbsp; <i>$type</i> <b>$parameter</b>;<br>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 }
560 }
561 print "};<br>\n";
562
563 print "<h3>Members</h3>\n";
564 print "<dl>\n";
565 foreach $parameter (@{$args{'parameterlist'}}) {
566 ($parameter =~ /^#/) && next;
567
568 my $parameter_name = $parameter;
569 $parameter_name =~ s/\[.*//;
570
Randy Dunlap3c308792007-05-08 00:24:39 -0700571 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Randy Dunlapb9d973282009-06-09 08:50:38 -0700572 print "<dt><b>" . $parameter . "</b>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 print "<dd>";
574 output_highlight($args{'parameterdescs'}{$parameter_name});
575 }
576 print "</dl>\n";
577 output_section_html(@_);
578 print "<hr>\n";
579}
580
581# output function in html
582sub output_function_html(%) {
583 my %args = %{$_[0]};
584 my ($parameter, $section);
585 my $count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586
Randy Dunlapb9d973282009-06-09 08:50:38 -0700587 print "<h2>" . $args{'function'} . " - " . $args{'purpose'} . "</h2>\n";
588 print "<i>" . $args{'functiontype'} . "</i>\n";
589 print "<b>" . $args{'function'} . "</b>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 print "(";
591 $count = 0;
592 foreach $parameter (@{$args{'parameterlist'}}) {
593 $type = $args{'parametertypes'}{$parameter};
594 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
595 # pointer-to-function
596 print "<i>$1</i><b>$parameter</b>) <i>($2)</i>";
597 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -0700598 print "<i>" . $type . "</i> <b>" . $parameter . "</b>";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 }
600 if ($count != $#{$args{'parameterlist'}}) {
601 $count++;
602 print ",\n";
603 }
604 }
605 print ")\n";
606
607 print "<h3>Arguments</h3>\n";
608 print "<dl>\n";
609 foreach $parameter (@{$args{'parameterlist'}}) {
610 my $parameter_name = $parameter;
611 $parameter_name =~ s/\[.*//;
612
Randy Dunlap3c308792007-05-08 00:24:39 -0700613 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Randy Dunlapb9d973282009-06-09 08:50:38 -0700614 print "<dt><b>" . $parameter . "</b>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 print "<dd>";
616 output_highlight($args{'parameterdescs'}{$parameter_name});
617 }
618 print "</dl>\n";
619 output_section_html(@_);
620 print "<hr>\n";
621}
622
Johannes Bergb112e0f2007-10-24 15:08:48 -0700623# output DOC: block header in html
624sub output_blockhead_html(%) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 my %args = %{$_[0]};
626 my ($parameter, $section);
627 my $count;
628
629 foreach $section (@{$args{'sectionlist'}}) {
630 print "<h3>$section</h3>\n";
631 print "<ul>\n";
632 output_highlight($args{'sections'}{$section});
633 print "</ul>\n";
634 }
635 print "<hr>\n";
636}
637
638sub output_section_xml(%) {
639 my %args = %{$_[0]};
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800640 my $section;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 # print out each section
642 $lineprefix=" ";
643 foreach $section (@{$args{'sectionlist'}}) {
Rich Walkerc73894c2005-05-01 08:59:26 -0700644 print "<refsect1>\n";
645 print "<title>$section</title>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 if ($section =~ m/EXAMPLE/i) {
Rich Walkerc73894c2005-05-01 08:59:26 -0700647 print "<informalexample><programlisting>\n";
648 } else {
649 print "<para>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 }
651 output_highlight($args{'sections'}{$section});
652 if ($section =~ m/EXAMPLE/i) {
Rich Walkerc73894c2005-05-01 08:59:26 -0700653 print "</programlisting></informalexample>\n";
654 } else {
655 print "</para>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 }
Rich Walkerc73894c2005-05-01 08:59:26 -0700657 print "</refsect1>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 }
659}
660
661# output function in XML DocBook
662sub output_function_xml(%) {
663 my %args = %{$_[0]};
664 my ($parameter, $section);
665 my $count;
666 my $id;
667
Randy Dunlapb9d973282009-06-09 08:50:38 -0700668 $id = "API-" . $args{'function'};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 $id =~ s/[^A-Za-z0-9]/-/g;
670
Pavel Pisa5449bc92007-02-10 01:45:37 -0800671 print "<refentry id=\"$id\">\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700672 print "<refentryinfo>\n";
673 print " <title>LINUX</title>\n";
674 print " <productname>Kernel Hackers Manual</productname>\n";
675 print " <date>$man_date</date>\n";
676 print "</refentryinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 print "<refmeta>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700678 print " <refentrytitle><phrase>" . $args{'function'} . "</phrase></refentrytitle>\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700679 print " <manvolnum>9</manvolnum>\n";
Borislav Petkov03662992007-05-09 02:33:43 -0700680 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 print "</refmeta>\n";
682 print "<refnamediv>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700683 print " <refname>" . $args{'function'} . "</refname>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 print " <refpurpose>\n";
685 print " ";
686 output_highlight ($args{'purpose'});
687 print " </refpurpose>\n";
688 print "</refnamediv>\n";
689
690 print "<refsynopsisdiv>\n";
691 print " <title>Synopsis</title>\n";
692 print " <funcsynopsis><funcprototype>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700693 print " <funcdef>" . $args{'functiontype'} . " ";
694 print "<function>" . $args{'function'} . " </function></funcdef>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695
696 $count = 0;
697 if ($#{$args{'parameterlist'}} >= 0) {
698 foreach $parameter (@{$args{'parameterlist'}}) {
699 $type = $args{'parametertypes'}{$parameter};
700 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
701 # pointer-to-function
702 print " <paramdef>$1<parameter>$parameter</parameter>)\n";
703 print " <funcparams>$2</funcparams></paramdef>\n";
704 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -0700705 print " <paramdef>" . $type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 print " <parameter>$parameter</parameter></paramdef>\n";
707 }
708 }
709 } else {
Martin Waitz6013d542005-05-01 08:59:25 -0700710 print " <void/>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 }
712 print " </funcprototype></funcsynopsis>\n";
713 print "</refsynopsisdiv>\n";
714
715 # print parameters
716 print "<refsect1>\n <title>Arguments</title>\n";
717 if ($#{$args{'parameterlist'}} >= 0) {
718 print " <variablelist>\n";
719 foreach $parameter (@{$args{'parameterlist'}}) {
720 my $parameter_name = $parameter;
721 $parameter_name =~ s/\[.*//;
722
723 print " <varlistentry>\n <term><parameter>$parameter</parameter></term>\n";
724 print " <listitem>\n <para>\n";
725 $lineprefix=" ";
726 output_highlight($args{'parameterdescs'}{$parameter_name});
727 print " </para>\n </listitem>\n </varlistentry>\n";
728 }
729 print " </variablelist>\n";
730 } else {
731 print " <para>\n None\n </para>\n";
732 }
733 print "</refsect1>\n";
734
735 output_section_xml(@_);
736 print "</refentry>\n\n";
737}
738
739# output struct in XML DocBook
740sub output_struct_xml(%) {
741 my %args = %{$_[0]};
742 my ($parameter, $section);
743 my $id;
744
Randy Dunlapb9d973282009-06-09 08:50:38 -0700745 $id = "API-struct-" . $args{'struct'};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 $id =~ s/[^A-Za-z0-9]/-/g;
747
Pavel Pisa5449bc92007-02-10 01:45:37 -0800748 print "<refentry id=\"$id\">\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700749 print "<refentryinfo>\n";
750 print " <title>LINUX</title>\n";
751 print " <productname>Kernel Hackers Manual</productname>\n";
752 print " <date>$man_date</date>\n";
753 print "</refentryinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 print "<refmeta>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700755 print " <refentrytitle><phrase>" . $args{'type'} . " " . $args{'struct'} . "</phrase></refentrytitle>\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700756 print " <manvolnum>9</manvolnum>\n";
Borislav Petkov03662992007-05-09 02:33:43 -0700757 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 print "</refmeta>\n";
759 print "<refnamediv>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700760 print " <refname>" . $args{'type'} . " " . $args{'struct'} . "</refname>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 print " <refpurpose>\n";
762 print " ";
763 output_highlight ($args{'purpose'});
764 print " </refpurpose>\n";
765 print "</refnamediv>\n";
766
767 print "<refsynopsisdiv>\n";
768 print " <title>Synopsis</title>\n";
769 print " <programlisting>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700770 print $args{'type'} . " " . $args{'struct'} . " {\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 foreach $parameter (@{$args{'parameterlist'}}) {
772 if ($parameter =~ /^#/) {
773 print "$parameter\n";
774 next;
775 }
776
777 my $parameter_name = $parameter;
778 $parameter_name =~ s/\[.*//;
779
780 defined($args{'parameterdescs'}{$parameter_name}) || next;
Randy Dunlap3c308792007-05-08 00:24:39 -0700781 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 $type = $args{'parametertypes'}{$parameter};
783 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
784 # pointer-to-function
785 print " $1 $parameter) ($2);\n";
786 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
Randy Dunlap51f5a0c2007-07-19 01:48:24 -0700787 # bitfield
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 print " $1 $parameter$2;\n";
789 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -0700790 print " " . $type . " " . $parameter . ";\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 }
792 }
793 print "};";
794 print " </programlisting>\n";
795 print "</refsynopsisdiv>\n";
796
797 print " <refsect1>\n";
798 print " <title>Members</title>\n";
799
Randy Dunlap39f00c02008-09-22 13:57:44 -0700800 if ($#{$args{'parameterlist'}} >= 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 print " <variablelist>\n";
802 foreach $parameter (@{$args{'parameterlist'}}) {
803 ($parameter =~ /^#/) && next;
804
805 my $parameter_name = $parameter;
806 $parameter_name =~ s/\[.*//;
807
808 defined($args{'parameterdescs'}{$parameter_name}) || next;
809 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
810 print " <varlistentry>";
811 print " <term>$parameter</term>\n";
812 print " <listitem><para>\n";
813 output_highlight($args{'parameterdescs'}{$parameter_name});
814 print " </para></listitem>\n";
815 print " </varlistentry>\n";
816 }
817 print " </variablelist>\n";
Randy Dunlap39f00c02008-09-22 13:57:44 -0700818 } else {
819 print " <para>\n None\n </para>\n";
820 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 print " </refsect1>\n";
822
823 output_section_xml(@_);
824
825 print "</refentry>\n\n";
826}
827
828# output enum in XML DocBook
829sub output_enum_xml(%) {
830 my %args = %{$_[0]};
831 my ($parameter, $section);
832 my $count;
833 my $id;
834
Randy Dunlapb9d973282009-06-09 08:50:38 -0700835 $id = "API-enum-" . $args{'enum'};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 $id =~ s/[^A-Za-z0-9]/-/g;
837
Pavel Pisa5449bc92007-02-10 01:45:37 -0800838 print "<refentry id=\"$id\">\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700839 print "<refentryinfo>\n";
840 print " <title>LINUX</title>\n";
841 print " <productname>Kernel Hackers Manual</productname>\n";
842 print " <date>$man_date</date>\n";
843 print "</refentryinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 print "<refmeta>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700845 print " <refentrytitle><phrase>enum " . $args{'enum'} . "</phrase></refentrytitle>\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700846 print " <manvolnum>9</manvolnum>\n";
Borislav Petkov03662992007-05-09 02:33:43 -0700847 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 print "</refmeta>\n";
849 print "<refnamediv>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700850 print " <refname>enum " . $args{'enum'} . "</refname>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 print " <refpurpose>\n";
852 print " ";
853 output_highlight ($args{'purpose'});
854 print " </refpurpose>\n";
855 print "</refnamediv>\n";
856
857 print "<refsynopsisdiv>\n";
858 print " <title>Synopsis</title>\n";
859 print " <programlisting>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700860 print "enum " . $args{'enum'} . " {\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 $count = 0;
862 foreach $parameter (@{$args{'parameterlist'}}) {
Randy Dunlap3c308792007-05-08 00:24:39 -0700863 print " $parameter";
864 if ($count != $#{$args{'parameterlist'}}) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 $count++;
866 print ",";
Randy Dunlap3c308792007-05-08 00:24:39 -0700867 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 print "\n";
869 }
870 print "};";
871 print " </programlisting>\n";
872 print "</refsynopsisdiv>\n";
873
874 print "<refsect1>\n";
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800875 print " <title>Constants</title>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 print " <variablelist>\n";
877 foreach $parameter (@{$args{'parameterlist'}}) {
878 my $parameter_name = $parameter;
879 $parameter_name =~ s/\[.*//;
880
881 print " <varlistentry>";
882 print " <term>$parameter</term>\n";
883 print " <listitem><para>\n";
884 output_highlight($args{'parameterdescs'}{$parameter_name});
885 print " </para></listitem>\n";
886 print " </varlistentry>\n";
887 }
888 print " </variablelist>\n";
889 print "</refsect1>\n";
890
891 output_section_xml(@_);
892
893 print "</refentry>\n\n";
894}
895
896# output typedef in XML DocBook
897sub output_typedef_xml(%) {
898 my %args = %{$_[0]};
899 my ($parameter, $section);
900 my $id;
901
Randy Dunlapb9d973282009-06-09 08:50:38 -0700902 $id = "API-typedef-" . $args{'typedef'};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 $id =~ s/[^A-Za-z0-9]/-/g;
904
Pavel Pisa5449bc92007-02-10 01:45:37 -0800905 print "<refentry id=\"$id\">\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700906 print "<refentryinfo>\n";
907 print " <title>LINUX</title>\n";
908 print " <productname>Kernel Hackers Manual</productname>\n";
909 print " <date>$man_date</date>\n";
910 print "</refentryinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 print "<refmeta>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700912 print " <refentrytitle><phrase>typedef " . $args{'typedef'} . "</phrase></refentrytitle>\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700913 print " <manvolnum>9</manvolnum>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 print "</refmeta>\n";
915 print "<refnamediv>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700916 print " <refname>typedef " . $args{'typedef'} . "</refname>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 print " <refpurpose>\n";
918 print " ";
919 output_highlight ($args{'purpose'});
920 print " </refpurpose>\n";
921 print "</refnamediv>\n";
922
923 print "<refsynopsisdiv>\n";
924 print " <title>Synopsis</title>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700925 print " <synopsis>typedef " . $args{'typedef'} . ";</synopsis>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 print "</refsynopsisdiv>\n";
927
928 output_section_xml(@_);
929
930 print "</refentry>\n\n";
931}
932
933# output in XML DocBook
Johannes Bergb112e0f2007-10-24 15:08:48 -0700934sub output_blockhead_xml(%) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 my %args = %{$_[0]};
936 my ($parameter, $section);
937 my $count;
938
939 my $id = $args{'module'};
940 $id =~ s/[^A-Za-z0-9]/-/g;
941
942 # print out each section
943 $lineprefix=" ";
944 foreach $section (@{$args{'sectionlist'}}) {
Johannes Bergb112e0f2007-10-24 15:08:48 -0700945 if (!$args{'content-only'}) {
946 print "<refsect1>\n <title>$section</title>\n";
947 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 if ($section =~ m/EXAMPLE/i) {
949 print "<example><para>\n";
Johannes Bergb112e0f2007-10-24 15:08:48 -0700950 } else {
951 print "<para>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 }
953 output_highlight($args{'sections'}{$section});
954 if ($section =~ m/EXAMPLE/i) {
955 print "</para></example>\n";
Johannes Bergb112e0f2007-10-24 15:08:48 -0700956 } else {
957 print "</para>";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 }
Johannes Bergb112e0f2007-10-24 15:08:48 -0700959 if (!$args{'content-only'}) {
960 print "\n</refsect1>\n";
961 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 }
963
964 print "\n\n";
965}
966
967# output in XML DocBook
968sub output_function_gnome {
969 my %args = %{$_[0]};
970 my ($parameter, $section);
971 my $count;
972 my $id;
973
Randy Dunlapb9d973282009-06-09 08:50:38 -0700974 $id = $args{'module'} . "-" . $args{'function'};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975 $id =~ s/[^A-Za-z0-9]/-/g;
976
977 print "<sect2>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700978 print " <title id=\"$id\">" . $args{'function'} . "</title>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979
980 print " <funcsynopsis>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700981 print " <funcdef>" . $args{'functiontype'} . " ";
982 print "<function>" . $args{'function'} . " ";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 print "</function></funcdef>\n";
984
985 $count = 0;
986 if ($#{$args{'parameterlist'}} >= 0) {
987 foreach $parameter (@{$args{'parameterlist'}}) {
988 $type = $args{'parametertypes'}{$parameter};
989 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
990 # pointer-to-function
991 print " <paramdef>$1 <parameter>$parameter</parameter>)\n";
992 print " <funcparams>$2</funcparams></paramdef>\n";
993 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -0700994 print " <paramdef>" . $type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995 print " <parameter>$parameter</parameter></paramdef>\n";
996 }
997 }
998 } else {
999 print " <void>\n";
1000 }
1001 print " </funcsynopsis>\n";
1002 if ($#{$args{'parameterlist'}} >= 0) {
1003 print " <informaltable pgwide=\"1\" frame=\"none\" role=\"params\">\n";
1004 print "<tgroup cols=\"2\">\n";
1005 print "<colspec colwidth=\"2*\">\n";
1006 print "<colspec colwidth=\"8*\">\n";
1007 print "<tbody>\n";
1008 foreach $parameter (@{$args{'parameterlist'}}) {
1009 my $parameter_name = $parameter;
1010 $parameter_name =~ s/\[.*//;
1011
1012 print " <row><entry align=\"right\"><parameter>$parameter</parameter></entry>\n";
1013 print " <entry>\n";
1014 $lineprefix=" ";
1015 output_highlight($args{'parameterdescs'}{$parameter_name});
1016 print " </entry></row>\n";
1017 }
1018 print " </tbody></tgroup></informaltable>\n";
1019 } else {
1020 print " <para>\n None\n </para>\n";
1021 }
1022
1023 # print out each section
1024 $lineprefix=" ";
1025 foreach $section (@{$args{'sectionlist'}}) {
1026 print "<simplesect>\n <title>$section</title>\n";
1027 if ($section =~ m/EXAMPLE/i) {
1028 print "<example><programlisting>\n";
1029 } else {
1030 }
1031 print "<para>\n";
1032 output_highlight($args{'sections'}{$section});
1033 print "</para>\n";
1034 if ($section =~ m/EXAMPLE/i) {
1035 print "</programlisting></example>\n";
1036 } else {
1037 }
1038 print " </simplesect>\n";
1039 }
1040
1041 print "</sect2>\n\n";
1042}
1043
1044##
1045# output function in man
1046sub output_function_man(%) {
1047 my %args = %{$_[0]};
1048 my ($parameter, $section);
1049 my $count;
1050
1051 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
1052
1053 print ".SH NAME\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -07001054 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055
1056 print ".SH SYNOPSIS\n";
Randy Dunlapa21217d2007-02-10 01:46:04 -08001057 if ($args{'functiontype'} ne "") {
Randy Dunlapb9d973282009-06-09 08:50:38 -07001058 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
Randy Dunlapa21217d2007-02-10 01:46:04 -08001059 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -07001060 print ".B \"" . $args{'function'} . "\n";
Randy Dunlapa21217d2007-02-10 01:46:04 -08001061 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 $count = 0;
1063 my $parenth = "(";
1064 my $post = ",";
1065 foreach my $parameter (@{$args{'parameterlist'}}) {
1066 if ($count == $#{$args{'parameterlist'}}) {
1067 $post = ");";
1068 }
1069 $type = $args{'parametertypes'}{$parameter};
1070 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1071 # pointer-to-function
Randy Dunlapb9d973282009-06-09 08:50:38 -07001072 print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 } else {
1074 $type =~ s/([^\*])$/$1 /;
Randy Dunlapb9d973282009-06-09 08:50:38 -07001075 print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 }
1077 $count++;
1078 $parenth = "";
1079 }
1080
1081 print ".SH ARGUMENTS\n";
1082 foreach $parameter (@{$args{'parameterlist'}}) {
1083 my $parameter_name = $parameter;
1084 $parameter_name =~ s/\[.*//;
1085
Randy Dunlapb9d973282009-06-09 08:50:38 -07001086 print ".IP \"" . $parameter . "\" 12\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 output_highlight($args{'parameterdescs'}{$parameter_name});
1088 }
1089 foreach $section (@{$args{'sectionlist'}}) {
1090 print ".SH \"", uc $section, "\"\n";
1091 output_highlight($args{'sections'}{$section});
1092 }
1093}
1094
1095##
1096# output enum in man
1097sub output_enum_man(%) {
1098 my %args = %{$_[0]};
1099 my ($parameter, $section);
1100 my $count;
1101
1102 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
1103
1104 print ".SH NAME\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -07001105 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106
1107 print ".SH SYNOPSIS\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -07001108 print "enum " . $args{'enum'} . " {\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 $count = 0;
1110 foreach my $parameter (@{$args{'parameterlist'}}) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001111 print ".br\n.BI \" $parameter\"\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 if ($count == $#{$args{'parameterlist'}}) {
1113 print "\n};\n";
1114 last;
1115 }
1116 else {
1117 print ", \n.br\n";
1118 }
1119 $count++;
1120 }
1121
1122 print ".SH Constants\n";
1123 foreach $parameter (@{$args{'parameterlist'}}) {
1124 my $parameter_name = $parameter;
1125 $parameter_name =~ s/\[.*//;
1126
Randy Dunlapb9d973282009-06-09 08:50:38 -07001127 print ".IP \"" . $parameter . "\" 12\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 output_highlight($args{'parameterdescs'}{$parameter_name});
1129 }
1130 foreach $section (@{$args{'sectionlist'}}) {
1131 print ".SH \"$section\"\n";
1132 output_highlight($args{'sections'}{$section});
1133 }
1134}
1135
1136##
1137# output struct in man
1138sub output_struct_man(%) {
1139 my %args = %{$_[0]};
1140 my ($parameter, $section);
1141
Randy Dunlapb9d973282009-06-09 08:50:38 -07001142 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143
1144 print ".SH NAME\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -07001145 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146
1147 print ".SH SYNOPSIS\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -07001148 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149
1150 foreach my $parameter (@{$args{'parameterlist'}}) {
1151 if ($parameter =~ /^#/) {
1152 print ".BI \"$parameter\"\n.br\n";
1153 next;
1154 }
1155 my $parameter_name = $parameter;
1156 $parameter_name =~ s/\[.*//;
1157
Randy Dunlap3c308792007-05-08 00:24:39 -07001158 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 $type = $args{'parametertypes'}{$parameter};
1160 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1161 # pointer-to-function
Randy Dunlapb9d973282009-06-09 08:50:38 -07001162 print ".BI \" " . $1 . "\" " . $parameter . " \") (" . $2 . ")" . "\"\n;\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
Randy.Dunlap1d7e1d42006-07-01 04:36:34 -07001164 # bitfield
Randy Dunlapb9d973282009-06-09 08:50:38 -07001165 print ".BI \" " . $1 . "\ \" " . $parameter . $2 . " \"" . "\"\n;\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 } else {
1167 $type =~ s/([^\*])$/$1 /;
Randy Dunlapb9d973282009-06-09 08:50:38 -07001168 print ".BI \" " . $type . "\" " . $parameter . " \"" . "\"\n;\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169 }
1170 print "\n.br\n";
1171 }
1172 print "};\n.br\n";
1173
Randy Dunlapc51d3da2006-06-25 05:49:14 -07001174 print ".SH Members\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 foreach $parameter (@{$args{'parameterlist'}}) {
1176 ($parameter =~ /^#/) && next;
1177
1178 my $parameter_name = $parameter;
1179 $parameter_name =~ s/\[.*//;
1180
Randy Dunlap3c308792007-05-08 00:24:39 -07001181 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Randy Dunlapb9d973282009-06-09 08:50:38 -07001182 print ".IP \"" . $parameter . "\" 12\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 output_highlight($args{'parameterdescs'}{$parameter_name});
1184 }
1185 foreach $section (@{$args{'sectionlist'}}) {
1186 print ".SH \"$section\"\n";
1187 output_highlight($args{'sections'}{$section});
1188 }
1189}
1190
1191##
1192# output typedef in man
1193sub output_typedef_man(%) {
1194 my %args = %{$_[0]};
1195 my ($parameter, $section);
1196
1197 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
1198
1199 print ".SH NAME\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -07001200 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201
1202 foreach $section (@{$args{'sectionlist'}}) {
1203 print ".SH \"$section\"\n";
1204 output_highlight($args{'sections'}{$section});
1205 }
1206}
1207
Johannes Bergb112e0f2007-10-24 15:08:48 -07001208sub output_blockhead_man(%) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 my %args = %{$_[0]};
1210 my ($parameter, $section);
1211 my $count;
1212
1213 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
1214
1215 foreach $section (@{$args{'sectionlist'}}) {
1216 print ".SH \"$section\"\n";
1217 output_highlight($args{'sections'}{$section});
1218 }
1219}
1220
1221##
1222# output in text
1223sub output_function_text(%) {
1224 my %args = %{$_[0]};
1225 my ($parameter, $section);
Randy Dunlapa21217d2007-02-10 01:46:04 -08001226 my $start;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227
Randy Dunlapf47634b2006-07-01 04:36:36 -07001228 print "Name:\n\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -07001229 print $args{'function'} . " - " . $args{'purpose'} . "\n";
Randy Dunlapf47634b2006-07-01 04:36:36 -07001230
1231 print "\nSynopsis:\n\n";
Randy Dunlapa21217d2007-02-10 01:46:04 -08001232 if ($args{'functiontype'} ne "") {
Randy Dunlapb9d973282009-06-09 08:50:38 -07001233 $start = $args{'functiontype'} . " " . $args{'function'} . " (";
Randy Dunlapa21217d2007-02-10 01:46:04 -08001234 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -07001235 $start = $args{'function'} . " (";
Randy Dunlapa21217d2007-02-10 01:46:04 -08001236 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 print $start;
Randy Dunlapa21217d2007-02-10 01:46:04 -08001238
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239 my $count = 0;
1240 foreach my $parameter (@{$args{'parameterlist'}}) {
1241 $type = $args{'parametertypes'}{$parameter};
1242 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1243 # pointer-to-function
Randy Dunlapb9d973282009-06-09 08:50:38 -07001244 print $1 . $parameter . ") (" . $2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -07001246 print $type . " " . $parameter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 }
1248 if ($count != $#{$args{'parameterlist'}}) {
1249 $count++;
1250 print ",\n";
1251 print " " x length($start);
1252 } else {
1253 print ");\n\n";
1254 }
1255 }
1256
1257 print "Arguments:\n\n";
1258 foreach $parameter (@{$args{'parameterlist'}}) {
1259 my $parameter_name = $parameter;
1260 $parameter_name =~ s/\[.*//;
1261
Randy Dunlapb9d973282009-06-09 08:50:38 -07001262 print $parameter . "\n\t" . $args{'parameterdescs'}{$parameter_name} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 }
1264 output_section_text(@_);
1265}
1266
1267#output sections in text
1268sub output_section_text(%) {
1269 my %args = %{$_[0]};
1270 my $section;
1271
1272 print "\n";
1273 foreach $section (@{$args{'sectionlist'}}) {
1274 print "$section:\n\n";
1275 output_highlight($args{'sections'}{$section});
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001276 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 print "\n\n";
1278}
1279
1280# output enum in text
1281sub output_enum_text(%) {
1282 my %args = %{$_[0]};
1283 my ($parameter);
1284 my $count;
1285 print "Enum:\n\n";
1286
Randy Dunlapb9d973282009-06-09 08:50:38 -07001287 print "enum " . $args{'enum'} . " - " . $args{'purpose'} . "\n\n";
1288 print "enum " . $args{'enum'} . " {\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 $count = 0;
1290 foreach $parameter (@{$args{'parameterlist'}}) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001291 print "\t$parameter";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292 if ($count != $#{$args{'parameterlist'}}) {
1293 $count++;
1294 print ",";
1295 }
1296 print "\n";
1297 }
1298 print "};\n\n";
1299
1300 print "Constants:\n\n";
1301 foreach $parameter (@{$args{'parameterlist'}}) {
1302 print "$parameter\n\t";
Randy Dunlapb9d973282009-06-09 08:50:38 -07001303 print $args{'parameterdescs'}{$parameter} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 }
1305
1306 output_section_text(@_);
1307}
1308
1309# output typedef in text
1310sub output_typedef_text(%) {
1311 my %args = %{$_[0]};
1312 my ($parameter);
1313 my $count;
1314 print "Typedef:\n\n";
1315
Randy Dunlapb9d973282009-06-09 08:50:38 -07001316 print "typedef " . $args{'typedef'} . " - " . $args{'purpose'} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 output_section_text(@_);
1318}
1319
1320# output struct as text
1321sub output_struct_text(%) {
1322 my %args = %{$_[0]};
1323 my ($parameter);
1324
Randy Dunlapb9d973282009-06-09 08:50:38 -07001325 print $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "\n\n";
1326 print $args{'type'} . " " . $args{'struct'} . " {\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 foreach $parameter (@{$args{'parameterlist'}}) {
1328 if ($parameter =~ /^#/) {
1329 print "$parameter\n";
1330 next;
1331 }
1332
1333 my $parameter_name = $parameter;
1334 $parameter_name =~ s/\[.*//;
1335
Randy Dunlap3c308792007-05-08 00:24:39 -07001336 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337 $type = $args{'parametertypes'}{$parameter};
1338 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1339 # pointer-to-function
1340 print "\t$1 $parameter) ($2);\n";
1341 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
Randy Dunlap51f5a0c2007-07-19 01:48:24 -07001342 # bitfield
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 print "\t$1 $parameter$2;\n";
1344 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -07001345 print "\t" . $type . " " . $parameter . ";\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 }
1347 }
1348 print "};\n\n";
1349
1350 print "Members:\n\n";
1351 foreach $parameter (@{$args{'parameterlist'}}) {
1352 ($parameter =~ /^#/) && next;
1353
1354 my $parameter_name = $parameter;
1355 $parameter_name =~ s/\[.*//;
1356
Randy Dunlap3c308792007-05-08 00:24:39 -07001357 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 print "$parameter\n\t";
Randy Dunlapb9d973282009-06-09 08:50:38 -07001359 print $args{'parameterdescs'}{$parameter_name} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 }
1361 print "\n";
1362 output_section_text(@_);
1363}
1364
Johannes Bergb112e0f2007-10-24 15:08:48 -07001365sub output_blockhead_text(%) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 my %args = %{$_[0]};
1367 my ($parameter, $section);
1368
1369 foreach $section (@{$args{'sectionlist'}}) {
1370 print " $section:\n";
1371 print " -> ";
1372 output_highlight($args{'sections'}{$section});
1373 }
1374}
1375
Johannes Bergeda603f2010-09-11 15:55:22 -07001376## list mode output functions
1377
1378sub output_function_list(%) {
1379 my %args = %{$_[0]};
1380
1381 print $args{'function'} . "\n";
1382}
1383
1384# output enum in list
1385sub output_enum_list(%) {
1386 my %args = %{$_[0]};
1387 print $args{'enum'} . "\n";
1388}
1389
1390# output typedef in list
1391sub output_typedef_list(%) {
1392 my %args = %{$_[0]};
1393 print $args{'typedef'} . "\n";
1394}
1395
1396# output struct as list
1397sub output_struct_list(%) {
1398 my %args = %{$_[0]};
1399
1400 print $args{'struct'} . "\n";
1401}
1402
1403sub output_blockhead_list(%) {
1404 my %args = %{$_[0]};
1405 my ($parameter, $section);
1406
1407 foreach $section (@{$args{'sectionlist'}}) {
1408 print "DOC: $section\n";
1409 }
1410}
1411
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412##
Randy Dunlap27205742006-10-11 01:22:12 -07001413# generic output function for all types (function, struct/union, typedef, enum);
1414# calls the generated, variable output_ function name based on
1415# functype and output_mode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416sub output_declaration {
1417 no strict 'refs';
1418 my $name = shift;
1419 my $functype = shift;
1420 my $func = "output_${functype}_$output_mode";
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001421 if (($function_only==0) ||
1422 ( $function_only == 1 && defined($function_table{$name})) ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 ( $function_only == 2 && !defined($function_table{$name})))
1424 {
Randy Dunlap3c308792007-05-08 00:24:39 -07001425 &$func(@_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 $section_counter++;
1427 }
1428}
1429
1430##
Randy Dunlap27205742006-10-11 01:22:12 -07001431# generic output function - calls the right one based on current output mode.
Johannes Bergb112e0f2007-10-24 15:08:48 -07001432sub output_blockhead {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 no strict 'refs';
Randy Dunlapb9d973282009-06-09 08:50:38 -07001434 my $func = "output_blockhead_" . $output_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435 &$func(@_);
1436 $section_counter++;
1437}
1438
1439##
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001440# takes a declaration (struct, union, enum, typedef) and
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441# invokes the right handler. NOT called for functions.
1442sub dump_declaration($$) {
1443 no strict 'refs';
1444 my ($prototype, $file) = @_;
Randy Dunlapb9d973282009-06-09 08:50:38 -07001445 my $func = "dump_" . $decl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 &$func(@_);
1447}
1448
1449sub dump_union($$) {
1450 dump_struct(@_);
1451}
1452
1453sub dump_struct($$) {
1454 my $x = shift;
1455 my $file = shift;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001456 my $nested;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457
Randy Dunlap52dc5ae2009-04-30 15:08:53 -07001458 if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) {
1459 #my $decl_type = $1;
Randy Dunlap3c308792007-05-08 00:24:39 -07001460 $declaration_name = $2;
1461 my $members = $3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462
1463 # ignore embedded structs or unions
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001464 $members =~ s/({.*})//g;
1465 $nested = $1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466
Martin Waitzaeec46b2005-11-13 16:08:13 -08001467 # ignore members marked private:
Randy Dunlap52dc5ae2009-04-30 15:08:53 -07001468 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gos;
1469 $members =~ s/\/\*\s*private:.*//gos;
Martin Waitzaeec46b2005-11-13 16:08:13 -08001470 # strip comments:
1471 $members =~ s/\/\*.*?\*\///gos;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001472 $nested =~ s/\/\*.*?\*\///gos;
Randy Dunlapd960eea2009-06-29 14:54:11 -07001473 # strip kmemcheck_bitfield_{begin,end}.*;
1474 $members =~ s/kmemcheck_bitfield_.*?;//gos;
Randy Dunlapef5da592010-03-23 13:35:14 -07001475 # strip attributes
1476 $members =~ s/__aligned\s*\(\d+\)//gos;
Martin Waitzaeec46b2005-11-13 16:08:13 -08001477
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478 create_parameterlist($members, ';', $file);
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001479 check_sections($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480
1481 output_declaration($declaration_name,
1482 'struct',
1483 {'struct' => $declaration_name,
1484 'module' => $modulename,
1485 'parameterlist' => \@parameterlist,
1486 'parameterdescs' => \%parameterdescs,
1487 'parametertypes' => \%parametertypes,
1488 'sectionlist' => \@sectionlist,
1489 'sections' => \%sections,
1490 'purpose' => $declaration_purpose,
1491 'type' => $decl_type
1492 });
1493 }
1494 else {
Randy Dunlap3c308792007-05-08 00:24:39 -07001495 print STDERR "Error(${file}:$.): Cannot parse struct or union!\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 ++$errors;
1497 }
1498}
1499
1500sub dump_enum($$) {
1501 my $x = shift;
1502 my $file = shift;
1503
Martin Waitzaeec46b2005-11-13 16:08:13 -08001504 $x =~ s@/\*.*?\*/@@gos; # strip comments.
Randy Dunlapb6d676d2010-08-10 18:02:50 -07001505 $x =~ s/^#\s*define\s+.*$//; # strip #define macros inside enums
1506
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001508 $declaration_name = $1;
1509 my $members = $2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510
1511 foreach my $arg (split ',', $members) {
1512 $arg =~ s/^\s*(\w+).*/$1/;
1513 push @parameterlist, $arg;
1514 if (!$parameterdescs{$arg}) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001515 $parameterdescs{$arg} = $undescribed;
1516 print STDERR "Warning(${file}:$.): Enum value '$arg' ".
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517 "not described in enum '$declaration_name'\n";
1518 }
1519
1520 }
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001521
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 output_declaration($declaration_name,
1523 'enum',
1524 {'enum' => $declaration_name,
1525 'module' => $modulename,
1526 'parameterlist' => \@parameterlist,
1527 'parameterdescs' => \%parameterdescs,
1528 'sectionlist' => \@sectionlist,
1529 'sections' => \%sections,
1530 'purpose' => $declaration_purpose
1531 });
1532 }
1533 else {
Randy Dunlap3c308792007-05-08 00:24:39 -07001534 print STDERR "Error(${file}:$.): Cannot parse enum!\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 ++$errors;
1536 }
1537}
1538
1539sub dump_typedef($$) {
1540 my $x = shift;
1541 my $file = shift;
1542
Martin Waitzaeec46b2005-11-13 16:08:13 -08001543 $x =~ s@/\*.*?\*/@@gos; # strip comments.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001545 $x =~ s/\(*.\)\s*;$/;/;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546 $x =~ s/\[*.\]\s*;$/;/;
1547 }
1548
1549 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001550 $declaration_name = $1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551
1552 output_declaration($declaration_name,
1553 'typedef',
1554 {'typedef' => $declaration_name,
1555 'module' => $modulename,
1556 'sectionlist' => \@sectionlist,
1557 'sections' => \%sections,
1558 'purpose' => $declaration_purpose
1559 });
1560 }
1561 else {
Randy Dunlap3c308792007-05-08 00:24:39 -07001562 print STDERR "Error(${file}:$.): Cannot parse typedef!\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563 ++$errors;
1564 }
1565}
1566
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001567sub save_struct_actual($) {
1568 my $actual = shift;
1569
1570 # strip all spaces from the actual param so that it looks like one string item
1571 $actual =~ s/\s*//g;
1572 $struct_actual = $struct_actual . $actual . " ";
1573}
1574
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575sub create_parameterlist($$$) {
1576 my $args = shift;
1577 my $splitter = shift;
1578 my $file = shift;
1579 my $type;
1580 my $param;
1581
Martin Waitza6d3fe72006-01-09 20:53:55 -08001582 # temporarily replace commas inside function pointer definition
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583 while ($args =~ /(\([^\),]+),/) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001584 $args =~ s/(\([^\),]+),/$1#/g;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585 }
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001586
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 foreach my $arg (split($splitter, $args)) {
1588 # strip comments
1589 $arg =~ s/\/\*.*\*\///;
Randy Dunlap3c308792007-05-08 00:24:39 -07001590 # strip leading/trailing spaces
1591 $arg =~ s/^\s*//;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592 $arg =~ s/\s*$//;
1593 $arg =~ s/\s+/ /;
1594
1595 if ($arg =~ /^#/) {
1596 # Treat preprocessor directive as a typeless variable just to fill
1597 # corresponding data structures "correctly". Catch it later in
1598 # output_* subs.
1599 push_parameter($arg, "", $file);
Richard Kennedy00d62962008-02-23 15:24:01 -08001600 } elsif ($arg =~ m/\(.+\)\s*\(/) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 # pointer-to-function
1602 $arg =~ tr/#/,/;
Richard Kennedy00d62962008-02-23 15:24:01 -08001603 $arg =~ m/[^\(]+\(\*?\s*(\w*)\s*\)/;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 $param = $1;
1605 $type = $arg;
Richard Kennedy00d62962008-02-23 15:24:01 -08001606 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001607 save_struct_actual($param);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 push_parameter($param, $type, $file);
Martin Waitzaeec46b2005-11-13 16:08:13 -08001609 } elsif ($arg) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 $arg =~ s/\s*:\s*/:/g;
1611 $arg =~ s/\s*\[/\[/g;
1612
1613 my @args = split('\s*,\s*', $arg);
1614 if ($args[0] =~ m/\*/) {
1615 $args[0] =~ s/(\*+)\s*/ $1/;
1616 }
Borislav Petkov884f2812007-05-08 00:29:05 -07001617
1618 my @first_arg;
1619 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1620 shift @args;
1621 push(@first_arg, split('\s+', $1));
1622 push(@first_arg, $2);
1623 } else {
1624 @first_arg = split('\s+', shift @args);
1625 }
1626
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627 unshift(@args, pop @first_arg);
1628 $type = join " ", @first_arg;
1629
1630 foreach $param (@args) {
1631 if ($param =~ m/^(\*+)\s*(.*)/) {
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001632 save_struct_actual($2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 push_parameter($2, "$type $1", $file);
1634 }
1635 elsif ($param =~ m/(.*?):(\d+)/) {
Randy Dunlap7b978872008-05-16 15:45:52 -07001636 if ($type ne "") { # skip unnamed bit-fields
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001637 save_struct_actual($1);
Randy Dunlap7b978872008-05-16 15:45:52 -07001638 push_parameter($1, "$type:$2", $file)
1639 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640 }
1641 else {
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001642 save_struct_actual($param);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 push_parameter($param, $type, $file);
1644 }
1645 }
1646 }
1647 }
1648}
1649
1650sub push_parameter($$$) {
1651 my $param = shift;
1652 my $type = shift;
1653 my $file = shift;
1654
Randy Dunlap5f8c7c92007-07-19 01:48:24 -07001655 if (($anon_struct_union == 1) && ($type eq "") &&
1656 ($param eq "}")) {
1657 return; # ignore the ending }; from anon. struct/union
1658 }
1659
1660 $anon_struct_union = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 my $param_name = $param;
1662 $param_name =~ s/\[.*//;
1663
Martin Waitza6d3fe72006-01-09 20:53:55 -08001664 if ($type eq "" && $param =~ /\.\.\.$/)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665 {
Randy Dunlapced69092008-12-01 13:14:03 -08001666 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1667 $parameterdescs{$param} = "variable arguments";
1668 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 }
1670 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1671 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672 $param="void";
1673 $parameterdescs{void} = "no arguments";
1674 }
Randy Dunlap134fe012006-12-22 01:10:50 -08001675 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1676 # handle unnamed (anonymous) union or struct:
1677 {
1678 $type = $param;
Randy Dunlap5f8c7c92007-07-19 01:48:24 -07001679 $param = "{unnamed_" . $param . "}";
Randy Dunlap134fe012006-12-22 01:10:50 -08001680 $parameterdescs{$param} = "anonymous\n";
Randy Dunlap5f8c7c92007-07-19 01:48:24 -07001681 $anon_struct_union = 1;
Randy Dunlap134fe012006-12-22 01:10:50 -08001682 }
1683
Martin Waitza6d3fe72006-01-09 20:53:55 -08001684 # warn if parameter has no description
Randy Dunlap134fe012006-12-22 01:10:50 -08001685 # (but ignore ones starting with # as these are not parameters
1686 # but inline preprocessor statements);
1687 # also ignore unnamed structs/unions;
Randy Dunlap5f8c7c92007-07-19 01:48:24 -07001688 if (!$anon_struct_union) {
Martin Waitza6d3fe72006-01-09 20:53:55 -08001689 if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) {
1690
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691 $parameterdescs{$param_name} = $undescribed;
1692
1693 if (($type eq 'function') || ($type eq 'enum')) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001694 print STDERR "Warning(${file}:$.): Function parameter ".
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695 "or member '$param' not " .
1696 "described in '$declaration_name'\n";
1697 }
Randy Dunlapb9d973282009-06-09 08:50:38 -07001698 print STDERR "Warning(${file}:$.):" .
Randy Dunlap3c308792007-05-08 00:24:39 -07001699 " No description found for parameter '$param'\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700 ++$warnings;
Randy Dunlap3c308792007-05-08 00:24:39 -07001701 }
1702 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703
Randy Dunlape34e7db2009-06-17 17:37:47 -07001704 # strip spaces from $param so that it is one continous string
1705 # on @parameterlist;
1706 # this fixes a problem where check_sections() cannot find
1707 # a parameter like "addr[6 + 2]" because it actually appears
1708 # as "addr[6", "+", "2]" on the parameter list;
1709 # but it's better to maintain the param string unchanged for output,
1710 # so just weaken the string compare in check_sections() to ignore
1711 # "[blah" in a parameter string;
1712 ###$param =~ s/\s*//g;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 push @parameterlist, $param;
1714 $parametertypes{$param} = $type;
1715}
1716
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001717sub check_sections($$$$$$) {
1718 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck, $nested) = @_;
1719 my @sects = split ' ', $sectcheck;
1720 my @prms = split ' ', $prmscheck;
1721 my $err;
1722 my ($px, $sx);
1723 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
1724
1725 foreach $sx (0 .. $#sects) {
1726 $err = 1;
1727 foreach $px (0 .. $#prms) {
1728 $prm_clean = $prms[$px];
1729 $prm_clean =~ s/\[.*\]//;
Johannes Berg1f3a6682010-09-11 15:55:12 -07001730 $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;
Randy Dunlape34e7db2009-06-17 17:37:47 -07001731 # ignore array size in a parameter string;
1732 # however, the original param string may contain
1733 # spaces, e.g.: addr[6 + 2]
1734 # and this appears in @prms as "addr[6" since the
1735 # parameter list is split at spaces;
1736 # hence just ignore "[..." for the sections check;
1737 $prm_clean =~ s/\[.*//;
1738
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001739 ##$prm_clean =~ s/^\**//;
1740 if ($prm_clean eq $sects[$sx]) {
1741 $err = 0;
1742 last;
1743 }
1744 }
1745 if ($err) {
1746 if ($decl_type eq "function") {
1747 print STDERR "Warning(${file}:$.): " .
1748 "Excess function parameter " .
1749 "'$sects[$sx]' " .
1750 "description in '$decl_name'\n";
1751 ++$warnings;
1752 } else {
1753 if ($nested !~ m/\Q$sects[$sx]\E/) {
1754 print STDERR "Warning(${file}:$.): " .
1755 "Excess struct/union/enum/typedef member " .
1756 "'$sects[$sx]' " .
1757 "description in '$decl_name'\n";
1758 ++$warnings;
1759 }
1760 }
1761 }
1762 }
1763}
1764
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765##
1766# takes a function prototype and the name of the current file being
1767# processed and spits out all the details stored in the global
1768# arrays/hashes.
1769sub dump_function($$) {
1770 my $prototype = shift;
1771 my $file = shift;
1772
1773 $prototype =~ s/^static +//;
1774 $prototype =~ s/^extern +//;
Pavel Pisa4dc3b162005-05-01 08:59:25 -07001775 $prototype =~ s/^asmlinkage +//;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776 $prototype =~ s/^inline +//;
1777 $prototype =~ s/^__inline__ +//;
Randy Dunlap32e79402006-10-11 01:22:10 -07001778 $prototype =~ s/^__inline +//;
1779 $prototype =~ s/^__always_inline +//;
1780 $prototype =~ s/^noinline +//;
Randy Dunlap0129a052006-07-30 03:03:41 -07001781 $prototype =~ s/__devinit +//;
Randy Dunlap74fc5c62008-06-19 16:03:29 -07001782 $prototype =~ s/__init +//;
Randy Dunlap20072202010-03-23 13:35:24 -07001783 $prototype =~ s/__init_or_module +//;
Randy Dunlap890c78c2008-10-25 17:06:43 -07001784 $prototype =~ s/^#\s*define\s+//; #ak added
Randy Dunlap328d2442007-02-28 20:12:10 -08001785 $prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786
1787 # Yes, this truly is vile. We are looking for:
1788 # 1. Return type (may be nothing if we're looking at a macro)
1789 # 2. Function name
1790 # 3. Function parameters.
1791 #
1792 # All the while we have to watch out for function pointer parameters
1793 # (which IIRC is what the two sections are for), C types (these
1794 # regexps don't even start to express all the possibilities), and
1795 # so on.
1796 #
1797 # If you mess with these regexps, it's a good idea to check that
1798 # the following functions' documentation still comes out right:
1799 # - parport_register_device (function pointer parameters)
1800 # - atomic_set (macro)
Martin Waitz9598f912006-02-01 03:06:55 -08001801 # - pci_match_device, __copy_to_user (long return type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802
1803 if ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1804 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1805 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1806 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
Randy Dunlap94b3e032008-02-07 00:13:26 -08001807 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1809 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1810 $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1811 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1812 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1813 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1814 $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1815 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
Martin Waitz9598f912006-02-01 03:06:55 -08001816 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1817 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
Randy Dunlap412ecd72007-02-10 22:47:33 -08001818 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1819 $prototype =~ m/^(\w+\s+\w+\s*\*\s*\w+\s*\*\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820 $return_type = $1;
1821 $declaration_name = $2;
1822 my $args = $3;
1823
1824 create_parameterlist($args, ',', $file);
1825 } else {
1826 print STDERR "Error(${file}:$.): cannot understand prototype: '$prototype'\n";
1827 ++$errors;
1828 return;
1829 }
1830
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001831 my $prms = join " ", @parameterlist;
1832 check_sections($file, $declaration_name, "function", $sectcheck, $prms, "");
1833
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001834 output_declaration($declaration_name,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835 'function',
1836 {'function' => $declaration_name,
1837 'module' => $modulename,
1838 'functiontype' => $return_type,
1839 'parameterlist' => \@parameterlist,
1840 'parameterdescs' => \%parameterdescs,
1841 'parametertypes' => \%parametertypes,
1842 'sectionlist' => \@sectionlist,
1843 'sections' => \%sections,
1844 'purpose' => $declaration_purpose
1845 });
1846}
1847
1848sub process_file($);
1849
1850# Read the file that maps relative names to absolute names for
1851# separate source and object directories and for shadow trees.
1852if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
1853 my ($relname, $absname);
1854 while(<SOURCE_MAP>) {
1855 chop();
1856 ($relname, $absname) = (split())[0..1];
1857 $relname =~ s:^/+::;
1858 $source_map{$relname} = $absname;
1859 }
1860 close(SOURCE_MAP);
1861}
1862
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863foreach (@ARGV) {
1864 chomp;
1865 process_file($_);
1866}
1867if ($verbose && $errors) {
1868 print STDERR "$errors errors\n";
1869}
1870if ($verbose && $warnings) {
1871 print STDERR "$warnings warnings\n";
1872}
1873
1874exit($errors);
1875
1876sub reset_state {
1877 $function = "";
1878 %constants = ();
1879 %parameterdescs = ();
1880 %parametertypes = ();
1881 @parameterlist = ();
1882 %sections = ();
1883 @sectionlist = ();
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001884 $sectcheck = "";
1885 $struct_actual = "";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886 $prototype = "";
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001887
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888 $state = 0;
1889}
1890
Jason Baron56afb0f2009-04-30 13:29:36 -04001891sub tracepoint_munge($) {
1892 my $file = shift;
1893 my $tracepointname = 0;
1894 my $tracepointargs = 0;
1895
Jason Baron3a9089f2009-12-01 12:18:49 -05001896 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
Jason Baron56afb0f2009-04-30 13:29:36 -04001897 $tracepointname = $1;
1898 }
Jason Baron3a9089f2009-12-01 12:18:49 -05001899 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1900 $tracepointname = $1;
1901 }
1902 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1903 $tracepointname = $2;
1904 }
1905 $tracepointname =~ s/^\s+//; #strip leading whitespace
1906 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
Jason Baron56afb0f2009-04-30 13:29:36 -04001907 $tracepointargs = $1;
1908 }
1909 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1910 print STDERR "Warning(${file}:$.): Unrecognized tracepoint format: \n".
1911 "$prototype\n";
1912 } else {
1913 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1914 }
1915}
1916
Randy Dunlapb4870bc2009-02-11 13:04:33 -08001917sub syscall_munge() {
1918 my $void = 0;
1919
1920 $prototype =~ s@[\r\n\t]+@ @gos; # strip newlines/CR's/tabs
1921## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1922 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1923 $void = 1;
1924## $prototype = "long sys_$1(void)";
1925 }
1926
1927 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1928 if ($prototype =~ m/long (sys_.*?),/) {
1929 $prototype =~ s/,/\(/;
1930 } elsif ($void) {
1931 $prototype =~ s/\)/\(void\)/;
1932 }
1933
1934 # now delete all of the odd-number commas in $prototype
1935 # so that arg types & arg names don't have a comma between them
1936 my $count = 0;
1937 my $len = length($prototype);
1938 if ($void) {
1939 $len = 0; # skip the for-loop
1940 }
1941 for (my $ix = 0; $ix < $len; $ix++) {
1942 if (substr($prototype, $ix, 1) eq ',') {
1943 $count++;
1944 if ($count % 2 == 1) {
1945 substr($prototype, $ix, 1) = ' ';
1946 }
1947 }
1948 }
1949}
1950
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001951sub process_state3_function($$) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 my $x = shift;
1953 my $file = shift;
1954
Randy Dunlap51f5a0c2007-07-19 01:48:24 -07001955 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1956
Randy Dunlap890c78c2008-10-25 17:06:43 -07001957 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958 # do nothing
1959 }
1960 elsif ($x =~ /([^\{]*)/) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001961 $prototype .= $1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962 }
Randy Dunlapb4870bc2009-02-11 13:04:33 -08001963
Randy Dunlap890c78c2008-10-25 17:06:43 -07001964 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001965 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1967 $prototype =~ s@^\s+@@gos; # strip leading spaces
Randy Dunlapb4870bc2009-02-11 13:04:33 -08001968 if ($prototype =~ /SYSCALL_DEFINE/) {
1969 syscall_munge();
1970 }
Jason Baron3a9089f2009-12-01 12:18:49 -05001971 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1972 $prototype =~ /DEFINE_SINGLE_EVENT/)
1973 {
Jason Baron56afb0f2009-04-30 13:29:36 -04001974 tracepoint_munge($file);
1975 }
Randy Dunlapb4870bc2009-02-11 13:04:33 -08001976 dump_function($prototype, $file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 reset_state();
1978 }
1979}
1980
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001981sub process_state3_type($$) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982 my $x = shift;
1983 my $file = shift;
1984
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1986 $x =~ s@^\s+@@gos; # strip leading spaces
1987 $x =~ s@\s+$@@gos; # strip trailing spaces
Randy Dunlap51f5a0c2007-07-19 01:48:24 -07001988 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1989
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990 if ($x =~ /^#/) {
1991 # To distinguish preprocessor directive from regular declaration later.
1992 $x .= ";";
1993 }
1994
1995 while (1) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001996 if ( $x =~ /([^{};]*)([{};])(.*)/ ) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997 $prototype .= $1 . $2;
1998 ($2 eq '{') && $brcount++;
1999 ($2 eq '}') && $brcount--;
2000 if (($2 eq ';') && ($brcount == 0)) {
Randy Dunlapb9d973282009-06-09 08:50:38 -07002001 dump_declaration($prototype, $file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002 reset_state();
Randy Dunlap3c308792007-05-08 00:24:39 -07002003 last;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004 }
2005 $x = $3;
Randy Dunlap3c308792007-05-08 00:24:39 -07002006 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007 $prototype .= $x;
2008 last;
2009 }
2010 }
2011}
2012
Randy Dunlap6b5b55f2007-10-16 23:31:20 -07002013# xml_escape: replace <, >, and & in the text stream;
2014#
2015# however, formatting controls that are generated internally/locally in the
2016# kernel-doc script are not escaped here; instead, they begin life like
2017# $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings
2018# are converted to their mnemonic-expected output, without the 4 * '\' & ':',
2019# just before actual output; (this is done by local_unescape())
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020sub xml_escape($) {
2021 my $text = shift;
Randy Dunlapecfb2512006-06-25 05:49:13 -07002022 if (($output_mode eq "text") || ($output_mode eq "man")) {
2023 return $text;
2024 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025 $text =~ s/\&/\\\\\\amp;/g;
2026 $text =~ s/\</\\\\\\lt;/g;
2027 $text =~ s/\>/\\\\\\gt;/g;
2028 return $text;
2029}
2030
Randy Dunlap6b5b55f2007-10-16 23:31:20 -07002031# convert local escape strings to html
2032# local escape strings look like: '\\\\menmonic:' (that's 4 backslashes)
2033sub local_unescape($) {
2034 my $text = shift;
2035 if (($output_mode eq "text") || ($output_mode eq "man")) {
2036 return $text;
2037 }
2038 $text =~ s/\\\\\\\\lt:/</g;
2039 $text =~ s/\\\\\\\\gt:/>/g;
2040 return $text;
2041}
2042
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043sub process_file($) {
Randy Dunlap2283a112005-07-07 15:39:26 -07002044 my $file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 my $identifier;
2046 my $func;
Randy Dunlapa21217d2007-02-10 01:46:04 -08002047 my $descr;
Johannes Weiner64231332009-09-17 19:26:53 -07002048 my $in_purpose = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049 my $initial_section_counter = $section_counter;
2050
Randy Dunlap2283a112005-07-07 15:39:26 -07002051 if (defined($ENV{'SRCTREE'})) {
2052 $file = "$ENV{'SRCTREE'}" . "/" . "@_";
2053 }
2054 else {
2055 $file = "@_";
2056 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057 if (defined($source_map{$file})) {
2058 $file = $source_map{$file};
2059 }
2060
2061 if (!open(IN,"<$file")) {
2062 print STDERR "Error: Cannot open file $file\n";
2063 ++$errors;
2064 return;
2065 }
2066
Ilya Dryomova9e73142010-02-26 13:05:47 -08002067 $. = 1;
2068
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069 $section_counter = 0;
2070 while (<IN>) {
2071 if ($state == 0) {
2072 if (/$doc_start/o) {
2073 $state = 1; # next line is always the function name
Randy Dunlap850622d2006-06-25 05:48:55 -07002074 $in_doc_sect = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075 }
2076 } elsif ($state == 1) { # this line is the function name (always)
2077 if (/$doc_block/o) {
2078 $state = 4;
2079 $contents = "";
2080 if ( $1 eq "" ) {
2081 $section = $section_intro;
2082 } else {
2083 $section = $1;
2084 }
Randy Dunlap3c308792007-05-08 00:24:39 -07002085 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 elsif (/$doc_decl/o) {
2087 $identifier = $1;
2088 if (/\s*([\w\s]+?)\s*-/) {
2089 $identifier = $1;
2090 }
2091
2092 $state = 2;
2093 if (/-(.*)/) {
Randy Dunlap51f5a0c2007-07-19 01:48:24 -07002094 # strip leading/trailing/multiple spaces
Randy Dunlapa21217d2007-02-10 01:46:04 -08002095 $descr= $1;
2096 $descr =~ s/^\s*//;
2097 $descr =~ s/\s*$//;
2098 $descr =~ s/\s+/ /;
2099 $declaration_purpose = xml_escape($descr);
Johannes Weiner64231332009-09-17 19:26:53 -07002100 $in_purpose = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 } else {
2102 $declaration_purpose = "";
2103 }
Randy Dunlap77cc23b2008-02-07 00:13:42 -08002104
2105 if (($declaration_purpose eq "") && $verbose) {
2106 print STDERR "Warning(${file}:$.): missing initial short description on line:\n";
2107 print STDERR $_;
2108 ++$warnings;
2109 }
2110
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 if ($identifier =~ m/^struct/) {
2112 $decl_type = 'struct';
2113 } elsif ($identifier =~ m/^union/) {
2114 $decl_type = 'union';
2115 } elsif ($identifier =~ m/^enum/) {
2116 $decl_type = 'enum';
2117 } elsif ($identifier =~ m/^typedef/) {
2118 $decl_type = 'typedef';
2119 } else {
2120 $decl_type = 'function';
2121 }
2122
2123 if ($verbose) {
2124 print STDERR "Info(${file}:$.): Scanning doc for $identifier\n";
2125 }
2126 } else {
2127 print STDERR "Warning(${file}:$.): Cannot understand $_ on line $.",
2128 " - I thought it was a doc line\n";
2129 ++$warnings;
2130 $state = 0;
2131 }
2132 } elsif ($state == 2) { # look for head: lines, and include content
2133 if (/$doc_sect/o) {
2134 $newsection = $1;
2135 $newcontents = $2;
2136
Randy Dunlap792aa2f2008-02-07 00:13:41 -08002137 if (($contents ne "") && ($contents ne "\n")) {
Randy Dunlap850622d2006-06-25 05:48:55 -07002138 if (!$in_doc_sect && $verbose) {
2139 print STDERR "Warning(${file}:$.): contents before sections\n";
2140 ++$warnings;
2141 }
Randy Dunlap94dc7ad2008-04-28 02:16:34 -07002142 dump_section($file, $section, xml_escape($contents));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 $section = $section_default;
2144 }
2145
Randy Dunlap850622d2006-06-25 05:48:55 -07002146 $in_doc_sect = 1;
Johannes Weiner64231332009-09-17 19:26:53 -07002147 $in_purpose = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148 $contents = $newcontents;
2149 if ($contents ne "") {
Randy Dunlap27205742006-10-11 01:22:12 -07002150 while ((substr($contents, 0, 1) eq " ") ||
2151 substr($contents, 0, 1) eq "\t") {
2152 $contents = substr($contents, 1);
Randy Dunlap05189492006-06-25 05:47:47 -07002153 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 $contents .= "\n";
2155 }
2156 $section = $newsection;
2157 } elsif (/$doc_end/) {
2158
Randy Dunlap4c98eca2010-03-10 15:22:02 -08002159 if (($contents ne "") && ($contents ne "\n")) {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -07002160 dump_section($file, $section, xml_escape($contents));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 $section = $section_default;
2162 $contents = "";
2163 }
Randy Dunlap46b958e2008-04-28 02:16:35 -07002164 # look for doc_com + <text> + doc_end:
2165 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2166 print STDERR "Warning(${file}:$.): suspicious ending line: $_";
2167 ++$warnings;
2168 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169
2170 $prototype = "";
2171 $state = 3;
2172 $brcount = 0;
Randy Dunlap232acbc2006-06-25 05:47:48 -07002173# print STDERR "end of doc comment, looking for prototype\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174 } elsif (/$doc_content/) {
2175 # miguel-style comment kludge, look for blank lines after
2176 # @parameter line to signify start of description
Johannes Weiner64231332009-09-17 19:26:53 -07002177 if ($1 eq "") {
2178 if ($section =~ m/^@/ || $section eq $section_context) {
2179 dump_section($file, $section, xml_escape($contents));
2180 $section = $section_default;
2181 $contents = "";
2182 } else {
2183 $contents .= "\n";
2184 }
2185 $in_purpose = 0;
2186 } elsif ($in_purpose == 1) {
2187 # Continued declaration purpose
2188 chomp($declaration_purpose);
2189 $declaration_purpose .= " " . xml_escape($1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -07002191 $contents .= $1 . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192 }
2193 } else {
2194 # i dont know - bad line? ignore.
Randy Dunlap3c3b8092006-02-01 03:06:58 -08002195 print STDERR "Warning(${file}:$.): bad line: $_";
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196 ++$warnings;
2197 }
Randy Dunlap232acbc2006-06-25 05:47:48 -07002198 } elsif ($state == 3) { # scanning for function '{' (end of prototype)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199 if ($decl_type eq 'function') {
Randy Dunlap3c308792007-05-08 00:24:39 -07002200 process_state3_function($_, $file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201 } else {
Randy Dunlap3c308792007-05-08 00:24:39 -07002202 process_state3_type($_, $file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203 }
2204 } elsif ($state == 4) {
2205 # Documentation block
Randy Dunlap3c308792007-05-08 00:24:39 -07002206 if (/$doc_block/) {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -07002207 dump_doc_section($file, $section, xml_escape($contents));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 $contents = "";
2209 $function = "";
2210 %constants = ();
2211 %parameterdescs = ();
2212 %parametertypes = ();
2213 @parameterlist = ();
2214 %sections = ();
2215 @sectionlist = ();
2216 $prototype = "";
2217 if ( $1 eq "" ) {
2218 $section = $section_intro;
2219 } else {
2220 $section = $1;
2221 }
Randy Dunlap3c308792007-05-08 00:24:39 -07002222 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 elsif (/$doc_end/)
2224 {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -07002225 dump_doc_section($file, $section, xml_escape($contents));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226 $contents = "";
2227 $function = "";
2228 %constants = ();
2229 %parameterdescs = ();
2230 %parametertypes = ();
2231 @parameterlist = ();
2232 %sections = ();
2233 @sectionlist = ();
2234 $prototype = "";
2235 $state = 0;
2236 }
2237 elsif (/$doc_content/)
2238 {
2239 if ( $1 eq "" )
2240 {
2241 $contents .= $blankline;
2242 }
2243 else
2244 {
2245 $contents .= $1 . "\n";
Randy Dunlap3c3b8092006-02-01 03:06:58 -08002246 }
Randy Dunlap3c308792007-05-08 00:24:39 -07002247 }
2248 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249 }
2250 if ($initial_section_counter == $section_counter) {
2251 print STDERR "Warning(${file}): no structured comments found\n";
2252 if ($output_mode eq "xml") {
2253 # The template wants at least one RefEntry here; make one.
2254 print "<refentry>\n";
2255 print " <refnamediv>\n";
2256 print " <refname>\n";
2257 print " ${file}\n";
2258 print " </refname>\n";
2259 print " <refpurpose>\n";
2260 print " Document generation inconsistency\n";
2261 print " </refpurpose>\n";
2262 print " </refnamediv>\n";
2263 print " <refsect1>\n";
2264 print " <title>\n";
2265 print " Oops\n";
2266 print " </title>\n";
2267 print " <warning>\n";
2268 print " <para>\n";
2269 print " The template for this document tried to insert\n";
2270 print " the structured comment from the file\n";
2271 print " <filename>${file}</filename> at this point,\n";
2272 print " but none was found.\n";
2273 print " This dummy section is inserted to allow\n";
2274 print " generation to continue.\n";
2275 print " </para>\n";
2276 print " </warning>\n";
2277 print " </refsect1>\n";
2278 print "</refentry>\n";
2279 }
2280 }
2281}