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