mirror of
https://github.com/boostorg/python.git
synced 2026-01-22 05:22:45 +00:00
111 lines
5.2 KiB
HTML
111 lines
5.2 KiB
HTML
<html>
|
|
<head>
|
|
<!-- Generated by the Spirit (http://spirit.sf.net) QuickDoc -->
|
|
<title>Running Pyste</title>
|
|
<link rel="stylesheet" href="theme/style.css" type="text/css">
|
|
<link rel="prev" href="introduction.html">
|
|
<link rel="next" href="the_interface_files.html">
|
|
</head>
|
|
<body>
|
|
<table width="100%" height="48" border="0" cellspacing="2">
|
|
<tr>
|
|
<td><img src="theme/c%2B%2Bboost.gif">
|
|
</td>
|
|
<td width="85%">
|
|
<font size="6" face="Verdana, Arial, Helvetica, sans-serif"><b>Running Pyste</b></font>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
<table border="0">
|
|
<tr>
|
|
<td width="30"><a href="../index.html"><img src="theme/u_arr.gif" border="0"></a></td>
|
|
<td width="30"><a href="introduction.html"><img src="theme/l_arr.gif" border="0"></a></td>
|
|
<td width="20"><a href="the_interface_files.html"><img src="theme/r_arr.gif" border="0"></a></td>
|
|
</tr>
|
|
</table>
|
|
<p>
|
|
To run pyste, you will need:</p>
|
|
<ul><li>Python 2.2, avaiable at <a href="http://www.python.org">
|
|
python's website</a>.</li><li>The great <a href="http://effbot.org">
|
|
elementtree</a> library, from Fredrik Lundh.</li><li>The excellent <a href="http://www.gccxml.org">
|
|
GCCXML</a>, from Brad King.</li></ul><p>
|
|
Installation for the tools is avaiable in their respective webpages.</p>
|
|
<table width="80%" border="0" align="center">
|
|
<tr>
|
|
<td class="note_box">
|
|
|
|
<img src="theme/note.gif"></img> <a href="http://www.gccxml.org">
|
|
GCCXML</a> must be accessible in the PATH environment variable, so
|
|
that pyste can call it. How to do this varies from platform to platform.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="ok__now_what_"></a><h2>Ok, now what?</h2><p>
|
|
Well, now let's fire it up:</p>
|
|
<code><pre>
|
|
|
|
>python pyste.py
|
|
|
|
Usage:
|
|
pyste [options] --module=<name> interface-files
|
|
|
|
where options are:
|
|
-I <path> add an include path
|
|
-D <symbol> define symbol
|
|
--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 "pyste"
|
|
|
|
</pre></code><p>
|
|
Options explained:</p>
|
|
<p>
|
|
The <tt>-I</tt> and <tt>-D</tt> 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.</p>
|
|
<p>
|
|
<tt>--no-using</tt> tells pyste to don't declare "<tt>using namespace boost;</tt>" in the
|
|
generated cpp, using the namespace boost::python explicitly in all declarations.
|
|
Use only if you're having a name conflict in one of the files.</p>
|
|
<p>
|
|
Use <tt>--pyste-ns</tt> to change the namespace where new types are declared (for
|
|
instance, the virtual wrappers). Use only if one of your header files declare a
|
|
namespace named "pyste" and this is causing conflicts.</p>
|
|
<p>
|
|
So, the usage is simple enough:</p>
|
|
<code><pre>>python pyste.py --module=mymodule file.pyste file2.pyste ...</pre></code><p>
|
|
will generate a file <tt>mymodule.cpp</tt> in the same dir where the command was
|
|
executed. Now you can compile the file using the same instructions of the
|
|
<a href="../../doc/tutorial/doc/building_hello_world.html">
|
|
tutorial</a>. </p>
|
|
<a name="wait____how_do_i_set_those_i_and_d_flags_"></a><h2>Wait... how do I set those I and D flags?</h2><p>
|
|
Don't worry: normally <a href="http://www.gccxml.org">
|
|
GCCXML</a> is already configured correctly for your plataform,
|
|
so the search path to the standard libraries and the standard defines should
|
|
already be set. You only have to set the paths to other libraries that your code
|
|
needs, like Boost, for example.</p>
|
|
<p>
|
|
Plus, Pyste automatically uses the contents of the environment variable
|
|
<tt>INCLUDE</tt> if it exists. Visual C++ users should run the <tt>Vcvars32.bat</tt> file,
|
|
which for Visual C++ 6 is normally located at:</p>
|
|
<code><pre>
|
|
<span class=identifier>C</span><span class=special>:\</span><span class=identifier>Program </span><span class=identifier>Files</span><span class=special>\</span><span class=identifier>Microsoft </span><span class=identifier>Visual </span><span class=identifier>Studio</span><span class=special>\</span><span class=identifier>VC98</span><span class=special>\</span><span class=identifier>bin</span><span class=special>\</span><span class=identifier>Vcvars32</span><span class=special>.</span><span class=identifier>bat
|
|
</span></pre></code>
|
|
<p>
|
|
with that, you should have little trouble setting up the flags.</p>
|
|
<table border="0">
|
|
<tr>
|
|
<td width="30"><a href="../index.html"><img src="theme/u_arr.gif" border="0"></a></td>
|
|
<td width="30"><a href="introduction.html"><img src="theme/l_arr.gif" border="0"></a></td>
|
|
<td width="20"><a href="the_interface_files.html"><img src="theme/r_arr.gif" border="0"></a></td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
<hr size="1"><p class="copyright">Copyright © 2003 Bruno da Silva de Oliveira<br>Copyright © 2002-2003 Joel de Guzman<br><br>
|
|
<font size="2">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. </font> </p>
|
|
</body>
|
|
</html>
|