annotate Plugin/JavaEnvironment.h @ 9:88c1614fb3dc

added sample basic plugin
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 19 Oct 2023 11:55:38 +0200
parents c8f19e93ff99
children 1c407ba1d311
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * SPDX-FileCopyrightText: 2023 Sebastien Jodogne, UCLouvain, Belgium
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * SPDX-License-Identifier: GPL-3.0-or-later
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 */
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 /**
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * Java plugin for Orthanc
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * Copyright (C) 2023 Sebastien Jodogne, UCLouvain, Belgium
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 *
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * This program is free software: you can redistribute it and/or
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * modify it under the terms of the GNU General Public License as
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * published by the Free Software Foundation, either version 3 of the
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * License, or (at your option) any later version.
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 *
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * This program is distributed in the hope that it will be useful, but
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * General Public License for more details.
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 *
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * You should have received a copy of the GNU General Public License
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 **/
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #pragma once
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 #include "JavaVirtualMachine.h"
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 #include <orthanc/OrthancCPlugin.h>
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 #include <vector>
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 class JavaEnvironment : public NonCopyable
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 {
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 private:
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 JavaVM *jvm_;
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 JNIEnv *env_;
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 public:
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 JavaEnvironment(JNIEnv* env);
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 JavaEnvironment(JavaVirtualMachine& jvm);
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 ~JavaEnvironment();
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 JNIEnv& GetValue();
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 void CheckException();
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 void ThrowException(const std::string& fqn,
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 const std::string& message);
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 void ThrowOrthancException(const std::string& message);
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 void ThrowOrthancException(OrthancPluginErrorCode code);
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 static void ThrowOrthancException(JNIEnv* env,
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 const std::string& message);
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 static void ThrowOrthancException(JNIEnv* env,
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 OrthancPluginErrorCode code);
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 void RegisterNatives(const std::string& fqn,
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 const std::vector<JNINativeMethod>& methods);
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 void RunGarbageCollector();
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 jclass FindClass(const std::string& fqn);
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 jclass GetObjectClass(jobject obj);
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 jmethodID GetMethodID(jclass c,
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 const std::string& method,
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 const std::string& signature);
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 jobject ConstructJavaWrapper(const std::string& fqn,
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 void* nativeObject);
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 jbyteArray ConstructByteArray(const size_t size,
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 const void* data);
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 jbyteArray ConstructByteArray(const std::string& data)
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 {
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 return ConstructByteArray(data.size(), data.c_str());
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 }
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 jobject ConstructEnumValue(const std::string& fqn,
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 int value);
c8f19e93ff99 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 };