source4/build/pidl/README

   1 This directory contains the source code of the pidl (Perl IDL)
   2 compiler.
   3
   4 pidl is the main file of pidl.
   5
   6 Pidl works by building a parse tree from a .pidl file (a simple
   7 dump of it's internal parse tree) or a .idl file
   8 (a file format mostly like the IDL file format midl uses).
   9 The IDL file parser is in idl.yp (a yacc file converted to
  10 perl code by yapp)
  11
  12 After a parse tree is present, pidl will call one of it's backends
  13 (which one depends on the options given on the command-line). Here is
  14 a list of current backends:
  15
  16 -- Generic --
  17 dump.pm - Converts the parse tree back to an IDL file
  18 validator.pm  - Validates the parse tree
  19
  20 -- DCE/RPC+NDR --
  21 ndr.pm - Generates intermediate datastructures for use by NDR parses/generators
  22 ndr_client.pm - Generates client call functions in C using the NDR parser
  23 eth_parser.pm - Generates a parser for the ethereal network sniffer
  24 eth_header.pm - Generates a header for ethereal
  25 swig.pm - Generates SWIG interface files (.i)
  26 ndr_header.pm - Generates a header file with structures
  27 ndr_parser.pm - Generates pull/push functions for parsing NDR
  28 server.pm - Generates server side implementation in C
  29 template.pm - Generates stubs in C for server implementation
  30 ejs.pm - Generates bindings for Embedded JavaScript (EJS)
  31 ejs_header.pm - Generates headers for the EJS bindings
  32
  33 -- COM / DCOM --
  34 odl.pm - Generates IDL structures from ODL structures for use in
  35                         the NDR parser generator
  36 dcom_proxy.pm - Generates proxy object for DCOM (client-side)
  37 dcom_stub.pm - Generates stub call handler for DCOM (server-side)
  38 com_header.pm - Generates header file for COM interface(s)
  39
  40 -- Utility modules --
  41 tables.pl - Generates a table of available interfaces from a list of IDL files
  42 util.pm - Misc utility functions used by *.pm and pidl.pl
  43 typelist.pm - Utility functions for keeping track of known types and their
  44                                 representation in C
  45
  46 Tips for hacking on pidl:
  47  - Look at the pidl's parse tree by using the --keep option and looking
  48    at the generated .pidl file.
  49  - The various backends have a lot in common, if you don't understand how one
  50    implements something, look at the others
  51  - See pidl(1) and the documentation on midl
  52  - See 'info bison' and yapp(1) for information on the file format of idl.yp