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