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