}
%}
-/* Import interfaces. */
+/* Documentation & importing interfaces. */
%pragma(java) jniclassimports=%{
- import org.sigrok.core.interfaces.LogCallback;
- import org.sigrok.core.interfaces.DatafeedCallback;
- import org.sigrok.core.interfaces.SourceCallback;
+/**
+ * @mainpage API Reference
+ *
+ * Introduction
+ * ------------
+ *
+ * The sigrok-java API provides an object-oriented Java interface to the
+ * functionality in libsigrok. It is built on top of the libsigrokcxx C++ API.
+ *
+ * Getting started
+ * ---------------
+ *
+ * Usage of the sigrok-java 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.
+ */
+
+import org.sigrok.core.interfaces.LogCallback;
+import org.sigrok.core.interfaces.DatafeedCallback;
%}
-/* Map Java FileDescriptor objects to int fds */
-%typemap(jni) int fd "jobject"
-%typemap(jtype) int fd "java.io.FileDescriptor"
-%typemap(jstype) int fd "java.io.FileDescriptor"
-%typemap(javain) int fd "$javainput"
-
-%typemap(in) int fd {
- jclass FileDescriptor = jenv->FindClass("java/io/FileDescriptor");
- jfieldID fd = jenv->GetFieldID(FileDescriptor, "fd", "I");
- $1 = jenv->GetIntField($input, fd);
-}
-
/* Map Glib::VariantBase to a Variant class in Java */
%rename(Variant) VariantBase;
namespace Glib {
class VariantBase {};
}
+%include "bindings/swig/templates.i"
+
/* Map between std::vector and java.util.Vector */
%define VECTOR(CValue, JValue)
%typemap(jstype) std::vector< CValue > "java.util.Vector<JValue>"
%typemap(javain,
- pre=" $javaclassname temp$javainput = $javaclassname.convertVector($javainput);",
+ pre=" $javaclassname temp$javainput = new $javaclassname();
+ for (JValue value : $javainput)
+ temp$javainput.add(value);",
pgcppname="temp$javainput")
std::vector< CValue > "$javaclassname.getCPtr(temp$javainput)"
-%typemap(javacode) std::vector< CValue > %{
- static $javaclassname convertVector(java.util.Vector<JValue> in)
- {
- $javaclassname out = new $javaclassname();
- for (JValue value : in)
- out.add(value);
- return out;
- }
-%}
-
%typemap(javaout) std::vector< CValue > {
return (java.util.Vector<JValue>)$jnicall;
}
"java.util.Map<JKey, JValue>"
%typemap(javain,
- pre=" $javaclassname temp$javainput = $javaclassname.convertMap($javainput);",
+ pre=" $javaclassname temp$javainput = new $javaclassname();
+ for (java.util.Map.Entry<JKey, JValue> entry : $javainput.entrySet())
+ temp$javainput.set(entry.getKey(), entry.getValue());",
pgcppname="temp$javainput")
std::map< CKey, CValue > "$javaclassname.getCPtr(temp$javainput)"
-%typemap(javacode) std::map< CKey, CValue > %{
- static $javaclassname convertMap(java.util.Map<JKey,JValue> in)
- {
- $javaclassname out = new $javaclassname();
- for (java.util.Map.Entry<JKey, JValue> entry : in.entrySet())
- out.set(entry.getKey(), entry.getValue());
- return out;
- }
-%}
-
%typemap(javaout) std::map< CKey, CValue > {
return (java.util.Map<JKey, JValue>)$jnicall;
}
MAP_COMMON(std::string, std::string, String, String)
+%typemap(jni) std::map<std::string, std::string>
+ "jobject"
+%typemap(jtype) std::map<std::string, std::string>
+ "java.util.Map<String,String>"
+
%typemap(out) std::map<std::string, std::string> {
jclass HashMap = jenv->FindClass("java/util/HashMap");
jmethodID init = jenv->GetMethodID(HashMap, "<init>", "()V");
}
}
-/* Support Driver.scan() with no arguments. */
-%extend sigrok::Driver {
- std::vector<std::shared_ptr<sigrok::HardwareDevice> > scan()
- {
- std::map<const sigrok::ConfigKey *, Glib::VariantBase> options;
- return $self->scan(options);
- }
-}
+/* Specialisation for ConfigKey->set<Capability> maps */
+
+MAP_COMMON(const sigrok::ConfigKey *, std::set<enum sigrok::Capability>,
+ ConfigKey, java.util.Set<Capability>)
-/* Support OutputFormat.create_output(device) with no options. */
-%extend sigrok::OutputFormat {
- std::shared_ptr<sigrok::Output> create_output(
- std::shared_ptr<sigrok::Device> device)
+%typemap(jni) std::map<const sigrok::ConfigKey *, std::set<enum sigrok::Capability>> "jobject"
+%typemap(jtype) std::map<const sigrok::ConfigKey *, std::set<enum sigrok::Capability>>
+ "java.util.Map<ConfigKey,java.util.Set<Capability>>"
+
+%typemap(out) std::map<const sigrok::ConfigKey *, std::set<enum sigrok::Capability>> {
+ jclass HashMap = jenv->FindClass("java/util/HashMap");
+ jmethodID HashMap_init = jenv->GetMethodID(HashMap, "<init>", "()V");
+ jmethodID HashMap_put = jenv->GetMethodID(HashMap, "put",
+ "(Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;");
+ jclass HashSet = jenv->FindClass("java/util/HashSet");
+ jmethodID HashSet_init = jenv->GetMethodID(HashSet, "<init>", "()V");
+ jmethodID HashSet_add = jenv->GetMethodID(HashSet, "add",
+ "(Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;");
+ jclass ConfigKey = jenv->FindClass("org/sigrok/core/classes/ConfigKey");
+ jmethodID ConfigKey_init = jenv->GetMethodID(ConfigKey, "<init>", "(JZ)V");
+ jclass Capability = jenv->FindClass("org/sigrok/core/classes/Capability");
+ jmethodID Capability_swigToEnum = jenv->GetStaticMethodID(Capability,
+ "swigToEnum", "(I)Lorg/sigrok/core/classes/Capability;");
+ $result = jenv->NewObject(HashMap, HashMap_init);
+ jlong key;
+ for (auto map_entry : $1)
{
- std::map<std::string, Glib::VariantBase> options;
- return $self->create_output(device, options);
+ *(const sigrok::ConfigKey **) &key = map_entry.first;
+ jobject value = jenv->NewObject(HashSet, HashSet_init);
+ for (auto &set_entry : map_entry.second)
+ jenv->CallObjectMethod(value, HashSet_add,
+ jenv->CallStaticObjectMethod(Capability,
+ Capability_swigToEnum, set_entry));
+ jenv->CallObjectMethod($result, HashMap_put,
+ jenv->NewObject(ConfigKey, ConfigKey_init, key, false), value);
}
}
}
}
-/* Support Java event source callbacks. */
-
-%typemap(javaimports) sigrok::EventSource
- "import org.sigrok.core.interfaces.SourceCallback;"
-
-%inline {
-typedef jobject jsourcecallback;
-}
-
-%typemap(jni) jsourcecallback "jsourcecallback"
-%typemap(jtype) jsourcecallback "SourceCallback"
-%typemap(jstype) jsourcecallback "SourceCallback"
-%typemap(javain) jsourcecallback "$javainput"
+%include "doc.i"
-%extend sigrok::EventSource
-{
- std::shared_ptr<sigrok::EventSource> create(
- int fd, Glib::IOCondition events, int timeout,
- JNIEnv *env, jsourcecallback obj)
- {
- (void) $self;
- jclass obj_class = env->GetObjectClass(obj);
- jmethodID method = env->GetMethodID(obj_class, "run", "(I)V");
- jobject obj_ref = env->NewGlobalRef(obj);
-
- return sigrok::EventSource::create(fd, events, timeout, [=] (int revents)
- {
- bool result = env->CallBooleanMethod(obj_ref, method, revents);
- if (env->ExceptionCheck())
- throw sigrok::Error(SR_ERR);
- return result;
- });
- }
-}
+%define %enumextras(Class)
+%enddef
-/* Currently broken due to some std::map typemap issues. */
-%ignore sigrok::Meta::get_config;
+/* Ignore these for now, need fixes. */
+%ignore sigrok::Context::create_analog_packet;
+%ignore sigrok::Context::create_meta_packet;
+%ignore sigrok::Meta::config;
%include "bindings/swig/classes.i"
+