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
|
/* -*- 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 .
*/
#pragma once
#include <memory>
#include <com/sun/star/uno/Any.h>
#include <com/sun/star/uno/Reference.h>
#include <com/sun/star/uno/Sequence.h>
#include <formula/errorcodes.hxx>
#include <i18nlangtag/lang.h>
#include "scdllapi.h"
#include <rtl/ustring.hxx>
#include <tools/long.hxx>
#include "types.hxx"
#include <string_view>
#include <vector>
#include <unordered_map>
namespace com::sun::star::reflection { class XIdlMethod; }
namespace com::sun::star::sheet { class XVolatileResult; }
namespace com::sun::star::uno { class XInterface; }
class SfxObjectShell;
class ScUnoAddInFuncData;
class ScFuncDesc;
class LanguageTag;
class ScDocument;
typedef std::unordered_map< OUString, const ScUnoAddInFuncData* > ScAddInHashMap;
enum ScAddInArgumentType
{
SC_ADDINARG_NONE, ///< -
SC_ADDINARG_INTEGER, ///< long
SC_ADDINARG_DOUBLE, ///< double
SC_ADDINARG_STRING, ///< string
SC_ADDINARG_INTEGER_ARRAY, ///< sequence<sequence<long>>
SC_ADDINARG_DOUBLE_ARRAY, ///< sequence<sequence<double>>
SC_ADDINARG_STRING_ARRAY, ///< sequence<sequence<string>>
SC_ADDINARG_MIXED_ARRAY, ///< sequence<sequence<any>>
SC_ADDINARG_VALUE_OR_ARRAY, ///< any
SC_ADDINARG_CELLRANGE, ///< XCellRange
SC_ADDINARG_CALLER, ///< XPropertySet
SC_ADDINARG_VARARGS ///< sequence<any>
};
struct ScAddInArgDesc
{
OUString aInternalName; ///< used to match configuration and reflection information
OUString aName;
OUString aDescription;
ScAddInArgumentType eType;
bool bOptional;
};
class ScUnoAddInFuncData
{
public:
struct LocalizedName
{
OUString maLocale;
OUString maName;
LocalizedName( const OUString& rLocale, const OUString& rName )
: maLocale( rLocale), maName( rName) { }
};
private:
OUString aOriginalName; ///< kept in formula
OUString aLocalName; ///< for display
OUString aUpperName; ///< for entering formulas
OUString aUpperLocal; ///< for entering formulas
OUString aUpperEnglish; ///< for Function Wizard and tooltips
OUString aDescription;
css::uno::Reference< css::reflection::XIdlMethod> xFunction;
css::uno::Any aObject;
tools::Long nArgCount;
std::unique_ptr<ScAddInArgDesc[]>
pArgDescs;
tools::Long nCallerPos;
sal_uInt16 nCategory;
OString sHelpId;
mutable ::std::vector< LocalizedName > maCompNames;
mutable bool bCompInitialized;
public:
ScUnoAddInFuncData( const OUString& rNam, const OUString& rLoc,
const OUString& rDesc,
sal_uInt16 nCat, const OString&,
const css::uno::Reference< css::reflection::XIdlMethod>& rFunc,
const css::uno::Any& rO,
tools::Long nAC, const ScAddInArgDesc* pAD,
tools::Long nCP );
~ScUnoAddInFuncData();
const OUString& GetOriginalName() const { return aOriginalName; }
const OUString& GetLocalName() const { return aLocalName; }
const OUString& GetUpperName() const { return aUpperName; }
const OUString& GetUpperLocal() const { return aUpperLocal; }
const OUString& GetUpperEnglish() const { return aUpperEnglish; }
const css::uno::Reference< css::reflection::XIdlMethod>& GetFunction() const
{ return xFunction; }
const css::uno::Any& GetObject() const { return aObject; }
tools::Long GetArgumentCount() const { return nArgCount; }
const ScAddInArgDesc* GetArguments() const { return pArgDescs.get(); }
tools::Long GetCallerPos() const { return nCallerPos; }
const OUString& GetDescription() const { return aDescription; }
sal_uInt16 GetCategory() const { return nCategory; }
const OString& GetHelpId() const { return sHelpId; }
const ::std::vector< LocalizedName >& GetCompNames() const;
bool GetExcelName( const LanguageTag& rDestLang, OUString& rRetExcelName,
bool bFallbackToAny = true ) const;
void SetFunction( const css::uno::Reference< css::reflection::XIdlMethod>& rNewFunc,
const css::uno::Any& rNewObj );
void SetArguments( tools::Long nNewCount, const ScAddInArgDesc* pNewDescs );
void SetCallerPos( tools::Long nNewPos );
void SetCompNames( ::std::vector< LocalizedName >&& rNew );
/// Takes care of handling an empty name *after* upper local name was set.
void SetEnglishName( const OUString& rEnglishName );
};
class SC_DLLPUBLIC ScUnoAddInCollection
{
private:
tools::Long nFuncCount;
std::unique_ptr<std::unique_ptr<ScUnoAddInFuncData>[]> ppFuncData;
std::unique_ptr<ScAddInHashMap> pExactHashMap; ///< exact internal name
std::unique_ptr<ScAddInHashMap> pNameHashMap; ///< internal name upper
std::unique_ptr<ScAddInHashMap> pLocalHashMap; ///< localized name upper
std::unique_ptr<ScAddInHashMap> pEnglishHashMap; ///< English name upper
bool bInitialized;
void Initialize();
void ReadConfiguration();
void ReadFromAddIn( const css::uno::Reference< css::uno::XInterface>& xInterface );
void UpdateFromAddIn( const css::uno::Reference< css::uno::XInterface>& xInterface,
std::u16string_view rServiceName );
void LoadComponent( const ScUnoAddInFuncData& rFuncData );
public:
ScUnoAddInCollection();
~ScUnoAddInCollection();
/// User entered name. rUpperName MUST already be upper case!
OUString FindFunction( const OUString& rUpperName, bool bLocalFirst );
/** Only if bComplete is set, the function reference and argument types
are initialized (component may have to be loaded).
@param rName is the exact Name. */
const ScUnoAddInFuncData* GetFuncData( const OUString& rName, bool bComplete = false );
/** For enumeration in ScCompiler::OpCodeMap::getAvailableMappings().
@param nIndex
0 <= nIndex < GetFuncCount()
*/
const ScUnoAddInFuncData* GetFuncData( tools::Long nIndex );
void Clear();
void LocalizeString( OUString& rName ); ///< modify rName - input: exact name
tools::Long GetFuncCount();
bool FillFunctionDesc( tools::Long nFunc, ScFuncDesc& rDesc, bool bEnglishFunctionNames );
static bool FillFunctionDescFromData( const ScUnoAddInFuncData& rFuncData, ScFuncDesc& rDesc,
bool bEnglishFunctionNames );
/// leave rRetExcelName unchanged, if no matching name is found
bool GetExcelName( const OUString& rCalcName, LanguageType eDestLang, OUString& rRetExcelName );
/// leave rRetCalcName unchanged, if no matching name is found
bool GetCalcName( const OUString& rExcelName, OUString& rRetCalcName );
};
class ScUnoAddInCall
{
private:
const ScUnoAddInFuncData* pFuncData;
css::uno::Sequence<css::uno::Any> aArgs;
css::uno::Sequence<css::uno::Any> aVarArg;
css::uno::Reference<css::uno::XInterface> xCaller;
ScDocument& mrDoc;
bool bValidCount;
// result:
FormulaError nErrCode;
bool bHasString;
double fValue;
OUString aString;
ScMatrixRef xMatrix;
css::uno::Reference<css::sheet::XVolatileResult> xVarRes;
void ExecuteCallWithArgs(css::uno::Sequence<css::uno::Any>& rCallArgs);
public:
// exact name
ScUnoAddInCall( ScDocument& rDoc, ScUnoAddInCollection& rColl, const OUString& rName,
tools::Long nParamCount );
~ScUnoAddInCall();
bool NeedsCaller() const;
void SetCaller( const css::uno::Reference<css::uno::XInterface>& rInterface );
void SetCallerFromObjectShell( const SfxObjectShell* pSh );
bool ValidParamCount() { return bValidCount;}
ScAddInArgumentType GetArgType( tools::Long nPos );
void SetParam( tools::Long nPos, const css::uno::Any& rValue );
void ExecuteCall();
void SetResult( const css::uno::Any& rNewRes );
FormulaError GetErrCode() const { return nErrCode; }
bool HasString() const { return bHasString; }
bool HasMatrix() const { return bool(xMatrix); }
bool HasVarRes() const { return xVarRes.is(); }
double GetValue() const { return fValue; }
const OUString& GetString() const { return aString; }
const ScMatrixRef& GetMatrix() const { return xMatrix;}
const css::uno::Reference<css::sheet::XVolatileResult>&
GetVarRes() const { return xVarRes; }
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
