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