1883 lines · 50.4 KB · Text
RawDownload
    print ".SH SYNOPSIS\n";    print "enum ".$args{'enum'}." {\n";    $count = 0;    foreach my $parameter (@{$args{'parameterlist'}}) {        print ".br\n.BI \"    $parameter\"\n";	if ($count == $#{$args{'parameterlist'}}) {	    print "\n};\n";	    last;	}	else {	    print ", \n.br\n";	}	$count++;    }     print ".SH Constants\n";    foreach $parameter (@{$args{'parameterlist'}}) {	my $parameter_name = $parameter;	$parameter_name =~ s/\[.*//; 	print ".IP \"".$parameter."\" 12\n";	output_highlight($args{'parameterdescs'}{$parameter_name});    }    foreach $section (@{$args{'sectionlist'}}) {	print ".SH \"$section\"\n";	output_highlight($args{'sections'}{$section});    }} ### output struct in mansub output_struct_man(%) {    my %args = %{$_[0]};    my ($parameter, $section);     print ".TH \"$args{'module'}\" 9 \"".$args{'type'}." ".$args{'struct'}."\" \"$man_date\" \"API Manual\" LINUX\n";     print ".SH NAME\n";    print $args{'type'}." ".$args{'struct'}." \\- ".$args{'purpose'}."\n";     print ".SH SYNOPSIS\n";    print $args{'type'}." ".$args{'struct'}." {\n.br\n";     foreach my $parameter (@{$args{'parameterlist'}}) {	if ($parameter =~ /^#/) {	    print ".BI \"$parameter\"\n.br\n";	    next;	}	my $parameter_name = $parameter;	$parameter_name =~ s/\[.*//;         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;	$type = $args{'parametertypes'}{$parameter};	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {	    # pointer-to-function	    print ".BI \"    ".$1."\" ".$parameter." \") (".$2.")"."\"\n;\n";	} elsif ($type =~ m/^(.*?)\s*(:.*)/) {	    print ".BI \"    ".$1."\" ".$parameter.$2." \""."\"\n;\n";	} else {	    $type =~ s/([^\*])$/$1 /;	    print ".BI \"    ".$type."\" ".$parameter." \""."\"\n;\n";	}	print "\n.br\n";    }    print "};\n.br\n";     print ".SH Arguments\n";    foreach $parameter (@{$args{'parameterlist'}}) {	($parameter =~ /^#/) && next; 	my $parameter_name = $parameter;	$parameter_name =~ s/\[.*//;         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;	print ".IP \"".$parameter."\" 12\n";	output_highlight($args{'parameterdescs'}{$parameter_name});    }    foreach $section (@{$args{'sectionlist'}}) {	print ".SH \"$section\"\n";	output_highlight($args{'sections'}{$section});    }} ### output typedef in mansub output_typedef_man(%) {    my %args = %{$_[0]};    my ($parameter, $section);     print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";     print ".SH NAME\n";    print "typedef ".$args{'typedef'}." \\- ".$args{'purpose'}."\n";     foreach $section (@{$args{'sectionlist'}}) {	print ".SH \"$section\"\n";	output_highlight($args{'sections'}{$section});    }} sub output_intro_man(%) {    my %args = %{$_[0]};    my ($parameter, $section);    my $count;     print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";     foreach $section (@{$args{'sectionlist'}}) {	print ".SH \"$section\"\n";	output_highlight($args{'sections'}{$section});    }} ### output in textsub output_function_text(%) {    my %args = %{$_[0]};    my ($parameter, $section);     print "Function:\n\n";    my $start=$args{'functiontype'}." ".$args{'function'}." (";    print $start;    my $count = 0;    foreach my $parameter (@{$args{'parameterlist'}}) {	$type = $args{'parametertypes'}{$parameter};	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {	    # pointer-to-function	    print $1.$parameter.") (".$2;	} else {	    print $type." ".$parameter;	}	if ($count != $#{$args{'parameterlist'}}) {	    $count++;	    print ",\n";	    print " " x length($start);	} else {	    print ");\n\n";	}    }     print "Arguments:\n\n";    foreach $parameter (@{$args{'parameterlist'}}) {	my $parameter_name = $parameter;	$parameter_name =~ s/\[.*//; 	print $parameter."\n\t".$args{'parameterdescs'}{$parameter_name}."\n";    }    output_section_text(@_);} #output sections in textsub output_section_text(%) {    my %args = %{$_[0]};    my $section;     print "\n";    foreach $section (@{$args{'sectionlist'}}) {	print "$section:\n\n";	output_highlight($args{'sections'}{$section});    }    print "\n\n";} # output enum in textsub output_enum_text(%) {    my %args = %{$_[0]};    my ($parameter);    my $count;    print "Enum:\n\n";     print "enum ".$args{'enum'}." {\n";    $count = 0;    foreach $parameter (@{$args{'parameterlist'}}) {        print "\t$parameter";	if ($count != $#{$args{'parameterlist'}}) {	    $count++;	    print ",";	}	print "\n";    }    print "};\n\n";     print "Constants:\n\n";    foreach $parameter (@{$args{'parameterlist'}}) {	print "$parameter\n\t";	print $args{'parameterdescs'}{$parameter}."\n";    }     output_section_text(@_);} # output typedef in textsub output_typedef_text(%) {    my %args = %{$_[0]};    my ($parameter);    my $count;    print "Typedef:\n\n";     print "typedef ".$args{'typedef'}."\n";    output_section_text(@_);} # output struct as textsub output_struct_text(%) {    my %args = %{$_[0]};    my ($parameter);     print $args{'type'}." ".$args{'struct'}.":\n\n";    print $args{'type'}." ".$args{'struct'}." {\n";    foreach $parameter (@{$args{'parameterlist'}}) {	if ($parameter =~ /^#/) {	    print "$parameter\n";	    next;	} 	my $parameter_name = $parameter;	$parameter_name =~ s/\[.*//;         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;	$type = $args{'parametertypes'}{$parameter};	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {	    # pointer-to-function	    print "\t$1 $parameter) ($2);\n";	} elsif ($type =~ m/^(.*?)\s*(:.*)/) {	    print "\t$1 $parameter$2;\n";	} else {	    print "\t".$type." ".$parameter.";\n";	}    }    print "};\n\n";     print "Members:\n\n";    foreach $parameter (@{$args{'parameterlist'}}) {	($parameter =~ /^#/) && next; 	my $parameter_name = $parameter;	$parameter_name =~ s/\[.*//;         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;	print "$parameter\n\t";	print $args{'parameterdescs'}{$parameter_name}."\n";    }    print "\n";    output_section_text(@_);} sub output_intro_text(%) {    my %args = %{$_[0]};    my ($parameter, $section);     foreach $section (@{$args{'sectionlist'}}) {	print " $section:\n";	print "    -> ";	output_highlight($args{'sections'}{$section});    }} ### generic output function for typedefssub output_declaration {    no strict 'refs';    my $name = shift;    my $functype = shift;    my $func = "output_${functype}_$output_mode";    if (($function_only==0) ||	( $function_only == 1 && defined($function_table{$name})) ||	( $function_only == 2 && !defined($function_table{$name})))    {        &$func(@_);	$section_counter++;    }} ### generic output function - calls the right one based# on current output mode.sub output_intro {    no strict 'refs';    my $func = "output_intro_".$output_mode;    &$func(@_);    $section_counter++;} ### takes a declaration (struct, union, enum, typedef) and# invokes the right handler. NOT called for functions.sub dump_declaration($$) {    no strict 'refs';    my ($prototype, $file) = @_;    my $func = "dump_".$decl_type;    &$func(@_);} sub dump_union($$) {    dump_struct(@_);} sub dump_struct($$) {    my $x = shift;    my $file = shift;     if ($x =~/(struct|union)\s+(\w+)\s*{(.*)}/) {        $declaration_name = $2;        my $members = $3; 	# ignore embedded structs or unions	$members =~ s/{.*?}//g; 	# ignore members marked private:	$members =~ s/\/\*.*?private:.*?public:.*?\*\///gos;	$members =~ s/\/\*.*?private:.*//gos;	# strip comments:	$members =~ s/\/\*.*?\*\///gos; 	create_parameterlist($members, ';', $file); 	output_declaration($declaration_name,			   'struct',			   {'struct' => $declaration_name,			    'module' => $modulename,			    'parameterlist' => \@parameterlist,			    'parameterdescs' => \%parameterdescs,			    'parametertypes' => \%parametertypes,			    'sectionlist' => \@sectionlist,			    'sections' => \%sections,			    'purpose' => $declaration_purpose,			    'type' => $decl_type			   });    }    else {        print STDERR "Error(${file}:$.): Cannot parse struct or union!\n";	++$errors;    }} sub dump_enum($$) {    my $x = shift;    my $file = shift;     $x =~ s@/\*.*?\*/@@gos;	# strip comments.    if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {        $declaration_name = $1;        my $members = $2; 	foreach my $arg (split ',', $members) {	    $arg =~ s/^\s*(\w+).*/$1/;	    push @parameterlist, $arg;	    if (!$parameterdescs{$arg}) {	        $parameterdescs{$arg} = $undescribed;	        print STDERR "Warning(${file}:$.): Enum value '$arg' ".		    "not described in enum '$declaration_name'\n";	    } 	} 	output_declaration($declaration_name,			   'enum',			   {'enum' => $declaration_name,			    'module' => $modulename,			    'parameterlist' => \@parameterlist,			    'parameterdescs' => \%parameterdescs,			    'sectionlist' => \@sectionlist,			    'sections' => \%sections,			    'purpose' => $declaration_purpose			   });    }    else {        print STDERR "Error(${file}:$.): Cannot parse enum!\n";	++$errors;    }} sub dump_typedef($$) {    my $x = shift;    my $file = shift;     $x =~ s@/\*.*?\*/@@gos;	# strip comments.    while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {        $x =~ s/\(*.\)\s*;$/;/;	$x =~ s/\[*.\]\s*;$/;/;    }     if ($x =~ /typedef.*\s+(\w+)\s*;/) {        $declaration_name = $1; 	output_declaration($declaration_name,			   'typedef',			   {'typedef' => $declaration_name,			    'module' => $modulename,			    'sectionlist' => \@sectionlist,			    'sections' => \%sections,			    'purpose' => $declaration_purpose			   });    }    else {        print STDERR "Error(${file}:$.): Cannot parse typedef!\n";	++$errors;    }} sub create_parameterlist($$$) {    my $args = shift;    my $splitter = shift;    my $file = shift;    my $type;    my $param;     # temporarily replace commas inside function pointer definition    while ($args =~ /(\([^\),]+),/) {        $args =~ s/(\([^\),]+),/$1#/g;    }     foreach my $arg (split($splitter, $args)) {	# strip comments	$arg =~ s/\/\*.*\*\///;        # strip leading/trailing spaces        $arg =~ s/^\s*//;	$arg =~ s/\s*$//;	$arg =~ s/\s+/ /; 	if ($arg =~ /^#/) {	    # Treat preprocessor directive as a typeless variable just to fill	    # corresponding data structures "correctly". Catch it later in	    # output_* subs.	    push_parameter($arg, "", $file);	} elsif ($arg =~ m/\(/) {	    # pointer-to-function	    $arg =~ tr/#/,/;	    $arg =~ m/[^\(]+\(\*([^\)]+)\)/;	    $param = $1;	    $type = $arg;	    $type =~ s/([^\(]+\(\*)$param/$1/;	    push_parameter($param, $type, $file);	} elsif ($arg) {	    $arg =~ s/\s*:\s*/:/g;	    $arg =~ s/\s*\[/\[/g; 	    my @args = split('\s*,\s*', $arg);	    if ($args[0] =~ m/\*/) {		$args[0] =~ s/(\*+)\s*/ $1/;	    }	    my @first_arg = split('\s+', shift @args);	    unshift(@args, pop @first_arg);	    $type = join " ", @first_arg; 	    foreach $param (@args) {		if ($param =~ m/^(\*+)\s*(.*)/) {		    push_parameter($2, "$type $1", $file);		}		elsif ($param =~ m/(.*?):(\d+)/) {		    push_parameter($1, "$type:$2", $file)		}		else {		    push_parameter($param, $type, $file);		}	    }	}    }} sub push_parameter($$$) {	my $param = shift;	my $type = shift;	my $file = shift; 	my $param_name = $param;	$param_name =~ s/\[.*//; 	if ($type eq "" && $param =~ /\.\.\.$/)	{	    $type="";	    $parameterdescs{$param} = "variable arguments";	}	elsif ($type eq "" && ($param eq "" or $param eq "void"))	{	    $type="";	    $param="void";	    $parameterdescs{void} = "no arguments";	}	# warn if parameter has no description	# (but ignore ones starting with # as these are no parameters	# but inline preprocessor statements	if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) { 	    $parameterdescs{$param_name} = $undescribed; 	    if (($type eq 'function') || ($type eq 'enum')) {	        print STDERR "Warning(${file}:$.): Function parameter ".		    "or member '$param' not " .		    "described in '$declaration_name'\n";	    }	    print STDERR "Warning(${file}:$.):".	                 " No description found for parameter '$param'\n";	    ++$warnings;        } 	push @parameterlist, $param;	$parametertypes{$param} = $type;} 

Lines 1001–1500 of 1883. Previous lines