formulaparser.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 <memory>
#include "formulabase.hxx"
 
namespace oox::xls {
 
// formula finalizer ==========================================================
 
class FormulaFinalizer : public OpCodeProvider, protected ApiOpCodes
{
public:
    explicit            FormulaFinalizer( const OpCodeProvider& rOpCodeProv );
 
    ApiTokenSequence    finalizeTokenArray( const ApiTokenSequence& rTokens );
 
protected:
    virtual const FunctionInfo* resolveBadFuncName( const OUString& rTokenData ) const;
 
    virtual OUString resolveDefinedName( sal_Int32 nTokenIndex ) const;
 
private:
    typedef ::std::vector< const ApiToken* > ParameterPosVector;
 
    const FunctionInfo* getFunctionInfo( ApiToken& orFuncToken );
    const FunctionInfo* getExternCallInfo( ApiToken& orFuncToken, const ApiToken& rECToken );
 
    void                processTokens( const ApiToken* pToken, const ApiToken* pTokenEnd );
    const ApiToken*     processParameters( const FunctionInfo& rFuncInfo, const ApiToken* pToken, const ApiToken* pTokenEnd );
 
    bool                isEmptyParameter( const ApiToken* pToken, const ApiToken* pTokenEnd ) const;
    const ApiToken*     getSingleToken( const ApiToken* pToken, const ApiToken* pTokenEnd ) const;
    const ApiToken*     skipParentheses( const ApiToken* pToken, const ApiToken* pTokenEnd ) const;
    const ApiToken*     findParameters( ParameterPosVector& rParams, const ApiToken* pToken, const ApiToken* pTokenEnd ) const;
    void                appendEmptyParameter( const FunctionInfo& rFuncInfo, size_t nParam );
    void                appendCalcOnlyParameter( const FunctionInfo& rFuncInfo, size_t nParam, size_t nParamCount );
    void                appendRequiredParameters( const FunctionInfo& rFuncInfo, size_t nParamCount );
 
    bool                appendFinalToken( const ApiToken& rToken );
 
private:
    ApiTokenVector      maTokens;
};
 
class FormulaParserImpl;
 
class FormulaParser final : public FormulaProcessorBase
{
public:
    explicit            FormulaParser( const WorkbookHelper& rHelper );
    virtual             ~FormulaParser() override;
 
    ApiTokenSequence    importFormula(
                            const ScAddress& rBaseAddr,
                            const OUString& rFormulaString ) const;
 
    ApiTokenSequence    importFormula(
                            const ScAddress& rBaseAddr,
                            FormulaType eType,
                            SequenceInputStream& rStrm ) const;
 
    OUString     importOleTargetLink( std::u16string_view aFormulaString );
 
    OUString     importOleTargetLink( SequenceInputStream& rStrm );
 
    OUString     importMacroName( std::u16string_view aFormulaString );
 
private:
    ::std::unique_ptr< FormulaParserImpl > mxImpl;
};
 
} // namespace oox::xls
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */