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
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_EXTENSIONS_SOURCE_OLE_UNOCONVERSIONUTILITIES_HXX
#define INCLUDED_EXTENSIONS_SOURCE_OLE_UNOCONVERSIONUTILITIES_HXX
#include <memory>
#include "com/sun/star/script/XInvocationAdapterFactory.hpp"
#include "com/sun/star/script/XInvocationAdapterFactory2.hpp"
#include "com/sun/star/script/XTypeConverter.hpp"
#include "com/sun/star/script/FailReason.hpp"
#include "com/sun/star/bridge/oleautomation/Date.hpp"
#include "com/sun/star/bridge/oleautomation/Currency.hpp"
#include "com/sun/star/bridge/oleautomation/SCode.hpp"
#include "com/sun/star/bridge/oleautomation/Decimal.hpp"
#include "typelib/typedescription.hxx"
#include <o3tl/any.hxx>
#include "ole2uno.hxx"
#include <cppuhelper/weakref.hxx>
#include "unotypewrapper.hxx"
#include <unordered_map>
// for some reason DECIMAL_NEG (wtypes.h) which contains BYTE is not resolved.
typedef unsigned char BYTE;
// classes for wrapping uno objects
#define INTERFACE_OLE_WRAPPER_IMPL 1
#define UNO_OBJECT_WRAPPER_REMOTE_OPT 2
#define INVOCATION_SERVICE "com.sun.star.script.Invocation"
// classes for wrapping ole objects
#define IUNKNOWN_WRAPPER_IMPL 1
#define INTERFACE_ADAPTER_FACTORY "com.sun.star.script.InvocationAdapterFactory"
// COM or JScript objects implementing UNO interfaces have to implement this property
#define SUPPORTED_INTERFACES_PROP L"_implementedInterfaces"
// Second property without leading underscore for use in VB
#define SUPPORTED_INTERFACES_PROP2 L"Bridge_ImplementedInterfaces"
using namespace com::sun::star::script;
using namespace com::sun::star::beans;
using namespace com::sun::star::uno;
using namespace com::sun::star::bridge::oleautomation;
namespace ole_adapter
{
extern std::unordered_map<sal_uIntPtr, sal_uIntPtr> AdapterToWrapperMap;
extern std::unordered_map<sal_uIntPtr, sal_uIntPtr> WrapperToAdapterMap;
typedef std::unordered_map<sal_uIntPtr, sal_uIntPtr>::iterator IT_Wrap;
typedef std::unordered_map<sal_uIntPtr, sal_uIntPtr>::iterator CIT_Wrap;
//Maps IUnknown pointers to a weak reference of the respective wrapper class (e.g.
// IUnknownWrapperImpl. It is the responsibility of the wrapper to remove the entry when
// it is being destroyed.
// Used to ensure that an Automation object is always mapped to the same UNO objects.
extern std::unordered_map<sal_uIntPtr, WeakReference<XInterface> > ComPtrToWrapperMap;
typedef std::unordered_map<sal_uIntPtr, WeakReference<XInterface> >::iterator IT_Com;
typedef std::unordered_map<sal_uIntPtr, WeakReference<XInterface> >::const_iterator CIT_Com;
// Maps XInterface pointers to a weak reference of its wrapper class (i.e.
// InterfaceOleWrapper_Impl). It is the responsibility of the wrapper to remove the entry when
// it is being destroyed. It is used to ensure the identity of objects. That is, an UNO interface
// is mapped to IDispatch which is kept alive in the COM environment. If the same
// UNO interface is mapped again to COM then the IDispach of the first mapped instance
// must be returned.
extern std::unordered_map<sal_uIntPtr, WeakReference<XInterface> > UnoObjToWrapperMap;
typedef std::unordered_map<sal_uIntPtr, WeakReference<XInterface> >::iterator IT_Uno;
typedef std::unordered_map<sal_uIntPtr, WeakReference<XInterface> >::const_iterator CIT_Uno;
// createUnoObjectWrapper gets a wrapper instance by calling createUnoWrapperInstance
// and initializes it via XInitialization. The wrapper object is required to implement
// XBridgeSupplier so that it can convert itself to IDispatch.
// class T: Deriving class ( must implement XInterface )
/** All methods are allowed to throw at least a BridgeRuntimeError.
*/
template< class >
class UnoConversionUtilities
{
public:
explicit UnoConversionUtilities( const Reference<XMultiServiceFactory> & smgr):
m_nUnoWrapperClass( INTERFACE_OLE_WRAPPER_IMPL),
m_nComWrapperClass( IUNKNOWN_WRAPPER_IMPL),
m_smgr( smgr)
{}
UnoConversionUtilities( const Reference<XMultiServiceFactory> & xFactory, sal_uInt8 unoWrapperClass, sal_uInt8 comWrapperClass )
: m_nUnoWrapperClass(unoWrapperClass),
m_nComWrapperClass(comWrapperClass), m_smgr(xFactory)
{}
virtual ~UnoConversionUtilities() {}
/** converts only into oleautomation types, that is there is no VT_I1, VT_UI2, VT_UI4
a sal_Unicode character is converted into a BSTR.
@exception com.sun.star.lang.IllegalArgumentException
If the any was inappropriate for conversion.
@exception com.sun.star.script.CannotConvertException
The any contains a type class for which no conversion is provided.
*/
void anyToVariant(VARIANT* pVariant, const Any& rAny);
void anyToVariant(VARIANT* pVariant, const Any& rAny, VARTYPE type);
/** @exception com.sun.star.lang.IllegalArgumentException
If rSeq does not contain a sequence then the exception is thrown.
*/
SAFEARRAY* createUnoSequenceWrapper(const Any& rSeq);
/** @exception com.sun.star.lang.IllegalArgumentException
If rSeq does not contain a sequence or elemtype has no proper value
then the exception is thrown.
*/
SAFEARRAY* createUnoSequenceWrapper(const Any& rSeq, VARTYPE elemtype);
/**
@exception com.sun.star.lang.IllegalArgumentException
If rObj does not contain a struct or interface
*/
void createUnoObjectWrapper(const Any & rObj, VARIANT * pVar);
/** @exception CannotConvertException
Thrown if the VARIANT contains a type that cannot be coerced in the expected Any.
ArgumentIndex is 0.
@IllegalArgumentException
Thrown if the VARIANT is inappropriate for conversion. ArgumentPosition is -1,
*/
void variantToAny(const VARIANT* pVariant, Any& rAny, bool bReduceValueRange = true);
/** This method converts variants arguments in calls from COM -> UNO. Only then
the expected UNO type is known.
@exception CannotConvertException
Thrown if the VARIANT contains a type that cannot be coerced in the expected Any.
ArgumentIndex is 0.
@IllegalArgumentException
Thrown if the VARIANT is inappropriate for conversion. ArgumentPosition is -1,
*/
void variantToAny( const VARIANTARG* pArg, Any& rAny, const Type& ptype, bool bReduceValueRange = true);
/**
@exception IllegalArgumentException
-if pVar does not contain VT_UNKNOWN or VT_DISPATCH or
pVar is used for a particular UNO type which is not supported by pVar
*/
Any createOleObjectWrapper(VARIANT* pVar, const Type& aType= Type());
/*
Return true means var contained a ValueObject, and it was successfully converted.
The result is in any. It an error occurred a BridgeRuntimeError will be thrown.
*/
bool convertValueObject( const VARIANTARG *var, Any& any);
void dispatchExObject2Sequence( const VARIANTARG* pvar, Any& anySeq, const Type& type);
Sequence<Any> createOleArrayWrapperOfDim(SAFEARRAY* pArray, unsigned int dimCount, unsigned int actDim, long* index,
VARTYPE type, const Type& unotype);
Sequence<Any> createOleArrayWrapper(SAFEARRAY* pArray, VARTYPE type, const Type& unotype= Type());
VARTYPE mapTypeClassToVartype( TypeClass type);
Reference< XSingleServiceFactory > getInvocationFactory(const Any& anyObject);
virtual Reference< XInterface > createUnoWrapperInstance()=0;
virtual Reference< XInterface > createComWrapperInstance()=0;
static bool isJScriptArray(const VARIANT* pvar);
Sequence<Type> getImplementedInterfaces(IUnknown* pUnk);
protected:
Reference<XInterface> createAdapter(const Sequence<Type>& types, const Reference<XInterface>& receiver);
// helper function for Sequence conversion
void getElementCountAndTypeOfSequence( const Any& rSeq, sal_Int32 dim, Sequence< sal_Int32 >& seqElementCounts, TypeDescription& typeDesc);
// helper function for Sequence conversion
static bool incrementMultidimensionalIndex(sal_Int32 dimensions, const sal_Int32 * parDimensionLength,
sal_Int32 * parMultidimensionalIndex);
// helper function for Sequence conversion
static size_t getOleElementSize( VARTYPE type);
static Type getElementTypeOfSequence( const Type& seqType);
//Provides a typeconverter
Reference<XTypeConverter> getTypeConverter();
// This member determines what class is used to convert a UNO object
// or struct to a COM object. It is passed along to the o2u_anyToVariant
// function in the createBridge function implementation
sal_uInt8 m_nUnoWrapperClass;
sal_uInt8 m_nComWrapperClass;
// The servicemanager is either a local smgr or remote when the service
// com.sun.star.bridge.OleBridgeSupplierVar1 is used. This service can be
// created by createInstanceWithArguments where one can supply a service
// manager that is to be used.
// Local service manager as supplied by the loader when the creator function
// of the service is being called.
Reference<XMultiServiceFactory> m_smgr;
// An explicitly supplied service manager when the service
// com.sun.star.bridge.OleBridgeSupplierVar1 is used. That can be a remote
// manager.
Reference<XMultiServiceFactory> m_smgrRemote;
Reference<XSingleServiceFactory> m_xInvocationFactoryLocal;
Reference<XSingleServiceFactory> m_xInvocationFactoryRemote;
private:
// Holds the type converter which is used for sequence conversion etc.
// Use the getTypeConverter function to obtain the interface.
Reference<XTypeConverter> m_typeConverter;
};
// ask the object for XBridgeSupplier2 and on success bridges
// the uno object to IUnknown or IDispatch.
// return true the UNO object supports
template < class T >
bool convertSelfToCom( T& unoInterface, VARIANT * pVar)
{
bool ret = false;
Reference< XInterface > xInt( unoInterface, UNO_QUERY);
if( xInt.is())
{
Reference< XBridgeSupplier2 > xSupplier( xInt, UNO_QUERY);
if( xSupplier.is())
{
sal_Int8 arId[16];
rtl_getGlobalProcessId( reinterpret_cast<sal_uInt8*>(arId));
Sequence<sal_Int8> seqId( arId, 16);
Any anySource;
anySource <<= xInt;
Any anyDisp = xSupplier->createBridge(anySource, seqId, UNO, OLE);
// due to global-process-id check this must be in-process pointer
if (auto v = o3tl::tryAccess<sal_uIntPtr>(anyDisp))
{
VARIANT* pvariant= reinterpret_cast<VARIANT*>(*v);
HRESULT hr;
if (FAILED(hr = VariantCopy(pVar, pvariant)))
throw BridgeRuntimeError(
"[automation bridge] convertSelfToCom\n"
"VariantCopy failed! Error: " +
OUString::number(hr));
VariantClear( pvariant);
CoTaskMemFree( pvariant);
ret = true;
}
}
}
return ret;
}
// Gets the invocation factory depending on the Type in the Any.
// The factory can be created by a local or remote multi service factory.
// In case there is a remote multi service factory available there are
// some services or types for which the local factory is used. The exceptions
// are: all structs.
// Param anyObject - contains the object ( interface, struct) for what we need an invocation object.
template<class T>
Reference< XSingleServiceFactory > UnoConversionUtilities<T>::getInvocationFactory(const Any& anyObject)
{
Reference< XSingleServiceFactory > retVal;
MutexGuard guard( getBridgeMutex());
if( anyObject.getValueTypeClass() != TypeClass_STRUCT &&
m_smgrRemote.is() )
{
if( ! m_xInvocationFactoryRemote.is() )
m_xInvocationFactoryRemote.set(m_smgrRemote->createInstance( INVOCATION_SERVICE), UNO_QUERY);
retVal= m_xInvocationFactoryRemote;
}
else
{
if( ! m_xInvocationFactoryLocal.is() )
m_xInvocationFactoryLocal.set(m_smgr->createInstance(INVOCATION_SERVICE ), UNO_QUERY);
retVal= m_xInvocationFactoryLocal;
}
return retVal;
}
template<class T>
void UnoConversionUtilities<T>::variantToAny( const VARIANTARG* pArg, Any& rAny, const Type& ptype, bool bReduceValueRange /* = sal_True */)
{
try
{
HRESULT hr;
bool bFail = false;
bool bCannotConvert = false;
CComVariant var;
// There is no need to support indirect values, since they're not supported by UNO
if( FAILED(hr= VariantCopyInd( &var, pArg))) // remove VT_BYREF
throw BridgeRuntimeError(
"[automation bridge] UnoConversionUtilities<T>::variantToAny \n"
"VariantCopyInd failed for reason : " + OUString::number(hr));
bool bHandled = convertValueObject( & var, rAny);
if( bHandled)
OSL_ENSURE( rAny.getValueType() == ptype, "type in Value Object must match the type parameter");
if( ! bHandled)
{
// convert into a variant type that is the equivalent to the type
// the sequence expects. Thus variantToAny produces the correct type
// E.g. An Array object contains VT_I4 and the sequence expects shorts
// than the vartype must be changed. The reason is, you can't specify the
// type in JavaScript and the script engine determines the type being used.
switch( ptype.getTypeClass())
{
case TypeClass_CHAR: // could be: new Array( 12, 'w', "w")
if( var.vt == VT_BSTR)
{
if(SUCCEEDED( hr= VariantChangeType( &var, &var, 0, VT_BSTR)))
rAny.setValue( V_BSTR( &var), ptype);
else if (hr == DISP_E_TYPEMISMATCH)
bCannotConvert = true;
else
bFail = true;
}
else
{
if(SUCCEEDED(hr = VariantChangeType( & var, &var, 0, VT_I2)))
rAny.setValue(& var.iVal, ptype);
else if (hr == DISP_E_TYPEMISMATCH)
bCannotConvert = true;
else
bFail = true;
}
break;
case TypeClass_INTERFACE: // could also be an IUnknown
case TypeClass_STRUCT:
{
rAny = createOleObjectWrapper( & var, ptype);
break;
}
case TypeClass_ENUM:
if(SUCCEEDED(hr = VariantChangeType( & var, &var, 0, VT_I4)))
rAny.setValue(& var.lVal, ptype);
else if (hr == DISP_E_TYPEMISMATCH)
bCannotConvert = true;
else
bFail = true;
break;
case TypeClass_SEQUENCE:
// There are different ways of receiving a sequence:
// 1: JScript, VARTYPE: VT_DISPATCH
// 2. VBScript simple arraysVT_VARIANT|VT_BYREF the referenced VARIANT contains
// a VT_ARRAY| <type>
// 3. VBScript multi dimensional arrays: VT_ARRAY|VT_BYREF
if( pArg->vt == VT_DISPATCH)
{
dispatchExObject2Sequence( pArg, rAny, ptype);
}
else
{
if ((var.vt & VT_ARRAY) != 0)
{
VARTYPE oleType = ::sal::static_int_cast< VARTYPE, int >( var.vt ^ VT_ARRAY );
Sequence<Any> unoSeq = createOleArrayWrapper( var.parray, oleType, ptype);
Reference<XTypeConverter> conv = getTypeConverter();
if (conv.is())
{
try
{
Any anySeq = makeAny(unoSeq);
Any convAny = conv->convertTo(anySeq, ptype);
rAny = convAny;
}
catch (const IllegalArgumentException& e)
{
throw BridgeRuntimeError(
"[automation bridge]com.sun.star.lang.IllegalArgumentException "
"in UnoConversionUtilities<T>::variantToAny! Message: " +
e.Message);
}
catch (const CannotConvertException& e)
{
throw BridgeRuntimeError(
"[automation bridge]com.sun.star.script.CannotConvertException "
"in UnoConversionUtilities<T>::variantToAny! Message: " +
e.Message);
}
}
}
}
break;
case TypeClass_VOID:
rAny.setValue(nullptr,Type());
break;
case TypeClass_ANY: // Any
// There could be a JScript Array that needs special handling
// If an Any is expected and this Any must contain a Sequence
// then we cannot figure out what element type is required.
// Therefore we convert to Sequence< Any >
if( pArg->vt == VT_DISPATCH && isJScriptArray( pArg))
{
dispatchExObject2Sequence( pArg, rAny,
cppu::UnoType<Sequence<Any>>::get());
}
else if (pArg->vt == VT_DECIMAL)
{
//Decimal maps to hyper in calls from COM -> UNO
// It does not matter if we create a sal_uInt64 or sal_Int64,
// because the UNO object is called through invocation which
//will do a type conversion if necessary
if (var.decVal.sign == 0)
{
// positive value
variantToAny( & var, rAny, cppu::UnoType<sal_uInt64>::get(),
bReduceValueRange);
}
else
{
//negative value
variantToAny( & var, rAny, cppu::UnoType<sal_Int64>::get(),
bReduceValueRange);
}
}
else
{
variantToAny( & var, rAny);
}
break;
case TypeClass_BOOLEAN: // VARIANT could be VARIANT_BOOL or other
if(SUCCEEDED(hr = VariantChangeType( & var, &var, 0, VT_BOOL)))
variantToAny( & var, rAny);
else if (hr == DISP_E_TYPEMISMATCH)
bCannotConvert = true;
else
bFail = true;
break;
case TypeClass_STRING: // UString
if(SUCCEEDED(hr = VariantChangeType( & var, &var, 0, VT_BSTR)))
variantToAny( & var, rAny);
else if (hr == DISP_E_TYPEMISMATCH)
bCannotConvert = true;
else
bFail = true;
break;
case TypeClass_FLOAT: // float
if(SUCCEEDED(hr = VariantChangeType( & var, &var, 0, VT_R4)))
variantToAny( & var, rAny);
else if (hr == DISP_E_TYPEMISMATCH)
bCannotConvert = true;
else
bFail = true;
break;
case TypeClass_DOUBLE: // double
if(SUCCEEDED(hr = VariantChangeType( & var, &var, 0, VT_R8)))
variantToAny(& var, rAny);
else if (hr == DISP_E_TYPEMISMATCH)
bCannotConvert = true;
else
bFail = true;
break;
case TypeClass_BYTE: // BYTE
if(SUCCEEDED(hr = VariantChangeType( & var, &var, 0, VT_I1)))
variantToAny( & var, rAny);
else if (hr == DISP_E_TYPEMISMATCH)
bCannotConvert = true;
else
bFail = true;
break;
case TypeClass_SHORT: // INT16
if(SUCCEEDED(hr = VariantChangeType( & var, &var, 0, VT_I2)))
variantToAny( & var, rAny);
else if (hr == DISP_E_TYPEMISMATCH)
bCannotConvert = true;
else
bFail = true;
break;
case TypeClass_LONG:
if(SUCCEEDED(hr = VariantChangeType(& var, &var, 0, VT_I4)))
variantToAny( & var, rAny, bReduceValueRange);
else if (hr == DISP_E_TYPEMISMATCH)
bCannotConvert = true;
else
bFail = true;
break;
case TypeClass_HYPER:
if(SUCCEEDED(hr = VariantChangeType(& var, &var, 0, VT_DECIMAL)))
{
if (var.decVal.Lo64 > SAL_CONST_UINT64(0x8000000000000000)
|| var.decVal.Hi32 > 0
|| var.decVal.scale > 0)
{
bFail = true;
break;
}
sal_Int64 value = var.decVal.Lo64;
if (var.decVal.sign == DECIMAL_NEG)
value |= SAL_CONST_UINT64(0x8000000000000000);
rAny <<= value;
}
else if (hr == DISP_E_TYPEMISMATCH)
bCannotConvert = true;
else
bFail = true;
break;
case TypeClass_UNSIGNED_SHORT: // UINT16
if(SUCCEEDED(hr = VariantChangeType( & var, &var, 0, VT_UI2)))
variantToAny( & var, rAny);
else if (hr == DISP_E_TYPEMISMATCH)
bCannotConvert = true;
else
bFail = true;
break;
case TypeClass_UNSIGNED_LONG:
if(SUCCEEDED(hr = VariantChangeType( & var, &var, 0, VT_UI4)))
variantToAny( & var, rAny, bReduceValueRange);
else if (hr == DISP_E_TYPEMISMATCH)
bCannotConvert = true;
else
bFail = true;
break;
case TypeClass_UNSIGNED_HYPER:
if(SUCCEEDED(hr = VariantChangeType(& var, &var, 0, VT_DECIMAL)))
{
if (var.decVal.Hi32 > 0 || var.decVal.scale > 0)
{
bFail = true;
break;
}
rAny <<= var.decVal.Lo64;
}
else if (hr == DISP_E_TYPEMISMATCH)
bCannotConvert = true;
else
bFail = true;
break;
case TypeClass_TYPE:
if(SUCCEEDED(hr = VariantChangeType(& var, &var, 0, VT_UNKNOWN)))
variantToAny( & var, rAny);
else if (hr == DISP_E_TYPEMISMATCH)
bCannotConvert = true;
else
bFail = true;
break;
default:
bCannotConvert = true;
break;
}
}
if (bCannotConvert)
throw CannotConvertException(
"[automation bridge]UnoConversionUtilities<T>::variantToAny \n"
"Cannot convert the value of vartype :\"" +
OUString::number((sal_Int32) var.vt) +
"\" to the expected UNO type of type class: " +
OUString::number((sal_Int32) ptype.getTypeClass()),
nullptr, TypeClass_UNKNOWN, FailReason::TYPE_NOT_SUPPORTED,0);
if (bFail)
throw IllegalArgumentException(
"[automation bridge]UnoConversionUtilities<T>:variantToAny\n"
"The provided VARIANT of type\" " + OUString::number((sal_Int32) var.vt) +
"\" is unappropriate for conversion!", Reference<XInterface>(), -1);
}
catch (const CannotConvertException &)
{
throw;
}
catch (const IllegalArgumentException &)
{
throw;
}
catch (const BridgeRuntimeError &)
{
throw;
}
catch (const Exception & e)
{
throw BridgeRuntimeError("[automation bridge] unexpected exception in "
"UnoConversionUtilities<T>::variantToAny ! Message : \n" +
e.Message);
}
catch(...)
{
throw BridgeRuntimeError(
"[automation bridge] unexpected exception in "
"UnoConversionUtilities<T>::variantToAny !");
}
}
// The function only converts Sequences to SAFEARRAYS with elements of the type
// specified by the parameter type. Everything else is forwarded to
// anyToVariant(VARIANT* pVariant, const Any& rAny)
// Param type must not be VT_BYREF
template<class T>
void UnoConversionUtilities<T>::anyToVariant(VARIANT* pVariant, const Any& rAny, VARTYPE type)
{
try
{
HRESULT hr= S_OK;
OSL_ASSERT( (type & VT_BYREF) == 0);
if (type & VT_ARRAY)
{
type ^= VT_ARRAY;
SAFEARRAY* ar= createUnoSequenceWrapper( rAny, type);
if( ar)
{
VariantClear( pVariant);
pVariant->vt= ::sal::static_int_cast< VARTYPE, int >( VT_ARRAY | type );
pVariant->byref= ar;
}
}
else if(type == VT_VARIANT)
{
anyToVariant(pVariant, rAny);
}
else
{
CComVariant var;
anyToVariant( &var, rAny);
if(FAILED(hr = VariantChangeType(&var, &var, 0, type)))
{
if (hr == DISP_E_TYPEMISMATCH)
throw CannotConvertException(
"[automation bridge]UnoConversionUtilities<T>::anyToVariant \n"
"Cannot convert the value of type :\"" +
rAny.getValueTypeName() +
"\" to the expected Automation type of VARTYPE: " +
OUString::number((sal_Int32)type),
nullptr, TypeClass_UNKNOWN, FailReason::TYPE_NOT_SUPPORTED,0);
throw BridgeRuntimeError(
"[automation bridge]UnoConversionUtilities<T>::anyToVariant \n"
"Conversion of any with " +
rAny.getValueType().getTypeName() +
" to VARIANT with type: " + OUString::number((sal_Int32) type) +
" failed! Error code: " + OUString::number(hr));
}
if(FAILED(hr = VariantCopy(pVariant, &var)))
{
throw BridgeRuntimeError(
"[automation bridge]UnoConversionUtilities<T>::anyToVariant \n"
"VariantCopy failed for reason: " + OUString::number(hr));
}
}
}
catch (const IllegalArgumentException &)
{
throw;
}
catch (const CannotConvertException &)
{
throw;
}
catch (const BridgeRuntimeError&)
{
throw;
}
catch(const Exception & e)
{
throw BridgeRuntimeError(
"[automation bridge]UnoConversionUtilities<T>::anyToVariant \n"
"Unexpected exception occurred. Message: " + e.Message);
}
catch(...)
{
throw BridgeRuntimeError(
"[automation bridge]UnoConversionUtilities<T>::anyToVariant \n"
"Unexpected exception occurred.");
}
}
template<class T>
void UnoConversionUtilities<T>::anyToVariant(VARIANT* pVariant, const Any& rAny)
{
try
{
bool bIllegal = false;
switch (rAny.getValueTypeClass())
{
case TypeClass_INTERFACE:
{
Reference<XInterface> xInt;
if (rAny >>= xInt)
{
createUnoObjectWrapper(rAny, pVariant);
}
else
{
bIllegal = true;
}
break;
}
case TypeClass_STRUCT:
{
if (rAny.getValueType() == cppu::UnoType<Date>::get() )
{
Date d;
if (rAny >>= d)
{
pVariant->vt = VT_DATE;
pVariant->date = d.Value;
}
else
{
bIllegal = true;
}
}
else if(rAny.getValueType() == cppu::UnoType<Decimal>::get())
{
Decimal d;
if (rAny >>= d)
{
pVariant->vt = VT_DECIMAL;
pVariant->decVal.scale = d.Scale;
pVariant->decVal.sign = d.Sign;
pVariant->decVal.Lo32 = d.LowValue;
pVariant->decVal.Mid32 = d.MiddleValue;
pVariant->decVal.Hi32 = d.HighValue;
}
else
{
bIllegal = true;
}
}
else if (rAny.getValueType() == cppu::UnoType<Currency>::get())
{
Currency c;
if (rAny >>= c)
{
pVariant->vt = VT_CY;
pVariant->cyVal.int64 = c.Value;
}
else
{
bIllegal = true;
}
}
else if(rAny.getValueType() == cppu::UnoType<SCode>::get())
{
SCode s;
if (rAny >>= s)
{
pVariant->vt = VT_ERROR;
pVariant->scode = s.Value;
}
else
{
bIllegal = true;
}
}
else
{
createUnoObjectWrapper(rAny, pVariant);
}
break;
}
case TypeClass_SEQUENCE: // sequence ??? SafeArray descriptor
{
SAFEARRAY* pArray = createUnoSequenceWrapper(rAny);
if (pArray)
{
V_VT(pVariant) = VT_ARRAY | VT_VARIANT;
V_ARRAY(pVariant) = pArray;
}
else
{
bIllegal = true;
}
break;
}
case TypeClass_VOID:
{
HRESULT hr = S_OK;
if (FAILED(hr = VariantClear(pVariant)))
{
throw BridgeRuntimeError(
"[automation bridge]UnoConversionUtilities<T>::anyToVariant\n"
"VariantClear failed with error:" + OUString::number(hr));
}
break;
}
case TypeClass_BOOLEAN:
{
bool value;
if (rAny >>= value)
{
pVariant->vt = VT_BOOL;
pVariant->boolVal = value ? VARIANT_TRUE: VARIANT_FALSE;
}
else
{
bIllegal = true;
}
break;
}
case TypeClass_CHAR:
{
// Because VT_UI2 does not conform to oleautomation we convert into VT_I2 instead
sal_uInt16 value = *o3tl::forceAccess<sal_Unicode>(rAny);
pVariant->vt = VT_I2;
pVariant->iVal = value;
break;
}
case TypeClass_STRING:
{
OUString value;
if (rAny >>= value)
{
pVariant->vt = VT_BSTR;
pVariant->bstrVal = SysAllocString(SAL_W(value.getStr()));
}
else
{
bIllegal = true;
}
break;
}
case TypeClass_FLOAT:
{
float value;
if (rAny >>= value)
{
pVariant->vt = VT_R4;
pVariant->fltVal = value;
}
else
{
bIllegal = true;
}
break;
}
case TypeClass_DOUBLE:
{
double value;
if (rAny >>= value)
{
pVariant->vt = VT_R8;
pVariant->dblVal = value;
}
else
{
bIllegal = true;
}
break;
}
case TypeClass_BYTE:
{
// ole automation does not know a signed char but only unsigned char
sal_Int8 value;
if (rAny >>= value)
{
pVariant->vt = VT_UI1;
pVariant->bVal = value;
}
else
{
bIllegal = true;
}
break;
}
case TypeClass_SHORT: // INT16
case TypeClass_UNSIGNED_SHORT: // UINT16
{
sal_Int16 value;
if (rAny >>= value)
{
pVariant->vt = VT_I2;
pVariant->iVal = value;
}
else
{
bIllegal = true;
}
break;
}
case TypeClass_ENUM:
{
sal_Int32 value = *static_cast<sal_Int32 const *>(rAny.getValue());
pVariant->vt = VT_I4;
pVariant->lVal= value;
break;
}
case TypeClass_LONG:
case TypeClass_UNSIGNED_LONG:
{
sal_Int32 value;
if (rAny >>= value)
{
pVariant->vt = VT_I4;
pVariant->lVal= value;
}
else
{
bIllegal = true;
}
break;
}
case TypeClass_HYPER:
{
pVariant->vt = VT_DECIMAL;
pVariant->decVal.scale = 0;
pVariant->decVal.sign = 0;
pVariant->decVal.Hi32 = 0;
sal_Int64 value;
rAny >>= value;
if (value & SAL_CONST_UINT64(0x8000000000000000))
pVariant->decVal.sign = DECIMAL_NEG;
pVariant->decVal.Lo64 = value;
break;
}
case TypeClass_UNSIGNED_HYPER:
{
pVariant->vt = VT_DECIMAL;
pVariant->decVal.scale = 0;
pVariant->decVal.sign = 0;
pVariant->decVal.Hi32 = 0;
sal_uInt64 value;
rAny >>= value;
pVariant->decVal.Lo64 = value;
break;
}
case TypeClass_TYPE:
{
Type type;
rAny >>= type;
CComVariant var;
if (!createUnoTypeWrapper(type.getTypeName(), & var))
throw BridgeRuntimeError(
"[automation bridge] UnoConversionUtilities<T>::anyToVariant \n"
"Error during conversion of UNO type to Automation object!");
if (FAILED(VariantCopy(pVariant, &var)))
throw BridgeRuntimeError(
"[automation bridge] UnoConversionUtilities<T>::anyToVariant \n"
"Unexpected error!");
break;
}
default:
//TypeClass_SERVICE:
//TypeClass_EXCEPTION:
//When a InvocationTargetException is thrown when calling XInvocation::invoke
//on a UNO object, then the target exception is directly used to create a
//EXEPINFO structure
//TypeClass_TYPEDEF
//TypeClass_ANY:
//TypeClass_UNKNOWN:
//TypeClass_MODULE:
throw CannotConvertException(
"[automation bridge]UnoConversionUtilities<T>::anyToVariant\n"
"There is no conversion for this UNO type to a Automation type."
"The destination type class is the type class of the UNO "
"argument which was to be converted.",
Reference<XInterface>(), rAny.getValueTypeClass(),
FailReason::TYPE_NOT_SUPPORTED, 0);
break;
}
if (bIllegal)
{
throw IllegalArgumentException(
"[automation bridge]UnoConversionUtilities<T>::anyToVariant\n"
"The provided any of type\" " + rAny.getValueType().getTypeName() +
"\" is unappropriate for conversion!", Reference<XInterface>(), -1);
}
}
catch (const CannotConvertException &)
{
throw;
}
catch (const IllegalArgumentException &)
{
throw;
}
catch(const BridgeRuntimeError&)
{
throw;
}
catch(const Exception & e)
{
throw BridgeRuntimeError(
"[automation bridge]UnoConversionUtilities<T>::anyToVariant \n"
"Unexpected exception occurred. Message: " + e.Message);
}
catch(...)
{
throw BridgeRuntimeError(
"[automation bridge]UnoConversionUtilities<T>::anyToVariant \n"
"Unexpected exception occurred. " );
}
}
// Creates an SAFEARRAY of the specified element and if necessary
// creates a SAFEARRAY with multiple dimensions.
// Used by sal_Bool anyToVariant(VARIANT* pVariant, const Any& rAny, VARTYPE type);
template<class T>
SAFEARRAY* UnoConversionUtilities<T>::createUnoSequenceWrapper(const Any& rSeq, VARTYPE elemtype)
{
if (rSeq.getValueTypeClass() != TypeClass_SEQUENCE)
throw IllegalArgumentException(
"[automation bridge]UnoConversionUtilities<T>::createUnoSequenceWrapper \n"
"The any does not contain a sequence!", nullptr, 0);
if (elemtype == VT_NULL || elemtype == VT_EMPTY)
throw IllegalArgumentException(
"[automation bridge]UnoConversionUtilities<T>::createUnoSequenceWrapper \n"
"No element type supplied!",nullptr, -1);
SAFEARRAY* pArray= nullptr;
// Get the dimensions. This is done by examining the type name string
// The count of brackets determines the dimensions.
OUString sTypeName= rSeq.getValueType().getTypeName();
sal_Int32 dims=0;
for(sal_Int32 lastIndex=0;(lastIndex= sTypeName.indexOf( L'[', lastIndex)) != -1; lastIndex++,dims++);
//get the maximum number of elements per dimensions and the typedescription of the elements
Sequence<sal_Int32> seqElementCounts( dims);
TypeDescription elementTypeDesc;
getElementCountAndTypeOfSequence( rSeq, 1, seqElementCounts, elementTypeDesc );
if( elementTypeDesc.is() )
{
// set up the SAFEARRAY
std::unique_ptr<SAFEARRAYBOUND[]> sarSafeArrayBound(new SAFEARRAYBOUND[dims]);
SAFEARRAYBOUND* prgsabound= sarSafeArrayBound.get();
for( sal_Int32 i=0; i < dims; i++)
{
//prgsabound[0] is the right most dimension
prgsabound[dims - i - 1].lLbound = 0;
prgsabound[dims - i - 1].cElements = seqElementCounts[i];
}
typelib_TypeDescription* rawTypeDesc= elementTypeDesc.get();
sal_Int32 elementSize= rawTypeDesc->nSize;
size_t oleElementSize= getOleElementSize( elemtype);
// SafeArrayCreate clears the memory for the data itself.
pArray = SafeArrayCreate(elemtype, dims, prgsabound);
// convert the Sequence's elements and populate the SAFEARRAY
if( pArray)
{
// Iterate over every Sequence that contains the actual elements
void* pSAData;
if( SUCCEEDED( SafeArrayAccessData( pArray, &pSAData)))
{
const sal_Int32* parElementCount= seqElementCounts.getConstArray();
uno_Sequence * pMultiSeq= *static_cast<uno_Sequence* const*>(rSeq.getValue());
sal_Int32 dimsSeq= dims - 1;
// arDimSeqIndices contains the current index of a block of data.
// E.g. Sequence<Sequence<sal_Int32>> , the index would refer to Sequence<sal_Int32>
// In this case arDimSeqIndices would have the size 1. That is the elements are not counted
// but the Sequences that contain those elements.
// The indices ar 0 based
std::unique_ptr<sal_Int32[]> sarDimsSeqIndices;
sal_Int32* arDimsSeqIndices= nullptr;
if( dimsSeq > 0)
{
sarDimsSeqIndices.reset(new sal_Int32[dimsSeq]);
arDimsSeqIndices = sarDimsSeqIndices.get();
memset( arDimsSeqIndices, 0, sizeof( sal_Int32 ) * dimsSeq);
}
char* psaCurrentData= static_cast<char*>(pSAData);
do
{
// Get the Sequence at the current index , see arDimsSeqIndices
uno_Sequence * pCurrentSeq= pMultiSeq;
sal_Int32 curDim=1; // 1 based
bool skipSeq= false;
while( curDim <= dimsSeq )
{
// get the Sequence at the index if valid
if( pCurrentSeq->nElements > arDimsSeqIndices[ curDim - 1] ) // don't point to Nirvana
{
// size of Sequence is 4
sal_Int32 offset= arDimsSeqIndices[ curDim - 1] * 4;
pCurrentSeq= *reinterpret_cast<uno_Sequence**>(&pCurrentSeq->elements[ offset]);
curDim++;
}
else
{
// There is no Sequence at this index, so skip this index
skipSeq= true;
break;
}
}
if( skipSeq)
continue;
// Calculate the current position within the datablock of the SAFEARRAY
// for the next Sequence.
sal_Int32 memOffset= 0;
sal_Int32 dimWeight= parElementCount[ dims - 1]; // size of the rightmost dimension
for(sal_Int32 idims=0; idims < dimsSeq; idims++ )
{
memOffset+= arDimsSeqIndices[dimsSeq - 1 - idims] * dimWeight;
// now determine the weight of the dimension to the left of the current.
if( dims - 2 - idims >=0)
dimWeight*= parElementCount[dims - 2 - idims];
}
psaCurrentData= static_cast<char*>(pSAData) + memOffset * oleElementSize;
// convert the Sequence and put the elements into the Safearray
for( sal_Int32 i= 0; i < pCurrentSeq->nElements; i++)
{
Any unoElement( pCurrentSeq->elements + i * elementSize, rawTypeDesc );
// The any is being converted into an VARIANT which value is then copied
// to the SAFEARRAY's data block. When copying one has to follow the rules for
// copying certain types, as are VT_DISPATCH, VT_UNKNOWN, VT_VARIANT, VT_BSTR.
// To increase performance, we just do a memcpy of VARIANT::byref. This is possible
// because anyToVariant has already followed the copying rules. To make this
// work there must not be a VariantClear.
// One Exception is VARIANT because I don't know how VariantCopy works.
VARIANT var;
VariantInit( &var);
anyToVariant( &var, unoElement);
if( elemtype == VT_VARIANT )
{
VariantCopy( reinterpret_cast<VARIANT*>(psaCurrentData), &var);
VariantClear( &var);
}
else
memcpy( psaCurrentData, &var.byref, oleElementSize);
psaCurrentData+= oleElementSize;
}
}
while( incrementMultidimensionalIndex( dimsSeq, parElementCount, arDimsSeqIndices));
SafeArrayUnaccessData( pArray);
}
}
}
return pArray;
}
// Increments a multi dimensional index.
// Returns true as long as the index has been successfully incremented, false otherwise.
// False is also returned if an overflow of the most significant dimension occurs. E.g.
// assume an array with the dimensions (2,2), then the lowest index is (0,0) and the highest
// index is (1,1). If the function is being called with the index (1,1) then the overflow would
// occur, with the result (0,0) and a sal_False as return value.
// Param dimensions - number of dimensions
// Param parDimensionsLength - The array contains the size of each dimension, that is the
// size of the array equals the parameter dimensions.
// The rightmost dimensions is the least significant one
// ( parDimensionsLengths[ dimensions -1 ] ).
// Param parMultiDimensionalIndex - The array contains the index. Each dimension index is
// 0 based.
template<class T>
bool UnoConversionUtilities<T>::incrementMultidimensionalIndex(sal_Int32 dimensions,
const sal_Int32 * parDimensionLengths,
sal_Int32 * parMultidimensionalIndex)
{
if( dimensions < 1)
return false;
bool ret= true;
bool carry= true; // to get into the while loop
sal_Int32 currentDimension= dimensions; //most significant is 1
while( carry)
{
parMultidimensionalIndex[ currentDimension - 1]++;
// if carryover, set index to 0 and handle carry on a level above
if( parMultidimensionalIndex[ currentDimension - 1] > (parDimensionLengths[ currentDimension - 1] - 1))
parMultidimensionalIndex[ currentDimension - 1]= 0;
else
carry= false;
currentDimension --;
// if dimensions drops below 1 and carry is set than then all indices are 0 again
// this is signalled by returning sal_False
if( currentDimension < 1 && carry)
{
carry= false;
ret= false;
}
}
return ret;
}
// Determines the size of a certain OLE type. The function takes
// only those types into account which are oleautomation types and
// can have a value ( unless VT_NULL, VT_EMPTY, VT_ARRAY, VT_BYREF).
// Currently used in createUnoSequenceWrapper to calculate addresses
// for data within a SAFEARRAY.
template<class T>
size_t UnoConversionUtilities<T>::getOleElementSize( VARTYPE type)
{
size_t size;
switch( type)
{
case VT_BOOL: size= sizeof( VARIANT_BOOL);break;
case VT_UI1: size= sizeof( unsigned char);break;
case VT_R8: size= sizeof( double);break;
case VT_R4: size= sizeof( float);break;
case VT_I2: size= sizeof( short);break;
case VT_I4: size= sizeof( long);break;
case VT_BSTR: size= sizeof( BSTR); break;
case VT_ERROR: size= sizeof( SCODE); break;
case VT_DISPATCH:
case VT_UNKNOWN: size= sizeof( IUnknown*); break;
case VT_VARIANT: size= sizeof( VARIANT);break;
default: size= 0;
}
return size;
}
//If a Sequence is being converted into a SAFEARRAY then we possibly have
// to create a SAFEARRAY with multiple dimensions. This is the case when a
// Sequence contains Sequences ( Sequence< Sequence < XXX > > ). The leftmost
// Sequence in the declaration is assumed to represent dimension 1. Because
// all Sequence elements of a Sequence can have different length, we have to
// determine the maximum length which is then the length of the respective
// dimension.
// getElementCountAndTypeOfSequence determines the length of each dimension and calls itself recursively
// in the process.
// param rSeq - an Any that has to contain a Sequence
// param dim - the dimension for which the number of elements is being determined,
// must be one.
// param seqElementCounts - contains the maximum number of elements for each
// dimension. Index 0 contains the number of dimension one.
// After return the Sequence contains the maximum number of
// elements for each dimension.
// The length of the Sequence must equal the number of dimensions.
// param typeClass - TypeClass of the element type that is no Sequence, e.g.
// Sequence< Sequence <Sequence <sal_Int32> > > - type is sal_Int32)
template<class T>
void UnoConversionUtilities<T>::getElementCountAndTypeOfSequence( const Any& rSeq, sal_Int32 dim,
Sequence< sal_Int32 >& seqElementCounts, TypeDescription& typeDesc)
{
sal_Int32 dimCount= (*static_cast<uno_Sequence* const *>(rSeq.getValue()))->nElements;
if( dimCount > seqElementCounts[ dim-1])
seqElementCounts[ dim-1]= dimCount;
// we need the element type to construct the any that is
// passed into getElementCountAndTypeOfSequence again
typelib_TypeDescription* pSeqDesc= nullptr;
rSeq.getValueTypeDescription( &pSeqDesc);
typelib_TypeDescriptionReference* pElementDescRef= reinterpret_cast<typelib_IndirectTypeDescription*>(pSeqDesc)->pType;
// if the elements are Sequences than do recursion
if( dim < seqElementCounts.getLength() )
{
uno_Sequence* pSeq = *static_cast<uno_Sequence* const*>(rSeq.getValue());
uno_Sequence** arSequences= reinterpret_cast<uno_Sequence**>(pSeq->elements);
for( sal_Int32 i=0; i < dimCount; i++)
{
uno_Sequence* arElement= arSequences[ i];
getElementCountAndTypeOfSequence( Any( &arElement, pElementDescRef), dim + 1 , seqElementCounts, typeDesc);
}
}
else
{
// determine the element type ( e.g. Sequence< Sequence <Sequence <sal_Int32> > > - type is sal_Int32)
typeDesc= pElementDescRef;
}
typelib_typedescription_release( pSeqDesc);
}
template<class T>
SAFEARRAY* UnoConversionUtilities<T>::createUnoSequenceWrapper(const Any& rSeq)
{
SAFEARRAY* pArray = nullptr;
sal_uInt32 n = 0;
if( rSeq.getValueTypeClass() != TypeClass_SEQUENCE )
throw IllegalArgumentException(
"[automation bridge]UnoConversionUtilities<T>::createUnoSequenceWrapper\n"
"The UNO argument is not a sequence", nullptr, -1);
uno_Sequence * punoSeq= *static_cast<uno_Sequence* const *>(rSeq.getValue());
typelib_TypeDescriptionReference* pSeqTypeRef= rSeq.getValueTypeRef();
typelib_TypeDescription* pSeqType= nullptr;
TYPELIB_DANGER_GET( &pSeqType, pSeqTypeRef);
typelib_IndirectTypeDescription * pSeqIndDec= reinterpret_cast<typelib_IndirectTypeDescription*>(pSeqType);
typelib_TypeDescriptionReference * pSeqElementTypeRef= pSeqIndDec->pType;
TYPELIB_DANGER_RELEASE( pSeqType);
typelib_TypeDescription* pSeqElementDesc= nullptr;
TYPELIB_DANGER_GET( &pSeqElementDesc, pSeqElementTypeRef);
sal_Int32 nElementSize= pSeqElementDesc->nSize;
n= punoSeq->nElements;
SAFEARRAYBOUND rgsabound[1];
rgsabound[0].lLbound = 0;
rgsabound[0].cElements = n;
VARIANT oleElement;
long safeI[1];
pArray = SafeArrayCreate(VT_VARIANT, 1, rgsabound);
Any unoElement;
char * pSeqData= punoSeq->elements;
for (sal_uInt32 i = 0; i < n; i++)
{
unoElement.setValue( pSeqData + i * nElementSize, pSeqElementDesc);
VariantInit(&oleElement);
anyToVariant(&oleElement, unoElement);
safeI[0] = i;
SafeArrayPutElement(pArray, safeI, &oleElement);
VariantClear(&oleElement);
}
TYPELIB_DANGER_RELEASE( pSeqElementDesc);
return pArray;
}
/* The argument rObj can contain
- UNO struct
- UNO interface
- UNO interface created by this bridge (adapter factory)
- UNO interface created by this bridge ( COM Wrapper)
pVar must be initialized.
*/
template<class T>
void UnoConversionUtilities<T>::createUnoObjectWrapper(const Any & rObj, VARIANT * pVar)
{
MutexGuard guard(getBridgeMutex());
Reference<XInterface> xInt;
TypeClass tc = rObj.getValueTypeClass();
if (tc != TypeClass_INTERFACE && tc != TypeClass_STRUCT)
throw IllegalArgumentException(
"[automation bridge]UnoConversionUtilities<T>::createUnoObjectWrapper \n"
"Cannot create an Automation interface for a UNO type which is not "
"a struct or interface!", nullptr, -1);
if (rObj.getValueTypeClass() == TypeClass_INTERFACE)
{
if (! (rObj >>= xInt))
throw IllegalArgumentException(
"[automation bridge] UnoConversionUtilities<T>::createUnoObjectWrapper\n "
"Could not create wrapper object for UNO object!", nullptr, -1);
//If XInterface is NULL, which is a valid value, then simply return NULL.
if ( ! xInt.is())
{
pVar->vt = VT_UNKNOWN;
pVar->punkVal = nullptr;
return;
}
//make sure we have the main XInterface which is used with a map
xInt.set(xInt, UNO_QUERY);
//If there is already a wrapper for the UNO object then use it
Reference<XInterface> xIntWrapper;
// Does a UNO wrapper exist already ?
IT_Uno it_uno = UnoObjToWrapperMap.find( reinterpret_cast<sal_uIntPtr>(xInt.get()));
if(it_uno != UnoObjToWrapperMap.end())
{
xIntWrapper = it_uno->second;
if (xIntWrapper.is())
{
convertSelfToCom(xIntWrapper, pVar);
return;
}
}
// Is the object a COM wrapper ( either XInvocation, or Adapter object)
// or does it supply an IDispatch by its own ?
else
{
Reference<XInterface> xIntComWrapper = xInt;
typedef std::unordered_map<sal_uIntPtr,sal_uIntPtr>::iterator IT;
// Adapter? then get the COM wrapper to which the adapter delegates its calls
IT it= AdapterToWrapperMap.find( reinterpret_cast<sal_uIntPtr>(xInt.get()));
if( it != AdapterToWrapperMap.end() )
xIntComWrapper= reinterpret_cast<XInterface*>(it->second);
if (convertSelfToCom(xIntComWrapper, pVar))
return;
}
}
// If we have no UNO wrapper nor the IDispatch yet then we have to create
// a wrapper. For that we need an XInvocation from the UNO object.
// get an XInvocation or create one using the invocation service
Reference<XInvocation> xInv(xInt, UNO_QUERY);
if ( ! xInv.is())
{
Reference<XSingleServiceFactory> xInvFactory= getInvocationFactory(rObj);
if (xInvFactory.is())
{
Sequence<Any> params(1);
params.getArray()[0] = rObj;
Reference<XInterface> xInt2 = xInvFactory->createInstanceWithArguments(params);
xInv.set(xInt2, UNO_QUERY);
}
}
if (xInv.is())
{
Reference<XInterface> xNewWrapper = createUnoWrapperInstance();
Reference<XInitialization> xInitWrapper(xNewWrapper, UNO_QUERY);
if (xInitWrapper.is())
{
VARTYPE vartype= getVarType( rObj);
if (xInt.is())
{
Any params[3];
params[0] <<= xInv;
params[1] <<= xInt;
params[2] <<= vartype;
xInitWrapper->initialize( Sequence<Any>(params, 3));
}
else
{
Any params[2];
params[0] <<= xInv;
params[1] <<= vartype;
xInitWrapper->initialize( Sequence<Any>(params, 2));
}
// put the newly created object into a map. If the same object will
// be mapped again and there is already a wrapper then the old wrapper
// will be used.
if(xInt.is()) // only interfaces
UnoObjToWrapperMap[reinterpret_cast<sal_uIntPtr>(xInt.get())]= xNewWrapper;
convertSelfToCom(xNewWrapper, pVar);
return;
}
}
}
template<class T>
void UnoConversionUtilities<T>::variantToAny( const VARIANT* pVariant, Any& rAny,
bool bReduceValueRange /* = sal_True */)
{
HRESULT hr = S_OK;
try
{
CComVariant var;
// There is no need to support indirect values, since they're not supported by UNO
if( FAILED(hr= VariantCopyInd( &var, pVariant))) // remove VT_BYREF
throw BridgeRuntimeError(
"[automation bridge] UnoConversionUtilities<T>::variantToAny \n"
"VariantCopyInd failed for reason : " + OUString::number(hr));
if ( ! convertValueObject( & var, rAny))
{
if ((var.vt & VT_ARRAY) > 0)
{
VARTYPE oleTypeFlags = ::sal::static_int_cast< VARTYPE, int >( var.vt ^ VT_ARRAY );
Sequence<Any> unoSeq = createOleArrayWrapper(var.parray, oleTypeFlags);
rAny.setValue( &unoSeq, cppu::UnoType<decltype(unoSeq)>::get());
}
else
{
switch (var.vt)
{
case VT_EMPTY:
rAny.setValue(nullptr, Type());
break;
case VT_NULL:
rAny.setValue(nullptr, Type());
break;
case VT_I2:
rAny.setValue( & var.iVal, cppu::UnoType<sal_Int16>::get());
break;
case VT_I4:
rAny.setValue( & var.lVal, cppu::UnoType<sal_Int32>::get());
// necessary for use in JavaScript ( see "reduceRange")
if( bReduceValueRange)
reduceRange(rAny);
break;
case VT_R4:
rAny.setValue( & var.fltVal, cppu::UnoType<float>::get());
break;
case VT_R8:
rAny.setValue(& var.dblVal, cppu::UnoType<double>::get());
break;
case VT_CY:
{
Currency cy(var.cyVal.int64);
rAny <<= cy;
break;
}
case VT_DATE:
{
Date d(var.date);
rAny <<= d;
break;
}
case VT_BSTR:
{
OUString b(SAL_U(var.bstrVal));
rAny.setValue( &b, cppu::UnoType<decltype(b)>::get());
break;
}
case VT_UNKNOWN:
case VT_DISPATCH:
{
//check if it is a UNO type
CComQIPtr<IUnoTypeWrapper> spType(static_cast<IUnknown*>(var.byref));
if (spType)
{
CComBSTR sName;
if (FAILED(spType->get_Name(&sName)))
throw BridgeRuntimeError(
"[automation bridge]UnoConversionUtilities<T>::variantToAny \n"
"Failed to get the type name from a UnoTypeWrapper!");
Type type;
if (!getType(sName, type))
{
throw CannotConvertException(
"[automation bridge]UnoConversionUtilities<T>::variantToAny \n"
"A UNO type with the name: " + OUString(SAL_U(LPCOLESTR(sName))) +
"does not exist!",
nullptr, TypeClass_UNKNOWN, FailReason::TYPE_NOT_SUPPORTED,0);
}
rAny <<= type;
}
else
{
rAny = createOleObjectWrapper( & var);
}
break;
}
case VT_ERROR:
{
SCode scode(var.scode);
rAny <<= scode;
break;
}
case VT_BOOL:
{
rAny <<= (var.boolVal == VARIANT_TRUE);
break;
}
case VT_I1:
rAny.setValue( & var.cVal, cppu::UnoType<sal_Int8>::get());
break;
case VT_UI1: // there is no unsigned char in UNO
rAny <<= sal_Int8(var.bVal);
break;
case VT_UI2:
rAny.setValue( & var.uiVal, cppu::UnoType<cppu::UnoUnsignedShortType>::get() );
break;
case VT_UI4:
rAny.setValue( & var.ulVal, cppu::UnoType<sal_uInt32>::get());
break;
case VT_INT:
rAny.setValue( & var.intVal, cppu::UnoType<sal_Int32>::get());
break;
case VT_UINT:
rAny.setValue( & var.uintVal, cppu::UnoType<sal_uInt32>::get());
break;
case VT_VOID:
rAny.setValue( nullptr, Type());
break;
case VT_DECIMAL:
{
Decimal dec;
dec.Scale = var.decVal.scale;
dec.Sign = var.decVal.sign;
dec.LowValue = var.decVal.Lo32;
dec.MiddleValue = var.decVal.Mid32;
dec.HighValue = var.decVal.Hi32;
rAny <<= dec;
break;
}
default:
break;
}
}
}
}
catch (const IllegalArgumentException &)
{
throw;
}
catch (const CannotConvertException &)
{
throw;
}
catch (const BridgeRuntimeError &)
{
throw;
}
catch (const Exception & e)
{
throw BridgeRuntimeError("[automation bridge] unexpected exception in "
"UnoConversionUtilities<T>::variantToAny ! Message : \n" +
e.Message);
}
catch(...)
{
throw BridgeRuntimeError(
"[automation bridge] unexpected exception in "
"UnoConversionUtilities<T>::variantToAny !");
}
}
// The function converts an IUnknown* into an UNO interface or struct. The
// IUnknown pointer can constitute different kind of objects:
// 1. a wrapper of an UNO struct (the wrapper was created by this bridge)
// 2. a wrapper of an UNO interface (created by this bridge)
// 3. a dispatch object that implements UNO interfaces
// 4. a dispatch object.
// If the parameter "aType" has a value then the COM object ( pUnknown) is supposed to
// implement the interface described by "aType". Moreover it ( pUnknown) can implement
// several other
// UNO interfaces in which case it has to support the SUPPORTED_INTERFACES_PROP (see
// #define) property. That property contains all names of interfaces.
// "pUnknown" is wrapped by a COM wrapper object that implements XInvocation, e.g.
// IUnknownWrapper_Impl. Additionally an object of type "aType" is created by help
// of the INTERFACE_ADAPTER_FACTORY (see #define) service. The implementation of
// "aType" calls on the COM wrapper's XInvocation::invoke. If the COM object supports
// more than one UNO interfaces, as can be determined by the property
// SUPPORTED_INTERFACES_PROP, then the INTERFACE_ADAPTER_FACTORY creates an object that
// implements all these interfaces.
// This is only done if "pUnknown" is not already a UNO wrapper,
// that is it is actually NOT an UNO object that was converted to a COM object. If it is an
// UNO wrapper than the original UNO object is being extracted, queried for "aType" (if
// it is no struct) and returned.
template<class T>
Any UnoConversionUtilities<T>::createOleObjectWrapper(VARIANT* pVar, const Type& aType)
{
//To allow passing "Nothing" in VS 2008 we need to accept VT_EMPTY
if (pVar->vt != VT_UNKNOWN && pVar->vt != VT_DISPATCH && pVar->vt != VT_EMPTY)
throw IllegalArgumentException(
"[automation bridge]UnoConversionUtilities<T>::createOleObjectWrapper \n"
"The VARIANT does not contain an object type! ", nullptr, -1);
MutexGuard guard( getBridgeMutex());
CComPtr<IUnknown> spUnknown;
CComPtr<IDispatch> spDispatch;
if (pVar->vt == VT_UNKNOWN)
{
spUnknown = pVar->punkVal;
if (spUnknown)
spUnknown.QueryInterface( & spDispatch.p);
}
else if (pVar->vt == VT_DISPATCH && pVar->pdispVal != nullptr)
{
CComPtr<IDispatch> spDispatch2(pVar->pdispVal);
if (spDispatch2)
spDispatch2.QueryInterface( & spUnknown.p);
}
static Type VOID_TYPE= Type();
Any ret;
//If no Type is provided and pVar contains IUnknown then we return a XInterface.
//If pVar contains an IDispatch then we return a XInvocation.
Type desiredType = aType;
if (aType == VOID_TYPE)
{
switch (pVar->vt)
{
case VT_EMPTY:
case VT_UNKNOWN:
desiredType = cppu::UnoType<XInterface>::get();
break;
case VT_DISPATCH:
desiredType = cppu::UnoType<XInvocation>::get();
break;
default:
desiredType = aType;
}
}
// COM pointer are NULL, no wrapper required
if (spUnknown == nullptr)
{
Reference<XInterface> xInt;
if( aType.getTypeClass() == TypeClass_INTERFACE)
ret.setValue( &xInt, aType);
else if( aType.getTypeClass() == TypeClass_STRUCT)
ret.setValue( nullptr, aType);
else
ret <<= xInt;
return ret;
}
// Check if "spUnknown" is a UNO wrapper, that is an UNO object that has been
// passed to COM. Then it supports IUnoObjectWrapper
// and we extract the original UNO object.
CComQIPtr<IUnoObjectWrapper> spUno( spUnknown);
if( spUno)
{ // it is a wrapper
Reference<XInterface> xInt;
if( SUCCEEDED( spUno->getOriginalUnoObject( &xInt)))
{
ret <<= xInt;
}
else
{
Any any;
if( SUCCEEDED( spUno->getOriginalUnoStruct(&any)))
ret= any;
}
return ret;
}
// "spUnknown" is a real COM object.
// Before we create a new wrapper object we check if there is an existing wrapper
// There can be two kinds of wrappers, those who wrap dispatch - UNO objects, and those who
// wrap ordinary dispatch objects. The dispatch-UNO objects usually are adapted to represent
// particular UNO interfaces.
Reference<XInterface> xIntWrapper;
CIT_Com cit_currWrapper= ComPtrToWrapperMap.find( reinterpret_cast<sal_uIntPtr>(spUnknown.p));
if(cit_currWrapper != ComPtrToWrapperMap.end())
xIntWrapper = cit_currWrapper->second;
if (xIntWrapper.is())
{
//Try to find an adapter for the wrapper
//find the proper Adapter. The pointer in the WrapperToAdapterMap are valid as long as
//we get a pointer to the wrapper from ComPtrToWrapperMap, because the Adapter hold references
//to the wrapper.
CIT_Wrap it = WrapperToAdapterMap.find(reinterpret_cast<sal_uIntPtr>(xIntWrapper.get()));
if (it == WrapperToAdapterMap.end())
{
// No adapter available.
//The COM component could be a UNO object. Then we need to provide
// a proxy that implements all interfaces
Sequence<Type> seqTypes= getImplementedInterfaces(spUnknown);
Reference<XInterface> xIntAdapter;
if (seqTypes.getLength() > 0)
{
//It is a COM UNO object
xIntAdapter = createAdapter(seqTypes, xIntWrapper);
}
else
{
// Some ordinary COM object
xIntAdapter = xIntWrapper;
}
// return the wrapper directly, return XInterface or XInvocation
ret = xIntWrapper->queryInterface(desiredType);
if ( ! ret.hasValue())
throw IllegalArgumentException(
"[automation bridge]UnoConversionUtilities<T>::createOleObjectWrapper \n"
"The COM object is not suitable for the UNO type: " +
desiredType.getTypeName(), nullptr, -1);
}
else
{
//There is an adapter available
Reference<XInterface> xIntAdapter(reinterpret_cast<XInterface*>(it->second));
ret = xIntAdapter->queryInterface( desiredType);
if ( ! ret.hasValue())
throw IllegalArgumentException(
"[automation bridge]UnoConversionUtilities<T>::createOleObjectWrapper \n"
"The COM object is not suitable for the UNO type: " +
desiredType.getTypeName(), nullptr, -1);
}
return ret;
}
// No existing wrapper. Therefore create a new proxy.
// If the object implements UNO interfaces then get the types.
Sequence<Type> seqTypes = getImplementedInterfaces(spUnknown);
if (seqTypes.getLength() == 0 &&
aType != VOID_TYPE && aType != cppu::UnoType<XInvocation>::get())
{
seqTypes = Sequence<Type>( & aType, 1);
}
//There is no existing wrapper, therefore we create one for the real COM object
Reference<XInterface> xIntNewProxy= createComWrapperInstance();
if ( ! xIntNewProxy.is())
throw BridgeRuntimeError(
"[automation bridge]UnoConversionUtilities<T>::createOleObjectWrapper \n"
"Could not create proxy object for COM object!");
// initialize the COM wrapper
Reference<XInitialization> xInit( xIntNewProxy, UNO_QUERY);
OSL_ASSERT( xInit.is());
Any params[3];
params[0] <<= reinterpret_cast<sal_uIntPtr>(spUnknown.p);
params[1] <<= (pVar->vt == VT_DISPATCH);
params[2] <<= seqTypes;
xInit->initialize( Sequence<Any>( params, 3));
ComPtrToWrapperMap[reinterpret_cast<sal_uInt64>(spUnknown.p)] = xIntNewProxy;
// we have a wrapper object
//The wrapper implements already XInvocation and XInterface. If
//param aType is void then the object is supposed to have XInvocation.
if (aType == cppu::UnoType<XInvocation>::get()||
(aType == VOID_TYPE && seqTypes.getLength() == 0 ))
{
ret = xIntNewProxy->queryInterface(desiredType);
}
else
{
Reference<XInterface> xIntAdapter =
createAdapter(seqTypes, xIntNewProxy);
ret = xIntAdapter->queryInterface(desiredType);
}
return ret;
}
template<class T>
Reference<XInterface> UnoConversionUtilities<T>::createAdapter(const Sequence<Type>& seqTypes,
const Reference<XInterface>& receiver)
{
Reference< XInterface> xIntAdapterFac;
xIntAdapterFac= m_smgr->createInstance(INTERFACE_ADAPTER_FACTORY);
// We create an adapter object that does not only implement the required type but also
// all types that the COM object pretends to implement. An COM object must therefore
// support the property "_implementedInterfaces".
Reference<XInterface> xIntAdapted;
Reference<XInvocation> xInv(receiver, UNO_QUERY);
Reference<XInvocationAdapterFactory2> xAdapterFac( xIntAdapterFac, UNO_QUERY);
if( xAdapterFac.is())
xIntAdapted= xAdapterFac->createAdapter( xInv, seqTypes);
if( xIntAdapted.is())
{
// Put the pointer to the wrapper object and the interface pointer of the adapted interface
// in a global map. Thus we can determine in a call to createUnoObjectWrapper whether the UNO
// object is a wrapped COM object. In that case we extract the original COM object rather than
// creating a wrapper around the UNO object.
typedef std::unordered_map<sal_uInt64,sal_uInt64>::value_type VALUE;
AdapterToWrapperMap.insert( VALUE( reinterpret_cast<sal_uInt64>(xIntAdapted.get()), reinterpret_cast<sal_uInt64>(receiver.get())));
WrapperToAdapterMap.insert( VALUE( reinterpret_cast<sal_uInt64>(receiver.get()), reinterpret_cast<sal_uInt64>(xIntAdapted.get())));
}
else
{
throw BridgeRuntimeError(
"[automation bridge]UnoConversionUtilities<T>::createOleObjectWrapper \n"
"Could not create a proxy for COM object! Creation of adapter failed.");
}
return xIntAdapted;
}
// "convertValueObject" converts a JScriptValue object contained in "var" into
// an any. The type contained in the any is stipulated by a "type value" thas
// was set within the JScript script on the value object ( see JScriptValue).
template<class T>
bool UnoConversionUtilities<T>::convertValueObject( const VARIANTARG *var, Any& any)
{
bool ret = false;
try
{
bool bFail = false;
HRESULT hr= S_OK;
CComVariant varDisp;
if(SUCCEEDED(hr = varDisp.ChangeType( VT_DISPATCH, var)))
{
CComPtr <IJScriptValueObject> spValue;
VARIANT_BOOL varBool;
CComBSTR bstrType;
CComVariant varValue;
CComPtr<IDispatch> spDisp( varDisp.pdispVal);
if(spDisp)
{
if(SUCCEEDED( spDisp->QueryInterface( __uuidof( IJScriptValueObject),
reinterpret_cast<void**> (&spValue))))
{
ret = true; // is a ValueObject
//If it is an out - param then it does not need to be converted. In/out and
// in params does so.
if (SUCCEEDED(hr= spValue->IsOutParam( &varBool)))
{
// if varBool == true then no conversion needed because out param
if (varBool == VARIANT_FALSE)
{
if(SUCCEEDED(hr = spValue->GetValue( & bstrType, & varValue)))
{
Type type;
if (getType(bstrType, type))
variantToAny( & varValue, any, type);
else
bFail = true;
}
else
bFail = true;
}
}
else
bFail = true;
}
}
}
else if( hr != DISP_E_TYPEMISMATCH && hr != E_NOINTERFACE)
bFail = true;
if (bFail)
throw BridgeRuntimeError(
"[automation bridge] Conversion of ValueObject failed ");
}
catch (const BridgeRuntimeError &)
{
throw;
}
catch (const Exception & e)
{
throw BridgeRuntimeError("[automation bridge] unexpected exception in "
"UnoConversionUtilities<T>::convertValueObject ! Message : \n" +
e.Message);
}
catch(...)
{
throw BridgeRuntimeError(
"[automation bridge] unexpected exception in "
"UnoConversionUtilities<T>::convertValueObject !");
}
return ret;
}
template<class T>
void UnoConversionUtilities<T>::dispatchExObject2Sequence( const VARIANTARG* pvar, Any& anySeq, const Type& type)
{
try
{
bool bFail = false;
if( pvar->vt != VT_DISPATCH)
throw BridgeRuntimeError("[automation bridge] UnoConversionUtilities<T>::dispatchExObject2Sequence \n"
"Conversion of dispatch object to Sequence failed!");
IDispatchEx* pdispEx;
HRESULT hr;
if( FAILED( hr= pvar->pdispVal->QueryInterface( IID_IDispatchEx,
reinterpret_cast<void**>( &pdispEx))))
throw BridgeRuntimeError("[automation bridge] UnoConversionUtilities<T>::dispatchExObject2Sequence \n"
"Conversion of dispatch object to Sequence failed!");
DISPID dispid;
DISPPARAMS param= {nullptr,nullptr,0,0};
CComVariant result;
OLECHAR const * sLength= L"length";
// Get the length of the array. Can also be obtained through GetNextDispID. The
// method only returns DISPIDs of the array data. Their names are like "0", "1" etc.
if( FAILED( hr= pdispEx->GetIDsOfNames(IID_NULL, const_cast<OLECHAR **>(&sLength), 1, LOCALE_USER_DEFAULT, &dispid)))
throw BridgeRuntimeError("[automation bridge] UnoConversionUtilities<T>::dispatchExObject2Sequence \n"
"Conversion of dispatch object to Sequence failed!");
if( FAILED( hr= pdispEx->InvokeEx(dispid, LOCALE_USER_DEFAULT, DISPATCH_PROPERTYGET,
¶m, &result, nullptr, nullptr)))
throw BridgeRuntimeError("[automation bridge] UnoConversionUtilities<T>::dispatchExObject2Sequence \n"
"Conversion of dispatch object to Sequence failed!");
if( FAILED( VariantChangeType( &result, &result, 0, VT_I4)))
throw BridgeRuntimeError("[automation bridge] UnoConversionUtilities<T>::dispatchExObject2Sequence \n"
"Conversion of dispatch object to Sequence failed!");
long length= result.lVal;
result.Clear();
// get a few basic facts about the sequence, and reallocate:
// create the Sequences
// get the size of the elements
typelib_TypeDescription *pDesc= nullptr;
type.getDescription( &pDesc);
typelib_IndirectTypeDescription *pSeqDesc= reinterpret_cast<typelib_IndirectTypeDescription*>(pDesc);
typelib_TypeDescriptionReference *pSeqElemDescRef= pSeqDesc->pType; // type of the Sequence' elements
Type elemType( pSeqElemDescRef);
_typelib_TypeDescription* pSeqElemDesc=nullptr;
TYPELIB_DANGER_GET( &pSeqElemDesc, pSeqElemDescRef);
sal_uInt32 nelementSize= pSeqElemDesc->nSize;
TYPELIB_DANGER_RELEASE( pSeqElemDesc);
uno_Sequence *p_uno_Seq;
uno_sequence_construct( &p_uno_Seq, pDesc, nullptr, length, cpp_acquire);
typelib_TypeClass typeElement= pSeqDesc->pType->eTypeClass;
char *pArray= p_uno_Seq->elements;
// Get All properties in the object, convert their values to the expected type and
// put them into the passed in sequence
for( sal_Int32 i= 0; i< length; i++)
{
OUString ousIndex=OUString::number( i);
OLECHAR* sindex = const_cast<OLECHAR *>(SAL_W(ousIndex.getStr()));
if( FAILED( hr= pdispEx->GetIDsOfNames(IID_NULL, &sindex , 1, LOCALE_USER_DEFAULT, &dispid)))
{
throw BridgeRuntimeError("[automation bridge] UnoConversionUtilities<T>::dispatchExObject2Sequence \n"
"Conversion of dispatch object to Sequence failed!");
}
if( FAILED( hr= pdispEx->InvokeEx(dispid, LOCALE_USER_DEFAULT, DISPATCH_PROPERTYGET,
¶m, &result, nullptr, nullptr)))
{
throw BridgeRuntimeError("[automation bridge] UnoConversionUtilities<T>::dispatchExObject2Sequence \n"
"Conversion of dispatch object to Sequence failed!");
}
// If the result is VT_DISPATCH than the Sequence's element type could be Sequence
// Look that up in the CoreReflection to make clear.
// That requires a recursiv conversion
Any any;
// Destination address within the out-Sequence "anySeq" where to copy the next converted element
void* pDest= pArray + (i * nelementSize);
if( result.vt & VT_DISPATCH && typeElement == typelib_TypeClass_SEQUENCE)
{
variantToAny( &result, any, elemType, false);
// copy the converted VARIANT, that is a Sequence to the Sequence
uno_Sequence * p_unoSeq= *static_cast<uno_Sequence* const *>(any.getValue());
// just copy the pointer of the uno_Sequence
// nelementSize should be 4 !!!!
memcpy( pDest, &p_unoSeq, nelementSize);
osl_atomic_increment( &p_unoSeq->nRefCount);
}
else // Element type is no Sequence -> do one conversion
{
variantToAny( &result, any, elemType, false);
if( typeElement == typelib_TypeClass_ANY)
{
// copy the converted VARIANT to the Sequence
uno_type_assignData( pDest, pSeqElemDescRef , &any, pSeqElemDescRef,cpp_queryInterface,
cpp_acquire, cpp_release);
}
else
{
// type after conversion must be the element type of the sequence
OSL_ENSURE(any.getValueTypeClass() == css::uno::TypeClass(typeElement), "wrong conversion");
uno_type_assignData( pDest, pSeqElemDescRef,const_cast<void*>( any.getValue()), any.getValueTypeRef(),
cpp_queryInterface, cpp_acquire, cpp_release);
}
}
} // else
result.Clear();
anySeq.setValue( &p_uno_Seq, pDesc);
uno_destructData( &p_uno_Seq, pDesc, cpp_release);
typelib_typedescription_release( pDesc);
if (bFail)
throw BridgeRuntimeError(
"[automation bridge] Conversion of ValueObject failed ");
}
catch (const BridgeRuntimeError &)
{
throw;
}
catch (const Exception & e)
{
throw BridgeRuntimeError("[automation bridge] unexpected exception in "
"UnoConversionUtilities<T>::convertValueObject ! Message : \n" +
e.Message);
}
catch(...)
{
throw BridgeRuntimeError(
"[automation bridge] unexpected exception in "
"UnoConversionUtilities<T>::convertValueObject !");
}
}
/* The argument unotype is the type that is expected by the currently called UNO function.
For example: []long, [][]long. If the function calls itself recursively then the element type
is passed on. For example a two dimensional SAFEARRAY of type VT_I4 is to be converted. Then
unotype has to be either void or [][]long. When the function calls itself recursivly then
it passes the element type which is []long.
*/
template<class T>
Sequence<Any> UnoConversionUtilities<T>::createOleArrayWrapperOfDim(SAFEARRAY* pArray,
unsigned int dimCount, unsigned int actDim, long* index, VARTYPE type, const Type& unotype)
{
HRESULT hr= S_OK;
long lBound;
long uBound;
long nCountElements;
SafeArrayGetLBound(pArray, actDim, &lBound);
SafeArrayGetUBound(pArray, actDim, &uBound);
nCountElements= uBound - lBound +1;
Sequence<Any> anySeq(nCountElements);
Any* pUnoArray = anySeq.getArray();
for (index[actDim - 1] = lBound; index[actDim - 1] <= uBound; index[actDim - 1]++)
{
if (actDim > 1 )
{
Sequence<Any> element = createOleArrayWrapperOfDim(pArray, dimCount,
actDim - 1, index, type, getElementTypeOfSequence(unotype));
pUnoArray[index[actDim - 1] - lBound].setValue(&element, cppu::UnoType<decltype(element)>::get());
}
else
{
VARIANT variant;
VariantInit(&variant);
V_VT(&variant) = type;
switch (type)
{
case VT_I2:
SafeArrayGetElement(pArray, index, &V_I2(&variant));
break;
case VT_I4:
SafeArrayGetElement(pArray, index, &V_I4(&variant));
break;
case VT_R4:
SafeArrayGetElement(pArray, index, &V_R4(&variant));
break;
case VT_R8:
SafeArrayGetElement(pArray, index, &V_R8(&variant));
break;
case VT_CY:
SafeArrayGetElement(pArray, index, &V_CY(&variant));
break;
case VT_DATE:
SafeArrayGetElement(pArray, index, &V_DATE(&variant));
break;
case VT_BSTR:
hr= SafeArrayGetElement(pArray, index, &V_BSTR(&variant));
break;
case VT_DISPATCH:
SafeArrayGetElement(pArray, index, &V_DISPATCH(&variant));
break;
case VT_ERROR:
SafeArrayGetElement(pArray, index, &V_ERROR(&variant));
break;
case VT_BOOL:
SafeArrayGetElement(pArray, index, &V_BOOL(&variant));
break;
case VT_VARIANT:
SafeArrayGetElement(pArray, index, &variant);
break;
case VT_UNKNOWN:
SafeArrayGetElement(pArray, index, &V_UNKNOWN(&variant));
break;
case VT_I1:
SafeArrayGetElement(pArray, index, &V_I1(&variant));
break;
case VT_UI1:
SafeArrayGetElement(pArray, index, &V_UI1(&variant));
break;
case VT_UI2:
SafeArrayGetElement(pArray, index, &V_UI2(&variant));
break;
case VT_UI4:
SafeArrayGetElement(pArray, index, &V_UI4(&variant));
break;
default:
break;
}
if( unotype.getTypeClass() == TypeClass_VOID)
// the function was called without specifying the destination type
variantToAny(&variant, pUnoArray[index[actDim - 1] - lBound], false);
else
variantToAny(&variant, pUnoArray[index[actDim - 1] - lBound],
getElementTypeOfSequence(unotype), false);
VariantClear(&variant);
}
}
return anySeq;
}
template<class T>
Type UnoConversionUtilities<T>::getElementTypeOfSequence( const Type& seqType)
{
Type retValue;
if( seqType.getTypeClass() != TypeClass_VOID)
{
OSL_ASSERT( seqType.getTypeClass() == TypeClass_SEQUENCE);
typelib_TypeDescription* pDescSeq= nullptr;
seqType.getDescription(& pDescSeq);
retValue = Type(reinterpret_cast<typelib_IndirectTypeDescription *>(pDescSeq)->pType);
typelib_typedescription_release(pDescSeq);
}
return retValue;
}
template<class T>
Sequence<Any> UnoConversionUtilities<T>::createOleArrayWrapper(SAFEARRAY* pArray, VARTYPE type, const Type& unoType)
{
sal_uInt32 dim = SafeArrayGetDim(pArray);
Sequence<Any> ret;
if (dim > 0)
{
std::unique_ptr<long[]> sarIndex(new long[dim]);
long * index = sarIndex.get();
for (unsigned int i = 0; i < dim; i++)
{
index[i] = 0;
}
ret = createOleArrayWrapperOfDim(pArray, dim, dim, index, type, unoType);
}
return ret;
}
// If an VARIANT has the type VT_DISPATCH it can either be an JScript Array
// or some other object. This function finds out if it is such an array or
// not. Currently there's no way to make sure it's an array
// so we assume that when the object has a property "0" then it is an Array.
// An JScript has property like "0", "1", "2" etc. which represent the
// value at the corresponding index of the array
template<class T>
bool UnoConversionUtilities<T>::isJScriptArray(const VARIANT* rvar)
{
OSL_ENSURE( rvar->vt == VT_DISPATCH, "param is not a VT_DISPATCH");
HRESULT hr;
OLECHAR const * sindex= L"0";
DISPID id;
if ( rvar->vt == VT_DISPATCH && rvar->pdispVal )
{
hr= rvar->pdispVal->GetIDsOfNames(
IID_NULL, const_cast<OLECHAR **>(&sindex), 1, LOCALE_USER_DEFAULT,
&id);
if( SUCCEEDED ( hr) )
return true;
}
return false;
}
template<class T>
VARTYPE UnoConversionUtilities<T>::mapTypeClassToVartype( TypeClass type)
{
VARTYPE ret;
switch( type)
{
case TypeClass_INTERFACE: ret= VT_DISPATCH;
break;
case TypeClass_STRUCT: ret= VT_DISPATCH;
break;
case TypeClass_ENUM: ret= VT_I4;
break;
case TypeClass_SEQUENCE: ret= VT_ARRAY;
break;
case TypeClass_ANY: ret= VT_VARIANT;
break;
case TypeClass_BOOLEAN: ret= VT_BOOL;
break;
case TypeClass_CHAR: ret= VT_I2;
break;
case TypeClass_STRING: ret= VT_BSTR;
break;
case TypeClass_FLOAT: ret= VT_R4;
break;
case TypeClass_DOUBLE: ret= VT_R8;
break;
case TypeClass_BYTE: ret= VT_UI1;
break;
case TypeClass_SHORT: ret= VT_I2;
break;
case TypeClass_LONG: ret= VT_I4;
break;
case TypeClass_UNSIGNED_SHORT: ret= VT_UI2;
break;
case TypeClass_UNSIGNED_LONG: ret= VT_UI4;
break;
default:
ret= VT_EMPTY;
}
return ret;
}
template<class T>
Sequence<Type> UnoConversionUtilities<T>::getImplementedInterfaces(IUnknown* pUnk)
{
Sequence<Type> seqTypes;
CComDispatchDriver disp( pUnk);
if( disp)
{
CComVariant var;
HRESULT hr= S_OK;
// There are two different property names possible.
if( FAILED( hr= disp.GetPropertyByName( SUPPORTED_INTERFACES_PROP, &var)))
{
hr= disp.GetPropertyByName( SUPPORTED_INTERFACES_PROP2, &var);
}
if (SUCCEEDED( hr))
{
// we exspect an array( SafeArray or IDispatch) of Strings.
Any anyNames;
variantToAny( &var, anyNames, cppu::UnoType<Sequence<Any>>::get());
Sequence<Any> seqAny;
if( anyNames >>= seqAny)
{
seqTypes.realloc( seqAny.getLength());
for( sal_Int32 i=0; i < seqAny.getLength(); i++)
{
OUString typeName;
seqAny[i] >>= typeName;
seqTypes[i]= Type( TypeClass_INTERFACE, typeName);
}
}
}
}
return seqTypes;
}
template<class T>
Reference<XTypeConverter> UnoConversionUtilities<T>::getTypeConverter()
{
if ( ! m_typeConverter.is())
{
MutexGuard guard(getBridgeMutex());
if ( ! m_typeConverter.is())
{
Reference<XInterface> xIntConverter =
m_smgr->createInstance("com.sun.star.script.Converter");
if (xIntConverter.is())
m_typeConverter.set(xIntConverter, UNO_QUERY);
}
}
return m_typeConverter;
}
// This function tries to the change the type of a value (contained in the Any)
// to the smallest possible that can hold the value. This is actually done only
// for types of VT_I4 (see o2u_variantToAny). The reason is the following:
// JavaScript passes integer values always as VT_I4. If there is a parameter or
// property of type any then the bridge converts the any's content according
// to "o2u_variantToAny". Because the VARTYPE is VT_I4 the value would be converted
// to TypeClass_LONG. Say the method XPropertySet::setPropertyValue( string name, any value)
// would be called on an object and the property actually is of TypeClass_SHORT.
// After conversion of the VARIANT parameter the Any would contain type
// TypeClass_LONG. Because the corereflection does not cast from long to short
// the "setPropertValue" would fail as the value has not the right type.
// The corereflection does convert small integer types to bigger types.
// Therefore we can reduce the type if possible and avoid the above mentioned
// problem.
// The function is not used when elements are to be converted for Sequences.
inline void reduceRange( Any& any)
{
OSL_ASSERT( any.getValueTypeClass() == TypeClass_LONG);
sal_Int32 value= *o3tl::doAccess<sal_Int32>(any);
if( value <= 0x7f && value >= -0x80)
{// -128 bis 127
sal_Int8 charVal= static_cast<sal_Int8>( value);
any.setValue( &charVal, cppu::UnoType<sal_Int8>::get());
}
else if( value <= 0x7fff && value >= -0x8000)
{// -32768 bis 32767
sal_Int16 shortVal= static_cast<sal_Int16>( value);
any.setValue( &shortVal, cppu::UnoType<sal_Int16>::get());
}
}
} // end namespace
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|