summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMarcelo Lira <marcelo.lira@openbossa.org>2009-12-08 12:59:40 -0300
committerMarcelo Lira <marcelo.lira@openbossa.org>2009-12-08 13:48:22 -0300
commitb27f6f347dc19db7706b69c0e7c22e74dea2853b (patch)
tree223206ee3b3009bd3103d7dc38a2bd28a44f5915 /doc
parentdd1680a72c7709439f0ea5b91d1ac6f7957c1179 (diff)
downloadshiboken-b27f6f347dc19db7706b69c0e7c22e74dea2853b.tar.gz
shiboken-b27f6f347dc19db7706b69c0e7c22e74dea2853b.tar.xz
shiboken-b27f6f347dc19db7706b69c0e7c22e74dea2853b.zip
Fixed inconsistency on type system variables and added a new one.
The %# group of type system variables are meant to be replaced by C++ arguments and %PYARG_# by Python arguments. For some reason %0 is replaced by the Python return variable and %PYARG_0 is considered invalid by the replacement system. Now %PYARG_0 is replaced by the Python return variable and %0 by the C++ version. The %CONVERTTOCPP type system variable was added. Fixed ShibokenGenerator::injectedCodeHasReturnValueAttribution to consider a return value attribution when the user does "%PYARG_0 = ..." instead of "%0 = ...". The changes were documented and all the test bindings inject codes were updated to use the modified variables properly. Reviewed by Hugo Lima <hugo.lima@openbossa.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/typesystemvariables.rst20
1 files changed, 18 insertions, 2 deletions
diff --git a/doc/typesystemvariables.rst b/doc/typesystemvariables.rst
index 9966cfc5..1a6a36f9 100644
--- a/doc/typesystemvariables.rst
+++ b/doc/typesystemvariables.rst
@@ -15,11 +15,11 @@ Variables
=========
-.. _return_argument:
+.. _cpp_return_argument:
**%0**
- Replaced by the name of the return variable of the Python method/function wrapper.
+ Replaced by the C++ return variable of the Python method/function wrapper.
.. _arg_number:
@@ -120,6 +120,14 @@ Variables
value ``123``.
+.. _converttocpp:
+
+**%CONVERTTOCPP[CPPTYPE]**
+
+ Replaced by a |project| conversion call that converts a Python variable
+ to a C++ variable of the type indicated by ``CPPTYPE``.
+
+
.. _converttopython:
**%CONVERTTOPYTHON[CPPTYPE]**
@@ -143,6 +151,14 @@ Variables
Replaced by the name of a function or method.
+
+.. _py_return_argument:
+
+**%PYARG_0**
+
+ Replaced by the name of the Python return variable of the Python method/function wrapper.
+
+
.. _pyarg:
**%PYARG_#**