18fac9c7bSMasahiro Yamada#!/usr/bin/perl -w 28fac9c7bSMasahiro Yamada 38fac9c7bSMasahiro Yamadause strict; 48fac9c7bSMasahiro Yamada 58fac9c7bSMasahiro Yamada## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## 68fac9c7bSMasahiro Yamada## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ## 78fac9c7bSMasahiro Yamada## Copyright (C) 2001 Simon Huggins ## 88fac9c7bSMasahiro Yamada## Copyright (C) 2005-2012 Randy Dunlap ## 98fac9c7bSMasahiro Yamada## Copyright (C) 2012 Dan Luedtke ## 108fac9c7bSMasahiro Yamada## ## 118fac9c7bSMasahiro Yamada## #define enhancements by Armin Kuster <akuster@mvista.com> ## 128fac9c7bSMasahiro Yamada## Copyright (c) 2000 MontaVista Software, Inc. ## 138fac9c7bSMasahiro Yamada## ## 148fac9c7bSMasahiro Yamada## This software falls under the GNU General Public License. ## 158fac9c7bSMasahiro Yamada## Please read the COPYING file for more information ## 168fac9c7bSMasahiro Yamada 178fac9c7bSMasahiro Yamada# 18/01/2001 - Cleanups 188fac9c7bSMasahiro Yamada# Functions prototyped as foo(void) same as foo() 198fac9c7bSMasahiro Yamada# Stop eval'ing where we don't need to. 208fac9c7bSMasahiro Yamada# -- huggie@earth.li 218fac9c7bSMasahiro Yamada 228fac9c7bSMasahiro Yamada# 27/06/2001 - Allowed whitespace after initial "/**" and 238fac9c7bSMasahiro Yamada# allowed comments before function declarations. 248fac9c7bSMasahiro Yamada# -- Christian Kreibich <ck@whoop.org> 258fac9c7bSMasahiro Yamada 268fac9c7bSMasahiro Yamada# Still to do: 278fac9c7bSMasahiro Yamada# - add perldoc documentation 288fac9c7bSMasahiro Yamada# - Look more closely at some of the scarier bits :) 298fac9c7bSMasahiro Yamada 308fac9c7bSMasahiro Yamada# 26/05/2001 - Support for separate source and object trees. 318fac9c7bSMasahiro Yamada# Return error code. 328fac9c7bSMasahiro Yamada# Keith Owens <kaos@ocs.com.au> 338fac9c7bSMasahiro Yamada 348fac9c7bSMasahiro Yamada# 23/09/2001 - Added support for typedefs, structs, enums and unions 358fac9c7bSMasahiro Yamada# Support for Context section; can be terminated using empty line 368fac9c7bSMasahiro Yamada# Small fixes (like spaces vs. \s in regex) 378fac9c7bSMasahiro Yamada# -- Tim Jansen <tim@tjansen.de> 388fac9c7bSMasahiro Yamada 398fac9c7bSMasahiro Yamada# 25/07/2012 - Added support for HTML5 408fac9c7bSMasahiro Yamada# -- Dan Luedtke <mail@danrl.de> 418fac9c7bSMasahiro Yamada 428fac9c7bSMasahiro Yamada# 438fac9c7bSMasahiro Yamada# This will read a 'c' file and scan for embedded comments in the 448fac9c7bSMasahiro Yamada# style of gnome comments (+minor extensions - see below). 458fac9c7bSMasahiro Yamada# 468fac9c7bSMasahiro Yamada 478fac9c7bSMasahiro Yamada# Note: This only supports 'c'. 488fac9c7bSMasahiro Yamada 498fac9c7bSMasahiro Yamada# usage: 508fac9c7bSMasahiro Yamada# kernel-doc [ -docbook | -html | -html5 | -text | -man | -list ] 518fac9c7bSMasahiro Yamada# [ -no-doc-sections ] 528fac9c7bSMasahiro Yamada# [ -function funcname [ -function funcname ...] ] 538fac9c7bSMasahiro Yamada# c file(s)s > outputfile 548fac9c7bSMasahiro Yamada# or 558fac9c7bSMasahiro Yamada# [ -nofunction funcname [ -function funcname ...] ] 568fac9c7bSMasahiro Yamada# c file(s)s > outputfile 578fac9c7bSMasahiro Yamada# 588fac9c7bSMasahiro Yamada# Set output format using one of -docbook -html -html5 -text or -man. 598fac9c7bSMasahiro Yamada# Default is man. 608fac9c7bSMasahiro Yamada# The -list format is for internal use by docproc. 618fac9c7bSMasahiro Yamada# 628fac9c7bSMasahiro Yamada# -no-doc-sections 638fac9c7bSMasahiro Yamada# Do not output DOC: sections 648fac9c7bSMasahiro Yamada# 658fac9c7bSMasahiro Yamada# -function funcname 668fac9c7bSMasahiro Yamada# If set, then only generate documentation for the given function(s) or 678fac9c7bSMasahiro Yamada# DOC: section titles. All other functions and DOC: sections are ignored. 688fac9c7bSMasahiro Yamada# 698fac9c7bSMasahiro Yamada# -nofunction funcname 708fac9c7bSMasahiro Yamada# If set, then only generate documentation for the other function(s)/DOC: 718fac9c7bSMasahiro Yamada# sections. Cannot be used together with -function (yes, that's a bug -- 728fac9c7bSMasahiro Yamada# perl hackers can fix it 8)) 738fac9c7bSMasahiro Yamada# 748fac9c7bSMasahiro Yamada# c files - list of 'c' files to process 758fac9c7bSMasahiro Yamada# 768fac9c7bSMasahiro Yamada# All output goes to stdout, with errors to stderr. 778fac9c7bSMasahiro Yamada 788fac9c7bSMasahiro Yamada# 798fac9c7bSMasahiro Yamada# format of comments. 808fac9c7bSMasahiro Yamada# In the following table, (...)? signifies optional structure. 818fac9c7bSMasahiro Yamada# (...)* signifies 0 or more structure elements 828fac9c7bSMasahiro Yamada# /** 838fac9c7bSMasahiro Yamada# * function_name(:)? (- short description)? 848fac9c7bSMasahiro Yamada# (* @parameterx: (description of parameter x)?)* 858fac9c7bSMasahiro Yamada# (* a blank line)? 868fac9c7bSMasahiro Yamada# * (Description:)? (Description of function)? 878fac9c7bSMasahiro Yamada# * (section header: (section description)? )* 888fac9c7bSMasahiro Yamada# (*)?*/ 898fac9c7bSMasahiro Yamada# 908fac9c7bSMasahiro Yamada# So .. the trivial example would be: 918fac9c7bSMasahiro Yamada# 928fac9c7bSMasahiro Yamada# /** 938fac9c7bSMasahiro Yamada# * my_function 948fac9c7bSMasahiro Yamada# */ 958fac9c7bSMasahiro Yamada# 968fac9c7bSMasahiro Yamada# If the Description: header tag is omitted, then there must be a blank line 978fac9c7bSMasahiro Yamada# after the last parameter specification. 988fac9c7bSMasahiro Yamada# e.g. 998fac9c7bSMasahiro Yamada# /** 1008fac9c7bSMasahiro Yamada# * my_function - does my stuff 1018fac9c7bSMasahiro Yamada# * @my_arg: its mine damnit 1028fac9c7bSMasahiro Yamada# * 1038fac9c7bSMasahiro Yamada# * Does my stuff explained. 1048fac9c7bSMasahiro Yamada# */ 1058fac9c7bSMasahiro Yamada# 1068fac9c7bSMasahiro Yamada# or, could also use: 1078fac9c7bSMasahiro Yamada# /** 1088fac9c7bSMasahiro Yamada# * my_function - does my stuff 1098fac9c7bSMasahiro Yamada# * @my_arg: its mine damnit 1108fac9c7bSMasahiro Yamada# * Description: Does my stuff explained. 1118fac9c7bSMasahiro Yamada# */ 1128fac9c7bSMasahiro Yamada# etc. 1138fac9c7bSMasahiro Yamada# 1148fac9c7bSMasahiro Yamada# Besides functions you can also write documentation for structs, unions, 1158fac9c7bSMasahiro Yamada# enums and typedefs. Instead of the function name you must write the name 1168fac9c7bSMasahiro Yamada# of the declaration; the struct/union/enum/typedef must always precede 1178fac9c7bSMasahiro Yamada# the name. Nesting of declarations is not supported. 1188fac9c7bSMasahiro Yamada# Use the argument mechanism to document members or constants. 1198fac9c7bSMasahiro Yamada# e.g. 1208fac9c7bSMasahiro Yamada# /** 1218fac9c7bSMasahiro Yamada# * struct my_struct - short description 1228fac9c7bSMasahiro Yamada# * @a: first member 1238fac9c7bSMasahiro Yamada# * @b: second member 1248fac9c7bSMasahiro Yamada# * 1258fac9c7bSMasahiro Yamada# * Longer description 1268fac9c7bSMasahiro Yamada# */ 1278fac9c7bSMasahiro Yamada# struct my_struct { 1288fac9c7bSMasahiro Yamada# int a; 1298fac9c7bSMasahiro Yamada# int b; 1308fac9c7bSMasahiro Yamada# /* private: */ 1318fac9c7bSMasahiro Yamada# int c; 1328fac9c7bSMasahiro Yamada# }; 1338fac9c7bSMasahiro Yamada# 1348fac9c7bSMasahiro Yamada# All descriptions can be multiline, except the short function description. 1358fac9c7bSMasahiro Yamada# 1368fac9c7bSMasahiro Yamada# You can also add additional sections. When documenting kernel functions you 1378fac9c7bSMasahiro Yamada# should document the "Context:" of the function, e.g. whether the functions 1388fac9c7bSMasahiro Yamada# can be called form interrupts. Unlike other sections you can end it with an 1398fac9c7bSMasahiro Yamada# empty line. 140ced03298SMasahiro Yamada# A non-void function should have a "Return:" section describing the return 141ced03298SMasahiro Yamada# value(s). 1428fac9c7bSMasahiro Yamada# Example-sections should contain the string EXAMPLE so that they are marked 1438fac9c7bSMasahiro Yamada# appropriately in DocBook. 1448fac9c7bSMasahiro Yamada# 1458fac9c7bSMasahiro Yamada# Example: 1468fac9c7bSMasahiro Yamada# /** 1478fac9c7bSMasahiro Yamada# * user_function - function that can only be called in user context 1488fac9c7bSMasahiro Yamada# * @a: some argument 1498fac9c7bSMasahiro Yamada# * Context: !in_interrupt() 1508fac9c7bSMasahiro Yamada# * 1518fac9c7bSMasahiro Yamada# * Some description 1528fac9c7bSMasahiro Yamada# * Example: 1538fac9c7bSMasahiro Yamada# * user_function(22); 1548fac9c7bSMasahiro Yamada# */ 1558fac9c7bSMasahiro Yamada# ... 1568fac9c7bSMasahiro Yamada# 1578fac9c7bSMasahiro Yamada# 1588fac9c7bSMasahiro Yamada# All descriptive text is further processed, scanning for the following special 1598fac9c7bSMasahiro Yamada# patterns, which are highlighted appropriately. 1608fac9c7bSMasahiro Yamada# 1618fac9c7bSMasahiro Yamada# 'funcname()' - function 1628fac9c7bSMasahiro Yamada# '$ENVVAR' - environmental variable 1638fac9c7bSMasahiro Yamada# '&struct_name' - name of a structure (up to two words including 'struct') 1648fac9c7bSMasahiro Yamada# '@parameter' - name of a parameter 1658fac9c7bSMasahiro Yamada# '%CONST' - name of a constant. 1668fac9c7bSMasahiro Yamada 1678fac9c7bSMasahiro Yamada## init lots of data 1688fac9c7bSMasahiro Yamada 1698fac9c7bSMasahiro Yamadamy $errors = 0; 1708fac9c7bSMasahiro Yamadamy $warnings = 0; 1718fac9c7bSMasahiro Yamadamy $anon_struct_union = 0; 1728fac9c7bSMasahiro Yamada 1738fac9c7bSMasahiro Yamada# match expressions used to find embedded type information 1748fac9c7bSMasahiro Yamadamy $type_constant = '\%([-_\w]+)'; 1758fac9c7bSMasahiro Yamadamy $type_func = '(\w+)\(\)'; 1768fac9c7bSMasahiro Yamadamy $type_param = '\@(\w+)'; 1778fac9c7bSMasahiro Yamadamy $type_struct = '\&((struct\s*)*[_\w]+)'; 1788fac9c7bSMasahiro Yamadamy $type_struct_xml = '\\&((struct\s*)*[_\w]+)'; 1798fac9c7bSMasahiro Yamadamy $type_env = '(\$\w+)'; 1808fac9c7bSMasahiro Yamada 1818fac9c7bSMasahiro Yamada# Output conversion substitutions. 1828fac9c7bSMasahiro Yamada# One for each output format 1838fac9c7bSMasahiro Yamada 1848fac9c7bSMasahiro Yamada# these work fairly well 1858fac9c7bSMasahiro Yamadamy %highlights_html = ( $type_constant, "<i>\$1</i>", 1868fac9c7bSMasahiro Yamada $type_func, "<b>\$1</b>", 1878fac9c7bSMasahiro Yamada $type_struct_xml, "<i>\$1</i>", 1888fac9c7bSMasahiro Yamada $type_env, "<b><i>\$1</i></b>", 1898fac9c7bSMasahiro Yamada $type_param, "<tt><b>\$1</b></tt>" ); 1908fac9c7bSMasahiro Yamadamy $local_lt = "\\\\\\\\lt:"; 1918fac9c7bSMasahiro Yamadamy $local_gt = "\\\\\\\\gt:"; 1928fac9c7bSMasahiro Yamadamy $blankline_html = $local_lt . "p" . $local_gt; # was "<p>" 1938fac9c7bSMasahiro Yamada 1948fac9c7bSMasahiro Yamada# html version 5 1958fac9c7bSMasahiro Yamadamy %highlights_html5 = ( $type_constant, "<span class=\"const\">\$1</span>", 1968fac9c7bSMasahiro Yamada $type_func, "<span class=\"func\">\$1</span>", 1978fac9c7bSMasahiro Yamada $type_struct_xml, "<span class=\"struct\">\$1</span>", 1988fac9c7bSMasahiro Yamada $type_env, "<span class=\"env\">\$1</span>", 1998fac9c7bSMasahiro Yamada $type_param, "<span class=\"param\">\$1</span>" ); 2008fac9c7bSMasahiro Yamadamy $blankline_html5 = $local_lt . "br /" . $local_gt; 2018fac9c7bSMasahiro Yamada 2028fac9c7bSMasahiro Yamada# XML, docbook format 2038fac9c7bSMasahiro Yamadamy %highlights_xml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>", 2048fac9c7bSMasahiro Yamada $type_constant, "<constant>\$1</constant>", 2058fac9c7bSMasahiro Yamada $type_func, "<function>\$1</function>", 2068fac9c7bSMasahiro Yamada $type_struct_xml, "<structname>\$1</structname>", 2078fac9c7bSMasahiro Yamada $type_env, "<envar>\$1</envar>", 2088fac9c7bSMasahiro Yamada $type_param, "<parameter>\$1</parameter>" ); 2098fac9c7bSMasahiro Yamadamy $blankline_xml = $local_lt . "/para" . $local_gt . $local_lt . "para" . $local_gt . "\n"; 2108fac9c7bSMasahiro Yamada 2118fac9c7bSMasahiro Yamada# gnome, docbook format 2128fac9c7bSMasahiro Yamadamy %highlights_gnome = ( $type_constant, "<replaceable class=\"option\">\$1</replaceable>", 2138fac9c7bSMasahiro Yamada $type_func, "<function>\$1</function>", 2148fac9c7bSMasahiro Yamada $type_struct, "<structname>\$1</structname>", 2158fac9c7bSMasahiro Yamada $type_env, "<envar>\$1</envar>", 2168fac9c7bSMasahiro Yamada $type_param, "<parameter>\$1</parameter>" ); 2178fac9c7bSMasahiro Yamadamy $blankline_gnome = "</para><para>\n"; 2188fac9c7bSMasahiro Yamada 2198fac9c7bSMasahiro Yamada# these are pretty rough 2208fac9c7bSMasahiro Yamadamy %highlights_man = ( $type_constant, "\$1", 2218fac9c7bSMasahiro Yamada $type_func, "\\\\fB\$1\\\\fP", 2228fac9c7bSMasahiro Yamada $type_struct, "\\\\fI\$1\\\\fP", 2238fac9c7bSMasahiro Yamada $type_param, "\\\\fI\$1\\\\fP" ); 2248fac9c7bSMasahiro Yamadamy $blankline_man = ""; 2258fac9c7bSMasahiro Yamada 2268fac9c7bSMasahiro Yamada# text-mode 2278fac9c7bSMasahiro Yamadamy %highlights_text = ( $type_constant, "\$1", 2288fac9c7bSMasahiro Yamada $type_func, "\$1", 2298fac9c7bSMasahiro Yamada $type_struct, "\$1", 2308fac9c7bSMasahiro Yamada $type_param, "\$1" ); 2318fac9c7bSMasahiro Yamadamy $blankline_text = ""; 2328fac9c7bSMasahiro Yamada 2338fac9c7bSMasahiro Yamada# list mode 2348fac9c7bSMasahiro Yamadamy %highlights_list = ( $type_constant, "\$1", 2358fac9c7bSMasahiro Yamada $type_func, "\$1", 2368fac9c7bSMasahiro Yamada $type_struct, "\$1", 2378fac9c7bSMasahiro Yamada $type_param, "\$1" ); 2388fac9c7bSMasahiro Yamadamy $blankline_list = ""; 2398fac9c7bSMasahiro Yamada 2408fac9c7bSMasahiro Yamada# read arguments 2418fac9c7bSMasahiro Yamadaif ($#ARGV == -1) { 2428fac9c7bSMasahiro Yamada usage(); 2438fac9c7bSMasahiro Yamada} 2448fac9c7bSMasahiro Yamada 2458fac9c7bSMasahiro Yamadamy $kernelversion; 2468fac9c7bSMasahiro Yamadamy $dohighlight = ""; 2478fac9c7bSMasahiro Yamada 2488fac9c7bSMasahiro Yamadamy $verbose = 0; 2498fac9c7bSMasahiro Yamadamy $output_mode = "man"; 250ced03298SMasahiro Yamadamy $output_preformatted = 0; 2518fac9c7bSMasahiro Yamadamy $no_doc_sections = 0; 2528fac9c7bSMasahiro Yamadamy %highlights = %highlights_man; 2538fac9c7bSMasahiro Yamadamy $blankline = $blankline_man; 2548fac9c7bSMasahiro Yamadamy $modulename = "Bootloader API"; 2558fac9c7bSMasahiro Yamadamy $function_only = 0; 2568fac9c7bSMasahiro Yamadamy $man_date = ('January', 'February', 'March', 'April', 'May', 'June', 2578fac9c7bSMasahiro Yamada 'July', 'August', 'September', 'October', 2588fac9c7bSMasahiro Yamada 'November', 'December')[(localtime)[4]] . 2598fac9c7bSMasahiro Yamada " " . ((localtime)[5]+1900); 260ced03298SMasahiro Yamadamy $show_not_found = 0; 2618fac9c7bSMasahiro Yamada 2628fac9c7bSMasahiro Yamada# Essentially these are globals. 2638fac9c7bSMasahiro Yamada# They probably want to be tidied up, made more localised or something. 2648fac9c7bSMasahiro Yamada# CAVEAT EMPTOR! Some of the others I localised may not want to be, which 2658fac9c7bSMasahiro Yamada# could cause "use of undefined value" or other bugs. 2668fac9c7bSMasahiro Yamadamy ($function, %function_table, %parametertypes, $declaration_purpose); 2678fac9c7bSMasahiro Yamadamy ($type, $declaration_name, $return_type); 2688fac9c7bSMasahiro Yamadamy ($newsection, $newcontents, $prototype, $brcount, %source_map); 2698fac9c7bSMasahiro Yamada 2708fac9c7bSMasahiro Yamadaif (defined($ENV{'KBUILD_VERBOSE'})) { 2718fac9c7bSMasahiro Yamada $verbose = "$ENV{'KBUILD_VERBOSE'}"; 2728fac9c7bSMasahiro Yamada} 2738fac9c7bSMasahiro Yamada 2748fac9c7bSMasahiro Yamada# Generated docbook code is inserted in a template at a point where 2758fac9c7bSMasahiro Yamada# docbook v3.1 requires a non-zero sequence of RefEntry's; see: 2768fac9c7bSMasahiro Yamada# http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html 2778fac9c7bSMasahiro Yamada# We keep track of number of generated entries and generate a dummy 2788fac9c7bSMasahiro Yamada# if needs be to ensure the expanded template can be postprocessed 2798fac9c7bSMasahiro Yamada# into html. 2808fac9c7bSMasahiro Yamadamy $section_counter = 0; 2818fac9c7bSMasahiro Yamada 2828fac9c7bSMasahiro Yamadamy $lineprefix=""; 2838fac9c7bSMasahiro Yamada 2848fac9c7bSMasahiro Yamada# states 2858fac9c7bSMasahiro Yamada# 0 - normal code 2868fac9c7bSMasahiro Yamada# 1 - looking for function name 2878fac9c7bSMasahiro Yamada# 2 - scanning field start. 2888fac9c7bSMasahiro Yamada# 3 - scanning prototype. 2898fac9c7bSMasahiro Yamada# 4 - documentation block 2908fac9c7bSMasahiro Yamadamy $state; 2918fac9c7bSMasahiro Yamadamy $in_doc_sect; 2928fac9c7bSMasahiro Yamada 2938fac9c7bSMasahiro Yamada#declaration types: can be 2948fac9c7bSMasahiro Yamada# 'function', 'struct', 'union', 'enum', 'typedef' 2958fac9c7bSMasahiro Yamadamy $decl_type; 2968fac9c7bSMasahiro Yamada 2978fac9c7bSMasahiro Yamadamy $doc_special = "\@\%\$\&"; 2988fac9c7bSMasahiro Yamada 2998fac9c7bSMasahiro Yamadamy $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start. 3008fac9c7bSMasahiro Yamadamy $doc_end = '\*/'; 3018fac9c7bSMasahiro Yamadamy $doc_com = '\s*\*\s*'; 302ced03298SMasahiro Yamadamy $doc_com_body = '\s*\* ?'; 3038fac9c7bSMasahiro Yamadamy $doc_decl = $doc_com . '(\w+)'; 3048fac9c7bSMasahiro Yamadamy $doc_sect = $doc_com . '([' . $doc_special . ']?[\w\s]+):(.*)'; 305ced03298SMasahiro Yamadamy $doc_content = $doc_com_body . '(.*)'; 3068fac9c7bSMasahiro Yamadamy $doc_block = $doc_com . 'DOC:\s*(.*)?'; 3078fac9c7bSMasahiro Yamada 3088fac9c7bSMasahiro Yamadamy %constants; 3098fac9c7bSMasahiro Yamadamy %parameterdescs; 3108fac9c7bSMasahiro Yamadamy @parameterlist; 3118fac9c7bSMasahiro Yamadamy %sections; 3128fac9c7bSMasahiro Yamadamy @sectionlist; 3138fac9c7bSMasahiro Yamadamy $sectcheck; 3148fac9c7bSMasahiro Yamadamy $struct_actual; 3158fac9c7bSMasahiro Yamada 3168fac9c7bSMasahiro Yamadamy $contents = ""; 3178fac9c7bSMasahiro Yamadamy $section_default = "Description"; # default section 3188fac9c7bSMasahiro Yamadamy $section_intro = "Introduction"; 3198fac9c7bSMasahiro Yamadamy $section = $section_default; 3208fac9c7bSMasahiro Yamadamy $section_context = "Context"; 321ced03298SMasahiro Yamadamy $section_return = "Return"; 3228fac9c7bSMasahiro Yamada 3238fac9c7bSMasahiro Yamadamy $undescribed = "-- undescribed --"; 3248fac9c7bSMasahiro Yamada 3258fac9c7bSMasahiro Yamadareset_state(); 3268fac9c7bSMasahiro Yamada 3278fac9c7bSMasahiro Yamadawhile ($ARGV[0] =~ m/^-(.*)/) { 3288fac9c7bSMasahiro Yamada my $cmd = shift @ARGV; 3298fac9c7bSMasahiro Yamada if ($cmd eq "-html") { 3308fac9c7bSMasahiro Yamada $output_mode = "html"; 3318fac9c7bSMasahiro Yamada %highlights = %highlights_html; 3328fac9c7bSMasahiro Yamada $blankline = $blankline_html; 3338fac9c7bSMasahiro Yamada } elsif ($cmd eq "-html5") { 3348fac9c7bSMasahiro Yamada $output_mode = "html5"; 3358fac9c7bSMasahiro Yamada %highlights = %highlights_html5; 3368fac9c7bSMasahiro Yamada $blankline = $blankline_html5; 3378fac9c7bSMasahiro Yamada } elsif ($cmd eq "-man") { 3388fac9c7bSMasahiro Yamada $output_mode = "man"; 3398fac9c7bSMasahiro Yamada %highlights = %highlights_man; 3408fac9c7bSMasahiro Yamada $blankline = $blankline_man; 3418fac9c7bSMasahiro Yamada } elsif ($cmd eq "-text") { 3428fac9c7bSMasahiro Yamada $output_mode = "text"; 3438fac9c7bSMasahiro Yamada %highlights = %highlights_text; 3448fac9c7bSMasahiro Yamada $blankline = $blankline_text; 3458fac9c7bSMasahiro Yamada } elsif ($cmd eq "-docbook") { 3468fac9c7bSMasahiro Yamada $output_mode = "xml"; 3478fac9c7bSMasahiro Yamada %highlights = %highlights_xml; 3488fac9c7bSMasahiro Yamada $blankline = $blankline_xml; 3498fac9c7bSMasahiro Yamada } elsif ($cmd eq "-list") { 3508fac9c7bSMasahiro Yamada $output_mode = "list"; 3518fac9c7bSMasahiro Yamada %highlights = %highlights_list; 3528fac9c7bSMasahiro Yamada $blankline = $blankline_list; 3538fac9c7bSMasahiro Yamada } elsif ($cmd eq "-gnome") { 3548fac9c7bSMasahiro Yamada $output_mode = "gnome"; 3558fac9c7bSMasahiro Yamada %highlights = %highlights_gnome; 3568fac9c7bSMasahiro Yamada $blankline = $blankline_gnome; 3578fac9c7bSMasahiro Yamada } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document 3588fac9c7bSMasahiro Yamada $modulename = shift @ARGV; 3598fac9c7bSMasahiro Yamada } elsif ($cmd eq "-function") { # to only output specific functions 3608fac9c7bSMasahiro Yamada $function_only = 1; 3618fac9c7bSMasahiro Yamada $function = shift @ARGV; 3628fac9c7bSMasahiro Yamada $function_table{$function} = 1; 3638fac9c7bSMasahiro Yamada } elsif ($cmd eq "-nofunction") { # to only output specific functions 3648fac9c7bSMasahiro Yamada $function_only = 2; 3658fac9c7bSMasahiro Yamada $function = shift @ARGV; 3668fac9c7bSMasahiro Yamada $function_table{$function} = 1; 3678fac9c7bSMasahiro Yamada } elsif ($cmd eq "-v") { 3688fac9c7bSMasahiro Yamada $verbose = 1; 3698fac9c7bSMasahiro Yamada } elsif (($cmd eq "-h") || ($cmd eq "--help")) { 3708fac9c7bSMasahiro Yamada usage(); 3718fac9c7bSMasahiro Yamada } elsif ($cmd eq '-no-doc-sections') { 3728fac9c7bSMasahiro Yamada $no_doc_sections = 1; 373ced03298SMasahiro Yamada } elsif ($cmd eq '-show-not-found') { 374ced03298SMasahiro Yamada $show_not_found = 1; 3758fac9c7bSMasahiro Yamada } 3768fac9c7bSMasahiro Yamada} 3778fac9c7bSMasahiro Yamada 3788fac9c7bSMasahiro Yamada# continue execution near EOF; 3798fac9c7bSMasahiro Yamada 3808fac9c7bSMasahiro Yamadasub usage { 3818fac9c7bSMasahiro Yamada print "Usage: $0 [ -docbook | -html | -html5 | -text | -man | -list ]\n"; 3828fac9c7bSMasahiro Yamada print " [ -no-doc-sections ]\n"; 3838fac9c7bSMasahiro Yamada print " [ -function funcname [ -function funcname ...] ]\n"; 3848fac9c7bSMasahiro Yamada print " [ -nofunction funcname [ -nofunction funcname ...] ]\n"; 3858fac9c7bSMasahiro Yamada print " [ -v ]\n"; 3868fac9c7bSMasahiro Yamada print " c source file(s) > outputfile\n"; 3878fac9c7bSMasahiro Yamada print " -v : verbose output, more warnings & other info listed\n"; 3888fac9c7bSMasahiro Yamada exit 1; 3898fac9c7bSMasahiro Yamada} 3908fac9c7bSMasahiro Yamada 3918fac9c7bSMasahiro Yamada# get kernel version from env 3928fac9c7bSMasahiro Yamadasub get_kernel_version() { 3938fac9c7bSMasahiro Yamada my $version = 'unknown kernel version'; 3948fac9c7bSMasahiro Yamada 3957424145fSMasahiro Yamada if (defined($ENV{'UBOOTVERSION'})) { 3967424145fSMasahiro Yamada $version = $ENV{'UBOOTVERSION'}; 3978fac9c7bSMasahiro Yamada } 3988fac9c7bSMasahiro Yamada return $version; 3998fac9c7bSMasahiro Yamada} 4008fac9c7bSMasahiro Yamada 4018fac9c7bSMasahiro Yamada## 4028fac9c7bSMasahiro Yamada# dumps section contents to arrays/hashes intended for that purpose. 4038fac9c7bSMasahiro Yamada# 4048fac9c7bSMasahiro Yamadasub dump_section { 4058fac9c7bSMasahiro Yamada my $file = shift; 4068fac9c7bSMasahiro Yamada my $name = shift; 4078fac9c7bSMasahiro Yamada my $contents = join "\n", @_; 4088fac9c7bSMasahiro Yamada 4098fac9c7bSMasahiro Yamada if ($name =~ m/$type_constant/) { 4108fac9c7bSMasahiro Yamada $name = $1; 4118fac9c7bSMasahiro Yamada# print STDERR "constant section '$1' = '$contents'\n"; 4128fac9c7bSMasahiro Yamada $constants{$name} = $contents; 4138fac9c7bSMasahiro Yamada } elsif ($name =~ m/$type_param/) { 4148fac9c7bSMasahiro Yamada# print STDERR "parameter def '$1' = '$contents'\n"; 4158fac9c7bSMasahiro Yamada $name = $1; 4168fac9c7bSMasahiro Yamada $parameterdescs{$name} = $contents; 4178fac9c7bSMasahiro Yamada $sectcheck = $sectcheck . $name . " "; 4188fac9c7bSMasahiro Yamada } elsif ($name eq "@\.\.\.") { 4198fac9c7bSMasahiro Yamada# print STDERR "parameter def '...' = '$contents'\n"; 4208fac9c7bSMasahiro Yamada $name = "..."; 4218fac9c7bSMasahiro Yamada $parameterdescs{$name} = $contents; 4228fac9c7bSMasahiro Yamada $sectcheck = $sectcheck . $name . " "; 4238fac9c7bSMasahiro Yamada } else { 4248fac9c7bSMasahiro Yamada# print STDERR "other section '$name' = '$contents'\n"; 4258fac9c7bSMasahiro Yamada if (defined($sections{$name}) && ($sections{$name} ne "")) { 4268fac9c7bSMasahiro Yamada print STDERR "Error(${file}:$.): duplicate section name '$name'\n"; 4278fac9c7bSMasahiro Yamada ++$errors; 4288fac9c7bSMasahiro Yamada } 4298fac9c7bSMasahiro Yamada $sections{$name} = $contents; 4308fac9c7bSMasahiro Yamada push @sectionlist, $name; 4318fac9c7bSMasahiro Yamada } 4328fac9c7bSMasahiro Yamada} 4338fac9c7bSMasahiro Yamada 4348fac9c7bSMasahiro Yamada## 4358fac9c7bSMasahiro Yamada# dump DOC: section after checking that it should go out 4368fac9c7bSMasahiro Yamada# 4378fac9c7bSMasahiro Yamadasub dump_doc_section { 4388fac9c7bSMasahiro Yamada my $file = shift; 4398fac9c7bSMasahiro Yamada my $name = shift; 4408fac9c7bSMasahiro Yamada my $contents = join "\n", @_; 4418fac9c7bSMasahiro Yamada 4428fac9c7bSMasahiro Yamada if ($no_doc_sections) { 4438fac9c7bSMasahiro Yamada return; 4448fac9c7bSMasahiro Yamada } 4458fac9c7bSMasahiro Yamada 4468fac9c7bSMasahiro Yamada if (($function_only == 0) || 4478fac9c7bSMasahiro Yamada ( $function_only == 1 && defined($function_table{$name})) || 4488fac9c7bSMasahiro Yamada ( $function_only == 2 && !defined($function_table{$name}))) 4498fac9c7bSMasahiro Yamada { 4508fac9c7bSMasahiro Yamada dump_section($file, $name, $contents); 4518fac9c7bSMasahiro Yamada output_blockhead({'sectionlist' => \@sectionlist, 4528fac9c7bSMasahiro Yamada 'sections' => \%sections, 4538fac9c7bSMasahiro Yamada 'module' => $modulename, 4548fac9c7bSMasahiro Yamada 'content-only' => ($function_only != 0), }); 4558fac9c7bSMasahiro Yamada } 4568fac9c7bSMasahiro Yamada} 4578fac9c7bSMasahiro Yamada 4588fac9c7bSMasahiro Yamada## 4598fac9c7bSMasahiro Yamada# output function 4608fac9c7bSMasahiro Yamada# 4618fac9c7bSMasahiro Yamada# parameterdescs, a hash. 4628fac9c7bSMasahiro Yamada# function => "function name" 4638fac9c7bSMasahiro Yamada# parameterlist => @list of parameters 4648fac9c7bSMasahiro Yamada# parameterdescs => %parameter descriptions 4658fac9c7bSMasahiro Yamada# sectionlist => @list of sections 4668fac9c7bSMasahiro Yamada# sections => %section descriptions 4678fac9c7bSMasahiro Yamada# 4688fac9c7bSMasahiro Yamada 4698fac9c7bSMasahiro Yamadasub output_highlight { 4708fac9c7bSMasahiro Yamada my $contents = join "\n",@_; 4718fac9c7bSMasahiro Yamada my $line; 4728fac9c7bSMasahiro Yamada 4738fac9c7bSMasahiro Yamada# DEBUG 4748fac9c7bSMasahiro Yamada# if (!defined $contents) { 4758fac9c7bSMasahiro Yamada# use Carp; 4768fac9c7bSMasahiro Yamada# confess "output_highlight got called with no args?\n"; 4778fac9c7bSMasahiro Yamada# } 4788fac9c7bSMasahiro Yamada 4798fac9c7bSMasahiro Yamada if ($output_mode eq "html" || $output_mode eq "html5" || 4808fac9c7bSMasahiro Yamada $output_mode eq "xml") { 4818fac9c7bSMasahiro Yamada $contents = local_unescape($contents); 4828fac9c7bSMasahiro Yamada # convert data read & converted thru xml_escape() into &xyz; format: 4838fac9c7bSMasahiro Yamada $contents =~ s/\\\\\\/\&/g; 4848fac9c7bSMasahiro Yamada } 4858fac9c7bSMasahiro Yamada# print STDERR "contents b4:$contents\n"; 4868fac9c7bSMasahiro Yamada eval $dohighlight; 4878fac9c7bSMasahiro Yamada die $@ if $@; 4888fac9c7bSMasahiro Yamada# print STDERR "contents af:$contents\n"; 4898fac9c7bSMasahiro Yamada 4908fac9c7bSMasahiro Yamada# strip whitespaces when generating html5 4918fac9c7bSMasahiro Yamada if ($output_mode eq "html5") { 4928fac9c7bSMasahiro Yamada $contents =~ s/^\s+//; 4938fac9c7bSMasahiro Yamada $contents =~ s/\s+$//; 4948fac9c7bSMasahiro Yamada } 4958fac9c7bSMasahiro Yamada foreach $line (split "\n", $contents) { 496ced03298SMasahiro Yamada if (! $output_preformatted) { 497ced03298SMasahiro Yamada $line =~ s/^\s*//; 498ced03298SMasahiro Yamada } 4998fac9c7bSMasahiro Yamada if ($line eq ""){ 500ced03298SMasahiro Yamada if (! $output_preformatted) { 5018fac9c7bSMasahiro Yamada print $lineprefix, local_unescape($blankline); 502ced03298SMasahiro Yamada } 5038fac9c7bSMasahiro Yamada } else { 5048fac9c7bSMasahiro Yamada $line =~ s/\\\\\\/\&/g; 5058fac9c7bSMasahiro Yamada if ($output_mode eq "man" && substr($line, 0, 1) eq ".") { 5068fac9c7bSMasahiro Yamada print "\\&$line"; 5078fac9c7bSMasahiro Yamada } else { 5088fac9c7bSMasahiro Yamada print $lineprefix, $line; 5098fac9c7bSMasahiro Yamada } 5108fac9c7bSMasahiro Yamada } 5118fac9c7bSMasahiro Yamada print "\n"; 5128fac9c7bSMasahiro Yamada } 5138fac9c7bSMasahiro Yamada} 5148fac9c7bSMasahiro Yamada 5158fac9c7bSMasahiro Yamada# output sections in html 5168fac9c7bSMasahiro Yamadasub output_section_html(%) { 5178fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 5188fac9c7bSMasahiro Yamada my $section; 5198fac9c7bSMasahiro Yamada 5208fac9c7bSMasahiro Yamada foreach $section (@{$args{'sectionlist'}}) { 5218fac9c7bSMasahiro Yamada print "<h3>$section</h3>\n"; 5228fac9c7bSMasahiro Yamada print "<blockquote>\n"; 5238fac9c7bSMasahiro Yamada output_highlight($args{'sections'}{$section}); 5248fac9c7bSMasahiro Yamada print "</blockquote>\n"; 5258fac9c7bSMasahiro Yamada } 5268fac9c7bSMasahiro Yamada} 5278fac9c7bSMasahiro Yamada 5288fac9c7bSMasahiro Yamada# output enum in html 5298fac9c7bSMasahiro Yamadasub output_enum_html(%) { 5308fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 5318fac9c7bSMasahiro Yamada my ($parameter); 5328fac9c7bSMasahiro Yamada my $count; 5338fac9c7bSMasahiro Yamada print "<h2>enum " . $args{'enum'} . "</h2>\n"; 5348fac9c7bSMasahiro Yamada 5358fac9c7bSMasahiro Yamada print "<b>enum " . $args{'enum'} . "</b> {<br>\n"; 5368fac9c7bSMasahiro Yamada $count = 0; 5378fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 5388fac9c7bSMasahiro Yamada print " <b>" . $parameter . "</b>"; 5398fac9c7bSMasahiro Yamada if ($count != $#{$args{'parameterlist'}}) { 5408fac9c7bSMasahiro Yamada $count++; 5418fac9c7bSMasahiro Yamada print ",\n"; 5428fac9c7bSMasahiro Yamada } 5438fac9c7bSMasahiro Yamada print "<br>"; 5448fac9c7bSMasahiro Yamada } 5458fac9c7bSMasahiro Yamada print "};<br>\n"; 5468fac9c7bSMasahiro Yamada 5478fac9c7bSMasahiro Yamada print "<h3>Constants</h3>\n"; 5488fac9c7bSMasahiro Yamada print "<dl>\n"; 5498fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 5508fac9c7bSMasahiro Yamada print "<dt><b>" . $parameter . "</b>\n"; 5518fac9c7bSMasahiro Yamada print "<dd>"; 5528fac9c7bSMasahiro Yamada output_highlight($args{'parameterdescs'}{$parameter}); 5538fac9c7bSMasahiro Yamada } 5548fac9c7bSMasahiro Yamada print "</dl>\n"; 5558fac9c7bSMasahiro Yamada output_section_html(@_); 5568fac9c7bSMasahiro Yamada print "<hr>\n"; 5578fac9c7bSMasahiro Yamada} 5588fac9c7bSMasahiro Yamada 5598fac9c7bSMasahiro Yamada# output typedef in html 5608fac9c7bSMasahiro Yamadasub output_typedef_html(%) { 5618fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 5628fac9c7bSMasahiro Yamada my ($parameter); 5638fac9c7bSMasahiro Yamada my $count; 5648fac9c7bSMasahiro Yamada print "<h2>typedef " . $args{'typedef'} . "</h2>\n"; 5658fac9c7bSMasahiro Yamada 5668fac9c7bSMasahiro Yamada print "<b>typedef " . $args{'typedef'} . "</b>\n"; 5678fac9c7bSMasahiro Yamada output_section_html(@_); 5688fac9c7bSMasahiro Yamada print "<hr>\n"; 5698fac9c7bSMasahiro Yamada} 5708fac9c7bSMasahiro Yamada 5718fac9c7bSMasahiro Yamada# output struct in html 5728fac9c7bSMasahiro Yamadasub output_struct_html(%) { 5738fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 5748fac9c7bSMasahiro Yamada my ($parameter); 5758fac9c7bSMasahiro Yamada 5768fac9c7bSMasahiro Yamada print "<h2>" . $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "</h2>\n"; 5778fac9c7bSMasahiro Yamada print "<b>" . $args{'type'} . " " . $args{'struct'} . "</b> {<br>\n"; 5788fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 5798fac9c7bSMasahiro Yamada if ($parameter =~ /^#/) { 5808fac9c7bSMasahiro Yamada print "$parameter<br>\n"; 5818fac9c7bSMasahiro Yamada next; 5828fac9c7bSMasahiro Yamada } 5838fac9c7bSMasahiro Yamada my $parameter_name = $parameter; 5848fac9c7bSMasahiro Yamada $parameter_name =~ s/\[.*//; 5858fac9c7bSMasahiro Yamada 5868fac9c7bSMasahiro Yamada ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 5878fac9c7bSMasahiro Yamada $type = $args{'parametertypes'}{$parameter}; 5888fac9c7bSMasahiro Yamada if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 5898fac9c7bSMasahiro Yamada # pointer-to-function 5908fac9c7bSMasahiro Yamada print " <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>\n"; 5918fac9c7bSMasahiro Yamada } elsif ($type =~ m/^(.*?)\s*(:.*)/) { 5928fac9c7bSMasahiro Yamada # bitfield 5938fac9c7bSMasahiro Yamada print " <i>$1</i> <b>$parameter</b>$2;<br>\n"; 5948fac9c7bSMasahiro Yamada } else { 5958fac9c7bSMasahiro Yamada print " <i>$type</i> <b>$parameter</b>;<br>\n"; 5968fac9c7bSMasahiro Yamada } 5978fac9c7bSMasahiro Yamada } 5988fac9c7bSMasahiro Yamada print "};<br>\n"; 5998fac9c7bSMasahiro Yamada 6008fac9c7bSMasahiro Yamada print "<h3>Members</h3>\n"; 6018fac9c7bSMasahiro Yamada print "<dl>\n"; 6028fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 6038fac9c7bSMasahiro Yamada ($parameter =~ /^#/) && next; 6048fac9c7bSMasahiro Yamada 6058fac9c7bSMasahiro Yamada my $parameter_name = $parameter; 6068fac9c7bSMasahiro Yamada $parameter_name =~ s/\[.*//; 6078fac9c7bSMasahiro Yamada 6088fac9c7bSMasahiro Yamada ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 6098fac9c7bSMasahiro Yamada print "<dt><b>" . $parameter . "</b>\n"; 6108fac9c7bSMasahiro Yamada print "<dd>"; 6118fac9c7bSMasahiro Yamada output_highlight($args{'parameterdescs'}{$parameter_name}); 6128fac9c7bSMasahiro Yamada } 6138fac9c7bSMasahiro Yamada print "</dl>\n"; 6148fac9c7bSMasahiro Yamada output_section_html(@_); 6158fac9c7bSMasahiro Yamada print "<hr>\n"; 6168fac9c7bSMasahiro Yamada} 6178fac9c7bSMasahiro Yamada 6188fac9c7bSMasahiro Yamada# output function in html 6198fac9c7bSMasahiro Yamadasub output_function_html(%) { 6208fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 6218fac9c7bSMasahiro Yamada my ($parameter, $section); 6228fac9c7bSMasahiro Yamada my $count; 6238fac9c7bSMasahiro Yamada 6248fac9c7bSMasahiro Yamada print "<h2>" . $args{'function'} . " - " . $args{'purpose'} . "</h2>\n"; 6258fac9c7bSMasahiro Yamada print "<i>" . $args{'functiontype'} . "</i>\n"; 6268fac9c7bSMasahiro Yamada print "<b>" . $args{'function'} . "</b>\n"; 6278fac9c7bSMasahiro Yamada print "("; 6288fac9c7bSMasahiro Yamada $count = 0; 6298fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 6308fac9c7bSMasahiro Yamada $type = $args{'parametertypes'}{$parameter}; 6318fac9c7bSMasahiro Yamada if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 6328fac9c7bSMasahiro Yamada # pointer-to-function 6338fac9c7bSMasahiro Yamada print "<i>$1</i><b>$parameter</b>) <i>($2)</i>"; 6348fac9c7bSMasahiro Yamada } else { 6358fac9c7bSMasahiro Yamada print "<i>" . $type . "</i> <b>" . $parameter . "</b>"; 6368fac9c7bSMasahiro Yamada } 6378fac9c7bSMasahiro Yamada if ($count != $#{$args{'parameterlist'}}) { 6388fac9c7bSMasahiro Yamada $count++; 6398fac9c7bSMasahiro Yamada print ",\n"; 6408fac9c7bSMasahiro Yamada } 6418fac9c7bSMasahiro Yamada } 6428fac9c7bSMasahiro Yamada print ")\n"; 6438fac9c7bSMasahiro Yamada 6448fac9c7bSMasahiro Yamada print "<h3>Arguments</h3>\n"; 6458fac9c7bSMasahiro Yamada print "<dl>\n"; 6468fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 6478fac9c7bSMasahiro Yamada my $parameter_name = $parameter; 6488fac9c7bSMasahiro Yamada $parameter_name =~ s/\[.*//; 6498fac9c7bSMasahiro Yamada 6508fac9c7bSMasahiro Yamada ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 6518fac9c7bSMasahiro Yamada print "<dt><b>" . $parameter . "</b>\n"; 6528fac9c7bSMasahiro Yamada print "<dd>"; 6538fac9c7bSMasahiro Yamada output_highlight($args{'parameterdescs'}{$parameter_name}); 6548fac9c7bSMasahiro Yamada } 6558fac9c7bSMasahiro Yamada print "</dl>\n"; 6568fac9c7bSMasahiro Yamada output_section_html(@_); 6578fac9c7bSMasahiro Yamada print "<hr>\n"; 6588fac9c7bSMasahiro Yamada} 6598fac9c7bSMasahiro Yamada 6608fac9c7bSMasahiro Yamada# output DOC: block header in html 6618fac9c7bSMasahiro Yamadasub output_blockhead_html(%) { 6628fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 6638fac9c7bSMasahiro Yamada my ($parameter, $section); 6648fac9c7bSMasahiro Yamada my $count; 6658fac9c7bSMasahiro Yamada 6668fac9c7bSMasahiro Yamada foreach $section (@{$args{'sectionlist'}}) { 6678fac9c7bSMasahiro Yamada print "<h3>$section</h3>\n"; 6688fac9c7bSMasahiro Yamada print "<ul>\n"; 6698fac9c7bSMasahiro Yamada output_highlight($args{'sections'}{$section}); 6708fac9c7bSMasahiro Yamada print "</ul>\n"; 6718fac9c7bSMasahiro Yamada } 6728fac9c7bSMasahiro Yamada print "<hr>\n"; 6738fac9c7bSMasahiro Yamada} 6748fac9c7bSMasahiro Yamada 6758fac9c7bSMasahiro Yamada# output sections in html5 6768fac9c7bSMasahiro Yamadasub output_section_html5(%) { 6778fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 6788fac9c7bSMasahiro Yamada my $section; 6798fac9c7bSMasahiro Yamada 6808fac9c7bSMasahiro Yamada foreach $section (@{$args{'sectionlist'}}) { 6818fac9c7bSMasahiro Yamada print "<section>\n"; 6828fac9c7bSMasahiro Yamada print "<h1>$section</h1>\n"; 6838fac9c7bSMasahiro Yamada print "<p>\n"; 6848fac9c7bSMasahiro Yamada output_highlight($args{'sections'}{$section}); 6858fac9c7bSMasahiro Yamada print "</p>\n"; 6868fac9c7bSMasahiro Yamada print "</section>\n"; 6878fac9c7bSMasahiro Yamada } 6888fac9c7bSMasahiro Yamada} 6898fac9c7bSMasahiro Yamada 6908fac9c7bSMasahiro Yamada# output enum in html5 6918fac9c7bSMasahiro Yamadasub output_enum_html5(%) { 6928fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 6938fac9c7bSMasahiro Yamada my ($parameter); 6948fac9c7bSMasahiro Yamada my $count; 6958fac9c7bSMasahiro Yamada my $html5id; 6968fac9c7bSMasahiro Yamada 6978fac9c7bSMasahiro Yamada $html5id = $args{'enum'}; 6988fac9c7bSMasahiro Yamada $html5id =~ s/[^a-zA-Z0-9\-]+/_/g; 6998fac9c7bSMasahiro Yamada print "<article class=\"enum\" id=\"enum:". $html5id . "\">"; 7008fac9c7bSMasahiro Yamada print "<h1>enum " . $args{'enum'} . "</h1>\n"; 7018fac9c7bSMasahiro Yamada print "<ol class=\"code\">\n"; 7028fac9c7bSMasahiro Yamada print "<li>"; 7038fac9c7bSMasahiro Yamada print "<span class=\"keyword\">enum</span> "; 7048fac9c7bSMasahiro Yamada print "<span class=\"identifier\">" . $args{'enum'} . "</span> {"; 7058fac9c7bSMasahiro Yamada print "</li>\n"; 7068fac9c7bSMasahiro Yamada $count = 0; 7078fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 7088fac9c7bSMasahiro Yamada print "<li class=\"indent\">"; 7098fac9c7bSMasahiro Yamada print "<span class=\"param\">" . $parameter . "</span>"; 7108fac9c7bSMasahiro Yamada if ($count != $#{$args{'parameterlist'}}) { 7118fac9c7bSMasahiro Yamada $count++; 7128fac9c7bSMasahiro Yamada print ","; 7138fac9c7bSMasahiro Yamada } 7148fac9c7bSMasahiro Yamada print "</li>\n"; 7158fac9c7bSMasahiro Yamada } 7168fac9c7bSMasahiro Yamada print "<li>};</li>\n"; 7178fac9c7bSMasahiro Yamada print "</ol>\n"; 7188fac9c7bSMasahiro Yamada 7198fac9c7bSMasahiro Yamada print "<section>\n"; 7208fac9c7bSMasahiro Yamada print "<h1>Constants</h1>\n"; 7218fac9c7bSMasahiro Yamada print "<dl>\n"; 7228fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 7238fac9c7bSMasahiro Yamada print "<dt>" . $parameter . "</dt>\n"; 7248fac9c7bSMasahiro Yamada print "<dd>"; 7258fac9c7bSMasahiro Yamada output_highlight($args{'parameterdescs'}{$parameter}); 7268fac9c7bSMasahiro Yamada print "</dd>\n"; 7278fac9c7bSMasahiro Yamada } 7288fac9c7bSMasahiro Yamada print "</dl>\n"; 7298fac9c7bSMasahiro Yamada print "</section>\n"; 7308fac9c7bSMasahiro Yamada output_section_html5(@_); 7318fac9c7bSMasahiro Yamada print "</article>\n"; 7328fac9c7bSMasahiro Yamada} 7338fac9c7bSMasahiro Yamada 7348fac9c7bSMasahiro Yamada# output typedef in html5 7358fac9c7bSMasahiro Yamadasub output_typedef_html5(%) { 7368fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 7378fac9c7bSMasahiro Yamada my ($parameter); 7388fac9c7bSMasahiro Yamada my $count; 7398fac9c7bSMasahiro Yamada my $html5id; 7408fac9c7bSMasahiro Yamada 7418fac9c7bSMasahiro Yamada $html5id = $args{'typedef'}; 7428fac9c7bSMasahiro Yamada $html5id =~ s/[^a-zA-Z0-9\-]+/_/g; 7438fac9c7bSMasahiro Yamada print "<article class=\"typedef\" id=\"typedef:" . $html5id . "\">\n"; 7448fac9c7bSMasahiro Yamada print "<h1>typedef " . $args{'typedef'} . "</h1>\n"; 7458fac9c7bSMasahiro Yamada 7468fac9c7bSMasahiro Yamada print "<ol class=\"code\">\n"; 7478fac9c7bSMasahiro Yamada print "<li>"; 7488fac9c7bSMasahiro Yamada print "<span class=\"keyword\">typedef</span> "; 7498fac9c7bSMasahiro Yamada print "<span class=\"identifier\">" . $args{'typedef'} . "</span>"; 7508fac9c7bSMasahiro Yamada print "</li>\n"; 7518fac9c7bSMasahiro Yamada print "</ol>\n"; 7528fac9c7bSMasahiro Yamada output_section_html5(@_); 7538fac9c7bSMasahiro Yamada print "</article>\n"; 7548fac9c7bSMasahiro Yamada} 7558fac9c7bSMasahiro Yamada 7568fac9c7bSMasahiro Yamada# output struct in html5 7578fac9c7bSMasahiro Yamadasub output_struct_html5(%) { 7588fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 7598fac9c7bSMasahiro Yamada my ($parameter); 7608fac9c7bSMasahiro Yamada my $html5id; 7618fac9c7bSMasahiro Yamada 7628fac9c7bSMasahiro Yamada $html5id = $args{'struct'}; 7638fac9c7bSMasahiro Yamada $html5id =~ s/[^a-zA-Z0-9\-]+/_/g; 7648fac9c7bSMasahiro Yamada print "<article class=\"struct\" id=\"struct:" . $html5id . "\">\n"; 7658fac9c7bSMasahiro Yamada print "<hgroup>\n"; 7668fac9c7bSMasahiro Yamada print "<h1>" . $args{'type'} . " " . $args{'struct'} . "</h1>"; 7678fac9c7bSMasahiro Yamada print "<h2>". $args{'purpose'} . "</h2>\n"; 7688fac9c7bSMasahiro Yamada print "</hgroup>\n"; 7698fac9c7bSMasahiro Yamada print "<ol class=\"code\">\n"; 7708fac9c7bSMasahiro Yamada print "<li>"; 7718fac9c7bSMasahiro Yamada print "<span class=\"type\">" . $args{'type'} . "</span> "; 7728fac9c7bSMasahiro Yamada print "<span class=\"identifier\">" . $args{'struct'} . "</span> {"; 7738fac9c7bSMasahiro Yamada print "</li>\n"; 7748fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 7758fac9c7bSMasahiro Yamada print "<li class=\"indent\">"; 7768fac9c7bSMasahiro Yamada if ($parameter =~ /^#/) { 7778fac9c7bSMasahiro Yamada print "<span class=\"param\">" . $parameter ."</span>\n"; 7788fac9c7bSMasahiro Yamada print "</li>\n"; 7798fac9c7bSMasahiro Yamada next; 7808fac9c7bSMasahiro Yamada } 7818fac9c7bSMasahiro Yamada my $parameter_name = $parameter; 7828fac9c7bSMasahiro Yamada $parameter_name =~ s/\[.*//; 7838fac9c7bSMasahiro Yamada 7848fac9c7bSMasahiro Yamada ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 7858fac9c7bSMasahiro Yamada $type = $args{'parametertypes'}{$parameter}; 7868fac9c7bSMasahiro Yamada if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 7878fac9c7bSMasahiro Yamada # pointer-to-function 7888fac9c7bSMasahiro Yamada print "<span class=\"type\">$1</span> "; 7898fac9c7bSMasahiro Yamada print "<span class=\"param\">$parameter</span>"; 7908fac9c7bSMasahiro Yamada print "<span class=\"type\">)</span> "; 7918fac9c7bSMasahiro Yamada print "(<span class=\"args\">$2</span>);"; 7928fac9c7bSMasahiro Yamada } elsif ($type =~ m/^(.*?)\s*(:.*)/) { 7938fac9c7bSMasahiro Yamada # bitfield 7948fac9c7bSMasahiro Yamada print "<span class=\"type\">$1</span> "; 7958fac9c7bSMasahiro Yamada print "<span class=\"param\">$parameter</span>"; 7968fac9c7bSMasahiro Yamada print "<span class=\"bits\">$2</span>;"; 7978fac9c7bSMasahiro Yamada } else { 7988fac9c7bSMasahiro Yamada print "<span class=\"type\">$type</span> "; 7998fac9c7bSMasahiro Yamada print "<span class=\"param\">$parameter</span>;"; 8008fac9c7bSMasahiro Yamada } 8018fac9c7bSMasahiro Yamada print "</li>\n"; 8028fac9c7bSMasahiro Yamada } 8038fac9c7bSMasahiro Yamada print "<li>};</li>\n"; 8048fac9c7bSMasahiro Yamada print "</ol>\n"; 8058fac9c7bSMasahiro Yamada 8068fac9c7bSMasahiro Yamada print "<section>\n"; 8078fac9c7bSMasahiro Yamada print "<h1>Members</h1>\n"; 8088fac9c7bSMasahiro Yamada print "<dl>\n"; 8098fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 8108fac9c7bSMasahiro Yamada ($parameter =~ /^#/) && next; 8118fac9c7bSMasahiro Yamada 8128fac9c7bSMasahiro Yamada my $parameter_name = $parameter; 8138fac9c7bSMasahiro Yamada $parameter_name =~ s/\[.*//; 8148fac9c7bSMasahiro Yamada 8158fac9c7bSMasahiro Yamada ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 8168fac9c7bSMasahiro Yamada print "<dt>" . $parameter . "</dt>\n"; 8178fac9c7bSMasahiro Yamada print "<dd>"; 8188fac9c7bSMasahiro Yamada output_highlight($args{'parameterdescs'}{$parameter_name}); 8198fac9c7bSMasahiro Yamada print "</dd>\n"; 8208fac9c7bSMasahiro Yamada } 8218fac9c7bSMasahiro Yamada print "</dl>\n"; 8228fac9c7bSMasahiro Yamada print "</section>\n"; 8238fac9c7bSMasahiro Yamada output_section_html5(@_); 8248fac9c7bSMasahiro Yamada print "</article>\n"; 8258fac9c7bSMasahiro Yamada} 8268fac9c7bSMasahiro Yamada 8278fac9c7bSMasahiro Yamada# output function in html5 8288fac9c7bSMasahiro Yamadasub output_function_html5(%) { 8298fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 8308fac9c7bSMasahiro Yamada my ($parameter, $section); 8318fac9c7bSMasahiro Yamada my $count; 8328fac9c7bSMasahiro Yamada my $html5id; 8338fac9c7bSMasahiro Yamada 8348fac9c7bSMasahiro Yamada $html5id = $args{'function'}; 8358fac9c7bSMasahiro Yamada $html5id =~ s/[^a-zA-Z0-9\-]+/_/g; 8368fac9c7bSMasahiro Yamada print "<article class=\"function\" id=\"func:". $html5id . "\">\n"; 8378fac9c7bSMasahiro Yamada print "<hgroup>\n"; 8388fac9c7bSMasahiro Yamada print "<h1>" . $args{'function'} . "</h1>"; 8398fac9c7bSMasahiro Yamada print "<h2>" . $args{'purpose'} . "</h2>\n"; 8408fac9c7bSMasahiro Yamada print "</hgroup>\n"; 8418fac9c7bSMasahiro Yamada print "<ol class=\"code\">\n"; 8428fac9c7bSMasahiro Yamada print "<li>"; 8438fac9c7bSMasahiro Yamada print "<span class=\"type\">" . $args{'functiontype'} . "</span> "; 8448fac9c7bSMasahiro Yamada print "<span class=\"identifier\">" . $args{'function'} . "</span> ("; 8458fac9c7bSMasahiro Yamada print "</li>"; 8468fac9c7bSMasahiro Yamada $count = 0; 8478fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 8488fac9c7bSMasahiro Yamada print "<li class=\"indent\">"; 8498fac9c7bSMasahiro Yamada $type = $args{'parametertypes'}{$parameter}; 8508fac9c7bSMasahiro Yamada if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 8518fac9c7bSMasahiro Yamada # pointer-to-function 8528fac9c7bSMasahiro Yamada print "<span class=\"type\">$1</span> "; 8538fac9c7bSMasahiro Yamada print "<span class=\"param\">$parameter</span>"; 8548fac9c7bSMasahiro Yamada print "<span class=\"type\">)</span> "; 8558fac9c7bSMasahiro Yamada print "(<span class=\"args\">$2</span>)"; 8568fac9c7bSMasahiro Yamada } else { 8578fac9c7bSMasahiro Yamada print "<span class=\"type\">$type</span> "; 8588fac9c7bSMasahiro Yamada print "<span class=\"param\">$parameter</span>"; 8598fac9c7bSMasahiro Yamada } 8608fac9c7bSMasahiro Yamada if ($count != $#{$args{'parameterlist'}}) { 8618fac9c7bSMasahiro Yamada $count++; 8628fac9c7bSMasahiro Yamada print ","; 8638fac9c7bSMasahiro Yamada } 8648fac9c7bSMasahiro Yamada print "</li>\n"; 8658fac9c7bSMasahiro Yamada } 8668fac9c7bSMasahiro Yamada print "<li>)</li>\n"; 8678fac9c7bSMasahiro Yamada print "</ol>\n"; 8688fac9c7bSMasahiro Yamada 8698fac9c7bSMasahiro Yamada print "<section>\n"; 8708fac9c7bSMasahiro Yamada print "<h1>Arguments</h1>\n"; 8718fac9c7bSMasahiro Yamada print "<p>\n"; 8728fac9c7bSMasahiro Yamada print "<dl>\n"; 8738fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 8748fac9c7bSMasahiro Yamada my $parameter_name = $parameter; 8758fac9c7bSMasahiro Yamada $parameter_name =~ s/\[.*//; 8768fac9c7bSMasahiro Yamada 8778fac9c7bSMasahiro Yamada ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 8788fac9c7bSMasahiro Yamada print "<dt>" . $parameter . "</dt>\n"; 8798fac9c7bSMasahiro Yamada print "<dd>"; 8808fac9c7bSMasahiro Yamada output_highlight($args{'parameterdescs'}{$parameter_name}); 8818fac9c7bSMasahiro Yamada print "</dd>\n"; 8828fac9c7bSMasahiro Yamada } 8838fac9c7bSMasahiro Yamada print "</dl>\n"; 8848fac9c7bSMasahiro Yamada print "</section>\n"; 8858fac9c7bSMasahiro Yamada output_section_html5(@_); 8868fac9c7bSMasahiro Yamada print "</article>\n"; 8878fac9c7bSMasahiro Yamada} 8888fac9c7bSMasahiro Yamada 8898fac9c7bSMasahiro Yamada# output DOC: block header in html5 8908fac9c7bSMasahiro Yamadasub output_blockhead_html5(%) { 8918fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 8928fac9c7bSMasahiro Yamada my ($parameter, $section); 8938fac9c7bSMasahiro Yamada my $count; 8948fac9c7bSMasahiro Yamada my $html5id; 8958fac9c7bSMasahiro Yamada 8968fac9c7bSMasahiro Yamada foreach $section (@{$args{'sectionlist'}}) { 8978fac9c7bSMasahiro Yamada $html5id = $section; 8988fac9c7bSMasahiro Yamada $html5id =~ s/[^a-zA-Z0-9\-]+/_/g; 8998fac9c7bSMasahiro Yamada print "<article class=\"doc\" id=\"doc:". $html5id . "\">\n"; 9008fac9c7bSMasahiro Yamada print "<h1>$section</h1>\n"; 9018fac9c7bSMasahiro Yamada print "<p>\n"; 9028fac9c7bSMasahiro Yamada output_highlight($args{'sections'}{$section}); 9038fac9c7bSMasahiro Yamada print "</p>\n"; 9048fac9c7bSMasahiro Yamada } 9058fac9c7bSMasahiro Yamada print "</article>\n"; 9068fac9c7bSMasahiro Yamada} 9078fac9c7bSMasahiro Yamada 9088fac9c7bSMasahiro Yamadasub output_section_xml(%) { 9098fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 9108fac9c7bSMasahiro Yamada my $section; 9118fac9c7bSMasahiro Yamada # print out each section 9128fac9c7bSMasahiro Yamada $lineprefix=" "; 9138fac9c7bSMasahiro Yamada foreach $section (@{$args{'sectionlist'}}) { 9148fac9c7bSMasahiro Yamada print "<refsect1>\n"; 9158fac9c7bSMasahiro Yamada print "<title>$section</title>\n"; 9168fac9c7bSMasahiro Yamada if ($section =~ m/EXAMPLE/i) { 9178fac9c7bSMasahiro Yamada print "<informalexample><programlisting>\n"; 918ced03298SMasahiro Yamada $output_preformatted = 1; 9198fac9c7bSMasahiro Yamada } else { 9208fac9c7bSMasahiro Yamada print "<para>\n"; 9218fac9c7bSMasahiro Yamada } 9228fac9c7bSMasahiro Yamada output_highlight($args{'sections'}{$section}); 923ced03298SMasahiro Yamada $output_preformatted = 0; 9248fac9c7bSMasahiro Yamada if ($section =~ m/EXAMPLE/i) { 9258fac9c7bSMasahiro Yamada print "</programlisting></informalexample>\n"; 9268fac9c7bSMasahiro Yamada } else { 9278fac9c7bSMasahiro Yamada print "</para>\n"; 9288fac9c7bSMasahiro Yamada } 9298fac9c7bSMasahiro Yamada print "</refsect1>\n"; 9308fac9c7bSMasahiro Yamada } 9318fac9c7bSMasahiro Yamada} 9328fac9c7bSMasahiro Yamada 9338fac9c7bSMasahiro Yamada# output function in XML DocBook 9348fac9c7bSMasahiro Yamadasub output_function_xml(%) { 9358fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 9368fac9c7bSMasahiro Yamada my ($parameter, $section); 9378fac9c7bSMasahiro Yamada my $count; 9388fac9c7bSMasahiro Yamada my $id; 9398fac9c7bSMasahiro Yamada 9408fac9c7bSMasahiro Yamada $id = "API-" . $args{'function'}; 9418fac9c7bSMasahiro Yamada $id =~ s/[^A-Za-z0-9]/-/g; 9428fac9c7bSMasahiro Yamada 9438fac9c7bSMasahiro Yamada print "<refentry id=\"$id\">\n"; 9448fac9c7bSMasahiro Yamada print "<refentryinfo>\n"; 9458fac9c7bSMasahiro Yamada print " <title>U-BOOT</title>\n"; 9468fac9c7bSMasahiro Yamada print " <productname>Bootloader Hackers Manual</productname>\n"; 9478fac9c7bSMasahiro Yamada print " <date>$man_date</date>\n"; 9488fac9c7bSMasahiro Yamada print "</refentryinfo>\n"; 9498fac9c7bSMasahiro Yamada print "<refmeta>\n"; 9508fac9c7bSMasahiro Yamada print " <refentrytitle><phrase>" . $args{'function'} . "</phrase></refentrytitle>\n"; 9518fac9c7bSMasahiro Yamada print " <manvolnum>9</manvolnum>\n"; 9528fac9c7bSMasahiro Yamada print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n"; 9538fac9c7bSMasahiro Yamada print "</refmeta>\n"; 9548fac9c7bSMasahiro Yamada print "<refnamediv>\n"; 9558fac9c7bSMasahiro Yamada print " <refname>" . $args{'function'} . "</refname>\n"; 9568fac9c7bSMasahiro Yamada print " <refpurpose>\n"; 9578fac9c7bSMasahiro Yamada print " "; 9588fac9c7bSMasahiro Yamada output_highlight ($args{'purpose'}); 9598fac9c7bSMasahiro Yamada print " </refpurpose>\n"; 9608fac9c7bSMasahiro Yamada print "</refnamediv>\n"; 9618fac9c7bSMasahiro Yamada 9628fac9c7bSMasahiro Yamada print "<refsynopsisdiv>\n"; 9638fac9c7bSMasahiro Yamada print " <title>Synopsis</title>\n"; 9648fac9c7bSMasahiro Yamada print " <funcsynopsis><funcprototype>\n"; 9658fac9c7bSMasahiro Yamada print " <funcdef>" . $args{'functiontype'} . " "; 9668fac9c7bSMasahiro Yamada print "<function>" . $args{'function'} . " </function></funcdef>\n"; 9678fac9c7bSMasahiro Yamada 9688fac9c7bSMasahiro Yamada $count = 0; 9698fac9c7bSMasahiro Yamada if ($#{$args{'parameterlist'}} >= 0) { 9708fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 9718fac9c7bSMasahiro Yamada $type = $args{'parametertypes'}{$parameter}; 9728fac9c7bSMasahiro Yamada if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 9738fac9c7bSMasahiro Yamada # pointer-to-function 9748fac9c7bSMasahiro Yamada print " <paramdef>$1<parameter>$parameter</parameter>)\n"; 9758fac9c7bSMasahiro Yamada print " <funcparams>$2</funcparams></paramdef>\n"; 9768fac9c7bSMasahiro Yamada } else { 9778fac9c7bSMasahiro Yamada print " <paramdef>" . $type; 9788fac9c7bSMasahiro Yamada print " <parameter>$parameter</parameter></paramdef>\n"; 9798fac9c7bSMasahiro Yamada } 9808fac9c7bSMasahiro Yamada } 9818fac9c7bSMasahiro Yamada } else { 9828fac9c7bSMasahiro Yamada print " <void/>\n"; 9838fac9c7bSMasahiro Yamada } 9848fac9c7bSMasahiro Yamada print " </funcprototype></funcsynopsis>\n"; 9858fac9c7bSMasahiro Yamada print "</refsynopsisdiv>\n"; 9868fac9c7bSMasahiro Yamada 9878fac9c7bSMasahiro Yamada # print parameters 9888fac9c7bSMasahiro Yamada print "<refsect1>\n <title>Arguments</title>\n"; 9898fac9c7bSMasahiro Yamada if ($#{$args{'parameterlist'}} >= 0) { 9908fac9c7bSMasahiro Yamada print " <variablelist>\n"; 9918fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 9928fac9c7bSMasahiro Yamada my $parameter_name = $parameter; 9938fac9c7bSMasahiro Yamada $parameter_name =~ s/\[.*//; 9948fac9c7bSMasahiro Yamada 9958fac9c7bSMasahiro Yamada print " <varlistentry>\n <term><parameter>$parameter</parameter></term>\n"; 9968fac9c7bSMasahiro Yamada print " <listitem>\n <para>\n"; 9978fac9c7bSMasahiro Yamada $lineprefix=" "; 9988fac9c7bSMasahiro Yamada output_highlight($args{'parameterdescs'}{$parameter_name}); 9998fac9c7bSMasahiro Yamada print " </para>\n </listitem>\n </varlistentry>\n"; 10008fac9c7bSMasahiro Yamada } 10018fac9c7bSMasahiro Yamada print " </variablelist>\n"; 10028fac9c7bSMasahiro Yamada } else { 10038fac9c7bSMasahiro Yamada print " <para>\n None\n </para>\n"; 10048fac9c7bSMasahiro Yamada } 10058fac9c7bSMasahiro Yamada print "</refsect1>\n"; 10068fac9c7bSMasahiro Yamada 10078fac9c7bSMasahiro Yamada output_section_xml(@_); 10088fac9c7bSMasahiro Yamada print "</refentry>\n\n"; 10098fac9c7bSMasahiro Yamada} 10108fac9c7bSMasahiro Yamada 10118fac9c7bSMasahiro Yamada# output struct in XML DocBook 10128fac9c7bSMasahiro Yamadasub output_struct_xml(%) { 10138fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 10148fac9c7bSMasahiro Yamada my ($parameter, $section); 10158fac9c7bSMasahiro Yamada my $id; 10168fac9c7bSMasahiro Yamada 10178fac9c7bSMasahiro Yamada $id = "API-struct-" . $args{'struct'}; 10188fac9c7bSMasahiro Yamada $id =~ s/[^A-Za-z0-9]/-/g; 10198fac9c7bSMasahiro Yamada 10208fac9c7bSMasahiro Yamada print "<refentry id=\"$id\">\n"; 10218fac9c7bSMasahiro Yamada print "<refentryinfo>\n"; 10228fac9c7bSMasahiro Yamada print " <title>U-BOOT</title>\n"; 10238fac9c7bSMasahiro Yamada print " <productname>Bootloader Hackers Manual</productname>\n"; 10248fac9c7bSMasahiro Yamada print " <date>$man_date</date>\n"; 10258fac9c7bSMasahiro Yamada print "</refentryinfo>\n"; 10268fac9c7bSMasahiro Yamada print "<refmeta>\n"; 10278fac9c7bSMasahiro Yamada print " <refentrytitle><phrase>" . $args{'type'} . " " . $args{'struct'} . "</phrase></refentrytitle>\n"; 10288fac9c7bSMasahiro Yamada print " <manvolnum>9</manvolnum>\n"; 10298fac9c7bSMasahiro Yamada print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n"; 10308fac9c7bSMasahiro Yamada print "</refmeta>\n"; 10318fac9c7bSMasahiro Yamada print "<refnamediv>\n"; 10328fac9c7bSMasahiro Yamada print " <refname>" . $args{'type'} . " " . $args{'struct'} . "</refname>\n"; 10338fac9c7bSMasahiro Yamada print " <refpurpose>\n"; 10348fac9c7bSMasahiro Yamada print " "; 10358fac9c7bSMasahiro Yamada output_highlight ($args{'purpose'}); 10368fac9c7bSMasahiro Yamada print " </refpurpose>\n"; 10378fac9c7bSMasahiro Yamada print "</refnamediv>\n"; 10388fac9c7bSMasahiro Yamada 10398fac9c7bSMasahiro Yamada print "<refsynopsisdiv>\n"; 10408fac9c7bSMasahiro Yamada print " <title>Synopsis</title>\n"; 10418fac9c7bSMasahiro Yamada print " <programlisting>\n"; 10428fac9c7bSMasahiro Yamada print $args{'type'} . " " . $args{'struct'} . " {\n"; 10438fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 10448fac9c7bSMasahiro Yamada if ($parameter =~ /^#/) { 10458fac9c7bSMasahiro Yamada my $prm = $parameter; 10468fac9c7bSMasahiro Yamada # convert data read & converted thru xml_escape() into &xyz; format: 10478fac9c7bSMasahiro Yamada # This allows us to have #define macros interspersed in a struct. 10488fac9c7bSMasahiro Yamada $prm =~ s/\\\\\\/\&/g; 10498fac9c7bSMasahiro Yamada print "$prm\n"; 10508fac9c7bSMasahiro Yamada next; 10518fac9c7bSMasahiro Yamada } 10528fac9c7bSMasahiro Yamada 10538fac9c7bSMasahiro Yamada my $parameter_name = $parameter; 10548fac9c7bSMasahiro Yamada $parameter_name =~ s/\[.*//; 10558fac9c7bSMasahiro Yamada 10568fac9c7bSMasahiro Yamada defined($args{'parameterdescs'}{$parameter_name}) || next; 10578fac9c7bSMasahiro Yamada ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 10588fac9c7bSMasahiro Yamada $type = $args{'parametertypes'}{$parameter}; 10598fac9c7bSMasahiro Yamada if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 10608fac9c7bSMasahiro Yamada # pointer-to-function 10618fac9c7bSMasahiro Yamada print " $1 $parameter) ($2);\n"; 10628fac9c7bSMasahiro Yamada } elsif ($type =~ m/^(.*?)\s*(:.*)/) { 10638fac9c7bSMasahiro Yamada # bitfield 10648fac9c7bSMasahiro Yamada print " $1 $parameter$2;\n"; 10658fac9c7bSMasahiro Yamada } else { 10668fac9c7bSMasahiro Yamada print " " . $type . " " . $parameter . ";\n"; 10678fac9c7bSMasahiro Yamada } 10688fac9c7bSMasahiro Yamada } 10698fac9c7bSMasahiro Yamada print "};"; 10708fac9c7bSMasahiro Yamada print " </programlisting>\n"; 10718fac9c7bSMasahiro Yamada print "</refsynopsisdiv>\n"; 10728fac9c7bSMasahiro Yamada 10738fac9c7bSMasahiro Yamada print " <refsect1>\n"; 10748fac9c7bSMasahiro Yamada print " <title>Members</title>\n"; 10758fac9c7bSMasahiro Yamada 10768fac9c7bSMasahiro Yamada if ($#{$args{'parameterlist'}} >= 0) { 10778fac9c7bSMasahiro Yamada print " <variablelist>\n"; 10788fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 10798fac9c7bSMasahiro Yamada ($parameter =~ /^#/) && next; 10808fac9c7bSMasahiro Yamada 10818fac9c7bSMasahiro Yamada my $parameter_name = $parameter; 10828fac9c7bSMasahiro Yamada $parameter_name =~ s/\[.*//; 10838fac9c7bSMasahiro Yamada 10848fac9c7bSMasahiro Yamada defined($args{'parameterdescs'}{$parameter_name}) || next; 10858fac9c7bSMasahiro Yamada ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 10868fac9c7bSMasahiro Yamada print " <varlistentry>"; 10878fac9c7bSMasahiro Yamada print " <term>$parameter</term>\n"; 10888fac9c7bSMasahiro Yamada print " <listitem><para>\n"; 10898fac9c7bSMasahiro Yamada output_highlight($args{'parameterdescs'}{$parameter_name}); 10908fac9c7bSMasahiro Yamada print " </para></listitem>\n"; 10918fac9c7bSMasahiro Yamada print " </varlistentry>\n"; 10928fac9c7bSMasahiro Yamada } 10938fac9c7bSMasahiro Yamada print " </variablelist>\n"; 10948fac9c7bSMasahiro Yamada } else { 10958fac9c7bSMasahiro Yamada print " <para>\n None\n </para>\n"; 10968fac9c7bSMasahiro Yamada } 10978fac9c7bSMasahiro Yamada print " </refsect1>\n"; 10988fac9c7bSMasahiro Yamada 10998fac9c7bSMasahiro Yamada output_section_xml(@_); 11008fac9c7bSMasahiro Yamada 11018fac9c7bSMasahiro Yamada print "</refentry>\n\n"; 11028fac9c7bSMasahiro Yamada} 11038fac9c7bSMasahiro Yamada 11048fac9c7bSMasahiro Yamada# output enum in XML DocBook 11058fac9c7bSMasahiro Yamadasub output_enum_xml(%) { 11068fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 11078fac9c7bSMasahiro Yamada my ($parameter, $section); 11088fac9c7bSMasahiro Yamada my $count; 11098fac9c7bSMasahiro Yamada my $id; 11108fac9c7bSMasahiro Yamada 11118fac9c7bSMasahiro Yamada $id = "API-enum-" . $args{'enum'}; 11128fac9c7bSMasahiro Yamada $id =~ s/[^A-Za-z0-9]/-/g; 11138fac9c7bSMasahiro Yamada 11148fac9c7bSMasahiro Yamada print "<refentry id=\"$id\">\n"; 11158fac9c7bSMasahiro Yamada print "<refentryinfo>\n"; 11168fac9c7bSMasahiro Yamada print " <title>U-BOOT</title>\n"; 11178fac9c7bSMasahiro Yamada print " <productname>Bootloader Hackers Manual</productname>\n"; 11188fac9c7bSMasahiro Yamada print " <date>$man_date</date>\n"; 11198fac9c7bSMasahiro Yamada print "</refentryinfo>\n"; 11208fac9c7bSMasahiro Yamada print "<refmeta>\n"; 11218fac9c7bSMasahiro Yamada print " <refentrytitle><phrase>enum " . $args{'enum'} . "</phrase></refentrytitle>\n"; 11228fac9c7bSMasahiro Yamada print " <manvolnum>9</manvolnum>\n"; 11238fac9c7bSMasahiro Yamada print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n"; 11248fac9c7bSMasahiro Yamada print "</refmeta>\n"; 11258fac9c7bSMasahiro Yamada print "<refnamediv>\n"; 11268fac9c7bSMasahiro Yamada print " <refname>enum " . $args{'enum'} . "</refname>\n"; 11278fac9c7bSMasahiro Yamada print " <refpurpose>\n"; 11288fac9c7bSMasahiro Yamada print " "; 11298fac9c7bSMasahiro Yamada output_highlight ($args{'purpose'}); 11308fac9c7bSMasahiro Yamada print " </refpurpose>\n"; 11318fac9c7bSMasahiro Yamada print "</refnamediv>\n"; 11328fac9c7bSMasahiro Yamada 11338fac9c7bSMasahiro Yamada print "<refsynopsisdiv>\n"; 11348fac9c7bSMasahiro Yamada print " <title>Synopsis</title>\n"; 11358fac9c7bSMasahiro Yamada print " <programlisting>\n"; 11368fac9c7bSMasahiro Yamada print "enum " . $args{'enum'} . " {\n"; 11378fac9c7bSMasahiro Yamada $count = 0; 11388fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 11398fac9c7bSMasahiro Yamada print " $parameter"; 11408fac9c7bSMasahiro Yamada if ($count != $#{$args{'parameterlist'}}) { 11418fac9c7bSMasahiro Yamada $count++; 11428fac9c7bSMasahiro Yamada print ","; 11438fac9c7bSMasahiro Yamada } 11448fac9c7bSMasahiro Yamada print "\n"; 11458fac9c7bSMasahiro Yamada } 11468fac9c7bSMasahiro Yamada print "};"; 11478fac9c7bSMasahiro Yamada print " </programlisting>\n"; 11488fac9c7bSMasahiro Yamada print "</refsynopsisdiv>\n"; 11498fac9c7bSMasahiro Yamada 11508fac9c7bSMasahiro Yamada print "<refsect1>\n"; 11518fac9c7bSMasahiro Yamada print " <title>Constants</title>\n"; 11528fac9c7bSMasahiro Yamada print " <variablelist>\n"; 11538fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 11548fac9c7bSMasahiro Yamada my $parameter_name = $parameter; 11558fac9c7bSMasahiro Yamada $parameter_name =~ s/\[.*//; 11568fac9c7bSMasahiro Yamada 11578fac9c7bSMasahiro Yamada print " <varlistentry>"; 11588fac9c7bSMasahiro Yamada print " <term>$parameter</term>\n"; 11598fac9c7bSMasahiro Yamada print " <listitem><para>\n"; 11608fac9c7bSMasahiro Yamada output_highlight($args{'parameterdescs'}{$parameter_name}); 11618fac9c7bSMasahiro Yamada print " </para></listitem>\n"; 11628fac9c7bSMasahiro Yamada print " </varlistentry>\n"; 11638fac9c7bSMasahiro Yamada } 11648fac9c7bSMasahiro Yamada print " </variablelist>\n"; 11658fac9c7bSMasahiro Yamada print "</refsect1>\n"; 11668fac9c7bSMasahiro Yamada 11678fac9c7bSMasahiro Yamada output_section_xml(@_); 11688fac9c7bSMasahiro Yamada 11698fac9c7bSMasahiro Yamada print "</refentry>\n\n"; 11708fac9c7bSMasahiro Yamada} 11718fac9c7bSMasahiro Yamada 11728fac9c7bSMasahiro Yamada# output typedef in XML DocBook 11738fac9c7bSMasahiro Yamadasub output_typedef_xml(%) { 11748fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 11758fac9c7bSMasahiro Yamada my ($parameter, $section); 11768fac9c7bSMasahiro Yamada my $id; 11778fac9c7bSMasahiro Yamada 11788fac9c7bSMasahiro Yamada $id = "API-typedef-" . $args{'typedef'}; 11798fac9c7bSMasahiro Yamada $id =~ s/[^A-Za-z0-9]/-/g; 11808fac9c7bSMasahiro Yamada 11818fac9c7bSMasahiro Yamada print "<refentry id=\"$id\">\n"; 11828fac9c7bSMasahiro Yamada print "<refentryinfo>\n"; 11838fac9c7bSMasahiro Yamada print " <title>U-BOOT</title>\n"; 11848fac9c7bSMasahiro Yamada print " <productname>Bootloader Hackers Manual</productname>\n"; 11858fac9c7bSMasahiro Yamada print " <date>$man_date</date>\n"; 11868fac9c7bSMasahiro Yamada print "</refentryinfo>\n"; 11878fac9c7bSMasahiro Yamada print "<refmeta>\n"; 11888fac9c7bSMasahiro Yamada print " <refentrytitle><phrase>typedef " . $args{'typedef'} . "</phrase></refentrytitle>\n"; 11898fac9c7bSMasahiro Yamada print " <manvolnum>9</manvolnum>\n"; 11908fac9c7bSMasahiro Yamada print "</refmeta>\n"; 11918fac9c7bSMasahiro Yamada print "<refnamediv>\n"; 11928fac9c7bSMasahiro Yamada print " <refname>typedef " . $args{'typedef'} . "</refname>\n"; 11938fac9c7bSMasahiro Yamada print " <refpurpose>\n"; 11948fac9c7bSMasahiro Yamada print " "; 11958fac9c7bSMasahiro Yamada output_highlight ($args{'purpose'}); 11968fac9c7bSMasahiro Yamada print " </refpurpose>\n"; 11978fac9c7bSMasahiro Yamada print "</refnamediv>\n"; 11988fac9c7bSMasahiro Yamada 11998fac9c7bSMasahiro Yamada print "<refsynopsisdiv>\n"; 12008fac9c7bSMasahiro Yamada print " <title>Synopsis</title>\n"; 12018fac9c7bSMasahiro Yamada print " <synopsis>typedef " . $args{'typedef'} . ";</synopsis>\n"; 12028fac9c7bSMasahiro Yamada print "</refsynopsisdiv>\n"; 12038fac9c7bSMasahiro Yamada 12048fac9c7bSMasahiro Yamada output_section_xml(@_); 12058fac9c7bSMasahiro Yamada 12068fac9c7bSMasahiro Yamada print "</refentry>\n\n"; 12078fac9c7bSMasahiro Yamada} 12088fac9c7bSMasahiro Yamada 12098fac9c7bSMasahiro Yamada# output in XML DocBook 12108fac9c7bSMasahiro Yamadasub output_blockhead_xml(%) { 12118fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 12128fac9c7bSMasahiro Yamada my ($parameter, $section); 12138fac9c7bSMasahiro Yamada my $count; 12148fac9c7bSMasahiro Yamada 12158fac9c7bSMasahiro Yamada my $id = $args{'module'}; 12168fac9c7bSMasahiro Yamada $id =~ s/[^A-Za-z0-9]/-/g; 12178fac9c7bSMasahiro Yamada 12188fac9c7bSMasahiro Yamada # print out each section 12198fac9c7bSMasahiro Yamada $lineprefix=" "; 12208fac9c7bSMasahiro Yamada foreach $section (@{$args{'sectionlist'}}) { 12218fac9c7bSMasahiro Yamada if (!$args{'content-only'}) { 12228fac9c7bSMasahiro Yamada print "<refsect1>\n <title>$section</title>\n"; 12238fac9c7bSMasahiro Yamada } 12248fac9c7bSMasahiro Yamada if ($section =~ m/EXAMPLE/i) { 12258fac9c7bSMasahiro Yamada print "<example><para>\n"; 1226ced03298SMasahiro Yamada $output_preformatted = 1; 12278fac9c7bSMasahiro Yamada } else { 12288fac9c7bSMasahiro Yamada print "<para>\n"; 12298fac9c7bSMasahiro Yamada } 12308fac9c7bSMasahiro Yamada output_highlight($args{'sections'}{$section}); 1231ced03298SMasahiro Yamada $output_preformatted = 0; 12328fac9c7bSMasahiro Yamada if ($section =~ m/EXAMPLE/i) { 12338fac9c7bSMasahiro Yamada print "</para></example>\n"; 12348fac9c7bSMasahiro Yamada } else { 12358fac9c7bSMasahiro Yamada print "</para>"; 12368fac9c7bSMasahiro Yamada } 12378fac9c7bSMasahiro Yamada if (!$args{'content-only'}) { 12388fac9c7bSMasahiro Yamada print "\n</refsect1>\n"; 12398fac9c7bSMasahiro Yamada } 12408fac9c7bSMasahiro Yamada } 12418fac9c7bSMasahiro Yamada 12428fac9c7bSMasahiro Yamada print "\n\n"; 12438fac9c7bSMasahiro Yamada} 12448fac9c7bSMasahiro Yamada 12458fac9c7bSMasahiro Yamada# output in XML DocBook 12468fac9c7bSMasahiro Yamadasub output_function_gnome { 12478fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 12488fac9c7bSMasahiro Yamada my ($parameter, $section); 12498fac9c7bSMasahiro Yamada my $count; 12508fac9c7bSMasahiro Yamada my $id; 12518fac9c7bSMasahiro Yamada 12528fac9c7bSMasahiro Yamada $id = $args{'module'} . "-" . $args{'function'}; 12538fac9c7bSMasahiro Yamada $id =~ s/[^A-Za-z0-9]/-/g; 12548fac9c7bSMasahiro Yamada 12558fac9c7bSMasahiro Yamada print "<sect2>\n"; 12568fac9c7bSMasahiro Yamada print " <title id=\"$id\">" . $args{'function'} . "</title>\n"; 12578fac9c7bSMasahiro Yamada 12588fac9c7bSMasahiro Yamada print " <funcsynopsis>\n"; 12598fac9c7bSMasahiro Yamada print " <funcdef>" . $args{'functiontype'} . " "; 12608fac9c7bSMasahiro Yamada print "<function>" . $args{'function'} . " "; 12618fac9c7bSMasahiro Yamada print "</function></funcdef>\n"; 12628fac9c7bSMasahiro Yamada 12638fac9c7bSMasahiro Yamada $count = 0; 12648fac9c7bSMasahiro Yamada if ($#{$args{'parameterlist'}} >= 0) { 12658fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 12668fac9c7bSMasahiro Yamada $type = $args{'parametertypes'}{$parameter}; 12678fac9c7bSMasahiro Yamada if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 12688fac9c7bSMasahiro Yamada # pointer-to-function 12698fac9c7bSMasahiro Yamada print " <paramdef>$1 <parameter>$parameter</parameter>)\n"; 12708fac9c7bSMasahiro Yamada print " <funcparams>$2</funcparams></paramdef>\n"; 12718fac9c7bSMasahiro Yamada } else { 12728fac9c7bSMasahiro Yamada print " <paramdef>" . $type; 12738fac9c7bSMasahiro Yamada print " <parameter>$parameter</parameter></paramdef>\n"; 12748fac9c7bSMasahiro Yamada } 12758fac9c7bSMasahiro Yamada } 12768fac9c7bSMasahiro Yamada } else { 12778fac9c7bSMasahiro Yamada print " <void>\n"; 12788fac9c7bSMasahiro Yamada } 12798fac9c7bSMasahiro Yamada print " </funcsynopsis>\n"; 12808fac9c7bSMasahiro Yamada if ($#{$args{'parameterlist'}} >= 0) { 12818fac9c7bSMasahiro Yamada print " <informaltable pgwide=\"1\" frame=\"none\" role=\"params\">\n"; 12828fac9c7bSMasahiro Yamada print "<tgroup cols=\"2\">\n"; 12838fac9c7bSMasahiro Yamada print "<colspec colwidth=\"2*\">\n"; 12848fac9c7bSMasahiro Yamada print "<colspec colwidth=\"8*\">\n"; 12858fac9c7bSMasahiro Yamada print "<tbody>\n"; 12868fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 12878fac9c7bSMasahiro Yamada my $parameter_name = $parameter; 12888fac9c7bSMasahiro Yamada $parameter_name =~ s/\[.*//; 12898fac9c7bSMasahiro Yamada 12908fac9c7bSMasahiro Yamada print " <row><entry align=\"right\"><parameter>$parameter</parameter></entry>\n"; 12918fac9c7bSMasahiro Yamada print " <entry>\n"; 12928fac9c7bSMasahiro Yamada $lineprefix=" "; 12938fac9c7bSMasahiro Yamada output_highlight($args{'parameterdescs'}{$parameter_name}); 12948fac9c7bSMasahiro Yamada print " </entry></row>\n"; 12958fac9c7bSMasahiro Yamada } 12968fac9c7bSMasahiro Yamada print " </tbody></tgroup></informaltable>\n"; 12978fac9c7bSMasahiro Yamada } else { 12988fac9c7bSMasahiro Yamada print " <para>\n None\n </para>\n"; 12998fac9c7bSMasahiro Yamada } 13008fac9c7bSMasahiro Yamada 13018fac9c7bSMasahiro Yamada # print out each section 13028fac9c7bSMasahiro Yamada $lineprefix=" "; 13038fac9c7bSMasahiro Yamada foreach $section (@{$args{'sectionlist'}}) { 13048fac9c7bSMasahiro Yamada print "<simplesect>\n <title>$section</title>\n"; 13058fac9c7bSMasahiro Yamada if ($section =~ m/EXAMPLE/i) { 13068fac9c7bSMasahiro Yamada print "<example><programlisting>\n"; 1307ced03298SMasahiro Yamada $output_preformatted = 1; 13088fac9c7bSMasahiro Yamada } else { 13098fac9c7bSMasahiro Yamada } 13108fac9c7bSMasahiro Yamada print "<para>\n"; 13118fac9c7bSMasahiro Yamada output_highlight($args{'sections'}{$section}); 1312ced03298SMasahiro Yamada $output_preformatted = 0; 13138fac9c7bSMasahiro Yamada print "</para>\n"; 13148fac9c7bSMasahiro Yamada if ($section =~ m/EXAMPLE/i) { 13158fac9c7bSMasahiro Yamada print "</programlisting></example>\n"; 13168fac9c7bSMasahiro Yamada } else { 13178fac9c7bSMasahiro Yamada } 13188fac9c7bSMasahiro Yamada print " </simplesect>\n"; 13198fac9c7bSMasahiro Yamada } 13208fac9c7bSMasahiro Yamada 13218fac9c7bSMasahiro Yamada print "</sect2>\n\n"; 13228fac9c7bSMasahiro Yamada} 13238fac9c7bSMasahiro Yamada 13248fac9c7bSMasahiro Yamada## 13258fac9c7bSMasahiro Yamada# output function in man 13268fac9c7bSMasahiro Yamadasub output_function_man(%) { 13278fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 13288fac9c7bSMasahiro Yamada my ($parameter, $section); 13298fac9c7bSMasahiro Yamada my $count; 13308fac9c7bSMasahiro Yamada 13318fac9c7bSMasahiro Yamada print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Bootloader Hacker's Manual\" U-BOOT\n"; 13328fac9c7bSMasahiro Yamada 13338fac9c7bSMasahiro Yamada print ".SH NAME\n"; 13348fac9c7bSMasahiro Yamada print $args{'function'} . " \\- " . $args{'purpose'} . "\n"; 13358fac9c7bSMasahiro Yamada 13368fac9c7bSMasahiro Yamada print ".SH SYNOPSIS\n"; 13378fac9c7bSMasahiro Yamada if ($args{'functiontype'} ne "") { 13388fac9c7bSMasahiro Yamada print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n"; 13398fac9c7bSMasahiro Yamada } else { 13408fac9c7bSMasahiro Yamada print ".B \"" . $args{'function'} . "\n"; 13418fac9c7bSMasahiro Yamada } 13428fac9c7bSMasahiro Yamada $count = 0; 13438fac9c7bSMasahiro Yamada my $parenth = "("; 13448fac9c7bSMasahiro Yamada my $post = ","; 13458fac9c7bSMasahiro Yamada foreach my $parameter (@{$args{'parameterlist'}}) { 13468fac9c7bSMasahiro Yamada if ($count == $#{$args{'parameterlist'}}) { 13478fac9c7bSMasahiro Yamada $post = ");"; 13488fac9c7bSMasahiro Yamada } 13498fac9c7bSMasahiro Yamada $type = $args{'parametertypes'}{$parameter}; 13508fac9c7bSMasahiro Yamada if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 13518fac9c7bSMasahiro Yamada # pointer-to-function 13528fac9c7bSMasahiro Yamada print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n"; 13538fac9c7bSMasahiro Yamada } else { 13548fac9c7bSMasahiro Yamada $type =~ s/([^\*])$/$1 /; 13558fac9c7bSMasahiro Yamada print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n"; 13568fac9c7bSMasahiro Yamada } 13578fac9c7bSMasahiro Yamada $count++; 13588fac9c7bSMasahiro Yamada $parenth = ""; 13598fac9c7bSMasahiro Yamada } 13608fac9c7bSMasahiro Yamada 13618fac9c7bSMasahiro Yamada print ".SH ARGUMENTS\n"; 13628fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 13638fac9c7bSMasahiro Yamada my $parameter_name = $parameter; 13648fac9c7bSMasahiro Yamada $parameter_name =~ s/\[.*//; 13658fac9c7bSMasahiro Yamada 13668fac9c7bSMasahiro Yamada print ".IP \"" . $parameter . "\" 12\n"; 13678fac9c7bSMasahiro Yamada output_highlight($args{'parameterdescs'}{$parameter_name}); 13688fac9c7bSMasahiro Yamada } 13698fac9c7bSMasahiro Yamada foreach $section (@{$args{'sectionlist'}}) { 13708fac9c7bSMasahiro Yamada print ".SH \"", uc $section, "\"\n"; 13718fac9c7bSMasahiro Yamada output_highlight($args{'sections'}{$section}); 13728fac9c7bSMasahiro Yamada } 13738fac9c7bSMasahiro Yamada} 13748fac9c7bSMasahiro Yamada 13758fac9c7bSMasahiro Yamada## 13768fac9c7bSMasahiro Yamada# output enum in man 13778fac9c7bSMasahiro Yamadasub output_enum_man(%) { 13788fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 13798fac9c7bSMasahiro Yamada my ($parameter, $section); 13808fac9c7bSMasahiro Yamada my $count; 13818fac9c7bSMasahiro Yamada 13828fac9c7bSMasahiro Yamada print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" U-BOOT\n"; 13838fac9c7bSMasahiro Yamada 13848fac9c7bSMasahiro Yamada print ".SH NAME\n"; 13858fac9c7bSMasahiro Yamada print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n"; 13868fac9c7bSMasahiro Yamada 13878fac9c7bSMasahiro Yamada print ".SH SYNOPSIS\n"; 13888fac9c7bSMasahiro Yamada print "enum " . $args{'enum'} . " {\n"; 13898fac9c7bSMasahiro Yamada $count = 0; 13908fac9c7bSMasahiro Yamada foreach my $parameter (@{$args{'parameterlist'}}) { 13918fac9c7bSMasahiro Yamada print ".br\n.BI \" $parameter\"\n"; 13928fac9c7bSMasahiro Yamada if ($count == $#{$args{'parameterlist'}}) { 13938fac9c7bSMasahiro Yamada print "\n};\n"; 13948fac9c7bSMasahiro Yamada last; 13958fac9c7bSMasahiro Yamada } 13968fac9c7bSMasahiro Yamada else { 13978fac9c7bSMasahiro Yamada print ", \n.br\n"; 13988fac9c7bSMasahiro Yamada } 13998fac9c7bSMasahiro Yamada $count++; 14008fac9c7bSMasahiro Yamada } 14018fac9c7bSMasahiro Yamada 14028fac9c7bSMasahiro Yamada print ".SH Constants\n"; 14038fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 14048fac9c7bSMasahiro Yamada my $parameter_name = $parameter; 14058fac9c7bSMasahiro Yamada $parameter_name =~ s/\[.*//; 14068fac9c7bSMasahiro Yamada 14078fac9c7bSMasahiro Yamada print ".IP \"" . $parameter . "\" 12\n"; 14088fac9c7bSMasahiro Yamada output_highlight($args{'parameterdescs'}{$parameter_name}); 14098fac9c7bSMasahiro Yamada } 14108fac9c7bSMasahiro Yamada foreach $section (@{$args{'sectionlist'}}) { 14118fac9c7bSMasahiro Yamada print ".SH \"$section\"\n"; 14128fac9c7bSMasahiro Yamada output_highlight($args{'sections'}{$section}); 14138fac9c7bSMasahiro Yamada } 14148fac9c7bSMasahiro Yamada} 14158fac9c7bSMasahiro Yamada 14168fac9c7bSMasahiro Yamada## 14178fac9c7bSMasahiro Yamada# output struct in man 14188fac9c7bSMasahiro Yamadasub output_struct_man(%) { 14198fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 14208fac9c7bSMasahiro Yamada my ($parameter, $section); 14218fac9c7bSMasahiro Yamada 14228fac9c7bSMasahiro Yamada print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" U-BOOT\n"; 14238fac9c7bSMasahiro Yamada 14248fac9c7bSMasahiro Yamada print ".SH NAME\n"; 14258fac9c7bSMasahiro Yamada print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n"; 14268fac9c7bSMasahiro Yamada 14278fac9c7bSMasahiro Yamada print ".SH SYNOPSIS\n"; 14288fac9c7bSMasahiro Yamada print $args{'type'} . " " . $args{'struct'} . " {\n.br\n"; 14298fac9c7bSMasahiro Yamada 14308fac9c7bSMasahiro Yamada foreach my $parameter (@{$args{'parameterlist'}}) { 14318fac9c7bSMasahiro Yamada if ($parameter =~ /^#/) { 14328fac9c7bSMasahiro Yamada print ".BI \"$parameter\"\n.br\n"; 14338fac9c7bSMasahiro Yamada next; 14348fac9c7bSMasahiro Yamada } 14358fac9c7bSMasahiro Yamada my $parameter_name = $parameter; 14368fac9c7bSMasahiro Yamada $parameter_name =~ s/\[.*//; 14378fac9c7bSMasahiro Yamada 14388fac9c7bSMasahiro Yamada ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 14398fac9c7bSMasahiro Yamada $type = $args{'parametertypes'}{$parameter}; 14408fac9c7bSMasahiro Yamada if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 14418fac9c7bSMasahiro Yamada # pointer-to-function 14428fac9c7bSMasahiro Yamada print ".BI \" " . $1 . "\" " . $parameter . " \") (" . $2 . ")" . "\"\n;\n"; 14438fac9c7bSMasahiro Yamada } elsif ($type =~ m/^(.*?)\s*(:.*)/) { 14448fac9c7bSMasahiro Yamada # bitfield 14458fac9c7bSMasahiro Yamada print ".BI \" " . $1 . "\ \" " . $parameter . $2 . " \"" . "\"\n;\n"; 14468fac9c7bSMasahiro Yamada } else { 14478fac9c7bSMasahiro Yamada $type =~ s/([^\*])$/$1 /; 14488fac9c7bSMasahiro Yamada print ".BI \" " . $type . "\" " . $parameter . " \"" . "\"\n;\n"; 14498fac9c7bSMasahiro Yamada } 14508fac9c7bSMasahiro Yamada print "\n.br\n"; 14518fac9c7bSMasahiro Yamada } 14528fac9c7bSMasahiro Yamada print "};\n.br\n"; 14538fac9c7bSMasahiro Yamada 14548fac9c7bSMasahiro Yamada print ".SH Members\n"; 14558fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 14568fac9c7bSMasahiro Yamada ($parameter =~ /^#/) && next; 14578fac9c7bSMasahiro Yamada 14588fac9c7bSMasahiro Yamada my $parameter_name = $parameter; 14598fac9c7bSMasahiro Yamada $parameter_name =~ s/\[.*//; 14608fac9c7bSMasahiro Yamada 14618fac9c7bSMasahiro Yamada ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 14628fac9c7bSMasahiro Yamada print ".IP \"" . $parameter . "\" 12\n"; 14638fac9c7bSMasahiro Yamada output_highlight($args{'parameterdescs'}{$parameter_name}); 14648fac9c7bSMasahiro Yamada } 14658fac9c7bSMasahiro Yamada foreach $section (@{$args{'sectionlist'}}) { 14668fac9c7bSMasahiro Yamada print ".SH \"$section\"\n"; 14678fac9c7bSMasahiro Yamada output_highlight($args{'sections'}{$section}); 14688fac9c7bSMasahiro Yamada } 14698fac9c7bSMasahiro Yamada} 14708fac9c7bSMasahiro Yamada 14718fac9c7bSMasahiro Yamada## 14728fac9c7bSMasahiro Yamada# output typedef in man 14738fac9c7bSMasahiro Yamadasub output_typedef_man(%) { 14748fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 14758fac9c7bSMasahiro Yamada my ($parameter, $section); 14768fac9c7bSMasahiro Yamada 14778fac9c7bSMasahiro Yamada print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" U-BOOT\n"; 14788fac9c7bSMasahiro Yamada 14798fac9c7bSMasahiro Yamada print ".SH NAME\n"; 14808fac9c7bSMasahiro Yamada print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n"; 14818fac9c7bSMasahiro Yamada 14828fac9c7bSMasahiro Yamada foreach $section (@{$args{'sectionlist'}}) { 14838fac9c7bSMasahiro Yamada print ".SH \"$section\"\n"; 14848fac9c7bSMasahiro Yamada output_highlight($args{'sections'}{$section}); 14858fac9c7bSMasahiro Yamada } 14868fac9c7bSMasahiro Yamada} 14878fac9c7bSMasahiro Yamada 14888fac9c7bSMasahiro Yamadasub output_blockhead_man(%) { 14898fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 14908fac9c7bSMasahiro Yamada my ($parameter, $section); 14918fac9c7bSMasahiro Yamada my $count; 14928fac9c7bSMasahiro Yamada 14938fac9c7bSMasahiro Yamada print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" U-BOOT\n"; 14948fac9c7bSMasahiro Yamada 14958fac9c7bSMasahiro Yamada foreach $section (@{$args{'sectionlist'}}) { 14968fac9c7bSMasahiro Yamada print ".SH \"$section\"\n"; 14978fac9c7bSMasahiro Yamada output_highlight($args{'sections'}{$section}); 14988fac9c7bSMasahiro Yamada } 14998fac9c7bSMasahiro Yamada} 15008fac9c7bSMasahiro Yamada 15018fac9c7bSMasahiro Yamada## 15028fac9c7bSMasahiro Yamada# output in text 15038fac9c7bSMasahiro Yamadasub output_function_text(%) { 15048fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 15058fac9c7bSMasahiro Yamada my ($parameter, $section); 15068fac9c7bSMasahiro Yamada my $start; 15078fac9c7bSMasahiro Yamada 15088fac9c7bSMasahiro Yamada print "Name:\n\n"; 15098fac9c7bSMasahiro Yamada print $args{'function'} . " - " . $args{'purpose'} . "\n"; 15108fac9c7bSMasahiro Yamada 15118fac9c7bSMasahiro Yamada print "\nSynopsis:\n\n"; 15128fac9c7bSMasahiro Yamada if ($args{'functiontype'} ne "") { 15138fac9c7bSMasahiro Yamada $start = $args{'functiontype'} . " " . $args{'function'} . " ("; 15148fac9c7bSMasahiro Yamada } else { 15158fac9c7bSMasahiro Yamada $start = $args{'function'} . " ("; 15168fac9c7bSMasahiro Yamada } 15178fac9c7bSMasahiro Yamada print $start; 15188fac9c7bSMasahiro Yamada 15198fac9c7bSMasahiro Yamada my $count = 0; 15208fac9c7bSMasahiro Yamada foreach my $parameter (@{$args{'parameterlist'}}) { 15218fac9c7bSMasahiro Yamada $type = $args{'parametertypes'}{$parameter}; 15228fac9c7bSMasahiro Yamada if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 15238fac9c7bSMasahiro Yamada # pointer-to-function 15248fac9c7bSMasahiro Yamada print $1 . $parameter . ") (" . $2; 15258fac9c7bSMasahiro Yamada } else { 15268fac9c7bSMasahiro Yamada print $type . " " . $parameter; 15278fac9c7bSMasahiro Yamada } 15288fac9c7bSMasahiro Yamada if ($count != $#{$args{'parameterlist'}}) { 15298fac9c7bSMasahiro Yamada $count++; 15308fac9c7bSMasahiro Yamada print ",\n"; 15318fac9c7bSMasahiro Yamada print " " x length($start); 15328fac9c7bSMasahiro Yamada } else { 15338fac9c7bSMasahiro Yamada print ");\n\n"; 15348fac9c7bSMasahiro Yamada } 15358fac9c7bSMasahiro Yamada } 15368fac9c7bSMasahiro Yamada 15378fac9c7bSMasahiro Yamada print "Arguments:\n\n"; 15388fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 15398fac9c7bSMasahiro Yamada my $parameter_name = $parameter; 15408fac9c7bSMasahiro Yamada $parameter_name =~ s/\[.*//; 15418fac9c7bSMasahiro Yamada 15428fac9c7bSMasahiro Yamada print $parameter . "\n\t" . $args{'parameterdescs'}{$parameter_name} . "\n"; 15438fac9c7bSMasahiro Yamada } 15448fac9c7bSMasahiro Yamada output_section_text(@_); 15458fac9c7bSMasahiro Yamada} 15468fac9c7bSMasahiro Yamada 15478fac9c7bSMasahiro Yamada#output sections in text 15488fac9c7bSMasahiro Yamadasub output_section_text(%) { 15498fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 15508fac9c7bSMasahiro Yamada my $section; 15518fac9c7bSMasahiro Yamada 15528fac9c7bSMasahiro Yamada print "\n"; 15538fac9c7bSMasahiro Yamada foreach $section (@{$args{'sectionlist'}}) { 15548fac9c7bSMasahiro Yamada print "$section:\n\n"; 15558fac9c7bSMasahiro Yamada output_highlight($args{'sections'}{$section}); 15568fac9c7bSMasahiro Yamada } 15578fac9c7bSMasahiro Yamada print "\n\n"; 15588fac9c7bSMasahiro Yamada} 15598fac9c7bSMasahiro Yamada 15608fac9c7bSMasahiro Yamada# output enum in text 15618fac9c7bSMasahiro Yamadasub output_enum_text(%) { 15628fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 15638fac9c7bSMasahiro Yamada my ($parameter); 15648fac9c7bSMasahiro Yamada my $count; 15658fac9c7bSMasahiro Yamada print "Enum:\n\n"; 15668fac9c7bSMasahiro Yamada 15678fac9c7bSMasahiro Yamada print "enum " . $args{'enum'} . " - " . $args{'purpose'} . "\n\n"; 15688fac9c7bSMasahiro Yamada print "enum " . $args{'enum'} . " {\n"; 15698fac9c7bSMasahiro Yamada $count = 0; 15708fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 15718fac9c7bSMasahiro Yamada print "\t$parameter"; 15728fac9c7bSMasahiro Yamada if ($count != $#{$args{'parameterlist'}}) { 15738fac9c7bSMasahiro Yamada $count++; 15748fac9c7bSMasahiro Yamada print ","; 15758fac9c7bSMasahiro Yamada } 15768fac9c7bSMasahiro Yamada print "\n"; 15778fac9c7bSMasahiro Yamada } 15788fac9c7bSMasahiro Yamada print "};\n\n"; 15798fac9c7bSMasahiro Yamada 15808fac9c7bSMasahiro Yamada print "Constants:\n\n"; 15818fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 15828fac9c7bSMasahiro Yamada print "$parameter\n\t"; 15838fac9c7bSMasahiro Yamada print $args{'parameterdescs'}{$parameter} . "\n"; 15848fac9c7bSMasahiro Yamada } 15858fac9c7bSMasahiro Yamada 15868fac9c7bSMasahiro Yamada output_section_text(@_); 15878fac9c7bSMasahiro Yamada} 15888fac9c7bSMasahiro Yamada 15898fac9c7bSMasahiro Yamada# output typedef in text 15908fac9c7bSMasahiro Yamadasub output_typedef_text(%) { 15918fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 15928fac9c7bSMasahiro Yamada my ($parameter); 15938fac9c7bSMasahiro Yamada my $count; 15948fac9c7bSMasahiro Yamada print "Typedef:\n\n"; 15958fac9c7bSMasahiro Yamada 15968fac9c7bSMasahiro Yamada print "typedef " . $args{'typedef'} . " - " . $args{'purpose'} . "\n"; 15978fac9c7bSMasahiro Yamada output_section_text(@_); 15988fac9c7bSMasahiro Yamada} 15998fac9c7bSMasahiro Yamada 16008fac9c7bSMasahiro Yamada# output struct as text 16018fac9c7bSMasahiro Yamadasub output_struct_text(%) { 16028fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 16038fac9c7bSMasahiro Yamada my ($parameter); 16048fac9c7bSMasahiro Yamada 16058fac9c7bSMasahiro Yamada print $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "\n\n"; 16068fac9c7bSMasahiro Yamada print $args{'type'} . " " . $args{'struct'} . " {\n"; 16078fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 16088fac9c7bSMasahiro Yamada if ($parameter =~ /^#/) { 16098fac9c7bSMasahiro Yamada print "$parameter\n"; 16108fac9c7bSMasahiro Yamada next; 16118fac9c7bSMasahiro Yamada } 16128fac9c7bSMasahiro Yamada 16138fac9c7bSMasahiro Yamada my $parameter_name = $parameter; 16148fac9c7bSMasahiro Yamada $parameter_name =~ s/\[.*//; 16158fac9c7bSMasahiro Yamada 16168fac9c7bSMasahiro Yamada ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 16178fac9c7bSMasahiro Yamada $type = $args{'parametertypes'}{$parameter}; 16188fac9c7bSMasahiro Yamada if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { 16198fac9c7bSMasahiro Yamada # pointer-to-function 16208fac9c7bSMasahiro Yamada print "\t$1 $parameter) ($2);\n"; 16218fac9c7bSMasahiro Yamada } elsif ($type =~ m/^(.*?)\s*(:.*)/) { 16228fac9c7bSMasahiro Yamada # bitfield 16238fac9c7bSMasahiro Yamada print "\t$1 $parameter$2;\n"; 16248fac9c7bSMasahiro Yamada } else { 16258fac9c7bSMasahiro Yamada print "\t" . $type . " " . $parameter . ";\n"; 16268fac9c7bSMasahiro Yamada } 16278fac9c7bSMasahiro Yamada } 16288fac9c7bSMasahiro Yamada print "};\n\n"; 16298fac9c7bSMasahiro Yamada 16308fac9c7bSMasahiro Yamada print "Members:\n\n"; 16318fac9c7bSMasahiro Yamada foreach $parameter (@{$args{'parameterlist'}}) { 16328fac9c7bSMasahiro Yamada ($parameter =~ /^#/) && next; 16338fac9c7bSMasahiro Yamada 16348fac9c7bSMasahiro Yamada my $parameter_name = $parameter; 16358fac9c7bSMasahiro Yamada $parameter_name =~ s/\[.*//; 16368fac9c7bSMasahiro Yamada 16378fac9c7bSMasahiro Yamada ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 16388fac9c7bSMasahiro Yamada print "$parameter\n\t"; 16398fac9c7bSMasahiro Yamada print $args{'parameterdescs'}{$parameter_name} . "\n"; 16408fac9c7bSMasahiro Yamada } 16418fac9c7bSMasahiro Yamada print "\n"; 16428fac9c7bSMasahiro Yamada output_section_text(@_); 16438fac9c7bSMasahiro Yamada} 16448fac9c7bSMasahiro Yamada 16458fac9c7bSMasahiro Yamadasub output_blockhead_text(%) { 16468fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 16478fac9c7bSMasahiro Yamada my ($parameter, $section); 16488fac9c7bSMasahiro Yamada 16498fac9c7bSMasahiro Yamada foreach $section (@{$args{'sectionlist'}}) { 16508fac9c7bSMasahiro Yamada print " $section:\n"; 16518fac9c7bSMasahiro Yamada print " -> "; 16528fac9c7bSMasahiro Yamada output_highlight($args{'sections'}{$section}); 16538fac9c7bSMasahiro Yamada } 16548fac9c7bSMasahiro Yamada} 16558fac9c7bSMasahiro Yamada 16568fac9c7bSMasahiro Yamada## list mode output functions 16578fac9c7bSMasahiro Yamada 16588fac9c7bSMasahiro Yamadasub output_function_list(%) { 16598fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 16608fac9c7bSMasahiro Yamada 16618fac9c7bSMasahiro Yamada print $args{'function'} . "\n"; 16628fac9c7bSMasahiro Yamada} 16638fac9c7bSMasahiro Yamada 16648fac9c7bSMasahiro Yamada# output enum in list 16658fac9c7bSMasahiro Yamadasub output_enum_list(%) { 16668fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 16678fac9c7bSMasahiro Yamada print $args{'enum'} . "\n"; 16688fac9c7bSMasahiro Yamada} 16698fac9c7bSMasahiro Yamada 16708fac9c7bSMasahiro Yamada# output typedef in list 16718fac9c7bSMasahiro Yamadasub output_typedef_list(%) { 16728fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 16738fac9c7bSMasahiro Yamada print $args{'typedef'} . "\n"; 16748fac9c7bSMasahiro Yamada} 16758fac9c7bSMasahiro Yamada 16768fac9c7bSMasahiro Yamada# output struct as list 16778fac9c7bSMasahiro Yamadasub output_struct_list(%) { 16788fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 16798fac9c7bSMasahiro Yamada 16808fac9c7bSMasahiro Yamada print $args{'struct'} . "\n"; 16818fac9c7bSMasahiro Yamada} 16828fac9c7bSMasahiro Yamada 16838fac9c7bSMasahiro Yamadasub output_blockhead_list(%) { 16848fac9c7bSMasahiro Yamada my %args = %{$_[0]}; 16858fac9c7bSMasahiro Yamada my ($parameter, $section); 16868fac9c7bSMasahiro Yamada 16878fac9c7bSMasahiro Yamada foreach $section (@{$args{'sectionlist'}}) { 16888fac9c7bSMasahiro Yamada print "DOC: $section\n"; 16898fac9c7bSMasahiro Yamada } 16908fac9c7bSMasahiro Yamada} 16918fac9c7bSMasahiro Yamada 16928fac9c7bSMasahiro Yamada## 16938fac9c7bSMasahiro Yamada# generic output function for all types (function, struct/union, typedef, enum); 16948fac9c7bSMasahiro Yamada# calls the generated, variable output_ function name based on 16958fac9c7bSMasahiro Yamada# functype and output_mode 16968fac9c7bSMasahiro Yamadasub output_declaration { 16978fac9c7bSMasahiro Yamada no strict 'refs'; 16988fac9c7bSMasahiro Yamada my $name = shift; 16998fac9c7bSMasahiro Yamada my $functype = shift; 17008fac9c7bSMasahiro Yamada my $func = "output_${functype}_$output_mode"; 17018fac9c7bSMasahiro Yamada if (($function_only==0) || 17028fac9c7bSMasahiro Yamada ( $function_only == 1 && defined($function_table{$name})) || 17038fac9c7bSMasahiro Yamada ( $function_only == 2 && !defined($function_table{$name}))) 17048fac9c7bSMasahiro Yamada { 17058fac9c7bSMasahiro Yamada &$func(@_); 17068fac9c7bSMasahiro Yamada $section_counter++; 17078fac9c7bSMasahiro Yamada } 17088fac9c7bSMasahiro Yamada} 17098fac9c7bSMasahiro Yamada 17108fac9c7bSMasahiro Yamada## 17118fac9c7bSMasahiro Yamada# generic output function - calls the right one based on current output mode. 17128fac9c7bSMasahiro Yamadasub output_blockhead { 17138fac9c7bSMasahiro Yamada no strict 'refs'; 17148fac9c7bSMasahiro Yamada my $func = "output_blockhead_" . $output_mode; 17158fac9c7bSMasahiro Yamada &$func(@_); 17168fac9c7bSMasahiro Yamada $section_counter++; 17178fac9c7bSMasahiro Yamada} 17188fac9c7bSMasahiro Yamada 17198fac9c7bSMasahiro Yamada## 17208fac9c7bSMasahiro Yamada# takes a declaration (struct, union, enum, typedef) and 17218fac9c7bSMasahiro Yamada# invokes the right handler. NOT called for functions. 17228fac9c7bSMasahiro Yamadasub dump_declaration($$) { 17238fac9c7bSMasahiro Yamada no strict 'refs'; 17248fac9c7bSMasahiro Yamada my ($prototype, $file) = @_; 17258fac9c7bSMasahiro Yamada my $func = "dump_" . $decl_type; 17268fac9c7bSMasahiro Yamada &$func(@_); 17278fac9c7bSMasahiro Yamada} 17288fac9c7bSMasahiro Yamada 17298fac9c7bSMasahiro Yamadasub dump_union($$) { 17308fac9c7bSMasahiro Yamada dump_struct(@_); 17318fac9c7bSMasahiro Yamada} 17328fac9c7bSMasahiro Yamada 17338fac9c7bSMasahiro Yamadasub dump_struct($$) { 17348fac9c7bSMasahiro Yamada my $x = shift; 17358fac9c7bSMasahiro Yamada my $file = shift; 17368fac9c7bSMasahiro Yamada my $nested; 17378fac9c7bSMasahiro Yamada 17388fac9c7bSMasahiro Yamada if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) { 17398fac9c7bSMasahiro Yamada #my $decl_type = $1; 17408fac9c7bSMasahiro Yamada $declaration_name = $2; 17418fac9c7bSMasahiro Yamada my $members = $3; 17428fac9c7bSMasahiro Yamada 17438fac9c7bSMasahiro Yamada # ignore embedded structs or unions 17448fac9c7bSMasahiro Yamada $members =~ s/({.*})//g; 17458fac9c7bSMasahiro Yamada $nested = $1; 17468fac9c7bSMasahiro Yamada 17478fac9c7bSMasahiro Yamada # ignore members marked private: 17488fac9c7bSMasahiro Yamada $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gos; 17498fac9c7bSMasahiro Yamada $members =~ s/\/\*\s*private:.*//gos; 17508fac9c7bSMasahiro Yamada # strip comments: 17518fac9c7bSMasahiro Yamada $members =~ s/\/\*.*?\*\///gos; 17528fac9c7bSMasahiro Yamada $nested =~ s/\/\*.*?\*\///gos; 17538fac9c7bSMasahiro Yamada # strip kmemcheck_bitfield_{begin,end}.*; 17548fac9c7bSMasahiro Yamada $members =~ s/kmemcheck_bitfield_.*?;//gos; 17558fac9c7bSMasahiro Yamada # strip attributes 1756ced03298SMasahiro Yamada $members =~ s/__aligned\s*\(.+\)//gos; 17578fac9c7bSMasahiro Yamada 17588fac9c7bSMasahiro Yamada create_parameterlist($members, ';', $file); 17598fac9c7bSMasahiro Yamada check_sections($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested); 17608fac9c7bSMasahiro Yamada 17618fac9c7bSMasahiro Yamada output_declaration($declaration_name, 17628fac9c7bSMasahiro Yamada 'struct', 17638fac9c7bSMasahiro Yamada {'struct' => $declaration_name, 17648fac9c7bSMasahiro Yamada 'module' => $modulename, 17658fac9c7bSMasahiro Yamada 'parameterlist' => \@parameterlist, 17668fac9c7bSMasahiro Yamada 'parameterdescs' => \%parameterdescs, 17678fac9c7bSMasahiro Yamada 'parametertypes' => \%parametertypes, 17688fac9c7bSMasahiro Yamada 'sectionlist' => \@sectionlist, 17698fac9c7bSMasahiro Yamada 'sections' => \%sections, 17708fac9c7bSMasahiro Yamada 'purpose' => $declaration_purpose, 17718fac9c7bSMasahiro Yamada 'type' => $decl_type 17728fac9c7bSMasahiro Yamada }); 17738fac9c7bSMasahiro Yamada } 17748fac9c7bSMasahiro Yamada else { 17758fac9c7bSMasahiro Yamada print STDERR "Error(${file}:$.): Cannot parse struct or union!\n"; 17768fac9c7bSMasahiro Yamada ++$errors; 17778fac9c7bSMasahiro Yamada } 17788fac9c7bSMasahiro Yamada} 17798fac9c7bSMasahiro Yamada 17808fac9c7bSMasahiro Yamadasub dump_enum($$) { 17818fac9c7bSMasahiro Yamada my $x = shift; 17828fac9c7bSMasahiro Yamada my $file = shift; 17838fac9c7bSMasahiro Yamada 17848fac9c7bSMasahiro Yamada $x =~ s@/\*.*?\*/@@gos; # strip comments. 17858fac9c7bSMasahiro Yamada $x =~ s/^#\s*define\s+.*$//; # strip #define macros inside enums 17868fac9c7bSMasahiro Yamada 17878fac9c7bSMasahiro Yamada if ($x =~ /enum\s+(\w+)\s*{(.*)}/) { 17888fac9c7bSMasahiro Yamada $declaration_name = $1; 17898fac9c7bSMasahiro Yamada my $members = $2; 17908fac9c7bSMasahiro Yamada 17918fac9c7bSMasahiro Yamada foreach my $arg (split ',', $members) { 17928fac9c7bSMasahiro Yamada $arg =~ s/^\s*(\w+).*/$1/; 17938fac9c7bSMasahiro Yamada push @parameterlist, $arg; 17948fac9c7bSMasahiro Yamada if (!$parameterdescs{$arg}) { 17958fac9c7bSMasahiro Yamada $parameterdescs{$arg} = $undescribed; 17968fac9c7bSMasahiro Yamada print STDERR "Warning(${file}:$.): Enum value '$arg' ". 17978fac9c7bSMasahiro Yamada "not described in enum '$declaration_name'\n"; 17988fac9c7bSMasahiro Yamada } 17998fac9c7bSMasahiro Yamada 18008fac9c7bSMasahiro Yamada } 18018fac9c7bSMasahiro Yamada 18028fac9c7bSMasahiro Yamada output_declaration($declaration_name, 18038fac9c7bSMasahiro Yamada 'enum', 18048fac9c7bSMasahiro Yamada {'enum' => $declaration_name, 18058fac9c7bSMasahiro Yamada 'module' => $modulename, 18068fac9c7bSMasahiro Yamada 'parameterlist' => \@parameterlist, 18078fac9c7bSMasahiro Yamada 'parameterdescs' => \%parameterdescs, 18088fac9c7bSMasahiro Yamada 'sectionlist' => \@sectionlist, 18098fac9c7bSMasahiro Yamada 'sections' => \%sections, 18108fac9c7bSMasahiro Yamada 'purpose' => $declaration_purpose 18118fac9c7bSMasahiro Yamada }); 18128fac9c7bSMasahiro Yamada } 18138fac9c7bSMasahiro Yamada else { 18148fac9c7bSMasahiro Yamada print STDERR "Error(${file}:$.): Cannot parse enum!\n"; 18158fac9c7bSMasahiro Yamada ++$errors; 18168fac9c7bSMasahiro Yamada } 18178fac9c7bSMasahiro Yamada} 18188fac9c7bSMasahiro Yamada 18198fac9c7bSMasahiro Yamadasub dump_typedef($$) { 18208fac9c7bSMasahiro Yamada my $x = shift; 18218fac9c7bSMasahiro Yamada my $file = shift; 18228fac9c7bSMasahiro Yamada 18238fac9c7bSMasahiro Yamada $x =~ s@/\*.*?\*/@@gos; # strip comments. 18248fac9c7bSMasahiro Yamada while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) { 18258fac9c7bSMasahiro Yamada $x =~ s/\(*.\)\s*;$/;/; 18268fac9c7bSMasahiro Yamada $x =~ s/\[*.\]\s*;$/;/; 18278fac9c7bSMasahiro Yamada } 18288fac9c7bSMasahiro Yamada 18298fac9c7bSMasahiro Yamada if ($x =~ /typedef.*\s+(\w+)\s*;/) { 18308fac9c7bSMasahiro Yamada $declaration_name = $1; 18318fac9c7bSMasahiro Yamada 18328fac9c7bSMasahiro Yamada output_declaration($declaration_name, 18338fac9c7bSMasahiro Yamada 'typedef', 18348fac9c7bSMasahiro Yamada {'typedef' => $declaration_name, 18358fac9c7bSMasahiro Yamada 'module' => $modulename, 18368fac9c7bSMasahiro Yamada 'sectionlist' => \@sectionlist, 18378fac9c7bSMasahiro Yamada 'sections' => \%sections, 18388fac9c7bSMasahiro Yamada 'purpose' => $declaration_purpose 18398fac9c7bSMasahiro Yamada }); 18408fac9c7bSMasahiro Yamada } 18418fac9c7bSMasahiro Yamada else { 18428fac9c7bSMasahiro Yamada print STDERR "Error(${file}:$.): Cannot parse typedef!\n"; 18438fac9c7bSMasahiro Yamada ++$errors; 18448fac9c7bSMasahiro Yamada } 18458fac9c7bSMasahiro Yamada} 18468fac9c7bSMasahiro Yamada 18478fac9c7bSMasahiro Yamadasub save_struct_actual($) { 18488fac9c7bSMasahiro Yamada my $actual = shift; 18498fac9c7bSMasahiro Yamada 18508fac9c7bSMasahiro Yamada # strip all spaces from the actual param so that it looks like one string item 18518fac9c7bSMasahiro Yamada $actual =~ s/\s*//g; 18528fac9c7bSMasahiro Yamada $struct_actual = $struct_actual . $actual . " "; 18538fac9c7bSMasahiro Yamada} 18548fac9c7bSMasahiro Yamada 18558fac9c7bSMasahiro Yamadasub create_parameterlist($$$) { 18568fac9c7bSMasahiro Yamada my $args = shift; 18578fac9c7bSMasahiro Yamada my $splitter = shift; 18588fac9c7bSMasahiro Yamada my $file = shift; 18598fac9c7bSMasahiro Yamada my $type; 18608fac9c7bSMasahiro Yamada my $param; 18618fac9c7bSMasahiro Yamada 18628fac9c7bSMasahiro Yamada # temporarily replace commas inside function pointer definition 18638fac9c7bSMasahiro Yamada while ($args =~ /(\([^\),]+),/) { 18648fac9c7bSMasahiro Yamada $args =~ s/(\([^\),]+),/$1#/g; 18658fac9c7bSMasahiro Yamada } 18668fac9c7bSMasahiro Yamada 18678fac9c7bSMasahiro Yamada foreach my $arg (split($splitter, $args)) { 18688fac9c7bSMasahiro Yamada # strip comments 18698fac9c7bSMasahiro Yamada $arg =~ s/\/\*.*\*\///; 18708fac9c7bSMasahiro Yamada # strip leading/trailing spaces 18718fac9c7bSMasahiro Yamada $arg =~ s/^\s*//; 18728fac9c7bSMasahiro Yamada $arg =~ s/\s*$//; 18738fac9c7bSMasahiro Yamada $arg =~ s/\s+/ /; 18748fac9c7bSMasahiro Yamada 18758fac9c7bSMasahiro Yamada if ($arg =~ /^#/) { 18768fac9c7bSMasahiro Yamada # Treat preprocessor directive as a typeless variable just to fill 18778fac9c7bSMasahiro Yamada # corresponding data structures "correctly". Catch it later in 18788fac9c7bSMasahiro Yamada # output_* subs. 18798fac9c7bSMasahiro Yamada push_parameter($arg, "", $file); 18808fac9c7bSMasahiro Yamada } elsif ($arg =~ m/\(.+\)\s*\(/) { 18818fac9c7bSMasahiro Yamada # pointer-to-function 18828fac9c7bSMasahiro Yamada $arg =~ tr/#/,/; 18838fac9c7bSMasahiro Yamada $arg =~ m/[^\(]+\(\*?\s*(\w*)\s*\)/; 18848fac9c7bSMasahiro Yamada $param = $1; 18858fac9c7bSMasahiro Yamada $type = $arg; 18868fac9c7bSMasahiro Yamada $type =~ s/([^\(]+\(\*?)\s*$param/$1/; 18878fac9c7bSMasahiro Yamada save_struct_actual($param); 18888fac9c7bSMasahiro Yamada push_parameter($param, $type, $file); 18898fac9c7bSMasahiro Yamada } elsif ($arg) { 18908fac9c7bSMasahiro Yamada $arg =~ s/\s*:\s*/:/g; 18918fac9c7bSMasahiro Yamada $arg =~ s/\s*\[/\[/g; 18928fac9c7bSMasahiro Yamada 18938fac9c7bSMasahiro Yamada my @args = split('\s*,\s*', $arg); 18948fac9c7bSMasahiro Yamada if ($args[0] =~ m/\*/) { 18958fac9c7bSMasahiro Yamada $args[0] =~ s/(\*+)\s*/ $1/; 18968fac9c7bSMasahiro Yamada } 18978fac9c7bSMasahiro Yamada 18988fac9c7bSMasahiro Yamada my @first_arg; 18998fac9c7bSMasahiro Yamada if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) { 19008fac9c7bSMasahiro Yamada shift @args; 19018fac9c7bSMasahiro Yamada push(@first_arg, split('\s+', $1)); 19028fac9c7bSMasahiro Yamada push(@first_arg, $2); 19038fac9c7bSMasahiro Yamada } else { 19048fac9c7bSMasahiro Yamada @first_arg = split('\s+', shift @args); 19058fac9c7bSMasahiro Yamada } 19068fac9c7bSMasahiro Yamada 19078fac9c7bSMasahiro Yamada unshift(@args, pop @first_arg); 19088fac9c7bSMasahiro Yamada $type = join " ", @first_arg; 19098fac9c7bSMasahiro Yamada 19108fac9c7bSMasahiro Yamada foreach $param (@args) { 19118fac9c7bSMasahiro Yamada if ($param =~ m/^(\*+)\s*(.*)/) { 19128fac9c7bSMasahiro Yamada save_struct_actual($2); 19138fac9c7bSMasahiro Yamada push_parameter($2, "$type $1", $file); 19148fac9c7bSMasahiro Yamada } 19158fac9c7bSMasahiro Yamada elsif ($param =~ m/(.*?):(\d+)/) { 19168fac9c7bSMasahiro Yamada if ($type ne "") { # skip unnamed bit-fields 19178fac9c7bSMasahiro Yamada save_struct_actual($1); 19188fac9c7bSMasahiro Yamada push_parameter($1, "$type:$2", $file) 19198fac9c7bSMasahiro Yamada } 19208fac9c7bSMasahiro Yamada } 19218fac9c7bSMasahiro Yamada else { 19228fac9c7bSMasahiro Yamada save_struct_actual($param); 19238fac9c7bSMasahiro Yamada push_parameter($param, $type, $file); 19248fac9c7bSMasahiro Yamada } 19258fac9c7bSMasahiro Yamada } 19268fac9c7bSMasahiro Yamada } 19278fac9c7bSMasahiro Yamada } 19288fac9c7bSMasahiro Yamada} 19298fac9c7bSMasahiro Yamada 19308fac9c7bSMasahiro Yamadasub push_parameter($$$) { 19318fac9c7bSMasahiro Yamada my $param = shift; 19328fac9c7bSMasahiro Yamada my $type = shift; 19338fac9c7bSMasahiro Yamada my $file = shift; 19348fac9c7bSMasahiro Yamada 19358fac9c7bSMasahiro Yamada if (($anon_struct_union == 1) && ($type eq "") && 19368fac9c7bSMasahiro Yamada ($param eq "}")) { 19378fac9c7bSMasahiro Yamada return; # ignore the ending }; from anon. struct/union 19388fac9c7bSMasahiro Yamada } 19398fac9c7bSMasahiro Yamada 19408fac9c7bSMasahiro Yamada $anon_struct_union = 0; 19418fac9c7bSMasahiro Yamada my $param_name = $param; 19428fac9c7bSMasahiro Yamada $param_name =~ s/\[.*//; 19438fac9c7bSMasahiro Yamada 19448fac9c7bSMasahiro Yamada if ($type eq "" && $param =~ /\.\.\.$/) 19458fac9c7bSMasahiro Yamada { 19468fac9c7bSMasahiro Yamada if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") { 19478fac9c7bSMasahiro Yamada $parameterdescs{$param} = "variable arguments"; 19488fac9c7bSMasahiro Yamada } 19498fac9c7bSMasahiro Yamada } 19508fac9c7bSMasahiro Yamada elsif ($type eq "" && ($param eq "" or $param eq "void")) 19518fac9c7bSMasahiro Yamada { 19528fac9c7bSMasahiro Yamada $param="void"; 19538fac9c7bSMasahiro Yamada $parameterdescs{void} = "no arguments"; 19548fac9c7bSMasahiro Yamada } 19558fac9c7bSMasahiro Yamada elsif ($type eq "" && ($param eq "struct" or $param eq "union")) 19568fac9c7bSMasahiro Yamada # handle unnamed (anonymous) union or struct: 19578fac9c7bSMasahiro Yamada { 19588fac9c7bSMasahiro Yamada $type = $param; 19598fac9c7bSMasahiro Yamada $param = "{unnamed_" . $param . "}"; 19608fac9c7bSMasahiro Yamada $parameterdescs{$param} = "anonymous\n"; 19618fac9c7bSMasahiro Yamada $anon_struct_union = 1; 19628fac9c7bSMasahiro Yamada } 19638fac9c7bSMasahiro Yamada 19648fac9c7bSMasahiro Yamada # warn if parameter has no description 19658fac9c7bSMasahiro Yamada # (but ignore ones starting with # as these are not parameters 19668fac9c7bSMasahiro Yamada # but inline preprocessor statements); 19678fac9c7bSMasahiro Yamada # also ignore unnamed structs/unions; 19688fac9c7bSMasahiro Yamada if (!$anon_struct_union) { 19698fac9c7bSMasahiro Yamada if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) { 19708fac9c7bSMasahiro Yamada 19718fac9c7bSMasahiro Yamada $parameterdescs{$param_name} = $undescribed; 19728fac9c7bSMasahiro Yamada 19738fac9c7bSMasahiro Yamada if (($type eq 'function') || ($type eq 'enum')) { 19748fac9c7bSMasahiro Yamada print STDERR "Warning(${file}:$.): Function parameter ". 19758fac9c7bSMasahiro Yamada "or member '$param' not " . 19768fac9c7bSMasahiro Yamada "described in '$declaration_name'\n"; 19778fac9c7bSMasahiro Yamada } 19788fac9c7bSMasahiro Yamada print STDERR "Warning(${file}:$.):" . 19798fac9c7bSMasahiro Yamada " No description found for parameter '$param'\n"; 19808fac9c7bSMasahiro Yamada ++$warnings; 19818fac9c7bSMasahiro Yamada } 19828fac9c7bSMasahiro Yamada } 19838fac9c7bSMasahiro Yamada 19848fac9c7bSMasahiro Yamada $param = xml_escape($param); 19858fac9c7bSMasahiro Yamada 19868fac9c7bSMasahiro Yamada # strip spaces from $param so that it is one continuous string 19878fac9c7bSMasahiro Yamada # on @parameterlist; 19888fac9c7bSMasahiro Yamada # this fixes a problem where check_sections() cannot find 19898fac9c7bSMasahiro Yamada # a parameter like "addr[6 + 2]" because it actually appears 19908fac9c7bSMasahiro Yamada # as "addr[6", "+", "2]" on the parameter list; 19918fac9c7bSMasahiro Yamada # but it's better to maintain the param string unchanged for output, 19928fac9c7bSMasahiro Yamada # so just weaken the string compare in check_sections() to ignore 19938fac9c7bSMasahiro Yamada # "[blah" in a parameter string; 19948fac9c7bSMasahiro Yamada ###$param =~ s/\s*//g; 19958fac9c7bSMasahiro Yamada push @parameterlist, $param; 19968fac9c7bSMasahiro Yamada $parametertypes{$param} = $type; 19978fac9c7bSMasahiro Yamada} 19988fac9c7bSMasahiro Yamada 19998fac9c7bSMasahiro Yamadasub check_sections($$$$$$) { 20008fac9c7bSMasahiro Yamada my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck, $nested) = @_; 20018fac9c7bSMasahiro Yamada my @sects = split ' ', $sectcheck; 20028fac9c7bSMasahiro Yamada my @prms = split ' ', $prmscheck; 20038fac9c7bSMasahiro Yamada my $err; 20048fac9c7bSMasahiro Yamada my ($px, $sx); 20058fac9c7bSMasahiro Yamada my $prm_clean; # strip trailing "[array size]" and/or beginning "*" 20068fac9c7bSMasahiro Yamada 20078fac9c7bSMasahiro Yamada foreach $sx (0 .. $#sects) { 20088fac9c7bSMasahiro Yamada $err = 1; 20098fac9c7bSMasahiro Yamada foreach $px (0 .. $#prms) { 20108fac9c7bSMasahiro Yamada $prm_clean = $prms[$px]; 20118fac9c7bSMasahiro Yamada $prm_clean =~ s/\[.*\]//; 20128fac9c7bSMasahiro Yamada $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i; 20138fac9c7bSMasahiro Yamada # ignore array size in a parameter string; 20148fac9c7bSMasahiro Yamada # however, the original param string may contain 20158fac9c7bSMasahiro Yamada # spaces, e.g.: addr[6 + 2] 20168fac9c7bSMasahiro Yamada # and this appears in @prms as "addr[6" since the 20178fac9c7bSMasahiro Yamada # parameter list is split at spaces; 20188fac9c7bSMasahiro Yamada # hence just ignore "[..." for the sections check; 20198fac9c7bSMasahiro Yamada $prm_clean =~ s/\[.*//; 20208fac9c7bSMasahiro Yamada 20218fac9c7bSMasahiro Yamada ##$prm_clean =~ s/^\**//; 20228fac9c7bSMasahiro Yamada if ($prm_clean eq $sects[$sx]) { 20238fac9c7bSMasahiro Yamada $err = 0; 20248fac9c7bSMasahiro Yamada last; 20258fac9c7bSMasahiro Yamada } 20268fac9c7bSMasahiro Yamada } 20278fac9c7bSMasahiro Yamada if ($err) { 20288fac9c7bSMasahiro Yamada if ($decl_type eq "function") { 20298fac9c7bSMasahiro Yamada print STDERR "Warning(${file}:$.): " . 20308fac9c7bSMasahiro Yamada "Excess function parameter " . 20318fac9c7bSMasahiro Yamada "'$sects[$sx]' " . 20328fac9c7bSMasahiro Yamada "description in '$decl_name'\n"; 20338fac9c7bSMasahiro Yamada ++$warnings; 20348fac9c7bSMasahiro Yamada } else { 20358fac9c7bSMasahiro Yamada if ($nested !~ m/\Q$sects[$sx]\E/) { 20368fac9c7bSMasahiro Yamada print STDERR "Warning(${file}:$.): " . 20378fac9c7bSMasahiro Yamada "Excess struct/union/enum/typedef member " . 20388fac9c7bSMasahiro Yamada "'$sects[$sx]' " . 20398fac9c7bSMasahiro Yamada "description in '$decl_name'\n"; 20408fac9c7bSMasahiro Yamada ++$warnings; 20418fac9c7bSMasahiro Yamada } 20428fac9c7bSMasahiro Yamada } 20438fac9c7bSMasahiro Yamada } 20448fac9c7bSMasahiro Yamada } 20458fac9c7bSMasahiro Yamada} 20468fac9c7bSMasahiro Yamada 20478fac9c7bSMasahiro Yamada## 2048ced03298SMasahiro Yamada# Checks the section describing the return value of a function. 2049ced03298SMasahiro Yamadasub check_return_section { 2050ced03298SMasahiro Yamada my $file = shift; 2051ced03298SMasahiro Yamada my $declaration_name = shift; 2052ced03298SMasahiro Yamada my $return_type = shift; 2053ced03298SMasahiro Yamada 2054ced03298SMasahiro Yamada # Ignore an empty return type (It's a macro) 2055ced03298SMasahiro Yamada # Ignore functions with a "void" return type. (But don't ignore "void *") 2056ced03298SMasahiro Yamada if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) { 2057ced03298SMasahiro Yamada return; 2058ced03298SMasahiro Yamada } 2059ced03298SMasahiro Yamada 2060ced03298SMasahiro Yamada if (!defined($sections{$section_return}) || 2061ced03298SMasahiro Yamada $sections{$section_return} eq "") { 2062ced03298SMasahiro Yamada print STDERR "Warning(${file}:$.): " . 2063ced03298SMasahiro Yamada "No description found for return value of " . 2064ced03298SMasahiro Yamada "'$declaration_name'\n"; 2065ced03298SMasahiro Yamada ++$warnings; 2066ced03298SMasahiro Yamada } 2067ced03298SMasahiro Yamada} 2068ced03298SMasahiro Yamada 2069ced03298SMasahiro Yamada## 20708fac9c7bSMasahiro Yamada# takes a function prototype and the name of the current file being 20718fac9c7bSMasahiro Yamada# processed and spits out all the details stored in the global 20728fac9c7bSMasahiro Yamada# arrays/hashes. 20738fac9c7bSMasahiro Yamadasub dump_function($$) { 20748fac9c7bSMasahiro Yamada my $prototype = shift; 20758fac9c7bSMasahiro Yamada my $file = shift; 2076*176d0982SMasahiro Yamada my $noret = 0; 20778fac9c7bSMasahiro Yamada 20788fac9c7bSMasahiro Yamada $prototype =~ s/^static +//; 20798fac9c7bSMasahiro Yamada $prototype =~ s/^extern +//; 20808fac9c7bSMasahiro Yamada $prototype =~ s/^asmlinkage +//; 20818fac9c7bSMasahiro Yamada $prototype =~ s/^inline +//; 20828fac9c7bSMasahiro Yamada $prototype =~ s/^__inline__ +//; 20838fac9c7bSMasahiro Yamada $prototype =~ s/^__inline +//; 20848fac9c7bSMasahiro Yamada $prototype =~ s/^__always_inline +//; 20858fac9c7bSMasahiro Yamada $prototype =~ s/^noinline +//; 20868fac9c7bSMasahiro Yamada $prototype =~ s/__init +//; 20878fac9c7bSMasahiro Yamada $prototype =~ s/__init_or_module +//; 2088*176d0982SMasahiro Yamada $prototype =~ s/__meminit +//; 20898fac9c7bSMasahiro Yamada $prototype =~ s/__must_check +//; 20908fac9c7bSMasahiro Yamada $prototype =~ s/__weak +//; 2091*176d0982SMasahiro Yamada my $define = $prototype =~ s/^#\s*define\s+//; #ak added 20928fac9c7bSMasahiro Yamada $prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//; 20938fac9c7bSMasahiro Yamada 20948fac9c7bSMasahiro Yamada # Yes, this truly is vile. We are looking for: 20958fac9c7bSMasahiro Yamada # 1. Return type (may be nothing if we're looking at a macro) 20968fac9c7bSMasahiro Yamada # 2. Function name 20978fac9c7bSMasahiro Yamada # 3. Function parameters. 20988fac9c7bSMasahiro Yamada # 20998fac9c7bSMasahiro Yamada # All the while we have to watch out for function pointer parameters 21008fac9c7bSMasahiro Yamada # (which IIRC is what the two sections are for), C types (these 21018fac9c7bSMasahiro Yamada # regexps don't even start to express all the possibilities), and 21028fac9c7bSMasahiro Yamada # so on. 21038fac9c7bSMasahiro Yamada # 21048fac9c7bSMasahiro Yamada # If you mess with these regexps, it's a good idea to check that 21058fac9c7bSMasahiro Yamada # the following functions' documentation still comes out right: 21068fac9c7bSMasahiro Yamada # - parport_register_device (function pointer parameters) 21078fac9c7bSMasahiro Yamada # - atomic_set (macro) 21088fac9c7bSMasahiro Yamada # - pci_match_device, __copy_to_user (long return type) 21098fac9c7bSMasahiro Yamada 2110*176d0982SMasahiro Yamada if ($define && $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s+/) { 2111*176d0982SMasahiro Yamada # This is an object-like macro, it has no return type and no parameter 2112*176d0982SMasahiro Yamada # list. 2113*176d0982SMasahiro Yamada # Function-like macros are not allowed to have spaces between 2114*176d0982SMasahiro Yamada # declaration_name and opening parenthesis (notice the \s+). 2115*176d0982SMasahiro Yamada $return_type = $1; 2116*176d0982SMasahiro Yamada $declaration_name = $2; 2117*176d0982SMasahiro Yamada $noret = 1; 2118*176d0982SMasahiro Yamada } elsif ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 21198fac9c7bSMasahiro Yamada $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 21208fac9c7bSMasahiro Yamada $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 21218fac9c7bSMasahiro Yamada $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 21228fac9c7bSMasahiro Yamada $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 21238fac9c7bSMasahiro Yamada $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 21248fac9c7bSMasahiro Yamada $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || 21258fac9c7bSMasahiro Yamada $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 21268fac9c7bSMasahiro Yamada $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 21278fac9c7bSMasahiro Yamada $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 21288fac9c7bSMasahiro Yamada $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 21298fac9c7bSMasahiro Yamada $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 21308fac9c7bSMasahiro Yamada $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 21318fac9c7bSMasahiro Yamada $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 21328fac9c7bSMasahiro Yamada $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 21338fac9c7bSMasahiro Yamada $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || 21348fac9c7bSMasahiro Yamada $prototype =~ m/^(\w+\s+\w+\s*\*\s*\w+\s*\*\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) { 21358fac9c7bSMasahiro Yamada $return_type = $1; 21368fac9c7bSMasahiro Yamada $declaration_name = $2; 21378fac9c7bSMasahiro Yamada my $args = $3; 21388fac9c7bSMasahiro Yamada 21398fac9c7bSMasahiro Yamada create_parameterlist($args, ',', $file); 21408fac9c7bSMasahiro Yamada } else { 2141ced03298SMasahiro Yamada print STDERR "Warning(${file}:$.): cannot understand function prototype: '$prototype'\n"; 21428fac9c7bSMasahiro Yamada return; 21438fac9c7bSMasahiro Yamada } 21448fac9c7bSMasahiro Yamada 21458fac9c7bSMasahiro Yamada my $prms = join " ", @parameterlist; 21468fac9c7bSMasahiro Yamada check_sections($file, $declaration_name, "function", $sectcheck, $prms, ""); 21478fac9c7bSMasahiro Yamada 2148ced03298SMasahiro Yamada # This check emits a lot of warnings at the moment, because many 2149ced03298SMasahiro Yamada # functions don't have a 'Return' doc section. So until the number 2150ced03298SMasahiro Yamada # of warnings goes sufficiently down, the check is only performed in 2151ced03298SMasahiro Yamada # verbose mode. 2152ced03298SMasahiro Yamada # TODO: always perform the check. 2153*176d0982SMasahiro Yamada if ($verbose && !$noret) { 2154ced03298SMasahiro Yamada check_return_section($file, $declaration_name, $return_type); 2155ced03298SMasahiro Yamada } 2156ced03298SMasahiro Yamada 21578fac9c7bSMasahiro Yamada output_declaration($declaration_name, 21588fac9c7bSMasahiro Yamada 'function', 21598fac9c7bSMasahiro Yamada {'function' => $declaration_name, 21608fac9c7bSMasahiro Yamada 'module' => $modulename, 21618fac9c7bSMasahiro Yamada 'functiontype' => $return_type, 21628fac9c7bSMasahiro Yamada 'parameterlist' => \@parameterlist, 21638fac9c7bSMasahiro Yamada 'parameterdescs' => \%parameterdescs, 21648fac9c7bSMasahiro Yamada 'parametertypes' => \%parametertypes, 21658fac9c7bSMasahiro Yamada 'sectionlist' => \@sectionlist, 21668fac9c7bSMasahiro Yamada 'sections' => \%sections, 21678fac9c7bSMasahiro Yamada 'purpose' => $declaration_purpose 21688fac9c7bSMasahiro Yamada }); 21698fac9c7bSMasahiro Yamada} 21708fac9c7bSMasahiro Yamada 21718fac9c7bSMasahiro Yamadasub reset_state { 21728fac9c7bSMasahiro Yamada $function = ""; 21738fac9c7bSMasahiro Yamada %constants = (); 21748fac9c7bSMasahiro Yamada %parameterdescs = (); 21758fac9c7bSMasahiro Yamada %parametertypes = (); 21768fac9c7bSMasahiro Yamada @parameterlist = (); 21778fac9c7bSMasahiro Yamada %sections = (); 21788fac9c7bSMasahiro Yamada @sectionlist = (); 21798fac9c7bSMasahiro Yamada $sectcheck = ""; 21808fac9c7bSMasahiro Yamada $struct_actual = ""; 21818fac9c7bSMasahiro Yamada $prototype = ""; 21828fac9c7bSMasahiro Yamada 21838fac9c7bSMasahiro Yamada $state = 0; 21848fac9c7bSMasahiro Yamada} 21858fac9c7bSMasahiro Yamada 21868fac9c7bSMasahiro Yamadasub tracepoint_munge($) { 21878fac9c7bSMasahiro Yamada my $file = shift; 21888fac9c7bSMasahiro Yamada my $tracepointname = 0; 21898fac9c7bSMasahiro Yamada my $tracepointargs = 0; 21908fac9c7bSMasahiro Yamada 21918fac9c7bSMasahiro Yamada if ($prototype =~ m/TRACE_EVENT\((.*?),/) { 21928fac9c7bSMasahiro Yamada $tracepointname = $1; 21938fac9c7bSMasahiro Yamada } 21948fac9c7bSMasahiro Yamada if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) { 21958fac9c7bSMasahiro Yamada $tracepointname = $1; 21968fac9c7bSMasahiro Yamada } 21978fac9c7bSMasahiro Yamada if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) { 21988fac9c7bSMasahiro Yamada $tracepointname = $2; 21998fac9c7bSMasahiro Yamada } 22008fac9c7bSMasahiro Yamada $tracepointname =~ s/^\s+//; #strip leading whitespace 22018fac9c7bSMasahiro Yamada if ($prototype =~ m/TP_PROTO\((.*?)\)/) { 22028fac9c7bSMasahiro Yamada $tracepointargs = $1; 22038fac9c7bSMasahiro Yamada } 22048fac9c7bSMasahiro Yamada if (($tracepointname eq 0) || ($tracepointargs eq 0)) { 22058fac9c7bSMasahiro Yamada print STDERR "Warning(${file}:$.): Unrecognized tracepoint format: \n". 22068fac9c7bSMasahiro Yamada "$prototype\n"; 22078fac9c7bSMasahiro Yamada } else { 22088fac9c7bSMasahiro Yamada $prototype = "static inline void trace_$tracepointname($tracepointargs)"; 22098fac9c7bSMasahiro Yamada } 22108fac9c7bSMasahiro Yamada} 22118fac9c7bSMasahiro Yamada 22128fac9c7bSMasahiro Yamadasub syscall_munge() { 22138fac9c7bSMasahiro Yamada my $void = 0; 22148fac9c7bSMasahiro Yamada 22158fac9c7bSMasahiro Yamada $prototype =~ s@[\r\n\t]+@ @gos; # strip newlines/CR's/tabs 22168fac9c7bSMasahiro Yamada## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) { 22178fac9c7bSMasahiro Yamada if ($prototype =~ m/SYSCALL_DEFINE0/) { 22188fac9c7bSMasahiro Yamada $void = 1; 22198fac9c7bSMasahiro Yamada## $prototype = "long sys_$1(void)"; 22208fac9c7bSMasahiro Yamada } 22218fac9c7bSMasahiro Yamada 22228fac9c7bSMasahiro Yamada $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name 22238fac9c7bSMasahiro Yamada if ($prototype =~ m/long (sys_.*?),/) { 22248fac9c7bSMasahiro Yamada $prototype =~ s/,/\(/; 22258fac9c7bSMasahiro Yamada } elsif ($void) { 22268fac9c7bSMasahiro Yamada $prototype =~ s/\)/\(void\)/; 22278fac9c7bSMasahiro Yamada } 22288fac9c7bSMasahiro Yamada 22298fac9c7bSMasahiro Yamada # now delete all of the odd-number commas in $prototype 22308fac9c7bSMasahiro Yamada # so that arg types & arg names don't have a comma between them 22318fac9c7bSMasahiro Yamada my $count = 0; 22328fac9c7bSMasahiro Yamada my $len = length($prototype); 22338fac9c7bSMasahiro Yamada if ($void) { 22348fac9c7bSMasahiro Yamada $len = 0; # skip the for-loop 22358fac9c7bSMasahiro Yamada } 22368fac9c7bSMasahiro Yamada for (my $ix = 0; $ix < $len; $ix++) { 22378fac9c7bSMasahiro Yamada if (substr($prototype, $ix, 1) eq ',') { 22388fac9c7bSMasahiro Yamada $count++; 22398fac9c7bSMasahiro Yamada if ($count % 2 == 1) { 22408fac9c7bSMasahiro Yamada substr($prototype, $ix, 1) = ' '; 22418fac9c7bSMasahiro Yamada } 22428fac9c7bSMasahiro Yamada } 22438fac9c7bSMasahiro Yamada } 22448fac9c7bSMasahiro Yamada} 22458fac9c7bSMasahiro Yamada 22468fac9c7bSMasahiro Yamadasub process_state3_function($$) { 22478fac9c7bSMasahiro Yamada my $x = shift; 22488fac9c7bSMasahiro Yamada my $file = shift; 22498fac9c7bSMasahiro Yamada 22508fac9c7bSMasahiro Yamada $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line 22518fac9c7bSMasahiro Yamada 22528fac9c7bSMasahiro Yamada if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) { 22538fac9c7bSMasahiro Yamada # do nothing 22548fac9c7bSMasahiro Yamada } 22558fac9c7bSMasahiro Yamada elsif ($x =~ /([^\{]*)/) { 22568fac9c7bSMasahiro Yamada $prototype .= $1; 22578fac9c7bSMasahiro Yamada } 22588fac9c7bSMasahiro Yamada 22598fac9c7bSMasahiro Yamada if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) { 22608fac9c7bSMasahiro Yamada $prototype =~ s@/\*.*?\*/@@gos; # strip comments. 22618fac9c7bSMasahiro Yamada $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's. 22628fac9c7bSMasahiro Yamada $prototype =~ s@^\s+@@gos; # strip leading spaces 22638fac9c7bSMasahiro Yamada if ($prototype =~ /SYSCALL_DEFINE/) { 22648fac9c7bSMasahiro Yamada syscall_munge(); 22658fac9c7bSMasahiro Yamada } 22668fac9c7bSMasahiro Yamada if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ || 22678fac9c7bSMasahiro Yamada $prototype =~ /DEFINE_SINGLE_EVENT/) 22688fac9c7bSMasahiro Yamada { 22698fac9c7bSMasahiro Yamada tracepoint_munge($file); 22708fac9c7bSMasahiro Yamada } 22718fac9c7bSMasahiro Yamada dump_function($prototype, $file); 22728fac9c7bSMasahiro Yamada reset_state(); 22738fac9c7bSMasahiro Yamada } 22748fac9c7bSMasahiro Yamada} 22758fac9c7bSMasahiro Yamada 22768fac9c7bSMasahiro Yamadasub process_state3_type($$) { 22778fac9c7bSMasahiro Yamada my $x = shift; 22788fac9c7bSMasahiro Yamada my $file = shift; 22798fac9c7bSMasahiro Yamada 22808fac9c7bSMasahiro Yamada $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's. 22818fac9c7bSMasahiro Yamada $x =~ s@^\s+@@gos; # strip leading spaces 22828fac9c7bSMasahiro Yamada $x =~ s@\s+$@@gos; # strip trailing spaces 22838fac9c7bSMasahiro Yamada $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line 22848fac9c7bSMasahiro Yamada 22858fac9c7bSMasahiro Yamada if ($x =~ /^#/) { 22868fac9c7bSMasahiro Yamada # To distinguish preprocessor directive from regular declaration later. 22878fac9c7bSMasahiro Yamada $x .= ";"; 22888fac9c7bSMasahiro Yamada } 22898fac9c7bSMasahiro Yamada 22908fac9c7bSMasahiro Yamada while (1) { 22918fac9c7bSMasahiro Yamada if ( $x =~ /([^{};]*)([{};])(.*)/ ) { 22928fac9c7bSMasahiro Yamada $prototype .= $1 . $2; 22938fac9c7bSMasahiro Yamada ($2 eq '{') && $brcount++; 22948fac9c7bSMasahiro Yamada ($2 eq '}') && $brcount--; 22958fac9c7bSMasahiro Yamada if (($2 eq ';') && ($brcount == 0)) { 22968fac9c7bSMasahiro Yamada dump_declaration($prototype, $file); 22978fac9c7bSMasahiro Yamada reset_state(); 22988fac9c7bSMasahiro Yamada last; 22998fac9c7bSMasahiro Yamada } 23008fac9c7bSMasahiro Yamada $x = $3; 23018fac9c7bSMasahiro Yamada } else { 23028fac9c7bSMasahiro Yamada $prototype .= $x; 23038fac9c7bSMasahiro Yamada last; 23048fac9c7bSMasahiro Yamada } 23058fac9c7bSMasahiro Yamada } 23068fac9c7bSMasahiro Yamada} 23078fac9c7bSMasahiro Yamada 23088fac9c7bSMasahiro Yamada# xml_escape: replace <, >, and & in the text stream; 23098fac9c7bSMasahiro Yamada# 23108fac9c7bSMasahiro Yamada# however, formatting controls that are generated internally/locally in the 23118fac9c7bSMasahiro Yamada# kernel-doc script are not escaped here; instead, they begin life like 23128fac9c7bSMasahiro Yamada# $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings 23138fac9c7bSMasahiro Yamada# are converted to their mnemonic-expected output, without the 4 * '\' & ':', 23148fac9c7bSMasahiro Yamada# just before actual output; (this is done by local_unescape()) 23158fac9c7bSMasahiro Yamadasub xml_escape($) { 23168fac9c7bSMasahiro Yamada my $text = shift; 23178fac9c7bSMasahiro Yamada if (($output_mode eq "text") || ($output_mode eq "man")) { 23188fac9c7bSMasahiro Yamada return $text; 23198fac9c7bSMasahiro Yamada } 23208fac9c7bSMasahiro Yamada $text =~ s/\&/\\\\\\amp;/g; 23218fac9c7bSMasahiro Yamada $text =~ s/\</\\\\\\lt;/g; 23228fac9c7bSMasahiro Yamada $text =~ s/\>/\\\\\\gt;/g; 23238fac9c7bSMasahiro Yamada return $text; 23248fac9c7bSMasahiro Yamada} 23258fac9c7bSMasahiro Yamada 23268fac9c7bSMasahiro Yamada# convert local escape strings to html 23278fac9c7bSMasahiro Yamada# local escape strings look like: '\\\\menmonic:' (that's 4 backslashes) 23288fac9c7bSMasahiro Yamadasub local_unescape($) { 23298fac9c7bSMasahiro Yamada my $text = shift; 23308fac9c7bSMasahiro Yamada if (($output_mode eq "text") || ($output_mode eq "man")) { 23318fac9c7bSMasahiro Yamada return $text; 23328fac9c7bSMasahiro Yamada } 23338fac9c7bSMasahiro Yamada $text =~ s/\\\\\\\\lt:/</g; 23348fac9c7bSMasahiro Yamada $text =~ s/\\\\\\\\gt:/>/g; 23358fac9c7bSMasahiro Yamada return $text; 23368fac9c7bSMasahiro Yamada} 23378fac9c7bSMasahiro Yamada 23388fac9c7bSMasahiro Yamadasub process_file($) { 23398fac9c7bSMasahiro Yamada my $file; 23408fac9c7bSMasahiro Yamada my $identifier; 23418fac9c7bSMasahiro Yamada my $func; 23428fac9c7bSMasahiro Yamada my $descr; 23438fac9c7bSMasahiro Yamada my $in_purpose = 0; 23448fac9c7bSMasahiro Yamada my $initial_section_counter = $section_counter; 23458fac9c7bSMasahiro Yamada 23468fac9c7bSMasahiro Yamada if (defined($ENV{'SRCTREE'})) { 23478fac9c7bSMasahiro Yamada $file = "$ENV{'SRCTREE'}" . "/" . "@_"; 23488fac9c7bSMasahiro Yamada } 23498fac9c7bSMasahiro Yamada else { 23508fac9c7bSMasahiro Yamada $file = "@_"; 23518fac9c7bSMasahiro Yamada } 23528fac9c7bSMasahiro Yamada if (defined($source_map{$file})) { 23538fac9c7bSMasahiro Yamada $file = $source_map{$file}; 23548fac9c7bSMasahiro Yamada } 23558fac9c7bSMasahiro Yamada 23568fac9c7bSMasahiro Yamada if (!open(IN,"<$file")) { 23578fac9c7bSMasahiro Yamada print STDERR "Error: Cannot open file $file\n"; 23588fac9c7bSMasahiro Yamada ++$errors; 23598fac9c7bSMasahiro Yamada return; 23608fac9c7bSMasahiro Yamada } 23618fac9c7bSMasahiro Yamada 23628fac9c7bSMasahiro Yamada $. = 1; 23638fac9c7bSMasahiro Yamada 23648fac9c7bSMasahiro Yamada $section_counter = 0; 23658fac9c7bSMasahiro Yamada while (<IN>) { 2366ced03298SMasahiro Yamada while (s/\\\s*$//) { 2367ced03298SMasahiro Yamada $_ .= <IN>; 2368ced03298SMasahiro Yamada } 23698fac9c7bSMasahiro Yamada if ($state == 0) { 23708fac9c7bSMasahiro Yamada if (/$doc_start/o) { 23718fac9c7bSMasahiro Yamada $state = 1; # next line is always the function name 23728fac9c7bSMasahiro Yamada $in_doc_sect = 0; 23738fac9c7bSMasahiro Yamada } 23748fac9c7bSMasahiro Yamada } elsif ($state == 1) { # this line is the function name (always) 23758fac9c7bSMasahiro Yamada if (/$doc_block/o) { 23768fac9c7bSMasahiro Yamada $state = 4; 23778fac9c7bSMasahiro Yamada $contents = ""; 23788fac9c7bSMasahiro Yamada if ( $1 eq "" ) { 23798fac9c7bSMasahiro Yamada $section = $section_intro; 23808fac9c7bSMasahiro Yamada } else { 23818fac9c7bSMasahiro Yamada $section = $1; 23828fac9c7bSMasahiro Yamada } 23838fac9c7bSMasahiro Yamada } 23848fac9c7bSMasahiro Yamada elsif (/$doc_decl/o) { 23858fac9c7bSMasahiro Yamada $identifier = $1; 23868fac9c7bSMasahiro Yamada if (/\s*([\w\s]+?)\s*-/) { 23878fac9c7bSMasahiro Yamada $identifier = $1; 23888fac9c7bSMasahiro Yamada } 23898fac9c7bSMasahiro Yamada 23908fac9c7bSMasahiro Yamada $state = 2; 23918fac9c7bSMasahiro Yamada if (/-(.*)/) { 23928fac9c7bSMasahiro Yamada # strip leading/trailing/multiple spaces 23938fac9c7bSMasahiro Yamada $descr= $1; 23948fac9c7bSMasahiro Yamada $descr =~ s/^\s*//; 23958fac9c7bSMasahiro Yamada $descr =~ s/\s*$//; 2396ced03298SMasahiro Yamada $descr =~ s/\s+/ /g; 23978fac9c7bSMasahiro Yamada $declaration_purpose = xml_escape($descr); 23988fac9c7bSMasahiro Yamada $in_purpose = 1; 23998fac9c7bSMasahiro Yamada } else { 24008fac9c7bSMasahiro Yamada $declaration_purpose = ""; 24018fac9c7bSMasahiro Yamada } 24028fac9c7bSMasahiro Yamada 24038fac9c7bSMasahiro Yamada if (($declaration_purpose eq "") && $verbose) { 24048fac9c7bSMasahiro Yamada print STDERR "Warning(${file}:$.): missing initial short description on line:\n"; 24058fac9c7bSMasahiro Yamada print STDERR $_; 24068fac9c7bSMasahiro Yamada ++$warnings; 24078fac9c7bSMasahiro Yamada } 24088fac9c7bSMasahiro Yamada 24098fac9c7bSMasahiro Yamada if ($identifier =~ m/^struct/) { 24108fac9c7bSMasahiro Yamada $decl_type = 'struct'; 24118fac9c7bSMasahiro Yamada } elsif ($identifier =~ m/^union/) { 24128fac9c7bSMasahiro Yamada $decl_type = 'union'; 24138fac9c7bSMasahiro Yamada } elsif ($identifier =~ m/^enum/) { 24148fac9c7bSMasahiro Yamada $decl_type = 'enum'; 24158fac9c7bSMasahiro Yamada } elsif ($identifier =~ m/^typedef/) { 24168fac9c7bSMasahiro Yamada $decl_type = 'typedef'; 24178fac9c7bSMasahiro Yamada } else { 24188fac9c7bSMasahiro Yamada $decl_type = 'function'; 24198fac9c7bSMasahiro Yamada } 24208fac9c7bSMasahiro Yamada 24218fac9c7bSMasahiro Yamada if ($verbose) { 24228fac9c7bSMasahiro Yamada print STDERR "Info(${file}:$.): Scanning doc for $identifier\n"; 24238fac9c7bSMasahiro Yamada } 24248fac9c7bSMasahiro Yamada } else { 24258fac9c7bSMasahiro Yamada print STDERR "Warning(${file}:$.): Cannot understand $_ on line $.", 24268fac9c7bSMasahiro Yamada " - I thought it was a doc line\n"; 24278fac9c7bSMasahiro Yamada ++$warnings; 24288fac9c7bSMasahiro Yamada $state = 0; 24298fac9c7bSMasahiro Yamada } 24308fac9c7bSMasahiro Yamada } elsif ($state == 2) { # look for head: lines, and include content 24318fac9c7bSMasahiro Yamada if (/$doc_sect/o) { 24328fac9c7bSMasahiro Yamada $newsection = $1; 24338fac9c7bSMasahiro Yamada $newcontents = $2; 24348fac9c7bSMasahiro Yamada 24358fac9c7bSMasahiro Yamada if (($contents ne "") && ($contents ne "\n")) { 24368fac9c7bSMasahiro Yamada if (!$in_doc_sect && $verbose) { 24378fac9c7bSMasahiro Yamada print STDERR "Warning(${file}:$.): contents before sections\n"; 24388fac9c7bSMasahiro Yamada ++$warnings; 24398fac9c7bSMasahiro Yamada } 24408fac9c7bSMasahiro Yamada dump_section($file, $section, xml_escape($contents)); 24418fac9c7bSMasahiro Yamada $section = $section_default; 24428fac9c7bSMasahiro Yamada } 24438fac9c7bSMasahiro Yamada 24448fac9c7bSMasahiro Yamada $in_doc_sect = 1; 24458fac9c7bSMasahiro Yamada $in_purpose = 0; 24468fac9c7bSMasahiro Yamada $contents = $newcontents; 24478fac9c7bSMasahiro Yamada if ($contents ne "") { 24488fac9c7bSMasahiro Yamada while ((substr($contents, 0, 1) eq " ") || 24498fac9c7bSMasahiro Yamada substr($contents, 0, 1) eq "\t") { 24508fac9c7bSMasahiro Yamada $contents = substr($contents, 1); 24518fac9c7bSMasahiro Yamada } 24528fac9c7bSMasahiro Yamada $contents .= "\n"; 24538fac9c7bSMasahiro Yamada } 24548fac9c7bSMasahiro Yamada $section = $newsection; 24558fac9c7bSMasahiro Yamada } elsif (/$doc_end/) { 24568fac9c7bSMasahiro Yamada 24578fac9c7bSMasahiro Yamada if (($contents ne "") && ($contents ne "\n")) { 24588fac9c7bSMasahiro Yamada dump_section($file, $section, xml_escape($contents)); 24598fac9c7bSMasahiro Yamada $section = $section_default; 24608fac9c7bSMasahiro Yamada $contents = ""; 24618fac9c7bSMasahiro Yamada } 24628fac9c7bSMasahiro Yamada # look for doc_com + <text> + doc_end: 24638fac9c7bSMasahiro Yamada if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') { 24648fac9c7bSMasahiro Yamada print STDERR "Warning(${file}:$.): suspicious ending line: $_"; 24658fac9c7bSMasahiro Yamada ++$warnings; 24668fac9c7bSMasahiro Yamada } 24678fac9c7bSMasahiro Yamada 24688fac9c7bSMasahiro Yamada $prototype = ""; 24698fac9c7bSMasahiro Yamada $state = 3; 24708fac9c7bSMasahiro Yamada $brcount = 0; 24718fac9c7bSMasahiro Yamada# print STDERR "end of doc comment, looking for prototype\n"; 24728fac9c7bSMasahiro Yamada } elsif (/$doc_content/) { 24738fac9c7bSMasahiro Yamada # miguel-style comment kludge, look for blank lines after 24748fac9c7bSMasahiro Yamada # @parameter line to signify start of description 24758fac9c7bSMasahiro Yamada if ($1 eq "") { 24768fac9c7bSMasahiro Yamada if ($section =~ m/^@/ || $section eq $section_context) { 24778fac9c7bSMasahiro Yamada dump_section($file, $section, xml_escape($contents)); 24788fac9c7bSMasahiro Yamada $section = $section_default; 24798fac9c7bSMasahiro Yamada $contents = ""; 24808fac9c7bSMasahiro Yamada } else { 24818fac9c7bSMasahiro Yamada $contents .= "\n"; 24828fac9c7bSMasahiro Yamada } 24838fac9c7bSMasahiro Yamada $in_purpose = 0; 24848fac9c7bSMasahiro Yamada } elsif ($in_purpose == 1) { 24858fac9c7bSMasahiro Yamada # Continued declaration purpose 24868fac9c7bSMasahiro Yamada chomp($declaration_purpose); 24878fac9c7bSMasahiro Yamada $declaration_purpose .= " " . xml_escape($1); 2488ced03298SMasahiro Yamada $declaration_purpose =~ s/\s+/ /g; 24898fac9c7bSMasahiro Yamada } else { 24908fac9c7bSMasahiro Yamada $contents .= $1 . "\n"; 24918fac9c7bSMasahiro Yamada } 24928fac9c7bSMasahiro Yamada } else { 24938fac9c7bSMasahiro Yamada # i dont know - bad line? ignore. 24948fac9c7bSMasahiro Yamada print STDERR "Warning(${file}:$.): bad line: $_"; 24958fac9c7bSMasahiro Yamada ++$warnings; 24968fac9c7bSMasahiro Yamada } 24978fac9c7bSMasahiro Yamada } elsif ($state == 3) { # scanning for function '{' (end of prototype) 24988fac9c7bSMasahiro Yamada if ($decl_type eq 'function') { 24998fac9c7bSMasahiro Yamada process_state3_function($_, $file); 25008fac9c7bSMasahiro Yamada } else { 25018fac9c7bSMasahiro Yamada process_state3_type($_, $file); 25028fac9c7bSMasahiro Yamada } 25038fac9c7bSMasahiro Yamada } elsif ($state == 4) { 25048fac9c7bSMasahiro Yamada # Documentation block 25058fac9c7bSMasahiro Yamada if (/$doc_block/) { 25068fac9c7bSMasahiro Yamada dump_doc_section($file, $section, xml_escape($contents)); 25078fac9c7bSMasahiro Yamada $contents = ""; 25088fac9c7bSMasahiro Yamada $function = ""; 25098fac9c7bSMasahiro Yamada %constants = (); 25108fac9c7bSMasahiro Yamada %parameterdescs = (); 25118fac9c7bSMasahiro Yamada %parametertypes = (); 25128fac9c7bSMasahiro Yamada @parameterlist = (); 25138fac9c7bSMasahiro Yamada %sections = (); 25148fac9c7bSMasahiro Yamada @sectionlist = (); 25158fac9c7bSMasahiro Yamada $prototype = ""; 25168fac9c7bSMasahiro Yamada if ( $1 eq "" ) { 25178fac9c7bSMasahiro Yamada $section = $section_intro; 25188fac9c7bSMasahiro Yamada } else { 25198fac9c7bSMasahiro Yamada $section = $1; 25208fac9c7bSMasahiro Yamada } 25218fac9c7bSMasahiro Yamada } 25228fac9c7bSMasahiro Yamada elsif (/$doc_end/) 25238fac9c7bSMasahiro Yamada { 25248fac9c7bSMasahiro Yamada dump_doc_section($file, $section, xml_escape($contents)); 25258fac9c7bSMasahiro Yamada $contents = ""; 25268fac9c7bSMasahiro Yamada $function = ""; 25278fac9c7bSMasahiro Yamada %constants = (); 25288fac9c7bSMasahiro Yamada %parameterdescs = (); 25298fac9c7bSMasahiro Yamada %parametertypes = (); 25308fac9c7bSMasahiro Yamada @parameterlist = (); 25318fac9c7bSMasahiro Yamada %sections = (); 25328fac9c7bSMasahiro Yamada @sectionlist = (); 25338fac9c7bSMasahiro Yamada $prototype = ""; 25348fac9c7bSMasahiro Yamada $state = 0; 25358fac9c7bSMasahiro Yamada } 25368fac9c7bSMasahiro Yamada elsif (/$doc_content/) 25378fac9c7bSMasahiro Yamada { 25388fac9c7bSMasahiro Yamada if ( $1 eq "" ) 25398fac9c7bSMasahiro Yamada { 25408fac9c7bSMasahiro Yamada $contents .= $blankline; 25418fac9c7bSMasahiro Yamada } 25428fac9c7bSMasahiro Yamada else 25438fac9c7bSMasahiro Yamada { 25448fac9c7bSMasahiro Yamada $contents .= $1 . "\n"; 25458fac9c7bSMasahiro Yamada } 25468fac9c7bSMasahiro Yamada } 25478fac9c7bSMasahiro Yamada } 25488fac9c7bSMasahiro Yamada } 25498fac9c7bSMasahiro Yamada if ($initial_section_counter == $section_counter) { 25508fac9c7bSMasahiro Yamada print STDERR "Warning(${file}): no structured comments found\n"; 2551ced03298SMasahiro Yamada if (($function_only == 1) && ($show_not_found == 1)) { 2552ced03298SMasahiro Yamada print STDERR " Was looking for '$_'.\n" for keys %function_table; 2553ced03298SMasahiro Yamada } 25548fac9c7bSMasahiro Yamada if ($output_mode eq "xml") { 25558fac9c7bSMasahiro Yamada # The template wants at least one RefEntry here; make one. 25568fac9c7bSMasahiro Yamada print "<refentry>\n"; 25578fac9c7bSMasahiro Yamada print " <refnamediv>\n"; 25588fac9c7bSMasahiro Yamada print " <refname>\n"; 25598fac9c7bSMasahiro Yamada print " ${file}\n"; 25608fac9c7bSMasahiro Yamada print " </refname>\n"; 25618fac9c7bSMasahiro Yamada print " <refpurpose>\n"; 25628fac9c7bSMasahiro Yamada print " Document generation inconsistency\n"; 25638fac9c7bSMasahiro Yamada print " </refpurpose>\n"; 25648fac9c7bSMasahiro Yamada print " </refnamediv>\n"; 25658fac9c7bSMasahiro Yamada print " <refsect1>\n"; 25668fac9c7bSMasahiro Yamada print " <title>\n"; 25678fac9c7bSMasahiro Yamada print " Oops\n"; 25688fac9c7bSMasahiro Yamada print " </title>\n"; 25698fac9c7bSMasahiro Yamada print " <warning>\n"; 25708fac9c7bSMasahiro Yamada print " <para>\n"; 25718fac9c7bSMasahiro Yamada print " The template for this document tried to insert\n"; 25728fac9c7bSMasahiro Yamada print " the structured comment from the file\n"; 25738fac9c7bSMasahiro Yamada print " <filename>${file}</filename> at this point,\n"; 25748fac9c7bSMasahiro Yamada print " but none was found.\n"; 25758fac9c7bSMasahiro Yamada print " This dummy section is inserted to allow\n"; 25768fac9c7bSMasahiro Yamada print " generation to continue.\n"; 25778fac9c7bSMasahiro Yamada print " </para>\n"; 25788fac9c7bSMasahiro Yamada print " </warning>\n"; 25798fac9c7bSMasahiro Yamada print " </refsect1>\n"; 25808fac9c7bSMasahiro Yamada print "</refentry>\n"; 25818fac9c7bSMasahiro Yamada } 25828fac9c7bSMasahiro Yamada } 25838fac9c7bSMasahiro Yamada} 25848fac9c7bSMasahiro Yamada 25858fac9c7bSMasahiro Yamada 25868fac9c7bSMasahiro Yamada$kernelversion = get_kernel_version(); 25878fac9c7bSMasahiro Yamada 25888fac9c7bSMasahiro Yamada# generate a sequence of code that will splice in highlighting information 25898fac9c7bSMasahiro Yamada# using the s// operator. 25908fac9c7bSMasahiro Yamadaforeach my $pattern (keys %highlights) { 25918fac9c7bSMasahiro Yamada# print STDERR "scanning pattern:$pattern, highlight:($highlights{$pattern})\n"; 25928fac9c7bSMasahiro Yamada $dohighlight .= "\$contents =~ s:$pattern:$highlights{$pattern}:gs;\n"; 25938fac9c7bSMasahiro Yamada} 25948fac9c7bSMasahiro Yamada 25958fac9c7bSMasahiro Yamada# Read the file that maps relative names to absolute names for 25968fac9c7bSMasahiro Yamada# separate source and object directories and for shadow trees. 25978fac9c7bSMasahiro Yamadaif (open(SOURCE_MAP, "<.tmp_filelist.txt")) { 25988fac9c7bSMasahiro Yamada my ($relname, $absname); 25998fac9c7bSMasahiro Yamada while(<SOURCE_MAP>) { 26008fac9c7bSMasahiro Yamada chop(); 26018fac9c7bSMasahiro Yamada ($relname, $absname) = (split())[0..1]; 26028fac9c7bSMasahiro Yamada $relname =~ s:^/+::; 26038fac9c7bSMasahiro Yamada $source_map{$relname} = $absname; 26048fac9c7bSMasahiro Yamada } 26058fac9c7bSMasahiro Yamada close(SOURCE_MAP); 26068fac9c7bSMasahiro Yamada} 26078fac9c7bSMasahiro Yamada 26088fac9c7bSMasahiro Yamadaforeach (@ARGV) { 26098fac9c7bSMasahiro Yamada chomp; 26108fac9c7bSMasahiro Yamada process_file($_); 26118fac9c7bSMasahiro Yamada} 26128fac9c7bSMasahiro Yamadaif ($verbose && $errors) { 26138fac9c7bSMasahiro Yamada print STDERR "$errors errors\n"; 26148fac9c7bSMasahiro Yamada} 26158fac9c7bSMasahiro Yamadaif ($verbose && $warnings) { 26168fac9c7bSMasahiro Yamada print STDERR "$warnings warnings\n"; 26178fac9c7bSMasahiro Yamada} 26188fac9c7bSMasahiro Yamada 26198fac9c7bSMasahiro Yamadaexit($errors); 2620