1
0
mirror of https://github.com/samba-team/samba.git synced 2024-12-23 17:34:34 +03:00
samba-mirror/source4/pidl
2007-12-21 05:46:08 +01:00
..
lib/Parse r26110: Create separate function for connecting, add helper for creating result typemaps. 2007-12-21 05:46:08 +01:00
tests r25915: ndr/pidl: change NTSTAUS into enum ndr_err_code (pidl code) 2007-12-21 05:44:54 +01:00
expr.yp r21222: Merge a couple of pidl fixes: 2007-10-10 14:44:48 -05:00
idl.yp r24815: Support cpp_quote(). 2007-10-10 15:03:14 -05:00
Makefile.PL r20675: Fix installation. 2007-10-10 14:40:19 -05:00
MANIFEST r21586: update manifest 2007-10-10 14:49:01 -05:00
pidl r24815: Support cpp_quote(). 2007-10-10 15:03:14 -05:00
README r21584: Support for tagged types has landed! 2007-10-10 14:49:00 -05:00
smb_interfaces.pm r9459: Move pidl up one level (to prevent too much nesting) 2007-10-10 13:34:17 -05:00
smb_interfaces.yp r9459: Move pidl up one level (to prevent too much nesting) 2007-10-10 13:34:17 -05:00
TODO r21681: Fix bug in the parsing code that parsed "struct foo;" the same as 2007-10-10 14:49:10 -05:00

Introduction:
=============
This directory contains the source code of the pidl (Perl IDL) 
compiler for Samba 4. 

The main sources for pidl are available by Subversion on
svn://svnanon.samba.org/samba/branches/SAMBA_4_0/source/pidl

Pidl works by building a parse tree from a .pidl file (a simple 
dump of it's internal parse tree) or a .idl file 
(a file format mostly like the IDL file format midl uses). 
The IDL file parser is in idl.yp (a yacc file converted to 
perl code by yapp)

After a parse tree is present, pidl will call one of it's backends 
(which one depends on the options given on the command-line). Here is 
a list of current backends:

Standalone installation:
========================
Run Makefile.PL to generate the Makefile. 

Then run "make install" (as root) to install.

Internals overview:
===================

-- Generic --
Parse::Pidl::Dump - Converts the parse tree back to an IDL file
Parse::Pidl::Samba4::Header - Generates header file with data structures defined in IDL file
Parse::Pidl::NDR - Generates intermediate datastructures for use by NDR parses/generators
Parse::Pidl::ODL - Generates IDL structures from ODL structures for use in the NDR parser generator
Parse::Pidl::Test - Utility functions for use in pidl's testsuite

-- Samba NDR --
Parse::Pidl::Samba4::NDR::Client - Generates client call functions in C using the NDR parser
Parse::Pidl::Samba4::SWIG - Generates SWIG interface files (.i)
Parse::Pidl::Samba4::NDR::Parser - Generates pull/push functions for parsing NDR
Parse::Pidl::Samba4::NDR::Server - Generates server side implementation in C
Parse::Pidl::Samba4::TDR - Parser generator for the "Trivial Data Representation"
Parse::Pidl::Samba4::Template - Generates stubs in C for server implementation
Parse::Pidl::Samba4::EJS - Generates bindings for Embedded JavaScript (EJS)

-- Samba COM / DCOM --
Parse::Pidl::Samba4::COM::Proxy - Generates proxy object for DCOM (client-side)
Parse::Pidl::Samba4::COM::Stub - Generates stub call handler for DCOM (server-side)
Parse::Pidl::Samba4::COM::Header - Generates headers for COM

-- Wireshark --
Parse::Pidl::Wireshark::NDR - Generates a parser for the Wireshark network sniffer
Parse::Pidl::Wireshark::Conformance - Reads conformance files containing additional data for generating Wireshark parsers

-- Utility modules --
Parse::Pidl::Util - Misc utility functions used by *.pm and pidl.pl
Parse::Pidl::Typelist - Utility functions for keeping track of known types and their representation in C

Tips for hacking on pidl:
 - Look at the pidl's parse tree by using the --keep option and looking 
   at the generated .pidl file. 
 - The various backends have a lot in common, if you don't understand how one 
   implements something, look at the others
 - See pidl(1) and the documentation on midl
 - See 'info bison' and yapp(1) for information on the file format of idl.yp