11da177e4SLinus Torvalds#!/usr/bin/perl -w 21da177e4SLinus Torvalds 31da177e4SLinus Torvaldsuse strict; 41da177e4SLinus Torvalds 51da177e4SLinus Torvalds## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## 61da177e4SLinus Torvalds## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ## 71da177e4SLinus Torvalds## Copyright (C) 2001 Simon Huggins ## 870c95b00SRandy Dunlap## Copyright (C) 2005-2012 Randy Dunlap ## 91da177e4SLinus Torvalds## ## 101da177e4SLinus Torvalds## #define enhancements by Armin Kuster <akuster@mvista.com> ## 111da177e4SLinus Torvalds## Copyright (c) 2000 MontaVista Software, Inc. ## 121da177e4SLinus Torvalds## ## 131da177e4SLinus Torvalds## This software falls under the GNU General Public License. ## 141da177e4SLinus Torvalds## Please read the COPYING file for more information ## 151da177e4SLinus Torvalds 161da177e4SLinus Torvalds# 18/01/2001 - Cleanups 171da177e4SLinus Torvalds# Functions prototyped as foo(void) same as foo() 181da177e4SLinus Torvalds# Stop eval'ing where we don't need to. 191da177e4SLinus Torvalds# -- huggie@earth.li 201da177e4SLinus Torvalds 211da177e4SLinus Torvalds# 27/06/2001 - Allowed whitespace after initial "/**" and 221da177e4SLinus Torvalds# allowed comments before function declarations. 231da177e4SLinus Torvalds# -- Christian Kreibich <ck@whoop.org> 241da177e4SLinus Torvalds 251da177e4SLinus Torvalds# Still to do: 261da177e4SLinus Torvalds# - add perldoc documentation 271da177e4SLinus Torvalds# - Look more closely at some of the scarier bits :) 281da177e4SLinus Torvalds 291da177e4SLinus Torvalds# 26/05/2001 - Support for separate source and object trees. 301da177e4SLinus Torvalds# Return error code. 311da177e4SLinus Torvalds# Keith Owens <kaos@ocs.com.au> 321da177e4SLinus Torvalds 331da177e4SLinus Torvalds# 23/09/2001 - Added support for typedefs, structs, enums and unions 341da177e4SLinus Torvalds# Support for Context section; can be terminated using empty line 351da177e4SLinus Torvalds# Small fixes (like spaces vs. \s in regex) 361da177e4SLinus Torvalds# -- Tim Jansen <tim@tjansen.de> 371da177e4SLinus Torvalds 381da177e4SLinus Torvalds 391da177e4SLinus Torvalds# 401da177e4SLinus Torvalds# This will read a 'c' file and scan for embedded comments in the 411da177e4SLinus Torvalds# style of gnome comments (+minor extensions - see below). 421da177e4SLinus Torvalds# 431da177e4SLinus Torvalds 441da177e4SLinus Torvalds# Note: This only supports 'c'. 451da177e4SLinus Torvalds 461da177e4SLinus Torvalds# usage: 47eda603f6SJohannes Berg# kernel-doc [ -docbook | -html | -text | -man | -list ] [ -no-doc-sections ] 481da177e4SLinus Torvalds# [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile 491da177e4SLinus Torvalds# or 501da177e4SLinus Torvalds# [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile 511da177e4SLinus Torvalds# 521da177e4SLinus Torvalds# Set output format using one of -docbook -html -text or -man. Default is man. 53eda603f6SJohannes Berg# The -list format is for internal use by docproc. 541da177e4SLinus Torvalds# 554b44595aSJohannes Berg# -no-doc-sections 564b44595aSJohannes Berg# Do not output DOC: sections 574b44595aSJohannes Berg# 581da177e4SLinus Torvalds# -function funcname 59b112e0f7SJohannes Berg# If set, then only generate documentation for the given function(s) or 60b112e0f7SJohannes Berg# DOC: section titles. All other functions and DOC: sections are ignored. 611da177e4SLinus Torvalds# 621da177e4SLinus Torvalds# -nofunction funcname 63b112e0f7SJohannes Berg# If set, then only generate documentation for the other function(s)/DOC: 64b112e0f7SJohannes Berg# sections. Cannot be used together with -function (yes, that's a bug -- 65b112e0f7SJohannes Berg# perl hackers can fix it 8)) 661da177e4SLinus Torvalds# 671da177e4SLinus Torvalds# c files - list of 'c' files to process 681da177e4SLinus Torvalds# 691da177e4SLinus Torvalds# All output goes to stdout, with errors to stderr. 701da177e4SLinus Torvalds 711da177e4SLinus Torvalds# 721da177e4SLinus Torvalds# format of comments. 731da177e4SLinus Torvalds# In the following table, (...)? signifies optional structure. 741da177e4SLinus Torvalds# (...)* signifies 0 or more structure elements 751da177e4SLinus Torvalds# /** 761da177e4SLinus Torvalds# * function_name(:)? (- short description)? 771da177e4SLinus Torvalds# (* @parameterx: (description of parameter x)?)* 781da177e4SLinus Torvalds# (* a blank line)? 791da177e4SLinus Torvalds# * (Description:)? (Description of function)? 801da177e4SLinus Torvalds# * (section header: (section description)? )* 811da177e4SLinus Torvalds# (*)?*/ 821da177e4SLinus Torvalds# 831da177e4SLinus Torvalds# So .. the trivial example would be: 841da177e4SLinus Torvalds# 851da177e4SLinus Torvalds# /** 861da177e4SLinus Torvalds# * my_function 87b9d97328SRandy Dunlap# */ 881da177e4SLinus Torvalds# 89891dcd2fSRandy Dunlap# If the Description: header tag is omitted, then there must be a blank line 901da177e4SLinus Torvalds# after the last parameter specification. 911da177e4SLinus Torvalds# e.g. 921da177e4SLinus Torvalds# /** 931da177e4SLinus Torvalds# * my_function - does my stuff 941da177e4SLinus Torvalds# * @my_arg: its mine damnit 951da177e4SLinus Torvalds# * 961da177e4SLinus Torvalds# * Does my stuff explained. 971da177e4SLinus Torvalds# */ 981da177e4SLinus Torvalds# 991da177e4SLinus Torvalds# or, could also use: 1001da177e4SLinus Torvalds# /** 1011da177e4SLinus Torvalds# * my_function - does my stuff 1021da177e4SLinus Torvalds# * @my_arg: its mine damnit 1031da177e4SLinus Torvalds# * Description: Does my stuff explained. 1041da177e4SLinus Torvalds# */ 1051da177e4SLinus Torvalds# etc. 1061da177e4SLinus Torvalds# 107b9d97328SRandy Dunlap# Besides functions you can also write documentation for structs, unions, 1081da177e4SLinus Torvalds# enums and typedefs. Instead of the function name you must write the name 1091da177e4SLinus Torvalds# of the declaration; the struct/union/enum/typedef must always precede 1101da177e4SLinus Torvalds# the name. Nesting of declarations is not supported. 1111da177e4SLinus Torvalds# Use the argument mechanism to document members or constants. 1121da177e4SLinus Torvalds# e.g. 1131da177e4SLinus Torvalds# /** 1141da177e4SLinus Torvalds# * struct my_struct - short description 1151da177e4SLinus Torvalds# * @a: first member 1161da177e4SLinus Torvalds# * @b: second member 1171da177e4SLinus Torvalds# * 1181da177e4SLinus Torvalds# * Longer description 1191da177e4SLinus Torvalds# */ 1201da177e4SLinus Torvalds# struct my_struct { 1211da177e4SLinus Torvalds# int a; 1221da177e4SLinus Torvalds# int b; 123aeec46b9SMartin Waitz# /* private: */ 124aeec46b9SMartin Waitz# int c; 1251da177e4SLinus Torvalds# }; 1261da177e4SLinus Torvalds# 1271da177e4SLinus Torvalds# All descriptions can be multiline, except the short function description. 1281da177e4SLinus Torvalds# 1291da177e4SLinus Torvalds# You can also add additional sections. When documenting kernel functions you 1301da177e4SLinus Torvalds# should document the "Context:" of the function, e.g. whether the functions 1311da177e4SLinus Torvalds# can be called form interrupts. Unlike other sections you can end it with an 1321da177e4SLinus Torvalds# empty line. 1331da177e4SLinus Torvalds# Example-sections should contain the string EXAMPLE so that they are marked 1341da177e4SLinus Torvalds# appropriately in DocBook. 1351da177e4SLinus Torvalds# 1361da177e4SLinus Torvalds# Example: 1371da177e4SLinus Torvalds# /** 1381da177e4SLinus Torvalds# * user_function - function that can only be called in user context 1391da177e4SLinus Torvalds# * @a: some argument 1401da177e4SLinus Torvalds# * Context: !in_interrupt() 1411da177e4SLinus Torvalds# * 1421da177e4SLinus Torvalds# * Some description 1431da177e4SLinus Torvalds# * Example: 1441da177e4SLinus Torvalds# * user_function(22); 1451da177e4SLinus Torvalds# */ 1461da177e4SLinus Torvalds# ... 1471da177e4SLinus Torvalds# 1481da177e4SLinus Torvalds# 1491da177e4SLinus Torvalds# All descriptive text is further processed, scanning for the following special 1501da177e4SLinus Torvalds# patterns, which are highlighted appropriately. 1511da177e4SLinus Torvalds# 1521da177e4SLinus Torvalds# 'funcname()' - function 1531da177e4SLinus Torvalds# '$ENVVAR' - environmental variable 1541da177e4SLinus Torvalds# '&struct_name' - name of a structure (up to two words including 'struct') 1551da177e4SLinus Torvalds# '@parameter' - name of a parameter 1561da177e4SLinus Torvalds# '%CONST' - name of a constant. 1571da177e4SLinus Torvalds 1588484baaaSRandy Dunlap## init lots of data 1598484baaaSRandy Dunlap 1601da177e4SLinus Torvaldsmy $errors = 0; 1611da177e4SLinus Torvaldsmy $warnings = 0; 1625f8c7c98SRandy Dunlapmy $anon_struct_union = 0; 1631da177e4SLinus Torvalds 1641da177e4SLinus Torvalds# match expressions used to find embedded type information 1651da177e4SLinus Torvaldsmy $type_constant = '\%([-_\w]+)'; 1661da177e4SLinus Torvaldsmy $type_func = '(\w+)\(\)'; 1671da177e4SLinus Torvaldsmy $type_param = '\@(\w+)'; 1683eb014a1SRandy Dunlapmy $type_struct = '\&((struct\s*)*[_\w]+)'; 1696b5b55f6SRandy Dunlapmy $type_struct_xml = '\\&((struct\s*)*[_\w]+)'; 1701da177e4SLinus Torvaldsmy $type_env = '(\$\w+)'; 1711da177e4SLinus Torvalds 1721da177e4SLinus Torvalds# Output conversion substitutions. 1731da177e4SLinus Torvalds# One for each output format 1741da177e4SLinus Torvalds 1751da177e4SLinus Torvalds# these work fairly well 1761da177e4SLinus Torvaldsmy %highlights_html = ( $type_constant, "<i>\$1</i>", 1771da177e4SLinus Torvalds $type_func, "<b>\$1</b>", 1783eb014a1SRandy Dunlap $type_struct_xml, "<i>\$1</i>", 1793eb014a1SRandy Dunlap $type_env, "<b><i>\$1</i></b>", 1801da177e4SLinus Torvalds $type_param, "<tt><b>\$1</b></tt>" ); 1816b5b55f6SRandy Dunlapmy $local_lt = "\\\\\\\\lt:"; 1826b5b55f6SRandy Dunlapmy $local_gt = "\\\\\\\\gt:"; 1836b5b55f6SRandy Dunlapmy $blankline_html = $local_lt . "p" . $local_gt; # was "<p>" 1841da177e4SLinus Torvalds 1851da177e4SLinus Torvalds# XML, docbook format 1861da177e4SLinus Torvaldsmy %highlights_xml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>", 1871da177e4SLinus Torvalds $type_constant, "<constant>\$1</constant>", 1881da177e4SLinus Torvalds $type_func, "<function>\$1</function>", 1895c98fc03SJohannes Berg $type_struct_xml, "<structname>\$1</structname>", 1901da177e4SLinus Torvalds $type_env, "<envar>\$1</envar>", 1911da177e4SLinus Torvalds $type_param, "<parameter>\$1</parameter>" ); 1925c98fc03SJohannes Bergmy $blankline_xml = $local_lt . "/para" . $local_gt . $local_lt . "para" . $local_gt . "\n"; 1931da177e4SLinus Torvalds 1941da177e4SLinus Torvalds# gnome, docbook format 1951da177e4SLinus Torvaldsmy %highlights_gnome = ( $type_constant, "<replaceable class=\"option\">\$1</replaceable>", 1961da177e4SLinus Torvalds $type_func, "<function>\$1</function>", 1971da177e4SLinus Torvalds $type_struct, "<structname>\$1</structname>", 1981da177e4SLinus Torvalds $type_env, "<envar>\$1</envar>", 1991da177e4SLinus Torvalds $type_param, "<parameter>\$1</parameter>" ); 2001da177e4SLinus Torvaldsmy $blankline_gnome = "</para><para>\n"; 2011da177e4SLinus Torvalds 2021da177e4SLinus Torvalds# these are pretty rough 2031da177e4SLinus Torvaldsmy %highlights_man = ( $type_constant, "\$1", 2041da177e4SLinus Torvalds $type_func, "\\\\fB\$1\\\\fP", 2051da177e4SLinus Torvalds $type_struct, "\\\\fI\$1\\\\fP", 2061da177e4SLinus Torvalds $type_param, "\\\\fI\$1\\\\fP" ); 2071da177e4SLinus Torvaldsmy $blankline_man = ""; 2081da177e4SLinus Torvalds 2091da177e4SLinus Torvalds# text-mode 2101da177e4SLinus Torvaldsmy %highlights_text = ( $type_constant, "\$1", 2111da177e4SLinus Torvalds $type_func, "\$1", 2121da177e4SLinus Torvalds $type_struct, "\$1", 2131da177e4SLinus Torvalds $type_param, "\$1" ); 2141da177e4SLinus Torvaldsmy $blankline_text = ""; 2151da177e4SLinus Torvalds 216eda603f6SJohannes Berg# list mode 217eda603f6SJohannes Bergmy %highlights_list = ( $type_constant, "\$1", 218eda603f6SJohannes Berg $type_func, "\$1", 219eda603f6SJohannes Berg $type_struct, "\$1", 220eda603f6SJohannes Berg $type_param, "\$1" ); 221eda603f6SJohannes Bergmy $blankline_list = ""; 2221da177e4SLinus Torvalds 2231da177e4SLinus Torvalds# read arguments 2241da177e4SLinus Torvaldsif ($#ARGV == -1) { 2251da177e4SLinus Torvalds usage(); 2261da177e4SLinus Torvalds} 2271da177e4SLinus Torvalds 2288484baaaSRandy Dunlapmy $kernelversion; 2298484baaaSRandy Dunlapmy $dohighlight = ""; 2308484baaaSRandy Dunlap 2311da177e4SLinus Torvaldsmy $verbose = 0; 2321da177e4SLinus Torvaldsmy $output_mode = "man"; 233e314ba31SDaniel Santosmy $output_preformatted = 0; 2344b44595aSJohannes Bergmy $no_doc_sections = 0; 2351da177e4SLinus Torvaldsmy %highlights = %highlights_man; 2361da177e4SLinus Torvaldsmy $blankline = $blankline_man; 2371da177e4SLinus Torvaldsmy $modulename = "Kernel API"; 2381da177e4SLinus Torvaldsmy $function_only = 0; 2391da177e4SLinus Torvaldsmy $man_date = ('January', 'February', 'March', 'April', 'May', 'June', 2401da177e4SLinus Torvalds 'July', 'August', 'September', 'October', 2411da177e4SLinus Torvalds 'November', 'December')[(localtime)[4]] . 2421da177e4SLinus Torvalds " " . ((localtime)[5]+1900); 2431da177e4SLinus Torvalds 2448484baaaSRandy Dunlap# Essentially these are globals. 245b9d97328SRandy Dunlap# They probably want to be tidied up, made more localised or something. 246b9d97328SRandy Dunlap# CAVEAT EMPTOR! Some of the others I localised may not want to be, which 2471da177e4SLinus Torvalds# could cause "use of undefined value" or other bugs. 2481da177e4SLinus Torvaldsmy ($function, %function_table, %parametertypes, $declaration_purpose); 2491da177e4SLinus Torvaldsmy ($type, $declaration_name, $return_type); 2501c32fd0cSIlya Dryomovmy ($newsection, $newcontents, $prototype, $brcount, %source_map); 2511da177e4SLinus Torvalds 252bd0e88e5SRandy Dunlapif (defined($ENV{'KBUILD_VERBOSE'})) { 253bd0e88e5SRandy Dunlap $verbose = "$ENV{'KBUILD_VERBOSE'}"; 254bd0e88e5SRandy Dunlap} 255bd0e88e5SRandy Dunlap 2561da177e4SLinus Torvalds# Generated docbook code is inserted in a template at a point where 2571da177e4SLinus Torvalds# docbook v3.1 requires a non-zero sequence of RefEntry's; see: 2581da177e4SLinus Torvalds# http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html 2591da177e4SLinus Torvalds# We keep track of number of generated entries and generate a dummy 2601da177e4SLinus Torvalds# if needs be to ensure the expanded template can be postprocessed 2611da177e4SLinus Torvalds# into html. 2621da177e4SLinus Torvaldsmy $section_counter = 0; 2631da177e4SLinus Torvalds 2641da177e4SLinus Torvaldsmy $lineprefix=""; 2651da177e4SLinus Torvalds 2661da177e4SLinus Torvalds# states 2671da177e4SLinus Torvalds# 0 - normal code 2681da177e4SLinus Torvalds# 1 - looking for function name 2691da177e4SLinus Torvalds# 2 - scanning field start. 2701da177e4SLinus Torvalds# 3 - scanning prototype. 2711da177e4SLinus Torvalds# 4 - documentation block 2721da177e4SLinus Torvaldsmy $state; 273850622dfSRandy Dunlapmy $in_doc_sect; 2741da177e4SLinus Torvalds 2751da177e4SLinus Torvalds#declaration types: can be 2761da177e4SLinus Torvalds# 'function', 'struct', 'union', 'enum', 'typedef' 2771da177e4SLinus Torvaldsmy $decl_type; 2781da177e4SLinus Torvalds 2791da177e4SLinus Torvaldsmy $doc_special = "\@\%\$\&"; 2801da177e4SLinus Torvalds 2811da177e4SLinus Torvaldsmy $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start. 2821da177e4SLinus Torvaldsmy $doc_end = '\*/'; 2831da177e4SLinus Torvaldsmy $doc_com = '\s*\*\s*'; 284*12ae6779SDaniel Santosmy $doc_com_body = '\s*\* ?'; 2851da177e4SLinus Torvaldsmy $doc_decl = $doc_com . '(\w+)'; 286891dcd2fSRandy Dunlapmy $doc_sect = $doc_com . '([' . $doc_special . ']?[\w\s]+):(.*)'; 287*12ae6779SDaniel Santosmy $doc_content = $doc_com_body . '(.*)'; 2881da177e4SLinus Torvaldsmy $doc_block = $doc_com . 'DOC:\s*(.*)?'; 2891da177e4SLinus Torvalds 2901da177e4SLinus Torvaldsmy %constants; 2911da177e4SLinus Torvaldsmy %parameterdescs; 2921da177e4SLinus Torvaldsmy @parameterlist; 2931da177e4SLinus Torvaldsmy %sections; 2941da177e4SLinus Torvaldsmy @sectionlist; 295a1d94aa5SRandy Dunlapmy $sectcheck; 296a1d94aa5SRandy Dunlapmy $struct_actual; 2971da177e4SLinus Torvalds 2981da177e4SLinus Torvaldsmy $contents = ""; 2991da177e4SLinus Torvaldsmy $section_default = "Description"; # default section 3001da177e4SLinus Torvaldsmy $section_intro = "Introduction"; 3011da177e4SLinus Torvaldsmy $section = $section_default; 3021da177e4SLinus Torvaldsmy $section_context = "Context"; 3031da177e4SLinus Torvalds 3041da177e4SLinus Torvaldsmy $undescribed = "-- undescribed --"; 3051da177e4SLinus Torvalds 3061da177e4SLinus Torvaldsreset_state(); 3071da177e4SLinus Torvalds 3081da177e4SLinus Torvaldswhile ($ARGV[0] =~ m/^-(.*)/) { 3091da177e4SLinus Torvalds my $cmd = shift @ARGV; 3101da177e4SLinus Torvalds if ($cmd eq "-html") { 3111da177e4SLinus Torvalds $output_mode = "html"; 3121da177e4SLinus Torvalds %highlights = %highlights_html; 3131da177e4SLinus Torvalds $blankline = $blankline_html; 3141da177e4SLinus Torvalds } elsif ($cmd eq "-man") { 3151da177e4SLinus Torvalds $output_mode = "man"; 3161da177e4SLinus Torvalds %highlights = %highlights_man; 3171da177e4SLinus Torvalds $blankline = $blankline_man; 3181da177e4SLinus Torvalds } elsif ($cmd eq "-text") { 3191da177e4SLinus Torvalds $output_mode = "text"; 3201da177e4SLinus Torvalds %highlights = %highlights_text; 3211da177e4SLinus Torvalds $blankline = $blankline_text; 3221da177e4SLinus Torvalds } elsif ($cmd eq "-docbook") { 3231da177e4SLinus Torvalds $output_mode = "xml"; 3241da177e4SLinus Torvalds %highlights = %highlights_xml; 3251da177e4SLinus Torvalds $blankline = $blankline_xml; 326eda603f6SJohannes Berg } elsif ($cmd eq "-list") { 327eda603f6SJohannes Berg $output_mode = "list"; 328eda603f6SJohannes Berg %highlights = %highlights_list; 329eda603f6SJohannes Berg $blankline = $blankline_list; 3301da177e4SLinus Torvalds } elsif ($cmd eq "-gnome") { 3311da177e4SLinus Torvalds $output_mode = "gnome"; 3321da177e4SLinus Torvalds %highlights = %highlights_gnome; 3331da177e4SLinus Torvalds $blankline = $blankline_gnome; 3341da177e4SLinus Torvalds } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document 3351da177e4SLinus Torvalds $modulename = shift @ARGV; 3361da177e4SLinus Torvalds } elsif ($cmd eq "-function") { # to only output specific functions 3371da177e4SLinus Torvalds $function_only = 1; 3381da177e4SLinus Torvalds $function = shift @ARGV; 3391da177e4SLinus Torvalds $function_table{$function} = 1; 3401da177e4SLinus Torvalds } elsif ($cmd eq "-nofunction") { # to only output specific functions 3411da177e4SLinus Torvalds $function_only = 2; 3421da177e4SLinus Torvalds $function = shift @ARGV; 3431da177e4SLinus Torvalds $function_table{$function} = 1; 3441da177e4SLinus Torvalds } elsif ($cmd eq "-v") { 3451da177e4SLinus Torvalds $verbose = 1; 3461da177e4SLinus Torvalds } elsif (($cmd eq "-h") || ($cmd eq "--help")) { 3471da177e4SLinus Torvalds usage(); 3484b44595aSJohannes Berg } elsif ($cmd eq '-no-doc-sections') { 3494b44595aSJohannes Berg $no_doc_sections = 1; 3501da177e4SLinus Torvalds } 3511da177e4SLinus Torvalds} 3521da177e4SLinus Torvalds 3538484baaaSRandy Dunlap# continue execution near EOF; 3548484baaaSRandy Dunlap 3558484baaaSRandy Dunlapsub usage { 3568484baaaSRandy Dunlap print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man | -list ]\n"; 3578484baaaSRandy Dunlap print " [ -no-doc-sections ]\n"; 3588484baaaSRandy Dunlap print " [ -function funcname [ -function funcname ...] ]\n"; 3598484baaaSRandy Dunlap print " [ -nofunction funcname [ -nofunction funcname ...] ]\n"; 3608484baaaSRandy Dunlap print " c source file(s) > outputfile\n"; 3618484baaaSRandy Dunlap print " -v : verbose output, more warnings & other info listed\n"; 3628484baaaSRandy Dunlap exit 1; 3638484baaaSRandy Dunlap} 3648484baaaSRandy Dunlap 36553f049faSBorislav Petkov# get kernel version from env 36653f049faSBorislav Petkovsub get_kernel_version() { 3671b9bc22dSJohannes Berg my $version = 'unknown kernel version'; 36853f049faSBorislav Petkov 36953f049faSBorislav Petkov if (defined($ENV{'KERNELVERSION'})) { 37053f049faSBorislav Petkov $version = $ENV{'KERNELVERSION'}; 37153f049faSBorislav Petkov } 37253f049faSBorislav Petkov return $version; 37353f049faSBorislav Petkov} 3741da177e4SLinus Torvalds 3751da177e4SLinus Torvalds## 3761da177e4SLinus Torvalds# dumps section contents to arrays/hashes intended for that purpose. 3771da177e4SLinus Torvalds# 3781da177e4SLinus Torvaldssub dump_section { 37994dc7ad5SRandy Dunlap my $file = shift; 3801da177e4SLinus Torvalds my $name = shift; 3811da177e4SLinus Torvalds my $contents = join "\n", @_; 3821da177e4SLinus Torvalds 3831da177e4SLinus Torvalds if ($name =~ m/$type_constant/) { 3841da177e4SLinus Torvalds $name = $1; 3851da177e4SLinus Torvalds# print STDERR "constant section '$1' = '$contents'\n"; 3861da177e4SLinus Torvalds $constants{$name} = $contents; 3871da177e4SLinus Torvalds } elsif ($name =~ m/$type_param/) { 3881da177e4SLinus Torvalds# print STDERR "parameter def '$1' = '$contents'\n"; 3891da177e4SLinus Torvalds $name = $1; 3901da177e4SLinus Torvalds $parameterdescs{$name} = $contents; 391a1d94aa5SRandy Dunlap $sectcheck = $sectcheck . $name . " "; 392ced69090SRandy Dunlap } elsif ($name eq "@\.\.\.") { 393ced69090SRandy Dunlap# print STDERR "parameter def '...' = '$contents'\n"; 394ced69090SRandy Dunlap $name = "..."; 395ced69090SRandy Dunlap $parameterdescs{$name} = $contents; 396a1d94aa5SRandy Dunlap $sectcheck = $sectcheck . $name . " "; 3971da177e4SLinus Torvalds } else { 3981da177e4SLinus Torvalds# print STDERR "other section '$name' = '$contents'\n"; 39994dc7ad5SRandy Dunlap if (defined($sections{$name}) && ($sections{$name} ne "")) { 40094dc7ad5SRandy Dunlap print STDERR "Error(${file}:$.): duplicate section name '$name'\n"; 40194dc7ad5SRandy Dunlap ++$errors; 40294dc7ad5SRandy Dunlap } 4031da177e4SLinus Torvalds $sections{$name} = $contents; 4041da177e4SLinus Torvalds push @sectionlist, $name; 4051da177e4SLinus Torvalds } 4061da177e4SLinus Torvalds} 4071da177e4SLinus Torvalds 4081da177e4SLinus Torvalds## 409b112e0f7SJohannes Berg# dump DOC: section after checking that it should go out 410b112e0f7SJohannes Berg# 411b112e0f7SJohannes Bergsub dump_doc_section { 41294dc7ad5SRandy Dunlap my $file = shift; 413b112e0f7SJohannes Berg my $name = shift; 414b112e0f7SJohannes Berg my $contents = join "\n", @_; 415b112e0f7SJohannes Berg 4164b44595aSJohannes Berg if ($no_doc_sections) { 4174b44595aSJohannes Berg return; 4184b44595aSJohannes Berg } 4194b44595aSJohannes Berg 420b112e0f7SJohannes Berg if (($function_only == 0) || 421b112e0f7SJohannes Berg ( $function_only == 1 && defined($function_table{$name})) || 422b112e0f7SJohannes Berg ( $function_only == 2 && !defined($function_table{$name}))) 423b112e0f7SJohannes Berg { 42494dc7ad5SRandy Dunlap dump_section($file, $name, $contents); 425b112e0f7SJohannes Berg output_blockhead({'sectionlist' => \@sectionlist, 426b112e0f7SJohannes Berg 'sections' => \%sections, 427b112e0f7SJohannes Berg 'module' => $modulename, 428b112e0f7SJohannes Berg 'content-only' => ($function_only != 0), }); 429b112e0f7SJohannes Berg } 430b112e0f7SJohannes Berg} 431b112e0f7SJohannes Berg 432b112e0f7SJohannes Berg## 4331da177e4SLinus Torvalds# output function 4341da177e4SLinus Torvalds# 4351da177e4SLinus Torvalds# parameterdescs, a hash. 4361da177e4SLinus Torvalds# function => "function name" 4371da177e4SLinus Torvalds# parameterlist => @list of parameters 4381da177e4SLinus Torvalds# parameterdescs => %parameter descriptions 4391da177e4SLinus Torvalds# sectionlist => @list of sections 440a21217daSRandy Dunlap# sections => %section descriptions 4411da177e4SLinus Torvalds# 4421da177e4SLinus Torvalds 4431da177e4SLinus Torvaldssub output_highlight { 4441da177e4SLinus Torvalds my $contents = join "\n",@_; 4451da177e4SLinus Torvalds my $line; 4461da177e4SLinus Torvalds 4471da177e4SLinus Torvalds# DEBUG 4481da177e4SLinus Torvalds# if (!defined $contents) { 4491da177e4SLinus Torvalds# use Carp; 4501da177e4SLinus Torvalds# confess "output_highlight got called with no args?\n"; 4511da177e4SLinus Torvalds# } 4521da177e4SLinus Torvalds 4535c98fc03SJohannes Berg if ($output_mode eq "html" || $output_mode eq "xml") { 4546b5b55f6SRandy Dunlap $contents = local_unescape($contents); 4556b5b55f6SRandy Dunlap # convert data read & converted thru xml_escape() into &xyz; format: 4562b35f4d9SRandy Dunlap $contents =~ s/\\\\\\/\&/g; 4576b5b55f6SRandy Dunlap } 4583eb014a1SRandy Dunlap# print STDERR "contents b4:$contents\n"; 4591da177e4SLinus Torvalds eval $dohighlight; 4601da177e4SLinus Torvalds die $@ if $@; 4613eb014a1SRandy Dunlap# print STDERR "contents af:$contents\n"; 4623eb014a1SRandy Dunlap 4631da177e4SLinus Torvalds foreach $line (split "\n", $contents) { 464*12ae6779SDaniel Santos if (! $output_preformatted) { 465*12ae6779SDaniel Santos $line =~ s/^\s*//; 466*12ae6779SDaniel Santos } 4671da177e4SLinus Torvalds if ($line eq ""){ 468e314ba31SDaniel Santos if (! $output_preformatted) { 4696b5b55f6SRandy Dunlap print $lineprefix, local_unescape($blankline); 470e314ba31SDaniel Santos } 4711da177e4SLinus Torvalds } else { 4721da177e4SLinus Torvalds $line =~ s/\\\\\\/\&/g; 473cdccb316SRandy Dunlap if ($output_mode eq "man" && substr($line, 0, 1) eq ".") { 474cdccb316SRandy Dunlap print "\\&$line"; 475cdccb316SRandy Dunlap } else { 4761da177e4SLinus Torvalds print $lineprefix, $line; 4771da177e4SLinus Torvalds } 478cdccb316SRandy Dunlap } 4791da177e4SLinus Torvalds print "\n"; 4801da177e4SLinus Torvalds } 4811da177e4SLinus Torvalds} 4821da177e4SLinus Torvalds 4831da177e4SLinus Torvalds#output sections in html 4841da177e4SLinus Torvaldssub output_section_html(%) { 4851da177e4SLinus Torvalds my %args = %{$_[0]}; 4861da177e4SLinus Torvalds my $section; 4871da177e4SLinus Torvalds 4881da177e4SLinus Torvalds foreach $section (@{$args{'sectionlist'}}) { 4891da177e4SLinus Torvalds print "<h3>$section</h3>\n"; 4901da177e4SLinus Torvalds print "<blockquote>\n"; 4911da177e4SLinus Torvalds output_highlight($args{'sections'}{$section}); 4921da177e4SLinus Torvalds print "</blockquote>\n"; 4931da177e4SLinus Torvalds } 4941da177e4SLinus Torvalds} 4951da177e4SLinus Torvalds 4961da177e4SLinus Torvalds# output enum in html 4971da177e4SLinus Torvaldssub output_enum_html(%) { 4981da177e4SLinus Torvalds my %args = %{$_[0]}; 4991da177e4SLinus Torvalds my ($parameter); 5001da177e4SLinus Torvalds my $count; 5011da177e4SLinus Torvalds print "<h2>enum " . $args{'enum'} . "</h2>\n"; 5021da177e4SLinus Torvalds 5031da177e4SLinus Torvalds print "<b>enum " . $args{'enum'} . "</b> {<br>\n"; 5041da177e4SLinus Torvalds $count = 0; 5051da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 5061da177e4SLinus Torvalds print " <b>" . $parameter . "</b>"; 5071da177e4SLinus Torvalds if ($count != $#{$args{'parameterlist'}}) { 5081da177e4SLinus Torvalds $count++; 5091da177e4SLinus Torvalds print ",\n"; 5101da177e4SLinus Torvalds } 5111da177e4SLinus Torvalds print "<br>"; 5121da177e4SLinus Torvalds } 5131da177e4SLinus Torvalds print "};<br>\n"; 5141da177e4SLinus Torvalds 5151da177e4SLinus Torvalds print "<h3>Constants</h3>\n"; 5161da177e4SLinus Torvalds print "<dl>\n"; 5171da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 5181da177e4SLinus Torvalds print "<dt><b>" . $parameter . "</b>\n"; 5191da177e4SLinus Torvalds print "<dd>"; 5201da177e4SLinus Torvalds output_highlight($args{'parameterdescs'}{$parameter}); 5211da177e4SLinus Torvalds } 5221da177e4SLinus Torvalds print "</dl>\n"; 5231da177e4SLinus Torvalds output_section_html(@_); 5241da177e4SLinus Torvalds print "<hr>\n"; 5251da177e4SLinus Torvalds} 5261da177e4SLinus Torvalds 527d28bee0cSRandy Dunlap# output typedef in html 5281da177e4SLinus Torvaldssub output_typedef_html(%) { 5291da177e4SLinus Torvalds my %args = %{$_[0]}; 5301da177e4SLinus Torvalds my ($parameter); 5311da177e4SLinus Torvalds my $count; 5321da177e4SLinus Torvalds print "<h2>typedef " . $args{'typedef'} . "</h2>\n"; 5331da177e4SLinus Torvalds 5341da177e4SLinus Torvalds print "<b>typedef " . $args{'typedef'} . "</b>\n"; 5351da177e4SLinus Torvalds output_section_html(@_); 5361da177e4SLinus Torvalds print "<hr>\n"; 5371da177e4SLinus Torvalds} 5381da177e4SLinus Torvalds 5391da177e4SLinus Torvalds# output struct in html 5401da177e4SLinus Torvaldssub output_struct_html(%) { 5411da177e4SLinus Torvalds my %args = %{$_[0]}; 5421da177e4SLinus Torvalds my ($parameter); 5431da177e4SLinus Torvalds 544262d9b01SRandy Dunlap print "<h2>" . $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "</h2>\n"; 5451da177e4SLinus Torvalds print "<b>" . $args{'type'} . " " . $args{'struct'} . "</b> {<br>\n"; 5461da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 5471da177e4SLinus Torvalds if ($parameter =~ /^#/) { 5481da177e4SLinus Torvalds print "$parameter<br>\n"; 5491da177e4SLinus Torvalds next; 5501da177e4SLinus Torvalds } 5511da177e4SLinus Torvalds my $parameter_name = $parameter; 5521da177e4SLinus Torvalds $parameter_name =~ s/\[.*//; 5531da177e4SLinus Torvalds 5541da177e4SLinus Torvalds ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 5551da177e4SLinus Torvalds $type = $args{'parametertypes'}{$parameter}; 5561da177e4SLinus Torvalds if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 5571da177e4SLinus Torvalds # pointer-to-function 5583eb014a1SRandy Dunlap print " <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>\n"; 5591da177e4SLinus Torvalds } elsif ($type =~ m/^(.*?)\s*(:.*)/) { 5603eb014a1SRandy Dunlap # bitfield 5613eb014a1SRandy Dunlap print " <i>$1</i> <b>$parameter</b>$2;<br>\n"; 5621da177e4SLinus Torvalds } else { 5633eb014a1SRandy Dunlap print " <i>$type</i> <b>$parameter</b>;<br>\n"; 5641da177e4SLinus Torvalds } 5651da177e4SLinus Torvalds } 5661da177e4SLinus Torvalds print "};<br>\n"; 5671da177e4SLinus Torvalds 5681da177e4SLinus Torvalds print "<h3>Members</h3>\n"; 5691da177e4SLinus Torvalds print "<dl>\n"; 5701da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 5711da177e4SLinus Torvalds ($parameter =~ /^#/) && next; 5721da177e4SLinus Torvalds 5731da177e4SLinus Torvalds my $parameter_name = $parameter; 5741da177e4SLinus Torvalds $parameter_name =~ s/\[.*//; 5751da177e4SLinus Torvalds 5761da177e4SLinus Torvalds ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 5771da177e4SLinus Torvalds print "<dt><b>" . $parameter . "</b>\n"; 5781da177e4SLinus Torvalds print "<dd>"; 5791da177e4SLinus Torvalds output_highlight($args{'parameterdescs'}{$parameter_name}); 5801da177e4SLinus Torvalds } 5811da177e4SLinus Torvalds print "</dl>\n"; 5821da177e4SLinus Torvalds output_section_html(@_); 5831da177e4SLinus Torvalds print "<hr>\n"; 5841da177e4SLinus Torvalds} 5851da177e4SLinus Torvalds 5861da177e4SLinus Torvalds# output function in html 5871da177e4SLinus Torvaldssub output_function_html(%) { 5881da177e4SLinus Torvalds my %args = %{$_[0]}; 5891da177e4SLinus Torvalds my ($parameter, $section); 5901da177e4SLinus Torvalds my $count; 5911da177e4SLinus Torvalds 592262d9b01SRandy Dunlap print "<h2>" . $args{'function'} . " - " . $args{'purpose'} . "</h2>\n"; 5931da177e4SLinus Torvalds print "<i>" . $args{'functiontype'} . "</i>\n"; 5941da177e4SLinus Torvalds print "<b>" . $args{'function'} . "</b>\n"; 5951da177e4SLinus Torvalds print "("; 5961da177e4SLinus Torvalds $count = 0; 5971da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 5981da177e4SLinus Torvalds $type = $args{'parametertypes'}{$parameter}; 5991da177e4SLinus Torvalds if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 6001da177e4SLinus Torvalds # pointer-to-function 6011da177e4SLinus Torvalds print "<i>$1</i><b>$parameter</b>) <i>($2)</i>"; 6021da177e4SLinus Torvalds } else { 6031da177e4SLinus Torvalds print "<i>" . $type . "</i> <b>" . $parameter . "</b>"; 6041da177e4SLinus Torvalds } 6051da177e4SLinus Torvalds if ($count != $#{$args{'parameterlist'}}) { 6061da177e4SLinus Torvalds $count++; 6071da177e4SLinus Torvalds print ",\n"; 6081da177e4SLinus Torvalds } 6091da177e4SLinus Torvalds } 6101da177e4SLinus Torvalds print ")\n"; 6111da177e4SLinus Torvalds 6121da177e4SLinus Torvalds print "<h3>Arguments</h3>\n"; 6131da177e4SLinus Torvalds print "<dl>\n"; 6141da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 6151da177e4SLinus Torvalds my $parameter_name = $parameter; 6161da177e4SLinus Torvalds $parameter_name =~ s/\[.*//; 6171da177e4SLinus Torvalds 6181da177e4SLinus Torvalds ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 6191da177e4SLinus Torvalds print "<dt><b>" . $parameter . "</b>\n"; 6201da177e4SLinus Torvalds print "<dd>"; 6211da177e4SLinus Torvalds output_highlight($args{'parameterdescs'}{$parameter_name}); 6221da177e4SLinus Torvalds } 6231da177e4SLinus Torvalds print "</dl>\n"; 6241da177e4SLinus Torvalds output_section_html(@_); 6251da177e4SLinus Torvalds print "<hr>\n"; 6261da177e4SLinus Torvalds} 6271da177e4SLinus Torvalds 628b112e0f7SJohannes Berg# output DOC: block header in html 629b112e0f7SJohannes Bergsub output_blockhead_html(%) { 6301da177e4SLinus Torvalds my %args = %{$_[0]}; 6311da177e4SLinus Torvalds my ($parameter, $section); 6321da177e4SLinus Torvalds my $count; 6331da177e4SLinus Torvalds 6341da177e4SLinus Torvalds foreach $section (@{$args{'sectionlist'}}) { 6351da177e4SLinus Torvalds print "<h3>$section</h3>\n"; 6361da177e4SLinus Torvalds print "<ul>\n"; 6371da177e4SLinus Torvalds output_highlight($args{'sections'}{$section}); 6381da177e4SLinus Torvalds print "</ul>\n"; 6391da177e4SLinus Torvalds } 6401da177e4SLinus Torvalds print "<hr>\n"; 6411da177e4SLinus Torvalds} 6421da177e4SLinus Torvalds 6431da177e4SLinus Torvaldssub output_section_xml(%) { 6441da177e4SLinus Torvalds my %args = %{$_[0]}; 6451da177e4SLinus Torvalds my $section; 6461da177e4SLinus Torvalds # print out each section 6471da177e4SLinus Torvalds $lineprefix=" "; 6481da177e4SLinus Torvalds foreach $section (@{$args{'sectionlist'}}) { 649c73894c1SRich Walker print "<refsect1>\n"; 650c73894c1SRich Walker print "<title>$section</title>\n"; 6511da177e4SLinus Torvalds if ($section =~ m/EXAMPLE/i) { 652c73894c1SRich Walker print "<informalexample><programlisting>\n"; 653e314ba31SDaniel Santos $output_preformatted = 1; 654c73894c1SRich Walker } else { 655c73894c1SRich Walker print "<para>\n"; 6561da177e4SLinus Torvalds } 6571da177e4SLinus Torvalds output_highlight($args{'sections'}{$section}); 658e314ba31SDaniel Santos $output_preformatted = 0; 6591da177e4SLinus Torvalds if ($section =~ m/EXAMPLE/i) { 660c73894c1SRich Walker print "</programlisting></informalexample>\n"; 661c73894c1SRich Walker } else { 662c73894c1SRich Walker print "</para>\n"; 6631da177e4SLinus Torvalds } 664c73894c1SRich Walker print "</refsect1>\n"; 6651da177e4SLinus Torvalds } 6661da177e4SLinus Torvalds} 6671da177e4SLinus Torvalds 6681da177e4SLinus Torvalds# output function in XML DocBook 6691da177e4SLinus Torvaldssub output_function_xml(%) { 6701da177e4SLinus Torvalds my %args = %{$_[0]}; 6711da177e4SLinus Torvalds my ($parameter, $section); 6721da177e4SLinus Torvalds my $count; 6731da177e4SLinus Torvalds my $id; 6741da177e4SLinus Torvalds 6751da177e4SLinus Torvalds $id = "API-" . $args{'function'}; 6761da177e4SLinus Torvalds $id =~ s/[^A-Za-z0-9]/-/g; 6771da177e4SLinus Torvalds 6785449bc94SPavel Pisa print "<refentry id=\"$id\">\n"; 6798b0c2d98SMartin Waitz print "<refentryinfo>\n"; 6808b0c2d98SMartin Waitz print " <title>LINUX</title>\n"; 6818b0c2d98SMartin Waitz print " <productname>Kernel Hackers Manual</productname>\n"; 6828b0c2d98SMartin Waitz print " <date>$man_date</date>\n"; 6838b0c2d98SMartin Waitz print "</refentryinfo>\n"; 6841da177e4SLinus Torvalds print "<refmeta>\n"; 6855449bc94SPavel Pisa print " <refentrytitle><phrase>" . $args{'function'} . "</phrase></refentrytitle>\n"; 6868b0c2d98SMartin Waitz print " <manvolnum>9</manvolnum>\n"; 6870366299bSBorislav Petkov print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n"; 6881da177e4SLinus Torvalds print "</refmeta>\n"; 6891da177e4SLinus Torvalds print "<refnamediv>\n"; 6901da177e4SLinus Torvalds print " <refname>" . $args{'function'} . "</refname>\n"; 6911da177e4SLinus Torvalds print " <refpurpose>\n"; 6921da177e4SLinus Torvalds print " "; 6931da177e4SLinus Torvalds output_highlight ($args{'purpose'}); 6941da177e4SLinus Torvalds print " </refpurpose>\n"; 6951da177e4SLinus Torvalds print "</refnamediv>\n"; 6961da177e4SLinus Torvalds 6971da177e4SLinus Torvalds print "<refsynopsisdiv>\n"; 6981da177e4SLinus Torvalds print " <title>Synopsis</title>\n"; 6991da177e4SLinus Torvalds print " <funcsynopsis><funcprototype>\n"; 7001da177e4SLinus Torvalds print " <funcdef>" . $args{'functiontype'} . " "; 7011da177e4SLinus Torvalds print "<function>" . $args{'function'} . " </function></funcdef>\n"; 7021da177e4SLinus Torvalds 7031da177e4SLinus Torvalds $count = 0; 7041da177e4SLinus Torvalds if ($#{$args{'parameterlist'}} >= 0) { 7051da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 7061da177e4SLinus Torvalds $type = $args{'parametertypes'}{$parameter}; 7071da177e4SLinus Torvalds if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 7081da177e4SLinus Torvalds # pointer-to-function 7091da177e4SLinus Torvalds print " <paramdef>$1<parameter>$parameter</parameter>)\n"; 7101da177e4SLinus Torvalds print " <funcparams>$2</funcparams></paramdef>\n"; 7111da177e4SLinus Torvalds } else { 7121da177e4SLinus Torvalds print " <paramdef>" . $type; 7131da177e4SLinus Torvalds print " <parameter>$parameter</parameter></paramdef>\n"; 7141da177e4SLinus Torvalds } 7151da177e4SLinus Torvalds } 7161da177e4SLinus Torvalds } else { 7176013d544SMartin Waitz print " <void/>\n"; 7181da177e4SLinus Torvalds } 7191da177e4SLinus Torvalds print " </funcprototype></funcsynopsis>\n"; 7201da177e4SLinus Torvalds print "</refsynopsisdiv>\n"; 7211da177e4SLinus Torvalds 7221da177e4SLinus Torvalds # print parameters 7231da177e4SLinus Torvalds print "<refsect1>\n <title>Arguments</title>\n"; 7241da177e4SLinus Torvalds if ($#{$args{'parameterlist'}} >= 0) { 7251da177e4SLinus Torvalds print " <variablelist>\n"; 7261da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 7271da177e4SLinus Torvalds my $parameter_name = $parameter; 7281da177e4SLinus Torvalds $parameter_name =~ s/\[.*//; 7291da177e4SLinus Torvalds 7301da177e4SLinus Torvalds print " <varlistentry>\n <term><parameter>$parameter</parameter></term>\n"; 7311da177e4SLinus Torvalds print " <listitem>\n <para>\n"; 7321da177e4SLinus Torvalds $lineprefix=" "; 7331da177e4SLinus Torvalds output_highlight($args{'parameterdescs'}{$parameter_name}); 7341da177e4SLinus Torvalds print " </para>\n </listitem>\n </varlistentry>\n"; 7351da177e4SLinus Torvalds } 7361da177e4SLinus Torvalds print " </variablelist>\n"; 7371da177e4SLinus Torvalds } else { 7381da177e4SLinus Torvalds print " <para>\n None\n </para>\n"; 7391da177e4SLinus Torvalds } 7401da177e4SLinus Torvalds print "</refsect1>\n"; 7411da177e4SLinus Torvalds 7421da177e4SLinus Torvalds output_section_xml(@_); 7431da177e4SLinus Torvalds print "</refentry>\n\n"; 7441da177e4SLinus Torvalds} 7451da177e4SLinus Torvalds 7461da177e4SLinus Torvalds# output struct in XML DocBook 7471da177e4SLinus Torvaldssub output_struct_xml(%) { 7481da177e4SLinus Torvalds my %args = %{$_[0]}; 7491da177e4SLinus Torvalds my ($parameter, $section); 7501da177e4SLinus Torvalds my $id; 7511da177e4SLinus Torvalds 7521da177e4SLinus Torvalds $id = "API-struct-" . $args{'struct'}; 7531da177e4SLinus Torvalds $id =~ s/[^A-Za-z0-9]/-/g; 7541da177e4SLinus Torvalds 7555449bc94SPavel Pisa print "<refentry id=\"$id\">\n"; 7568b0c2d98SMartin Waitz print "<refentryinfo>\n"; 7578b0c2d98SMartin Waitz print " <title>LINUX</title>\n"; 7588b0c2d98SMartin Waitz print " <productname>Kernel Hackers Manual</productname>\n"; 7598b0c2d98SMartin Waitz print " <date>$man_date</date>\n"; 7608b0c2d98SMartin Waitz print "</refentryinfo>\n"; 7611da177e4SLinus Torvalds print "<refmeta>\n"; 7625449bc94SPavel Pisa print " <refentrytitle><phrase>" . $args{'type'} . " " . $args{'struct'} . "</phrase></refentrytitle>\n"; 7638b0c2d98SMartin Waitz print " <manvolnum>9</manvolnum>\n"; 7640366299bSBorislav Petkov print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n"; 7651da177e4SLinus Torvalds print "</refmeta>\n"; 7661da177e4SLinus Torvalds print "<refnamediv>\n"; 7671da177e4SLinus Torvalds print " <refname>" . $args{'type'} . " " . $args{'struct'} . "</refname>\n"; 7681da177e4SLinus Torvalds print " <refpurpose>\n"; 7691da177e4SLinus Torvalds print " "; 7701da177e4SLinus Torvalds output_highlight ($args{'purpose'}); 7711da177e4SLinus Torvalds print " </refpurpose>\n"; 7721da177e4SLinus Torvalds print "</refnamediv>\n"; 7731da177e4SLinus Torvalds 7741da177e4SLinus Torvalds print "<refsynopsisdiv>\n"; 7751da177e4SLinus Torvalds print " <title>Synopsis</title>\n"; 7761da177e4SLinus Torvalds print " <programlisting>\n"; 7771da177e4SLinus Torvalds print $args{'type'} . " " . $args{'struct'} . " {\n"; 7781da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 7791da177e4SLinus Torvalds if ($parameter =~ /^#/) { 7802b35f4d9SRandy Dunlap my $prm = $parameter; 7812b35f4d9SRandy Dunlap # convert data read & converted thru xml_escape() into &xyz; format: 7822b35f4d9SRandy Dunlap # This allows us to have #define macros interspersed in a struct. 7832b35f4d9SRandy Dunlap $prm =~ s/\\\\\\/\&/g; 7842b35f4d9SRandy Dunlap print "$prm\n"; 7851da177e4SLinus Torvalds next; 7861da177e4SLinus Torvalds } 7871da177e4SLinus Torvalds 7881da177e4SLinus Torvalds my $parameter_name = $parameter; 7891da177e4SLinus Torvalds $parameter_name =~ s/\[.*//; 7901da177e4SLinus Torvalds 7911da177e4SLinus Torvalds defined($args{'parameterdescs'}{$parameter_name}) || next; 7921da177e4SLinus Torvalds ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 7931da177e4SLinus Torvalds $type = $args{'parametertypes'}{$parameter}; 7941da177e4SLinus Torvalds if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 7951da177e4SLinus Torvalds # pointer-to-function 7961da177e4SLinus Torvalds print " $1 $parameter) ($2);\n"; 7971da177e4SLinus Torvalds } elsif ($type =~ m/^(.*?)\s*(:.*)/) { 79851f5a0c8SRandy Dunlap # bitfield 7991da177e4SLinus Torvalds print " $1 $parameter$2;\n"; 8001da177e4SLinus Torvalds } else { 8011da177e4SLinus Torvalds print " " . $type . " " . $parameter . ";\n"; 8021da177e4SLinus Torvalds } 8031da177e4SLinus Torvalds } 8041da177e4SLinus Torvalds print "};"; 8051da177e4SLinus Torvalds print " </programlisting>\n"; 8061da177e4SLinus Torvalds print "</refsynopsisdiv>\n"; 8071da177e4SLinus Torvalds 8081da177e4SLinus Torvalds print " <refsect1>\n"; 8091da177e4SLinus Torvalds print " <title>Members</title>\n"; 8101da177e4SLinus Torvalds 81139f00c08SRandy Dunlap if ($#{$args{'parameterlist'}} >= 0) { 8121da177e4SLinus Torvalds print " <variablelist>\n"; 8131da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 8141da177e4SLinus Torvalds ($parameter =~ /^#/) && next; 8151da177e4SLinus Torvalds 8161da177e4SLinus Torvalds my $parameter_name = $parameter; 8171da177e4SLinus Torvalds $parameter_name =~ s/\[.*//; 8181da177e4SLinus Torvalds 8191da177e4SLinus Torvalds defined($args{'parameterdescs'}{$parameter_name}) || next; 8201da177e4SLinus Torvalds ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 8211da177e4SLinus Torvalds print " <varlistentry>"; 8221da177e4SLinus Torvalds print " <term>$parameter</term>\n"; 8231da177e4SLinus Torvalds print " <listitem><para>\n"; 8241da177e4SLinus Torvalds output_highlight($args{'parameterdescs'}{$parameter_name}); 8251da177e4SLinus Torvalds print " </para></listitem>\n"; 8261da177e4SLinus Torvalds print " </varlistentry>\n"; 8271da177e4SLinus Torvalds } 8281da177e4SLinus Torvalds print " </variablelist>\n"; 82939f00c08SRandy Dunlap } else { 83039f00c08SRandy Dunlap print " <para>\n None\n </para>\n"; 83139f00c08SRandy Dunlap } 8321da177e4SLinus Torvalds print " </refsect1>\n"; 8331da177e4SLinus Torvalds 8341da177e4SLinus Torvalds output_section_xml(@_); 8351da177e4SLinus Torvalds 8361da177e4SLinus Torvalds print "</refentry>\n\n"; 8371da177e4SLinus Torvalds} 8381da177e4SLinus Torvalds 8391da177e4SLinus Torvalds# output enum in XML DocBook 8401da177e4SLinus Torvaldssub output_enum_xml(%) { 8411da177e4SLinus Torvalds my %args = %{$_[0]}; 8421da177e4SLinus Torvalds my ($parameter, $section); 8431da177e4SLinus Torvalds my $count; 8441da177e4SLinus Torvalds my $id; 8451da177e4SLinus Torvalds 8461da177e4SLinus Torvalds $id = "API-enum-" . $args{'enum'}; 8471da177e4SLinus Torvalds $id =~ s/[^A-Za-z0-9]/-/g; 8481da177e4SLinus Torvalds 8495449bc94SPavel Pisa print "<refentry id=\"$id\">\n"; 8508b0c2d98SMartin Waitz print "<refentryinfo>\n"; 8518b0c2d98SMartin Waitz print " <title>LINUX</title>\n"; 8528b0c2d98SMartin Waitz print " <productname>Kernel Hackers Manual</productname>\n"; 8538b0c2d98SMartin Waitz print " <date>$man_date</date>\n"; 8548b0c2d98SMartin Waitz print "</refentryinfo>\n"; 8551da177e4SLinus Torvalds print "<refmeta>\n"; 8565449bc94SPavel Pisa print " <refentrytitle><phrase>enum " . $args{'enum'} . "</phrase></refentrytitle>\n"; 8578b0c2d98SMartin Waitz print " <manvolnum>9</manvolnum>\n"; 8580366299bSBorislav Petkov print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n"; 8591da177e4SLinus Torvalds print "</refmeta>\n"; 8601da177e4SLinus Torvalds print "<refnamediv>\n"; 8611da177e4SLinus Torvalds print " <refname>enum " . $args{'enum'} . "</refname>\n"; 8621da177e4SLinus Torvalds print " <refpurpose>\n"; 8631da177e4SLinus Torvalds print " "; 8641da177e4SLinus Torvalds output_highlight ($args{'purpose'}); 8651da177e4SLinus Torvalds print " </refpurpose>\n"; 8661da177e4SLinus Torvalds print "</refnamediv>\n"; 8671da177e4SLinus Torvalds 8681da177e4SLinus Torvalds print "<refsynopsisdiv>\n"; 8691da177e4SLinus Torvalds print " <title>Synopsis</title>\n"; 8701da177e4SLinus Torvalds print " <programlisting>\n"; 8711da177e4SLinus Torvalds print "enum " . $args{'enum'} . " {\n"; 8721da177e4SLinus Torvalds $count = 0; 8731da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 8741da177e4SLinus Torvalds print " $parameter"; 8751da177e4SLinus Torvalds if ($count != $#{$args{'parameterlist'}}) { 8761da177e4SLinus Torvalds $count++; 8771da177e4SLinus Torvalds print ","; 8781da177e4SLinus Torvalds } 8791da177e4SLinus Torvalds print "\n"; 8801da177e4SLinus Torvalds } 8811da177e4SLinus Torvalds print "};"; 8821da177e4SLinus Torvalds print " </programlisting>\n"; 8831da177e4SLinus Torvalds print "</refsynopsisdiv>\n"; 8841da177e4SLinus Torvalds 8851da177e4SLinus Torvalds print "<refsect1>\n"; 8861da177e4SLinus Torvalds print " <title>Constants</title>\n"; 8871da177e4SLinus Torvalds print " <variablelist>\n"; 8881da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 8891da177e4SLinus Torvalds my $parameter_name = $parameter; 8901da177e4SLinus Torvalds $parameter_name =~ s/\[.*//; 8911da177e4SLinus Torvalds 8921da177e4SLinus Torvalds print " <varlistentry>"; 8931da177e4SLinus Torvalds print " <term>$parameter</term>\n"; 8941da177e4SLinus Torvalds print " <listitem><para>\n"; 8951da177e4SLinus Torvalds output_highlight($args{'parameterdescs'}{$parameter_name}); 8961da177e4SLinus Torvalds print " </para></listitem>\n"; 8971da177e4SLinus Torvalds print " </varlistentry>\n"; 8981da177e4SLinus Torvalds } 8991da177e4SLinus Torvalds print " </variablelist>\n"; 9001da177e4SLinus Torvalds print "</refsect1>\n"; 9011da177e4SLinus Torvalds 9021da177e4SLinus Torvalds output_section_xml(@_); 9031da177e4SLinus Torvalds 9041da177e4SLinus Torvalds print "</refentry>\n\n"; 9051da177e4SLinus Torvalds} 9061da177e4SLinus Torvalds 9071da177e4SLinus Torvalds# output typedef in XML DocBook 9081da177e4SLinus Torvaldssub output_typedef_xml(%) { 9091da177e4SLinus Torvalds my %args = %{$_[0]}; 9101da177e4SLinus Torvalds my ($parameter, $section); 9111da177e4SLinus Torvalds my $id; 9121da177e4SLinus Torvalds 9131da177e4SLinus Torvalds $id = "API-typedef-" . $args{'typedef'}; 9141da177e4SLinus Torvalds $id =~ s/[^A-Za-z0-9]/-/g; 9151da177e4SLinus Torvalds 9165449bc94SPavel Pisa print "<refentry id=\"$id\">\n"; 9178b0c2d98SMartin Waitz print "<refentryinfo>\n"; 9188b0c2d98SMartin Waitz print " <title>LINUX</title>\n"; 9198b0c2d98SMartin Waitz print " <productname>Kernel Hackers Manual</productname>\n"; 9208b0c2d98SMartin Waitz print " <date>$man_date</date>\n"; 9218b0c2d98SMartin Waitz print "</refentryinfo>\n"; 9221da177e4SLinus Torvalds print "<refmeta>\n"; 9235449bc94SPavel Pisa print " <refentrytitle><phrase>typedef " . $args{'typedef'} . "</phrase></refentrytitle>\n"; 9248b0c2d98SMartin Waitz print " <manvolnum>9</manvolnum>\n"; 9251da177e4SLinus Torvalds print "</refmeta>\n"; 9261da177e4SLinus Torvalds print "<refnamediv>\n"; 9271da177e4SLinus Torvalds print " <refname>typedef " . $args{'typedef'} . "</refname>\n"; 9281da177e4SLinus Torvalds print " <refpurpose>\n"; 9291da177e4SLinus Torvalds print " "; 9301da177e4SLinus Torvalds output_highlight ($args{'purpose'}); 9311da177e4SLinus Torvalds print " </refpurpose>\n"; 9321da177e4SLinus Torvalds print "</refnamediv>\n"; 9331da177e4SLinus Torvalds 9341da177e4SLinus Torvalds print "<refsynopsisdiv>\n"; 9351da177e4SLinus Torvalds print " <title>Synopsis</title>\n"; 9361da177e4SLinus Torvalds print " <synopsis>typedef " . $args{'typedef'} . ";</synopsis>\n"; 9371da177e4SLinus Torvalds print "</refsynopsisdiv>\n"; 9381da177e4SLinus Torvalds 9391da177e4SLinus Torvalds output_section_xml(@_); 9401da177e4SLinus Torvalds 9411da177e4SLinus Torvalds print "</refentry>\n\n"; 9421da177e4SLinus Torvalds} 9431da177e4SLinus Torvalds 9441da177e4SLinus Torvalds# output in XML DocBook 945b112e0f7SJohannes Bergsub output_blockhead_xml(%) { 9461da177e4SLinus Torvalds my %args = %{$_[0]}; 9471da177e4SLinus Torvalds my ($parameter, $section); 9481da177e4SLinus Torvalds my $count; 9491da177e4SLinus Torvalds 9501da177e4SLinus Torvalds my $id = $args{'module'}; 9511da177e4SLinus Torvalds $id =~ s/[^A-Za-z0-9]/-/g; 9521da177e4SLinus Torvalds 9531da177e4SLinus Torvalds # print out each section 9541da177e4SLinus Torvalds $lineprefix=" "; 9551da177e4SLinus Torvalds foreach $section (@{$args{'sectionlist'}}) { 956b112e0f7SJohannes Berg if (!$args{'content-only'}) { 957b112e0f7SJohannes Berg print "<refsect1>\n <title>$section</title>\n"; 958b112e0f7SJohannes Berg } 9591da177e4SLinus Torvalds if ($section =~ m/EXAMPLE/i) { 9601da177e4SLinus Torvalds print "<example><para>\n"; 961e314ba31SDaniel Santos $output_preformatted = 1; 962b112e0f7SJohannes Berg } else { 963b112e0f7SJohannes Berg print "<para>\n"; 9641da177e4SLinus Torvalds } 9651da177e4SLinus Torvalds output_highlight($args{'sections'}{$section}); 966e314ba31SDaniel Santos $output_preformatted = 0; 9671da177e4SLinus Torvalds if ($section =~ m/EXAMPLE/i) { 9681da177e4SLinus Torvalds print "</para></example>\n"; 969b112e0f7SJohannes Berg } else { 970b112e0f7SJohannes Berg print "</para>"; 9711da177e4SLinus Torvalds } 972b112e0f7SJohannes Berg if (!$args{'content-only'}) { 973b112e0f7SJohannes Berg print "\n</refsect1>\n"; 974b112e0f7SJohannes Berg } 9751da177e4SLinus Torvalds } 9761da177e4SLinus Torvalds 9771da177e4SLinus Torvalds print "\n\n"; 9781da177e4SLinus Torvalds} 9791da177e4SLinus Torvalds 9801da177e4SLinus Torvalds# output in XML DocBook 9811da177e4SLinus Torvaldssub output_function_gnome { 9821da177e4SLinus Torvalds my %args = %{$_[0]}; 9831da177e4SLinus Torvalds my ($parameter, $section); 9841da177e4SLinus Torvalds my $count; 9851da177e4SLinus Torvalds my $id; 9861da177e4SLinus Torvalds 9871da177e4SLinus Torvalds $id = $args{'module'} . "-" . $args{'function'}; 9881da177e4SLinus Torvalds $id =~ s/[^A-Za-z0-9]/-/g; 9891da177e4SLinus Torvalds 9901da177e4SLinus Torvalds print "<sect2>\n"; 9911da177e4SLinus Torvalds print " <title id=\"$id\">" . $args{'function'} . "</title>\n"; 9921da177e4SLinus Torvalds 9931da177e4SLinus Torvalds print " <funcsynopsis>\n"; 9941da177e4SLinus Torvalds print " <funcdef>" . $args{'functiontype'} . " "; 9951da177e4SLinus Torvalds print "<function>" . $args{'function'} . " "; 9961da177e4SLinus Torvalds print "</function></funcdef>\n"; 9971da177e4SLinus Torvalds 9981da177e4SLinus Torvalds $count = 0; 9991da177e4SLinus Torvalds if ($#{$args{'parameterlist'}} >= 0) { 10001da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 10011da177e4SLinus Torvalds $type = $args{'parametertypes'}{$parameter}; 10021da177e4SLinus Torvalds if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 10031da177e4SLinus Torvalds # pointer-to-function 10041da177e4SLinus Torvalds print " <paramdef>$1 <parameter>$parameter</parameter>)\n"; 10051da177e4SLinus Torvalds print " <funcparams>$2</funcparams></paramdef>\n"; 10061da177e4SLinus Torvalds } else { 10071da177e4SLinus Torvalds print " <paramdef>" . $type; 10081da177e4SLinus Torvalds print " <parameter>$parameter</parameter></paramdef>\n"; 10091da177e4SLinus Torvalds } 10101da177e4SLinus Torvalds } 10111da177e4SLinus Torvalds } else { 10121da177e4SLinus Torvalds print " <void>\n"; 10131da177e4SLinus Torvalds } 10141da177e4SLinus Torvalds print " </funcsynopsis>\n"; 10151da177e4SLinus Torvalds if ($#{$args{'parameterlist'}} >= 0) { 10161da177e4SLinus Torvalds print " <informaltable pgwide=\"1\" frame=\"none\" role=\"params\">\n"; 10171da177e4SLinus Torvalds print "<tgroup cols=\"2\">\n"; 10181da177e4SLinus Torvalds print "<colspec colwidth=\"2*\">\n"; 10191da177e4SLinus Torvalds print "<colspec colwidth=\"8*\">\n"; 10201da177e4SLinus Torvalds print "<tbody>\n"; 10211da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 10221da177e4SLinus Torvalds my $parameter_name = $parameter; 10231da177e4SLinus Torvalds $parameter_name =~ s/\[.*//; 10241da177e4SLinus Torvalds 10251da177e4SLinus Torvalds print " <row><entry align=\"right\"><parameter>$parameter</parameter></entry>\n"; 10261da177e4SLinus Torvalds print " <entry>\n"; 10271da177e4SLinus Torvalds $lineprefix=" "; 10281da177e4SLinus Torvalds output_highlight($args{'parameterdescs'}{$parameter_name}); 10291da177e4SLinus Torvalds print " </entry></row>\n"; 10301da177e4SLinus Torvalds } 10311da177e4SLinus Torvalds print " </tbody></tgroup></informaltable>\n"; 10321da177e4SLinus Torvalds } else { 10331da177e4SLinus Torvalds print " <para>\n None\n </para>\n"; 10341da177e4SLinus Torvalds } 10351da177e4SLinus Torvalds 10361da177e4SLinus Torvalds # print out each section 10371da177e4SLinus Torvalds $lineprefix=" "; 10381da177e4SLinus Torvalds foreach $section (@{$args{'sectionlist'}}) { 10391da177e4SLinus Torvalds print "<simplesect>\n <title>$section</title>\n"; 10401da177e4SLinus Torvalds if ($section =~ m/EXAMPLE/i) { 10411da177e4SLinus Torvalds print "<example><programlisting>\n"; 1042e314ba31SDaniel Santos $output_preformatted = 1; 10431da177e4SLinus Torvalds } else { 10441da177e4SLinus Torvalds } 10451da177e4SLinus Torvalds print "<para>\n"; 10461da177e4SLinus Torvalds output_highlight($args{'sections'}{$section}); 1047e314ba31SDaniel Santos $output_preformatted = 0; 10481da177e4SLinus Torvalds print "</para>\n"; 10491da177e4SLinus Torvalds if ($section =~ m/EXAMPLE/i) { 10501da177e4SLinus Torvalds print "</programlisting></example>\n"; 10511da177e4SLinus Torvalds } else { 10521da177e4SLinus Torvalds } 10531da177e4SLinus Torvalds print " </simplesect>\n"; 10541da177e4SLinus Torvalds } 10551da177e4SLinus Torvalds 10561da177e4SLinus Torvalds print "</sect2>\n\n"; 10571da177e4SLinus Torvalds} 10581da177e4SLinus Torvalds 10591da177e4SLinus Torvalds## 10601da177e4SLinus Torvalds# output function in man 10611da177e4SLinus Torvaldssub output_function_man(%) { 10621da177e4SLinus Torvalds my %args = %{$_[0]}; 10631da177e4SLinus Torvalds my ($parameter, $section); 10641da177e4SLinus Torvalds my $count; 10651da177e4SLinus Torvalds 10661da177e4SLinus Torvalds print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n"; 10671da177e4SLinus Torvalds 10681da177e4SLinus Torvalds print ".SH NAME\n"; 10691da177e4SLinus Torvalds print $args{'function'} . " \\- " . $args{'purpose'} . "\n"; 10701da177e4SLinus Torvalds 10711da177e4SLinus Torvalds print ".SH SYNOPSIS\n"; 1072a21217daSRandy Dunlap if ($args{'functiontype'} ne "") { 10731da177e4SLinus Torvalds print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n"; 1074a21217daSRandy Dunlap } else { 1075a21217daSRandy Dunlap print ".B \"" . $args{'function'} . "\n"; 1076a21217daSRandy Dunlap } 10771da177e4SLinus Torvalds $count = 0; 10781da177e4SLinus Torvalds my $parenth = "("; 10791da177e4SLinus Torvalds my $post = ","; 10801da177e4SLinus Torvalds foreach my $parameter (@{$args{'parameterlist'}}) { 10811da177e4SLinus Torvalds if ($count == $#{$args{'parameterlist'}}) { 10821da177e4SLinus Torvalds $post = ");"; 10831da177e4SLinus Torvalds } 10841da177e4SLinus Torvalds $type = $args{'parametertypes'}{$parameter}; 10851da177e4SLinus Torvalds if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 10861da177e4SLinus Torvalds # pointer-to-function 10871da177e4SLinus Torvalds print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n"; 10881da177e4SLinus Torvalds } else { 10891da177e4SLinus Torvalds $type =~ s/([^\*])$/$1 /; 10901da177e4SLinus Torvalds print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n"; 10911da177e4SLinus Torvalds } 10921da177e4SLinus Torvalds $count++; 10931da177e4SLinus Torvalds $parenth = ""; 10941da177e4SLinus Torvalds } 10951da177e4SLinus Torvalds 10961da177e4SLinus Torvalds print ".SH ARGUMENTS\n"; 10971da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 10981da177e4SLinus Torvalds my $parameter_name = $parameter; 10991da177e4SLinus Torvalds $parameter_name =~ s/\[.*//; 11001da177e4SLinus Torvalds 11011da177e4SLinus Torvalds print ".IP \"" . $parameter . "\" 12\n"; 11021da177e4SLinus Torvalds output_highlight($args{'parameterdescs'}{$parameter_name}); 11031da177e4SLinus Torvalds } 11041da177e4SLinus Torvalds foreach $section (@{$args{'sectionlist'}}) { 11051da177e4SLinus Torvalds print ".SH \"", uc $section, "\"\n"; 11061da177e4SLinus Torvalds output_highlight($args{'sections'}{$section}); 11071da177e4SLinus Torvalds } 11081da177e4SLinus Torvalds} 11091da177e4SLinus Torvalds 11101da177e4SLinus Torvalds## 11111da177e4SLinus Torvalds# output enum in man 11121da177e4SLinus Torvaldssub output_enum_man(%) { 11131da177e4SLinus Torvalds my %args = %{$_[0]}; 11141da177e4SLinus Torvalds my ($parameter, $section); 11151da177e4SLinus Torvalds my $count; 11161da177e4SLinus Torvalds 11171da177e4SLinus Torvalds print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n"; 11181da177e4SLinus Torvalds 11191da177e4SLinus Torvalds print ".SH NAME\n"; 11201da177e4SLinus Torvalds print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n"; 11211da177e4SLinus Torvalds 11221da177e4SLinus Torvalds print ".SH SYNOPSIS\n"; 11231da177e4SLinus Torvalds print "enum " . $args{'enum'} . " {\n"; 11241da177e4SLinus Torvalds $count = 0; 11251da177e4SLinus Torvalds foreach my $parameter (@{$args{'parameterlist'}}) { 11261da177e4SLinus Torvalds print ".br\n.BI \" $parameter\"\n"; 11271da177e4SLinus Torvalds if ($count == $#{$args{'parameterlist'}}) { 11281da177e4SLinus Torvalds print "\n};\n"; 11291da177e4SLinus Torvalds last; 11301da177e4SLinus Torvalds } 11311da177e4SLinus Torvalds else { 11321da177e4SLinus Torvalds print ", \n.br\n"; 11331da177e4SLinus Torvalds } 11341da177e4SLinus Torvalds $count++; 11351da177e4SLinus Torvalds } 11361da177e4SLinus Torvalds 11371da177e4SLinus Torvalds print ".SH Constants\n"; 11381da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 11391da177e4SLinus Torvalds my $parameter_name = $parameter; 11401da177e4SLinus Torvalds $parameter_name =~ s/\[.*//; 11411da177e4SLinus Torvalds 11421da177e4SLinus Torvalds print ".IP \"" . $parameter . "\" 12\n"; 11431da177e4SLinus Torvalds output_highlight($args{'parameterdescs'}{$parameter_name}); 11441da177e4SLinus Torvalds } 11451da177e4SLinus Torvalds foreach $section (@{$args{'sectionlist'}}) { 11461da177e4SLinus Torvalds print ".SH \"$section\"\n"; 11471da177e4SLinus Torvalds output_highlight($args{'sections'}{$section}); 11481da177e4SLinus Torvalds } 11491da177e4SLinus Torvalds} 11501da177e4SLinus Torvalds 11511da177e4SLinus Torvalds## 11521da177e4SLinus Torvalds# output struct in man 11531da177e4SLinus Torvaldssub output_struct_man(%) { 11541da177e4SLinus Torvalds my %args = %{$_[0]}; 11551da177e4SLinus Torvalds my ($parameter, $section); 11561da177e4SLinus Torvalds 11571da177e4SLinus Torvalds print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n"; 11581da177e4SLinus Torvalds 11591da177e4SLinus Torvalds print ".SH NAME\n"; 11601da177e4SLinus Torvalds print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n"; 11611da177e4SLinus Torvalds 11621da177e4SLinus Torvalds print ".SH SYNOPSIS\n"; 11631da177e4SLinus Torvalds print $args{'type'} . " " . $args{'struct'} . " {\n.br\n"; 11641da177e4SLinus Torvalds 11651da177e4SLinus Torvalds foreach my $parameter (@{$args{'parameterlist'}}) { 11661da177e4SLinus Torvalds if ($parameter =~ /^#/) { 11671da177e4SLinus Torvalds print ".BI \"$parameter\"\n.br\n"; 11681da177e4SLinus Torvalds next; 11691da177e4SLinus Torvalds } 11701da177e4SLinus Torvalds my $parameter_name = $parameter; 11711da177e4SLinus Torvalds $parameter_name =~ s/\[.*//; 11721da177e4SLinus Torvalds 11731da177e4SLinus Torvalds ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 11741da177e4SLinus Torvalds $type = $args{'parametertypes'}{$parameter}; 11751da177e4SLinus Torvalds if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 11761da177e4SLinus Torvalds # pointer-to-function 11771da177e4SLinus Torvalds print ".BI \" " . $1 . "\" " . $parameter . " \") (" . $2 . ")" . "\"\n;\n"; 11781da177e4SLinus Torvalds } elsif ($type =~ m/^(.*?)\s*(:.*)/) { 11791d7e1d45SRandy.Dunlap # bitfield 11801d7e1d45SRandy.Dunlap print ".BI \" " . $1 . "\ \" " . $parameter . $2 . " \"" . "\"\n;\n"; 11811da177e4SLinus Torvalds } else { 11821da177e4SLinus Torvalds $type =~ s/([^\*])$/$1 /; 11831da177e4SLinus Torvalds print ".BI \" " . $type . "\" " . $parameter . " \"" . "\"\n;\n"; 11841da177e4SLinus Torvalds } 11851da177e4SLinus Torvalds print "\n.br\n"; 11861da177e4SLinus Torvalds } 11871da177e4SLinus Torvalds print "};\n.br\n"; 11881da177e4SLinus Torvalds 1189c51d3dacSRandy Dunlap print ".SH Members\n"; 11901da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 11911da177e4SLinus Torvalds ($parameter =~ /^#/) && next; 11921da177e4SLinus Torvalds 11931da177e4SLinus Torvalds my $parameter_name = $parameter; 11941da177e4SLinus Torvalds $parameter_name =~ s/\[.*//; 11951da177e4SLinus Torvalds 11961da177e4SLinus Torvalds ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 11971da177e4SLinus Torvalds print ".IP \"" . $parameter . "\" 12\n"; 11981da177e4SLinus Torvalds output_highlight($args{'parameterdescs'}{$parameter_name}); 11991da177e4SLinus Torvalds } 12001da177e4SLinus Torvalds foreach $section (@{$args{'sectionlist'}}) { 12011da177e4SLinus Torvalds print ".SH \"$section\"\n"; 12021da177e4SLinus Torvalds output_highlight($args{'sections'}{$section}); 12031da177e4SLinus Torvalds } 12041da177e4SLinus Torvalds} 12051da177e4SLinus Torvalds 12061da177e4SLinus Torvalds## 12071da177e4SLinus Torvalds# output typedef in man 12081da177e4SLinus Torvaldssub output_typedef_man(%) { 12091da177e4SLinus Torvalds my %args = %{$_[0]}; 12101da177e4SLinus Torvalds my ($parameter, $section); 12111da177e4SLinus Torvalds 12121da177e4SLinus Torvalds print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n"; 12131da177e4SLinus Torvalds 12141da177e4SLinus Torvalds print ".SH NAME\n"; 12151da177e4SLinus Torvalds print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n"; 12161da177e4SLinus Torvalds 12171da177e4SLinus Torvalds foreach $section (@{$args{'sectionlist'}}) { 12181da177e4SLinus Torvalds print ".SH \"$section\"\n"; 12191da177e4SLinus Torvalds output_highlight($args{'sections'}{$section}); 12201da177e4SLinus Torvalds } 12211da177e4SLinus Torvalds} 12221da177e4SLinus Torvalds 1223b112e0f7SJohannes Bergsub output_blockhead_man(%) { 12241da177e4SLinus Torvalds my %args = %{$_[0]}; 12251da177e4SLinus Torvalds my ($parameter, $section); 12261da177e4SLinus Torvalds my $count; 12271da177e4SLinus Torvalds 12281da177e4SLinus Torvalds print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n"; 12291da177e4SLinus Torvalds 12301da177e4SLinus Torvalds foreach $section (@{$args{'sectionlist'}}) { 12311da177e4SLinus Torvalds print ".SH \"$section\"\n"; 12321da177e4SLinus Torvalds output_highlight($args{'sections'}{$section}); 12331da177e4SLinus Torvalds } 12341da177e4SLinus Torvalds} 12351da177e4SLinus Torvalds 12361da177e4SLinus Torvalds## 12371da177e4SLinus Torvalds# output in text 12381da177e4SLinus Torvaldssub output_function_text(%) { 12391da177e4SLinus Torvalds my %args = %{$_[0]}; 12401da177e4SLinus Torvalds my ($parameter, $section); 1241a21217daSRandy Dunlap my $start; 12421da177e4SLinus Torvalds 1243f47634b2SRandy Dunlap print "Name:\n\n"; 1244f47634b2SRandy Dunlap print $args{'function'} . " - " . $args{'purpose'} . "\n"; 1245f47634b2SRandy Dunlap 1246f47634b2SRandy Dunlap print "\nSynopsis:\n\n"; 1247a21217daSRandy Dunlap if ($args{'functiontype'} ne "") { 1248a21217daSRandy Dunlap $start = $args{'functiontype'} . " " . $args{'function'} . " ("; 1249a21217daSRandy Dunlap } else { 1250a21217daSRandy Dunlap $start = $args{'function'} . " ("; 1251a21217daSRandy Dunlap } 12521da177e4SLinus Torvalds print $start; 1253a21217daSRandy Dunlap 12541da177e4SLinus Torvalds my $count = 0; 12551da177e4SLinus Torvalds foreach my $parameter (@{$args{'parameterlist'}}) { 12561da177e4SLinus Torvalds $type = $args{'parametertypes'}{$parameter}; 12571da177e4SLinus Torvalds if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 12581da177e4SLinus Torvalds # pointer-to-function 12591da177e4SLinus Torvalds print $1 . $parameter . ") (" . $2; 12601da177e4SLinus Torvalds } else { 12611da177e4SLinus Torvalds print $type . " " . $parameter; 12621da177e4SLinus Torvalds } 12631da177e4SLinus Torvalds if ($count != $#{$args{'parameterlist'}}) { 12641da177e4SLinus Torvalds $count++; 12651da177e4SLinus Torvalds print ",\n"; 12661da177e4SLinus Torvalds print " " x length($start); 12671da177e4SLinus Torvalds } else { 12681da177e4SLinus Torvalds print ");\n\n"; 12691da177e4SLinus Torvalds } 12701da177e4SLinus Torvalds } 12711da177e4SLinus Torvalds 12721da177e4SLinus Torvalds print "Arguments:\n\n"; 12731da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 12741da177e4SLinus Torvalds my $parameter_name = $parameter; 12751da177e4SLinus Torvalds $parameter_name =~ s/\[.*//; 12761da177e4SLinus Torvalds 12771da177e4SLinus Torvalds print $parameter . "\n\t" . $args{'parameterdescs'}{$parameter_name} . "\n"; 12781da177e4SLinus Torvalds } 12791da177e4SLinus Torvalds output_section_text(@_); 12801da177e4SLinus Torvalds} 12811da177e4SLinus Torvalds 12821da177e4SLinus Torvalds#output sections in text 12831da177e4SLinus Torvaldssub output_section_text(%) { 12841da177e4SLinus Torvalds my %args = %{$_[0]}; 12851da177e4SLinus Torvalds my $section; 12861da177e4SLinus Torvalds 12871da177e4SLinus Torvalds print "\n"; 12881da177e4SLinus Torvalds foreach $section (@{$args{'sectionlist'}}) { 12891da177e4SLinus Torvalds print "$section:\n\n"; 12901da177e4SLinus Torvalds output_highlight($args{'sections'}{$section}); 12911da177e4SLinus Torvalds } 12921da177e4SLinus Torvalds print "\n\n"; 12931da177e4SLinus Torvalds} 12941da177e4SLinus Torvalds 12951da177e4SLinus Torvalds# output enum in text 12961da177e4SLinus Torvaldssub output_enum_text(%) { 12971da177e4SLinus Torvalds my %args = %{$_[0]}; 12981da177e4SLinus Torvalds my ($parameter); 12991da177e4SLinus Torvalds my $count; 13001da177e4SLinus Torvalds print "Enum:\n\n"; 13011da177e4SLinus Torvalds 13021d7e1d45SRandy.Dunlap print "enum " . $args{'enum'} . " - " . $args{'purpose'} . "\n\n"; 13031da177e4SLinus Torvalds print "enum " . $args{'enum'} . " {\n"; 13041da177e4SLinus Torvalds $count = 0; 13051da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 13061da177e4SLinus Torvalds print "\t$parameter"; 13071da177e4SLinus Torvalds if ($count != $#{$args{'parameterlist'}}) { 13081da177e4SLinus Torvalds $count++; 13091da177e4SLinus Torvalds print ","; 13101da177e4SLinus Torvalds } 13111da177e4SLinus Torvalds print "\n"; 13121da177e4SLinus Torvalds } 13131da177e4SLinus Torvalds print "};\n\n"; 13141da177e4SLinus Torvalds 13151da177e4SLinus Torvalds print "Constants:\n\n"; 13161da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 13171da177e4SLinus Torvalds print "$parameter\n\t"; 13181da177e4SLinus Torvalds print $args{'parameterdescs'}{$parameter} . "\n"; 13191da177e4SLinus Torvalds } 13201da177e4SLinus Torvalds 13211da177e4SLinus Torvalds output_section_text(@_); 13221da177e4SLinus Torvalds} 13231da177e4SLinus Torvalds 13241da177e4SLinus Torvalds# output typedef in text 13251da177e4SLinus Torvaldssub output_typedef_text(%) { 13261da177e4SLinus Torvalds my %args = %{$_[0]}; 13271da177e4SLinus Torvalds my ($parameter); 13281da177e4SLinus Torvalds my $count; 13291da177e4SLinus Torvalds print "Typedef:\n\n"; 13301da177e4SLinus Torvalds 13311d7e1d45SRandy.Dunlap print "typedef " . $args{'typedef'} . " - " . $args{'purpose'} . "\n"; 13321da177e4SLinus Torvalds output_section_text(@_); 13331da177e4SLinus Torvalds} 13341da177e4SLinus Torvalds 13351da177e4SLinus Torvalds# output struct as text 13361da177e4SLinus Torvaldssub output_struct_text(%) { 13371da177e4SLinus Torvalds my %args = %{$_[0]}; 13381da177e4SLinus Torvalds my ($parameter); 13391da177e4SLinus Torvalds 13401d7e1d45SRandy.Dunlap print $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "\n\n"; 13411da177e4SLinus Torvalds print $args{'type'} . " " . $args{'struct'} . " {\n"; 13421da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 13431da177e4SLinus Torvalds if ($parameter =~ /^#/) { 13441da177e4SLinus Torvalds print "$parameter\n"; 13451da177e4SLinus Torvalds next; 13461da177e4SLinus Torvalds } 13471da177e4SLinus Torvalds 13481da177e4SLinus Torvalds my $parameter_name = $parameter; 13491da177e4SLinus Torvalds $parameter_name =~ s/\[.*//; 13501da177e4SLinus Torvalds 13511da177e4SLinus Torvalds ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 13521da177e4SLinus Torvalds $type = $args{'parametertypes'}{$parameter}; 13531da177e4SLinus Torvalds if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 13541da177e4SLinus Torvalds # pointer-to-function 13551da177e4SLinus Torvalds print "\t$1 $parameter) ($2);\n"; 13561da177e4SLinus Torvalds } elsif ($type =~ m/^(.*?)\s*(:.*)/) { 135751f5a0c8SRandy Dunlap # bitfield 13581da177e4SLinus Torvalds print "\t$1 $parameter$2;\n"; 13591da177e4SLinus Torvalds } else { 13601da177e4SLinus Torvalds print "\t" . $type . " " . $parameter . ";\n"; 13611da177e4SLinus Torvalds } 13621da177e4SLinus Torvalds } 13631da177e4SLinus Torvalds print "};\n\n"; 13641da177e4SLinus Torvalds 13651da177e4SLinus Torvalds print "Members:\n\n"; 13661da177e4SLinus Torvalds foreach $parameter (@{$args{'parameterlist'}}) { 13671da177e4SLinus Torvalds ($parameter =~ /^#/) && next; 13681da177e4SLinus Torvalds 13691da177e4SLinus Torvalds my $parameter_name = $parameter; 13701da177e4SLinus Torvalds $parameter_name =~ s/\[.*//; 13711da177e4SLinus Torvalds 13721da177e4SLinus Torvalds ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 13731da177e4SLinus Torvalds print "$parameter\n\t"; 13741da177e4SLinus Torvalds print $args{'parameterdescs'}{$parameter_name} . "\n"; 13751da177e4SLinus Torvalds } 13761da177e4SLinus Torvalds print "\n"; 13771da177e4SLinus Torvalds output_section_text(@_); 13781da177e4SLinus Torvalds} 13791da177e4SLinus Torvalds 1380b112e0f7SJohannes Bergsub output_blockhead_text(%) { 13811da177e4SLinus Torvalds my %args = %{$_[0]}; 13821da177e4SLinus Torvalds my ($parameter, $section); 13831da177e4SLinus Torvalds 13841da177e4SLinus Torvalds foreach $section (@{$args{'sectionlist'}}) { 13851da177e4SLinus Torvalds print " $section:\n"; 13861da177e4SLinus Torvalds print " -> "; 13871da177e4SLinus Torvalds output_highlight($args{'sections'}{$section}); 13881da177e4SLinus Torvalds } 13891da177e4SLinus Torvalds} 13901da177e4SLinus Torvalds 1391eda603f6SJohannes Berg## list mode output functions 1392eda603f6SJohannes Berg 1393eda603f6SJohannes Bergsub output_function_list(%) { 1394eda603f6SJohannes Berg my %args = %{$_[0]}; 1395eda603f6SJohannes Berg 1396eda603f6SJohannes Berg print $args{'function'} . "\n"; 1397eda603f6SJohannes Berg} 1398eda603f6SJohannes Berg 1399eda603f6SJohannes Berg# output enum in list 1400eda603f6SJohannes Bergsub output_enum_list(%) { 1401eda603f6SJohannes Berg my %args = %{$_[0]}; 1402eda603f6SJohannes Berg print $args{'enum'} . "\n"; 1403eda603f6SJohannes Berg} 1404eda603f6SJohannes Berg 1405eda603f6SJohannes Berg# output typedef in list 1406eda603f6SJohannes Bergsub output_typedef_list(%) { 1407eda603f6SJohannes Berg my %args = %{$_[0]}; 1408eda603f6SJohannes Berg print $args{'typedef'} . "\n"; 1409eda603f6SJohannes Berg} 1410eda603f6SJohannes Berg 1411eda603f6SJohannes Berg# output struct as list 1412eda603f6SJohannes Bergsub output_struct_list(%) { 1413eda603f6SJohannes Berg my %args = %{$_[0]}; 1414eda603f6SJohannes Berg 1415eda603f6SJohannes Berg print $args{'struct'} . "\n"; 1416eda603f6SJohannes Berg} 1417eda603f6SJohannes Berg 1418eda603f6SJohannes Bergsub output_blockhead_list(%) { 1419eda603f6SJohannes Berg my %args = %{$_[0]}; 1420eda603f6SJohannes Berg my ($parameter, $section); 1421eda603f6SJohannes Berg 1422eda603f6SJohannes Berg foreach $section (@{$args{'sectionlist'}}) { 1423eda603f6SJohannes Berg print "DOC: $section\n"; 1424eda603f6SJohannes Berg } 1425eda603f6SJohannes Berg} 1426eda603f6SJohannes Berg 14271da177e4SLinus Torvalds## 142827205744SRandy Dunlap# generic output function for all types (function, struct/union, typedef, enum); 142927205744SRandy Dunlap# calls the generated, variable output_ function name based on 143027205744SRandy Dunlap# functype and output_mode 14311da177e4SLinus Torvaldssub output_declaration { 14321da177e4SLinus Torvalds no strict 'refs'; 14331da177e4SLinus Torvalds my $name = shift; 14341da177e4SLinus Torvalds my $functype = shift; 14351da177e4SLinus Torvalds my $func = "output_${functype}_$output_mode"; 14361da177e4SLinus Torvalds if (($function_only==0) || 14371da177e4SLinus Torvalds ( $function_only == 1 && defined($function_table{$name})) || 14381da177e4SLinus Torvalds ( $function_only == 2 && !defined($function_table{$name}))) 14391da177e4SLinus Torvalds { 14401da177e4SLinus Torvalds &$func(@_); 14411da177e4SLinus Torvalds $section_counter++; 14421da177e4SLinus Torvalds } 14431da177e4SLinus Torvalds} 14441da177e4SLinus Torvalds 14451da177e4SLinus Torvalds## 144627205744SRandy Dunlap# generic output function - calls the right one based on current output mode. 1447b112e0f7SJohannes Bergsub output_blockhead { 14481da177e4SLinus Torvalds no strict 'refs'; 1449b112e0f7SJohannes Berg my $func = "output_blockhead_" . $output_mode; 14501da177e4SLinus Torvalds &$func(@_); 14511da177e4SLinus Torvalds $section_counter++; 14521da177e4SLinus Torvalds} 14531da177e4SLinus Torvalds 14541da177e4SLinus Torvalds## 14551da177e4SLinus Torvalds# takes a declaration (struct, union, enum, typedef) and 14561da177e4SLinus Torvalds# invokes the right handler. NOT called for functions. 14571da177e4SLinus Torvaldssub dump_declaration($$) { 14581da177e4SLinus Torvalds no strict 'refs'; 14591da177e4SLinus Torvalds my ($prototype, $file) = @_; 14601da177e4SLinus Torvalds my $func = "dump_" . $decl_type; 14611da177e4SLinus Torvalds &$func(@_); 14621da177e4SLinus Torvalds} 14631da177e4SLinus Torvalds 14641da177e4SLinus Torvaldssub dump_union($$) { 14651da177e4SLinus Torvalds dump_struct(@_); 14661da177e4SLinus Torvalds} 14671da177e4SLinus Torvalds 14681da177e4SLinus Torvaldssub dump_struct($$) { 14691da177e4SLinus Torvalds my $x = shift; 14701da177e4SLinus Torvalds my $file = shift; 1471a1d94aa5SRandy Dunlap my $nested; 14721da177e4SLinus Torvalds 14731da177e4SLinus Torvalds if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) { 147452dc5aecSRandy Dunlap #my $decl_type = $1; 14751da177e4SLinus Torvalds $declaration_name = $2; 14761da177e4SLinus Torvalds my $members = $3; 14771da177e4SLinus Torvalds 14781da177e4SLinus Torvalds # ignore embedded structs or unions 1479a1d94aa5SRandy Dunlap $members =~ s/({.*})//g; 1480a1d94aa5SRandy Dunlap $nested = $1; 14811da177e4SLinus Torvalds 1482aeec46b9SMartin Waitz # ignore members marked private: 148352dc5aecSRandy Dunlap $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gos; 148452dc5aecSRandy Dunlap $members =~ s/\/\*\s*private:.*//gos; 1485aeec46b9SMartin Waitz # strip comments: 1486aeec46b9SMartin Waitz $members =~ s/\/\*.*?\*\///gos; 1487a1d94aa5SRandy Dunlap $nested =~ s/\/\*.*?\*\///gos; 1488d960eea9SRandy Dunlap # strip kmemcheck_bitfield_{begin,end}.*; 1489d960eea9SRandy Dunlap $members =~ s/kmemcheck_bitfield_.*?;//gos; 1490ef5da59fSRandy Dunlap # strip attributes 1491ef5da59fSRandy Dunlap $members =~ s/__aligned\s*\(\d+\)//gos; 1492aeec46b9SMartin Waitz 14931da177e4SLinus Torvalds create_parameterlist($members, ';', $file); 1494a1d94aa5SRandy Dunlap check_sections($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested); 14951da177e4SLinus Torvalds 14961da177e4SLinus Torvalds output_declaration($declaration_name, 14971da177e4SLinus Torvalds 'struct', 14981da177e4SLinus Torvalds {'struct' => $declaration_name, 14991da177e4SLinus Torvalds 'module' => $modulename, 15001da177e4SLinus Torvalds 'parameterlist' => \@parameterlist, 15011da177e4SLinus Torvalds 'parameterdescs' => \%parameterdescs, 15021da177e4SLinus Torvalds 'parametertypes' => \%parametertypes, 15031da177e4SLinus Torvalds 'sectionlist' => \@sectionlist, 15041da177e4SLinus Torvalds 'sections' => \%sections, 15051da177e4SLinus Torvalds 'purpose' => $declaration_purpose, 15061da177e4SLinus Torvalds 'type' => $decl_type 15071da177e4SLinus Torvalds }); 15081da177e4SLinus Torvalds } 15091da177e4SLinus Torvalds else { 15101da177e4SLinus Torvalds print STDERR "Error(${file}:$.): Cannot parse struct or union!\n"; 15111da177e4SLinus Torvalds ++$errors; 15121da177e4SLinus Torvalds } 15131da177e4SLinus Torvalds} 15141da177e4SLinus Torvalds 15151da177e4SLinus Torvaldssub dump_enum($$) { 15161da177e4SLinus Torvalds my $x = shift; 15171da177e4SLinus Torvalds my $file = shift; 15181da177e4SLinus Torvalds 1519aeec46b9SMartin Waitz $x =~ s@/\*.*?\*/@@gos; # strip comments. 1520b6d676dbSRandy Dunlap $x =~ s/^#\s*define\s+.*$//; # strip #define macros inside enums 1521b6d676dbSRandy Dunlap 15221da177e4SLinus Torvalds if ($x =~ /enum\s+(\w+)\s*{(.*)}/) { 15231da177e4SLinus Torvalds $declaration_name = $1; 15241da177e4SLinus Torvalds my $members = $2; 15251da177e4SLinus Torvalds 15261da177e4SLinus Torvalds foreach my $arg (split ',', $members) { 15271da177e4SLinus Torvalds $arg =~ s/^\s*(\w+).*/$1/; 15281da177e4SLinus Torvalds push @parameterlist, $arg; 15291da177e4SLinus Torvalds if (!$parameterdescs{$arg}) { 15301da177e4SLinus Torvalds $parameterdescs{$arg} = $undescribed; 15311da177e4SLinus Torvalds print STDERR "Warning(${file}:$.): Enum value '$arg' ". 15321da177e4SLinus Torvalds "not described in enum '$declaration_name'\n"; 15331da177e4SLinus Torvalds } 15341da177e4SLinus Torvalds 15351da177e4SLinus Torvalds } 15361da177e4SLinus Torvalds 15371da177e4SLinus Torvalds output_declaration($declaration_name, 15381da177e4SLinus Torvalds 'enum', 15391da177e4SLinus Torvalds {'enum' => $declaration_name, 15401da177e4SLinus Torvalds 'module' => $modulename, 15411da177e4SLinus Torvalds 'parameterlist' => \@parameterlist, 15421da177e4SLinus Torvalds 'parameterdescs' => \%parameterdescs, 15431da177e4SLinus Torvalds 'sectionlist' => \@sectionlist, 15441da177e4SLinus Torvalds 'sections' => \%sections, 15451da177e4SLinus Torvalds 'purpose' => $declaration_purpose 15461da177e4SLinus Torvalds }); 15471da177e4SLinus Torvalds } 15481da177e4SLinus Torvalds else { 15491da177e4SLinus Torvalds print STDERR "Error(${file}:$.): Cannot parse enum!\n"; 15501da177e4SLinus Torvalds ++$errors; 15511da177e4SLinus Torvalds } 15521da177e4SLinus Torvalds} 15531da177e4SLinus Torvalds 15541da177e4SLinus Torvaldssub dump_typedef($$) { 15551da177e4SLinus Torvalds my $x = shift; 15561da177e4SLinus Torvalds my $file = shift; 15571da177e4SLinus Torvalds 1558aeec46b9SMartin Waitz $x =~ s@/\*.*?\*/@@gos; # strip comments. 15591da177e4SLinus Torvalds while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) { 15601da177e4SLinus Torvalds $x =~ s/\(*.\)\s*;$/;/; 15611da177e4SLinus Torvalds $x =~ s/\[*.\]\s*;$/;/; 15621da177e4SLinus Torvalds } 15631da177e4SLinus Torvalds 15641da177e4SLinus Torvalds if ($x =~ /typedef.*\s+(\w+)\s*;/) { 15651da177e4SLinus Torvalds $declaration_name = $1; 15661da177e4SLinus Torvalds 15671da177e4SLinus Torvalds output_declaration($declaration_name, 15681da177e4SLinus Torvalds 'typedef', 15691da177e4SLinus Torvalds {'typedef' => $declaration_name, 15701da177e4SLinus Torvalds 'module' => $modulename, 15711da177e4SLinus Torvalds 'sectionlist' => \@sectionlist, 15721da177e4SLinus Torvalds 'sections' => \%sections, 15731da177e4SLinus Torvalds 'purpose' => $declaration_purpose 15741da177e4SLinus Torvalds }); 15751da177e4SLinus Torvalds } 15761da177e4SLinus Torvalds else { 15771da177e4SLinus Torvalds print STDERR "Error(${file}:$.): Cannot parse typedef!\n"; 15781da177e4SLinus Torvalds ++$errors; 15791da177e4SLinus Torvalds } 15801da177e4SLinus Torvalds} 15811da177e4SLinus Torvalds 1582a1d94aa5SRandy Dunlapsub save_struct_actual($) { 1583a1d94aa5SRandy Dunlap my $actual = shift; 1584a1d94aa5SRandy Dunlap 1585a1d94aa5SRandy Dunlap # strip all spaces from the actual param so that it looks like one string item 1586a1d94aa5SRandy Dunlap $actual =~ s/\s*//g; 1587a1d94aa5SRandy Dunlap $struct_actual = $struct_actual . $actual . " "; 1588a1d94aa5SRandy Dunlap} 1589a1d94aa5SRandy Dunlap 15901da177e4SLinus Torvaldssub create_parameterlist($$$) { 15911da177e4SLinus Torvalds my $args = shift; 15921da177e4SLinus Torvalds my $splitter = shift; 15931da177e4SLinus Torvalds my $file = shift; 15941da177e4SLinus Torvalds my $type; 15951da177e4SLinus Torvalds my $param; 15961da177e4SLinus Torvalds 1597a6d3fe77SMartin Waitz # temporarily replace commas inside function pointer definition 15981da177e4SLinus Torvalds while ($args =~ /(\([^\),]+),/) { 15991da177e4SLinus Torvalds $args =~ s/(\([^\),]+),/$1#/g; 16001da177e4SLinus Torvalds } 16011da177e4SLinus Torvalds 16021da177e4SLinus Torvalds foreach my $arg (split($splitter, $args)) { 16031da177e4SLinus Torvalds # strip comments 16041da177e4SLinus Torvalds $arg =~ s/\/\*.*\*\///; 16051da177e4SLinus Torvalds # strip leading/trailing spaces 16061da177e4SLinus Torvalds $arg =~ s/^\s*//; 16071da177e4SLinus Torvalds $arg =~ s/\s*$//; 16081da177e4SLinus Torvalds $arg =~ s/\s+/ /; 16091da177e4SLinus Torvalds 16101da177e4SLinus Torvalds if ($arg =~ /^#/) { 16111da177e4SLinus Torvalds # Treat preprocessor directive as a typeless variable just to fill 16121da177e4SLinus Torvalds # corresponding data structures "correctly". Catch it later in 16131da177e4SLinus Torvalds # output_* subs. 16141da177e4SLinus Torvalds push_parameter($arg, "", $file); 161500d62961SRichard Kennedy } elsif ($arg =~ m/\(.+\)\s*\(/) { 16161da177e4SLinus Torvalds # pointer-to-function 16171da177e4SLinus Torvalds $arg =~ tr/#/,/; 161800d62961SRichard Kennedy $arg =~ m/[^\(]+\(\*?\s*(\w*)\s*\)/; 16191da177e4SLinus Torvalds $param = $1; 16201da177e4SLinus Torvalds $type = $arg; 162100d62961SRichard Kennedy $type =~ s/([^\(]+\(\*?)\s*$param/$1/; 1622a1d94aa5SRandy Dunlap save_struct_actual($param); 16231da177e4SLinus Torvalds push_parameter($param, $type, $file); 1624aeec46b9SMartin Waitz } elsif ($arg) { 16251da177e4SLinus Torvalds $arg =~ s/\s*:\s*/:/g; 16261da177e4SLinus Torvalds $arg =~ s/\s*\[/\[/g; 16271da177e4SLinus Torvalds 16281da177e4SLinus Torvalds my @args = split('\s*,\s*', $arg); 16291da177e4SLinus Torvalds if ($args[0] =~ m/\*/) { 16301da177e4SLinus Torvalds $args[0] =~ s/(\*+)\s*/ $1/; 16311da177e4SLinus Torvalds } 1632884f2810SBorislav Petkov 1633884f2810SBorislav Petkov my @first_arg; 1634884f2810SBorislav Petkov if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) { 1635884f2810SBorislav Petkov shift @args; 1636884f2810SBorislav Petkov push(@first_arg, split('\s+', $1)); 1637884f2810SBorislav Petkov push(@first_arg, $2); 1638884f2810SBorislav Petkov } else { 1639884f2810SBorislav Petkov @first_arg = split('\s+', shift @args); 1640884f2810SBorislav Petkov } 1641884f2810SBorislav Petkov 16421da177e4SLinus Torvalds unshift(@args, pop @first_arg); 16431da177e4SLinus Torvalds $type = join " ", @first_arg; 16441da177e4SLinus Torvalds 16451da177e4SLinus Torvalds foreach $param (@args) { 16461da177e4SLinus Torvalds if ($param =~ m/^(\*+)\s*(.*)/) { 1647a1d94aa5SRandy Dunlap save_struct_actual($2); 16481da177e4SLinus Torvalds push_parameter($2, "$type $1", $file); 16491da177e4SLinus Torvalds } 16501da177e4SLinus Torvalds elsif ($param =~ m/(.*?):(\d+)/) { 16517b97887eSRandy Dunlap if ($type ne "") { # skip unnamed bit-fields 1652a1d94aa5SRandy Dunlap save_struct_actual($1); 16531da177e4SLinus Torvalds push_parameter($1, "$type:$2", $file) 16541da177e4SLinus Torvalds } 16557b97887eSRandy Dunlap } 16561da177e4SLinus Torvalds else { 1657a1d94aa5SRandy Dunlap save_struct_actual($param); 16581da177e4SLinus Torvalds push_parameter($param, $type, $file); 16591da177e4SLinus Torvalds } 16601da177e4SLinus Torvalds } 16611da177e4SLinus Torvalds } 16621da177e4SLinus Torvalds } 16631da177e4SLinus Torvalds} 16641da177e4SLinus Torvalds 16651da177e4SLinus Torvaldssub push_parameter($$$) { 16661da177e4SLinus Torvalds my $param = shift; 16671da177e4SLinus Torvalds my $type = shift; 16681da177e4SLinus Torvalds my $file = shift; 16691da177e4SLinus Torvalds 16705f8c7c98SRandy Dunlap if (($anon_struct_union == 1) && ($type eq "") && 16715f8c7c98SRandy Dunlap ($param eq "}")) { 16725f8c7c98SRandy Dunlap return; # ignore the ending }; from anon. struct/union 16735f8c7c98SRandy Dunlap } 16745f8c7c98SRandy Dunlap 16755f8c7c98SRandy Dunlap $anon_struct_union = 0; 16761da177e4SLinus Torvalds my $param_name = $param; 16771da177e4SLinus Torvalds $param_name =~ s/\[.*//; 16781da177e4SLinus Torvalds 1679a6d3fe77SMartin Waitz if ($type eq "" && $param =~ /\.\.\.$/) 16801da177e4SLinus Torvalds { 1681ced69090SRandy Dunlap if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") { 1682a6d3fe77SMartin Waitz $parameterdescs{$param} = "variable arguments"; 16831da177e4SLinus Torvalds } 1684ced69090SRandy Dunlap } 16851da177e4SLinus Torvalds elsif ($type eq "" && ($param eq "" or $param eq "void")) 16861da177e4SLinus Torvalds { 16871da177e4SLinus Torvalds $param="void"; 16881da177e4SLinus Torvalds $parameterdescs{void} = "no arguments"; 16891da177e4SLinus Torvalds } 1690134fe01bSRandy Dunlap elsif ($type eq "" && ($param eq "struct" or $param eq "union")) 1691134fe01bSRandy Dunlap # handle unnamed (anonymous) union or struct: 1692134fe01bSRandy Dunlap { 1693134fe01bSRandy Dunlap $type = $param; 1694134fe01bSRandy Dunlap $param = "{unnamed_" . $param . "}"; 1695134fe01bSRandy Dunlap $parameterdescs{$param} = "anonymous\n"; 16965f8c7c98SRandy Dunlap $anon_struct_union = 1; 1697134fe01bSRandy Dunlap } 1698134fe01bSRandy Dunlap 1699a6d3fe77SMartin Waitz # warn if parameter has no description 1700134fe01bSRandy Dunlap # (but ignore ones starting with # as these are not parameters 1701134fe01bSRandy Dunlap # but inline preprocessor statements); 1702134fe01bSRandy Dunlap # also ignore unnamed structs/unions; 17035f8c7c98SRandy Dunlap if (!$anon_struct_union) { 1704a6d3fe77SMartin Waitz if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) { 1705a6d3fe77SMartin Waitz 17061da177e4SLinus Torvalds $parameterdescs{$param_name} = $undescribed; 17071da177e4SLinus Torvalds 17081da177e4SLinus Torvalds if (($type eq 'function') || ($type eq 'enum')) { 17091da177e4SLinus Torvalds print STDERR "Warning(${file}:$.): Function parameter ". 17101da177e4SLinus Torvalds "or member '$param' not " . 17111da177e4SLinus Torvalds "described in '$declaration_name'\n"; 17121da177e4SLinus Torvalds } 17131da177e4SLinus Torvalds print STDERR "Warning(${file}:$.):" . 17141da177e4SLinus Torvalds " No description found for parameter '$param'\n"; 17151da177e4SLinus Torvalds ++$warnings; 17161da177e4SLinus Torvalds } 1717134fe01bSRandy Dunlap } 17181da177e4SLinus Torvalds 17192b35f4d9SRandy Dunlap $param = xml_escape($param); 17202b35f4d9SRandy Dunlap 172125985edcSLucas De Marchi # strip spaces from $param so that it is one continuous string 1722e34e7dbbSRandy Dunlap # on @parameterlist; 1723e34e7dbbSRandy Dunlap # this fixes a problem where check_sections() cannot find 1724e34e7dbbSRandy Dunlap # a parameter like "addr[6 + 2]" because it actually appears 1725e34e7dbbSRandy Dunlap # as "addr[6", "+", "2]" on the parameter list; 1726e34e7dbbSRandy Dunlap # but it's better to maintain the param string unchanged for output, 1727e34e7dbbSRandy Dunlap # so just weaken the string compare in check_sections() to ignore 1728e34e7dbbSRandy Dunlap # "[blah" in a parameter string; 1729e34e7dbbSRandy Dunlap ###$param =~ s/\s*//g; 17301da177e4SLinus Torvalds push @parameterlist, $param; 17311da177e4SLinus Torvalds $parametertypes{$param} = $type; 17321da177e4SLinus Torvalds} 17331da177e4SLinus Torvalds 1734a1d94aa5SRandy Dunlapsub check_sections($$$$$$) { 1735a1d94aa5SRandy Dunlap my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck, $nested) = @_; 1736a1d94aa5SRandy Dunlap my @sects = split ' ', $sectcheck; 1737a1d94aa5SRandy Dunlap my @prms = split ' ', $prmscheck; 1738a1d94aa5SRandy Dunlap my $err; 1739a1d94aa5SRandy Dunlap my ($px, $sx); 1740a1d94aa5SRandy Dunlap my $prm_clean; # strip trailing "[array size]" and/or beginning "*" 1741a1d94aa5SRandy Dunlap 1742a1d94aa5SRandy Dunlap foreach $sx (0 .. $#sects) { 1743a1d94aa5SRandy Dunlap $err = 1; 1744a1d94aa5SRandy Dunlap foreach $px (0 .. $#prms) { 1745a1d94aa5SRandy Dunlap $prm_clean = $prms[$px]; 1746a1d94aa5SRandy Dunlap $prm_clean =~ s/\[.*\]//; 17471f3a6688SJohannes Berg $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i; 1748e34e7dbbSRandy Dunlap # ignore array size in a parameter string; 1749e34e7dbbSRandy Dunlap # however, the original param string may contain 1750e34e7dbbSRandy Dunlap # spaces, e.g.: addr[6 + 2] 1751e34e7dbbSRandy Dunlap # and this appears in @prms as "addr[6" since the 1752e34e7dbbSRandy Dunlap # parameter list is split at spaces; 1753e34e7dbbSRandy Dunlap # hence just ignore "[..." for the sections check; 1754e34e7dbbSRandy Dunlap $prm_clean =~ s/\[.*//; 1755e34e7dbbSRandy Dunlap 1756a1d94aa5SRandy Dunlap ##$prm_clean =~ s/^\**//; 1757a1d94aa5SRandy Dunlap if ($prm_clean eq $sects[$sx]) { 1758a1d94aa5SRandy Dunlap $err = 0; 1759a1d94aa5SRandy Dunlap last; 1760a1d94aa5SRandy Dunlap } 1761a1d94aa5SRandy Dunlap } 1762a1d94aa5SRandy Dunlap if ($err) { 1763a1d94aa5SRandy Dunlap if ($decl_type eq "function") { 1764a1d94aa5SRandy Dunlap print STDERR "Warning(${file}:$.): " . 1765a1d94aa5SRandy Dunlap "Excess function parameter " . 1766a1d94aa5SRandy Dunlap "'$sects[$sx]' " . 1767a1d94aa5SRandy Dunlap "description in '$decl_name'\n"; 1768a1d94aa5SRandy Dunlap ++$warnings; 1769a1d94aa5SRandy Dunlap } else { 1770a1d94aa5SRandy Dunlap if ($nested !~ m/\Q$sects[$sx]\E/) { 1771a1d94aa5SRandy Dunlap print STDERR "Warning(${file}:$.): " . 1772a1d94aa5SRandy Dunlap "Excess struct/union/enum/typedef member " . 1773a1d94aa5SRandy Dunlap "'$sects[$sx]' " . 1774a1d94aa5SRandy Dunlap "description in '$decl_name'\n"; 1775a1d94aa5SRandy Dunlap ++$warnings; 1776a1d94aa5SRandy Dunlap } 1777a1d94aa5SRandy Dunlap } 1778a1d94aa5SRandy Dunlap } 1779a1d94aa5SRandy Dunlap } 1780a1d94aa5SRandy Dunlap} 1781a1d94aa5SRandy Dunlap 17821da177e4SLinus Torvalds## 17831da177e4SLinus Torvalds# takes a function prototype and the name of the current file being 17841da177e4SLinus Torvalds# processed and spits out all the details stored in the global 17851da177e4SLinus Torvalds# arrays/hashes. 17861da177e4SLinus Torvaldssub dump_function($$) { 17871da177e4SLinus Torvalds my $prototype = shift; 17881da177e4SLinus Torvalds my $file = shift; 17891da177e4SLinus Torvalds 17901da177e4SLinus Torvalds $prototype =~ s/^static +//; 17911da177e4SLinus Torvalds $prototype =~ s/^extern +//; 17924dc3b16bSPavel Pisa $prototype =~ s/^asmlinkage +//; 17931da177e4SLinus Torvalds $prototype =~ s/^inline +//; 17941da177e4SLinus Torvalds $prototype =~ s/^__inline__ +//; 179532e79401SRandy Dunlap $prototype =~ s/^__inline +//; 179632e79401SRandy Dunlap $prototype =~ s/^__always_inline +//; 179732e79401SRandy Dunlap $prototype =~ s/^noinline +//; 17980129a057SRandy Dunlap $prototype =~ s/__devinit +//; 179974fc5c65SRandy Dunlap $prototype =~ s/__init +//; 180020072205SRandy Dunlap $prototype =~ s/__init_or_module +//; 180170c95b00SRandy Dunlap $prototype =~ s/__must_check +//; 18020df7c0e3SRandy Dunlap $prototype =~ s/__weak +//; 1803890c78c2SRandy Dunlap $prototype =~ s/^#\s*define\s+//; #ak added 1804328d2440SRandy Dunlap $prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//; 18051da177e4SLinus Torvalds 18061da177e4SLinus Torvalds # Yes, this truly is vile. We are looking for: 18071da177e4SLinus Torvalds # 1. Return type (may be nothing if we're looking at a macro) 18081da177e4SLinus Torvalds # 2. Function name 18091da177e4SLinus Torvalds # 3. Function parameters. 18101da177e4SLinus Torvalds # 18111da177e4SLinus Torvalds # All the while we have to watch out for function pointer parameters 18121da177e4SLinus Torvalds # (which IIRC is what the two sections are for), C types (these 18131da177e4SLinus Torvalds # regexps don't even start to express all the possibilities), and 18141da177e4SLinus Torvalds # so on. 18151da177e4SLinus Torvalds # 18161da177e4SLinus Torvalds # If you mess with these regexps, it's a good idea to check that 18171da177e4SLinus Torvalds # the following functions' documentation still comes out right: 18181da177e4SLinus Torvalds # - parport_register_device (function pointer parameters) 18191da177e4SLinus Torvalds # - atomic_set (macro) 18209598f91fSMartin Waitz # - pci_match_device, __copy_to_user (long return type) 18211da177e4SLinus Torvalds 18221da177e4SLinus Torvalds if ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 18231da177e4SLinus Torvalds $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 18241da177e4SLinus Torvalds $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 18251da177e4SLinus Torvalds $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 182694b3e03cSRandy Dunlap $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 18271da177e4SLinus Torvalds $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 18281da177e4SLinus Torvalds $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 18291da177e4SLinus Torvalds $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 18301da177e4SLinus Torvalds $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 18311da177e4SLinus Torvalds $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 18321da177e4SLinus Torvalds $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 18331da177e4SLinus Torvalds $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 18341da177e4SLinus Torvalds $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 18359598f91fSMartin Waitz $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 18369598f91fSMartin Waitz $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1837412ecd77SRandy Dunlap $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 1838412ecd77SRandy Dunlap $prototype =~ m/^(\w+\s+\w+\s*\*\s*\w+\s*\*\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) { 18391da177e4SLinus Torvalds $return_type = $1; 18401da177e4SLinus Torvalds $declaration_name = $2; 18411da177e4SLinus Torvalds my $args = $3; 18421da177e4SLinus Torvalds 18431da177e4SLinus Torvalds create_parameterlist($args, ',', $file); 18441da177e4SLinus Torvalds } else { 18451da177e4SLinus Torvalds print STDERR "Error(${file}:$.): cannot understand prototype: '$prototype'\n"; 18461da177e4SLinus Torvalds ++$errors; 18471da177e4SLinus Torvalds return; 18481da177e4SLinus Torvalds } 18491da177e4SLinus Torvalds 1850a1d94aa5SRandy Dunlap my $prms = join " ", @parameterlist; 1851a1d94aa5SRandy Dunlap check_sections($file, $declaration_name, "function", $sectcheck, $prms, ""); 1852a1d94aa5SRandy Dunlap 18531da177e4SLinus Torvalds output_declaration($declaration_name, 18541da177e4SLinus Torvalds 'function', 18551da177e4SLinus Torvalds {'function' => $declaration_name, 18561da177e4SLinus Torvalds 'module' => $modulename, 18571da177e4SLinus Torvalds 'functiontype' => $return_type, 18581da177e4SLinus Torvalds 'parameterlist' => \@parameterlist, 18591da177e4SLinus Torvalds 'parameterdescs' => \%parameterdescs, 18601da177e4SLinus Torvalds 'parametertypes' => \%parametertypes, 18611da177e4SLinus Torvalds 'sectionlist' => \@sectionlist, 18621da177e4SLinus Torvalds 'sections' => \%sections, 18631da177e4SLinus Torvalds 'purpose' => $declaration_purpose 18641da177e4SLinus Torvalds }); 18651da177e4SLinus Torvalds} 18661da177e4SLinus Torvalds 18671da177e4SLinus Torvaldssub reset_state { 18681da177e4SLinus Torvalds $function = ""; 18691da177e4SLinus Torvalds %constants = (); 18701da177e4SLinus Torvalds %parameterdescs = (); 18711da177e4SLinus Torvalds %parametertypes = (); 18721da177e4SLinus Torvalds @parameterlist = (); 18731da177e4SLinus Torvalds %sections = (); 18741da177e4SLinus Torvalds @sectionlist = (); 1875a1d94aa5SRandy Dunlap $sectcheck = ""; 1876a1d94aa5SRandy Dunlap $struct_actual = ""; 18771da177e4SLinus Torvalds $prototype = ""; 18781da177e4SLinus Torvalds 18791da177e4SLinus Torvalds $state = 0; 18801da177e4SLinus Torvalds} 18811da177e4SLinus Torvalds 188256afb0f8SJason Baronsub tracepoint_munge($) { 188356afb0f8SJason Baron my $file = shift; 188456afb0f8SJason Baron my $tracepointname = 0; 188556afb0f8SJason Baron my $tracepointargs = 0; 188656afb0f8SJason Baron 188756afb0f8SJason Baron if ($prototype =~ m/TRACE_EVENT\((.*?),/) { 188856afb0f8SJason Baron $tracepointname = $1; 188956afb0f8SJason Baron } 18903a9089fdSJason Baron if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) { 18913a9089fdSJason Baron $tracepointname = $1; 18923a9089fdSJason Baron } 18933a9089fdSJason Baron if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) { 18943a9089fdSJason Baron $tracepointname = $2; 18953a9089fdSJason Baron } 18963a9089fdSJason Baron $tracepointname =~ s/^\s+//; #strip leading whitespace 189756afb0f8SJason Baron if ($prototype =~ m/TP_PROTO\((.*?)\)/) { 189856afb0f8SJason Baron $tracepointargs = $1; 189956afb0f8SJason Baron } 190056afb0f8SJason Baron if (($tracepointname eq 0) || ($tracepointargs eq 0)) { 190156afb0f8SJason Baron print STDERR "Warning(${file}:$.): Unrecognized tracepoint format: \n". 190256afb0f8SJason Baron "$prototype\n"; 190356afb0f8SJason Baron } else { 190456afb0f8SJason Baron $prototype = "static inline void trace_$tracepointname($tracepointargs)"; 190556afb0f8SJason Baron } 190656afb0f8SJason Baron} 190756afb0f8SJason Baron 1908b4870bc5SRandy Dunlapsub syscall_munge() { 1909b4870bc5SRandy Dunlap my $void = 0; 1910b4870bc5SRandy Dunlap 1911b4870bc5SRandy Dunlap $prototype =~ s@[\r\n\t]+@ @gos; # strip newlines/CR's/tabs 1912b4870bc5SRandy Dunlap## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) { 1913b4870bc5SRandy Dunlap if ($prototype =~ m/SYSCALL_DEFINE0/) { 1914b4870bc5SRandy Dunlap $void = 1; 1915b4870bc5SRandy Dunlap## $prototype = "long sys_$1(void)"; 1916b4870bc5SRandy Dunlap } 1917b4870bc5SRandy Dunlap 1918b4870bc5SRandy Dunlap $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name 1919b4870bc5SRandy Dunlap if ($prototype =~ m/long (sys_.*?),/) { 1920b4870bc5SRandy Dunlap $prototype =~ s/,/\(/; 1921b4870bc5SRandy Dunlap } elsif ($void) { 1922b4870bc5SRandy Dunlap $prototype =~ s/\)/\(void\)/; 1923b4870bc5SRandy Dunlap } 1924b4870bc5SRandy Dunlap 1925b4870bc5SRandy Dunlap # now delete all of the odd-number commas in $prototype 1926b4870bc5SRandy Dunlap # so that arg types & arg names don't have a comma between them 1927b4870bc5SRandy Dunlap my $count = 0; 1928b4870bc5SRandy Dunlap my $len = length($prototype); 1929b4870bc5SRandy Dunlap if ($void) { 1930b4870bc5SRandy Dunlap $len = 0; # skip the for-loop 1931b4870bc5SRandy Dunlap } 1932b4870bc5SRandy Dunlap for (my $ix = 0; $ix < $len; $ix++) { 1933b4870bc5SRandy Dunlap if (substr($prototype, $ix, 1) eq ',') { 1934b4870bc5SRandy Dunlap $count++; 1935b4870bc5SRandy Dunlap if ($count % 2 == 1) { 1936b4870bc5SRandy Dunlap substr($prototype, $ix, 1) = ' '; 1937b4870bc5SRandy Dunlap } 1938b4870bc5SRandy Dunlap } 1939b4870bc5SRandy Dunlap } 1940b4870bc5SRandy Dunlap} 1941b4870bc5SRandy Dunlap 19421da177e4SLinus Torvaldssub process_state3_function($$) { 19431da177e4SLinus Torvalds my $x = shift; 19441da177e4SLinus Torvalds my $file = shift; 19451da177e4SLinus Torvalds 194651f5a0c8SRandy Dunlap $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line 194751f5a0c8SRandy Dunlap 1948890c78c2SRandy Dunlap if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) { 19491da177e4SLinus Torvalds # do nothing 19501da177e4SLinus Torvalds } 19511da177e4SLinus Torvalds elsif ($x =~ /([^\{]*)/) { 19521da177e4SLinus Torvalds $prototype .= $1; 19531da177e4SLinus Torvalds } 1954b4870bc5SRandy Dunlap 1955890c78c2SRandy Dunlap if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) { 19561da177e4SLinus Torvalds $prototype =~ s@/\*.*?\*/@@gos; # strip comments. 19571da177e4SLinus Torvalds $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's. 19581da177e4SLinus Torvalds $prototype =~ s@^\s+@@gos; # strip leading spaces 1959b4870bc5SRandy Dunlap if ($prototype =~ /SYSCALL_DEFINE/) { 1960b4870bc5SRandy Dunlap syscall_munge(); 1961b4870bc5SRandy Dunlap } 19623a9089fdSJason Baron if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ || 19633a9089fdSJason Baron $prototype =~ /DEFINE_SINGLE_EVENT/) 19643a9089fdSJason Baron { 196556afb0f8SJason Baron tracepoint_munge($file); 196656afb0f8SJason Baron } 19671da177e4SLinus Torvalds dump_function($prototype, $file); 19681da177e4SLinus Torvalds reset_state(); 19691da177e4SLinus Torvalds } 19701da177e4SLinus Torvalds} 19711da177e4SLinus Torvalds 19721da177e4SLinus Torvaldssub process_state3_type($$) { 19731da177e4SLinus Torvalds my $x = shift; 19741da177e4SLinus Torvalds my $file = shift; 19751da177e4SLinus Torvalds 19761da177e4SLinus Torvalds $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's. 19771da177e4SLinus Torvalds $x =~ s@^\s+@@gos; # strip leading spaces 19781da177e4SLinus Torvalds $x =~ s@\s+$@@gos; # strip trailing spaces 197951f5a0c8SRandy Dunlap $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line 198051f5a0c8SRandy Dunlap 19811da177e4SLinus Torvalds if ($x =~ /^#/) { 19821da177e4SLinus Torvalds # To distinguish preprocessor directive from regular declaration later. 19831da177e4SLinus Torvalds $x .= ";"; 19841da177e4SLinus Torvalds } 19851da177e4SLinus Torvalds 19861da177e4SLinus Torvalds while (1) { 19871da177e4SLinus Torvalds if ( $x =~ /([^{};]*)([{};])(.*)/ ) { 19881da177e4SLinus Torvalds $prototype .= $1 . $2; 19891da177e4SLinus Torvalds ($2 eq '{') && $brcount++; 19901da177e4SLinus Torvalds ($2 eq '}') && $brcount--; 19911da177e4SLinus Torvalds if (($2 eq ';') && ($brcount == 0)) { 19921da177e4SLinus Torvalds dump_declaration($prototype, $file); 19931da177e4SLinus Torvalds reset_state(); 19941da177e4SLinus Torvalds last; 19951da177e4SLinus Torvalds } 19961da177e4SLinus Torvalds $x = $3; 19971da177e4SLinus Torvalds } else { 19981da177e4SLinus Torvalds $prototype .= $x; 19991da177e4SLinus Torvalds last; 20001da177e4SLinus Torvalds } 20011da177e4SLinus Torvalds } 20021da177e4SLinus Torvalds} 20031da177e4SLinus Torvalds 20046b5b55f6SRandy Dunlap# xml_escape: replace <, >, and & in the text stream; 20056b5b55f6SRandy Dunlap# 20066b5b55f6SRandy Dunlap# however, formatting controls that are generated internally/locally in the 20076b5b55f6SRandy Dunlap# kernel-doc script are not escaped here; instead, they begin life like 20086b5b55f6SRandy Dunlap# $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings 20096b5b55f6SRandy Dunlap# are converted to their mnemonic-expected output, without the 4 * '\' & ':', 20106b5b55f6SRandy Dunlap# just before actual output; (this is done by local_unescape()) 20111da177e4SLinus Torvaldssub xml_escape($) { 20121da177e4SLinus Torvalds my $text = shift; 2013ecfb251aSRandy Dunlap if (($output_mode eq "text") || ($output_mode eq "man")) { 2014ecfb251aSRandy Dunlap return $text; 2015ecfb251aSRandy Dunlap } 20161da177e4SLinus Torvalds $text =~ s/\&/\\\\\\amp;/g; 20171da177e4SLinus Torvalds $text =~ s/\</\\\\\\lt;/g; 20181da177e4SLinus Torvalds $text =~ s/\>/\\\\\\gt;/g; 20191da177e4SLinus Torvalds return $text; 20201da177e4SLinus Torvalds} 20211da177e4SLinus Torvalds 20226b5b55f6SRandy Dunlap# convert local escape strings to html 20236b5b55f6SRandy Dunlap# local escape strings look like: '\\\\menmonic:' (that's 4 backslashes) 20246b5b55f6SRandy Dunlapsub local_unescape($) { 20256b5b55f6SRandy Dunlap my $text = shift; 20266b5b55f6SRandy Dunlap if (($output_mode eq "text") || ($output_mode eq "man")) { 20276b5b55f6SRandy Dunlap return $text; 20286b5b55f6SRandy Dunlap } 20296b5b55f6SRandy Dunlap $text =~ s/\\\\\\\\lt:/</g; 20306b5b55f6SRandy Dunlap $text =~ s/\\\\\\\\gt:/>/g; 20316b5b55f6SRandy Dunlap return $text; 20326b5b55f6SRandy Dunlap} 20336b5b55f6SRandy Dunlap 20341da177e4SLinus Torvaldssub process_file($) { 20352283a117SRandy Dunlap my $file; 20361da177e4SLinus Torvalds my $identifier; 20371da177e4SLinus Torvalds my $func; 2038a21217daSRandy Dunlap my $descr; 20396423133bSJohannes Weiner my $in_purpose = 0; 20401da177e4SLinus Torvalds my $initial_section_counter = $section_counter; 20411da177e4SLinus Torvalds 20422283a117SRandy Dunlap if (defined($ENV{'SRCTREE'})) { 20432283a117SRandy Dunlap $file = "$ENV{'SRCTREE'}" . "/" . "@_"; 20442283a117SRandy Dunlap } 20452283a117SRandy Dunlap else { 20462283a117SRandy Dunlap $file = "@_"; 20472283a117SRandy Dunlap } 20481da177e4SLinus Torvalds if (defined($source_map{$file})) { 20491da177e4SLinus Torvalds $file = $source_map{$file}; 20501da177e4SLinus Torvalds } 20511da177e4SLinus Torvalds 20521da177e4SLinus Torvalds if (!open(IN,"<$file")) { 20531da177e4SLinus Torvalds print STDERR "Error: Cannot open file $file\n"; 20541da177e4SLinus Torvalds ++$errors; 20551da177e4SLinus Torvalds return; 20561da177e4SLinus Torvalds } 20571da177e4SLinus Torvalds 2058a9e7314bSIlya Dryomov $. = 1; 2059a9e7314bSIlya Dryomov 20601da177e4SLinus Torvalds $section_counter = 0; 20611da177e4SLinus Torvalds while (<IN>) { 206265478428SDaniel Santos while (s/\\\s*$//) { 206365478428SDaniel Santos $_ .= <IN>; 206465478428SDaniel Santos } 20651da177e4SLinus Torvalds if ($state == 0) { 20661da177e4SLinus Torvalds if (/$doc_start/o) { 20671da177e4SLinus Torvalds $state = 1; # next line is always the function name 2068850622dfSRandy Dunlap $in_doc_sect = 0; 20691da177e4SLinus Torvalds } 20701da177e4SLinus Torvalds } elsif ($state == 1) { # this line is the function name (always) 20711da177e4SLinus Torvalds if (/$doc_block/o) { 20721da177e4SLinus Torvalds $state = 4; 20731da177e4SLinus Torvalds $contents = ""; 20741da177e4SLinus Torvalds if ( $1 eq "" ) { 20751da177e4SLinus Torvalds $section = $section_intro; 20761da177e4SLinus Torvalds } else { 20771da177e4SLinus Torvalds $section = $1; 20781da177e4SLinus Torvalds } 20791da177e4SLinus Torvalds } 20801da177e4SLinus Torvalds elsif (/$doc_decl/o) { 20811da177e4SLinus Torvalds $identifier = $1; 20821da177e4SLinus Torvalds if (/\s*([\w\s]+?)\s*-/) { 20831da177e4SLinus Torvalds $identifier = $1; 20841da177e4SLinus Torvalds } 20851da177e4SLinus Torvalds 20861da177e4SLinus Torvalds $state = 2; 20871da177e4SLinus Torvalds if (/-(.*)/) { 208851f5a0c8SRandy Dunlap # strip leading/trailing/multiple spaces 2089a21217daSRandy Dunlap $descr= $1; 2090a21217daSRandy Dunlap $descr =~ s/^\s*//; 2091a21217daSRandy Dunlap $descr =~ s/\s*$//; 2092*12ae6779SDaniel Santos $descr =~ s/\s+/ /g; 2093a21217daSRandy Dunlap $declaration_purpose = xml_escape($descr); 20946423133bSJohannes Weiner $in_purpose = 1; 20951da177e4SLinus Torvalds } else { 20961da177e4SLinus Torvalds $declaration_purpose = ""; 20971da177e4SLinus Torvalds } 209877cc23b8SRandy Dunlap 209977cc23b8SRandy Dunlap if (($declaration_purpose eq "") && $verbose) { 210077cc23b8SRandy Dunlap print STDERR "Warning(${file}:$.): missing initial short description on line:\n"; 210177cc23b8SRandy Dunlap print STDERR $_; 210277cc23b8SRandy Dunlap ++$warnings; 210377cc23b8SRandy Dunlap } 210477cc23b8SRandy Dunlap 21051da177e4SLinus Torvalds if ($identifier =~ m/^struct/) { 21061da177e4SLinus Torvalds $decl_type = 'struct'; 21071da177e4SLinus Torvalds } elsif ($identifier =~ m/^union/) { 21081da177e4SLinus Torvalds $decl_type = 'union'; 21091da177e4SLinus Torvalds } elsif ($identifier =~ m/^enum/) { 21101da177e4SLinus Torvalds $decl_type = 'enum'; 21111da177e4SLinus Torvalds } elsif ($identifier =~ m/^typedef/) { 21121da177e4SLinus Torvalds $decl_type = 'typedef'; 21131da177e4SLinus Torvalds } else { 21141da177e4SLinus Torvalds $decl_type = 'function'; 21151da177e4SLinus Torvalds } 21161da177e4SLinus Torvalds 21171da177e4SLinus Torvalds if ($verbose) { 21181da177e4SLinus Torvalds print STDERR "Info(${file}:$.): Scanning doc for $identifier\n"; 21191da177e4SLinus Torvalds } 21201da177e4SLinus Torvalds } else { 21211da177e4SLinus Torvalds print STDERR "Warning(${file}:$.): Cannot understand $_ on line $.", 21221da177e4SLinus Torvalds " - I thought it was a doc line\n"; 21231da177e4SLinus Torvalds ++$warnings; 21241da177e4SLinus Torvalds $state = 0; 21251da177e4SLinus Torvalds } 21261da177e4SLinus Torvalds } elsif ($state == 2) { # look for head: lines, and include content 21271da177e4SLinus Torvalds if (/$doc_sect/o) { 21281da177e4SLinus Torvalds $newsection = $1; 21291da177e4SLinus Torvalds $newcontents = $2; 21301da177e4SLinus Torvalds 2131792aa2f2SRandy Dunlap if (($contents ne "") && ($contents ne "\n")) { 2132850622dfSRandy Dunlap if (!$in_doc_sect && $verbose) { 2133850622dfSRandy Dunlap print STDERR "Warning(${file}:$.): contents before sections\n"; 2134850622dfSRandy Dunlap ++$warnings; 2135850622dfSRandy Dunlap } 213694dc7ad5SRandy Dunlap dump_section($file, $section, xml_escape($contents)); 21371da177e4SLinus Torvalds $section = $section_default; 21381da177e4SLinus Torvalds } 21391da177e4SLinus Torvalds 2140850622dfSRandy Dunlap $in_doc_sect = 1; 21416423133bSJohannes Weiner $in_purpose = 0; 21421da177e4SLinus Torvalds $contents = $newcontents; 21431da177e4SLinus Torvalds if ($contents ne "") { 214427205744SRandy Dunlap while ((substr($contents, 0, 1) eq " ") || 214527205744SRandy Dunlap substr($contents, 0, 1) eq "\t") { 214605189497SRandy Dunlap $contents = substr($contents, 1); 214705189497SRandy Dunlap } 21481da177e4SLinus Torvalds $contents .= "\n"; 21491da177e4SLinus Torvalds } 21501da177e4SLinus Torvalds $section = $newsection; 21511da177e4SLinus Torvalds } elsif (/$doc_end/) { 21521da177e4SLinus Torvalds 21534c98ecafSRandy Dunlap if (($contents ne "") && ($contents ne "\n")) { 215494dc7ad5SRandy Dunlap dump_section($file, $section, xml_escape($contents)); 21551da177e4SLinus Torvalds $section = $section_default; 21561da177e4SLinus Torvalds $contents = ""; 21571da177e4SLinus Torvalds } 215846b958ebSRandy Dunlap # look for doc_com + <text> + doc_end: 215946b958ebSRandy Dunlap if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') { 216046b958ebSRandy Dunlap print STDERR "Warning(${file}:$.): suspicious ending line: $_"; 216146b958ebSRandy Dunlap ++$warnings; 216246b958ebSRandy Dunlap } 21631da177e4SLinus Torvalds 21641da177e4SLinus Torvalds $prototype = ""; 21651da177e4SLinus Torvalds $state = 3; 21661da177e4SLinus Torvalds $brcount = 0; 21671da177e4SLinus Torvalds# print STDERR "end of doc comment, looking for prototype\n"; 21681da177e4SLinus Torvalds } elsif (/$doc_content/) { 21691da177e4SLinus Torvalds # miguel-style comment kludge, look for blank lines after 21701da177e4SLinus Torvalds # @parameter line to signify start of description 21716423133bSJohannes Weiner if ($1 eq "") { 21726423133bSJohannes Weiner if ($section =~ m/^@/ || $section eq $section_context) { 217394dc7ad5SRandy Dunlap dump_section($file, $section, xml_escape($contents)); 21741da177e4SLinus Torvalds $section = $section_default; 21751da177e4SLinus Torvalds $contents = ""; 21761da177e4SLinus Torvalds } else { 21776423133bSJohannes Weiner $contents .= "\n"; 21786423133bSJohannes Weiner } 21796423133bSJohannes Weiner $in_purpose = 0; 21806423133bSJohannes Weiner } elsif ($in_purpose == 1) { 21816423133bSJohannes Weiner # Continued declaration purpose 21826423133bSJohannes Weiner chomp($declaration_purpose); 21836423133bSJohannes Weiner $declaration_purpose .= " " . xml_escape($1); 2184*12ae6779SDaniel Santos $declaration_purpose =~ s/\s+/ /g; 21856423133bSJohannes Weiner } else { 21861da177e4SLinus Torvalds $contents .= $1 . "\n"; 21871da177e4SLinus Torvalds } 21881da177e4SLinus Torvalds } else { 21891da177e4SLinus Torvalds # i dont know - bad line? ignore. 21901da177e4SLinus Torvalds print STDERR "Warning(${file}:$.): bad line: $_"; 21911da177e4SLinus Torvalds ++$warnings; 21921da177e4SLinus Torvalds } 2193232acbcfSRandy Dunlap } elsif ($state == 3) { # scanning for function '{' (end of prototype) 21941da177e4SLinus Torvalds if ($decl_type eq 'function') { 21951da177e4SLinus Torvalds process_state3_function($_, $file); 21961da177e4SLinus Torvalds } else { 21971da177e4SLinus Torvalds process_state3_type($_, $file); 21981da177e4SLinus Torvalds } 21991da177e4SLinus Torvalds } elsif ($state == 4) { 22001da177e4SLinus Torvalds # Documentation block 22011da177e4SLinus Torvalds if (/$doc_block/) { 220294dc7ad5SRandy Dunlap dump_doc_section($file, $section, xml_escape($contents)); 22031da177e4SLinus Torvalds $contents = ""; 22041da177e4SLinus Torvalds $function = ""; 22051da177e4SLinus Torvalds %constants = (); 22061da177e4SLinus Torvalds %parameterdescs = (); 22071da177e4SLinus Torvalds %parametertypes = (); 22081da177e4SLinus Torvalds @parameterlist = (); 22091da177e4SLinus Torvalds %sections = (); 22101da177e4SLinus Torvalds @sectionlist = (); 22111da177e4SLinus Torvalds $prototype = ""; 22121da177e4SLinus Torvalds if ( $1 eq "" ) { 22131da177e4SLinus Torvalds $section = $section_intro; 22141da177e4SLinus Torvalds } else { 22151da177e4SLinus Torvalds $section = $1; 22161da177e4SLinus Torvalds } 22171da177e4SLinus Torvalds } 22181da177e4SLinus Torvalds elsif (/$doc_end/) 22191da177e4SLinus Torvalds { 222094dc7ad5SRandy Dunlap dump_doc_section($file, $section, xml_escape($contents)); 22211da177e4SLinus Torvalds $contents = ""; 22221da177e4SLinus Torvalds $function = ""; 22231da177e4SLinus Torvalds %constants = (); 22241da177e4SLinus Torvalds %parameterdescs = (); 22251da177e4SLinus Torvalds %parametertypes = (); 22261da177e4SLinus Torvalds @parameterlist = (); 22271da177e4SLinus Torvalds %sections = (); 22281da177e4SLinus Torvalds @sectionlist = (); 22291da177e4SLinus Torvalds $prototype = ""; 22301da177e4SLinus Torvalds $state = 0; 22311da177e4SLinus Torvalds } 22321da177e4SLinus Torvalds elsif (/$doc_content/) 22331da177e4SLinus Torvalds { 22341da177e4SLinus Torvalds if ( $1 eq "" ) 22351da177e4SLinus Torvalds { 22361da177e4SLinus Torvalds $contents .= $blankline; 22371da177e4SLinus Torvalds } 22381da177e4SLinus Torvalds else 22391da177e4SLinus Torvalds { 22401da177e4SLinus Torvalds $contents .= $1 . "\n"; 22411da177e4SLinus Torvalds } 22421da177e4SLinus Torvalds } 22431da177e4SLinus Torvalds } 22441da177e4SLinus Torvalds } 22451da177e4SLinus Torvalds if ($initial_section_counter == $section_counter) { 22461da177e4SLinus Torvalds print STDERR "Warning(${file}): no structured comments found\n"; 22471da177e4SLinus Torvalds if ($output_mode eq "xml") { 22481da177e4SLinus Torvalds # The template wants at least one RefEntry here; make one. 22491da177e4SLinus Torvalds print "<refentry>\n"; 22501da177e4SLinus Torvalds print " <refnamediv>\n"; 22511da177e4SLinus Torvalds print " <refname>\n"; 22521da177e4SLinus Torvalds print " ${file}\n"; 22531da177e4SLinus Torvalds print " </refname>\n"; 22541da177e4SLinus Torvalds print " <refpurpose>\n"; 22551da177e4SLinus Torvalds print " Document generation inconsistency\n"; 22561da177e4SLinus Torvalds print " </refpurpose>\n"; 22571da177e4SLinus Torvalds print " </refnamediv>\n"; 22581da177e4SLinus Torvalds print " <refsect1>\n"; 22591da177e4SLinus Torvalds print " <title>\n"; 22601da177e4SLinus Torvalds print " Oops\n"; 22611da177e4SLinus Torvalds print " </title>\n"; 22621da177e4SLinus Torvalds print " <warning>\n"; 22631da177e4SLinus Torvalds print " <para>\n"; 22641da177e4SLinus Torvalds print " The template for this document tried to insert\n"; 22651da177e4SLinus Torvalds print " the structured comment from the file\n"; 22661da177e4SLinus Torvalds print " <filename>${file}</filename> at this point,\n"; 22671da177e4SLinus Torvalds print " but none was found.\n"; 22681da177e4SLinus Torvalds print " This dummy section is inserted to allow\n"; 22691da177e4SLinus Torvalds print " generation to continue.\n"; 22701da177e4SLinus Torvalds print " </para>\n"; 22711da177e4SLinus Torvalds print " </warning>\n"; 22721da177e4SLinus Torvalds print " </refsect1>\n"; 22731da177e4SLinus Torvalds print "</refentry>\n"; 22741da177e4SLinus Torvalds } 22751da177e4SLinus Torvalds } 22761da177e4SLinus Torvalds} 22778484baaaSRandy Dunlap 22788484baaaSRandy Dunlap 22798484baaaSRandy Dunlap$kernelversion = get_kernel_version(); 22808484baaaSRandy Dunlap 22818484baaaSRandy Dunlap# generate a sequence of code that will splice in highlighting information 22828484baaaSRandy Dunlap# using the s// operator. 22838484baaaSRandy Dunlapforeach my $pattern (keys %highlights) { 22848484baaaSRandy Dunlap# print STDERR "scanning pattern:$pattern, highlight:($highlights{$pattern})\n"; 22858484baaaSRandy Dunlap $dohighlight .= "\$contents =~ s:$pattern:$highlights{$pattern}:gs;\n"; 22868484baaaSRandy Dunlap} 22878484baaaSRandy Dunlap 22888484baaaSRandy Dunlap# Read the file that maps relative names to absolute names for 22898484baaaSRandy Dunlap# separate source and object directories and for shadow trees. 22908484baaaSRandy Dunlapif (open(SOURCE_MAP, "<.tmp_filelist.txt")) { 22918484baaaSRandy Dunlap my ($relname, $absname); 22928484baaaSRandy Dunlap while(<SOURCE_MAP>) { 22938484baaaSRandy Dunlap chop(); 22948484baaaSRandy Dunlap ($relname, $absname) = (split())[0..1]; 22958484baaaSRandy Dunlap $relname =~ s:^/+::; 22968484baaaSRandy Dunlap $source_map{$relname} = $absname; 22978484baaaSRandy Dunlap } 22988484baaaSRandy Dunlap close(SOURCE_MAP); 22998484baaaSRandy Dunlap} 23008484baaaSRandy Dunlap 23018484baaaSRandy Dunlapforeach (@ARGV) { 23028484baaaSRandy Dunlap chomp; 23038484baaaSRandy Dunlap process_file($_); 23048484baaaSRandy Dunlap} 23058484baaaSRandy Dunlapif ($verbose && $errors) { 23068484baaaSRandy Dunlap print STDERR "$errors errors\n"; 23078484baaaSRandy Dunlap} 23088484baaaSRandy Dunlapif ($verbose && $warnings) { 23098484baaaSRandy Dunlap print STDERR "$warnings warnings\n"; 23108484baaaSRandy Dunlap} 23118484baaaSRandy Dunlap 23128484baaaSRandy Dunlapexit($errors); 2313