sin/samba-mirror
1
0
Fork 0
mirror of https://github.com/samba-team/samba.git synced 2024-12-25 23:21:54 +03:00
Code
3064782735
samba-mirror/source4/pidl/README

64 lines
2.8 KiB
Plaintext
Raw Normal View History

r9460: - Move pidl to lib/. This fixes standalone installation of pidl. - Update the README - Allow building the docs stand-alone (This used to be commit b56084ce251ab7a35dd1422f38de258e8e1e1477)
2005-08-22 03:30:17 +04:00
Introduction:
=============
r1867: Add README file in build/pidl/ (This used to be commit 189ed098408b52965ccdf652d78ec678bbe0462e)
2004-08-17 23:25:07 +04:00
This directory contains the source code of the pidl (Perl IDL)
r10093: Fix the HF_FIELD conformance file command (This used to be commit 0c0a4b55cff4079276073060dae91ff0c19af42f)
2005-09-09 01:59:40 +04:00
compiler for Samba 4.
r1867: Add README file in build/pidl/ (This used to be commit 189ed098408b52965ccdf652d78ec678bbe0462e)
2004-08-17 23:25:07 +04:00
r10093: Fix the HF_FIELD conformance file command (This used to be commit 0c0a4b55cff4079276073060dae91ff0c19af42f)
2005-09-09 01:59:40 +04:00
The main sources for pidl are available by Subversion on
svn+ssh://svnanon.samba.org/samba/branches/SAMBA_4_0/source/pidl
r1867: Add README file in build/pidl/ (This used to be commit 189ed098408b52965ccdf652d78ec678bbe0462e)
2004-08-17 23:25:07 +04:00
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:
r9460: - Move pidl to lib/. This fixes standalone installation of pidl. - Update the README - Allow building the docs stand-alone (This used to be commit b56084ce251ab7a35dd1422f38de258e8e1e1477)
2005-08-22 03:30:17 +04:00
Standalone installation:
========================
Run Makefile.PL to generate the Makefile.
Then run "make install" (as root) to install.
Internals overview:
===================
r5490: The big (D)COM commit! :-) Contains most of the changes described in the DCOM paper in lorikeet. This is the result of 1.5 months work (mainly figuring out how things *really* work) at the end of 2004. In general: - Clearer distinction between COM and DCOM. DCOM is now merely the glue between DCE/RPC+ORPC and COM. COM can also work without DCOM now. This makes the code a lot clearer. - Clearer distinction between NDR and DCOM. Before, NDR had a couple of "if"s to cope with DCOM, which are now gone. - Use "real" arguments rather then structures for function arguments in COM, mainly because most of these calls are local so packing/unpacking data for every call is too much overhead (both speed- and code-wise) - Support several mechanisms to load class objects: - from memory (e.g. part of the current executable, registered at start-up) - from shared object files - remotely - Most things are now also named COM rather then DCOM because that's what it really is. After an object is created, it no longer matters whether it was created locally or remotely. There is a very simple example class that contains both a class factory and a class that implements the IStream interface. It can be tested (locally only, remotely is broken at the moment) by running the COM-SIMPLE smbtorture test. Still to-do: - Autogenerate parts of the class implementation code (using the coclass definitions in IDL) - Test server-side - Implement some of the common classes, add definitions for common interfaces. (This used to be commit 71fd3e5c3aac5f0002001ab29d2248e6c6842d6f)
2005-02-21 17:30:49 +03:00
-- Generic --
r9433: - Update TODO & README - Extend compatibility module (work towards being able to generate Midl-compatible IDL files, pretty much just removing attributes midl doesn't know such as value() and charset()) - Support charset() on fixed-size arrays of characters (This used to be commit 43817eb0bd46aab10d1595ce008d8380565246f0)
2005-08-21 01:54:45 +04:00
Parse::Pidl::Dump - Converts the parse tree back to an IDL file
r12573: Update README to recent changes in pidls namespace (This used to be commit 33012dc015c837d4cbb61207ad8d3b5a8ad37c02)
2005-12-29 19:03:47 +03:00
Parse::Pidl::Samba4::Header - Generates header file with data structures defined in IDL file
r9433: - Update TODO & README - Extend compatibility module (work towards being able to generate Midl-compatible IDL files, pretty much just removing attributes midl doesn't know such as value() and charset()) - Support charset() on fixed-size arrays of characters (This used to be commit 43817eb0bd46aab10d1595ce008d8380565246f0)
2005-08-21 01:54:45 +04:00
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
r9460: - Move pidl to lib/. This fixes standalone installation of pidl. - Update the README - Allow building the docs stand-alone (This used to be commit b56084ce251ab7a35dd1422f38de258e8e1e1477)
2005-08-22 03:30:17 +04:00
Parse::Pidl::Test - Utility functions for use in pidl's testsuite
r9433: - Update TODO & README - Extend compatibility module (work towards being able to generate Midl-compatible IDL files, pretty much just removing attributes midl doesn't know such as value() and charset()) - Support charset() on fixed-size arrays of characters (This used to be commit 43817eb0bd46aab10d1595ce008d8380565246f0)
2005-08-21 01:54:45 +04:00
-- Samba NDR --
r12573: Update README to recent changes in pidls namespace (This used to be commit 33012dc015c837d4cbb61207ad8d3b5a8ad37c02)
2005-12-29 19:03:47 +03:00
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)
r9433: - Update TODO & README - Extend compatibility module (work towards being able to generate Midl-compatible IDL files, pretty much just removing attributes midl doesn't know such as value() and charset()) - Support charset() on fixed-size arrays of characters (This used to be commit 43817eb0bd46aab10d1595ce008d8380565246f0)
2005-08-21 01:54:45 +04:00
-- Samba COM / DCOM --
r12573: Update README to recent changes in pidls namespace (This used to be commit 33012dc015c837d4cbb61207ad8d3b5a8ad37c02)
2005-12-29 19:03:47 +03:00
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
r9433: - Update TODO & README - Extend compatibility module (work towards being able to generate Midl-compatible IDL files, pretty much just removing attributes midl doesn't know such as value() and charset()) - Support charset() on fixed-size arrays of characters (This used to be commit 43817eb0bd46aab10d1595ce008d8380565246f0)
2005-08-21 01:54:45 +04:00
-- Ethereal --
Parse::Pidl::Ethereal::NDR - Generates a parser for the ethereal network sniffer
Parse::Pidl::Ethereal::Conformance - Reads conformance files containing additional data for generating Ethereal parsers
r5490: The big (D)COM commit! :-) Contains most of the changes described in the DCOM paper in lorikeet. This is the result of 1.5 months work (mainly figuring out how things *really* work) at the end of 2004. In general: - Clearer distinction between COM and DCOM. DCOM is now merely the glue between DCE/RPC+ORPC and COM. COM can also work without DCOM now. This makes the code a lot clearer. - Clearer distinction between NDR and DCOM. Before, NDR had a couple of "if"s to cope with DCOM, which are now gone. - Use "real" arguments rather then structures for function arguments in COM, mainly because most of these calls are local so packing/unpacking data for every call is too much overhead (both speed- and code-wise) - Support several mechanisms to load class objects: - from memory (e.g. part of the current executable, registered at start-up) - from shared object files - remotely - Most things are now also named COM rather then DCOM because that's what it really is. After an object is created, it no longer matters whether it was created locally or remotely. There is a very simple example class that contains both a class factory and a class that implements the IStream interface. It can be tested (locally only, remotely is broken at the moment) by running the COM-SIMPLE smbtorture test. Still to-do: - Autogenerate parts of the class implementation code (using the coclass definitions in IDL) - Test server-side - Implement some of the common classes, add definitions for common interfaces. (This used to be commit 71fd3e5c3aac5f0002001ab29d2248e6c6842d6f)
2005-02-21 17:30:49 +03:00
-- Utility modules --
r9433: - Update TODO & README - Extend compatibility module (work towards being able to generate Midl-compatible IDL files, pretty much just removing attributes midl doesn't know such as value() and charset()) - Support charset() on fixed-size arrays of characters (This used to be commit 43817eb0bd46aab10d1595ce008d8380565246f0)
2005-08-21 01:54:45 +04:00
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
r1867: Add README file in build/pidl/ (This used to be commit 189ed098408b52965ccdf652d78ec678bbe0462e)
2004-08-17 23:25:07 +04:00
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
Copy Permalink