xeformula.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 .
 */

#ifndef INCLUDED_SC_SOURCE_FILTER_INC_XEFORMULA_HXX
#define INCLUDED_SC_SOURCE_FILTER_INC_XEFORMULA_HXX

#include "xlformula.hxx"
#include "xeroot.hxx"
#include <memory>

struct XclAddress;

// External reference log =====================================================

struct XclExpRefLogEntry
{
    const XclExpString* mpUrl;              
    const XclExpString* mpFirstTab;         
    const XclExpString* mpLastTab;          
    sal_uInt16          mnFirstXclTab;      
    sal_uInt16          mnLastXclTab;       

    explicit            XclExpRefLogEntry();
};

typedef ::std::vector< XclExpRefLogEntry > XclExpRefLog;

// Formula compiler ===========================================================

class ScRangeList;
class XclExpFmlaCompImpl;

class XclExpFormulaCompiler : protected XclExpRoot
{
public:
    explicit            XclExpFormulaCompiler( const XclExpRoot& rRoot );
    virtual             ~XclExpFormulaCompiler() override;

    XclTokenArrayRef    CreateFormula(
                            XclFormulaType eType, const ScTokenArray& rScTokArr,
                            const ScAddress* pScBasePos = nullptr, XclExpRefLog* pRefLog = nullptr );

    XclTokenArrayRef    CreateFormula( XclFormulaType eType, const ScAddress& rScPos );

    XclTokenArrayRef    CreateFormula( XclFormulaType eType, const ScRange& rScRange );

    XclTokenArrayRef    CreateFormula( XclFormulaType eType, const ScRangeList& rScRanges );

    XclTokenArrayRef    CreateErrorFormula( sal_uInt8 nErrCode );

    XclTokenArrayRef    CreateSpecialRefFormula( sal_uInt8 nTokenId, const XclAddress& rXclPos );

    XclTokenArrayRef    CreateNameXFormula( sal_uInt16 nExtSheet, sal_uInt16 nExtName );

    bool IsRef2D( const ScSingleRefData& rRefData ) const;
    bool IsRef2D( const ScComplexRefData& rRefData ) const;

private:
    typedef std::shared_ptr< XclExpFmlaCompImpl > XclExpFmlaCompImplRef;
    XclExpFmlaCompImplRef mxImpl;
};

#endif

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