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-2009 Randy Dunlap ##
10 ## #define enhancements by Armin Kuster <akuster@mvista.com> ##
11 ## Copyright (c) 2000 MontaVista Software, Inc. ##
13 ## This software falls under the GNU General Public License. ##
14 ## Please read the COPYING file for more information ##
16 # w.o. 03-11-2000: added the '-filelist' option.
18 # 18/01/2001 - Cleanups
19 # Functions prototyped as foo(void) same as foo()
20 # Stop eval'ing where we don't need to.
23 # 27/06/2001 - Allowed whitespace after initial "/**" and
24 # allowed comments before function declarations.
25 # -- Christian Kreibich <ck@whoop.org>
28 # - add perldoc documentation
29 # - Look more closely at some of the scarier bits :)
31 # 26/05/2001 - Support for separate source and object trees.
33 # Keith Owens <kaos@ocs.com.au>
35 # 23/09/2001 - Added support for typedefs, structs, enums and unions
36 # Support for Context section; can be terminated using empty line
37 # Small fixes (like spaces vs. \s in regex)
38 # -- Tim Jansen <tim@tjansen.de>
42 # This will read a 'c' file and scan for embedded comments in the
43 # style of gnome comments (+minor extensions - see below).
46 # Note: This only supports 'c'.
49 # kernel-doc [ -docbook | -html | -text | -man ] [ -no-doc-sections ]
50 # [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile
52 # [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile
54 # Set output format using one of -docbook -html -text or -man. Default is man.
57 # Do not output DOC: sections
60 # If set, then only generate documentation for the given function(s) or
61 # DOC: section titles. All other functions and DOC: sections are ignored.
63 # -nofunction funcname
64 # If set, then only generate documentation for the other function(s)/DOC:
65 # sections. Cannot be used together with -function (yes, that's a bug --
66 # perl hackers can fix it 8))
68 # c files - list of 'c' files to process
70 # All output goes to stdout, with errors to stderr.
74 # In the following table, (...)? signifies optional structure.
75 # (...)* signifies 0 or more structure elements
77 # * function_name(:)? (- short description)?
78 # (* @parameterx: (description of parameter x)?)*
80 # * (Description:)? (Description of function)?
81 # * (section header: (section description)? )*
84 # So .. the trivial example would be:
90 # If the Description: header tag is omitted, then there must be a blank line
91 # after the last parameter specification.
94 # * my_function - does my stuff
95 # * @my_arg: its mine damnit
97 # * Does my stuff explained.
100 # or, could also use:
102 # * my_function - does my stuff
103 # * @my_arg: its mine damnit
104 # * Description: Does my stuff explained.
108 # Besides functions you can also write documentation for structs, unions,
109 # enums and typedefs. Instead of the function name you must write the name
110 # of the declaration; the struct/union/enum/typedef must always precede
111 # the name. Nesting of declarations is not supported.
112 # Use the argument mechanism to document members or constants.
115 # * struct my_struct - short description
117 # * @b: second member
119 # * Longer description
128 # All descriptions can be multiline, except the short function description.
130 # You can also add additional sections. When documenting kernel functions you
131 # should document the "Context:" of the function, e.g. whether the functions
132 # can be called form interrupts. Unlike other sections you can end it with an
134 # Example-sections should contain the string EXAMPLE so that they are marked
135 # appropriately in DocBook.
139 # * user_function - function that can only be called in user context
140 # * @a: some argument
141 # * Context: !in_interrupt()
145 # * user_function(22);
150 # All descriptive text is further processed, scanning for the following special
151 # patterns, which are highlighted appropriately.
153 # 'funcname()' - function
154 # '$ENVVAR' - environmental variable
155 # '&struct_name' - name of a structure (up to two words including 'struct')
156 # '@parameter' - name of a parameter
157 # '%CONST' - name of a constant.
161 my $anon_struct_union = 0;
163 # match expressions used to find embedded type information
164 my $type_constant = '\%([-_\w]+)';
165 my $type_func = '(\w+)\(\)';
166 my $type_param = '\@(\w+)';
167 my $type_struct = '\&((struct\s*)*[_\w]+)';
168 my $type_struct_xml = '\\&((struct\s*)*[_\w]+)';
169 my $type_env = '(\$\w+)';
171 # Output conversion substitutions.
172 # One for each output format
174 # these work fairly well
175 my %highlights_html = ( $type_constant, "<i>\$1</i>",
176 $type_func, "<b>\$1</b>",
177 $type_struct_xml, "<i>\$1</i>",
178 $type_env, "<b><i>\$1</i></b>",
179 $type_param, "<tt><b>\$1</b></tt>" );
180 my $local_lt = "\\\\\\\\lt:";
181 my $local_gt = "\\\\\\\\gt:";
182 my $blankline_html = $local_lt . "p" . $local_gt; # was "<p>"
184 # XML, docbook format
185 my %highlights_xml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>",
186 $type_constant, "<constant>\$1</constant>",
187 $type_func, "<function>\$1</function>",
188 $type_struct_xml, "<structname>\$1</structname>",
189 $type_env, "<envar>\$1</envar>",
190 $type_param, "<parameter>\$1</parameter>" );
191 my $blankline_xml = $local_lt . "/para" . $local_gt . $local_lt . "para" . $local_gt . "\n";
193 # gnome, docbook format
194 my %highlights_gnome = ( $type_constant, "<replaceable class=\"option\">\$1</replaceable>",
195 $type_func, "<function>\$1</function>",
196 $type_struct, "<structname>\$1</structname>",
197 $type_env, "<envar>\$1</envar>",
198 $type_param, "<parameter>\$1</parameter>" );
199 my $blankline_gnome = "</para><para>\n";
201 # these are pretty rough
202 my %highlights_man = ( $type_constant, "\$1",
203 $type_func, "\\\\fB\$1\\\\fP",
204 $type_struct, "\\\\fI\$1\\\\fP",
205 $type_param, "\\\\fI\$1\\\\fP" );
206 my $blankline_man = "";
209 my %highlights_text = ( $type_constant, "\$1",
212 $type_param, "\$1" );
213 my $blankline_text = "";
217 print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man ] [ -no-doc-sections ]\n";
218 print " [ -function funcname [ -function funcname ...] ]\n";
219 print " [ -nofunction funcname [ -nofunction funcname ...] ]\n";
220 print " c source file(s) > outputfile\n";
221 print " -v : verbose output, more warnings & other info listed\n";
231 my $output_mode = "man";
232 my $no_doc_sections = 0;
233 my %highlights = %highlights_man;
234 my $blankline = $blankline_man;
235 my $modulename = "Kernel API";
236 my $function_only = 0;
237 my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
238 'July', 'August', 'September', 'October',
239 'November', 'December')[(localtime)[4]] .
240 " " . ((localtime)[5]+1900);
242 # Essentially these are globals
243 # They probably want to be tidied up, made more localised or something.
244 # CAVEAT EMPTOR! Some of the others I localised may not want to be, which
245 # could cause "use of undefined value" or other bugs.
246 my ($function, %function_table, %parametertypes, $declaration_purpose);
247 my ($type, $declaration_name, $return_type);
248 my ($newsection, $newcontents, $prototype, $filelist, $brcount, %source_map);
250 if (defined($ENV{'KBUILD_VERBOSE'})) {
251 $verbose = "$ENV{'KBUILD_VERBOSE'}";
254 # Generated docbook code is inserted in a template at a point where
255 # docbook v3.1 requires a non-zero sequence of RefEntry's; see:
256 # http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
257 # We keep track of number of generated entries and generate a dummy
258 # if needs be to ensure the expanded template can be postprocessed
260 my $section_counter = 0;
266 # 1 - looking for function name
267 # 2 - scanning field start.
268 # 3 - scanning prototype.
269 # 4 - documentation block
273 #declaration types: can be
274 # 'function', 'struct', 'union', 'enum', 'typedef'
277 my $doc_special = "\@\%\$\&";
279 my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
281 my $doc_com = '\s*\*\s*';
282 my $doc_decl = $doc_com . '(\w+)';
283 my $doc_sect = $doc_com . '([' . $doc_special . ']?[\w\s]+):(.*)';
284 my $doc_content = $doc_com . '(.*)';
285 my $doc_block = $doc_com . 'DOC:\s*(.*)?';
296 my $section_default = "Description"; # default section
297 my $section_intro = "Introduction";
298 my $section = $section_default;
299 my $section_context = "Context";
301 my $undescribed = "-- undescribed --";
305 while ($ARGV[0] =~ m/^-(.*)/) {
306 my $cmd = shift @ARGV;
307 if ($cmd eq "-html") {
308 $output_mode = "html";
309 %highlights = %highlights_html;
310 $blankline = $blankline_html;
311 } elsif ($cmd eq "-man") {
312 $output_mode = "man";
313 %highlights = %highlights_man;
314 $blankline = $blankline_man;
315 } elsif ($cmd eq "-text") {
316 $output_mode = "text";
317 %highlights = %highlights_text;
318 $blankline = $blankline_text;
319 } elsif ($cmd eq "-docbook") {
320 $output_mode = "xml";
321 %highlights = %highlights_xml;
322 $blankline = $blankline_xml;
323 } elsif ($cmd eq "-gnome") {
324 $output_mode = "gnome";
325 %highlights = %highlights_gnome;
326 $blankline = $blankline_gnome;
327 } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document
328 $modulename = shift @ARGV;
329 } elsif ($cmd eq "-function") { # to only output specific functions
331 $function = shift @ARGV;
332 $function_table{$function} = 1;
333 } elsif ($cmd eq "-nofunction") { # to only output specific functions
335 $function = shift @ARGV;
336 $function_table{$function} = 1;
337 } elsif ($cmd eq "-v") {
339 } elsif (($cmd eq "-h") || ($cmd eq "--help")) {
341 } elsif ($cmd eq '-filelist') {
342 $filelist = shift @ARGV;
343 } elsif ($cmd eq '-no-doc-sections') {
344 $no_doc_sections = 1;
348 # get kernel version from env
349 sub get_kernel_version
() {
350 my $version = 'unknown kernel version';
352 if (defined($ENV{'KERNELVERSION'})) {
353 $version = $ENV{'KERNELVERSION'};
357 my $kernelversion = get_kernel_version
();
359 # generate a sequence of code that will splice in highlighting information
360 # using the s// operator.
361 my $dohighlight = "";
362 foreach my $pattern (keys %highlights) {
363 # print STDERR "scanning pattern:$pattern, highlight:($highlights{$pattern})\n";
364 $dohighlight .= "\$contents =~ s:$pattern:$highlights{$pattern}:gs;\n";
368 # dumps section contents to arrays/hashes intended for that purpose.
373 my $contents = join "\n", @_;
375 if ($name =~ m/$type_constant/) {
377 # print STDERR "constant section '$1' = '$contents'\n";
378 $constants{$name} = $contents;
379 } elsif ($name =~ m/$type_param/) {
380 # print STDERR "parameter def '$1' = '$contents'\n";
382 $parameterdescs{$name} = $contents;
383 $sectcheck = $sectcheck . $name . " ";
384 } elsif ($name eq "@\.\.\.") {
385 # print STDERR "parameter def '...' = '$contents'\n";
387 $parameterdescs{$name} = $contents;
388 $sectcheck = $sectcheck . $name . " ";
390 # print STDERR "other section '$name' = '$contents'\n";
391 if (defined($sections{$name}) && ($sections{$name} ne "")) {
392 print STDERR
"Error(${file}:$.): duplicate section name '$name'\n";
395 $sections{$name} = $contents;
396 push @sectionlist, $name;
401 # dump DOC: section after checking that it should go out
403 sub dump_doc_section
{
406 my $contents = join "\n", @_;
408 if ($no_doc_sections) {
412 if (($function_only == 0) ||
413 ( $function_only == 1 && defined($function_table{$name})) ||
414 ( $function_only == 2 && !defined($function_table{$name})))
416 dump_section
($file, $name, $contents);
417 output_blockhead
({'sectionlist' => \
@sectionlist,
418 'sections' => \
%sections,
419 'module' => $modulename,
420 'content-only' => ($function_only != 0), });
427 # parameterdescs, a hash.
428 # function => "function name"
429 # parameterlist => @list of parameters
430 # parameterdescs => %parameter descriptions
431 # sectionlist => @list of sections
432 # sections => %section descriptions
435 sub output_highlight
{
436 my $contents = join "\n",@_;
440 # if (!defined $contents) {
442 # confess "output_highlight got called with no args?\n";
445 if ($output_mode eq "html" || $output_mode eq "xml") {
446 $contents = local_unescape
($contents);
447 # convert data read & converted thru xml_escape() into &xyz; format:
448 $contents =~ s/\\\\\\/&/g;
450 # print STDERR "contents b4:$contents\n";
453 # print STDERR "contents af:$contents\n";
455 foreach $line (split "\n", $contents) {
457 print $lineprefix, local_unescape
($blankline);
459 $line =~ s/\\\\\\/\&/g;
460 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
463 print $lineprefix, $line;
470 #output sections in html
471 sub output_section_html
(%) {
475 foreach $section (@
{$args{'sectionlist'}}) {
476 print "<h3>$section</h3>\n";
477 print "<blockquote>\n";
478 output_highlight
($args{'sections'}{$section});
479 print "</blockquote>\n";
483 # output enum in html
484 sub output_enum_html
(%) {
488 print "<h2>enum " . $args{'enum'} . "</h2>\n";
490 print "<b>enum " . $args{'enum'} . "</b> {<br>\n";
492 foreach $parameter (@
{$args{'parameterlist'}}) {
493 print " <b>" . $parameter . "</b>";
494 if ($count != $#{$args{'parameterlist'}}) {
502 print "<h3>Constants</h3>\n";
504 foreach $parameter (@
{$args{'parameterlist'}}) {
505 print "<dt><b>" . $parameter . "</b>\n";
507 output_highlight
($args{'parameterdescs'}{$parameter});
510 output_section_html
(@_);
514 # output typedef in html
515 sub output_typedef_html
(%) {
519 print "<h2>typedef " . $args{'typedef'} . "</h2>\n";
521 print "<b>typedef " . $args{'typedef'} . "</b>\n";
522 output_section_html
(@_);
526 # output struct in html
527 sub output_struct_html
(%) {
531 print "<h2>" . $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "</h2>\n";
532 print "<b>" . $args{'type'} . " " . $args{'struct'} . "</b> {<br>\n";
533 foreach $parameter (@
{$args{'parameterlist'}}) {
534 if ($parameter =~ /^#/) {
535 print "$parameter<br>\n";
538 my $parameter_name = $parameter;
539 $parameter_name =~ s/\[.*//;
541 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
542 $type = $args{'parametertypes'}{$parameter};
543 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
544 # pointer-to-function
545 print " <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>\n";
546 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
548 print " <i>$1</i> <b>$parameter</b>$2;<br>\n";
550 print " <i>$type</i> <b>$parameter</b>;<br>\n";
555 print "<h3>Members</h3>\n";
557 foreach $parameter (@
{$args{'parameterlist'}}) {
558 ($parameter =~ /^#/) && next;
560 my $parameter_name = $parameter;
561 $parameter_name =~ s/\[.*//;
563 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
564 print "<dt><b>" . $parameter . "</b>\n";
566 output_highlight
($args{'parameterdescs'}{$parameter_name});
569 output_section_html
(@_);
573 # output function in html
574 sub output_function_html
(%) {
576 my ($parameter, $section);
579 print "<h2>" . $args{'function'} . " - " . $args{'purpose'} . "</h2>\n";
580 print "<i>" . $args{'functiontype'} . "</i>\n";
581 print "<b>" . $args{'function'} . "</b>\n";
584 foreach $parameter (@
{$args{'parameterlist'}}) {
585 $type = $args{'parametertypes'}{$parameter};
586 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
587 # pointer-to-function
588 print "<i>$1</i><b>$parameter</b>) <i>($2)</i>";
590 print "<i>" . $type . "</i> <b>" . $parameter . "</b>";
592 if ($count != $#{$args{'parameterlist'}}) {
599 print "<h3>Arguments</h3>\n";
601 foreach $parameter (@
{$args{'parameterlist'}}) {
602 my $parameter_name = $parameter;
603 $parameter_name =~ s/\[.*//;
605 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
606 print "<dt><b>" . $parameter . "</b>\n";
608 output_highlight
($args{'parameterdescs'}{$parameter_name});
611 output_section_html
(@_);
615 # output DOC: block header in html
616 sub output_blockhead_html
(%) {
618 my ($parameter, $section);
621 foreach $section (@
{$args{'sectionlist'}}) {
622 print "<h3>$section</h3>\n";
624 output_highlight
($args{'sections'}{$section});
630 sub output_section_xml
(%) {
633 # print out each section
635 foreach $section (@
{$args{'sectionlist'}}) {
636 print "<refsect1>\n";
637 print "<title>$section</title>\n";
638 if ($section =~ m/EXAMPLE/i) {
639 print "<informalexample><programlisting>\n";
643 output_highlight
($args{'sections'}{$section});
644 if ($section =~ m/EXAMPLE/i) {
645 print "</programlisting></informalexample>\n";
649 print "</refsect1>\n";
653 # output function in XML DocBook
654 sub output_function_xml
(%) {
656 my ($parameter, $section);
660 $id = "API-" . $args{'function'};
661 $id =~ s/[^A-Za-z0-9]/-/g;
663 print "<refentry id=\"$id\">\n";
664 print "<refentryinfo>\n";
665 print " <title>LINUX</title>\n";
666 print " <productname>Kernel Hackers Manual</productname>\n";
667 print " <date>$man_date</date>\n";
668 print "</refentryinfo>\n";
670 print " <refentrytitle><phrase>" . $args{'function'} . "</phrase></refentrytitle>\n";
671 print " <manvolnum>9</manvolnum>\n";
672 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
673 print "</refmeta>\n";
674 print "<refnamediv>\n";
675 print " <refname>" . $args{'function'} . "</refname>\n";
676 print " <refpurpose>\n";
678 output_highlight
($args{'purpose'});
679 print " </refpurpose>\n";
680 print "</refnamediv>\n";
682 print "<refsynopsisdiv>\n";
683 print " <title>Synopsis</title>\n";
684 print " <funcsynopsis><funcprototype>\n";
685 print " <funcdef>" . $args{'functiontype'} . " ";
686 print "<function>" . $args{'function'} . " </function></funcdef>\n";
689 if ($#{$args{'parameterlist'}} >= 0) {
690 foreach $parameter (@
{$args{'parameterlist'}}) {
691 $type = $args{'parametertypes'}{$parameter};
692 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
693 # pointer-to-function
694 print " <paramdef>$1<parameter>$parameter</parameter>)\n";
695 print " <funcparams>$2</funcparams></paramdef>\n";
697 print " <paramdef>" . $type;
698 print " <parameter>$parameter</parameter></paramdef>\n";
704 print " </funcprototype></funcsynopsis>\n";
705 print "</refsynopsisdiv>\n";
708 print "<refsect1>\n <title>Arguments</title>\n";
709 if ($#{$args{'parameterlist'}} >= 0) {
710 print " <variablelist>\n";
711 foreach $parameter (@
{$args{'parameterlist'}}) {
712 my $parameter_name = $parameter;
713 $parameter_name =~ s/\[.*//;
715 print " <varlistentry>\n <term><parameter>$parameter</parameter></term>\n";
716 print " <listitem>\n <para>\n";
718 output_highlight
($args{'parameterdescs'}{$parameter_name});
719 print " </para>\n </listitem>\n </varlistentry>\n";
721 print " </variablelist>\n";
723 print " <para>\n None\n </para>\n";
725 print "</refsect1>\n";
727 output_section_xml
(@_);
728 print "</refentry>\n\n";
731 # output struct in XML DocBook
732 sub output_struct_xml
(%) {
734 my ($parameter, $section);
737 $id = "API-struct-" . $args{'struct'};
738 $id =~ s/[^A-Za-z0-9]/-/g;
740 print "<refentry id=\"$id\">\n";
741 print "<refentryinfo>\n";
742 print " <title>LINUX</title>\n";
743 print " <productname>Kernel Hackers Manual</productname>\n";
744 print " <date>$man_date</date>\n";
745 print "</refentryinfo>\n";
747 print " <refentrytitle><phrase>" . $args{'type'} . " " . $args{'struct'} . "</phrase></refentrytitle>\n";
748 print " <manvolnum>9</manvolnum>\n";
749 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
750 print "</refmeta>\n";
751 print "<refnamediv>\n";
752 print " <refname>" . $args{'type'} . " " . $args{'struct'} . "</refname>\n";
753 print " <refpurpose>\n";
755 output_highlight
($args{'purpose'});
756 print " </refpurpose>\n";
757 print "</refnamediv>\n";
759 print "<refsynopsisdiv>\n";
760 print " <title>Synopsis</title>\n";
761 print " <programlisting>\n";
762 print $args{'type'} . " " . $args{'struct'} . " {\n";
763 foreach $parameter (@
{$args{'parameterlist'}}) {
764 if ($parameter =~ /^#/) {
765 print "$parameter\n";
769 my $parameter_name = $parameter;
770 $parameter_name =~ s/\[.*//;
772 defined($args{'parameterdescs'}{$parameter_name}) || next;
773 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
774 $type = $args{'parametertypes'}{$parameter};
775 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
776 # pointer-to-function
777 print " $1 $parameter) ($2);\n";
778 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
780 print " $1 $parameter$2;\n";
782 print " " . $type . " " . $parameter . ";\n";
786 print " </programlisting>\n";
787 print "</refsynopsisdiv>\n";
789 print " <refsect1>\n";
790 print " <title>Members</title>\n";
792 if ($#{$args{'parameterlist'}} >= 0) {
793 print " <variablelist>\n";
794 foreach $parameter (@
{$args{'parameterlist'}}) {
795 ($parameter =~ /^#/) && next;
797 my $parameter_name = $parameter;
798 $parameter_name =~ s/\[.*//;
800 defined($args{'parameterdescs'}{$parameter_name}) || next;
801 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
802 print " <varlistentry>";
803 print " <term>$parameter</term>\n";
804 print " <listitem><para>\n";
805 output_highlight
($args{'parameterdescs'}{$parameter_name});
806 print " </para></listitem>\n";
807 print " </varlistentry>\n";
809 print " </variablelist>\n";
811 print " <para>\n None\n </para>\n";
813 print " </refsect1>\n";
815 output_section_xml
(@_);
817 print "</refentry>\n\n";
820 # output enum in XML DocBook
821 sub output_enum_xml
(%) {
823 my ($parameter, $section);
827 $id = "API-enum-" . $args{'enum'};
828 $id =~ s/[^A-Za-z0-9]/-/g;
830 print "<refentry id=\"$id\">\n";
831 print "<refentryinfo>\n";
832 print " <title>LINUX</title>\n";
833 print " <productname>Kernel Hackers Manual</productname>\n";
834 print " <date>$man_date</date>\n";
835 print "</refentryinfo>\n";
837 print " <refentrytitle><phrase>enum " . $args{'enum'} . "</phrase></refentrytitle>\n";
838 print " <manvolnum>9</manvolnum>\n";
839 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
840 print "</refmeta>\n";
841 print "<refnamediv>\n";
842 print " <refname>enum " . $args{'enum'} . "</refname>\n";
843 print " <refpurpose>\n";
845 output_highlight
($args{'purpose'});
846 print " </refpurpose>\n";
847 print "</refnamediv>\n";
849 print "<refsynopsisdiv>\n";
850 print " <title>Synopsis</title>\n";
851 print " <programlisting>\n";
852 print "enum " . $args{'enum'} . " {\n";
854 foreach $parameter (@
{$args{'parameterlist'}}) {
856 if ($count != $#{$args{'parameterlist'}}) {
863 print " </programlisting>\n";
864 print "</refsynopsisdiv>\n";
866 print "<refsect1>\n";
867 print " <title>Constants</title>\n";
868 print " <variablelist>\n";
869 foreach $parameter (@
{$args{'parameterlist'}}) {
870 my $parameter_name = $parameter;
871 $parameter_name =~ s/\[.*//;
873 print " <varlistentry>";
874 print " <term>$parameter</term>\n";
875 print " <listitem><para>\n";
876 output_highlight
($args{'parameterdescs'}{$parameter_name});
877 print " </para></listitem>\n";
878 print " </varlistentry>\n";
880 print " </variablelist>\n";
881 print "</refsect1>\n";
883 output_section_xml
(@_);
885 print "</refentry>\n\n";
888 # output typedef in XML DocBook
889 sub output_typedef_xml
(%) {
891 my ($parameter, $section);
894 $id = "API-typedef-" . $args{'typedef'};
895 $id =~ s/[^A-Za-z0-9]/-/g;
897 print "<refentry id=\"$id\">\n";
898 print "<refentryinfo>\n";
899 print " <title>LINUX</title>\n";
900 print " <productname>Kernel Hackers Manual</productname>\n";
901 print " <date>$man_date</date>\n";
902 print "</refentryinfo>\n";
904 print " <refentrytitle><phrase>typedef " . $args{'typedef'} . "</phrase></refentrytitle>\n";
905 print " <manvolnum>9</manvolnum>\n";
906 print "</refmeta>\n";
907 print "<refnamediv>\n";
908 print " <refname>typedef " . $args{'typedef'} . "</refname>\n";
909 print " <refpurpose>\n";
911 output_highlight
($args{'purpose'});
912 print " </refpurpose>\n";
913 print "</refnamediv>\n";
915 print "<refsynopsisdiv>\n";
916 print " <title>Synopsis</title>\n";
917 print " <synopsis>typedef " . $args{'typedef'} . ";</synopsis>\n";
918 print "</refsynopsisdiv>\n";
920 output_section_xml
(@_);
922 print "</refentry>\n\n";
925 # output in XML DocBook
926 sub output_blockhead_xml
(%) {
928 my ($parameter, $section);
931 my $id = $args{'module'};
932 $id =~ s/[^A-Za-z0-9]/-/g;
934 # print out each section
936 foreach $section (@
{$args{'sectionlist'}}) {
937 if (!$args{'content-only'}) {
938 print "<refsect1>\n <title>$section</title>\n";
940 if ($section =~ m/EXAMPLE/i) {
941 print "<example><para>\n";
945 output_highlight
($args{'sections'}{$section});
946 if ($section =~ m/EXAMPLE/i) {
947 print "</para></example>\n";
951 if (!$args{'content-only'}) {
952 print "\n</refsect1>\n";
959 # output in XML DocBook
960 sub output_function_gnome
{
962 my ($parameter, $section);
966 $id = $args{'module'} . "-" . $args{'function'};
967 $id =~ s/[^A-Za-z0-9]/-/g;
970 print " <title id=\"$id\">" . $args{'function'} . "</title>\n";
972 print " <funcsynopsis>\n";
973 print " <funcdef>" . $args{'functiontype'} . " ";
974 print "<function>" . $args{'function'} . " ";
975 print "</function></funcdef>\n";
978 if ($#{$args{'parameterlist'}} >= 0) {
979 foreach $parameter (@
{$args{'parameterlist'}}) {
980 $type = $args{'parametertypes'}{$parameter};
981 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
982 # pointer-to-function
983 print " <paramdef>$1 <parameter>$parameter</parameter>)\n";
984 print " <funcparams>$2</funcparams></paramdef>\n";
986 print " <paramdef>" . $type;
987 print " <parameter>$parameter</parameter></paramdef>\n";
993 print " </funcsynopsis>\n";
994 if ($#{$args{'parameterlist'}} >= 0) {
995 print " <informaltable pgwide=\"1\" frame=\"none\" role=\"params\">\n";
996 print "<tgroup cols=\"2\">\n";
997 print "<colspec colwidth=\"2*\">\n";
998 print "<colspec colwidth=\"8*\">\n";
1000 foreach $parameter (@
{$args{'parameterlist'}}) {
1001 my $parameter_name = $parameter;
1002 $parameter_name =~ s/\[.*//;
1004 print " <row><entry align=\"right\"><parameter>$parameter</parameter></entry>\n";
1007 output_highlight
($args{'parameterdescs'}{$parameter_name});
1008 print " </entry></row>\n";
1010 print " </tbody></tgroup></informaltable>\n";
1012 print " <para>\n None\n </para>\n";
1015 # print out each section
1017 foreach $section (@
{$args{'sectionlist'}}) {
1018 print "<simplesect>\n <title>$section</title>\n";
1019 if ($section =~ m/EXAMPLE/i) {
1020 print "<example><programlisting>\n";
1024 output_highlight
($args{'sections'}{$section});
1026 if ($section =~ m/EXAMPLE/i) {
1027 print "</programlisting></example>\n";
1030 print " </simplesect>\n";
1033 print "</sect2>\n\n";
1037 # output function in man
1038 sub output_function_man
(%) {
1039 my %args = %{$_[0]};
1040 my ($parameter, $section);
1043 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
1046 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
1048 print ".SH SYNOPSIS\n";
1049 if ($args{'functiontype'} ne "") {
1050 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
1052 print ".B \"" . $args{'function'} . "\n";
1057 foreach my $parameter (@
{$args{'parameterlist'}}) {
1058 if ($count == $#{$args{'parameterlist'}}) {
1061 $type = $args{'parametertypes'}{$parameter};
1062 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1063 # pointer-to-function
1064 print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n";
1066 $type =~ s/([^\*])$/$1 /;
1067 print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n";
1073 print ".SH ARGUMENTS\n";
1074 foreach $parameter (@
{$args{'parameterlist'}}) {
1075 my $parameter_name = $parameter;
1076 $parameter_name =~ s/\[.*//;
1078 print ".IP \"" . $parameter . "\" 12\n";
1079 output_highlight
($args{'parameterdescs'}{$parameter_name});
1081 foreach $section (@
{$args{'sectionlist'}}) {
1082 print ".SH \"", uc $section, "\"\n";
1083 output_highlight
($args{'sections'}{$section});
1088 # output enum in man
1089 sub output_enum_man
(%) {
1090 my %args = %{$_[0]};
1091 my ($parameter, $section);
1094 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
1097 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
1099 print ".SH SYNOPSIS\n";
1100 print "enum " . $args{'enum'} . " {\n";
1102 foreach my $parameter (@
{$args{'parameterlist'}}) {
1103 print ".br\n.BI \" $parameter\"\n";
1104 if ($count == $#{$args{'parameterlist'}}) {
1114 print ".SH Constants\n";
1115 foreach $parameter (@
{$args{'parameterlist'}}) {
1116 my $parameter_name = $parameter;
1117 $parameter_name =~ s/\[.*//;
1119 print ".IP \"" . $parameter . "\" 12\n";
1120 output_highlight
($args{'parameterdescs'}{$parameter_name});
1122 foreach $section (@
{$args{'sectionlist'}}) {
1123 print ".SH \"$section\"\n";
1124 output_highlight
($args{'sections'}{$section});
1129 # output struct in man
1130 sub output_struct_man
(%) {
1131 my %args = %{$_[0]};
1132 my ($parameter, $section);
1134 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
1137 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
1139 print ".SH SYNOPSIS\n";
1140 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
1142 foreach my $parameter (@
{$args{'parameterlist'}}) {
1143 if ($parameter =~ /^#/) {
1144 print ".BI \"$parameter\"\n.br\n";
1147 my $parameter_name = $parameter;
1148 $parameter_name =~ s/\[.*//;
1150 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1151 $type = $args{'parametertypes'}{$parameter};
1152 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1153 # pointer-to-function
1154 print ".BI \" " . $1 . "\" " . $parameter . " \") (" . $2 . ")" . "\"\n;\n";
1155 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1157 print ".BI \" " . $1 . "\ \" " . $parameter . $2 . " \"" . "\"\n;\n";
1159 $type =~ s/([^\*])$/$1 /;
1160 print ".BI \" " . $type . "\" " . $parameter . " \"" . "\"\n;\n";
1166 print ".SH Members\n";
1167 foreach $parameter (@
{$args{'parameterlist'}}) {
1168 ($parameter =~ /^#/) && next;
1170 my $parameter_name = $parameter;
1171 $parameter_name =~ s/\[.*//;
1173 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1174 print ".IP \"" . $parameter . "\" 12\n";
1175 output_highlight
($args{'parameterdescs'}{$parameter_name});
1177 foreach $section (@
{$args{'sectionlist'}}) {
1178 print ".SH \"$section\"\n";
1179 output_highlight
($args{'sections'}{$section});
1184 # output typedef in man
1185 sub output_typedef_man
(%) {
1186 my %args = %{$_[0]};
1187 my ($parameter, $section);
1189 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
1192 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
1194 foreach $section (@
{$args{'sectionlist'}}) {
1195 print ".SH \"$section\"\n";
1196 output_highlight
($args{'sections'}{$section});
1200 sub output_blockhead_man
(%) {
1201 my %args = %{$_[0]};
1202 my ($parameter, $section);
1205 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
1207 foreach $section (@
{$args{'sectionlist'}}) {
1208 print ".SH \"$section\"\n";
1209 output_highlight
($args{'sections'}{$section});
1215 sub output_function_text
(%) {
1216 my %args = %{$_[0]};
1217 my ($parameter, $section);
1221 print $args{'function'} . " - " . $args{'purpose'} . "\n";
1223 print "\nSynopsis:\n\n";
1224 if ($args{'functiontype'} ne "") {
1225 $start = $args{'functiontype'} . " " . $args{'function'} . " (";
1227 $start = $args{'function'} . " (";
1232 foreach my $parameter (@
{$args{'parameterlist'}}) {
1233 $type = $args{'parametertypes'}{$parameter};
1234 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1235 # pointer-to-function
1236 print $1 . $parameter . ") (" . $2;
1238 print $type . " " . $parameter;
1240 if ($count != $#{$args{'parameterlist'}}) {
1243 print " " x
length($start);
1249 print "Arguments:\n\n";
1250 foreach $parameter (@
{$args{'parameterlist'}}) {
1251 my $parameter_name = $parameter;
1252 $parameter_name =~ s/\[.*//;
1254 print $parameter . "\n\t" . $args{'parameterdescs'}{$parameter_name} . "\n";
1256 output_section_text
(@_);
1259 #output sections in text
1260 sub output_section_text
(%) {
1261 my %args = %{$_[0]};
1265 foreach $section (@
{$args{'sectionlist'}}) {
1266 print "$section:\n\n";
1267 output_highlight
($args{'sections'}{$section});
1272 # output enum in text
1273 sub output_enum_text
(%) {
1274 my %args = %{$_[0]};
1279 print "enum " . $args{'enum'} . " - " . $args{'purpose'} . "\n\n";
1280 print "enum " . $args{'enum'} . " {\n";
1282 foreach $parameter (@
{$args{'parameterlist'}}) {
1283 print "\t$parameter";
1284 if ($count != $#{$args{'parameterlist'}}) {
1292 print "Constants:\n\n";
1293 foreach $parameter (@
{$args{'parameterlist'}}) {
1294 print "$parameter\n\t";
1295 print $args{'parameterdescs'}{$parameter} . "\n";
1298 output_section_text
(@_);
1301 # output typedef in text
1302 sub output_typedef_text
(%) {
1303 my %args = %{$_[0]};
1306 print "Typedef:\n\n";
1308 print "typedef " . $args{'typedef'} . " - " . $args{'purpose'} . "\n";
1309 output_section_text
(@_);
1312 # output struct as text
1313 sub output_struct_text
(%) {
1314 my %args = %{$_[0]};
1317 print $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "\n\n";
1318 print $args{'type'} . " " . $args{'struct'} . " {\n";
1319 foreach $parameter (@
{$args{'parameterlist'}}) {
1320 if ($parameter =~ /^#/) {
1321 print "$parameter\n";
1325 my $parameter_name = $parameter;
1326 $parameter_name =~ s/\[.*//;
1328 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1329 $type = $args{'parametertypes'}{$parameter};
1330 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1331 # pointer-to-function
1332 print "\t$1 $parameter) ($2);\n";
1333 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1335 print "\t$1 $parameter$2;\n";
1337 print "\t" . $type . " " . $parameter . ";\n";
1342 print "Members:\n\n";
1343 foreach $parameter (@
{$args{'parameterlist'}}) {
1344 ($parameter =~ /^#/) && next;
1346 my $parameter_name = $parameter;
1347 $parameter_name =~ s/\[.*//;
1349 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1350 print "$parameter\n\t";
1351 print $args{'parameterdescs'}{$parameter_name} . "\n";
1354 output_section_text
(@_);
1357 sub output_blockhead_text
(%) {
1358 my %args = %{$_[0]};
1359 my ($parameter, $section);
1361 foreach $section (@
{$args{'sectionlist'}}) {
1362 print " $section:\n";
1364 output_highlight
($args{'sections'}{$section});
1369 # generic output function for all types (function, struct/union, typedef, enum);
1370 # calls the generated, variable output_ function name based on
1371 # functype and output_mode
1372 sub output_declaration
{
1375 my $functype = shift;
1376 my $func = "output_${functype}_$output_mode";
1377 if (($function_only==0) ||
1378 ( $function_only == 1 && defined($function_table{$name})) ||
1379 ( $function_only == 2 && !defined($function_table{$name})))
1387 # generic output function - calls the right one based on current output mode.
1388 sub output_blockhead
{
1390 my $func = "output_blockhead_" . $output_mode;
1396 # takes a declaration (struct, union, enum, typedef) and
1397 # invokes the right handler. NOT called for functions.
1398 sub dump_declaration
($$) {
1400 my ($prototype, $file) = @_;
1401 my $func = "dump_" . $decl_type;
1405 sub dump_union
($$) {
1409 sub dump_struct
($$) {
1414 if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) {
1415 #my $decl_type = $1;
1416 $declaration_name = $2;
1419 # ignore embedded structs or unions
1420 $members =~ s/({.*})//g;
1423 # ignore members marked private:
1424 $members =~ s/\/\*\s*private:.*?\/\
*\s
*public
:.*?\
*\
///gos
;
1425 $members =~ s/\/\*\s*private:.*//gos
;
1427 $members =~ s/\/\*.*?\*\///gos;
1428 $nested =~ s/\/\*.*?\*\///gos;
1429 # strip kmemcheck_bitfield_{begin,end}.*;
1430 $members =~ s/kmemcheck_bitfield_.*?;//gos;
1432 create_parameterlist
($members, ';', $file);
1433 check_sections
($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested);
1435 output_declaration
($declaration_name,
1437 {'struct' => $declaration_name,
1438 'module' => $modulename,
1439 'parameterlist' => \
@parameterlist,
1440 'parameterdescs' => \
%parameterdescs,
1441 'parametertypes' => \
%parametertypes,
1442 'sectionlist' => \
@sectionlist,
1443 'sections' => \
%sections,
1444 'purpose' => $declaration_purpose,
1445 'type' => $decl_type
1449 print STDERR
"Error(${file}:$.): Cannot parse struct or union!\n";
1458 $x =~ s@
/\*.*?\*/@
@gos; # strip comments.
1459 if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
1460 $declaration_name = $1;
1463 foreach my $arg (split ',', $members) {
1464 $arg =~ s/^\s*(\w+).*/$1/;
1465 push @parameterlist, $arg;
1466 if (!$parameterdescs{$arg}) {
1467 $parameterdescs{$arg} = $undescribed;
1468 print STDERR
"Warning(${file}:$.): Enum value '$arg' ".
1469 "not described in enum '$declaration_name'\n";
1474 output_declaration
($declaration_name,
1476 {'enum' => $declaration_name,
1477 'module' => $modulename,
1478 'parameterlist' => \
@parameterlist,
1479 'parameterdescs' => \
%parameterdescs,
1480 'sectionlist' => \
@sectionlist,
1481 'sections' => \
%sections,
1482 'purpose' => $declaration_purpose
1486 print STDERR
"Error(${file}:$.): Cannot parse enum!\n";
1491 sub dump_typedef
($$) {
1495 $x =~ s@
/\*.*?\*/@
@gos; # strip comments.
1496 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1497 $x =~ s/\(*.\)\s*;$/;/;
1498 $x =~ s/\[*.\]\s*;$/;/;
1501 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1502 $declaration_name = $1;
1504 output_declaration
($declaration_name,
1506 {'typedef' => $declaration_name,
1507 'module' => $modulename,
1508 'sectionlist' => \
@sectionlist,
1509 'sections' => \
%sections,
1510 'purpose' => $declaration_purpose
1514 print STDERR
"Error(${file}:$.): Cannot parse typedef!\n";
1519 sub save_struct_actual
($) {
1522 # strip all spaces from the actual param so that it looks like one string item
1523 $actual =~ s/\s*//g;
1524 $struct_actual = $struct_actual . $actual . " ";
1527 sub create_parameterlist
($$$) {
1529 my $splitter = shift;
1534 # temporarily replace commas inside function pointer definition
1535 while ($args =~ /(\([^\),]+),/) {
1536 $args =~ s/(\([^\),]+),/$1#/g;
1539 foreach my $arg (split($splitter, $args)) {
1541 $arg =~ s/\/\*.*\*\///;
1542 # strip leading/trailing spaces
1548 # Treat preprocessor directive as a typeless variable just to fill
1549 # corresponding data structures "correctly". Catch it later in
1551 push_parameter
($arg, "", $file);
1552 } elsif ($arg =~ m/\(.+\)\s*\(/) {
1553 # pointer-to-function
1555 $arg =~ m/[^\(]+\(\*?\s*(\w*)\s*\)/;
1558 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1559 save_struct_actual
($param);
1560 push_parameter
($param, $type, $file);
1562 $arg =~ s/\s*:\s*/:/g;
1563 $arg =~ s/\s*\[/\[/g;
1565 my @args = split('\s*,\s*', $arg);
1566 if ($args[0] =~ m/\*/) {
1567 $args[0] =~ s/(\*+)\s*/ $1/;
1571 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1573 push(@first_arg, split('\s+', $1));
1574 push(@first_arg, $2);
1576 @first_arg = split('\s+', shift @args);
1579 unshift(@args, pop @first_arg);
1580 $type = join " ", @first_arg;
1582 foreach $param (@args) {
1583 if ($param =~ m/^(\*+)\s*(.*)/) {
1584 save_struct_actual
($2);
1585 push_parameter
($2, "$type $1", $file);
1587 elsif ($param =~ m/(.*?):(\d+)/) {
1588 if ($type ne "") { # skip unnamed bit-fields
1589 save_struct_actual
($1);
1590 push_parameter
($1, "$type:$2", $file)
1594 save_struct_actual
($param);
1595 push_parameter
($param, $type, $file);
1602 sub push_parameter
($$$) {
1607 if (($anon_struct_union == 1) && ($type eq "") &&
1609 return; # ignore the ending }; from anon. struct/union
1612 $anon_struct_union = 0;
1613 my $param_name = $param;
1614 $param_name =~ s/\[.*//;
1616 if ($type eq "" && $param =~ /\.\.\.$/)
1618 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1619 $parameterdescs{$param} = "variable arguments";
1622 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1625 $parameterdescs{void
} = "no arguments";
1627 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1628 # handle unnamed (anonymous) union or struct:
1631 $param = "{unnamed_" . $param . "}";
1632 $parameterdescs{$param} = "anonymous\n";
1633 $anon_struct_union = 1;
1636 # warn if parameter has no description
1637 # (but ignore ones starting with # as these are not parameters
1638 # but inline preprocessor statements);
1639 # also ignore unnamed structs/unions;
1640 if (!$anon_struct_union) {
1641 if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) {
1643 $parameterdescs{$param_name} = $undescribed;
1645 if (($type eq 'function') || ($type eq 'enum')) {
1646 print STDERR
"Warning(${file}:$.): Function parameter ".
1647 "or member '$param' not " .
1648 "described in '$declaration_name'\n";
1650 print STDERR
"Warning(${file}:$.):" .
1651 " No description found for parameter '$param'\n";
1656 # strip spaces from $param so that it is one continous string
1657 # on @parameterlist;
1658 # this fixes a problem where check_sections() cannot find
1659 # a parameter like "addr[6 + 2]" because it actually appears
1660 # as "addr[6", "+", "2]" on the parameter list;
1661 # but it's better to maintain the param string unchanged for output,
1662 # so just weaken the string compare in check_sections() to ignore
1663 # "[blah" in a parameter string;
1664 ###$param =~ s/\s*//g;
1665 push @parameterlist, $param;
1666 $parametertypes{$param} = $type;
1669 sub check_sections
($$$$$$) {
1670 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck, $nested) = @_;
1671 my @sects = split ' ', $sectcheck;
1672 my @prms = split ' ', $prmscheck;
1675 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
1677 foreach $sx (0 .. $#sects) {
1679 foreach $px (0 .. $#prms) {
1680 $prm_clean = $prms[$px];
1681 $prm_clean =~ s/\[.*\]//;
1682 $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//;
1683 # ignore array size in a parameter string;
1684 # however, the original param string may contain
1685 # spaces, e.g.: addr[6 + 2]
1686 # and this appears in @prms as "addr[6" since the
1687 # parameter list is split at spaces;
1688 # hence just ignore "[..." for the sections check;
1689 $prm_clean =~ s/\[.*//;
1691 ##$prm_clean =~ s/^\**//;
1692 if ($prm_clean eq $sects[$sx]) {
1698 if ($decl_type eq "function") {
1699 print STDERR
"Warning(${file}:$.): " .
1700 "Excess function parameter " .
1702 "description in '$decl_name'\n";
1705 if ($nested !~ m/\Q$sects[$sx]\E/) {
1706 print STDERR
"Warning(${file}:$.): " .
1707 "Excess struct/union/enum/typedef member " .
1709 "description in '$decl_name'\n";
1718 # takes a function prototype and the name of the current file being
1719 # processed and spits out all the details stored in the global
1721 sub dump_function
($$) {
1722 my $prototype = shift;
1725 $prototype =~ s/^static +//;
1726 $prototype =~ s/^extern +//;
1727 $prototype =~ s/^asmlinkage +//;
1728 $prototype =~ s/^inline +//;
1729 $prototype =~ s/^__inline__ +//;
1730 $prototype =~ s/^__inline +//;
1731 $prototype =~ s/^__always_inline +//;
1732 $prototype =~ s/^noinline +//;
1733 $prototype =~ s/__devinit +//;
1734 $prototype =~ s/__init +//;
1735 $prototype =~ s/^#\s*define\s+//; #ak added
1736 $prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//;
1738 # Yes, this truly is vile. We are looking for:
1739 # 1. Return type (may be nothing if we're looking at a macro)
1741 # 3. Function parameters.
1743 # All the while we have to watch out for function pointer parameters
1744 # (which IIRC is what the two sections are for), C types (these
1745 # regexps don't even start to express all the possibilities), and
1748 # If you mess with these regexps, it's a good idea to check that
1749 # the following functions' documentation still comes out right:
1750 # - parport_register_device (function pointer parameters)
1751 # - atomic_set (macro)
1752 # - pci_match_device, __copy_to_user (long return type)
1754 if ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1755 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1756 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1757 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1758 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1759 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1760 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1761 $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1762 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1763 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1764 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1765 $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1766 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1767 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1768 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1769 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1770 $prototype =~ m/^(\w+\s+\w+\s*\*\s*\w+\s*\*\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) {
1772 $declaration_name = $2;
1775 create_parameterlist
($args, ',', $file);
1777 print STDERR
"Error(${file}:$.): cannot understand prototype: '$prototype'\n";
1782 my $prms = join " ", @parameterlist;
1783 check_sections
($file, $declaration_name, "function", $sectcheck, $prms, "");
1785 output_declaration
($declaration_name,
1787 {'function' => $declaration_name,
1788 'module' => $modulename,
1789 'functiontype' => $return_type,
1790 'parameterlist' => \
@parameterlist,
1791 'parameterdescs' => \
%parameterdescs,
1792 'parametertypes' => \
%parametertypes,
1793 'sectionlist' => \
@sectionlist,
1794 'sections' => \
%sections,
1795 'purpose' => $declaration_purpose
1799 sub process_file
($);
1801 # Read the file that maps relative names to absolute names for
1802 # separate source and object directories and for shadow trees.
1803 if (open(SOURCE_MAP
, "<.tmp_filelist.txt")) {
1804 my ($relname, $absname);
1805 while(<SOURCE_MAP
>) {
1807 ($relname, $absname) = (split())[0..1];
1808 $relname =~ s
:^/+::;
1809 $source_map{$relname} = $absname;
1815 open(FLIST
,"<$filelist") or die "Can't open file list $filelist";
1826 if ($verbose && $errors) {
1827 print STDERR
"$errors errors\n";
1829 if ($verbose && $warnings) {
1830 print STDERR
"$warnings warnings\n";
1838 %parameterdescs = ();
1839 %parametertypes = ();
1840 @parameterlist = ();
1844 $struct_actual = "";
1850 sub tracepoint_munge
($) {
1852 my $tracepointname = 0;
1853 my $tracepointargs = 0;
1855 if($prototype =~ m/TRACE_EVENT\((.*?),/) {
1856 $tracepointname = $1;
1858 if($prototype =~ m/TP_PROTO\((.*?)\)/) {
1859 $tracepointargs = $1;
1861 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1862 print STDERR
"Warning(${file}:$.): Unrecognized tracepoint format: \n".
1865 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1869 sub syscall_munge
() {
1872 $prototype =~ s@
[\r\n\t]+@
@gos; # strip newlines/CR's/tabs
1873 ## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1874 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1876 ## $prototype = "long sys_$1(void)";
1879 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1880 if ($prototype =~ m/long (sys_.*?),/) {
1881 $prototype =~ s/,/\(/;
1883 $prototype =~ s/\)/\(void\)/;
1886 # now delete all of the odd-number commas in $prototype
1887 # so that arg types & arg names don't have a comma between them
1889 my $len = length($prototype);
1891 $len = 0; # skip the for-loop
1893 for (my $ix = 0; $ix < $len; $ix++) {
1894 if (substr($prototype, $ix, 1) eq ',') {
1896 if ($count % 2 == 1) {
1897 substr($prototype, $ix, 1) = ' ';
1903 sub process_state3_function
($$) {
1907 $x =~ s@\
/\/.*$@
@gos; # strip C99-style comments to end of line
1909 if ($x =~ m
#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
1912 elsif ($x =~ /([^\{]*)/) {
1916 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1917 $prototype =~ s@
/\*.*?\*/@
@gos; # strip comments.
1918 $prototype =~ s@
[\r\n]+@
@gos; # strip newlines/cr's.
1919 $prototype =~ s@
^\s
+@
@gos; # strip leading spaces
1920 if ($prototype =~ /SYSCALL_DEFINE/) {
1923 if ($prototype =~ /TRACE_EVENT/) {
1924 tracepoint_munge
($file);
1926 dump_function
($prototype, $file);
1931 sub process_state3_type
($$) {
1935 $x =~ s@
[\r\n]+@
@gos; # strip newlines/cr's.
1936 $x =~ s@
^\s
+@
@gos; # strip leading spaces
1937 $x =~ s@\s
+$@
@gos; # strip trailing spaces
1938 $x =~ s@\
/\/.*$@
@gos; # strip C99-style comments to end of line
1941 # To distinguish preprocessor directive from regular declaration later.
1946 if ( $x =~ /([^{};]*)([{};])(.*)/ ) {
1947 $prototype .= $1 . $2;
1948 ($2 eq '{') && $brcount++;
1949 ($2 eq '}') && $brcount--;
1950 if (($2 eq ';') && ($brcount == 0)) {
1951 dump_declaration
($prototype, $file);
1963 # xml_escape: replace <, >, and & in the text stream;
1965 # however, formatting controls that are generated internally/locally in the
1966 # kernel-doc script are not escaped here; instead, they begin life like
1967 # $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings
1968 # are converted to their mnemonic-expected output, without the 4 * '\' & ':',
1969 # just before actual output; (this is done by local_unescape())
1972 if (($output_mode eq "text") || ($output_mode eq "man")) {
1975 $text =~ s/\&/\\\\\\amp;/g;
1976 $text =~ s/\</\\\\\\lt;/g;
1977 $text =~ s/\>/\\\\\\gt;/g;
1981 # convert local escape strings to html
1982 # local escape strings look like: '\\\\menmonic:' (that's 4 backslashes)
1983 sub local_unescape
($) {
1985 if (($output_mode eq "text") || ($output_mode eq "man")) {
1988 $text =~ s/\\\\\\\\lt:/</g;
1989 $text =~ s/\\\\\\\\gt:/>/g;
1993 sub process_file
($) {
1998 my $initial_section_counter = $section_counter;
2000 if (defined($ENV{'SRCTREE'})) {
2001 $file = "$ENV{'SRCTREE'}" . "/" . "@_";
2006 if (defined($source_map{$file})) {
2007 $file = $source_map{$file};
2010 if (!open(IN
,"<$file")) {
2011 print STDERR
"Error: Cannot open file $file\n";
2016 $section_counter = 0;
2019 if (/$doc_start/o) {
2020 $state = 1; # next line is always the function name
2023 } elsif ($state == 1) { # this line is the function name (always)
2024 if (/$doc_block/o) {
2028 $section = $section_intro;
2033 elsif (/$doc_decl/o) {
2035 if (/\s*([\w\s]+?)\s*-/) {
2041 # strip leading/trailing/multiple spaces
2046 $declaration_purpose = xml_escape
($descr);
2048 $declaration_purpose = "";
2051 if (($declaration_purpose eq "") && $verbose) {
2052 print STDERR
"Warning(${file}:$.): missing initial short description on line:\n";
2057 if ($identifier =~ m/^struct/) {
2058 $decl_type = 'struct';
2059 } elsif ($identifier =~ m/^union/) {
2060 $decl_type = 'union';
2061 } elsif ($identifier =~ m/^enum/) {
2062 $decl_type = 'enum';
2063 } elsif ($identifier =~ m/^typedef/) {
2064 $decl_type = 'typedef';
2066 $decl_type = 'function';
2070 print STDERR
"Info(${file}:$.): Scanning doc for $identifier\n";
2073 print STDERR
"Warning(${file}:$.): Cannot understand $_ on line $.",
2074 " - I thought it was a doc line\n";
2078 } elsif ($state == 2) { # look for head: lines, and include content
2083 if (($contents ne "") && ($contents ne "\n")) {
2084 if (!$in_doc_sect && $verbose) {
2085 print STDERR
"Warning(${file}:$.): contents before sections\n";
2088 dump_section
($file, $section, xml_escape
($contents));
2089 $section = $section_default;
2093 $contents = $newcontents;
2094 if ($contents ne "") {
2095 while ((substr($contents, 0, 1) eq " ") ||
2096 substr($contents, 0, 1) eq "\t") {
2097 $contents = substr($contents, 1);
2101 $section = $newsection;
2102 } elsif (/$doc_end/) {
2104 if ($contents ne "") {
2105 dump_section
($file, $section, xml_escape
($contents));
2106 $section = $section_default;
2109 # look for doc_com + <text> + doc_end:
2110 if ($_ =~ m
'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2111 print STDERR
"Warning(${file}:$.): suspicious ending line: $_";
2118 # print STDERR "end of doc comment, looking for prototype\n";
2119 } elsif (/$doc_content/) {
2120 # miguel-style comment kludge, look for blank lines after
2121 # @parameter line to signify start of description
2123 ($section =~ m/^@/ || $section eq $section_context)) {
2124 dump_section
($file, $section, xml_escape
($contents));
2125 $section = $section_default;
2128 $contents .= $1 . "\n";
2131 # i dont know - bad line? ignore.
2132 print STDERR
"Warning(${file}:$.): bad line: $_";
2135 } elsif ($state == 3) { # scanning for function '{' (end of prototype)
2136 if ($decl_type eq 'function') {
2137 process_state3_function
($_, $file);
2139 process_state3_type
($_, $file);
2141 } elsif ($state == 4) {
2142 # Documentation block
2144 dump_doc_section
($file, $section, xml_escape
($contents));
2148 %parameterdescs = ();
2149 %parametertypes = ();
2150 @parameterlist = ();
2155 $section = $section_intro;
2162 dump_doc_section
($file, $section, xml_escape
($contents));
2166 %parameterdescs = ();
2167 %parametertypes = ();
2168 @parameterlist = ();
2174 elsif (/$doc_content/)
2178 $contents .= $blankline;
2182 $contents .= $1 . "\n";
2187 if ($initial_section_counter == $section_counter) {
2188 print STDERR
"Warning(${file}): no structured comments found\n";
2189 if ($output_mode eq "xml") {
2190 # The template wants at least one RefEntry here; make one.
2191 print "<refentry>\n";
2192 print " <refnamediv>\n";
2193 print " <refname>\n";
2195 print " </refname>\n";
2196 print " <refpurpose>\n";
2197 print " Document generation inconsistency\n";
2198 print " </refpurpose>\n";
2199 print " </refnamediv>\n";
2200 print " <refsect1>\n";
2203 print " </title>\n";
2204 print " <warning>\n";
2206 print " The template for this document tried to insert\n";
2207 print " the structured comment from the file\n";
2208 print " <filename>${file}</filename> at this point,\n";
2209 print " but none was found.\n";
2210 print " This dummy section is inserted to allow\n";
2211 print " generation to continue.\n";
2213 print " </warning>\n";
2214 print " </refsect1>\n";
2215 print "</refentry>\n";
This page took 0.106922 seconds and 5 git commands to generate.