From 3533bd05049a50a0d49da25e3bf5852e759f5e15 Mon Sep 17 00:00:00 2001 From: Bruno da Silva de Oliveira Date: Mon, 6 Oct 2003 19:10:50 +0000 Subject: [PATCH] no message [SVN r20266] --- pyste/NEWS | 23 +++ pyste/TODO | 3 + pyste/doc/adding_new_methods.html | 5 +- pyste/doc/exporting_an_entire_header.html | 9 + pyste/doc/inserting_code.html | 73 ++++++++ pyste/doc/policies.html | 2 +- pyste/doc/pyste.txt | 194 +++++++++++++++++----- pyste/doc/renaming_and_excluding.html | 8 +- pyste/doc/running_pyste.html | 107 ++++++++---- pyste/doc/the_interface_files.html | 22 +++ pyste/doc/wrappers.html | 9 +- pyste/index.html | 5 + pyste/src/Pyste/ClassExporter.py | 7 +- pyste/src/Pyste/CodeExporter.py | 5 + pyste/src/Pyste/CppParser.py | 8 +- pyste/src/Pyste/EnumExporter.py | 56 +++---- pyste/src/Pyste/Exporter.py | 5 + pyste/src/Pyste/FunctionExporter.py | 5 + pyste/src/Pyste/GCCXMLParser.py | 11 ++ pyste/src/Pyste/HeaderExporter.py | 7 +- pyste/src/Pyste/MultipleCodeUnit.py | 5 + pyste/src/Pyste/SingleCodeUnit.py | 22 ++- pyste/src/Pyste/SmartFile.py | 5 + pyste/src/Pyste/VarExporter.py | 5 + pyste/src/Pyste/__init__.py | 6 + pyste/src/Pyste/declarations.py | 5 + pyste/src/Pyste/exporters.py | 5 + pyste/src/Pyste/exporterutils.py | 5 + pyste/src/Pyste/infos.py | 5 + pyste/src/Pyste/policies.py | 15 +- pyste/src/Pyste/pyste.py | 28 +++- pyste/src/Pyste/settings.py | 8 + pyste/src/Pyste/utils.py | 5 + 33 files changed, 561 insertions(+), 122 deletions(-) create mode 100644 pyste/doc/inserting_code.html diff --git a/pyste/NEWS b/pyste/NEWS index 4862e0af..355d1b97 100644 --- a/pyste/NEWS +++ b/pyste/NEWS @@ -1,3 +1,26 @@ +6 October 2003 +Fixed bug reported by Niall Douglas (using his patch) about UniqueInt not +appearing correctly with --multiple. + +Added precompiled header support on windows systems (using #pragma hdrstop). +Suggested by Niall Douglas. + +Fixed a bug with -I directive and AllFromHeader. Reported by Scott Snyder. + +4 October 2003 +Added return_self, thanks for Niall Douglas for pointing out that it was +missing. + +Added --file-list, where you can pass a file where the pyste files are listed +one per line. Also suggested by Niall Douglas. + +Documentation has been finally updated, after a long wait. Please let me know +if you spot any mistake! + +2 October 2003 +Scott Snyder found a typo in ClassExporter that prevented -= and *= operators +from being exported. Thanks Scott! + 20 September 2003 Added return_by_value in the list of policies supported. Thanks to Niall Douglas for the remainder. diff --git a/pyste/TODO b/pyste/TODO index 778ec11e..ef8623f7 100644 --- a/pyste/TODO +++ b/pyste/TODO @@ -10,3 +10,6 @@ - Virtual operators - args() support + +- --file-list, allowing the user to pass the filename of a file with the pyste + files diff --git a/pyste/doc/adding_new_methods.html b/pyste/doc/adding_new_methods.html index 22af96c8..5bf2b1e0 100644 --- a/pyste/doc/adding_new_methods.html +++ b/pyste/doc/adding_new_methods.html @@ -4,6 +4,7 @@ Adding New Methods + @@ -20,7 +21,7 @@ - +

@@ -66,7 +67,7 @@ Now from Python:

- +
diff --git a/pyste/doc/exporting_an_entire_header.html b/pyste/doc/exporting_an_entire_header.html index d82b8ba2..c33bd6f9 100644 --- a/pyste/doc/exporting_an_entire_header.html +++ b/pyste/doc/exporting_an_entire_header.html @@ -60,6 +60,15 @@ the members of the header object like this:

rename(hello.World.greet, "Greet") exclude(hello.World.set, "Set") + + + + +
+ + AllFromHeader is broken in some cases. Until it is fixed, +use at you own risk. +
diff --git a/pyste/doc/inserting_code.html b/pyste/doc/inserting_code.html new file mode 100644 index 00000000..c834dc55 --- /dev/null +++ b/pyste/doc/inserting_code.html @@ -0,0 +1,73 @@ + + + +Inserting Code + + + + +
+ + + + +
+ + Inserting Code +
+
+ + + + + + +
+

+You can insert arbitrary code in the generated cpps, just use the functions +declaration_code and module_code. This will insert the given string in the +respective sections. Example:

+
+    ##file A.pyste
+    Class("A", "A.h")
+    declaration_code("/* declaration_code() comes here */\n")
+    module_code("/* module_code() comes here */\n")
+
 +

+Will generate:

+
+    // Includes ====================================================================
+    #include <boost/python.hpp>
+
+    // Using =======================================================================
+    using namespace boost::python;
+
+    // Declarations ================================================================
+
+    /* declaration_code() comes here */
+
+    // Module ======================================================================
+    BOOST_PYTHON_MODULE(A)
+    {
+        class_< A >("A", init<  >())
+            .def(init< const A& >())
+        ;
+
+    /* module_code() comes here */
+    }
+
 + + + + + + +
+
+

Copyright © 2003 Bruno da Silva de Oliveira
Copyright © 2002-2003 Joel de Guzman

+Permission to copy, use, modify, sell and distribute this document + is granted provided this copyright notice appears in all copies. This document + is provided "as is" without express or implied warranty, and with + no claim as to its suitability for any purpose.

+ + diff --git a/pyste/doc/policies.html b/pyste/doc/policies.html index 704aa33b..f4af9df5 100644 --- a/pyste/doc/policies.html +++ b/pyste/doc/policies.html @@ -67,7 +67,7 @@ compile. -Note that, for functions that return const T&, the policy +Note that for functions that return const T&, the policy return_value_policy<copy_const_reference>() wil be used by default, because that's normally what you want. You can change it to something else if you need to, though. diff --git a/pyste/doc/pyste.txt b/pyste/doc/pyste.txt index 9b0ee96f..08eda4aa 100644 --- a/pyste/doc/pyste.txt +++ b/pyste/doc/pyste.txt @@ -73,26 +73,36 @@ Well, now let's fire it up: ''' >python pyste.py -Pyste version 0.6.5 +Pyste version 0.9.26 Usage: - pyste [options] --module= interface-files + pyste [options] interface-files where options are: - -I add an include path - -D define symbol - --multiple create various cpps (one for each pyste file), instead - of only one (useful during development) - --out specify output filename (default: .cpp) - in --multiple mode, this will be a directory - --no-using do not declare "using namespace boost"; - use explicit declarations instead - --pyste-ns= set the namespace where new types will be declared; - default is the empty namespace - --debug writes the xml for each file parsed in the current - directory - -h, --help print this help and exit - -v, --version print version information + --module= The name of the module that will be generated; + defaults to the first interface filename, without + the extension. + -I Add an include path + -D Define symbol + --multiple Create various cpps, instead of only one + (useful during development) + --out= Specify output filename (default: .cpp) + in --multiple mode, this will be a directory + --no-using Do not declare "using namespace boost"; + use explicit declarations instead + --pyste-ns= Set the namespace where new types will be declared; + default is the empty namespace + --debug Writes the xml for each file parsed in the current + directory + --cache-dir= Directory for cache files (speeds up future runs) + --only-create-cache Recreates all caches (doesn't generate code). + --generate-main Generates the _main.cpp file (in multiple mode) + --file-list A file with one pyste file per line. Use as a + substitute for passing the files in the command + line. + -h, --help Print this help and exit + -v, --version Print version information + ''' ] @@ -102,12 +112,6 @@ The [^-I] and [^-D] are preprocessor flags, which are needed by GCCXML to parse the header files correctly and by Pyste to find the header files declared in the interface files. -[^--multiple] tells Pyste to generate multiple cpps for this module (one for -each header parsed) in the directory named by [^--out], instead of the usual -single cpp file. This mode is useful during development of a binding, because -you are constantly changing source files, re-generating the bindings and -recompiling. This saves a lot of time in compiling. - [^--out] names the output file (default: [^.cpp]), or in multiple mode, names a output directory for the files (default: [^]). @@ -122,6 +126,13 @@ default, Pyste uses the empty namespace. [^--debug] will write in the current directory a xml file as outputted by GCCXML for each header parsed. Useful for bug reports. +[^--file-list] names a file where each line points to a Pyste file. Use this instead +to pass the pyste files if you have a lot of them and your shell has some command line +size limit. + +The other options are explained below, in [@#multiple_mode [*Multiple Mode]] and +[@#cache [*Cache]]. + [^-h, --help, -v, --version] are self-explaining, I believe. ;) So, the usage is simple enough: @@ -130,13 +141,7 @@ So, the usage is simple enough: will generate a file [^mymodule.cpp] in the same dir where the command was executed. Now you can compile the file using the same instructions of the -[@../../doc/tutorial/doc/building_hello_world.html tutorial]. Or, if you prefer: - -[pre >python pyste.py --module=mymodule --multiple file.pyste file2.pyste ...] - -will create a directory named "mymodule" in the current directory, and will -generate a bunch of cpp files, one for each header exported. You can then -compile them all into a single shared library (or dll). +[@../../doc/tutorial/doc/building_hello_world.html tutorial]. [h2 Wait... how do I set those I and D flags?] @@ -154,9 +159,62 @@ which for Visual C++ 6 is normally located at: with that, you should have little trouble setting up the flags. [blurb [$theme/note.gif][*A note about Psyco][br][br] -Although you don't have to install [@http://psyco.sourceforge.net/ Psyco] to use Pyste, if you do, Pyste will make use of it to speed up the wrapper generation. Speed ups of 30% can be achieved, so it's highly recommended. +Although you don't have to install [@http://psyco.sourceforge.net/ Psyco] to +use Pyste, if you do, Pyste will make use of it to speed up the wrapper +generation. Speed ups of 30% can be achieved, so it's highly recommended. ] + +[h2 Multiple Mode] + +The multiple mode is useful in large projects, where the presence of multiple +classes in a single file makes the compilation unpractical (excessive memory +usage, mostly). + +The solution is make Pyste generate multiple files, more specifically one cpp +file for each Pyste file. This files will contain a function named after the +file, for instance Export_MyPysteFile, which will contain all the code to export +the classes, enums, etc. You can pass as much files as you want this way: + +[pre >python pyste.py --module=mymodule file1.pyste file2.pyste] + +This will create the files [^mymodule/file1.cpp] and [^mymodule/file2.cpp]. You +can then later do: + +[pre >python pyste.py --module=mymodule file3.pyste] + +and [^mymodule/file3.cpp] will be generated. + +But compiling and linking this files won't be sufficient to generate your +extension. You have to also generate a file named [^main.cpp]; call pyste with +[*all] the Pyste files of your extension, and use the [^--generate-main] option: + +[pre >python pyste.py --module=mymodule --generate-main file1.pyste file2.pyste file3.pyste] + +Now compile and link all this files together and your extension is ready for +use. + +[h2 Cache] + +Pyste now supports a form of cache, which is a way to speed up the code +generation. Most of the time that Pyste takes to generate the code comes from +having to execute GCCXML (since being a front-end to GCC, it has to compile the +header files) and reading back the XML generated. + +When you use the [^--cache-dir=] option, Pyste will dump in the specified +directory the generated XMLs to a file named after the Pyste file, with the +extension [^.pystec]. The next time you run with this option, Pyste will use +the cache, instead of calling GCCXML again: + +[pre >python pyste.py --module=mymodule --cache-dir=cache file1.pyste] + +Will generate [^file1.cpp] and [^cache/file1.pystec]. Next time you execute +this command, the cache file will be used. Note that Pyste doesn't do any check +to ensure that the cache is up to date, but you can configure your build system to do that for you. + +When you run Pyste with [^--only-create-cache], all the cache files will be +created again, but no code will be generated. + [page The Interface Files] The interface files are the heart of Pyste. The user creates one or more @@ -198,6 +256,28 @@ We create a file named [^hello.pyste] and create instances of the classes That will expose the class, the free function and the enum found in [^hello.h]. +[h2 Inheritance] + +Pyste automatically generates the correct code (specifying [^bases<>] in the +[^class_] declaration) [*if] the Class() function that exports the base classes +and their children are in the same Pyste file. If that's not the case, you have +to indicate that there's a relationship between the Pyste files using the +[^Import] function specifying the other Pyste file. + +Suppose we have two classes, [^A] and [^B], and A is a base class for B. We +create two Pyste files: + +[^A.pyste]: + + Class("A", "A.h") + +[^B.pyste]: + + Import("A.pyste") + Class("B", "B.h") + +Note that we specify that [^B] needs to know about [^A] to be properly exported. + [page:1 Renaming and Excluding] You can easily rename functions, classes, member functions, attributes, etc. Just use the @@ -233,10 +313,10 @@ The string inside the brackets is the same as the name of the operator in C++.[b [h2 Virtual Member Functions] -Pyste automatically generates wrappers for virtual member functions, but you -may want to disable this behaviour (for performance reasons, or to let the -code more clean) if you do not plan to override the functions in Python. To do -this, use the function [^final]: +Pyste automatically generates wrappers for virtual member functions, but you may +want to disable this behaviour (for performance reasons, for instance) if you do +not plan to override the functions in Python. To do this, use the function +[^final]: C = Class('C', 'C.h') final(C.foo) # C::foo is a virtual member function @@ -277,7 +357,7 @@ compile. [blurb [$theme/note.gif] -Note that, for functions that return [^const T&], the policy +Note that for functions that return [^const T&], the policy [^return_value_policy()] wil be used by default, because that's normally what you want. You can change it to something else if you need to, though. @@ -344,9 +424,9 @@ Suppose you have this function: std::vector names(); -But you don't want to export [^std::vector], you want this function -to return a python list of strings. Boost.Python has excellent support for -that: +But you don't want to [@../../doc/v2/faq.html#question2 to export std::vector], +you want this function to return a python list of strings. Boost.Python has +excellent support for things like that: list names_wrapper() { @@ -445,6 +525,11 @@ the members of the header object like this: rename(hello.World.greet, "Greet") exclude(hello.World.set, "Set") +[blurb +[$theme/note.gif] [*AllFromHeader is broken] in some cases. Until it is fixed, +use at you own risk. +] + [page:1 Smart Pointers] @@ -501,6 +586,7 @@ Beware of non-const global variables: changes in Python won't reflect in C++! If you really must change them in Python, you will have to write some accessor functions, and export those. + [page:1 Adding New Methods] Suppose that you want to add a function to a class, turning it into a member @@ -539,3 +625,35 @@ Now from Python: Oh no! The knights who say Ni! +[page:1 Inserting Code] + +You can insert arbitrary code in the generated cpps, just use the functions +[^declaration_code] and [^module_code]. This will insert the given string in the +respective sections. Example: + + # file A.pyste + Class("A", "A.h") + declaration_code("/* declaration_code() comes here */\n") + module_code("/* module_code() comes here */\n") + +Will generate: + + // Includes ==================================================================== + #include + + // Using ======================================================================= + using namespace boost::python; + + // Declarations ================================================================ + + /* declaration_code() comes here */ + + // Module ====================================================================== + BOOST_PYTHON_MODULE(A) + { + class_< A >("A", init< >()) + .def(init< const A& >()) + ; + + /* module_code() comes here */ + } diff --git a/pyste/doc/renaming_and_excluding.html b/pyste/doc/renaming_and_excluding.html index e06e0496..79fd4dee 100644 --- a/pyste/doc/renaming_and_excluding.html +++ b/pyste/doc/renaming_and_excluding.html @@ -60,10 +60,10 @@ To access the operators of a class, access the member operator like thi

The string inside the brackets is the same as the name of the operator in C++.

Virtual Member Functions

-Pyste automatically generates wrappers for virtual member functions, but you -may want to disable this behaviour (for performance reasons, or to let the -code more clean) if you do not plan to override the functions in Python. To do -this, use the function final:

+Pyste automatically generates wrappers for virtual member functions, but you may +want to disable this behaviour (for performance reasons, for instance) if you do +not plan to override the functions in Python. To do this, use the function +final:

     C = Class('C', 'C.h')
     final(C.foo) ##C::foo is a virtual member function
diff --git a/pyste/doc/running_pyste.html b/pyste/doc/running_pyste.html
index 6acfbcd0..46bb7f46 100644
--- a/pyste/doc/running_pyste.html
+++ b/pyste/doc/running_pyste.html
@@ -47,26 +47,36 @@ Well, now let's fire it up:

 
 >python pyste.py
 
-Pyste version 0.6.5
+Pyste version 0.9.26
 
 Usage:
-    pyste [options] --module=<name> interface-files
+    pyste [options] interface-files
 
 where options are:
-    -I <path>           add an include path    
-    -D <symbol>         define symbol    
-    --multiple          create various cpps (one for each pyste file), instead
-                        of only one (useful during development)                        
-    --out               specify output filename (default: <module>.cpp)
-                        in --multiple mode, this will be a directory
-    --no-using          do not declare "using namespace boost";
-                        use explicit declarations instead
-    --pyste-ns=<name>   set the namespace where new types will be declared;
-                        default is the empty namespace
-    --debug             writes the xml for each file parsed in the current
-                        directory
-    -h, --help          print this help and exit
-    -v, --version       print version information      
+    --module=<name>         The name of the module that will be generated;
+                            defaults to the first interface filename, without
+                            the extension.
+    -I <path>               Add an include path
+    -D <symbol>             Define symbol
+    --multiple              Create various cpps, instead of only one
+                            (useful during development)
+    --out=<name>            Specify output filename (default: <module>.cpp)
+                            in --multiple mode, this will be a directory
+    --no-using              Do not declare "using namespace boost";
+                            use explicit declarations instead
+    --pyste-ns=<name>       Set the namespace where new types will be declared;
+                            default is the empty namespace
+    --debug                 Writes the xml for each file parsed in the current
+                            directory
+    --cache-dir=<dir>       Directory for cache files (speeds up future runs)
+    --only-create-cache     Recreates all caches (doesn't generate code).
+    --generate-main         Generates the _main.cpp file (in multiple mode)
+    --file-list             A file with one pyste file per line. Use as a 
+                            substitute for passing the files in the command
+                            line.
+    -h, --help              Print this help and exit
+    -v, --version           Print version information
+

Options explained:

@@ -76,12 +86,6 @@ GCCXML to parse the header files correctly and by Pyste to find the header files declared in the interface files.

---multiple tells Pyste to generate multiple cpps for this module (one for -each header parsed) in the directory named by --out, instead of the usual -single cpp file. This mode is useful during development of a binding, because -you are constantly changing source files, re-generating the bindings and -recompiling. This saves a lot of time in compiling.

-

--out names the output file (default: <module>.cpp), or in multiple mode, names a output directory for the files (default: <module>).

@@ -97,6 +101,15 @@ default, Pyste uses the empty namespace.

GCCXML for each header parsed. Useful for bug reports.

+--file-list names a file where each line points to a Pyste file. Use this instead +to pass the pyste files if you have a lot of them and your shell has some command line +size limit.

+

+The other options are explained below, in +Multiple Mode and + +Cache.

+

-h, --help, -v, --version are self-explaining, I believe. ;)

So, the usage is simple enough:

@@ -104,11 +117,7 @@ So, the usage is simple enough:

will generate a file mymodule.cpp in the same dir where the command was executed. Now you can compile the file using the same instructions of the -tutorial. Or, if you prefer:

-
>python pyste.py --module=mymodule --multiple file.pyste file2.pyste ...

-will create a directory named "mymodule" in the current directory, and will -generate a bunch of cpp files, one for each header exported. You can then -compile them all into a single shared library (or dll).

+tutorial.

Wait... how do I set those I and D flags?

Don't worry: normally GCCXML is already configured correctly for your plataform, @@ -129,10 +138,52 @@ with that, you should have little trouble setting up the flags.

A note about Psyco

Although you don't have to install -Psyco to use Pyste, if you do, Pyste will make use of it to speed up the wrapper generation. Speed ups of 30% can be achieved, so it's highly recommended. +Psyco to +use Pyste, if you do, Pyste will make use of it to speed up the wrapper +generation. Speed ups of 30% can be achieved, so it's highly recommended. +

Multiple Mode

+The multiple mode is useful in large projects, where the presence of multiple +classes in a single file makes the compilation unpractical (excessive memory +usage, mostly).

+

+The solution is make Pyste generate multiple files, more specifically one cpp +file for each Pyste file. This files will contain a function named after the +file, for instance Export_MyPysteFile, which will contain all the code to export +the classes, enums, etc. You can pass as much files as you want this way:

+
>python pyste.py --module=mymodule file1.pyste file2.pyste

+This will create the files mymodule/file1.cpp and mymodule/file2.cpp. You +can then later do:

+
>python pyste.py --module=mymodule file3.pyste

+and mymodule/file3.cpp will be generated.

+

+But compiling and linking this files won't be sufficient to generate your +extension. You have to also generate a file named main.cpp; call pyste with +all the Pyste files of your extension, and use the --generate-main option:

+
>python pyste.py --module=mymodule --generate-main file1.pyste file2.pyste file3.pyste

+Now compile and link all this files together and your extension is ready for +use.

+

Cache

+Pyste now supports a form of cache, which is a way to speed up the code +generation. Most of the time that Pyste takes to generate the code comes from +having to execute +GCCXML (since being a front-end to GCC, it has to compile the +header files) and reading back the XML generated.

+

+When you use the --cache-dir=<dir> option, Pyste will dump in the specified +directory the generated XMLs to a file named after the Pyste file, with the +extension .pystec. The next time you run with this option, Pyste will use +the cache, instead of calling +GCCXML again:

+
>python pyste.py --module=mymodule --cache-dir=cache file1.pyste

+Will generate file1.cpp and cache/file1.pystec. Next time you execute +this command, the cache file will be used. Note that Pyste doesn't do any check +to ensure that the cache is up to date, but you can configure your build system to do that for you.

+

+When you run Pyste with --only-create-cache, all the cache files will be +created again, but no code will be generated.

diff --git a/pyste/doc/the_interface_files.html b/pyste/doc/the_interface_files.html index 33ab7103..029e4302 100644 --- a/pyste/doc/the_interface_files.html +++ b/pyste/doc/the_interface_files.html @@ -64,6 +64,28 @@ We create a file named hello.pyste and create instances of the classes

That will expose the class, the free function and the enum found in hello.h.

+

Inheritance

+Pyste automatically generates the correct code (specifying bases<> in the +class_ declaration) if the Class() function that exports the base classes +and their children are in the same Pyste file. If that's not the case, you have +to indicate that there's a relationship between the Pyste files using the +Import function specifying the other Pyste file.

+

+Suppose we have two classes, A and B, and A is a base class for B. We +create two Pyste files:

+

+A.pyste:

+
+    Class("A", "A.h")
+
 +

+B.pyste:

+
+    Import("A.pyste")
+    Class("B", "B.h")
+
 +

+Note that we specify that B needs to know about A to be properly exported.

diff --git a/pyste/doc/wrappers.html b/pyste/doc/wrappers.html index 3265a350..bb4057d1 100644 --- a/pyste/doc/wrappers.html +++ b/pyste/doc/wrappers.html @@ -30,10 +30,11 @@ Suppose you have this function:

std::vector<std::string> names();

-But you don't want to export std::vector<std::string>, you want this function -to return a python list of strings. -Boost.Python has excellent support for -that:

+But you don't want to +to export std::vector<std::string>, +you want this function to return a python list of strings. +Boost.Python has +excellent support for things like that:

     list names_wrapper()
     {
diff --git a/pyste/index.html b/pyste/index.html
index 5017c8af..5a781362 100644
--- a/pyste/index.html
+++ b/pyste/index.html
@@ -75,6 +75,11 @@
         Adding New Methods
+ + +
+ Inserting Code +

Copyright © 2003 Bruno da Silva de Oliveira
Copyright © 2002-2003 Joel de Guzman

diff --git a/pyste/src/Pyste/ClassExporter.py b/pyste/src/Pyste/ClassExporter.py index b8ef74ee..c680383c 100644 --- a/pyste/src/Pyste/ClassExporter.py +++ b/pyste/src/Pyste/ClassExporter.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + import exporters from Exporter import Exporter from declarations import * @@ -425,7 +430,7 @@ class ClassExporter(Exporter): self.Add('template', holder(self.class_.FullName())) # operators natively supported by boost - BOOST_SUPPORTED_OPERATORS = '+ - * / % ^ & ! ~ | < > == != <= >= << >> && || += -='\ + BOOST_SUPPORTED_OPERATORS = '+ - * / % ^ & ! ~ | < > == != <= >= << >> && || += -= '\ '*= /= %= ^= &= |= <<= >>='.split() # create a map for faster lookup BOOST_SUPPORTED_OPERATORS = dict(zip(BOOST_SUPPORTED_OPERATORS, range(len(BOOST_SUPPORTED_OPERATORS)))) diff --git a/pyste/src/Pyste/CodeExporter.py b/pyste/src/Pyste/CodeExporter.py index e89d72aa..3680bb72 100644 --- a/pyste/src/Pyste/CodeExporter.py +++ b/pyste/src/Pyste/CodeExporter.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + from Exporter import Exporter #============================================================================== diff --git a/pyste/src/Pyste/CppParser.py b/pyste/src/Pyste/CppParser.py index 526d61e4..eb5e32c3 100644 --- a/pyste/src/Pyste/CppParser.py +++ b/pyste/src/Pyste/CppParser.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + from GCCXMLParser import ParseDeclarations import tempfile import shutil @@ -151,7 +156,8 @@ class CppParser: if declarations is None: declarations = self.ParseWithGCCXML(header, tail) self.CreateCache(header, interface, tail, declarations) - return declarations, header + header_fullpath = os.path.abspath(self.FindHeader(header)) + return declarations, header_fullpath def CacheFileName(self, interface): diff --git a/pyste/src/Pyste/EnumExporter.py b/pyste/src/Pyste/EnumExporter.py index a9763878..3206ca32 100644 --- a/pyste/src/Pyste/EnumExporter.py +++ b/pyste/src/Pyste/EnumExporter.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + from Exporter import Exporter from settings import * import utils @@ -47,44 +52,23 @@ class EnumExporter(Exporter): exported_names[self.enum.FullName()] = 1 - UNIQUE_INT_EXPORTED = False - def ExportUniqueInt(self, codeunit): - if not EnumExporter.UNIQUE_INT_EXPORTED: - write = lambda s: codeunit.Write('declaration', s) - write('// Unique type for unnamed enums\n') - write('template\n') - write('struct UniqueInt {\n') - write(' int v;\n') - write(' enum { value=num };\n') - write(' UniqueInt(int v_):\n') - write(' v(v_)\n') - write(' {}\n') - write(' operator int() const\n') - write(' { return v; }\n') - write('};\n') - EnumExporter.UNIQUE_INT_EXPORTED = True + write = lambda s: codeunit.Write('declaration', s) + write('// Unique type for unnamed enums\n') + write('#ifndef PYSTE_UNIQUE_INT_DEFINED\n') + write('#define PYSTE_UNIQUE_INT_DEFINED\n') + write('template\n') + write('struct UniqueInt {\n') + write(' int v;\n') + write(' enum { value=num };\n') + write(' UniqueInt(int v_):\n') + write(' v(v_)\n') + write(' {}\n') + write(' operator int() const\n') + write(' { return v; }\n') + write('};\n') + write('#endif // PYSTE_UNIQUE_INT_DEFINED \n') - #def Export(self, codeunit, exported_names): - # if not self.info.exclude: - # indent = self.INDENT - # in_indent = self.INDENT*2 - # rename = self.info.rename or self.enum.name - # full_name = self.enum.FullName() - # if rename == "$_0" or rename == '._0': - # full_name = "int" - # rename = "unnamed" - # code = indent + namespaces.python - # code += 'enum_< %s >("%s")\n' % (full_name, rename) - # for name in self.enum.values: - # rename = self.info[name].rename or name - # value_fullname = self.enum.ValueFullName(name) - # code += in_indent + '.value("%s", %s)\n' % (rename, value_fullname) - # code += indent + ';\n\n' - # codeunit.Write('module', code) - # exported_names[self.Name()] = 1 - - def Name(self): return self.info.name diff --git a/pyste/src/Pyste/Exporter.py b/pyste/src/Pyste/Exporter.py index 2947308e..4de90693 100644 --- a/pyste/src/Pyste/Exporter.py +++ b/pyste/src/Pyste/Exporter.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + import os.path #============================================================================== diff --git a/pyste/src/Pyste/FunctionExporter.py b/pyste/src/Pyste/FunctionExporter.py index bcffcd7c..05da6ec5 100644 --- a/pyste/src/Pyste/FunctionExporter.py +++ b/pyste/src/Pyste/FunctionExporter.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + from Exporter import Exporter from policies import * from declarations import * diff --git a/pyste/src/Pyste/GCCXMLParser.py b/pyste/src/Pyste/GCCXMLParser.py index 8bd9814d..da3862aa 100644 --- a/pyste/src/Pyste/GCCXMLParser.py +++ b/pyste/src/Pyste/GCCXMLParser.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + from declarations import * from elementtree.ElementTree import ElementTree from xml.parsers.expat import ExpatError @@ -313,8 +318,14 @@ class GCCXMLParser(object): self.ParseClass(id, element) + FUNDAMENTAL_RENAME = { + 'long long int' : 'boost::int64_t', + 'long long unsigned int' : 'boost::uint64_t', + } + def ParseFundamentalType(self, id, element): name = element.get('name') + name = self.FUNDAMENTAL_RENAME.get(name, name) type_ = FundamentalType(name) self.Update(id, type_) diff --git a/pyste/src/Pyste/HeaderExporter.py b/pyste/src/Pyste/HeaderExporter.py index 9b3a3ea4..e1f20555 100644 --- a/pyste/src/Pyste/HeaderExporter.py +++ b/pyste/src/Pyste/HeaderExporter.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + from Exporter import Exporter from ClassExporter import ClassExporter from FunctionExporter import FunctionExporter @@ -33,7 +38,7 @@ class HeaderExporter(Exporter): header = os.path.normpath(self.parser_header) for decl in self.declarations: # check if this declaration is in the header - location = os.path.normpath(decl.location[0]) + location = os.path.abspath(decl.location[0]) if location == header and not self.IsInternalName(decl.name): # ok, check the type of the declaration and export it accordingly self.HandleDeclaration(decl, codeunit, exported_names) diff --git a/pyste/src/Pyste/MultipleCodeUnit.py b/pyste/src/Pyste/MultipleCodeUnit.py index f7eaacba..347268a7 100644 --- a/pyste/src/Pyste/MultipleCodeUnit.py +++ b/pyste/src/Pyste/MultipleCodeUnit.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + from SingleCodeUnit import SingleCodeUnit import os import utils diff --git a/pyste/src/Pyste/SingleCodeUnit.py b/pyste/src/Pyste/SingleCodeUnit.py index 26dab92d..b02ba384 100644 --- a/pyste/src/Pyste/SingleCodeUnit.py +++ b/pyste/src/Pyste/SingleCodeUnit.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + from settings import namespaces import settings from utils import remove_duplicated_lines, left_equals @@ -23,7 +28,7 @@ class SingleCodeUnit: # define the avaiable sections self.code = {} # include section - self.code['include'] = '#include \n' + self.code['include'] = '' # declaration section (inside namespace) self.code['declaration'] = '' # declaration (outside namespace) @@ -66,10 +71,23 @@ class SingleCodeUnit: else: flag = 'a' fout = SmartFile(self.filename, flag) + fout.write('\n') # includes + # boost.python header + fout.write(left_equals('Boost Includes')) + fout.write('#include \n') + # include numerical boost for int64 definitions + fout.write('#include \n') + if settings.msvc: + # include precompiled header directive + fout.write('#ifdef _MSC_VER\n') + fout.write('#pragma hdrstop\n') + fout.write('#endif\n') + fout.write('\n') + # other includes if self.code['include']: + fout.write(left_equals('Includes')) includes = remove_duplicated_lines(self.code['include']) - fout.write('\n' + left_equals('Includes')) fout.write(includes) fout.write(space) # using diff --git a/pyste/src/Pyste/SmartFile.py b/pyste/src/Pyste/SmartFile.py index fc353e01..1f9388a8 100644 --- a/pyste/src/Pyste/SmartFile.py +++ b/pyste/src/Pyste/SmartFile.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + import os import md5 diff --git a/pyste/src/Pyste/VarExporter.py b/pyste/src/Pyste/VarExporter.py index 7fd830a3..91e3dd0e 100644 --- a/pyste/src/Pyste/VarExporter.py +++ b/pyste/src/Pyste/VarExporter.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + from Exporter import Exporter from settings import * import utils diff --git a/pyste/src/Pyste/__init__.py b/pyste/src/Pyste/__init__.py index e69de29b..c4025f34 100644 --- a/pyste/src/Pyste/__init__.py +++ b/pyste/src/Pyste/__init__.py @@ -0,0 +1,6 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + + diff --git a/pyste/src/Pyste/declarations.py b/pyste/src/Pyste/declarations.py index 453b2f1c..2d61e015 100644 --- a/pyste/src/Pyste/declarations.py +++ b/pyste/src/Pyste/declarations.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + ''' Defines classes that represent declarations found in C++ header files. diff --git a/pyste/src/Pyste/exporters.py b/pyste/src/Pyste/exporters.py index 56018fb5..8d62c8b1 100644 --- a/pyste/src/Pyste/exporters.py +++ b/pyste/src/Pyste/exporters.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + # a list of Exporter instances exporters = [] diff --git a/pyste/src/Pyste/exporterutils.py b/pyste/src/Pyste/exporterutils.py index 99aedd58..ce862383 100644 --- a/pyste/src/Pyste/exporterutils.py +++ b/pyste/src/Pyste/exporterutils.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + ''' Various helpers for interface files. ''' diff --git a/pyste/src/Pyste/infos.py b/pyste/src/Pyste/infos.py index 2985226d..661d79b7 100644 --- a/pyste/src/Pyste/infos.py +++ b/pyste/src/Pyste/infos.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + import os.path import copy import exporters diff --git a/pyste/src/Pyste/policies.py b/pyste/src/Pyste/policies.py index 43179b79..ff635072 100644 --- a/pyste/src/Pyste/policies.py +++ b/pyste/src/Pyste/policies.py @@ -1,10 +1,16 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) -class Policy: + +class Policy(object): 'Represents one of the call policies of boost.python.' def __init__(self): - raise RuntimeError, "Can't create an instance of the class Policy" + if type(self) is Policy: + raise RuntimeError, "Can't create an instance of the class Policy" def Code(self): @@ -74,6 +80,11 @@ class return_value_policy(Policy): c += self._next() return c +class return_self(Policy): + + def Code(self): + return 'return_self<>' + # values for return_value_policy reference_existing_object = 'reference_existing_object' diff --git a/pyste/src/Pyste/pyste.py b/pyste/src/Pyste/pyste.py index 572424fc..237ce1c9 100644 --- a/pyste/src/Pyste/pyste.py +++ b/pyste/src/Pyste/pyste.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + """ Pyste version %s @@ -23,6 +28,9 @@ where options are: --cache-dir=

Directory for cache files (speeds up future runs) --only-create-cache Recreates all caches (doesn't generate code). --generate-main Generates the _main.cpp file (in multiple mode) + --file-list A file with one pyste file per line. Use as a + substitute for passing the files in the command + line. -h, --help Print this help and exit -v, --version Print version information """ @@ -43,7 +51,7 @@ from CppParser import CppParser, CppParserError import time import declarations -__version__ = '0.9.26' +__version__ = '0.9.27' def RecursiveIncludes(include): 'Return a list containg the include dir and all its subdirectories' @@ -72,6 +80,19 @@ def ProcessIncludes(includes): index += 1 +def ReadFileList(filename): + f = file(filename) + files = [] + try: + for line in f: + line = line.strip() + if line: + files.append(line) + finally: + f.close() + return files + + def ParseArguments(): def Usage(): @@ -83,7 +104,7 @@ def ParseArguments(): sys.argv[1:], 'R:I:D:vh', ['module=', 'multiple', 'out=', 'no-using', 'pyste-ns=', 'debug', 'cache-dir=', - 'only-create-cache', 'version', 'generate-main', 'help']) + 'only-create-cache', 'version', 'generate-main', 'file-list=', 'help']) except getopt.GetoptError, e: print print 'ERROR:', e @@ -122,6 +143,8 @@ def ParseArguments(): cache_dir = value elif opt == '--only-create-cache': create_cache = True + elif opt == '--file-list': + files += ReadFileList(value) elif opt in ['-h', '--help']: Usage() elif opt in ['-v', '--version']: @@ -193,6 +216,7 @@ def CreateContext(): context['return_opaque_pointer'] = return_opaque_pointer context['manage_new_object'] = manage_new_object context['return_by_value'] = return_by_value + context['return_self'] = return_self # utils context['Wrapper'] = exporterutils.FunctionWrapper context['declaration_code'] = lambda code: infos.CodeInfo(code, 'declaration-outside') diff --git a/pyste/src/Pyste/settings.py b/pyste/src/Pyste/settings.py index 62fa3e20..145ad046 100644 --- a/pyste/src/Pyste/settings.py +++ b/pyste/src/Pyste/settings.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + #============================================================================== # Global information @@ -11,3 +16,6 @@ class namespaces: pyste = '' python = '' # default is to not use boost::python namespace explicitly, so # use the "using namespace" statement instead + +import sys +msvc = sys.platform == 'win32' diff --git a/pyste/src/Pyste/utils.py b/pyste/src/Pyste/utils.py index 82cf941a..766bcb9a 100644 --- a/pyste/src/Pyste/utils.py +++ b/pyste/src/Pyste/utils.py @@ -1,3 +1,8 @@ +# Copyright Bruno da Silva de Oliveira 2003. Use, modification and +# distribution is subject to the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http:#www.boost.org/LICENSE_1_0.txt) + from __future__ import generators import string import sys