source4/build/pidl/pidl

   1 #!/usr/bin/perl -w
   2
   3 ###################################################
   4 # package to parse IDL files and generate code for
   5 # rpc functions in Samba
   6 # Copyright tridge@samba.org 2000-2003
   7 # Copyright jelmer@samba.org 2005
   8 # released under the GNU GPL
   9
  10 use strict;
  11
  12 use Getopt::Long;
  13 use File::Basename;
  14 use Parse::Pidl;
  15 use Parse::Pidl::Util;
  16
  17 #####################################################################
  18 # save a data structure into a file
  19 sub SaveStructure($$)
  20 {
  21         my($filename,$v) = @_;
  22         Parse::Pidl::Util::FileSave($filename, Parse::Pidl::Util::MyDumper($v));
  23 }
  24
  25 #####################################################################
  26 # load a data structure from a file (as saved with SaveStructure)
  27 sub LoadStructure($)
  28 {
  29         my $f = shift;
  30         my $contents = Parse::Pidl::Util::FileLoad($f);
  31         defined $contents || return undef;
  32         return eval "$contents";
  33 }
  34
  35 my($opt_help) = 0;
  36 my($opt_parse) = 0;
  37 my($opt_dump) = 0;
  38 my($opt_uint_enums) = 0;
  39 my($opt_diff) = 0;
  40 my($opt_ndr_header);
  41 my($opt_template) = 0;
  42 my($opt_client);
  43 my($opt_server);
  44 my($opt_ndr_parser);
  45 my($opt_eth_parser);
  46 my($opt_eth_header);
  47 my($opt_keep);
  48 my($opt_swig);
  49 my($opt_dcom_proxy);
  50 my($opt_com_header);
  51 my($opt_ejs);
  52 my($opt_odl) = 0;
  53 my($opt_quiet) = 0;
  54 my($opt_outputdir) = '.';
  55 my($opt_verbose) = 0;
  56 my($opt_warn_compat) = 0;
  57
  58 #########################################
  59 # display help text
  60 sub ShowHelp()
  61 {
  62 print "perl IDL parser and code generator
  63 Copyright (C) tridge\@samba.org
  64
  65 Usage: pidl [options] <idlfile>
  66
  67 Options:
  68  --help                this help page
  69  --outputdir=OUTDIR    put output in OUTDIR/ [.]
  70  --parse               parse a idl file to a .pidl file
  71  --dump                dump a pidl file back to idl
  72  --uint-enums          don't use C enums, instead use uint* types
  73  --ndr-header[=OUTFILE]create a C NDR header file
  74  --ndr-parser[=OUTFILE]create a C NDR parser
  75  --ejs[=OUTFILE]       create ejs wrapper file
  76  --client[=OUTFILE]    create a C NDR client
  77  --server[=OUTFILE]    create server boilerplate
  78  --template            print a template for a pipe
  79  --eth-parser[=OUTFILE]create an ethereal parser
  80  --eth-header[=OUTFILE]create an ethereal header file
  81  --swig[=OUTFILE]      create swig wrapper file
  82  --diff                run diff on the idl and dumped output
  83  --keep[=OUTFILE]      keep the .pidl file
  84  --odl                 accept ODL input
  85  --dcom-proxy[=OUTFILE]create DCOM proxy (implies --odl)
  86  --com-header[=OUTFILE]create header for COM interfaces (implies --odl)
  87  --warn-compat         warn about incompatibility with other compilers
  88  --quiet               be quiet
  89  --verbose             be verbose
  90 \n";
  91     exit(0);
  92 }
  93
  94 # main program
  95 GetOptions (
  96             'help|h|?' => \$opt_help,
  97             'outputdir=s' => \$opt_outputdir,
  98             'parse' => \$opt_parse,
  99             'dump' => \$opt_dump,
 100             'uint-enums' => \$opt_uint_enums,
 101             'ndr-header:s' => \$opt_ndr_header,
 102             'server:s' => \$opt_server,
 103             'template' => \$opt_template,
 104             'ndr-parser:s' => \$opt_ndr_parser,
 105             'client:s' => \$opt_client,
 106             'eth-parser:s' => \$opt_eth_parser,
 107             'eth-header:s' => \$opt_eth_header,
 108             'ejs' => \$opt_ejs,
 109             'diff' => \$opt_diff,
 110             'odl' => \$opt_odl,
 111             'keep:s' => \$opt_keep,
 112             'swig:s' => \$opt_swig,
 113             'dcom-proxy:s' => \$opt_dcom_proxy,
 114             'com-header:s' => \$opt_com_header,
 115             'quiet' => \$opt_quiet,
 116                 'verbose' => \$opt_verbose,
 117             'warn-compat' => \$opt_warn_compat
 118             );
 119
 120 if ($opt_help) {
 121     ShowHelp();
 122     exit(0);
 123 }
 124
 125 sub process_file($)
 126 {
 127         my $idl_file = shift;
 128         my $outputdir = $opt_outputdir;
 129         my $pidl;
 130         my $ndr;
 131
 132         my $basename = basename($idl_file, ".idl");
 133
 134         my($pidl_file) = ($opt_keep or "$outputdir/$basename.pidl");
 135
 136         unless ($opt_quiet) { print "Compiling $idl_file\n"; }
 137
 138         if ($opt_parse) {
 139                 require Parse::Pidl::IDL;
 140                 my $idl_parser = new Parse::Pidl::IDL;
 141
 142                 $pidl = $idl_parser->parse_idl($idl_file);
 143                 defined @$pidl || die "Failed to parse $idl_file";
 144                 require Parse::Pidl::Typelist;
 145                 Parse::Pidl::Typelist::LoadIdl($pidl);
 146         require Parse::Pidl::Validator;
 147                 Parse::Pidl::Validator::Validate($pidl);
 148                 if (defined($opt_keep) && !SaveStructure($pidl_file, $pidl)) {
 149                             die "Failed to save $pidl_file\n";
 150                 }
 151         } else {
 152                 $pidl = LoadStructure($pidl_file);
 153                 defined $pidl || die "Failed to load $pidl_file - maybe you need --parse\n";
 154         }
 155
 156         if ($opt_uint_enums) {
 157                 Parse::Pidl::Util::setUseUintEnums(1);
 158         }
 159
 160         if ($opt_dump) {
 161                 require Parse::Pidl::Dump;
 162                 print Parse::Pidl::Dump($pidl);
 163         }
 164
 165         if ($opt_diff) {
 166                 my($tempfile) = "$outputdir/$basename.tmp";
 167                 Parse::Pidl::Util::FileSave($tempfile, IdlDump::Dump($pidl));
 168                 system("diff -wu $idl_file $tempfile");
 169                 unlink($tempfile);
 170         }
 171
 172         if (defined($opt_com_header)) {
 173                 require Parse::Pidl::Samba::COM::Header;
 174                 my $res = Parse::Pidl::Samba::COM::Header::Parse($pidl);
 175                 if ($res) {
 176                         my $comh_filename = ($opt_com_header or "$outputdir/com_$basename.h");
 177                         Parse::Pidl::Util::FileSave($comh_filename,
 178                         "#include \"librpc/gen_ndr/ndr_orpc.h\"\n" .
 179                         "#include \"$outputdir/ndr_$basename.h\"\n" .
 180                         $res);
 181                 }
 182                 $opt_odl = 1;
 183         }
 184
 185         if (defined($opt_dcom_proxy)) {
 186                 require Parse::Pidl::Samba::COM::Proxy;
 187                 my $res = Parse::Pidl::Samba::COM::Proxy::Parse($pidl);
 188                 if ($res) {
 189                         my ($client) = ($opt_dcom_proxy or "$outputdir/$basename\_p.c");
 190                         Parse::Pidl::Util::FileSave($client,
 191                         "#include \"includes.h\"\n" .
 192                         "#include \"$outputdir/com_$basename.h\"\n" .
 193                         "#include \"lib/com/dcom/dcom.h\"\n" .$res);
 194                 }
 195                 $opt_odl = 1;
 196         }
 197
 198         if ($opt_warn_compat) {
 199                 require Parse::Pidl::Compat;
 200                 Parse::Pidl::Compat::Check($pidl);
 201         }
 202
 203         if ($opt_odl) {
 204                 require Parse::Pidl::ODL;
 205                 $pidl = Parse::Pidl::ODL::ODL2IDL($pidl);
 206         }
 207
 208         if (defined($opt_ndr_header) or defined($opt_eth_parser) or
 209             defined($opt_eth_header) or defined($opt_client) or
 210             defined($opt_server) or defined($opt_ndr_parser) or
 211             defined($opt_ejs)) {
 212                 require Parse::Pidl::NDR;
 213                 $ndr = Parse::Pidl::NDR::Parse($pidl);
 214         }
 215
 216         if (defined($opt_ndr_header)) {
 217                 my $header = ($opt_ndr_header or "$outputdir/ndr_$basename.h");
 218                 require Parse::Pidl::Samba::NDR::Header;
 219                 Parse::Pidl::Util::FileSave($header, Parse::Pidl::Samba::NDR::Header::Parse($pidl));
 220                 if (defined($opt_swig)) {
 221                   require Parse::Pidl::Samba::SWIG;
 222                   my($filename) = ($opt_swig or "$outputdir/$basename.i");
 223                   Parse::Pidl::Samba::SWIG::RewriteHeader($pidl, $header, $filename);
 224                 }
 225         }
 226
 227         if (defined($opt_eth_header)) {
 228           require Parse::Pidl::Ethereal::NDR::Header;
 229           my($eparserhdr) = ($opt_eth_header or "$outputdir/packet-dcerpc-$basename.h");
 230
 231           Parse::Pidl::Util::FileSave($eparserhdr, Parse::Pidl::Ethereal::NDR::Header::Parse($ndr));
 232         }
 233
 234         my $h_filename = "$outputdir/ndr_$basename.h";
 235         if (defined($opt_client)) {
 236                 require Parse::Pidl::Samba::NDR::Client;
 237                 my ($client) = ($opt_client or "$outputdir/ndr_$basename\_c.c");
 238
 239                 Parse::Pidl::Util::FileSave($client, Parse::Pidl::Samba::NDR::Client::Parse($ndr,$h_filename));
 240         }
 241
 242         if (defined($opt_ejs)) {
 243                 require Parse::Pidl::Samba::EJS;
 244                 require Parse::Pidl::Samba::EJSHeader;
 245                 Parse::Pidl::Util::FileSave("$outputdir/ndr_$basename\_ejs.c", Parse::Pidl::Samba::EJS::Parse($ndr, $h_filename));
 246
 247                 Parse::Pidl::Util::FileSave("$outputdir/ndr_$basename\_ejs.h", Parse::Pidl::Samba::EJSHeader::Parse($ndr));
 248         }
 249
 250         if (defined($opt_server)) {
 251                 require Parse::Pidl::Samba::NDR::Server;
 252                 my $dcom = "";
 253
 254                 foreach my $x (@{$pidl}) {
 255                         next if ($x->{TYPE} ne "INTERFACE");
 256
 257                         if (Parse::Pidl::Util::has_property($x, "object")) {
 258                                 require Parse::Pidl::Samba::COM::Stub;
 259                                 $dcom .= Parse::Pidl::Samba::COM::Stub::ParseInterface($x);
 260                         }
 261                 }
 262
 263                 Parse::Pidl::Util::FileSave(($opt_server or "$outputdir/ndr_$basename\_s.c"), Parse::Pidl::Samba::NDR::Server::Parse($ndr,$h_filename));
 264
 265                 if ($dcom ne "") {
 266                         $dcom = "
 267 #include \"includes.h\"
 268 #include \"$h_filename\"
 269 #include \"rpc_server/dcerpc_server.h\"
 270 #include \"rpc_server/common/common.h\"
 271
 272 $dcom
 273 ";
 274         Parse::Pidl::Util::FileSave("$outputdir/$basename\_d.c", $dcom);
 275                 }
 276         }
 277
 278         if (defined($opt_ndr_parser)) {
 279                 my $parser = ($opt_ndr_parser or "$outputdir/ndr_$basename.c");
 280                 require Parse::Pidl::Samba::NDR::Parser;
 281                 Parse::Pidl::Util::FileSave($parser, Parse::Pidl::Samba::NDR::Parser::Parse($ndr, $parser));
 282         }
 283
 284         if (defined($opt_eth_parser)) {
 285           require Parse::Pidl::Ethereal::NDR::Parser;
 286           my($eparser) = ($opt_eth_parser or "$outputdir/packet-dcerpc-$basename.c");
 287           Parse::Pidl::Util::FileSave($eparser, Parse::Pidl::Ethereal::NDR::Parser::Parse($ndr, $basename, $eparser));
 288         }
 289
 290         if ($opt_template) {
 291                 require Parse::Pidl::Samba::Template;
 292                 print Parse::Pidl::Samba::Template::Parse($pidl);
 293         }
 294 }
 295
 296 foreach my $filename (@ARGV) {
 297         process_file($filename);
 298 }