summaryrefslogtreecommitdiffstats
path: root/include/formula/funcvarargs.h
blob: 7a1f1e4e7f5fb0e057c9166a1c4541d33400d82a (plain)
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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
 * 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/.
 */

#ifndef INCLUDED_FORMULA_FUNCVARARGS_H
#define INCLUDED_FORMULA_FUNCVARARGS_H

/** Used to indicate a variable number of parameters for the Function Wizard.

    VAR_ARGS if variable number of parameters, or VAR_ARGS+number if number of
    fixed parameters and variable arguments following.

    @see formula::ParaWin
    @see ScFuncDescCore

    @NOTE: the value can't be easily changed. If changed then
    reportdesign/source/ui/misc/FunctionHelper.cxx
    FunctionDescription::getVarArgsStart() has to provide some backward
    compatibility for implicit API stability.
    The new VAR_ARGS value must be significantly greater than the old
    PAIRED_VAR_ARGS (2*VAR_ARGS) value, in fact greater than any used number of
    fixed parameters followed by optional paired parameters.

    @NOTE: also
    reportbuilder/java/org/libreoffice/report/pentaho/StarFunctionDescription.java
    uses a hard coded value in StarFunctionDescription::getArguments() for
    functionDescription.isInfiniteParameterCount() which though looks like it
    could be easily adapted.
 */
#define VAR_ARGS 255

/** Used to indicate a variable number of paired parameters for the Function Wizard.

    PAIRED_VAR_ARGS if variable number of paired parameters, or
    PAIRED_VAR_ARGS+number if number of fixed parameters and variable paired
    arguments following.

    @see VAR_ARGS
 */
#define PAIRED_VAR_ARGS (VAR_ARGS + VAR_ARGS)

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */