1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
|
#!@PERL@ -w
# -*- cperl -*-
#
# gtk-doc - GTK DocBook documentation generator.
# Copyright (C) 2001 Damon Chaplin
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
#
# These are functions used by several of the gtk-doc Perl scripts.
# I'll move more of the common routines here eventually, though I need to
# stop them from using global variables.
#
1;
#############################################################################
# Function : UpdateFileIfChanged
# Description : Compares the old version of the file with the new version and
# if the file has changed it moves the new version into the old
# versions place. This is used so we only change files if
# needed, so we can do proper dependency tracking and we don't
# needlessly check files into CVS that haven't changed.
# It returns 0 if the file hasn't changed, and 1 if it has.
# Arguments : $old_file - the pathname of the old file.
# $new_file - the pathname of the new version of the file.
# $make_backup - 1 if a backup of the old file should be kept.
# It will have the .bak suffix added to the file name.
#############################################################################
sub UpdateFileIfChanged {
my ($old_file, $new_file, $make_backup) = @_;
# print "Comparing $old_file with $new_file...\n";
# If the old file doesn't exist we want this to default to 1.
my $exit_code = 1;
if (-e $old_file) {
`cmp -s $old_file $new_file`;
$exit_code = $? >> 8;
# print " cmp exit code: $exit_code ($?)\n";
}
if ($exit_code > 1) {
die "Error running 'cmp $old_file $new_file'";
}
if ($exit_code == 1) {
# print " files changed - replacing old version with new version.\n";
if ($make_backup && -e $old_file) {
rename ($old_file, "$old_file.bak")
|| die "Can't move $old_file to $old_file.bak: $!";
}
rename ($new_file, $old_file)
|| die "Can't move $new_file to $old_file: $!";
return 1;
} else {
# print " files the same - deleting new version.\n";
unlink ("$new_file")
|| die "Can't delete file: $new_file: $!";
return 0;
}
}
#############################################################################
# Function : ParseStructDeclaration
# Description : This function takes a structure declaration and
# breaks it into individual type declarations.
# Arguments : $declaration - the declaration to parse
# $is_object - true if this is an object structure
# $typefunc - function reference to apply to type
# $namefunc - function reference to apply to name
#############################################################################
sub ParseStructDeclaration {
my ($declaration, $is_object, $output_function_params, $typefunc, $namefunc) = @_;
# For forward struct declarations just return an empty array.
if ($declaration =~ m/struct\s+\S+\s*;/msg) {
return ();
}
# Remove all private parts of the declaration
# For objects, assume private
if ($is_object) {
$declaration =~ s!(struct\s+\w*\s*\{)
.*?
(?:/\*\s*<\s*public\s*>\s*\*/|(?=\}))!$1!msgx;
}
# Assume end of declaration if line begins with '}'
$declaration =~ s!\n?[ \t]*/\*\s*<\s*(private|protected)\s*>\s*\*/
.*?
(?:/\*\s*<\s*public\s*>\s*\*/|(?=^\}))!!msgx;
# Remove all other comments;
$declaration =~ s@/\*([^*]+|\*(?!/))*\*/@ @g;
my @result = ();
if ($declaration =~ /^\s*$/) {
return @result;
}
# Prime match after "struct {" declaration
if (!scalar($declaration =~ m/struct\s+\w*\s*\{/msg)) {
die "Structure declaration '$declaration' does not begin with struct [NAME] {\n";
}
# Treat lines in sequence, allowing singly nested anonymous structs
# and unions.
while ($declaration =~ m/\s*([^{;]+(\{[^\}]*\}[^{;]+)?);/msg) {
my $line = $1;
last if $line =~ /^\s*\}\s*\w*\s*$/;
# FIXME: Just ignore nested structs and unions for now
next if $line =~ /{/;
# ignore preprocessor directives
while ($line =~ /^#.*?\n\s*(.*)/msg) {
$line=$1;
}
last if $line =~ /^\s*\}\s*\w*\s*$/;
# Try to match structure members which are functions
if ($line =~ m/^
(const\s+|G_CONST_RETURN\s+|unsigned\s+|signed\s+|long\s+|short\s+)*(struct\s+|enum\s+)? # mod1
(\w+)\s* # type
(\**(?:\s*restrict)?)\s* # ptr1
(const\s+)? # mod2
(\**\s*) # ptr2
(const\s+)? # mod3
\(\s*\*\s*(\w+)\s*\)\s* # name
\(([^)]*)\)\s* # func_params
$/x) {
my $mod1 = defined($1) ? $1 : "";
if (defined($2)) { $mod1 .= $2; }
my $type = $3;
my $ptr1 = $4;
my $mod2 = defined($5) ? $5 : "";
my $ptr2 = $6;
my $mod3 = defined($7) ? $7 : "";
my $name = $8;
my $func_params = $9;
my $ptype = defined $typefunc ? $typefunc->($type) : $type;
my $pname = defined $namefunc ? $namefunc->($name) : $name;
push @result, $name;
if ($output_function_params) {
push @result, "$mod1$ptype$ptr1$mod2$ptr2$mod3 (*$pname) ($func_params)";
} else {
push @result, "$pname ()";
}
# Try to match normal struct fields of comma-separated variables/
} elsif ($line =~ m/^
((?:const\s+|volatile\s+|unsigned\s+|signed\s+|short\s+|long\s+)?)(struct\s+|enum\s+)? # mod1
(\w+)\s* # type
(\** \s* const\s+)? # mod2
(.*) # variables
$/x) {
my $mod1 = defined($1) ? $1 : "";
if (defined($2)) { $mod1 .= $2; }
my $type = $3;
my $ptype = defined $typefunc ? $typefunc->($type) : $type;
my $mod2 = defined($4) ? " " . $4 : "";
my $list = $5;
#print "'$mod1' '$type' '$mod2' '$list' \n";
$mod1 =~ s/ / /g;
$mod2 =~ s/ / /g;
my @names = split /,/, $list;
for my $n (@names) {
# Each variable can have any number of '*' before the
# identifier, and be followed by any number of pairs of
# brackets or a bit field specifier.
# e.g. *foo, ***bar, *baz[12][23], foo : 25.
if ($n =~ m/^\s* (\**(?:\s*restrict\b)?) \s* (\w+) \s* (?: ((?:\[[^\]]*\]\s*)+) | (:\s*\d+)?) \s* $/x) {
my $ptrs = $1;
my $name = $2;
my $array = defined($3) ? $3 : "";
my $bits = defined($4) ? " $4" : "";
if ($ptrs && $ptrs !~ m/\*$/) { $ptrs .= " "; }
$array =~ s/ / /g;
$bits =~ s/ / /g;
push @result, $name;
if (defined $namefunc) {
$name = $namefunc->($name);
}
push @result, "$mod1$ptype$mod2 $ptrs$name$array$bits;";
#print "***** Matched line: $mod1$ptype$mod2 $ptrs$name$array$bits\n";
} else {
print "WARNING: Couldn't parse struct field: $n\n";
}
}
} else {
warn "Cannot parse structure field \"$line\"";
}
}
return @result;
}
#############################################################################
# Function : ParseEnumDeclaration
# Description : This function takes a enumeration declaration and
# breaks it into individual enum member declarations.
# Arguments : $declaration - the declaration to parse
#############################################################################
sub ParseEnumDeclaration {
my ($declaration, $is_object) = @_;
# For forward enum declarations just return an empty array.
if ($declaration =~ m/enum\s+\S+\s*;/msg) {
return ();
}
# Remove comments;
$declaration =~ s@/\*([^*]+|\*(?!/))*\*/@ @g;
my @result = ();
if ($declaration =~ /^\s*$/) {
return @result;
}
# Remove parenthesized expressions (in macros like GTK_BLAH = BLAH(1,3))
# to avoid getting confused by commas they might contain. This
# doesn't handle nested parentheses correctly.
$declaration =~ s/\([^)]+\)//g;
# Remove comma from comma - possible whitespace - closing brace sequence
# since it is legal in GNU C and C99 to have a trailing comma but doesn't
# result in an actual enum member
$declaration =~ s/,(\s*})/$1/g;
# Prime match after "typedef enum {" declaration
if (!scalar($declaration =~ m/(typedef\s+)?enum\s*(\S+\s*)?\{/msg)) {
die "Enum declaration '$declaration' does not begin with 'typedef enum {' or 'enum XXX {'\n";
}
# Treat lines in sequence.
while ($declaration =~ m/\s*([^,\}]+)([,\}])/msg) {
my $line = $1;
my $terminator = $2;
# ignore preprocessor directives
while ($line =~ /^#.*?\n\s*(.*)/msg) {
$line=$1;
}
if ($line =~ m/^(\w+)\s*(=.*)?$/msg) {
push @result, $1;
# Special case for GIOCondition, where the values are specified by
# macros which expand to include the equal sign like '=1'.
} elsif ($line =~ m/^(\w+)\s*GLIB_SYSDEF_POLL/msg) {
push @result, $1;
# Special case include of <gdk/gdkcursors.h>, just ignore it
} elsif ($line =~ m/^#include/) {
last;
# Special case for #ifdef/#else/#endif, just ignore it
} elsif ($line =~ m/^#(?:if|else|endif)/) {
last;
} else {
warn "Cannot parse enumeration member \"$line\"";
}
last if $terminator eq '}';
}
return @result;
}
|