summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorHugo Lima <hugo.lima@openbossa.org>2009-11-03 20:09:32 -0200
committerHugo Lima <hugo.lima@openbossa.org>2009-11-03 20:09:32 -0200
commit2d8b5d3467e34757bf462211e7bbd8e4e1453ac3 (patch)
treea0d12a16fb5acaf578f7cee542bd000e515c9a92 /doc
parentec2e6f46ced20a82d886725f146e54e96fedd2ce (diff)
downloadshiboken-2d8b5d3467e34757bf462211e7bbd8e4e1453ac3.tar.gz
shiboken-2d8b5d3467e34757bf462211e7bbd8e4e1453ac3.tar.xz
shiboken-2d8b5d3467e34757bf462211e7bbd8e4e1453ac3.zip
Added documentation for sequence protocol support in shiboken.
Diffstat (limited to 'doc')
-rw-r--r--doc/sequenceprotocol.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/sequenceprotocol.rst b/doc/sequenceprotocol.rst
new file mode 100644
index 00000000..2ac48588
--- /dev/null
+++ b/doc/sequenceprotocol.rst
@@ -0,0 +1,24 @@
+Sequence Protocol
+-----------------
+
+Support for the sequence protocol is achieved adding functions with special names, this is done using the add-function tag.
+
+The special function names are:
+
+ ============= =============================================== ==================== ===================
+ Function name Parameters Return type CPython equivalent
+ ============= =============================================== ==================== ===================
+ __len__ PyObject* self Py_ssize_t PySequence_Size
+ __getitem__ PyObject* self, Py_ssize_t _i PyObject* PySequence_GetItem
+ __setitem__ PyObject* self, Py_ssize_t _i, PyObject* _value int PySequence_SetItem
+ __contains__ PyObject* self, PyObject* _value int PySequence_Contains
+ __concat__ PyObject* self, PyObject* _other PyObject* PySequence_Concat
+ ============= =============================================== ==================== ===================
+
+You just need to inform the function name to the add-function tag, without any parameter or return type information, when you do it, |project| will create a C function with parameters and return type definied by the table above.
+
+The function needs to follow the same semantics of the *CPython equivalent* function, the only way to do it is using the inject-code tag.
+
+A concrete exemple how to add sequence protocol support to a class can be found on shiboken tests, more precisely in the definition of the Str class in ``tests/samplebinding/typesystem_sample.xml``.
+
+