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
|
/* -*- 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_SC_INC_FUNCDESC_HXX
#define INCLUDED_SC_INC_FUNCDESC_HXX
/* Function descriptions for function wizard / autopilot */
#include "scfuncs.hrc"
#include <formula/IFunctionDescription.hxx>
#include <sal/types.h>
#include <rtl/ustring.hxx>
#include <map>
#define MAX_FUNCCAT 12 /* maximum number of categories for functions */
#define LRU_MAX 10 /* maximal number of last recently used functions */
class ScFuncDesc;
class ScFunctionList;
class ScFunctionCategory;
class ScFunctionMgr;
/**
Stores and generates human readable descriptions for spreadsheet-functions,
e.g.\ functions used in formulas in calc
*/
class ScFuncDesc : public formula::IFunctionDescription
{
public:
ScFuncDesc();
virtual ~ScFuncDesc();
/**
Clears the object
Deletes all objets referenced by the pointers in the class,
sets pointers to NULL, and all numerical variables to 0
*/
void Clear();
/**
Fills a mapping with indexes for non-suppressed arguments
Fills mapping from visible arguments to real arguments, e.g. if of 4
parameters the second one is suppressed {0,2,3}. For VAR_ARGS
parameters only one element is added to the end of the sequence.
@param _rArgumens
Vector, which the indices are written to
*/
virtual void fillVisibleArgumentMapping(::std::vector<sal_uInt16>& _rArguments) const SAL_OVERRIDE ;
/**
Returns the category of the function
@return the category of the function
*/
virtual const formula::IFunctionCategory* getCategory() const SAL_OVERRIDE ;
/**
Returns the description of the function
@return the description of the function, or an empty OUString if there is no description
*/
virtual OUString getDescription() const SAL_OVERRIDE ;
/**
Returns the function signature with parameters from the passed string array.
@return function signature with parameters
*/
virtual OUString getFormula(const ::std::vector< OUString >& _aArguments) const SAL_OVERRIDE ;
/**
Returns the name of the function
@return the name of the function, or an empty OUString if there is no name
*/
virtual OUString getFunctionName() const SAL_OVERRIDE ;
/**
Returns the help id of the function
@return help id of the function
*/
virtual OString getHelpId() const SAL_OVERRIDE ;
/**
Returns number of arguments
@return help id of the function
*/
virtual sal_uInt32 getParameterCount() const SAL_OVERRIDE ;
/**
Returns description of parameter at given position
@param _nPos
Position of the parameter
@return OUString description of the parameter
*/
virtual OUString getParameterDescription(sal_uInt32 _nPos) const SAL_OVERRIDE ;
/**
Returns name of parameter at given position
@param _nPos
Position of the parameter
@return OUString name of the parameter
*/
virtual OUString getParameterName(sal_uInt32 _nPos) const SAL_OVERRIDE ;
/**
Returns list of all parameter names
@return OUString containing separated list of all parameter names
*/
OUString GetParamList() const;
/**
Returns the full function signature
@return OUString of the form "FUNCTIONNAME( parameter list )"
*/
virtual OUString getSignature() const SAL_OVERRIDE ;
/**
Returns the number of non-suppressed arguments
In case there are variable arguments the number of fixed non-suppressed
arguments plus VAR_ARGS, same as for nArgCount (variable arguments can't
be suppressed). The two functions are equal apart from return type and
name.
@return number of non-suppressed arguments
*/
sal_uInt16 GetSuppressedArgCount() const;
virtual sal_Int32 getSuppressedArgumentCount() const SAL_OVERRIDE ;
/**
Requests function data from AddInCollection
Logs error message on failure for debugging purposes
*/
virtual void initArgumentInfo() const SAL_OVERRIDE;
/**
Returns true if parameter at given position is optional
@param _nPos
Position of the parameter
@return true if optional, false if not optional
*/
virtual bool isParameterOptional(sal_uInt32 _nPos) const SAL_OVERRIDE ;
/**
Compares functions by name, respecting special characters
@param a
pointer to first function descriptor
@param b
pointer to second function descriptor
@return "(a < b)"
*/
static bool compareByName(const ScFuncDesc* a, const ScFuncDesc* b);
/**
Stores whether a parameter is optional or suppressed
*/
struct ParameterFlags
{
bool bOptional :1; /**< Parameter is optional */
bool bSuppress :1; /**< Suppress parameter in UI because not implemented yet */
ParameterFlags() : bOptional(false), bSuppress(false) {}
};
OUString *pFuncName; /**< Function name */
OUString *pFuncDesc; /**< Description of function */
std::vector<OUString> maDefArgNames; /**< Parameter name(s) */
std::vector<OUString> maDefArgDescs; /**< Description(s) of parameter(s) */
ParameterFlags *pDefArgFlags; /**< Flags for each parameter */
sal_uInt16 nFIndex; /**< Unique function index */
sal_uInt16 nCategory; /**< Function category */
sal_uInt16 nArgCount; /**< All parameter count, suppressed and unsuppressed */
OString sHelpId; /**< HelpId of function */
bool bIncomplete :1; /**< Incomplete argument info (set for add-in info from configuration) */
bool bHasSuppressedArgs :1; /**< Whether there is any suppressed parameter. */
};
/**
List of spreadsheet functions.
Generated by retrieving functions from resources, AddIns and StarOne AddIns,
and storing these in one linked list. Functions can be retrieved by index and
by iterating through the list, starting at the First element, and retrieving
the Next elements one by one.
The length of the longest function name can be retrieved for easier
processing (i.e printing a function list).
*/
class ScFunctionList
{
public:
ScFunctionList();
~ScFunctionList();
sal_uInt32 GetCount() const
{ return aFunctionList.size(); }
const ScFuncDesc* First();
const ScFuncDesc* Next();
const ScFuncDesc* GetFunction( sal_uInt32 nIndex ) const;
sal_Int32 GetMaxFuncNameLen() const
{ return nMaxFuncNameLen; }
private:
::std::vector<const ScFuncDesc*> aFunctionList; /**< List of functions */
::std::vector<const ScFuncDesc*>::iterator aFunctionListIter; /**< position in function list */
sal_Int32 nMaxFuncNameLen; /**< Length of longest function name */
};
/**
Category of spreadsheet functions.
Contains the name, index and function manager of a category,
as well as a list of functions in the category
*/
class ScFunctionCategory : public formula::IFunctionCategory
{
public:
ScFunctionCategory(::std::vector<const ScFuncDesc*>* _pCategory,sal_uInt32 _nCategory)
: m_pCategory(_pCategory),m_nCategory(_nCategory){}
virtual ~ScFunctionCategory(){}
/**
@return count of functions in this category
*/
virtual sal_uInt32 getCount() const SAL_OVERRIDE;
/**
Gives the _nPos'th function in this category.
@param _nPos
position of function in this category.
@return function at the _nPos position in this category, null if _nPos out of bounds.
*/
virtual const formula::IFunctionDescription* getFunction(sal_uInt32 _nPos) const SAL_OVERRIDE;
/**
@return index number of this category.
*/
virtual sal_uInt32 getNumber() const SAL_OVERRIDE;
virtual OUString getName() const SAL_OVERRIDE;
private:
::std::vector<const ScFuncDesc*>* m_pCategory; /**< list of functions in this category */
mutable OUString m_sName; /**< name of this category */
sal_uInt32 m_nCategory; /**< index number of this category */
};
#define SC_FUNCGROUP_COUNT ID_FUNCTION_GRP_ADDINS
/**
Stores spreadsheet functions in categories, including a cumulative ('All') category and makes them accessible.
*/
class ScFunctionMgr : public formula::IFunctionManager
{
public:
/**
Retrieves all calc functions, generates cumulative ('All') category, and the categories.
The function lists of the categories are sorted by (case insensitive) function name
*/
ScFunctionMgr();
virtual ~ScFunctionMgr();
/**
Returns name of category.
@param _nCategoryNumber
index of category
@return name of the category specified by _nCategoryNumber, empty string if _nCategoryNumber out of bounds
*/
static OUString GetCategoryName(sal_uInt32 _nCategoryNumber );
/**
Returns function by index.
Searches for a function with the function index nFIndex.
@param nFIndex
index of the function
@return pointer to function with the index nFIndex, null if no such function was found.
*/
const ScFuncDesc* Get( sal_uInt16 nFIndex ) const;
/**
Returns the first function in category nCategory.
Selects nCategory as current category and returns first element of this.
@param nCategory
index of requested category
@return pointer to first element in current category, null if nCategory out of bounds
*/
const ScFuncDesc* First( sal_uInt16 nCategory = 0 ) const;
/**
Returns the next function of the current category.
@return pointer to the next function in current category, null if current category not set.
*/
const ScFuncDesc* Next() const;
/**
@return number of categories, not counting the cumulative category ('All')
*/
virtual sal_uInt32 getCount() const SAL_OVERRIDE;
/**
Returns a category.
Returns an IFunctionCategory object for a category specified by nPos.
@param nPos
the index of the category, note that 0 maps to the first category not the cumulative ('All') category.
@return pointer to an IFunctionCategory object, null if nPos out of bounds.
*/
virtual const formula::IFunctionCategory* getCategory(sal_uInt32 nPos) const SAL_OVERRIDE;
/**
Appends the last recently used functions.
Takes the last recently used functions, but maximal LRU_MAX, and appends them to the given vector _rLastRUFunctions.
@param _rLastRUFunctions
a vector of pointer to IFunctionDescription, by reference.
*/
virtual void fillLastRecentlyUsedFunctions(::std::vector< const formula::IFunctionDescription*>& _rLastRUFunctions) const SAL_OVERRIDE;
/**
Maps Etoken to character
Used for retrieving characters for parantheses and separators.
@param _eToken
token for which, the corresponding character is retrieved
@return character
*/
virtual sal_Unicode getSingleToken(const formula::IFunctionManager::EToken _eToken) const SAL_OVERRIDE;
private:
ScFunctionList* pFuncList; /**< list of all calc functions */
std::vector<const ScFuncDesc*>* aCatLists[MAX_FUNCCAT]; /**< array of all categories, 0 is the cumulative ('All') category */
mutable std::map< sal_uInt32, std::shared_ptr<ScFunctionCategory> > m_aCategories; /**< map of category pos to IFunctionCategory */
mutable std::vector<const ScFuncDesc*>::iterator pCurCatListIter; /**< position in current category */
mutable std::vector<const ScFuncDesc*>::iterator pCurCatListEnd; /**< end of current category */
};
#endif // INCLUDED_SC_INC_FUNCDESC_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|