include/formula/funcvarargs.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #ifndef INCLUDED_FORMULA_FUNCVARARGS_H
  11 #define INCLUDED_FORMULA_FUNCVARARGS_H
  12
  13 /** Used to indicate a variable number of parameters for the Function Wizard.
  14
  15     VAR_ARGS if variable number of parameters, or VAR_ARGS+number if number of
  16     fixed parameters and variable arguments following.
  17
  18     @see formula::ParaWin
  19     @see ScFuncDescCore
  20
  21     @NOTE: the value can't be easily changed. If changed then
  22     reportdesign/source/ui/misc/FunctionHelper.cxx
  23     FunctionDescription::getVarArgsStart() has to provide some backward
  24     compatibility for implicit API stability.
  25     The new VAR_ARGS value must be significantly greater than the old
  26     PAIRED_VAR_ARGS (2*VAR_ARGS) value, in fact greater than any used number of
  27     fixed parameters followed by optional paired parameters.
  28
  29     @NOTE: also
  30     reportbuilder/java/org/libreoffice/report/pentaho/StarFunctionDescription.java
  31     uses a hard coded value in StarFunctionDescription::getArguments() for
  32     functionDescription.isInfiniteParameterCount() which though looks like it
  33     could be easily adapted.
  34  */
  35 #define VAR_ARGS            255
  36
  37 /** Used to indicate a variable number of paired parameters for the Function Wizard.
  38
  39     PAIRED_VAR_ARGS if variable number of paired parameters, or
  40     PAIRED_VAR_ARGS+number if number of fixed parameters and variable paired
  41     arguments following.
  42
  43     @see VAR_ARGS
  44  */
  45 #define PAIRED_VAR_ARGS     (VAR_ARGS + VAR_ARGS)
  46
  47 #endif
  48
  49 /* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */