X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=build%2Fdoc-extract;h=67fdd64cb070ab919fe7de69cc239c8bf39ccd2f;hb=1481eca416a467e9952dbc5e4852afe66eaf1256;hp=8bd84ef76b07ffe0024a9a14d2e2407cb8e4c19f;hpb=9e0e2f9c68df3a3b44778799d8d8347f04d3d50f;p=libucw.git diff --git a/build/doc-extract b/build/doc-extract index 8bd84ef7..67fdd64c 100755 --- a/build/doc-extract +++ b/build/doc-extract @@ -22,22 +22,33 @@ if( defined $defdump ) { $hasdump = 1; } +# Function to guess type of statement sub detect( $ ) { ( $_ ) = @_; - return( 'struct', 1, $1, "typedef struct { ... } $1;" ) if /^\s*typedef\s+struct\s*{.*}\s*(\w+)\s*;\s*$/s; - return( 'enum', 1, $1, "typedef enum { ... } $1;" ) if /^\s*typedef\s+enum\s*{.*}\s*(\w+)\s*;\s*$/s; + # typedef struct|enum { something } name; + return( $1, 1, $2, "typedef $1 { ... } $2;" ) if /^\s*typedef\s+(struct|enum)\s*{.*}\s*(\w+)\s*;\s*$/s; + # struct|enum name { something }; + return( $1, 1, $2, $_ ) if /^\s*(struct|enum)\s+(\w+)\s*;\s*$/s; my $l = length; s/\n.*//s; - return( 'struct', 0, $1, $_ ) if /struct\s+(\w+)\s+{/; - return( 'enum', 0, $1, $_ ) if /enum\s+(\w+)\s+{/; + # struct|enum name { + # something + # }; + return( $1, 0, $2, $_ ) if /(struct|enum)\s+(\w+)\s+{/; return( 'def', 0, $1, $_ ) if /#define\s+(\w+)/; if( $l > length ) { warn( "Unknown multiline statement $_\n" ); return( '', 0, $_, $_ ); } + # typedef type (*function_type)(params); return( 'type', 1, $2, $_ ) if /^\s*typedef[^()]+?(\(\s*?\*\s*?)?(\w+)(\s*\))?\s*\(.*\)/; + # type (*function_var)(params); + return( 'var', 1, $1, $_ ) if /^.*?\(\*(\w+)\)\(.*\)/; + # type function(name); return( 'fun', 1, $2, $1 ) if /^(.*?(\w+)\([^{]*\)[^{]*)/; + # typedef something name; return( 'type', 1, $1, $_ ) if /^\s*typedef.*?(\w+);/; + # type name; return( 'var', 1, $1, $_ ) if /\s\**(\w+);/; warn( "Unknown statement $_\n" ); return( '', 0, $_, $_ ); @@ -53,24 +64,36 @@ sub formatNote( $$ ) { print OUT "''''\n"; chomp $head; my( $type, $semicolon, $name, $oneline ) = detect( $head ); + # Just few transformations of the result $oneline =~ s/\s+$//; $oneline =~ s/;?$/;/ if( $semicolon ); $head =~ s/;?\s*$/;/ if( $semicolon ); - $head =~ s/(\.\.\.)/\\$1/g; + $head =~ s/(\s|,|\()(\.\.\.)/$1\\$2/g; # Do not convert tripple dot into ellipsis print OUT "[[${type}_$name]]\n"; $head = $oneline if $type eq 'fun';#Remove { from inline functions + # Remove the generic hack markup + $head =~ s/_OPEN_PAREN_/(/g; + $head =~ s/_CLOSE_PAREN_/)/g; print OUT "..................\n"; print OUT "$head\n"; print OUT "..................\n\n"; if( $hasdump ) { - print DUMP "$outname,${type}_$name,$type,$name,$oneline\n"; + $oneline =~ s/_OPEN_PAREN_/(/g; + $oneline =~ s/_CLOSE_PAREN_/)/g; + my $symname = $type.'_'.$name; + $name =~ s/_OPEN_PAREN_/(/g; + $name =~ s/_CLOSE_PAREN_/)/g; + print DUMP "$outname,$symname,$type,$name,$oneline\n"; $id ++; } + $comment =~ s/_OPEN_PAREN_/(/g; + $comment =~ s/_CLOSE_PAREN_/)/g; + $comment =~ s/_GENERIC_LINK_\|([^|]+)\|([^|]+)\|/${1}_OPEN_PAREN_${2}_CLOSE_PAREN_/g; print OUT "$comment\n\n"; } -sub process( $ ) { - my $file = shift; +sub process( $$ ) { + my( $file, $prefixes ) = @_; open FILE, $file or die "Could nod read $file ($!)\n"; my $line; my $active; @@ -79,8 +102,11 @@ sub process( $ ) { my $head; my $struct; my $def; + my $sdepth; while( defined( $line = ) ) { chomp $line; + # Generic macro hack - replaces the parenthesis so it is valid identifier + $line =~ s/$_\(([^()]+)\)/${_}_OPEN_PAREN_${1}_CLOSE_PAREN_/g foreach @{$prefixes}; if( $def ) { $head .= "\n".$line; $line =~ s/(\/\*.*?\*\/|\/\/.*)//g; @@ -91,7 +117,10 @@ sub process( $ ) { } } elsif( $struct ) { $head .= "\n".$line; - if( $line =~ /}/ ) { + my $cp = $line; + $sdepth += ($cp =~ tr/{//); + $sdepth -= ($cp =~ tr/}//); + if( !$sdepth ) { formatNote( $head, $buff ); $struct = 0; $buff = undef; @@ -127,12 +156,15 @@ sub process( $ ) { $buff = undef; } else { $head = $line; - $struct = 1; + $struct = $sdepth = 1; } } elsif( ( $buff ) = ( $line =~ /\/\*\*\*(.*)\*\*\*\// ) ) { - $buff =~ s/\s?//; + $buff =~ s/^\s?//; print OUT "$buff\n\n"; $buff = undef; + } elsif( ( $buff ) = ( $line =~ /^\s*\/\*\*(.*)\*\*\// ) ) { + $buff =~ s/^\s*//; + $buff .= "\n"; } elsif( ( $head, $buff ) = ( $line =~ /^(.*)\/\*\*(.*)\*\*\// ) ) { $buff =~ s/^\s*//; $buff =~ s/\s*$//; @@ -143,7 +175,7 @@ sub process( $ ) { $head = undef; $buff = undef; } else { - $struct = 1; + $struct = $sdepth = 1; } } elsif( $line =~ /\/\*\*\*/ ) { $verbatim = 1; @@ -158,9 +190,13 @@ sub process( $ ) { my $line; while( defined( $line = ) ) { chomp $line; - if( my( $fname ) = ( $line =~ /^!!\s*(.*\S)/ ) ) { + my $prefixes; + if( my( $fname, $prefixes ) = ( $line =~ /^!!\s*(\S+)(.*)/ ) ) { $fname = "$basedir/$fname" if( ( $fname !~ /^\// ) && defined $basedir ); - process( $fname ); + process( $fname, [ ( map( { + my( $result ) = /^\s*(.*\S)\s*$/; + $result; + } ( split /,/, $prefixes ) ) ) ] ); push @deps, $fname; } else { print OUT "$line\n";