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 ##
9 ## #define enhancements by Armin Kuster <akuster@mvista.com> ##
10 ## Copyright (c) 2000 MontaVista Software, Inc. ##
12 ## This software falls under the GNU General Public License. ##
13 ## Please read the COPYING file for more information ##
15 # w.o. 03-11-2000: added the '-filelist' option.
17 # 18/01/2001 - Cleanups
18 # Functions prototyped as foo(void) same as foo()
19 # Stop eval'ing where we don't need to.
22 # 27/06/2001 - Allowed whitespace after initial "/**" and
23 # allowed comments before function declarations.
24 # -- Christian Kreibich <ck@whoop.org>
27 # - add perldoc documentation
28 # - Look more closely at some of the scarier bits :)
30 # 26/05/2001 - Support for separate source and object trees.
32 # Keith Owens <kaos@ocs.com.au>
34 # 23/09/2001 - Added support for typedefs, structs, enums and unions
35 # Support for Context section; can be terminated using empty line
36 # Small fixes (like spaces vs. \s in regex)
37 # -- Tim Jansen <tim@tjansen.de>
41 # This will read a 'c' file and scan for embedded comments in the
42 # style of gnome comments (+minor extensions - see below).
45 # Note: This only supports 'c'.
48 # kernel-doc [ -docbook | -html | -text | -man ]
49 # [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile
51 # [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile
53 # Set output format using one of -docbook -html -text or -man. Default is man.
56 # If set, then only generate documentation for the given function(s). All
57 # other functions are ignored.
59 # -nofunction funcname
60 # If set, then only generate documentation for the other function(s).
61 # Cannot be used together with -function
62 # (yes, that's a bug -- perl hackers can fix it 8))
64 # c files - list of 'c' files to process
66 # All output goes to stdout, with errors to stderr.
70 # In the following table, (...)? signifies optional structure.
71 # (...)* signifies 0 or more structure elements
73 # * function_name(:)? (- short description)?
74 # (* @parameterx: (description of parameter x)?)*
76 # * (Description:)? (Description of function)?
77 # * (section header: (section description)? )*
80 # So .. the trivial example would be:
86 # If the Description: header tag is omitted, then there must be a blank line
87 # after the last parameter specification.
90 # * my_function - does my stuff
91 # * @my_arg: its mine damnit
93 # * Does my stuff explained.
98 # * my_function - does my stuff
99 # * @my_arg: its mine damnit
100 # * Description: Does my stuff explained.
104 # Beside functions you can also write documentation for structs, unions,
105 # enums and typedefs. Instead of the function name you must write the name
106 # of the declaration; the struct/union/enum/typedef must always precede
107 # the name. Nesting of declarations is not supported.
108 # Use the argument mechanism to document members or constants.
111 # * struct my_struct - short description
113 # * @b: second member
115 # * Longer description
124 # All descriptions can be multiline, except the short function description.
126 # You can also add additional sections. When documenting kernel functions you
127 # should document the "Context:" of the function, e.g. whether the functions
128 # can be called form interrupts. Unlike other sections you can end it with an
130 # Example-sections should contain the string EXAMPLE so that they are marked
131 # appropriately in DocBook.
135 # * user_function - function that can only be called in user context
136 # * @a: some argument
137 # * Context: !in_interrupt()
141 # * user_function(22);
146 # All descriptive text is further processed, scanning for the following special
147 # patterns, which are highlighted appropriately.
149 # 'funcname()' - function
150 # '$ENVVAR' - environmental variable
151 # '&struct_name' - name of a structure (up to two words including 'struct')
152 # '@parameter' - name of a parameter
153 # '%CONST' - name of a constant.
157 my $anon_struct_union = 0;
159 # match expressions used to find embedded type information
160 my $type_constant = '\%([-_\w]+)';
161 my $type_func = '(\w+)\(\)';
162 my $type_param = '\@(\w+)';
163 my $type_struct = '\&((struct\s*)*[_\w]+)';
164 my $type_struct_xml = '\\\amp;((struct\s*)*[_\w]+)';
165 my $type_env = '(\$\w+)';
167 # Output conversion substitutions.
168 # One for each output format
170 # these work fairly well
171 my %highlights_html = ( $type_constant, "<i>\$1</i>",
172 $type_func, "<b>\$1</b>",
173 $type_struct_xml, "<i>\$1</i>",
174 $type_env, "<b><i>\$1</i></b>",
175 $type_param, "<tt><b>\$1</b></tt>" );
176 my $blankline_html = "<p>";
178 # XML, docbook format
179 my %highlights_xml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>",
180 $type_constant, "<constant>\$1</constant>",
181 $type_func, "<function>\$1</function>",
182 $type_struct, "<structname>\$1</structname>",
183 $type_env, "<envar>\$1</envar>",
184 $type_param, "<parameter>\$1</parameter>" );
185 my $blankline_xml = "</para><para>\n";
187 # gnome, docbook format
188 my %highlights_gnome = ( $type_constant, "<replaceable class=\"option\">\$1</replaceable>",
189 $type_func, "<function>\$1</function>",
190 $type_struct, "<structname>\$1</structname>",
191 $type_env, "<envar>\$1</envar>",
192 $type_param, "<parameter>\$1</parameter>" );
193 my $blankline_gnome = "</para><para>\n";
195 # these are pretty rough
196 my %highlights_man = ( $type_constant, "\$1",
197 $type_func, "\\\\fB\$1\\\\fP",
198 $type_struct, "\\\\fI\$1\\\\fP",
199 $type_param, "\\\\fI\$1\\\\fP" );
200 my $blankline_man = "";
203 my %highlights_text = ( $type_constant, "\$1",
206 $type_param, "\$1" );
207 my $blankline_text = "";
211 print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man ]\n";
212 print " [ -function funcname [ -function funcname ...] ]\n";
213 print " [ -nofunction funcname [ -nofunction funcname ...] ]\n";
214 print " c source file(s) > outputfile\n";
224 my $output_mode = "man";
225 my %highlights = %highlights_man;
226 my $blankline = $blankline_man;
227 my $modulename = "Kernel API";
228 my $function_only = 0;
229 my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
230 'July', 'August', 'September', 'October',
231 'November', 'December')[(localtime)[4]] .
232 " " . ((localtime)[5]+1900);
234 # Essentially these are globals
235 # They probably want to be tidied up made more localised or summat.
236 # CAVEAT EMPTOR! Some of the others I localised may not want to be which
237 # could cause "use of undefined value" or other bugs.
238 my ($function, %function_table,%parametertypes,$declaration_purpose);
239 my ($type,$declaration_name,$return_type);
240 my ($newsection,$newcontents,$prototype,$filelist, $brcount, %source_map);
242 # Generated docbook code is inserted in a template at a point where
243 # docbook v3.1 requires a non-zero sequence of RefEntry's; see:
244 # http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
245 # We keep track of number of generated entries and generate a dummy
246 # if needs be to ensure the expanded template can be postprocessed
248 my $section_counter = 0;
254 # 1 - looking for function name
255 # 2 - scanning field start.
256 # 3 - scanning prototype.
257 # 4 - documentation block
261 #declaration types: can be
262 # 'function', 'struct', 'union', 'enum', 'typedef'
265 my $doc_special = "\@\%\$\&";
267 my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
269 my $doc_com = '\s*\*\s*';
270 my $doc_decl = $doc_com.'(\w+)';
271 my $doc_sect = $doc_com.'(['.$doc_special.']?[\w\s]+):(.*)';
272 my $doc_content = $doc_com.'(.*)';
273 my $doc_block = $doc_com.'DOC:\s*(.*)?';
282 my $section_default = "Description"; # default section
283 my $section_intro = "Introduction";
284 my $section = $section_default;
285 my $section_context = "Context";
287 my $undescribed = "-- undescribed --";
291 while ($ARGV[0] =~ m/^-(.*)/) {
292 my $cmd = shift @ARGV;
293 if ($cmd eq "-html") {
294 $output_mode = "html";
295 %highlights = %highlights_html;
296 $blankline = $blankline_html;
297 } elsif ($cmd eq "-man") {
298 $output_mode = "man";
299 %highlights = %highlights_man;
300 $blankline = $blankline_man;
301 } elsif ($cmd eq "-text") {
302 $output_mode = "text";
303 %highlights = %highlights_text;
304 $blankline = $blankline_text;
305 } elsif ($cmd eq "-docbook") {
306 $output_mode = "xml";
307 %highlights = %highlights_xml;
308 $blankline = $blankline_xml;
309 } elsif ($cmd eq "-gnome") {
310 $output_mode = "gnome";
311 %highlights = %highlights_gnome;
312 $blankline = $blankline_gnome;
313 } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document
314 $modulename = shift @ARGV;
315 } elsif ($cmd eq "-function") { # to only output specific functions
317 $function = shift @ARGV;
318 $function_table{$function} = 1;
319 } elsif ($cmd eq "-nofunction") { # to only output specific functions
321 $function = shift @ARGV;
322 $function_table{$function} = 1;
323 } elsif ($cmd eq "-v") {
325 } elsif (($cmd eq "-h") || ($cmd eq "--help")) {
327 } elsif ($cmd eq '-filelist') {
328 $filelist = shift @ARGV;
332 # get kernel version from env
333 sub get_kernel_version() {
336 if (defined($ENV{'KERNELVERSION'})) {
337 $version = $ENV{'KERNELVERSION'};
341 my $kernelversion = get_kernel_version();
343 # generate a sequence of code that will splice in highlighting information
344 # using the s// operator.
345 my $dohighlight = "";
346 foreach my $pattern (keys %highlights) {
347 # print STDERR "scanning pattern:$pattern, highlight:($highlights{$pattern})\n";
348 $dohighlight .= "\$contents =~ s:$pattern:$highlights{$pattern}:gs;\n";
352 # dumps section contents to arrays/hashes intended for that purpose.
356 my $contents = join "\n", @_;
358 if ($name =~ m/$type_constant/) {
360 # print STDERR "constant section '$1' = '$contents'\n";
361 $constants{$name} = $contents;
362 } elsif ($name =~ m/$type_param/) {
363 # print STDERR "parameter def '$1' = '$contents'\n";
365 $parameterdescs{$name} = $contents;
367 # print STDERR "other section '$name' = '$contents'\n";
368 $sections{$name} = $contents;
369 push @sectionlist, $name;
376 # parameterdescs, a hash.
377 # function => "function name"
378 # parameterlist => @list of parameters
379 # parameterdescs => %parameter descriptions
380 # sectionlist => @list of sections
381 # sections => %section descriptions
384 sub output_highlight {
385 my $contents = join "\n",@_;
389 # if (!defined $contents) {
391 # confess "output_highlight got called with no args?\n";
394 # print STDERR "contents b4:$contents\n";
397 if ($output_mode eq "html") {
398 $contents =~ s/\\\\//;
400 # print STDERR "contents af:$contents\n";
402 foreach $line (split "\n", $contents) {
404 print $lineprefix, $blankline;
406 $line =~ s/\\\\\\/\&/g;
407 print $lineprefix, $line;
413 #output sections in html
414 sub output_section_html(%) {
418 foreach $section (@{$args{'sectionlist'}}) {
419 print "<h3>$section</h3>\n";
420 print "<blockquote>\n";
421 output_highlight($args{'sections'}{$section});
422 print "</blockquote>\n";
426 # output enum in html
427 sub output_enum_html(%) {
431 print "<h2>enum ".$args{'enum'}."</h2>\n";
433 print "<b>enum ".$args{'enum'}."</b> {<br>\n";
435 foreach $parameter (@{$args{'parameterlist'}}) {
436 print " <b>".$parameter."</b>";
437 if ($count != $#{$args{'parameterlist'}}) {
445 print "<h3>Constants</h3>\n";
447 foreach $parameter (@{$args{'parameterlist'}}) {
448 print "<dt><b>".$parameter."</b>\n";
450 output_highlight($args{'parameterdescs'}{$parameter});
453 output_section_html(@_);
457 # output typedef in html
458 sub output_typedef_html(%) {
462 print "<h2>typedef ".$args{'typedef'}."</h2>\n";
464 print "<b>typedef ".$args{'typedef'}."</b>\n";
465 output_section_html(@_);
469 # output struct in html
470 sub output_struct_html(%) {
474 print "<h2>".$args{'type'}." ".$args{'struct'}. " - " .$args{'purpose'}."</h2>\n";
475 print "<b>".$args{'type'}." ".$args{'struct'}."</b> {<br>\n";
476 foreach $parameter (@{$args{'parameterlist'}}) {
477 if ($parameter =~ /^#/) {
478 print "$parameter<br>\n";
481 my $parameter_name = $parameter;
482 $parameter_name =~ s/\[.*//;
484 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
485 $type = $args{'parametertypes'}{$parameter};
486 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
487 # pointer-to-function
488 print " <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>\n";
489 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
491 print " <i>$1</i> <b>$parameter</b>$2;<br>\n";
493 print " <i>$type</i> <b>$parameter</b>;<br>\n";
498 print "<h3>Members</h3>\n";
500 foreach $parameter (@{$args{'parameterlist'}}) {
501 ($parameter =~ /^#/) && next;
503 my $parameter_name = $parameter;
504 $parameter_name =~ s/\[.*//;
506 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
507 print "<dt><b>".$parameter."</b>\n";
509 output_highlight($args{'parameterdescs'}{$parameter_name});
512 output_section_html(@_);
516 # output function in html
517 sub output_function_html(%) {
519 my ($parameter, $section);
522 print "<h2>" .$args{'function'}." - ".$args{'purpose'}."</h2>\n";
523 print "<i>".$args{'functiontype'}."</i>\n";
524 print "<b>".$args{'function'}."</b>\n";
527 foreach $parameter (@{$args{'parameterlist'}}) {
528 $type = $args{'parametertypes'}{$parameter};
529 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
530 # pointer-to-function
531 print "<i>$1</i><b>$parameter</b>) <i>($2)</i>";
533 print "<i>".$type."</i> <b>".$parameter."</b>";
535 if ($count != $#{$args{'parameterlist'}}) {
542 print "<h3>Arguments</h3>\n";
544 foreach $parameter (@{$args{'parameterlist'}}) {
545 my $parameter_name = $parameter;
546 $parameter_name =~ s/\[.*//;
548 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
549 print "<dt><b>".$parameter."</b>\n";
551 output_highlight($args{'parameterdescs'}{$parameter_name});
554 output_section_html(@_);
558 # output intro in html
559 sub output_intro_html(%) {
561 my ($parameter, $section);
564 foreach $section (@{$args{'sectionlist'}}) {
565 print "<h3>$section</h3>\n";
567 output_highlight($args{'sections'}{$section});
573 sub output_section_xml(%) {
576 # print out each section
578 foreach $section (@{$args{'sectionlist'}}) {
579 print "<refsect1>\n";
580 print "<title>$section</title>\n";
581 if ($section =~ m/EXAMPLE/i) {
582 print "<informalexample><programlisting>\n";
586 output_highlight($args{'sections'}{$section});
587 if ($section =~ m/EXAMPLE/i) {
588 print "</programlisting></informalexample>\n";
592 print "</refsect1>\n";
596 # output function in XML DocBook
597 sub output_function_xml(%) {
599 my ($parameter, $section);
603 $id = "API-".$args{'function'};
604 $id =~ s/[^A-Za-z0-9]/-/g;
606 print "<refentry id=\"$id\">\n";
607 print "<refentryinfo>\n";
608 print " <title>LINUX</title>\n";
609 print " <productname>Kernel Hackers Manual</productname>\n";
610 print " <date>$man_date</date>\n";
611 print "</refentryinfo>\n";
613 print " <refentrytitle><phrase>".$args{'function'}."</phrase></refentrytitle>\n";
614 print " <manvolnum>9</manvolnum>\n";
615 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
616 print "</refmeta>\n";
617 print "<refnamediv>\n";
618 print " <refname>".$args{'function'}."</refname>\n";
619 print " <refpurpose>\n";
621 output_highlight ($args{'purpose'});
622 print " </refpurpose>\n";
623 print "</refnamediv>\n";
625 print "<refsynopsisdiv>\n";
626 print " <title>Synopsis</title>\n";
627 print " <funcsynopsis><funcprototype>\n";
628 print " <funcdef>".$args{'functiontype'}." ";
629 print "<function>".$args{'function'}." </function></funcdef>\n";
632 if ($#{$args{'parameterlist'}} >= 0) {
633 foreach $parameter (@{$args{'parameterlist'}}) {
634 $type = $args{'parametertypes'}{$parameter};
635 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
636 # pointer-to-function
637 print " <paramdef>$1<parameter>$parameter</parameter>)\n";
638 print " <funcparams>$2</funcparams></paramdef>\n";
640 print " <paramdef>".$type;
641 print " <parameter>$parameter</parameter></paramdef>\n";
647 print " </funcprototype></funcsynopsis>\n";
648 print "</refsynopsisdiv>\n";
651 print "<refsect1>\n <title>Arguments</title>\n";
652 if ($#{$args{'parameterlist'}} >= 0) {
653 print " <variablelist>\n";
654 foreach $parameter (@{$args{'parameterlist'}}) {
655 my $parameter_name = $parameter;
656 $parameter_name =~ s/\[.*//;
658 print " <varlistentry>\n <term><parameter>$parameter</parameter></term>\n";
659 print " <listitem>\n <para>\n";
661 output_highlight($args{'parameterdescs'}{$parameter_name});
662 print " </para>\n </listitem>\n </varlistentry>\n";
664 print " </variablelist>\n";
666 print " <para>\n None\n </para>\n";
668 print "</refsect1>\n";
670 output_section_xml(@_);
671 print "</refentry>\n\n";
674 # output struct in XML DocBook
675 sub output_struct_xml(%) {
677 my ($parameter, $section);
680 $id = "API-struct-".$args{'struct'};
681 $id =~ s/[^A-Za-z0-9]/-/g;
683 print "<refentry id=\"$id\">\n";
684 print "<refentryinfo>\n";
685 print " <title>LINUX</title>\n";
686 print " <productname>Kernel Hackers Manual</productname>\n";
687 print " <date>$man_date</date>\n";
688 print "</refentryinfo>\n";
690 print " <refentrytitle><phrase>".$args{'type'}." ".$args{'struct'}."</phrase></refentrytitle>\n";
691 print " <manvolnum>9</manvolnum>\n";
692 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
693 print "</refmeta>\n";
694 print "<refnamediv>\n";
695 print " <refname>".$args{'type'}." ".$args{'struct'}."</refname>\n";
696 print " <refpurpose>\n";
698 output_highlight ($args{'purpose'});
699 print " </refpurpose>\n";
700 print "</refnamediv>\n";
702 print "<refsynopsisdiv>\n";
703 print " <title>Synopsis</title>\n";
704 print " <programlisting>\n";
705 print $args{'type'}." ".$args{'struct'}." {\n";
706 foreach $parameter (@{$args{'parameterlist'}}) {
707 if ($parameter =~ /^#/) {
708 print "$parameter\n";
712 my $parameter_name = $parameter;
713 $parameter_name =~ s/\[.*//;
715 defined($args{'parameterdescs'}{$parameter_name}) || next;
716 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
717 $type = $args{'parametertypes'}{$parameter};
718 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
719 # pointer-to-function
720 print " $1 $parameter) ($2);\n";
721 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
722 print " $1 $parameter$2;\n";
724 print " ".$type." ".$parameter.";\n";
728 print " </programlisting>\n";
729 print "</refsynopsisdiv>\n";
731 print " <refsect1>\n";
732 print " <title>Members</title>\n";
734 print " <variablelist>\n";
735 foreach $parameter (@{$args{'parameterlist'}}) {
736 ($parameter =~ /^#/) && next;
738 my $parameter_name = $parameter;
739 $parameter_name =~ s/\[.*//;
741 defined($args{'parameterdescs'}{$parameter_name}) || next;
742 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
743 print " <varlistentry>";
744 print " <term>$parameter</term>\n";
745 print " <listitem><para>\n";
746 output_highlight($args{'parameterdescs'}{$parameter_name});
747 print " </para></listitem>\n";
748 print " </varlistentry>\n";
750 print " </variablelist>\n";
751 print " </refsect1>\n";
753 output_section_xml(@_);
755 print "</refentry>\n\n";
758 # output enum in XML DocBook
759 sub output_enum_xml(%) {
761 my ($parameter, $section);
765 $id = "API-enum-".$args{'enum'};
766 $id =~ s/[^A-Za-z0-9]/-/g;
768 print "<refentry id=\"$id\">\n";
769 print "<refentryinfo>\n";
770 print " <title>LINUX</title>\n";
771 print " <productname>Kernel Hackers Manual</productname>\n";
772 print " <date>$man_date</date>\n";
773 print "</refentryinfo>\n";
775 print " <refentrytitle><phrase>enum ".$args{'enum'}."</phrase></refentrytitle>\n";
776 print " <manvolnum>9</manvolnum>\n";
777 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
778 print "</refmeta>\n";
779 print "<refnamediv>\n";
780 print " <refname>enum ".$args{'enum'}."</refname>\n";
781 print " <refpurpose>\n";
783 output_highlight ($args{'purpose'});
784 print " </refpurpose>\n";
785 print "</refnamediv>\n";
787 print "<refsynopsisdiv>\n";
788 print " <title>Synopsis</title>\n";
789 print " <programlisting>\n";
790 print "enum ".$args{'enum'}." {\n";
792 foreach $parameter (@{$args{'parameterlist'}}) {
794 if ($count != $#{$args{'parameterlist'}}) {
801 print " </programlisting>\n";
802 print "</refsynopsisdiv>\n";
804 print "<refsect1>\n";
805 print " <title>Constants</title>\n";
806 print " <variablelist>\n";
807 foreach $parameter (@{$args{'parameterlist'}}) {
808 my $parameter_name = $parameter;
809 $parameter_name =~ s/\[.*//;
811 print " <varlistentry>";
812 print " <term>$parameter</term>\n";
813 print " <listitem><para>\n";
814 output_highlight($args{'parameterdescs'}{$parameter_name});
815 print " </para></listitem>\n";
816 print " </varlistentry>\n";
818 print " </variablelist>\n";
819 print "</refsect1>\n";
821 output_section_xml(@_);
823 print "</refentry>\n\n";
826 # output typedef in XML DocBook
827 sub output_typedef_xml(%) {
829 my ($parameter, $section);
832 $id = "API-typedef-".$args{'typedef'};
833 $id =~ s/[^A-Za-z0-9]/-/g;
835 print "<refentry id=\"$id\">\n";
836 print "<refentryinfo>\n";
837 print " <title>LINUX</title>\n";
838 print " <productname>Kernel Hackers Manual</productname>\n";
839 print " <date>$man_date</date>\n";
840 print "</refentryinfo>\n";
842 print " <refentrytitle><phrase>typedef ".$args{'typedef'}."</phrase></refentrytitle>\n";
843 print " <manvolnum>9</manvolnum>\n";
844 print "</refmeta>\n";
845 print "<refnamediv>\n";
846 print " <refname>typedef ".$args{'typedef'}."</refname>\n";
847 print " <refpurpose>\n";
849 output_highlight ($args{'purpose'});
850 print " </refpurpose>\n";
851 print "</refnamediv>\n";
853 print "<refsynopsisdiv>\n";
854 print " <title>Synopsis</title>\n";
855 print " <synopsis>typedef ".$args{'typedef'}.";</synopsis>\n";
856 print "</refsynopsisdiv>\n";
858 output_section_xml(@_);
860 print "</refentry>\n\n";
863 # output in XML DocBook
864 sub output_intro_xml(%) {
866 my ($parameter, $section);
869 my $id = $args{'module'};
870 $id =~ s/[^A-Za-z0-9]/-/g;
872 # print out each section
874 foreach $section (@{$args{'sectionlist'}}) {
875 print "<refsect1>\n <title>$section</title>\n <para>\n";
876 if ($section =~ m/EXAMPLE/i) {
877 print "<example><para>\n";
879 output_highlight($args{'sections'}{$section});
880 if ($section =~ m/EXAMPLE/i) {
881 print "</para></example>\n";
883 print " </para>\n</refsect1>\n";
889 # output in XML DocBook
890 sub output_function_gnome {
892 my ($parameter, $section);
896 $id = $args{'module'}."-".$args{'function'};
897 $id =~ s/[^A-Za-z0-9]/-/g;
900 print " <title id=\"$id\">".$args{'function'}."</title>\n";
902 print " <funcsynopsis>\n";
903 print " <funcdef>".$args{'functiontype'}." ";
904 print "<function>".$args{'function'}." ";
905 print "</function></funcdef>\n";
908 if ($#{$args{'parameterlist'}} >= 0) {
909 foreach $parameter (@{$args{'parameterlist'}}) {
910 $type = $args{'parametertypes'}{$parameter};
911 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
912 # pointer-to-function
913 print " <paramdef>$1 <parameter>$parameter</parameter>)\n";
914 print " <funcparams>$2</funcparams></paramdef>\n";
916 print " <paramdef>".$type;
917 print " <parameter>$parameter</parameter></paramdef>\n";
923 print " </funcsynopsis>\n";
924 if ($#{$args{'parameterlist'}} >= 0) {
925 print " <informaltable pgwide=\"1\" frame=\"none\" role=\"params\">\n";
926 print "<tgroup cols=\"2\">\n";
927 print "<colspec colwidth=\"2*\">\n";
928 print "<colspec colwidth=\"8*\">\n";
930 foreach $parameter (@{$args{'parameterlist'}}) {
931 my $parameter_name = $parameter;
932 $parameter_name =~ s/\[.*//;
934 print " <row><entry align=\"right\"><parameter>$parameter</parameter></entry>\n";
937 output_highlight($args{'parameterdescs'}{$parameter_name});
938 print " </entry></row>\n";
940 print " </tbody></tgroup></informaltable>\n";
942 print " <para>\n None\n </para>\n";
945 # print out each section
947 foreach $section (@{$args{'sectionlist'}}) {
948 print "<simplesect>\n <title>$section</title>\n";
949 if ($section =~ m/EXAMPLE/i) {
950 print "<example><programlisting>\n";
954 output_highlight($args{'sections'}{$section});
956 if ($section =~ m/EXAMPLE/i) {
957 print "</programlisting></example>\n";
960 print " </simplesect>\n";
963 print "</sect2>\n\n";
967 # output function in man
968 sub output_function_man(%) {
970 my ($parameter, $section);
973 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
976 print $args{'function'}." \\- ".$args{'purpose'}."\n";
978 print ".SH SYNOPSIS\n";
979 if ($args{'functiontype'} ne "") {
980 print ".B \"".$args{'functiontype'}."\" ".$args{'function'}."\n";
982 print ".B \"".$args{'function'}."\n";
987 foreach my $parameter (@{$args{'parameterlist'}}) {
988 if ($count == $#{$args{'parameterlist'}}) {
991 $type = $args{'parametertypes'}{$parameter};
992 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
993 # pointer-to-function
994 print ".BI \"".$parenth.$1."\" ".$parameter." \") (".$2.")".$post."\"\n";
996 $type =~ s/([^\*])$/$1 /;
997 print ".BI \"".$parenth.$type."\" ".$parameter." \"".$post."\"\n";
1003 print ".SH ARGUMENTS\n";
1004 foreach $parameter (@{$args{'parameterlist'}}) {
1005 my $parameter_name = $parameter;
1006 $parameter_name =~ s/\[.*//;
1008 print ".IP \"".$parameter."\" 12\n";
1009 output_highlight($args{'parameterdescs'}{$parameter_name});
1011 foreach $section (@{$args{'sectionlist'}}) {
1012 print ".SH \"", uc $section, "\"\n";
1013 output_highlight($args{'sections'}{$section});
1018 # output enum in man
1019 sub output_enum_man(%) {
1020 my %args = %{$_[0]};
1021 my ($parameter, $section);
1024 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
1027 print "enum ".$args{'enum'}." \\- ".$args{'purpose'}."\n";
1029 print ".SH SYNOPSIS\n";
1030 print "enum ".$args{'enum'}." {\n";
1032 foreach my $parameter (@{$args{'parameterlist'}}) {
1033 print ".br\n.BI \" $parameter\"\n";
1034 if ($count == $#{$args{'parameterlist'}}) {
1044 print ".SH Constants\n";
1045 foreach $parameter (@{$args{'parameterlist'}}) {
1046 my $parameter_name = $parameter;
1047 $parameter_name =~ s/\[.*//;
1049 print ".IP \"".$parameter."\" 12\n";
1050 output_highlight($args{'parameterdescs'}{$parameter_name});
1052 foreach $section (@{$args{'sectionlist'}}) {
1053 print ".SH \"$section\"\n";
1054 output_highlight($args{'sections'}{$section});
1059 # output struct in man
1060 sub output_struct_man(%) {
1061 my %args = %{$_[0]};
1062 my ($parameter, $section);
1064 print ".TH \"$args{'module'}\" 9 \"".$args{'type'}." ".$args{'struct'}."\" \"$man_date\" \"API Manual\" LINUX\n";
1067 print $args{'type'}." ".$args{'struct'}." \\- ".$args{'purpose'}."\n";
1069 print ".SH SYNOPSIS\n";
1070 print $args{'type'}." ".$args{'struct'}." {\n.br\n";
1072 foreach my $parameter (@{$args{'parameterlist'}}) {
1073 if ($parameter =~ /^#/) {
1074 print ".BI \"$parameter\"\n.br\n";
1077 my $parameter_name = $parameter;
1078 $parameter_name =~ s/\[.*//;
1080 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1081 $type = $args{'parametertypes'}{$parameter};
1082 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1083 # pointer-to-function
1084 print ".BI \" ".$1."\" ".$parameter." \") (".$2.")"."\"\n;\n";
1085 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1087 print ".BI \" ".$1."\ \" ".$parameter.$2." \""."\"\n;\n";
1089 $type =~ s/([^\*])$/$1 /;
1090 print ".BI \" ".$type."\" ".$parameter." \""."\"\n;\n";
1096 print ".SH Members\n";
1097 foreach $parameter (@{$args{'parameterlist'}}) {
1098 ($parameter =~ /^#/) && next;
1100 my $parameter_name = $parameter;
1101 $parameter_name =~ s/\[.*//;
1103 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1104 print ".IP \"".$parameter."\" 12\n";
1105 output_highlight($args{'parameterdescs'}{$parameter_name});
1107 foreach $section (@{$args{'sectionlist'}}) {
1108 print ".SH \"$section\"\n";
1109 output_highlight($args{'sections'}{$section});
1114 # output typedef in man
1115 sub output_typedef_man(%) {
1116 my %args = %{$_[0]};
1117 my ($parameter, $section);
1119 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
1122 print "typedef ".$args{'typedef'}." \\- ".$args{'purpose'}."\n";
1124 foreach $section (@{$args{'sectionlist'}}) {
1125 print ".SH \"$section\"\n";
1126 output_highlight($args{'sections'}{$section});
1130 sub output_intro_man(%) {
1131 my %args = %{$_[0]};
1132 my ($parameter, $section);
1135 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
1137 foreach $section (@{$args{'sectionlist'}}) {
1138 print ".SH \"$section\"\n";
1139 output_highlight($args{'sections'}{$section});
1145 sub output_function_text(%) {
1146 my %args = %{$_[0]};
1147 my ($parameter, $section);
1151 print $args{'function'}." - ".$args{'purpose'}."\n";
1153 print "\nSynopsis:\n\n";
1154 if ($args{'functiontype'} ne "") {
1155 $start = $args{'functiontype'}." ".$args{'function'}." (";
1157 $start = $args{'function'}." (";
1162 foreach my $parameter (@{$args{'parameterlist'}}) {
1163 $type = $args{'parametertypes'}{$parameter};
1164 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1165 # pointer-to-function
1166 print $1.$parameter.") (".$2;
1168 print $type." ".$parameter;
1170 if ($count != $#{$args{'parameterlist'}}) {
1173 print " " x length($start);
1179 print "Arguments:\n\n";
1180 foreach $parameter (@{$args{'parameterlist'}}) {
1181 my $parameter_name = $parameter;
1182 $parameter_name =~ s/\[.*//;
1184 print $parameter."\n\t".$args{'parameterdescs'}{$parameter_name}."\n";
1186 output_section_text(@_);
1189 #output sections in text
1190 sub output_section_text(%) {
1191 my %args = %{$_[0]};
1195 foreach $section (@{$args{'sectionlist'}}) {
1196 print "$section:\n\n";
1197 output_highlight($args{'sections'}{$section});
1202 # output enum in text
1203 sub output_enum_text(%) {
1204 my %args = %{$_[0]};
1209 print "enum ".$args{'enum'}." - ".$args{'purpose'}."\n\n";
1210 print "enum ".$args{'enum'}." {\n";
1212 foreach $parameter (@{$args{'parameterlist'}}) {
1213 print "\t$parameter";
1214 if ($count != $#{$args{'parameterlist'}}) {
1222 print "Constants:\n\n";
1223 foreach $parameter (@{$args{'parameterlist'}}) {
1224 print "$parameter\n\t";
1225 print $args{'parameterdescs'}{$parameter}."\n";
1228 output_section_text(@_);
1231 # output typedef in text
1232 sub output_typedef_text(%) {
1233 my %args = %{$_[0]};
1236 print "Typedef:\n\n";
1238 print "typedef ".$args{'typedef'}." - ".$args{'purpose'}."\n";
1239 output_section_text(@_);
1242 # output struct as text
1243 sub output_struct_text(%) {
1244 my %args = %{$_[0]};
1247 print $args{'type'}." ".$args{'struct'}." - ".$args{'purpose'}."\n\n";
1248 print $args{'type'}." ".$args{'struct'}." {\n";
1249 foreach $parameter (@{$args{'parameterlist'}}) {
1250 if ($parameter =~ /^#/) {
1251 print "$parameter\n";
1255 my $parameter_name = $parameter;
1256 $parameter_name =~ s/\[.*//;
1258 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1259 $type = $args{'parametertypes'}{$parameter};
1260 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1261 # pointer-to-function
1262 print "\t$1 $parameter) ($2);\n";
1263 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1264 print "\t$1 $parameter$2;\n";
1266 print "\t".$type." ".$parameter.";\n";
1271 print "Members:\n\n";
1272 foreach $parameter (@{$args{'parameterlist'}}) {
1273 ($parameter =~ /^#/) && next;
1275 my $parameter_name = $parameter;
1276 $parameter_name =~ s/\[.*//;
1278 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1279 print "$parameter\n\t";
1280 print $args{'parameterdescs'}{$parameter_name}."\n";
1283 output_section_text(@_);
1286 sub output_intro_text(%) {
1287 my %args = %{$_[0]};
1288 my ($parameter, $section);
1290 foreach $section (@{$args{'sectionlist'}}) {
1291 print " $section:\n";
1293 output_highlight($args{'sections'}{$section});
1298 # generic output function for all types (function, struct/union, typedef, enum);
1299 # calls the generated, variable output_ function name based on
1300 # functype and output_mode
1301 sub output_declaration {
1304 my $functype = shift;
1305 my $func = "output_${functype}_$output_mode";
1306 if (($function_only==0) ||
1307 ( $function_only == 1 && defined($function_table{$name})) ||
1308 ( $function_only == 2 && !defined($function_table{$name})))
1316 # generic output function - calls the right one based on current output mode.
1319 my $func = "output_intro_".$output_mode;
1325 # takes a declaration (struct, union, enum, typedef) and
1326 # invokes the right handler. NOT called for functions.
1327 sub dump_declaration($$) {
1329 my ($prototype, $file) = @_;
1330 my $func = "dump_".$decl_type;
1334 sub dump_union($$) {
1338 sub dump_struct($$) {
1342 if ($x =~/(struct|union)\s+(\w+)\s*{(.*)}/) {
1343 $declaration_name = $2;
1346 # ignore embedded structs or unions
1347 $members =~ s/{.*?}//g;
1349 # ignore members marked private:
1350 $members =~ s/\/\*.*?private:.*?public:.*?\*\///gos;
1351 $members =~ s/\/\*.*?private:.*//gos;
1353 $members =~ s/\/\*.*?\*\///gos;
1355 create_parameterlist($members, ';', $file);
1357 output_declaration($declaration_name,
1359 {'struct' => $declaration_name,
1360 'module' => $modulename,
1361 'parameterlist' => \@parameterlist,
1362 'parameterdescs' => \%parameterdescs,
1363 'parametertypes' => \%parametertypes,
1364 'sectionlist' => \@sectionlist,
1365 'sections' => \%sections,
1366 'purpose' => $declaration_purpose,
1367 'type' => $decl_type
1371 print STDERR "Error(${file}:$.): Cannot parse struct or union!\n";
1380 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1381 if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
1382 $declaration_name = $1;
1385 foreach my $arg (split ',', $members) {
1386 $arg =~ s/^\s*(\w+).*/$1/;
1387 push @parameterlist, $arg;
1388 if (!$parameterdescs{$arg}) {
1389 $parameterdescs{$arg} = $undescribed;
1390 print STDERR "Warning(${file}:$.): Enum value '$arg' ".
1391 "not described in enum '$declaration_name'\n";
1396 output_declaration($declaration_name,
1398 {'enum' => $declaration_name,
1399 'module' => $modulename,
1400 'parameterlist' => \@parameterlist,
1401 'parameterdescs' => \%parameterdescs,
1402 'sectionlist' => \@sectionlist,
1403 'sections' => \%sections,
1404 'purpose' => $declaration_purpose
1408 print STDERR "Error(${file}:$.): Cannot parse enum!\n";
1413 sub dump_typedef($$) {
1417 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1418 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1419 $x =~ s/\(*.\)\s*;$/;/;
1420 $x =~ s/\[*.\]\s*;$/;/;
1423 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1424 $declaration_name = $1;
1426 output_declaration($declaration_name,
1428 {'typedef' => $declaration_name,
1429 'module' => $modulename,
1430 'sectionlist' => \@sectionlist,
1431 'sections' => \%sections,
1432 'purpose' => $declaration_purpose
1436 print STDERR "Error(${file}:$.): Cannot parse typedef!\n";
1441 sub create_parameterlist($$$) {
1443 my $splitter = shift;
1448 # temporarily replace commas inside function pointer definition
1449 while ($args =~ /(\([^\),]+),/) {
1450 $args =~ s/(\([^\),]+),/$1#/g;
1453 foreach my $arg (split($splitter, $args)) {
1455 $arg =~ s/\/\*.*\*\///;
1456 # strip leading/trailing spaces
1462 # Treat preprocessor directive as a typeless variable just to fill
1463 # corresponding data structures "correctly". Catch it later in
1465 push_parameter($arg, "", $file);
1466 } elsif ($arg =~ m/\(.*\*/) {
1467 # pointer-to-function
1469 $arg =~ m/[^\(]+\(\*\s*([^\)]+)\)/;
1472 $type =~ s/([^\(]+\(\*)$param/$1/;
1473 push_parameter($param, $type, $file);
1475 $arg =~ s/\s*:\s*/:/g;
1476 $arg =~ s/\s*\[/\[/g;
1478 my @args = split('\s*,\s*', $arg);
1479 if ($args[0] =~ m/\*/) {
1480 $args[0] =~ s/(\*+)\s*/ $1/;
1484 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1486 push(@first_arg, split('\s+', $1));
1487 push(@first_arg, $2);
1489 @first_arg = split('\s+', shift @args);
1492 unshift(@args, pop @first_arg);
1493 $type = join " ", @first_arg;
1495 foreach $param (@args) {
1496 if ($param =~ m/^(\*+)\s*(.*)/) {
1497 push_parameter($2, "$type $1", $file);
1499 elsif ($param =~ m/(.*?):(\d+)/) {
1500 push_parameter($1, "$type:$2", $file)
1503 push_parameter($param, $type, $file);
1510 sub push_parameter($$$) {
1515 if (($anon_struct_union == 1) && ($type eq "") &&
1517 return; # ignore the ending }; from anon. struct/union
1520 $anon_struct_union = 0;
1521 my $param_name = $param;
1522 $param_name =~ s/\[.*//;
1524 if ($type eq "" && $param =~ /\.\.\.$/)
1527 $parameterdescs{$param} = "variable arguments";
1529 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1533 $parameterdescs{void} = "no arguments";
1535 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1536 # handle unnamed (anonymous) union or struct:
1539 $param = "{unnamed_" . $param . "}";
1540 $parameterdescs{$param} = "anonymous\n";
1541 $anon_struct_union = 1;
1544 # warn if parameter has no description
1545 # (but ignore ones starting with # as these are not parameters
1546 # but inline preprocessor statements);
1547 # also ignore unnamed structs/unions;
1548 if (!$anon_struct_union) {
1549 if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) {
1551 $parameterdescs{$param_name} = $undescribed;
1553 if (($type eq 'function') || ($type eq 'enum')) {
1554 print STDERR "Warning(${file}:$.): Function parameter ".
1555 "or member '$param' not " .
1556 "described in '$declaration_name'\n";
1558 print STDERR "Warning(${file}:$.):".
1559 " No description found for parameter '$param'\n";
1564 push @parameterlist, $param;
1565 $parametertypes{$param} = $type;
1569 # takes a function prototype and the name of the current file being
1570 # processed and spits out all the details stored in the global
1572 sub dump_function($$) {
1573 my $prototype = shift;
1576 $prototype =~ s/^static +//;
1577 $prototype =~ s/^extern +//;
1578 $prototype =~ s/^fastcall +//;
1579 $prototype =~ s/^asmlinkage +//;
1580 $prototype =~ s/^inline +//;
1581 $prototype =~ s/^__inline__ +//;
1582 $prototype =~ s/^__inline +//;
1583 $prototype =~ s/^__always_inline +//;
1584 $prototype =~ s/^noinline +//;
1585 $prototype =~ s/__devinit +//;
1586 $prototype =~ s/^#define\s+//; #ak added
1587 $prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//;
1589 # Yes, this truly is vile. We are looking for:
1590 # 1. Return type (may be nothing if we're looking at a macro)
1592 # 3. Function parameters.
1594 # All the while we have to watch out for function pointer parameters
1595 # (which IIRC is what the two sections are for), C types (these
1596 # regexps don't even start to express all the possibilities), and
1599 # If you mess with these regexps, it's a good idea to check that
1600 # the following functions' documentation still comes out right:
1601 # - parport_register_device (function pointer parameters)
1602 # - atomic_set (macro)
1603 # - pci_match_device, __copy_to_user (long return type)
1605 if ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1606 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1607 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1608 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1609 $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1610 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1611 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1612 $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1613 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1614 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1615 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1616 $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1617 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1618 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1619 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1620 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1621 $prototype =~ m/^(\w+\s+\w+\s*\*\s*\w+\s*\*\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) {
1623 $declaration_name = $2;
1626 create_parameterlist($args, ',', $file);
1628 print STDERR "Error(${file}:$.): cannot understand prototype: '$prototype'\n";
1633 output_declaration($declaration_name,
1635 {'function' => $declaration_name,
1636 'module' => $modulename,
1637 'functiontype' => $return_type,
1638 'parameterlist' => \@parameterlist,
1639 'parameterdescs' => \%parameterdescs,
1640 'parametertypes' => \%parametertypes,
1641 'sectionlist' => \@sectionlist,
1642 'sections' => \%sections,
1643 'purpose' => $declaration_purpose
1647 sub process_file($);
1649 # Read the file that maps relative names to absolute names for
1650 # separate source and object directories and for shadow trees.
1651 if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
1652 my ($relname, $absname);
1653 while(<SOURCE_MAP>) {
1655 ($relname, $absname) = (split())[0..1];
1656 $relname =~ s:^/+::;
1657 $source_map{$relname} = $absname;
1663 open(FLIST,"<$filelist") or die "Can't open file list $filelist";
1674 if ($verbose && $errors) {
1675 print STDERR "$errors errors\n";
1677 if ($verbose && $warnings) {
1678 print STDERR "$warnings warnings\n";
1686 %parameterdescs = ();
1687 %parametertypes = ();
1688 @parameterlist = ();
1696 sub process_state3_function($$) {
1700 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#define/)) {
1703 elsif ($x =~ /([^\{]*)/) {
1706 if (($x =~ /\{/) || ($x =~ /\#define/) || ($x =~ /;/)) {
1707 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1708 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1709 $prototype =~ s@^\s+@@gos; # strip leading spaces
1710 dump_function($prototype,$file);
1715 sub process_state3_type($$) {
1719 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1720 $x =~ s@^\s+@@gos; # strip leading spaces
1721 $x =~ s@\s+$@@gos; # strip trailing spaces
1723 # To distinguish preprocessor directive from regular declaration later.
1728 if ( $x =~ /([^{};]*)([{};])(.*)/ ) {
1729 $prototype .= $1 . $2;
1730 ($2 eq '{') && $brcount++;
1731 ($2 eq '}') && $brcount--;
1732 if (($2 eq ';') && ($brcount == 0)) {
1733 dump_declaration($prototype,$file);
1745 # replace <, >, and &
1748 if (($output_mode eq "text") || ($output_mode eq "man")) {
1751 $text =~ s/\&/\\\\\\amp;/g;
1752 $text =~ s/\</\\\\\\lt;/g;
1753 $text =~ s/\>/\\\\\\gt;/g;
1757 sub process_file($) {
1762 my $initial_section_counter = $section_counter;
1764 if (defined($ENV{'SRCTREE'})) {
1765 $file = "$ENV{'SRCTREE'}" . "/" . "@_";
1770 if (defined($source_map{$file})) {
1771 $file = $source_map{$file};
1774 if (!open(IN,"<$file")) {
1775 print STDERR "Error: Cannot open file $file\n";
1780 $section_counter = 0;
1783 if (/$doc_start/o) {
1784 $state = 1; # next line is always the function name
1787 } elsif ($state == 1) { # this line is the function name (always)
1788 if (/$doc_block/o) {
1792 $section = $section_intro;
1797 elsif (/$doc_decl/o) {
1799 if (/\s*([\w\s]+?)\s*-/) {
1805 # strip leading/trailing/multiple spaces #RDD:T:
1810 $declaration_purpose = xml_escape($descr);
1812 $declaration_purpose = "";
1814 if ($identifier =~ m/^struct/) {
1815 $decl_type = 'struct';
1816 } elsif ($identifier =~ m/^union/) {
1817 $decl_type = 'union';
1818 } elsif ($identifier =~ m/^enum/) {
1819 $decl_type = 'enum';
1820 } elsif ($identifier =~ m/^typedef/) {
1821 $decl_type = 'typedef';
1823 $decl_type = 'function';
1827 print STDERR "Info(${file}:$.): Scanning doc for $identifier\n";
1830 print STDERR "Warning(${file}:$.): Cannot understand $_ on line $.",
1831 " - I thought it was a doc line\n";
1835 } elsif ($state == 2) { # look for head: lines, and include content
1840 if ($contents ne "") {
1841 if (!$in_doc_sect && $verbose) {
1842 print STDERR "Warning(${file}:$.): contents before sections\n";
1845 dump_section($section, xml_escape($contents));
1846 $section = $section_default;
1850 $contents = $newcontents;
1851 if ($contents ne "") {
1852 while ((substr($contents, 0, 1) eq " ") ||
1853 substr($contents, 0, 1) eq "\t") {
1854 $contents = substr($contents, 1);
1858 $section = $newsection;
1859 } elsif (/$doc_end/) {
1861 if ($contents ne "") {
1862 dump_section($section, xml_escape($contents));
1863 $section = $section_default;
1870 # print STDERR "end of doc comment, looking for prototype\n";
1871 } elsif (/$doc_content/) {
1872 # miguel-style comment kludge, look for blank lines after
1873 # @parameter line to signify start of description
1875 ($section =~ m/^@/ || $section eq $section_context)) {
1876 dump_section($section, xml_escape($contents));
1877 $section = $section_default;
1880 $contents .= $1."\n";
1883 # i dont know - bad line? ignore.
1884 print STDERR "Warning(${file}:$.): bad line: $_";
1887 } elsif ($state == 3) { # scanning for function '{' (end of prototype)
1888 if ($decl_type eq 'function') {
1889 process_state3_function($_, $file);
1891 process_state3_type($_, $file);
1893 } elsif ($state == 4) {
1894 # Documentation block
1896 dump_section($section, $contents);
1897 output_intro({'sectionlist' => \@sectionlist,
1898 'sections' => \%sections });
1902 %parameterdescs = ();
1903 %parametertypes = ();
1904 @parameterlist = ();
1909 $section = $section_intro;
1916 dump_section($section, $contents);
1917 output_intro({'sectionlist' => \@sectionlist,
1918 'sections' => \%sections });
1922 %parameterdescs = ();
1923 %parametertypes = ();
1924 @parameterlist = ();
1930 elsif (/$doc_content/)
1934 $contents .= $blankline;
1938 $contents .= $1 . "\n";
1943 if ($initial_section_counter == $section_counter) {
1944 print STDERR "Warning(${file}): no structured comments found\n";
1945 if ($output_mode eq "xml") {
1946 # The template wants at least one RefEntry here; make one.
1947 print "<refentry>\n";
1948 print " <refnamediv>\n";
1949 print " <refname>\n";
1951 print " </refname>\n";
1952 print " <refpurpose>\n";
1953 print " Document generation inconsistency\n";
1954 print " </refpurpose>\n";
1955 print " </refnamediv>\n";
1956 print " <refsect1>\n";
1959 print " </title>\n";
1960 print " <warning>\n";
1962 print " The template for this document tried to insert\n";
1963 print " the structured comment from the file\n";
1964 print " <filename>${file}</filename> at this point,\n";
1965 print " but none was found.\n";
1966 print " This dummy section is inserted to allow\n";
1967 print " generation to continue.\n";
1969 print " </warning>\n";
1970 print " </refsect1>\n";
1971 print "</refentry>\n";