Loading...
1#!/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 ##
8## Copyright (C) 2005-2012 Randy Dunlap ##
9## Copyright (C) 2012 Dan Luedtke ##
10## ##
11## #define enhancements by Armin Kuster <akuster@mvista.com> ##
12## Copyright (c) 2000 MontaVista Software, Inc. ##
13## ##
14## This software falls under the GNU General Public License. ##
15## Please read the COPYING file for more information ##
16
17# 18/01/2001 - Cleanups
18# Functions prototyped as foo(void) same as foo()
19# Stop eval'ing where we don't need to.
20# -- huggie@earth.li
21
22# 27/06/2001 - Allowed whitespace after initial "/**" and
23# allowed comments before function declarations.
24# -- Christian Kreibich <ck@whoop.org>
25
26# Still to do:
27# - add perldoc documentation
28# - Look more closely at some of the scarier bits :)
29
30# 26/05/2001 - Support for separate source and object trees.
31# Return error code.
32# Keith Owens <kaos@ocs.com.au>
33
34# 23/09/2001 - Added support for typedefs, structs, enums and unions
35# Support for Context section; can be terminated using empty line
36# Small fixes (like spaces vs. \s in regex)
37# -- Tim Jansen <tim@tjansen.de>
38
39# 25/07/2012 - Added support for HTML5
40# -- Dan Luedtke <mail@danrl.de>
41
42#
43# This will read a 'c' file and scan for embedded comments in the
44# style of gnome comments (+minor extensions - see below).
45#
46
47# Note: This only supports 'c'.
48
49# usage:
50# kernel-doc [ -docbook | -html | -html5 | -text | -man | -list ]
51# [ -no-doc-sections ]
52# [ -function funcname [ -function funcname ...] ]
53# c file(s)s > outputfile
54# or
55# [ -nofunction funcname [ -function funcname ...] ]
56# c file(s)s > outputfile
57#
58# Set output format using one of -docbook -html -html5 -text or -man.
59# Default is man.
60# The -list format is for internal use by docproc.
61#
62# -no-doc-sections
63# Do not output DOC: sections
64#
65# -function funcname
66# If set, then only generate documentation for the given function(s) or
67# DOC: section titles. All other functions and DOC: sections are ignored.
68#
69# -nofunction funcname
70# If set, then only generate documentation for the other function(s)/DOC:
71# sections. Cannot be used together with -function (yes, that's a bug --
72# perl hackers can fix it 8))
73#
74# c files - list of 'c' files to process
75#
76# All output goes to stdout, with errors to stderr.
77
78#
79# format of comments.
80# In the following table, (...)? signifies optional structure.
81# (...)* signifies 0 or more structure elements
82# /**
83# * function_name(:)? (- short description)?
84# (* @parameterx: (description of parameter x)?)*
85# (* a blank line)?
86# * (Description:)? (Description of function)?
87# * (section header: (section description)? )*
88# (*)?*/
89#
90# So .. the trivial example would be:
91#
92# /**
93# * my_function
94# */
95#
96# If the Description: header tag is omitted, then there must be a blank line
97# after the last parameter specification.
98# e.g.
99# /**
100# * my_function - does my stuff
101# * @my_arg: its mine damnit
102# *
103# * Does my stuff explained.
104# */
105#
106# or, could also use:
107# /**
108# * my_function - does my stuff
109# * @my_arg: its mine damnit
110# * Description: Does my stuff explained.
111# */
112# etc.
113#
114# Besides functions you can also write documentation for structs, unions,
115# enums and typedefs. Instead of the function name you must write the name
116# of the declaration; the struct/union/enum/typedef must always precede
117# the name. Nesting of declarations is not supported.
118# Use the argument mechanism to document members or constants.
119# e.g.
120# /**
121# * struct my_struct - short description
122# * @a: first member
123# * @b: second member
124# *
125# * Longer description
126# */
127# struct my_struct {
128# int a;
129# int b;
130# /* private: */
131# int c;
132# };
133#
134# All descriptions can be multiline, except the short function description.
135#
136# For really longs structs, you can also describe arguments inside the
137# body of the struct.
138# eg.
139# /**
140# * struct my_struct - short description
141# * @a: first member
142# * @b: second member
143# *
144# * Longer description
145# */
146# struct my_struct {
147# int a;
148# int b;
149# /**
150# * @c: This is longer description of C
151# *
152# * You can use paragraphs to describe arguments
153# * using this method.
154# */
155# int c;
156# };
157#
158# This should be use only for struct/enum members.
159#
160# You can also add additional sections. When documenting kernel functions you
161# should document the "Context:" of the function, e.g. whether the functions
162# can be called form interrupts. Unlike other sections you can end it with an
163# empty line.
164# A non-void function should have a "Return:" section describing the return
165# value(s).
166# Example-sections should contain the string EXAMPLE so that they are marked
167# appropriately in DocBook.
168#
169# Example:
170# /**
171# * user_function - function that can only be called in user context
172# * @a: some argument
173# * Context: !in_interrupt()
174# *
175# * Some description
176# * Example:
177# * user_function(22);
178# */
179# ...
180#
181#
182# All descriptive text is further processed, scanning for the following special
183# patterns, which are highlighted appropriately.
184#
185# 'funcname()' - function
186# '$ENVVAR' - environmental variable
187# '&struct_name' - name of a structure (up to two words including 'struct')
188# '@parameter' - name of a parameter
189# '%CONST' - name of a constant.
190
191## init lots of data
192
193my $errors = 0;
194my $warnings = 0;
195my $anon_struct_union = 0;
196
197# match expressions used to find embedded type information
198my $type_constant = '\%([-_\w]+)';
199my $type_func = '(\w+)\(\)';
200my $type_param = '\@(\w+)';
201my $type_struct = '\&((struct\s*)*[_\w]+)';
202my $type_struct_xml = '\\&((struct\s*)*[_\w]+)';
203my $type_env = '(\$\w+)';
204
205# Output conversion substitutions.
206# One for each output format
207
208# these work fairly well
209my @highlights_html = (
210 [$type_constant, "<i>\$1</i>"],
211 [$type_func, "<b>\$1</b>"],
212 [$type_struct_xml, "<i>\$1</i>"],
213 [$type_env, "<b><i>\$1</i></b>"],
214 [$type_param, "<tt><b>\$1</b></tt>"]
215 );
216my $local_lt = "\\\\\\\\lt:";
217my $local_gt = "\\\\\\\\gt:";
218my $blankline_html = $local_lt . "p" . $local_gt; # was "<p>"
219
220# html version 5
221my @highlights_html5 = (
222 [$type_constant, "<span class=\"const\">\$1</span>"],
223 [$type_func, "<span class=\"func\">\$1</span>"],
224 [$type_struct_xml, "<span class=\"struct\">\$1</span>"],
225 [$type_env, "<span class=\"env\">\$1</span>"],
226 [$type_param, "<span class=\"param\">\$1</span>]"]
227 );
228my $blankline_html5 = $local_lt . "br /" . $local_gt;
229
230# XML, docbook format
231my @highlights_xml = (
232 ["([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>"],
233 [$type_constant, "<constant>\$1</constant>"],
234 [$type_struct_xml, "<structname>\$1</structname>"],
235 [$type_param, "<parameter>\$1</parameter>"],
236 [$type_func, "<function>\$1</function>"],
237 [$type_env, "<envar>\$1</envar>"]
238 );
239my $blankline_xml = $local_lt . "/para" . $local_gt . $local_lt . "para" . $local_gt . "\n";
240
241# gnome, docbook format
242my @highlights_gnome = (
243 [$type_constant, "<replaceable class=\"option\">\$1</replaceable>"],
244 [$type_func, "<function>\$1</function>"],
245 [$type_struct, "<structname>\$1</structname>"],
246 [$type_env, "<envar>\$1</envar>"],
247 [$type_param, "<parameter>\$1</parameter>" ]
248 );
249my $blankline_gnome = "</para><para>\n";
250
251# these are pretty rough
252my @highlights_man = (
253 [$type_constant, "\$1"],
254 [$type_func, "\\\\fB\$1\\\\fP"],
255 [$type_struct, "\\\\fI\$1\\\\fP"],
256 [$type_param, "\\\\fI\$1\\\\fP"]
257 );
258my $blankline_man = "";
259
260# text-mode
261my @highlights_text = (
262 [$type_constant, "\$1"],
263 [$type_func, "\$1"],
264 [$type_struct, "\$1"],
265 [$type_param, "\$1"]
266 );
267my $blankline_text = "";
268
269# list mode
270my @highlights_list = (
271 [$type_constant, "\$1"],
272 [$type_func, "\$1"],
273 [$type_struct, "\$1"],
274 [$type_param, "\$1"]
275 );
276my $blankline_list = "";
277
278# read arguments
279if ($#ARGV == -1) {
280 usage();
281}
282
283my $kernelversion;
284my $dohighlight = "";
285
286my $verbose = 0;
287my $output_mode = "man";
288my $output_preformatted = 0;
289my $no_doc_sections = 0;
290my @highlights = @highlights_man;
291my $blankline = $blankline_man;
292my $modulename = "Kernel API";
293my $function_only = 0;
294my $show_not_found = 0;
295
296my @build_time;
297if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) &&
298 (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') {
299 @build_time = gmtime($seconds);
300} else {
301 @build_time = localtime;
302}
303
304my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
305 'July', 'August', 'September', 'October',
306 'November', 'December')[$build_time[4]] .
307 " " . ($build_time[5]+1900);
308
309# Essentially these are globals.
310# They probably want to be tidied up, made more localised or something.
311# CAVEAT EMPTOR! Some of the others I localised may not want to be, which
312# could cause "use of undefined value" or other bugs.
313my ($function, %function_table, %parametertypes, $declaration_purpose);
314my ($type, $declaration_name, $return_type);
315my ($newsection, $newcontents, $prototype, $brcount, %source_map);
316
317if (defined($ENV{'KBUILD_VERBOSE'})) {
318 $verbose = "$ENV{'KBUILD_VERBOSE'}";
319}
320
321# Generated docbook code is inserted in a template at a point where
322# docbook v3.1 requires a non-zero sequence of RefEntry's; see:
323# http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
324# We keep track of number of generated entries and generate a dummy
325# if needs be to ensure the expanded template can be postprocessed
326# into html.
327my $section_counter = 0;
328
329my $lineprefix="";
330
331# states
332# 0 - normal code
333# 1 - looking for function name
334# 2 - scanning field start.
335# 3 - scanning prototype.
336# 4 - documentation block
337# 5 - gathering documentation outside main block
338my $state;
339my $in_doc_sect;
340
341# Split Doc State
342# 0 - Invalid (Before start or after finish)
343# 1 - Is started (the /** was found inside a struct)
344# 2 - The @parameter header was found, start accepting multi paragraph text.
345# 3 - Finished (the */ was found)
346# 4 - Error - Comment without header was found. Spit a warning as it's not
347# proper kernel-doc and ignore the rest.
348my $split_doc_state;
349
350#declaration types: can be
351# 'function', 'struct', 'union', 'enum', 'typedef'
352my $decl_type;
353
354my $doc_special = "\@\%\$\&";
355
356my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
357my $doc_end = '\*/';
358my $doc_com = '\s*\*\s*';
359my $doc_com_body = '\s*\* ?';
360my $doc_decl = $doc_com . '(\w+)';
361my $doc_sect = $doc_com . '([' . $doc_special . ']?[\w\s]+):(.*)';
362my $doc_content = $doc_com_body . '(.*)';
363my $doc_block = $doc_com . 'DOC:\s*(.*)?';
364my $doc_split_start = '^\s*/\*\*\s*$';
365my $doc_split_sect = '\s*\*\s*(@[\w\s]+):(.*)';
366my $doc_split_end = '^\s*\*/\s*$';
367
368my %constants;
369my %parameterdescs;
370my @parameterlist;
371my %sections;
372my @sectionlist;
373my $sectcheck;
374my $struct_actual;
375
376my $contents = "";
377my $section_default = "Description"; # default section
378my $section_intro = "Introduction";
379my $section = $section_default;
380my $section_context = "Context";
381my $section_return = "Return";
382
383my $undescribed = "-- undescribed --";
384
385reset_state();
386
387while ($ARGV[0] =~ m/^-(.*)/) {
388 my $cmd = shift @ARGV;
389 if ($cmd eq "-html") {
390 $output_mode = "html";
391 @highlights = @highlights_html;
392 $blankline = $blankline_html;
393 } elsif ($cmd eq "-html5") {
394 $output_mode = "html5";
395 @highlights = @highlights_html5;
396 $blankline = $blankline_html5;
397 } elsif ($cmd eq "-man") {
398 $output_mode = "man";
399 @highlights = @highlights_man;
400 $blankline = $blankline_man;
401 } elsif ($cmd eq "-text") {
402 $output_mode = "text";
403 @highlights = @highlights_text;
404 $blankline = $blankline_text;
405 } elsif ($cmd eq "-docbook") {
406 $output_mode = "xml";
407 @highlights = @highlights_xml;
408 $blankline = $blankline_xml;
409 } elsif ($cmd eq "-list") {
410 $output_mode = "list";
411 @highlights = @highlights_list;
412 $blankline = $blankline_list;
413 } elsif ($cmd eq "-gnome") {
414 $output_mode = "gnome";
415 @highlights = @highlights_gnome;
416 $blankline = $blankline_gnome;
417 } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document
418 $modulename = shift @ARGV;
419 } elsif ($cmd eq "-function") { # to only output specific functions
420 $function_only = 1;
421 $function = shift @ARGV;
422 $function_table{$function} = 1;
423 } elsif ($cmd eq "-nofunction") { # to only output specific functions
424 $function_only = 2;
425 $function = shift @ARGV;
426 $function_table{$function} = 1;
427 } elsif ($cmd eq "-v") {
428 $verbose = 1;
429 } elsif (($cmd eq "-h") || ($cmd eq "--help")) {
430 usage();
431 } elsif ($cmd eq '-no-doc-sections') {
432 $no_doc_sections = 1;
433 } elsif ($cmd eq '-show-not-found') {
434 $show_not_found = 1;
435 }
436}
437
438# continue execution near EOF;
439
440sub usage {
441 print "Usage: $0 [ -docbook | -html | -html5 | -text | -man | -list ]\n";
442 print " [ -no-doc-sections ]\n";
443 print " [ -function funcname [ -function funcname ...] ]\n";
444 print " [ -nofunction funcname [ -nofunction funcname ...] ]\n";
445 print " [ -v ]\n";
446 print " c source file(s) > outputfile\n";
447 print " -v : verbose output, more warnings & other info listed\n";
448 exit 1;
449}
450
451# get kernel version from env
452sub get_kernel_version() {
453 my $version = 'unknown kernel version';
454
455 if (defined($ENV{'KERNELVERSION'})) {
456 $version = $ENV{'KERNELVERSION'};
457 }
458 return $version;
459}
460
461##
462# dumps section contents to arrays/hashes intended for that purpose.
463#
464sub dump_section {
465 my $file = shift;
466 my $name = shift;
467 my $contents = join "\n", @_;
468
469 if ($name =~ m/$type_constant/) {
470 $name = $1;
471# print STDERR "constant section '$1' = '$contents'\n";
472 $constants{$name} = $contents;
473 } elsif ($name =~ m/$type_param/) {
474# print STDERR "parameter def '$1' = '$contents'\n";
475 $name = $1;
476 $parameterdescs{$name} = $contents;
477 $sectcheck = $sectcheck . $name . " ";
478 } elsif ($name eq "@\.\.\.") {
479# print STDERR "parameter def '...' = '$contents'\n";
480 $name = "...";
481 $parameterdescs{$name} = $contents;
482 $sectcheck = $sectcheck . $name . " ";
483 } else {
484# print STDERR "other section '$name' = '$contents'\n";
485 if (defined($sections{$name}) && ($sections{$name} ne "")) {
486 print STDERR "${file}:$.: error: duplicate section name '$name'\n";
487 ++$errors;
488 }
489 $sections{$name} = $contents;
490 push @sectionlist, $name;
491 }
492}
493
494##
495# dump DOC: section after checking that it should go out
496#
497sub dump_doc_section {
498 my $file = shift;
499 my $name = shift;
500 my $contents = join "\n", @_;
501
502 if ($no_doc_sections) {
503 return;
504 }
505
506 if (($function_only == 0) ||
507 ( $function_only == 1 && defined($function_table{$name})) ||
508 ( $function_only == 2 && !defined($function_table{$name})))
509 {
510 dump_section($file, $name, $contents);
511 output_blockhead({'sectionlist' => \@sectionlist,
512 'sections' => \%sections,
513 'module' => $modulename,
514 'content-only' => ($function_only != 0), });
515 }
516}
517
518##
519# output function
520#
521# parameterdescs, a hash.
522# function => "function name"
523# parameterlist => @list of parameters
524# parameterdescs => %parameter descriptions
525# sectionlist => @list of sections
526# sections => %section descriptions
527#
528
529sub output_highlight {
530 my $contents = join "\n",@_;
531 my $line;
532
533# DEBUG
534# if (!defined $contents) {
535# use Carp;
536# confess "output_highlight got called with no args?\n";
537# }
538
539 if ($output_mode eq "html" || $output_mode eq "html5" ||
540 $output_mode eq "xml") {
541 $contents = local_unescape($contents);
542 # convert data read & converted thru xml_escape() into &xyz; format:
543 $contents =~ s/\\\\\\/\&/g;
544 }
545# print STDERR "contents b4:$contents\n";
546 eval $dohighlight;
547 die $@ if $@;
548# print STDERR "contents af:$contents\n";
549
550# strip whitespaces when generating html5
551 if ($output_mode eq "html5") {
552 $contents =~ s/^\s+//;
553 $contents =~ s/\s+$//;
554 }
555 foreach $line (split "\n", $contents) {
556 if (! $output_preformatted) {
557 $line =~ s/^\s*//;
558 }
559 if ($line eq ""){
560 if (! $output_preformatted) {
561 print $lineprefix, local_unescape($blankline);
562 }
563 } else {
564 $line =~ s/\\\\\\/\&/g;
565 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
566 print "\\&$line";
567 } else {
568 print $lineprefix, $line;
569 }
570 }
571 print "\n";
572 }
573}
574
575# output sections in html
576sub output_section_html(%) {
577 my %args = %{$_[0]};
578 my $section;
579
580 foreach $section (@{$args{'sectionlist'}}) {
581 print "<h3>$section</h3>\n";
582 print "<blockquote>\n";
583 output_highlight($args{'sections'}{$section});
584 print "</blockquote>\n";
585 }
586}
587
588# output enum in html
589sub output_enum_html(%) {
590 my %args = %{$_[0]};
591 my ($parameter);
592 my $count;
593 print "<h2>enum " . $args{'enum'} . "</h2>\n";
594
595 print "<b>enum " . $args{'enum'} . "</b> {<br>\n";
596 $count = 0;
597 foreach $parameter (@{$args{'parameterlist'}}) {
598 print " <b>" . $parameter . "</b>";
599 if ($count != $#{$args{'parameterlist'}}) {
600 $count++;
601 print ",\n";
602 }
603 print "<br>";
604 }
605 print "};<br>\n";
606
607 print "<h3>Constants</h3>\n";
608 print "<dl>\n";
609 foreach $parameter (@{$args{'parameterlist'}}) {
610 print "<dt><b>" . $parameter . "</b>\n";
611 print "<dd>";
612 output_highlight($args{'parameterdescs'}{$parameter});
613 }
614 print "</dl>\n";
615 output_section_html(@_);
616 print "<hr>\n";
617}
618
619# output typedef in html
620sub output_typedef_html(%) {
621 my %args = %{$_[0]};
622 my ($parameter);
623 my $count;
624 print "<h2>typedef " . $args{'typedef'} . "</h2>\n";
625
626 print "<b>typedef " . $args{'typedef'} . "</b>\n";
627 output_section_html(@_);
628 print "<hr>\n";
629}
630
631# output struct in html
632sub output_struct_html(%) {
633 my %args = %{$_[0]};
634 my ($parameter);
635
636 print "<h2>" . $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "</h2>\n";
637 print "<b>" . $args{'type'} . " " . $args{'struct'} . "</b> {<br>\n";
638 foreach $parameter (@{$args{'parameterlist'}}) {
639 if ($parameter =~ /^#/) {
640 print "$parameter<br>\n";
641 next;
642 }
643 my $parameter_name = $parameter;
644 $parameter_name =~ s/\[.*//;
645
646 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
647 $type = $args{'parametertypes'}{$parameter};
648 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
649 # pointer-to-function
650 print " <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>\n";
651 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
652 # bitfield
653 print " <i>$1</i> <b>$parameter</b>$2;<br>\n";
654 } else {
655 print " <i>$type</i> <b>$parameter</b>;<br>\n";
656 }
657 }
658 print "};<br>\n";
659
660 print "<h3>Members</h3>\n";
661 print "<dl>\n";
662 foreach $parameter (@{$args{'parameterlist'}}) {
663 ($parameter =~ /^#/) && next;
664
665 my $parameter_name = $parameter;
666 $parameter_name =~ s/\[.*//;
667
668 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
669 print "<dt><b>" . $parameter . "</b>\n";
670 print "<dd>";
671 output_highlight($args{'parameterdescs'}{$parameter_name});
672 }
673 print "</dl>\n";
674 output_section_html(@_);
675 print "<hr>\n";
676}
677
678# output function in html
679sub output_function_html(%) {
680 my %args = %{$_[0]};
681 my ($parameter, $section);
682 my $count;
683
684 print "<h2>" . $args{'function'} . " - " . $args{'purpose'} . "</h2>\n";
685 print "<i>" . $args{'functiontype'} . "</i>\n";
686 print "<b>" . $args{'function'} . "</b>\n";
687 print "(";
688 $count = 0;
689 foreach $parameter (@{$args{'parameterlist'}}) {
690 $type = $args{'parametertypes'}{$parameter};
691 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
692 # pointer-to-function
693 print "<i>$1</i><b>$parameter</b>) <i>($2)</i>";
694 } else {
695 print "<i>" . $type . "</i> <b>" . $parameter . "</b>";
696 }
697 if ($count != $#{$args{'parameterlist'}}) {
698 $count++;
699 print ",\n";
700 }
701 }
702 print ")\n";
703
704 print "<h3>Arguments</h3>\n";
705 print "<dl>\n";
706 foreach $parameter (@{$args{'parameterlist'}}) {
707 my $parameter_name = $parameter;
708 $parameter_name =~ s/\[.*//;
709
710 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
711 print "<dt><b>" . $parameter . "</b>\n";
712 print "<dd>";
713 output_highlight($args{'parameterdescs'}{$parameter_name});
714 }
715 print "</dl>\n";
716 output_section_html(@_);
717 print "<hr>\n";
718}
719
720# output DOC: block header in html
721sub output_blockhead_html(%) {
722 my %args = %{$_[0]};
723 my ($parameter, $section);
724 my $count;
725
726 foreach $section (@{$args{'sectionlist'}}) {
727 print "<h3>$section</h3>\n";
728 print "<ul>\n";
729 output_highlight($args{'sections'}{$section});
730 print "</ul>\n";
731 }
732 print "<hr>\n";
733}
734
735# output sections in html5
736sub output_section_html5(%) {
737 my %args = %{$_[0]};
738 my $section;
739
740 foreach $section (@{$args{'sectionlist'}}) {
741 print "<section>\n";
742 print "<h1>$section</h1>\n";
743 print "<p>\n";
744 output_highlight($args{'sections'}{$section});
745 print "</p>\n";
746 print "</section>\n";
747 }
748}
749
750# output enum in html5
751sub output_enum_html5(%) {
752 my %args = %{$_[0]};
753 my ($parameter);
754 my $count;
755 my $html5id;
756
757 $html5id = $args{'enum'};
758 $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
759 print "<article class=\"enum\" id=\"enum:". $html5id . "\">";
760 print "<h1>enum " . $args{'enum'} . "</h1>\n";
761 print "<ol class=\"code\">\n";
762 print "<li>";
763 print "<span class=\"keyword\">enum</span> ";
764 print "<span class=\"identifier\">" . $args{'enum'} . "</span> {";
765 print "</li>\n";
766 $count = 0;
767 foreach $parameter (@{$args{'parameterlist'}}) {
768 print "<li class=\"indent\">";
769 print "<span class=\"param\">" . $parameter . "</span>";
770 if ($count != $#{$args{'parameterlist'}}) {
771 $count++;
772 print ",";
773 }
774 print "</li>\n";
775 }
776 print "<li>};</li>\n";
777 print "</ol>\n";
778
779 print "<section>\n";
780 print "<h1>Constants</h1>\n";
781 print "<dl>\n";
782 foreach $parameter (@{$args{'parameterlist'}}) {
783 print "<dt>" . $parameter . "</dt>\n";
784 print "<dd>";
785 output_highlight($args{'parameterdescs'}{$parameter});
786 print "</dd>\n";
787 }
788 print "</dl>\n";
789 print "</section>\n";
790 output_section_html5(@_);
791 print "</article>\n";
792}
793
794# output typedef in html5
795sub output_typedef_html5(%) {
796 my %args = %{$_[0]};
797 my ($parameter);
798 my $count;
799 my $html5id;
800
801 $html5id = $args{'typedef'};
802 $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
803 print "<article class=\"typedef\" id=\"typedef:" . $html5id . "\">\n";
804 print "<h1>typedef " . $args{'typedef'} . "</h1>\n";
805
806 print "<ol class=\"code\">\n";
807 print "<li>";
808 print "<span class=\"keyword\">typedef</span> ";
809 print "<span class=\"identifier\">" . $args{'typedef'} . "</span>";
810 print "</li>\n";
811 print "</ol>\n";
812 output_section_html5(@_);
813 print "</article>\n";
814}
815
816# output struct in html5
817sub output_struct_html5(%) {
818 my %args = %{$_[0]};
819 my ($parameter);
820 my $html5id;
821
822 $html5id = $args{'struct'};
823 $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
824 print "<article class=\"struct\" id=\"struct:" . $html5id . "\">\n";
825 print "<hgroup>\n";
826 print "<h1>" . $args{'type'} . " " . $args{'struct'} . "</h1>";
827 print "<h2>". $args{'purpose'} . "</h2>\n";
828 print "</hgroup>\n";
829 print "<ol class=\"code\">\n";
830 print "<li>";
831 print "<span class=\"type\">" . $args{'type'} . "</span> ";
832 print "<span class=\"identifier\">" . $args{'struct'} . "</span> {";
833 print "</li>\n";
834 foreach $parameter (@{$args{'parameterlist'}}) {
835 print "<li class=\"indent\">";
836 if ($parameter =~ /^#/) {
837 print "<span class=\"param\">" . $parameter ."</span>\n";
838 print "</li>\n";
839 next;
840 }
841 my $parameter_name = $parameter;
842 $parameter_name =~ s/\[.*//;
843
844 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
845 $type = $args{'parametertypes'}{$parameter};
846 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
847 # pointer-to-function
848 print "<span class=\"type\">$1</span> ";
849 print "<span class=\"param\">$parameter</span>";
850 print "<span class=\"type\">)</span> ";
851 print "(<span class=\"args\">$2</span>);";
852 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
853 # bitfield
854 print "<span class=\"type\">$1</span> ";
855 print "<span class=\"param\">$parameter</span>";
856 print "<span class=\"bits\">$2</span>;";
857 } else {
858 print "<span class=\"type\">$type</span> ";
859 print "<span class=\"param\">$parameter</span>;";
860 }
861 print "</li>\n";
862 }
863 print "<li>};</li>\n";
864 print "</ol>\n";
865
866 print "<section>\n";
867 print "<h1>Members</h1>\n";
868 print "<dl>\n";
869 foreach $parameter (@{$args{'parameterlist'}}) {
870 ($parameter =~ /^#/) && next;
871
872 my $parameter_name = $parameter;
873 $parameter_name =~ s/\[.*//;
874
875 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
876 print "<dt>" . $parameter . "</dt>\n";
877 print "<dd>";
878 output_highlight($args{'parameterdescs'}{$parameter_name});
879 print "</dd>\n";
880 }
881 print "</dl>\n";
882 print "</section>\n";
883 output_section_html5(@_);
884 print "</article>\n";
885}
886
887# output function in html5
888sub output_function_html5(%) {
889 my %args = %{$_[0]};
890 my ($parameter, $section);
891 my $count;
892 my $html5id;
893
894 $html5id = $args{'function'};
895 $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
896 print "<article class=\"function\" id=\"func:". $html5id . "\">\n";
897 print "<hgroup>\n";
898 print "<h1>" . $args{'function'} . "</h1>";
899 print "<h2>" . $args{'purpose'} . "</h2>\n";
900 print "</hgroup>\n";
901 print "<ol class=\"code\">\n";
902 print "<li>";
903 print "<span class=\"type\">" . $args{'functiontype'} . "</span> ";
904 print "<span class=\"identifier\">" . $args{'function'} . "</span> (";
905 print "</li>";
906 $count = 0;
907 foreach $parameter (@{$args{'parameterlist'}}) {
908 print "<li class=\"indent\">";
909 $type = $args{'parametertypes'}{$parameter};
910 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
911 # pointer-to-function
912 print "<span class=\"type\">$1</span> ";
913 print "<span class=\"param\">$parameter</span>";
914 print "<span class=\"type\">)</span> ";
915 print "(<span class=\"args\">$2</span>)";
916 } else {
917 print "<span class=\"type\">$type</span> ";
918 print "<span class=\"param\">$parameter</span>";
919 }
920 if ($count != $#{$args{'parameterlist'}}) {
921 $count++;
922 print ",";
923 }
924 print "</li>\n";
925 }
926 print "<li>)</li>\n";
927 print "</ol>\n";
928
929 print "<section>\n";
930 print "<h1>Arguments</h1>\n";
931 print "<p>\n";
932 print "<dl>\n";
933 foreach $parameter (@{$args{'parameterlist'}}) {
934 my $parameter_name = $parameter;
935 $parameter_name =~ s/\[.*//;
936
937 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
938 print "<dt>" . $parameter . "</dt>\n";
939 print "<dd>";
940 output_highlight($args{'parameterdescs'}{$parameter_name});
941 print "</dd>\n";
942 }
943 print "</dl>\n";
944 print "</section>\n";
945 output_section_html5(@_);
946 print "</article>\n";
947}
948
949# output DOC: block header in html5
950sub output_blockhead_html5(%) {
951 my %args = %{$_[0]};
952 my ($parameter, $section);
953 my $count;
954 my $html5id;
955
956 foreach $section (@{$args{'sectionlist'}}) {
957 $html5id = $section;
958 $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
959 print "<article class=\"doc\" id=\"doc:". $html5id . "\">\n";
960 print "<h1>$section</h1>\n";
961 print "<p>\n";
962 output_highlight($args{'sections'}{$section});
963 print "</p>\n";
964 }
965 print "</article>\n";
966}
967
968sub output_section_xml(%) {
969 my %args = %{$_[0]};
970 my $section;
971 # print out each section
972 $lineprefix=" ";
973 foreach $section (@{$args{'sectionlist'}}) {
974 print "<refsect1>\n";
975 print "<title>$section</title>\n";
976 if ($section =~ m/EXAMPLE/i) {
977 print "<informalexample><programlisting>\n";
978 $output_preformatted = 1;
979 } else {
980 print "<para>\n";
981 }
982 output_highlight($args{'sections'}{$section});
983 $output_preformatted = 0;
984 if ($section =~ m/EXAMPLE/i) {
985 print "</programlisting></informalexample>\n";
986 } else {
987 print "</para>\n";
988 }
989 print "</refsect1>\n";
990 }
991}
992
993# output function in XML DocBook
994sub output_function_xml(%) {
995 my %args = %{$_[0]};
996 my ($parameter, $section);
997 my $count;
998 my $id;
999
1000 $id = "API-" . $args{'function'};
1001 $id =~ s/[^A-Za-z0-9]/-/g;
1002
1003 print "<refentry id=\"$id\">\n";
1004 print "<refentryinfo>\n";
1005 print " <title>LINUX</title>\n";
1006 print " <productname>Kernel Hackers Manual</productname>\n";
1007 print " <date>$man_date</date>\n";
1008 print "</refentryinfo>\n";
1009 print "<refmeta>\n";
1010 print " <refentrytitle><phrase>" . $args{'function'} . "</phrase></refentrytitle>\n";
1011 print " <manvolnum>9</manvolnum>\n";
1012 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
1013 print "</refmeta>\n";
1014 print "<refnamediv>\n";
1015 print " <refname>" . $args{'function'} . "</refname>\n";
1016 print " <refpurpose>\n";
1017 print " ";
1018 output_highlight ($args{'purpose'});
1019 print " </refpurpose>\n";
1020 print "</refnamediv>\n";
1021
1022 print "<refsynopsisdiv>\n";
1023 print " <title>Synopsis</title>\n";
1024 print " <funcsynopsis><funcprototype>\n";
1025 print " <funcdef>" . $args{'functiontype'} . " ";
1026 print "<function>" . $args{'function'} . " </function></funcdef>\n";
1027
1028 $count = 0;
1029 if ($#{$args{'parameterlist'}} >= 0) {
1030 foreach $parameter (@{$args{'parameterlist'}}) {
1031 $type = $args{'parametertypes'}{$parameter};
1032 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1033 # pointer-to-function
1034 print " <paramdef>$1<parameter>$parameter</parameter>)\n";
1035 print " <funcparams>$2</funcparams></paramdef>\n";
1036 } else {
1037 print " <paramdef>" . $type;
1038 print " <parameter>$parameter</parameter></paramdef>\n";
1039 }
1040 }
1041 } else {
1042 print " <void/>\n";
1043 }
1044 print " </funcprototype></funcsynopsis>\n";
1045 print "</refsynopsisdiv>\n";
1046
1047 # print parameters
1048 print "<refsect1>\n <title>Arguments</title>\n";
1049 if ($#{$args{'parameterlist'}} >= 0) {
1050 print " <variablelist>\n";
1051 foreach $parameter (@{$args{'parameterlist'}}) {
1052 my $parameter_name = $parameter;
1053 $parameter_name =~ s/\[.*//;
1054
1055 print " <varlistentry>\n <term><parameter>$parameter</parameter></term>\n";
1056 print " <listitem>\n <para>\n";
1057 $lineprefix=" ";
1058 output_highlight($args{'parameterdescs'}{$parameter_name});
1059 print " </para>\n </listitem>\n </varlistentry>\n";
1060 }
1061 print " </variablelist>\n";
1062 } else {
1063 print " <para>\n None\n </para>\n";
1064 }
1065 print "</refsect1>\n";
1066
1067 output_section_xml(@_);
1068 print "</refentry>\n\n";
1069}
1070
1071# output struct in XML DocBook
1072sub output_struct_xml(%) {
1073 my %args = %{$_[0]};
1074 my ($parameter, $section);
1075 my $id;
1076
1077 $id = "API-struct-" . $args{'struct'};
1078 $id =~ s/[^A-Za-z0-9]/-/g;
1079
1080 print "<refentry id=\"$id\">\n";
1081 print "<refentryinfo>\n";
1082 print " <title>LINUX</title>\n";
1083 print " <productname>Kernel Hackers Manual</productname>\n";
1084 print " <date>$man_date</date>\n";
1085 print "</refentryinfo>\n";
1086 print "<refmeta>\n";
1087 print " <refentrytitle><phrase>" . $args{'type'} . " " . $args{'struct'} . "</phrase></refentrytitle>\n";
1088 print " <manvolnum>9</manvolnum>\n";
1089 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
1090 print "</refmeta>\n";
1091 print "<refnamediv>\n";
1092 print " <refname>" . $args{'type'} . " " . $args{'struct'} . "</refname>\n";
1093 print " <refpurpose>\n";
1094 print " ";
1095 output_highlight ($args{'purpose'});
1096 print " </refpurpose>\n";
1097 print "</refnamediv>\n";
1098
1099 print "<refsynopsisdiv>\n";
1100 print " <title>Synopsis</title>\n";
1101 print " <programlisting>\n";
1102 print $args{'type'} . " " . $args{'struct'} . " {\n";
1103 foreach $parameter (@{$args{'parameterlist'}}) {
1104 if ($parameter =~ /^#/) {
1105 my $prm = $parameter;
1106 # convert data read & converted thru xml_escape() into &xyz; format:
1107 # This allows us to have #define macros interspersed in a struct.
1108 $prm =~ s/\\\\\\/\&/g;
1109 print "$prm\n";
1110 next;
1111 }
1112
1113 my $parameter_name = $parameter;
1114 $parameter_name =~ s/\[.*//;
1115
1116 defined($args{'parameterdescs'}{$parameter_name}) || next;
1117 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1118 $type = $args{'parametertypes'}{$parameter};
1119 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1120 # pointer-to-function
1121 print " $1 $parameter) ($2);\n";
1122 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1123 # bitfield
1124 print " $1 $parameter$2;\n";
1125 } else {
1126 print " " . $type . " " . $parameter . ";\n";
1127 }
1128 }
1129 print "};";
1130 print " </programlisting>\n";
1131 print "</refsynopsisdiv>\n";
1132
1133 print " <refsect1>\n";
1134 print " <title>Members</title>\n";
1135
1136 if ($#{$args{'parameterlist'}} >= 0) {
1137 print " <variablelist>\n";
1138 foreach $parameter (@{$args{'parameterlist'}}) {
1139 ($parameter =~ /^#/) && next;
1140
1141 my $parameter_name = $parameter;
1142 $parameter_name =~ s/\[.*//;
1143
1144 defined($args{'parameterdescs'}{$parameter_name}) || next;
1145 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1146 print " <varlistentry>";
1147 print " <term>$parameter</term>\n";
1148 print " <listitem><para>\n";
1149 output_highlight($args{'parameterdescs'}{$parameter_name});
1150 print " </para></listitem>\n";
1151 print " </varlistentry>\n";
1152 }
1153 print " </variablelist>\n";
1154 } else {
1155 print " <para>\n None\n </para>\n";
1156 }
1157 print " </refsect1>\n";
1158
1159 output_section_xml(@_);
1160
1161 print "</refentry>\n\n";
1162}
1163
1164# output enum in XML DocBook
1165sub output_enum_xml(%) {
1166 my %args = %{$_[0]};
1167 my ($parameter, $section);
1168 my $count;
1169 my $id;
1170
1171 $id = "API-enum-" . $args{'enum'};
1172 $id =~ s/[^A-Za-z0-9]/-/g;
1173
1174 print "<refentry id=\"$id\">\n";
1175 print "<refentryinfo>\n";
1176 print " <title>LINUX</title>\n";
1177 print " <productname>Kernel Hackers Manual</productname>\n";
1178 print " <date>$man_date</date>\n";
1179 print "</refentryinfo>\n";
1180 print "<refmeta>\n";
1181 print " <refentrytitle><phrase>enum " . $args{'enum'} . "</phrase></refentrytitle>\n";
1182 print " <manvolnum>9</manvolnum>\n";
1183 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
1184 print "</refmeta>\n";
1185 print "<refnamediv>\n";
1186 print " <refname>enum " . $args{'enum'} . "</refname>\n";
1187 print " <refpurpose>\n";
1188 print " ";
1189 output_highlight ($args{'purpose'});
1190 print " </refpurpose>\n";
1191 print "</refnamediv>\n";
1192
1193 print "<refsynopsisdiv>\n";
1194 print " <title>Synopsis</title>\n";
1195 print " <programlisting>\n";
1196 print "enum " . $args{'enum'} . " {\n";
1197 $count = 0;
1198 foreach $parameter (@{$args{'parameterlist'}}) {
1199 print " $parameter";
1200 if ($count != $#{$args{'parameterlist'}}) {
1201 $count++;
1202 print ",";
1203 }
1204 print "\n";
1205 }
1206 print "};";
1207 print " </programlisting>\n";
1208 print "</refsynopsisdiv>\n";
1209
1210 print "<refsect1>\n";
1211 print " <title>Constants</title>\n";
1212 print " <variablelist>\n";
1213 foreach $parameter (@{$args{'parameterlist'}}) {
1214 my $parameter_name = $parameter;
1215 $parameter_name =~ s/\[.*//;
1216
1217 print " <varlistentry>";
1218 print " <term>$parameter</term>\n";
1219 print " <listitem><para>\n";
1220 output_highlight($args{'parameterdescs'}{$parameter_name});
1221 print " </para></listitem>\n";
1222 print " </varlistentry>\n";
1223 }
1224 print " </variablelist>\n";
1225 print "</refsect1>\n";
1226
1227 output_section_xml(@_);
1228
1229 print "</refentry>\n\n";
1230}
1231
1232# output typedef in XML DocBook
1233sub output_typedef_xml(%) {
1234 my %args = %{$_[0]};
1235 my ($parameter, $section);
1236 my $id;
1237
1238 $id = "API-typedef-" . $args{'typedef'};
1239 $id =~ s/[^A-Za-z0-9]/-/g;
1240
1241 print "<refentry id=\"$id\">\n";
1242 print "<refentryinfo>\n";
1243 print " <title>LINUX</title>\n";
1244 print " <productname>Kernel Hackers Manual</productname>\n";
1245 print " <date>$man_date</date>\n";
1246 print "</refentryinfo>\n";
1247 print "<refmeta>\n";
1248 print " <refentrytitle><phrase>typedef " . $args{'typedef'} . "</phrase></refentrytitle>\n";
1249 print " <manvolnum>9</manvolnum>\n";
1250 print "</refmeta>\n";
1251 print "<refnamediv>\n";
1252 print " <refname>typedef " . $args{'typedef'} . "</refname>\n";
1253 print " <refpurpose>\n";
1254 print " ";
1255 output_highlight ($args{'purpose'});
1256 print " </refpurpose>\n";
1257 print "</refnamediv>\n";
1258
1259 print "<refsynopsisdiv>\n";
1260 print " <title>Synopsis</title>\n";
1261 print " <synopsis>typedef " . $args{'typedef'} . ";</synopsis>\n";
1262 print "</refsynopsisdiv>\n";
1263
1264 output_section_xml(@_);
1265
1266 print "</refentry>\n\n";
1267}
1268
1269# output in XML DocBook
1270sub output_blockhead_xml(%) {
1271 my %args = %{$_[0]};
1272 my ($parameter, $section);
1273 my $count;
1274
1275 my $id = $args{'module'};
1276 $id =~ s/[^A-Za-z0-9]/-/g;
1277
1278 # print out each section
1279 $lineprefix=" ";
1280 foreach $section (@{$args{'sectionlist'}}) {
1281 if (!$args{'content-only'}) {
1282 print "<refsect1>\n <title>$section</title>\n";
1283 }
1284 if ($section =~ m/EXAMPLE/i) {
1285 print "<example><para>\n";
1286 $output_preformatted = 1;
1287 } else {
1288 print "<para>\n";
1289 }
1290 output_highlight($args{'sections'}{$section});
1291 $output_preformatted = 0;
1292 if ($section =~ m/EXAMPLE/i) {
1293 print "</para></example>\n";
1294 } else {
1295 print "</para>";
1296 }
1297 if (!$args{'content-only'}) {
1298 print "\n</refsect1>\n";
1299 }
1300 }
1301
1302 print "\n\n";
1303}
1304
1305# output in XML DocBook
1306sub output_function_gnome {
1307 my %args = %{$_[0]};
1308 my ($parameter, $section);
1309 my $count;
1310 my $id;
1311
1312 $id = $args{'module'} . "-" . $args{'function'};
1313 $id =~ s/[^A-Za-z0-9]/-/g;
1314
1315 print "<sect2>\n";
1316 print " <title id=\"$id\">" . $args{'function'} . "</title>\n";
1317
1318 print " <funcsynopsis>\n";
1319 print " <funcdef>" . $args{'functiontype'} . " ";
1320 print "<function>" . $args{'function'} . " ";
1321 print "</function></funcdef>\n";
1322
1323 $count = 0;
1324 if ($#{$args{'parameterlist'}} >= 0) {
1325 foreach $parameter (@{$args{'parameterlist'}}) {
1326 $type = $args{'parametertypes'}{$parameter};
1327 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1328 # pointer-to-function
1329 print " <paramdef>$1 <parameter>$parameter</parameter>)\n";
1330 print " <funcparams>$2</funcparams></paramdef>\n";
1331 } else {
1332 print " <paramdef>" . $type;
1333 print " <parameter>$parameter</parameter></paramdef>\n";
1334 }
1335 }
1336 } else {
1337 print " <void>\n";
1338 }
1339 print " </funcsynopsis>\n";
1340 if ($#{$args{'parameterlist'}} >= 0) {
1341 print " <informaltable pgwide=\"1\" frame=\"none\" role=\"params\">\n";
1342 print "<tgroup cols=\"2\">\n";
1343 print "<colspec colwidth=\"2*\">\n";
1344 print "<colspec colwidth=\"8*\">\n";
1345 print "<tbody>\n";
1346 foreach $parameter (@{$args{'parameterlist'}}) {
1347 my $parameter_name = $parameter;
1348 $parameter_name =~ s/\[.*//;
1349
1350 print " <row><entry align=\"right\"><parameter>$parameter</parameter></entry>\n";
1351 print " <entry>\n";
1352 $lineprefix=" ";
1353 output_highlight($args{'parameterdescs'}{$parameter_name});
1354 print " </entry></row>\n";
1355 }
1356 print " </tbody></tgroup></informaltable>\n";
1357 } else {
1358 print " <para>\n None\n </para>\n";
1359 }
1360
1361 # print out each section
1362 $lineprefix=" ";
1363 foreach $section (@{$args{'sectionlist'}}) {
1364 print "<simplesect>\n <title>$section</title>\n";
1365 if ($section =~ m/EXAMPLE/i) {
1366 print "<example><programlisting>\n";
1367 $output_preformatted = 1;
1368 } else {
1369 }
1370 print "<para>\n";
1371 output_highlight($args{'sections'}{$section});
1372 $output_preformatted = 0;
1373 print "</para>\n";
1374 if ($section =~ m/EXAMPLE/i) {
1375 print "</programlisting></example>\n";
1376 } else {
1377 }
1378 print " </simplesect>\n";
1379 }
1380
1381 print "</sect2>\n\n";
1382}
1383
1384##
1385# output function in man
1386sub output_function_man(%) {
1387 my %args = %{$_[0]};
1388 my ($parameter, $section);
1389 my $count;
1390
1391 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
1392
1393 print ".SH NAME\n";
1394 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
1395
1396 print ".SH SYNOPSIS\n";
1397 if ($args{'functiontype'} ne "") {
1398 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
1399 } else {
1400 print ".B \"" . $args{'function'} . "\n";
1401 }
1402 $count = 0;
1403 my $parenth = "(";
1404 my $post = ",";
1405 foreach my $parameter (@{$args{'parameterlist'}}) {
1406 if ($count == $#{$args{'parameterlist'}}) {
1407 $post = ");";
1408 }
1409 $type = $args{'parametertypes'}{$parameter};
1410 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1411 # pointer-to-function
1412 print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n";
1413 } else {
1414 $type =~ s/([^\*])$/$1 /;
1415 print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n";
1416 }
1417 $count++;
1418 $parenth = "";
1419 }
1420
1421 print ".SH ARGUMENTS\n";
1422 foreach $parameter (@{$args{'parameterlist'}}) {
1423 my $parameter_name = $parameter;
1424 $parameter_name =~ s/\[.*//;
1425
1426 print ".IP \"" . $parameter . "\" 12\n";
1427 output_highlight($args{'parameterdescs'}{$parameter_name});
1428 }
1429 foreach $section (@{$args{'sectionlist'}}) {
1430 print ".SH \"", uc $section, "\"\n";
1431 output_highlight($args{'sections'}{$section});
1432 }
1433}
1434
1435##
1436# output enum in man
1437sub output_enum_man(%) {
1438 my %args = %{$_[0]};
1439 my ($parameter, $section);
1440 my $count;
1441
1442 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
1443
1444 print ".SH NAME\n";
1445 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
1446
1447 print ".SH SYNOPSIS\n";
1448 print "enum " . $args{'enum'} . " {\n";
1449 $count = 0;
1450 foreach my $parameter (@{$args{'parameterlist'}}) {
1451 print ".br\n.BI \" $parameter\"\n";
1452 if ($count == $#{$args{'parameterlist'}}) {
1453 print "\n};\n";
1454 last;
1455 }
1456 else {
1457 print ", \n.br\n";
1458 }
1459 $count++;
1460 }
1461
1462 print ".SH Constants\n";
1463 foreach $parameter (@{$args{'parameterlist'}}) {
1464 my $parameter_name = $parameter;
1465 $parameter_name =~ s/\[.*//;
1466
1467 print ".IP \"" . $parameter . "\" 12\n";
1468 output_highlight($args{'parameterdescs'}{$parameter_name});
1469 }
1470 foreach $section (@{$args{'sectionlist'}}) {
1471 print ".SH \"$section\"\n";
1472 output_highlight($args{'sections'}{$section});
1473 }
1474}
1475
1476##
1477# output struct in man
1478sub output_struct_man(%) {
1479 my %args = %{$_[0]};
1480 my ($parameter, $section);
1481
1482 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
1483
1484 print ".SH NAME\n";
1485 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
1486
1487 print ".SH SYNOPSIS\n";
1488 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
1489
1490 foreach my $parameter (@{$args{'parameterlist'}}) {
1491 if ($parameter =~ /^#/) {
1492 print ".BI \"$parameter\"\n.br\n";
1493 next;
1494 }
1495 my $parameter_name = $parameter;
1496 $parameter_name =~ s/\[.*//;
1497
1498 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1499 $type = $args{'parametertypes'}{$parameter};
1500 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1501 # pointer-to-function
1502 print ".BI \" " . $1 . "\" " . $parameter . " \") (" . $2 . ")" . "\"\n;\n";
1503 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1504 # bitfield
1505 print ".BI \" " . $1 . "\ \" " . $parameter . $2 . " \"" . "\"\n;\n";
1506 } else {
1507 $type =~ s/([^\*])$/$1 /;
1508 print ".BI \" " . $type . "\" " . $parameter . " \"" . "\"\n;\n";
1509 }
1510 print "\n.br\n";
1511 }
1512 print "};\n.br\n";
1513
1514 print ".SH Members\n";
1515 foreach $parameter (@{$args{'parameterlist'}}) {
1516 ($parameter =~ /^#/) && next;
1517
1518 my $parameter_name = $parameter;
1519 $parameter_name =~ s/\[.*//;
1520
1521 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1522 print ".IP \"" . $parameter . "\" 12\n";
1523 output_highlight($args{'parameterdescs'}{$parameter_name});
1524 }
1525 foreach $section (@{$args{'sectionlist'}}) {
1526 print ".SH \"$section\"\n";
1527 output_highlight($args{'sections'}{$section});
1528 }
1529}
1530
1531##
1532# output typedef in man
1533sub output_typedef_man(%) {
1534 my %args = %{$_[0]};
1535 my ($parameter, $section);
1536
1537 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
1538
1539 print ".SH NAME\n";
1540 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
1541
1542 foreach $section (@{$args{'sectionlist'}}) {
1543 print ".SH \"$section\"\n";
1544 output_highlight($args{'sections'}{$section});
1545 }
1546}
1547
1548sub output_blockhead_man(%) {
1549 my %args = %{$_[0]};
1550 my ($parameter, $section);
1551 my $count;
1552
1553 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
1554
1555 foreach $section (@{$args{'sectionlist'}}) {
1556 print ".SH \"$section\"\n";
1557 output_highlight($args{'sections'}{$section});
1558 }
1559}
1560
1561##
1562# output in text
1563sub output_function_text(%) {
1564 my %args = %{$_[0]};
1565 my ($parameter, $section);
1566 my $start;
1567
1568 print "Name:\n\n";
1569 print $args{'function'} . " - " . $args{'purpose'} . "\n";
1570
1571 print "\nSynopsis:\n\n";
1572 if ($args{'functiontype'} ne "") {
1573 $start = $args{'functiontype'} . " " . $args{'function'} . " (";
1574 } else {
1575 $start = $args{'function'} . " (";
1576 }
1577 print $start;
1578
1579 my $count = 0;
1580 foreach my $parameter (@{$args{'parameterlist'}}) {
1581 $type = $args{'parametertypes'}{$parameter};
1582 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1583 # pointer-to-function
1584 print $1 . $parameter . ") (" . $2;
1585 } else {
1586 print $type . " " . $parameter;
1587 }
1588 if ($count != $#{$args{'parameterlist'}}) {
1589 $count++;
1590 print ",\n";
1591 print " " x length($start);
1592 } else {
1593 print ");\n\n";
1594 }
1595 }
1596
1597 print "Arguments:\n\n";
1598 foreach $parameter (@{$args{'parameterlist'}}) {
1599 my $parameter_name = $parameter;
1600 $parameter_name =~ s/\[.*//;
1601
1602 print $parameter . "\n\t" . $args{'parameterdescs'}{$parameter_name} . "\n";
1603 }
1604 output_section_text(@_);
1605}
1606
1607#output sections in text
1608sub output_section_text(%) {
1609 my %args = %{$_[0]};
1610 my $section;
1611
1612 print "\n";
1613 foreach $section (@{$args{'sectionlist'}}) {
1614 print "$section:\n\n";
1615 output_highlight($args{'sections'}{$section});
1616 }
1617 print "\n\n";
1618}
1619
1620# output enum in text
1621sub output_enum_text(%) {
1622 my %args = %{$_[0]};
1623 my ($parameter);
1624 my $count;
1625 print "Enum:\n\n";
1626
1627 print "enum " . $args{'enum'} . " - " . $args{'purpose'} . "\n\n";
1628 print "enum " . $args{'enum'} . " {\n";
1629 $count = 0;
1630 foreach $parameter (@{$args{'parameterlist'}}) {
1631 print "\t$parameter";
1632 if ($count != $#{$args{'parameterlist'}}) {
1633 $count++;
1634 print ",";
1635 }
1636 print "\n";
1637 }
1638 print "};\n\n";
1639
1640 print "Constants:\n\n";
1641 foreach $parameter (@{$args{'parameterlist'}}) {
1642 print "$parameter\n\t";
1643 print $args{'parameterdescs'}{$parameter} . "\n";
1644 }
1645
1646 output_section_text(@_);
1647}
1648
1649# output typedef in text
1650sub output_typedef_text(%) {
1651 my %args = %{$_[0]};
1652 my ($parameter);
1653 my $count;
1654 print "Typedef:\n\n";
1655
1656 print "typedef " . $args{'typedef'} . " - " . $args{'purpose'} . "\n";
1657 output_section_text(@_);
1658}
1659
1660# output struct as text
1661sub output_struct_text(%) {
1662 my %args = %{$_[0]};
1663 my ($parameter);
1664
1665 print $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "\n\n";
1666 print $args{'type'} . " " . $args{'struct'} . " {\n";
1667 foreach $parameter (@{$args{'parameterlist'}}) {
1668 if ($parameter =~ /^#/) {
1669 print "$parameter\n";
1670 next;
1671 }
1672
1673 my $parameter_name = $parameter;
1674 $parameter_name =~ s/\[.*//;
1675
1676 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1677 $type = $args{'parametertypes'}{$parameter};
1678 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1679 # pointer-to-function
1680 print "\t$1 $parameter) ($2);\n";
1681 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1682 # bitfield
1683 print "\t$1 $parameter$2;\n";
1684 } else {
1685 print "\t" . $type . " " . $parameter . ";\n";
1686 }
1687 }
1688 print "};\n\n";
1689
1690 print "Members:\n\n";
1691 foreach $parameter (@{$args{'parameterlist'}}) {
1692 ($parameter =~ /^#/) && next;
1693
1694 my $parameter_name = $parameter;
1695 $parameter_name =~ s/\[.*//;
1696
1697 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1698 print "$parameter\n\t";
1699 print $args{'parameterdescs'}{$parameter_name} . "\n";
1700 }
1701 print "\n";
1702 output_section_text(@_);
1703}
1704
1705sub output_blockhead_text(%) {
1706 my %args = %{$_[0]};
1707 my ($parameter, $section);
1708
1709 foreach $section (@{$args{'sectionlist'}}) {
1710 print " $section:\n";
1711 print " -> ";
1712 output_highlight($args{'sections'}{$section});
1713 }
1714}
1715
1716## list mode output functions
1717
1718sub output_function_list(%) {
1719 my %args = %{$_[0]};
1720
1721 print $args{'function'} . "\n";
1722}
1723
1724# output enum in list
1725sub output_enum_list(%) {
1726 my %args = %{$_[0]};
1727 print $args{'enum'} . "\n";
1728}
1729
1730# output typedef in list
1731sub output_typedef_list(%) {
1732 my %args = %{$_[0]};
1733 print $args{'typedef'} . "\n";
1734}
1735
1736# output struct as list
1737sub output_struct_list(%) {
1738 my %args = %{$_[0]};
1739
1740 print $args{'struct'} . "\n";
1741}
1742
1743sub output_blockhead_list(%) {
1744 my %args = %{$_[0]};
1745 my ($parameter, $section);
1746
1747 foreach $section (@{$args{'sectionlist'}}) {
1748 print "DOC: $section\n";
1749 }
1750}
1751
1752##
1753# generic output function for all types (function, struct/union, typedef, enum);
1754# calls the generated, variable output_ function name based on
1755# functype and output_mode
1756sub output_declaration {
1757 no strict 'refs';
1758 my $name = shift;
1759 my $functype = shift;
1760 my $func = "output_${functype}_$output_mode";
1761 if (($function_only==0) ||
1762 ( $function_only == 1 && defined($function_table{$name})) ||
1763 ( $function_only == 2 && !($functype eq "function" && defined($function_table{$name}))))
1764 {
1765 &$func(@_);
1766 $section_counter++;
1767 }
1768}
1769
1770##
1771# generic output function - calls the right one based on current output mode.
1772sub output_blockhead {
1773 no strict 'refs';
1774 my $func = "output_blockhead_" . $output_mode;
1775 &$func(@_);
1776 $section_counter++;
1777}
1778
1779##
1780# takes a declaration (struct, union, enum, typedef) and
1781# invokes the right handler. NOT called for functions.
1782sub dump_declaration($$) {
1783 no strict 'refs';
1784 my ($prototype, $file) = @_;
1785 my $func = "dump_" . $decl_type;
1786 &$func(@_);
1787}
1788
1789sub dump_union($$) {
1790 dump_struct(@_);
1791}
1792
1793sub dump_struct($$) {
1794 my $x = shift;
1795 my $file = shift;
1796 my $nested;
1797
1798 if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) {
1799 #my $decl_type = $1;
1800 $declaration_name = $2;
1801 my $members = $3;
1802
1803 # ignore embedded structs or unions
1804 $members =~ s/({.*})//g;
1805 $nested = $1;
1806
1807 # ignore members marked private:
1808 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1809 $members =~ s/\/\*\s*private:.*//gosi;
1810 # strip comments:
1811 $members =~ s/\/\*.*?\*\///gos;
1812 $nested =~ s/\/\*.*?\*\///gos;
1813 # strip kmemcheck_bitfield_{begin,end}.*;
1814 $members =~ s/kmemcheck_bitfield_.*?;//gos;
1815 # strip attributes
1816 $members =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;
1817 $members =~ s/__aligned\s*\([^;]*\)//gos;
1818 $members =~ s/\s*CRYPTO_MINALIGN_ATTR//gos;
1819 # replace DECLARE_BITMAP
1820 $members =~ s/DECLARE_BITMAP\s*\(([^,)]+), ([^,)]+)\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
1821
1822 create_parameterlist($members, ';', $file);
1823 check_sections($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested);
1824
1825 output_declaration($declaration_name,
1826 'struct',
1827 {'struct' => $declaration_name,
1828 'module' => $modulename,
1829 'parameterlist' => \@parameterlist,
1830 'parameterdescs' => \%parameterdescs,
1831 'parametertypes' => \%parametertypes,
1832 'sectionlist' => \@sectionlist,
1833 'sections' => \%sections,
1834 'purpose' => $declaration_purpose,
1835 'type' => $decl_type
1836 });
1837 }
1838 else {
1839 print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
1840 ++$errors;
1841 }
1842}
1843
1844sub dump_enum($$) {
1845 my $x = shift;
1846 my $file = shift;
1847
1848 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1849 # strip #define macros inside enums
1850 $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;
1851
1852 if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
1853 $declaration_name = $1;
1854 my $members = $2;
1855
1856 foreach my $arg (split ',', $members) {
1857 $arg =~ s/^\s*(\w+).*/$1/;
1858 push @parameterlist, $arg;
1859 if (!$parameterdescs{$arg}) {
1860 $parameterdescs{$arg} = $undescribed;
1861 print STDERR "${file}:$.: warning: Enum value '$arg' ".
1862 "not described in enum '$declaration_name'\n";
1863 }
1864
1865 }
1866
1867 output_declaration($declaration_name,
1868 'enum',
1869 {'enum' => $declaration_name,
1870 'module' => $modulename,
1871 'parameterlist' => \@parameterlist,
1872 'parameterdescs' => \%parameterdescs,
1873 'sectionlist' => \@sectionlist,
1874 'sections' => \%sections,
1875 'purpose' => $declaration_purpose
1876 });
1877 }
1878 else {
1879 print STDERR "${file}:$.: error: Cannot parse enum!\n";
1880 ++$errors;
1881 }
1882}
1883
1884sub dump_typedef($$) {
1885 my $x = shift;
1886 my $file = shift;
1887
1888 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1889
1890 # Parse function prototypes
1891 if ($x =~ /typedef\s+(\w+)\s*\(\*\s*(\w\S+)\s*\)\s*\((.*)\);/) {
1892 # Function typedefs
1893 $return_type = $1;
1894 $declaration_name = $2;
1895 my $args = $3;
1896
1897 create_parameterlist($args, ',', $file);
1898
1899 output_declaration($declaration_name,
1900 'function',
1901 {'function' => $declaration_name,
1902 'module' => $modulename,
1903 'functiontype' => $return_type,
1904 'parameterlist' => \@parameterlist,
1905 'parameterdescs' => \%parameterdescs,
1906 'parametertypes' => \%parametertypes,
1907 'sectionlist' => \@sectionlist,
1908 'sections' => \%sections,
1909 'purpose' => $declaration_purpose
1910 });
1911 return;
1912 }
1913
1914 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1915 $x =~ s/\(*.\)\s*;$/;/;
1916 $x =~ s/\[*.\]\s*;$/;/;
1917 }
1918
1919 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1920 $declaration_name = $1;
1921
1922 output_declaration($declaration_name,
1923 'typedef',
1924 {'typedef' => $declaration_name,
1925 'module' => $modulename,
1926 'sectionlist' => \@sectionlist,
1927 'sections' => \%sections,
1928 'purpose' => $declaration_purpose
1929 });
1930 }
1931 else {
1932 print STDERR "${file}:$.: error: Cannot parse typedef!\n";
1933 ++$errors;
1934 }
1935}
1936
1937sub save_struct_actual($) {
1938 my $actual = shift;
1939
1940 # strip all spaces from the actual param so that it looks like one string item
1941 $actual =~ s/\s*//g;
1942 $struct_actual = $struct_actual . $actual . " ";
1943}
1944
1945sub create_parameterlist($$$) {
1946 my $args = shift;
1947 my $splitter = shift;
1948 my $file = shift;
1949 my $type;
1950 my $param;
1951
1952 # temporarily replace commas inside function pointer definition
1953 while ($args =~ /(\([^\),]+),/) {
1954 $args =~ s/(\([^\),]+),/$1#/g;
1955 }
1956
1957 foreach my $arg (split($splitter, $args)) {
1958 # strip comments
1959 $arg =~ s/\/\*.*\*\///;
1960 # strip leading/trailing spaces
1961 $arg =~ s/^\s*//;
1962 $arg =~ s/\s*$//;
1963 $arg =~ s/\s+/ /;
1964
1965 if ($arg =~ /^#/) {
1966 # Treat preprocessor directive as a typeless variable just to fill
1967 # corresponding data structures "correctly". Catch it later in
1968 # output_* subs.
1969 push_parameter($arg, "", $file);
1970 } elsif ($arg =~ m/\(.+\)\s*\(/) {
1971 # pointer-to-function
1972 $arg =~ tr/#/,/;
1973 $arg =~ m/[^\(]+\(\*?\s*(\w*)\s*\)/;
1974 $param = $1;
1975 $type = $arg;
1976 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1977 save_struct_actual($param);
1978 push_parameter($param, $type, $file);
1979 } elsif ($arg) {
1980 $arg =~ s/\s*:\s*/:/g;
1981 $arg =~ s/\s*\[/\[/g;
1982
1983 my @args = split('\s*,\s*', $arg);
1984 if ($args[0] =~ m/\*/) {
1985 $args[0] =~ s/(\*+)\s*/ $1/;
1986 }
1987
1988 my @first_arg;
1989 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1990 shift @args;
1991 push(@first_arg, split('\s+', $1));
1992 push(@first_arg, $2);
1993 } else {
1994 @first_arg = split('\s+', shift @args);
1995 }
1996
1997 unshift(@args, pop @first_arg);
1998 $type = join " ", @first_arg;
1999
2000 foreach $param (@args) {
2001 if ($param =~ m/^(\*+)\s*(.*)/) {
2002 save_struct_actual($2);
2003 push_parameter($2, "$type $1", $file);
2004 }
2005 elsif ($param =~ m/(.*?):(\d+)/) {
2006 if ($type ne "") { # skip unnamed bit-fields
2007 save_struct_actual($1);
2008 push_parameter($1, "$type:$2", $file)
2009 }
2010 }
2011 else {
2012 save_struct_actual($param);
2013 push_parameter($param, $type, $file);
2014 }
2015 }
2016 }
2017 }
2018}
2019
2020sub push_parameter($$$) {
2021 my $param = shift;
2022 my $type = shift;
2023 my $file = shift;
2024
2025 if (($anon_struct_union == 1) && ($type eq "") &&
2026 ($param eq "}")) {
2027 return; # ignore the ending }; from anon. struct/union
2028 }
2029
2030 $anon_struct_union = 0;
2031 my $param_name = $param;
2032 $param_name =~ s/\[.*//;
2033
2034 if ($type eq "" && $param =~ /\.\.\.$/)
2035 {
2036 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
2037 $parameterdescs{$param} = "variable arguments";
2038 }
2039 }
2040 elsif ($type eq "" && ($param eq "" or $param eq "void"))
2041 {
2042 $param="void";
2043 $parameterdescs{void} = "no arguments";
2044 }
2045 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
2046 # handle unnamed (anonymous) union or struct:
2047 {
2048 $type = $param;
2049 $param = "{unnamed_" . $param . "}";
2050 $parameterdescs{$param} = "anonymous\n";
2051 $anon_struct_union = 1;
2052 }
2053
2054 # warn if parameter has no description
2055 # (but ignore ones starting with # as these are not parameters
2056 # but inline preprocessor statements);
2057 # also ignore unnamed structs/unions;
2058 if (!$anon_struct_union) {
2059 if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) {
2060
2061 $parameterdescs{$param_name} = $undescribed;
2062
2063 if (($type eq 'function') || ($type eq 'enum')) {
2064 print STDERR "${file}:$.: warning: Function parameter ".
2065 "or member '$param' not " .
2066 "described in '$declaration_name'\n";
2067 }
2068 print STDERR "${file}:$.: warning:" .
2069 " No description found for parameter '$param'\n";
2070 ++$warnings;
2071 }
2072 }
2073
2074 $param = xml_escape($param);
2075
2076 # strip spaces from $param so that it is one continuous string
2077 # on @parameterlist;
2078 # this fixes a problem where check_sections() cannot find
2079 # a parameter like "addr[6 + 2]" because it actually appears
2080 # as "addr[6", "+", "2]" on the parameter list;
2081 # but it's better to maintain the param string unchanged for output,
2082 # so just weaken the string compare in check_sections() to ignore
2083 # "[blah" in a parameter string;
2084 ###$param =~ s/\s*//g;
2085 push @parameterlist, $param;
2086 $parametertypes{$param} = $type;
2087}
2088
2089sub check_sections($$$$$$) {
2090 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck, $nested) = @_;
2091 my @sects = split ' ', $sectcheck;
2092 my @prms = split ' ', $prmscheck;
2093 my $err;
2094 my ($px, $sx);
2095 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
2096
2097 foreach $sx (0 .. $#sects) {
2098 $err = 1;
2099 foreach $px (0 .. $#prms) {
2100 $prm_clean = $prms[$px];
2101 $prm_clean =~ s/\[.*\]//;
2102 $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;
2103 # ignore array size in a parameter string;
2104 # however, the original param string may contain
2105 # spaces, e.g.: addr[6 + 2]
2106 # and this appears in @prms as "addr[6" since the
2107 # parameter list is split at spaces;
2108 # hence just ignore "[..." for the sections check;
2109 $prm_clean =~ s/\[.*//;
2110
2111 ##$prm_clean =~ s/^\**//;
2112 if ($prm_clean eq $sects[$sx]) {
2113 $err = 0;
2114 last;
2115 }
2116 }
2117 if ($err) {
2118 if ($decl_type eq "function") {
2119 print STDERR "${file}:$.: warning: " .
2120 "Excess function parameter " .
2121 "'$sects[$sx]' " .
2122 "description in '$decl_name'\n";
2123 ++$warnings;
2124 } else {
2125 if ($nested !~ m/\Q$sects[$sx]\E/) {
2126 print STDERR "${file}:$.: warning: " .
2127 "Excess struct/union/enum/typedef member " .
2128 "'$sects[$sx]' " .
2129 "description in '$decl_name'\n";
2130 ++$warnings;
2131 }
2132 }
2133 }
2134 }
2135}
2136
2137##
2138# Checks the section describing the return value of a function.
2139sub check_return_section {
2140 my $file = shift;
2141 my $declaration_name = shift;
2142 my $return_type = shift;
2143
2144 # Ignore an empty return type (It's a macro)
2145 # Ignore functions with a "void" return type. (But don't ignore "void *")
2146 if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
2147 return;
2148 }
2149
2150 if (!defined($sections{$section_return}) ||
2151 $sections{$section_return} eq "") {
2152 print STDERR "${file}:$.: warning: " .
2153 "No description found for return value of " .
2154 "'$declaration_name'\n";
2155 ++$warnings;
2156 }
2157}
2158
2159##
2160# takes a function prototype and the name of the current file being
2161# processed and spits out all the details stored in the global
2162# arrays/hashes.
2163sub dump_function($$) {
2164 my $prototype = shift;
2165 my $file = shift;
2166 my $noret = 0;
2167
2168 $prototype =~ s/^static +//;
2169 $prototype =~ s/^extern +//;
2170 $prototype =~ s/^asmlinkage +//;
2171 $prototype =~ s/^inline +//;
2172 $prototype =~ s/^__inline__ +//;
2173 $prototype =~ s/^__inline +//;
2174 $prototype =~ s/^__always_inline +//;
2175 $prototype =~ s/^noinline +//;
2176 $prototype =~ s/__init +//;
2177 $prototype =~ s/__init_or_module +//;
2178 $prototype =~ s/__meminit +//;
2179 $prototype =~ s/__must_check +//;
2180 $prototype =~ s/__weak +//;
2181 my $define = $prototype =~ s/^#\s*define\s+//; #ak added
2182 $prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//;
2183
2184 # Yes, this truly is vile. We are looking for:
2185 # 1. Return type (may be nothing if we're looking at a macro)
2186 # 2. Function name
2187 # 3. Function parameters.
2188 #
2189 # All the while we have to watch out for function pointer parameters
2190 # (which IIRC is what the two sections are for), C types (these
2191 # regexps don't even start to express all the possibilities), and
2192 # so on.
2193 #
2194 # If you mess with these regexps, it's a good idea to check that
2195 # the following functions' documentation still comes out right:
2196 # - parport_register_device (function pointer parameters)
2197 # - atomic_set (macro)
2198 # - pci_match_device, __copy_to_user (long return type)
2199
2200 if ($define && $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s+/) {
2201 # This is an object-like macro, it has no return type and no parameter
2202 # list.
2203 # Function-like macros are not allowed to have spaces between
2204 # declaration_name and opening parenthesis (notice the \s+).
2205 $return_type = $1;
2206 $declaration_name = $2;
2207 $noret = 1;
2208 } elsif ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
2209 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
2210 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
2211 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
2212 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
2213 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
2214 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
2215 $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2216 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2217 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2218 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2219 $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2220 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2221 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2222 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2223 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
2224 $prototype =~ m/^(\w+\s+\w+\s*\*\s*\w+\s*\*\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) {
2225 $return_type = $1;
2226 $declaration_name = $2;
2227 my $args = $3;
2228
2229 create_parameterlist($args, ',', $file);
2230 } else {
2231 print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype'\n";
2232 return;
2233 }
2234
2235 my $prms = join " ", @parameterlist;
2236 check_sections($file, $declaration_name, "function", $sectcheck, $prms, "");
2237
2238 # This check emits a lot of warnings at the moment, because many
2239 # functions don't have a 'Return' doc section. So until the number
2240 # of warnings goes sufficiently down, the check is only performed in
2241 # verbose mode.
2242 # TODO: always perform the check.
2243 if ($verbose && !$noret) {
2244 check_return_section($file, $declaration_name, $return_type);
2245 }
2246
2247 output_declaration($declaration_name,
2248 'function',
2249 {'function' => $declaration_name,
2250 'module' => $modulename,
2251 'functiontype' => $return_type,
2252 'parameterlist' => \@parameterlist,
2253 'parameterdescs' => \%parameterdescs,
2254 'parametertypes' => \%parametertypes,
2255 'sectionlist' => \@sectionlist,
2256 'sections' => \%sections,
2257 'purpose' => $declaration_purpose
2258 });
2259}
2260
2261sub reset_state {
2262 $function = "";
2263 %constants = ();
2264 %parameterdescs = ();
2265 %parametertypes = ();
2266 @parameterlist = ();
2267 %sections = ();
2268 @sectionlist = ();
2269 $sectcheck = "";
2270 $struct_actual = "";
2271 $prototype = "";
2272
2273 $state = 0;
2274 $split_doc_state = 0;
2275}
2276
2277sub tracepoint_munge($) {
2278 my $file = shift;
2279 my $tracepointname = 0;
2280 my $tracepointargs = 0;
2281
2282 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
2283 $tracepointname = $1;
2284 }
2285 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
2286 $tracepointname = $1;
2287 }
2288 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
2289 $tracepointname = $2;
2290 }
2291 $tracepointname =~ s/^\s+//; #strip leading whitespace
2292 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
2293 $tracepointargs = $1;
2294 }
2295 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
2296 print STDERR "${file}:$.: warning: Unrecognized tracepoint format: \n".
2297 "$prototype\n";
2298 } else {
2299 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
2300 }
2301}
2302
2303sub syscall_munge() {
2304 my $void = 0;
2305
2306 $prototype =~ s@[\r\n\t]+@ @gos; # strip newlines/CR's/tabs
2307## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
2308 if ($prototype =~ m/SYSCALL_DEFINE0/) {
2309 $void = 1;
2310## $prototype = "long sys_$1(void)";
2311 }
2312
2313 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
2314 if ($prototype =~ m/long (sys_.*?),/) {
2315 $prototype =~ s/,/\(/;
2316 } elsif ($void) {
2317 $prototype =~ s/\)/\(void\)/;
2318 }
2319
2320 # now delete all of the odd-number commas in $prototype
2321 # so that arg types & arg names don't have a comma between them
2322 my $count = 0;
2323 my $len = length($prototype);
2324 if ($void) {
2325 $len = 0; # skip the for-loop
2326 }
2327 for (my $ix = 0; $ix < $len; $ix++) {
2328 if (substr($prototype, $ix, 1) eq ',') {
2329 $count++;
2330 if ($count % 2 == 1) {
2331 substr($prototype, $ix, 1) = ' ';
2332 }
2333 }
2334 }
2335}
2336
2337sub process_state3_function($$) {
2338 my $x = shift;
2339 my $file = shift;
2340
2341 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
2342
2343 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
2344 # do nothing
2345 }
2346 elsif ($x =~ /([^\{]*)/) {
2347 $prototype .= $1;
2348 }
2349
2350 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
2351 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
2352 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
2353 $prototype =~ s@^\s+@@gos; # strip leading spaces
2354 if ($prototype =~ /SYSCALL_DEFINE/) {
2355 syscall_munge();
2356 }
2357 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
2358 $prototype =~ /DEFINE_SINGLE_EVENT/)
2359 {
2360 tracepoint_munge($file);
2361 }
2362 dump_function($prototype, $file);
2363 reset_state();
2364 }
2365}
2366
2367sub process_state3_type($$) {
2368 my $x = shift;
2369 my $file = shift;
2370
2371 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
2372 $x =~ s@^\s+@@gos; # strip leading spaces
2373 $x =~ s@\s+$@@gos; # strip trailing spaces
2374 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
2375
2376 if ($x =~ /^#/) {
2377 # To distinguish preprocessor directive from regular declaration later.
2378 $x .= ";";
2379 }
2380
2381 while (1) {
2382 if ( $x =~ /([^{};]*)([{};])(.*)/ ) {
2383 $prototype .= $1 . $2;
2384 ($2 eq '{') && $brcount++;
2385 ($2 eq '}') && $brcount--;
2386 if (($2 eq ';') && ($brcount == 0)) {
2387 dump_declaration($prototype, $file);
2388 reset_state();
2389 last;
2390 }
2391 $x = $3;
2392 } else {
2393 $prototype .= $x;
2394 last;
2395 }
2396 }
2397}
2398
2399# xml_escape: replace <, >, and & in the text stream;
2400#
2401# however, formatting controls that are generated internally/locally in the
2402# kernel-doc script are not escaped here; instead, they begin life like
2403# $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings
2404# are converted to their mnemonic-expected output, without the 4 * '\' & ':',
2405# just before actual output; (this is done by local_unescape())
2406sub xml_escape($) {
2407 my $text = shift;
2408 if (($output_mode eq "text") || ($output_mode eq "man")) {
2409 return $text;
2410 }
2411 $text =~ s/\&/\\\\\\amp;/g;
2412 $text =~ s/\</\\\\\\lt;/g;
2413 $text =~ s/\>/\\\\\\gt;/g;
2414 return $text;
2415}
2416
2417# convert local escape strings to html
2418# local escape strings look like: '\\\\menmonic:' (that's 4 backslashes)
2419sub local_unescape($) {
2420 my $text = shift;
2421 if (($output_mode eq "text") || ($output_mode eq "man")) {
2422 return $text;
2423 }
2424 $text =~ s/\\\\\\\\lt:/</g;
2425 $text =~ s/\\\\\\\\gt:/>/g;
2426 return $text;
2427}
2428
2429sub process_file($) {
2430 my $file;
2431 my $identifier;
2432 my $func;
2433 my $descr;
2434 my $in_purpose = 0;
2435 my $initial_section_counter = $section_counter;
2436 my ($orig_file) = @_;
2437
2438 if (defined($ENV{'SRCTREE'})) {
2439 $file = "$ENV{'SRCTREE'}" . "/" . $orig_file;
2440 }
2441 else {
2442 $file = $orig_file;
2443 }
2444 if (defined($source_map{$file})) {
2445 $file = $source_map{$file};
2446 }
2447
2448 if (!open(IN,"<$file")) {
2449 print STDERR "Error: Cannot open file $file\n";
2450 ++$errors;
2451 return;
2452 }
2453
2454 $. = 1;
2455
2456 $section_counter = 0;
2457 while (<IN>) {
2458 while (s/\\\s*$//) {
2459 $_ .= <IN>;
2460 }
2461 if ($state == 0) {
2462 if (/$doc_start/o) {
2463 $state = 1; # next line is always the function name
2464 $in_doc_sect = 0;
2465 }
2466 } elsif ($state == 1) { # this line is the function name (always)
2467 if (/$doc_block/o) {
2468 $state = 4;
2469 $contents = "";
2470 if ( $1 eq "" ) {
2471 $section = $section_intro;
2472 } else {
2473 $section = $1;
2474 }
2475 }
2476 elsif (/$doc_decl/o) {
2477 $identifier = $1;
2478 if (/\s*([\w\s]+?)\s*-/) {
2479 $identifier = $1;
2480 }
2481
2482 $state = 2;
2483 if (/-(.*)/) {
2484 # strip leading/trailing/multiple spaces
2485 $descr= $1;
2486 $descr =~ s/^\s*//;
2487 $descr =~ s/\s*$//;
2488 $descr =~ s/\s+/ /g;
2489 $declaration_purpose = xml_escape($descr);
2490 $in_purpose = 1;
2491 } else {
2492 $declaration_purpose = "";
2493 }
2494
2495 if (($declaration_purpose eq "") && $verbose) {
2496 print STDERR "${file}:$.: warning: missing initial short description on line:\n";
2497 print STDERR $_;
2498 ++$warnings;
2499 }
2500
2501 if ($identifier =~ m/^struct/) {
2502 $decl_type = 'struct';
2503 } elsif ($identifier =~ m/^union/) {
2504 $decl_type = 'union';
2505 } elsif ($identifier =~ m/^enum/) {
2506 $decl_type = 'enum';
2507 } elsif ($identifier =~ m/^typedef/) {
2508 $decl_type = 'typedef';
2509 } else {
2510 $decl_type = 'function';
2511 }
2512
2513 if ($verbose) {
2514 print STDERR "${file}:$.: info: Scanning doc for $identifier\n";
2515 }
2516 } else {
2517 print STDERR "${file}:$.: warning: Cannot understand $_ on line $.",
2518 " - I thought it was a doc line\n";
2519 ++$warnings;
2520 $state = 0;
2521 }
2522 } elsif ($state == 2) { # look for head: lines, and include content
2523 if (/$doc_sect/o) {
2524 $newsection = $1;
2525 $newcontents = $2;
2526
2527 if (($contents ne "") && ($contents ne "\n")) {
2528 if (!$in_doc_sect && $verbose) {
2529 print STDERR "${file}:$.: warning: contents before sections\n";
2530 ++$warnings;
2531 }
2532 dump_section($file, $section, xml_escape($contents));
2533 $section = $section_default;
2534 }
2535
2536 $in_doc_sect = 1;
2537 $in_purpose = 0;
2538 $contents = $newcontents;
2539 if ($contents ne "") {
2540 while ((substr($contents, 0, 1) eq " ") ||
2541 substr($contents, 0, 1) eq "\t") {
2542 $contents = substr($contents, 1);
2543 }
2544 $contents .= "\n";
2545 }
2546 $section = $newsection;
2547 } elsif (/$doc_end/) {
2548 if (($contents ne "") && ($contents ne "\n")) {
2549 dump_section($file, $section, xml_escape($contents));
2550 $section = $section_default;
2551 $contents = "";
2552 }
2553 # look for doc_com + <text> + doc_end:
2554 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2555 print STDERR "${file}:$.: warning: suspicious ending line: $_";
2556 ++$warnings;
2557 }
2558
2559 $prototype = "";
2560 $state = 3;
2561 $brcount = 0;
2562# print STDERR "end of doc comment, looking for prototype\n";
2563 } elsif (/$doc_content/) {
2564 # miguel-style comment kludge, look for blank lines after
2565 # @parameter line to signify start of description
2566 if ($1 eq "") {
2567 if ($section =~ m/^@/ || $section eq $section_context) {
2568 dump_section($file, $section, xml_escape($contents));
2569 $section = $section_default;
2570 $contents = "";
2571 } else {
2572 $contents .= "\n";
2573 }
2574 $in_purpose = 0;
2575 } elsif ($in_purpose == 1) {
2576 # Continued declaration purpose
2577 chomp($declaration_purpose);
2578 $declaration_purpose .= " " . xml_escape($1);
2579 $declaration_purpose =~ s/\s+/ /g;
2580 } else {
2581 $contents .= $1 . "\n";
2582 }
2583 } else {
2584 # i dont know - bad line? ignore.
2585 print STDERR "${file}:$.: warning: bad line: $_";
2586 ++$warnings;
2587 }
2588 } elsif ($state == 5) { # scanning for split parameters
2589 # First line (state 1) needs to be a @parameter
2590 if ($split_doc_state == 1 && /$doc_split_sect/o) {
2591 $section = $1;
2592 $contents = $2;
2593 if ($contents ne "") {
2594 while ((substr($contents, 0, 1) eq " ") ||
2595 substr($contents, 0, 1) eq "\t") {
2596 $contents = substr($contents, 1);
2597 }
2598 $contents .= "\n";
2599 }
2600 $split_doc_state = 2;
2601 # Documentation block end */
2602 } elsif (/$doc_split_end/) {
2603 if (($contents ne "") && ($contents ne "\n")) {
2604 dump_section($file, $section, xml_escape($contents));
2605 $section = $section_default;
2606 $contents = "";
2607 }
2608 $state = 3;
2609 $split_doc_state = 0;
2610 # Regular text
2611 } elsif (/$doc_content/) {
2612 if ($split_doc_state == 2) {
2613 $contents .= $1 . "\n";
2614 } elsif ($split_doc_state == 1) {
2615 $split_doc_state = 4;
2616 print STDERR "Warning(${file}:$.): ";
2617 print STDERR "Incorrect use of kernel-doc format: $_";
2618 ++$warnings;
2619 }
2620 }
2621 } elsif ($state == 3) { # scanning for function '{' (end of prototype)
2622 if (/$doc_split_start/) {
2623 $state = 5;
2624 $split_doc_state = 1;
2625 } elsif ($decl_type eq 'function') {
2626 process_state3_function($_, $file);
2627 } else {
2628 process_state3_type($_, $file);
2629 }
2630 } elsif ($state == 4) {
2631 # Documentation block
2632 if (/$doc_block/) {
2633 dump_doc_section($file, $section, xml_escape($contents));
2634 $contents = "";
2635 $function = "";
2636 %constants = ();
2637 %parameterdescs = ();
2638 %parametertypes = ();
2639 @parameterlist = ();
2640 %sections = ();
2641 @sectionlist = ();
2642 $prototype = "";
2643 if ( $1 eq "" ) {
2644 $section = $section_intro;
2645 } else {
2646 $section = $1;
2647 }
2648 }
2649 elsif (/$doc_end/)
2650 {
2651 dump_doc_section($file, $section, xml_escape($contents));
2652 $contents = "";
2653 $function = "";
2654 %constants = ();
2655 %parameterdescs = ();
2656 %parametertypes = ();
2657 @parameterlist = ();
2658 %sections = ();
2659 @sectionlist = ();
2660 $prototype = "";
2661 $state = 0;
2662 }
2663 elsif (/$doc_content/)
2664 {
2665 if ( $1 eq "" )
2666 {
2667 $contents .= $blankline;
2668 }
2669 else
2670 {
2671 $contents .= $1 . "\n";
2672 }
2673 }
2674 }
2675 }
2676 if ($initial_section_counter == $section_counter) {
2677 print STDERR "${file}:1: warning: no structured comments found\n";
2678 if (($function_only == 1) && ($show_not_found == 1)) {
2679 print STDERR " Was looking for '$_'.\n" for keys %function_table;
2680 }
2681 if ($output_mode eq "xml") {
2682 # The template wants at least one RefEntry here; make one.
2683 print "<refentry>\n";
2684 print " <refnamediv>\n";
2685 print " <refname>\n";
2686 print " ${orig_file}\n";
2687 print " </refname>\n";
2688 print " <refpurpose>\n";
2689 print " Document generation inconsistency\n";
2690 print " </refpurpose>\n";
2691 print " </refnamediv>\n";
2692 print " <refsect1>\n";
2693 print " <title>\n";
2694 print " Oops\n";
2695 print " </title>\n";
2696 print " <warning>\n";
2697 print " <para>\n";
2698 print " The template for this document tried to insert\n";
2699 print " the structured comment from the file\n";
2700 print " <filename>${orig_file}</filename> at this point,\n";
2701 print " but none was found.\n";
2702 print " This dummy section is inserted to allow\n";
2703 print " generation to continue.\n";
2704 print " </para>\n";
2705 print " </warning>\n";
2706 print " </refsect1>\n";
2707 print "</refentry>\n";
2708 }
2709 }
2710}
2711
2712
2713$kernelversion = get_kernel_version();
2714
2715# generate a sequence of code that will splice in highlighting information
2716# using the s// operator.
2717for (my $k = 0; $k < @highlights; $k++) {
2718 my $pattern = $highlights[$k][0];
2719 my $result = $highlights[$k][1];
2720# print STDERR "scanning pattern:$pattern, highlight:($result)\n";
2721 $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n";
2722}
2723
2724# Read the file that maps relative names to absolute names for
2725# separate source and object directories and for shadow trees.
2726if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2727 my ($relname, $absname);
2728 while(<SOURCE_MAP>) {
2729 chop();
2730 ($relname, $absname) = (split())[0..1];
2731 $relname =~ s:^/+::;
2732 $source_map{$relname} = $absname;
2733 }
2734 close(SOURCE_MAP);
2735}
2736
2737foreach (@ARGV) {
2738 chomp;
2739 process_file($_);
2740}
2741if ($verbose && $errors) {
2742 print STDERR "$errors errors\n";
2743}
2744if ($verbose && $warnings) {
2745 print STDERR "$warnings warnings\n";
2746}
2747
2748exit($errors);
1#!/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 ##
8## Copyright (C) 2005-2012 Randy Dunlap ##
9## ##
10## #define enhancements by Armin Kuster <akuster@mvista.com> ##
11## Copyright (c) 2000 MontaVista Software, Inc. ##
12## ##
13## This software falls under the GNU General Public License. ##
14## Please read the COPYING file for more information ##
15
16# 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:
47# kernel-doc [ -docbook | -html | -text | -man | -list ] [ -no-doc-sections ]
48# [ -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.
53# The -list format is for internal use by docproc.
54#
55# -no-doc-sections
56# Do not output DOC: sections
57#
58# -function funcname
59# If set, then only generate documentation for the given function(s) or
60# DOC: section titles. All other functions and DOC: sections are ignored.
61#
62# -nofunction funcname
63# 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))
66#
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
87# */
88#
89# If the Description: header tag is omitted, then there must be a blank line
90# after the last parameter specification.
91# e.g.
92# /**
93# * my_function - does my stuff
94# * @my_arg: its mine damnit
95# *
96# * Does my stuff explained.
97# */
98#
99# or, could also use:
100# /**
101# * my_function - does my stuff
102# * @my_arg: its mine damnit
103# * Description: Does my stuff explained.
104# */
105# etc.
106#
107# Besides functions you can also write documentation for structs, unions,
108# 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.
111# 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
117# *
118# * Longer description
119# */
120# struct my_struct {
121# int a;
122# int b;
123# /* private: */
124# int c;
125# };
126#
127# All descriptions can be multiline, except the short function description.
128#
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
131# can be called form interrupts. Unlike other sections you can end it with an
132# empty line.
133# Example-sections should contain the string EXAMPLE so that they are marked
134# 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()
141# *
142# * 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
158## init lots of data
159
160my $errors = 0;
161my $warnings = 0;
162my $anon_struct_union = 0;
163
164# match expressions used to find embedded type information
165my $type_constant = '\%([-_\w]+)';
166my $type_func = '(\w+)\(\)';
167my $type_param = '\@(\w+)';
168my $type_struct = '\&((struct\s*)*[_\w]+)';
169my $type_struct_xml = '\\&((struct\s*)*[_\w]+)';
170my $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>",
178 $type_struct_xml, "<i>\$1</i>",
179 $type_env, "<b><i>\$1</i></b>",
180 $type_param, "<tt><b>\$1</b></tt>" );
181my $local_lt = "\\\\\\\\lt:";
182my $local_gt = "\\\\\\\\gt:";
183my $blankline_html = $local_lt . "p" . $local_gt; # was "<p>"
184
185# XML, docbook format
186my %highlights_xml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>",
187 $type_constant, "<constant>\$1</constant>",
188 $type_func, "<function>\$1</function>",
189 $type_struct_xml, "<structname>\$1</structname>",
190 $type_env, "<envar>\$1</envar>",
191 $type_param, "<parameter>\$1</parameter>" );
192my $blankline_xml = $local_lt . "/para" . $local_gt . $local_lt . "para" . $local_gt . "\n";
193
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
216# list mode
217my %highlights_list = ( $type_constant, "\$1",
218 $type_func, "\$1",
219 $type_struct, "\$1",
220 $type_param, "\$1" );
221my $blankline_list = "";
222
223# read arguments
224if ($#ARGV == -1) {
225 usage();
226}
227
228my $kernelversion;
229my $dohighlight = "";
230
231my $verbose = 0;
232my $output_mode = "man";
233my $no_doc_sections = 0;
234my %highlights = %highlights_man;
235my $blankline = $blankline_man;
236my $modulename = "Kernel API";
237my $function_only = 0;
238my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
239 'July', 'August', 'September', 'October',
240 'November', 'December')[(localtime)[4]] .
241 " " . ((localtime)[5]+1900);
242
243# Essentially these are globals.
244# 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
246# could cause "use of undefined value" or other bugs.
247my ($function, %function_table, %parametertypes, $declaration_purpose);
248my ($type, $declaration_name, $return_type);
249my ($newsection, $newcontents, $prototype, $brcount, %source_map);
250
251if (defined($ENV{'KBUILD_VERBOSE'})) {
252 $verbose = "$ENV{'KBUILD_VERBOSE'}";
253}
254
255# Generated docbook code is inserted in a template at a point where
256# 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;
272my $in_doc_sect;
273
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*';
283my $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*(.*)?';
287
288my %constants;
289my %parameterdescs;
290my @parameterlist;
291my %sections;
292my @sectionlist;
293my $sectcheck;
294my $struct_actual;
295
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;
324 } elsif ($cmd eq "-list") {
325 $output_mode = "list";
326 %highlights = %highlights_list;
327 $blankline = $blankline_list;
328 } 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();
346 } elsif ($cmd eq '-no-doc-sections') {
347 $no_doc_sections = 1;
348 }
349}
350
351# 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
363# get kernel version from env
364sub get_kernel_version() {
365 my $version = 'unknown kernel version';
366
367 if (defined($ENV{'KERNELVERSION'})) {
368 $version = $ENV{'KERNELVERSION'};
369 }
370 return $version;
371}
372
373##
374# dumps section contents to arrays/hashes intended for that purpose.
375#
376sub dump_section {
377 my $file = shift;
378 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;
389 $sectcheck = $sectcheck . $name . " ";
390 } elsif ($name eq "@\.\.\.") {
391# print STDERR "parameter def '...' = '$contents'\n";
392 $name = "...";
393 $parameterdescs{$name} = $contents;
394 $sectcheck = $sectcheck . $name . " ";
395 } else {
396# print STDERR "other section '$name' = '$contents'\n";
397 if (defined($sections{$name}) && ($sections{$name} ne "")) {
398 print STDERR "Error(${file}:$.): duplicate section name '$name'\n";
399 ++$errors;
400 }
401 $sections{$name} = $contents;
402 push @sectionlist, $name;
403 }
404}
405
406##
407# dump DOC: section after checking that it should go out
408#
409sub dump_doc_section {
410 my $file = shift;
411 my $name = shift;
412 my $contents = join "\n", @_;
413
414 if ($no_doc_sections) {
415 return;
416 }
417
418 if (($function_only == 0) ||
419 ( $function_only == 1 && defined($function_table{$name})) ||
420 ( $function_only == 2 && !defined($function_table{$name})))
421 {
422 dump_section($file, $name, $contents);
423 output_blockhead({'sectionlist' => \@sectionlist,
424 'sections' => \%sections,
425 'module' => $modulename,
426 'content-only' => ($function_only != 0), });
427 }
428}
429
430##
431# 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
438# sections => %section descriptions
439#
440
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
451 if ($output_mode eq "html" || $output_mode eq "xml") {
452 $contents = local_unescape($contents);
453 # convert data read & converted thru xml_escape() into &xyz; format:
454 $contents =~ s/\\\\\\/\&/g;
455 }
456# print STDERR "contents b4:$contents\n";
457 eval $dohighlight;
458 die $@ if $@;
459# print STDERR "contents af:$contents\n";
460
461 foreach $line (split "\n", $contents) {
462 if ($line eq ""){
463 print $lineprefix, local_unescape($blankline);
464 } else {
465 $line =~ s/\\\\\\/\&/g;
466 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
467 print "\\&$line";
468 } else {
469 print $lineprefix, $line;
470 }
471 }
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";
486 }
487}
488
489# output enum in html
490sub output_enum_html(%) {
491 my %args = %{$_[0]};
492 my ($parameter);
493 my $count;
494 print "<h2>enum " . $args{'enum'} . "</h2>\n";
495
496 print "<b>enum " . $args{'enum'} . "</b> {<br>\n";
497 $count = 0;
498 foreach $parameter (@{$args{'parameterlist'}}) {
499 print " <b>" . $parameter . "</b>";
500 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'}}) {
511 print "<dt><b>" . $parameter . "</b>\n";
512 print "<dd>";
513 output_highlight($args{'parameterdescs'}{$parameter});
514 }
515 print "</dl>\n";
516 output_section_html(@_);
517 print "<hr>\n";
518}
519
520# output typedef in html
521sub output_typedef_html(%) {
522 my %args = %{$_[0]};
523 my ($parameter);
524 my $count;
525 print "<h2>typedef " . $args{'typedef'} . "</h2>\n";
526
527 print "<b>typedef " . $args{'typedef'} . "</b>\n";
528 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
537 print "<h2>" . $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "</h2>\n";
538 print "<b>" . $args{'type'} . " " . $args{'struct'} . "</b> {<br>\n";
539 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
547 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
548 $type = $args{'parametertypes'}{$parameter};
549 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
550 # pointer-to-function
551 print " <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>\n";
552 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
553 # bitfield
554 print " <i>$1</i> <b>$parameter</b>$2;<br>\n";
555 } else {
556 print " <i>$type</i> <b>$parameter</b>;<br>\n";
557 }
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
569 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
570 print "<dt><b>" . $parameter . "</b>\n";
571 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;
584
585 print "<h2>" . $args{'function'} . " - " . $args{'purpose'} . "</h2>\n";
586 print "<i>" . $args{'functiontype'} . "</i>\n";
587 print "<b>" . $args{'function'} . "</b>\n";
588 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 {
596 print "<i>" . $type . "</i> <b>" . $parameter . "</b>";
597 }
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
611 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
612 print "<dt><b>" . $parameter . "</b>\n";
613 print "<dd>";
614 output_highlight($args{'parameterdescs'}{$parameter_name});
615 }
616 print "</dl>\n";
617 output_section_html(@_);
618 print "<hr>\n";
619}
620
621# output DOC: block header in html
622sub output_blockhead_html(%) {
623 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]};
638 my $section;
639 # print out each section
640 $lineprefix=" ";
641 foreach $section (@{$args{'sectionlist'}}) {
642 print "<refsect1>\n";
643 print "<title>$section</title>\n";
644 if ($section =~ m/EXAMPLE/i) {
645 print "<informalexample><programlisting>\n";
646 } else {
647 print "<para>\n";
648 }
649 output_highlight($args{'sections'}{$section});
650 if ($section =~ m/EXAMPLE/i) {
651 print "</programlisting></informalexample>\n";
652 } else {
653 print "</para>\n";
654 }
655 print "</refsect1>\n";
656 }
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
666 $id = "API-" . $args{'function'};
667 $id =~ s/[^A-Za-z0-9]/-/g;
668
669 print "<refentry id=\"$id\">\n";
670 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";
675 print "<refmeta>\n";
676 print " <refentrytitle><phrase>" . $args{'function'} . "</phrase></refentrytitle>\n";
677 print " <manvolnum>9</manvolnum>\n";
678 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
679 print "</refmeta>\n";
680 print "<refnamediv>\n";
681 print " <refname>" . $args{'function'} . "</refname>\n";
682 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";
691 print " <funcdef>" . $args{'functiontype'} . " ";
692 print "<function>" . $args{'function'} . " </function></funcdef>\n";
693
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 {
703 print " <paramdef>" . $type;
704 print " <parameter>$parameter</parameter></paramdef>\n";
705 }
706 }
707 } else {
708 print " <void/>\n";
709 }
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
743 $id = "API-struct-" . $args{'struct'};
744 $id =~ s/[^A-Za-z0-9]/-/g;
745
746 print "<refentry id=\"$id\">\n";
747 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";
752 print "<refmeta>\n";
753 print " <refentrytitle><phrase>" . $args{'type'} . " " . $args{'struct'} . "</phrase></refentrytitle>\n";
754 print " <manvolnum>9</manvolnum>\n";
755 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
756 print "</refmeta>\n";
757 print "<refnamediv>\n";
758 print " <refname>" . $args{'type'} . " " . $args{'struct'} . "</refname>\n";
759 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";
768 print $args{'type'} . " " . $args{'struct'} . " {\n";
769 foreach $parameter (@{$args{'parameterlist'}}) {
770 if ($parameter =~ /^#/) {
771 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";
776 next;
777 }
778
779 my $parameter_name = $parameter;
780 $parameter_name =~ s/\[.*//;
781
782 defined($args{'parameterdescs'}{$parameter_name}) || next;
783 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
784 $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*(:.*)/) {
789 # bitfield
790 print " $1 $parameter$2;\n";
791 } else {
792 print " " . $type . " " . $parameter . ";\n";
793 }
794 }
795 print "};";
796 print " </programlisting>\n";
797 print "</refsynopsisdiv>\n";
798
799 print " <refsect1>\n";
800 print " <title>Members</title>\n";
801
802 if ($#{$args{'parameterlist'}} >= 0) {
803 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";
820 } else {
821 print " <para>\n None\n </para>\n";
822 }
823 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
837 $id = "API-enum-" . $args{'enum'};
838 $id =~ s/[^A-Za-z0-9]/-/g;
839
840 print "<refentry id=\"$id\">\n";
841 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";
846 print "<refmeta>\n";
847 print " <refentrytitle><phrase>enum " . $args{'enum'} . "</phrase></refentrytitle>\n";
848 print " <manvolnum>9</manvolnum>\n";
849 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
850 print "</refmeta>\n";
851 print "<refnamediv>\n";
852 print " <refname>enum " . $args{'enum'} . "</refname>\n";
853 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";
862 print "enum " . $args{'enum'} . " {\n";
863 $count = 0;
864 foreach $parameter (@{$args{'parameterlist'}}) {
865 print " $parameter";
866 if ($count != $#{$args{'parameterlist'}}) {
867 $count++;
868 print ",";
869 }
870 print "\n";
871 }
872 print "};";
873 print " </programlisting>\n";
874 print "</refsynopsisdiv>\n";
875
876 print "<refsect1>\n";
877 print " <title>Constants</title>\n";
878 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
904 $id = "API-typedef-" . $args{'typedef'};
905 $id =~ s/[^A-Za-z0-9]/-/g;
906
907 print "<refentry id=\"$id\">\n";
908 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";
913 print "<refmeta>\n";
914 print " <refentrytitle><phrase>typedef " . $args{'typedef'} . "</phrase></refentrytitle>\n";
915 print " <manvolnum>9</manvolnum>\n";
916 print "</refmeta>\n";
917 print "<refnamediv>\n";
918 print " <refname>typedef " . $args{'typedef'} . "</refname>\n";
919 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";
927 print " <synopsis>typedef " . $args{'typedef'} . ";</synopsis>\n";
928 print "</refsynopsisdiv>\n";
929
930 output_section_xml(@_);
931
932 print "</refentry>\n\n";
933}
934
935# output in XML DocBook
936sub output_blockhead_xml(%) {
937 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'}}) {
947 if (!$args{'content-only'}) {
948 print "<refsect1>\n <title>$section</title>\n";
949 }
950 if ($section =~ m/EXAMPLE/i) {
951 print "<example><para>\n";
952 } else {
953 print "<para>\n";
954 }
955 output_highlight($args{'sections'}{$section});
956 if ($section =~ m/EXAMPLE/i) {
957 print "</para></example>\n";
958 } else {
959 print "</para>";
960 }
961 if (!$args{'content-only'}) {
962 print "\n</refsect1>\n";
963 }
964 }
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
976 $id = $args{'module'} . "-" . $args{'function'};
977 $id =~ s/[^A-Za-z0-9]/-/g;
978
979 print "<sect2>\n";
980 print " <title id=\"$id\">" . $args{'function'} . "</title>\n";
981
982 print " <funcsynopsis>\n";
983 print " <funcdef>" . $args{'functiontype'} . " ";
984 print "<function>" . $args{'function'} . " ";
985 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 {
996 print " <paramdef>" . $type;
997 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";
1056 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
1057
1058 print ".SH SYNOPSIS\n";
1059 if ($args{'functiontype'} ne "") {
1060 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
1061 } else {
1062 print ".B \"" . $args{'function'} . "\n";
1063 }
1064 $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
1074 print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n";
1075 } else {
1076 $type =~ s/([^\*])$/$1 /;
1077 print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n";
1078 }
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
1088 print ".IP \"" . $parameter . "\" 12\n";
1089 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";
1107 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
1108
1109 print ".SH SYNOPSIS\n";
1110 print "enum " . $args{'enum'} . " {\n";
1111 $count = 0;
1112 foreach my $parameter (@{$args{'parameterlist'}}) {
1113 print ".br\n.BI \" $parameter\"\n";
1114 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
1129 print ".IP \"" . $parameter . "\" 12\n";
1130 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
1144 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
1145
1146 print ".SH NAME\n";
1147 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
1148
1149 print ".SH SYNOPSIS\n";
1150 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
1151
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
1160 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1161 $type = $args{'parametertypes'}{$parameter};
1162 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1163 # pointer-to-function
1164 print ".BI \" " . $1 . "\" " . $parameter . " \") (" . $2 . ")" . "\"\n;\n";
1165 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1166 # bitfield
1167 print ".BI \" " . $1 . "\ \" " . $parameter . $2 . " \"" . "\"\n;\n";
1168 } else {
1169 $type =~ s/([^\*])$/$1 /;
1170 print ".BI \" " . $type . "\" " . $parameter . " \"" . "\"\n;\n";
1171 }
1172 print "\n.br\n";
1173 }
1174 print "};\n.br\n";
1175
1176 print ".SH Members\n";
1177 foreach $parameter (@{$args{'parameterlist'}}) {
1178 ($parameter =~ /^#/) && next;
1179
1180 my $parameter_name = $parameter;
1181 $parameter_name =~ s/\[.*//;
1182
1183 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1184 print ".IP \"" . $parameter . "\" 12\n";
1185 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";
1202 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
1203
1204 foreach $section (@{$args{'sectionlist'}}) {
1205 print ".SH \"$section\"\n";
1206 output_highlight($args{'sections'}{$section});
1207 }
1208}
1209
1210sub output_blockhead_man(%) {
1211 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);
1228 my $start;
1229
1230 print "Name:\n\n";
1231 print $args{'function'} . " - " . $args{'purpose'} . "\n";
1232
1233 print "\nSynopsis:\n\n";
1234 if ($args{'functiontype'} ne "") {
1235 $start = $args{'functiontype'} . " " . $args{'function'} . " (";
1236 } else {
1237 $start = $args{'function'} . " (";
1238 }
1239 print $start;
1240
1241 my $count = 0;
1242 foreach my $parameter (@{$args{'parameterlist'}}) {
1243 $type = $args{'parametertypes'}{$parameter};
1244 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1245 # pointer-to-function
1246 print $1 . $parameter . ") (" . $2;
1247 } else {
1248 print $type . " " . $parameter;
1249 }
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
1264 print $parameter . "\n\t" . $args{'parameterdescs'}{$parameter_name} . "\n";
1265 }
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});
1278 }
1279 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
1289 print "enum " . $args{'enum'} . " - " . $args{'purpose'} . "\n\n";
1290 print "enum " . $args{'enum'} . " {\n";
1291 $count = 0;
1292 foreach $parameter (@{$args{'parameterlist'}}) {
1293 print "\t$parameter";
1294 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";
1305 print $args{'parameterdescs'}{$parameter} . "\n";
1306 }
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
1318 print "typedef " . $args{'typedef'} . " - " . $args{'purpose'} . "\n";
1319 output_section_text(@_);
1320}
1321
1322# output struct as text
1323sub output_struct_text(%) {
1324 my %args = %{$_[0]};
1325 my ($parameter);
1326
1327 print $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "\n\n";
1328 print $args{'type'} . " " . $args{'struct'} . " {\n";
1329 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
1338 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1339 $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*(:.*)/) {
1344 # bitfield
1345 print "\t$1 $parameter$2;\n";
1346 } else {
1347 print "\t" . $type . " " . $parameter . ";\n";
1348 }
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
1359 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1360 print "$parameter\n\t";
1361 print $args{'parameterdescs'}{$parameter_name} . "\n";
1362 }
1363 print "\n";
1364 output_section_text(@_);
1365}
1366
1367sub output_blockhead_text(%) {
1368 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
1378## 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
1414##
1415# 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
1418sub output_declaration {
1419 no strict 'refs';
1420 my $name = shift;
1421 my $functype = shift;
1422 my $func = "output_${functype}_$output_mode";
1423 if (($function_only==0) ||
1424 ( $function_only == 1 && defined($function_table{$name})) ||
1425 ( $function_only == 2 && !defined($function_table{$name})))
1426 {
1427 &$func(@_);
1428 $section_counter++;
1429 }
1430}
1431
1432##
1433# generic output function - calls the right one based on current output mode.
1434sub output_blockhead {
1435 no strict 'refs';
1436 my $func = "output_blockhead_" . $output_mode;
1437 &$func(@_);
1438 $section_counter++;
1439}
1440
1441##
1442# takes a declaration (struct, union, enum, typedef) and
1443# invokes the right handler. NOT called for functions.
1444sub dump_declaration($$) {
1445 no strict 'refs';
1446 my ($prototype, $file) = @_;
1447 my $func = "dump_" . $decl_type;
1448 &$func(@_);
1449}
1450
1451sub dump_union($$) {
1452 dump_struct(@_);
1453}
1454
1455sub dump_struct($$) {
1456 my $x = shift;
1457 my $file = shift;
1458 my $nested;
1459
1460 if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) {
1461 #my $decl_type = $1;
1462 $declaration_name = $2;
1463 my $members = $3;
1464
1465 # ignore embedded structs or unions
1466 $members =~ s/({.*})//g;
1467 $nested = $1;
1468
1469 # ignore members marked private:
1470 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gos;
1471 $members =~ s/\/\*\s*private:.*//gos;
1472 # strip comments:
1473 $members =~ s/\/\*.*?\*\///gos;
1474 $nested =~ s/\/\*.*?\*\///gos;
1475 # strip kmemcheck_bitfield_{begin,end}.*;
1476 $members =~ s/kmemcheck_bitfield_.*?;//gos;
1477 # strip attributes
1478 $members =~ s/__aligned\s*\(\d+\)//gos;
1479
1480 create_parameterlist($members, ';', $file);
1481 check_sections($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested);
1482
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 {
1497 print STDERR "Error(${file}:$.): Cannot parse struct or union!\n";
1498 ++$errors;
1499 }
1500}
1501
1502sub dump_enum($$) {
1503 my $x = shift;
1504 my $file = shift;
1505
1506 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1507 $x =~ s/^#\s*define\s+.*$//; # strip #define macros inside enums
1508
1509 if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
1510 $declaration_name = $1;
1511 my $members = $2;
1512
1513 foreach my $arg (split ',', $members) {
1514 $arg =~ s/^\s*(\w+).*/$1/;
1515 push @parameterlist, $arg;
1516 if (!$parameterdescs{$arg}) {
1517 $parameterdescs{$arg} = $undescribed;
1518 print STDERR "Warning(${file}:$.): Enum value '$arg' ".
1519 "not described in enum '$declaration_name'\n";
1520 }
1521
1522 }
1523
1524 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 {
1536 print STDERR "Error(${file}:$.): Cannot parse enum!\n";
1537 ++$errors;
1538 }
1539}
1540
1541sub dump_typedef($$) {
1542 my $x = shift;
1543 my $file = shift;
1544
1545 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1546 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1547 $x =~ s/\(*.\)\s*;$/;/;
1548 $x =~ s/\[*.\]\s*;$/;/;
1549 }
1550
1551 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1552 $declaration_name = $1;
1553
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 {
1564 print STDERR "Error(${file}:$.): Cannot parse typedef!\n";
1565 ++$errors;
1566 }
1567}
1568
1569sub 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
1577sub create_parameterlist($$$) {
1578 my $args = shift;
1579 my $splitter = shift;
1580 my $file = shift;
1581 my $type;
1582 my $param;
1583
1584 # temporarily replace commas inside function pointer definition
1585 while ($args =~ /(\([^\),]+),/) {
1586 $args =~ s/(\([^\),]+),/$1#/g;
1587 }
1588
1589 foreach my $arg (split($splitter, $args)) {
1590 # strip comments
1591 $arg =~ s/\/\*.*\*\///;
1592 # strip leading/trailing spaces
1593 $arg =~ s/^\s*//;
1594 $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);
1602 } elsif ($arg =~ m/\(.+\)\s*\(/) {
1603 # pointer-to-function
1604 $arg =~ tr/#/,/;
1605 $arg =~ m/[^\(]+\(\*?\s*(\w*)\s*\)/;
1606 $param = $1;
1607 $type = $arg;
1608 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1609 save_struct_actual($param);
1610 push_parameter($param, $type, $file);
1611 } elsif ($arg) {
1612 $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 }
1619
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
1629 unshift(@args, pop @first_arg);
1630 $type = join " ", @first_arg;
1631
1632 foreach $param (@args) {
1633 if ($param =~ m/^(\*+)\s*(.*)/) {
1634 save_struct_actual($2);
1635 push_parameter($2, "$type $1", $file);
1636 }
1637 elsif ($param =~ m/(.*?):(\d+)/) {
1638 if ($type ne "") { # skip unnamed bit-fields
1639 save_struct_actual($1);
1640 push_parameter($1, "$type:$2", $file)
1641 }
1642 }
1643 else {
1644 save_struct_actual($param);
1645 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
1657 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;
1663 my $param_name = $param;
1664 $param_name =~ s/\[.*//;
1665
1666 if ($type eq "" && $param =~ /\.\.\.$/)
1667 {
1668 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1669 $parameterdescs{$param} = "variable arguments";
1670 }
1671 }
1672 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1673 {
1674 $param="void";
1675 $parameterdescs{void} = "no arguments";
1676 }
1677 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1678 # handle unnamed (anonymous) union or struct:
1679 {
1680 $type = $param;
1681 $param = "{unnamed_" . $param . "}";
1682 $parameterdescs{$param} = "anonymous\n";
1683 $anon_struct_union = 1;
1684 }
1685
1686 # warn if parameter has no description
1687 # (but ignore ones starting with # as these are not parameters
1688 # but inline preprocessor statements);
1689 # also ignore unnamed structs/unions;
1690 if (!$anon_struct_union) {
1691 if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) {
1692
1693 $parameterdescs{$param_name} = $undescribed;
1694
1695 if (($type eq 'function') || ($type eq 'enum')) {
1696 print STDERR "Warning(${file}:$.): Function parameter ".
1697 "or member '$param' not " .
1698 "described in '$declaration_name'\n";
1699 }
1700 print STDERR "Warning(${file}:$.):" .
1701 " No description found for parameter '$param'\n";
1702 ++$warnings;
1703 }
1704 }
1705
1706 $param = xml_escape($param);
1707
1708 # strip spaces from $param so that it is one continuous 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;
1717 push @parameterlist, $param;
1718 $parametertypes{$param} = $type;
1719}
1720
1721sub 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/\[.*\]//;
1734 $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;
1735 # 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
1743 ##$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
1769##
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 +//;
1779 $prototype =~ s/^asmlinkage +//;
1780 $prototype =~ s/^inline +//;
1781 $prototype =~ s/^__inline__ +//;
1782 $prototype =~ s/^__inline +//;
1783 $prototype =~ s/^__always_inline +//;
1784 $prototype =~ s/^noinline +//;
1785 $prototype =~ s/__devinit +//;
1786 $prototype =~ s/__init +//;
1787 $prototype =~ s/__init_or_module +//;
1788 $prototype =~ s/__must_check +//;
1789 $prototype =~ s/^#\s*define\s+//; #ak added
1790 $prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//;
1791
1792 # Yes, this truly is vile. We are looking for:
1793 # 1. Return type (may be nothing if we're looking at a macro)
1794 # 2. Function name
1795 # 3. Function parameters.
1796 #
1797 # All the while we have to watch out for function pointer parameters
1798 # (which IIRC is what the two sections are for), C types (these
1799 # regexps don't even start to express all the possibilities), and
1800 # so on.
1801 #
1802 # If you mess with these regexps, it's a good idea to check that
1803 # the following functions' documentation still comes out right:
1804 # - parport_register_device (function pointer parameters)
1805 # - atomic_set (macro)
1806 # - pci_match_device, __copy_to_user (long return type)
1807
1808 if ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1809 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1810 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1811 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1812 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1813 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1814 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1815 $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1816 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1817 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1818 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1819 $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1820 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1821 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1822 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1823 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1824 $prototype =~ m/^(\w+\s+\w+\s*\*\s*\w+\s*\*\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) {
1825 $return_type = $1;
1826 $declaration_name = $2;
1827 my $args = $3;
1828
1829 create_parameterlist($args, ',', $file);
1830 } else {
1831 print STDERR "Error(${file}:$.): cannot understand prototype: '$prototype'\n";
1832 ++$errors;
1833 return;
1834 }
1835
1836 my $prms = join " ", @parameterlist;
1837 check_sections($file, $declaration_name, "function", $sectcheck, $prms, "");
1838
1839 output_declaration($declaration_name,
1840 'function',
1841 {'function' => $declaration_name,
1842 'module' => $modulename,
1843 'functiontype' => $return_type,
1844 'parameterlist' => \@parameterlist,
1845 'parameterdescs' => \%parameterdescs,
1846 'parametertypes' => \%parametertypes,
1847 'sectionlist' => \@sectionlist,
1848 'sections' => \%sections,
1849 'purpose' => $declaration_purpose
1850 });
1851}
1852
1853sub reset_state {
1854 $function = "";
1855 %constants = ();
1856 %parameterdescs = ();
1857 %parametertypes = ();
1858 @parameterlist = ();
1859 %sections = ();
1860 @sectionlist = ();
1861 $sectcheck = "";
1862 $struct_actual = "";
1863 $prototype = "";
1864
1865 $state = 0;
1866}
1867
1868sub tracepoint_munge($) {
1869 my $file = shift;
1870 my $tracepointname = 0;
1871 my $tracepointargs = 0;
1872
1873 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
1874 $tracepointname = $1;
1875 }
1876 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1877 $tracepointname = $1;
1878 }
1879 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1880 $tracepointname = $2;
1881 }
1882 $tracepointname =~ s/^\s+//; #strip leading whitespace
1883 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
1884 $tracepointargs = $1;
1885 }
1886 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1887 print STDERR "Warning(${file}:$.): Unrecognized tracepoint format: \n".
1888 "$prototype\n";
1889 } else {
1890 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1891 }
1892}
1893
1894sub syscall_munge() {
1895 my $void = 0;
1896
1897 $prototype =~ s@[\r\n\t]+@ @gos; # strip newlines/CR's/tabs
1898## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1899 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1900 $void = 1;
1901## $prototype = "long sys_$1(void)";
1902 }
1903
1904 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1905 if ($prototype =~ m/long (sys_.*?),/) {
1906 $prototype =~ s/,/\(/;
1907 } elsif ($void) {
1908 $prototype =~ s/\)/\(void\)/;
1909 }
1910
1911 # now delete all of the odd-number commas in $prototype
1912 # so that arg types & arg names don't have a comma between them
1913 my $count = 0;
1914 my $len = length($prototype);
1915 if ($void) {
1916 $len = 0; # skip the for-loop
1917 }
1918 for (my $ix = 0; $ix < $len; $ix++) {
1919 if (substr($prototype, $ix, 1) eq ',') {
1920 $count++;
1921 if ($count % 2 == 1) {
1922 substr($prototype, $ix, 1) = ' ';
1923 }
1924 }
1925 }
1926}
1927
1928sub process_state3_function($$) {
1929 my $x = shift;
1930 my $file = shift;
1931
1932 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1933
1934 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
1935 # do nothing
1936 }
1937 elsif ($x =~ /([^\{]*)/) {
1938 $prototype .= $1;
1939 }
1940
1941 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1942 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1943 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1944 $prototype =~ s@^\s+@@gos; # strip leading spaces
1945 if ($prototype =~ /SYSCALL_DEFINE/) {
1946 syscall_munge();
1947 }
1948 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1949 $prototype =~ /DEFINE_SINGLE_EVENT/)
1950 {
1951 tracepoint_munge($file);
1952 }
1953 dump_function($prototype, $file);
1954 reset_state();
1955 }
1956}
1957
1958sub process_state3_type($$) {
1959 my $x = shift;
1960 my $file = shift;
1961
1962 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1963 $x =~ s@^\s+@@gos; # strip leading spaces
1964 $x =~ s@\s+$@@gos; # strip trailing spaces
1965 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1966
1967 if ($x =~ /^#/) {
1968 # To distinguish preprocessor directive from regular declaration later.
1969 $x .= ";";
1970 }
1971
1972 while (1) {
1973 if ( $x =~ /([^{};]*)([{};])(.*)/ ) {
1974 $prototype .= $1 . $2;
1975 ($2 eq '{') && $brcount++;
1976 ($2 eq '}') && $brcount--;
1977 if (($2 eq ';') && ($brcount == 0)) {
1978 dump_declaration($prototype, $file);
1979 reset_state();
1980 last;
1981 }
1982 $x = $3;
1983 } else {
1984 $prototype .= $x;
1985 last;
1986 }
1987 }
1988}
1989
1990# xml_escape: replace <, >, and & in the text stream;
1991#
1992# however, formatting controls that are generated internally/locally in the
1993# kernel-doc script are not escaped here; instead, they begin life like
1994# $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings
1995# are converted to their mnemonic-expected output, without the 4 * '\' & ':',
1996# just before actual output; (this is done by local_unescape())
1997sub xml_escape($) {
1998 my $text = shift;
1999 if (($output_mode eq "text") || ($output_mode eq "man")) {
2000 return $text;
2001 }
2002 $text =~ s/\&/\\\\\\amp;/g;
2003 $text =~ s/\</\\\\\\lt;/g;
2004 $text =~ s/\>/\\\\\\gt;/g;
2005 return $text;
2006}
2007
2008# convert local escape strings to html
2009# local escape strings look like: '\\\\menmonic:' (that's 4 backslashes)
2010sub local_unescape($) {
2011 my $text = shift;
2012 if (($output_mode eq "text") || ($output_mode eq "man")) {
2013 return $text;
2014 }
2015 $text =~ s/\\\\\\\\lt:/</g;
2016 $text =~ s/\\\\\\\\gt:/>/g;
2017 return $text;
2018}
2019
2020sub process_file($) {
2021 my $file;
2022 my $identifier;
2023 my $func;
2024 my $descr;
2025 my $in_purpose = 0;
2026 my $initial_section_counter = $section_counter;
2027
2028 if (defined($ENV{'SRCTREE'})) {
2029 $file = "$ENV{'SRCTREE'}" . "/" . "@_";
2030 }
2031 else {
2032 $file = "@_";
2033 }
2034 if (defined($source_map{$file})) {
2035 $file = $source_map{$file};
2036 }
2037
2038 if (!open(IN,"<$file")) {
2039 print STDERR "Error: Cannot open file $file\n";
2040 ++$errors;
2041 return;
2042 }
2043
2044 $. = 1;
2045
2046 $section_counter = 0;
2047 while (<IN>) {
2048 if ($state == 0) {
2049 if (/$doc_start/o) {
2050 $state = 1; # next line is always the function name
2051 $in_doc_sect = 0;
2052 }
2053 } elsif ($state == 1) { # this line is the function name (always)
2054 if (/$doc_block/o) {
2055 $state = 4;
2056 $contents = "";
2057 if ( $1 eq "" ) {
2058 $section = $section_intro;
2059 } else {
2060 $section = $1;
2061 }
2062 }
2063 elsif (/$doc_decl/o) {
2064 $identifier = $1;
2065 if (/\s*([\w\s]+?)\s*-/) {
2066 $identifier = $1;
2067 }
2068
2069 $state = 2;
2070 if (/-(.*)/) {
2071 # strip leading/trailing/multiple spaces
2072 $descr= $1;
2073 $descr =~ s/^\s*//;
2074 $descr =~ s/\s*$//;
2075 $descr =~ s/\s+/ /;
2076 $declaration_purpose = xml_escape($descr);
2077 $in_purpose = 1;
2078 } else {
2079 $declaration_purpose = "";
2080 }
2081
2082 if (($declaration_purpose eq "") && $verbose) {
2083 print STDERR "Warning(${file}:$.): missing initial short description on line:\n";
2084 print STDERR $_;
2085 ++$warnings;
2086 }
2087
2088 if ($identifier =~ m/^struct/) {
2089 $decl_type = 'struct';
2090 } elsif ($identifier =~ m/^union/) {
2091 $decl_type = 'union';
2092 } elsif ($identifier =~ m/^enum/) {
2093 $decl_type = 'enum';
2094 } elsif ($identifier =~ m/^typedef/) {
2095 $decl_type = 'typedef';
2096 } else {
2097 $decl_type = 'function';
2098 }
2099
2100 if ($verbose) {
2101 print STDERR "Info(${file}:$.): Scanning doc for $identifier\n";
2102 }
2103 } else {
2104 print STDERR "Warning(${file}:$.): Cannot understand $_ on line $.",
2105 " - I thought it was a doc line\n";
2106 ++$warnings;
2107 $state = 0;
2108 }
2109 } elsif ($state == 2) { # look for head: lines, and include content
2110 if (/$doc_sect/o) {
2111 $newsection = $1;
2112 $newcontents = $2;
2113
2114 if (($contents ne "") && ($contents ne "\n")) {
2115 if (!$in_doc_sect && $verbose) {
2116 print STDERR "Warning(${file}:$.): contents before sections\n";
2117 ++$warnings;
2118 }
2119 dump_section($file, $section, xml_escape($contents));
2120 $section = $section_default;
2121 }
2122
2123 $in_doc_sect = 1;
2124 $in_purpose = 0;
2125 $contents = $newcontents;
2126 if ($contents ne "") {
2127 while ((substr($contents, 0, 1) eq " ") ||
2128 substr($contents, 0, 1) eq "\t") {
2129 $contents = substr($contents, 1);
2130 }
2131 $contents .= "\n";
2132 }
2133 $section = $newsection;
2134 } elsif (/$doc_end/) {
2135
2136 if (($contents ne "") && ($contents ne "\n")) {
2137 dump_section($file, $section, xml_escape($contents));
2138 $section = $section_default;
2139 $contents = "";
2140 }
2141 # look for doc_com + <text> + doc_end:
2142 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2143 print STDERR "Warning(${file}:$.): suspicious ending line: $_";
2144 ++$warnings;
2145 }
2146
2147 $prototype = "";
2148 $state = 3;
2149 $brcount = 0;
2150# print STDERR "end of doc comment, looking for prototype\n";
2151 } elsif (/$doc_content/) {
2152 # miguel-style comment kludge, look for blank lines after
2153 # @parameter line to signify start of description
2154 if ($1 eq "") {
2155 if ($section =~ m/^@/ || $section eq $section_context) {
2156 dump_section($file, $section, xml_escape($contents));
2157 $section = $section_default;
2158 $contents = "";
2159 } else {
2160 $contents .= "\n";
2161 }
2162 $in_purpose = 0;
2163 } elsif ($in_purpose == 1) {
2164 # Continued declaration purpose
2165 chomp($declaration_purpose);
2166 $declaration_purpose .= " " . xml_escape($1);
2167 } else {
2168 $contents .= $1 . "\n";
2169 }
2170 } else {
2171 # i dont know - bad line? ignore.
2172 print STDERR "Warning(${file}:$.): bad line: $_";
2173 ++$warnings;
2174 }
2175 } elsif ($state == 3) { # scanning for function '{' (end of prototype)
2176 if ($decl_type eq 'function') {
2177 process_state3_function($_, $file);
2178 } else {
2179 process_state3_type($_, $file);
2180 }
2181 } elsif ($state == 4) {
2182 # Documentation block
2183 if (/$doc_block/) {
2184 dump_doc_section($file, $section, xml_escape($contents));
2185 $contents = "";
2186 $function = "";
2187 %constants = ();
2188 %parameterdescs = ();
2189 %parametertypes = ();
2190 @parameterlist = ();
2191 %sections = ();
2192 @sectionlist = ();
2193 $prototype = "";
2194 if ( $1 eq "" ) {
2195 $section = $section_intro;
2196 } else {
2197 $section = $1;
2198 }
2199 }
2200 elsif (/$doc_end/)
2201 {
2202 dump_doc_section($file, $section, xml_escape($contents));
2203 $contents = "";
2204 $function = "";
2205 %constants = ();
2206 %parameterdescs = ();
2207 %parametertypes = ();
2208 @parameterlist = ();
2209 %sections = ();
2210 @sectionlist = ();
2211 $prototype = "";
2212 $state = 0;
2213 }
2214 elsif (/$doc_content/)
2215 {
2216 if ( $1 eq "" )
2217 {
2218 $contents .= $blankline;
2219 }
2220 else
2221 {
2222 $contents .= $1 . "\n";
2223 }
2224 }
2225 }
2226 }
2227 if ($initial_section_counter == $section_counter) {
2228 print STDERR "Warning(${file}): no structured comments found\n";
2229 if ($output_mode eq "xml") {
2230 # The template wants at least one RefEntry here; make one.
2231 print "<refentry>\n";
2232 print " <refnamediv>\n";
2233 print " <refname>\n";
2234 print " ${file}\n";
2235 print " </refname>\n";
2236 print " <refpurpose>\n";
2237 print " Document generation inconsistency\n";
2238 print " </refpurpose>\n";
2239 print " </refnamediv>\n";
2240 print " <refsect1>\n";
2241 print " <title>\n";
2242 print " Oops\n";
2243 print " </title>\n";
2244 print " <warning>\n";
2245 print " <para>\n";
2246 print " The template for this document tried to insert\n";
2247 print " the structured comment from the file\n";
2248 print " <filename>${file}</filename> at this point,\n";
2249 print " but none was found.\n";
2250 print " This dummy section is inserted to allow\n";
2251 print " generation to continue.\n";
2252 print " </para>\n";
2253 print " </warning>\n";
2254 print " </refsect1>\n";
2255 print "</refentry>\n";
2256 }
2257 }
2258}
2259
2260
2261$kernelversion = get_kernel_version();
2262
2263# generate a sequence of code that will splice in highlighting information
2264# using the s// operator.
2265foreach my $pattern (keys %highlights) {
2266# print STDERR "scanning pattern:$pattern, highlight:($highlights{$pattern})\n";
2267 $dohighlight .= "\$contents =~ s:$pattern:$highlights{$pattern}:gs;\n";
2268}
2269
2270# Read the file that maps relative names to absolute names for
2271# separate source and object directories and for shadow trees.
2272if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2273 my ($relname, $absname);
2274 while(<SOURCE_MAP>) {
2275 chop();
2276 ($relname, $absname) = (split())[0..1];
2277 $relname =~ s:^/+::;
2278 $source_map{$relname} = $absname;
2279 }
2280 close(SOURCE_MAP);
2281}
2282
2283foreach (@ARGV) {
2284 chomp;
2285 process_file($_);
2286}
2287if ($verbose && $errors) {
2288 print STDERR "$errors errors\n";
2289}
2290if ($verbose && $warnings) {
2291 print STDERR "$warnings warnings\n";
2292}
2293
2294exit($errors);