From: <le...@us...> - 2012-06-26 15:16:02
|
Revision: 13193 http://swig.svn.sourceforge.net/swig/?rev=13193&view=rev Author: leiflm Date: 2012-06-26 15:15:56 +0000 (Tue, 26 Jun 2012) Log Message: ----------- Document typemaps; Correct compile instructions Modified Paths: -------------- branches/gsoc2012-c/Doc/Manual/C.html Modified: branches/gsoc2012-c/Doc/Manual/C.html =================================================================== --- branches/gsoc2012-c/Doc/Manual/C.html 2012-06-25 18:22:17 UTC (rev 13192) +++ branches/gsoc2012-c/Doc/Manual/C.html 2012-06-26 15:15:56 UTC (rev 13193) @@ -145,7 +145,8 @@ <div class="code"><pre> $ swig -c example.i -$ gcc -c example_wrap.c +$ gcc -c example_wrap.c +$ gcc -c example_proxy.c $ gcc -shared example_wrap.o -o libexample.so </pre></div> @@ -155,8 +156,9 @@ <div class="code"><pre> $ swig -c++ -c example.i -$ g++ -c example_wrap.c -$ g++ -shared example_wrap.o -o libexample.so +$ g++ -c example_wrap.cxx +$ gcc -c example_proxy.c +$ g++ -shared example_proxy.o example_wrap.o -o libexample.so </pre></div> <p> @@ -171,7 +173,7 @@ </p> <div class="code"><pre> -$ gcc runme.c example_proxy.c -L. -lexample -o runme +$ gcc runme.c -L. -lexample -o runme </pre></div> <p> @@ -304,6 +306,34 @@ The main reason of having the C module in SWIG is to be able to access C++ from C. In this chapter we will take a look at the rules of wrapping elements of the C++ language. </p> +<p> +By default, SWIG attempts to build a natural C interface to your C/C++ code. +<table BORDER summary="Generated C representation of C++"> + <tr> + <th>C++ Type</th> + <th>SWIG C Translation</th> + </tr> + <tr> + <td>Class <tt>Example</tt></td> + <td>Empty structure <tt>Example</tt></td> + </tr> + <tr> + <td>Public, mutable member variable <tt><tt>Foo Example::foo</tt></td> + <td><tt> + Example_foo_get(Example *e);</br> + Example_foo_set(Example *e, Foo *f); + </tt></td> + </tr> + <tr> + <td>Public, immutable member variable <tt><tt>Foo Example::bar</tt></td> + <td><tt> + Example_foo_get(Example *e);</br> + </tt></td> + </tr> +</table> +This section briefly covers the essential aspects of this wrapping. +</p> + <H3><a name="C_classes"></a>36.4.1 Classes</H3> @@ -382,6 +412,95 @@ area: 7.068583 </pre></div> +<H2><a name="C_developer"></a>Backend Developer Documentation</H2> + +<H2><a name="C_typemaps"></a>Typemaps</H2> + +<table BORDER summary="C Backend Typemaps"> + <tr> + <th>Typemap</th> + <th>Used for</th> + </tr> + <tr> + <td><tt>proxy</tt></td> + <td>Input parameters of proxy function</td> + </tr> + <tr> + <td><tt>ctype</tt></td> + <td>Wrapper function declaration</td> + </tr> + <tr> + <td><tt>wrap_call</tt></td> + <td> + Casts functions' parameters of wrapper function calls</br> + </br> + <tt> + extern void _wrap_MyClass_delete(SwigObj *o);</br> + </br> + void MyClass_delete(MyClass *c) {</br> + _wrap_MyClass_delete((Swig_Obj *)c);</br> + } + </tt> + </td> + </tr> + <tr> + <td><tt>in</tt></td> + <td>Generated for input parameters of a function</td> + </tr> + <tr> + <td><tt>couttype</tt></td> + <td>Casts return values of wrapper functions</br> + </br> + <tt> + SwigObj* _wrap_MyClass_new(void) {</br> + void *obj = ...</br> + return (SwigObj*)obj;</br> + } + </tt> + </td> + </tr> + <tr> + <td><tt>proxy</tt></td> + <td>Adds typecasts to class objects of wrapper functions calls in proxy functions</br> + <tt> + void MyClass_delete(MyClass *myClass) {</br> + _wrap_MyClass_delete((SwigObj*)myClass);</br> + } + </tt> + </td> + </tr> + <tr> + <td><tt>couttype</tt></td> + <td>Adds typecasts to wrap function return values in proxy functions</br> + <tt> + MyClass_new(void) {</br> + return (MyClass *)_wrap_MyClass_new();</br> + } + </tt> + </td> + </tr> + <tr> + <td><tt>proxycouttype</tt></td> + <td>Adds typecasts to wrap function return values in proxy functions</br> + <tt> + MyClass_new(void) {</br> + return (MyClass *)_wrap_MyClass_new();</br> + } + </tt> + </td> + </tr> + <tr> + <td><tt>out</tt></td> + <td>Adds code to wrapper functions for the return value variables</td> + </tr> + <tr> + <td><tt>cppouttype</tt></td> + <td>special case where a special cppresult variable is added to a wrapper + function (TODO:the reason for its existence needs investigation). + </td> + </tr> +</table> + <H2><a name="C_exceptions"></a>36.5 Exception handling</H2> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <le...@us...> - 2012-06-26 16:37:40
|
Revision: 13194 http://swig.svn.sourceforge.net/swig/?rev=13194&view=rev Author: leiflm Date: 2012-06-26 16:37:34 +0000 (Tue, 26 Jun 2012) Log Message: ----------- Fix compile instructions. Modified Paths: -------------- branches/gsoc2012-c/Doc/Manual/C.html Modified: branches/gsoc2012-c/Doc/Manual/C.html =================================================================== --- branches/gsoc2012-c/Doc/Manual/C.html 2012-06-26 15:15:56 UTC (rev 13193) +++ branches/gsoc2012-c/Doc/Manual/C.html 2012-06-26 16:37:34 UTC (rev 13194) @@ -147,7 +147,7 @@ $ swig -c example.i $ gcc -c example_wrap.c $ gcc -c example_proxy.c -$ gcc -shared example_wrap.o -o libexample.so +$ gcc -shared example_wrap.o example_proxy.o -o libexample.so </pre></div> <p> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <le...@us...> - 2012-08-17 12:15:14
|
Revision: 13638 http://swig.svn.sourceforge.net/swig/?rev=13638&view=rev Author: leiflm Date: 2012-08-17 12:15:08 +0000 (Fri, 17 Aug 2012) Log Message: ----------- Correct some descriptions of the typemaps. Remove duplicates Modified Paths: -------------- branches/gsoc2012-c/Doc/Manual/C.html Modified: branches/gsoc2012-c/Doc/Manual/C.html =================================================================== --- branches/gsoc2012-c/Doc/Manual/C.html 2012-08-16 22:35:36 UTC (rev 13637) +++ branches/gsoc2012-c/Doc/Manual/C.html 2012-08-17 12:15:08 UTC (rev 13638) @@ -423,11 +423,11 @@ </tr> <tr> <td><tt>proxy</tt></td> - <td>Input parameters of proxy function</td> + <td>Parameter types of proxy functions</td> </tr> <tr> <td><tt>ctype</tt></td> - <td>Wrapper function declaration</td> + <td>Parameter types of wrapper functions</td> </tr> <tr> <td><tt>wrap_call</tt></td> @@ -445,58 +445,47 @@ </tr> <tr> <td><tt>in</tt></td> - <td>Generated for input parameters of a function</td> + <td>Mapping of wrapper functions' parameters to local C++ variables</br> + </br> + <tt> + SwigObj* _wrap_MyClass_do(SwigObj *carg1) {</br> + SomeCPPClass *arg1 = 0;</br> + if (carg1)</br> + arg1 = (SomeCPPClass*)carg1->obj</br> + else</br> + arg1 = 0;</br> + } + </tt></td> </tr> <tr> <td><tt>couttype</tt></td> - <td>Casts return values of wrapper functions</br> + <td>Return value type of wrapper functions</br> </br> <tt> SwigObj* _wrap_MyClass_new(void) {</br> - void *obj = ...</br> - return (SwigObj*)obj;</br> + SwigObj *result;</br> + return result;</br> } </tt> </td> </tr> <tr> - <td><tt>proxy</tt></td> - <td>Adds typecasts to class objects of wrapper functions calls in proxy functions</br> - <tt> - void MyClass_delete(MyClass *myClass) {</br> - _wrap_MyClass_delete((SwigObj*)myClass);</br> - } - </tt> - </td> - </tr> - <tr> - <td><tt>couttype</tt></td> - <td>Adds typecasts to wrap function return values in proxy functions</br> - <tt> - MyClass_new(void) {</br> - return (MyClass *)_wrap_MyClass_new();</br> - } - </tt> - </td> - </tr> - <tr> <td><tt>proxycouttype</tt></td> - <td>Adds typecasts to wrap function return values in proxy functions</br> + <td>Typecasts wrapper functions' return values in proxy functions</br> <tt> - MyClass_new(void) {</br> - return (MyClass *)_wrap_MyClass_new();</br> - } + MyClass *MyClass_new(void) {</br> + return (MyClass *)_wrap_MyClass_new();</br> + } </tt> </td> </tr> <tr> <td><tt>out</tt></td> - <td>Adds code to wrapper functions for the return value variables</td> + <td>Assigns wrapped function's return value to return variable, packaging it into SwigObj if necessary</td> </tr> <tr> <td><tt>cppouttype</tt></td> - <td>special case where a special cppresult variable is added to a wrapper - function (TODO:the reason for its existence needs investigation). + <td>Type of the result variable used for the return value if the wrapped function is a C++ function </td> </tr> </table> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <le...@us...> - 2012-08-17 17:21:57
|
Revision: 13639 http://swig.svn.sourceforge.net/swig/?rev=13639&view=rev Author: leiflm Date: 2012-08-17 17:21:51 +0000 (Fri, 17 Aug 2012) Log Message: ----------- Add beginning of 'which typemap is for what' for C backend documentation. Modified Paths: -------------- branches/gsoc2012-c/Doc/Manual/C.html Modified: branches/gsoc2012-c/Doc/Manual/C.html =================================================================== --- branches/gsoc2012-c/Doc/Manual/C.html 2012-08-17 12:15:08 UTC (rev 13638) +++ branches/gsoc2012-c/Doc/Manual/C.html 2012-08-17 17:21:51 UTC (rev 13639) @@ -490,6 +490,159 @@ </tr> </table> +<H3>C Typemaps, a Code Generation Walkthrough</H3> + +To get a better idea of which typemap is used for which generated code, have a look at the following 'walk through'.</br> +Let's assume we have the following C++ interface file, we'd like to generate code for: + +<H4>The Interface</H4> +<div class="code"><pre> +%module example + +%inline +%{ + class SomeClass{}; + template <typename T> class SomeTemplateClass{}; + SomeClass someFunction(SomeTemplateClass<int> &someParameter, int simpleInt); +%} + +%template (SomeIntTemplateClass) SomeTemplateClass<int>; +</pre></div> + + +What we would like to generate as a C interface of this function would be something like this: + +<div class="code"><pre> +//proxy header file +SomeClass *new_SomeClass(void); +void delete_SomeClass(SomeClass* carg); + +SomeIntTemplateClass * new_SomeIntTemplateClass(); +void delete_SomeIntTemplateClass(SomeIntTemplateClass * carg1); + +SomeClass *someFunction(SomeIntTemplateClass *someParameter, int simpleInt); +</pre></div> + +When we generate the bindings, we generate code for two translation units: +<ul> +<li>The proxy</li> +<li>The wrapper</li> +</ul> +We need 2 translation units to be able to have C types with the same names as the original C++ types. + +<H4>The Wrapper</H4> +Since the proxy embeds a call to the wrapper function, we'll examine the generation of the wrapper function first. + +<div class="code"><pre> +SWIGEXPORTC SwigObj * _wrap_someFunction(SwigObj * carg1, int carg2) { + SomeClass * cppresult; + SomeTemplateClass< int > *arg1 = 0 ; + int arg2 ; + SwigObj * result; + + { + if (carg1) + arg1 = (SomeTemplateClass< int > *) carg1->obj; + else + arg1 = (SomeTemplateClass< int > *) 0; + } + arg2 = (int) carg2; + { + const int &_result_ref = someFunction(*arg1,arg2);cppresult = (int*) &_result_ref; + } + { + result = (SwigObj*) SWIG_create_object(SWIG_STR(SomeClass)); + result->obj = (void*) &cppresult; + } + return result; +} +</pre></div> + +It might be helpful to think of the way function calls are generated as a composition of building blocks.</br> +A typical wrapper will be composited with these [optional] blocks: + +<ol> +<li>Prototype</li> +<li>C return value variable</li> +<li>Local variables equal to the called C++ function's parameters</li> +<li>[C++ return value variable]</li> +<li>Assignment (extraction) of wrapper parameters to local parameter copies</li> +<li>[Contract (e.g. constraints) checking]</li> +<li> C++ function call</li> +<li>[Exception handling]</li> +<li>[Assignment to C++ return value]</li> +<li>Assignment to C return value</li> +</ol> + +Let's go through it step by step and start with the wrapper prototype + +<div class="code"><pre> +couttype ctype ctype +--------- --------- --- +SwigObj * _wrap_someFunction(SwigObj * carg1, int carg2); +</pre></div> + +As first unit of the wrapper code, a variable to hold the return value of the function is emitted to the wrapper's body + +<div class="code"><pre> +couttype +--------- +SwigObj * result; +</pre></div> + +Now for each of the C++ function's arguments, a local variable with the very same type is emitted to the wrapper's body. + +<div class="code"><pre> +SomeTemplateClass< int > *arg1 = 0 ; +int arg2 ; +</pre></div> + +If it's a C++ function that is wrapped (in this case it is), another variable is emitted for the 'original' return value of the C++ function.</br> +At this point, we simply 'inject' behavior if it's a C++ function that is wrapped (in this cas it obviously is). + +<div class="code"><pre> +cppouttype +----------- +SomeClass * cppresult; +</pre></div> + +Next, the values of the input parameters are assigned to the local variables using the 'in' typemap. + +<div class="code"><pre> +{ + if (carg1) + arg1 = (SomeTemplateClass< int > *) carg1->obj; + else + arg1 = (SomeTemplateClass< int > *) 0; +} +arg2 = (int) carg2; +</pre></div> + +A reasonable question would be: "Why aren't the parameters assigned in the declaration of their local counterparts?"</br> +As seen above, for complex types pointers have to be verified before extracting and </br> +casting the actual data pointer from the provided SwigObj pointer.</br> +This could easily become messy if it was done in the same line with the local variable declaration.</br> +<p> +At this point we are ready to call the C++ function with our parameters.</br> +</p> +<div class="code"><pre> +{ + const int &_result_ref = someFunction(*arg1,arg2);cppresult = (int*) &_result_ref; +} +</pre></div> +Subsequently, the return value is assigned to the dedicated return value variable using the 'out' typemap +<div class="code"><pre> +{ + result = (SwigObj*) SWIG_create_object(SWIG_STR(SomeClass)); + result->obj = (void*) &cppresult; +} +</pre></div> + +Finally, the return value variable is returned. +<div class="code"><pre> +return result; +</pre></div> + <H2><a name="C_exceptions"></a>36.5 Exception handling</H2> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <le...@us...> - 2012-08-17 17:22:23
|
Revision: 13641 http://swig.svn.sourceforge.net/swig/?rev=13641&view=rev Author: leiflm Date: 2012-08-17 17:22:17 +0000 (Fri, 17 Aug 2012) Log Message: ----------- Use "targetlang" style for C code in docs. Modified Paths: -------------- branches/gsoc2012-c/Doc/Manual/C.html Modified: branches/gsoc2012-c/Doc/Manual/C.html =================================================================== --- branches/gsoc2012-c/Doc/Manual/C.html 2012-08-17 17:22:06 UTC (rev 13640) +++ branches/gsoc2012-c/Doc/Manual/C.html 2012-08-17 17:22:17 UTC (rev 13641) @@ -512,7 +512,7 @@ What we would like to generate as a C interface of this function would be something like this: -<div class="code"><pre> +<div class="targetlang"><pre> //proxy header file SomeClass *new_SomeClass(void); void delete_SomeClass(SomeClass* carg); @@ -533,7 +533,7 @@ <H4>The Wrapper</H4> Since the proxy embeds a call to the wrapper function, we'll examine the generation of the wrapper function first. -<div class="code"><pre> +<div class="targetlang"><pre> SWIGEXPORTC SwigObj * _wrap_someFunction(SwigObj * carg1, int carg2) { SomeClass * cppresult; SomeTemplateClass< int > *arg1 = 0 ; @@ -576,7 +576,7 @@ Let's go through it step by step and start with the wrapper prototype -<div class="code"><pre> +<div class="targetlang"><pre> couttype ctype ctype --------- --------- --- SwigObj * _wrap_someFunction(SwigObj * carg1, int carg2); @@ -584,7 +584,7 @@ As first unit of the wrapper code, a variable to hold the return value of the function is emitted to the wrapper's body -<div class="code"><pre> +<div class="targetlang"><pre> couttype --------- SwigObj * result; @@ -592,7 +592,7 @@ Now for each of the C++ function's arguments, a local variable with the very same type is emitted to the wrapper's body. -<div class="code"><pre> +<div class="targetlang"><pre> SomeTemplateClass< int > *arg1 = 0 ; int arg2 ; </pre></div> @@ -600,7 +600,7 @@ If it's a C++ function that is wrapped (in this case it is), another variable is emitted for the 'original' return value of the C++ function.</br> At this point, we simply 'inject' behavior if it's a C++ function that is wrapped (in this cas it obviously is). -<div class="code"><pre> +<div class="targetlang"><pre> cppouttype ----------- SomeClass * cppresult; @@ -608,7 +608,7 @@ Next, the values of the input parameters are assigned to the local variables using the 'in' typemap. -<div class="code"><pre> +<div class="targetlang"><pre> { if (carg1) arg1 = (SomeTemplateClass< int > *) carg1->obj; @@ -625,13 +625,13 @@ <p> At this point we are ready to call the C++ function with our parameters.</br> </p> -<div class="code"><pre> +<div class="targetlang"><pre> { const int &_result_ref = someFunction(*arg1,arg2);cppresult = (int*) &_result_ref; } </pre></div> Subsequently, the return value is assigned to the dedicated return value variable using the 'out' typemap -<div class="code"><pre> +<div class="targetlang"><pre> { result = (SwigObj*) SWIG_create_object(SWIG_STR(SomeClass)); result->obj = (void*) &cppresult; @@ -639,7 +639,7 @@ </pre></div> Finally, the return value variable is returned. -<div class="code"><pre> +<div class="targetlang"><pre> return result; </pre></div> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <le...@us...> - 2012-08-17 17:22:34
|
Revision: 13642 http://swig.svn.sourceforge.net/swig/?rev=13642&view=rev Author: leiflm Date: 2012-08-17 17:22:28 +0000 (Fri, 17 Aug 2012) Log Message: ----------- Add docs about typemaps used by the C backend for proxy code generation. Modified Paths: -------------- branches/gsoc2012-c/Doc/Manual/C.html Modified: branches/gsoc2012-c/Doc/Manual/C.html =================================================================== --- branches/gsoc2012-c/Doc/Manual/C.html 2012-08-17 17:22:17 UTC (rev 13641) +++ branches/gsoc2012-c/Doc/Manual/C.html 2012-08-17 17:22:28 UTC (rev 13642) @@ -643,6 +643,51 @@ return result; </pre></div> +<H4>The Proxy</H4> +Compared to the wrapper code generation, the proxy code is very simple.</br> +Basically it just casts types for the wrapper call. Let's have a look at the corresponding proxy header file code of the interface above. + +<div class="targetlang"><pre> +//proxy header file +typedef struct SwigObj_SomeClass SomeClass; + +SomeClass * new_SomeClass(); + +void delete_SomeClass(SomeClass * carg1); + +SomeClass* someFunction(SomeIntTemplateClass* carg1, int carg2); + + +typedef struct SwigObj_SomeIntTemplateClass SomeIntTemplateClass; + +SomeIntTemplateClass * new_SomeIntTemplateClass(); + +void delete_SomeIntTemplateClass(SomeIntTemplateClass * carg1); +</pre></div> + +For shortness sake, we'll only examine one function that uses all proxy typemaps, as the other functions are analogous. + +<div class="targetlang"><pre> +SomeClass* someFunction(SomeIntTemplateClass* carg1, int carg2) { + return (SomeClass*)_wrap_someFunction((SwigObj *)carg1, (int)carg2); +} +</pre></div> + +Again, let's first examine the protype: +<div class="targetlang"><pre> +proxycouttype proxy proxy +---------- --------------------- --- +SomeClass* someFunction(SomeIntTemplateClass* carg1, int carg2); +</pre></div> + +In the body of this function, we'll reuse the 'proxycouttype' and 'ctype' to cast the return value and arguments of the wrapper function. + +<div class="targetlang"><pre> + proxycouttype ctype + ---------- --------- +return (SomeClass*)_wrap_someFunction((SwigObj *)carg1, (int)carg2); +</pre></div> + <H2><a name="C_exceptions"></a>36.5 Exception handling</H2> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <le...@us...> - 2012-08-17 17:22:44
|
Revision: 13643 http://swig.svn.sourceforge.net/swig/?rev=13643&view=rev Author: leiflm Date: 2012-08-17 17:22:38 +0000 (Fri, 17 Aug 2012) Log Message: ----------- Change style of C code to "targetlang" Modified Paths: -------------- branches/gsoc2012-c/Doc/Manual/C.html Modified: branches/gsoc2012-c/Doc/Manual/C.html =================================================================== --- branches/gsoc2012-c/Doc/Manual/C.html 2012-08-17 17:22:28 UTC (rev 13642) +++ branches/gsoc2012-c/Doc/Manual/C.html 2012-08-17 17:22:38 UTC (rev 13643) @@ -198,7 +198,7 @@ For example, for function declaration: </p> -<div class="code"><pre> +<div class="targetlang"><pre> int gcd(int x, int y); </pre></div> @@ -206,7 +206,7 @@ The output is simply: </p> -<div class="code"><pre> +<div class="targetlang"><pre> int _wrap_gcd(int arg1, int arg2) { int result; result = gcd(arg1,arg2); @@ -218,7 +218,7 @@ Then again, this wrapper function is usually called from C using helper function declared in proxy file, preserving the original name: </p> -<div class="code"><pre> +<div class="targetlang"><pre> int gcd(int arg1, int arg2) { return _wrap_gcd(arg1,arg2); } @@ -241,7 +241,7 @@ And now the generated result looks like: </p> -<div class="code"><pre> +<div class="targetlang"><pre> int _wrap_gcd(int arg1, int arg2) { { if (arg1 <= 0) @@ -272,7 +272,7 @@ You can still apply some of the SWIG features when handling structs, e.g. <tt>%extend</tt> directive. Suppose, you have a C struct declaration: </p> -<div class="code"><pre> +<div class="targetlang"><pre> typedef struct { int x; char *str; @@ -341,7 +341,7 @@ Consider the following example. We have a C++ class, and want to use it from C code. </p> -<div class="code"><pre> +<div class="targetlang"><pre> class Circle { public: double radius; @@ -367,7 +367,7 @@ The generated functions make calls to class' constructors and destructors, respectively. They also do all the necessary things required by the SWIG object management system in C. </p> -<div class="code"><pre> +<div class="targetlang"><pre> Circle * new_Circle(double r); void delete_Circle(Circle * self); </pre></div> @@ -376,7 +376,7 @@ The class <tt>Circle</tt> has a public variable called <tt>radius</tt>. SWIG generates a pair of setters and getters for each such variable: </p> -<div class="code"><pre> +<div class="targetlang"><pre> void Circle_radius_set(Circle * self, double radius); double Circle_radius_get(Circle * self); </pre></div> @@ -385,7 +385,7 @@ For each public method, an appropriate function is generated: </p> -<div class="code"><pre> +<div class="targetlang"><pre> double Circle_area(Circle * self); </pre></div> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <le...@us...> - 2012-08-17 17:22:55
|
Revision: 13644 http://swig.svn.sourceforge.net/swig/?rev=13644&view=rev Author: leiflm Date: 2012-08-17 17:22:48 +0000 (Fri, 17 Aug 2012) Log Message: ----------- Change style of command line snippets to "shell" Modified Paths: -------------- branches/gsoc2012-c/Doc/Manual/C.html Modified: branches/gsoc2012-c/Doc/Manual/C.html =================================================================== --- branches/gsoc2012-c/Doc/Manual/C.html 2012-08-17 17:22:38 UTC (rev 13643) +++ branches/gsoc2012-c/Doc/Manual/C.html 2012-08-17 17:22:48 UTC (rev 13644) @@ -84,7 +84,7 @@ <p> To build a C module (C as the target language), run SWIG using the <tt>-c</tt> option :</p> -<div class="code"><pre> +<div class="shell"><pre> %swig -c example.i </pre></div> @@ -92,7 +92,7 @@ The above assumes C as the input language. If the input language is C++ add the <tt>-c++</tt> option: </p> -<div class="code"><pre> +<div class="shell"><pre> $ swig -c++ -c example.i </pre></div> @@ -115,7 +115,7 @@ The following table list the additional commandline options available for the C module. They can also be seen by using: </p> -<div class="code"><pre> +<div class="shell"><pre> swig -c -help </pre></div> @@ -143,7 +143,7 @@ The next step is to build a dynamically loadable module, which we can link to our application. This can be done easily, for example using the <tt>gcc</tt> compiler (Linux, MinGW, etc.): </p> -<div class="code"><pre> +<div class="shell"><pre> $ swig -c example.i $ gcc -c example_wrap.c $ gcc -c example_proxy.c @@ -154,7 +154,7 @@ Or, for C++ input: </p> -<div class="code"><pre> +<div class="shell"><pre> $ swig -c++ -c example.i $ g++ -c example_wrap.cxx $ gcc -c example_proxy.c @@ -172,7 +172,7 @@ The simplest way to use the generated shared module is to link it to the application code during the compilation stage. We have to compile the proxy file as well. The process is usually similar to this: </p> -<div class="code"><pre> +<div class="shell"><pre> $ gcc runme.c -L. -lexample -o runme </pre></div> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <le...@us...> - 2012-08-17 17:23:05
|
Revision: 13645 http://swig.svn.sourceforge.net/swig/?rev=13645&view=rev Author: leiflm Date: 2012-08-17 17:22:59 +0000 (Fri, 17 Aug 2012) Log Message: ----------- Unify beginning of command line code Modified Paths: -------------- branches/gsoc2012-c/Doc/Manual/C.html Modified: branches/gsoc2012-c/Doc/Manual/C.html =================================================================== --- branches/gsoc2012-c/Doc/Manual/C.html 2012-08-17 17:22:48 UTC (rev 13644) +++ branches/gsoc2012-c/Doc/Manual/C.html 2012-08-17 17:22:59 UTC (rev 13645) @@ -85,7 +85,7 @@ To build a C module (C as the target language), run SWIG using the <tt>-c</tt> option :</p> <div class="shell"><pre> -%swig -c example.i +$ swig -c example.i </pre></div> <p> @@ -116,7 +116,7 @@ </p> <div class="shell"><pre> -swig -c -help +$ swig -c -help </pre></div> <table summary="C specific options"> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <le...@us...> - 2012-08-17 17:23:16
|
Revision: 13646 http://swig.svn.sourceforge.net/swig/?rev=13646&view=rev Author: leiflm Date: 2012-08-17 17:23:10 +0000 (Fri, 17 Aug 2012) Log Message: ----------- Use actual generated code for 'would like' prologue. Modified Paths: -------------- branches/gsoc2012-c/Doc/Manual/C.html Modified: branches/gsoc2012-c/Doc/Manual/C.html =================================================================== --- branches/gsoc2012-c/Doc/Manual/C.html 2012-08-17 17:22:59 UTC (rev 13645) +++ branches/gsoc2012-c/Doc/Manual/C.html 2012-08-17 17:23:10 UTC (rev 13646) @@ -514,13 +514,20 @@ <div class="targetlang"><pre> //proxy header file -SomeClass *new_SomeClass(void); -void delete_SomeClass(SomeClass* carg); +typedef struct SwigObj_SomeClass SomeClass; +SomeClass * new_SomeClass(); + +void delete_SomeClass(SomeClass * carg1); + +SomeClass* someFunction(SomeIntTemplateClass* carg1, int carg2); + + +typedef struct SwigObj_SomeIntTemplateClass SomeIntTemplateClass; + SomeIntTemplateClass * new_SomeIntTemplateClass(); + void delete_SomeIntTemplateClass(SomeIntTemplateClass * carg1); - -SomeClass *someFunction(SomeIntTemplateClass *someParameter, int simpleInt); </pre></div> When we generate the bindings, we generate code for two translation units: This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <le...@us...> - 2012-08-18 13:42:34
|
Revision: 13648 http://swig.svn.sourceforge.net/swig/?rev=13648&view=rev Author: leiflm Date: 2012-08-18 13:42:28 +0000 (Sat, 18 Aug 2012) Log Message: ----------- Remove docs about 'wrap_call' typemap. Modified Paths: -------------- branches/gsoc2012-c/Doc/Manual/C.html Modified: branches/gsoc2012-c/Doc/Manual/C.html =================================================================== --- branches/gsoc2012-c/Doc/Manual/C.html 2012-08-17 23:47:56 UTC (rev 13647) +++ branches/gsoc2012-c/Doc/Manual/C.html 2012-08-18 13:42:28 UTC (rev 13648) @@ -427,12 +427,8 @@ </tr> <tr> <td><tt>ctype</tt></td> - <td>Parameter types of wrapper functions</td> - </tr> - <tr> - <td><tt>wrap_call</tt></td> - <td> - Casts functions' parameters of wrapper function calls</br> + <td>Parameter types of wrapper functions and</br> + Casts of functions' parameters of wrapper function calls</br> </br> <tt> extern void _wrap_MyClass_delete(SwigObj *o);</br> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <le...@us...> - 2012-08-18 13:42:45
|
Revision: 13649 http://swig.svn.sourceforge.net/swig/?rev=13649&view=rev Author: leiflm Date: 2012-08-18 13:42:39 +0000 (Sat, 18 Aug 2012) Log Message: ----------- Minor formatting tweaks. Modified Paths: -------------- branches/gsoc2012-c/Doc/Manual/C.html Modified: branches/gsoc2012-c/Doc/Manual/C.html =================================================================== --- branches/gsoc2012-c/Doc/Manual/C.html 2012-08-18 13:42:28 UTC (rev 13648) +++ branches/gsoc2012-c/Doc/Manual/C.html 2012-08-18 13:42:39 UTC (rev 13649) @@ -430,49 +430,49 @@ <td>Parameter types of wrapper functions and</br> Casts of functions' parameters of wrapper function calls</br> </br> - <tt> + <code> extern void _wrap_MyClass_delete(SwigObj *o);</br> </br> void MyClass_delete(MyClass *c) {</br> - _wrap_MyClass_delete((Swig_Obj *)c);</br> + _wrap_MyClass_delete((Swig_Obj *)c);</br> } - </tt> + </code> </td> </tr> <tr> <td><tt>in</tt></td> <td>Mapping of wrapper functions' parameters to local C++ variables</br> </br> - <tt> + <code> SwigObj* _wrap_MyClass_do(SwigObj *carg1) {</br> - SomeCPPClass *arg1 = 0;</br> - if (carg1)</br> - arg1 = (SomeCPPClass*)carg1->obj</br> - else</br> - arg1 = 0;</br> + SomeCPPClass *arg1 = 0;</br> + if (carg1)</br> + arg1 = (SomeCPPClass*)carg1->obj</br> + else</br> + arg1 = 0;</br> } - </tt></td> + </code></td> </tr> <tr> <td><tt>couttype</tt></td> <td>Return value type of wrapper functions</br> </br> - <tt> + <code> SwigObj* _wrap_MyClass_new(void) {</br> - SwigObj *result;</br> - return result;</br> + SwigObj *result;</br> + return result;</br> } - </tt> + </code> </td> </tr> <tr> <td><tt>proxycouttype</tt></td> <td>Typecasts wrapper functions' return values in proxy functions</br> - <tt> + <code> MyClass *MyClass_new(void) {</br> - return (MyClass *)_wrap_MyClass_new();</br> + return (MyClass *)_wrap_MyClass_new();</br> } - </tt> + </code> </td> </tr> <tr> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <le...@us...> - 2012-08-20 18:55:40
|
Revision: 13708 http://swig.svn.sourceforge.net/swig/?rev=13708&view=rev Author: leiflm Date: 2012-08-20 18:55:34 +0000 (Mon, 20 Aug 2012) Log Message: ----------- Update docs to reflect typemap changes. Modified Paths: -------------- branches/gsoc2012-c/Doc/Manual/C.html Modified: branches/gsoc2012-c/Doc/Manual/C.html =================================================================== --- branches/gsoc2012-c/Doc/Manual/C.html 2012-08-20 18:42:28 UTC (rev 13707) +++ branches/gsoc2012-c/Doc/Manual/C.html 2012-08-20 18:55:34 UTC (rev 13708) @@ -422,13 +422,20 @@ <th>Used for</th> </tr> <tr> - <td><tt>proxy</tt></td> - <td>Parameter types of proxy functions</td> + <td><tt>ctype</tt></td> + <td>Provides types used for the C API and</br> + Typecasts wrapper functions return values in proxy functions</br> + <code> + MyClass *MyClass_new(void) {</br> + return (MyClass *)_wrap_MyClass_new();</br> + } + </code> + </td> </tr> <tr> - <td><tt>ctype</tt></td> - <td>Parameter types of wrapper functions and</br> - Casts of functions' parameters of wrapper function calls</br> + <td><tt>cmodtype</tt></td> + <td>Provides types used by wrapper functions and</br> + Casts of function parameters of wrapper function calls</br> </br> <code> extern void _wrap_MyClass_delete(SwigObj *o);</br> @@ -441,7 +448,7 @@ </tr> <tr> <td><tt>in</tt></td> - <td>Mapping of wrapper functions' parameters to local C++ variables</br> + <td>Mapping of wrapper functions parameters to local C++ variables</br> </br> <code> SwigObj* _wrap_MyClass_do(SwigObj *carg1) {</br> @@ -454,30 +461,8 @@ </code></td> </tr> <tr> - <td><tt>couttype</tt></td> - <td>Return value type of wrapper functions</br> - </br> - <code> - SwigObj* _wrap_MyClass_new(void) {</br> - SwigObj *result;</br> - return result;</br> - } - </code> - </td> - </tr> - <tr> - <td><tt>proxycouttype</tt></td> - <td>Typecasts wrapper functions' return values in proxy functions</br> - <code> - MyClass *MyClass_new(void) {</br> - return (MyClass *)_wrap_MyClass_new();</br> - } - </code> - </td> - </tr> - <tr> <td><tt>out</tt></td> - <td>Assigns wrapped function's return value to return variable, packaging it into SwigObj if necessary</td> + <td>Assigns wrapped function's return value to a dedicated return variable, packaging it into SwigObj if necessary</td> </tr> <tr> <td><tt>cppouttype</tt></td> @@ -551,7 +536,7 @@ } arg2 = (int) carg2; { - const int &_result_ref = someFunction(*arg1,arg2);cppresult = (int*) &_result_ref; + const SomeClass &_result_ref = someFunction(*arg1,arg2);cppresult = (SomeClass*) &_result_ref; } { result = (SwigObj*) SWIG_create_object(SWIG_STR(SomeClass)); @@ -580,7 +565,7 @@ Let's go through it step by step and start with the wrapper prototype <div class="targetlang"><pre> -couttype ctype ctype +cmodtype cmodtype cmodtype --------- --------- --- SwigObj * _wrap_someFunction(SwigObj * carg1, int carg2); </pre></div> @@ -588,7 +573,7 @@ As first unit of the wrapper code, a variable to hold the return value of the function is emitted to the wrapper's body <div class="targetlang"><pre> -couttype +cmodtype --------- SwigObj * result; </pre></div> @@ -630,7 +615,7 @@ </p> <div class="targetlang"><pre> { - const int &_result_ref = someFunction(*arg1,arg2);cppresult = (int*) &_result_ref; + const SomeClass &_result_ref = someFunction(*arg1,arg2);cppresult = (SomeClass*) &_result_ref; } </pre></div> Subsequently, the return value is assigned to the dedicated return value variable using the 'out' typemap @@ -678,7 +663,7 @@ Again, let's first examine the protype: <div class="targetlang"><pre> -proxycouttype proxy proxy +ctype ctype ctype ---------- --------------------- --- SomeClass* someFunction(SomeIntTemplateClass* carg1, int carg2); </pre></div> @@ -686,8 +671,8 @@ In the body of this function, we'll reuse the 'proxycouttype' and 'ctype' to cast the return value and arguments of the wrapper function. <div class="targetlang"><pre> - proxycouttype ctype - ---------- --------- + ctype cmodtype cmodtype + ---------- --------- ___ return (SomeClass*)_wrap_someFunction((SwigObj *)carg1, (int)carg2); </pre></div> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <le...@us...> - 2012-08-20 19:09:00
|
Revision: 13710 http://swig.svn.sourceforge.net/swig/?rev=13710&view=rev Author: leiflm Date: 2012-08-20 19:08:54 +0000 (Mon, 20 Aug 2012) Log Message: ----------- Add docs about known shortcomings of C++ wrapping. Modified Paths: -------------- branches/gsoc2012-c/Doc/Manual/C.html Modified: branches/gsoc2012-c/Doc/Manual/C.html =================================================================== --- branches/gsoc2012-c/Doc/Manual/C.html 2012-08-20 18:55:51 UTC (rev 13709) +++ branches/gsoc2012-c/Doc/Manual/C.html 2012-08-20 19:08:54 UTC (rev 13710) @@ -60,6 +60,13 @@ Flattening C++ language constructs into a set of C-style functions obviously comes with many limitations and inconveniences. All data and functions become global. Manipulating objects requires explicit calls to special functions. We are losing the high level abstraction and have to work around it. </p> +<H3>Known C++ Shortcomings in Generated C API:</H3> +<ul> + <li>Namespaced global functions are not namespaced</li> + <li>Enums with a context like class or namespace are broken</li> + <li>Global variables are not supported</li> + <li>Qualifiers are stripped</li> +</ul> <H2><a name="C_preliminaries"></a>36.2 Preliminaries</H2> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |