}
%}
-/* 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);
-}
+/* Documentation & importing interfaces. */
+%pragma(java) jniclassimports=%{
+/**
+ * @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 Glib::VariantBase to a Variant class in Java */
%rename(Variant) VariantBase;
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");
MAP_COMMON(const sigrok::ConfigKey *, Glib::VariantBase, ConfigKey, Variant)
+%typemap(jni) std::map<const sigrok::ConfigKey, Glib::VariantBase> "jobject"
+%typemap(jtype) std::map<const sigrok::ConfigKey, Glib::VariantBase>
+ "java.util.Map<ConfigKey,Variant>"
+
%typemap(out) std::map<const sigrok::ConfigKey *, Glib::VariantBase> {
jclass HashMap = jenv->FindClass("java/util/HashMap");
jmethodID HashMap_init = jenv->GetMethodID(HashMap, "<init>", "()V");
}
/* Support Driver.scan() with no arguments. */
+%ignore sigrok::Driver::scan;
+
%extend sigrok::Driver {
std::vector<std::shared_ptr<sigrok::HardwareDevice> > scan()
{
std::map<const sigrok::ConfigKey *, Glib::VariantBase> options;
return $self->scan(options);
}
+
+ std::vector<std::shared_ptr<sigrok::HardwareDevice> > scan(
+ std::map<const sigrok::ConfigKey *, Glib::VariantBase> options)
+ {
+ return $self->scan(options);
+ }
}
-/* Support OutputFormat.create_output(device) with no options. */
+/* Support InputFormat.create_input() with or without options. */
+%ignore sigrok::InputFormat::create_input;
+
+%extend sigrok::InputFormat {
+ std::shared_ptr<sigrok::Input> create_input()
+ {
+ return $self->create_input();
+ }
+
+ std::shared_ptr<sigrok::Input> create_input(
+ std::map<std::string, Glib::VariantBase> options)
+ {
+ return $self->create_input(options);
+ }
+}
+
+/* Support OutputFormat.create_output() with or without options. */
+%ignore sigrok::OutputFormat::create_output;
+
%extend sigrok::OutputFormat {
std::shared_ptr<sigrok::Output> create_output(
std::shared_ptr<sigrok::Device> device)
{
- std::map<std::string, std::string> options;
+ return $self->create_output(device);
+ }
+
+ std::shared_ptr<sigrok::Output> create_output(
+ std::shared_ptr<sigrok::Device> device,
+ std::map<std::string, Glib::VariantBase> options)
+ {
return $self->create_output(device, options);
}
+
+ std::shared_ptr<sigrok::Output> create_output(
+ std::string filename,
+ std::shared_ptr<sigrok::Device> device)
+ {
+ return $self->create_output(filename, device);
+ }
+
+ std::shared_ptr<sigrok::Output> create_output(
+ std::string filename,
+ std::shared_ptr<sigrok::Device> device,
+ std::map<std::string, Glib::VariantBase> options)
+ {
+ return $self->create_output(filename, device, options);
+ }
}
/* Pass JNIEnv parameter to C++ extension methods requiring it. */
/* Support Java log callbacks. */
+%typemap(javaimports) sigrok::Context
+ "import org.sigrok.core.interfaces.LogCallback;"
+
%inline {
typedef jobject jlogcallback;
}
/* Support Java datafeed callbacks. */
+%typemap(javaimports) sigrok::Session
+ "import org.sigrok.core.interfaces.DatafeedCallback;"
+
%inline {
typedef jobject jdatafeedcallback;
}
}
}
-/* Support Java event source callbacks. */
+%include "doc.i"
-%inline {
-typedef jobject jsourcecallback;
-}
+%define %attributevector(Class, Type, Name, Get)
+%attributeval(sigrok::Class, Type, Name, Get);
+%enddef
-%typemap(jni) jsourcecallback "jsourcecallback"
-%typemap(jtype) jsourcecallback "SourceCallback"
-%typemap(jstype) jsourcecallback "SourceCallback"
-%typemap(javain) jsourcecallback "$javainput"
+%define %attributemap(Class, Type, Name, Get)
+%attributeval(sigrok::Class, Type, Name, Get);
+%enddef
-%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);
+%define %enumextras(Class)
+%enddef
- 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;
- });
- }
-}
+/* Ignore this for now, needs a fix. */
+%ignore sigrok::Context::create_analog_packet;
%include "bindings/swig/classes.i"
+
projects / libsigrok.git / blobdiff