1e2c54635SPaolo Bonzini#!/usr/bin/env perl 2e2c54635SPaolo Bonzini# SPDX-License-Identifier: GPL-2.0 3e2c54635SPaolo Bonzini 4e2c54635SPaolo Bonziniuse warnings; 5e2c54635SPaolo Bonziniuse strict; 6e2c54635SPaolo Bonzini 7e2c54635SPaolo Bonzini## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## 8e2c54635SPaolo Bonzini## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ## 9e2c54635SPaolo Bonzini## Copyright (C) 2001 Simon Huggins ## 10e2c54635SPaolo Bonzini## Copyright (C) 2005-2012 Randy Dunlap ## 11e2c54635SPaolo Bonzini## Copyright (C) 2012 Dan Luedtke ## 12e2c54635SPaolo Bonzini## ## 13e2c54635SPaolo Bonzini## #define enhancements by Armin Kuster <akuster@mvista.com> ## 14e2c54635SPaolo Bonzini## Copyright (c) 2000 MontaVista Software, Inc. ## 15e2c54635SPaolo Bonzini## ## 16e2c54635SPaolo Bonzini## This software falls under the GNU General Public License. ## 17e2c54635SPaolo Bonzini## Please read the COPYING file for more information ## 18e2c54635SPaolo Bonzini 19e2c54635SPaolo Bonzini# 18/01/2001 - Cleanups 20e2c54635SPaolo Bonzini# Functions prototyped as foo(void) same as foo() 21e2c54635SPaolo Bonzini# Stop eval'ing where we don't need to. 22e2c54635SPaolo Bonzini# -- huggie@earth.li 23e2c54635SPaolo Bonzini 24e2c54635SPaolo Bonzini# 27/06/2001 - Allowed whitespace after initial "/**" and 25e2c54635SPaolo Bonzini# allowed comments before function declarations. 26e2c54635SPaolo Bonzini# -- Christian Kreibich <ck@whoop.org> 27e2c54635SPaolo Bonzini 28e2c54635SPaolo Bonzini# Still to do: 29e2c54635SPaolo Bonzini# - add perldoc documentation 30e2c54635SPaolo Bonzini# - Look more closely at some of the scarier bits :) 31e2c54635SPaolo Bonzini 32e2c54635SPaolo Bonzini# 26/05/2001 - Support for separate source and object trees. 33e2c54635SPaolo Bonzini# Return error code. 34e2c54635SPaolo Bonzini# Keith Owens <kaos@ocs.com.au> 35e2c54635SPaolo Bonzini 36e2c54635SPaolo Bonzini# 23/09/2001 - Added support for typedefs, structs, enums and unions 37e2c54635SPaolo Bonzini# Support for Context section; can be terminated using empty line 38e2c54635SPaolo Bonzini# Small fixes (like spaces vs. \s in regex) 39e2c54635SPaolo Bonzini# -- Tim Jansen <tim@tjansen.de> 40e2c54635SPaolo Bonzini 41e2c54635SPaolo Bonzini# 25/07/2012 - Added support for HTML5 42e2c54635SPaolo Bonzini# -- Dan Luedtke <mail@danrl.de> 43e2c54635SPaolo Bonzini 44e2c54635SPaolo Bonzinisub usage { 45e2c54635SPaolo Bonzini my $message = <<"EOF"; 46e2c54635SPaolo BonziniUsage: $0 [OPTION ...] FILE ... 47e2c54635SPaolo Bonzini 48e2c54635SPaolo BonziniRead C language source or header FILEs, extract embedded documentation comments, 49e2c54635SPaolo Bonziniand print formatted documentation to standard output. 50e2c54635SPaolo Bonzini 51e2c54635SPaolo BonziniThe documentation comments are identified by "/**" opening comment mark. See 52e2c54635SPaolo BonziniDocumentation/doc-guide/kernel-doc.rst for the documentation comment syntax. 53e2c54635SPaolo Bonzini 54e2c54635SPaolo BonziniOutput format selection (mutually exclusive): 55e2c54635SPaolo Bonzini -man Output troff manual page format. This is the default. 56e2c54635SPaolo Bonzini -rst Output reStructuredText format. 57e2c54635SPaolo Bonzini -none Do not output documentation, only warnings. 58e2c54635SPaolo Bonzini 59e2c54635SPaolo BonziniOutput selection (mutually exclusive): 60e2c54635SPaolo Bonzini -export Only output documentation for symbols that have been 61e2c54635SPaolo Bonzini exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() 62e2c54635SPaolo Bonzini in any input FILE or -export-file FILE. 63e2c54635SPaolo Bonzini -internal Only output documentation for symbols that have NOT been 64e2c54635SPaolo Bonzini exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() 65e2c54635SPaolo Bonzini in any input FILE or -export-file FILE. 66e2c54635SPaolo Bonzini -function NAME Only output documentation for the given function(s) 67e2c54635SPaolo Bonzini or DOC: section title(s). All other functions and DOC: 68e2c54635SPaolo Bonzini sections are ignored. May be specified multiple times. 69e2c54635SPaolo Bonzini -nofunction NAME Do NOT output documentation for the given function(s); 70e2c54635SPaolo Bonzini only output documentation for the other functions and 71e2c54635SPaolo Bonzini DOC: sections. May be specified multiple times. 72e2c54635SPaolo Bonzini 73e2c54635SPaolo BonziniOutput selection modifiers: 74e2c54635SPaolo Bonzini -no-doc-sections Do not output DOC: sections. 75e2c54635SPaolo Bonzini -enable-lineno Enable output of #define LINENO lines. Only works with 76e2c54635SPaolo Bonzini reStructuredText format. 77e2c54635SPaolo Bonzini -export-file FILE Specify an additional FILE in which to look for 78e2c54635SPaolo Bonzini EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be used with 79e2c54635SPaolo Bonzini -export or -internal. May be specified multiple times. 80e2c54635SPaolo Bonzini 81e2c54635SPaolo BonziniOther parameters: 82e2c54635SPaolo Bonzini -v Verbose output, more warnings and other information. 83e2c54635SPaolo Bonzini -h Print this help. 84e2c54635SPaolo Bonzini 85e2c54635SPaolo BonziniEOF 86e2c54635SPaolo Bonzini print $message; 87e2c54635SPaolo Bonzini exit 1; 88e2c54635SPaolo Bonzini} 89e2c54635SPaolo Bonzini 90e2c54635SPaolo Bonzini# 91e2c54635SPaolo Bonzini# format of comments. 92e2c54635SPaolo Bonzini# In the following table, (...)? signifies optional structure. 93e2c54635SPaolo Bonzini# (...)* signifies 0 or more structure elements 94e2c54635SPaolo Bonzini# /** 95e2c54635SPaolo Bonzini# * function_name(:)? (- short description)? 96e2c54635SPaolo Bonzini# (* @parameterx: (description of parameter x)?)* 97e2c54635SPaolo Bonzini# (* a blank line)? 98e2c54635SPaolo Bonzini# * (Description:)? (Description of function)? 99e2c54635SPaolo Bonzini# * (section header: (section description)? )* 100e2c54635SPaolo Bonzini# (*)?*/ 101e2c54635SPaolo Bonzini# 102e2c54635SPaolo Bonzini# So .. the trivial example would be: 103e2c54635SPaolo Bonzini# 104e2c54635SPaolo Bonzini# /** 105e2c54635SPaolo Bonzini# * my_function 106e2c54635SPaolo Bonzini# */ 107e2c54635SPaolo Bonzini# 108e2c54635SPaolo Bonzini# If the Description: header tag is omitted, then there must be a blank line 109e2c54635SPaolo Bonzini# after the last parameter specification. 110e2c54635SPaolo Bonzini# e.g. 111e2c54635SPaolo Bonzini# /** 112e2c54635SPaolo Bonzini# * my_function - does my stuff 113e2c54635SPaolo Bonzini# * @my_arg: its mine damnit 114e2c54635SPaolo Bonzini# * 115e2c54635SPaolo Bonzini# * Does my stuff explained. 116e2c54635SPaolo Bonzini# */ 117e2c54635SPaolo Bonzini# 118e2c54635SPaolo Bonzini# or, could also use: 119e2c54635SPaolo Bonzini# /** 120e2c54635SPaolo Bonzini# * my_function - does my stuff 121e2c54635SPaolo Bonzini# * @my_arg: its mine damnit 122e2c54635SPaolo Bonzini# * Description: Does my stuff explained. 123e2c54635SPaolo Bonzini# */ 124e2c54635SPaolo Bonzini# etc. 125e2c54635SPaolo Bonzini# 126e2c54635SPaolo Bonzini# Besides functions you can also write documentation for structs, unions, 127e2c54635SPaolo Bonzini# enums and typedefs. Instead of the function name you must write the name 128e2c54635SPaolo Bonzini# of the declaration; the struct/union/enum/typedef must always precede 129e2c54635SPaolo Bonzini# the name. Nesting of declarations is not supported. 130e2c54635SPaolo Bonzini# Use the argument mechanism to document members or constants. 131e2c54635SPaolo Bonzini# e.g. 132e2c54635SPaolo Bonzini# /** 133e2c54635SPaolo Bonzini# * struct my_struct - short description 134e2c54635SPaolo Bonzini# * @a: first member 135e2c54635SPaolo Bonzini# * @b: second member 136e2c54635SPaolo Bonzini# * 137e2c54635SPaolo Bonzini# * Longer description 138e2c54635SPaolo Bonzini# */ 139e2c54635SPaolo Bonzini# struct my_struct { 140e2c54635SPaolo Bonzini# int a; 141e2c54635SPaolo Bonzini# int b; 142e2c54635SPaolo Bonzini# /* private: */ 143e2c54635SPaolo Bonzini# int c; 144e2c54635SPaolo Bonzini# }; 145e2c54635SPaolo Bonzini# 146e2c54635SPaolo Bonzini# All descriptions can be multiline, except the short function description. 147e2c54635SPaolo Bonzini# 148e2c54635SPaolo Bonzini# For really longs structs, you can also describe arguments inside the 149e2c54635SPaolo Bonzini# body of the struct. 150e2c54635SPaolo Bonzini# eg. 151e2c54635SPaolo Bonzini# /** 152e2c54635SPaolo Bonzini# * struct my_struct - short description 153e2c54635SPaolo Bonzini# * @a: first member 154e2c54635SPaolo Bonzini# * @b: second member 155e2c54635SPaolo Bonzini# * 156e2c54635SPaolo Bonzini# * Longer description 157e2c54635SPaolo Bonzini# */ 158e2c54635SPaolo Bonzini# struct my_struct { 159e2c54635SPaolo Bonzini# int a; 160e2c54635SPaolo Bonzini# int b; 161e2c54635SPaolo Bonzini# /** 162e2c54635SPaolo Bonzini# * @c: This is longer description of C 163e2c54635SPaolo Bonzini# * 164e2c54635SPaolo Bonzini# * You can use paragraphs to describe arguments 165e2c54635SPaolo Bonzini# * using this method. 166e2c54635SPaolo Bonzini# */ 167e2c54635SPaolo Bonzini# int c; 168e2c54635SPaolo Bonzini# }; 169e2c54635SPaolo Bonzini# 170e2c54635SPaolo Bonzini# This should be use only for struct/enum members. 171e2c54635SPaolo Bonzini# 172e2c54635SPaolo Bonzini# You can also add additional sections. When documenting kernel functions you 173e2c54635SPaolo Bonzini# should document the "Context:" of the function, e.g. whether the functions 174e2c54635SPaolo Bonzini# can be called form interrupts. Unlike other sections you can end it with an 175e2c54635SPaolo Bonzini# empty line. 176e2c54635SPaolo Bonzini# A non-void function should have a "Return:" section describing the return 177e2c54635SPaolo Bonzini# value(s). 178e2c54635SPaolo Bonzini# Example-sections should contain the string EXAMPLE so that they are marked 179e2c54635SPaolo Bonzini# appropriately in DocBook. 180e2c54635SPaolo Bonzini# 181e2c54635SPaolo Bonzini# Example: 182e2c54635SPaolo Bonzini# /** 183e2c54635SPaolo Bonzini# * user_function - function that can only be called in user context 184e2c54635SPaolo Bonzini# * @a: some argument 185e2c54635SPaolo Bonzini# * Context: !in_interrupt() 186e2c54635SPaolo Bonzini# * 187e2c54635SPaolo Bonzini# * Some description 188e2c54635SPaolo Bonzini# * Example: 189e2c54635SPaolo Bonzini# * user_function(22); 190e2c54635SPaolo Bonzini# */ 191e2c54635SPaolo Bonzini# ... 192e2c54635SPaolo Bonzini# 193e2c54635SPaolo Bonzini# 194e2c54635SPaolo Bonzini# All descriptive text is further processed, scanning for the following special 195e2c54635SPaolo Bonzini# patterns, which are highlighted appropriately. 196e2c54635SPaolo Bonzini# 197e2c54635SPaolo Bonzini# 'funcname()' - function 198e2c54635SPaolo Bonzini# '$ENVVAR' - environmental variable 199e2c54635SPaolo Bonzini# '&struct_name' - name of a structure (up to two words including 'struct') 200e2c54635SPaolo Bonzini# '&struct_name.member' - name of a structure member 201e2c54635SPaolo Bonzini# '@parameter' - name of a parameter 202e2c54635SPaolo Bonzini# '%CONST' - name of a constant. 203e2c54635SPaolo Bonzini# '``LITERAL``' - literal string without any spaces on it. 204e2c54635SPaolo Bonzini 205e2c54635SPaolo Bonzini## init lots of data 206e2c54635SPaolo Bonzini 207e2c54635SPaolo Bonzinimy $errors = 0; 208e2c54635SPaolo Bonzinimy $warnings = 0; 209e2c54635SPaolo Bonzinimy $anon_struct_union = 0; 210e2c54635SPaolo Bonzini 211e2c54635SPaolo Bonzini# match expressions used to find embedded type information 212e2c54635SPaolo Bonzinimy $type_constant = '\b``([^\`]+)``\b'; 213e2c54635SPaolo Bonzinimy $type_constant2 = '\%([-_\w]+)'; 214e2c54635SPaolo Bonzinimy $type_func = '(\w+)\(\)'; 215e2c54635SPaolo Bonzinimy $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; 216e2c54635SPaolo Bonzinimy $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params 217e2c54635SPaolo Bonzinimy $type_env = '(\$\w+)'; 2184cf41794SPaolo Bonzinimy $type_enum = '#(enum\s*([_\w]+))'; 2194cf41794SPaolo Bonzinimy $type_struct = '#(struct\s*([_\w]+))'; 2204cf41794SPaolo Bonzinimy $type_typedef = '#(([A-Z][_\w]*))'; 2214cf41794SPaolo Bonzinimy $type_union = '#(union\s*([_\w]+))'; 2224cf41794SPaolo Bonzinimy $type_member = '#([_\w]+)(\.|->)([_\w]+)'; 2234cf41794SPaolo Bonzinimy $type_fallback = '(?!)'; # this never matches 224e2c54635SPaolo Bonzinimy $type_member_func = $type_member . '\(\)'; 225e2c54635SPaolo Bonzini 226e2c54635SPaolo Bonzini# Output conversion substitutions. 227e2c54635SPaolo Bonzini# One for each output format 228e2c54635SPaolo Bonzini 229e2c54635SPaolo Bonzini# these are pretty rough 230e2c54635SPaolo Bonzinimy @highlights_man = ( 231e2c54635SPaolo Bonzini [$type_constant, "\$1"], 232e2c54635SPaolo Bonzini [$type_constant2, "\$1"], 233e2c54635SPaolo Bonzini [$type_func, "\\\\fB\$1\\\\fP"], 234e2c54635SPaolo Bonzini [$type_enum, "\\\\fI\$1\\\\fP"], 235e2c54635SPaolo Bonzini [$type_struct, "\\\\fI\$1\\\\fP"], 236e2c54635SPaolo Bonzini [$type_typedef, "\\\\fI\$1\\\\fP"], 237e2c54635SPaolo Bonzini [$type_union, "\\\\fI\$1\\\\fP"], 238e2c54635SPaolo Bonzini [$type_param, "\\\\fI\$1\\\\fP"], 239e2c54635SPaolo Bonzini [$type_member, "\\\\fI\$1\$2\$3\\\\fP"], 240e2c54635SPaolo Bonzini [$type_fallback, "\\\\fI\$1\\\\fP"] 241e2c54635SPaolo Bonzini ); 242e2c54635SPaolo Bonzinimy $blankline_man = ""; 243e2c54635SPaolo Bonzini 244e2c54635SPaolo Bonzini# rst-mode 245e2c54635SPaolo Bonzinimy @highlights_rst = ( 246e2c54635SPaolo Bonzini [$type_constant, "``\$1``"], 247e2c54635SPaolo Bonzini [$type_constant2, "``\$1``"], 248e2c54635SPaolo Bonzini # Note: need to escape () to avoid func matching later 249e2c54635SPaolo Bonzini [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\\\\) <\$1>`"], 250e2c54635SPaolo Bonzini [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"], 251e2c54635SPaolo Bonzini [$type_fp_param, "**\$1\\\\(\\\\)**"], 252e2c54635SPaolo Bonzini [$type_func, "\$1()"], 253e2c54635SPaolo Bonzini [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"], 254e2c54635SPaolo Bonzini [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"], 255e2c54635SPaolo Bonzini [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"], 256e2c54635SPaolo Bonzini [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"], 257e2c54635SPaolo Bonzini # in rst this can refer to any type 258e2c54635SPaolo Bonzini [$type_fallback, "\\:c\\:type\\:`\$1`"], 259e2c54635SPaolo Bonzini [$type_param, "**\$1**"] 260e2c54635SPaolo Bonzini ); 261e2c54635SPaolo Bonzinimy $blankline_rst = "\n"; 262e2c54635SPaolo Bonzini 263e2c54635SPaolo Bonzini# read arguments 264e2c54635SPaolo Bonziniif ($#ARGV == -1) { 265e2c54635SPaolo Bonzini usage(); 266e2c54635SPaolo Bonzini} 267e2c54635SPaolo Bonzini 268e2c54635SPaolo Bonzinimy $kernelversion; 269e2c54635SPaolo Bonzinimy $dohighlight = ""; 270e2c54635SPaolo Bonzini 271e2c54635SPaolo Bonzinimy $verbose = 0; 272e2c54635SPaolo Bonzinimy $output_mode = "rst"; 273e2c54635SPaolo Bonzinimy $output_preformatted = 0; 274e2c54635SPaolo Bonzinimy $no_doc_sections = 0; 275e2c54635SPaolo Bonzinimy $enable_lineno = 0; 276e2c54635SPaolo Bonzinimy @highlights = @highlights_rst; 277e2c54635SPaolo Bonzinimy $blankline = $blankline_rst; 278e2c54635SPaolo Bonzinimy $modulename = "Kernel API"; 279e2c54635SPaolo Bonzini 280e2c54635SPaolo Bonziniuse constant { 281e2c54635SPaolo Bonzini OUTPUT_ALL => 0, # output all symbols and doc sections 282e2c54635SPaolo Bonzini OUTPUT_INCLUDE => 1, # output only specified symbols 283e2c54635SPaolo Bonzini OUTPUT_EXCLUDE => 2, # output everything except specified symbols 284e2c54635SPaolo Bonzini OUTPUT_EXPORTED => 3, # output exported symbols 285e2c54635SPaolo Bonzini OUTPUT_INTERNAL => 4, # output non-exported symbols 286e2c54635SPaolo Bonzini}; 287e2c54635SPaolo Bonzinimy $output_selection = OUTPUT_ALL; 288e2c54635SPaolo Bonzinimy $show_not_found = 0; # No longer used 289e2c54635SPaolo Bonzini 290e2c54635SPaolo Bonzinimy @export_file_list; 291e2c54635SPaolo Bonzini 292e2c54635SPaolo Bonzinimy @build_time; 293e2c54635SPaolo Bonziniif (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) && 294e2c54635SPaolo Bonzini (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') { 295e2c54635SPaolo Bonzini @build_time = gmtime($seconds); 296e2c54635SPaolo Bonzini} else { 297e2c54635SPaolo Bonzini @build_time = localtime; 298e2c54635SPaolo Bonzini} 299e2c54635SPaolo Bonzini 300e2c54635SPaolo Bonzinimy $man_date = ('January', 'February', 'March', 'April', 'May', 'June', 301e2c54635SPaolo Bonzini 'July', 'August', 'September', 'October', 302e2c54635SPaolo Bonzini 'November', 'December')[$build_time[4]] . 303e2c54635SPaolo Bonzini " " . ($build_time[5]+1900); 304e2c54635SPaolo Bonzini 305e2c54635SPaolo Bonzini# Essentially these are globals. 306e2c54635SPaolo Bonzini# They probably want to be tidied up, made more localised or something. 307e2c54635SPaolo Bonzini# CAVEAT EMPTOR! Some of the others I localised may not want to be, which 308e2c54635SPaolo Bonzini# could cause "use of undefined value" or other bugs. 309e2c54635SPaolo Bonzinimy ($function, %function_table, %parametertypes, $declaration_purpose); 310e2c54635SPaolo Bonzinimy $declaration_start_line; 311e2c54635SPaolo Bonzinimy ($type, $declaration_name, $return_type); 312e2c54635SPaolo Bonzinimy ($newsection, $newcontents, $prototype, $brcount, %source_map); 313e2c54635SPaolo Bonzini 314e2c54635SPaolo Bonziniif (defined($ENV{'KBUILD_VERBOSE'})) { 315e2c54635SPaolo Bonzini $verbose = "$ENV{'KBUILD_VERBOSE'}"; 316e2c54635SPaolo Bonzini} 317e2c54635SPaolo Bonzini 318e2c54635SPaolo Bonzini# Generated docbook code is inserted in a template at a point where 319e2c54635SPaolo Bonzini# docbook v3.1 requires a non-zero sequence of RefEntry's; see: 320e2c54635SPaolo Bonzini# http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html 321e2c54635SPaolo Bonzini# We keep track of number of generated entries and generate a dummy 322e2c54635SPaolo Bonzini# if needs be to ensure the expanded template can be postprocessed 323e2c54635SPaolo Bonzini# into html. 324e2c54635SPaolo Bonzinimy $section_counter = 0; 325e2c54635SPaolo Bonzini 326e2c54635SPaolo Bonzinimy $lineprefix=""; 327e2c54635SPaolo Bonzini 328e2c54635SPaolo Bonzini# Parser states 329e2c54635SPaolo Bonziniuse constant { 330e2c54635SPaolo Bonzini STATE_NORMAL => 0, # normal code 331e2c54635SPaolo Bonzini STATE_NAME => 1, # looking for function name 332e2c54635SPaolo Bonzini STATE_BODY_MAYBE => 2, # body - or maybe more description 333e2c54635SPaolo Bonzini STATE_BODY => 3, # the body of the comment 334e2c54635SPaolo Bonzini STATE_PROTO => 4, # scanning prototype 335e2c54635SPaolo Bonzini STATE_DOCBLOCK => 5, # documentation block 336e2c54635SPaolo Bonzini STATE_INLINE => 6, # gathering documentation outside main block 337e2c54635SPaolo Bonzini}; 338e2c54635SPaolo Bonzinimy $state; 339e2c54635SPaolo Bonzinimy $in_doc_sect; 340e2c54635SPaolo Bonzinimy $leading_space; 341e2c54635SPaolo Bonzini 342e2c54635SPaolo Bonzini# Inline documentation state 343e2c54635SPaolo Bonziniuse constant { 344e2c54635SPaolo Bonzini STATE_INLINE_NA => 0, # not applicable ($state != STATE_INLINE) 345e2c54635SPaolo Bonzini STATE_INLINE_NAME => 1, # looking for member name (@foo:) 346e2c54635SPaolo Bonzini STATE_INLINE_TEXT => 2, # looking for member documentation 347e2c54635SPaolo Bonzini STATE_INLINE_END => 3, # done 348e2c54635SPaolo Bonzini STATE_INLINE_ERROR => 4, # error - Comment without header was found. 349e2c54635SPaolo Bonzini # Spit a warning as it's not 350e2c54635SPaolo Bonzini # proper kernel-doc and ignore the rest. 351e2c54635SPaolo Bonzini}; 352e2c54635SPaolo Bonzinimy $inline_doc_state; 353e2c54635SPaolo Bonzini 354e2c54635SPaolo Bonzini#declaration types: can be 355e2c54635SPaolo Bonzini# 'function', 'struct', 'union', 'enum', 'typedef' 356e2c54635SPaolo Bonzinimy $decl_type; 357e2c54635SPaolo Bonzini 358e2c54635SPaolo Bonzinimy $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start. 359e2c54635SPaolo Bonzinimy $doc_end = '\*/'; 360e2c54635SPaolo Bonzinimy $doc_com = '\s*\*\s*'; 361e2c54635SPaolo Bonzinimy $doc_com_body = '\s*\* ?'; 362e2c54635SPaolo Bonzinimy $doc_decl = $doc_com . '(\w+)'; 363e2c54635SPaolo Bonzini# @params and a strictly limited set of supported section names 364e2c54635SPaolo Bonzinimy $doc_sect = $doc_com . 365e2c54635SPaolo Bonzini '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:(.*)'; 366e2c54635SPaolo Bonzinimy $doc_content = $doc_com_body . '(.*)'; 367e2c54635SPaolo Bonzinimy $doc_block = $doc_com . 'DOC:\s*(.*)?'; 368e2c54635SPaolo Bonzinimy $doc_inline_start = '^\s*/\*\*\s*$'; 369e2c54635SPaolo Bonzinimy $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)'; 370e2c54635SPaolo Bonzinimy $doc_inline_end = '^\s*\*/\s*$'; 371e2c54635SPaolo Bonzinimy $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$'; 372e2c54635SPaolo Bonzinimy $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;'; 373e2c54635SPaolo Bonzini 374e2c54635SPaolo Bonzinimy %parameterdescs; 375e2c54635SPaolo Bonzinimy %parameterdesc_start_lines; 376e2c54635SPaolo Bonzinimy @parameterlist; 377e2c54635SPaolo Bonzinimy %sections; 378e2c54635SPaolo Bonzinimy @sectionlist; 379e2c54635SPaolo Bonzinimy %section_start_lines; 380e2c54635SPaolo Bonzinimy $sectcheck; 381e2c54635SPaolo Bonzinimy $struct_actual; 382e2c54635SPaolo Bonzini 383e2c54635SPaolo Bonzinimy $contents = ""; 384e2c54635SPaolo Bonzinimy $new_start_line = 0; 385e2c54635SPaolo Bonzini 386e2c54635SPaolo Bonzini# the canonical section names. see also $doc_sect above. 387e2c54635SPaolo Bonzinimy $section_default = "Description"; # default section 388e2c54635SPaolo Bonzinimy $section_intro = "Introduction"; 389e2c54635SPaolo Bonzinimy $section = $section_default; 390e2c54635SPaolo Bonzinimy $section_context = "Context"; 391e2c54635SPaolo Bonzinimy $section_return = "Return"; 392e2c54635SPaolo Bonzini 393e2c54635SPaolo Bonzinimy $undescribed = "-- undescribed --"; 394e2c54635SPaolo Bonzini 395e2c54635SPaolo Bonzinireset_state(); 396e2c54635SPaolo Bonzini 397e2c54635SPaolo Bonziniwhile ($ARGV[0] =~ m/^--?(.*)/) { 398e2c54635SPaolo Bonzini my $cmd = $1; 399e2c54635SPaolo Bonzini shift @ARGV; 400e2c54635SPaolo Bonzini if ($cmd eq "man") { 401e2c54635SPaolo Bonzini $output_mode = "man"; 402e2c54635SPaolo Bonzini @highlights = @highlights_man; 403e2c54635SPaolo Bonzini $blankline = $blankline_man; 404e2c54635SPaolo Bonzini } elsif ($cmd eq "rst") { 405e2c54635SPaolo Bonzini $output_mode = "rst"; 406e2c54635SPaolo Bonzini @highlights = @highlights_rst; 407e2c54635SPaolo Bonzini $blankline = $blankline_rst; 408e2c54635SPaolo Bonzini } elsif ($cmd eq "none") { 409e2c54635SPaolo Bonzini $output_mode = "none"; 410e2c54635SPaolo Bonzini } elsif ($cmd eq "module") { # not needed for XML, inherits from calling document 411e2c54635SPaolo Bonzini $modulename = shift @ARGV; 412e2c54635SPaolo Bonzini } elsif ($cmd eq "function") { # to only output specific functions 413e2c54635SPaolo Bonzini $output_selection = OUTPUT_INCLUDE; 414e2c54635SPaolo Bonzini $function = shift @ARGV; 415e2c54635SPaolo Bonzini $function_table{$function} = 1; 416e2c54635SPaolo Bonzini } elsif ($cmd eq "nofunction") { # output all except specific functions 417e2c54635SPaolo Bonzini $output_selection = OUTPUT_EXCLUDE; 418e2c54635SPaolo Bonzini $function = shift @ARGV; 419e2c54635SPaolo Bonzini $function_table{$function} = 1; 420e2c54635SPaolo Bonzini } elsif ($cmd eq "export") { # only exported symbols 421e2c54635SPaolo Bonzini $output_selection = OUTPUT_EXPORTED; 422e2c54635SPaolo Bonzini %function_table = (); 423e2c54635SPaolo Bonzini } elsif ($cmd eq "internal") { # only non-exported symbols 424e2c54635SPaolo Bonzini $output_selection = OUTPUT_INTERNAL; 425e2c54635SPaolo Bonzini %function_table = (); 426e2c54635SPaolo Bonzini } elsif ($cmd eq "export-file") { 427e2c54635SPaolo Bonzini my $file = shift @ARGV; 428e2c54635SPaolo Bonzini push(@export_file_list, $file); 429e2c54635SPaolo Bonzini } elsif ($cmd eq "v") { 430e2c54635SPaolo Bonzini $verbose = 1; 431e2c54635SPaolo Bonzini } elsif (($cmd eq "h") || ($cmd eq "help")) { 432e2c54635SPaolo Bonzini usage(); 433e2c54635SPaolo Bonzini } elsif ($cmd eq 'no-doc-sections') { 434e2c54635SPaolo Bonzini $no_doc_sections = 1; 435e2c54635SPaolo Bonzini } elsif ($cmd eq 'enable-lineno') { 436e2c54635SPaolo Bonzini $enable_lineno = 1; 437e2c54635SPaolo Bonzini } elsif ($cmd eq 'show-not-found') { 438e2c54635SPaolo Bonzini $show_not_found = 1; # A no-op but don't fail 439e2c54635SPaolo Bonzini } else { 440e2c54635SPaolo Bonzini # Unknown argument 441e2c54635SPaolo Bonzini usage(); 442e2c54635SPaolo Bonzini } 443e2c54635SPaolo Bonzini} 444e2c54635SPaolo Bonzini 445e2c54635SPaolo Bonzini# continue execution near EOF; 446e2c54635SPaolo Bonzini 447e2c54635SPaolo Bonzini# get kernel version from env 448e2c54635SPaolo Bonzinisub get_kernel_version() { 449e2c54635SPaolo Bonzini my $version = 'unknown kernel version'; 450e2c54635SPaolo Bonzini 451e2c54635SPaolo Bonzini if (defined($ENV{'KERNELVERSION'})) { 452e2c54635SPaolo Bonzini $version = $ENV{'KERNELVERSION'}; 453e2c54635SPaolo Bonzini } 454e2c54635SPaolo Bonzini return $version; 455e2c54635SPaolo Bonzini} 456e2c54635SPaolo Bonzini 457e2c54635SPaolo Bonzini# 458e2c54635SPaolo Bonzinisub print_lineno { 459e2c54635SPaolo Bonzini my $lineno = shift; 460e2c54635SPaolo Bonzini if ($enable_lineno && defined($lineno)) { 461e2c54635SPaolo Bonzini print "#define LINENO " . $lineno . "\n"; 462e2c54635SPaolo Bonzini } 463e2c54635SPaolo Bonzini} 464e2c54635SPaolo Bonzini## 465e2c54635SPaolo Bonzini# dumps section contents to arrays/hashes intended for that purpose. 466e2c54635SPaolo Bonzini# 467e2c54635SPaolo Bonzinisub dump_section { 468e2c54635SPaolo Bonzini my $file = shift; 469e2c54635SPaolo Bonzini my $name = shift; 470e2c54635SPaolo Bonzini my $contents = join "\n", @_; 471e2c54635SPaolo Bonzini 472e2c54635SPaolo Bonzini if ($name =~ m/$type_param/) { 473e2c54635SPaolo Bonzini $name = $1; 474e2c54635SPaolo Bonzini $parameterdescs{$name} = $contents; 475e2c54635SPaolo Bonzini $sectcheck = $sectcheck . $name . " "; 476e2c54635SPaolo Bonzini $parameterdesc_start_lines{$name} = $new_start_line; 477e2c54635SPaolo Bonzini $new_start_line = 0; 478e2c54635SPaolo Bonzini } elsif ($name eq "@\.\.\.") { 479e2c54635SPaolo Bonzini $name = "..."; 480e2c54635SPaolo Bonzini $parameterdescs{$name} = $contents; 481e2c54635SPaolo Bonzini $sectcheck = $sectcheck . $name . " "; 482e2c54635SPaolo Bonzini $parameterdesc_start_lines{$name} = $new_start_line; 483e2c54635SPaolo Bonzini $new_start_line = 0; 484e2c54635SPaolo Bonzini } else { 485e2c54635SPaolo Bonzini if (defined($sections{$name}) && ($sections{$name} ne "")) { 486e2c54635SPaolo Bonzini # Only warn on user specified duplicate section names. 487e2c54635SPaolo Bonzini if ($name ne $section_default) { 488e2c54635SPaolo Bonzini print STDERR "${file}:$.: warning: duplicate section name '$name'\n"; 489e2c54635SPaolo Bonzini ++$warnings; 490e2c54635SPaolo Bonzini } 491e2c54635SPaolo Bonzini $sections{$name} .= $contents; 492e2c54635SPaolo Bonzini } else { 493e2c54635SPaolo Bonzini $sections{$name} = $contents; 494e2c54635SPaolo Bonzini push @sectionlist, $name; 495e2c54635SPaolo Bonzini $section_start_lines{$name} = $new_start_line; 496e2c54635SPaolo Bonzini $new_start_line = 0; 497e2c54635SPaolo Bonzini } 498e2c54635SPaolo Bonzini } 499e2c54635SPaolo Bonzini} 500e2c54635SPaolo Bonzini 501e2c54635SPaolo Bonzini## 502e2c54635SPaolo Bonzini# dump DOC: section after checking that it should go out 503e2c54635SPaolo Bonzini# 504e2c54635SPaolo Bonzinisub dump_doc_section { 505e2c54635SPaolo Bonzini my $file = shift; 506e2c54635SPaolo Bonzini my $name = shift; 507e2c54635SPaolo Bonzini my $contents = join "\n", @_; 508e2c54635SPaolo Bonzini 509e2c54635SPaolo Bonzini if ($no_doc_sections) { 510e2c54635SPaolo Bonzini return; 511e2c54635SPaolo Bonzini } 512e2c54635SPaolo Bonzini 513e2c54635SPaolo Bonzini if (($output_selection == OUTPUT_ALL) || 514e2c54635SPaolo Bonzini ($output_selection == OUTPUT_INCLUDE && 515e2c54635SPaolo Bonzini defined($function_table{$name})) || 516e2c54635SPaolo Bonzini ($output_selection == OUTPUT_EXCLUDE && 517e2c54635SPaolo Bonzini !defined($function_table{$name}))) 518e2c54635SPaolo Bonzini { 519e2c54635SPaolo Bonzini dump_section($file, $name, $contents); 520e2c54635SPaolo Bonzini output_blockhead({'sectionlist' => \@sectionlist, 521e2c54635SPaolo Bonzini 'sections' => \%sections, 522e2c54635SPaolo Bonzini 'module' => $modulename, 523e2c54635SPaolo Bonzini 'content-only' => ($output_selection != OUTPUT_ALL), }); 524e2c54635SPaolo Bonzini } 525e2c54635SPaolo Bonzini} 526e2c54635SPaolo Bonzini 527e2c54635SPaolo Bonzini## 528e2c54635SPaolo Bonzini# output function 529e2c54635SPaolo Bonzini# 530e2c54635SPaolo Bonzini# parameterdescs, a hash. 531e2c54635SPaolo Bonzini# function => "function name" 532e2c54635SPaolo Bonzini# parameterlist => @list of parameters 533e2c54635SPaolo Bonzini# parameterdescs => %parameter descriptions 534e2c54635SPaolo Bonzini# sectionlist => @list of sections 535e2c54635SPaolo Bonzini# sections => %section descriptions 536e2c54635SPaolo Bonzini# 537e2c54635SPaolo Bonzini 538e2c54635SPaolo Bonzinisub output_highlight { 539e2c54635SPaolo Bonzini my $contents = join "\n",@_; 540e2c54635SPaolo Bonzini my $line; 541e2c54635SPaolo Bonzini 542e2c54635SPaolo Bonzini# DEBUG 543e2c54635SPaolo Bonzini# if (!defined $contents) { 544e2c54635SPaolo Bonzini# use Carp; 545e2c54635SPaolo Bonzini# confess "output_highlight got called with no args?\n"; 546e2c54635SPaolo Bonzini# } 547e2c54635SPaolo Bonzini 548e2c54635SPaolo Bonzini# print STDERR "contents b4:$contents\n"; 549e2c54635SPaolo Bonzini eval $dohighlight; 550e2c54635SPaolo Bonzini die $@ if $@; 551e2c54635SPaolo Bonzini# print STDERR "contents af:$contents\n"; 552e2c54635SPaolo Bonzini 553e2c54635SPaolo Bonzini foreach $line (split "\n", $contents) { 554e2c54635SPaolo Bonzini if (! $output_preformatted) { 555e2c54635SPaolo Bonzini $line =~ s/^\s*//; 556e2c54635SPaolo Bonzini } 557e2c54635SPaolo Bonzini if ($line eq ""){ 558e2c54635SPaolo Bonzini if (! $output_preformatted) { 559e2c54635SPaolo Bonzini print $lineprefix, $blankline; 560e2c54635SPaolo Bonzini } 561e2c54635SPaolo Bonzini } else { 562e2c54635SPaolo Bonzini if ($output_mode eq "man" && substr($line, 0, 1) eq ".") { 563e2c54635SPaolo Bonzini print "\\&$line"; 564e2c54635SPaolo Bonzini } else { 565e2c54635SPaolo Bonzini print $lineprefix, $line; 566e2c54635SPaolo Bonzini } 567e2c54635SPaolo Bonzini } 568e2c54635SPaolo Bonzini print "\n"; 569e2c54635SPaolo Bonzini } 570e2c54635SPaolo Bonzini} 571e2c54635SPaolo Bonzini 572e2c54635SPaolo Bonzini## 573e2c54635SPaolo Bonzini# output function in man 574e2c54635SPaolo Bonzinisub output_function_man(%) { 575e2c54635SPaolo Bonzini my %args = %{$_[0]}; 576e2c54635SPaolo Bonzini my ($parameter, $section); 577e2c54635SPaolo Bonzini my $count; 578e2c54635SPaolo Bonzini 579e2c54635SPaolo Bonzini print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n"; 580e2c54635SPaolo Bonzini 581e2c54635SPaolo Bonzini print ".SH NAME\n"; 582e2c54635SPaolo Bonzini print $args{'function'} . " \\- " . $args{'purpose'} . "\n"; 583e2c54635SPaolo Bonzini 584e2c54635SPaolo Bonzini print ".SH SYNOPSIS\n"; 585e2c54635SPaolo Bonzini if ($args{'functiontype'} ne "") { 586e2c54635SPaolo Bonzini print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n"; 587e2c54635SPaolo Bonzini } else { 588e2c54635SPaolo Bonzini print ".B \"" . $args{'function'} . "\n"; 589e2c54635SPaolo Bonzini } 590e2c54635SPaolo Bonzini $count = 0; 591e2c54635SPaolo Bonzini my $parenth = "("; 592e2c54635SPaolo Bonzini my $post = ","; 593e2c54635SPaolo Bonzini foreach my $parameter (@{$args{'parameterlist'}}) { 594e2c54635SPaolo Bonzini if ($count == $#{$args{'parameterlist'}}) { 595e2c54635SPaolo Bonzini $post = ");"; 596e2c54635SPaolo Bonzini } 597e2c54635SPaolo Bonzini $type = $args{'parametertypes'}{$parameter}; 598e2c54635SPaolo Bonzini if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 599e2c54635SPaolo Bonzini # pointer-to-function 600e2c54635SPaolo Bonzini print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n"; 601e2c54635SPaolo Bonzini } else { 602e2c54635SPaolo Bonzini $type =~ s/([^\*])$/$1 /; 603e2c54635SPaolo Bonzini print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n"; 604e2c54635SPaolo Bonzini } 605e2c54635SPaolo Bonzini $count++; 606e2c54635SPaolo Bonzini $parenth = ""; 607e2c54635SPaolo Bonzini } 608e2c54635SPaolo Bonzini 609e2c54635SPaolo Bonzini print ".SH ARGUMENTS\n"; 610e2c54635SPaolo Bonzini foreach $parameter (@{$args{'parameterlist'}}) { 611e2c54635SPaolo Bonzini my $parameter_name = $parameter; 612e2c54635SPaolo Bonzini $parameter_name =~ s/\[.*//; 613e2c54635SPaolo Bonzini 614e2c54635SPaolo Bonzini print ".IP \"" . $parameter . "\" 12\n"; 615e2c54635SPaolo Bonzini output_highlight($args{'parameterdescs'}{$parameter_name}); 616e2c54635SPaolo Bonzini } 617e2c54635SPaolo Bonzini foreach $section (@{$args{'sectionlist'}}) { 618e2c54635SPaolo Bonzini print ".SH \"", uc $section, "\"\n"; 619e2c54635SPaolo Bonzini output_highlight($args{'sections'}{$section}); 620e2c54635SPaolo Bonzini } 621e2c54635SPaolo Bonzini} 622e2c54635SPaolo Bonzini 623e2c54635SPaolo Bonzini## 624e2c54635SPaolo Bonzini# output enum in man 625e2c54635SPaolo Bonzinisub output_enum_man(%) { 626e2c54635SPaolo Bonzini my %args = %{$_[0]}; 627e2c54635SPaolo Bonzini my ($parameter, $section); 628e2c54635SPaolo Bonzini my $count; 629e2c54635SPaolo Bonzini 630e2c54635SPaolo Bonzini print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n"; 631e2c54635SPaolo Bonzini 632e2c54635SPaolo Bonzini print ".SH NAME\n"; 633e2c54635SPaolo Bonzini print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n"; 634e2c54635SPaolo Bonzini 635e2c54635SPaolo Bonzini print ".SH SYNOPSIS\n"; 636e2c54635SPaolo Bonzini print "enum " . $args{'enum'} . " {\n"; 637e2c54635SPaolo Bonzini $count = 0; 638e2c54635SPaolo Bonzini foreach my $parameter (@{$args{'parameterlist'}}) { 639e2c54635SPaolo Bonzini print ".br\n.BI \" $parameter\"\n"; 640e2c54635SPaolo Bonzini if ($count == $#{$args{'parameterlist'}}) { 641e2c54635SPaolo Bonzini print "\n};\n"; 642e2c54635SPaolo Bonzini last; 643e2c54635SPaolo Bonzini } 644e2c54635SPaolo Bonzini else { 645e2c54635SPaolo Bonzini print ", \n.br\n"; 646e2c54635SPaolo Bonzini } 647e2c54635SPaolo Bonzini $count++; 648e2c54635SPaolo Bonzini } 649e2c54635SPaolo Bonzini 650e2c54635SPaolo Bonzini print ".SH Constants\n"; 651e2c54635SPaolo Bonzini foreach $parameter (@{$args{'parameterlist'}}) { 652e2c54635SPaolo Bonzini my $parameter_name = $parameter; 653e2c54635SPaolo Bonzini $parameter_name =~ s/\[.*//; 654e2c54635SPaolo Bonzini 655e2c54635SPaolo Bonzini print ".IP \"" . $parameter . "\" 12\n"; 656e2c54635SPaolo Bonzini output_highlight($args{'parameterdescs'}{$parameter_name}); 657e2c54635SPaolo Bonzini } 658e2c54635SPaolo Bonzini foreach $section (@{$args{'sectionlist'}}) { 659e2c54635SPaolo Bonzini print ".SH \"$section\"\n"; 660e2c54635SPaolo Bonzini output_highlight($args{'sections'}{$section}); 661e2c54635SPaolo Bonzini } 662e2c54635SPaolo Bonzini} 663e2c54635SPaolo Bonzini 664e2c54635SPaolo Bonzini## 665e2c54635SPaolo Bonzini# output struct in man 666e2c54635SPaolo Bonzinisub output_struct_man(%) { 667e2c54635SPaolo Bonzini my %args = %{$_[0]}; 668e2c54635SPaolo Bonzini my ($parameter, $section); 669e2c54635SPaolo Bonzini 670e2c54635SPaolo Bonzini print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n"; 671e2c54635SPaolo Bonzini 672e2c54635SPaolo Bonzini print ".SH NAME\n"; 673e2c54635SPaolo Bonzini print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n"; 674e2c54635SPaolo Bonzini 675e2c54635SPaolo Bonzini my $declaration = $args{'definition'}; 676e2c54635SPaolo Bonzini $declaration =~ s/\t/ /g; 677e2c54635SPaolo Bonzini $declaration =~ s/\n/"\n.br\n.BI \"/g; 678e2c54635SPaolo Bonzini print ".SH SYNOPSIS\n"; 679e2c54635SPaolo Bonzini print $args{'type'} . " " . $args{'struct'} . " {\n.br\n"; 680e2c54635SPaolo Bonzini print ".BI \"$declaration\n};\n.br\n\n"; 681e2c54635SPaolo Bonzini 682e2c54635SPaolo Bonzini print ".SH Members\n"; 683e2c54635SPaolo Bonzini foreach $parameter (@{$args{'parameterlist'}}) { 684e2c54635SPaolo Bonzini ($parameter =~ /^#/) && next; 685e2c54635SPaolo Bonzini 686e2c54635SPaolo Bonzini my $parameter_name = $parameter; 687e2c54635SPaolo Bonzini $parameter_name =~ s/\[.*//; 688e2c54635SPaolo Bonzini 689e2c54635SPaolo Bonzini ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 690e2c54635SPaolo Bonzini print ".IP \"" . $parameter . "\" 12\n"; 691e2c54635SPaolo Bonzini output_highlight($args{'parameterdescs'}{$parameter_name}); 692e2c54635SPaolo Bonzini } 693e2c54635SPaolo Bonzini foreach $section (@{$args{'sectionlist'}}) { 694e2c54635SPaolo Bonzini print ".SH \"$section\"\n"; 695e2c54635SPaolo Bonzini output_highlight($args{'sections'}{$section}); 696e2c54635SPaolo Bonzini } 697e2c54635SPaolo Bonzini} 698e2c54635SPaolo Bonzini 699e2c54635SPaolo Bonzini## 700e2c54635SPaolo Bonzini# output typedef in man 701e2c54635SPaolo Bonzinisub output_typedef_man(%) { 702e2c54635SPaolo Bonzini my %args = %{$_[0]}; 703e2c54635SPaolo Bonzini my ($parameter, $section); 704e2c54635SPaolo Bonzini 705e2c54635SPaolo Bonzini print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n"; 706e2c54635SPaolo Bonzini 707e2c54635SPaolo Bonzini print ".SH NAME\n"; 708e2c54635SPaolo Bonzini print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n"; 709e2c54635SPaolo Bonzini 710e2c54635SPaolo Bonzini foreach $section (@{$args{'sectionlist'}}) { 711e2c54635SPaolo Bonzini print ".SH \"$section\"\n"; 712e2c54635SPaolo Bonzini output_highlight($args{'sections'}{$section}); 713e2c54635SPaolo Bonzini } 714e2c54635SPaolo Bonzini} 715e2c54635SPaolo Bonzini 716e2c54635SPaolo Bonzinisub output_blockhead_man(%) { 717e2c54635SPaolo Bonzini my %args = %{$_[0]}; 718e2c54635SPaolo Bonzini my ($parameter, $section); 719e2c54635SPaolo Bonzini my $count; 720e2c54635SPaolo Bonzini 721e2c54635SPaolo Bonzini print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n"; 722e2c54635SPaolo Bonzini 723e2c54635SPaolo Bonzini foreach $section (@{$args{'sectionlist'}}) { 724e2c54635SPaolo Bonzini print ".SH \"$section\"\n"; 725e2c54635SPaolo Bonzini output_highlight($args{'sections'}{$section}); 726e2c54635SPaolo Bonzini } 727e2c54635SPaolo Bonzini} 728e2c54635SPaolo Bonzini 729e2c54635SPaolo Bonzini## 730e2c54635SPaolo Bonzini# output in restructured text 731e2c54635SPaolo Bonzini# 732e2c54635SPaolo Bonzini 733e2c54635SPaolo Bonzini# 734e2c54635SPaolo Bonzini# This could use some work; it's used to output the DOC: sections, and 735e2c54635SPaolo Bonzini# starts by putting out the name of the doc section itself, but that tends 736e2c54635SPaolo Bonzini# to duplicate a header already in the template file. 737e2c54635SPaolo Bonzini# 738e2c54635SPaolo Bonzinisub output_blockhead_rst(%) { 739e2c54635SPaolo Bonzini my %args = %{$_[0]}; 740e2c54635SPaolo Bonzini my ($parameter, $section); 741e2c54635SPaolo Bonzini 742e2c54635SPaolo Bonzini foreach $section (@{$args{'sectionlist'}}) { 743e2c54635SPaolo Bonzini if ($output_selection != OUTPUT_INCLUDE) { 744e2c54635SPaolo Bonzini print "**$section**\n\n"; 745e2c54635SPaolo Bonzini } 746e2c54635SPaolo Bonzini print_lineno($section_start_lines{$section}); 747e2c54635SPaolo Bonzini output_highlight_rst($args{'sections'}{$section}); 748e2c54635SPaolo Bonzini print "\n"; 749e2c54635SPaolo Bonzini } 750e2c54635SPaolo Bonzini} 751e2c54635SPaolo Bonzini 752e2c54635SPaolo Bonzini# 753e2c54635SPaolo Bonzini# Apply the RST highlights to a sub-block of text. 754e2c54635SPaolo Bonzini# 755e2c54635SPaolo Bonzinisub highlight_block($) { 756e2c54635SPaolo Bonzini # The dohighlight kludge requires the text be called $contents 757e2c54635SPaolo Bonzini my $contents = shift; 758e2c54635SPaolo Bonzini eval $dohighlight; 759e2c54635SPaolo Bonzini die $@ if $@; 760e2c54635SPaolo Bonzini return $contents; 761e2c54635SPaolo Bonzini} 762e2c54635SPaolo Bonzini 763e2c54635SPaolo Bonzini# 764e2c54635SPaolo Bonzini# Regexes used only here. 765e2c54635SPaolo Bonzini# 766e2c54635SPaolo Bonzinimy $sphinx_literal = '^[^.].*::$'; 767e2c54635SPaolo Bonzinimy $sphinx_cblock = '^\.\.\ +code-block::'; 768e2c54635SPaolo Bonzini 769e2c54635SPaolo Bonzinisub output_highlight_rst { 770e2c54635SPaolo Bonzini my $input = join "\n",@_; 771e2c54635SPaolo Bonzini my $output = ""; 772e2c54635SPaolo Bonzini my $line; 773e2c54635SPaolo Bonzini my $in_literal = 0; 774e2c54635SPaolo Bonzini my $litprefix; 775e2c54635SPaolo Bonzini my $block = ""; 776e2c54635SPaolo Bonzini 777e2c54635SPaolo Bonzini foreach $line (split "\n",$input) { 778e2c54635SPaolo Bonzini # 779e2c54635SPaolo Bonzini # If we're in a literal block, see if we should drop out 780e2c54635SPaolo Bonzini # of it. Otherwise pass the line straight through unmunged. 781e2c54635SPaolo Bonzini # 782e2c54635SPaolo Bonzini if ($in_literal) { 783e2c54635SPaolo Bonzini if (! ($line =~ /^\s*$/)) { 784e2c54635SPaolo Bonzini # 785e2c54635SPaolo Bonzini # If this is the first non-blank line in a literal 786e2c54635SPaolo Bonzini # block we need to figure out what the proper indent is. 787e2c54635SPaolo Bonzini # 788e2c54635SPaolo Bonzini if ($litprefix eq "") { 789e2c54635SPaolo Bonzini $line =~ /^(\s*)/; 790e2c54635SPaolo Bonzini $litprefix = '^' . $1; 791e2c54635SPaolo Bonzini $output .= $line . "\n"; 792e2c54635SPaolo Bonzini } elsif (! ($line =~ /$litprefix/)) { 793e2c54635SPaolo Bonzini $in_literal = 0; 794e2c54635SPaolo Bonzini } else { 795e2c54635SPaolo Bonzini $output .= $line . "\n"; 796e2c54635SPaolo Bonzini } 797e2c54635SPaolo Bonzini } else { 798e2c54635SPaolo Bonzini $output .= $line . "\n"; 799e2c54635SPaolo Bonzini } 800e2c54635SPaolo Bonzini } 801e2c54635SPaolo Bonzini # 802e2c54635SPaolo Bonzini # Not in a literal block (or just dropped out) 803e2c54635SPaolo Bonzini # 804e2c54635SPaolo Bonzini if (! $in_literal) { 805e2c54635SPaolo Bonzini $block .= $line . "\n"; 806e2c54635SPaolo Bonzini if (($line =~ /$sphinx_literal/) || ($line =~ /$sphinx_cblock/)) { 807e2c54635SPaolo Bonzini $in_literal = 1; 808e2c54635SPaolo Bonzini $litprefix = ""; 809e2c54635SPaolo Bonzini $output .= highlight_block($block); 810e2c54635SPaolo Bonzini $block = "" 811e2c54635SPaolo Bonzini } 812e2c54635SPaolo Bonzini } 813e2c54635SPaolo Bonzini } 814e2c54635SPaolo Bonzini 815e2c54635SPaolo Bonzini if ($block) { 816e2c54635SPaolo Bonzini $output .= highlight_block($block); 817e2c54635SPaolo Bonzini } 818e2c54635SPaolo Bonzini foreach $line (split "\n", $output) { 819e2c54635SPaolo Bonzini print $lineprefix . $line . "\n"; 820e2c54635SPaolo Bonzini } 821e2c54635SPaolo Bonzini} 822e2c54635SPaolo Bonzini 823e2c54635SPaolo Bonzinisub output_function_rst(%) { 824e2c54635SPaolo Bonzini my %args = %{$_[0]}; 825e2c54635SPaolo Bonzini my ($parameter, $section); 826e2c54635SPaolo Bonzini my $oldprefix = $lineprefix; 827e2c54635SPaolo Bonzini my $start = ""; 828e2c54635SPaolo Bonzini 829e2c54635SPaolo Bonzini if ($args{'typedef'}) { 830e2c54635SPaolo Bonzini print ".. c:type:: ". $args{'function'} . "\n\n"; 831e2c54635SPaolo Bonzini print_lineno($declaration_start_line); 832e2c54635SPaolo Bonzini print " **Typedef**: "; 833e2c54635SPaolo Bonzini $lineprefix = ""; 834e2c54635SPaolo Bonzini output_highlight_rst($args{'purpose'}); 835e2c54635SPaolo Bonzini $start = "\n\n**Syntax**\n\n ``"; 836e2c54635SPaolo Bonzini } else { 837e2c54635SPaolo Bonzini print ".. c:function:: "; 838e2c54635SPaolo Bonzini } 839e2c54635SPaolo Bonzini if ($args{'functiontype'} ne "") { 840e2c54635SPaolo Bonzini $start .= $args{'functiontype'} . " " . $args{'function'} . " ("; 841e2c54635SPaolo Bonzini } else { 842e2c54635SPaolo Bonzini $start .= $args{'function'} . " ("; 843e2c54635SPaolo Bonzini } 844e2c54635SPaolo Bonzini print $start; 845e2c54635SPaolo Bonzini 846e2c54635SPaolo Bonzini my $count = 0; 847e2c54635SPaolo Bonzini foreach my $parameter (@{$args{'parameterlist'}}) { 848e2c54635SPaolo Bonzini if ($count ne 0) { 849e2c54635SPaolo Bonzini print ", "; 850e2c54635SPaolo Bonzini } 851e2c54635SPaolo Bonzini $count++; 852e2c54635SPaolo Bonzini $type = $args{'parametertypes'}{$parameter}; 853e2c54635SPaolo Bonzini 854e2c54635SPaolo Bonzini if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 855e2c54635SPaolo Bonzini # pointer-to-function 856*a62d5637SPeter Maydell print $1 . $parameter . ") (" . $2 . ")"; 857e2c54635SPaolo Bonzini } else { 858e2c54635SPaolo Bonzini print $type . " " . $parameter; 859e2c54635SPaolo Bonzini } 860e2c54635SPaolo Bonzini } 861e2c54635SPaolo Bonzini if ($args{'typedef'}) { 862e2c54635SPaolo Bonzini print ");``\n\n"; 863e2c54635SPaolo Bonzini } else { 864e2c54635SPaolo Bonzini print ")\n\n"; 865e2c54635SPaolo Bonzini print_lineno($declaration_start_line); 866e2c54635SPaolo Bonzini $lineprefix = " "; 867e2c54635SPaolo Bonzini output_highlight_rst($args{'purpose'}); 868e2c54635SPaolo Bonzini print "\n"; 869e2c54635SPaolo Bonzini } 870e2c54635SPaolo Bonzini 871e2c54635SPaolo Bonzini print "**Parameters**\n\n"; 872e2c54635SPaolo Bonzini $lineprefix = " "; 873e2c54635SPaolo Bonzini foreach $parameter (@{$args{'parameterlist'}}) { 874e2c54635SPaolo Bonzini my $parameter_name = $parameter; 875e2c54635SPaolo Bonzini $parameter_name =~ s/\[.*//; 876e2c54635SPaolo Bonzini $type = $args{'parametertypes'}{$parameter}; 877e2c54635SPaolo Bonzini 878e2c54635SPaolo Bonzini if ($type ne "") { 879e2c54635SPaolo Bonzini print "``$type $parameter``\n"; 880e2c54635SPaolo Bonzini } else { 881e2c54635SPaolo Bonzini print "``$parameter``\n"; 882e2c54635SPaolo Bonzini } 883e2c54635SPaolo Bonzini 884e2c54635SPaolo Bonzini print_lineno($parameterdesc_start_lines{$parameter_name}); 885e2c54635SPaolo Bonzini 886e2c54635SPaolo Bonzini if (defined($args{'parameterdescs'}{$parameter_name}) && 887e2c54635SPaolo Bonzini $args{'parameterdescs'}{$parameter_name} ne $undescribed) { 888e2c54635SPaolo Bonzini output_highlight_rst($args{'parameterdescs'}{$parameter_name}); 889e2c54635SPaolo Bonzini } else { 890e2c54635SPaolo Bonzini print " *undescribed*\n"; 891e2c54635SPaolo Bonzini } 892e2c54635SPaolo Bonzini print "\n"; 893e2c54635SPaolo Bonzini } 894e2c54635SPaolo Bonzini 895e2c54635SPaolo Bonzini $lineprefix = $oldprefix; 896e2c54635SPaolo Bonzini output_section_rst(@_); 897e2c54635SPaolo Bonzini} 898e2c54635SPaolo Bonzini 899e2c54635SPaolo Bonzinisub output_section_rst(%) { 900e2c54635SPaolo Bonzini my %args = %{$_[0]}; 901e2c54635SPaolo Bonzini my $section; 902e2c54635SPaolo Bonzini my $oldprefix = $lineprefix; 903e2c54635SPaolo Bonzini $lineprefix = ""; 904e2c54635SPaolo Bonzini 905e2c54635SPaolo Bonzini foreach $section (@{$args{'sectionlist'}}) { 906e2c54635SPaolo Bonzini print "**$section**\n\n"; 907e2c54635SPaolo Bonzini print_lineno($section_start_lines{$section}); 908e2c54635SPaolo Bonzini output_highlight_rst($args{'sections'}{$section}); 909e2c54635SPaolo Bonzini print "\n"; 910e2c54635SPaolo Bonzini } 911e2c54635SPaolo Bonzini print "\n"; 912e2c54635SPaolo Bonzini $lineprefix = $oldprefix; 913e2c54635SPaolo Bonzini} 914e2c54635SPaolo Bonzini 915e2c54635SPaolo Bonzinisub output_enum_rst(%) { 916e2c54635SPaolo Bonzini my %args = %{$_[0]}; 917e2c54635SPaolo Bonzini my ($parameter); 918e2c54635SPaolo Bonzini my $oldprefix = $lineprefix; 919e2c54635SPaolo Bonzini my $count; 920e2c54635SPaolo Bonzini my $name = "enum " . $args{'enum'}; 921e2c54635SPaolo Bonzini 922e2c54635SPaolo Bonzini print "\n\n.. c:type:: " . $name . "\n\n"; 923e2c54635SPaolo Bonzini print_lineno($declaration_start_line); 924e2c54635SPaolo Bonzini $lineprefix = " "; 925e2c54635SPaolo Bonzini output_highlight_rst($args{'purpose'}); 926e2c54635SPaolo Bonzini print "\n"; 927e2c54635SPaolo Bonzini 928e2c54635SPaolo Bonzini print "**Constants**\n\n"; 929e2c54635SPaolo Bonzini $lineprefix = " "; 930e2c54635SPaolo Bonzini foreach $parameter (@{$args{'parameterlist'}}) { 931e2c54635SPaolo Bonzini print "``$parameter``\n"; 932e2c54635SPaolo Bonzini if ($args{'parameterdescs'}{$parameter} ne $undescribed) { 933e2c54635SPaolo Bonzini output_highlight_rst($args{'parameterdescs'}{$parameter}); 934e2c54635SPaolo Bonzini } else { 935e2c54635SPaolo Bonzini print " *undescribed*\n"; 936e2c54635SPaolo Bonzini } 937e2c54635SPaolo Bonzini print "\n"; 938e2c54635SPaolo Bonzini } 939e2c54635SPaolo Bonzini 940e2c54635SPaolo Bonzini $lineprefix = $oldprefix; 941e2c54635SPaolo Bonzini output_section_rst(@_); 942e2c54635SPaolo Bonzini} 943e2c54635SPaolo Bonzini 944e2c54635SPaolo Bonzinisub output_typedef_rst(%) { 945e2c54635SPaolo Bonzini my %args = %{$_[0]}; 946e2c54635SPaolo Bonzini my ($parameter); 947e2c54635SPaolo Bonzini my $oldprefix = $lineprefix; 948e2c54635SPaolo Bonzini my $name = "typedef " . $args{'typedef'}; 949e2c54635SPaolo Bonzini 950e2c54635SPaolo Bonzini print "\n\n.. c:type:: " . $name . "\n\n"; 951e2c54635SPaolo Bonzini print_lineno($declaration_start_line); 952e2c54635SPaolo Bonzini $lineprefix = " "; 953e2c54635SPaolo Bonzini output_highlight_rst($args{'purpose'}); 954e2c54635SPaolo Bonzini print "\n"; 955e2c54635SPaolo Bonzini 956e2c54635SPaolo Bonzini $lineprefix = $oldprefix; 957e2c54635SPaolo Bonzini output_section_rst(@_); 958e2c54635SPaolo Bonzini} 959e2c54635SPaolo Bonzini 960e2c54635SPaolo Bonzinisub output_struct_rst(%) { 961e2c54635SPaolo Bonzini my %args = %{$_[0]}; 962e2c54635SPaolo Bonzini my ($parameter); 963e2c54635SPaolo Bonzini my $oldprefix = $lineprefix; 964e2c54635SPaolo Bonzini my $name = $args{'type'} . " " . $args{'struct'}; 965e2c54635SPaolo Bonzini 966e2c54635SPaolo Bonzini print "\n\n.. c:type:: " . $name . "\n\n"; 967e2c54635SPaolo Bonzini print_lineno($declaration_start_line); 968e2c54635SPaolo Bonzini $lineprefix = " "; 969e2c54635SPaolo Bonzini output_highlight_rst($args{'purpose'}); 970e2c54635SPaolo Bonzini print "\n"; 971e2c54635SPaolo Bonzini 972e2c54635SPaolo Bonzini print "**Definition**\n\n"; 973e2c54635SPaolo Bonzini print "::\n\n"; 974e2c54635SPaolo Bonzini my $declaration = $args{'definition'}; 975e2c54635SPaolo Bonzini $declaration =~ s/\t/ /g; 976e2c54635SPaolo Bonzini print " " . $args{'type'} . " " . $args{'struct'} . " {\n$declaration };\n\n"; 977e2c54635SPaolo Bonzini 978e2c54635SPaolo Bonzini print "**Members**\n\n"; 979e2c54635SPaolo Bonzini $lineprefix = " "; 980e2c54635SPaolo Bonzini foreach $parameter (@{$args{'parameterlist'}}) { 981e2c54635SPaolo Bonzini ($parameter =~ /^#/) && next; 982e2c54635SPaolo Bonzini 983e2c54635SPaolo Bonzini my $parameter_name = $parameter; 984e2c54635SPaolo Bonzini $parameter_name =~ s/\[.*//; 985e2c54635SPaolo Bonzini 986e2c54635SPaolo Bonzini ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 987e2c54635SPaolo Bonzini $type = $args{'parametertypes'}{$parameter}; 988e2c54635SPaolo Bonzini print_lineno($parameterdesc_start_lines{$parameter_name}); 989e2c54635SPaolo Bonzini print "``" . $parameter . "``\n"; 990e2c54635SPaolo Bonzini output_highlight_rst($args{'parameterdescs'}{$parameter_name}); 991e2c54635SPaolo Bonzini print "\n"; 992e2c54635SPaolo Bonzini } 993e2c54635SPaolo Bonzini print "\n"; 994e2c54635SPaolo Bonzini 995e2c54635SPaolo Bonzini $lineprefix = $oldprefix; 996e2c54635SPaolo Bonzini output_section_rst(@_); 997e2c54635SPaolo Bonzini} 998e2c54635SPaolo Bonzini 999e2c54635SPaolo Bonzini## none mode output functions 1000e2c54635SPaolo Bonzini 1001e2c54635SPaolo Bonzinisub output_function_none(%) { 1002e2c54635SPaolo Bonzini} 1003e2c54635SPaolo Bonzini 1004e2c54635SPaolo Bonzinisub output_enum_none(%) { 1005e2c54635SPaolo Bonzini} 1006e2c54635SPaolo Bonzini 1007e2c54635SPaolo Bonzinisub output_typedef_none(%) { 1008e2c54635SPaolo Bonzini} 1009e2c54635SPaolo Bonzini 1010e2c54635SPaolo Bonzinisub output_struct_none(%) { 1011e2c54635SPaolo Bonzini} 1012e2c54635SPaolo Bonzini 1013e2c54635SPaolo Bonzinisub output_blockhead_none(%) { 1014e2c54635SPaolo Bonzini} 1015e2c54635SPaolo Bonzini 1016e2c54635SPaolo Bonzini## 1017e2c54635SPaolo Bonzini# generic output function for all types (function, struct/union, typedef, enum); 1018e2c54635SPaolo Bonzini# calls the generated, variable output_ function name based on 1019e2c54635SPaolo Bonzini# functype and output_mode 1020e2c54635SPaolo Bonzinisub output_declaration { 1021e2c54635SPaolo Bonzini no strict 'refs'; 1022e2c54635SPaolo Bonzini my $name = shift; 1023e2c54635SPaolo Bonzini my $functype = shift; 1024e2c54635SPaolo Bonzini my $func = "output_${functype}_$output_mode"; 1025e2c54635SPaolo Bonzini if (($output_selection == OUTPUT_ALL) || 1026e2c54635SPaolo Bonzini (($output_selection == OUTPUT_INCLUDE || 1027e2c54635SPaolo Bonzini $output_selection == OUTPUT_EXPORTED) && 1028e2c54635SPaolo Bonzini defined($function_table{$name})) || 1029e2c54635SPaolo Bonzini (($output_selection == OUTPUT_EXCLUDE || 1030e2c54635SPaolo Bonzini $output_selection == OUTPUT_INTERNAL) && 1031e2c54635SPaolo Bonzini !($functype eq "function" && defined($function_table{$name})))) 1032e2c54635SPaolo Bonzini { 1033e2c54635SPaolo Bonzini &$func(@_); 1034e2c54635SPaolo Bonzini $section_counter++; 1035e2c54635SPaolo Bonzini } 1036e2c54635SPaolo Bonzini} 1037e2c54635SPaolo Bonzini 1038e2c54635SPaolo Bonzini## 1039e2c54635SPaolo Bonzini# generic output function - calls the right one based on current output mode. 1040e2c54635SPaolo Bonzinisub output_blockhead { 1041e2c54635SPaolo Bonzini no strict 'refs'; 1042e2c54635SPaolo Bonzini my $func = "output_blockhead_" . $output_mode; 1043e2c54635SPaolo Bonzini &$func(@_); 1044e2c54635SPaolo Bonzini $section_counter++; 1045e2c54635SPaolo Bonzini} 1046e2c54635SPaolo Bonzini 1047e2c54635SPaolo Bonzini## 1048e2c54635SPaolo Bonzini# takes a declaration (struct, union, enum, typedef) and 1049e2c54635SPaolo Bonzini# invokes the right handler. NOT called for functions. 1050e2c54635SPaolo Bonzinisub dump_declaration($$) { 1051e2c54635SPaolo Bonzini no strict 'refs'; 1052e2c54635SPaolo Bonzini my ($prototype, $file) = @_; 10534cf41794SPaolo Bonzini if ($decl_type eq 'type name') { 10544cf41794SPaolo Bonzini if ($prototype =~ /^(enum|struct|union)\s+/) { 10554cf41794SPaolo Bonzini $decl_type = $1; 10564cf41794SPaolo Bonzini } else { 10574cf41794SPaolo Bonzini return; 10584cf41794SPaolo Bonzini } 10594cf41794SPaolo Bonzini } 10604cf41794SPaolo Bonzini 1061e2c54635SPaolo Bonzini my $func = "dump_" . $decl_type; 1062e2c54635SPaolo Bonzini &$func(@_); 1063e2c54635SPaolo Bonzini} 1064e2c54635SPaolo Bonzini 1065e2c54635SPaolo Bonzinisub dump_union($$) { 1066e2c54635SPaolo Bonzini dump_struct(@_); 1067e2c54635SPaolo Bonzini} 1068e2c54635SPaolo Bonzini 1069e2c54635SPaolo Bonzinisub dump_struct($$) { 1070e2c54635SPaolo Bonzini my $x = shift; 1071e2c54635SPaolo Bonzini my $file = shift; 1072e2c54635SPaolo Bonzini 1073e2c54635SPaolo Bonzini if ($x =~ /(struct|union)\s+(\w+)\s*\{(.*)\}(\s*(__packed|__aligned|__attribute__\s*\(\([a-z0-9,_\s\(\)]*\)\)))*/) { 1074e2c54635SPaolo Bonzini my $decl_type = $1; 1075e2c54635SPaolo Bonzini $declaration_name = $2; 1076e2c54635SPaolo Bonzini my $members = $3; 1077e2c54635SPaolo Bonzini 1078e2c54635SPaolo Bonzini # ignore members marked private: 1079e2c54635SPaolo Bonzini $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi; 1080e2c54635SPaolo Bonzini $members =~ s/\/\*\s*private:.*//gosi; 1081e2c54635SPaolo Bonzini # strip comments: 1082e2c54635SPaolo Bonzini $members =~ s/\/\*.*?\*\///gos; 1083e2c54635SPaolo Bonzini # strip attributes 1084e2c54635SPaolo Bonzini $members =~ s/\s*__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)//gi; 1085e2c54635SPaolo Bonzini $members =~ s/\s*__aligned\s*\([^;]*\)//gos; 1086e2c54635SPaolo Bonzini $members =~ s/\s*__packed\s*//gos; 1087e2c54635SPaolo Bonzini $members =~ s/\s*CRYPTO_MINALIGN_ATTR//gos; 1088e2c54635SPaolo Bonzini # replace DECLARE_BITMAP 1089e2c54635SPaolo Bonzini $members =~ s/DECLARE_BITMAP\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos; 1090e2c54635SPaolo Bonzini # replace DECLARE_HASHTABLE 1091e2c54635SPaolo Bonzini $members =~ s/DECLARE_HASHTABLE\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[1 << (($2) - 1)\]/gos; 1092e2c54635SPaolo Bonzini # replace DECLARE_KFIFO 1093e2c54635SPaolo Bonzini $members =~ s/DECLARE_KFIFO\s*\(([^,)]+),\s*([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos; 1094e2c54635SPaolo Bonzini # replace DECLARE_KFIFO_PTR 1095e2c54635SPaolo Bonzini $members =~ s/DECLARE_KFIFO_PTR\s*\(([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos; 1096e2c54635SPaolo Bonzini 1097e2c54635SPaolo Bonzini my $declaration = $members; 1098e2c54635SPaolo Bonzini 1099e2c54635SPaolo Bonzini # Split nested struct/union elements as newer ones 1100e2c54635SPaolo Bonzini while ($members =~ m/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/) { 1101e2c54635SPaolo Bonzini my $newmember; 1102e2c54635SPaolo Bonzini my $maintype = $1; 1103e2c54635SPaolo Bonzini my $ids = $4; 1104e2c54635SPaolo Bonzini my $content = $3; 1105e2c54635SPaolo Bonzini foreach my $id(split /,/, $ids) { 1106e2c54635SPaolo Bonzini $newmember .= "$maintype $id; "; 1107e2c54635SPaolo Bonzini 1108e2c54635SPaolo Bonzini $id =~ s/[:\[].*//; 1109e2c54635SPaolo Bonzini $id =~ s/^\s*\**(\S+)\s*/$1/; 1110e2c54635SPaolo Bonzini foreach my $arg (split /;/, $content) { 1111e2c54635SPaolo Bonzini next if ($arg =~ m/^\s*$/); 1112e2c54635SPaolo Bonzini if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) { 1113e2c54635SPaolo Bonzini # pointer-to-function 1114e2c54635SPaolo Bonzini my $type = $1; 1115e2c54635SPaolo Bonzini my $name = $2; 1116e2c54635SPaolo Bonzini my $extra = $3; 1117e2c54635SPaolo Bonzini next if (!$name); 1118e2c54635SPaolo Bonzini if ($id =~ m/^\s*$/) { 1119e2c54635SPaolo Bonzini # anonymous struct/union 1120e2c54635SPaolo Bonzini $newmember .= "$type$name$extra; "; 1121e2c54635SPaolo Bonzini } else { 1122e2c54635SPaolo Bonzini $newmember .= "$type$id.$name$extra; "; 1123e2c54635SPaolo Bonzini } 1124e2c54635SPaolo Bonzini } else { 1125e2c54635SPaolo Bonzini my $type; 1126e2c54635SPaolo Bonzini my $names; 1127e2c54635SPaolo Bonzini $arg =~ s/^\s+//; 1128e2c54635SPaolo Bonzini $arg =~ s/\s+$//; 1129e2c54635SPaolo Bonzini # Handle bitmaps 1130e2c54635SPaolo Bonzini $arg =~ s/:\s*\d+\s*//g; 1131e2c54635SPaolo Bonzini # Handle arrays 1132e2c54635SPaolo Bonzini $arg =~ s/\[.*\]//g; 1133e2c54635SPaolo Bonzini # The type may have multiple words, 1134e2c54635SPaolo Bonzini # and multiple IDs can be defined, like: 1135e2c54635SPaolo Bonzini # const struct foo, *bar, foobar 1136e2c54635SPaolo Bonzini # So, we remove spaces when parsing the 1137e2c54635SPaolo Bonzini # names, in order to match just names 1138e2c54635SPaolo Bonzini # and commas for the names 1139e2c54635SPaolo Bonzini $arg =~ s/\s*,\s*/,/g; 1140e2c54635SPaolo Bonzini if ($arg =~ m/(.*)\s+([\S+,]+)/) { 1141e2c54635SPaolo Bonzini $type = $1; 1142e2c54635SPaolo Bonzini $names = $2; 1143e2c54635SPaolo Bonzini } else { 1144e2c54635SPaolo Bonzini $newmember .= "$arg; "; 1145e2c54635SPaolo Bonzini next; 1146e2c54635SPaolo Bonzini } 1147e2c54635SPaolo Bonzini foreach my $name (split /,/, $names) { 1148e2c54635SPaolo Bonzini $name =~ s/^\s*\**(\S+)\s*/$1/; 1149e2c54635SPaolo Bonzini next if (($name =~ m/^\s*$/)); 1150e2c54635SPaolo Bonzini if ($id =~ m/^\s*$/) { 1151e2c54635SPaolo Bonzini # anonymous struct/union 1152e2c54635SPaolo Bonzini $newmember .= "$type $name; "; 1153e2c54635SPaolo Bonzini } else { 1154e2c54635SPaolo Bonzini $newmember .= "$type $id.$name; "; 1155e2c54635SPaolo Bonzini } 1156e2c54635SPaolo Bonzini } 1157e2c54635SPaolo Bonzini } 1158e2c54635SPaolo Bonzini } 1159e2c54635SPaolo Bonzini } 1160e2c54635SPaolo Bonzini $members =~ s/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/$newmember/; 1161e2c54635SPaolo Bonzini } 1162e2c54635SPaolo Bonzini 1163e2c54635SPaolo Bonzini # Ignore other nested elements, like enums 1164e2c54635SPaolo Bonzini $members =~ s/(\{[^\{\}]*\})//g; 1165e2c54635SPaolo Bonzini 1166e2c54635SPaolo Bonzini create_parameterlist($members, ';', $file, $declaration_name); 1167e2c54635SPaolo Bonzini check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual); 1168e2c54635SPaolo Bonzini 1169e2c54635SPaolo Bonzini # Adjust declaration for better display 1170e2c54635SPaolo Bonzini $declaration =~ s/([\{;])/$1\n/g; 1171e2c54635SPaolo Bonzini $declaration =~ s/\}\s+;/};/g; 1172e2c54635SPaolo Bonzini # Better handle inlined enums 1173e2c54635SPaolo Bonzini do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/); 1174e2c54635SPaolo Bonzini 1175e2c54635SPaolo Bonzini my @def_args = split /\n/, $declaration; 1176e2c54635SPaolo Bonzini my $level = 1; 1177e2c54635SPaolo Bonzini $declaration = ""; 1178e2c54635SPaolo Bonzini foreach my $clause (@def_args) { 1179e2c54635SPaolo Bonzini $clause =~ s/^\s+//; 1180e2c54635SPaolo Bonzini $clause =~ s/\s+$//; 1181e2c54635SPaolo Bonzini $clause =~ s/\s+/ /; 1182e2c54635SPaolo Bonzini next if (!$clause); 1183e2c54635SPaolo Bonzini $level-- if ($clause =~ m/(\})/ && $level > 1); 1184e2c54635SPaolo Bonzini if (!($clause =~ m/^\s*#/)) { 1185e2c54635SPaolo Bonzini $declaration .= "\t" x $level; 1186e2c54635SPaolo Bonzini } 1187e2c54635SPaolo Bonzini $declaration .= "\t" . $clause . "\n"; 1188e2c54635SPaolo Bonzini $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/)); 1189e2c54635SPaolo Bonzini } 1190e2c54635SPaolo Bonzini output_declaration($declaration_name, 1191e2c54635SPaolo Bonzini 'struct', 1192e2c54635SPaolo Bonzini {'struct' => $declaration_name, 1193e2c54635SPaolo Bonzini 'module' => $modulename, 1194e2c54635SPaolo Bonzini 'definition' => $declaration, 1195e2c54635SPaolo Bonzini 'parameterlist' => \@parameterlist, 1196e2c54635SPaolo Bonzini 'parameterdescs' => \%parameterdescs, 1197e2c54635SPaolo Bonzini 'parametertypes' => \%parametertypes, 1198e2c54635SPaolo Bonzini 'sectionlist' => \@sectionlist, 1199e2c54635SPaolo Bonzini 'sections' => \%sections, 1200e2c54635SPaolo Bonzini 'purpose' => $declaration_purpose, 1201e2c54635SPaolo Bonzini 'type' => $decl_type 1202e2c54635SPaolo Bonzini }); 1203e2c54635SPaolo Bonzini } 1204e2c54635SPaolo Bonzini else { 1205e2c54635SPaolo Bonzini print STDERR "${file}:$.: error: Cannot parse struct or union!\n"; 1206e2c54635SPaolo Bonzini ++$errors; 1207e2c54635SPaolo Bonzini } 1208e2c54635SPaolo Bonzini} 1209e2c54635SPaolo Bonzini 1210e2c54635SPaolo Bonzini 1211e2c54635SPaolo Bonzinisub show_warnings($$) { 1212e2c54635SPaolo Bonzini my $functype = shift; 1213e2c54635SPaolo Bonzini my $name = shift; 1214e2c54635SPaolo Bonzini 1215e2c54635SPaolo Bonzini return 1 if ($output_selection == OUTPUT_ALL); 1216e2c54635SPaolo Bonzini 1217e2c54635SPaolo Bonzini if ($output_selection == OUTPUT_EXPORTED) { 1218e2c54635SPaolo Bonzini if (defined($function_table{$name})) { 1219e2c54635SPaolo Bonzini return 1; 1220e2c54635SPaolo Bonzini } else { 1221e2c54635SPaolo Bonzini return 0; 1222e2c54635SPaolo Bonzini } 1223e2c54635SPaolo Bonzini } 1224e2c54635SPaolo Bonzini if ($output_selection == OUTPUT_INTERNAL) { 1225e2c54635SPaolo Bonzini if (!($functype eq "function" && defined($function_table{$name}))) { 1226e2c54635SPaolo Bonzini return 1; 1227e2c54635SPaolo Bonzini } else { 1228e2c54635SPaolo Bonzini return 0; 1229e2c54635SPaolo Bonzini } 1230e2c54635SPaolo Bonzini } 1231e2c54635SPaolo Bonzini if ($output_selection == OUTPUT_INCLUDE) { 1232e2c54635SPaolo Bonzini if (defined($function_table{$name})) { 1233e2c54635SPaolo Bonzini return 1; 1234e2c54635SPaolo Bonzini } else { 1235e2c54635SPaolo Bonzini return 0; 1236e2c54635SPaolo Bonzini } 1237e2c54635SPaolo Bonzini } 1238e2c54635SPaolo Bonzini if ($output_selection == OUTPUT_EXCLUDE) { 1239e2c54635SPaolo Bonzini if (!defined($function_table{$name})) { 1240e2c54635SPaolo Bonzini return 1; 1241e2c54635SPaolo Bonzini } else { 1242e2c54635SPaolo Bonzini return 0; 1243e2c54635SPaolo Bonzini } 1244e2c54635SPaolo Bonzini } 1245e2c54635SPaolo Bonzini die("Please add the new output type at show_warnings()"); 1246e2c54635SPaolo Bonzini} 1247e2c54635SPaolo Bonzini 1248e2c54635SPaolo Bonzinisub dump_enum($$) { 1249e2c54635SPaolo Bonzini my $x = shift; 1250e2c54635SPaolo Bonzini my $file = shift; 1251e2c54635SPaolo Bonzini 1252e2c54635SPaolo Bonzini $x =~ s@/\*.*?\*/@@gos; # strip comments. 1253e2c54635SPaolo Bonzini # strip #define macros inside enums 1254e2c54635SPaolo Bonzini $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos; 1255e2c54635SPaolo Bonzini 1256e2c54635SPaolo Bonzini if ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) { 1257e2c54635SPaolo Bonzini $declaration_name = $1; 1258e2c54635SPaolo Bonzini my $members = $2; 1259e2c54635SPaolo Bonzini my %_members; 1260e2c54635SPaolo Bonzini 1261e2c54635SPaolo Bonzini $members =~ s/\s+$//; 1262e2c54635SPaolo Bonzini 1263e2c54635SPaolo Bonzini foreach my $arg (split ',', $members) { 1264e2c54635SPaolo Bonzini $arg =~ s/^\s*(\w+).*/$1/; 1265e2c54635SPaolo Bonzini push @parameterlist, $arg; 1266e2c54635SPaolo Bonzini if (!$parameterdescs{$arg}) { 1267e2c54635SPaolo Bonzini $parameterdescs{$arg} = $undescribed; 1268e2c54635SPaolo Bonzini if (show_warnings("enum", $declaration_name)) { 1269e2c54635SPaolo Bonzini print STDERR "${file}:$.: warning: Enum value '$arg' not described in enum '$declaration_name'\n"; 1270e2c54635SPaolo Bonzini } 1271e2c54635SPaolo Bonzini } 1272e2c54635SPaolo Bonzini $_members{$arg} = 1; 1273e2c54635SPaolo Bonzini } 1274e2c54635SPaolo Bonzini 1275e2c54635SPaolo Bonzini while (my ($k, $v) = each %parameterdescs) { 1276e2c54635SPaolo Bonzini if (!exists($_members{$k})) { 1277e2c54635SPaolo Bonzini if (show_warnings("enum", $declaration_name)) { 1278e2c54635SPaolo Bonzini print STDERR "${file}:$.: warning: Excess enum value '$k' description in '$declaration_name'\n"; 1279e2c54635SPaolo Bonzini } 1280e2c54635SPaolo Bonzini } 1281e2c54635SPaolo Bonzini } 1282e2c54635SPaolo Bonzini 1283e2c54635SPaolo Bonzini output_declaration($declaration_name, 1284e2c54635SPaolo Bonzini 'enum', 1285e2c54635SPaolo Bonzini {'enum' => $declaration_name, 1286e2c54635SPaolo Bonzini 'module' => $modulename, 1287e2c54635SPaolo Bonzini 'parameterlist' => \@parameterlist, 1288e2c54635SPaolo Bonzini 'parameterdescs' => \%parameterdescs, 1289e2c54635SPaolo Bonzini 'sectionlist' => \@sectionlist, 1290e2c54635SPaolo Bonzini 'sections' => \%sections, 1291e2c54635SPaolo Bonzini 'purpose' => $declaration_purpose 1292e2c54635SPaolo Bonzini }); 1293e2c54635SPaolo Bonzini } 1294e2c54635SPaolo Bonzini else { 1295e2c54635SPaolo Bonzini print STDERR "${file}:$.: error: Cannot parse enum!\n"; 1296e2c54635SPaolo Bonzini ++$errors; 1297e2c54635SPaolo Bonzini } 1298e2c54635SPaolo Bonzini} 1299e2c54635SPaolo Bonzini 1300e2c54635SPaolo Bonzinisub dump_typedef($$) { 1301e2c54635SPaolo Bonzini my $x = shift; 1302e2c54635SPaolo Bonzini my $file = shift; 1303e2c54635SPaolo Bonzini 1304e2c54635SPaolo Bonzini $x =~ s@/\*.*?\*/@@gos; # strip comments. 1305e2c54635SPaolo Bonzini 1306e2c54635SPaolo Bonzini # Parse function prototypes 1307e2c54635SPaolo Bonzini if ($x =~ /typedef\s+(\w+)\s*\(\*\s*(\w\S+)\s*\)\s*\((.*)\);/ || 1308e2c54635SPaolo Bonzini $x =~ /typedef\s+(\w+)\s*(\w\S+)\s*\s*\((.*)\);/) { 1309e2c54635SPaolo Bonzini 1310e2c54635SPaolo Bonzini # Function typedefs 1311e2c54635SPaolo Bonzini $return_type = $1; 1312e2c54635SPaolo Bonzini $declaration_name = $2; 1313e2c54635SPaolo Bonzini my $args = $3; 1314e2c54635SPaolo Bonzini 1315e2c54635SPaolo Bonzini create_parameterlist($args, ',', $file, $declaration_name); 1316e2c54635SPaolo Bonzini 1317e2c54635SPaolo Bonzini output_declaration($declaration_name, 1318e2c54635SPaolo Bonzini 'function', 1319e2c54635SPaolo Bonzini {'function' => $declaration_name, 1320e2c54635SPaolo Bonzini 'typedef' => 1, 1321e2c54635SPaolo Bonzini 'module' => $modulename, 1322e2c54635SPaolo Bonzini 'functiontype' => $return_type, 1323e2c54635SPaolo Bonzini 'parameterlist' => \@parameterlist, 1324e2c54635SPaolo Bonzini 'parameterdescs' => \%parameterdescs, 1325e2c54635SPaolo Bonzini 'parametertypes' => \%parametertypes, 1326e2c54635SPaolo Bonzini 'sectionlist' => \@sectionlist, 1327e2c54635SPaolo Bonzini 'sections' => \%sections, 1328e2c54635SPaolo Bonzini 'purpose' => $declaration_purpose 1329e2c54635SPaolo Bonzini }); 1330e2c54635SPaolo Bonzini return; 1331e2c54635SPaolo Bonzini } 1332e2c54635SPaolo Bonzini 1333e2c54635SPaolo Bonzini while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) { 1334e2c54635SPaolo Bonzini $x =~ s/\(*.\)\s*;$/;/; 1335e2c54635SPaolo Bonzini $x =~ s/\[*.\]\s*;$/;/; 1336e2c54635SPaolo Bonzini } 1337e2c54635SPaolo Bonzini 1338e2c54635SPaolo Bonzini if ($x =~ /typedef.*\s+(\w+)\s*;/) { 1339e2c54635SPaolo Bonzini $declaration_name = $1; 1340e2c54635SPaolo Bonzini 1341e2c54635SPaolo Bonzini output_declaration($declaration_name, 1342e2c54635SPaolo Bonzini 'typedef', 1343e2c54635SPaolo Bonzini {'typedef' => $declaration_name, 1344e2c54635SPaolo Bonzini 'module' => $modulename, 1345e2c54635SPaolo Bonzini 'sectionlist' => \@sectionlist, 1346e2c54635SPaolo Bonzini 'sections' => \%sections, 1347e2c54635SPaolo Bonzini 'purpose' => $declaration_purpose 1348e2c54635SPaolo Bonzini }); 1349e2c54635SPaolo Bonzini } 1350e2c54635SPaolo Bonzini else { 1351e2c54635SPaolo Bonzini print STDERR "${file}:$.: error: Cannot parse typedef!\n"; 1352e2c54635SPaolo Bonzini ++$errors; 1353e2c54635SPaolo Bonzini } 1354e2c54635SPaolo Bonzini} 1355e2c54635SPaolo Bonzini 1356e2c54635SPaolo Bonzinisub save_struct_actual($) { 1357e2c54635SPaolo Bonzini my $actual = shift; 1358e2c54635SPaolo Bonzini 1359e2c54635SPaolo Bonzini # strip all spaces from the actual param so that it looks like one string item 1360e2c54635SPaolo Bonzini $actual =~ s/\s*//g; 1361e2c54635SPaolo Bonzini $struct_actual = $struct_actual . $actual . " "; 1362e2c54635SPaolo Bonzini} 1363e2c54635SPaolo Bonzini 1364e2c54635SPaolo Bonzinisub create_parameterlist($$$$) { 1365e2c54635SPaolo Bonzini my $args = shift; 1366e2c54635SPaolo Bonzini my $splitter = shift; 1367e2c54635SPaolo Bonzini my $file = shift; 1368e2c54635SPaolo Bonzini my $declaration_name = shift; 1369e2c54635SPaolo Bonzini my $type; 1370e2c54635SPaolo Bonzini my $param; 1371e2c54635SPaolo Bonzini 1372e2c54635SPaolo Bonzini # temporarily replace commas inside function pointer definition 1373e2c54635SPaolo Bonzini while ($args =~ /(\([^\),]+),/) { 1374e2c54635SPaolo Bonzini $args =~ s/(\([^\),]+),/$1#/g; 1375e2c54635SPaolo Bonzini } 1376e2c54635SPaolo Bonzini 1377e2c54635SPaolo Bonzini foreach my $arg (split($splitter, $args)) { 1378e2c54635SPaolo Bonzini # strip comments 1379e2c54635SPaolo Bonzini $arg =~ s/\/\*.*\*\///; 1380e2c54635SPaolo Bonzini # strip leading/trailing spaces 1381e2c54635SPaolo Bonzini $arg =~ s/^\s*//; 1382e2c54635SPaolo Bonzini $arg =~ s/\s*$//; 1383e2c54635SPaolo Bonzini $arg =~ s/\s+/ /; 1384e2c54635SPaolo Bonzini 1385e2c54635SPaolo Bonzini if ($arg =~ /^#/) { 1386e2c54635SPaolo Bonzini # Treat preprocessor directive as a typeless variable just to fill 1387e2c54635SPaolo Bonzini # corresponding data structures "correctly". Catch it later in 1388e2c54635SPaolo Bonzini # output_* subs. 1389e2c54635SPaolo Bonzini push_parameter($arg, "", $file); 1390e2c54635SPaolo Bonzini } elsif ($arg =~ m/\(.+\)\s*\(/) { 1391e2c54635SPaolo Bonzini # pointer-to-function 1392e2c54635SPaolo Bonzini $arg =~ tr/#/,/; 1393e2c54635SPaolo Bonzini $arg =~ m/[^\(]+\(\*?\s*([\w\.]*)\s*\)/; 1394e2c54635SPaolo Bonzini $param = $1; 1395e2c54635SPaolo Bonzini $type = $arg; 1396e2c54635SPaolo Bonzini $type =~ s/([^\(]+\(\*?)\s*$param/$1/; 1397e2c54635SPaolo Bonzini save_struct_actual($param); 1398e2c54635SPaolo Bonzini push_parameter($param, $type, $file, $declaration_name); 1399e2c54635SPaolo Bonzini } elsif ($arg) { 1400e2c54635SPaolo Bonzini $arg =~ s/\s*:\s*/:/g; 1401e2c54635SPaolo Bonzini $arg =~ s/\s*\[/\[/g; 1402e2c54635SPaolo Bonzini 1403e2c54635SPaolo Bonzini my @args = split('\s*,\s*', $arg); 1404e2c54635SPaolo Bonzini if ($args[0] =~ m/\*/) { 1405e2c54635SPaolo Bonzini $args[0] =~ s/(\*+)\s*/ $1/; 1406e2c54635SPaolo Bonzini } 1407e2c54635SPaolo Bonzini 1408e2c54635SPaolo Bonzini my @first_arg; 1409e2c54635SPaolo Bonzini if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) { 1410e2c54635SPaolo Bonzini shift @args; 1411e2c54635SPaolo Bonzini push(@first_arg, split('\s+', $1)); 1412e2c54635SPaolo Bonzini push(@first_arg, $2); 1413e2c54635SPaolo Bonzini } else { 1414e2c54635SPaolo Bonzini @first_arg = split('\s+', shift @args); 1415e2c54635SPaolo Bonzini } 1416e2c54635SPaolo Bonzini 1417e2c54635SPaolo Bonzini unshift(@args, pop @first_arg); 1418e2c54635SPaolo Bonzini $type = join " ", @first_arg; 1419e2c54635SPaolo Bonzini 1420e2c54635SPaolo Bonzini foreach $param (@args) { 1421e2c54635SPaolo Bonzini if ($param =~ m/^(\*+)\s*(.*)/) { 1422e2c54635SPaolo Bonzini save_struct_actual($2); 1423e2c54635SPaolo Bonzini push_parameter($2, "$type $1", $file, $declaration_name); 1424e2c54635SPaolo Bonzini } 1425e2c54635SPaolo Bonzini elsif ($param =~ m/(.*?):(\d+)/) { 1426e2c54635SPaolo Bonzini if ($type ne "") { # skip unnamed bit-fields 1427e2c54635SPaolo Bonzini save_struct_actual($1); 1428e2c54635SPaolo Bonzini push_parameter($1, "$type:$2", $file, $declaration_name) 1429e2c54635SPaolo Bonzini } 1430e2c54635SPaolo Bonzini } 1431e2c54635SPaolo Bonzini else { 1432e2c54635SPaolo Bonzini save_struct_actual($param); 1433e2c54635SPaolo Bonzini push_parameter($param, $type, $file, $declaration_name); 1434e2c54635SPaolo Bonzini } 1435e2c54635SPaolo Bonzini } 1436e2c54635SPaolo Bonzini } 1437e2c54635SPaolo Bonzini } 1438e2c54635SPaolo Bonzini} 1439e2c54635SPaolo Bonzini 1440e2c54635SPaolo Bonzinisub push_parameter($$$$) { 1441e2c54635SPaolo Bonzini my $param = shift; 1442e2c54635SPaolo Bonzini my $type = shift; 1443e2c54635SPaolo Bonzini my $file = shift; 1444e2c54635SPaolo Bonzini my $declaration_name = shift; 1445e2c54635SPaolo Bonzini 1446e2c54635SPaolo Bonzini if (($anon_struct_union == 1) && ($type eq "") && 1447e2c54635SPaolo Bonzini ($param eq "}")) { 1448e2c54635SPaolo Bonzini return; # ignore the ending }; from anon. struct/union 1449e2c54635SPaolo Bonzini } 1450e2c54635SPaolo Bonzini 1451e2c54635SPaolo Bonzini $anon_struct_union = 0; 1452e2c54635SPaolo Bonzini $param =~ s/[\[\)].*//; 1453e2c54635SPaolo Bonzini 1454e2c54635SPaolo Bonzini if ($type eq "" && $param =~ /\.\.\.$/) 1455e2c54635SPaolo Bonzini { 1456e2c54635SPaolo Bonzini if (!$param =~ /\w\.\.\.$/) { 1457e2c54635SPaolo Bonzini # handles unnamed variable parameters 1458e2c54635SPaolo Bonzini $param = "..."; 1459e2c54635SPaolo Bonzini } 1460e2c54635SPaolo Bonzini if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") { 1461e2c54635SPaolo Bonzini $parameterdescs{$param} = "variable arguments"; 1462e2c54635SPaolo Bonzini } 1463e2c54635SPaolo Bonzini } 1464e2c54635SPaolo Bonzini elsif ($type eq "" && ($param eq "" or $param eq "void")) 1465e2c54635SPaolo Bonzini { 1466e2c54635SPaolo Bonzini $param="void"; 1467e2c54635SPaolo Bonzini $parameterdescs{void} = "no arguments"; 1468e2c54635SPaolo Bonzini } 1469e2c54635SPaolo Bonzini elsif ($type eq "" && ($param eq "struct" or $param eq "union")) 1470e2c54635SPaolo Bonzini # handle unnamed (anonymous) union or struct: 1471e2c54635SPaolo Bonzini { 1472e2c54635SPaolo Bonzini $type = $param; 1473e2c54635SPaolo Bonzini $param = "{unnamed_" . $param . "}"; 1474e2c54635SPaolo Bonzini $parameterdescs{$param} = "anonymous\n"; 1475e2c54635SPaolo Bonzini $anon_struct_union = 1; 1476e2c54635SPaolo Bonzini } 1477e2c54635SPaolo Bonzini 1478e2c54635SPaolo Bonzini # warn if parameter has no description 1479e2c54635SPaolo Bonzini # (but ignore ones starting with # as these are not parameters 1480e2c54635SPaolo Bonzini # but inline preprocessor statements); 1481e2c54635SPaolo Bonzini # Note: It will also ignore void params and unnamed structs/unions 1482e2c54635SPaolo Bonzini if (!defined $parameterdescs{$param} && $param !~ /^#/) { 1483e2c54635SPaolo Bonzini $parameterdescs{$param} = $undescribed; 1484e2c54635SPaolo Bonzini 1485e2c54635SPaolo Bonzini if (show_warnings($type, $declaration_name) && $param !~ /\./) { 1486e2c54635SPaolo Bonzini print STDERR 1487e2c54635SPaolo Bonzini "${file}:$.: warning: Function parameter or member '$param' not described in '$declaration_name'\n"; 1488e2c54635SPaolo Bonzini ++$warnings; 1489e2c54635SPaolo Bonzini } 1490e2c54635SPaolo Bonzini } 1491e2c54635SPaolo Bonzini 1492e2c54635SPaolo Bonzini # strip spaces from $param so that it is one continuous string 1493e2c54635SPaolo Bonzini # on @parameterlist; 1494e2c54635SPaolo Bonzini # this fixes a problem where check_sections() cannot find 1495e2c54635SPaolo Bonzini # a parameter like "addr[6 + 2]" because it actually appears 1496e2c54635SPaolo Bonzini # as "addr[6", "+", "2]" on the parameter list; 1497e2c54635SPaolo Bonzini # but it's better to maintain the param string unchanged for output, 1498e2c54635SPaolo Bonzini # so just weaken the string compare in check_sections() to ignore 1499e2c54635SPaolo Bonzini # "[blah" in a parameter string; 1500e2c54635SPaolo Bonzini ###$param =~ s/\s*//g; 1501e2c54635SPaolo Bonzini push @parameterlist, $param; 1502e2c54635SPaolo Bonzini $type =~ s/\s\s+/ /g; 1503e2c54635SPaolo Bonzini $parametertypes{$param} = $type; 1504e2c54635SPaolo Bonzini} 1505e2c54635SPaolo Bonzini 1506e2c54635SPaolo Bonzinisub check_sections($$$$$) { 1507e2c54635SPaolo Bonzini my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_; 1508e2c54635SPaolo Bonzini my @sects = split ' ', $sectcheck; 1509e2c54635SPaolo Bonzini my @prms = split ' ', $prmscheck; 1510e2c54635SPaolo Bonzini my $err; 1511e2c54635SPaolo Bonzini my ($px, $sx); 1512e2c54635SPaolo Bonzini my $prm_clean; # strip trailing "[array size]" and/or beginning "*" 1513e2c54635SPaolo Bonzini 1514e2c54635SPaolo Bonzini foreach $sx (0 .. $#sects) { 1515e2c54635SPaolo Bonzini $err = 1; 1516e2c54635SPaolo Bonzini foreach $px (0 .. $#prms) { 1517e2c54635SPaolo Bonzini $prm_clean = $prms[$px]; 1518e2c54635SPaolo Bonzini $prm_clean =~ s/\[.*\]//; 1519e2c54635SPaolo Bonzini $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i; 1520e2c54635SPaolo Bonzini # ignore array size in a parameter string; 1521e2c54635SPaolo Bonzini # however, the original param string may contain 1522e2c54635SPaolo Bonzini # spaces, e.g.: addr[6 + 2] 1523e2c54635SPaolo Bonzini # and this appears in @prms as "addr[6" since the 1524e2c54635SPaolo Bonzini # parameter list is split at spaces; 1525e2c54635SPaolo Bonzini # hence just ignore "[..." for the sections check; 1526e2c54635SPaolo Bonzini $prm_clean =~ s/\[.*//; 1527e2c54635SPaolo Bonzini 1528e2c54635SPaolo Bonzini ##$prm_clean =~ s/^\**//; 1529e2c54635SPaolo Bonzini if ($prm_clean eq $sects[$sx]) { 1530e2c54635SPaolo Bonzini $err = 0; 1531e2c54635SPaolo Bonzini last; 1532e2c54635SPaolo Bonzini } 1533e2c54635SPaolo Bonzini } 1534e2c54635SPaolo Bonzini if ($err) { 1535e2c54635SPaolo Bonzini if ($decl_type eq "function") { 1536e2c54635SPaolo Bonzini print STDERR "${file}:$.: warning: " . 1537e2c54635SPaolo Bonzini "Excess function parameter " . 1538e2c54635SPaolo Bonzini "'$sects[$sx]' " . 1539e2c54635SPaolo Bonzini "description in '$decl_name'\n"; 1540e2c54635SPaolo Bonzini ++$warnings; 1541e2c54635SPaolo Bonzini } 1542e2c54635SPaolo Bonzini } 1543e2c54635SPaolo Bonzini } 1544e2c54635SPaolo Bonzini} 1545e2c54635SPaolo Bonzini 1546e2c54635SPaolo Bonzini## 1547e2c54635SPaolo Bonzini# Checks the section describing the return value of a function. 1548e2c54635SPaolo Bonzinisub check_return_section { 1549e2c54635SPaolo Bonzini my $file = shift; 1550e2c54635SPaolo Bonzini my $declaration_name = shift; 1551e2c54635SPaolo Bonzini my $return_type = shift; 1552e2c54635SPaolo Bonzini 1553e2c54635SPaolo Bonzini # Ignore an empty return type (It's a macro) 1554e2c54635SPaolo Bonzini # Ignore functions with a "void" return type. (But don't ignore "void *") 1555e2c54635SPaolo Bonzini if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) { 1556e2c54635SPaolo Bonzini return; 1557e2c54635SPaolo Bonzini } 1558e2c54635SPaolo Bonzini 1559e2c54635SPaolo Bonzini if (!defined($sections{$section_return}) || 1560e2c54635SPaolo Bonzini $sections{$section_return} eq "") { 1561e2c54635SPaolo Bonzini print STDERR "${file}:$.: warning: " . 1562e2c54635SPaolo Bonzini "No description found for return value of " . 1563e2c54635SPaolo Bonzini "'$declaration_name'\n"; 1564e2c54635SPaolo Bonzini ++$warnings; 1565e2c54635SPaolo Bonzini } 1566e2c54635SPaolo Bonzini} 1567e2c54635SPaolo Bonzini 1568e2c54635SPaolo Bonzini## 1569e2c54635SPaolo Bonzini# takes a function prototype and the name of the current file being 1570e2c54635SPaolo Bonzini# processed and spits out all the details stored in the global 1571e2c54635SPaolo Bonzini# arrays/hashes. 1572e2c54635SPaolo Bonzinisub dump_function($$) { 1573e2c54635SPaolo Bonzini my $prototype = shift; 1574e2c54635SPaolo Bonzini my $file = shift; 1575e2c54635SPaolo Bonzini my $noret = 0; 1576e2c54635SPaolo Bonzini 1577e2c54635SPaolo Bonzini $prototype =~ s/^static +//; 1578e2c54635SPaolo Bonzini $prototype =~ s/^extern +//; 1579e2c54635SPaolo Bonzini $prototype =~ s/^asmlinkage +//; 1580e2c54635SPaolo Bonzini $prototype =~ s/^inline +//; 1581e2c54635SPaolo Bonzini $prototype =~ s/^__inline__ +//; 1582e2c54635SPaolo Bonzini $prototype =~ s/^__inline +//; 1583e2c54635SPaolo Bonzini $prototype =~ s/^__always_inline +//; 1584e2c54635SPaolo Bonzini $prototype =~ s/^noinline +//; 1585e2c54635SPaolo Bonzini $prototype =~ s/__init +//; 1586e2c54635SPaolo Bonzini $prototype =~ s/__init_or_module +//; 1587e2c54635SPaolo Bonzini $prototype =~ s/__meminit +//; 1588e2c54635SPaolo Bonzini $prototype =~ s/__must_check +//; 1589e2c54635SPaolo Bonzini $prototype =~ s/__weak +//; 1590e2c54635SPaolo Bonzini $prototype =~ s/__sched +//; 1591e2c54635SPaolo Bonzini $prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//; 1592e2c54635SPaolo Bonzini my $define = $prototype =~ s/^#\s*define\s+//; #ak added 1593e2c54635SPaolo Bonzini $prototype =~ s/__attribute__\s*\(\( 1594e2c54635SPaolo Bonzini (?: 1595e2c54635SPaolo Bonzini [\w\s]++ # attribute name 1596e2c54635SPaolo Bonzini (?:\([^)]*+\))? # attribute arguments 1597e2c54635SPaolo Bonzini \s*+,? # optional comma at the end 1598e2c54635SPaolo Bonzini )+ 1599e2c54635SPaolo Bonzini \)\)\s+//x; 1600e2c54635SPaolo Bonzini 1601e2c54635SPaolo Bonzini # Yes, this truly is vile. We are looking for: 1602e2c54635SPaolo Bonzini # 1. Return type (may be nothing if we're looking at a macro) 1603e2c54635SPaolo Bonzini # 2. Function name 1604e2c54635SPaolo Bonzini # 3. Function parameters. 1605e2c54635SPaolo Bonzini # 1606e2c54635SPaolo Bonzini # All the while we have to watch out for function pointer parameters 1607e2c54635SPaolo Bonzini # (which IIRC is what the two sections are for), C types (these 1608e2c54635SPaolo Bonzini # regexps don't even start to express all the possibilities), and 1609e2c54635SPaolo Bonzini # so on. 1610e2c54635SPaolo Bonzini # 1611e2c54635SPaolo Bonzini # If you mess with these regexps, it's a good idea to check that 1612e2c54635SPaolo Bonzini # the following functions' documentation still comes out right: 1613e2c54635SPaolo Bonzini # - parport_register_device (function pointer parameters) 1614e2c54635SPaolo Bonzini # - atomic_set (macro) 1615e2c54635SPaolo Bonzini # - pci_match_device, __copy_to_user (long return type) 1616e2c54635SPaolo Bonzini 1617e2c54635SPaolo Bonzini if ($define && $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s+/) { 1618e2c54635SPaolo Bonzini # This is an object-like macro, it has no return type and no parameter 1619e2c54635SPaolo Bonzini # list. 1620e2c54635SPaolo Bonzini # Function-like macros are not allowed to have spaces between 1621e2c54635SPaolo Bonzini # declaration_name and opening parenthesis (notice the \s+). 1622e2c54635SPaolo Bonzini $return_type = $1; 1623e2c54635SPaolo Bonzini $declaration_name = $2; 1624e2c54635SPaolo Bonzini $noret = 1; 1625e2c54635SPaolo Bonzini } elsif ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1626e2c54635SPaolo Bonzini $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1627e2c54635SPaolo Bonzini $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1628e2c54635SPaolo Bonzini $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1629e2c54635SPaolo Bonzini $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1630e2c54635SPaolo Bonzini $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1631e2c54635SPaolo Bonzini $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 1632e2c54635SPaolo Bonzini $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1633e2c54635SPaolo Bonzini $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1634e2c54635SPaolo Bonzini $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1635e2c54635SPaolo Bonzini $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1636e2c54635SPaolo Bonzini $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1637e2c54635SPaolo Bonzini $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1638e2c54635SPaolo Bonzini $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1639e2c54635SPaolo Bonzini $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1640e2c54635SPaolo Bonzini $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1641e2c54635SPaolo Bonzini $prototype =~ m/^(\w+\s+\w+\s*\*+\s*\w+\s*\*+\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) { 1642e2c54635SPaolo Bonzini $return_type = $1; 1643e2c54635SPaolo Bonzini $declaration_name = $2; 1644e2c54635SPaolo Bonzini my $args = $3; 1645e2c54635SPaolo Bonzini 1646e2c54635SPaolo Bonzini create_parameterlist($args, ',', $file, $declaration_name); 1647e2c54635SPaolo Bonzini } else { 1648e2c54635SPaolo Bonzini print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype'\n"; 1649e2c54635SPaolo Bonzini return; 1650e2c54635SPaolo Bonzini } 1651e2c54635SPaolo Bonzini 1652e2c54635SPaolo Bonzini my $prms = join " ", @parameterlist; 1653e2c54635SPaolo Bonzini check_sections($file, $declaration_name, "function", $sectcheck, $prms); 1654e2c54635SPaolo Bonzini 1655e2c54635SPaolo Bonzini # This check emits a lot of warnings at the moment, because many 1656e2c54635SPaolo Bonzini # functions don't have a 'Return' doc section. So until the number 1657e2c54635SPaolo Bonzini # of warnings goes sufficiently down, the check is only performed in 1658e2c54635SPaolo Bonzini # verbose mode. 1659e2c54635SPaolo Bonzini # TODO: always perform the check. 1660e2c54635SPaolo Bonzini if ($verbose && !$noret) { 1661e2c54635SPaolo Bonzini check_return_section($file, $declaration_name, $return_type); 1662e2c54635SPaolo Bonzini } 1663e2c54635SPaolo Bonzini 1664e2c54635SPaolo Bonzini output_declaration($declaration_name, 1665e2c54635SPaolo Bonzini 'function', 1666e2c54635SPaolo Bonzini {'function' => $declaration_name, 1667e2c54635SPaolo Bonzini 'module' => $modulename, 1668e2c54635SPaolo Bonzini 'functiontype' => $return_type, 1669e2c54635SPaolo Bonzini 'parameterlist' => \@parameterlist, 1670e2c54635SPaolo Bonzini 'parameterdescs' => \%parameterdescs, 1671e2c54635SPaolo Bonzini 'parametertypes' => \%parametertypes, 1672e2c54635SPaolo Bonzini 'sectionlist' => \@sectionlist, 1673e2c54635SPaolo Bonzini 'sections' => \%sections, 1674e2c54635SPaolo Bonzini 'purpose' => $declaration_purpose 1675e2c54635SPaolo Bonzini }); 1676e2c54635SPaolo Bonzini} 1677e2c54635SPaolo Bonzini 1678e2c54635SPaolo Bonzinisub reset_state { 1679e2c54635SPaolo Bonzini $function = ""; 1680e2c54635SPaolo Bonzini %parameterdescs = (); 1681e2c54635SPaolo Bonzini %parametertypes = (); 1682e2c54635SPaolo Bonzini @parameterlist = (); 1683e2c54635SPaolo Bonzini %sections = (); 1684e2c54635SPaolo Bonzini @sectionlist = (); 1685e2c54635SPaolo Bonzini $sectcheck = ""; 1686e2c54635SPaolo Bonzini $struct_actual = ""; 1687e2c54635SPaolo Bonzini $prototype = ""; 1688e2c54635SPaolo Bonzini 1689e2c54635SPaolo Bonzini $state = STATE_NORMAL; 1690e2c54635SPaolo Bonzini $inline_doc_state = STATE_INLINE_NA; 1691e2c54635SPaolo Bonzini} 1692e2c54635SPaolo Bonzini 1693e2c54635SPaolo Bonzinisub tracepoint_munge($) { 1694e2c54635SPaolo Bonzini my $file = shift; 1695e2c54635SPaolo Bonzini my $tracepointname = 0; 1696e2c54635SPaolo Bonzini my $tracepointargs = 0; 1697e2c54635SPaolo Bonzini 1698e2c54635SPaolo Bonzini if ($prototype =~ m/TRACE_EVENT\((.*?),/) { 1699e2c54635SPaolo Bonzini $tracepointname = $1; 1700e2c54635SPaolo Bonzini } 1701e2c54635SPaolo Bonzini if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) { 1702e2c54635SPaolo Bonzini $tracepointname = $1; 1703e2c54635SPaolo Bonzini } 1704e2c54635SPaolo Bonzini if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) { 1705e2c54635SPaolo Bonzini $tracepointname = $2; 1706e2c54635SPaolo Bonzini } 1707e2c54635SPaolo Bonzini $tracepointname =~ s/^\s+//; #strip leading whitespace 1708e2c54635SPaolo Bonzini if ($prototype =~ m/TP_PROTO\((.*?)\)/) { 1709e2c54635SPaolo Bonzini $tracepointargs = $1; 1710e2c54635SPaolo Bonzini } 1711e2c54635SPaolo Bonzini if (($tracepointname eq 0) || ($tracepointargs eq 0)) { 1712e2c54635SPaolo Bonzini print STDERR "${file}:$.: warning: Unrecognized tracepoint format: \n". 1713e2c54635SPaolo Bonzini "$prototype\n"; 1714e2c54635SPaolo Bonzini } else { 1715e2c54635SPaolo Bonzini $prototype = "static inline void trace_$tracepointname($tracepointargs)"; 1716e2c54635SPaolo Bonzini } 1717e2c54635SPaolo Bonzini} 1718e2c54635SPaolo Bonzini 1719e2c54635SPaolo Bonzinisub syscall_munge() { 1720e2c54635SPaolo Bonzini my $void = 0; 1721e2c54635SPaolo Bonzini 1722e2c54635SPaolo Bonzini $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's 1723e2c54635SPaolo Bonzini## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) { 1724e2c54635SPaolo Bonzini if ($prototype =~ m/SYSCALL_DEFINE0/) { 1725e2c54635SPaolo Bonzini $void = 1; 1726e2c54635SPaolo Bonzini## $prototype = "long sys_$1(void)"; 1727e2c54635SPaolo Bonzini } 1728e2c54635SPaolo Bonzini 1729e2c54635SPaolo Bonzini $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name 1730e2c54635SPaolo Bonzini if ($prototype =~ m/long (sys_.*?),/) { 1731e2c54635SPaolo Bonzini $prototype =~ s/,/\(/; 1732e2c54635SPaolo Bonzini } elsif ($void) { 1733e2c54635SPaolo Bonzini $prototype =~ s/\)/\(void\)/; 1734e2c54635SPaolo Bonzini } 1735e2c54635SPaolo Bonzini 1736e2c54635SPaolo Bonzini # now delete all of the odd-number commas in $prototype 1737e2c54635SPaolo Bonzini # so that arg types & arg names don't have a comma between them 1738e2c54635SPaolo Bonzini my $count = 0; 1739e2c54635SPaolo Bonzini my $len = length($prototype); 1740e2c54635SPaolo Bonzini if ($void) { 1741e2c54635SPaolo Bonzini $len = 0; # skip the for-loop 1742e2c54635SPaolo Bonzini } 1743e2c54635SPaolo Bonzini for (my $ix = 0; $ix < $len; $ix++) { 1744e2c54635SPaolo Bonzini if (substr($prototype, $ix, 1) eq ',') { 1745e2c54635SPaolo Bonzini $count++; 1746e2c54635SPaolo Bonzini if ($count % 2 == 1) { 1747e2c54635SPaolo Bonzini substr($prototype, $ix, 1) = ' '; 1748e2c54635SPaolo Bonzini } 1749e2c54635SPaolo Bonzini } 1750e2c54635SPaolo Bonzini } 1751e2c54635SPaolo Bonzini} 1752e2c54635SPaolo Bonzini 1753e2c54635SPaolo Bonzinisub process_proto_function($$) { 1754e2c54635SPaolo Bonzini my $x = shift; 1755e2c54635SPaolo Bonzini my $file = shift; 1756e2c54635SPaolo Bonzini 1757e2c54635SPaolo Bonzini $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line 1758e2c54635SPaolo Bonzini 1759e2c54635SPaolo Bonzini if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) { 1760e2c54635SPaolo Bonzini # do nothing 1761e2c54635SPaolo Bonzini } 1762e2c54635SPaolo Bonzini elsif ($x =~ /([^\{]*)/) { 1763e2c54635SPaolo Bonzini $prototype .= $1; 1764e2c54635SPaolo Bonzini } 1765e2c54635SPaolo Bonzini 1766e2c54635SPaolo Bonzini if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) { 1767e2c54635SPaolo Bonzini $prototype =~ s@/\*.*?\*/@@gos; # strip comments. 1768e2c54635SPaolo Bonzini $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's. 1769e2c54635SPaolo Bonzini $prototype =~ s@^\s+@@gos; # strip leading spaces 1770e2c54635SPaolo Bonzini if ($prototype =~ /SYSCALL_DEFINE/) { 1771e2c54635SPaolo Bonzini syscall_munge(); 1772e2c54635SPaolo Bonzini } 1773e2c54635SPaolo Bonzini if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ || 1774e2c54635SPaolo Bonzini $prototype =~ /DEFINE_SINGLE_EVENT/) 1775e2c54635SPaolo Bonzini { 1776e2c54635SPaolo Bonzini tracepoint_munge($file); 1777e2c54635SPaolo Bonzini } 1778e2c54635SPaolo Bonzini dump_function($prototype, $file); 1779e2c54635SPaolo Bonzini reset_state(); 1780e2c54635SPaolo Bonzini } 1781e2c54635SPaolo Bonzini} 1782e2c54635SPaolo Bonzini 1783e2c54635SPaolo Bonzinisub process_proto_type($$) { 1784e2c54635SPaolo Bonzini my $x = shift; 1785e2c54635SPaolo Bonzini my $file = shift; 1786e2c54635SPaolo Bonzini 1787e2c54635SPaolo Bonzini $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's. 1788e2c54635SPaolo Bonzini $x =~ s@^\s+@@gos; # strip leading spaces 1789e2c54635SPaolo Bonzini $x =~ s@\s+$@@gos; # strip trailing spaces 1790e2c54635SPaolo Bonzini $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line 1791e2c54635SPaolo Bonzini 1792e2c54635SPaolo Bonzini if ($x =~ /^#/) { 1793e2c54635SPaolo Bonzini # To distinguish preprocessor directive from regular declaration later. 1794e2c54635SPaolo Bonzini $x .= ";"; 1795e2c54635SPaolo Bonzini } 1796e2c54635SPaolo Bonzini 1797e2c54635SPaolo Bonzini while (1) { 1798e2c54635SPaolo Bonzini if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) { 1799e2c54635SPaolo Bonzini if( length $prototype ) { 1800e2c54635SPaolo Bonzini $prototype .= " " 1801e2c54635SPaolo Bonzini } 1802e2c54635SPaolo Bonzini $prototype .= $1 . $2; 1803e2c54635SPaolo Bonzini ($2 eq '{') && $brcount++; 1804e2c54635SPaolo Bonzini ($2 eq '}') && $brcount--; 1805e2c54635SPaolo Bonzini if (($2 eq ';') && ($brcount == 0)) { 1806e2c54635SPaolo Bonzini dump_declaration($prototype, $file); 1807e2c54635SPaolo Bonzini reset_state(); 1808e2c54635SPaolo Bonzini last; 1809e2c54635SPaolo Bonzini } 1810e2c54635SPaolo Bonzini $x = $3; 1811e2c54635SPaolo Bonzini } else { 1812e2c54635SPaolo Bonzini $prototype .= $x; 1813e2c54635SPaolo Bonzini last; 1814e2c54635SPaolo Bonzini } 1815e2c54635SPaolo Bonzini } 1816e2c54635SPaolo Bonzini} 1817e2c54635SPaolo Bonzini 1818e2c54635SPaolo Bonzini 1819e2c54635SPaolo Bonzinisub map_filename($) { 1820e2c54635SPaolo Bonzini my $file; 1821e2c54635SPaolo Bonzini my ($orig_file) = @_; 1822e2c54635SPaolo Bonzini 1823e2c54635SPaolo Bonzini if (defined($ENV{'SRCTREE'})) { 1824e2c54635SPaolo Bonzini $file = "$ENV{'SRCTREE'}" . "/" . $orig_file; 1825e2c54635SPaolo Bonzini } else { 1826e2c54635SPaolo Bonzini $file = $orig_file; 1827e2c54635SPaolo Bonzini } 1828e2c54635SPaolo Bonzini 1829e2c54635SPaolo Bonzini if (defined($source_map{$file})) { 1830e2c54635SPaolo Bonzini $file = $source_map{$file}; 1831e2c54635SPaolo Bonzini } 1832e2c54635SPaolo Bonzini 1833e2c54635SPaolo Bonzini return $file; 1834e2c54635SPaolo Bonzini} 1835e2c54635SPaolo Bonzini 1836e2c54635SPaolo Bonzinisub process_export_file($) { 1837e2c54635SPaolo Bonzini my ($orig_file) = @_; 1838e2c54635SPaolo Bonzini my $file = map_filename($orig_file); 1839e2c54635SPaolo Bonzini 1840e2c54635SPaolo Bonzini if (!open(IN,"<$file")) { 1841e2c54635SPaolo Bonzini print STDERR "Error: Cannot open file $file\n"; 1842e2c54635SPaolo Bonzini ++$errors; 1843e2c54635SPaolo Bonzini return; 1844e2c54635SPaolo Bonzini } 1845e2c54635SPaolo Bonzini 1846e2c54635SPaolo Bonzini while (<IN>) { 1847e2c54635SPaolo Bonzini if (/$export_symbol/) { 1848e2c54635SPaolo Bonzini $function_table{$2} = 1; 1849e2c54635SPaolo Bonzini } 1850e2c54635SPaolo Bonzini } 1851e2c54635SPaolo Bonzini 1852e2c54635SPaolo Bonzini close(IN); 1853e2c54635SPaolo Bonzini} 1854e2c54635SPaolo Bonzini 1855e2c54635SPaolo Bonzini# 1856e2c54635SPaolo Bonzini# Parsers for the various processing states. 1857e2c54635SPaolo Bonzini# 1858e2c54635SPaolo Bonzini# STATE_NORMAL: looking for the /** to begin everything. 1859e2c54635SPaolo Bonzini# 1860e2c54635SPaolo Bonzinisub process_normal() { 1861e2c54635SPaolo Bonzini if (/$doc_start/o) { 1862e2c54635SPaolo Bonzini $state = STATE_NAME; # next line is always the function name 1863e2c54635SPaolo Bonzini $in_doc_sect = 0; 1864e2c54635SPaolo Bonzini $declaration_start_line = $. + 1; 1865e2c54635SPaolo Bonzini } 1866e2c54635SPaolo Bonzini} 1867e2c54635SPaolo Bonzini 1868e2c54635SPaolo Bonzini# 1869e2c54635SPaolo Bonzini# STATE_NAME: Looking for the "name - description" line 1870e2c54635SPaolo Bonzini# 1871e2c54635SPaolo Bonzinisub process_name($$) { 1872e2c54635SPaolo Bonzini my $file = shift; 1873e2c54635SPaolo Bonzini my $identifier; 1874e2c54635SPaolo Bonzini my $descr; 1875e2c54635SPaolo Bonzini 1876e2c54635SPaolo Bonzini if (/$doc_block/o) { 1877e2c54635SPaolo Bonzini $state = STATE_DOCBLOCK; 1878e2c54635SPaolo Bonzini $contents = ""; 1879e2c54635SPaolo Bonzini $new_start_line = $. + 1; 1880e2c54635SPaolo Bonzini 1881e2c54635SPaolo Bonzini if ( $1 eq "" ) { 1882e2c54635SPaolo Bonzini $section = $section_intro; 1883e2c54635SPaolo Bonzini } else { 1884e2c54635SPaolo Bonzini $section = $1; 1885e2c54635SPaolo Bonzini } 1886e2c54635SPaolo Bonzini } 1887e2c54635SPaolo Bonzini elsif (/$doc_decl/o) { 1888e2c54635SPaolo Bonzini $identifier = $1; 18894cf41794SPaolo Bonzini if (/\s*([\w\s]+?)(\s*-|:)/) { 1890e2c54635SPaolo Bonzini $identifier = $1; 1891e2c54635SPaolo Bonzini } 1892e2c54635SPaolo Bonzini 1893e2c54635SPaolo Bonzini $state = STATE_BODY; 1894e2c54635SPaolo Bonzini # if there's no @param blocks need to set up default section 1895e2c54635SPaolo Bonzini # here 1896e2c54635SPaolo Bonzini $contents = ""; 1897e2c54635SPaolo Bonzini $section = $section_default; 1898e2c54635SPaolo Bonzini $new_start_line = $. + 1; 18994cf41794SPaolo Bonzini if (/[-:](.*)/) { 1900e2c54635SPaolo Bonzini # strip leading/trailing/multiple spaces 1901e2c54635SPaolo Bonzini $descr= $1; 1902e2c54635SPaolo Bonzini $descr =~ s/^\s*//; 1903e2c54635SPaolo Bonzini $descr =~ s/\s*$//; 1904e2c54635SPaolo Bonzini $descr =~ s/\s+/ /g; 1905e2c54635SPaolo Bonzini $declaration_purpose = $descr; 1906e2c54635SPaolo Bonzini $state = STATE_BODY_MAYBE; 1907e2c54635SPaolo Bonzini } else { 1908e2c54635SPaolo Bonzini $declaration_purpose = ""; 1909e2c54635SPaolo Bonzini } 1910e2c54635SPaolo Bonzini 1911e2c54635SPaolo Bonzini if (($declaration_purpose eq "") && $verbose) { 1912e2c54635SPaolo Bonzini print STDERR "${file}:$.: warning: missing initial short description on line:\n"; 1913e2c54635SPaolo Bonzini print STDERR $_; 1914e2c54635SPaolo Bonzini ++$warnings; 1915e2c54635SPaolo Bonzini } 1916e2c54635SPaolo Bonzini 19174cf41794SPaolo Bonzini if ($identifier =~ m/^[A-Z]/) { 19184cf41794SPaolo Bonzini $decl_type = 'type name'; 19194cf41794SPaolo Bonzini } elsif ($identifier =~ m/^struct\b/) { 1920e2c54635SPaolo Bonzini $decl_type = 'struct'; 1921e2c54635SPaolo Bonzini } elsif ($identifier =~ m/^union\b/) { 1922e2c54635SPaolo Bonzini $decl_type = 'union'; 1923e2c54635SPaolo Bonzini } elsif ($identifier =~ m/^enum\b/) { 1924e2c54635SPaolo Bonzini $decl_type = 'enum'; 1925e2c54635SPaolo Bonzini } elsif ($identifier =~ m/^typedef\b/) { 1926e2c54635SPaolo Bonzini $decl_type = 'typedef'; 1927e2c54635SPaolo Bonzini } else { 1928e2c54635SPaolo Bonzini $decl_type = 'function'; 1929e2c54635SPaolo Bonzini } 1930e2c54635SPaolo Bonzini 1931e2c54635SPaolo Bonzini if ($verbose) { 1932e2c54635SPaolo Bonzini print STDERR "${file}:$.: info: Scanning doc for $identifier\n"; 1933e2c54635SPaolo Bonzini } 1934e2c54635SPaolo Bonzini } else { 1935e2c54635SPaolo Bonzini print STDERR "${file}:$.: warning: Cannot understand $_ on line $.", 1936e2c54635SPaolo Bonzini " - I thought it was a doc line\n"; 1937e2c54635SPaolo Bonzini ++$warnings; 1938e2c54635SPaolo Bonzini $state = STATE_NORMAL; 1939e2c54635SPaolo Bonzini } 1940e2c54635SPaolo Bonzini} 1941e2c54635SPaolo Bonzini 1942e2c54635SPaolo Bonzini 1943e2c54635SPaolo Bonzini# 1944e2c54635SPaolo Bonzini# STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment. 1945e2c54635SPaolo Bonzini# 1946e2c54635SPaolo Bonzinisub process_body($$) { 1947e2c54635SPaolo Bonzini my $file = shift; 1948e2c54635SPaolo Bonzini 1949e2c54635SPaolo Bonzini if (/$doc_sect/i) { # case insensitive for supported section names 1950e2c54635SPaolo Bonzini $newsection = $1; 1951e2c54635SPaolo Bonzini $newcontents = $2; 1952e2c54635SPaolo Bonzini 1953e2c54635SPaolo Bonzini # map the supported section names to the canonical names 1954e2c54635SPaolo Bonzini if ($newsection =~ m/^description$/i) { 1955e2c54635SPaolo Bonzini $newsection = $section_default; 1956e2c54635SPaolo Bonzini } elsif ($newsection =~ m/^context$/i) { 1957e2c54635SPaolo Bonzini $newsection = $section_context; 1958e2c54635SPaolo Bonzini } elsif ($newsection =~ m/^returns?$/i) { 1959e2c54635SPaolo Bonzini $newsection = $section_return; 1960e2c54635SPaolo Bonzini } elsif ($newsection =~ m/^\@return$/) { 1961e2c54635SPaolo Bonzini # special: @return is a section, not a param description 1962e2c54635SPaolo Bonzini $newsection = $section_return; 1963e2c54635SPaolo Bonzini } 1964e2c54635SPaolo Bonzini 1965e2c54635SPaolo Bonzini if (($contents ne "") && ($contents ne "\n")) { 1966e2c54635SPaolo Bonzini if (!$in_doc_sect && $verbose) { 1967e2c54635SPaolo Bonzini print STDERR "${file}:$.: warning: contents before sections\n"; 1968e2c54635SPaolo Bonzini ++$warnings; 1969e2c54635SPaolo Bonzini } 1970e2c54635SPaolo Bonzini dump_section($file, $section, $contents); 1971e2c54635SPaolo Bonzini $section = $section_default; 1972e2c54635SPaolo Bonzini } 1973e2c54635SPaolo Bonzini 1974e2c54635SPaolo Bonzini $in_doc_sect = 1; 1975e2c54635SPaolo Bonzini $state = STATE_BODY; 1976e2c54635SPaolo Bonzini $contents = $newcontents; 1977e2c54635SPaolo Bonzini $new_start_line = $.; 1978e2c54635SPaolo Bonzini while (substr($contents, 0, 1) eq " ") { 1979e2c54635SPaolo Bonzini $contents = substr($contents, 1); 1980e2c54635SPaolo Bonzini } 1981e2c54635SPaolo Bonzini if ($contents ne "") { 1982e2c54635SPaolo Bonzini $contents .= "\n"; 1983e2c54635SPaolo Bonzini } 1984e2c54635SPaolo Bonzini $section = $newsection; 1985e2c54635SPaolo Bonzini $leading_space = undef; 1986e2c54635SPaolo Bonzini } elsif (/$doc_end/) { 1987e2c54635SPaolo Bonzini if (($contents ne "") && ($contents ne "\n")) { 1988e2c54635SPaolo Bonzini dump_section($file, $section, $contents); 1989e2c54635SPaolo Bonzini $section = $section_default; 1990e2c54635SPaolo Bonzini $contents = ""; 1991e2c54635SPaolo Bonzini } 1992e2c54635SPaolo Bonzini # look for doc_com + <text> + doc_end: 1993e2c54635SPaolo Bonzini if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') { 1994e2c54635SPaolo Bonzini print STDERR "${file}:$.: warning: suspicious ending line: $_"; 1995e2c54635SPaolo Bonzini ++$warnings; 1996e2c54635SPaolo Bonzini } 1997e2c54635SPaolo Bonzini 1998e2c54635SPaolo Bonzini $prototype = ""; 1999e2c54635SPaolo Bonzini $state = STATE_PROTO; 2000e2c54635SPaolo Bonzini $brcount = 0; 2001e2c54635SPaolo Bonzini } elsif (/$doc_content/) { 2002e2c54635SPaolo Bonzini # miguel-style comment kludge, look for blank lines after 2003e2c54635SPaolo Bonzini # @parameter line to signify start of description 2004e2c54635SPaolo Bonzini if ($1 eq "") { 2005e2c54635SPaolo Bonzini if ($section =~ m/^@/ || $section eq $section_context) { 2006e2c54635SPaolo Bonzini dump_section($file, $section, $contents); 2007e2c54635SPaolo Bonzini $section = $section_default; 2008e2c54635SPaolo Bonzini $contents = ""; 2009e2c54635SPaolo Bonzini $new_start_line = $.; 2010e2c54635SPaolo Bonzini } else { 2011e2c54635SPaolo Bonzini $contents .= "\n"; 2012e2c54635SPaolo Bonzini } 2013e2c54635SPaolo Bonzini $state = STATE_BODY; 2014e2c54635SPaolo Bonzini } elsif ($state == STATE_BODY_MAYBE) { 2015e2c54635SPaolo Bonzini # Continued declaration purpose 2016e2c54635SPaolo Bonzini chomp($declaration_purpose); 2017e2c54635SPaolo Bonzini $declaration_purpose .= " " . $1; 2018e2c54635SPaolo Bonzini $declaration_purpose =~ s/\s+/ /g; 2019e2c54635SPaolo Bonzini } else { 2020e2c54635SPaolo Bonzini my $cont = $1; 2021e2c54635SPaolo Bonzini if ($section =~ m/^@/ || $section eq $section_context) { 2022e2c54635SPaolo Bonzini if (!defined $leading_space) { 2023e2c54635SPaolo Bonzini if ($cont =~ m/^(\s+)/) { 2024e2c54635SPaolo Bonzini $leading_space = $1; 2025e2c54635SPaolo Bonzini } else { 2026e2c54635SPaolo Bonzini $leading_space = ""; 2027e2c54635SPaolo Bonzini } 2028e2c54635SPaolo Bonzini } 2029e2c54635SPaolo Bonzini $cont =~ s/^$leading_space//; 2030e2c54635SPaolo Bonzini } 2031e2c54635SPaolo Bonzini $contents .= $cont . "\n"; 2032e2c54635SPaolo Bonzini } 2033e2c54635SPaolo Bonzini } else { 2034e2c54635SPaolo Bonzini # i dont know - bad line? ignore. 2035e2c54635SPaolo Bonzini print STDERR "${file}:$.: warning: bad line: $_"; 2036e2c54635SPaolo Bonzini ++$warnings; 2037e2c54635SPaolo Bonzini } 2038e2c54635SPaolo Bonzini} 2039e2c54635SPaolo Bonzini 2040e2c54635SPaolo Bonzini 2041e2c54635SPaolo Bonzini# 2042e2c54635SPaolo Bonzini# STATE_PROTO: reading a function/whatever prototype. 2043e2c54635SPaolo Bonzini# 2044e2c54635SPaolo Bonzinisub process_proto($$) { 2045e2c54635SPaolo Bonzini my $file = shift; 2046e2c54635SPaolo Bonzini 2047e2c54635SPaolo Bonzini if (/$doc_inline_oneline/) { 2048e2c54635SPaolo Bonzini $section = $1; 2049e2c54635SPaolo Bonzini $contents = $2; 2050e2c54635SPaolo Bonzini if ($contents ne "") { 2051e2c54635SPaolo Bonzini $contents .= "\n"; 2052e2c54635SPaolo Bonzini dump_section($file, $section, $contents); 2053e2c54635SPaolo Bonzini $section = $section_default; 2054e2c54635SPaolo Bonzini $contents = ""; 2055e2c54635SPaolo Bonzini } 2056e2c54635SPaolo Bonzini } elsif (/$doc_inline_start/) { 2057e2c54635SPaolo Bonzini $state = STATE_INLINE; 2058e2c54635SPaolo Bonzini $inline_doc_state = STATE_INLINE_NAME; 2059e2c54635SPaolo Bonzini } elsif ($decl_type eq 'function') { 2060e2c54635SPaolo Bonzini process_proto_function($_, $file); 2061e2c54635SPaolo Bonzini } else { 2062e2c54635SPaolo Bonzini process_proto_type($_, $file); 2063e2c54635SPaolo Bonzini } 2064e2c54635SPaolo Bonzini} 2065e2c54635SPaolo Bonzini 2066e2c54635SPaolo Bonzini# 2067e2c54635SPaolo Bonzini# STATE_DOCBLOCK: within a DOC: block. 2068e2c54635SPaolo Bonzini# 2069e2c54635SPaolo Bonzinisub process_docblock($$) { 2070e2c54635SPaolo Bonzini my $file = shift; 2071e2c54635SPaolo Bonzini 2072e2c54635SPaolo Bonzini if (/$doc_end/) { 2073e2c54635SPaolo Bonzini dump_doc_section($file, $section, $contents); 2074e2c54635SPaolo Bonzini $section = $section_default; 2075e2c54635SPaolo Bonzini $contents = ""; 2076e2c54635SPaolo Bonzini $function = ""; 2077e2c54635SPaolo Bonzini %parameterdescs = (); 2078e2c54635SPaolo Bonzini %parametertypes = (); 2079e2c54635SPaolo Bonzini @parameterlist = (); 2080e2c54635SPaolo Bonzini %sections = (); 2081e2c54635SPaolo Bonzini @sectionlist = (); 2082e2c54635SPaolo Bonzini $prototype = ""; 2083e2c54635SPaolo Bonzini $state = STATE_NORMAL; 2084e2c54635SPaolo Bonzini } elsif (/$doc_content/) { 2085e2c54635SPaolo Bonzini if ( $1 eq "" ) { 2086e2c54635SPaolo Bonzini $contents .= $blankline; 2087e2c54635SPaolo Bonzini } else { 2088e2c54635SPaolo Bonzini $contents .= $1 . "\n"; 2089e2c54635SPaolo Bonzini } 2090e2c54635SPaolo Bonzini } 2091e2c54635SPaolo Bonzini} 2092e2c54635SPaolo Bonzini 2093e2c54635SPaolo Bonzini# 2094e2c54635SPaolo Bonzini# STATE_INLINE: docbook comments within a prototype. 2095e2c54635SPaolo Bonzini# 2096e2c54635SPaolo Bonzinisub process_inline($$) { 2097e2c54635SPaolo Bonzini my $file = shift; 2098e2c54635SPaolo Bonzini 2099e2c54635SPaolo Bonzini # First line (state 1) needs to be a @parameter 2100e2c54635SPaolo Bonzini if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) { 2101e2c54635SPaolo Bonzini $section = $1; 2102e2c54635SPaolo Bonzini $contents = $2; 2103e2c54635SPaolo Bonzini $new_start_line = $.; 2104e2c54635SPaolo Bonzini if ($contents ne "") { 2105e2c54635SPaolo Bonzini while (substr($contents, 0, 1) eq " ") { 2106e2c54635SPaolo Bonzini $contents = substr($contents, 1); 2107e2c54635SPaolo Bonzini } 2108e2c54635SPaolo Bonzini $contents .= "\n"; 2109e2c54635SPaolo Bonzini } 2110e2c54635SPaolo Bonzini $inline_doc_state = STATE_INLINE_TEXT; 2111e2c54635SPaolo Bonzini # Documentation block end */ 2112e2c54635SPaolo Bonzini } elsif (/$doc_inline_end/) { 2113e2c54635SPaolo Bonzini if (($contents ne "") && ($contents ne "\n")) { 2114e2c54635SPaolo Bonzini dump_section($file, $section, $contents); 2115e2c54635SPaolo Bonzini $section = $section_default; 2116e2c54635SPaolo Bonzini $contents = ""; 2117e2c54635SPaolo Bonzini } 2118e2c54635SPaolo Bonzini $state = STATE_PROTO; 2119e2c54635SPaolo Bonzini $inline_doc_state = STATE_INLINE_NA; 2120e2c54635SPaolo Bonzini # Regular text 2121e2c54635SPaolo Bonzini } elsif (/$doc_content/) { 2122e2c54635SPaolo Bonzini if ($inline_doc_state == STATE_INLINE_TEXT) { 2123e2c54635SPaolo Bonzini $contents .= $1 . "\n"; 2124e2c54635SPaolo Bonzini # nuke leading blank lines 2125e2c54635SPaolo Bonzini if ($contents =~ /^\s*$/) { 2126e2c54635SPaolo Bonzini $contents = ""; 2127e2c54635SPaolo Bonzini } 2128e2c54635SPaolo Bonzini } elsif ($inline_doc_state == STATE_INLINE_NAME) { 2129e2c54635SPaolo Bonzini $inline_doc_state = STATE_INLINE_ERROR; 2130e2c54635SPaolo Bonzini print STDERR "${file}:$.: warning: "; 2131e2c54635SPaolo Bonzini print STDERR "Incorrect use of kernel-doc format: $_"; 2132e2c54635SPaolo Bonzini ++$warnings; 2133e2c54635SPaolo Bonzini } 2134e2c54635SPaolo Bonzini } 2135e2c54635SPaolo Bonzini} 2136e2c54635SPaolo Bonzini 2137e2c54635SPaolo Bonzini 2138e2c54635SPaolo Bonzinisub process_file($) { 2139e2c54635SPaolo Bonzini my $file; 2140e2c54635SPaolo Bonzini my $initial_section_counter = $section_counter; 2141e2c54635SPaolo Bonzini my ($orig_file) = @_; 2142e2c54635SPaolo Bonzini 2143e2c54635SPaolo Bonzini $file = map_filename($orig_file); 2144e2c54635SPaolo Bonzini 2145e2c54635SPaolo Bonzini if (!open(IN,"<$file")) { 2146e2c54635SPaolo Bonzini print STDERR "Error: Cannot open file $file\n"; 2147e2c54635SPaolo Bonzini ++$errors; 2148e2c54635SPaolo Bonzini return; 2149e2c54635SPaolo Bonzini } 2150e2c54635SPaolo Bonzini 2151e2c54635SPaolo Bonzini $. = 1; 2152e2c54635SPaolo Bonzini 2153e2c54635SPaolo Bonzini $section_counter = 0; 2154e2c54635SPaolo Bonzini while (<IN>) { 2155e2c54635SPaolo Bonzini while (s/\\\s*$//) { 2156e2c54635SPaolo Bonzini $_ .= <IN>; 2157e2c54635SPaolo Bonzini } 2158e2c54635SPaolo Bonzini # Replace tabs by spaces 2159e2c54635SPaolo Bonzini while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {}; 2160e2c54635SPaolo Bonzini # Hand this line to the appropriate state handler 2161e2c54635SPaolo Bonzini if ($state == STATE_NORMAL) { 2162e2c54635SPaolo Bonzini process_normal(); 2163e2c54635SPaolo Bonzini } elsif ($state == STATE_NAME) { 2164e2c54635SPaolo Bonzini process_name($file, $_); 2165e2c54635SPaolo Bonzini } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE) { 2166e2c54635SPaolo Bonzini process_body($file, $_); 2167e2c54635SPaolo Bonzini } elsif ($state == STATE_INLINE) { # scanning for inline parameters 2168e2c54635SPaolo Bonzini process_inline($file, $_); 2169e2c54635SPaolo Bonzini } elsif ($state == STATE_PROTO) { 2170e2c54635SPaolo Bonzini process_proto($file, $_); 2171e2c54635SPaolo Bonzini } elsif ($state == STATE_DOCBLOCK) { 2172e2c54635SPaolo Bonzini process_docblock($file, $_); 2173e2c54635SPaolo Bonzini } 2174e2c54635SPaolo Bonzini } 2175e2c54635SPaolo Bonzini 2176e2c54635SPaolo Bonzini # Make sure we got something interesting. 2177e2c54635SPaolo Bonzini if ($initial_section_counter == $section_counter && $ 2178e2c54635SPaolo Bonzini output_mode ne "none") { 2179e2c54635SPaolo Bonzini if ($output_selection == OUTPUT_INCLUDE) { 2180e2c54635SPaolo Bonzini print STDERR "${file}:1: warning: '$_' not found\n" 2181e2c54635SPaolo Bonzini for keys %function_table; 2182e2c54635SPaolo Bonzini } 2183e2c54635SPaolo Bonzini else { 2184e2c54635SPaolo Bonzini print STDERR "${file}:1: warning: no structured comments found\n"; 2185e2c54635SPaolo Bonzini } 2186e2c54635SPaolo Bonzini } 2187e2c54635SPaolo Bonzini} 2188e2c54635SPaolo Bonzini 2189e2c54635SPaolo Bonzini 2190e2c54635SPaolo Bonzini$kernelversion = get_kernel_version(); 2191e2c54635SPaolo Bonzini 2192e2c54635SPaolo Bonzini# generate a sequence of code that will splice in highlighting information 2193e2c54635SPaolo Bonzini# using the s// operator. 2194e2c54635SPaolo Bonzinifor (my $k = 0; $k < @highlights; $k++) { 2195e2c54635SPaolo Bonzini my $pattern = $highlights[$k][0]; 2196e2c54635SPaolo Bonzini my $result = $highlights[$k][1]; 2197e2c54635SPaolo Bonzini# print STDERR "scanning pattern:$pattern, highlight:($result)\n"; 2198e2c54635SPaolo Bonzini $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n"; 2199e2c54635SPaolo Bonzini} 2200e2c54635SPaolo Bonzini 2201e2c54635SPaolo Bonzini# Read the file that maps relative names to absolute names for 2202e2c54635SPaolo Bonzini# separate source and object directories and for shadow trees. 2203e2c54635SPaolo Bonziniif (open(SOURCE_MAP, "<.tmp_filelist.txt")) { 2204e2c54635SPaolo Bonzini my ($relname, $absname); 2205e2c54635SPaolo Bonzini while(<SOURCE_MAP>) { 2206e2c54635SPaolo Bonzini chop(); 2207e2c54635SPaolo Bonzini ($relname, $absname) = (split())[0..1]; 2208e2c54635SPaolo Bonzini $relname =~ s:^/+::; 2209e2c54635SPaolo Bonzini $source_map{$relname} = $absname; 2210e2c54635SPaolo Bonzini } 2211e2c54635SPaolo Bonzini close(SOURCE_MAP); 2212e2c54635SPaolo Bonzini} 2213e2c54635SPaolo Bonzini 2214e2c54635SPaolo Bonziniif ($output_selection == OUTPUT_EXPORTED || 2215e2c54635SPaolo Bonzini $output_selection == OUTPUT_INTERNAL) { 2216e2c54635SPaolo Bonzini 2217e2c54635SPaolo Bonzini push(@export_file_list, @ARGV); 2218e2c54635SPaolo Bonzini 2219e2c54635SPaolo Bonzini foreach (@export_file_list) { 2220e2c54635SPaolo Bonzini chomp; 2221e2c54635SPaolo Bonzini process_export_file($_); 2222e2c54635SPaolo Bonzini } 2223e2c54635SPaolo Bonzini} 2224e2c54635SPaolo Bonzini 2225e2c54635SPaolo Bonziniforeach (@ARGV) { 2226e2c54635SPaolo Bonzini chomp; 2227e2c54635SPaolo Bonzini process_file($_); 2228e2c54635SPaolo Bonzini} 2229e2c54635SPaolo Bonziniif ($verbose && $errors) { 2230e2c54635SPaolo Bonzini print STDERR "$errors errors\n"; 2231e2c54635SPaolo Bonzini} 2232e2c54635SPaolo Bonziniif ($verbose && $warnings) { 2233e2c54635SPaolo Bonzini print STDERR "$warnings warnings\n"; 2234e2c54635SPaolo Bonzini} 2235e2c54635SPaolo Bonzini 2236e2c54635SPaolo Bonziniexit($output_mode eq "none" ? 0 : $errors); 2237