blob: 9f85012acf0d2fb749a4ded8bb962d514d524c03 [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 Dunlap2b35f4d2010-11-18 12:27:31 -08008## Copyright (C) 2005-2010 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
Randy Dunlap8484baa2011-01-05 16:28:43 -0800158## init lots of data
159
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160my $errors = 0;
161my $warnings = 0;
Randy Dunlap5f8c7c92007-07-19 01:48:24 -0700162my $anon_struct_union = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
164# match expressions used to find embedded type information
165my $type_constant = '\%([-_\w]+)';
166my $type_func = '(\w+)\(\)';
167my $type_param = '\@(\w+)';
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700168my $type_struct = '\&((struct\s*)*[_\w]+)';
Randy Dunlap6b5b55f2007-10-16 23:31:20 -0700169my $type_struct_xml = '\\&amp;((struct\s*)*[_\w]+)';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170my $type_env = '(\$\w+)';
171
172# Output conversion substitutions.
173# One for each output format
174
175# these work fairly well
176my %highlights_html = ( $type_constant, "<i>\$1</i>",
177 $type_func, "<b>\$1</b>",
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700178 $type_struct_xml, "<i>\$1</i>",
179 $type_env, "<b><i>\$1</i></b>",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 $type_param, "<tt><b>\$1</b></tt>" );
Randy Dunlap6b5b55f2007-10-16 23:31:20 -0700181my $local_lt = "\\\\\\\\lt:";
182my $local_gt = "\\\\\\\\gt:";
183my $blankline_html = $local_lt . "p" . $local_gt; # was "<p>"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
185# XML, docbook format
186my %highlights_xml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>",
187 $type_constant, "<constant>\$1</constant>",
188 $type_func, "<function>\$1</function>",
Johannes Berg5c98fc02007-10-24 15:08:48 -0700189 $type_struct_xml, "<structname>\$1</structname>",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 $type_env, "<envar>\$1</envar>",
191 $type_param, "<parameter>\$1</parameter>" );
Johannes Berg5c98fc02007-10-24 15:08:48 -0700192my $blankline_xml = $local_lt . "/para" . $local_gt . $local_lt . "para" . $local_gt . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
194# gnome, docbook format
195my %highlights_gnome = ( $type_constant, "<replaceable class=\"option\">\$1</replaceable>",
196 $type_func, "<function>\$1</function>",
197 $type_struct, "<structname>\$1</structname>",
198 $type_env, "<envar>\$1</envar>",
199 $type_param, "<parameter>\$1</parameter>" );
200my $blankline_gnome = "</para><para>\n";
201
202# these are pretty rough
203my %highlights_man = ( $type_constant, "\$1",
204 $type_func, "\\\\fB\$1\\\\fP",
205 $type_struct, "\\\\fI\$1\\\\fP",
206 $type_param, "\\\\fI\$1\\\\fP" );
207my $blankline_man = "";
208
209# text-mode
210my %highlights_text = ( $type_constant, "\$1",
211 $type_func, "\$1",
212 $type_struct, "\$1",
213 $type_param, "\$1" );
214my $blankline_text = "";
215
Johannes Bergeda603f2010-09-11 15:55:22 -0700216# list mode
217my %highlights_list = ( $type_constant, "\$1",
218 $type_func, "\$1",
219 $type_struct, "\$1",
220 $type_param, "\$1" );
221my $blankline_list = "";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223# read arguments
Randy Dunlapb9d973282009-06-09 08:50:38 -0700224if ($#ARGV == -1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 usage();
226}
227
Randy Dunlap8484baa2011-01-05 16:28:43 -0800228my $kernelversion;
229my $dohighlight = "";
230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231my $verbose = 0;
232my $output_mode = "man";
Johannes Berg4b445952007-10-24 15:08:48 -0700233my $no_doc_sections = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234my %highlights = %highlights_man;
235my $blankline = $blankline_man;
236my $modulename = "Kernel API";
237my $function_only = 0;
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800238my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
239 'July', 'August', 'September', 'October',
240 'November', 'December')[(localtime)[4]] .
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 " " . ((localtime)[5]+1900);
242
Randy Dunlap8484baa2011-01-05 16:28:43 -0800243# Essentially these are globals.
Randy Dunlapb9d973282009-06-09 08:50:38 -0700244# They probably want to be tidied up, made more localised or something.
245# CAVEAT EMPTOR! Some of the others I localised may not want to be, which
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246# could cause "use of undefined value" or other bugs.
Randy Dunlapb9d973282009-06-09 08:50:38 -0700247my ($function, %function_table, %parametertypes, $declaration_purpose);
248my ($type, $declaration_name, $return_type);
Ilya Dryomov1c32fd02010-02-26 13:06:03 -0800249my ($newsection, $newcontents, $prototype, $brcount, %source_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
Randy Dunlapbd0e88e2008-03-13 12:32:43 -0700251if (defined($ENV{'KBUILD_VERBOSE'})) {
252 $verbose = "$ENV{'KBUILD_VERBOSE'}";
253}
254
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800255# Generated docbook code is inserted in a template at a point where
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256# docbook v3.1 requires a non-zero sequence of RefEntry's; see:
257# http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
258# We keep track of number of generated entries and generate a dummy
259# if needs be to ensure the expanded template can be postprocessed
260# into html.
261my $section_counter = 0;
262
263my $lineprefix="";
264
265# states
266# 0 - normal code
267# 1 - looking for function name
268# 2 - scanning field start.
269# 3 - scanning prototype.
270# 4 - documentation block
271my $state;
Randy Dunlap850622d2006-06-25 05:48:55 -0700272my $in_doc_sect;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273
274#declaration types: can be
275# 'function', 'struct', 'union', 'enum', 'typedef'
276my $decl_type;
277
278my $doc_special = "\@\%\$\&";
279
280my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
281my $doc_end = '\*/';
282my $doc_com = '\s*\*\s*';
Randy Dunlapb9d973282009-06-09 08:50:38 -0700283my $doc_decl = $doc_com . '(\w+)';
284my $doc_sect = $doc_com . '([' . $doc_special . ']?[\w\s]+):(.*)';
285my $doc_content = $doc_com . '(.*)';
286my $doc_block = $doc_com . 'DOC:\s*(.*)?';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
288my %constants;
289my %parameterdescs;
290my @parameterlist;
291my %sections;
292my @sectionlist;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -0800293my $sectcheck;
294my $struct_actual;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
296my $contents = "";
297my $section_default = "Description"; # default section
298my $section_intro = "Introduction";
299my $section = $section_default;
300my $section_context = "Context";
301
302my $undescribed = "-- undescribed --";
303
304reset_state();
305
306while ($ARGV[0] =~ m/^-(.*)/) {
307 my $cmd = shift @ARGV;
308 if ($cmd eq "-html") {
309 $output_mode = "html";
310 %highlights = %highlights_html;
311 $blankline = $blankline_html;
312 } elsif ($cmd eq "-man") {
313 $output_mode = "man";
314 %highlights = %highlights_man;
315 $blankline = $blankline_man;
316 } elsif ($cmd eq "-text") {
317 $output_mode = "text";
318 %highlights = %highlights_text;
319 $blankline = $blankline_text;
320 } elsif ($cmd eq "-docbook") {
321 $output_mode = "xml";
322 %highlights = %highlights_xml;
323 $blankline = $blankline_xml;
Johannes Bergeda603f2010-09-11 15:55:22 -0700324 } elsif ($cmd eq "-list") {
325 $output_mode = "list";
326 %highlights = %highlights_list;
327 $blankline = $blankline_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 } elsif ($cmd eq "-gnome") {
329 $output_mode = "gnome";
330 %highlights = %highlights_gnome;
331 $blankline = $blankline_gnome;
332 } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document
333 $modulename = shift @ARGV;
334 } elsif ($cmd eq "-function") { # to only output specific functions
335 $function_only = 1;
336 $function = shift @ARGV;
337 $function_table{$function} = 1;
338 } elsif ($cmd eq "-nofunction") { # to only output specific functions
339 $function_only = 2;
340 $function = shift @ARGV;
341 $function_table{$function} = 1;
342 } elsif ($cmd eq "-v") {
343 $verbose = 1;
344 } elsif (($cmd eq "-h") || ($cmd eq "--help")) {
345 usage();
Johannes Berg4b445952007-10-24 15:08:48 -0700346 } elsif ($cmd eq '-no-doc-sections') {
347 $no_doc_sections = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 }
349}
350
Randy Dunlap8484baa2011-01-05 16:28:43 -0800351# continue execution near EOF;
352
353sub usage {
354 print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man | -list ]\n";
355 print " [ -no-doc-sections ]\n";
356 print " [ -function funcname [ -function funcname ...] ]\n";
357 print " [ -nofunction funcname [ -nofunction funcname ...] ]\n";
358 print " c source file(s) > outputfile\n";
359 print " -v : verbose output, more warnings & other info listed\n";
360 exit 1;
361}
362
Borislav Petkov53f049f2007-05-08 00:30:54 -0700363# get kernel version from env
364sub get_kernel_version() {
Johannes Berg1b9bc222007-10-24 15:08:48 -0700365 my $version = 'unknown kernel version';
Borislav Petkov53f049f2007-05-08 00:30:54 -0700366
367 if (defined($ENV{'KERNELVERSION'})) {
368 $version = $ENV{'KERNELVERSION'};
369 }
370 return $version;
371}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
373##
374# dumps section contents to arrays/hashes intended for that purpose.
375#
376sub dump_section {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -0700377 my $file = shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 my $name = shift;
379 my $contents = join "\n", @_;
380
381 if ($name =~ m/$type_constant/) {
382 $name = $1;
383# print STDERR "constant section '$1' = '$contents'\n";
384 $constants{$name} = $contents;
385 } elsif ($name =~ m/$type_param/) {
386# print STDERR "parameter def '$1' = '$contents'\n";
387 $name = $1;
388 $parameterdescs{$name} = $contents;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -0800389 $sectcheck = $sectcheck . $name . " ";
Randy Dunlapced69092008-12-01 13:14:03 -0800390 } elsif ($name eq "@\.\.\.") {
391# print STDERR "parameter def '...' = '$contents'\n";
392 $name = "...";
393 $parameterdescs{$name} = $contents;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -0800394 $sectcheck = $sectcheck . $name . " ";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 } else {
396# print STDERR "other section '$name' = '$contents'\n";
Randy Dunlap94dc7ad2008-04-28 02:16:34 -0700397 if (defined($sections{$name}) && ($sections{$name} ne "")) {
398 print STDERR "Error(${file}:$.): duplicate section name '$name'\n";
399 ++$errors;
400 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 $sections{$name} = $contents;
402 push @sectionlist, $name;
403 }
404}
405
406##
Johannes Bergb112e0f2007-10-24 15:08:48 -0700407# dump DOC: section after checking that it should go out
408#
409sub dump_doc_section {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -0700410 my $file = shift;
Johannes Bergb112e0f2007-10-24 15:08:48 -0700411 my $name = shift;
412 my $contents = join "\n", @_;
413
Johannes Berg4b445952007-10-24 15:08:48 -0700414 if ($no_doc_sections) {
415 return;
416 }
417
Johannes Bergb112e0f2007-10-24 15:08:48 -0700418 if (($function_only == 0) ||
419 ( $function_only == 1 && defined($function_table{$name})) ||
420 ( $function_only == 2 && !defined($function_table{$name})))
421 {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -0700422 dump_section($file, $name, $contents);
Johannes Bergb112e0f2007-10-24 15:08:48 -0700423 output_blockhead({'sectionlist' => \@sectionlist,
424 'sections' => \%sections,
425 'module' => $modulename,
426 'content-only' => ($function_only != 0), });
427 }
428}
429
430##
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431# output function
432#
433# parameterdescs, a hash.
434# function => "function name"
435# parameterlist => @list of parameters
436# parameterdescs => %parameter descriptions
437# sectionlist => @list of sections
Randy Dunlapa21217d2007-02-10 01:46:04 -0800438# sections => %section descriptions
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800439#
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440
441sub output_highlight {
442 my $contents = join "\n",@_;
443 my $line;
444
445# DEBUG
446# if (!defined $contents) {
447# use Carp;
448# confess "output_highlight got called with no args?\n";
449# }
450
Johannes Berg5c98fc02007-10-24 15:08:48 -0700451 if ($output_mode eq "html" || $output_mode eq "xml") {
Randy Dunlap6b5b55f2007-10-16 23:31:20 -0700452 $contents = local_unescape($contents);
453 # convert data read & converted thru xml_escape() into &xyz; format:
Randy Dunlap2b35f4d2010-11-18 12:27:31 -0800454 $contents =~ s/\\\\\\/\&/g;
Randy Dunlap6b5b55f2007-10-16 23:31:20 -0700455 }
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700456# print STDERR "contents b4:$contents\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 eval $dohighlight;
458 die $@ if $@;
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700459# print STDERR "contents af:$contents\n";
460
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 foreach $line (split "\n", $contents) {
Randy Dunlap3c308792007-05-08 00:24:39 -0700462 if ($line eq ""){
Randy Dunlap6b5b55f2007-10-16 23:31:20 -0700463 print $lineprefix, local_unescape($blankline);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 } else {
Randy Dunlap3c308792007-05-08 00:24:39 -0700465 $line =~ s/\\\\\\/\&/g;
Randy Dunlapcdccb312007-07-19 01:48:25 -0700466 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
467 print "\\&$line";
468 } else {
469 print $lineprefix, $line;
470 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 }
472 print "\n";
473 }
474}
475
476#output sections in html
477sub output_section_html(%) {
478 my %args = %{$_[0]};
479 my $section;
480
481 foreach $section (@{$args{'sectionlist'}}) {
482 print "<h3>$section</h3>\n";
483 print "<blockquote>\n";
484 output_highlight($args{'sections'}{$section});
485 print "</blockquote>\n";
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800486 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487}
488
489# output enum in html
490sub output_enum_html(%) {
491 my %args = %{$_[0]};
492 my ($parameter);
493 my $count;
Randy Dunlapb9d973282009-06-09 08:50:38 -0700494 print "<h2>enum " . $args{'enum'} . "</h2>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495
Randy Dunlapb9d973282009-06-09 08:50:38 -0700496 print "<b>enum " . $args{'enum'} . "</b> {<br>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 $count = 0;
498 foreach $parameter (@{$args{'parameterlist'}}) {
Randy Dunlapb9d973282009-06-09 08:50:38 -0700499 print " <b>" . $parameter . "</b>";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 if ($count != $#{$args{'parameterlist'}}) {
501 $count++;
502 print ",\n";
503 }
504 print "<br>";
505 }
506 print "};<br>\n";
507
508 print "<h3>Constants</h3>\n";
509 print "<dl>\n";
510 foreach $parameter (@{$args{'parameterlist'}}) {
Randy Dunlapb9d973282009-06-09 08:50:38 -0700511 print "<dt><b>" . $parameter . "</b>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 print "<dd>";
513 output_highlight($args{'parameterdescs'}{$parameter});
514 }
515 print "</dl>\n";
516 output_section_html(@_);
517 print "<hr>\n";
518}
519
Randy Dunlapd28bee02006-02-01 03:06:57 -0800520# output typedef in html
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521sub output_typedef_html(%) {
522 my %args = %{$_[0]};
523 my ($parameter);
524 my $count;
Randy Dunlapb9d973282009-06-09 08:50:38 -0700525 print "<h2>typedef " . $args{'typedef'} . "</h2>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526
Randy Dunlapb9d973282009-06-09 08:50:38 -0700527 print "<b>typedef " . $args{'typedef'} . "</b>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 output_section_html(@_);
529 print "<hr>\n";
530}
531
532# output struct in html
533sub output_struct_html(%) {
534 my %args = %{$_[0]};
535 my ($parameter);
536
Randy Dunlapb9d973282009-06-09 08:50:38 -0700537 print "<h2>" . $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "</h2>\n";
538 print "<b>" . $args{'type'} . " " . $args{'struct'} . "</b> {<br>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 foreach $parameter (@{$args{'parameterlist'}}) {
540 if ($parameter =~ /^#/) {
541 print "$parameter<br>\n";
542 next;
543 }
544 my $parameter_name = $parameter;
545 $parameter_name =~ s/\[.*//;
546
Randy Dunlap3c308792007-05-08 00:24:39 -0700547 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 $type = $args{'parametertypes'}{$parameter};
549 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
550 # pointer-to-function
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700551 print "&nbsp; &nbsp; <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700553 # bitfield
554 print "&nbsp; &nbsp; <i>$1</i> <b>$parameter</b>$2;<br>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 } else {
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700556 print "&nbsp; &nbsp; <i>$type</i> <b>$parameter</b>;<br>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 }
558 }
559 print "};<br>\n";
560
561 print "<h3>Members</h3>\n";
562 print "<dl>\n";
563 foreach $parameter (@{$args{'parameterlist'}}) {
564 ($parameter =~ /^#/) && next;
565
566 my $parameter_name = $parameter;
567 $parameter_name =~ s/\[.*//;
568
Randy Dunlap3c308792007-05-08 00:24:39 -0700569 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Randy Dunlapb9d973282009-06-09 08:50:38 -0700570 print "<dt><b>" . $parameter . "</b>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 print "<dd>";
572 output_highlight($args{'parameterdescs'}{$parameter_name});
573 }
574 print "</dl>\n";
575 output_section_html(@_);
576 print "<hr>\n";
577}
578
579# output function in html
580sub output_function_html(%) {
581 my %args = %{$_[0]};
582 my ($parameter, $section);
583 my $count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
Randy Dunlapb9d973282009-06-09 08:50:38 -0700585 print "<h2>" . $args{'function'} . " - " . $args{'purpose'} . "</h2>\n";
586 print "<i>" . $args{'functiontype'} . "</i>\n";
587 print "<b>" . $args{'function'} . "</b>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 print "(";
589 $count = 0;
590 foreach $parameter (@{$args{'parameterlist'}}) {
591 $type = $args{'parametertypes'}{$parameter};
592 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
593 # pointer-to-function
594 print "<i>$1</i><b>$parameter</b>) <i>($2)</i>";
595 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -0700596 print "<i>" . $type . "</i> <b>" . $parameter . "</b>";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 }
598 if ($count != $#{$args{'parameterlist'}}) {
599 $count++;
600 print ",\n";
601 }
602 }
603 print ")\n";
604
605 print "<h3>Arguments</h3>\n";
606 print "<dl>\n";
607 foreach $parameter (@{$args{'parameterlist'}}) {
608 my $parameter_name = $parameter;
609 $parameter_name =~ s/\[.*//;
610
Randy Dunlap3c308792007-05-08 00:24:39 -0700611 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Randy Dunlapb9d973282009-06-09 08:50:38 -0700612 print "<dt><b>" . $parameter . "</b>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 print "<dd>";
614 output_highlight($args{'parameterdescs'}{$parameter_name});
615 }
616 print "</dl>\n";
617 output_section_html(@_);
618 print "<hr>\n";
619}
620
Johannes Bergb112e0f2007-10-24 15:08:48 -0700621# output DOC: block header in html
622sub output_blockhead_html(%) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 my %args = %{$_[0]};
624 my ($parameter, $section);
625 my $count;
626
627 foreach $section (@{$args{'sectionlist'}}) {
628 print "<h3>$section</h3>\n";
629 print "<ul>\n";
630 output_highlight($args{'sections'}{$section});
631 print "</ul>\n";
632 }
633 print "<hr>\n";
634}
635
636sub output_section_xml(%) {
637 my %args = %{$_[0]};
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800638 my $section;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 # print out each section
640 $lineprefix=" ";
641 foreach $section (@{$args{'sectionlist'}}) {
Rich Walkerc73894c2005-05-01 08:59:26 -0700642 print "<refsect1>\n";
643 print "<title>$section</title>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 if ($section =~ m/EXAMPLE/i) {
Rich Walkerc73894c2005-05-01 08:59:26 -0700645 print "<informalexample><programlisting>\n";
646 } else {
647 print "<para>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 }
649 output_highlight($args{'sections'}{$section});
650 if ($section =~ m/EXAMPLE/i) {
Rich Walkerc73894c2005-05-01 08:59:26 -0700651 print "</programlisting></informalexample>\n";
652 } else {
653 print "</para>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 }
Rich Walkerc73894c2005-05-01 08:59:26 -0700655 print "</refsect1>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 }
657}
658
659# output function in XML DocBook
660sub output_function_xml(%) {
661 my %args = %{$_[0]};
662 my ($parameter, $section);
663 my $count;
664 my $id;
665
Randy Dunlapb9d973282009-06-09 08:50:38 -0700666 $id = "API-" . $args{'function'};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 $id =~ s/[^A-Za-z0-9]/-/g;
668
Pavel Pisa5449bc92007-02-10 01:45:37 -0800669 print "<refentry id=\"$id\">\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700670 print "<refentryinfo>\n";
671 print " <title>LINUX</title>\n";
672 print " <productname>Kernel Hackers Manual</productname>\n";
673 print " <date>$man_date</date>\n";
674 print "</refentryinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 print "<refmeta>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700676 print " <refentrytitle><phrase>" . $args{'function'} . "</phrase></refentrytitle>\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700677 print " <manvolnum>9</manvolnum>\n";
Borislav Petkov03662992007-05-09 02:33:43 -0700678 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 print "</refmeta>\n";
680 print "<refnamediv>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700681 print " <refname>" . $args{'function'} . "</refname>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 print " <refpurpose>\n";
683 print " ";
684 output_highlight ($args{'purpose'});
685 print " </refpurpose>\n";
686 print "</refnamediv>\n";
687
688 print "<refsynopsisdiv>\n";
689 print " <title>Synopsis</title>\n";
690 print " <funcsynopsis><funcprototype>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700691 print " <funcdef>" . $args{'functiontype'} . " ";
692 print "<function>" . $args{'function'} . " </function></funcdef>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
694 $count = 0;
695 if ($#{$args{'parameterlist'}} >= 0) {
696 foreach $parameter (@{$args{'parameterlist'}}) {
697 $type = $args{'parametertypes'}{$parameter};
698 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
699 # pointer-to-function
700 print " <paramdef>$1<parameter>$parameter</parameter>)\n";
701 print " <funcparams>$2</funcparams></paramdef>\n";
702 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -0700703 print " <paramdef>" . $type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 print " <parameter>$parameter</parameter></paramdef>\n";
705 }
706 }
707 } else {
Martin Waitz6013d542005-05-01 08:59:25 -0700708 print " <void/>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 }
710 print " </funcprototype></funcsynopsis>\n";
711 print "</refsynopsisdiv>\n";
712
713 # print parameters
714 print "<refsect1>\n <title>Arguments</title>\n";
715 if ($#{$args{'parameterlist'}} >= 0) {
716 print " <variablelist>\n";
717 foreach $parameter (@{$args{'parameterlist'}}) {
718 my $parameter_name = $parameter;
719 $parameter_name =~ s/\[.*//;
720
721 print " <varlistentry>\n <term><parameter>$parameter</parameter></term>\n";
722 print " <listitem>\n <para>\n";
723 $lineprefix=" ";
724 output_highlight($args{'parameterdescs'}{$parameter_name});
725 print " </para>\n </listitem>\n </varlistentry>\n";
726 }
727 print " </variablelist>\n";
728 } else {
729 print " <para>\n None\n </para>\n";
730 }
731 print "</refsect1>\n";
732
733 output_section_xml(@_);
734 print "</refentry>\n\n";
735}
736
737# output struct in XML DocBook
738sub output_struct_xml(%) {
739 my %args = %{$_[0]};
740 my ($parameter, $section);
741 my $id;
742
Randy Dunlapb9d973282009-06-09 08:50:38 -0700743 $id = "API-struct-" . $args{'struct'};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 $id =~ s/[^A-Za-z0-9]/-/g;
745
Pavel Pisa5449bc92007-02-10 01:45:37 -0800746 print "<refentry id=\"$id\">\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700747 print "<refentryinfo>\n";
748 print " <title>LINUX</title>\n";
749 print " <productname>Kernel Hackers Manual</productname>\n";
750 print " <date>$man_date</date>\n";
751 print "</refentryinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 print "<refmeta>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700753 print " <refentrytitle><phrase>" . $args{'type'} . " " . $args{'struct'} . "</phrase></refentrytitle>\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700754 print " <manvolnum>9</manvolnum>\n";
Borislav Petkov03662992007-05-09 02:33:43 -0700755 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 print "</refmeta>\n";
757 print "<refnamediv>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700758 print " <refname>" . $args{'type'} . " " . $args{'struct'} . "</refname>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 print " <refpurpose>\n";
760 print " ";
761 output_highlight ($args{'purpose'});
762 print " </refpurpose>\n";
763 print "</refnamediv>\n";
764
765 print "<refsynopsisdiv>\n";
766 print " <title>Synopsis</title>\n";
767 print " <programlisting>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700768 print $args{'type'} . " " . $args{'struct'} . " {\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 foreach $parameter (@{$args{'parameterlist'}}) {
770 if ($parameter =~ /^#/) {
Randy Dunlap2b35f4d2010-11-18 12:27:31 -0800771 my $prm = $parameter;
772 # convert data read & converted thru xml_escape() into &xyz; format:
773 # This allows us to have #define macros interspersed in a struct.
774 $prm =~ s/\\\\\\/\&/g;
775 print "$prm\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 next;
777 }
778
779 my $parameter_name = $parameter;
780 $parameter_name =~ s/\[.*//;
781
782 defined($args{'parameterdescs'}{$parameter_name}) || next;
Randy Dunlap3c308792007-05-08 00:24:39 -0700783 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 $type = $args{'parametertypes'}{$parameter};
785 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
786 # pointer-to-function
787 print " $1 $parameter) ($2);\n";
788 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
Randy Dunlap51f5a0c2007-07-19 01:48:24 -0700789 # bitfield
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 print " $1 $parameter$2;\n";
791 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -0700792 print " " . $type . " " . $parameter . ";\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 }
794 }
795 print "};";
796 print " </programlisting>\n";
797 print "</refsynopsisdiv>\n";
798
799 print " <refsect1>\n";
800 print " <title>Members</title>\n";
801
Randy Dunlap39f00c02008-09-22 13:57:44 -0700802 if ($#{$args{'parameterlist'}} >= 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 print " <variablelist>\n";
804 foreach $parameter (@{$args{'parameterlist'}}) {
805 ($parameter =~ /^#/) && next;
806
807 my $parameter_name = $parameter;
808 $parameter_name =~ s/\[.*//;
809
810 defined($args{'parameterdescs'}{$parameter_name}) || next;
811 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
812 print " <varlistentry>";
813 print " <term>$parameter</term>\n";
814 print " <listitem><para>\n";
815 output_highlight($args{'parameterdescs'}{$parameter_name});
816 print " </para></listitem>\n";
817 print " </varlistentry>\n";
818 }
819 print " </variablelist>\n";
Randy Dunlap39f00c02008-09-22 13:57:44 -0700820 } else {
821 print " <para>\n None\n </para>\n";
822 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 print " </refsect1>\n";
824
825 output_section_xml(@_);
826
827 print "</refentry>\n\n";
828}
829
830# output enum in XML DocBook
831sub output_enum_xml(%) {
832 my %args = %{$_[0]};
833 my ($parameter, $section);
834 my $count;
835 my $id;
836
Randy Dunlapb9d973282009-06-09 08:50:38 -0700837 $id = "API-enum-" . $args{'enum'};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 $id =~ s/[^A-Za-z0-9]/-/g;
839
Pavel Pisa5449bc92007-02-10 01:45:37 -0800840 print "<refentry id=\"$id\">\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700841 print "<refentryinfo>\n";
842 print " <title>LINUX</title>\n";
843 print " <productname>Kernel Hackers Manual</productname>\n";
844 print " <date>$man_date</date>\n";
845 print "</refentryinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 print "<refmeta>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700847 print " <refentrytitle><phrase>enum " . $args{'enum'} . "</phrase></refentrytitle>\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700848 print " <manvolnum>9</manvolnum>\n";
Borislav Petkov03662992007-05-09 02:33:43 -0700849 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 print "</refmeta>\n";
851 print "<refnamediv>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700852 print " <refname>enum " . $args{'enum'} . "</refname>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 print " <refpurpose>\n";
854 print " ";
855 output_highlight ($args{'purpose'});
856 print " </refpurpose>\n";
857 print "</refnamediv>\n";
858
859 print "<refsynopsisdiv>\n";
860 print " <title>Synopsis</title>\n";
861 print " <programlisting>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700862 print "enum " . $args{'enum'} . " {\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 $count = 0;
864 foreach $parameter (@{$args{'parameterlist'}}) {
Randy Dunlap3c308792007-05-08 00:24:39 -0700865 print " $parameter";
866 if ($count != $#{$args{'parameterlist'}}) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 $count++;
868 print ",";
Randy Dunlap3c308792007-05-08 00:24:39 -0700869 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 print "\n";
871 }
872 print "};";
873 print " </programlisting>\n";
874 print "</refsynopsisdiv>\n";
875
876 print "<refsect1>\n";
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800877 print " <title>Constants</title>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 print " <variablelist>\n";
879 foreach $parameter (@{$args{'parameterlist'}}) {
880 my $parameter_name = $parameter;
881 $parameter_name =~ s/\[.*//;
882
883 print " <varlistentry>";
884 print " <term>$parameter</term>\n";
885 print " <listitem><para>\n";
886 output_highlight($args{'parameterdescs'}{$parameter_name});
887 print " </para></listitem>\n";
888 print " </varlistentry>\n";
889 }
890 print " </variablelist>\n";
891 print "</refsect1>\n";
892
893 output_section_xml(@_);
894
895 print "</refentry>\n\n";
896}
897
898# output typedef in XML DocBook
899sub output_typedef_xml(%) {
900 my %args = %{$_[0]};
901 my ($parameter, $section);
902 my $id;
903
Randy Dunlapb9d973282009-06-09 08:50:38 -0700904 $id = "API-typedef-" . $args{'typedef'};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 $id =~ s/[^A-Za-z0-9]/-/g;
906
Pavel Pisa5449bc92007-02-10 01:45:37 -0800907 print "<refentry id=\"$id\">\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700908 print "<refentryinfo>\n";
909 print " <title>LINUX</title>\n";
910 print " <productname>Kernel Hackers Manual</productname>\n";
911 print " <date>$man_date</date>\n";
912 print "</refentryinfo>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 print "<refmeta>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700914 print " <refentrytitle><phrase>typedef " . $args{'typedef'} . "</phrase></refentrytitle>\n";
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700915 print " <manvolnum>9</manvolnum>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 print "</refmeta>\n";
917 print "<refnamediv>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700918 print " <refname>typedef " . $args{'typedef'} . "</refname>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 print " <refpurpose>\n";
920 print " ";
921 output_highlight ($args{'purpose'});
922 print " </refpurpose>\n";
923 print "</refnamediv>\n";
924
925 print "<refsynopsisdiv>\n";
926 print " <title>Synopsis</title>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700927 print " <synopsis>typedef " . $args{'typedef'} . ";</synopsis>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 print "</refsynopsisdiv>\n";
929
930 output_section_xml(@_);
931
932 print "</refentry>\n\n";
933}
934
935# output in XML DocBook
Johannes Bergb112e0f2007-10-24 15:08:48 -0700936sub output_blockhead_xml(%) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 my %args = %{$_[0]};
938 my ($parameter, $section);
939 my $count;
940
941 my $id = $args{'module'};
942 $id =~ s/[^A-Za-z0-9]/-/g;
943
944 # print out each section
945 $lineprefix=" ";
946 foreach $section (@{$args{'sectionlist'}}) {
Johannes Bergb112e0f2007-10-24 15:08:48 -0700947 if (!$args{'content-only'}) {
948 print "<refsect1>\n <title>$section</title>\n";
949 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 if ($section =~ m/EXAMPLE/i) {
951 print "<example><para>\n";
Johannes Bergb112e0f2007-10-24 15:08:48 -0700952 } else {
953 print "<para>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 }
955 output_highlight($args{'sections'}{$section});
956 if ($section =~ m/EXAMPLE/i) {
957 print "</para></example>\n";
Johannes Bergb112e0f2007-10-24 15:08:48 -0700958 } else {
959 print "</para>";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 }
Johannes Bergb112e0f2007-10-24 15:08:48 -0700961 if (!$args{'content-only'}) {
962 print "\n</refsect1>\n";
963 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 }
965
966 print "\n\n";
967}
968
969# output in XML DocBook
970sub output_function_gnome {
971 my %args = %{$_[0]};
972 my ($parameter, $section);
973 my $count;
974 my $id;
975
Randy Dunlapb9d973282009-06-09 08:50:38 -0700976 $id = $args{'module'} . "-" . $args{'function'};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 $id =~ s/[^A-Za-z0-9]/-/g;
978
979 print "<sect2>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700980 print " <title id=\"$id\">" . $args{'function'} . "</title>\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981
982 print " <funcsynopsis>\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700983 print " <funcdef>" . $args{'functiontype'} . " ";
984 print "<function>" . $args{'function'} . " ";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 print "</function></funcdef>\n";
986
987 $count = 0;
988 if ($#{$args{'parameterlist'}} >= 0) {
989 foreach $parameter (@{$args{'parameterlist'}}) {
990 $type = $args{'parametertypes'}{$parameter};
991 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
992 # pointer-to-function
993 print " <paramdef>$1 <parameter>$parameter</parameter>)\n";
994 print " <funcparams>$2</funcparams></paramdef>\n";
995 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -0700996 print " <paramdef>" . $type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 print " <parameter>$parameter</parameter></paramdef>\n";
998 }
999 }
1000 } else {
1001 print " <void>\n";
1002 }
1003 print " </funcsynopsis>\n";
1004 if ($#{$args{'parameterlist'}} >= 0) {
1005 print " <informaltable pgwide=\"1\" frame=\"none\" role=\"params\">\n";
1006 print "<tgroup cols=\"2\">\n";
1007 print "<colspec colwidth=\"2*\">\n";
1008 print "<colspec colwidth=\"8*\">\n";
1009 print "<tbody>\n";
1010 foreach $parameter (@{$args{'parameterlist'}}) {
1011 my $parameter_name = $parameter;
1012 $parameter_name =~ s/\[.*//;
1013
1014 print " <row><entry align=\"right\"><parameter>$parameter</parameter></entry>\n";
1015 print " <entry>\n";
1016 $lineprefix=" ";
1017 output_highlight($args{'parameterdescs'}{$parameter_name});
1018 print " </entry></row>\n";
1019 }
1020 print " </tbody></tgroup></informaltable>\n";
1021 } else {
1022 print " <para>\n None\n </para>\n";
1023 }
1024
1025 # print out each section
1026 $lineprefix=" ";
1027 foreach $section (@{$args{'sectionlist'}}) {
1028 print "<simplesect>\n <title>$section</title>\n";
1029 if ($section =~ m/EXAMPLE/i) {
1030 print "<example><programlisting>\n";
1031 } else {
1032 }
1033 print "<para>\n";
1034 output_highlight($args{'sections'}{$section});
1035 print "</para>\n";
1036 if ($section =~ m/EXAMPLE/i) {
1037 print "</programlisting></example>\n";
1038 } else {
1039 }
1040 print " </simplesect>\n";
1041 }
1042
1043 print "</sect2>\n\n";
1044}
1045
1046##
1047# output function in man
1048sub output_function_man(%) {
1049 my %args = %{$_[0]};
1050 my ($parameter, $section);
1051 my $count;
1052
1053 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
1054
1055 print ".SH NAME\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -07001056 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057
1058 print ".SH SYNOPSIS\n";
Randy Dunlapa21217d2007-02-10 01:46:04 -08001059 if ($args{'functiontype'} ne "") {
Randy Dunlapb9d973282009-06-09 08:50:38 -07001060 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
Randy Dunlapa21217d2007-02-10 01:46:04 -08001061 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -07001062 print ".B \"" . $args{'function'} . "\n";
Randy Dunlapa21217d2007-02-10 01:46:04 -08001063 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 $count = 0;
1065 my $parenth = "(";
1066 my $post = ",";
1067 foreach my $parameter (@{$args{'parameterlist'}}) {
1068 if ($count == $#{$args{'parameterlist'}}) {
1069 $post = ");";
1070 }
1071 $type = $args{'parametertypes'}{$parameter};
1072 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1073 # pointer-to-function
Randy Dunlapb9d973282009-06-09 08:50:38 -07001074 print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 } else {
1076 $type =~ s/([^\*])$/$1 /;
Randy Dunlapb9d973282009-06-09 08:50:38 -07001077 print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078 }
1079 $count++;
1080 $parenth = "";
1081 }
1082
1083 print ".SH ARGUMENTS\n";
1084 foreach $parameter (@{$args{'parameterlist'}}) {
1085 my $parameter_name = $parameter;
1086 $parameter_name =~ s/\[.*//;
1087
Randy Dunlapb9d973282009-06-09 08:50:38 -07001088 print ".IP \"" . $parameter . "\" 12\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 output_highlight($args{'parameterdescs'}{$parameter_name});
1090 }
1091 foreach $section (@{$args{'sectionlist'}}) {
1092 print ".SH \"", uc $section, "\"\n";
1093 output_highlight($args{'sections'}{$section});
1094 }
1095}
1096
1097##
1098# output enum in man
1099sub output_enum_man(%) {
1100 my %args = %{$_[0]};
1101 my ($parameter, $section);
1102 my $count;
1103
1104 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
1105
1106 print ".SH NAME\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -07001107 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108
1109 print ".SH SYNOPSIS\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -07001110 print "enum " . $args{'enum'} . " {\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111 $count = 0;
1112 foreach my $parameter (@{$args{'parameterlist'}}) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001113 print ".br\n.BI \" $parameter\"\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 if ($count == $#{$args{'parameterlist'}}) {
1115 print "\n};\n";
1116 last;
1117 }
1118 else {
1119 print ", \n.br\n";
1120 }
1121 $count++;
1122 }
1123
1124 print ".SH Constants\n";
1125 foreach $parameter (@{$args{'parameterlist'}}) {
1126 my $parameter_name = $parameter;
1127 $parameter_name =~ s/\[.*//;
1128
Randy Dunlapb9d973282009-06-09 08:50:38 -07001129 print ".IP \"" . $parameter . "\" 12\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 output_highlight($args{'parameterdescs'}{$parameter_name});
1131 }
1132 foreach $section (@{$args{'sectionlist'}}) {
1133 print ".SH \"$section\"\n";
1134 output_highlight($args{'sections'}{$section});
1135 }
1136}
1137
1138##
1139# output struct in man
1140sub output_struct_man(%) {
1141 my %args = %{$_[0]};
1142 my ($parameter, $section);
1143
Randy Dunlapb9d973282009-06-09 08:50:38 -07001144 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145
1146 print ".SH NAME\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -07001147 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148
1149 print ".SH SYNOPSIS\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -07001150 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151
1152 foreach my $parameter (@{$args{'parameterlist'}}) {
1153 if ($parameter =~ /^#/) {
1154 print ".BI \"$parameter\"\n.br\n";
1155 next;
1156 }
1157 my $parameter_name = $parameter;
1158 $parameter_name =~ s/\[.*//;
1159
Randy Dunlap3c308792007-05-08 00:24:39 -07001160 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161 $type = $args{'parametertypes'}{$parameter};
1162 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1163 # pointer-to-function
Randy Dunlapb9d973282009-06-09 08:50:38 -07001164 print ".BI \" " . $1 . "\" " . $parameter . " \") (" . $2 . ")" . "\"\n;\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
Randy.Dunlap1d7e1d42006-07-01 04:36:34 -07001166 # bitfield
Randy Dunlapb9d973282009-06-09 08:50:38 -07001167 print ".BI \" " . $1 . "\ \" " . $parameter . $2 . " \"" . "\"\n;\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 } else {
1169 $type =~ s/([^\*])$/$1 /;
Randy Dunlapb9d973282009-06-09 08:50:38 -07001170 print ".BI \" " . $type . "\" " . $parameter . " \"" . "\"\n;\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 }
1172 print "\n.br\n";
1173 }
1174 print "};\n.br\n";
1175
Randy Dunlapc51d3da2006-06-25 05:49:14 -07001176 print ".SH Members\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177 foreach $parameter (@{$args{'parameterlist'}}) {
1178 ($parameter =~ /^#/) && next;
1179
1180 my $parameter_name = $parameter;
1181 $parameter_name =~ s/\[.*//;
1182
Randy Dunlap3c308792007-05-08 00:24:39 -07001183 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Randy Dunlapb9d973282009-06-09 08:50:38 -07001184 print ".IP \"" . $parameter . "\" 12\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185 output_highlight($args{'parameterdescs'}{$parameter_name});
1186 }
1187 foreach $section (@{$args{'sectionlist'}}) {
1188 print ".SH \"$section\"\n";
1189 output_highlight($args{'sections'}{$section});
1190 }
1191}
1192
1193##
1194# output typedef in man
1195sub output_typedef_man(%) {
1196 my %args = %{$_[0]};
1197 my ($parameter, $section);
1198
1199 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
1200
1201 print ".SH NAME\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -07001202 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203
1204 foreach $section (@{$args{'sectionlist'}}) {
1205 print ".SH \"$section\"\n";
1206 output_highlight($args{'sections'}{$section});
1207 }
1208}
1209
Johannes Bergb112e0f2007-10-24 15:08:48 -07001210sub output_blockhead_man(%) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 my %args = %{$_[0]};
1212 my ($parameter, $section);
1213 my $count;
1214
1215 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
1216
1217 foreach $section (@{$args{'sectionlist'}}) {
1218 print ".SH \"$section\"\n";
1219 output_highlight($args{'sections'}{$section});
1220 }
1221}
1222
1223##
1224# output in text
1225sub output_function_text(%) {
1226 my %args = %{$_[0]};
1227 my ($parameter, $section);
Randy Dunlapa21217d2007-02-10 01:46:04 -08001228 my $start;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229
Randy Dunlapf47634b2006-07-01 04:36:36 -07001230 print "Name:\n\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -07001231 print $args{'function'} . " - " . $args{'purpose'} . "\n";
Randy Dunlapf47634b2006-07-01 04:36:36 -07001232
1233 print "\nSynopsis:\n\n";
Randy Dunlapa21217d2007-02-10 01:46:04 -08001234 if ($args{'functiontype'} ne "") {
Randy Dunlapb9d973282009-06-09 08:50:38 -07001235 $start = $args{'functiontype'} . " " . $args{'function'} . " (";
Randy Dunlapa21217d2007-02-10 01:46:04 -08001236 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -07001237 $start = $args{'function'} . " (";
Randy Dunlapa21217d2007-02-10 01:46:04 -08001238 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239 print $start;
Randy Dunlapa21217d2007-02-10 01:46:04 -08001240
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 my $count = 0;
1242 foreach my $parameter (@{$args{'parameterlist'}}) {
1243 $type = $args{'parametertypes'}{$parameter};
1244 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1245 # pointer-to-function
Randy Dunlapb9d973282009-06-09 08:50:38 -07001246 print $1 . $parameter . ") (" . $2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -07001248 print $type . " " . $parameter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 }
1250 if ($count != $#{$args{'parameterlist'}}) {
1251 $count++;
1252 print ",\n";
1253 print " " x length($start);
1254 } else {
1255 print ");\n\n";
1256 }
1257 }
1258
1259 print "Arguments:\n\n";
1260 foreach $parameter (@{$args{'parameterlist'}}) {
1261 my $parameter_name = $parameter;
1262 $parameter_name =~ s/\[.*//;
1263
Randy Dunlapb9d973282009-06-09 08:50:38 -07001264 print $parameter . "\n\t" . $args{'parameterdescs'}{$parameter_name} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 }
1266 output_section_text(@_);
1267}
1268
1269#output sections in text
1270sub output_section_text(%) {
1271 my %args = %{$_[0]};
1272 my $section;
1273
1274 print "\n";
1275 foreach $section (@{$args{'sectionlist'}}) {
1276 print "$section:\n\n";
1277 output_highlight($args{'sections'}{$section});
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001278 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279 print "\n\n";
1280}
1281
1282# output enum in text
1283sub output_enum_text(%) {
1284 my %args = %{$_[0]};
1285 my ($parameter);
1286 my $count;
1287 print "Enum:\n\n";
1288
Randy Dunlapb9d973282009-06-09 08:50:38 -07001289 print "enum " . $args{'enum'} . " - " . $args{'purpose'} . "\n\n";
1290 print "enum " . $args{'enum'} . " {\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 $count = 0;
1292 foreach $parameter (@{$args{'parameterlist'}}) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001293 print "\t$parameter";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 if ($count != $#{$args{'parameterlist'}}) {
1295 $count++;
1296 print ",";
1297 }
1298 print "\n";
1299 }
1300 print "};\n\n";
1301
1302 print "Constants:\n\n";
1303 foreach $parameter (@{$args{'parameterlist'}}) {
1304 print "$parameter\n\t";
Randy Dunlapb9d973282009-06-09 08:50:38 -07001305 print $args{'parameterdescs'}{$parameter} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306 }
1307
1308 output_section_text(@_);
1309}
1310
1311# output typedef in text
1312sub output_typedef_text(%) {
1313 my %args = %{$_[0]};
1314 my ($parameter);
1315 my $count;
1316 print "Typedef:\n\n";
1317
Randy Dunlapb9d973282009-06-09 08:50:38 -07001318 print "typedef " . $args{'typedef'} . " - " . $args{'purpose'} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319 output_section_text(@_);
1320}
1321
1322# output struct as text
1323sub output_struct_text(%) {
1324 my %args = %{$_[0]};
1325 my ($parameter);
1326
Randy Dunlapb9d973282009-06-09 08:50:38 -07001327 print $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "\n\n";
1328 print $args{'type'} . " " . $args{'struct'} . " {\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329 foreach $parameter (@{$args{'parameterlist'}}) {
1330 if ($parameter =~ /^#/) {
1331 print "$parameter\n";
1332 next;
1333 }
1334
1335 my $parameter_name = $parameter;
1336 $parameter_name =~ s/\[.*//;
1337
Randy Dunlap3c308792007-05-08 00:24:39 -07001338 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 $type = $args{'parametertypes'}{$parameter};
1340 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1341 # pointer-to-function
1342 print "\t$1 $parameter) ($2);\n";
1343 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
Randy Dunlap51f5a0c2007-07-19 01:48:24 -07001344 # bitfield
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 print "\t$1 $parameter$2;\n";
1346 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -07001347 print "\t" . $type . " " . $parameter . ";\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 }
1349 }
1350 print "};\n\n";
1351
1352 print "Members:\n\n";
1353 foreach $parameter (@{$args{'parameterlist'}}) {
1354 ($parameter =~ /^#/) && next;
1355
1356 my $parameter_name = $parameter;
1357 $parameter_name =~ s/\[.*//;
1358
Randy Dunlap3c308792007-05-08 00:24:39 -07001359 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 print "$parameter\n\t";
Randy Dunlapb9d973282009-06-09 08:50:38 -07001361 print $args{'parameterdescs'}{$parameter_name} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 }
1363 print "\n";
1364 output_section_text(@_);
1365}
1366
Johannes Bergb112e0f2007-10-24 15:08:48 -07001367sub output_blockhead_text(%) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 my %args = %{$_[0]};
1369 my ($parameter, $section);
1370
1371 foreach $section (@{$args{'sectionlist'}}) {
1372 print " $section:\n";
1373 print " -> ";
1374 output_highlight($args{'sections'}{$section});
1375 }
1376}
1377
Johannes Bergeda603f2010-09-11 15:55:22 -07001378## list mode output functions
1379
1380sub output_function_list(%) {
1381 my %args = %{$_[0]};
1382
1383 print $args{'function'} . "\n";
1384}
1385
1386# output enum in list
1387sub output_enum_list(%) {
1388 my %args = %{$_[0]};
1389 print $args{'enum'} . "\n";
1390}
1391
1392# output typedef in list
1393sub output_typedef_list(%) {
1394 my %args = %{$_[0]};
1395 print $args{'typedef'} . "\n";
1396}
1397
1398# output struct as list
1399sub output_struct_list(%) {
1400 my %args = %{$_[0]};
1401
1402 print $args{'struct'} . "\n";
1403}
1404
1405sub output_blockhead_list(%) {
1406 my %args = %{$_[0]};
1407 my ($parameter, $section);
1408
1409 foreach $section (@{$args{'sectionlist'}}) {
1410 print "DOC: $section\n";
1411 }
1412}
1413
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414##
Randy Dunlap27205742006-10-11 01:22:12 -07001415# generic output function for all types (function, struct/union, typedef, enum);
1416# calls the generated, variable output_ function name based on
1417# functype and output_mode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418sub output_declaration {
1419 no strict 'refs';
1420 my $name = shift;
1421 my $functype = shift;
1422 my $func = "output_${functype}_$output_mode";
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001423 if (($function_only==0) ||
1424 ( $function_only == 1 && defined($function_table{$name})) ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 ( $function_only == 2 && !defined($function_table{$name})))
1426 {
Randy Dunlap3c308792007-05-08 00:24:39 -07001427 &$func(@_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428 $section_counter++;
1429 }
1430}
1431
1432##
Randy Dunlap27205742006-10-11 01:22:12 -07001433# generic output function - calls the right one based on current output mode.
Johannes Bergb112e0f2007-10-24 15:08:48 -07001434sub output_blockhead {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435 no strict 'refs';
Randy Dunlapb9d973282009-06-09 08:50:38 -07001436 my $func = "output_blockhead_" . $output_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 &$func(@_);
1438 $section_counter++;
1439}
1440
1441##
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001442# takes a declaration (struct, union, enum, typedef) and
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443# invokes the right handler. NOT called for functions.
1444sub dump_declaration($$) {
1445 no strict 'refs';
1446 my ($prototype, $file) = @_;
Randy Dunlapb9d973282009-06-09 08:50:38 -07001447 my $func = "dump_" . $decl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448 &$func(@_);
1449}
1450
1451sub dump_union($$) {
1452 dump_struct(@_);
1453}
1454
1455sub dump_struct($$) {
1456 my $x = shift;
1457 my $file = shift;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001458 my $nested;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459
Randy Dunlap52dc5ae2009-04-30 15:08:53 -07001460 if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) {
1461 #my $decl_type = $1;
Randy Dunlap3c308792007-05-08 00:24:39 -07001462 $declaration_name = $2;
1463 my $members = $3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464
1465 # ignore embedded structs or unions
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001466 $members =~ s/({.*})//g;
1467 $nested = $1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468
Martin Waitzaeec46b2005-11-13 16:08:13 -08001469 # ignore members marked private:
Randy Dunlap52dc5ae2009-04-30 15:08:53 -07001470 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gos;
1471 $members =~ s/\/\*\s*private:.*//gos;
Martin Waitzaeec46b2005-11-13 16:08:13 -08001472 # strip comments:
1473 $members =~ s/\/\*.*?\*\///gos;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001474 $nested =~ s/\/\*.*?\*\///gos;
Randy Dunlapd960eea2009-06-29 14:54:11 -07001475 # strip kmemcheck_bitfield_{begin,end}.*;
1476 $members =~ s/kmemcheck_bitfield_.*?;//gos;
Randy Dunlapef5da592010-03-23 13:35:14 -07001477 # strip attributes
1478 $members =~ s/__aligned\s*\(\d+\)//gos;
Martin Waitzaeec46b2005-11-13 16:08:13 -08001479
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480 create_parameterlist($members, ';', $file);
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001481 check_sections($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482
1483 output_declaration($declaration_name,
1484 'struct',
1485 {'struct' => $declaration_name,
1486 'module' => $modulename,
1487 'parameterlist' => \@parameterlist,
1488 'parameterdescs' => \%parameterdescs,
1489 'parametertypes' => \%parametertypes,
1490 'sectionlist' => \@sectionlist,
1491 'sections' => \%sections,
1492 'purpose' => $declaration_purpose,
1493 'type' => $decl_type
1494 });
1495 }
1496 else {
Randy Dunlap3c308792007-05-08 00:24:39 -07001497 print STDERR "Error(${file}:$.): Cannot parse struct or union!\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 ++$errors;
1499 }
1500}
1501
1502sub dump_enum($$) {
1503 my $x = shift;
1504 my $file = shift;
1505
Martin Waitzaeec46b2005-11-13 16:08:13 -08001506 $x =~ s@/\*.*?\*/@@gos; # strip comments.
Randy Dunlapb6d676d2010-08-10 18:02:50 -07001507 $x =~ s/^#\s*define\s+.*$//; # strip #define macros inside enums
1508
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001510 $declaration_name = $1;
1511 my $members = $2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512
1513 foreach my $arg (split ',', $members) {
1514 $arg =~ s/^\s*(\w+).*/$1/;
1515 push @parameterlist, $arg;
1516 if (!$parameterdescs{$arg}) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001517 $parameterdescs{$arg} = $undescribed;
1518 print STDERR "Warning(${file}:$.): Enum value '$arg' ".
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519 "not described in enum '$declaration_name'\n";
1520 }
1521
1522 }
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001523
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 output_declaration($declaration_name,
1525 'enum',
1526 {'enum' => $declaration_name,
1527 'module' => $modulename,
1528 'parameterlist' => \@parameterlist,
1529 'parameterdescs' => \%parameterdescs,
1530 'sectionlist' => \@sectionlist,
1531 'sections' => \%sections,
1532 'purpose' => $declaration_purpose
1533 });
1534 }
1535 else {
Randy Dunlap3c308792007-05-08 00:24:39 -07001536 print STDERR "Error(${file}:$.): Cannot parse enum!\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537 ++$errors;
1538 }
1539}
1540
1541sub dump_typedef($$) {
1542 my $x = shift;
1543 my $file = shift;
1544
Martin Waitzaeec46b2005-11-13 16:08:13 -08001545 $x =~ s@/\*.*?\*/@@gos; # strip comments.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001547 $x =~ s/\(*.\)\s*;$/;/;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 $x =~ s/\[*.\]\s*;$/;/;
1549 }
1550
1551 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001552 $declaration_name = $1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553
1554 output_declaration($declaration_name,
1555 'typedef',
1556 {'typedef' => $declaration_name,
1557 'module' => $modulename,
1558 'sectionlist' => \@sectionlist,
1559 'sections' => \%sections,
1560 'purpose' => $declaration_purpose
1561 });
1562 }
1563 else {
Randy Dunlap3c308792007-05-08 00:24:39 -07001564 print STDERR "Error(${file}:$.): Cannot parse typedef!\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 ++$errors;
1566 }
1567}
1568
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001569sub save_struct_actual($) {
1570 my $actual = shift;
1571
1572 # strip all spaces from the actual param so that it looks like one string item
1573 $actual =~ s/\s*//g;
1574 $struct_actual = $struct_actual . $actual . " ";
1575}
1576
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577sub create_parameterlist($$$) {
1578 my $args = shift;
1579 my $splitter = shift;
1580 my $file = shift;
1581 my $type;
1582 my $param;
1583
Martin Waitza6d3fe72006-01-09 20:53:55 -08001584 # temporarily replace commas inside function pointer definition
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585 while ($args =~ /(\([^\),]+),/) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001586 $args =~ s/(\([^\),]+),/$1#/g;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 }
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001588
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 foreach my $arg (split($splitter, $args)) {
1590 # strip comments
1591 $arg =~ s/\/\*.*\*\///;
Randy Dunlap3c308792007-05-08 00:24:39 -07001592 # strip leading/trailing spaces
1593 $arg =~ s/^\s*//;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 $arg =~ s/\s*$//;
1595 $arg =~ s/\s+/ /;
1596
1597 if ($arg =~ /^#/) {
1598 # Treat preprocessor directive as a typeless variable just to fill
1599 # corresponding data structures "correctly". Catch it later in
1600 # output_* subs.
1601 push_parameter($arg, "", $file);
Richard Kennedy00d62962008-02-23 15:24:01 -08001602 } elsif ($arg =~ m/\(.+\)\s*\(/) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 # pointer-to-function
1604 $arg =~ tr/#/,/;
Richard Kennedy00d62962008-02-23 15:24:01 -08001605 $arg =~ m/[^\(]+\(\*?\s*(\w*)\s*\)/;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 $param = $1;
1607 $type = $arg;
Richard Kennedy00d62962008-02-23 15:24:01 -08001608 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001609 save_struct_actual($param);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 push_parameter($param, $type, $file);
Martin Waitzaeec46b2005-11-13 16:08:13 -08001611 } elsif ($arg) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 $arg =~ s/\s*:\s*/:/g;
1613 $arg =~ s/\s*\[/\[/g;
1614
1615 my @args = split('\s*,\s*', $arg);
1616 if ($args[0] =~ m/\*/) {
1617 $args[0] =~ s/(\*+)\s*/ $1/;
1618 }
Borislav Petkov884f2812007-05-08 00:29:05 -07001619
1620 my @first_arg;
1621 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1622 shift @args;
1623 push(@first_arg, split('\s+', $1));
1624 push(@first_arg, $2);
1625 } else {
1626 @first_arg = split('\s+', shift @args);
1627 }
1628
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 unshift(@args, pop @first_arg);
1630 $type = join " ", @first_arg;
1631
1632 foreach $param (@args) {
1633 if ($param =~ m/^(\*+)\s*(.*)/) {
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001634 save_struct_actual($2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 push_parameter($2, "$type $1", $file);
1636 }
1637 elsif ($param =~ m/(.*?):(\d+)/) {
Randy Dunlap7b978872008-05-16 15:45:52 -07001638 if ($type ne "") { # skip unnamed bit-fields
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001639 save_struct_actual($1);
Randy Dunlap7b978872008-05-16 15:45:52 -07001640 push_parameter($1, "$type:$2", $file)
1641 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642 }
1643 else {
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001644 save_struct_actual($param);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 push_parameter($param, $type, $file);
1646 }
1647 }
1648 }
1649 }
1650}
1651
1652sub push_parameter($$$) {
1653 my $param = shift;
1654 my $type = shift;
1655 my $file = shift;
1656
Randy Dunlap5f8c7c92007-07-19 01:48:24 -07001657 if (($anon_struct_union == 1) && ($type eq "") &&
1658 ($param eq "}")) {
1659 return; # ignore the ending }; from anon. struct/union
1660 }
1661
1662 $anon_struct_union = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 my $param_name = $param;
1664 $param_name =~ s/\[.*//;
1665
Martin Waitza6d3fe72006-01-09 20:53:55 -08001666 if ($type eq "" && $param =~ /\.\.\.$/)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667 {
Randy Dunlapced69092008-12-01 13:14:03 -08001668 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1669 $parameterdescs{$param} = "variable arguments";
1670 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 }
1672 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1673 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 $param="void";
1675 $parameterdescs{void} = "no arguments";
1676 }
Randy Dunlap134fe012006-12-22 01:10:50 -08001677 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1678 # handle unnamed (anonymous) union or struct:
1679 {
1680 $type = $param;
Randy Dunlap5f8c7c92007-07-19 01:48:24 -07001681 $param = "{unnamed_" . $param . "}";
Randy Dunlap134fe012006-12-22 01:10:50 -08001682 $parameterdescs{$param} = "anonymous\n";
Randy Dunlap5f8c7c92007-07-19 01:48:24 -07001683 $anon_struct_union = 1;
Randy Dunlap134fe012006-12-22 01:10:50 -08001684 }
1685
Martin Waitza6d3fe72006-01-09 20:53:55 -08001686 # warn if parameter has no description
Randy Dunlap134fe012006-12-22 01:10:50 -08001687 # (but ignore ones starting with # as these are not parameters
1688 # but inline preprocessor statements);
1689 # also ignore unnamed structs/unions;
Randy Dunlap5f8c7c92007-07-19 01:48:24 -07001690 if (!$anon_struct_union) {
Martin Waitza6d3fe72006-01-09 20:53:55 -08001691 if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) {
1692
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 $parameterdescs{$param_name} = $undescribed;
1694
1695 if (($type eq 'function') || ($type eq 'enum')) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001696 print STDERR "Warning(${file}:$.): Function parameter ".
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 "or member '$param' not " .
1698 "described in '$declaration_name'\n";
1699 }
Randy Dunlapb9d973282009-06-09 08:50:38 -07001700 print STDERR "Warning(${file}:$.):" .
Randy Dunlap3c308792007-05-08 00:24:39 -07001701 " No description found for parameter '$param'\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702 ++$warnings;
Randy Dunlap3c308792007-05-08 00:24:39 -07001703 }
1704 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705
Randy Dunlap2b35f4d2010-11-18 12:27:31 -08001706 $param = xml_escape($param);
1707
Randy Dunlape34e7db2009-06-17 17:37:47 -07001708 # strip spaces from $param so that it is one continous string
1709 # on @parameterlist;
1710 # this fixes a problem where check_sections() cannot find
1711 # a parameter like "addr[6 + 2]" because it actually appears
1712 # as "addr[6", "+", "2]" on the parameter list;
1713 # but it's better to maintain the param string unchanged for output,
1714 # so just weaken the string compare in check_sections() to ignore
1715 # "[blah" in a parameter string;
1716 ###$param =~ s/\s*//g;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717 push @parameterlist, $param;
1718 $parametertypes{$param} = $type;
1719}
1720
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001721sub check_sections($$$$$$) {
1722 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck, $nested) = @_;
1723 my @sects = split ' ', $sectcheck;
1724 my @prms = split ' ', $prmscheck;
1725 my $err;
1726 my ($px, $sx);
1727 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
1728
1729 foreach $sx (0 .. $#sects) {
1730 $err = 1;
1731 foreach $px (0 .. $#prms) {
1732 $prm_clean = $prms[$px];
1733 $prm_clean =~ s/\[.*\]//;
Johannes Berg1f3a6682010-09-11 15:55:12 -07001734 $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;
Randy Dunlape34e7db2009-06-17 17:37:47 -07001735 # ignore array size in a parameter string;
1736 # however, the original param string may contain
1737 # spaces, e.g.: addr[6 + 2]
1738 # and this appears in @prms as "addr[6" since the
1739 # parameter list is split at spaces;
1740 # hence just ignore "[..." for the sections check;
1741 $prm_clean =~ s/\[.*//;
1742
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001743 ##$prm_clean =~ s/^\**//;
1744 if ($prm_clean eq $sects[$sx]) {
1745 $err = 0;
1746 last;
1747 }
1748 }
1749 if ($err) {
1750 if ($decl_type eq "function") {
1751 print STDERR "Warning(${file}:$.): " .
1752 "Excess function parameter " .
1753 "'$sects[$sx]' " .
1754 "description in '$decl_name'\n";
1755 ++$warnings;
1756 } else {
1757 if ($nested !~ m/\Q$sects[$sx]\E/) {
1758 print STDERR "Warning(${file}:$.): " .
1759 "Excess struct/union/enum/typedef member " .
1760 "'$sects[$sx]' " .
1761 "description in '$decl_name'\n";
1762 ++$warnings;
1763 }
1764 }
1765 }
1766 }
1767}
1768
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769##
1770# takes a function prototype and the name of the current file being
1771# processed and spits out all the details stored in the global
1772# arrays/hashes.
1773sub dump_function($$) {
1774 my $prototype = shift;
1775 my $file = shift;
1776
1777 $prototype =~ s/^static +//;
1778 $prototype =~ s/^extern +//;
Pavel Pisa4dc3b162005-05-01 08:59:25 -07001779 $prototype =~ s/^asmlinkage +//;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780 $prototype =~ s/^inline +//;
1781 $prototype =~ s/^__inline__ +//;
Randy Dunlap32e79402006-10-11 01:22:10 -07001782 $prototype =~ s/^__inline +//;
1783 $prototype =~ s/^__always_inline +//;
1784 $prototype =~ s/^noinline +//;
Randy Dunlap0129a052006-07-30 03:03:41 -07001785 $prototype =~ s/__devinit +//;
Randy Dunlap74fc5c62008-06-19 16:03:29 -07001786 $prototype =~ s/__init +//;
Randy Dunlap20072202010-03-23 13:35:24 -07001787 $prototype =~ s/__init_or_module +//;
Randy Dunlap890c78c2008-10-25 17:06:43 -07001788 $prototype =~ s/^#\s*define\s+//; #ak added
Randy Dunlap328d2442007-02-28 20:12:10 -08001789 $prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790
1791 # Yes, this truly is vile. We are looking for:
1792 # 1. Return type (may be nothing if we're looking at a macro)
1793 # 2. Function name
1794 # 3. Function parameters.
1795 #
1796 # All the while we have to watch out for function pointer parameters
1797 # (which IIRC is what the two sections are for), C types (these
1798 # regexps don't even start to express all the possibilities), and
1799 # so on.
1800 #
1801 # If you mess with these regexps, it's a good idea to check that
1802 # the following functions' documentation still comes out right:
1803 # - parport_register_device (function pointer parameters)
1804 # - atomic_set (macro)
Martin Waitz9598f912006-02-01 03:06:55 -08001805 # - pci_match_device, __copy_to_user (long return type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806
1807 if ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1808 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1809 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1810 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
Randy Dunlap94b3e032008-02-07 00:13:26 -08001811 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1813 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1814 $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1815 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1816 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1817 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1818 $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1819 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
Martin Waitz9598f912006-02-01 03:06:55 -08001820 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1821 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
Randy Dunlap412ecd72007-02-10 22:47:33 -08001822 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1823 $prototype =~ m/^(\w+\s+\w+\s*\*\s*\w+\s*\*\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 $return_type = $1;
1825 $declaration_name = $2;
1826 my $args = $3;
1827
1828 create_parameterlist($args, ',', $file);
1829 } else {
1830 print STDERR "Error(${file}:$.): cannot understand prototype: '$prototype'\n";
1831 ++$errors;
1832 return;
1833 }
1834
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001835 my $prms = join " ", @parameterlist;
1836 check_sections($file, $declaration_name, "function", $sectcheck, $prms, "");
1837
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001838 output_declaration($declaration_name,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839 'function',
1840 {'function' => $declaration_name,
1841 'module' => $modulename,
1842 'functiontype' => $return_type,
1843 'parameterlist' => \@parameterlist,
1844 'parameterdescs' => \%parameterdescs,
1845 'parametertypes' => \%parametertypes,
1846 'sectionlist' => \@sectionlist,
1847 'sections' => \%sections,
1848 'purpose' => $declaration_purpose
1849 });
1850}
1851
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852sub reset_state {
1853 $function = "";
1854 %constants = ();
1855 %parameterdescs = ();
1856 %parametertypes = ();
1857 @parameterlist = ();
1858 %sections = ();
1859 @sectionlist = ();
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001860 $sectcheck = "";
1861 $struct_actual = "";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 $prototype = "";
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001863
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864 $state = 0;
1865}
1866
Jason Baron56afb0f2009-04-30 13:29:36 -04001867sub tracepoint_munge($) {
1868 my $file = shift;
1869 my $tracepointname = 0;
1870 my $tracepointargs = 0;
1871
Jason Baron3a9089f2009-12-01 12:18:49 -05001872 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
Jason Baron56afb0f2009-04-30 13:29:36 -04001873 $tracepointname = $1;
1874 }
Jason Baron3a9089f2009-12-01 12:18:49 -05001875 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1876 $tracepointname = $1;
1877 }
1878 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1879 $tracepointname = $2;
1880 }
1881 $tracepointname =~ s/^\s+//; #strip leading whitespace
1882 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
Jason Baron56afb0f2009-04-30 13:29:36 -04001883 $tracepointargs = $1;
1884 }
1885 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1886 print STDERR "Warning(${file}:$.): Unrecognized tracepoint format: \n".
1887 "$prototype\n";
1888 } else {
1889 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1890 }
1891}
1892
Randy Dunlapb4870bc2009-02-11 13:04:33 -08001893sub syscall_munge() {
1894 my $void = 0;
1895
1896 $prototype =~ s@[\r\n\t]+@ @gos; # strip newlines/CR's/tabs
1897## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1898 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1899 $void = 1;
1900## $prototype = "long sys_$1(void)";
1901 }
1902
1903 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1904 if ($prototype =~ m/long (sys_.*?),/) {
1905 $prototype =~ s/,/\(/;
1906 } elsif ($void) {
1907 $prototype =~ s/\)/\(void\)/;
1908 }
1909
1910 # now delete all of the odd-number commas in $prototype
1911 # so that arg types & arg names don't have a comma between them
1912 my $count = 0;
1913 my $len = length($prototype);
1914 if ($void) {
1915 $len = 0; # skip the for-loop
1916 }
1917 for (my $ix = 0; $ix < $len; $ix++) {
1918 if (substr($prototype, $ix, 1) eq ',') {
1919 $count++;
1920 if ($count % 2 == 1) {
1921 substr($prototype, $ix, 1) = ' ';
1922 }
1923 }
1924 }
1925}
1926
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001927sub process_state3_function($$) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928 my $x = shift;
1929 my $file = shift;
1930
Randy Dunlap51f5a0c2007-07-19 01:48:24 -07001931 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1932
Randy Dunlap890c78c2008-10-25 17:06:43 -07001933 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934 # do nothing
1935 }
1936 elsif ($x =~ /([^\{]*)/) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001937 $prototype .= $1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938 }
Randy Dunlapb4870bc2009-02-11 13:04:33 -08001939
Randy Dunlap890c78c2008-10-25 17:06:43 -07001940 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001941 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1943 $prototype =~ s@^\s+@@gos; # strip leading spaces
Randy Dunlapb4870bc2009-02-11 13:04:33 -08001944 if ($prototype =~ /SYSCALL_DEFINE/) {
1945 syscall_munge();
1946 }
Jason Baron3a9089f2009-12-01 12:18:49 -05001947 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1948 $prototype =~ /DEFINE_SINGLE_EVENT/)
1949 {
Jason Baron56afb0f2009-04-30 13:29:36 -04001950 tracepoint_munge($file);
1951 }
Randy Dunlapb4870bc2009-02-11 13:04:33 -08001952 dump_function($prototype, $file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 reset_state();
1954 }
1955}
1956
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001957sub process_state3_type($$) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958 my $x = shift;
1959 my $file = shift;
1960
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1962 $x =~ s@^\s+@@gos; # strip leading spaces
1963 $x =~ s@\s+$@@gos; # strip trailing spaces
Randy Dunlap51f5a0c2007-07-19 01:48:24 -07001964 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1965
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966 if ($x =~ /^#/) {
1967 # To distinguish preprocessor directive from regular declaration later.
1968 $x .= ";";
1969 }
1970
1971 while (1) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001972 if ( $x =~ /([^{};]*)([{};])(.*)/ ) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 $prototype .= $1 . $2;
1974 ($2 eq '{') && $brcount++;
1975 ($2 eq '}') && $brcount--;
1976 if (($2 eq ';') && ($brcount == 0)) {
Randy Dunlapb9d973282009-06-09 08:50:38 -07001977 dump_declaration($prototype, $file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978 reset_state();
Randy Dunlap3c308792007-05-08 00:24:39 -07001979 last;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980 }
1981 $x = $3;
Randy Dunlap3c308792007-05-08 00:24:39 -07001982 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983 $prototype .= $x;
1984 last;
1985 }
1986 }
1987}
1988
Randy Dunlap6b5b55f2007-10-16 23:31:20 -07001989# xml_escape: replace <, >, and & in the text stream;
1990#
1991# however, formatting controls that are generated internally/locally in the
1992# kernel-doc script are not escaped here; instead, they begin life like
1993# $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings
1994# are converted to their mnemonic-expected output, without the 4 * '\' & ':',
1995# just before actual output; (this is done by local_unescape())
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996sub xml_escape($) {
1997 my $text = shift;
Randy Dunlapecfb2512006-06-25 05:49:13 -07001998 if (($output_mode eq "text") || ($output_mode eq "man")) {
1999 return $text;
2000 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001 $text =~ s/\&/\\\\\\amp;/g;
2002 $text =~ s/\</\\\\\\lt;/g;
2003 $text =~ s/\>/\\\\\\gt;/g;
2004 return $text;
2005}
2006
Randy Dunlap6b5b55f2007-10-16 23:31:20 -07002007# convert local escape strings to html
2008# local escape strings look like: '\\\\menmonic:' (that's 4 backslashes)
2009sub local_unescape($) {
2010 my $text = shift;
2011 if (($output_mode eq "text") || ($output_mode eq "man")) {
2012 return $text;
2013 }
2014 $text =~ s/\\\\\\\\lt:/</g;
2015 $text =~ s/\\\\\\\\gt:/>/g;
2016 return $text;
2017}
2018
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019sub process_file($) {
Randy Dunlap2283a112005-07-07 15:39:26 -07002020 my $file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021 my $identifier;
2022 my $func;
Randy Dunlapa21217d2007-02-10 01:46:04 -08002023 my $descr;
Johannes Weiner64231332009-09-17 19:26:53 -07002024 my $in_purpose = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025 my $initial_section_counter = $section_counter;
2026
Randy Dunlap2283a112005-07-07 15:39:26 -07002027 if (defined($ENV{'SRCTREE'})) {
2028 $file = "$ENV{'SRCTREE'}" . "/" . "@_";
2029 }
2030 else {
2031 $file = "@_";
2032 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033 if (defined($source_map{$file})) {
2034 $file = $source_map{$file};
2035 }
2036
2037 if (!open(IN,"<$file")) {
2038 print STDERR "Error: Cannot open file $file\n";
2039 ++$errors;
2040 return;
2041 }
2042
Ilya Dryomova9e73142010-02-26 13:05:47 -08002043 $. = 1;
2044
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 $section_counter = 0;
2046 while (<IN>) {
2047 if ($state == 0) {
2048 if (/$doc_start/o) {
2049 $state = 1; # next line is always the function name
Randy Dunlap850622d2006-06-25 05:48:55 -07002050 $in_doc_sect = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051 }
2052 } elsif ($state == 1) { # this line is the function name (always)
2053 if (/$doc_block/o) {
2054 $state = 4;
2055 $contents = "";
2056 if ( $1 eq "" ) {
2057 $section = $section_intro;
2058 } else {
2059 $section = $1;
2060 }
Randy Dunlap3c308792007-05-08 00:24:39 -07002061 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062 elsif (/$doc_decl/o) {
2063 $identifier = $1;
2064 if (/\s*([\w\s]+?)\s*-/) {
2065 $identifier = $1;
2066 }
2067
2068 $state = 2;
2069 if (/-(.*)/) {
Randy Dunlap51f5a0c2007-07-19 01:48:24 -07002070 # strip leading/trailing/multiple spaces
Randy Dunlapa21217d2007-02-10 01:46:04 -08002071 $descr= $1;
2072 $descr =~ s/^\s*//;
2073 $descr =~ s/\s*$//;
2074 $descr =~ s/\s+/ /;
2075 $declaration_purpose = xml_escape($descr);
Johannes Weiner64231332009-09-17 19:26:53 -07002076 $in_purpose = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077 } else {
2078 $declaration_purpose = "";
2079 }
Randy Dunlap77cc23b2008-02-07 00:13:42 -08002080
2081 if (($declaration_purpose eq "") && $verbose) {
2082 print STDERR "Warning(${file}:$.): missing initial short description on line:\n";
2083 print STDERR $_;
2084 ++$warnings;
2085 }
2086
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 if ($identifier =~ m/^struct/) {
2088 $decl_type = 'struct';
2089 } elsif ($identifier =~ m/^union/) {
2090 $decl_type = 'union';
2091 } elsif ($identifier =~ m/^enum/) {
2092 $decl_type = 'enum';
2093 } elsif ($identifier =~ m/^typedef/) {
2094 $decl_type = 'typedef';
2095 } else {
2096 $decl_type = 'function';
2097 }
2098
2099 if ($verbose) {
2100 print STDERR "Info(${file}:$.): Scanning doc for $identifier\n";
2101 }
2102 } else {
2103 print STDERR "Warning(${file}:$.): Cannot understand $_ on line $.",
2104 " - I thought it was a doc line\n";
2105 ++$warnings;
2106 $state = 0;
2107 }
2108 } elsif ($state == 2) { # look for head: lines, and include content
2109 if (/$doc_sect/o) {
2110 $newsection = $1;
2111 $newcontents = $2;
2112
Randy Dunlap792aa2f2008-02-07 00:13:41 -08002113 if (($contents ne "") && ($contents ne "\n")) {
Randy Dunlap850622d2006-06-25 05:48:55 -07002114 if (!$in_doc_sect && $verbose) {
2115 print STDERR "Warning(${file}:$.): contents before sections\n";
2116 ++$warnings;
2117 }
Randy Dunlap94dc7ad2008-04-28 02:16:34 -07002118 dump_section($file, $section, xml_escape($contents));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 $section = $section_default;
2120 }
2121
Randy Dunlap850622d2006-06-25 05:48:55 -07002122 $in_doc_sect = 1;
Johannes Weiner64231332009-09-17 19:26:53 -07002123 $in_purpose = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124 $contents = $newcontents;
2125 if ($contents ne "") {
Randy Dunlap27205742006-10-11 01:22:12 -07002126 while ((substr($contents, 0, 1) eq " ") ||
2127 substr($contents, 0, 1) eq "\t") {
2128 $contents = substr($contents, 1);
Randy Dunlap05189492006-06-25 05:47:47 -07002129 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 $contents .= "\n";
2131 }
2132 $section = $newsection;
2133 } elsif (/$doc_end/) {
2134
Randy Dunlap4c98eca2010-03-10 15:22:02 -08002135 if (($contents ne "") && ($contents ne "\n")) {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -07002136 dump_section($file, $section, xml_escape($contents));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 $section = $section_default;
2138 $contents = "";
2139 }
Randy Dunlap46b958e2008-04-28 02:16:35 -07002140 # look for doc_com + <text> + doc_end:
2141 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2142 print STDERR "Warning(${file}:$.): suspicious ending line: $_";
2143 ++$warnings;
2144 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145
2146 $prototype = "";
2147 $state = 3;
2148 $brcount = 0;
Randy Dunlap232acbc2006-06-25 05:47:48 -07002149# print STDERR "end of doc comment, looking for prototype\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 } elsif (/$doc_content/) {
2151 # miguel-style comment kludge, look for blank lines after
2152 # @parameter line to signify start of description
Johannes Weiner64231332009-09-17 19:26:53 -07002153 if ($1 eq "") {
2154 if ($section =~ m/^@/ || $section eq $section_context) {
2155 dump_section($file, $section, xml_escape($contents));
2156 $section = $section_default;
2157 $contents = "";
2158 } else {
2159 $contents .= "\n";
2160 }
2161 $in_purpose = 0;
2162 } elsif ($in_purpose == 1) {
2163 # Continued declaration purpose
2164 chomp($declaration_purpose);
2165 $declaration_purpose .= " " . xml_escape($1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -07002167 $contents .= $1 . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168 }
2169 } else {
2170 # i dont know - bad line? ignore.
Randy Dunlap3c3b8092006-02-01 03:06:58 -08002171 print STDERR "Warning(${file}:$.): bad line: $_";
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 ++$warnings;
2173 }
Randy Dunlap232acbc2006-06-25 05:47:48 -07002174 } elsif ($state == 3) { # scanning for function '{' (end of prototype)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 if ($decl_type eq 'function') {
Randy Dunlap3c308792007-05-08 00:24:39 -07002176 process_state3_function($_, $file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 } else {
Randy Dunlap3c308792007-05-08 00:24:39 -07002178 process_state3_type($_, $file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 }
2180 } elsif ($state == 4) {
2181 # Documentation block
Randy Dunlap3c308792007-05-08 00:24:39 -07002182 if (/$doc_block/) {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -07002183 dump_doc_section($file, $section, xml_escape($contents));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 $contents = "";
2185 $function = "";
2186 %constants = ();
2187 %parameterdescs = ();
2188 %parametertypes = ();
2189 @parameterlist = ();
2190 %sections = ();
2191 @sectionlist = ();
2192 $prototype = "";
2193 if ( $1 eq "" ) {
2194 $section = $section_intro;
2195 } else {
2196 $section = $1;
2197 }
Randy Dunlap3c308792007-05-08 00:24:39 -07002198 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199 elsif (/$doc_end/)
2200 {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -07002201 dump_doc_section($file, $section, xml_escape($contents));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202 $contents = "";
2203 $function = "";
2204 %constants = ();
2205 %parameterdescs = ();
2206 %parametertypes = ();
2207 @parameterlist = ();
2208 %sections = ();
2209 @sectionlist = ();
2210 $prototype = "";
2211 $state = 0;
2212 }
2213 elsif (/$doc_content/)
2214 {
2215 if ( $1 eq "" )
2216 {
2217 $contents .= $blankline;
2218 }
2219 else
2220 {
2221 $contents .= $1 . "\n";
Randy Dunlap3c3b8092006-02-01 03:06:58 -08002222 }
Randy Dunlap3c308792007-05-08 00:24:39 -07002223 }
2224 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225 }
2226 if ($initial_section_counter == $section_counter) {
2227 print STDERR "Warning(${file}): no structured comments found\n";
2228 if ($output_mode eq "xml") {
2229 # The template wants at least one RefEntry here; make one.
2230 print "<refentry>\n";
2231 print " <refnamediv>\n";
2232 print " <refname>\n";
2233 print " ${file}\n";
2234 print " </refname>\n";
2235 print " <refpurpose>\n";
2236 print " Document generation inconsistency\n";
2237 print " </refpurpose>\n";
2238 print " </refnamediv>\n";
2239 print " <refsect1>\n";
2240 print " <title>\n";
2241 print " Oops\n";
2242 print " </title>\n";
2243 print " <warning>\n";
2244 print " <para>\n";
2245 print " The template for this document tried to insert\n";
2246 print " the structured comment from the file\n";
2247 print " <filename>${file}</filename> at this point,\n";
2248 print " but none was found.\n";
2249 print " This dummy section is inserted to allow\n";
2250 print " generation to continue.\n";
2251 print " </para>\n";
2252 print " </warning>\n";
2253 print " </refsect1>\n";
2254 print "</refentry>\n";
2255 }
2256 }
2257}
Randy Dunlap8484baa2011-01-05 16:28:43 -08002258
2259
2260$kernelversion = get_kernel_version();
2261
2262# generate a sequence of code that will splice in highlighting information
2263# using the s// operator.
2264foreach my $pattern (keys %highlights) {
2265# print STDERR "scanning pattern:$pattern, highlight:($highlights{$pattern})\n";
2266 $dohighlight .= "\$contents =~ s:$pattern:$highlights{$pattern}:gs;\n";
2267}
2268
2269# Read the file that maps relative names to absolute names for
2270# separate source and object directories and for shadow trees.
2271if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2272 my ($relname, $absname);
2273 while(<SOURCE_MAP>) {
2274 chop();
2275 ($relname, $absname) = (split())[0..1];
2276 $relname =~ s:^/+::;
2277 $source_map{$relname} = $absname;
2278 }
2279 close(SOURCE_MAP);
2280}
2281
2282foreach (@ARGV) {
2283 chomp;
2284 process_file($_);
2285}
2286if ($verbose && $errors) {
2287 print STDERR "$errors errors\n";
2288}
2289if ($verbose && $warnings) {
2290 print STDERR "$warnings warnings\n";
2291}
2292
2293exit($errors);