e0878888408d16a5ee04cef286e45046afe606fc
[samba.git] / source4 / build / pidl / README
1 This directory contains the source code of the pidl (Perl IDL) 
2 compiler. 
3
4 pidl.pl 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_client.pm - Generates client call functions in C using the NDR parser
22 eparser.pm - Generates a parser for the ethereal network sniffer by 
23                                 applying regexes to the output of parser.pm
24 swig.pm - Generates SWIG interface files (.i)
25 ndr_header.pm - Generates a header file with structures
26 ndr.pm - Generates pull/push functions for parsing NDR
27 server.pm - Generates server side implementation in C
28 template.pm - Generates stubs in C for server implementation
29
30 -- COM / DCOM --
31 odl.pm - Generates IDL structures from ODL structures for use in 
32                         the NDR parser generator
33 dcom_proxy.pm - Generates proxy object for DCOM (client-side)
34 dcom_stub.pm - Generates stub call handler for DCOM (server-side)
35 com_header.pm - Generates header file for COM interface(s)
36
37 -- Utility modules --
38 tables.pl - Generates a table of available interfaces from a list of IDL files 
39 util.pm - Misc utility functions used by *.pm and pidl.pl
40 typelist.pm - Utility functions for keeping track of known types and their 
41                                 representation in C
42
43 Tips for hacking on pidl:
44  - Look at the pidl's parse tree by using the --keep option and looking 
45    at the generated .pidl file. 
46  - The various backends have a lot in common, if you don't understand how one 
47    implements something, look at the others
48  - See pidl(1) and the documentation on midl
49  - See 'info bison' and yapp(1) for information on the file format of idl.yp