Add Qt JNI API.
[qt:qtandroidextras.git] / src / androidextras / jni / qjniobject.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia.  For licensing terms and
14 ** conditions see http://qt.digia.com/licensing.  For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file.  Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights.  These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file.  Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef QJNIOBJECT_H
43 #define QJNIOBJECT_H
44
45 #include <jni.h>
46 #include <QtAndroidExtras/qandroidextrasglobal.h>
47 #include <QtCore/qglobal.h>
48 #include <QtCore/qsharedpointer.h>
49
50 QT_BEGIN_NAMESPACE
51
52 class QJNIObjectPrivate;
53
54 class Q_ANDROIDEXTRAS_EXPORT QJNIObject
55 {
56 public:
57     QJNIObject();
58     explicit QJNIObject(const char *className);
59     QJNIObject(const char *className, const char *sig, ...);
60     explicit QJNIObject(jclass clazz);
61     QJNIObject(jclass clazz, const char *sig, ...);
62     QJNIObject(jobject obj);
63     ~QJNIObject() { }
64
65     template <typename T>
66     inline T object() const { return static_cast<T>(javaObject()); }
67
68     template <typename T>
69     T callMethod(const char *methodName) const;
70     template <typename T>
71     T callMethod(const char *methodName, const char *sig, ...) const;
72     template <typename T>
73     QJNIObject callObjectMethod(const char *methodName) const;
74     QJNIObject callObjectMethod(const char *methodName,
75                                 const char *sig,
76                                 ...) const;
77
78     template <typename T>
79     static T callStaticMethod(const char *className, const char *methodName);
80     template <typename T>
81     static T callStaticMethod(const char *className, const char *methodName, const char *sig, ...);
82     template <typename T>
83     static QJNIObject callStaticObjectMethod(const char *className, const char *methodName);
84     static QJNIObject callStaticObjectMethod(const char *className,
85                                              const char *methodName,
86                                              const char *sig, ...);
87     template <typename T>
88     static T callStaticMethod(jclass clazz, const char *methodName);
89     template <typename T>
90     static T callStaticMethod(jclass clazz, const char *methodName, const char *sig, ...);
91     template <typename T>
92     static QJNIObject callStaticObjectMethod(jclass clazz, const char *methodName);
93     static QJNIObject callStaticObjectMethod(jclass clazz,
94                                              const char *methodName,
95                                              const char *sig, ...);
96     template <typename T>
97     T getField(const char *fieldName) const;
98     template <typename T>
99     QJNIObject getObjectField(const char *fieldName) const;
100     template <typename T>
101     QJNIObject getObjectField(const char *fieldName, const char *sig) const;
102     template <typename T>
103     void setField(const char *fieldName, T value);
104     template <typename T>
105     void setField(const char *fieldName, const char *sig, T value);
106     template <typename T>
107     static QJNIObject getStaticObjectField(const char *className, const char *fieldName);
108     template <typename T>
109     static QJNIObject getStaticObjectField(const char *className,
110                                            const char *fieldName,
111                                            const char *sig);
112     template <typename T>
113     static T getStaticField(const char *className, const char *fieldName);
114     template <typename T>
115     static QJNIObject getStaticObjectField(jclass clazz, const char *fieldName);
116     template <typename T>
117     static QJNIObject getStaticObjectField(jclass clazz,
118                                            const char *fieldName,
119                                            const char *sig);
120     template <typename T>
121     static T getStaticField(jclass clazz, const char *fieldName);
122
123     template <typename T>
124     static void setStaticField(const char *className,
125                                const char *fieldName,
126                                const char *sig,
127                                T value);
128     template <typename T>
129     static void setStaticField(const char *className, const char *fieldName, T value);
130     template <typename T>
131     static void setStaticField(jclass clazz, const char *fieldName, const char *sig, T value);
132     template <typename T>
133     static void setStaticField(jclass clazz, const char *fieldName, T value);
134
135     static QJNIObject fromString(const QString &string);
136     QString toString() const;
137
138     static bool isClassAvailable(const char *className);
139     bool isValid() const;
140
141     template <typename T>
142     inline QJNIObject &operator=(T o)
143     {
144         assign(static_cast<jobject>(o));
145         return *this;
146     }
147
148 private:
149     friend bool operator==(const QJNIObject &, const QJNIObject &);
150     friend bool operator!=(const QJNIObject &, const QJNIObject &);
151     template <typename T> friend bool operator!=(const QJNIObject &, T);
152     template <typename T> friend bool operator==(const QJNIObject &, T);
153     template <typename T> friend bool operator!=(T, const QJNIObject &);
154     template <typename T> friend bool operator==(T, const QJNIObject &);
155
156     QJNIObject(const QJNIObjectPrivate &o);
157
158     void assign(jobject o);
159     jobject javaObject() const;
160     bool isSameObject(jobject obj) const;
161     bool isSameObject(const QJNIObject &obj) const;
162
163     QSharedPointer<QJNIObjectPrivate> d;
164 };
165
166 inline bool operator==(const QJNIObject &obj1, const QJNIObject &obj2)
167 {
168     return obj1.isSameObject(obj2);
169 }
170
171 inline bool operator!=(const QJNIObject &obj1, const QJNIObject &obj2)
172 {
173     return !obj1.isSameObject(obj2);
174 }
175
176 template <typename T>
177 inline bool operator==(const QJNIObject &obj1, T obj2)
178 {
179     return obj1.isSameObject(static_cast<jobject>(obj2));
180 }
181
182 template <typename T>
183 inline bool operator==(T obj1, const QJNIObject &obj2)
184 {
185     return obj2.isSameObject(static_cast<jobject>(obj1));
186 }
187
188 template <typename T>
189 inline bool operator!=(const QJNIObject &obj1, T obj2)
190 {
191     return !obj1.isSameObject(static_cast<jobject>(obj2));
192 }
193
194 template <typename T>
195 inline bool operator!=(T obj1, const QJNIObject &obj2)
196 {
197     return !obj2.isSameObject(static_cast<jobject>(obj1));
198 }
199
200 QT_END_NAMESPACE
201
202 #endif // QJNIOBJECT_H