source4/build/pidl/util.pm

   1 ###################################################
   2 # utility functions to support pidl
   3 # Copyright tridge@samba.org 2000
   4 # released under the GNU GPL
   5 package util;
   6
   7 #####################################################################
   8 # load a data structure from a file (as saved with SaveStructure)
   9 sub LoadStructure($)
  10 {
  11         my $f = shift;
  12         my $contents = FileLoad($f);
  13         defined $contents || return undef;
  14         return eval "$contents";
  15 }
  16
  17 use strict;
  18
  19 #####################################################################
  20 # flatten an array of arrays into a single array
  21 sub FlattenArray2($)
  22 {
  23     my $a = shift;
  24     my @b;
  25     for my $d (@{$a}) {
  26         for my $d1 (@{$d}) {
  27             push(@b, $d1);
  28         }
  29     }
  30     return \@b;
  31 }
  32
  33 #####################################################################
  34 # flatten an array of arrays into a single array
  35 sub FlattenArray($)
  36 {
  37     my $a = shift;
  38     my @b;
  39     for my $d (@{$a}) {
  40         for my $d1 (@{$d}) {
  41             push(@b, $d1);
  42         }
  43     }
  44     return \@b;
  45 }
  46
  47 #####################################################################
  48 # flatten an array of hashes into a single hash
  49 sub FlattenHash($)
  50 {
  51     my $a = shift;
  52     my %b;
  53     for my $d (@{$a}) {
  54         for my $k (keys %{$d}) {
  55             $b{$k} = $d->{$k};
  56         }
  57     }
  58     return \%b;
  59 }
  60
  61
  62 #####################################################################
  63 # traverse a perl data structure removing any empty arrays or
  64 # hashes and any hash elements that map to undef
  65 sub CleanData($)
  66 {
  67     sub CleanData($);
  68     my($v) = shift;
  69     if (ref($v) eq "ARRAY") {
  70         foreach my $i (0 .. $#{$v}) {
  71             CleanData($v->[$i]);
  72             if (ref($v->[$i]) eq "ARRAY" && $#{$v->[$i]}==-1) {
  73                     $v->[$i] = undef;
  74                     next;
  75             }
  76         }
  77         # this removes any undefined elements from the array
  78         @{$v} = grep { defined $_ } @{$v};
  79     } elsif (ref($v) eq "HASH") {
  80         foreach my $x (keys %{$v}) {
  81             CleanData($v->{$x});
  82             if (!defined $v->{$x}) { delete($v->{$x}); next; }
  83             if (ref($v->{$x}) eq "ARRAY" && $#{$v->{$x}}==-1) { delete($v->{$x}); next; }
  84         }
  85     }
  86 }
  87
  88
  89 #####################################################################
  90 # return the modification time of a file
  91 sub FileModtime($)
  92 {
  93     my($filename) = shift;
  94     return (stat($filename))[9];
  95 }
  96
  97
  98 #####################################################################
  99 # read a file into a string
 100 sub FileLoad($)
 101 {
 102     my($filename) = shift;
 103     local(*INPUTFILE);
 104     open(INPUTFILE, $filename) || return undef;
 105     my($saved_delim) = $/;
 106     undef $/;
 107     my($data) = <INPUTFILE>;
 108     close(INPUTFILE);
 109     $/ = $saved_delim;
 110     return $data;
 111 }
 112
 113 #####################################################################
 114 # write a string into a file
 115 sub FileSave($$)
 116 {
 117     my($filename) = shift;
 118     my($v) = shift;
 119     local(*FILE);
 120     open(FILE, ">$filename") || die "can't open $filename";
 121     print FILE $v;
 122     close(FILE);
 123 }
 124
 125 #####################################################################
 126 # return a filename with a changed extension
 127 sub ChangeExtension($$)
 128 {
 129     my($fname) = shift;
 130     my($ext) = shift;
 131     if ($fname =~ /^(.*)\.(.*?)$/) {
 132         return "$1$ext";
 133     }
 134     return "$fname$ext";
 135 }
 136
 137 #####################################################################
 138 # a dumper wrapper to prevent dependence on the Data::Dumper module
 139 # unless we actually need it
 140 sub MyDumper($)
 141 {
 142         require Data::Dumper;
 143         my $s = shift;
 144         return Data::Dumper::Dumper($s);
 145 }
 146
 147 #####################################################################
 148 # save a data structure into a file
 149 sub SaveStructure($$)
 150 {
 151         my($filename) = shift;
 152         my($v) = shift;
 153         FileSave($filename, MyDumper($v));
 154 }
 155
 156 #####################################################################
 157 # find an interface in an array of interfaces
 158 sub get_interface($$)
 159 {
 160         my($if) = shift;
 161         my($n) = shift;
 162
 163         foreach(@{$if}) {
 164                 if($_->{NAME} eq $n) { return $_; }
 165         }
 166
 167         return 0;
 168 }
 169
 170 #####################################################################
 171 # see if a pidl property list contains a given property
 172 sub has_property($$)
 173 {
 174         my($e) = shift;
 175         my($p) = shift;
 176
 177         if (!defined $e->{PROPERTIES}) {
 178                 return undef;
 179         }
 180
 181         return $e->{PROPERTIES}->{$p};
 182 }
 183
 184 #####################################################################
 185 # see if a pidl property matches a value
 186 sub property_matches($$$)
 187 {
 188         my($e) = shift;
 189         my($p) = shift;
 190         my($v) = shift;
 191
 192         if (!defined has_property($e, $p)) {
 193                 return undef;
 194         }
 195
 196         if ($e->{PROPERTIES}->{$p} =~ /$v/) {
 197                 return 1;
 198         }
 199
 200         return undef;
 201 }
 202
 203 my %enum_list;
 204
 205 sub register_enum($$)
 206 {
 207         my $enum = shift;
 208         my $name = shift;
 209         $enum_list{$name} = $enum;
 210 }
 211
 212 sub is_enum($)
 213 {
 214         my $name = shift;
 215         return defined $enum_list{$name}
 216 }
 217
 218 sub get_enum($)
 219 {
 220         my $name = shift;
 221         return $enum_list{$name};
 222 }
 223
 224 sub enum_type_decl($)
 225 {
 226         my $enum = shift;
 227         return "enum $enum->{TYPE}";
 228 }
 229
 230 sub enum_type_fn($)
 231 {
 232         my $enum = shift;
 233         if (util::has_property($enum->{PARENT}, "enum8bit")) {
 234                 return "uint8";
 235         } elsif (util::has_property($enum->{PARENT}, "v1_enum")) {
 236                 return "uint32";
 237         }
 238         return "uint16";
 239 }
 240
 241 my %bitmap_list;
 242
 243 sub register_bitmap($$)
 244 {
 245         my $bitmap = shift;
 246         my $name = shift;
 247         $bitmap_list{$name} = $bitmap;
 248 }
 249
 250 sub is_bitmap($)
 251 {
 252         my $name = shift;
 253         return defined $bitmap_list{$name};
 254 }
 255
 256 sub get_bitmap($)
 257 {
 258         my $name = shift;
 259         return $bitmap_list{$name};
 260 }
 261
 262 sub bitmap_type_fn($)
 263 {
 264         my $bitmap = shift;
 265
 266         if (util::has_property($bitmap->{PARENT}, "bitmap8bit")) {
 267                 return "uint8";
 268         } elsif (util::has_property($bitmap->{PARENT}, "bitmap16bit")) {
 269                 return "uint16";
 270         } elsif (util::has_property($bitmap->{PARENT}, "bitmap64bit")) {
 271                 return "uint64";
 272         }
 273         return "uint32";
 274 }
 275
 276 sub bitmap_type_decl($)
 277 {
 278         my $bitmap = shift;
 279         return map_type(bitmap_type_fn($bitmap));
 280 }
 281
 282
 283 # determine if an element is a pass-by-reference structure
 284 sub is_ref_struct($)
 285 {
 286         my $e = shift;
 287         if (!is_scalar_type($e->{TYPE}) &&
 288             has_property($e, "ref")) {
 289                 return 1;
 290         }
 291         return 0;
 292 }
 293
 294 # determine the array size (size_is() or ARRAY_LEN)
 295 sub array_size($)
 296 {
 297         my $e = shift;
 298         my $size = has_property($e, "size_is");
 299         if ($size) {
 300                 return $size;
 301         }
 302         $size = $e->{ARRAY_LEN};
 303         if ($size) {
 304                 return $size;
 305         }
 306         return undef;
 307 }
 308
 309 # return 1 if the string is a C constant
 310 sub is_constant($)
 311 {
 312         my $s = shift;
 313         if (defined $s && $s =~ /^\d/) {
 314                 return 1;
 315         }
 316         return 0;
 317 }
 318
 319 # return 1 if this is a fixed array
 320 sub is_fixed_array($)
 321 {
 322         my $e = shift;
 323         my $len = $e->{"ARRAY_LEN"};
 324         if (defined $len && is_constant($len)) {
 325                 return 1;
 326         }
 327         return 0;
 328 }
 329
 330 # return 1 if this is a inline array
 331 sub is_inline_array($)
 332 {
 333         my $e = shift;
 334         my $len = $e->{"ARRAY_LEN"};
 335         if (is_fixed_array($e) ||
 336             defined $len && $len ne "*") {
 337                 return 1;
 338         }
 339         return 0;
 340 }
 341
 342 # return a "" quoted string, unless already quoted
 343 sub make_str($)
 344 {
 345         my $str = shift;
 346         if (substr($str, 0, 1) eq "\"") {
 347                 return $str;
 348         }
 349         return "\"" . $str . "\"";
 350 }
 351
 352
 353 # provide mappings between IDL base types and types in our headers
 354 my %type_mappings =
 355     (
 356      "int8"         => "int8_t",
 357      "uint8"        => "uint8_t",
 358      "short"        => "int16_t",
 359      "wchar_t"      => "uint16_t",
 360      "int16"        => "int16_t",
 361      "uint16"       => "uint16_t",
 362      "int32"        => "int32_t",
 363      "uint32"       => "uint32_t",
 364      "int64"        => "int64_t",
 365      "uint64"       => "uint64_t",
 366      "dlong"        => "int64_t",
 367      "udlong"       => "uint64_t",
 368      "hyper"        => "uint64_t",
 369      "NTTIME_1sec"  => "NTTIME",
 370      "NTTIME_hyper" => "NTTIME",
 371      "ipv4address"  => "const char *"
 372      );
 373
 374 # map from a IDL type to a C header type
 375 sub map_type($)
 376 {
 377         my $name = shift;
 378         if (my $ret = $type_mappings{$name}) {
 379                 return $ret;
 380         }
 381         return $name;
 382 }
 383
 384 1;
 385