summaryrefslogtreecommitdiffstats
path: root/java/jni/JNIMem.hpp
blob: b7f5323b6e318254bf9cc8219a2506604e8fa3e2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/*
 * Author: Petre Eftime <petre.p.eftime@intel.com>
 * Copyright (c) 2016 Intel Corporation.
 *
 * Author: Sven Gothel <sgothel@jausoft.com>
 * Copyright (c) 2020 Gothel Software e.K.
 * Copyright (c) 2020 ZAFENA AB
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef JNIMEM__HPP_
#define JNIMEM__HPP_

#include <jni.h>
#include <stdexcept>

#include "BasicTypes.hpp"

extern JavaVM* vm;


/* 
 * This class provides a lifetime-managed JNIEnv object, which attaches or
 * detaches the current thread from the JVM automatically
 */
class JNIEnvContainer {
private:    
    JNIEnv *env = nullptr;
    bool needsDetach = false;
    
public:
    /* Attaches this thread to the JVM if it is not already attached */
    JNIEnvContainer();
    /* Detaches this thread to the JVM if it is attached */
    ~JNIEnvContainer();

    /* Provides access to the local thread's JNIEnv object */
    JNIEnv *operator*();
    /* Provides access to the local thread's JNIEnv object's methods */
    JNIEnv *operator->();

    /* Attaches this thread to the JVM if it is not already attached */
    void attach();
    /* Detaches this thread to the JVM if it is attached */
    void detach();
};

/* Each thread has a local jni_env variable of JNIEnvContainer type */
extern thread_local JNIEnvContainer jni_env;

/*
 * This class provides a lifetime-managed GlobalRef variable, which is automatically
 * deleted when it goes out of scope.
 */
class JNIGlobalRef {
private:
    jobject object;

public:
    static inline void check(jobject object, const char* file, int line) {
        if( nullptr == object ) {
            throw direct_bt::RuntimeException("JNIGlobalRef::check: Null jobject", file, line);
        }
    }

    /* Creates a GlobalRef from an object passed to it */
    JNIGlobalRef(jobject object);

    JNIGlobalRef(const JNIGlobalRef &o);
    JNIGlobalRef(JNIGlobalRef &&o);

    JNIGlobalRef& operator=(const JNIGlobalRef &o);
    JNIGlobalRef& operator=(JNIGlobalRef &&o);

    /* Deletes the stored GlobalRef */
    ~JNIGlobalRef();

    /* Provides access to the stored GlobalRef as an jobject. */
    jobject operator*() { return object; }

    /* Provides access to the stored GlobalRef as an jobject. */
    jobject getObject() const { return object; }
    /* Provides access to the stored GlobalRef as a jclass. */
    jclass getClass() const { return (jclass)object; }

    bool operator==(const JNIGlobalRef& rhs) const;

    bool operator!=(const JNIGlobalRef& rhs) const
    { return !( *this == rhs ); }
};

#endif /* JNIMEM__HPP_ */