4 # gtk-doc - GTK DocBook documentation generator.
5 # Copyright (C) 1998 Damon Chaplin
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.
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.
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.
22 #############################################################################
23 # Script : gtkdoc-scan
24 # Description : Extracts declarations of functions, macros, enums, structs
25 # and unions from header files.
27 # It is called with a module name, an optional source directory,
28 # an optional output directory, and the header files to scan.
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'.
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 #############################################################################
43 push @INC, '@PACKAGE_DATA_DIR@';
44 require "gtkdoc-common.pl";
48 # name of documentation module
52 my $IGNORE_HEADERS = "";
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;
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");
89 gtkdoc-scan version @VERSION@ - scan header files for public symbols
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/dirs not to
95 --output-dir=DIRNAME The directory where the results are stored
96 --deprecated-guards=GUARDS A |-separated list of symbols used as deprecation
98 --ignore-decorators=DECS A |-separated list of addition decorators in
99 declarations that should be ignored
100 --rebuild-sections Rebuild (overwrite) the MODULE-sections.txt file
101 --rebuild-types Automatically recreate the MODULE.types file using
102 all the *_get_type() functions found
103 --version Print the version of this program
104 --help Print this help
109 $DEPRECATED_GUARDS = $DEPRECATED_GUARDS ? $DEPRECATED_GUARDS : "does_not_match_any_cpp_symbols_at_all_nope";
111 $IGNORE_DECORATORS = $IGNORE_DECORATORS || "(?=no)match";
113 $OUTPUT_DIR = $OUTPUT_DIR ? $OUTPUT_DIR : ".";
115 if (!-d ${OUTPUT_DIR}) {
116 mkdir($OUTPUT_DIR, 0755) || die "Cannot create $OUTPUT_DIR: $!";
119 my $old_decl_list = "${OUTPUT_DIR}/$MODULE-decl-list.txt";
120 my $new_decl_list = "${OUTPUT_DIR}/$MODULE-decl-list.new";
121 my $old_decl = "${OUTPUT_DIR}/$MODULE-decl.txt";
122 my $new_decl = "${OUTPUT_DIR}/$MODULE-decl.new";
123 my $old_types = "${OUTPUT_DIR}/$MODULE.types";
124 my $new_types = "${OUTPUT_DIR}/$MODULE.types.new";
125 my $sections_file = "${OUTPUT_DIR}/$MODULE-sections.txt";
127 # If this is the very first run then we create the .types file automatically.
128 if (! -e $sections_file && ! -e $old_types) {
132 open (DECLLIST, ">$new_decl_list")
133 || die "Can't open $new_decl_list";
134 open (DECL, ">$new_decl")
135 || die "Can't open $new_decl";
136 if ($REBUILD_TYPES) {
137 open (TYPES, ">$new_types")
138 || die "Can't open $new_types";
142 my $object_list = "";
148 # do not read files twice; checking it here permits to give both srcdir and
149 # builddir as --source-dir without fear of duplicities
152 # The header files to scan are passed in as command-line args.
154 &ScanHeader ($file, \$object_list, \$main_list);
157 for my $dir (@SOURCE_DIRS) {
158 &ScanHeaders ($dir, \$object_list, \$main_list);
161 print DECLLIST $object_list, $main_list;
164 if ($REBUILD_TYPES) {
167 foreach $func (sort(@get_types)) {
168 print TYPES "$func\n";
171 &UpdateFileIfChanged ($old_types, $new_types, 1);
173 # remove the file if empty
174 if (scalar (@get_types) == 0) {
175 unlink ("$new_types");
179 &UpdateFileIfChanged ($old_decl_list, $new_decl_list, 1);
180 &UpdateFileIfChanged ($old_decl, $new_decl, 1);
182 # If there is no MODULE-sections.txt file yet or we are asked to rebuild it,
183 # we copy the MODULE-decl-list.txt file into its place. The user can tweak it
184 # later if they want.
185 if ($REBUILD_SECTIONS || ! -e $sections_file) {
186 `cp $old_decl_list $sections_file`;
189 # If there is no MODULE-overrides.txt file we create an empty one
190 # because EXTRA_DIST in gtk-doc.make requires it.
191 my $overrides_file = "${OUTPUT_DIR}/$MODULE-overrides.txt";
192 if (! -e $overrides_file) {
193 `touch $overrides_file`;
198 #############################################################################
199 # Function : ScanHeaders
200 # Description : This scans a directory tree looking for header files.
202 # Arguments : $source_dir - the directory to scan.
203 # $object_list - a reference to the list of object functions &
205 # $main_list - a reference to the list of other declarations.
206 #############################################################################
209 my ($source_dir, $object_list, $main_list) = @_;
210 @TRACE@("Scanning source directory: $source_dir");
212 # This array holds any subdirectories found.
215 opendir (SRCDIR, $source_dir)
216 || die "Can't open source directory $source_dir: $!";
218 foreach $file (readdir (SRCDIR)) {
219 if ($file eq '.' || $file eq '..' || $file =~ /^\./) {
221 } elsif (-d "$source_dir/$file") {
222 push (@subdirs, $file);
223 } elsif ($file =~ m/\.h$/) {
224 &ScanHeader ("$source_dir/$file", $object_list, $main_list);
229 # Now recursively scan the subdirectories.
231 foreach $dir (@subdirs) {
232 next if ($IGNORE_HEADERS =~ m/(\s|^)\Q${dir}\E(\s|$)/);
233 &ScanHeaders ("$source_dir/$dir", $object_list, $main_list);
238 #############################################################################
239 # Function : ScanHeader
240 # Description : This scans a header file, looking for declarations of
241 # functions, macros, typedefs, structs and unions, which it
242 # outputs to the DECL file.
243 # Arguments : $input_file - the header file to scan.
244 # $object_list - a reference to the list of object functions &
246 # $main_list - a reference to the list of other declarations.
247 # Returns : it adds declarations to the appropriate list.
248 #############################################################################
251 my ($input_file, $object_list, $main_list) = @_;
253 my $list = ""; # Holds the resulting list of declarations.
254 my ($in_comment) = 0; # True if we are in a comment.
255 my ($in_declaration) = ""; # The type of declaration we are in, e.g.
256 # 'function' or 'macro'.
257 my ($skip_block) = 0; # True if we should skip a block.
258 my ($symbol); # The current symbol being declared.
259 my ($decl); # Holds the declaration of the current symbol.
260 my ($ret_type); # For functions and function typedefs this
261 # holds the function's return type.
262 my ($pre_previous_line) = ""; # The pre-previous line read in - some Gnome
263 # functions have the return type on one
264 # line, the function name on the next,
265 # and the rest of the declaration after.
266 my ($previous_line) = ""; # The previous line read in - some Gnome
267 # functions have the return type on one line
268 # and the rest of the declaration after.
269 my ($first_macro) = 1; # Used to try to skip the standard #ifdef XXX
270 # #define XXX at the start of headers.
271 my ($level); # Used to handle structs/unions which contain
272 # nested structs or unions.
273 my @objects = (); # Holds declarations that look like GtkObject
274 # subclasses, which we remove from the list.
275 my ($internal) = 0; # Set to 1 for internal symbols, we need to
276 # fully parse, but don't add them to docs
277 my %forward_decls = (); # hashtable of forward declarations, we skip
278 # them if we find the real declaration
283 my $deprecated_conditional_nest = 0;
284 my $ignore_conditional_nest = 0;
288 # Don't scan headers twice
289 my $canonical_input_file = realpath $input_file;
290 if (exists $seen_headers{$canonical_input_file}) {
291 @TRACE@("File already scanned: $input_file");
294 $seen_headers{$canonical_input_file} = 1;
296 if ($input_file =~ m/^.*[\/\\](.*)\.h+$/) {
299 LogWarning(__FILE__,__LINE__,"Can't find basename of file $input_file");
300 $file_basename = $input_file;
303 # Check if the basename is in the list of headers to ignore.
304 if ($IGNORE_HEADERS =~ m/(\s|^)\Q${file_basename}\E\.h(\s|$)/) {
305 @TRACE@("File ignored: $input_file");
309 if (! -f $input_file) {
310 LogWarning(__FILE__,__LINE__,"File doesn't exist: $input_file");
314 @TRACE@("Scanning $input_file");
316 open(INPUT, $input_file)
317 || die "Can't open $input_file: $!";
319 # If this is a private header, skip it.
320 if (m%^\s*/\*\s*<\s*private_header\s*>\s*\*/%) {
325 # Skip to the end of the current comment.
327 @TRACE@("Comment: $_");
334 # Keep a count of #if, #ifdef, #ifndef nesting,
335 # and if we enter a deprecation-symbol-bracketed
337 if (m/^\s*#\s*if(?:n?def\b|\s+!?\s*defined\s*\()\s*(\w+)/) {
338 my $define_name = $1;
339 if ($deprecated_conditional_nest == 0 and $define_name =~ /$DEPRECATED_GUARDS/) {
340 $deprecated_conditional_nest = 1;
341 } elsif ($deprecated_conditional_nest > 0) {
342 $deprecated_conditional_nest += 1;
344 if ($ignore_conditional_nest == 0 and $define_name =~ /__GTK_DOC_IGNORE__/) {
345 $ignore_conditional_nest = 1;
346 } elsif ($ignore_conditional_nest > 0) {
347 $ignore_conditional_nest += 1;
349 } elsif (m/^\s*#\sif/) {
350 if ($deprecated_conditional_nest > 0) {
351 $deprecated_conditional_nest += 1;
353 if ($ignore_conditional_nest > 0) {
354 $ignore_conditional_nest += 1;
356 } elsif (m/^\s*#endif/) {
357 if ($deprecated_conditional_nest > 0) {
358 $deprecated_conditional_nest -= 1;
360 if ($ignore_conditional_nest > 0) {
361 $ignore_conditional_nest -= 1;
365 # set global that is used later when we do AddSymbolToList
366 if ($deprecated_conditional_nest > 0) {
367 $deprecated = "<DEPRECATED/>\n";
372 if($ignore_conditional_nest) {
376 if (!$in_declaration) {
377 # Skip top-level comments.
380 @TRACE@("Found one-line comment: $_");
383 @TRACE@("Found start of comment: $_");
392 if (m/^\s*#\s*define\s+(\w+)/) {
395 # We assume all macros which start with '_' are private, but
396 # we accept '_' itself which is the standard gettext macro.
397 # We also try to skip the first macro if it looks like the
398 # standard #ifndef HEADER_FILE #define HEADER_FILE etc.
399 # And we only want TRUE & FALSE defined in GLib (libdefs.h in
400 # libgnome also defines them if they are not already defined).
401 if (($symbol !~ m/^_/
402 && ($previous_line !~ m/#ifndef\s+$symbol/
403 || $first_macro == 0)
404 && (($symbol ne 'TRUE' && $symbol ne 'FALSE')
405 || $MODULE eq 'glib'))
407 $in_declaration = "macro";
408 @TRACE@("Macro: $symbol");
410 @TRACE@("skipping Macro: $symbol");
411 $in_declaration = "macro";
417 # TYPEDEF'D FUNCTIONS (i.e. user functions)
420 } elsif (m/^\s*typedef\s+((const\s+|G_CONST_RETURN\s+)?\w+)(\s+const)?\s*(\**)\s*\(\*\s*(\w+)\)\s*\(/) {
421 my $p3 = defined($3) ? $3 : "";
422 $ret_type = "$1$p3 $4";
425 $in_declaration = "user_function";
426 @TRACE@("user function (1): $symbol, Returns: $ret_type");
429 } elsif (($previous_line =~ m/^\s*typedef\s*/) && m/^\s*((const\s+|G_CONST_RETURN\s+)?\w+)(\s+const)?\s*(\**)\s*\(\*\s*(\w+)\)\s*\(/) {
430 my $p3 = defined($3) ? $3 : "";
431 $ret_type = "$1$p3 $4";
434 $in_declaration = "user_function";
435 @TRACE@("user function (2): $symbol, Returns: $ret_type");
438 } elsif (($previous_line =~ m/^\s*typedef\s*/) && m/^\s*(\**)\s*\(\*\s*(\w+)\)\s*\(/) {
443 if ($previous_line =~ m/^\s*typedef\s*((const\s+|G_CONST_RETURN\s+)?\w+)(\s+const)?\s*/) {
444 my $p3 = defined($3) ? $3 : "";
445 $ret_type = "$1$p3 ".$ret_type;
446 $in_declaration = "user_function";
447 @TRACE@("user function (3): $symbol, Returns: $ret_type");
450 # FUNCTION POINTER VARIABLES
452 } 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) {
453 my $p3 = defined($3) ? $3 : "";
454 $ret_type = "$1$p3 $4";
457 $in_declaration = "user_function";
458 @TRACE@("function pointer variable: $symbol, Returns: $ret_type");
462 } elsif (s/^\s*enum\s+_(\w+)\s+\{/enum $1 {/) {
463 # We assume that 'enum _<enum_name> {' is really the
464 # declaration of enum <enum_name>.
466 @TRACE@("plain enum: $symbol");
468 $in_declaration = "enum";
470 } elsif (m/^\s*typedef\s+enum\s+_?(\w+)\s+\1\s*;/) {
471 # We skip 'typedef enum <enum_name> _<enum_name>;' as the enum will
472 # be declared elsewhere.
473 @TRACE@("skipping enum typedef: $1");
475 } elsif (m/^\s*typedef\s+enum/) {
477 @TRACE@("typedef enum: -");
479 $in_declaration = "enum";
484 } elsif (m/^\s*typedef\s+(struct|union)\s+_(\w+)\s+\2\s*;/) {
485 # We've found a 'typedef struct _<name> <name>;'
486 # This could be an opaque data structure, so we output an
487 # empty declaration. If the structure is actually found that
488 # will override this.
489 my $structsym = uc $1;
490 @TRACE@("$structsym typedef: $2");
491 $forward_decls{$2} = "<$structsym>\n<NAME>$2</NAME>\n$deprecated</$structsym>\n"
493 } elsif (m/^\s*(?:struct|union)\s+_(\w+)\s*;/) {
494 # Skip private structs/unions.
495 @TRACE@("private struct/union");
497 } elsif (m/^\s*(struct|union)\s+(\w+)\s*;/) {
498 # Do a similar thing for normal structs as for typedefs above.
499 # But we output the declaration as well in this case, so we
500 # can differentiate it from a typedef.
501 my $structsym = uc $1;
502 @TRACE@("$structsym: $2");
503 $forward_decls{$2} = "<$structsym>\n<NAME>$2</NAME>\n$_$deprecated</$structsym>\n";
505 } elsif (m/^\s*typedef\s+(struct|union)\s*\w*\s*{/) {
509 $in_declaration = $1;
510 @TRACE@("typedef struct/union $1");
514 } elsif (m/^\s*typedef\s+(?:struct|union)\s+\w+[\s\*]+(\w+)\s*;/) {
515 @TRACE@("Found struct/union(*) typedef $1: $_");
516 if (&AddSymbolToList (\$list, $1)) {
517 print DECL "<TYPEDEF>\n<NAME>$1</NAME>\n$deprecated$_</TYPEDEF>\n";
520 } elsif (m/^\s*(G_GNUC_EXTENSION\s+)?typedef\s+(.+[\s\*])(\w+)(\s*\[[^\]]+\])*\s*;/) {
521 if ($2 !~ m/^struct\s/ && $2 !~ m/^union\s/) {
522 @TRACE@("Found typedef: $_");
523 if (&AddSymbolToList (\$list, $3)) {
524 print DECL "<TYPEDEF>\n<NAME>$3</NAME>\n$deprecated$_</TYPEDEF>\n";
527 } elsif (m/^\s*typedef\s+/) {
528 @TRACE@("Skipping typedef: $_");
531 # VARIABLES (extern'ed variables)
533 } elsif (m/^\s*(extern|[A-Za-z_]+VAR)\s+((const\s+|signed\s+|unsigned\s+)*\w+)(\s+\*+|\*+|\s)\s*([A-Za-z]\w*)\s*;/) {
535 s/^\s*([A-Za-z_]+VAR)\b/extern/;
536 @TRACE@("Possible extern: $_");
537 if (&AddSymbolToList (\$list, $symbol)) {
538 print DECL "<VARIABLE>\n<NAME>$symbol</NAME>\n$deprecated$_</VARIABLE>\n";
544 # We assume that functions which start with '_' are private, so
547 } 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) {
549 if (defined ($2)) { $ret_type .= " $2"; }
552 @TRACE@("internal Function: $symbol, Returns: [$1][$2]");
553 $in_declaration = "function";
555 if (m/^\s*G_INLINE_FUNC/) {
556 @TRACE@("skip block after inline function");
557 # now we we need to skip a whole { } block
562 } 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) {
564 if (defined ($2)) { $ret_type .= " $2"; }
567 @TRACE@("Function (1): $symbol, Returns: [$1][$2]");
568 $in_declaration = "function";
569 if (m/^\s*G_INLINE_FUNC/) {
570 @TRACE@("skip block after inline function");
571 # now we we need to skip a whole { } block
575 # Try to catch function declarations which have the return type on
576 # the previous line. But we don't want to catch complete functions
577 # which have been declared G_INLINE_FUNC, e.g. g_bit_nth_lsf in
578 # glib, or 'static inline' functions.
579 } elsif (m/^\s*([A-Za-z]\w*)\s*\(/) {
583 if ($previous_line !~ m/^\s*G_INLINE_FUNC/) {
584 if ($previous_line !~ m/^\s*static\s+/) {
586 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) {
588 if (defined ($2)) { $ret_type .= " $2"; }
589 @TRACE@("Function (2): $symbol, Returns: $ret_type");
590 $in_declaration = "function";
593 @TRACE@("skip block after inline function");
594 # now we we need to skip a whole { } block
597 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) {
599 if (defined ($2)) { $ret_type .= " $2"; }
600 @TRACE@("Function (3): $symbol, Returns: $ret_type");
601 $in_declaration = "function";
606 if ($previous_line !~ m/^\s*static\s+/) {
607 @TRACE@("skip block after inline function");
608 # now we we need to skip a whole { } block
611 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) {
613 if (defined ($2)) { $ret_type .= " $2"; }
614 @TRACE@("Function (4): $symbol, Returns: $ret_type");
615 $in_declaration = "function";
620 # Try to catch function declarations with the return type and name
621 # on the previous line(s), and the start of the parameters on this.
622 } elsif (m/^\s*\(/) {
624 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) {
627 @TRACE@("Function (5): $symbol, Returns: $ret_type");
628 $in_declaration = "function";
630 } elsif ($previous_line =~ m/^\s*\w+\s*$/
631 && $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) {
633 $ret_type =~ s/\s*\n//;
634 $in_declaration = "function";
636 $symbol = $previous_line;
638 $symbol =~ s/\s*\n//;
639 @TRACE@("Function (6): $symbol, Returns: $ret_type");
642 #} elsif (m/^extern\s+/) {
643 #print "DEBUG: Skipping extern: $_";
648 } elsif (m/^\s*struct\s+_(\w+)\s*\*/) {
649 # Skip 'struct _<struct_name> *', since it could be a
650 # return type on its own line.
652 } elsif (m/^\s*struct\s+_(\w+)/) {
653 # We assume that 'struct _<struct_name>' is really the
654 # declaration of struct <struct_name>.
657 # we will find the correct level as below we do $level += tr/{//;
659 $in_declaration = "struct";
660 @TRACE@("Struct(_): $symbol");
665 } elsif (m/^\s*union\s+_(\w+)\s*\*/) {
666 # Skip 'union _<union_name> *' (see above)
667 } elsif (m/^\s*union\s+_(\w+)/) {
671 $in_declaration = "union";
672 @TRACE@("Union(_): $symbol");
676 @TRACE@("1: [$skip_block] $_");
677 # If we were already in the middle of a declaration, we simply add
678 # the current line onto the end of it.
679 if ($skip_block == 0) {
683 if ($skip_block == 1) {
689 if ($skip_block == 1) {
690 # this is a hack to detect the end of declaration
696 if ($skip_block == 1) {
703 #if ($in_declaration ne '') {
704 # print "$in_declaration = $decl\n";
707 # Note that sometimes functions end in ') G_GNUC_PRINTF (2, 3);' or
708 # ') __attribute__ (...);'.
709 if ($in_declaration eq 'function') {
710 if ($decl =~ s/\)\s*(G_GNUC_.*|${IGNORE_DECORATORS}\s*|__attribute__\s*\(.*\)\s*)?;.*$//) {
711 if ($internal == 0) {
712 $decl =~ s%/\*.*?\*/%%gs; # remove comments.
713 #$decl =~ s/^\s+//; # remove leading whitespace.
714 #$decl =~ s/\s+$//; # remove trailing whitespace.
715 $decl =~ s/\s*\n\s*/ /gs; # consolidate whitespace at start
717 $ret_type =~ s%/\*.*?\*/%%g; # remove comments in ret type.
718 if (&AddSymbolToList (\$list, $symbol)) {
719 print DECL "<FUNCTION>\n<NAME>$symbol</NAME>\n$deprecated<RETURNS>$ret_type</RETURNS>\n$decl\n</FUNCTION>\n";
720 if ($REBUILD_TYPES) {
721 # check if this looks like a get_type function and if so remember
722 if (($symbol =~ m/_get_type$/) && ($ret_type =~ m/GType/) && ($decl =~ m/(void|)/)) {
723 @TRACE@("Adding get-type: [$ret_type] [$symbol] [$decl]\tfrom $input_file");
724 push (@get_types, $symbol);
731 $in_declaration = "";
736 if ($in_declaration eq 'user_function') {
737 if ($decl =~ s/\).*$//) {
738 if (&AddSymbolToList (\$list, $symbol)) {
739 print DECL "<USER_FUNCTION>\n<NAME>$symbol</NAME>\n$deprecated<RETURNS>$ret_type</RETURNS>\n$decl</USER_FUNCTION>\n";
741 $in_declaration = "";
745 if ($in_declaration eq 'macro') {
746 if ($decl !~ m/\\\s*$/) {
747 if ($internal == 0) {
748 if (&AddSymbolToList (\$list, $symbol)) {
749 print DECL "<MACRO>\n<NAME>$symbol</NAME>\n$deprecated$decl</MACRO>\n";
754 $in_declaration = "";
758 if ($in_declaration eq 'enum') {
759 if ($decl =~ m/\}\s*(\w+)?;\s*$/) {
763 if (&AddSymbolToList (\$list, $symbol)) {
764 print DECL "<ENUM>\n<NAME>$symbol</NAME>\n$deprecated$decl</ENUM>\n";
766 $in_declaration = "";
770 # We try to handle nested stucts/unions, but unmatched brackets in
771 # comments will cause problems.
772 if ($in_declaration eq 'struct' or $in_declaration eq 'union') {
773 if (($level <= 1) && ($decl =~ m/\n\}\s*(\w*);\s*$/)) {
778 if ($symbol =~ m/^(\S+)(Class|Iface|Interface)\b/) {
780 @TRACE@("Found object: $1");
781 $list = "<TITLE>$objectname</TITLE>\n$list";
782 push (@objects, $objectname);
784 @TRACE@("Store struct: $symbol");
785 if (&AddSymbolToList (\$list, $symbol)) {
786 my $structsym = uc $in_declaration;
787 print DECL "<$structsym>\n<NAME>$symbol</NAME>\n$deprecated$decl</$structsym>\n";
788 if (defined($forward_decls{$symbol})) {
789 undef($forward_decls{$symbol});
792 $in_declaration = "";
794 # We use tr to count the brackets in the line, and adjust
795 # $level accordingly.
798 @TRACE@("struct/union level : $level");
802 $pre_previous_line = $previous_line;
807 # print remaining forward declarations
808 foreach $symbol (keys %forward_decls) {
809 if (defined($forward_decls{$symbol})) {
810 &AddSymbolToList (\$list, $symbol);
811 print DECL $forward_decls{$symbol};
815 @TRACE@("Scanning $input_file done\n\n\n");
818 # Try to separate the standard macros and functions, placing them at the
819 # end of the current section, in a subsection named 'Standard'.
821 my ($standard_decl) = "";
822 if ($list =~ m/^\S+_IS_(\S*)_CLASS/m) {
824 } elsif ($list =~ m/^\S+_IS_(\S*)/m) {
829 if ($list =~ s/^\S+_IS_$class\n//m) { $standard_decl .= $&; }
830 if ($list =~ s/^\S+_TYPE_$class\n//m) { $standard_decl .= $&; }
831 if ($list =~ s/^\S+_.*_get_type\n//m) { $standard_decl .= $&; }
832 if ($list =~ s/^\S+_${class}_CLASS\n//m) { $standard_decl .= $&; }
833 if ($list =~ s/^\S+_IS_${class}_CLASS\n//m) { $standard_decl .= $&; }
834 if ($list =~ s/^\S+_${class}_GET_CLASS\n//m) { $standard_decl .= $&; }
835 if ($list =~ s/^\S+_${class}_GET_IFACE\n//m) { $standard_decl .= $&; }
836 if ($list =~ s/^\S+_${class}_GET_INTERFACE\n//m) { $standard_decl .= $&; }
838 # We do this one last, otherwise it tends to be caught by the IS_$class macro
839 if ($list =~ s/^\S+_$class\n//m) { $standard_decl = $& . $standard_decl; }
841 if ($standard_decl ne "") {
842 $list .= "<SUBSECTION Standard>\n$standard_decl";
846 $$object_list .= "<SECTION>\n<FILE>$file_basename</FILE>\n$list</SECTION>\n\n";
850 $$main_list .= "<SECTION>\n<FILE>$file_basename</FILE>\n$list</SECTION>\n\n";
856 #############################################################################
857 # Function : AddSymbolToList
858 # Description : This adds the symbol to the list of declarations, but only if
859 # it is not already in the list.
860 # Arguments : $list - reference to the list of symbols, one on each line.
861 # $symbol - the symbol to add to the list.
862 #############################################################################
864 sub AddSymbolToList {
865 my ($list, $symbol) = @_;
867 if ($$list =~ m/\b\Q$symbol\E\b/) {
868 #print "Symbol $symbol already in list. skipping\n";
869 # we return 0 to skip outputting another entry to -decl.txt
870 # this is to avoid redeclarations (e.g. in conditional
874 $$list .= "$symbol\n";