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-2010 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 # 18/01/2001 - Cleanups
17 # Functions prototyped as foo(void) same as foo()
18 # Stop eval'ing where we don't need to.
21 # 27/06/2001 - Allowed whitespace after initial "/**" and
22 # allowed comments before function declarations.
23 # -- Christian Kreibich <ck@whoop.org>
26 # - add perldoc documentation
27 # - Look more closely at some of the scarier bits :)
29 # 26/05/2001 - Support for separate source and object trees.
31 # Keith Owens <kaos@ocs.com.au>
33 # 23/09/2001 - Added support for typedefs, structs, enums and unions
34 # Support for Context section; can be terminated using empty line
35 # Small fixes (like spaces vs. \s in regex)
36 # -- Tim Jansen <tim@tjansen.de>
40 # This will read a 'c' file and scan for embedded comments in the
41 # style of gnome comments (+minor extensions - see below).
44 # Note: This only supports 'c'.
47 # kernel-doc [ -docbook | -html | -text | -man | -list ] [ -no-doc-sections ]
48 # [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile
50 # [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile
52 # Set output format using one of -docbook -html -text or -man. Default is man.
53 # The -list format is for internal use by docproc.
56 # Do not output DOC: sections
59 # If set, then only generate documentation for the given function(s) or
60 # DOC: section titles. All other functions and DOC: sections are ignored.
62 # -nofunction funcname
63 # If set, then only generate documentation for the other function(s)/DOC:
64 # sections. Cannot be used together with -function (yes, that's a bug --
65 # perl hackers can fix it 8))
67 # c files - list of 'c' files to process
69 # All output goes to stdout, with errors to stderr.
73 # In the following table, (...)? signifies optional structure.
74 # (...)* signifies 0 or more structure elements
76 # * function_name(:)? (- short description)?
77 # (* @parameterx: (description of parameter x)?)*
79 # * (Description:)? (Description of function)?
80 # * (section header: (section description)? )*
83 # So .. the trivial example would be:
89 # If the Description: header tag is omitted, then there must be a blank line
90 # after the last parameter specification.
93 # * my_function - does my stuff
94 # * @my_arg: its mine damnit
96 # * Does my stuff explained.
101 # * my_function - does my stuff
102 # * @my_arg: its mine damnit
103 # * Description: Does my stuff explained.
107 # Besides functions you can also write documentation for structs, unions,
108 # enums and typedefs. Instead of the function name you must write the name
109 # of the declaration; the struct/union/enum/typedef must always precede
110 # the name. Nesting of declarations is not supported.
111 # Use the argument mechanism to document members or constants.
114 # * struct my_struct - short description
116 # * @b: second member
118 # * Longer description
127 # All descriptions can be multiline, except the short function description.
129 # You can also add additional sections. When documenting kernel functions you
130 # should document the "Context:" of the function, e.g. whether the functions
131 # can be called form interrupts. Unlike other sections you can end it with an
133 # Example-sections should contain the string EXAMPLE so that they are marked
134 # appropriately in DocBook.
138 # * user_function - function that can only be called in user context
139 # * @a: some argument
140 # * Context: !in_interrupt()
144 # * user_function(22);
149 # All descriptive text is further processed, scanning for the following special
150 # patterns, which are highlighted appropriately.
152 # 'funcname()' - function
153 # '$ENVVAR' - environmental variable
154 # '&struct_name' - name of a structure (up to two words including 'struct')
155 # '@parameter' - name of a parameter
156 # '%CONST' - name of a constant.
162 my $anon_struct_union = 0;
164 # match expressions used to find embedded type information
165 my $type_constant = '\%([-_\w]+)';
166 my $type_func = '(\w+)\(\)';
167 my $type_param = '\@(\w+)';
168 my $type_struct = '\&((struct\s*)*[_\w]+)';
169 my $type_struct_xml = '\\&((struct\s*)*[_\w]+)';
170 my $type_env = '(\$\w+)';
172 # Output conversion substitutions.
173 # One for each output format
175 # these work fairly well
176 my %highlights_html = ( $type_constant, "<i>\$1</i>",
177 $type_func, "<b>\$1</b>",
178 $type_struct_xml, "<i>\$1</i>",
179 $type_env, "<b><i>\$1</i></b>",
180 $type_param, "<tt><b>\$1</b></tt>" );
181 my $local_lt = "\\\\\\\\lt:";
182 my $local_gt = "\\\\\\\\gt:";
183 my $blankline_html = $local_lt . "p" . $local_gt; # was "<p>"
185 # XML, docbook format
186 my %highlights_xml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>",
187 $type_constant, "<constant>\$1</constant>",
188 $type_func, "<function>\$1</function>",
189 $type_struct_xml, "<structname>\$1</structname>",
190 $type_env, "<envar>\$1</envar>",
191 $type_param, "<parameter>\$1</parameter>" );
192 my $blankline_xml = $local_lt . "/para" . $local_gt . $local_lt . "para" . $local_gt . "\n";
194 # gnome, docbook format
195 my %highlights_gnome = ( $type_constant, "<replaceable class=\"option\">\$1</replaceable>",
196 $type_func, "<function>\$1</function>",
197 $type_struct, "<structname>\$1</structname>",
198 $type_env, "<envar>\$1</envar>",
199 $type_param, "<parameter>\$1</parameter>" );
200 my $blankline_gnome = "</para><para>\n";
202 # these are pretty rough
203 my %highlights_man = ( $type_constant, "\$1",
204 $type_func, "\\\\fB\$1\\\\fP",
205 $type_struct, "\\\\fI\$1\\\\fP",
206 $type_param, "\\\\fI\$1\\\\fP" );
207 my $blankline_man = "";
210 my %highlights_text = ( $type_constant, "\$1",
213 $type_param, "\$1" );
214 my $blankline_text = "";
217 my %highlights_list = ( $type_constant, "\$1",
220 $type_param, "\$1" );
221 my $blankline_list = "";
229 my $dohighlight = "";
232 my $output_mode = "man";
233 my $no_doc_sections = 0;
234 my %highlights = %highlights_man;
235 my $blankline = $blankline_man;
236 my $modulename = "Kernel API";
237 my $function_only = 0;
238 my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
239 'July', 'August', 'September', 'October',
240 'November', 'December')[(localtime)[4]] .
241 " " . ((localtime)[5]+1900);
243 # Essentially these are globals.
244 # They probably want to be tidied up, made more localised or something.
245 # CAVEAT EMPTOR! Some of the others I localised may not want to be, which
246 # could cause "use of undefined value" or other bugs.
247 my ($function, %function_table, %parametertypes, $declaration_purpose);
248 my ($type, $declaration_name, $return_type);
249 my ($newsection, $newcontents, $prototype, $brcount, %source_map);
251 if (defined($ENV{'KBUILD_VERBOSE'})) {
252 $verbose = "$ENV{'KBUILD_VERBOSE'}";
255 # Generated docbook code is inserted in a template at a point where
256 # docbook v3.1 requires a non-zero sequence of RefEntry's; see:
257 # http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
258 # We keep track of number of generated entries and generate a dummy
259 # if needs be to ensure the expanded template can be postprocessed
261 my $section_counter = 0;
267 # 1 - looking for function name
268 # 2 - scanning field start.
269 # 3 - scanning prototype.
270 # 4 - documentation block
274 #declaration types: can be
275 # 'function', 'struct', 'union', 'enum', 'typedef'
278 my $doc_special = "\@\%\$\&";
280 my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
282 my $doc_com = '\s*\*\s*';
283 my $doc_decl = $doc_com . '(\w+)';
284 my $doc_sect = $doc_com . '([' . $doc_special . ']?[\w\s]+):(.*)';
285 my $doc_content = $doc_com . '(.*)';
286 my $doc_block = $doc_com . 'DOC:\s*(.*)?';
297 my $section_default = "Description"; # default section
298 my $section_intro = "Introduction";
299 my $section = $section_default;
300 my $section_context = "Context";
302 my $undescribed = "-- undescribed --";
306 while ($ARGV[0] =~ m/^-(.*)/) {
307 my $cmd = shift @ARGV;
308 if ($cmd eq "-html") {
309 $output_mode = "html";
310 %highlights = %highlights_html;
311 $blankline = $blankline_html;
312 } elsif ($cmd eq "-man") {
313 $output_mode = "man";
314 %highlights = %highlights_man;
315 $blankline = $blankline_man;
316 } elsif ($cmd eq "-text") {
317 $output_mode = "text";
318 %highlights = %highlights_text;
319 $blankline = $blankline_text;
320 } elsif ($cmd eq "-docbook") {
321 $output_mode = "xml";
322 %highlights = %highlights_xml;
323 $blankline = $blankline_xml;
324 } elsif ($cmd eq "-list") {
325 $output_mode = "list";
326 %highlights = %highlights_list;
327 $blankline = $blankline_list;
328 } elsif ($cmd eq "-gnome") {
329 $output_mode = "gnome";
330 %highlights = %highlights_gnome;
331 $blankline = $blankline_gnome;
332 } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document
333 $modulename = shift @ARGV;
334 } elsif ($cmd eq "-function") { # to only output specific functions
336 $function = shift @ARGV;
337 $function_table{$function} = 1;
338 } elsif ($cmd eq "-nofunction") { # to only output specific functions
340 $function = shift @ARGV;
341 $function_table{$function} = 1;
342 } elsif ($cmd eq "-v") {
344 } elsif (($cmd eq "-h") || ($cmd eq "--help")) {
346 } elsif ($cmd eq '-no-doc-sections') {
347 $no_doc_sections = 1;
351 # continue execution near EOF;
354 print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man | -list ]\n";
355 print " [ -no-doc-sections ]\n";
356 print " [ -function funcname [ -function funcname ...] ]\n";
357 print " [ -nofunction funcname [ -nofunction funcname ...] ]\n";
358 print " c source file(s) > outputfile\n";
359 print " -v : verbose output, more warnings & other info listed\n";
363 # get kernel version from env
364 sub get_kernel_version
() {
365 my $version = 'unknown kernel version';
367 if (defined($ENV{'KERNELVERSION'})) {
368 $version = $ENV{'KERNELVERSION'};
374 # dumps section contents to arrays/hashes intended for that purpose.
379 my $contents = join "\n", @_;
381 if ($name =~ m/$type_constant/) {
383 # print STDERR "constant section '$1' = '$contents'\n";
384 $constants{$name} = $contents;
385 } elsif ($name =~ m/$type_param/) {
386 # print STDERR "parameter def '$1' = '$contents'\n";
388 $parameterdescs{$name} = $contents;
389 $sectcheck = $sectcheck . $name . " ";
390 } elsif ($name eq "@\.\.\.") {
391 # print STDERR "parameter def '...' = '$contents'\n";
393 $parameterdescs{$name} = $contents;
394 $sectcheck = $sectcheck . $name . " ";
396 # print STDERR "other section '$name' = '$contents'\n";
397 if (defined($sections{$name}) && ($sections{$name} ne "")) {
398 print STDERR
"Error(${file}:$.): duplicate section name '$name'\n";
401 $sections{$name} = $contents;
402 push @sectionlist, $name;
407 # dump DOC: section after checking that it should go out
409 sub dump_doc_section
{
412 my $contents = join "\n", @_;
414 if ($no_doc_sections) {
418 if (($function_only == 0) ||
419 ( $function_only == 1 && defined($function_table{$name})) ||
420 ( $function_only == 2 && !defined($function_table{$name})))
422 dump_section
($file, $name, $contents);
423 output_blockhead
({'sectionlist' => \
@sectionlist,
424 'sections' => \
%sections,
425 'module' => $modulename,
426 'content-only' => ($function_only != 0), });
433 # parameterdescs, a hash.
434 # function => "function name"
435 # parameterlist => @list of parameters
436 # parameterdescs => %parameter descriptions
437 # sectionlist => @list of sections
438 # sections => %section descriptions
441 sub output_highlight
{
442 my $contents = join "\n",@_;
446 # if (!defined $contents) {
448 # confess "output_highlight got called with no args?\n";
451 if ($output_mode eq "html" || $output_mode eq "xml") {
452 $contents = local_unescape
($contents);
453 # convert data read & converted thru xml_escape() into &xyz; format:
454 $contents =~ s/\\\\\\/\&/g;
456 # print STDERR "contents b4:$contents\n";
459 # print STDERR "contents af:$contents\n";
461 foreach $line (split "\n", $contents) {
463 print $lineprefix, local_unescape
($blankline);
465 $line =~ s/\\\\\\/\&/g;
466 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
469 print $lineprefix, $line;
476 #output sections in html
477 sub output_section_html
(%) {
481 foreach $section (@
{$args{'sectionlist'}}) {
482 print "<h3>$section</h3>\n";
483 print "<blockquote>\n";
484 output_highlight
($args{'sections'}{$section});
485 print "</blockquote>\n";
489 # output enum in html
490 sub output_enum_html
(%) {
494 print "<h2>enum " . $args{'enum'} . "</h2>\n";
496 print "<b>enum " . $args{'enum'} . "</b> {<br>\n";
498 foreach $parameter (@
{$args{'parameterlist'}}) {
499 print " <b>" . $parameter . "</b>";
500 if ($count != $#{$args{'parameterlist'}}) {
508 print "<h3>Constants</h3>\n";
510 foreach $parameter (@
{$args{'parameterlist'}}) {
511 print "<dt><b>" . $parameter . "</b>\n";
513 output_highlight
($args{'parameterdescs'}{$parameter});
516 output_section_html
(@_);
520 # output typedef in html
521 sub output_typedef_html
(%) {
525 print "<h2>typedef " . $args{'typedef'} . "</h2>\n";
527 print "<b>typedef " . $args{'typedef'} . "</b>\n";
528 output_section_html
(@_);
532 # output struct in html
533 sub output_struct_html
(%) {
537 print "<h2>" . $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "</h2>\n";
538 print "<b>" . $args{'type'} . " " . $args{'struct'} . "</b> {<br>\n";
539 foreach $parameter (@
{$args{'parameterlist'}}) {
540 if ($parameter =~ /^#/) {
541 print "$parameter<br>\n";
544 my $parameter_name = $parameter;
545 $parameter_name =~ s/\[.*//;
547 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
548 $type = $args{'parametertypes'}{$parameter};
549 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
550 # pointer-to-function
551 print " <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>\n";
552 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
554 print " <i>$1</i> <b>$parameter</b>$2;<br>\n";
556 print " <i>$type</i> <b>$parameter</b>;<br>\n";
561 print "<h3>Members</h3>\n";
563 foreach $parameter (@
{$args{'parameterlist'}}) {
564 ($parameter =~ /^#/) && next;
566 my $parameter_name = $parameter;
567 $parameter_name =~ s/\[.*//;
569 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
570 print "<dt><b>" . $parameter . "</b>\n";
572 output_highlight
($args{'parameterdescs'}{$parameter_name});
575 output_section_html
(@_);
579 # output function in html
580 sub output_function_html
(%) {
582 my ($parameter, $section);
585 print "<h2>" . $args{'function'} . " - " . $args{'purpose'} . "</h2>\n";
586 print "<i>" . $args{'functiontype'} . "</i>\n";
587 print "<b>" . $args{'function'} . "</b>\n";
590 foreach $parameter (@
{$args{'parameterlist'}}) {
591 $type = $args{'parametertypes'}{$parameter};
592 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
593 # pointer-to-function
594 print "<i>$1</i><b>$parameter</b>) <i>($2)</i>";
596 print "<i>" . $type . "</i> <b>" . $parameter . "</b>";
598 if ($count != $#{$args{'parameterlist'}}) {
605 print "<h3>Arguments</h3>\n";
607 foreach $parameter (@
{$args{'parameterlist'}}) {
608 my $parameter_name = $parameter;
609 $parameter_name =~ s/\[.*//;
611 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
612 print "<dt><b>" . $parameter . "</b>\n";
614 output_highlight
($args{'parameterdescs'}{$parameter_name});
617 output_section_html
(@_);
621 # output DOC: block header in html
622 sub output_blockhead_html
(%) {
624 my ($parameter, $section);
627 foreach $section (@
{$args{'sectionlist'}}) {
628 print "<h3>$section</h3>\n";
630 output_highlight
($args{'sections'}{$section});
636 sub output_section_xml
(%) {
639 # print out each section
641 foreach $section (@
{$args{'sectionlist'}}) {
642 print "<refsect1>\n";
643 print "<title>$section</title>\n";
644 if ($section =~ m/EXAMPLE/i) {
645 print "<informalexample><programlisting>\n";
649 output_highlight
($args{'sections'}{$section});
650 if ($section =~ m/EXAMPLE/i) {
651 print "</programlisting></informalexample>\n";
655 print "</refsect1>\n";
659 # output function in XML DocBook
660 sub output_function_xml
(%) {
662 my ($parameter, $section);
666 $id = "API-" . $args{'function'};
667 $id =~ s/[^A-Za-z0-9]/-/g;
669 print "<refentry id=\"$id\">\n";
670 print "<refentryinfo>\n";
671 print " <title>LINUX</title>\n";
672 print " <productname>Kernel Hackers Manual</productname>\n";
673 print " <date>$man_date</date>\n";
674 print "</refentryinfo>\n";
676 print " <refentrytitle><phrase>" . $args{'function'} . "</phrase></refentrytitle>\n";
677 print " <manvolnum>9</manvolnum>\n";
678 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
679 print "</refmeta>\n";
680 print "<refnamediv>\n";
681 print " <refname>" . $args{'function'} . "</refname>\n";
682 print " <refpurpose>\n";
684 output_highlight
($args{'purpose'});
685 print " </refpurpose>\n";
686 print "</refnamediv>\n";
688 print "<refsynopsisdiv>\n";
689 print " <title>Synopsis</title>\n";
690 print " <funcsynopsis><funcprototype>\n";
691 print " <funcdef>" . $args{'functiontype'} . " ";
692 print "<function>" . $args{'function'} . " </function></funcdef>\n";
695 if ($#{$args{'parameterlist'}} >= 0) {
696 foreach $parameter (@
{$args{'parameterlist'}}) {
697 $type = $args{'parametertypes'}{$parameter};
698 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
699 # pointer-to-function
700 print " <paramdef>$1<parameter>$parameter</parameter>)\n";
701 print " <funcparams>$2</funcparams></paramdef>\n";
703 print " <paramdef>" . $type;
704 print " <parameter>$parameter</parameter></paramdef>\n";
710 print " </funcprototype></funcsynopsis>\n";
711 print "</refsynopsisdiv>\n";
714 print "<refsect1>\n <title>Arguments</title>\n";
715 if ($#{$args{'parameterlist'}} >= 0) {
716 print " <variablelist>\n";
717 foreach $parameter (@
{$args{'parameterlist'}}) {
718 my $parameter_name = $parameter;
719 $parameter_name =~ s/\[.*//;
721 print " <varlistentry>\n <term><parameter>$parameter</parameter></term>\n";
722 print " <listitem>\n <para>\n";
724 output_highlight
($args{'parameterdescs'}{$parameter_name});
725 print " </para>\n </listitem>\n </varlistentry>\n";
727 print " </variablelist>\n";
729 print " <para>\n None\n </para>\n";
731 print "</refsect1>\n";
733 output_section_xml
(@_);
734 print "</refentry>\n\n";
737 # output struct in XML DocBook
738 sub output_struct_xml
(%) {
740 my ($parameter, $section);
743 $id = "API-struct-" . $args{'struct'};
744 $id =~ s/[^A-Za-z0-9]/-/g;
746 print "<refentry id=\"$id\">\n";
747 print "<refentryinfo>\n";
748 print " <title>LINUX</title>\n";
749 print " <productname>Kernel Hackers Manual</productname>\n";
750 print " <date>$man_date</date>\n";
751 print "</refentryinfo>\n";
753 print " <refentrytitle><phrase>" . $args{'type'} . " " . $args{'struct'} . "</phrase></refentrytitle>\n";
754 print " <manvolnum>9</manvolnum>\n";
755 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
756 print "</refmeta>\n";
757 print "<refnamediv>\n";
758 print " <refname>" . $args{'type'} . " " . $args{'struct'} . "</refname>\n";
759 print " <refpurpose>\n";
761 output_highlight
($args{'purpose'});
762 print " </refpurpose>\n";
763 print "</refnamediv>\n";
765 print "<refsynopsisdiv>\n";
766 print " <title>Synopsis</title>\n";
767 print " <programlisting>\n";
768 print $args{'type'} . " " . $args{'struct'} . " {\n";
769 foreach $parameter (@
{$args{'parameterlist'}}) {
770 if ($parameter =~ /^#/) {
771 my $prm = $parameter;
772 # convert data read & converted thru xml_escape() into &xyz; format:
773 # This allows us to have #define macros interspersed in a struct.
774 $prm =~ s/\\\\\\/\&/g;
779 my $parameter_name = $parameter;
780 $parameter_name =~ s/\[.*//;
782 defined($args{'parameterdescs'}{$parameter_name}) || next;
783 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
784 $type = $args{'parametertypes'}{$parameter};
785 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
786 # pointer-to-function
787 print " $1 $parameter) ($2);\n";
788 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
790 print " $1 $parameter$2;\n";
792 print " " . $type . " " . $parameter . ";\n";
796 print " </programlisting>\n";
797 print "</refsynopsisdiv>\n";
799 print " <refsect1>\n";
800 print " <title>Members</title>\n";
802 if ($#{$args{'parameterlist'}} >= 0) {
803 print " <variablelist>\n";
804 foreach $parameter (@
{$args{'parameterlist'}}) {
805 ($parameter =~ /^#/) && next;
807 my $parameter_name = $parameter;
808 $parameter_name =~ s/\[.*//;
810 defined($args{'parameterdescs'}{$parameter_name}) || next;
811 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
812 print " <varlistentry>";
813 print " <term>$parameter</term>\n";
814 print " <listitem><para>\n";
815 output_highlight
($args{'parameterdescs'}{$parameter_name});
816 print " </para></listitem>\n";
817 print " </varlistentry>\n";
819 print " </variablelist>\n";
821 print " <para>\n None\n </para>\n";
823 print " </refsect1>\n";
825 output_section_xml
(@_);
827 print "</refentry>\n\n";
830 # output enum in XML DocBook
831 sub output_enum_xml
(%) {
833 my ($parameter, $section);
837 $id = "API-enum-" . $args{'enum'};
838 $id =~ s/[^A-Za-z0-9]/-/g;
840 print "<refentry id=\"$id\">\n";
841 print "<refentryinfo>\n";
842 print " <title>LINUX</title>\n";
843 print " <productname>Kernel Hackers Manual</productname>\n";
844 print " <date>$man_date</date>\n";
845 print "</refentryinfo>\n";
847 print " <refentrytitle><phrase>enum " . $args{'enum'} . "</phrase></refentrytitle>\n";
848 print " <manvolnum>9</manvolnum>\n";
849 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
850 print "</refmeta>\n";
851 print "<refnamediv>\n";
852 print " <refname>enum " . $args{'enum'} . "</refname>\n";
853 print " <refpurpose>\n";
855 output_highlight
($args{'purpose'});
856 print " </refpurpose>\n";
857 print "</refnamediv>\n";
859 print "<refsynopsisdiv>\n";
860 print " <title>Synopsis</title>\n";
861 print " <programlisting>\n";
862 print "enum " . $args{'enum'} . " {\n";
864 foreach $parameter (@
{$args{'parameterlist'}}) {
866 if ($count != $#{$args{'parameterlist'}}) {
873 print " </programlisting>\n";
874 print "</refsynopsisdiv>\n";
876 print "<refsect1>\n";
877 print " <title>Constants</title>\n";
878 print " <variablelist>\n";
879 foreach $parameter (@
{$args{'parameterlist'}}) {
880 my $parameter_name = $parameter;
881 $parameter_name =~ s/\[.*//;
883 print " <varlistentry>";
884 print " <term>$parameter</term>\n";
885 print " <listitem><para>\n";
886 output_highlight
($args{'parameterdescs'}{$parameter_name});
887 print " </para></listitem>\n";
888 print " </varlistentry>\n";
890 print " </variablelist>\n";
891 print "</refsect1>\n";
893 output_section_xml
(@_);
895 print "</refentry>\n\n";
898 # output typedef in XML DocBook
899 sub output_typedef_xml
(%) {
901 my ($parameter, $section);
904 $id = "API-typedef-" . $args{'typedef'};
905 $id =~ s/[^A-Za-z0-9]/-/g;
907 print "<refentry id=\"$id\">\n";
908 print "<refentryinfo>\n";
909 print " <title>LINUX</title>\n";
910 print " <productname>Kernel Hackers Manual</productname>\n";
911 print " <date>$man_date</date>\n";
912 print "</refentryinfo>\n";
914 print " <refentrytitle><phrase>typedef " . $args{'typedef'} . "</phrase></refentrytitle>\n";
915 print " <manvolnum>9</manvolnum>\n";
916 print "</refmeta>\n";
917 print "<refnamediv>\n";
918 print " <refname>typedef " . $args{'typedef'} . "</refname>\n";
919 print " <refpurpose>\n";
921 output_highlight
($args{'purpose'});
922 print " </refpurpose>\n";
923 print "</refnamediv>\n";
925 print "<refsynopsisdiv>\n";
926 print " <title>Synopsis</title>\n";
927 print " <synopsis>typedef " . $args{'typedef'} . ";</synopsis>\n";
928 print "</refsynopsisdiv>\n";
930 output_section_xml
(@_);
932 print "</refentry>\n\n";
935 # output in XML DocBook
936 sub output_blockhead_xml
(%) {
938 my ($parameter, $section);
941 my $id = $args{'module'};
942 $id =~ s/[^A-Za-z0-9]/-/g;
944 # print out each section
946 foreach $section (@
{$args{'sectionlist'}}) {
947 if (!$args{'content-only'}) {
948 print "<refsect1>\n <title>$section</title>\n";
950 if ($section =~ m/EXAMPLE/i) {
951 print "<example><para>\n";
955 output_highlight
($args{'sections'}{$section});
956 if ($section =~ m/EXAMPLE/i) {
957 print "</para></example>\n";
961 if (!$args{'content-only'}) {
962 print "\n</refsect1>\n";
969 # output in XML DocBook
970 sub output_function_gnome
{
972 my ($parameter, $section);
976 $id = $args{'module'} . "-" . $args{'function'};
977 $id =~ s/[^A-Za-z0-9]/-/g;
980 print " <title id=\"$id\">" . $args{'function'} . "</title>\n";
982 print " <funcsynopsis>\n";
983 print " <funcdef>" . $args{'functiontype'} . " ";
984 print "<function>" . $args{'function'} . " ";
985 print "</function></funcdef>\n";
988 if ($#{$args{'parameterlist'}} >= 0) {
989 foreach $parameter (@
{$args{'parameterlist'}}) {
990 $type = $args{'parametertypes'}{$parameter};
991 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
992 # pointer-to-function
993 print " <paramdef>$1 <parameter>$parameter</parameter>)\n";
994 print " <funcparams>$2</funcparams></paramdef>\n";
996 print " <paramdef>" . $type;
997 print " <parameter>$parameter</parameter></paramdef>\n";
1003 print " </funcsynopsis>\n";
1004 if ($#{$args{'parameterlist'}} >= 0) {
1005 print " <informaltable pgwide=\"1\" frame=\"none\" role=\"params\">\n";
1006 print "<tgroup cols=\"2\">\n";
1007 print "<colspec colwidth=\"2*\">\n";
1008 print "<colspec colwidth=\"8*\">\n";
1010 foreach $parameter (@
{$args{'parameterlist'}}) {
1011 my $parameter_name = $parameter;
1012 $parameter_name =~ s/\[.*//;
1014 print " <row><entry align=\"right\"><parameter>$parameter</parameter></entry>\n";
1017 output_highlight
($args{'parameterdescs'}{$parameter_name});
1018 print " </entry></row>\n";
1020 print " </tbody></tgroup></informaltable>\n";
1022 print " <para>\n None\n </para>\n";
1025 # print out each section
1027 foreach $section (@
{$args{'sectionlist'}}) {
1028 print "<simplesect>\n <title>$section</title>\n";
1029 if ($section =~ m/EXAMPLE/i) {
1030 print "<example><programlisting>\n";
1034 output_highlight
($args{'sections'}{$section});
1036 if ($section =~ m/EXAMPLE/i) {
1037 print "</programlisting></example>\n";
1040 print " </simplesect>\n";
1043 print "</sect2>\n\n";
1047 # output function in man
1048 sub output_function_man
(%) {
1049 my %args = %{$_[0]};
1050 my ($parameter, $section);
1053 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
1056 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
1058 print ".SH SYNOPSIS\n";
1059 if ($args{'functiontype'} ne "") {
1060 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
1062 print ".B \"" . $args{'function'} . "\n";
1067 foreach my $parameter (@
{$args{'parameterlist'}}) {
1068 if ($count == $#{$args{'parameterlist'}}) {
1071 $type = $args{'parametertypes'}{$parameter};
1072 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1073 # pointer-to-function
1074 print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n";
1076 $type =~ s/([^\*])$/$1 /;
1077 print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n";
1083 print ".SH ARGUMENTS\n";
1084 foreach $parameter (@
{$args{'parameterlist'}}) {
1085 my $parameter_name = $parameter;
1086 $parameter_name =~ s/\[.*//;
1088 print ".IP \"" . $parameter . "\" 12\n";
1089 output_highlight
($args{'parameterdescs'}{$parameter_name});
1091 foreach $section (@
{$args{'sectionlist'}}) {
1092 print ".SH \"", uc $section, "\"\n";
1093 output_highlight
($args{'sections'}{$section});
1098 # output enum in man
1099 sub output_enum_man
(%) {
1100 my %args = %{$_[0]};
1101 my ($parameter, $section);
1104 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
1107 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
1109 print ".SH SYNOPSIS\n";
1110 print "enum " . $args{'enum'} . " {\n";
1112 foreach my $parameter (@
{$args{'parameterlist'}}) {
1113 print ".br\n.BI \" $parameter\"\n";
1114 if ($count == $#{$args{'parameterlist'}}) {
1124 print ".SH Constants\n";
1125 foreach $parameter (@
{$args{'parameterlist'}}) {
1126 my $parameter_name = $parameter;
1127 $parameter_name =~ s/\[.*//;
1129 print ".IP \"" . $parameter . "\" 12\n";
1130 output_highlight
($args{'parameterdescs'}{$parameter_name});
1132 foreach $section (@
{$args{'sectionlist'}}) {
1133 print ".SH \"$section\"\n";
1134 output_highlight
($args{'sections'}{$section});
1139 # output struct in man
1140 sub output_struct_man
(%) {
1141 my %args = %{$_[0]};
1142 my ($parameter, $section);
1144 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
1147 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
1149 print ".SH SYNOPSIS\n";
1150 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
1152 foreach my $parameter (@
{$args{'parameterlist'}}) {
1153 if ($parameter =~ /^#/) {
1154 print ".BI \"$parameter\"\n.br\n";
1157 my $parameter_name = $parameter;
1158 $parameter_name =~ s/\[.*//;
1160 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1161 $type = $args{'parametertypes'}{$parameter};
1162 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1163 # pointer-to-function
1164 print ".BI \" " . $1 . "\" " . $parameter . " \") (" . $2 . ")" . "\"\n;\n";
1165 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1167 print ".BI \" " . $1 . "\ \" " . $parameter . $2 . " \"" . "\"\n;\n";
1169 $type =~ s/([^\*])$/$1 /;
1170 print ".BI \" " . $type . "\" " . $parameter . " \"" . "\"\n;\n";
1176 print ".SH Members\n";
1177 foreach $parameter (@
{$args{'parameterlist'}}) {
1178 ($parameter =~ /^#/) && next;
1180 my $parameter_name = $parameter;
1181 $parameter_name =~ s/\[.*//;
1183 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1184 print ".IP \"" . $parameter . "\" 12\n";
1185 output_highlight
($args{'parameterdescs'}{$parameter_name});
1187 foreach $section (@
{$args{'sectionlist'}}) {
1188 print ".SH \"$section\"\n";
1189 output_highlight
($args{'sections'}{$section});
1194 # output typedef in man
1195 sub output_typedef_man
(%) {
1196 my %args = %{$_[0]};
1197 my ($parameter, $section);
1199 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
1202 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
1204 foreach $section (@
{$args{'sectionlist'}}) {
1205 print ".SH \"$section\"\n";
1206 output_highlight
($args{'sections'}{$section});
1210 sub output_blockhead_man
(%) {
1211 my %args = %{$_[0]};
1212 my ($parameter, $section);
1215 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
1217 foreach $section (@
{$args{'sectionlist'}}) {
1218 print ".SH \"$section\"\n";
1219 output_highlight
($args{'sections'}{$section});
1225 sub output_function_text
(%) {
1226 my %args = %{$_[0]};
1227 my ($parameter, $section);
1231 print $args{'function'} . " - " . $args{'purpose'} . "\n";
1233 print "\nSynopsis:\n\n";
1234 if ($args{'functiontype'} ne "") {
1235 $start = $args{'functiontype'} . " " . $args{'function'} . " (";
1237 $start = $args{'function'} . " (";
1242 foreach my $parameter (@
{$args{'parameterlist'}}) {
1243 $type = $args{'parametertypes'}{$parameter};
1244 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1245 # pointer-to-function
1246 print $1 . $parameter . ") (" . $2;
1248 print $type . " " . $parameter;
1250 if ($count != $#{$args{'parameterlist'}}) {
1253 print " " x
length($start);
1259 print "Arguments:\n\n";
1260 foreach $parameter (@
{$args{'parameterlist'}}) {
1261 my $parameter_name = $parameter;
1262 $parameter_name =~ s/\[.*//;
1264 print $parameter . "\n\t" . $args{'parameterdescs'}{$parameter_name} . "\n";
1266 output_section_text
(@_);
1269 #output sections in text
1270 sub output_section_text
(%) {
1271 my %args = %{$_[0]};
1275 foreach $section (@
{$args{'sectionlist'}}) {
1276 print "$section:\n\n";
1277 output_highlight
($args{'sections'}{$section});
1282 # output enum in text
1283 sub output_enum_text
(%) {
1284 my %args = %{$_[0]};
1289 print "enum " . $args{'enum'} . " - " . $args{'purpose'} . "\n\n";
1290 print "enum " . $args{'enum'} . " {\n";
1292 foreach $parameter (@
{$args{'parameterlist'}}) {
1293 print "\t$parameter";
1294 if ($count != $#{$args{'parameterlist'}}) {
1302 print "Constants:\n\n";
1303 foreach $parameter (@
{$args{'parameterlist'}}) {
1304 print "$parameter\n\t";
1305 print $args{'parameterdescs'}{$parameter} . "\n";
1308 output_section_text
(@_);
1311 # output typedef in text
1312 sub output_typedef_text
(%) {
1313 my %args = %{$_[0]};
1316 print "Typedef:\n\n";
1318 print "typedef " . $args{'typedef'} . " - " . $args{'purpose'} . "\n";
1319 output_section_text
(@_);
1322 # output struct as text
1323 sub output_struct_text
(%) {
1324 my %args = %{$_[0]};
1327 print $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "\n\n";
1328 print $args{'type'} . " " . $args{'struct'} . " {\n";
1329 foreach $parameter (@
{$args{'parameterlist'}}) {
1330 if ($parameter =~ /^#/) {
1331 print "$parameter\n";
1335 my $parameter_name = $parameter;
1336 $parameter_name =~ s/\[.*//;
1338 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1339 $type = $args{'parametertypes'}{$parameter};
1340 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1341 # pointer-to-function
1342 print "\t$1 $parameter) ($2);\n";
1343 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1345 print "\t$1 $parameter$2;\n";
1347 print "\t" . $type . " " . $parameter . ";\n";
1352 print "Members:\n\n";
1353 foreach $parameter (@
{$args{'parameterlist'}}) {
1354 ($parameter =~ /^#/) && next;
1356 my $parameter_name = $parameter;
1357 $parameter_name =~ s/\[.*//;
1359 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1360 print "$parameter\n\t";
1361 print $args{'parameterdescs'}{$parameter_name} . "\n";
1364 output_section_text
(@_);
1367 sub output_blockhead_text
(%) {
1368 my %args = %{$_[0]};
1369 my ($parameter, $section);
1371 foreach $section (@
{$args{'sectionlist'}}) {
1372 print " $section:\n";
1374 output_highlight
($args{'sections'}{$section});
1378 ## list mode output functions
1380 sub output_function_list
(%) {
1381 my %args = %{$_[0]};
1383 print $args{'function'} . "\n";
1386 # output enum in list
1387 sub output_enum_list
(%) {
1388 my %args = %{$_[0]};
1389 print $args{'enum'} . "\n";
1392 # output typedef in list
1393 sub output_typedef_list
(%) {
1394 my %args = %{$_[0]};
1395 print $args{'typedef'} . "\n";
1398 # output struct as list
1399 sub output_struct_list
(%) {
1400 my %args = %{$_[0]};
1402 print $args{'struct'} . "\n";
1405 sub output_blockhead_list
(%) {
1406 my %args = %{$_[0]};
1407 my ($parameter, $section);
1409 foreach $section (@
{$args{'sectionlist'}}) {
1410 print "DOC: $section\n";
1415 # generic output function for all types (function, struct/union, typedef, enum);
1416 # calls the generated, variable output_ function name based on
1417 # functype and output_mode
1418 sub output_declaration
{
1421 my $functype = shift;
1422 my $func = "output_${functype}_$output_mode";
1423 if (($function_only==0) ||
1424 ( $function_only == 1 && defined($function_table{$name})) ||
1425 ( $function_only == 2 && !defined($function_table{$name})))
1433 # generic output function - calls the right one based on current output mode.
1434 sub output_blockhead
{
1436 my $func = "output_blockhead_" . $output_mode;
1442 # takes a declaration (struct, union, enum, typedef) and
1443 # invokes the right handler. NOT called for functions.
1444 sub dump_declaration
($$) {
1446 my ($prototype, $file) = @_;
1447 my $func = "dump_" . $decl_type;
1451 sub dump_union
($$) {
1455 sub dump_struct
($$) {
1460 if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) {
1461 #my $decl_type = $1;
1462 $declaration_name = $2;
1465 # ignore embedded structs or unions
1466 $members =~ s/({.*})//g;
1469 # ignore members marked private:
1470 $members =~ s/\/\*\s*private:.*?\/\
*\s
*public
:.*?\
*\
///gos
;
1471 $members =~ s/\/\*\s*private:.*//gos
;
1473 $members =~ s/\/\*.*?\*\///gos;
1474 $nested =~ s/\/\*.*?\*\///gos;
1475 # strip kmemcheck_bitfield_{begin,end}.*;
1476 $members =~ s/kmemcheck_bitfield_.*?;//gos;
1478 $members =~ s/__aligned\s*\(\d+\)//gos;
1480 create_parameterlist
($members, ';', $file);
1481 check_sections
($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested);
1483 output_declaration
($declaration_name,
1485 {'struct' => $declaration_name,
1486 'module' => $modulename,
1487 'parameterlist' => \
@parameterlist,
1488 'parameterdescs' => \
%parameterdescs,
1489 'parametertypes' => \
%parametertypes,
1490 'sectionlist' => \
@sectionlist,
1491 'sections' => \
%sections,
1492 'purpose' => $declaration_purpose,
1493 'type' => $decl_type
1497 print STDERR
"Error(${file}:$.): Cannot parse struct or union!\n";
1506 $x =~ s@
/\*.*?\*/@
@gos; # strip comments.
1507 $x =~ s/^#\s*define\s+.*$//; # strip #define macros inside enums
1509 if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
1510 $declaration_name = $1;
1513 foreach my $arg (split ',', $members) {
1514 $arg =~ s/^\s*(\w+).*/$1/;
1515 push @parameterlist, $arg;
1516 if (!$parameterdescs{$arg}) {
1517 $parameterdescs{$arg} = $undescribed;
1518 print STDERR
"Warning(${file}:$.): Enum value '$arg' ".
1519 "not described in enum '$declaration_name'\n";
1524 output_declaration
($declaration_name,
1526 {'enum' => $declaration_name,
1527 'module' => $modulename,
1528 'parameterlist' => \
@parameterlist,
1529 'parameterdescs' => \
%parameterdescs,
1530 'sectionlist' => \
@sectionlist,
1531 'sections' => \
%sections,
1532 'purpose' => $declaration_purpose
1536 print STDERR
"Error(${file}:$.): Cannot parse enum!\n";
1541 sub dump_typedef
($$) {
1545 $x =~ s@
/\*.*?\*/@
@gos; # strip comments.
1546 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1547 $x =~ s/\(*.\)\s*;$/;/;
1548 $x =~ s/\[*.\]\s*;$/;/;
1551 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1552 $declaration_name = $1;
1554 output_declaration
($declaration_name,
1556 {'typedef' => $declaration_name,
1557 'module' => $modulename,
1558 'sectionlist' => \
@sectionlist,
1559 'sections' => \
%sections,
1560 'purpose' => $declaration_purpose
1564 print STDERR
"Error(${file}:$.): Cannot parse typedef!\n";
1569 sub save_struct_actual
($) {
1572 # strip all spaces from the actual param so that it looks like one string item
1573 $actual =~ s/\s*//g;
1574 $struct_actual = $struct_actual . $actual . " ";
1577 sub create_parameterlist
($$$) {
1579 my $splitter = shift;
1584 # temporarily replace commas inside function pointer definition
1585 while ($args =~ /(\([^\),]+),/) {
1586 $args =~ s/(\([^\),]+),/$1#/g;
1589 foreach my $arg (split($splitter, $args)) {
1591 $arg =~ s/\/\*.*\*\///;
1592 # strip leading/trailing spaces
1598 # Treat preprocessor directive as a typeless variable just to fill
1599 # corresponding data structures "correctly". Catch it later in
1601 push_parameter
($arg, "", $file);
1602 } elsif ($arg =~ m/\(.+\)\s*\(/) {
1603 # pointer-to-function
1605 $arg =~ m/[^\(]+\(\*?\s*(\w*)\s*\)/;
1608 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1609 save_struct_actual
($param);
1610 push_parameter
($param, $type, $file);
1612 $arg =~ s/\s*:\s*/:/g;
1613 $arg =~ s/\s*\[/\[/g;
1615 my @args = split('\s*,\s*', $arg);
1616 if ($args[0] =~ m/\*/) {
1617 $args[0] =~ s/(\*+)\s*/ $1/;
1621 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1623 push(@first_arg, split('\s+', $1));
1624 push(@first_arg, $2);
1626 @first_arg = split('\s+', shift @args);
1629 unshift(@args, pop @first_arg);
1630 $type = join " ", @first_arg;
1632 foreach $param (@args) {
1633 if ($param =~ m/^(\*+)\s*(.*)/) {
1634 save_struct_actual
($2);
1635 push_parameter
($2, "$type $1", $file);
1637 elsif ($param =~ m/(.*?):(\d+)/) {
1638 if ($type ne "") { # skip unnamed bit-fields
1639 save_struct_actual
($1);
1640 push_parameter
($1, "$type:$2", $file)
1644 save_struct_actual
($param);
1645 push_parameter
($param, $type, $file);
1652 sub push_parameter
($$$) {
1657 if (($anon_struct_union == 1) && ($type eq "") &&
1659 return; # ignore the ending }; from anon. struct/union
1662 $anon_struct_union = 0;
1663 my $param_name = $param;
1664 $param_name =~ s/\[.*//;
1666 if ($type eq "" && $param =~ /\.\.\.$/)
1668 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1669 $parameterdescs{$param} = "variable arguments";
1672 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1675 $parameterdescs{void
} = "no arguments";
1677 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1678 # handle unnamed (anonymous) union or struct:
1681 $param = "{unnamed_" . $param . "}";
1682 $parameterdescs{$param} = "anonymous\n";
1683 $anon_struct_union = 1;
1686 # warn if parameter has no description
1687 # (but ignore ones starting with # as these are not parameters
1688 # but inline preprocessor statements);
1689 # also ignore unnamed structs/unions;
1690 if (!$anon_struct_union) {
1691 if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) {
1693 $parameterdescs{$param_name} = $undescribed;
1695 if (($type eq 'function') || ($type eq 'enum')) {
1696 print STDERR
"Warning(${file}:$.): Function parameter ".
1697 "or member '$param' not " .
1698 "described in '$declaration_name'\n";
1700 print STDERR
"Warning(${file}:$.):" .
1701 " No description found for parameter '$param'\n";
1706 $param = xml_escape
($param);
1708 # strip spaces from $param so that it is one continuous string
1709 # on @parameterlist;
1710 # this fixes a problem where check_sections() cannot find
1711 # a parameter like "addr[6 + 2]" because it actually appears
1712 # as "addr[6", "+", "2]" on the parameter list;
1713 # but it's better to maintain the param string unchanged for output,
1714 # so just weaken the string compare in check_sections() to ignore
1715 # "[blah" in a parameter string;
1716 ###$param =~ s/\s*//g;
1717 push @parameterlist, $param;
1718 $parametertypes{$param} = $type;
1721 sub check_sections
($$$$$$) {
1722 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck, $nested) = @_;
1723 my @sects = split ' ', $sectcheck;
1724 my @prms = split ' ', $prmscheck;
1727 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
1729 foreach $sx (0 .. $#sects) {
1731 foreach $px (0 .. $#prms) {
1732 $prm_clean = $prms[$px];
1733 $prm_clean =~ s/\[.*\]//;
1734 $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;
1735 # ignore array size in a parameter string;
1736 # however, the original param string may contain
1737 # spaces, e.g.: addr[6 + 2]
1738 # and this appears in @prms as "addr[6" since the
1739 # parameter list is split at spaces;
1740 # hence just ignore "[..." for the sections check;
1741 $prm_clean =~ s/\[.*//;
1743 ##$prm_clean =~ s/^\**//;
1744 if ($prm_clean eq $sects[$sx]) {
1750 if ($decl_type eq "function") {
1751 print STDERR
"Warning(${file}:$.): " .
1752 "Excess function parameter " .
1754 "description in '$decl_name'\n";
1757 if ($nested !~ m/\Q$sects[$sx]\E/) {
1758 print STDERR
"Warning(${file}:$.): " .
1759 "Excess struct/union/enum/typedef member " .
1761 "description in '$decl_name'\n";
1770 # takes a function prototype and the name of the current file being
1771 # processed and spits out all the details stored in the global
1773 sub dump_function
($$) {
1774 my $prototype = shift;
1777 $prototype =~ s/^static +//;
1778 $prototype =~ s/^extern +//;
1779 $prototype =~ s/^asmlinkage +//;
1780 $prototype =~ s/^inline +//;
1781 $prototype =~ s/^__inline__ +//;
1782 $prototype =~ s/^__inline +//;
1783 $prototype =~ s/^__always_inline +//;
1784 $prototype =~ s/^noinline +//;
1785 $prototype =~ s/__devinit +//;
1786 $prototype =~ s/__init +//;
1787 $prototype =~ s/__init_or_module +//;
1788 $prototype =~ s/^#\s*define\s+//; #ak added
1789 $prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//;
1791 # Yes, this truly is vile. We are looking for:
1792 # 1. Return type (may be nothing if we're looking at a macro)
1794 # 3. Function parameters.
1796 # All the while we have to watch out for function pointer parameters
1797 # (which IIRC is what the two sections are for), C types (these
1798 # regexps don't even start to express all the possibilities), and
1801 # If you mess with these regexps, it's a good idea to check that
1802 # the following functions' documentation still comes out right:
1803 # - parport_register_device (function pointer parameters)
1804 # - atomic_set (macro)
1805 # - pci_match_device, __copy_to_user (long return type)
1807 if ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1808 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1809 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1810 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1811 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1812 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1813 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1814 $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1815 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1816 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1817 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1818 $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1819 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1820 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1821 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1822 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1823 $prototype =~ m/^(\w+\s+\w+\s*\*\s*\w+\s*\*\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) {
1825 $declaration_name = $2;
1828 create_parameterlist
($args, ',', $file);
1830 print STDERR
"Error(${file}:$.): cannot understand prototype: '$prototype'\n";
1835 my $prms = join " ", @parameterlist;
1836 check_sections
($file, $declaration_name, "function", $sectcheck, $prms, "");
1838 output_declaration
($declaration_name,
1840 {'function' => $declaration_name,
1841 'module' => $modulename,
1842 'functiontype' => $return_type,
1843 'parameterlist' => \
@parameterlist,
1844 'parameterdescs' => \
%parameterdescs,
1845 'parametertypes' => \
%parametertypes,
1846 'sectionlist' => \
@sectionlist,
1847 'sections' => \
%sections,
1848 'purpose' => $declaration_purpose
1855 %parameterdescs = ();
1856 %parametertypes = ();
1857 @parameterlist = ();
1861 $struct_actual = "";
1867 sub tracepoint_munge
($) {
1869 my $tracepointname = 0;
1870 my $tracepointargs = 0;
1872 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
1873 $tracepointname = $1;
1875 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1876 $tracepointname = $1;
1878 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1879 $tracepointname = $2;
1881 $tracepointname =~ s/^\s+//; #strip leading whitespace
1882 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
1883 $tracepointargs = $1;
1885 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1886 print STDERR
"Warning(${file}:$.): Unrecognized tracepoint format: \n".
1889 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1893 sub syscall_munge
() {
1896 $prototype =~ s@
[\r\n\t]+@
@gos; # strip newlines/CR's/tabs
1897 ## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1898 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1900 ## $prototype = "long sys_$1(void)";
1903 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1904 if ($prototype =~ m/long (sys_.*?),/) {
1905 $prototype =~ s/,/\(/;
1907 $prototype =~ s/\)/\(void\)/;
1910 # now delete all of the odd-number commas in $prototype
1911 # so that arg types & arg names don't have a comma between them
1913 my $len = length($prototype);
1915 $len = 0; # skip the for-loop
1917 for (my $ix = 0; $ix < $len; $ix++) {
1918 if (substr($prototype, $ix, 1) eq ',') {
1920 if ($count % 2 == 1) {
1921 substr($prototype, $ix, 1) = ' ';
1927 sub process_state3_function
($$) {
1931 $x =~ s@\
/\/.*$@
@gos; # strip C99-style comments to end of line
1933 if ($x =~ m
#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
1936 elsif ($x =~ /([^\{]*)/) {
1940 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1941 $prototype =~ s@
/\*.*?\*/@
@gos; # strip comments.
1942 $prototype =~ s@
[\r\n]+@
@gos; # strip newlines/cr's.
1943 $prototype =~ s@
^\s
+@
@gos; # strip leading spaces
1944 if ($prototype =~ /SYSCALL_DEFINE/) {
1947 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1948 $prototype =~ /DEFINE_SINGLE_EVENT/)
1950 tracepoint_munge
($file);
1952 dump_function
($prototype, $file);
1957 sub process_state3_type
($$) {
1961 $x =~ s@
[\r\n]+@
@gos; # strip newlines/cr's.
1962 $x =~ s@
^\s
+@
@gos; # strip leading spaces
1963 $x =~ s@\s
+$@
@gos; # strip trailing spaces
1964 $x =~ s@\
/\/.*$@
@gos; # strip C99-style comments to end of line
1967 # To distinguish preprocessor directive from regular declaration later.
1972 if ( $x =~ /([^{};]*)([{};])(.*)/ ) {
1973 $prototype .= $1 . $2;
1974 ($2 eq '{') && $brcount++;
1975 ($2 eq '}') && $brcount--;
1976 if (($2 eq ';') && ($brcount == 0)) {
1977 dump_declaration
($prototype, $file);
1989 # xml_escape: replace <, >, and & in the text stream;
1991 # however, formatting controls that are generated internally/locally in the
1992 # kernel-doc script are not escaped here; instead, they begin life like
1993 # $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings
1994 # are converted to their mnemonic-expected output, without the 4 * '\' & ':',
1995 # just before actual output; (this is done by local_unescape())
1998 if (($output_mode eq "text") || ($output_mode eq "man")) {
2001 $text =~ s/\&/\\\\\\amp;/g;
2002 $text =~ s/\</\\\\\\lt;/g;
2003 $text =~ s/\>/\\\\\\gt;/g;
2007 # convert local escape strings to html
2008 # local escape strings look like: '\\\\menmonic:' (that's 4 backslashes)
2009 sub local_unescape
($) {
2011 if (($output_mode eq "text") || ($output_mode eq "man")) {
2014 $text =~ s/\\\\\\\\lt:/</g;
2015 $text =~ s/\\\\\\\\gt:/>/g;
2019 sub process_file
($) {
2025 my $initial_section_counter = $section_counter;
2027 if (defined($ENV{'SRCTREE'})) {
2028 $file = "$ENV{'SRCTREE'}" . "/" . "@_";
2033 if (defined($source_map{$file})) {
2034 $file = $source_map{$file};
2037 if (!open(IN
,"<$file")) {
2038 print STDERR
"Error: Cannot open file $file\n";
2045 $section_counter = 0;
2048 if (/$doc_start/o) {
2049 $state = 1; # next line is always the function name
2052 } elsif ($state == 1) { # this line is the function name (always)
2053 if (/$doc_block/o) {
2057 $section = $section_intro;
2062 elsif (/$doc_decl/o) {
2064 if (/\s*([\w\s]+?)\s*-/) {
2070 # strip leading/trailing/multiple spaces
2075 $declaration_purpose = xml_escape
($descr);
2078 $declaration_purpose = "";
2081 if (($declaration_purpose eq "") && $verbose) {
2082 print STDERR
"Warning(${file}:$.): missing initial short description on line:\n";
2087 if ($identifier =~ m/^struct/) {
2088 $decl_type = 'struct';
2089 } elsif ($identifier =~ m/^union/) {
2090 $decl_type = 'union';
2091 } elsif ($identifier =~ m/^enum/) {
2092 $decl_type = 'enum';
2093 } elsif ($identifier =~ m/^typedef/) {
2094 $decl_type = 'typedef';
2096 $decl_type = 'function';
2100 print STDERR
"Info(${file}:$.): Scanning doc for $identifier\n";
2103 print STDERR
"Warning(${file}:$.): Cannot understand $_ on line $.",
2104 " - I thought it was a doc line\n";
2108 } elsif ($state == 2) { # look for head: lines, and include content
2113 if (($contents ne "") && ($contents ne "\n")) {
2114 if (!$in_doc_sect && $verbose) {
2115 print STDERR
"Warning(${file}:$.): contents before sections\n";
2118 dump_section
($file, $section, xml_escape
($contents));
2119 $section = $section_default;
2124 $contents = $newcontents;
2125 if ($contents ne "") {
2126 while ((substr($contents, 0, 1) eq " ") ||
2127 substr($contents, 0, 1) eq "\t") {
2128 $contents = substr($contents, 1);
2132 $section = $newsection;
2133 } elsif (/$doc_end/) {
2135 if (($contents ne "") && ($contents ne "\n")) {
2136 dump_section
($file, $section, xml_escape
($contents));
2137 $section = $section_default;
2140 # look for doc_com + <text> + doc_end:
2141 if ($_ =~ m
'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2142 print STDERR
"Warning(${file}:$.): suspicious ending line: $_";
2149 # print STDERR "end of doc comment, looking for prototype\n";
2150 } elsif (/$doc_content/) {
2151 # miguel-style comment kludge, look for blank lines after
2152 # @parameter line to signify start of description
2154 if ($section =~ m/^@/ || $section eq $section_context) {
2155 dump_section
($file, $section, xml_escape
($contents));
2156 $section = $section_default;
2162 } elsif ($in_purpose == 1) {
2163 # Continued declaration purpose
2164 chomp($declaration_purpose);
2165 $declaration_purpose .= " " . xml_escape
($1);
2167 $contents .= $1 . "\n";
2170 # i dont know - bad line? ignore.
2171 print STDERR
"Warning(${file}:$.): bad line: $_";
2174 } elsif ($state == 3) { # scanning for function '{' (end of prototype)
2175 if ($decl_type eq 'function') {
2176 process_state3_function
($_, $file);
2178 process_state3_type
($_, $file);
2180 } elsif ($state == 4) {
2181 # Documentation block
2183 dump_doc_section
($file, $section, xml_escape
($contents));
2187 %parameterdescs = ();
2188 %parametertypes = ();
2189 @parameterlist = ();
2194 $section = $section_intro;
2201 dump_doc_section
($file, $section, xml_escape
($contents));
2205 %parameterdescs = ();
2206 %parametertypes = ();
2207 @parameterlist = ();
2213 elsif (/$doc_content/)
2217 $contents .= $blankline;
2221 $contents .= $1 . "\n";
2226 if ($initial_section_counter == $section_counter) {
2227 print STDERR
"Warning(${file}): no structured comments found\n";
2228 if ($output_mode eq "xml") {
2229 # The template wants at least one RefEntry here; make one.
2230 print "<refentry>\n";
2231 print " <refnamediv>\n";
2232 print " <refname>\n";
2234 print " </refname>\n";
2235 print " <refpurpose>\n";
2236 print " Document generation inconsistency\n";
2237 print " </refpurpose>\n";
2238 print " </refnamediv>\n";
2239 print " <refsect1>\n";
2242 print " </title>\n";
2243 print " <warning>\n";
2245 print " The template for this document tried to insert\n";
2246 print " the structured comment from the file\n";
2247 print " <filename>${file}</filename> at this point,\n";
2248 print " but none was found.\n";
2249 print " This dummy section is inserted to allow\n";
2250 print " generation to continue.\n";
2252 print " </warning>\n";
2253 print " </refsect1>\n";
2254 print "</refentry>\n";
2260 $kernelversion = get_kernel_version
();
2262 # generate a sequence of code that will splice in highlighting information
2263 # using the s// operator.
2264 foreach my $pattern (keys %highlights) {
2265 # print STDERR "scanning pattern:$pattern, highlight:($highlights{$pattern})\n";
2266 $dohighlight .= "\$contents =~ s:$pattern:$highlights{$pattern}:gs;\n";
2269 # Read the file that maps relative names to absolute names for
2270 # separate source and object directories and for shadow trees.
2271 if (open(SOURCE_MAP
, "<.tmp_filelist.txt")) {
2272 my ($relname, $absname);
2273 while(<SOURCE_MAP
>) {
2275 ($relname, $absname) = (split())[0..1];
2276 $relname =~ s
:^/+::;
2277 $source_map{$relname} = $absname;
2286 if ($verbose && $errors) {
2287 print STDERR
"$errors errors\n";
2289 if ($verbose && $warnings) {
2290 print STDERR
"$warnings warnings\n";
This page took 0.108936 seconds and 5 git commands to generate.