formularesult.hxx

Go to the documentation of this file.

/* -*- 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 "global.hxx"
#include "calcmacros.hxx"
#include <svl/sharedstring.hxx>
#include <formula/token.hxx>
#include <formula/types.hxx>
 
class ScMatrixFormulaCellToken;
 
namespace sc {
 
struct FormulaResultValue
{
    enum Type : sal_uInt8 { Invalid, Value, String, Error };
 
    double mfValue;
    svl::SharedString maString;
    bool mbMultiLine = false;
    Type meType;
    FormulaError mnError;
 
    FormulaResultValue();
    FormulaResultValue( double fValue );
    FormulaResultValue( svl::SharedString aStr, bool bMultiLine );
    FormulaResultValue( FormulaError nErr );
};
 
}
 
class ScFormulaResult
{
    typedef unsigned char Multiline;
    static const Multiline MULTILINE_UNKNOWN = 0;
    static const Multiline MULTILINE_FALSE   = 1;
    static const Multiline MULTILINE_TRUE    = 2;
 
    union
    {
        double          mfValue;    // double result direct for performance and memory consumption
        const formula::FormulaToken*  mpToken;    // if not, result token obtained from interpreter
    };
    bool                mbToken :1; // whether content of union is a token
    bool                mbEmpty :1; // empty cell result
    bool                mbEmptyDisplayedAsString :1;    // only if mbEmpty
    // If set it implies that the result is a simple double (in mfValue) and no error
    bool                mbValueCached :1;
    Multiline           meMultiline :2; // result is multiline
    FormulaError        mnError;    // error code
 
    void ResetToDefaults();
 
    void ResolveToken( const formula::FormulaToken * p );
 
public:
    ScFormulaResult();
 
    ScFormulaResult( const ScFormulaResult & r );
 
    explicit ScFormulaResult( const formula::FormulaToken* p );
 
    ~ScFormulaResult();
 
    ScFormulaResult& operator=( const ScFormulaResult & r );
 
    void Assign( const ScFormulaResult & r );
 
    void SetToken( const formula::FormulaToken* p );
 
    formula::FormulaConstTokenRef GetToken() const;
 
    formula::FormulaConstTokenRef GetCellResultToken() const;
 
    formula::StackVar GetType() const;
 
    formula::StackVar GetCellResultType() const;
 
    bool IsEmptyDisplayedAsString() const;
 
    bool IsValue() const;
 
    bool IsValueNoError() const;
 
    bool IsMultiline() const;
 
    bool GetErrorOrDouble( FormulaError& rErr, double& rVal ) const;
    sc::FormulaResultValue GetResult() const;
 
    FormulaError GetResultError() const;
 
    void SetResultError( FormulaError nErr );
 
    void SetDouble( double f );
 
    double GetDouble() const;
 
    const svl::SharedString & GetString() const;
 
    ScConstMatrixRef GetMatrix() const;
 
    OUString GetHybridFormula() const;
 
    void SetHybridDouble( double f );
 
    void SetHybridString( const svl::SharedString & rStr );
 
    void SetHybridEmptyDisplayedAsString();
 
    void SetHybridFormula( const OUString & rFormula );
 
    void SetMatrix( SCCOL nCols, SCROW nRows, const ScConstMatrixRef& pMat, const formula::FormulaToken* pUL );
 
    const ScMatrixFormulaCellToken* GetMatrixFormulaCellToken() const;
 
    ScMatrixFormulaCellToken* GetMatrixFormulaCellTokenNonConst();
};
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */