libreoffice/include/formula/paramclass.hxx
Eike Rathke d0ded163d8 Related: tdf#122301 FREQUENCY() with ForceArrayReturn on caller
FREQUENCY() forces its direct caller into array mode, but only for
the immediate subexpression and not for further operators of the
same parameter.

This weird Excel behaviour is stated in

ECMA-376-1:2016 OOXML 18.17.7.127 FREQUENCY
"A call to FREQUENCY shall be an array formula."

somewhat unclear what it actually applies to, but it turned out
that "a call" is indeed *only* THE direct call, see
https://bugs.documentfoundation.org/show_bug.cgi?id=122301#c19

Change-Id: I145d8fe26d75d5af25b987e190bf35f2d2c03ec6
Reviewed-on: https://gerrit.libreoffice.org/66407
Reviewed-by: Eike Rathke <erack@redhat.com>
Tested-by: Jenkins
2019-01-16 11:17:14 +01:00

82 lines
3.5 KiB
C++

/* -*- 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_PARAMCLASS_HXX
#define INCLUDED_FORMULA_PARAMCLASS_HXX
#include <sal/config.h>
#include <sal/types.h>
namespace formula
{
enum ParamClass : sal_uInt8
{
Unknown = 0, // MUST be zero for initialization mechanism!
/** Out of bounds, function doesn't expect that many parameters.
However, not necessarily returned if a module specific definition
for example returns type Value for an unlisted function. */
Bounds,
/** In array formula: single value to be passed. Results in JumpMatrix
being created and multiple calls to function. Functions handling a
formula::svDoubleRef by means of DoubleRefToPosSingleRef() or
PopDoubleRefOrSingleRef() or GetDouble() or GetString() should have
this. */
Value,
/** In array formula: area reference must stay reference. Otherwise
don't care. Functions handling a formula::svDoubleRef by means of
PopDoubleRefOrSingleRef() should not have this. */
Reference,
/** Like Reference but the function accepts also a list of references
(ocUnion svRefList) as one argument AND handles the special case of
an array of references in array mode. Then the resulting argument
for a parameter in JumpMatrix context may be an array of references
which then is to be preferred over a result matrix. This final
behaviour is the opposite of SuppressedReferenceOrForceArray. */
ReferenceOrRefArray,
/** In array formula: convert area reference to array. Function will be
called only once if no Value type is involved. Functions able to
handle a svMatrix parameter but not a formula::svDoubleRef parameter as area
should have this. */
Array,
/** Area reference must be converted to array in any case, and must
also be propagated to subsequent operators and functions being part
of a parameter of this function. */
ForceArray,
/** Area reference is not converted to array, but ForceArray must be
propagated to subsequent operators and functions being part of a
parameter of this function. Used with functions that treat
references separately from arrays, but need the forced array
calculation of parameters that are not references. */
ReferenceOrForceArray,
/** Same as ReferenceOrForceArray but suppressed / not inherited in the
compiler's ForceArray context to indicate that a result of
Reference in JumpMatrix context should use the result matrix
instead of the array of references. Never used as initial parameter
classification. */
SuppressedReferenceOrForceArray,
/** A function return forces the caller into array mode for this one
call, making it behave like it had ForceArray but not propagated to
any further operators in the same parameter. */
ForceArrayReturn
};
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */