3 /* Automatically load JNI library. */
4 %pragma(java) jniclasscode=%{
6 System.loadLibrary("sigrok_java_core_classes");
10 /* Documentation & importing interfaces. */
11 %pragma(java) jniclassimports=%{
13 * @mainpage API Reference
18 * The sigrok-java API provides an object-oriented Java interface to the
19 * functionality in libsigrok. It is built on top of the libsigrokcxx C++ API.
24 * Usage of the sigrok-java API needs to begin with a call to Context.create().
25 * This will create the global libsigrok context and returns a Context object.
26 * Methods on this object provide access to the hardware drivers, input and
27 * output formats supported by the library, as well as means of creating other
28 * objects such as sessions and triggers.
33 * When any libsigrok C API call returns an error, an Error exception is raised,
34 * which provides access to the error code and description.
37 import org.sigrok.core.interfaces.LogCallback;
38 import org.sigrok.core.interfaces.DatafeedCallback;
41 /* Map Glib::VariantBase to a Variant class in Java */
42 %rename(Variant) VariantBase;
47 %include "bindings/swig/templates.i"
49 /* Map between std::vector and java.util.Vector */
50 %define VECTOR(CValue, JValue)
52 %typemap(jni) std::vector< CValue > "jobject"
53 %typemap(jtype) std::vector< CValue > "java.util.Vector<JValue>"
54 %typemap(jstype) std::vector< CValue > "java.util.Vector<JValue>"
57 pre=" $javaclassname temp$javainput = new $javaclassname();
58 for (JValue value : $javainput)
59 temp$javainput.add(value);",
60 pgcppname="temp$javainput")
61 std::vector< CValue > "$javaclassname.getCPtr(temp$javainput)"
63 %typemap(javaout) std::vector< CValue > {
64 return (java.util.Vector<JValue>)$jnicall;
67 %typemap(out) std::vector< CValue > {
68 jclass Vector = jenv->FindClass("java/util/Vector");
69 jmethodID Vector_init = jenv->GetMethodID(Vector, "<init>", "()V");
70 jmethodID Vector_add = jenv->GetMethodID(Vector, "add",
71 "(Ljava/lang/Object;)Z");
72 jclass Value = jenv->FindClass("org/sigrok/core/classes/" #JValue);
73 jmethodID Value_init = jenv->GetMethodID(Value, "<init>", "(JZ)V");
74 $result = jenv->NewObject(Vector, Vector_init);
78 *(CValue **) &value = new CValue(entry);
79 jenv->CallObjectMethod($result, Vector_add,
80 jenv->NewObject(Value, Value_init, value, true));
86 VECTOR(std::shared_ptr<sigrok::Channel>, Channel)
87 VECTOR(std::shared_ptr<sigrok::HardwareDevice>, HardwareDevice)
89 /* Common macro for mapping between std::map and java.util.Map */
91 %define MAP_COMMON(CKey, CValue, JKey, JValue)
93 %typemap(jstype) std::map< CKey, CValue >
94 "java.util.Map<JKey, JValue>"
97 pre=" $javaclassname temp$javainput = new $javaclassname();
98 for (java.util.Map.Entry<JKey, JValue> entry : $javainput.entrySet())
99 temp$javainput.set(entry.getKey(), entry.getValue());",
100 pgcppname="temp$javainput")
101 std::map< CKey, CValue > "$javaclassname.getCPtr(temp$javainput)"
103 %typemap(javaout) std::map< CKey, CValue > {
104 return (java.util.Map<JKey, JValue>)$jnicall;
109 /* Specialisation for string->string maps. */
111 MAP_COMMON(std::string, std::string, String, String)
113 %typemap(jni) std::map<std::string, std::string>
115 %typemap(jtype) std::map<std::string, std::string>
116 "java.util.Map<String,String>"
118 %typemap(out) std::map<std::string, std::string> {
119 jclass HashMap = jenv->FindClass("java/util/HashMap");
120 jmethodID init = jenv->GetMethodID(HashMap, "<init>", "()V");
121 jmethodID put = jenv->GetMethodID(HashMap, "put",
122 "(Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;");
123 $result = jenv->NewObject(HashMap, init);
124 for (auto entry : $1)
125 jenv->CallObjectMethod($result, put,
126 jenv->NewStringUTF(entry.first.c_str()),
127 jenv->NewStringUTF(entry.second.c_str()));
130 /* Specialisation macro for string->shared_ptr maps. */
132 %define STRING_TO_SHARED_PTR_MAP(ClassName)
134 %typemap(jni) std::map<std::string, std::shared_ptr<sigrok::ClassName> >
136 %typemap(jtype) std::map<std::string, std::shared_ptr<sigrok::ClassName> >
137 "java.util.Map<String,ClassName>"
139 MAP_COMMON(std::string, std::shared_ptr<sigrok::ClassName>, String, ClassName)
141 %typemap(out) std::map<std::string, std::shared_ptr<sigrok::ClassName> > {
142 jclass HashMap = jenv->FindClass("java/util/HashMap");
143 jmethodID HashMap_init = jenv->GetMethodID(HashMap, "<init>", "()V");
144 jmethodID HashMap_put = jenv->GetMethodID(HashMap, "put",
145 "(Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;");
146 jclass Value = jenv->FindClass("org/sigrok/core/classes/" #ClassName);
147 jmethodID Value_init = jenv->GetMethodID(Value, "<init>", "(JZ)V");
148 $result = jenv->NewObject(HashMap, HashMap_init);
150 for (auto entry : $1)
152 *(std::shared_ptr< sigrok::ClassName > **)&value =
153 new std::shared_ptr< sigrok::ClassName>(entry.second);
154 jenv->CallObjectMethod($result, HashMap_put,
155 jenv->NewStringUTF(entry.first.c_str()),
156 jenv->NewObject(Value, Value_init, value, true));
162 STRING_TO_SHARED_PTR_MAP(Driver)
163 STRING_TO_SHARED_PTR_MAP(InputFormat)
164 STRING_TO_SHARED_PTR_MAP(OutputFormat)
166 /* Specialisation for ConfigKey->Variant maps */
168 MAP_COMMON(const sigrok::ConfigKey *, Glib::VariantBase, ConfigKey, Variant)
170 %typemap(jni) std::map<const sigrok::ConfigKey, Glib::VariantBase> "jobject"
171 %typemap(jtype) std::map<const sigrok::ConfigKey, Glib::VariantBase>
172 "java.util.Map<ConfigKey,Variant>"
174 %typemap(out) std::map<const sigrok::ConfigKey *, Glib::VariantBase> {
175 jclass HashMap = jenv->FindClass("java/util/HashMap");
176 jmethodID HashMap_init = jenv->GetMethodID(HashMap, "<init>", "()V");
177 jmethodID HashMap_put = jenv->GetMethodID(HashMap, "put",
178 "(Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;");
179 jclass ConfigKey = jenv->FindClass("org/sigrok/core/classes/ConfigKey");
180 jmethodID ConfigKey_init = jenv->GetMethodID(ConfigKey, "<init>", "(JZ)V");
181 jclass Variant = jenv->FindClass("org/sigrok/core/classes/Variant");
182 jmethodID Variant_init = jenv->GetMethodID(Variant, "<init>", "(JZ)V");
183 $result = jenv->NewObject(HashMap, HashMap_init);
186 for (auto entry : $1)
188 *(const sigrok::ConfigKey **) &key = entry.first;
189 *(Glib::VariantBase **) &value = new Glib::VariantBase(entry.second);
190 jenv->CallObjectMethod($result, HashMap_put,
191 jenv->NewObject(ConfigKey, ConfigKey_init, key, false));
192 jenv->NewObject(Variant, Variant_init, value, true));
196 /* Specialisation for ConfigKey->set<Capability> maps */
198 MAP_COMMON(const sigrok::ConfigKey *, std::set<enum sigrok::Capability>,
199 ConfigKey, java.util.Set<Capability>)
201 %typemap(jni) std::map<const sigrok::ConfigKey *, std::set<enum sigrok::Capability> > "jobject"
202 %typemap(jtype) std::map<const sigrok::ConfigKey *, std::set<enum sigrok::Capability> >
203 "java.util.Map<ConfigKey,java.util.Set<Capability>>"
205 %typemap(out) std::map<const sigrok::ConfigKey *, std::set<enum sigrok::Capability> > {
206 jclass HashMap = jenv->FindClass("java/util/HashMap");
207 jmethodID HashMap_init = jenv->GetMethodID(HashMap, "<init>", "()V");
208 jmethodID HashMap_put = jenv->GetMethodID(HashMap, "put",
209 "(Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;");
210 jclass HashSet = jenv->FindClass("java/util/HashSet");
211 jmethodID HashSet_init = jenv->GetMethodID(HashSet, "<init>", "()V");
212 jmethodID HashSet_add = jenv->GetMethodID(HashSet, "add",
213 "(Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;");
214 jclass ConfigKey = jenv->FindClass("org/sigrok/core/classes/ConfigKey");
215 jmethodID ConfigKey_init = jenv->GetMethodID(ConfigKey, "<init>", "(JZ)V");
216 jclass Capability = jenv->FindClass("org/sigrok/core/classes/Capability");
217 jmethodID Capability_swigToEnum = jenv->GetStaticMethodID(Capability,
218 "swigToEnum", "(I)Lorg/sigrok/core/classes/Capability;");
219 $result = jenv->NewObject(HashMap, HashMap_init);
221 for (auto map_entry : $1)
223 *(const sigrok::ConfigKey **) &key = map_entry.first;
224 jobject value = jenv->NewObject(HashSet, HashSet_init);
225 for (auto &set_entry : map_entry.second)
226 jenv->CallObjectMethod(value, HashSet_add,
227 jenv->CallStaticObjectMethod(Capability,
228 Capability_swigToEnum, set_entry));
229 jenv->CallObjectMethod($result, HashMap_put,
230 jenv->NewObject(ConfigKey, ConfigKey_init, key, false), value);
234 /* Pass JNIEnv parameter to C++ extension methods requiring it. */
236 %typemap(in, numinputs=0) JNIEnv * %{
240 /* Thread safe JNIEnv handling */
246 ScopedEnv(JavaVM *jvm);
248 JNIEnv* operator-> () { return env; }
249 operator bool () const { return (bool)env; }
255 ScopedEnv::ScopedEnv(JavaVM *jvm) : jvm(jvm), env(NULL) {
256 env_status = jvm->GetEnv((void **)&env, JNI_VERSION_1_2);
257 if (env_status == JNI_EDETACHED) {
258 %#if defined(__ANDROID__)
259 jvm->AttachCurrentThread(&env, NULL);
261 jvm->AttachCurrentThread((void **)&env, NULL);
265 ScopedEnv::~ScopedEnv() {
266 if (env_status == JNI_EDETACHED) {
267 jvm->DetachCurrentThread();
273 /* "Smartpointer" for Java references. */
280 GlobalRefBase (JavaVM *jvm, jobject ref);
285 GlobalRefBase::GlobalRefBase (JavaVM *jvm, jobject ref) : jvm(jvm), jref(0) {
288 jref = env->NewGlobalRef(ref);
290 GlobalRefBase::~GlobalRefBase () {
293 env->DeleteGlobalRef(jref);
295 template <class Jtype>
296 class GlobalRef : private GlobalRefBase
299 GlobalRef (JavaVM *jvm, Jtype ref) : GlobalRefBase(jvm, ref) {}
300 GlobalRef (const GlobalRef &ref) : GlobalRefBase(ref.jvm, ref.jref) {}
301 operator Jtype () const { return static_cast<Jtype>(jref); }
306 /* Support Java log callbacks. */
308 %typemap(javaimports) sigrok::Context
309 "import org.sigrok.core.interfaces.LogCallback;"
312 typedef jobject jlogcallback;
315 %typemap(jni) jlogcallback "jlogcallback"
316 %typemap(jtype) jlogcallback "LogCallback"
317 %typemap(jstype) jlogcallback "LogCallback"
318 %typemap(javain) jlogcallback "$javainput"
320 %extend sigrok::Context
322 void add_log_callback(JNIEnv *env, jlogcallback obj)
325 env->GetJavaVM(&jvm);
326 jclass obj_class = env->GetObjectClass(obj);
327 jmethodID method = env->GetMethodID(obj_class, "run",
328 "(Lorg/sigrok/core/classes/LogLevel;Ljava/lang/String;)V");
329 GlobalRef<jclass> LogLevel(jvm, env->FindClass("org/sigrok/core/classes/LogLevel"));
330 jmethodID LogLevel_init = env->GetMethodID(LogLevel, "<init>", "(JZ)V");
331 GlobalRef<jobject> obj_ref(jvm, obj);
333 $self->set_log_callback([=] (
334 const sigrok::LogLevel *loglevel,
339 throw sigrok::Error(SR_ERR);
340 jlong loglevel_addr = 0;
341 *(const sigrok::LogLevel **) &loglevel_addr = loglevel;
342 jobject loglevel_obj = env->NewObject(
343 LogLevel, LogLevel_init, loglevel_addr, false);
344 jobject message_obj = env->NewStringUTF(message.c_str());
345 env->CallVoidMethod(obj_ref, method, loglevel_obj, message_obj);
346 if (env->ExceptionCheck())
347 throw sigrok::Error(SR_ERR);
352 /* Support Java datafeed callbacks. */
354 %typemap(javaimports) sigrok::Session
355 "import org.sigrok.core.interfaces.DatafeedCallback;"
358 typedef jobject jdatafeedcallback;
361 %typemap(jni) jdatafeedcallback "jdatafeedcallback"
362 %typemap(jtype) jdatafeedcallback "DatafeedCallback"
363 %typemap(jstype) jdatafeedcallback "DatafeedCallback"
364 %typemap(javain) jdatafeedcallback "$javainput"
366 %extend sigrok::Session
368 void add_datafeed_callback(JNIEnv *env, jdatafeedcallback obj)
371 env->GetJavaVM(&jvm);
372 jclass obj_class = env->GetObjectClass(obj);
373 jmethodID method = env->GetMethodID(obj_class, "run",
374 "(Lorg/sigrok/core/classes/Device;Lorg/sigrok/core/classes/Packet;)V");
375 GlobalRef<jclass> Device(jvm, env->FindClass("org/sigrok/core/classes/Device"));
376 jmethodID Device_init = env->GetMethodID(Device, "<init>", "(JZ)V");
377 GlobalRef<jclass> Packet(jvm, env->FindClass("org/sigrok/core/classes/Packet"));
378 jmethodID Packet_init = env->GetMethodID(Packet, "<init>", "(JZ)V");
379 GlobalRef<jobject> obj_ref(jvm, obj);
381 $self->add_datafeed_callback([=] (
382 std::shared_ptr<sigrok::Device> device,
383 std::shared_ptr<sigrok::Packet> packet)
387 throw sigrok::Error(SR_ERR);
388 jlong device_addr = 0;
389 jlong packet_addr = 0;
390 *(std::shared_ptr<sigrok::Device> **) &device_addr =
391 new std::shared_ptr<sigrok::Device>(device);
392 *(std::shared_ptr<sigrok::Packet> **) &packet_addr =
393 new std::shared_ptr<sigrok::Packet>(packet);
394 jobject device_obj = env->NewObject(
395 Device, Device_init, device_addr, true);
396 jobject packet_obj = env->NewObject(
397 Packet, Packet_init, packet_addr, true);
398 env->CallVoidMethod(obj_ref, method, device_obj, packet_obj);
399 if (env->ExceptionCheck())
400 throw sigrok::Error(SR_ERR);
407 %define %enumextras(Class)
410 /* Ignore these for now, need fixes. */
411 %ignore sigrok::Context::create_analog_packet;
412 %ignore sigrok::Context::create_meta_packet;
413 %ignore sigrok::Meta::config;
415 %include "bindings/swig/classes.i"