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";
141 my %section_list = ();
147 # do not read files twice; checking it here permits to give both srcdir and
148 # builddir as --source-dir without fear of duplicities
151 # The header files to scan are passed in as command-line args.
153 &ScanHeader ($file, \%section_list);
156 for my $dir (@SOURCE_DIRS) {
157 &ScanHeaders ($dir, \%section_list);
160 ## FIXME: sort by key and output
161 #print DECLLIST $section_list;
163 foreach $section (sort(keys %section_list)) {
164 print DECLLIST "$section_list{$section}";
170 if ($REBUILD_TYPES) {
173 foreach $func (sort(@get_types)) {
174 print TYPES "$func\n";
177 &UpdateFileIfChanged ($old_types, $new_types, 1);
179 # remove the file if empty
180 if (scalar (@get_types) == 0) {
181 unlink ("$new_types");
185 &UpdateFileIfChanged ($old_decl_list, $new_decl_list, 1);
186 &UpdateFileIfChanged ($old_decl, $new_decl, 1);
188 # If there is no MODULE-sections.txt file yet or we are asked to rebuild it,
189 # we copy the MODULE-decl-list.txt file into its place. The user can tweak it
190 # later if they want.
191 if ($REBUILD_SECTIONS || ! -e $sections_file) {
192 `cp $old_decl_list $sections_file`;
195 # If there is no MODULE-overrides.txt file we create an empty one
196 # because EXTRA_DIST in gtk-doc.make requires it.
197 my $overrides_file = "${OUTPUT_DIR}/$MODULE-overrides.txt";
198 if (! -e $overrides_file) {
199 `touch $overrides_file`;
204 #############################################################################
205 # Function : ScanHeaders
206 # Description : This scans a directory tree looking for header files.
208 # Arguments : $source_dir - the directory to scan.
209 # $section_list - a reference to the hashmap of sections.
210 #############################################################################
213 my ($source_dir, $section_list) = @_;
214 @TRACE@("Scanning source directory: $source_dir");
216 # This array holds any subdirectories found.
219 opendir (SRCDIR, $source_dir)
220 || die "Can't open source directory $source_dir: $!";
222 foreach $file (readdir (SRCDIR)) {
223 if ($file eq '.' || $file eq '..' || $file =~ /^\./) {
225 } elsif (-d "$source_dir/$file") {
226 push (@subdirs, $file);
227 } elsif ($file =~ m/\.h$/) {
228 &ScanHeader ("$source_dir/$file", $section_list);
233 # Now recursively scan the subdirectories.
235 foreach $dir (@subdirs) {
236 next if ($IGNORE_HEADERS =~ m/(\s|^)\Q${dir}\E(\s|$)/);
237 &ScanHeaders ("$source_dir/$dir", $section_list);
242 #############################################################################
243 # Function : ScanHeader
244 # Description : This scans a header file, looking for declarations of
245 # functions, macros, typedefs, structs and unions, which it
246 # outputs to the DECL file.
247 # Arguments : $input_file - the header file to scan.
248 # $section_list - a reference to the hashmap of sections.
249 # Returns : it adds declarations to the appropriate list.
250 #############################################################################
253 my ($input_file, $section_list) = @_;
255 my $list = ""; # Holds the resulting list of declarations.
256 my $title = ""; # Holds the title of the section
257 my ($in_comment) = 0; # True if we are in a comment.
258 my ($in_declaration) = ""; # The type of declaration we are in, e.g.
259 # 'function' or 'macro'.
260 my ($skip_block) = 0; # True if we should skip a block.
261 my ($symbol); # The current symbol being declared.
262 my ($decl); # Holds the declaration of the current symbol.
263 my ($ret_type); # For functions and function typedefs this
264 # holds the function's return type.
265 my ($pre_previous_line) = ""; # The pre-previous line read in - some Gnome
266 # functions have the return type on one
267 # line, the function name on the next,
268 # and the rest of the declaration after.
269 my ($previous_line) = ""; # The previous line read in - some Gnome
270 # functions have the return type on one line
271 # and the rest of the declaration after.
272 my ($first_macro) = 1; # Used to try to skip the standard #ifdef XXX
273 # #define XXX at the start of headers.
274 my ($level); # Used to handle structs/unions which contain
275 # nested structs or unions.
276 my @objects = (); # Holds declarations that look like GtkObject
277 # subclasses, which we remove from the list.
278 my ($internal) = 0; # Set to 1 for internal symbols, we need to
279 # fully parse, but don't add them to docs
280 my %forward_decls = (); # hashtable of forward declarations, we skip
281 # them if we find the real declaration
283 my %doc_comments = (); # hastable of doc-comment we found. We can
284 # use that to put element to the right
285 # sction in the generated section-file
289 my $deprecated_conditional_nest = 0;
290 my $ignore_conditional_nest = 0;
293 my $doc_comment = "";
295 # Don't scan headers twice
296 my $canonical_input_file = realpath $input_file;
297 if (exists $seen_headers{$canonical_input_file}) {
298 @TRACE@("File already scanned: $input_file");
301 $seen_headers{$canonical_input_file} = 1;
303 if ($input_file =~ m/^.*[\/\\](.*)\.h+$/) {
306 LogWarning(__FILE__,__LINE__,"Can't find basename of file $input_file");
307 $file_basename = $input_file;
310 # Check if the basename is in the list of headers to ignore.
311 if ($IGNORE_HEADERS =~ m/(\s|^)\Q${file_basename}\E\.h(\s|$)/) {
312 @TRACE@("File ignored: $input_file");
315 # Check if the full name is in the list of headers to ignore.
316 if ($IGNORE_HEADERS =~ m/(\s|^)\Q${input_file}\E(\s|$)/) {
317 @TRACE@("File ignored: $input_file");
321 if (! -f $input_file) {
322 LogWarning(__FILE__,__LINE__,"File doesn't exist: $input_file");
326 @TRACE@("Scanning $input_file");
328 open(INPUT, $input_file)
329 || die "Can't open $input_file: $!";
331 # If this is a private header, skip it.
332 if (m%^\s*/\*\s*<\s*private_header\s*>\s*\*/%) {
337 # Skip to the end of the current comment.
339 @TRACE@("Comment: $_");
342 if ($doc_comment =~ m/\* ([a-zA-Z][a-zA-Z0-9_]+):/) {
343 $doc_comments{lc($1)} = 1;
351 # Keep a count of #if, #ifdef, #ifndef nesting,
352 # and if we enter a deprecation-symbol-bracketed
354 if (m/^\s*#\s*if(?:n?def\b|\s+!?\s*defined\s*\()\s*(\w+)/) {
355 my $define_name = $1;
356 if ($deprecated_conditional_nest < 1 and $define_name =~ /$DEPRECATED_GUARDS/) {
357 $deprecated_conditional_nest = 1;
358 } elsif ($deprecated_conditional_nest >= 1) {
359 $deprecated_conditional_nest += 1;
361 if ($ignore_conditional_nest == 0 and $define_name =~ /__GTK_DOC_IGNORE__/) {
362 $ignore_conditional_nest = 1;
363 } elsif ($ignore_conditional_nest > 0) {
364 $ignore_conditional_nest += 1;
366 } elsif (m/^\s*#\sif/) {
367 if ($deprecated_conditional_nest >= 1) {
368 $deprecated_conditional_nest += 1;
370 if ($ignore_conditional_nest > 0) {
371 $ignore_conditional_nest += 1;
373 } elsif (m/^\s*#endif/) {
374 if ($deprecated_conditional_nest >= 1) {
375 $deprecated_conditional_nest -= 1;
377 if ($ignore_conditional_nest > 0) {
378 $ignore_conditional_nest -= 1;
382 # If we find a line containing _DEPRECATED, we hope that this is
383 # attribute based deprecation and also treat this as a deprecation
385 if ($deprecated_conditional_nest == 0 and m/_DEPRECATED/) {
386 $deprecated_conditional_nest += 0.1;
389 # set global that is used later when we do AddSymbolToList
390 if ($deprecated_conditional_nest > 0) {
391 $deprecated = "<DEPRECATED/>\n";
396 if($ignore_conditional_nest) {
400 if (!$in_declaration) {
401 # Skip top-level comments.
404 @TRACE@("Found one-line comment: $_");
408 @TRACE@("Found start of comment: $_");
417 if (m/^\s*#\s*define\s+(\w+)/) {
420 # We assume all macros which start with '_' are private, but
421 # we accept '_' itself which is the standard gettext macro.
422 # We also try to skip the first macro if it looks like the
423 # standard #ifndef HEADER_FILE #define HEADER_FILE etc.
424 # And we only want TRUE & FALSE defined in GLib (libdefs.h in
425 # libgnome also defines them if they are not already defined).
426 if (($symbol !~ m/^_/
427 && ($previous_line !~ m/#ifndef\s+$symbol/
428 || $first_macro == 0)
429 && (($symbol ne 'TRUE' && $symbol ne 'FALSE')
430 || $MODULE eq 'glib'))
432 $in_declaration = "macro";
433 @TRACE@("Macro: $symbol");
435 @TRACE@("skipping Macro: $symbol");
436 $in_declaration = "macro";
442 # TYPEDEF'D FUNCTIONS (i.e. user functions)
445 } elsif (m/^\s*typedef\s+((const\s+|G_CONST_RETURN\s+)?\w+)(\s+const)?\s*(\**)\s*\(\*\s*(\w+)\)\s*\(/) {
446 my $p3 = defined($3) ? $3 : "";
447 $ret_type = "$1$p3 $4";
450 $in_declaration = "user_function";
451 @TRACE@("user function (1): $symbol, Returns: $ret_type");
454 } elsif (($previous_line =~ m/^\s*typedef\s*/) && m/^\s*((const\s+|G_CONST_RETURN\s+)?\w+)(\s+const)?\s*(\**)\s*\(\*\s*(\w+)\)\s*\(/) {
455 my $p3 = defined($3) ? $3 : "";
456 $ret_type = "$1$p3 $4";
459 $in_declaration = "user_function";
460 @TRACE@("user function (2): $symbol, Returns: $ret_type");
463 } elsif (($previous_line =~ m/^\s*typedef\s*/) && m/^\s*(\**)\s*\(\*\s*(\w+)\)\s*\(/) {
468 if ($previous_line =~ m/^\s*typedef\s*((const\s+|G_CONST_RETURN\s+)?\w+)(\s+const)?\s*/) {
469 my $p3 = defined($3) ? $3 : "";
470 $ret_type = "$1$p3 ".$ret_type;
471 $in_declaration = "user_function";
472 @TRACE@("user function (3): $symbol, Returns: $ret_type");
475 # FUNCTION POINTER VARIABLES
477 } elsif (m/^\s*(?:\b(?:extern|G_INLINE_FUNC|${IGNORE_DECORATORS})\s*)*((const\s+|G_CONST_RETURN\s+)?\w+)(\s+const)?\s*(\**)\s*\(\*\s*(\w+)\)\s*\(/o) {
478 my $p3 = defined($3) ? $3 : "";
479 $ret_type = "$1$p3 $4";
482 $in_declaration = "user_function";
483 @TRACE@("function pointer variable: $symbol, Returns: $ret_type");
487 } elsif (s/^\s*enum\s+_(\w+)\s+\{/enum $1 {/) {
488 # We assume that 'enum _<enum_name> {' is really the
489 # declaration of enum <enum_name>.
491 @TRACE@("plain enum: $symbol");
493 $in_declaration = "enum";
495 } elsif (m/^\s*typedef\s+enum\s+_?(\w+)\s+\1\s*;/) {
496 # We skip 'typedef enum <enum_name> _<enum_name>;' as the enum will
497 # be declared elsewhere.
498 @TRACE@("skipping enum typedef: $1");
500 } elsif (m/^\s*typedef\s+enum/) {
502 @TRACE@("typedef enum: -");
504 $in_declaration = "enum";
509 } elsif (m/^\s*typedef\s+(struct|union)\s+_(\w+)\s+\2\s*;/) {
510 # We've found a 'typedef struct _<name> <name>;'
511 # This could be an opaque data structure, so we output an
512 # empty declaration. If the structure is actually found that
513 # will override this.
514 my $structsym = uc $1;
515 @TRACE@("$structsym typedef: $2");
516 $forward_decls{$2} = "<$structsym>\n<NAME>$2</NAME>\n$deprecated</$structsym>\n"
518 } elsif (m/^\s*(?:struct|union)\s+_(\w+)\s*;/) {
519 # Skip private structs/unions.
520 @TRACE@("private struct/union");
522 } elsif (m/^\s*(struct|union)\s+(\w+)\s*;/) {
523 # Do a similar thing for normal structs as for typedefs above.
524 # But we output the declaration as well in this case, so we
525 # can differentiate it from a typedef.
526 my $structsym = uc $1;
527 @TRACE@("$structsym: $2");
528 $forward_decls{$2} = "<$structsym>\n<NAME>$2</NAME>\n$_$deprecated</$structsym>\n";
530 } elsif (m/^\s*typedef\s+(struct|union)\s*\w*\s*{/) {
534 $in_declaration = $1;
535 @TRACE@("typedef struct/union $1");
539 } elsif (m/^\s*typedef\s+(?:struct|union)\s+\w+[\s\*]+(\w+)\s*;/) {
540 @TRACE@("Found struct/union(*) typedef $1: $_");
541 if (&AddSymbolToList (\$list, $1)) {
542 print DECL "<TYPEDEF>\n<NAME>$1</NAME>\n$deprecated$_</TYPEDEF>\n";
545 } elsif (m/^\s*(G_GNUC_EXTENSION\s+)?typedef\s+(.+[\s\*])(\w+)(\s*\[[^\]]+\])*\s*;/) {
546 if ($2 !~ m/^struct\s/ && $2 !~ m/^union\s/) {
547 @TRACE@("Found typedef: $_");
548 if (&AddSymbolToList (\$list, $3)) {
549 print DECL "<TYPEDEF>\n<NAME>$3</NAME>\n$deprecated$_</TYPEDEF>\n";
552 } elsif (m/^\s*typedef\s+/) {
553 @TRACE@("Skipping typedef: $_");
556 # VARIABLES (extern'ed variables)
558 } elsif (m/^\s*(extern|[A-Za-z_]+VAR|${IGNORE_DECORATORS})\s+((const\s+|signed\s+|unsigned\s+|long\s+|short\s+)*\w+)(\s+\*+|\*+|\s)\s*(const\s+)*([A-Za-z]\w*)\s*;/) {
560 s/^\s*([A-Za-z_]+VAR)\b/extern/;
562 @TRACE@("Possible extern var $symbol: $decl");
563 if (&AddSymbolToList (\$list, $symbol)) {
564 print DECL "<VARIABLE>\n<NAME>$symbol</NAME>\n$deprecated$decl</VARIABLE>\n";
570 } elsif (m/^\s*((const\s+|signed\s+|unsigned\s+|long\s+|short\s+)*\w+)(\s+\*+|\*+|\s)\s*(const\s+)*([A-Za-z]\w*)\s*\=/) {
573 @TRACE@("Possible global var $symbol: $decl");
574 if (&AddSymbolToList (\$list, $symbol)) {
575 print DECL "<VARIABLE>\n<NAME>$symbol</NAME>\n$deprecated$decl</VARIABLE>\n";
581 # We assume that functions which start with '_' are private, so
584 } elsif (m/^\s*(?:\b(?:extern|G_INLINE_FUNC|${IGNORE_DECORATORS})\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) {
586 if (defined ($2)) { $ret_type .= " $2"; }
589 @TRACE@("internal Function: $symbol, Returns: [$1][$2]");
590 $in_declaration = "function";
592 if (m/^\s*G_INLINE_FUNC/) {
593 @TRACE@("skip block after inline function");
594 # now we we need to skip a whole { } block
599 } elsif (m/^\s*(?:\b(?:extern|G_INLINE_FUNC|${IGNORE_DECORATORS})\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) {
601 if (defined ($2)) { $ret_type .= " $2"; }
604 @TRACE@("Function (1): $symbol, Returns: [$1][$2]");
605 $in_declaration = "function";
606 if (m/^\s*G_INLINE_FUNC/) {
607 @TRACE@("skip block after inline function");
608 # now we we need to skip a whole { } block
612 # Try to catch function declarations which have the return type on
613 # the previous line. But we don't want to catch complete functions
614 # which have been declared G_INLINE_FUNC, e.g. g_bit_nth_lsf in
615 # glib, or 'static inline' functions.
616 } elsif (m/^\s*([A-Za-z]\w*)\s*\(/) {
620 if ($previous_line !~ m/^\s*G_INLINE_FUNC/) {
621 if ($previous_line !~ m/^\s*static\s+/) {
623 if ($previous_line =~ m/^\s*(?:\b(?:extern|${IGNORE_DECORATORS})\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) {
625 if (defined ($2)) { $ret_type .= " $2"; }
626 @TRACE@("Function (2): $symbol, Returns: $ret_type");
627 $in_declaration = "function";
630 @TRACE@("skip block after inline function");
631 # now we we need to skip a whole { } block
634 if ($previous_line =~ m/^\s*(?:\b(?:extern|static|inline|${IGNORE_DECORATORS})\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) {
636 if (defined ($2)) { $ret_type .= " $2"; }
637 @TRACE@("Function (3): $symbol, Returns: $ret_type");
638 $in_declaration = "function";
643 if ($previous_line !~ m/^\s*static\s+/) {
644 @TRACE@("skip block after inline function");
645 # now we we need to skip a whole { } block
648 if ($previous_line =~ m/^\s*(?:\b(?:extern|G_INLINE_FUNC|${IGNORE_DECORATORS})\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) {
650 if (defined ($2)) { $ret_type .= " $2"; }
651 @TRACE@("Function (4): $symbol, Returns: $ret_type");
652 $in_declaration = "function";
657 # Try to catch function declarations with the return type and name
658 # on the previous line(s), and the start of the parameters on this.
659 } elsif (m/^\s*\(/) {
661 if ($previous_line =~ m/^\s*(?:\b(?:extern|G_INLINE_FUNC|${IGNORE_DECORATORS})\s*)*((?:const\s+|G_CONST_RETURN\s+|signed\s+|unsigned\s+|enum\s+)*\w+)(\s+\*+|\*+|\s)\s*([A-Za-z]\w*)\s*$/o) {
664 @TRACE@("Function (5): $symbol, Returns: $ret_type");
665 $in_declaration = "function";
667 } elsif ($previous_line =~ m/^\s*\w+\s*$/
668 && $pre_previous_line =~ m/^\s*(?:\b(?:extern|G_INLINE_FUNC|${IGNORE_DECORATORS})\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) {
670 $ret_type =~ s/\s*\n//;
671 $in_declaration = "function";
673 $symbol = $previous_line;
675 $symbol =~ s/\s*\n//;
676 @TRACE@("Function (6): $symbol, Returns: $ret_type");
679 #} elsif (m/^extern\s+/) {
680 #print "DEBUG: Skipping extern: $_";
685 } elsif (m/^\s*struct\s+_(\w+)\s*\*/) {
686 # Skip 'struct _<struct_name> *', since it could be a
687 # return type on its own line.
689 } elsif (m/^\s*struct\s+_(\w+)/) {
690 # We assume that 'struct _<struct_name>' is really the
691 # declaration of struct <struct_name>.
694 # we will find the correct level as below we do $level += tr/{//;
696 $in_declaration = "struct";
697 @TRACE@("Struct(_): $symbol");
702 } elsif (m/^\s*union\s+_(\w+)\s*\*/) {
703 # Skip 'union _<union_name> *' (see above)
704 } elsif (m/^\s*union\s+_(\w+)/) {
708 $in_declaration = "union";
709 @TRACE@("Union(_): $symbol");
713 @TRACE@("1: [$skip_block] $_");
714 # If we were already in the middle of a declaration, we simply add
715 # the current line onto the end of it.
716 if ($skip_block == 0) {
719 # Remove all nested pairs of curly braces.
720 while ($_ =~ s/{[^{]*}//g) { }
721 # Then hope at most one remains in the line...
723 if ($skip_block == 1) {
729 if ($skip_block == 1) {
730 # this is a hack to detect the end of declaration
736 if ($skip_block == 1) {
743 #if ($in_declaration ne '') {
744 # print "$in_declaration = $decl\n";
747 # Note that sometimes functions end in ') G_GNUC_PRINTF (2, 3);' or
748 # ') __attribute__ (...);'.
749 if ($in_declaration eq 'function') {
750 if ($decl =~ s/\)\s*(G_GNUC_.*|.*DEPRECATED.*|${IGNORE_DECORATORS}\s*|__attribute__\s*\(.*\)\s*)?;.*$//) {
751 if ($internal == 0) {
752 $decl =~ s%/\*.*?\*/%%gs; # remove comments.
753 #$decl =~ s/^\s+//; # remove leading whitespace.
754 #$decl =~ s/\s+$//; # remove trailing whitespace.
755 $decl =~ s/\s*\n\s*/ /gs; # consolidate whitespace at start
757 $ret_type =~ s%/\*.*?\*/%%g; # remove comments in ret type.
758 if (&AddSymbolToList (\$list, $symbol)) {
759 print DECL "<FUNCTION>\n<NAME>$symbol</NAME>\n$deprecated<RETURNS>$ret_type</RETURNS>\n$decl\n</FUNCTION>\n";
760 if ($REBUILD_TYPES) {
761 # check if this looks like a get_type function and if so remember
762 if (($symbol =~ m/_get_type$/) && ($ret_type =~ m/GType/) && ($decl =~ m/(void|)/)) {
763 @TRACE@("Adding get-type: [$ret_type] [$symbol] [$decl]\tfrom $input_file");
764 push (@get_types, $symbol);
771 $deprecated_conditional_nest = int($deprecated_conditional_nest);
772 $in_declaration = "";
777 if ($in_declaration eq 'user_function') {
778 if ($decl =~ s/\).*$//) {
779 if (&AddSymbolToList (\$list, $symbol)) {
780 print DECL "<USER_FUNCTION>\n<NAME>$symbol</NAME>\n$deprecated<RETURNS>$ret_type</RETURNS>\n$decl</USER_FUNCTION>\n";
782 $deprecated_conditional_nest = int($deprecated_conditional_nest);
783 $in_declaration = "";
787 if ($in_declaration eq 'macro') {
788 if ($decl !~ m/\\\s*$/) {
789 if ($internal == 0) {
790 if (&AddSymbolToList (\$list, $symbol)) {
791 print DECL "<MACRO>\n<NAME>$symbol</NAME>\n$deprecated$decl</MACRO>\n";
796 $deprecated_conditional_nest = int($deprecated_conditional_nest);
797 $in_declaration = "";
801 if ($in_declaration eq 'enum') {
802 if ($decl =~ m/\}\s*(\w+)?;\s*$/) {
806 if (&AddSymbolToList (\$list, $symbol)) {
807 print DECL "<ENUM>\n<NAME>$symbol</NAME>\n$deprecated$decl</ENUM>\n";
809 $deprecated_conditional_nest = int($deprecated_conditional_nest);
810 $in_declaration = "";
814 # We try to handle nested stucts/unions, but unmatched brackets in
815 # comments will cause problems.
816 if ($in_declaration eq 'struct' or $in_declaration eq 'union') {
817 if (($level <= 1) && ($decl =~ m/\n\}\s*(\w*);\s*$/)) {
822 if ($symbol =~ m/^(\S+)(Class|Iface|Interface)\b/) {
824 @TRACE@("Found object: $1");
825 $title = "<TITLE>$objectname</TITLE>\n";
826 push (@objects, $objectname);
828 @TRACE@("Store struct: $symbol");
829 if (&AddSymbolToList (\$list, $symbol)) {
830 my $structsym = uc $in_declaration;
831 print DECL "<$structsym>\n<NAME>$symbol</NAME>\n$deprecated$decl</$structsym>\n";
832 if (defined($forward_decls{$symbol})) {
833 undef($forward_decls{$symbol});
836 $deprecated_conditional_nest = int($deprecated_conditional_nest);
837 $in_declaration = "";
839 # We use tr to count the brackets in the line, and adjust
840 # $level accordingly.
843 @TRACE@("struct/union level : $level");
847 $pre_previous_line = $previous_line;
852 # print remaining forward declarations
853 foreach $symbol (keys %forward_decls) {
854 if (defined($forward_decls{$symbol})) {
855 &AddSymbolToList (\$list, $symbol);
856 print DECL $forward_decls{$symbol};
861 $list = "$title$list";
863 @TRACE@("Scanning $input_file done\n");
865 # Try to separate the standard macros and functions, placing them at the
866 # end of the current section, in a subsection named 'Standard'.
867 # do this in a loop to catch object, enums and flags
868 my ($class,$lclass,$prefix,$lprefix);
869 my ($standard_decl) = "";
871 if ($list =~ m/^(\S+)_IS_(\S*)_CLASS\n/m) {
873 $lprefix = lc($prefix);
875 $lclass = lc($class);
876 @TRACE@("Found gobject type '${prefix}_$class' from is_class macro\n");
877 } elsif ($list =~ m/^(\S+)_IS_(\S*)\n/m) {
879 $lprefix = lc($prefix);
881 $lclass = lc($class);
882 @TRACE@("Found gobject type '${prefix}_$class' from is_ macro\n");
883 } elsif ($list =~ m/^(\S+?)_(\S*)_get_type\n/m) {
885 $prefix = uc($lprefix);
887 $class = uc($lclass);
888 @TRACE@("Found gobject type '${prefix}_$class' from get_type function\n");
890 $class = $lclass = "";
894 my ($cclass) = $lclass;
896 my ($type) = $lprefix.$cclass;
898 if ($list =~ s/^${type}Private\n//im) { $standard_decl .= $&; }
900 # We only leave XxYy* in the normal section if they have docs
901 if (! defined($doc_comments{$type})) {
902 @TRACE@(" Hide instance docs for $type");
903 if ($list =~ s/^${type}\n//im) { $standard_decl .= $&; }
905 if (! defined($doc_comments{$type."class"})) {
906 @TRACE@(" Hide class docs for $type");
907 if ($list =~ s/^${type}Class\n//im) { $standard_decl .= $&; }
909 if (! defined($doc_comments{$type."interface"})) {
910 @TRACE@(" Hide iface docs for $type");
911 if ($list =~ s/^$type}Interface\n//im) { $standard_decl .= $&; }
913 if (! defined($doc_comments{$type."iface"})) {
914 @TRACE@(" Hide iface docs for $type");
915 if ($list =~ s/${type}Iface\n//im) { $standard_decl .= $&; }
918 while ($list =~ s/^\S+_IS_$class\n//m) { $standard_decl .= $&; }
919 while ($list =~ s/^\S+_TYPE_$class\n//m) { $standard_decl .= $&; }
920 while ($list =~ s/^\S+_${lclass}_get_type\n//m) { $standard_decl .= $&; }
921 while ($list =~ s/^\S+_${class}_CLASS\n//m) { $standard_decl .= $&; }
922 while ($list =~ s/^\S+_IS_${class}_CLASS\n//m) { $standard_decl .= $&; }
923 while ($list =~ s/^\S+_${class}_GET_CLASS\n//m) { $standard_decl .= $&; }
924 while ($list =~ s/^\S+_${class}_GET_IFACE\n//m) { $standard_decl .= $&; }
925 while ($list =~ s/^\S+_${class}_GET_INTERFACE\n//m) { $standard_decl .= $&; }
927 # We do this one last, otherwise it tends to be caught by the IS_$class macro
928 while ($list =~ s/^\S+_$class\n//m) { $standard_decl .= $&; }
930 @TRACE@("Decl '".join(",",split("\n",$list))."'\n");
931 @TRACE@("Std '".join(",",split("\n",$standard_decl))."'\n");
933 } while ($class ne "");
934 if ($standard_decl ne "") {
936 $standard_decl=join("\n",sort(split("\n",$standard_decl)))."\n";
937 $list .= "<SUBSECTION Standard>\n$standard_decl";
940 $$section_list{$file_basename} .= "<SECTION>\n<FILE>$file_basename</FILE>\n$list</SECTION>\n\n";
945 #############################################################################
946 # Function : AddSymbolToList
947 # Description : This adds the symbol to the list of declarations, but only if
948 # it is not already in the list.
949 # Arguments : $list - reference to the list of symbols, one on each line.
950 # $symbol - the symbol to add to the list.
951 #############################################################################
953 sub AddSymbolToList {
954 my ($list, $symbol) = @_;
956 if ($$list =~ m/\b\Q$symbol\E\b/) {
957 #print "Symbol $symbol already in list. skipping\n";
958 # we return 0 to skip outputting another entry to -decl.txt
959 # this is to avoid redeclarations (e.g. in conditional
963 $$list .= "$symbol\n";