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