/* -*- 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_SOURCE_FILTER_INC_FORMEL_HXX
#define INCLUDED_SC_SOURCE_FILTER_INC_FORMEL_HXX

#include <compiler.hxx>
#include <global.hxx>

#include "root.hxx"
#include "tokstack.hxx"

#include <memory>
#include <vector>
#include <map>

namespace svl {

class SharedStringPool;

}

class XclImpStream;
class ScTokenArray;
struct ScSingleRefData;
struct ScComplexRefData;

enum ConvErr
{
    ConvOK = 0,
    ConvErrNi,      // unimplemented/unknown opcode occurred
    ConvErrNoMem,   // alloc error
    ConvErrExternal,// excel add-ins are not converted
    ConvErrCount    // did not get all bytes of formula
};

enum FORMULA_TYPE
{
    FT_CellFormula,
    FT_RangeName,
    FT_SharedFormula,
    FT_CondFormat
};

class ScRangeListTabs
{
    typedef ::std::vector<ScRange> RangeListType;
    typedef ::std::map<SCTAB, std::unique_ptr<RangeListType>> TabRangeType;
    TabRangeType m_TabRanges;
    RangeListType::const_iterator maItrCur;
    RangeListType::const_iterator maItrCurEnd;

public:
    ScRangeListTabs ();
    ~ScRangeListTabs();

    void Append( const ScAddress& aSRD, SCTAB nTab );
    void Append( const ScRange& aCRD, SCTAB nTab );

    const ScRange* First ( SCTAB nTab );
    const ScRange* Next ();

    bool HasRanges () const { return !m_TabRanges.empty(); }
};

class ConverterBase
{
protected:
    TokenPool           aPool;          // user token + predefined token
    TokenStack          aStack;
    ScAddress           aEingPos;
    ConvErr             eStatus;
    sal_Char*           pBuffer;        // universal buffer

    ConverterBase( svl::SharedStringPool& rSPool, sal_uInt16 nNewBuffer );
    virtual             ~ConverterBase();

    void                Reset();
};

class ExcelConverterBase : public ConverterBase
{
protected:
    ExcelConverterBase( svl::SharedStringPool& rSPool );
    virtual             ~ExcelConverterBase() override;

public:
    void                Reset();
    void                Reset( const ScAddress& rEingPos );

    virtual ConvErr     Convert( const ScTokenArray*& rpErg, XclImpStream& rStrm, std::size_t nFormulaLen,
                                 bool bAllowArrays, const FORMULA_TYPE eFT = FT_CellFormula ) = 0;
    virtual ConvErr     Convert( ScRangeListTabs&, XclImpStream& rStrm, std::size_t nFormulaLen, SCsTAB nTab,
                                    const FORMULA_TYPE eFT = FT_CellFormula ) = 0;
};

class LotusConverterBase : public ConverterBase
{
protected:
    SvStream&           aIn;
    sal_Int32           nBytesLeft;

    inline void         Ignore( const long nSeekRel );
    inline void         Read( sal_uInt8& nByte );
    inline void         Read( sal_uInt16& nUINT16 );
    inline void         Read( sal_Int16& nINT16 );
    inline void         Read( double& fDouble );
    inline void         Read( sal_uInt32& nUINT32 );

    LotusConverterBase( SvStream& rStr, svl::SharedStringPool& rSPool );
    virtual             ~LotusConverterBase() override;

public:
    void                Reset( const ScAddress& rEingPos );

    virtual void        Convert( const ScTokenArray*& rpErg, sal_Int32& nRest ) = 0;

protected:
    using               ConverterBase::Reset;
};

inline void LotusConverterBase::Ignore( const long nSeekRel )
{
    aIn.SeekRel( nSeekRel );
    nBytesLeft -= nSeekRel;
}

inline void LotusConverterBase::Read( sal_uInt8& nByte )
{
    aIn.ReadUChar( nByte );
    if (aIn.good())
        nBytesLeft--;
    else
    {
        // SvStream::ReadUChar() does not init a single char on failure. This
        // behaviour is even tested in a unit test.
        nByte = 0;
        nBytesLeft = -1;    // bail out early
    }
}

inline void LotusConverterBase::Read( sal_uInt16& nUINT16 )
{
    aIn.ReadUInt16( nUINT16 );
    if (aIn.good())
        nBytesLeft -= 2;
    else
        nBytesLeft = -1;    // bail out early
}

inline void LotusConverterBase::Read( sal_Int16& nINT16 )
{
    aIn.ReadInt16( nINT16 );
    if (aIn.good())
        nBytesLeft -= 2;
    else
        nBytesLeft = -1;    // bail out early
}

inline void LotusConverterBase::Read( double& fDouble )
{
    aIn.ReadDouble( fDouble );
    if (aIn.good())
        nBytesLeft -= 8;
    else
        nBytesLeft = -1;    // bail out early
}

inline void LotusConverterBase::Read( sal_uInt32& nUINT32 )
{
    aIn.ReadUInt32( nUINT32 );
    if (aIn.good())
        nBytesLeft -= 4;
    else
        nBytesLeft = -1;    // bail out early
}

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */