X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=bindings%2Fpython%2Fsigrok%2Fcore%2Fclasses.i;h=1da14d87cc45238701949549cc4181be562fc4d4;hb=9d229ecb9e301921284c6264ffc1d956572873df;hp=374996d56f86c15aa9c4079e95381dd411b45b5d;hpb=abc7146d032d41af41e8bd20ea64554021e86656;p=libsigrok.git
diff --git a/bindings/python/sigrok/core/classes.i b/bindings/python/sigrok/core/classes.i
index 374996d5..1da14d87 100644
--- a/bindings/python/sigrok/core/classes.i
+++ b/bindings/python/sigrok/core/classes.i
@@ -17,7 +17,32 @@
* along with this program. If not, see .
*/
-%module classes
+%define DOCSTRING
+"@mainpage API Reference
+
+Introduction
+------------
+
+The pysigrok API provides an object-oriented Python interface to the
+functionality in libsigrok. It is built on top of the sigrok++ C++ API.
+
+Getting started
+---------------
+
+Usage of the pysigrok API needs to begin with a call to Context.create().
+This will create the global libsigrok context and returns a Context object.
+Methods on this object provide access to the hardware drivers, input and output
+formats supported by the library, as well as means of creating other objects
+such as sessions and triggers.
+
+Error handling
+--------------
+
+When any libsigrok C API call returns an error, an Error exception is raised,
+which provides access to the error code and description."
+%enddef
+
+%module(docstring=DOCSTRING) classes
%{
#include
@@ -26,7 +51,7 @@ PyObject *GLib;
PyTypeObject *IOChannel;
PyTypeObject *PollFD;
-#include "../../../../config.h"
+#include "config.h"
#if PYGOBJECT_FLAGS_SIGNED
typedef gint pyg_flags_type;
@@ -236,7 +261,7 @@ typedef guint pyg_flags_type;
#include "libsigrok/libsigrok.hpp"
/* Convert from a Python dict to a std::map */
-std::map dict_to_map(PyObject *dict)
+std::map dict_to_map_string(PyObject *dict)
{
if (!PyDict_Check(dict))
throw sigrok::Error(SR_ERR_ARG);
@@ -262,14 +287,14 @@ std::map dict_to_map(PyObject *dict)
/* Convert from a Python type to Glib::Variant, according to config key data type. */
Glib::VariantBase python_to_variant_by_key(PyObject *input, const sigrok::ConfigKey *key)
{
- enum sr_datatype type = key->get_data_type()->get_id();
+ enum sr_datatype type = (enum sr_datatype) key->data_type()->id();
if (type == SR_T_UINT64 && PyInt_Check(input))
return Glib::Variant::create(PyInt_AsLong(input));
if (type == SR_T_UINT64 && PyLong_Check(input))
return Glib::Variant::create(PyLong_AsLong(input));
else if (type == SR_T_STRING && PyString_Check(input))
- return Glib::Variant::create(PyString_AsString(input));
+ return Glib::Variant::create(PyString_AsString(input));
else if (type == SR_T_BOOL && PyBool_Check(input))
return Glib::Variant::create(input == Py_True);
else if (type == SR_T_FLOAT && PyFloat_Check(input))
@@ -280,13 +305,60 @@ Glib::VariantBase python_to_variant_by_key(PyObject *input, const sigrok::Config
throw sigrok::Error(SR_ERR_ARG);
}
+/* Convert from a Python type to Glib::Variant, according to Option data type. */
+Glib::VariantBase python_to_variant_by_option(PyObject *input,
+ std::shared_ptr option)
+{
+ GVariantType *type = option->default_value().get_type().gobj();
+
+ if (type == G_VARIANT_TYPE_UINT64 && PyInt_Check(input))
+ return Glib::Variant::create(PyInt_AsLong(input));
+ if (type == G_VARIANT_TYPE_UINT64 && PyLong_Check(input))
+ return Glib::Variant::create(PyLong_AsLong(input));
+ else if (type == G_VARIANT_TYPE_STRING && PyString_Check(input))
+ return Glib::Variant::create(PyString_AsString(input));
+ else if (type == G_VARIANT_TYPE_BOOLEAN && PyBool_Check(input))
+ return Glib::Variant::create(input == Py_True);
+ else if (type == G_VARIANT_TYPE_DOUBLE && PyFloat_Check(input))
+ return Glib::Variant::create(PyFloat_AsDouble(input));
+ else if (type == G_VARIANT_TYPE_INT32 && PyInt_Check(input))
+ return Glib::Variant::create(PyInt_AsLong(input));
+ else
+ throw sigrok::Error(SR_ERR_ARG);
+}
+
+/* Convert from a Python dict to a std::map */
+std::map dict_to_map_options(PyObject *dict,
+ std::map > options)
+{
+ if (!PyDict_Check(dict))
+ throw sigrok::Error(SR_ERR_ARG);
+
+ std::map output;
+
+ PyObject *py_key, *py_value;
+ Py_ssize_t pos = 0;
+
+ while (PyDict_Next(dict, &pos, &py_key, &py_value)) {
+ if (!PyString_Check(py_key))
+ throw sigrok::Error(SR_ERR_ARG);
+ auto key = PyString_AsString(py_key);
+ auto value = python_to_variant_by_option(py_value, options[key]);
+ output[key] = value;
+ }
+
+ return output;
+}
+
%}
/* Ignore these methods, we will override them below. */
%ignore sigrok::Driver::scan;
-%ignore sigrok::InputFormat::open_file;
+%ignore sigrok::InputFormat::create_input;
%ignore sigrok::OutputFormat::create_output;
+%include "doc.i"
+
%include "../../../swig/classes.i"
/* Support Driver.scan() with keyword arguments. */
@@ -322,21 +394,22 @@ Glib::VariantBase python_to_variant_by_key(PyObject *input, const sigrok::Config
Driver.scan = _Driver_scan
}
-/* Support InputFormat.open_file() with keyword arguments. */
+/* Support InputFormat.create_input() with keyword arguments. */
%extend sigrok::InputFormat
{
- std::shared_ptr _open_file_kwargs(std::string filename, PyObject *dict)
+ std::shared_ptr _create_input_kwargs(PyObject *dict)
{
- return $self->open_file(filename, dict_to_map(dict));
+ return $self->create_input(
+ dict_to_map_options(dict, $self->options()));
}
}
%pythoncode
{
- def _InputFormat_open_file(self, filename, **kwargs):
- return self._open_file_kwargs(filename, kwargs)
+ def _InputFormat_create_input(self, **kwargs):
+ return self._create_input(kwargs)
- InputFormat.open_file = _InputFormat_open_file
+ InputFormat.create_input = _InputFormat_create_input
}
/* Support OutputFormat.create_output() with keyword arguments. */
@@ -345,7 +418,8 @@ Glib::VariantBase python_to_variant_by_key(PyObject *input, const sigrok::Config
std::shared_ptr _create_output_kwargs(
std::shared_ptr device, PyObject *dict)
{
- return $self->create_output(device, dict_to_map(dict));
+ return $self->create_output(device,
+ dict_to_map_options(dict, $self->options()));
}
}