| <html> |
| <head> |
| <!-- Generated by the Spirit (http://spirit.sf.net) QuickDoc --> |
| <title>Renaming and Excluding</title> |
| <link rel="stylesheet" href="theme/style.css" type="text/css"> |
| <link rel="prev" href="the_interface_files.html"> |
| <link rel="next" href="policies.html"> |
| </head> |
| <body> |
| <table width="100%" height="48" border="0" cellspacing="2"> |
| <tr> |
| <td><img src="../../../../boost.png"> |
| </td> |
| <td width="85%"> |
| <font size="6" face="Verdana, Arial, Helvetica, sans-serif"><b>Renaming and Excluding</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="the_interface_files.html"><img src="theme/l_arr.gif" border="0"></a></td> |
| <td width="20"><a href="policies.html"><img src="theme/r_arr.gif" border="0"></a></td> |
| </tr> |
| </table> |
| <p> |
| You can easily rename functions, classes, member functions, attributes, etc. Just use the |
| function <tt>rename</tt>, like this:</p> |
| <code><pre> |
| <span class=identifier>World </span><span class=special>= </span><span class=identifier>Class</span><span class=special>(</span><span class=string>"World"</span><span class=special>, </span><span class=string>"hello.h"</span><span class=special>) |
| </span><span class=identifier>rename</span><span class=special>(</span><span class=identifier>World</span><span class=special>, </span><span class=string>"IWorld"</span><span class=special>) |
| </span><span class=identifier>show </span><span class=special>= </span><span class=identifier>Function</span><span class=special>(</span><span class=string>"choice"</span><span class=special>, </span><span class=string>"hello.h"</span><span class=special>) |
| </span><span class=identifier>rename</span><span class=special>(</span><span class=identifier>show</span><span class=special>, </span><span class=string>"Show"</span><span class=special>) |
| </span></pre></code> |
| <p> |
| You can rename member functions and attributes using this syntax:</p> |
| <code><pre> |
| <span class=identifier>rename</span><span class=special>(</span><span class=identifier>World</span><span class=special>.</span><span class=identifier>greet</span><span class=special>, </span><span class=string>"Greet"</span><span class=special>) |
| </span><span class=identifier>rename</span><span class=special>(</span><span class=identifier>World</span><span class=special>.</span><span class=identifier>set</span><span class=special>, </span><span class=string>"Set"</span><span class=special>) |
| </span><span class=identifier>choice </span><span class=special>= </span><span class=identifier>Enum</span><span class=special>(</span><span class=string>"choice"</span><span class=special>, </span><span class=string>"hello.h"</span><span class=special>) |
| </span><span class=identifier>rename</span><span class=special>(</span><span class=identifier>choice</span><span class=special>.</span><span class=identifier>red</span><span class=special>, </span><span class=string>"Red"</span><span class=special>) |
| </span><span class=identifier>rename</span><span class=special>(</span><span class=identifier>choice</span><span class=special>.</span><span class=identifier>blue</span><span class=special>, </span><span class=string>"Blue"</span><span class=special>) |
| </span></pre></code> |
| <p> |
| You can exclude functions, classes, member functions, attributes, etc, in the same way, |
| with the function <tt>exclude</tt>:</p> |
| <code><pre> |
| <span class=identifier>exclude</span><span class=special>(</span><span class=identifier>World</span><span class=special>.</span><span class=identifier>greet</span><span class=special>) |
| </span><span class=identifier>exclude</span><span class=special>(</span><span class=identifier>World</span><span class=special>.</span><span class=identifier>msg</span><span class=special>) |
| </span></pre></code> |
| <p> |
| To access the operators of a class, access the member <tt>operator</tt> like this |
| (supposing that <tt>C</tt> is a class being exported):</p> |
| <code><pre> |
| <span class=identifier>exclude</span><span class=special>(</span><span class=identifier>C</span><span class=special>.</span><span class=keyword>operator</span><span class=special>[</span><span class=literal>'+'</span><span class=special>]) |
| </span><span class=identifier>exclude</span><span class=special>(</span><span class=identifier>C</span><span class=special>.</span><span class=keyword>operator</span><span class=special>[</span><span class=literal>'*'</span><span class=special>]) |
| </span><span class=identifier>exclude</span><span class=special>(</span><span class=identifier>C</span><span class=special>.</span><span class=keyword>operator</span><span class=special>[</span><span class=literal>'<<'</span><span class=special>]) |
| </span></pre></code> |
| <p> |
| The string inside the brackets is the same as the name of the operator in C++.<br></p> |
| <a name="virtual_member_functions"></a><h2>Virtual Member Functions</h2><p> |
| 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 |
| <tt>final</tt>:</p> |
| <code><pre> |
| <span class=identifier>C </span><span class=special>= </span><span class=identifier>Class</span><span class=special>(</span><span class=literal>'C'</span><span class=special>, </span><span class=literal>'C.h'</span><span class=special>) |
| </span><span class=identifier>final</span><span class=special>(</span><span class=identifier>C</span><span class=special>.</span><span class=identifier>foo</span><span class=special>) </span>##<span class=identifier>C</span><span class=special>::</span><span class=identifier>foo </span><span class=identifier>is </span><span class=identifier>a </span><span class=keyword>virtual </span><span class=identifier>member </span><span class=identifier>function |
| </span></pre></code> |
| <p> |
| No virtual wrapper code will be generated for the virtual member function |
| C::foo that way.</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="the_interface_files.html"><img src="theme/l_arr.gif" border="0"></a></td> |
| <td width="20"><a href="policies.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">Distributed under |
| 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) </font> </p> |
| </body> |
| </html> |