XTypes: Added support to configuration and option parser.

[libucw.git] / build / doc-extract

diff --git a/build/doc-extract b/build/doc-extract
index b8751f903e88b000f21ba691e353a9c6b3270d32..67fdd64cb070ab919fe7de69cc239c8bf39ccd2f 100755 (executable)
--- a/build/doc-extract
+++ b/build/doc-extract
@@ -22,21 +22,33 @@ if( defined $defdump ) {
        $hasdump = 1;
 }
 
+# Function to guess type of statement
 sub detect( $ ) {
        ( $_ ) = @_;
+       # 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;
+       # 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, $_, $_ );
@@ -52,12 +64,14 @@ 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";
@@ -88,8 +102,10 @@ sub process( $$ ) {
        my $head;
        my $struct;
        my $def;
+       my $sdepth;
        while( defined( $line = <FILE> ) ) {
                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;
@@ -101,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;
@@ -137,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*$//;
@@ -153,7 +175,7 @@ sub process( $$ ) {
                                        $head = undef;
                                        $buff = undef;
                                } else {
-                                       $struct = 1;
+                                       $struct = $sdepth = 1;
                                }
                        } elsif( $line =~ /\/\*\*\*/ ) {
                                $verbatim = 1;