Changes between Version 3 and Version 4 of pjsua2/SWIG_Quirks

Timestamp:

Jul 23, 2012 7:27:18 AM (12 years ago)

Author:

bennylp

Comment:

--

pjsua2/SWIG_Quirks

@@ -15 +15 @@
 [[BR]]
 
-== SWIG Quirks ==
-
+= SWIG Quirks =
+
+== Common ==
 === Quirks with the use of namespace ===
 
@@ -42 +43 @@
 }}}
 
+=== No pass by reference === #byref
+Continue reading below.
+=== "const" in parameter matters ===
+
+Otherwise conversion from Python list to std::vector doesn't work. E.g.:
+
+ {{{
+// example.h
+class A
+{
+  public:
+        void func_a( const vector<int> & param );
+        void func_b( vector<int> & param );
+};
+ }}}
+
+ {{{
+a.func_a( [0, 1, 2] )        # <-- OK
+a.func_b( [0, 1, 2] )        # <-- ERROR
+ }}}
+
+
+
+=== Must use exception specification in C++ functions ===
+
+Otherwise SWIG will terminate the app when it catches unspecified exception. E.g.:
+
+ {{{
+// example.h
+void raise_1() throw(Error)
+{
+   throw Error();
+}
+
+void raise_2()
+{
+   throw Error()
+}
+ }}}
+
+ {{{
+ # Python
+ try:
+    raise_1()
+ except Error, e:
+    pass               # <-- OK
+
+ try:
+    raise_2()          # <-- ERROR (SWIG terminates app), even with catch-anything
+ except:
+    pass
+ }}}
+
+=== Undeclared types will be (silently) converted to pointer ===
+
+Yes we know that, but it will catch you anyway, so I'll mention it again here.
+
+ {{{
+// example.h
+#include <pj/types.h>
+
+class Error
+{
+public:
+    pj_status_t   status;
+    string        reason;
+
+    Error(pj_status_t err, const string &res) : status(err), reason(res) {}
+};
+ }}}
+
+  {{{
+// example.i
+%module example
+%{
+#include “example.h”
+%}
+%include “example.h”
+  }}}
+
+ {{{
+# test.py
+err = pj.Error(-1, "Unknown error")
+print "%d" % err.status
+ }}}
+
+The code above compiles fine, but pj_status_t will be treated as pointer to unknown structure by SWIG, because the declaration is in <pj/types.h> which is not included in example.i. Hence the Python code above will not print -1 but the pointer value of status.
+
+
+
+== Python ==
 === std::vector as attributes doesn't work as expected ===
 
@@ -103 +195 @@
    }}}
 
-=== No pass by reference === #byref
-Continue reading below.
-=== "const" in parameter matters ===
-
-Otherwise conversion from Python list to std::vector doesn't work. E.g.:
-
- {{{
-// example.h
-class A
-{
-  public:
-        void func_a( const vector<int> & param );
-        void func_b( vector<int> & param );
-};
- }}}
-
- {{{
-a.func_a( [0, 1, 2] )        # <-- OK
-a.func_b( [0, 1, 2] )        # <-- ERROR
- }}}
-
-
-
-=== Must use exception specification in C++ functions ===
-
-Otherwise SWIG will terminate the app when it catches unspecified exception. E.g.:
-
- {{{
-// example.h
-void raise_1() throw(Error)
-{
-   throw Error();
-}
-
-void raise_2()
-{
-   throw Error()
-}
- }}}
-
- {{{
- # Python
- try:
-    raise_1()
- except Error, e:
-    pass               # <-- OK
-
- try:
-    raise_2()          # <-- ERROR (SWIG terminates app), even with catch-anything
- except:
-    pass
- }}}
-
-=== Undeclared types will be (silently) converted to pointer ===
-
-Yes we know that, but it will catch you anyway, so I'll mention it again here.
-
- {{{
-// example.h
-#include <pj/types.h>
-
-class Error
-{
-public:
-    pj_status_t   status;
-    string        reason;
-
-    Error(pj_status_t err, const string &res) : status(err), reason(res) {}
-};
- }}}
-
-  {{{
-// example.i
-%module example
+== Java ==
+=== Java attributes: none of them! === #javaattr
+
+C++ attributes will be converted to get/set functions in Java! E.g.:
+
+ {{{
+// example.h
+class A
+{
+public:
+   int data;
+};
+ }}}
+
+The "data" member will be converted to "getData()" and "setData()" in Java.
+
+=== No mapping between std::vector to Java array ===
+
+Even after applying the patch in [http://sourceforge.net/tracker/?func=detail&aid=3393025&group_id=1645&atid=301645 this SWIG ticket], std::vector is still not mapped to Java array. So we're left with awkward syntax to pass an array:
+
+  {{{
+// ua.h
+void set_array(const std::vector<std::string> &arr) {}
+  }}}
+
+  {{{
+// ua.i
+%module ua
 %{
-#include “example.h”
+#include "../ua.h"
 %}
-%include “example.h”
-  }}}
-
- {{{
-# test.py
-err = pj.Error(-1, "Unknown error")
-print "%d" % err.status
- }}}
-
-The code above compiles fine, but pj_status_t will be treated as pointer to unknown structure by SWIG, because the declaration is in <pj/types.h> which is not included in example.i. Hence the Python code above will not print -1 but the pointer value of status.
-
-
-=== Java attributes: none of them! === #javaattr
-
-C++ attributes will be converted to get/set functions in Java! E.g.:
-
- {{{
-// example.h
-class A
-{
-public:
-   int data;
-};
- }}}
-
-The "data" member will be converted to "getData()" and "setData()" in Java.
-
+
+%include "std_string.i"
+%include "std_vector.i"
+
+namespace std
+{
+        %template(StringVector) std::vector<std::string>;
+}
+
+%include "ua.h"
+  }}}
+
+  {{{
+// UaTest.java
+public class UaTest {
+  static {
+    System.loadLibrary("ua3");
+  }
+
+  public static void main(String argv[]) {
+        String[] sarr = { "Hello", "world"};
+        StringVector sv = new StringVector(sarr);
+
+        ua.set_array(sarr);     // <=----- ERROR
+        lc.set_the_svalues(sv); // <=------ OK
+  }
+}
+  }}}
 
 {{{