2 # Script for extracting documentation out of header files
3 # (c) 2008 Michal Vaner <vorner@ucw.cz>
8 my( $inname, $outname, $depname, $basedir, $defdump ) = @ARGV;
9 if( defined $inname ) {
10 open IN, $inname or die "Could not read $inname ($!)\n";
12 open IN, "<&STDIN" or die "Could not read stdin ($!)\n";
14 if( defined $outname ) {
15 open OUT, ">$outname" or die "Could not write $outname ($!)\n";
17 open OUT, ">&STDOUT" or die "Could not write to stdout ($!)\n";
20 if( defined $defdump ) {
21 open DUMP, ">$defdump" or die "Could not write definition dump $defdump ($!)\n";
27 return( 'struct', 1, $1, "typedef struct { ... } $1;" ) if( /^\s*typedef\s+struct\s*{.*}\s*(\w+)\s*;\s*$/s );
28 return( 'enum', 1, $1, "typedef enum { ... } $1;" ) if( /^\s*typedef\s+enum\s*{.*}\s*(\w+)\s*;\s*$/s );
31 return( 'struct', 0, $1, $_ ) if( /struct\s+(\w+)\s+{/ );
32 return( 'enum', 0, $1, $_ ) if( /enum\s+(\w+)\s+{/ );
34 warn( "Unknown statement $_\n" );
35 return( '', 0, $_, $_ );
37 return( 'def', 0, $1, $_ ) if( /#define\s+(\w+)/ );
38 return( 'fun', 1, $1, $_ ) if( /(\w+)\(.*\)/ );
39 return( 'var', 1, $1, $_ ) if( /\s(\w+);/ );
40 warn( "Unknown statement $_\n" );
41 return( '', 0, $_, $_ );
47 sub formatNote( $$ ) {
48 my( $head, $comment ) = @_;
49 $head =~ s/(\S)[ ]+/$1 /g;
53 my( $type, $semicolon, $name, $oneline ) = detect( $head );
55 $head =~ s/;?\s*$/;/ if( $semicolon );
56 $head =~ s/(\.\.\.)/\\$1/g;
57 print OUT "[[${type}_$name]]\n";
58 if( $type eq 'fun' ) {
59 print OUT "!!f!$head!!!\n\n";
61 print OUT "..................\n";
63 print OUT "..................\n\n";
66 print DUMP "$outname,${type}_$name,$type,$name,$oneline\n";
69 print OUT "$comment\n\n";
74 open FILE, $file or die "Could nod read $file ($!)\n";
81 while( defined( $line = <FILE> ) ) {
86 formatNote( $head, $buff );
91 } elsif( $verbatim ) {
92 if( $line =~ /\*\// ) {
96 $line =~ s/^\s*\* ?//;
100 if( $line =~ /\*\// ) {
103 $line =~ s/^\s*\* ?//;
107 if( ( $line =~ /\S/ ) && ( defined $buff ) ) {
108 if( $line =~ /\(/ || $line !~ /{/ ) {
113 formatNote( $_, $buff );
120 } elsif( ( $buff ) = ( $line =~ /\/\*\*\*(.*)\*\*\*\// ) ) {
122 print OUT "$buff\n\n";
124 } elsif( ( $head, $buff ) = ( $line =~ /^(.*)\/\*\*(.*)\*\*\// ) ) {
127 if( $head =~ /\(/ || $head !~ /{/ ) {
129 $head =~ s/\/\*.*?\*\///gs;
130 formatNote( $head, $buff );
136 } elsif( $line =~ /\/\*\*\*/ ) {
138 } elsif( $line =~ /\/\*\*/ ) {
147 while( defined( $line = <IN> ) ) {
149 if( my( $fname ) = ( $line =~ /^!!\s*(.*\S)/ ) ) {
150 $fname = "$basedir/$fname" if( ( $fname !~ /^\// ) && defined $basedir );
158 if( defined $depname ) {
159 open DEP, ">>$depname" or die "Could not write dep file $depname ($!)\n";
160 print DEP "$outname:";
161 print DEP " $_" foreach( @deps );
164 print DEP "$defdump:";
165 print DEP " $_" foreach( @deps );