Blame view
scripts/kernel-doc
60.6 KB
1da177e4c Linux-2.6.12-rc2 |
1 2 3 4 5 6 7 |
#!/usr/bin/perl -w use strict; ## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## ## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ## ## Copyright (C) 2001 Simon Huggins ## |
b9d97328e kernel-doc: clean... |
8 |
## Copyright (C) 2005-2009 Randy Dunlap ## |
1da177e4c Linux-2.6.12-rc2 |
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
## ## ## #define enhancements by Armin Kuster <akuster@mvista.com> ## ## Copyright (c) 2000 MontaVista Software, Inc. ## ## ## ## This software falls under the GNU General Public License. ## ## Please read the COPYING file for more information ## # w.o. 03-11-2000: added the '-filelist' option. # 18/01/2001 - Cleanups # Functions prototyped as foo(void) same as foo() # Stop eval'ing where we don't need to. # -- huggie@earth.li # 27/06/2001 - Allowed whitespace after initial "/**" and # allowed comments before function declarations. # -- Christian Kreibich <ck@whoop.org> # Still to do: # - add perldoc documentation # - Look more closely at some of the scarier bits :) # 26/05/2001 - Support for separate source and object trees. # Return error code. # Keith Owens <kaos@ocs.com.au> # 23/09/2001 - Added support for typedefs, structs, enums and unions # Support for Context section; can be terminated using empty line # Small fixes (like spaces vs. \s in regex) # -- Tim Jansen <tim@tjansen.de> # # This will read a 'c' file and scan for embedded comments in the # style of gnome comments (+minor extensions - see below). # # Note: This only supports 'c'. # usage: |
4b44595a7 kernel-doc: proce... |
49 |
# kernel-doc [ -docbook | -html | -text | -man ] [ -no-doc-sections ] |
1da177e4c Linux-2.6.12-rc2 |
50 51 52 53 54 55 |
# [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile # or # [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile # # Set output format using one of -docbook -html -text or -man. Default is man. # |
4b44595a7 kernel-doc: proce... |
56 57 58 |
# -no-doc-sections # Do not output DOC: sections # |
1da177e4c Linux-2.6.12-rc2 |
59 |
# -function funcname |
b112e0f73 kernel-doc: singl... |
60 61 |
# If set, then only generate documentation for the given function(s) or # DOC: section titles. All other functions and DOC: sections are ignored. |
1da177e4c Linux-2.6.12-rc2 |
62 63 |
# # -nofunction funcname |
b112e0f73 kernel-doc: singl... |
64 65 66 |
# If set, then only generate documentation for the other function(s)/DOC: # sections. Cannot be used together with -function (yes, that's a bug -- # perl hackers can fix it 8)) |
1da177e4c Linux-2.6.12-rc2 |
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# # c files - list of 'c' files to process # # All output goes to stdout, with errors to stderr. # # format of comments. # In the following table, (...)? signifies optional structure. # (...)* signifies 0 or more structure elements # /** # * function_name(:)? (- short description)? # (* @parameterx: (description of parameter x)?)* # (* a blank line)? # * (Description:)? (Description of function)? # * (section header: (section description)? )* # (*)?*/ # # So .. the trivial example would be: # # /** # * my_function |
b9d97328e kernel-doc: clean... |
88 |
# */ |
1da177e4c Linux-2.6.12-rc2 |
89 |
# |
891dcd2f7 [PATCH] kernel-do... |
90 |
# If the Description: header tag is omitted, then there must be a blank line |
1da177e4c Linux-2.6.12-rc2 |
91 92 93 94 95 96 |
# after the last parameter specification. # e.g. # /** # * my_function - does my stuff # * @my_arg: its mine damnit # * |
3c3b809e2 [PATCH] kernel-do... |
97 |
# * Does my stuff explained. |
1da177e4c Linux-2.6.12-rc2 |
98 99 100 101 102 103 |
# */ # # or, could also use: # /** # * my_function - does my stuff # * @my_arg: its mine damnit |
3c3b809e2 [PATCH] kernel-do... |
104 |
# * Description: Does my stuff explained. |
1da177e4c Linux-2.6.12-rc2 |
105 106 107 |
# */ # etc. # |
b9d97328e kernel-doc: clean... |
108 |
# Besides functions you can also write documentation for structs, unions, |
3c3b809e2 [PATCH] kernel-do... |
109 110 111 |
# enums and typedefs. Instead of the function name you must write the name # of the declaration; the struct/union/enum/typedef must always precede # the name. Nesting of declarations is not supported. |
1da177e4c Linux-2.6.12-rc2 |
112 113 114 115 116 117 |
# Use the argument mechanism to document members or constants. # e.g. # /** # * struct my_struct - short description # * @a: first member # * @b: second member |
3c3b809e2 [PATCH] kernel-do... |
118 |
# * |
1da177e4c Linux-2.6.12-rc2 |
119 120 121 122 123 |
# * Longer description # */ # struct my_struct { # int a; # int b; |
aeec46b97 [PATCH] DocBook: ... |
124 125 |
# /* private: */ # int c; |
1da177e4c Linux-2.6.12-rc2 |
126 127 128 |
# }; # # All descriptions can be multiline, except the short function description. |
3c3b809e2 [PATCH] kernel-do... |
129 130 131 |
# # You can also add additional sections. When documenting kernel functions you # should document the "Context:" of the function, e.g. whether the functions |
1da177e4c Linux-2.6.12-rc2 |
132 |
# can be called form interrupts. Unlike other sections you can end it with an |
3c3b809e2 [PATCH] kernel-do... |
133 134 |
# empty line. # Example-sections should contain the string EXAMPLE so that they are marked |
1da177e4c Linux-2.6.12-rc2 |
135 136 137 138 139 140 141 |
# appropriately in DocBook. # # Example: # /** # * user_function - function that can only be called in user context # * @a: some argument # * Context: !in_interrupt() |
3c3b809e2 [PATCH] kernel-do... |
142 |
# * |
1da177e4c Linux-2.6.12-rc2 |
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# * Some description # * Example: # * user_function(22); # */ # ... # # # All descriptive text is further processed, scanning for the following special # patterns, which are highlighted appropriately. # # 'funcname()' - function # '$ENVVAR' - environmental variable # '&struct_name' - name of a structure (up to two words including 'struct') # '@parameter' - name of a parameter # '%CONST' - name of a constant. my $errors = 0; my $warnings = 0; |
5f8c7c98a kernel-doc: fix u... |
161 |
my $anon_struct_union = 0; |
1da177e4c Linux-2.6.12-rc2 |
162 163 164 165 166 |
# match expressions used to find embedded type information my $type_constant = '\%([-_\w]+)'; my $type_func = '(\w+)\(\)'; my $type_param = '\@(\w+)'; |
3eb014a10 kernel-doc: html ... |
167 |
my $type_struct = '\&((struct\s*)*[_\w]+)'; |
6b5b55f6c kernel-doc: fix d... |
168 |
my $type_struct_xml = '\\&((struct\s*)*[_\w]+)'; |
1da177e4c Linux-2.6.12-rc2 |
169 170 171 172 173 174 175 176 |
my $type_env = '(\$\w+)'; # Output conversion substitutions. # One for each output format # these work fairly well my %highlights_html = ( $type_constant, "<i>\$1</i>", $type_func, "<b>\$1</b>", |
3eb014a10 kernel-doc: html ... |
177 178 |
$type_struct_xml, "<i>\$1</i>", $type_env, "<b><i>\$1</i></b>", |
1da177e4c Linux-2.6.12-rc2 |
179 |
$type_param, "<tt><b>\$1</b></tt>" ); |
6b5b55f6c kernel-doc: fix d... |
180 181 182 |
my $local_lt = "\\\\\\\\lt:"; my $local_gt = "\\\\\\\\gt:"; my $blankline_html = $local_lt . "p" . $local_gt; # was "<p>" |
1da177e4c Linux-2.6.12-rc2 |
183 184 185 186 187 |
# XML, docbook format my %highlights_xml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>", $type_constant, "<constant>\$1</constant>", $type_func, "<function>\$1</function>", |
5c98fc036 kernel-doc: fix x... |
188 |
$type_struct_xml, "<structname>\$1</structname>", |
1da177e4c Linux-2.6.12-rc2 |
189 190 |
$type_env, "<envar>\$1</envar>", $type_param, "<parameter>\$1</parameter>" ); |
5c98fc036 kernel-doc: fix x... |
191 192 |
my $blankline_xml = $local_lt . "/para" . $local_gt . $local_lt . "para" . $local_gt . " "; |
1da177e4c Linux-2.6.12-rc2 |
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 |
# gnome, docbook format my %highlights_gnome = ( $type_constant, "<replaceable class=\"option\">\$1</replaceable>", $type_func, "<function>\$1</function>", $type_struct, "<structname>\$1</structname>", $type_env, "<envar>\$1</envar>", $type_param, "<parameter>\$1</parameter>" ); my $blankline_gnome = "</para><para> "; # these are pretty rough my %highlights_man = ( $type_constant, "\$1", $type_func, "\\\\fB\$1\\\\fP", $type_struct, "\\\\fI\$1\\\\fP", $type_param, "\\\\fI\$1\\\\fP" ); my $blankline_man = ""; # text-mode my %highlights_text = ( $type_constant, "\$1", $type_func, "\$1", $type_struct, "\$1", $type_param, "\$1" ); my $blankline_text = ""; sub usage { |
4b44595a7 kernel-doc: proce... |
219 220 |
print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man ] [ -no-doc-sections ] "; |
1da177e4c Linux-2.6.12-rc2 |
221 222 223 224 225 226 |
print " [ -function funcname [ -function funcname ...] ] "; print " [ -nofunction funcname [ -nofunction funcname ...] ] "; print " c source file(s) > outputfile "; |
77cc23b8c kernel-doc: warn ... |
227 228 |
print " -v : verbose output, more warnings & other info listed "; |
1da177e4c Linux-2.6.12-rc2 |
229 230 231 232 |
exit 1; } # read arguments |
b9d97328e kernel-doc: clean... |
233 |
if ($#ARGV == -1) { |
1da177e4c Linux-2.6.12-rc2 |
234 235 236 237 238 |
usage(); } my $verbose = 0; my $output_mode = "man"; |
4b44595a7 kernel-doc: proce... |
239 |
my $no_doc_sections = 0; |
1da177e4c Linux-2.6.12-rc2 |
240 241 242 243 |
my %highlights = %highlights_man; my $blankline = $blankline_man; my $modulename = "Kernel API"; my $function_only = 0; |
3c3b809e2 [PATCH] kernel-do... |
244 245 246 |
my $man_date = ('January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December')[(localtime)[4]] . |
1da177e4c Linux-2.6.12-rc2 |
247 248 249 |
" " . ((localtime)[5]+1900); # Essentially these are globals |
b9d97328e kernel-doc: clean... |
250 251 |
# They probably want to be tidied up, made more localised or something. # CAVEAT EMPTOR! Some of the others I localised may not want to be, which |
1da177e4c Linux-2.6.12-rc2 |
252 |
# could cause "use of undefined value" or other bugs. |
b9d97328e kernel-doc: clean... |
253 254 255 |
my ($function, %function_table, %parametertypes, $declaration_purpose); my ($type, $declaration_name, $return_type); my ($newsection, $newcontents, $prototype, $filelist, $brcount, %source_map); |
1da177e4c Linux-2.6.12-rc2 |
256 |
|
bd0e88e51 kernel-doc: set v... |
257 258 259 |
if (defined($ENV{'KBUILD_VERBOSE'})) { $verbose = "$ENV{'KBUILD_VERBOSE'}"; } |
3c3b809e2 [PATCH] kernel-do... |
260 |
# Generated docbook code is inserted in a template at a point where |
1da177e4c Linux-2.6.12-rc2 |
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# docbook v3.1 requires a non-zero sequence of RefEntry's; see: # http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html # We keep track of number of generated entries and generate a dummy # if needs be to ensure the expanded template can be postprocessed # into html. my $section_counter = 0; my $lineprefix=""; # states # 0 - normal code # 1 - looking for function name # 2 - scanning field start. # 3 - scanning prototype. # 4 - documentation block my $state; |
850622dfa [PATCH] kernel-do... |
277 |
my $in_doc_sect; |
1da177e4c Linux-2.6.12-rc2 |
278 279 280 281 282 283 284 285 286 287 |
#declaration types: can be # 'function', 'struct', 'union', 'enum', 'typedef' my $decl_type; my $doc_special = "\@\%\$\&"; my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start. my $doc_end = '\*/'; my $doc_com = '\s*\*\s*'; |
b9d97328e kernel-doc: clean... |
288 289 290 291 |
my $doc_decl = $doc_com . '(\w+)'; my $doc_sect = $doc_com . '([' . $doc_special . ']?[\w\s]+):(.*)'; my $doc_content = $doc_com . '(.*)'; my $doc_block = $doc_com . 'DOC:\s*(.*)?'; |
1da177e4c Linux-2.6.12-rc2 |
292 293 294 295 296 297 |
my %constants; my %parameterdescs; my @parameterlist; my %sections; my @sectionlist; |
a1d94aa55 kernel-doc: check... |
298 299 |
my $sectcheck; my $struct_actual; |
1da177e4c Linux-2.6.12-rc2 |
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 |
my $contents = ""; my $section_default = "Description"; # default section my $section_intro = "Introduction"; my $section = $section_default; my $section_context = "Context"; my $undescribed = "-- undescribed --"; reset_state(); while ($ARGV[0] =~ m/^-(.*)/) { my $cmd = shift @ARGV; if ($cmd eq "-html") { $output_mode = "html"; %highlights = %highlights_html; $blankline = $blankline_html; } elsif ($cmd eq "-man") { $output_mode = "man"; %highlights = %highlights_man; $blankline = $blankline_man; } elsif ($cmd eq "-text") { $output_mode = "text"; %highlights = %highlights_text; $blankline = $blankline_text; } elsif ($cmd eq "-docbook") { $output_mode = "xml"; %highlights = %highlights_xml; $blankline = $blankline_xml; } elsif ($cmd eq "-gnome") { $output_mode = "gnome"; %highlights = %highlights_gnome; $blankline = $blankline_gnome; } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document $modulename = shift @ARGV; } elsif ($cmd eq "-function") { # to only output specific functions $function_only = 1; $function = shift @ARGV; $function_table{$function} = 1; } elsif ($cmd eq "-nofunction") { # to only output specific functions $function_only = 2; $function = shift @ARGV; $function_table{$function} = 1; } elsif ($cmd eq "-v") { $verbose = 1; } elsif (($cmd eq "-h") || ($cmd eq "--help")) { usage(); } elsif ($cmd eq '-filelist') { $filelist = shift @ARGV; |
4b44595a7 kernel-doc: proce... |
349 350 |
} elsif ($cmd eq '-no-doc-sections') { $no_doc_sections = 1; |
1da177e4c Linux-2.6.12-rc2 |
351 352 |
} } |
53f049fa5 kill warnings whe... |
353 354 |
# get kernel version from env sub get_kernel_version() { |
1b9bc22d7 kernel-doc: init ... |
355 |
my $version = 'unknown kernel version'; |
53f049fa5 kill warnings whe... |
356 357 358 359 360 361 |
if (defined($ENV{'KERNELVERSION'})) { $version = $ENV{'KERNELVERSION'}; } return $version; } |
0366299bd kernel-doc: small... |
362 |
my $kernelversion = get_kernel_version(); |
1da177e4c Linux-2.6.12-rc2 |
363 364 365 366 367 |
# generate a sequence of code that will splice in highlighting information # using the s// operator. my $dohighlight = ""; foreach my $pattern (keys %highlights) { |
3eb014a10 kernel-doc: html ... |
368 369 |
# print STDERR "scanning pattern:$pattern, highlight:($highlights{$pattern}) "; |
1da177e4c Linux-2.6.12-rc2 |
370 371 372 373 374 375 376 377 |
$dohighlight .= "\$contents =~ s:$pattern:$highlights{$pattern}:gs; "; } ## # dumps section contents to arrays/hashes intended for that purpose. # sub dump_section { |
94dc7ad55 kernel-doc: detec... |
378 |
my $file = shift; |
1da177e4c Linux-2.6.12-rc2 |
379 380 381 382 383 384 385 386 387 388 389 390 391 392 |
my $name = shift; my $contents = join " ", @_; if ($name =~ m/$type_constant/) { $name = $1; # print STDERR "constant section '$1' = '$contents' "; $constants{$name} = $contents; } elsif ($name =~ m/$type_param/) { # print STDERR "parameter def '$1' = '$contents' "; $name = $1; $parameterdescs{$name} = $contents; |
a1d94aa55 kernel-doc: check... |
393 |
$sectcheck = $sectcheck . $name . " "; |
ced69090c kernel-doc: handl... |
394 395 396 397 398 |
} elsif ($name eq "@\.\.\.") { # print STDERR "parameter def '...' = '$contents' "; $name = "..."; $parameterdescs{$name} = $contents; |
a1d94aa55 kernel-doc: check... |
399 |
$sectcheck = $sectcheck . $name . " "; |
1da177e4c Linux-2.6.12-rc2 |
400 401 402 |
} else { # print STDERR "other section '$name' = '$contents' "; |
94dc7ad55 kernel-doc: detec... |
403 404 405 406 407 |
if (defined($sections{$name}) && ($sections{$name} ne "")) { print STDERR "Error(${file}:$.): duplicate section name '$name' "; ++$errors; } |
1da177e4c Linux-2.6.12-rc2 |
408 409 410 411 412 413 |
$sections{$name} = $contents; push @sectionlist, $name; } } ## |
b112e0f73 kernel-doc: singl... |
414 415 416 |
# dump DOC: section after checking that it should go out # sub dump_doc_section { |
94dc7ad55 kernel-doc: detec... |
417 |
my $file = shift; |
b112e0f73 kernel-doc: singl... |
418 419 420 |
my $name = shift; my $contents = join " ", @_; |
4b44595a7 kernel-doc: proce... |
421 422 423 |
if ($no_doc_sections) { return; } |
b112e0f73 kernel-doc: singl... |
424 425 426 427 |
if (($function_only == 0) || ( $function_only == 1 && defined($function_table{$name})) || ( $function_only == 2 && !defined($function_table{$name}))) { |
94dc7ad55 kernel-doc: detec... |
428 |
dump_section($file, $name, $contents); |
b112e0f73 kernel-doc: singl... |
429 430 431 432 433 434 435 436 |
output_blockhead({'sectionlist' => \@sectionlist, 'sections' => \%sections, 'module' => $modulename, 'content-only' => ($function_only != 0), }); } } ## |
1da177e4c Linux-2.6.12-rc2 |
437 438 439 440 441 442 443 |
# output function # # parameterdescs, a hash. # function => "function name" # parameterlist => @list of parameters # parameterdescs => %parameter descriptions # sectionlist => @list of sections |
a21217daa [PATCH] kernel-do... |
444 |
# sections => %section descriptions |
3c3b809e2 [PATCH] kernel-do... |
445 |
# |
1da177e4c Linux-2.6.12-rc2 |
446 447 448 449 450 451 452 453 454 455 456 457 |
sub output_highlight { my $contents = join " ",@_; my $line; # DEBUG # if (!defined $contents) { # use Carp; # confess "output_highlight got called with no args? "; # } |
5c98fc036 kernel-doc: fix x... |
458 |
if ($output_mode eq "html" || $output_mode eq "xml") { |
6b5b55f6c kernel-doc: fix d... |
459 460 461 462 |
$contents = local_unescape($contents); # convert data read & converted thru xml_escape() into &xyz; format: $contents =~ s/\\\\\\/&/g; } |
3eb014a10 kernel-doc: html ... |
463 464 |
# print STDERR "contents b4:$contents "; |
1da177e4c Linux-2.6.12-rc2 |
465 466 |
eval $dohighlight; die $@ if $@; |
3eb014a10 kernel-doc: html ... |
467 468 |
# print STDERR "contents af:$contents "; |
1da177e4c Linux-2.6.12-rc2 |
469 470 |
foreach $line (split " ", $contents) { |
3c308798a scripts: kernel-d... |
471 |
if ($line eq ""){ |
6b5b55f6c kernel-doc: fix d... |
472 |
print $lineprefix, local_unescape($blankline); |
1da177e4c Linux-2.6.12-rc2 |
473 |
} else { |
3c308798a scripts: kernel-d... |
474 |
$line =~ s/\\\\\\/\&/g; |
cdccb316c kernel-doc: fix l... |
475 476 477 478 479 |
if ($output_mode eq "man" && substr($line, 0, 1) eq ".") { print "\\&$line"; } else { print $lineprefix, $line; } |
1da177e4c Linux-2.6.12-rc2 |
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 |
} print " "; } } #output sections in html sub output_section_html(%) { my %args = %{$_[0]}; my $section; foreach $section (@{$args{'sectionlist'}}) { print "<h3>$section</h3> "; print "<blockquote> "; output_highlight($args{'sections'}{$section}); print "</blockquote> "; |
3c3b809e2 [PATCH] kernel-do... |
499 |
} |
1da177e4c Linux-2.6.12-rc2 |
500 501 502 503 504 505 506 |
} # output enum in html sub output_enum_html(%) { my %args = %{$_[0]}; my ($parameter); my $count; |
b9d97328e kernel-doc: clean... |
507 508 |
print "<h2>enum " . $args{'enum'} . "</h2> "; |
1da177e4c Linux-2.6.12-rc2 |
509 |
|
b9d97328e kernel-doc: clean... |
510 511 |
print "<b>enum " . $args{'enum'} . "</b> {<br> "; |
1da177e4c Linux-2.6.12-rc2 |
512 513 |
$count = 0; foreach $parameter (@{$args{'parameterlist'}}) { |
b9d97328e kernel-doc: clean... |
514 |
print " <b>" . $parameter . "</b>"; |
1da177e4c Linux-2.6.12-rc2 |
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 |
if ($count != $#{$args{'parameterlist'}}) { $count++; print ", "; } print "<br>"; } print "};<br> "; print "<h3>Constants</h3> "; print "<dl> "; foreach $parameter (@{$args{'parameterlist'}}) { |
b9d97328e kernel-doc: clean... |
530 531 |
print "<dt><b>" . $parameter . "</b> "; |
1da177e4c Linux-2.6.12-rc2 |
532 533 534 535 536 537 538 539 540 |
print "<dd>"; output_highlight($args{'parameterdescs'}{$parameter}); } print "</dl> "; output_section_html(@_); print "<hr> "; } |
d28bee0c0 [PATCH] Doc/kerne... |
541 |
# output typedef in html |
1da177e4c Linux-2.6.12-rc2 |
542 543 544 545 |
sub output_typedef_html(%) { my %args = %{$_[0]}; my ($parameter); my $count; |
b9d97328e kernel-doc: clean... |
546 547 |
print "<h2>typedef " . $args{'typedef'} . "</h2> "; |
1da177e4c Linux-2.6.12-rc2 |
548 |
|
b9d97328e kernel-doc: clean... |
549 550 |
print "<b>typedef " . $args{'typedef'} . "</b> "; |
1da177e4c Linux-2.6.12-rc2 |
551 552 553 554 555 556 557 558 559 |
output_section_html(@_); print "<hr> "; } # output struct in html sub output_struct_html(%) { my %args = %{$_[0]}; my ($parameter); |
b9d97328e kernel-doc: clean... |
560 561 562 563 |
print "<h2>" . $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "</h2> "; print "<b>" . $args{'type'} . " " . $args{'struct'} . "</b> {<br> "; |
1da177e4c Linux-2.6.12-rc2 |
564 565 566 567 568 569 570 571 |
foreach $parameter (@{$args{'parameterlist'}}) { if ($parameter =~ /^#/) { print "$parameter<br> "; next; } my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
3c308798a scripts: kernel-d... |
572 |
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
1da177e4c Linux-2.6.12-rc2 |
573 574 575 |
$type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function |
3eb014a10 kernel-doc: html ... |
576 577 |
print " <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br> "; |
1da177e4c Linux-2.6.12-rc2 |
578 |
} elsif ($type =~ m/^(.*?)\s*(:.*)/) { |
3eb014a10 kernel-doc: html ... |
579 580 581 |
# bitfield print " <i>$1</i> <b>$parameter</b>$2;<br> "; |
1da177e4c Linux-2.6.12-rc2 |
582 |
} else { |
3eb014a10 kernel-doc: html ... |
583 584 |
print " <i>$type</i> <b>$parameter</b>;<br> "; |
1da177e4c Linux-2.6.12-rc2 |
585 586 587 588 589 590 591 592 593 594 595 596 597 598 |
} } print "};<br> "; print "<h3>Members</h3> "; print "<dl> "; foreach $parameter (@{$args{'parameterlist'}}) { ($parameter =~ /^#/) && next; my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
3c308798a scripts: kernel-d... |
599 |
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
b9d97328e kernel-doc: clean... |
600 601 |
print "<dt><b>" . $parameter . "</b> "; |
1da177e4c Linux-2.6.12-rc2 |
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 |
print "<dd>"; output_highlight($args{'parameterdescs'}{$parameter_name}); } print "</dl> "; output_section_html(@_); print "<hr> "; } # output function in html sub output_function_html(%) { my %args = %{$_[0]}; my ($parameter, $section); my $count; |
1da177e4c Linux-2.6.12-rc2 |
617 |
|
b9d97328e kernel-doc: clean... |
618 619 620 621 622 623 |
print "<h2>" . $args{'function'} . " - " . $args{'purpose'} . "</h2> "; print "<i>" . $args{'functiontype'} . "</i> "; print "<b>" . $args{'function'} . "</b> "; |
1da177e4c Linux-2.6.12-rc2 |
624 625 626 627 628 629 630 631 |
print "("; $count = 0; foreach $parameter (@{$args{'parameterlist'}}) { $type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function print "<i>$1</i><b>$parameter</b>) <i>($2)</i>"; } else { |
b9d97328e kernel-doc: clean... |
632 |
print "<i>" . $type . "</i> <b>" . $parameter . "</b>"; |
1da177e4c Linux-2.6.12-rc2 |
633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 |
} if ($count != $#{$args{'parameterlist'}}) { $count++; print ", "; } } print ") "; print "<h3>Arguments</h3> "; print "<dl> "; foreach $parameter (@{$args{'parameterlist'}}) { my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
3c308798a scripts: kernel-d... |
650 |
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
b9d97328e kernel-doc: clean... |
651 652 |
print "<dt><b>" . $parameter . "</b> "; |
1da177e4c Linux-2.6.12-rc2 |
653 654 655 656 657 658 659 660 661 |
print "<dd>"; output_highlight($args{'parameterdescs'}{$parameter_name}); } print "</dl> "; output_section_html(@_); print "<hr> "; } |
b112e0f73 kernel-doc: singl... |
662 663 |
# output DOC: block header in html sub output_blockhead_html(%) { |
1da177e4c Linux-2.6.12-rc2 |
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 |
my %args = %{$_[0]}; my ($parameter, $section); my $count; foreach $section (@{$args{'sectionlist'}}) { print "<h3>$section</h3> "; print "<ul> "; output_highlight($args{'sections'}{$section}); print "</ul> "; } print "<hr> "; } sub output_section_xml(%) { my %args = %{$_[0]}; |
3c3b809e2 [PATCH] kernel-do... |
683 |
my $section; |
1da177e4c Linux-2.6.12-rc2 |
684 685 686 |
# print out each section $lineprefix=" "; foreach $section (@{$args{'sectionlist'}}) { |
c73894c1e [PATCH] DocBook: ... |
687 688 689 690 |
print "<refsect1> "; print "<title>$section</title> "; |
1da177e4c Linux-2.6.12-rc2 |
691 |
if ($section =~ m/EXAMPLE/i) { |
c73894c1e [PATCH] DocBook: ... |
692 693 694 695 696 |
print "<informalexample><programlisting> "; } else { print "<para> "; |
1da177e4c Linux-2.6.12-rc2 |
697 698 699 |
} output_highlight($args{'sections'}{$section}); if ($section =~ m/EXAMPLE/i) { |
c73894c1e [PATCH] DocBook: ... |
700 701 702 703 704 |
print "</programlisting></informalexample> "; } else { print "</para> "; |
1da177e4c Linux-2.6.12-rc2 |
705 |
} |
c73894c1e [PATCH] DocBook: ... |
706 707 |
print "</refsect1> "; |
1da177e4c Linux-2.6.12-rc2 |
708 709 710 711 712 713 714 715 716 |
} } # output function in XML DocBook sub output_function_xml(%) { my %args = %{$_[0]}; my ($parameter, $section); my $count; my $id; |
b9d97328e kernel-doc: clean... |
717 |
$id = "API-" . $args{'function'}; |
1da177e4c Linux-2.6.12-rc2 |
718 |
$id =~ s/[^A-Za-z0-9]/-/g; |
5449bc941 [PATCH] DocBook/H... |
719 720 |
print "<refentry id=\"$id\"> "; |
8b0c2d989 [PATCH] DocBook: ... |
721 722 723 724 725 726 727 728 729 730 |
print "<refentryinfo> "; print " <title>LINUX</title> "; print " <productname>Kernel Hackers Manual</productname> "; print " <date>$man_date</date> "; print "</refentryinfo> "; |
1da177e4c Linux-2.6.12-rc2 |
731 732 |
print "<refmeta> "; |
b9d97328e kernel-doc: clean... |
733 734 |
print " <refentrytitle><phrase>" . $args{'function'} . "</phrase></refentrytitle> "; |
8b0c2d989 [PATCH] DocBook: ... |
735 736 |
print " <manvolnum>9</manvolnum> "; |
0366299bd kernel-doc: small... |
737 738 |
print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo> "; |
1da177e4c Linux-2.6.12-rc2 |
739 740 741 742 |
print "</refmeta> "; print "<refnamediv> "; |
b9d97328e kernel-doc: clean... |
743 744 |
print " <refname>" . $args{'function'} . "</refname> "; |
1da177e4c Linux-2.6.12-rc2 |
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 |
print " <refpurpose> "; print " "; output_highlight ($args{'purpose'}); print " </refpurpose> "; print "</refnamediv> "; print "<refsynopsisdiv> "; print " <title>Synopsis</title> "; print " <funcsynopsis><funcprototype> "; |
b9d97328e kernel-doc: clean... |
760 761 762 |
print " <funcdef>" . $args{'functiontype'} . " "; print "<function>" . $args{'function'} . " </function></funcdef> "; |
1da177e4c Linux-2.6.12-rc2 |
763 764 765 766 767 768 769 770 771 772 773 774 |
$count = 0; if ($#{$args{'parameterlist'}} >= 0) { foreach $parameter (@{$args{'parameterlist'}}) { $type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function print " <paramdef>$1<parameter>$parameter</parameter>) "; print " <funcparams>$2</funcparams></paramdef> "; } else { |
b9d97328e kernel-doc: clean... |
775 |
print " <paramdef>" . $type; |
1da177e4c Linux-2.6.12-rc2 |
776 777 778 779 780 |
print " <parameter>$parameter</parameter></paramdef> "; } } } else { |
6013d5445 [PATCH] DocBook: ... |
781 782 |
print " <void/> "; |
1da177e4c Linux-2.6.12-rc2 |
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 |
} print " </funcprototype></funcsynopsis> "; print "</refsynopsisdiv> "; # print parameters print "<refsect1> <title>Arguments</title> "; if ($#{$args{'parameterlist'}} >= 0) { print " <variablelist> "; foreach $parameter (@{$args{'parameterlist'}}) { my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; print " <varlistentry> <term><parameter>$parameter</parameter></term> "; print " <listitem> <para> "; $lineprefix=" "; output_highlight($args{'parameterdescs'}{$parameter_name}); print " </para> </listitem> </varlistentry> "; } print " </variablelist> "; } else { print " <para> None </para> "; } print "</refsect1> "; output_section_xml(@_); print "</refentry> "; } # output struct in XML DocBook sub output_struct_xml(%) { my %args = %{$_[0]}; my ($parameter, $section); my $id; |
b9d97328e kernel-doc: clean... |
835 |
$id = "API-struct-" . $args{'struct'}; |
1da177e4c Linux-2.6.12-rc2 |
836 |
$id =~ s/[^A-Za-z0-9]/-/g; |
5449bc941 [PATCH] DocBook/H... |
837 838 |
print "<refentry id=\"$id\"> "; |
8b0c2d989 [PATCH] DocBook: ... |
839 840 841 842 843 844 845 846 847 848 |
print "<refentryinfo> "; print " <title>LINUX</title> "; print " <productname>Kernel Hackers Manual</productname> "; print " <date>$man_date</date> "; print "</refentryinfo> "; |
1da177e4c Linux-2.6.12-rc2 |
849 850 |
print "<refmeta> "; |
b9d97328e kernel-doc: clean... |
851 852 |
print " <refentrytitle><phrase>" . $args{'type'} . " " . $args{'struct'} . "</phrase></refentrytitle> "; |
8b0c2d989 [PATCH] DocBook: ... |
853 854 |
print " <manvolnum>9</manvolnum> "; |
0366299bd kernel-doc: small... |
855 856 |
print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo> "; |
1da177e4c Linux-2.6.12-rc2 |
857 858 859 860 |
print "</refmeta> "; print "<refnamediv> "; |
b9d97328e kernel-doc: clean... |
861 862 |
print " <refname>" . $args{'type'} . " " . $args{'struct'} . "</refname> "; |
1da177e4c Linux-2.6.12-rc2 |
863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 |
print " <refpurpose> "; print " "; output_highlight ($args{'purpose'}); print " </refpurpose> "; print "</refnamediv> "; print "<refsynopsisdiv> "; print " <title>Synopsis</title> "; print " <programlisting> "; |
b9d97328e kernel-doc: clean... |
878 879 |
print $args{'type'} . " " . $args{'struct'} . " { "; |
1da177e4c Linux-2.6.12-rc2 |
880 881 882 883 884 885 886 887 888 889 890 |
foreach $parameter (@{$args{'parameterlist'}}) { if ($parameter =~ /^#/) { print "$parameter "; next; } my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; defined($args{'parameterdescs'}{$parameter_name}) || next; |
3c308798a scripts: kernel-d... |
891 |
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
1da177e4c Linux-2.6.12-rc2 |
892 893 894 895 896 897 |
$type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function print " $1 $parameter) ($2); "; } elsif ($type =~ m/^(.*?)\s*(:.*)/) { |
51f5a0c8f kernel-doc: strip... |
898 |
# bitfield |
1da177e4c Linux-2.6.12-rc2 |
899 900 901 |
print " $1 $parameter$2; "; } else { |
b9d97328e kernel-doc: clean... |
902 903 |
print " " . $type . " " . $parameter . "; "; |
1da177e4c Linux-2.6.12-rc2 |
904 905 906 907 908 909 910 911 912 913 914 915 |
} } print "};"; print " </programlisting> "; print "</refsynopsisdiv> "; print " <refsect1> "; print " <title>Members</title> "; |
39f00c087 kernel-doc: allow... |
916 |
if ($#{$args{'parameterlist'}} >= 0) { |
1da177e4c Linux-2.6.12-rc2 |
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 |
print " <variablelist> "; foreach $parameter (@{$args{'parameterlist'}}) { ($parameter =~ /^#/) && next; my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; defined($args{'parameterdescs'}{$parameter_name}) || next; ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; print " <varlistentry>"; print " <term>$parameter</term> "; print " <listitem><para> "; output_highlight($args{'parameterdescs'}{$parameter_name}); print " </para></listitem> "; print " </varlistentry> "; } print " </variablelist> "; |
39f00c087 kernel-doc: allow... |
940 941 942 943 944 945 |
} else { print " <para> None </para> "; } |
1da177e4c Linux-2.6.12-rc2 |
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 |
print " </refsect1> "; output_section_xml(@_); print "</refentry> "; } # output enum in XML DocBook sub output_enum_xml(%) { my %args = %{$_[0]}; my ($parameter, $section); my $count; my $id; |
b9d97328e kernel-doc: clean... |
962 |
$id = "API-enum-" . $args{'enum'}; |
1da177e4c Linux-2.6.12-rc2 |
963 |
$id =~ s/[^A-Za-z0-9]/-/g; |
5449bc941 [PATCH] DocBook/H... |
964 965 |
print "<refentry id=\"$id\"> "; |
8b0c2d989 [PATCH] DocBook: ... |
966 967 968 969 970 971 972 973 974 975 |
print "<refentryinfo> "; print " <title>LINUX</title> "; print " <productname>Kernel Hackers Manual</productname> "; print " <date>$man_date</date> "; print "</refentryinfo> "; |
1da177e4c Linux-2.6.12-rc2 |
976 977 |
print "<refmeta> "; |
b9d97328e kernel-doc: clean... |
978 979 |
print " <refentrytitle><phrase>enum " . $args{'enum'} . "</phrase></refentrytitle> "; |
8b0c2d989 [PATCH] DocBook: ... |
980 981 |
print " <manvolnum>9</manvolnum> "; |
0366299bd kernel-doc: small... |
982 983 |
print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo> "; |
1da177e4c Linux-2.6.12-rc2 |
984 985 986 987 |
print "</refmeta> "; print "<refnamediv> "; |
b9d97328e kernel-doc: clean... |
988 989 |
print " <refname>enum " . $args{'enum'} . "</refname> "; |
1da177e4c Linux-2.6.12-rc2 |
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
print " <refpurpose> "; print " "; output_highlight ($args{'purpose'}); print " </refpurpose> "; print "</refnamediv> "; print "<refsynopsisdiv> "; print " <title>Synopsis</title> "; print " <programlisting> "; |
b9d97328e kernel-doc: clean... |
1005 1006 |
print "enum " . $args{'enum'} . " { "; |
1da177e4c Linux-2.6.12-rc2 |
1007 1008 |
$count = 0; foreach $parameter (@{$args{'parameterlist'}}) { |
3c308798a scripts: kernel-d... |
1009 1010 |
print " $parameter"; if ($count != $#{$args{'parameterlist'}}) { |
1da177e4c Linux-2.6.12-rc2 |
1011 1012 |
$count++; print ","; |
3c308798a scripts: kernel-d... |
1013 |
} |
1da177e4c Linux-2.6.12-rc2 |
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 |
print " "; } print "};"; print " </programlisting> "; print "</refsynopsisdiv> "; print "<refsect1> "; |
3c3b809e2 [PATCH] kernel-do... |
1025 1026 |
print " <title>Constants</title> "; |
1da177e4c Linux-2.6.12-rc2 |
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 |
print " <variablelist> "; foreach $parameter (@{$args{'parameterlist'}}) { my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; print " <varlistentry>"; print " <term>$parameter</term> "; print " <listitem><para> "; output_highlight($args{'parameterdescs'}{$parameter_name}); print " </para></listitem> "; print " </varlistentry> "; } print " </variablelist> "; print "</refsect1> "; output_section_xml(@_); print "</refentry> "; } # output typedef in XML DocBook sub output_typedef_xml(%) { my %args = %{$_[0]}; my ($parameter, $section); my $id; |
b9d97328e kernel-doc: clean... |
1061 |
$id = "API-typedef-" . $args{'typedef'}; |
1da177e4c Linux-2.6.12-rc2 |
1062 |
$id =~ s/[^A-Za-z0-9]/-/g; |
5449bc941 [PATCH] DocBook/H... |
1063 1064 |
print "<refentry id=\"$id\"> "; |
8b0c2d989 [PATCH] DocBook: ... |
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 |
print "<refentryinfo> "; print " <title>LINUX</title> "; print " <productname>Kernel Hackers Manual</productname> "; print " <date>$man_date</date> "; print "</refentryinfo> "; |
1da177e4c Linux-2.6.12-rc2 |
1075 1076 |
print "<refmeta> "; |
b9d97328e kernel-doc: clean... |
1077 1078 |
print " <refentrytitle><phrase>typedef " . $args{'typedef'} . "</phrase></refentrytitle> "; |
8b0c2d989 [PATCH] DocBook: ... |
1079 1080 |
print " <manvolnum>9</manvolnum> "; |
1da177e4c Linux-2.6.12-rc2 |
1081 1082 1083 1084 |
print "</refmeta> "; print "<refnamediv> "; |
b9d97328e kernel-doc: clean... |
1085 1086 |
print " <refname>typedef " . $args{'typedef'} . "</refname> "; |
1da177e4c Linux-2.6.12-rc2 |
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 |
print " <refpurpose> "; print " "; output_highlight ($args{'purpose'}); print " </refpurpose> "; print "</refnamediv> "; print "<refsynopsisdiv> "; print " <title>Synopsis</title> "; |
b9d97328e kernel-doc: clean... |
1100 1101 |
print " <synopsis>typedef " . $args{'typedef'} . ";</synopsis> "; |
1da177e4c Linux-2.6.12-rc2 |
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 |
print "</refsynopsisdiv> "; output_section_xml(@_); print "</refentry> "; } # output in XML DocBook |
b112e0f73 kernel-doc: singl... |
1113 |
sub output_blockhead_xml(%) { |
1da177e4c Linux-2.6.12-rc2 |
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 |
my %args = %{$_[0]}; my ($parameter, $section); my $count; my $id = $args{'module'}; $id =~ s/[^A-Za-z0-9]/-/g; # print out each section $lineprefix=" "; foreach $section (@{$args{'sectionlist'}}) { |
b112e0f73 kernel-doc: singl... |
1124 1125 1126 1127 1128 |
if (!$args{'content-only'}) { print "<refsect1> <title>$section</title> "; } |
1da177e4c Linux-2.6.12-rc2 |
1129 1130 1131 |
if ($section =~ m/EXAMPLE/i) { print "<example><para> "; |
b112e0f73 kernel-doc: singl... |
1132 1133 1134 |
} else { print "<para> "; |
1da177e4c Linux-2.6.12-rc2 |
1135 1136 1137 1138 1139 |
} output_highlight($args{'sections'}{$section}); if ($section =~ m/EXAMPLE/i) { print "</para></example> "; |
b112e0f73 kernel-doc: singl... |
1140 1141 1142 1143 1144 1145 1146 |
} else { print "</para>"; } if (!$args{'content-only'}) { print " </refsect1> "; |
1da177e4c Linux-2.6.12-rc2 |
1147 |
} |
1da177e4c Linux-2.6.12-rc2 |
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 |
} print " "; } # output in XML DocBook sub output_function_gnome { my %args = %{$_[0]}; my ($parameter, $section); my $count; my $id; |
b9d97328e kernel-doc: clean... |
1161 |
$id = $args{'module'} . "-" . $args{'function'}; |
1da177e4c Linux-2.6.12-rc2 |
1162 1163 1164 1165 |
$id =~ s/[^A-Za-z0-9]/-/g; print "<sect2> "; |
b9d97328e kernel-doc: clean... |
1166 1167 |
print " <title id=\"$id\">" . $args{'function'} . "</title> "; |
1da177e4c Linux-2.6.12-rc2 |
1168 1169 1170 |
print " <funcsynopsis> "; |
b9d97328e kernel-doc: clean... |
1171 1172 |
print " <funcdef>" . $args{'functiontype'} . " "; print "<function>" . $args{'function'} . " "; |
1da177e4c Linux-2.6.12-rc2 |
1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 |
print "</function></funcdef> "; $count = 0; if ($#{$args{'parameterlist'}} >= 0) { foreach $parameter (@{$args{'parameterlist'}}) { $type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function print " <paramdef>$1 <parameter>$parameter</parameter>) "; print " <funcparams>$2</funcparams></paramdef> "; } else { |
b9d97328e kernel-doc: clean... |
1187 |
print " <paramdef>" . $type; |
1da177e4c Linux-2.6.12-rc2 |
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 |
print " <parameter>$parameter</parameter></paramdef> "; } } } else { print " <void> "; } print " </funcsynopsis> "; if ($#{$args{'parameterlist'}} >= 0) { print " <informaltable pgwide=\"1\" frame=\"none\" role=\"params\"> "; print "<tgroup cols=\"2\"> "; print "<colspec colwidth=\"2*\"> "; print "<colspec colwidth=\"8*\"> "; print "<tbody> "; foreach $parameter (@{$args{'parameterlist'}}) { my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; print " <row><entry align=\"right\"><parameter>$parameter</parameter></entry> "; print " <entry> "; $lineprefix=" "; output_highlight($args{'parameterdescs'}{$parameter_name}); print " </entry></row> "; } print " </tbody></tgroup></informaltable> "; } else { print " <para> None </para> "; } # print out each section $lineprefix=" "; foreach $section (@{$args{'sectionlist'}}) { print "<simplesect> <title>$section</title> "; if ($section =~ m/EXAMPLE/i) { print "<example><programlisting> "; } else { } print "<para> "; output_highlight($args{'sections'}{$section}); print "</para> "; if ($section =~ m/EXAMPLE/i) { print "</programlisting></example> "; } else { } print " </simplesect> "; } print "</sect2> "; } ## # output function in man sub output_function_man(%) { my %args = %{$_[0]}; my ($parameter, $section); my $count; print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX "; print ".SH NAME "; |
b9d97328e kernel-doc: clean... |
1273 1274 |
print $args{'function'} . " \\- " . $args{'purpose'} . " "; |
1da177e4c Linux-2.6.12-rc2 |
1275 1276 1277 |
print ".SH SYNOPSIS "; |
a21217daa [PATCH] kernel-do... |
1278 |
if ($args{'functiontype'} ne "") { |
b9d97328e kernel-doc: clean... |
1279 1280 |
print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . " "; |
a21217daa [PATCH] kernel-do... |
1281 |
} else { |
b9d97328e kernel-doc: clean... |
1282 1283 |
print ".B \"" . $args{'function'} . " "; |
a21217daa [PATCH] kernel-do... |
1284 |
} |
1da177e4c Linux-2.6.12-rc2 |
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 |
$count = 0; my $parenth = "("; my $post = ","; foreach my $parameter (@{$args{'parameterlist'}}) { if ($count == $#{$args{'parameterlist'}}) { $post = ");"; } $type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function |
b9d97328e kernel-doc: clean... |
1295 1296 |
print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\" "; |
1da177e4c Linux-2.6.12-rc2 |
1297 1298 |
} else { $type =~ s/([^\*])$/$1 /; |
b9d97328e kernel-doc: clean... |
1299 1300 |
print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\" "; |
1da177e4c Linux-2.6.12-rc2 |
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 |
} $count++; $parenth = ""; } print ".SH ARGUMENTS "; foreach $parameter (@{$args{'parameterlist'}}) { my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
b9d97328e kernel-doc: clean... |
1311 1312 |
print ".IP \"" . $parameter . "\" 12 "; |
1da177e4c Linux-2.6.12-rc2 |
1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 |
output_highlight($args{'parameterdescs'}{$parameter_name}); } foreach $section (@{$args{'sectionlist'}}) { print ".SH \"", uc $section, "\" "; output_highlight($args{'sections'}{$section}); } } ## # output enum in man sub output_enum_man(%) { my %args = %{$_[0]}; my ($parameter, $section); my $count; print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX "; print ".SH NAME "; |
b9d97328e kernel-doc: clean... |
1334 1335 |
print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . " "; |
1da177e4c Linux-2.6.12-rc2 |
1336 1337 1338 |
print ".SH SYNOPSIS "; |
b9d97328e kernel-doc: clean... |
1339 1340 |
print "enum " . $args{'enum'} . " { "; |
1da177e4c Linux-2.6.12-rc2 |
1341 1342 |
$count = 0; foreach my $parameter (@{$args{'parameterlist'}}) { |
3c308798a scripts: kernel-d... |
1343 1344 1345 |
print ".br .BI \" $parameter\" "; |
1da177e4c Linux-2.6.12-rc2 |
1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 |
if ($count == $#{$args{'parameterlist'}}) { print " }; "; last; } else { print ", .br "; } $count++; } print ".SH Constants "; foreach $parameter (@{$args{'parameterlist'}}) { my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
b9d97328e kernel-doc: clean... |
1365 1366 |
print ".IP \"" . $parameter . "\" 12 "; |
1da177e4c Linux-2.6.12-rc2 |
1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 |
output_highlight($args{'parameterdescs'}{$parameter_name}); } foreach $section (@{$args{'sectionlist'}}) { print ".SH \"$section\" "; output_highlight($args{'sections'}{$section}); } } ## # output struct in man sub output_struct_man(%) { my %args = %{$_[0]}; my ($parameter, $section); |
b9d97328e kernel-doc: clean... |
1381 1382 |
print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX "; |
1da177e4c Linux-2.6.12-rc2 |
1383 1384 1385 |
print ".SH NAME "; |
b9d97328e kernel-doc: clean... |
1386 1387 |
print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . " "; |
1da177e4c Linux-2.6.12-rc2 |
1388 1389 1390 |
print ".SH SYNOPSIS "; |
b9d97328e kernel-doc: clean... |
1391 1392 1393 |
print $args{'type'} . " " . $args{'struct'} . " { .br "; |
1da177e4c Linux-2.6.12-rc2 |
1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 |
foreach my $parameter (@{$args{'parameterlist'}}) { if ($parameter =~ /^#/) { print ".BI \"$parameter\" .br "; next; } my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
3c308798a scripts: kernel-d... |
1404 |
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
1da177e4c Linux-2.6.12-rc2 |
1405 1406 1407 |
$type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function |
b9d97328e kernel-doc: clean... |
1408 1409 1410 |
print ".BI \" " . $1 . "\" " . $parameter . " \") (" . $2 . ")" . "\" ; "; |
1da177e4c Linux-2.6.12-rc2 |
1411 |
} elsif ($type =~ m/^(.*?)\s*(:.*)/) { |
1d7e1d451 [PATCH] kernel-do... |
1412 |
# bitfield |
b9d97328e kernel-doc: clean... |
1413 1414 1415 |
print ".BI \" " . $1 . "\ \" " . $parameter . $2 . " \"" . "\" ; "; |
1da177e4c Linux-2.6.12-rc2 |
1416 1417 |
} else { $type =~ s/([^\*])$/$1 /; |
b9d97328e kernel-doc: clean... |
1418 1419 1420 |
print ".BI \" " . $type . "\" " . $parameter . " \"" . "\" ; "; |
1da177e4c Linux-2.6.12-rc2 |
1421 1422 1423 1424 1425 1426 1427 1428 |
} print " .br "; } print "}; .br "; |
c51d3dac3 [PATCH] kernel-do... |
1429 1430 |
print ".SH Members "; |
1da177e4c Linux-2.6.12-rc2 |
1431 1432 1433 1434 1435 |
foreach $parameter (@{$args{'parameterlist'}}) { ($parameter =~ /^#/) && next; my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
3c308798a scripts: kernel-d... |
1436 |
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
b9d97328e kernel-doc: clean... |
1437 1438 |
print ".IP \"" . $parameter . "\" 12 "; |
1da177e4c Linux-2.6.12-rc2 |
1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 |
output_highlight($args{'parameterdescs'}{$parameter_name}); } foreach $section (@{$args{'sectionlist'}}) { print ".SH \"$section\" "; output_highlight($args{'sections'}{$section}); } } ## # output typedef in man sub output_typedef_man(%) { my %args = %{$_[0]}; my ($parameter, $section); print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX "; print ".SH NAME "; |
b9d97328e kernel-doc: clean... |
1459 1460 |
print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . " "; |
1da177e4c Linux-2.6.12-rc2 |
1461 1462 1463 1464 1465 1466 1467 |
foreach $section (@{$args{'sectionlist'}}) { print ".SH \"$section\" "; output_highlight($args{'sections'}{$section}); } } |
b112e0f73 kernel-doc: singl... |
1468 |
sub output_blockhead_man(%) { |
1da177e4c Linux-2.6.12-rc2 |
1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 |
my %args = %{$_[0]}; my ($parameter, $section); my $count; print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX "; foreach $section (@{$args{'sectionlist'}}) { print ".SH \"$section\" "; output_highlight($args{'sections'}{$section}); } } ## # output in text sub output_function_text(%) { my %args = %{$_[0]}; my ($parameter, $section); |
a21217daa [PATCH] kernel-do... |
1488 |
my $start; |
1da177e4c Linux-2.6.12-rc2 |
1489 |
|
f47634b27 [PATCH] kernel-do... |
1490 1491 1492 |
print "Name: "; |
b9d97328e kernel-doc: clean... |
1493 1494 |
print $args{'function'} . " - " . $args{'purpose'} . " "; |
f47634b27 [PATCH] kernel-do... |
1495 1496 1497 1498 1499 |
print " Synopsis: "; |
a21217daa [PATCH] kernel-do... |
1500 |
if ($args{'functiontype'} ne "") { |
b9d97328e kernel-doc: clean... |
1501 |
$start = $args{'functiontype'} . " " . $args{'function'} . " ("; |
a21217daa [PATCH] kernel-do... |
1502 |
} else { |
b9d97328e kernel-doc: clean... |
1503 |
$start = $args{'function'} . " ("; |
a21217daa [PATCH] kernel-do... |
1504 |
} |
1da177e4c Linux-2.6.12-rc2 |
1505 |
print $start; |
a21217daa [PATCH] kernel-do... |
1506 |
|
1da177e4c Linux-2.6.12-rc2 |
1507 1508 1509 1510 1511 |
my $count = 0; foreach my $parameter (@{$args{'parameterlist'}}) { $type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function |
b9d97328e kernel-doc: clean... |
1512 |
print $1 . $parameter . ") (" . $2; |
1da177e4c Linux-2.6.12-rc2 |
1513 |
} else { |
b9d97328e kernel-doc: clean... |
1514 |
print $type . " " . $parameter; |
1da177e4c Linux-2.6.12-rc2 |
1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 |
} if ($count != $#{$args{'parameterlist'}}) { $count++; print ", "; print " " x length($start); } else { print "); "; } } print "Arguments: "; foreach $parameter (@{$args{'parameterlist'}}) { my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
b9d97328e kernel-doc: clean... |
1534 1535 1536 |
print $parameter . " \t" . $args{'parameterdescs'}{$parameter_name} . " "; |
1da177e4c Linux-2.6.12-rc2 |
1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 |
} output_section_text(@_); } #output sections in text sub output_section_text(%) { my %args = %{$_[0]}; my $section; print " "; foreach $section (@{$args{'sectionlist'}}) { print "$section: "; output_highlight($args{'sections'}{$section}); |
3c3b809e2 [PATCH] kernel-do... |
1553 |
} |
1da177e4c Linux-2.6.12-rc2 |
1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 |
print " "; } # output enum in text sub output_enum_text(%) { my %args = %{$_[0]}; my ($parameter); my $count; print "Enum: "; |
b9d97328e kernel-doc: clean... |
1567 1568 1569 1570 1571 |
print "enum " . $args{'enum'} . " - " . $args{'purpose'} . " "; print "enum " . $args{'enum'} . " { "; |
1da177e4c Linux-2.6.12-rc2 |
1572 1573 |
$count = 0; foreach $parameter (@{$args{'parameterlist'}}) { |
3c308798a scripts: kernel-d... |
1574 |
print "\t$parameter"; |
1da177e4c Linux-2.6.12-rc2 |
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 |
if ($count != $#{$args{'parameterlist'}}) { $count++; print ","; } print " "; } print "}; "; print "Constants: "; foreach $parameter (@{$args{'parameterlist'}}) { print "$parameter \t"; |
b9d97328e kernel-doc: clean... |
1592 1593 |
print $args{'parameterdescs'}{$parameter} . " "; |
1da177e4c Linux-2.6.12-rc2 |
1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 |
} output_section_text(@_); } # output typedef in text sub output_typedef_text(%) { my %args = %{$_[0]}; my ($parameter); my $count; print "Typedef: "; |
b9d97328e kernel-doc: clean... |
1607 1608 |
print "typedef " . $args{'typedef'} . " - " . $args{'purpose'} . " "; |
1da177e4c Linux-2.6.12-rc2 |
1609 1610 1611 1612 1613 1614 1615 |
output_section_text(@_); } # output struct as text sub output_struct_text(%) { my %args = %{$_[0]}; my ($parameter); |
b9d97328e kernel-doc: clean... |
1616 1617 1618 1619 1620 |
print $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . " "; print $args{'type'} . " " . $args{'struct'} . " { "; |
1da177e4c Linux-2.6.12-rc2 |
1621 1622 1623 1624 1625 1626 1627 1628 1629 |
foreach $parameter (@{$args{'parameterlist'}}) { if ($parameter =~ /^#/) { print "$parameter "; next; } my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
3c308798a scripts: kernel-d... |
1630 |
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
1da177e4c Linux-2.6.12-rc2 |
1631 1632 1633 1634 1635 1636 |
$type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function print "\t$1 $parameter) ($2); "; } elsif ($type =~ m/^(.*?)\s*(:.*)/) { |
51f5a0c8f kernel-doc: strip... |
1637 |
# bitfield |
1da177e4c Linux-2.6.12-rc2 |
1638 1639 1640 |
print "\t$1 $parameter$2; "; } else { |
b9d97328e kernel-doc: clean... |
1641 1642 |
print "\t" . $type . " " . $parameter . "; "; |
1da177e4c Linux-2.6.12-rc2 |
1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 |
} } print "}; "; print "Members: "; foreach $parameter (@{$args{'parameterlist'}}) { ($parameter =~ /^#/) && next; my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
3c308798a scripts: kernel-d... |
1657 |
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
1da177e4c Linux-2.6.12-rc2 |
1658 1659 |
print "$parameter \t"; |
b9d97328e kernel-doc: clean... |
1660 1661 |
print $args{'parameterdescs'}{$parameter_name} . " "; |
1da177e4c Linux-2.6.12-rc2 |
1662 1663 1664 1665 1666 |
} print " "; output_section_text(@_); } |
b112e0f73 kernel-doc: singl... |
1667 |
sub output_blockhead_text(%) { |
1da177e4c Linux-2.6.12-rc2 |
1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 |
my %args = %{$_[0]}; my ($parameter, $section); foreach $section (@{$args{'sectionlist'}}) { print " $section: "; print " -> "; output_highlight($args{'sections'}{$section}); } } ## |
272057447 [PATCH] kernel-do... |
1680 1681 1682 |
# generic output function for all types (function, struct/union, typedef, enum); # calls the generated, variable output_ function name based on # functype and output_mode |
1da177e4c Linux-2.6.12-rc2 |
1683 1684 1685 1686 1687 |
sub output_declaration { no strict 'refs'; my $name = shift; my $functype = shift; my $func = "output_${functype}_$output_mode"; |
3c3b809e2 [PATCH] kernel-do... |
1688 1689 |
if (($function_only==0) || ( $function_only == 1 && defined($function_table{$name})) || |
1da177e4c Linux-2.6.12-rc2 |
1690 1691 |
( $function_only == 2 && !defined($function_table{$name}))) { |
3c308798a scripts: kernel-d... |
1692 |
&$func(@_); |
1da177e4c Linux-2.6.12-rc2 |
1693 1694 1695 1696 1697 |
$section_counter++; } } ## |
272057447 [PATCH] kernel-do... |
1698 |
# generic output function - calls the right one based on current output mode. |
b112e0f73 kernel-doc: singl... |
1699 |
sub output_blockhead { |
1da177e4c Linux-2.6.12-rc2 |
1700 |
no strict 'refs'; |
b9d97328e kernel-doc: clean... |
1701 |
my $func = "output_blockhead_" . $output_mode; |
1da177e4c Linux-2.6.12-rc2 |
1702 1703 1704 1705 1706 |
&$func(@_); $section_counter++; } ## |
3c3b809e2 [PATCH] kernel-do... |
1707 |
# takes a declaration (struct, union, enum, typedef) and |
1da177e4c Linux-2.6.12-rc2 |
1708 1709 1710 1711 |
# invokes the right handler. NOT called for functions. sub dump_declaration($$) { no strict 'refs'; my ($prototype, $file) = @_; |
b9d97328e kernel-doc: clean... |
1712 |
my $func = "dump_" . $decl_type; |
1da177e4c Linux-2.6.12-rc2 |
1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 |
&$func(@_); } sub dump_union($$) { dump_struct(@_); } sub dump_struct($$) { my $x = shift; my $file = shift; |
a1d94aa55 kernel-doc: check... |
1723 |
my $nested; |
1da177e4c Linux-2.6.12-rc2 |
1724 |
|
52dc5aec9 kernel-doc: restr... |
1725 1726 |
if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) { #my $decl_type = $1; |
3c308798a scripts: kernel-d... |
1727 1728 |
$declaration_name = $2; my $members = $3; |
1da177e4c Linux-2.6.12-rc2 |
1729 1730 |
# ignore embedded structs or unions |
a1d94aa55 kernel-doc: check... |
1731 1732 |
$members =~ s/({.*})//g; $nested = $1; |
1da177e4c Linux-2.6.12-rc2 |
1733 |
|
aeec46b97 [PATCH] DocBook: ... |
1734 |
# ignore members marked private: |
52dc5aec9 kernel-doc: restr... |
1735 1736 |
$members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gos; $members =~ s/\/\*\s*private:.*//gos; |
aeec46b97 [PATCH] DocBook: ... |
1737 1738 |
# strip comments: $members =~ s/\/\*.*?\*\///gos; |
a1d94aa55 kernel-doc: check... |
1739 |
$nested =~ s/\/\*.*?\*\///gos; |
aeec46b97 [PATCH] DocBook: ... |
1740 |
|
1da177e4c Linux-2.6.12-rc2 |
1741 |
create_parameterlist($members, ';', $file); |
a1d94aa55 kernel-doc: check... |
1742 |
check_sections($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested); |
1da177e4c Linux-2.6.12-rc2 |
1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 |
output_declaration($declaration_name, 'struct', {'struct' => $declaration_name, 'module' => $modulename, 'parameterlist' => \@parameterlist, 'parameterdescs' => \%parameterdescs, 'parametertypes' => \%parametertypes, 'sectionlist' => \@sectionlist, 'sections' => \%sections, 'purpose' => $declaration_purpose, 'type' => $decl_type }); } else { |
3c308798a scripts: kernel-d... |
1758 1759 |
print STDERR "Error(${file}:$.): Cannot parse struct or union! "; |
1da177e4c Linux-2.6.12-rc2 |
1760 1761 1762 1763 1764 1765 1766 |
++$errors; } } sub dump_enum($$) { my $x = shift; my $file = shift; |
aeec46b97 [PATCH] DocBook: ... |
1767 |
$x =~ s@/\*.*?\*/@@gos; # strip comments. |
1da177e4c Linux-2.6.12-rc2 |
1768 |
if ($x =~ /enum\s+(\w+)\s*{(.*)}/) { |
3c308798a scripts: kernel-d... |
1769 1770 |
$declaration_name = $1; my $members = $2; |
1da177e4c Linux-2.6.12-rc2 |
1771 1772 1773 1774 1775 |
foreach my $arg (split ',', $members) { $arg =~ s/^\s*(\w+).*/$1/; push @parameterlist, $arg; if (!$parameterdescs{$arg}) { |
3c308798a scripts: kernel-d... |
1776 1777 |
$parameterdescs{$arg} = $undescribed; print STDERR "Warning(${file}:$.): Enum value '$arg' ". |
1da177e4c Linux-2.6.12-rc2 |
1778 1779 1780 1781 1782 |
"not described in enum '$declaration_name' "; } } |
b2fd6dbf2 kernel-doc: ignor... |
1783 1784 |
# strip kmemcheck_bitfield_{begin,end}.*; $members =~ s/kmemcheck_bitfield_.*?;//gos; |
3c3b809e2 [PATCH] kernel-do... |
1785 |
|
1da177e4c Linux-2.6.12-rc2 |
1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 |
output_declaration($declaration_name, 'enum', {'enum' => $declaration_name, 'module' => $modulename, 'parameterlist' => \@parameterlist, 'parameterdescs' => \%parameterdescs, 'sectionlist' => \@sectionlist, 'sections' => \%sections, 'purpose' => $declaration_purpose }); } else { |
3c308798a scripts: kernel-d... |
1798 1799 |
print STDERR "Error(${file}:$.): Cannot parse enum! "; |
1da177e4c Linux-2.6.12-rc2 |
1800 1801 1802 1803 1804 1805 1806 |
++$errors; } } sub dump_typedef($$) { my $x = shift; my $file = shift; |
aeec46b97 [PATCH] DocBook: ... |
1807 |
$x =~ s@/\*.*?\*/@@gos; # strip comments. |
1da177e4c Linux-2.6.12-rc2 |
1808 |
while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) { |
3c308798a scripts: kernel-d... |
1809 |
$x =~ s/\(*.\)\s*;$/;/; |
1da177e4c Linux-2.6.12-rc2 |
1810 1811 1812 1813 |
$x =~ s/\[*.\]\s*;$/;/; } if ($x =~ /typedef.*\s+(\w+)\s*;/) { |
3c308798a scripts: kernel-d... |
1814 |
$declaration_name = $1; |
1da177e4c Linux-2.6.12-rc2 |
1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 |
output_declaration($declaration_name, 'typedef', {'typedef' => $declaration_name, 'module' => $modulename, 'sectionlist' => \@sectionlist, 'sections' => \%sections, 'purpose' => $declaration_purpose }); } else { |
3c308798a scripts: kernel-d... |
1826 1827 |
print STDERR "Error(${file}:$.): Cannot parse typedef! "; |
1da177e4c Linux-2.6.12-rc2 |
1828 1829 1830 |
++$errors; } } |
a1d94aa55 kernel-doc: check... |
1831 1832 1833 1834 1835 1836 1837 |
sub save_struct_actual($) { my $actual = shift; # strip all spaces from the actual param so that it looks like one string item $actual =~ s/\s*//g; $struct_actual = $struct_actual . $actual . " "; } |
1da177e4c Linux-2.6.12-rc2 |
1838 1839 1840 1841 1842 1843 |
sub create_parameterlist($$$) { my $args = shift; my $splitter = shift; my $file = shift; my $type; my $param; |
a6d3fe77d [PATCH] DocBook: ... |
1844 |
# temporarily replace commas inside function pointer definition |
1da177e4c Linux-2.6.12-rc2 |
1845 |
while ($args =~ /(\([^\),]+),/) { |
3c308798a scripts: kernel-d... |
1846 |
$args =~ s/(\([^\),]+),/$1#/g; |
1da177e4c Linux-2.6.12-rc2 |
1847 |
} |
3c3b809e2 [PATCH] kernel-do... |
1848 |
|
1da177e4c Linux-2.6.12-rc2 |
1849 1850 1851 |
foreach my $arg (split($splitter, $args)) { # strip comments $arg =~ s/\/\*.*\*\///; |
3c308798a scripts: kernel-d... |
1852 1853 |
# strip leading/trailing spaces $arg =~ s/^\s*//; |
1da177e4c Linux-2.6.12-rc2 |
1854 1855 1856 1857 1858 1859 1860 1861 |
$arg =~ s/\s*$//; $arg =~ s/\s+/ /; if ($arg =~ /^#/) { # Treat preprocessor directive as a typeless variable just to fill # corresponding data structures "correctly". Catch it later in # output_* subs. push_parameter($arg, "", $file); |
00d629614 kernel-doc: fix f... |
1862 |
} elsif ($arg =~ m/\(.+\)\s*\(/) { |
1da177e4c Linux-2.6.12-rc2 |
1863 1864 |
# pointer-to-function $arg =~ tr/#/,/; |
00d629614 kernel-doc: fix f... |
1865 |
$arg =~ m/[^\(]+\(\*?\s*(\w*)\s*\)/; |
1da177e4c Linux-2.6.12-rc2 |
1866 1867 |
$param = $1; $type = $arg; |
00d629614 kernel-doc: fix f... |
1868 |
$type =~ s/([^\(]+\(\*?)\s*$param/$1/; |
a1d94aa55 kernel-doc: check... |
1869 |
save_struct_actual($param); |
1da177e4c Linux-2.6.12-rc2 |
1870 |
push_parameter($param, $type, $file); |
aeec46b97 [PATCH] DocBook: ... |
1871 |
} elsif ($arg) { |
1da177e4c Linux-2.6.12-rc2 |
1872 1873 1874 1875 1876 1877 1878 |
$arg =~ s/\s*:\s*/:/g; $arg =~ s/\s*\[/\[/g; my @args = split('\s*,\s*', $arg); if ($args[0] =~ m/\*/) { $args[0] =~ s/(\*+)\s*/ $1/; } |
884f2810b kernel-doc: handl... |
1879 1880 1881 1882 1883 1884 1885 1886 1887 |
my @first_arg; if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) { shift @args; push(@first_arg, split('\s+', $1)); push(@first_arg, $2); } else { @first_arg = split('\s+', shift @args); } |
1da177e4c Linux-2.6.12-rc2 |
1888 1889 1890 1891 1892 |
unshift(@args, pop @first_arg); $type = join " ", @first_arg; foreach $param (@args) { if ($param =~ m/^(\*+)\s*(.*)/) { |
a1d94aa55 kernel-doc: check... |
1893 |
save_struct_actual($2); |
1da177e4c Linux-2.6.12-rc2 |
1894 1895 1896 |
push_parameter($2, "$type $1", $file); } elsif ($param =~ m/(.*?):(\d+)/) { |
7b97887ea kernel-doc: allow... |
1897 |
if ($type ne "") { # skip unnamed bit-fields |
a1d94aa55 kernel-doc: check... |
1898 |
save_struct_actual($1); |
7b97887ea kernel-doc: allow... |
1899 1900 |
push_parameter($1, "$type:$2", $file) } |
1da177e4c Linux-2.6.12-rc2 |
1901 1902 |
} else { |
a1d94aa55 kernel-doc: check... |
1903 |
save_struct_actual($param); |
1da177e4c Linux-2.6.12-rc2 |
1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 |
push_parameter($param, $type, $file); } } } } } sub push_parameter($$$) { my $param = shift; my $type = shift; my $file = shift; |
5f8c7c98a kernel-doc: fix u... |
1915 1916 1917 1918 1919 1920 |
if (($anon_struct_union == 1) && ($type eq "") && ($param eq "}")) { return; # ignore the ending }; from anon. struct/union } $anon_struct_union = 0; |
1da177e4c Linux-2.6.12-rc2 |
1921 1922 |
my $param_name = $param; $param_name =~ s/\[.*//; |
a6d3fe77d [PATCH] DocBook: ... |
1923 |
if ($type eq "" && $param =~ /\.\.\.$/) |
1da177e4c Linux-2.6.12-rc2 |
1924 |
{ |
ced69090c kernel-doc: handl... |
1925 1926 1927 |
if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") { $parameterdescs{$param} = "variable arguments"; } |
1da177e4c Linux-2.6.12-rc2 |
1928 1929 1930 |
} elsif ($type eq "" && ($param eq "" or $param eq "void")) { |
1da177e4c Linux-2.6.12-rc2 |
1931 1932 1933 |
$param="void"; $parameterdescs{void} = "no arguments"; } |
134fe01bf [PATCH] kernel-do... |
1934 1935 1936 1937 |
elsif ($type eq "" && ($param eq "struct" or $param eq "union")) # handle unnamed (anonymous) union or struct: { $type = $param; |
5f8c7c98a kernel-doc: fix u... |
1938 |
$param = "{unnamed_" . $param . "}"; |
134fe01bf [PATCH] kernel-do... |
1939 1940 |
$parameterdescs{$param} = "anonymous "; |
5f8c7c98a kernel-doc: fix u... |
1941 |
$anon_struct_union = 1; |
134fe01bf [PATCH] kernel-do... |
1942 |
} |
a6d3fe77d [PATCH] DocBook: ... |
1943 |
# warn if parameter has no description |
134fe01bf [PATCH] kernel-do... |
1944 1945 1946 |
# (but ignore ones starting with # as these are not parameters # but inline preprocessor statements); # also ignore unnamed structs/unions; |
5f8c7c98a kernel-doc: fix u... |
1947 |
if (!$anon_struct_union) { |
a6d3fe77d [PATCH] DocBook: ... |
1948 |
if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) { |
1da177e4c Linux-2.6.12-rc2 |
1949 1950 1951 |
$parameterdescs{$param_name} = $undescribed; if (($type eq 'function') || ($type eq 'enum')) { |
3c308798a scripts: kernel-d... |
1952 |
print STDERR "Warning(${file}:$.): Function parameter ". |
1da177e4c Linux-2.6.12-rc2 |
1953 1954 1955 1956 |
"or member '$param' not " . "described in '$declaration_name' "; } |
b9d97328e kernel-doc: clean... |
1957 |
print STDERR "Warning(${file}:$.):" . |
3c308798a scripts: kernel-d... |
1958 1959 |
" No description found for parameter '$param' "; |
1da177e4c Linux-2.6.12-rc2 |
1960 |
++$warnings; |
3c308798a scripts: kernel-d... |
1961 1962 |
} } |
1da177e4c Linux-2.6.12-rc2 |
1963 |
|
e34e7dbb3 kernel-doc: fix p... |
1964 1965 1966 1967 1968 1969 1970 1971 1972 |
# strip spaces from $param so that it is one continous string # on @parameterlist; # this fixes a problem where check_sections() cannot find # a parameter like "addr[6 + 2]" because it actually appears # as "addr[6", "+", "2]" on the parameter list; # but it's better to maintain the param string unchanged for output, # so just weaken the string compare in check_sections() to ignore # "[blah" in a parameter string; ###$param =~ s/\s*//g; |
1da177e4c Linux-2.6.12-rc2 |
1973 1974 1975 |
push @parameterlist, $param; $parametertypes{$param} = $type; } |
a1d94aa55 kernel-doc: check... |
1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 |
sub check_sections($$$$$$) { my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck, $nested) = @_; my @sects = split ' ', $sectcheck; my @prms = split ' ', $prmscheck; my $err; my ($px, $sx); my $prm_clean; # strip trailing "[array size]" and/or beginning "*" foreach $sx (0 .. $#sects) { $err = 1; foreach $px (0 .. $#prms) { $prm_clean = $prms[$px]; $prm_clean =~ s/\[.*\]//; $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//; |
e34e7dbb3 kernel-doc: fix p... |
1990 1991 1992 1993 1994 1995 1996 |
# ignore array size in a parameter string; # however, the original param string may contain # spaces, e.g.: addr[6 + 2] # and this appears in @prms as "addr[6" since the # parameter list is split at spaces; # hence just ignore "[..." for the sections check; $prm_clean =~ s/\[.*//; |
a1d94aa55 kernel-doc: check... |
1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 |
##$prm_clean =~ s/^\**//; if ($prm_clean eq $sects[$sx]) { $err = 0; last; } } if ($err) { if ($decl_type eq "function") { print STDERR "Warning(${file}:$.): " . "Excess function parameter " . "'$sects[$sx]' " . "description in '$decl_name' "; ++$warnings; } else { if ($nested !~ m/\Q$sects[$sx]\E/) { print STDERR "Warning(${file}:$.): " . "Excess struct/union/enum/typedef member " . "'$sects[$sx]' " . "description in '$decl_name' "; ++$warnings; } } } } } |
1da177e4c Linux-2.6.12-rc2 |
2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 |
## # takes a function prototype and the name of the current file being # processed and spits out all the details stored in the global # arrays/hashes. sub dump_function($$) { my $prototype = shift; my $file = shift; $prototype =~ s/^static +//; $prototype =~ s/^extern +//; |
4dc3b16ba [PATCH] DocBook: ... |
2034 |
$prototype =~ s/^asmlinkage +//; |
1da177e4c Linux-2.6.12-rc2 |
2035 2036 |
$prototype =~ s/^inline +//; $prototype =~ s/^__inline__ +//; |
32e794015 [PATCH] kernel-do... |
2037 2038 2039 |
$prototype =~ s/^__inline +//; $prototype =~ s/^__always_inline +//; $prototype =~ s/^noinline +//; |
0129a057b [PATCH] kernel-do... |
2040 |
$prototype =~ s/__devinit +//; |
74fc5c653 kernel-doc: handl... |
2041 |
$prototype =~ s/__init +//; |
890c78c2d kernel-doc: allow... |
2042 |
$prototype =~ s/^#\s*define\s+//; #ak added |
328d24403 [PATCH] kernel-do... |
2043 |
$prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//; |
1da177e4c Linux-2.6.12-rc2 |
2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 |
# Yes, this truly is vile. We are looking for: # 1. Return type (may be nothing if we're looking at a macro) # 2. Function name # 3. Function parameters. # # All the while we have to watch out for function pointer parameters # (which IIRC is what the two sections are for), C types (these # regexps don't even start to express all the possibilities), and # so on. # # If you mess with these regexps, it's a good idea to check that # the following functions' documentation still comes out right: # - parport_register_device (function pointer parameters) # - atomic_set (macro) |
9598f91f2 [PATCH] DocBook: ... |
2059 |
# - pci_match_device, __copy_to_user (long return type) |
1da177e4c Linux-2.6.12-rc2 |
2060 2061 2062 2063 2064 |
if ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || |
94b3e03c8 kernel-doc: fix f... |
2065 |
$prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || |
1da177e4c Linux-2.6.12-rc2 |
2066 2067 2068 2069 2070 2071 2072 2073 |
$prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || |
9598f91f2 [PATCH] DocBook: ... |
2074 2075 |
$prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || |
412ecd775 [PATCH] fix fatal... |
2076 2077 |
$prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || $prototype =~ m/^(\w+\s+\w+\s*\*\s*\w+\s*\*\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) { |
1da177e4c Linux-2.6.12-rc2 |
2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 |
$return_type = $1; $declaration_name = $2; my $args = $3; create_parameterlist($args, ',', $file); } else { print STDERR "Error(${file}:$.): cannot understand prototype: '$prototype' "; ++$errors; return; } |
a1d94aa55 kernel-doc: check... |
2089 2090 |
my $prms = join " ", @parameterlist; check_sections($file, $declaration_name, "function", $sectcheck, $prms, ""); |
3c3b809e2 [PATCH] kernel-do... |
2091 |
output_declaration($declaration_name, |
1da177e4c Linux-2.6.12-rc2 |
2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 |
'function', {'function' => $declaration_name, 'module' => $modulename, 'functiontype' => $return_type, 'parameterlist' => \@parameterlist, 'parameterdescs' => \%parameterdescs, 'parametertypes' => \%parametertypes, 'sectionlist' => \@sectionlist, 'sections' => \%sections, 'purpose' => $declaration_purpose }); } sub process_file($); # Read the file that maps relative names to absolute names for # separate source and object directories and for shadow trees. if (open(SOURCE_MAP, "<.tmp_filelist.txt")) { my ($relname, $absname); while(<SOURCE_MAP>) { chop(); ($relname, $absname) = (split())[0..1]; $relname =~ s:^/+::; $source_map{$relname} = $absname; } close(SOURCE_MAP); } if ($filelist) { open(FLIST,"<$filelist") or die "Can't open file list $filelist"; while(<FLIST>) { chop; process_file($_); } } foreach (@ARGV) { chomp; process_file($_); } if ($verbose && $errors) { print STDERR "$errors errors "; } if ($verbose && $warnings) { print STDERR "$warnings warnings "; } exit($errors); sub reset_state { $function = ""; %constants = (); %parameterdescs = (); %parametertypes = (); @parameterlist = (); %sections = (); @sectionlist = (); |
a1d94aa55 kernel-doc: check... |
2151 2152 |
$sectcheck = ""; $struct_actual = ""; |
1da177e4c Linux-2.6.12-rc2 |
2153 |
$prototype = ""; |
3c3b809e2 [PATCH] kernel-do... |
2154 |
|
1da177e4c Linux-2.6.12-rc2 |
2155 2156 |
$state = 0; } |
56afb0f88 kerneldoc, tracin... |
2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 |
sub tracepoint_munge($) { my $file = shift; my $tracepointname = 0; my $tracepointargs = 0; if($prototype =~ m/TRACE_EVENT\((.*?),/) { $tracepointname = $1; } if($prototype =~ m/TP_PROTO\((.*?)\)/) { $tracepointargs = $1; } if (($tracepointname eq 0) || ($tracepointargs eq 0)) { print STDERR "Warning(${file}:$.): Unrecognized tracepoint format: ". "$prototype "; } else { $prototype = "static inline void trace_$tracepointname($tracepointargs)"; } } |
b4870bc5e kernel-doc: fix s... |
2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 |
sub syscall_munge() { my $void = 0; $prototype =~ s@[\r \t]+@ @gos; # strip newlines/CR's/tabs ## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) { if ($prototype =~ m/SYSCALL_DEFINE0/) { $void = 1; ## $prototype = "long sys_$1(void)"; } $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name if ($prototype =~ m/long (sys_.*?),/) { $prototype =~ s/,/\(/; } elsif ($void) { $prototype =~ s/\)/\(void\)/; } # now delete all of the odd-number commas in $prototype # so that arg types & arg names don't have a comma between them my $count = 0; my $len = length($prototype); if ($void) { $len = 0; # skip the for-loop } for (my $ix = 0; $ix < $len; $ix++) { if (substr($prototype, $ix, 1) eq ',') { $count++; if ($count % 2 == 1) { substr($prototype, $ix, 1) = ' '; } } } } |
3c3b809e2 [PATCH] kernel-do... |
2211 |
sub process_state3_function($$) { |
1da177e4c Linux-2.6.12-rc2 |
2212 2213 |
my $x = shift; my $file = shift; |
51f5a0c8f kernel-doc: strip... |
2214 |
$x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line |
890c78c2d kernel-doc: allow... |
2215 |
if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) { |
1da177e4c Linux-2.6.12-rc2 |
2216 2217 2218 |
# do nothing } elsif ($x =~ /([^\{]*)/) { |
3c308798a scripts: kernel-d... |
2219 |
$prototype .= $1; |
1da177e4c Linux-2.6.12-rc2 |
2220 |
} |
b4870bc5e kernel-doc: fix s... |
2221 |
|
890c78c2d kernel-doc: allow... |
2222 |
if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) { |
3c308798a scripts: kernel-d... |
2223 |
$prototype =~ s@/\*.*?\*/@@gos; # strip comments. |
1da177e4c Linux-2.6.12-rc2 |
2224 2225 2226 |
$prototype =~ s@[\r ]+@ @gos; # strip newlines/cr's. $prototype =~ s@^\s+@@gos; # strip leading spaces |
b4870bc5e kernel-doc: fix s... |
2227 2228 2229 |
if ($prototype =~ /SYSCALL_DEFINE/) { syscall_munge(); } |
56afb0f88 kerneldoc, tracin... |
2230 2231 2232 |
if ($prototype =~ /TRACE_EVENT/) { tracepoint_munge($file); } |
b4870bc5e kernel-doc: fix s... |
2233 |
dump_function($prototype, $file); |
1da177e4c Linux-2.6.12-rc2 |
2234 2235 2236 |
reset_state(); } } |
3c3b809e2 [PATCH] kernel-do... |
2237 |
sub process_state3_type($$) { |
1da177e4c Linux-2.6.12-rc2 |
2238 2239 |
my $x = shift; my $file = shift; |
1da177e4c Linux-2.6.12-rc2 |
2240 2241 2242 2243 |
$x =~ s@[\r ]+@ @gos; # strip newlines/cr's. $x =~ s@^\s+@@gos; # strip leading spaces $x =~ s@\s+$@@gos; # strip trailing spaces |
51f5a0c8f kernel-doc: strip... |
2244 |
$x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line |
1da177e4c Linux-2.6.12-rc2 |
2245 2246 2247 2248 2249 2250 |
if ($x =~ /^#/) { # To distinguish preprocessor directive from regular declaration later. $x .= ";"; } while (1) { |
3c308798a scripts: kernel-d... |
2251 |
if ( $x =~ /([^{};]*)([{};])(.*)/ ) { |
1da177e4c Linux-2.6.12-rc2 |
2252 2253 2254 2255 |
$prototype .= $1 . $2; ($2 eq '{') && $brcount++; ($2 eq '}') && $brcount--; if (($2 eq ';') && ($brcount == 0)) { |
b9d97328e kernel-doc: clean... |
2256 |
dump_declaration($prototype, $file); |
1da177e4c Linux-2.6.12-rc2 |
2257 |
reset_state(); |
3c308798a scripts: kernel-d... |
2258 |
last; |
1da177e4c Linux-2.6.12-rc2 |
2259 2260 |
} $x = $3; |
3c308798a scripts: kernel-d... |
2261 |
} else { |
1da177e4c Linux-2.6.12-rc2 |
2262 2263 2264 2265 2266 |
$prototype .= $x; last; } } } |
6b5b55f6c kernel-doc: fix d... |
2267 2268 2269 2270 2271 2272 2273 |
# xml_escape: replace <, >, and & in the text stream; # # however, formatting controls that are generated internally/locally in the # kernel-doc script are not escaped here; instead, they begin life like # $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings # are converted to their mnemonic-expected output, without the 4 * '\' & ':', # just before actual output; (this is done by local_unescape()) |
1da177e4c Linux-2.6.12-rc2 |
2274 2275 |
sub xml_escape($) { my $text = shift; |
ecfb251a9 [PATCH] kernel-do... |
2276 2277 2278 |
if (($output_mode eq "text") || ($output_mode eq "man")) { return $text; } |
1da177e4c Linux-2.6.12-rc2 |
2279 2280 2281 2282 2283 |
$text =~ s/\&/\\\\\\amp;/g; $text =~ s/\</\\\\\\lt;/g; $text =~ s/\>/\\\\\\gt;/g; return $text; } |
6b5b55f6c kernel-doc: fix d... |
2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 |
# convert local escape strings to html # local escape strings look like: '\\\\menmonic:' (that's 4 backslashes) sub local_unescape($) { my $text = shift; if (($output_mode eq "text") || ($output_mode eq "man")) { return $text; } $text =~ s/\\\\\\\\lt:/</g; $text =~ s/\\\\\\\\gt:/>/g; return $text; } |
1da177e4c Linux-2.6.12-rc2 |
2295 |
sub process_file($) { |
2283a117f [PATCH] scripts/k... |
2296 |
my $file; |
1da177e4c Linux-2.6.12-rc2 |
2297 2298 |
my $identifier; my $func; |
a21217daa [PATCH] kernel-do... |
2299 |
my $descr; |
1da177e4c Linux-2.6.12-rc2 |
2300 |
my $initial_section_counter = $section_counter; |
2283a117f [PATCH] scripts/k... |
2301 2302 2303 2304 2305 2306 |
if (defined($ENV{'SRCTREE'})) { $file = "$ENV{'SRCTREE'}" . "/" . "@_"; } else { $file = "@_"; } |
1da177e4c Linux-2.6.12-rc2 |
2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 |
if (defined($source_map{$file})) { $file = $source_map{$file}; } if (!open(IN,"<$file")) { print STDERR "Error: Cannot open file $file "; ++$errors; return; } $section_counter = 0; while (<IN>) { if ($state == 0) { if (/$doc_start/o) { $state = 1; # next line is always the function name |
850622dfa [PATCH] kernel-do... |
2323 |
$in_doc_sect = 0; |
1da177e4c Linux-2.6.12-rc2 |
2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 |
} } elsif ($state == 1) { # this line is the function name (always) if (/$doc_block/o) { $state = 4; $contents = ""; if ( $1 eq "" ) { $section = $section_intro; } else { $section = $1; } |
3c308798a scripts: kernel-d... |
2334 |
} |
1da177e4c Linux-2.6.12-rc2 |
2335 2336 2337 2338 2339 2340 2341 2342 |
elsif (/$doc_decl/o) { $identifier = $1; if (/\s*([\w\s]+?)\s*-/) { $identifier = $1; } $state = 2; if (/-(.*)/) { |
51f5a0c8f kernel-doc: strip... |
2343 |
# strip leading/trailing/multiple spaces |
a21217daa [PATCH] kernel-do... |
2344 2345 2346 2347 2348 |
$descr= $1; $descr =~ s/^\s*//; $descr =~ s/\s*$//; $descr =~ s/\s+/ /; $declaration_purpose = xml_escape($descr); |
1da177e4c Linux-2.6.12-rc2 |
2349 2350 2351 |
} else { $declaration_purpose = ""; } |
77cc23b8c kernel-doc: warn ... |
2352 2353 2354 2355 2356 2357 2358 |
if (($declaration_purpose eq "") && $verbose) { print STDERR "Warning(${file}:$.): missing initial short description on line: "; print STDERR $_; ++$warnings; } |
1da177e4c Linux-2.6.12-rc2 |
2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 |
if ($identifier =~ m/^struct/) { $decl_type = 'struct'; } elsif ($identifier =~ m/^union/) { $decl_type = 'union'; } elsif ($identifier =~ m/^enum/) { $decl_type = 'enum'; } elsif ($identifier =~ m/^typedef/) { $decl_type = 'typedef'; } else { $decl_type = 'function'; } if ($verbose) { print STDERR "Info(${file}:$.): Scanning doc for $identifier "; } } else { print STDERR "Warning(${file}:$.): Cannot understand $_ on line $.", " - I thought it was a doc line "; ++$warnings; $state = 0; } } elsif ($state == 2) { # look for head: lines, and include content if (/$doc_sect/o) { $newsection = $1; $newcontents = $2; |
792aa2f2c kernel-doc: preve... |
2386 2387 |
if (($contents ne "") && ($contents ne " ")) { |
850622dfa [PATCH] kernel-do... |
2388 2389 2390 2391 2392 |
if (!$in_doc_sect && $verbose) { print STDERR "Warning(${file}:$.): contents before sections "; ++$warnings; } |
94dc7ad55 kernel-doc: detec... |
2393 |
dump_section($file, $section, xml_escape($contents)); |
1da177e4c Linux-2.6.12-rc2 |
2394 2395 |
$section = $section_default; } |
850622dfa [PATCH] kernel-do... |
2396 |
$in_doc_sect = 1; |
1da177e4c Linux-2.6.12-rc2 |
2397 2398 |
$contents = $newcontents; if ($contents ne "") { |
272057447 [PATCH] kernel-do... |
2399 2400 2401 |
while ((substr($contents, 0, 1) eq " ") || substr($contents, 0, 1) eq "\t") { $contents = substr($contents, 1); |
05189497d [PATCH] kernel-do... |
2402 |
} |
1da177e4c Linux-2.6.12-rc2 |
2403 2404 2405 2406 2407 2408 2409 |
$contents .= " "; } $section = $newsection; } elsif (/$doc_end/) { if ($contents ne "") { |
94dc7ad55 kernel-doc: detec... |
2410 |
dump_section($file, $section, xml_escape($contents)); |
1da177e4c Linux-2.6.12-rc2 |
2411 2412 2413 |
$section = $section_default; $contents = ""; } |
46b958eb8 kernel-doc: detec... |
2414 2415 2416 2417 2418 |
# look for doc_com + <text> + doc_end: if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') { print STDERR "Warning(${file}:$.): suspicious ending line: $_"; ++$warnings; } |
1da177e4c Linux-2.6.12-rc2 |
2419 2420 2421 2422 |
$prototype = ""; $state = 3; $brcount = 0; |
232acbcf5 [PATCH] kernel-do... |
2423 2424 |
# print STDERR "end of doc comment, looking for prototype "; |
1da177e4c Linux-2.6.12-rc2 |
2425 2426 2427 |
} elsif (/$doc_content/) { # miguel-style comment kludge, look for blank lines after # @parameter line to signify start of description |
3c3b809e2 [PATCH] kernel-do... |
2428 |
if ($1 eq "" && |
1da177e4c Linux-2.6.12-rc2 |
2429 |
($section =~ m/^@/ || $section eq $section_context)) { |
94dc7ad55 kernel-doc: detec... |
2430 |
dump_section($file, $section, xml_escape($contents)); |
1da177e4c Linux-2.6.12-rc2 |
2431 2432 2433 |
$section = $section_default; $contents = ""; } else { |
b9d97328e kernel-doc: clean... |
2434 2435 |
$contents .= $1 . " "; |
1da177e4c Linux-2.6.12-rc2 |
2436 2437 2438 |
} } else { # i dont know - bad line? ignore. |
3c3b809e2 [PATCH] kernel-do... |
2439 |
print STDERR "Warning(${file}:$.): bad line: $_"; |
1da177e4c Linux-2.6.12-rc2 |
2440 2441 |
++$warnings; } |
232acbcf5 [PATCH] kernel-do... |
2442 |
} elsif ($state == 3) { # scanning for function '{' (end of prototype) |
1da177e4c Linux-2.6.12-rc2 |
2443 |
if ($decl_type eq 'function') { |
3c308798a scripts: kernel-d... |
2444 |
process_state3_function($_, $file); |
1da177e4c Linux-2.6.12-rc2 |
2445 |
} else { |
3c308798a scripts: kernel-d... |
2446 |
process_state3_type($_, $file); |
1da177e4c Linux-2.6.12-rc2 |
2447 2448 2449 |
} } elsif ($state == 4) { # Documentation block |
3c308798a scripts: kernel-d... |
2450 |
if (/$doc_block/) { |
94dc7ad55 kernel-doc: detec... |
2451 |
dump_doc_section($file, $section, xml_escape($contents)); |
1da177e4c Linux-2.6.12-rc2 |
2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 |
$contents = ""; $function = ""; %constants = (); %parameterdescs = (); %parametertypes = (); @parameterlist = (); %sections = (); @sectionlist = (); $prototype = ""; if ( $1 eq "" ) { $section = $section_intro; } else { $section = $1; } |
3c308798a scripts: kernel-d... |
2466 |
} |
1da177e4c Linux-2.6.12-rc2 |
2467 2468 |
elsif (/$doc_end/) { |
94dc7ad55 kernel-doc: detec... |
2469 |
dump_doc_section($file, $section, xml_escape($contents)); |
1da177e4c Linux-2.6.12-rc2 |
2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 |
$contents = ""; $function = ""; %constants = (); %parameterdescs = (); %parametertypes = (); @parameterlist = (); %sections = (); @sectionlist = (); $prototype = ""; $state = 0; } elsif (/$doc_content/) { if ( $1 eq "" ) { $contents .= $blankline; } else { $contents .= $1 . " "; |
3c3b809e2 [PATCH] kernel-do... |
2491 |
} |
3c308798a scripts: kernel-d... |
2492 2493 |
} } |
1da177e4c Linux-2.6.12-rc2 |
2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 |
} if ($initial_section_counter == $section_counter) { print STDERR "Warning(${file}): no structured comments found "; if ($output_mode eq "xml") { # The template wants at least one RefEntry here; make one. print "<refentry> "; print " <refnamediv> "; print " <refname> "; print " ${file} "; print " </refname> "; print " <refpurpose> "; print " Document generation inconsistency "; print " </refpurpose> "; print " </refnamediv> "; print " <refsect1> "; print " <title> "; print " Oops "; print " </title> "; print " <warning> "; print " <para> "; print " The template for this document tried to insert "; print " the structured comment from the file "; print " <filename>${file}</filename> at this point, "; print " but none was found. "; print " This dummy section is inserted to allow "; print " generation to continue. "; print " </para> "; print " </warning> "; print " </refsect1> "; print "</refentry> "; } } } |