8#include <QtCore/qbytearray.h>
9#include <QtCore/qhash.h>
10#include <QtCore/qreadwritelock.h>
11#include <QtCore/qloggingcategory.h>
16Q_LOGGING_CATEGORY(lcJniThreadCheck,
"qt.core.jni.threadcheck")
18using namespace Qt::StringLiterals;
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
316
317
318
319
320
321
325
326
327
328
337 JNIEnv *env = QJniEnvironment::getJniEnv();
339 env->DeleteGlobalRef(m_jobject);
340 if (m_jclass && m_own_jclass)
341 env->DeleteGlobalRef(m_jclass);
344 template <
typename ...Args>
345 void construct(
const char *signature =
nullptr, Args &&...args)
348 JNIEnv *env = QJniEnvironment::getJniEnv();
350 jmethodID constructorId = QJniObject::getCachedMethodID(env, m_jclass, m_className,
"<init>",
351 signature ? signature :
"()V");
353 jobject obj =
nullptr;
354 if constexpr (
sizeof...(Args) == 0)
355 obj = env->NewObject(m_jclass, constructorId);
357 obj = env->NewObjectV(m_jclass, constructorId,
std::forward<Args>(args)...);
359 m_jobject = env->NewGlobalRef(obj);
360 env->DeleteLocalRef(obj);
380template <
typename ...Args>
383 return (QByteArrayView(
":") + ... + QByteArrayView(args));
390Q_GLOBAL_STATIC(JClassHash, cachedClasses)
391Q_GLOBAL_STATIC(QReadWriteLock, cachedClassesLock)
393static jclass getCachedClass(
const QByteArray &className)
395 QReadLocker locker(cachedClassesLock);
396 const auto &it = cachedClasses->constFind(className);
397 return it != cachedClasses->constEnd() ? it.value() :
nullptr;
401bool QJniObjectPrivate::isJString(JNIEnv *env)
const
404 if (m_is_jstring != IsJString::Unknown)
405 return m_is_jstring == IsJString::Yes;
407 static constexpr auto stringSignature = QtJniTypes::Traits<jstring>::className();
408 if (!m_className.isEmpty()) {
409 m_is_jstring = m_className == stringSignature
413 const jclass strClass = getCachedClass(stringSignature.data());
414 const bool isStringInstance = strClass
415 ? env->IsInstanceOf(m_jobject, strClass)
417 m_is_jstring = isStringInstance ? IsJString::Yes : IsJString::No;
420 return m_is_jstring == IsJString::Yes;
424
425
426
427
428
429
430static QJniObject getCleanJniObject(jobject object, JNIEnv *env)
432 if (!object || env->ExceptionCheck())
435 return QJniObject::fromLocalRef(object);
440jclass loadClassHelper(
const QByteArray &className, JNIEnv *env)
443 QByteArray classNameArray(className);
445 if (classNameArray.contains(
'.')) {
446 qWarning(
"QtAndroidPrivate::findClass: className '%s' should use slash separators!",
447 className.constData());
450 classNameArray.replace(
'.',
'/');
451 jclass clazz = getCachedClass(classNameArray);
455 QWriteLocker locker(cachedClassesLock);
458 const auto &it = cachedClasses->constFind(classNameArray);
459 if (it != cachedClasses->constEnd())
464 jclass localClazz = env->FindClass(classNameArray.constData());
466 clazz =
static_cast<jclass>(env->NewGlobalRef(localClazz));
467 env->DeleteLocalRef(localClazz);
471 env->ExceptionClear();
476 jobject classLoader = QtAndroidPrivate::classLoader();
480 if (!cachedClasses->loadClassMethod) {
481 jclass classLoaderClass = env->GetObjectClass(classLoader);
482 if (!classLoaderClass)
484 cachedClasses->loadClassMethod =
485 env->GetMethodID(classLoaderClass,
486 "loadClass",
"(Ljava/lang/String;)Ljava/lang/Class;");
487 env->DeleteLocalRef(classLoaderClass);
488 if (!cachedClasses->loadClassMethod) {
489 qCritical(
"Couldn't find the 'loadClass' method in the Qt class loader");
497 const QString binaryClassName = QString::fromLatin1(className).replace(u'/', u'.');
498 jstring classNameObject = env->NewString(binaryClassName.utf16(), binaryClassName.length());
499 jobject classObject = env->CallObjectMethod(classLoader,
500 cachedClasses->loadClassMethod,
502 env->DeleteLocalRef(classNameObject);
504 if (classObject && !env->ExceptionCheck()) {
505 clazz =
static_cast<jclass>(env->NewGlobalRef(classObject));
506 env->DeleteLocalRef(classObject);
513 cachedClasses->insert(classNameArray, clazz);
521
522
523
524jclass QtAndroidPrivate::findClass(
const char *className, JNIEnv *env)
526 jclass clazz = loadClassHelper(className, env);
528 QJniEnvironment::checkAndClearExceptions(env);
532jclass QJniObject::loadClass(
const QByteArray &className, JNIEnv *env)
534 return QtAndroidPrivate::findClass(className, env);
537jclass QJniObject::loadClassKeepExceptions(
const QByteArray &className, JNIEnv *env)
539 return loadClassHelper(className, env);
544typedef QHash<QByteArray, jmethodID> JMethodIDHash;
545Q_GLOBAL_STATIC(JMethodIDHash, cachedMethodID)
546Q_GLOBAL_STATIC(QReadWriteLock, cachedMethodIDLock)
548jmethodID QJniObject::getMethodID(JNIEnv *env,
551 const char *signature,
554 jmethodID id = isStatic ? env->GetStaticMethodID(clazz, name, signature)
555 : env->GetMethodID(clazz, name, signature);
560void QJniObject::callVoidMethodV(JNIEnv *env, jmethodID id, ...)
const
564 env->CallVoidMethodV(d->m_jobject, id, args);
568jmethodID QJniObject::getCachedMethodID(JNIEnv *env,
570 const QByteArray &className,
572 const char *signature,
575 if (className.isEmpty())
576 return getMethodID(env, clazz, name, signature, isStatic);
578 const QByteArray key = cacheKey(className, name, signature);
579 QHash<QByteArray, jmethodID>::const_iterator it;
582 QReadLocker locker(cachedMethodIDLock);
583 it = cachedMethodID->constFind(key);
584 if (it != cachedMethodID->constEnd())
589 QWriteLocker locker(cachedMethodIDLock);
590 it = cachedMethodID->constFind(key);
591 if (it != cachedMethodID->constEnd())
594 jmethodID id = getMethodID(env, clazz, name, signature, isStatic);
597 cachedMethodID->insert(key, id);
602jmethodID QJniObject::getCachedMethodID(JNIEnv *env,
const char *name,
603 const char *signature,
bool isStatic)
const
605 return QJniObject::getCachedMethodID(env, d->m_jclass, d->m_className, name, signature, isStatic);
608typedef QHash<QByteArray, jfieldID> JFieldIDHash;
609Q_GLOBAL_STATIC(JFieldIDHash, cachedFieldID)
610Q_GLOBAL_STATIC(QReadWriteLock, cachedFieldIDLock)
612jfieldID QJniObject::getFieldID(JNIEnv *env,
615 const char *signature,
618 jfieldID id = isStatic ? env->GetStaticFieldID(clazz, name, signature)
619 : env->GetFieldID(clazz, name, signature);
624jfieldID QJniObject::getCachedFieldID(JNIEnv *env,
626 const QByteArray &className,
628 const char *signature,
631 if (className.isNull())
632 return getFieldID(env, clazz, name, signature, isStatic);
634 const QByteArray key = cacheKey(className, name, signature);
635 QHash<QByteArray, jfieldID>::const_iterator it;
638 QReadLocker locker(cachedFieldIDLock);
639 it = cachedFieldID->constFind(key);
640 if (it != cachedFieldID->constEnd())
645 QWriteLocker locker(cachedFieldIDLock);
646 it = cachedFieldID->constFind(key);
647 if (it != cachedFieldID->constEnd())
650 jfieldID id = getFieldID(env, clazz, name, signature, isStatic);
653 cachedFieldID->insert(key, id);
658jfieldID QJniObject::getCachedFieldID(JNIEnv *env,
660 const char *signature,
663 return QJniObject::getCachedFieldID(env, d->m_jclass, d->m_className, name, signature, isStatic);
667
668
669
670
671
672
673QJniObject::QJniObject()
674 : d(
new QJniObjectPrivate())
679
680
681
682
683
684
685
686
687QJniObject::QJniObject(
const char *className)
688 : d(
new QJniObjectPrivate())
690 d->m_className = className;
691 d->m_jclass = loadClass(d->m_className, jniEnv());
692 d->m_own_jclass =
false;
698
699
700
701
702
703
704
705
706
707
708
709
710QJniObject::QJniObject(
const char *className,
const char *signature, ...)
711 : d(
new QJniObjectPrivate())
713 d->m_className = className;
714 d->m_jclass = loadClass(d->m_className, jniEnv());
715 d->m_own_jclass =
false;
718 va_start(args, signature);
719 d->construct(signature, args);
724
725
726
727
728
729
730
731
732
733
734
735
736
737
740
741
742
743
744
745
746
747
748
749QJniObject::QJniObject(jclass clazz,
const char *signature, ...)
750 : d(
new QJniObjectPrivate())
753 d->m_jclass =
static_cast<jclass>(jniEnv()->NewGlobalRef(clazz));
755 va_start(args, signature);
756 d->construct(signature, args);
762
763
764
765
766
767
768
769
770
771
772
773
774
777
778
779
780
781
782
784QJniObject::QJniObject(jclass clazz)
785 : QJniObject(clazz,
"()V")
790
791
792
793
794
795
796
797
798
799
800
801QJniObject::QJniObject(jobject object)
802 : d(
new QJniObjectPrivate())
807 JNIEnv *env = jniEnv();
808 d->m_jobject = env->NewGlobalRef(object);
809 jclass cls = env->GetObjectClass(object);
810 d->m_jclass =
static_cast<jclass>(env->NewGlobalRef(cls));
811 env->DeleteLocalRef(cls);
815
816
817
818
819
820
821
822
823
824
825
826
827
830
831
832
833
834QJniObject::~QJniObject()
838
839
840
841
845QByteArray getClassNameHelper(JNIEnv *env,
const QJniObjectPrivate *d)
847 if (env->PushLocalFrame(3) != JNI_OK)
850 jmethodID mid = env->GetMethodID(d->m_jclass,
"getClass",
"()Ljava/lang/Class;");
851 jobject classObject = env->CallObjectMethod(d->m_jobject, mid);
852 jclass classObjectClass = env->GetObjectClass(classObject);
853 mid = env->GetMethodID(classObjectClass,
"getName",
"()Ljava/lang/String;");
854 jstring stringObject =
static_cast<jstring>(env->CallObjectMethod(classObject, mid));
855 const jsize length = env->GetStringUTFLength(stringObject);
856 const char* nameString = env->GetStringUTFChars(stringObject, NULL);
857 const QByteArray result = QByteArray::fromRawData(nameString, length).replace(
'.',
'/');
858 env->ReleaseStringUTFChars(stringObject, nameString);
859 env->PopLocalFrame(
nullptr);
865
866
867
868JNIEnv *QJniObject::jniEnv()
const noexcept
870 return QJniEnvironment::getJniEnv();
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893jobject QJniObject::object()
const
899
900
901
902
903
904
905
906
907
908
909
910
911jclass QJniObject::objectClass()
const
917
918
919
920
921
922
923QByteArray QJniObject::className()
const
925 if (d->m_className.isEmpty() && d->m_jclass && d->m_jobject) {
926 JNIEnv *env = jniEnv();
927 d->m_className = getClassNameHelper(env, d.get());
929 return d->m_className;
933
934
935
936
937
938
939
940
941
942
943
944
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
966
967
968
969
970
971
972
973
974
975
976
977
978
979
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087QJniObject QJniObject::callObjectMethod(
const char *methodName,
const char *signature, ...)
const
1089 JNIEnv *env = jniEnv();
1090 jmethodID id = getCachedMethodID(env, methodName, signature);
1092 va_start(args, signature);
1094 jobject object = id ? jniEnv()->CallObjectMethodV(javaObject(), id, args) :
nullptr;
1095 QJniObject res = getCleanJniObject(object, env);
1098 QJniEnvironment::checkAndClearExceptions(env);
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115QJniObject QJniObject::callStaticObjectMethod(
const char *className,
const char *methodName,
1116 const char *signature, ...)
1118 JNIEnv *env = QJniEnvironment::getJniEnv();
1119 jclass clazz = QJniObject::loadClass(className, env);
1121 jmethodID id = QJniObject::getCachedMethodID(env, clazz,
1123 methodName, signature,
true);
1126 va_start(args, signature);
1127 QJniObject res = getCleanJniObject(env->CallStaticObjectMethodV(clazz, id, args), env);
1133 return QJniObject();
1137
1138
1139
1140
1141
1142QJniObject QJniObject::callStaticObjectMethod(jclass clazz,
const char *methodName,
1143 const char *signature, ...)
1146 QJniEnvironment env;
1147 jmethodID id = getMethodID(env.jniEnv(), clazz, methodName, signature,
true);
1150 va_start(args, signature);
1151 QJniObject res = getCleanJniObject(env->CallStaticObjectMethodV(clazz, id, args), env.jniEnv());
1157 return QJniObject();
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175QJniObject QJniObject::callStaticObjectMethod(jclass clazz, jmethodID methodId, ...)
1177 if (clazz && methodId) {
1178 JNIEnv *env = QJniEnvironment::getJniEnv();
1180 va_start(args, methodId);
1181 QJniObject res = getCleanJniObject(env->CallStaticObjectMethodV(clazz, methodId, args), env);
1186 return QJniObject();
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1225
1226
1227
1228
1229
1230
1233
1234
1235
1236
1239
1240
1241
1242
1243
1244
1247
1248
1249
1250
1251
1254
1255
1256
1257
1258
1259
1260
1261
1262
1265
1266
1267
1268
1271
1272
1273
1274
1277
1278
1279
1280
1281
1282
1285
1286
1287
1288
1291
1292
1293
1294
1297
1298
1299
1300
1301
1302
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317QJniObject QJniObject::getStaticObjectField(
const char *className,
1318 const char *fieldName,
1319 const char *signature)
1321 JNIEnv *env = QJniEnvironment::getJniEnv();
1322 jclass clazz = QJniObject::loadClass(className, env);
1324 return QJniObject();
1325 jfieldID id = QJniObject::getCachedFieldID(env, clazz,
1330 return QJniObject();
1332 return getCleanJniObject(env->GetStaticObjectField(clazz, id), env);
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347QJniObject QJniObject::getStaticObjectField(jclass clazz,
const char *fieldName,
1348 const char *signature)
1350 JNIEnv *env = QJniEnvironment::getJniEnv();
1351 jfieldID id = getFieldID(env, clazz, fieldName, signature,
true);
1353 const auto clearExceptions = qScopeGuard([env]{
1354 QJniEnvironment::checkAndClearExceptions(env);
1357 return getCleanJniObject(getStaticObjectFieldImpl(env, clazz, id), env);
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1374
1375
1376
1377
1378
1379
1380
1381
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394QJniObject QJniObject::getObjectField(
const char *fieldName,
const char *signature)
const
1396 JNIEnv *env = jniEnv();
1397 jfieldID id = getCachedFieldID(env, fieldName, signature);
1399 const auto clearExceptions = qScopeGuard([env]{
1400 QJniEnvironment::checkAndClearExceptions(env);
1403 return getCleanJniObject(getObjectFieldImpl(env, id), env);
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1420
1421
1422
1423
1424
1425
1426
1427
1430
1431
1432
1433
1434
1435
1436
1437
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451QJniObject QJniObject::fromString(
const QString &string)
1453 JNIEnv *env = QJniEnvironment::getJniEnv();
1454 jstring stringRef = QtJniTypes::Detail::fromQString(string, env);
1455 QJniObject stringObject = getCleanJniObject(stringRef, env);
1456 stringObject.d->m_className = QtJniTypes::Traits<jstring>::className();
1457 stringObject.d->m_is_jstring = QJniObjectPrivate::IsJString::Yes;
1458 return stringObject;
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475QString QJniObject::toString()
const
1480 JNIEnv *env = jniEnv();
1481 if (d->isJString(env))
1482 return QtJniTypes::Detail::toQString(object<jstring>(), env);
1484 const QJniObject string = callMethod<jstring>(
"toString");
1485 return QtJniTypes::Detail::toQString(string.object<jstring>(), env);
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499bool QJniObject::isClassAvailable(
const char *className)
1501 JNIEnv *env = QJniEnvironment::getJniEnv();
1506 return loadClass(className, env);
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520bool QJniObject::isValid()
const
1522 return d && d->m_jobject;
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539QJniObject QJniObject::fromLocalRef(jobject lref)
1541 QJniObject obj(lref);
1542 obj.jniEnv()->DeleteLocalRef(lref);
1546bool QJniObject::isSameObject(jobject obj)
const
1549 return obj ==
nullptr;
1550 if (d->m_jobject == obj)
1552 if (!d->m_jobject || !obj)
1554 return jniEnv()->IsSameObject(d->m_jobject, obj);
1557bool QJniObject::isSameObject(
const QJniObject &other)
const
1559 if (!other.isValid())
1561 return isSameObject(other.d->m_jobject);
1564void QJniObject::assign(jobject obj)
1566 if (d && isSameObject(obj))
1569 d = QSharedPointer<QJniObjectPrivate>::create();
1571 JNIEnv *env = jniEnv();
1572 d->m_jobject = env->NewGlobalRef(obj);
1573 jclass objectClass = env->GetObjectClass(obj);
1574 d->m_jclass =
static_cast<jclass>(env->NewGlobalRef(objectClass));
1575 env->DeleteLocalRef(objectClass);
1579jobject QJniObject::javaObject()
const
1581 return d->m_jobject;
1586
1587
1588
1589
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1615
1616
1617
1618
1619
1622
1623
1624
1625
1628
1629
1630
1631
1634
1635
1636
1637
1640
1641
1642
1643
1644
1645
1648
1649
1650
1651
1652
1653
1656
1657
1658
1659
1660
1661
1664
1665
1666
1667
1668
1669
1672
1673
1674
1675
1676
1677
1678
1681
1682
1683
1684
1687
1688
1689
1690
1691
1694
1695
1696
1697
1698
1701
1702
1703
1704
1705
1706
1707
1708
1711
1712
1713
1714
1715
1716
1717
1720
1721
1722
1723
1724
1725
1728
1729
1730
1731
1732
1733
1736
1737
1738
1739
1740
1741
1742
1743
1746
1747
1748
1749
1750
1751
1754
1755
1756
1757
1758
1759
bool isJString(JNIEnv *env) const
void construct(const char *signature=nullptr, Args &&...args)
Combined button and popup list for selecting options.
static QByteArray cacheKey(Args &&...args)
jmethodID loadClassMethod