gtkdoc-scan.in

   1 #!@PERL@ -w
   2 # -*- cperl -*-
   3 #
   4 # gtk-doc - GTK DocBook documentation generator.
   5 # Copyright (C) 1998  Damon Chaplin
   6 #
   7 # This program is free software; you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 2 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program; if not, write to the Free Software
  19 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20 #
  21
  22 #############################################################################
  23 # Script      : gtkdoc-scan
  24 # Description : Extracts declarations of functions, macros, enums, structs
  25 #               and unions from header files.
  26 #
  27 #               It is called with a module name, an optional source directory,
  28 #               an optional output directory, and the header files to scan.
  29 #
  30 #               It outputs all declarations found to a file named
  31 #               '$MODULE-decl.txt', and the list of decarations to another
  32 #               file '$MODULE-decl-list.txt'.
  33 #
  34 #               This second list file is typically copied to
  35 #               '$MODULE-sections.txt' and organized into sections ready to
  36 #               output the SGML pages.
  37 #############################################################################
  38
  39 use strict;
  40 use Getopt::Long;
  41 use Cwd qw(realpath);
  42
  43 push @INC, '@PACKAGE_DATA_DIR@';
  44 require "gtkdoc-common.pl";
  45
  46 # Options
  47
  48 # name of documentation module
  49 my $MODULE;
  50 my $OUTPUT_DIR;
  51 my @SOURCE_DIRS;
  52 my $IGNORE_HEADERS = "";
  53 my $REBUILD_TYPES;
  54 my $REBUILD_SECTIONS;
  55 my $PRINT_VERSION;
  56 my $PRINT_HELP;
  57 # regexp matching cpp symbols which surround deprecated stuff
  58 # e.g. 'GTK_ENABLE_BROKEN|GTK_DISABLE_DEPRECATED'
  59 # these are detected if they are used as #if FOO, #ifndef FOO, or #ifdef FOO
  60 my $DEPRECATED_GUARDS;
  61 # regexp matching decorators that should be ignored
  62 my $IGNORE_DECORATORS;
  63
  64 my %optctl = (module => \$MODULE,
  65               'source-dir' => \@SOURCE_DIRS,
  66               'ignore-headers' => \$IGNORE_HEADERS,
  67               'output-dir' => \$OUTPUT_DIR,
  68               'rebuild-types' => \$REBUILD_TYPES,
  69               'rebuild-sections' => \$REBUILD_SECTIONS,
  70               'version' => \$PRINT_VERSION,
  71               'help' => \$PRINT_HELP,
  72               'deprecated-guards' => \$DEPRECATED_GUARDS,
  73               'ignore-decorators' => \$IGNORE_DECORATORS);
  74 GetOptions(\%optctl, "module=s", "source-dir:s", "ignore-headers:s",
  75            "output-dir:s", "rebuild-types", "rebuild-sections", "version",
  76            "help", "deprecated-guards:s", "ignore-decorators:s");
  77
  78 if ($PRINT_VERSION) {
  79     print "@VERSION@\n";
  80     exit 0;
  81 }
  82
  83 if (!$MODULE) {
  84     $PRINT_HELP = 1;
  85 }
  86
  87 if ($PRINT_HELP) {
  88     print <<EOF;
  89 gtkdoc-scan version @VERSION@ - scan header files for public symbols
  90
  91 --module=MODULE_NAME       Name of the doc module being parsed
  92 --source-dir=DIRNAME       Directories containing the source files to scan
  93 --ignore-headers=FILES     A space-separated list of header files not to scan
  94 --output-dir=DIRNAME       The directory where the results are stored
  95 --deprecated-guards=GUARDS A |-separated list of symbols used as deprecation
  96                            guards
  97 --ignore-decorators=DECS   A |-separated list of addition decorators in
  98                            declarations that should be ignored
  99 --rebuild-sections         Rebuild (overwrite) the MODULE-sections.txt file
 100 --rebuild-types            Automatically recreate the MODULE.types file using
 101                            all the *_get_type() functions found
 102 --version                  Print the version of this program
 103 --help                     Print this help
 104 EOF
 105     exit 0;
 106 }
 107
 108 $DEPRECATED_GUARDS = $DEPRECATED_GUARDS ? $DEPRECATED_GUARDS : "does_not_match_any_cpp_symbols_at_all_nope";
 109
 110 $IGNORE_DECORATORS = $IGNORE_DECORATORS || "(?=no)match";
 111
 112 $OUTPUT_DIR = $OUTPUT_DIR ? $OUTPUT_DIR : ".";
 113
 114 if (!-d ${OUTPUT_DIR}) {
 115     mkdir($OUTPUT_DIR, 0755) || die "Cannot create $OUTPUT_DIR: $!";
 116 }
 117
 118 my $old_decl_list = "${OUTPUT_DIR}/$MODULE-decl-list.txt";
 119 my $new_decl_list = "${OUTPUT_DIR}/$MODULE-decl-list.new";
 120 my $old_decl = "${OUTPUT_DIR}/$MODULE-decl.txt";
 121 my $new_decl = "${OUTPUT_DIR}/$MODULE-decl.new";
 122 my $old_types = "${OUTPUT_DIR}/$MODULE.types";
 123 my $new_types = "${OUTPUT_DIR}/$MODULE.types.new";
 124 my $sections_file = "${OUTPUT_DIR}/$MODULE-sections.txt";
 125
 126 # If this is the very first run then we create the .types file automatically.
 127 if (! -e $sections_file && ! -e $old_types) {
 128     $REBUILD_TYPES = 1;
 129 }
 130
 131 open (DECLLIST, ">$new_decl_list")
 132     || die "Can't open $new_decl_list";
 133 open (DECL, ">$new_decl")
 134     || die "Can't open $new_decl";
 135 if ($REBUILD_TYPES) {
 136     open (TYPES, ">$new_types")
 137         || die "Can't open $new_types";
 138 }
 139
 140 my $main_list = "";
 141 my $object_list = "";
 142 my $file;
 143
 144 my @get_types = ();
 145
 146
 147 # do not read files twice; checking it here permits to give both srcdir and
 148 # builddir as --source-dir without fear of duplicities
 149 my %seen_headers;
 150
 151 # The header files to scan are passed in as command-line args.
 152 for $file (@ARGV) {
 153     &ScanHeader ($file, \$object_list, \$main_list);
 154 }
 155
 156 for my $dir (@SOURCE_DIRS) {
 157     &ScanHeaders ($dir, \$object_list, \$main_list);
 158 }
 159
 160 print DECLLIST $object_list, $main_list;
 161 close (DECLLIST);
 162 close (DECL);
 163 if ($REBUILD_TYPES) {
 164     my $func;
 165
 166     foreach $func (sort(@get_types)) {
 167        print TYPES "$func\n";
 168     }
 169     close (TYPES);
 170     &UpdateFileIfChanged ($old_types, $new_types, 1);
 171
 172     # remove the file if empty
 173     if (scalar (@get_types) == 0) {
 174         unlink ("$new_types");
 175     }
 176 }
 177
 178 &UpdateFileIfChanged ($old_decl_list, $new_decl_list, 1);
 179 &UpdateFileIfChanged ($old_decl, $new_decl, 1);
 180
 181 # If there is no MODULE-sections.txt file yet or we are asked to rebuild it,
 182 # we copy the MODULE-decl-list.txt file into its place. The user can tweak it
 183 # later if they want.
 184 if ($REBUILD_SECTIONS || ! -e $sections_file) {
 185   `cp $old_decl_list $sections_file`;
 186 }
 187
 188 # If there is no MODULE-overrides.txt file we create an empty one
 189 # because EXTRA_DIST in gtk-doc.make requires it.
 190 my $overrides_file = "${OUTPUT_DIR}/$MODULE-overrides.txt";
 191 if (! -e $overrides_file) {
 192   `touch $overrides_file`;
 193 }
 194
 195
 196
 197 #############################################################################
 198 # Function    : ScanHeaders
 199 # Description : This scans a directory tree looking for header files.
 200 #
 201 # Arguments   : $source_dir - the directory to scan.
 202 #               $object_list - a reference to the list of object functions &
 203 #                       declarations.
 204 #               $main_list - a reference to the list of other declarations.
 205 #############################################################################
 206
 207 sub ScanHeaders {
 208     my ($source_dir, $object_list, $main_list) = @_;
 209     #print "Scanning source directory: $source_dir\n";
 210
 211     # This array holds any subdirectories found.
 212     my (@subdirs) = ();
 213
 214     opendir (SRCDIR, $source_dir)
 215         || die "Can't open source directory $source_dir: $!";
 216     my $file;
 217     foreach $file (readdir (SRCDIR)) {
 218         if ($file eq '.' || $file eq '..' || $file =~ /^\./) {
 219             next;
 220         } elsif (-d "$source_dir/$file") {
 221             push (@subdirs, $file);
 222         } elsif ($file =~ m/\.h$/) {
 223             &ScanHeader ("$source_dir/$file", $object_list, $main_list);
 224         }
 225     }
 226     closedir (SRCDIR);
 227
 228     # Now recursively scan the subdirectories.
 229     my $dir;
 230     foreach $dir (@subdirs) {
 231         next if ($IGNORE_HEADERS =~ m/(\s|^)\Q${dir}\E(\s|$)/);
 232         &ScanHeaders ("$source_dir/$dir", $object_list, $main_list);
 233     }
 234 }
 235
 236
 237 #############################################################################
 238 # Function    : ScanHeader
 239 # Description : This scans a header file, looking for declarations of
 240 #               functions, macros, typedefs, structs and unions, which it
 241 #               outputs to the DECL file.
 242 # Arguments   : $input_file - the header file to scan.
 243 #               $object_list - a reference to the list of object functions &
 244 #                       declarations.
 245 #               $main_list - a reference to the list of other declarations.
 246 # Returns     : it adds declarations to the appropriate list.
 247 #############################################################################
 248
 249 sub ScanHeader {
 250     my ($input_file, $object_list, $main_list) = @_;
 251
 252     my $list = "";                # Holds the resulting list of declarations.
 253     my ($in_comment) = 0;                 # True if we are in a comment.
 254     my ($in_declaration) = "";    # The type of declaration we are in, e.g.
 255                                   #   'function' or 'macro'.
 256     my ($skip_block) = 0;                 # True if we should skip a block.
 257     my ($symbol);                 # The current symbol being declared.
 258     my ($decl);                   # Holds the declaration of the current symbol.
 259     my ($ret_type);               # For functions and function typedefs this
 260                                   #   holds the function's return type.
 261     my ($pre_previous_line) = "";   # The pre-previous line read in - some Gnome
 262                                   #   functions have the return type on one
 263                                   #   line, the function name on the next,
 264                                   #   and the rest of the declaration after.
 265     my ($previous_line) = "";     # The previous line read in - some Gnome
 266                                   #   functions have the return type on one line
 267                                   #   and the rest of the declaration after.
 268     my ($first_macro) = 1;        # Used to try to skip the standard #ifdef XXX
 269                                   #   #define XXX at the start of headers.
 270     my ($level);                          # Used to handle structs/unions which contain
 271                                   #   nested structs or unions.
 272     my @objects = ();             # Holds declarations that look like GtkObject
 273                                   #   subclasses, which we remove from the list.
 274     my ($internal) = 0;             # Set to 1 for internal symbols, we need to
 275                                     #   fully parse, but don't add them to docs
 276
 277     my $file_basename;
 278
 279     my $deprecated_conditional_nest = 0;
 280
 281     my $deprecated = "";
 282
 283     # Don't scan headers twice
 284     my $canonical_input_file = realpath $input_file;
 285     return if exists $seen_headers{$canonical_input_file};
 286     $seen_headers{$canonical_input_file} = 1;
 287
 288     if ($input_file =~ m/^.*[\/\\](.*)\.h+$/) {
 289         $file_basename = $1;
 290     } else {
 291         print "WARNING: Can't find basename of file $input_file\n";
 292         $file_basename = $input_file;
 293     }
 294
 295     # Check if the basename is in the list of headers to ignore.
 296     if ($IGNORE_HEADERS =~ m/(\s|^)\Q${file_basename}\E\.h(\s|$)/) {
 297         #print "DEBUG: File ignored: $input_file\n";
 298         return;
 299     }
 300
 301     if (! -f $input_file) {
 302         print "WARNING: File doesn't exist: $input_file\n";
 303         return;
 304     }
 305
 306     #print "DEBUG: Scanning $input_file\n";
 307
 308     open(INPUT, $input_file)
 309         || die "Can't open $input_file: $!";
 310     while(<INPUT>) {
 311         # If this is a private header, skip it.
 312         if (m%^\s*/\*\s*<\s*private_header\s*>\s*\*/%) {
 313             close(INPUT);
 314             return;
 315         }
 316
 317         # Skip to the end of the current comment.
 318         if ($in_comment) {
 319             #print "Comment: $_";
 320             if (m%\*/%) {
 321                 $in_comment = 0;
 322             }
 323             next;
 324         }
 325
 326         # Keep a count of #if, #ifdef, #ifndef nesting,
 327         # and if we enter a deprecation-symbol-bracketed
 328         # zone, take note.
 329         if (m/^\s*#\s*if(?:n?def\b|\s+!?\s*defined\s*\()\s*(\w+)/) {
 330             if ($deprecated_conditional_nest == 0 and $1 =~ /$DEPRECATED_GUARDS/) {
 331                  $deprecated_conditional_nest = 1;
 332             } elsif ($deprecated_conditional_nest > 0) {
 333                  $deprecated_conditional_nest += 1;
 334             }
 335         } elsif (m/^\s*#\sif/) {
 336             if ($deprecated_conditional_nest > 0) {
 337                  $deprecated_conditional_nest += 1;
 338             }
 339         } elsif (m/^\s*#endif/) {
 340             if ($deprecated_conditional_nest > 0) {
 341                 $deprecated_conditional_nest -= 1;
 342             }
 343         }
 344
 345         # set global that affects AddSymbolToList
 346         if ($deprecated_conditional_nest > 0) {
 347             $deprecated = "<DEPRECATED/>\n";
 348         } else {
 349             $deprecated = "";
 350         }
 351
 352         if (!$in_declaration) {
 353             # Skip top-level comments.
 354             if (s%^\s*/\*%%) {
 355                 if (m%\*/%) {
 356                     #print "Found one-line comment: $_";
 357                 } else {
 358                     $in_comment = 1;
 359                     #print "Found start of comment: $_";
 360                 }
 361                 next;
 362             }
 363
 364             #print "0: $_";
 365
 366             # MACROS
 367
 368             if (m/^\s*#\s*define\s+(\w+)/) {
 369                 $symbol = $1;
 370                 $decl = $_;
 371                 # We assume all macros which start with '_' are private, but
 372                 # we accept '_' itself which is the standard gettext macro.
 373                 # We also try to skip the first macro if it looks like the
 374                 # standard #ifndef HEADER_FILE #define HEADER_FILE etc.
 375                 # And we only want TRUE & FALSE defined in GLib (libdefs.h in
 376                 # libgnome also defines them if they are not already defined).
 377                 if (($symbol !~ m/^_/
 378                      && ($previous_line !~ m/#ifndef\s+$symbol/
 379                          || $first_macro == 0)
 380                      && (($symbol ne 'TRUE' && $symbol ne 'FALSE')
 381                          || $MODULE eq 'glib'))
 382                     || $symbol eq "_") {
 383                     $in_declaration = "macro";
 384                     #print "DEBUG: Macro: $symbol\n";
 385                 } else {
 386                     #print "DEBUG: skipping Macro: $symbol\n";
 387                     $in_declaration = "macro";
 388                     $internal = 1;
 389                 }
 390                 $first_macro = 0;
 391
 392
 393             # TYPEDEF'D FUNCTIONS (i.e. user functions)
 394
 395             #                        $1                                $3            $4             $5
 396             } elsif (m/^\s*typedef\s+((const\s+|G_CONST_RETURN\s+)?\w+)(\s+const)?\s*(\**)\s*\(\*\s*(\w+)\)\s*\(/) {
 397                 my $p3 = defined($3) ? $3 : "";
 398                 $ret_type = "$1$p3 $4";
 399                 $symbol = $5;
 400                 $decl = $';
 401                 $in_declaration = "user_function";
 402                 #print "DEBUG: user function (1): $symbol, Returns: $ret_type\n";
 403
 404             #                                                       $1                                $3            $4             $5
 405             } elsif (($previous_line =~ m/^\s*typedef\s*/) && m/^\s*((const\s+|G_CONST_RETURN\s+)?\w+)(\s+const)?\s*(\**)\s*\(\*\s*(\w+)\)\s*\(/) {
 406                 my $p3 = defined($3) ? $3 : "";
 407                 $ret_type = "$1$p3 $4";
 408                 $symbol = $5;
 409                 $decl = $';
 410                 $in_declaration = "user_function";
 411                 #print "DEBUG: user function (2): $symbol, Returns: $ret_type\n";
 412
 413             #                                                       $1            $2
 414             } elsif (($previous_line =~ m/^\s*typedef\s*/) && m/^\s*(\**)\s*\(\*\s*(\w+)\)\s*\(/) {
 415                 $ret_type = $1;
 416                 $symbol = $2;
 417                 $decl = $';
 418                 #                                     $1                                $3
 419                 if ($previous_line =~ m/^\s*typedef\s*((const\s+|G_CONST_RETURN\s+)?\w+)(\s+const)?\s*/) {
 420                     my $p3 = defined($3) ? $3 : "";
 421                     $ret_type = "$1$p3 ".$ret_type;
 422                     $in_declaration = "user_function";
 423                     #print "DEBUG: user function (3): $symbol, Returns: $ret_type\n";
 424
 425                 }
 426             # FUNCTION POINTER VARIABLES
 427             #                                                                       $1                                $3            $4             $5
 428             } elsif (m/^\s*(?:\b(?:extern|G_INLINE_FUNC|${IGNORE_DECORATORS})\b\s*)*((const\s+|G_CONST_RETURN\s+)?\w+)(\s+const)?\s*(\**)\s*\(\*\s*(\w+)\)\s*\(/o) {
 429                 my $p3 = defined($3) ? $3 : "";
 430                 $ret_type = "$1$p3 $4";
 431                 $symbol = $5;
 432                 $decl = $';
 433                 $in_declaration = "user_function";
 434                 #print "DEBUG: function pointer variable: $symbol, Returns: $ret_type\n";
 435
 436             # ENUMS
 437
 438             } elsif (s/^\s*enum\s+_(\w+)\s+\{/enum $1 {/) {
 439                 # We assume that 'enum _<enum_name> {' is really the
 440                 # declaration of enum <enum_name>.
 441                 $symbol = $1;
 442                 #print "DEBUG: plain enum: $symbol\n";
 443                 $decl = $_;
 444                 $in_declaration = "enum";
 445
 446             } elsif (m/^\s*typedef\s+enum\s+_?(\w+)\s+\1\s*;/) {
 447                 # We skip 'typedef enum <enum_name> _<enum_name>;' as the enum will
 448                 # be declared elsewhere.
 449                 #print "DEBUG: skipping enum typedef: $1\n";
 450
 451             } elsif (m/^\s*typedef\s+enum/) {
 452                 $symbol = "";
 453                 #print "DEBUG: typedef enum: -\n";
 454                 $decl = $_;
 455                 $in_declaration = "enum";
 456
 457
 458             # STRUCTS AND UNIONS
 459
 460             } elsif (m/^\s*typedef\s+(struct|union)\s+_(\w+)\s+\2\s*;/) {
 461                 # We've found a 'typedef struct _<name> <name>;'
 462                 # This could be an opaque data structure, so we output an
 463                 # empty declaration. If the structure is actually found that
 464                 # will override this.
 465                 my $structsym = uc $1;
 466                 #print "DEBUG: $structsym typedef: $2\n";
 467                 &AddSymbolToList (\$list, $2);
 468                 print DECL "<$structsym>\n<NAME>$2</NAME>\n$deprecated</$structsym>\n";
 469
 470             } elsif (m/^\s*(?:struct|union)\s+_(\w+)\s*;/) {
 471                 # Skip private structs/unions.
 472                 #print "DEBUG: private struct/union\n";
 473
 474             } elsif (m/^\s*(struct|union)\s+(\w+)\s*;/) {
 475                 # Do a similar thing for normal structs as for typedefs above.
 476                 # But we output the declaration as well in this case, so we
 477                 # can differentiate it from a typedef.
 478                 my $structsym = uc $1;
 479                 #print "DEBUG: $structsym: $2\n";
 480                 &AddSymbolToList (\$list, $2);
 481                 print DECL "<$structsym>\n<NAME>$2</NAME>\n$_$deprecated</$structsym>\n";
 482
 483             } elsif (m/^\s*typedef\s+(struct|union)\s*\w*\s*{/) {
 484                 $symbol = "";
 485                 $decl = $_;
 486                 $level = 0;
 487                 $in_declaration = $1;
 488                 #print "DEBUG: $1\n";
 489
 490             # OTHER TYPEDEFS
 491
 492             } elsif (m/^\s*typedef\s+(?:struct|union)\s+\w+[\s\*]+(\w+)\s*;/) {
 493                 #print "DEBUG: Found struct/union(*) typedef $1: $_";
 494                 &AddSymbolToList (\$list, $1);
 495                 print DECL "<TYPEDEF>\n<NAME>$1</NAME>\n$deprecated$_</TYPEDEF>\n";
 496
 497             } elsif (m/^\s*(G_GNUC_EXTENSION\s+)?typedef\s+(.+[\s\*])(\w+)(\s*\[[^\]]+\])*\s*;/) {
 498                 if ($2 !~ m/^struct\s/ && $2 !~ m/^union\s/) {
 499                     #print "DEBUG: Found typedef: $_";
 500                     &AddSymbolToList (\$list, $3);
 501                     print DECL "<TYPEDEF>\n<NAME>$3</NAME>\n$deprecated$_</TYPEDEF>\n";
 502                 }
 503             } elsif (m/^\s*typedef\s+/) {
 504                 #print "DEBUG: Skipping typedef: $_";
 505
 506
 507             # VARIABLES (extern'ed variables)
 508
 509             } elsif (m/^\s*(extern|[A-Za-z_]+VAR)\s+((const\s+|signed\s+|unsigned\s+)*\w+)(\s+\*+|\*+|\s)\s*([A-Za-z]\w*)\s*;/) {
 510                 $symbol = $5;
 511                 s/^\s*([A-Za-z_]+VAR)\b/extern/;
 512                 #print "DEBUG: Possible extern: $_";
 513                 &AddSymbolToList (\$list, $symbol);
 514                 print DECL "<VARIABLE>\n<NAME>$symbol</NAME>\n$deprecated$_</VARIABLE>\n";
 515
 516
 517             # FUNCTIONS
 518
 519             # We assume that functions which start with '_' are private, so
 520             # we skip them.
 521             #                                                                       $1                                                                                                    $2                                                          $3
 522             } elsif (m/^\s*(?:\b(?:extern|G_INLINE_FUNC|${IGNORE_DECORATORS})\b\s*)*((?:const\s+|G_CONST_RETURN\s+|signed\s+|unsigned\s+|long\s+|short\s+|struct\s+|union\s+|enum\s+)*\w+)((?:\s+|\*)+(?:\s*(?:\*+|\bconst\b|\bG_CONST_RETURN\b))*)\s*(_[A-Za-z]\w*)\s*\(/o) {
 523                 $ret_type = $1;
 524                 if (defined ($2)) { $ret_type .= " $2"; }
 525                 $symbol = $3;
 526                 $decl = $';
 527                 #print "DEBUG: internal Function: $symbol, Returns: [$1][$2]\n";
 528                 $in_declaration = "function";
 529                 $internal = 1;
 530                 if (m/^\s*G_INLINE_FUNC/) {
 531                     #print "DEBUG: skip block after inline function\n";
 532                     # now we we need to skip a whole { } block
 533                     $skip_block = 1;
 534                 }
 535
 536             #                                                                       $1                                                                                                    $2                                                          $3
 537             } elsif (m/^\s*(?:\b(?:extern|G_INLINE_FUNC|${IGNORE_DECORATORS})\b\s*)*((?:const\s+|G_CONST_RETURN\s+|signed\s+|unsigned\s+|long\s+|short\s+|struct\s+|union\s+|enum\s+)*\w+)((?:\s+|\*)+(?:\s*(?:\*+|\bconst\b|\bG_CONST_RETURN\b))*)\s*([A-Za-z]\w*)\s*\(/o) {
 538                 $ret_type = $1;
 539                 if (defined ($2)) { $ret_type .= " $2"; }
 540                 $symbol = $3;
 541                 $decl = $';
 542                 #print "DEBUG: Function (1): $symbol, Returns: [$1][$2]\n";
 543                 $in_declaration = "function";
 544                 if (m/^\s*G_INLINE_FUNC/) {
 545                     #print "DEBUG: skip block after inline function\n";
 546                     # now we we need to skip a whole { } block
 547                     $skip_block = 1;
 548                 }
 549
 550             # Try to catch function declarations which have the return type on
 551             # the previous line. But we don't want to catch complete functions
 552             # which have been declared G_INLINE_FUNC, e.g. g_bit_nth_lsf in
 553             # glib, or 'static inline' functions.
 554             } elsif (m/^\s*([A-Za-z]\w*)\s*\(/) {
 555                 $symbol = $1;
 556                 $decl = $';
 557
 558                 if ($previous_line !~ m/^\s*G_INLINE_FUNC/) {
 559                     if ($previous_line !~ m/^\s*static\s+/) {
 560                         #                                                                       $1                                                                                                   $2
 561                         if ($previous_line =~ m/^\s*(?:\b(?:extern|${IGNORE_DECORATORS})\b\s*)*((?:const\s+|G_CONST_RETURN\s+|signed\s+|unsigned\s+|long\s+|short\s+|struct\s+|union\s+|enum\s+)*\w+)((?:\s*(?:\*+|\bconst\b|\bG_CONST_RETURN\b))*)\s*$/o) {
 562                             $ret_type = $1;
 563                             if (defined ($2)) { $ret_type .= " $2"; }
 564                             #print "DEBUG: Function  (2): $symbol, Returns: $ret_type\n";
 565                             $in_declaration = "function";
 566                         }
 567                     } else {
 568                         #print "DEBUG: skip block after inline function\n";
 569                         # now we we need to skip a whole { } block
 570                         $skip_block = 1;
 571                         #                                                                                    $1                                                                                                   $2
 572                         if ($previous_line =~ m/^\s*(?:\b(?:extern|static|inline|${IGNORE_DECORATORS})\b\s*)*((?:const\s+|G_CONST_RETURN\s+|signed\s+|unsigned\s+|long\s+|short\s+|struct\s+|union\s+|enum\s+)*\w+)((?:\s*(?:\*+|\bconst\b|\bG_CONST_RETURN\b))*)\s*$/o) {
 573                             $ret_type = $1;
 574                             if (defined ($2)) { $ret_type .= " $2"; }
 575                             #print "DEBUG: Function  (3): $symbol, Returns: $ret_type\n";
 576                             $in_declaration = "function";
 577                         }
 578                     }
 579                 }
 580                 else {
 581                     if ($previous_line !~ m/^\s*static\s+/) {
 582                         #print "DEBUG: skip block after inline function\n";
 583                         # now we we need to skip a whole { } block
 584                         $skip_block = 1;
 585                         #                                                                                    $1                                                                                                    $2
 586                         if ($previous_line =~ m/^\s*(?:\b(?:extern|G_INLINE_FUNC|${IGNORE_DECORATORS})\b\s*)*((?:const\s+|G_CONST_RETURN\s+|signed\s+|unsigned\s+|long\s+|short\s+|struct\s+|union\s+|enum\s+)*\w+)((?:\s*(?:\*+|\bconst\b|\bG_CONST_RETURN\b))*)\s*$/o) {
 587                             $ret_type = $1;
 588                             if (defined ($2)) { $ret_type .= " $2"; }
 589                             #print "DEBUG: Function (4): $symbol, Returns: $ret_type\n";
 590                             $in_declaration = "function";
 591                         }
 592                     }
 593                 }
 594
 595             # Try to catch function declarations with the return type and name
 596             # on the previous line(s), and the start of the parameters on this.
 597             } elsif (m/^\s*\(/) {
 598                 $decl = $';
 599                 if ($previous_line =~ m/^\s*(?:\b(?:extern|G_INLINE_FUNC|${IGNORE_DECORATORS})\b\s*)*((?:const\s+|G_CONST_RETURN\s+|signed\s+|unsigned\s+|enum\s+)*\w+)(\s+\*+|\*+|\s)\s*([A-Za-z]\w*)\s*$/o) {
 600                     $ret_type = "$1 $2";
 601                     $symbol = $3;
 602                     #print "DEBUG: Function (5): $symbol, Returns: $ret_type\n";
 603                     $in_declaration = "function";
 604
 605                 } elsif ($previous_line =~ m/^\s*\w+\s*$/
 606                          && $pre_previous_line =~ m/^\s*(?:\b(?:extern|G_INLINE_FUNC|${IGNORE_DECORATORS})\b\s*)*((?:const\s+|G_CONST_RETURN\s+|signed\s+|unsigned\s+|struct\s+|union\s+|enum\s+)*\w+(?:\**\s+\**(?:const|G_CONST_RETURN))?(?:\s+|\s*\*+))\s*$/o) {
 607                     $ret_type = $1;
 608                     $ret_type =~ s/\s*\n//;
 609                     $in_declaration = "function";
 610
 611                     $symbol = $previous_line;
 612                     $symbol =~ s/^\s+//;
 613                     $symbol =~ s/\s*\n//;
 614                     #print "DEBUG: Function (6): $symbol, Returns: $ret_type\n";
 615                 }
 616
 617             #} elsif (m/^extern\s+/) {
 618                 #print "DEBUG: Skipping extern: $_";
 619
 620
 621             # STRUCTS
 622
 623             } elsif (m/^\s*struct\s+_(\w+)\s*\*/) {
 624                 # Skip 'struct _<struct_name> *', since it could be a
 625                 # return type on its own line.
 626
 627             } elsif (m/^\s*struct\s+_(\w+)/) {
 628                 # We assume that 'struct _<struct_name>' is really the
 629                 # declaration of struct <struct_name>.
 630                 $symbol = $1;
 631                 $decl = $_;
 632                  # we will find the correct level as below we do $level += tr/{//;
 633                 $level = 0;
 634                 $in_declaration = "struct";
 635                 #print "DEBUG: Struct(_): $symbol\n";
 636
 637
 638             # UNIONS
 639
 640             } elsif (m/^\s*union\s+_(\w+)\s*\*/) {
 641                 # Skip 'union _<union_name> *' (see above)
 642             } elsif (m/^\s*union\s+_(\w+)/) {
 643                 $symbol = $1;
 644                 $decl = $_;
 645                 $level = 0;
 646                 $in_declaration = "union";
 647                 #print "DEBUG: Union(_): $symbol\n";
 648             }
 649
 650         } else {
 651             #print "1: [$skip_block] $_";
 652             # If we were already in the middle of a declaration, we simply add
 653             # the current line onto the end of it.
 654             if ($skip_block == 0) {
 655                 $decl .= $_;
 656             } else {
 657                 if (m%(.*?){%) {
 658                     if ($skip_block == 1) {
 659                         $decl .= $1;
 660                     }
 661                     $skip_block += 1;
 662                 } elsif (m%}%) {
 663                     $skip_block -= 1;
 664                     if ($skip_block == 1) {
 665                         # this is a hack to detect the end of declaration
 666                         $decl .= ";";
 667                         $skip_block = 0;
 668                         #print "2: ---\n";
 669                     }
 670                 } else {
 671                     if ($skip_block == 1) {
 672                         $decl .= $_;
 673                     }
 674                 }
 675             }
 676         }
 677
 678         #if ($in_declaration ne '') {
 679         #    print "$in_declaration = $decl\n";
 680         #}
 681
 682         # Note that sometimes functions end in ') G_GNUC_PRINTF (2, 3);' or
 683         # ') __attribute__ (...);'.
 684         if ($in_declaration eq 'function') {
 685             if ($decl =~ s/\)\s*(G_GNUC_.*|${IGNORE_DECORATORS}\s*|__attribute__\s*\(.*\)\s*)?;.*$//) {
 686                 if ($internal == 0) {
 687                      $decl =~ s%/\*.*?\*/%%gs;  # remove comments.
 688                      #$decl =~ s/^\s+//;                # remove leading whitespace.
 689                      #$decl =~ s/\s+$//;                # remove trailing whitespace.
 690                      $decl =~ s/\s*\n\s*/ /gs;  # consolidate whitespace at start
 691                                                    # and end of lines.
 692                      $ret_type =~ s%/\*.*?\*/%%g;       # remove comments in ret type.
 693                      &AddSymbolToList (\$list, $symbol);
 694                      print DECL "<FUNCTION>\n<NAME>$symbol</NAME>\n$deprecated<RETURNS>$ret_type</RETURNS>\n$decl\n</FUNCTION>\n";
 695                      if ($REBUILD_TYPES) {
 696                          # check if this looks like a get_type function and if so remember
 697                          if (($symbol =~ m/_get_type$/) && ($ret_type =~ m/GType/) && ($decl =~ m/(void|)/)) {
 698                              #print "Adding get-type: [$ret_type] [$symbol] [$decl]\tfrom $input_file\n";
 699                              push (@get_types, $symbol);
 700                          }
 701                      }
 702                 } else {
 703                      $internal = 0;
 704                 }
 705                 $in_declaration = "";
 706                 $skip_block = 0;
 707             }
 708         }
 709
 710         if ($in_declaration eq 'user_function') {
 711             if ($decl =~ s/\).*$//) {
 712                 &AddSymbolToList (\$list, $symbol);
 713                 print DECL "<USER_FUNCTION>\n<NAME>$symbol</NAME>\n$deprecated<RETURNS>$ret_type</RETURNS>\n$decl</USER_FUNCTION>\n";
 714                 $in_declaration = "";
 715             }
 716         }
 717
 718         if ($in_declaration eq 'macro') {
 719             if ($decl !~ m/\\\s*$/) {
 720                 if ($internal == 0) {
 721                     &AddSymbolToList (\$list, $symbol);
 722                     print DECL "<MACRO>\n<NAME>$symbol</NAME>\n$deprecated$decl</MACRO>\n";
 723                 } else {
 724                     $internal = 0;
 725                 }
 726                 $in_declaration = "";
 727             }
 728         }
 729
 730         if ($in_declaration eq 'enum') {
 731             if ($decl =~ m/\}\s*(\w+)?;\s*$/) {
 732                 if ($symbol eq "") {
 733                     $symbol = $1;
 734                 }
 735                 &AddSymbolToList (\$list, $symbol);
 736                 print DECL "<ENUM>\n<NAME>$symbol</NAME>\n$deprecated$decl</ENUM>\n";
 737                 $in_declaration = "";
 738             }
 739         }
 740
 741         # We try to handle nested stucts/unions, but unmatched brackets in
 742         # comments will cause problems.
 743         if ($in_declaration eq 'struct' or $in_declaration eq 'union') {
 744             if ($level <= 1 && $decl =~ m/\}\s*(\w*);\s*$/) {
 745                 if ($symbol eq "") {
 746                     $symbol = $1;
 747                 }
 748
 749                 if ($symbol =~ m/^(\S+)(Class|Iface|Interface)\b/) {
 750                     my $objectname = $1;
 751                     #print "Found object: $1\n";
 752                     $list = "<TITLE>$objectname</TITLE>\n$list";
 753                     push (@objects, $objectname);
 754                 }
 755                 #print "Store struct: $symbol\n";
 756                 &AddSymbolToList (\$list, $symbol);
 757
 758                 my $structsym = uc $in_declaration;
 759                 print DECL "<$structsym>\n<NAME>$symbol</NAME>\n$deprecated$decl</$structsym>\n";
 760                 $in_declaration = "";
 761             } else {
 762                 # We use tr to count the brackets in the line, and adjust
 763                 # $level accordingly.
 764                 $level += tr/{//;
 765                 $level -= tr/}//;
 766                 #print "struct/union level : $level\n";
 767             }
 768         }
 769
 770         $pre_previous_line = $previous_line;
 771         $previous_line = $_;
 772     }
 773     close(INPUT);
 774
 775     #print "DEBUG: Scanning $input_file done\n\n\n";
 776
 777
 778     # Try to separate the standard macros and functions, placing them at the
 779     # end of the current section, in a subsection named 'Standard'.
 780     my ($class) = "";
 781     my ($standard_decl) = "";
 782     if ($list =~ m/^\S+_IS_(\S*)_CLASS/m) {
 783         $class = $1;
 784     } elsif ($list =~ m/^\S+_IS_(\S*)/m) {
 785         $class = $1;
 786     }
 787
 788     if ($class ne "") {
 789         if ($list =~ s/^\S+_IS_$class\n//m)          { $standard_decl .= $&; }
 790         if ($list =~ s/^\S+_TYPE_$class\n//m)        { $standard_decl .= $&; }
 791         if ($list =~ s/^\S+_.*_get_type\n//m)        { $standard_decl .= $&; }
 792         if ($list =~ s/^\S+_${class}_CLASS\n//m)     { $standard_decl .= $&; }
 793         if ($list =~ s/^\S+_IS_${class}_CLASS\n//m)  { $standard_decl .= $&; }
 794         if ($list =~ s/^\S+_${class}_GET_CLASS\n//m) { $standard_decl .= $&; }
 795         if ($list =~ s/^\S+_${class}_GET_IFACE\n//m) { $standard_decl .= $&; }
 796         if ($list =~ s/^\S+_${class}_GET_INTERFACE\n//m) { $standard_decl .= $&; }
 797
 798         # We do this one last, otherwise it tends to be caught by the IS_$class macro
 799         if ($list =~ s/^\S+_$class\n//m)             { $standard_decl = $& . $standard_decl; }
 800
 801         if ($standard_decl ne "") {
 802             $list .= "<SUBSECTION Standard>\n$standard_decl";
 803         }
 804
 805         if ($list ne "") {
 806             $$object_list .= "<SECTION>\n<FILE>$file_basename</FILE>\n$list</SECTION>\n\n";
 807         }
 808     } else {
 809         if ($list ne "") {
 810             $$main_list .= "<SECTION>\n<FILE>$file_basename</FILE>\n$list</SECTION>\n\n";
 811         }
 812     }
 813 }
 814
 815
 816 #############################################################################
 817 # Function    : AddSymbolToList
 818 # Description : This adds the symbol to the list of declarations, but only if
 819 #               it is not already in the list.
 820 # Arguments   : $list - reference to the list of symbols, one on each line.
 821 #               $symbol - the symbol to add to the list.
 822 #############################################################################
 823
 824 sub AddSymbolToList {
 825     my ($list, $symbol) = @_;
 826
 827     if ($$list =~ m/\b\Q$symbol\E\b/) {
 828 #       print "Symbol $symbol already in list. skipping\n";
 829         return;
 830     }
 831     $$list .= "$symbol\n";
 832 }