1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef OOX_XLS_FORMULAPARSER_HXX 25*b1cdbd2cSJim Jagielski #define OOX_XLS_FORMULAPARSER_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include "oox/xls/formulabase.hxx" 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski namespace oox { 30*b1cdbd2cSJim Jagielski namespace xls { 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielski // formula finalizer ========================================================== 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski /** A generic formula token array finalizer. 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski After building a formula token array from alien binary file formats, or 37*b1cdbd2cSJim Jagielski parsing an XML formula string using the com.sun.star.sheet.FormulaParser 38*b1cdbd2cSJim Jagielski service, the token array is still not ready to be put into the spreadsheet 39*b1cdbd2cSJim Jagielski document. There may be functions with a wrong number of parameters (missing 40*b1cdbd2cSJim Jagielski but required parameters, or unsupported parameters) or intermediate tokens 41*b1cdbd2cSJim Jagielski used to encode references to macro functions or add-in functions. This 42*b1cdbd2cSJim Jagielski helper processes a passed token array and builds a new compatible token 43*b1cdbd2cSJim Jagielski array. 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski Derived classes may add more functionality by overwriting the virtual 46*b1cdbd2cSJim Jagielski functions. 47*b1cdbd2cSJim Jagielski */ 48*b1cdbd2cSJim Jagielski class FormulaFinalizer : public OpCodeProvider, protected ApiOpCodes 49*b1cdbd2cSJim Jagielski { 50*b1cdbd2cSJim Jagielski public: 51*b1cdbd2cSJim Jagielski explicit FormulaFinalizer( const OpCodeProvider& rOpCodeProv ); 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski /** Finalizes and returns the passed token array. */ 54*b1cdbd2cSJim Jagielski ApiTokenSequence finalizeTokenArray( const ApiTokenSequence& rTokens ); 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski protected: 57*b1cdbd2cSJim Jagielski /** Derived classed may try to find a function info struct from the passed 58*b1cdbd2cSJim Jagielski string extracted from an OPCODE_BAD token. 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski @param rTokenData The string that has been found in an OPCODE_BAD 61*b1cdbd2cSJim Jagielski token preceding the function parentheses. 62*b1cdbd2cSJim Jagielski */ 63*b1cdbd2cSJim Jagielski virtual const FunctionInfo* resolveBadFuncName( const ::rtl::OUString& rTokenData ) const; 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski /** Derived classed may try to find the name of a defined name with the 66*b1cdbd2cSJim Jagielski passed index extracted from an OPCODE_NAME token. 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski @param nTokenIndex The index of the defined name that has been found 69*b1cdbd2cSJim Jagielski in an OPCODE_NAME token preceding the function parentheses. 70*b1cdbd2cSJim Jagielski */ 71*b1cdbd2cSJim Jagielski virtual ::rtl::OUString resolveDefinedName( sal_Int32 nTokenIndex ) const; 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski private: 74*b1cdbd2cSJim Jagielski typedef ::std::vector< const ApiToken* > ParameterPosVector; 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski const FunctionInfo* getFunctionInfo( ApiToken& orFuncToken ); 77*b1cdbd2cSJim Jagielski const FunctionInfo* getExternCallInfo( ApiToken& orFuncToken, const ApiToken& rECToken ); 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski void processTokens( const ApiToken* pToken, const ApiToken* pTokenEnd ); 80*b1cdbd2cSJim Jagielski const ApiToken* processParameters( const FunctionInfo& rFuncInfo, const ApiToken* pToken, const ApiToken* pTokenEnd ); 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski bool isEmptyParameter( const ApiToken* pToken, const ApiToken* pTokenEnd ) const; 83*b1cdbd2cSJim Jagielski const ApiToken* getSingleToken( const ApiToken* pToken, const ApiToken* pTokenEnd ) const; 84*b1cdbd2cSJim Jagielski const ApiToken* skipParentheses( const ApiToken* pToken, const ApiToken* pTokenEnd ) const; 85*b1cdbd2cSJim Jagielski const ApiToken* findParameters( ParameterPosVector& rParams, const ApiToken* pToken, const ApiToken* pTokenEnd ) const; 86*b1cdbd2cSJim Jagielski void appendEmptyParameter( const FunctionInfo& rFuncInfo, size_t nParam ); 87*b1cdbd2cSJim Jagielski void appendCalcOnlyParameter( const FunctionInfo& rFuncInfo, size_t nParam ); 88*b1cdbd2cSJim Jagielski void appendRequiredParameters( const FunctionInfo& rFuncInfo, size_t nParamCount ); 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski bool appendFinalToken( const ApiToken& rToken ); 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski private: 93*b1cdbd2cSJim Jagielski ApiTokenVector maTokens; 94*b1cdbd2cSJim Jagielski }; 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski // ============================================================================ 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski class FormulaParserImpl; 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski /** Import formula parser for OOXML and BIFF filters. 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski This class implements formula import for the OOXML and BIFF filter. One 103*b1cdbd2cSJim Jagielski instance is contained in the global filter data to prevent construction and 104*b1cdbd2cSJim Jagielski destruction of internal buffers for every imported formula. 105*b1cdbd2cSJim Jagielski */ 106*b1cdbd2cSJim Jagielski class FormulaParser : public FormulaProcessorBase 107*b1cdbd2cSJim Jagielski { 108*b1cdbd2cSJim Jagielski public: 109*b1cdbd2cSJim Jagielski explicit FormulaParser( const WorkbookHelper& rHelper ); 110*b1cdbd2cSJim Jagielski virtual ~FormulaParser(); 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski /** Converts an OOXML formula string. */ 113*b1cdbd2cSJim Jagielski ApiTokenSequence importFormula( 114*b1cdbd2cSJim Jagielski const ::com::sun::star::table::CellAddress& rBaseAddr, 115*b1cdbd2cSJim Jagielski const ::rtl::OUString& rFormulaString ) const; 116*b1cdbd2cSJim Jagielski 117*b1cdbd2cSJim Jagielski /** Imports and converts a BIFF12 token array from the passed stream. */ 118*b1cdbd2cSJim Jagielski ApiTokenSequence importFormula( 119*b1cdbd2cSJim Jagielski const ::com::sun::star::table::CellAddress& rBaseAddr, 120*b1cdbd2cSJim Jagielski FormulaType eType, 121*b1cdbd2cSJim Jagielski SequenceInputStream& rStrm ) const; 122*b1cdbd2cSJim Jagielski 123*b1cdbd2cSJim Jagielski /** Imports and converts a BIFF2-BIFF8 token array from the passed stream. 124*b1cdbd2cSJim Jagielski @param pnFmlaSize Size of the token array. If null is passed, reads 125*b1cdbd2cSJim Jagielski it from stream (1 byte in BIFF2, 2 bytes otherwise) first. */ 126*b1cdbd2cSJim Jagielski ApiTokenSequence importFormula( 127*b1cdbd2cSJim Jagielski const ::com::sun::star::table::CellAddress& rBaseAddr, 128*b1cdbd2cSJim Jagielski FormulaType eType, 129*b1cdbd2cSJim Jagielski BiffInputStream& rStrm, 130*b1cdbd2cSJim Jagielski const sal_uInt16* pnFmlaSize = 0 ) const; 131*b1cdbd2cSJim Jagielski 132*b1cdbd2cSJim Jagielski /** Converts the passed Boolean value to a similar formula. */ 133*b1cdbd2cSJim Jagielski ApiTokenSequence convertBoolToFormula( bool bValue ) const; 134*b1cdbd2cSJim Jagielski 135*b1cdbd2cSJim Jagielski /** Converts the passed BIFF error code to a similar formula. */ 136*b1cdbd2cSJim Jagielski ApiTokenSequence convertErrorToFormula( sal_uInt8 nErrorCode ) const; 137*b1cdbd2cSJim Jagielski 138*b1cdbd2cSJim Jagielski /** Converts the passed token index of a defined name to a formula calling that name. */ 139*b1cdbd2cSJim Jagielski ApiTokenSequence convertNameToFormula( sal_Int32 nTokenIndex ) const; 140*b1cdbd2cSJim Jagielski 141*b1cdbd2cSJim Jagielski /** Converts the passed number into a HYPERLINK formula with the passed URL. */ 142*b1cdbd2cSJim Jagielski ApiTokenSequence convertNumberToHyperlink( const ::rtl::OUString& rUrl, double fValue ) const; 143*b1cdbd2cSJim Jagielski 144*b1cdbd2cSJim Jagielski /** Converts the passed XML formula to an OLE link target. */ 145*b1cdbd2cSJim Jagielski ::rtl::OUString importOleTargetLink( const ::rtl::OUString& rFormulaString ); 146*b1cdbd2cSJim Jagielski 147*b1cdbd2cSJim Jagielski /** Imports and converts an OLE link target from the passed stream. */ 148*b1cdbd2cSJim Jagielski ::rtl::OUString importOleTargetLink( SequenceInputStream& rStrm ); 149*b1cdbd2cSJim Jagielski 150*b1cdbd2cSJim Jagielski /** Imports and converts an OLE link target from the passed stream. */ 151*b1cdbd2cSJim Jagielski ::rtl::OUString importOleTargetLink( BiffInputStream& rStrm, const sal_uInt16* pnFmlaSize = 0 ) const; 152*b1cdbd2cSJim Jagielski 153*b1cdbd2cSJim Jagielski /** Converts the passed formula to a macro name for a drawing shape. */ 154*b1cdbd2cSJim Jagielski ::rtl::OUString importMacroName( const ::rtl::OUString& rFormulaString ); 155*b1cdbd2cSJim Jagielski 156*b1cdbd2cSJim Jagielski private: 157*b1cdbd2cSJim Jagielski ::std::auto_ptr< FormulaParserImpl > mxImpl; 158*b1cdbd2cSJim Jagielski }; 159*b1cdbd2cSJim Jagielski 160*b1cdbd2cSJim Jagielski // ============================================================================ 161*b1cdbd2cSJim Jagielski 162*b1cdbd2cSJim Jagielski } // namespace xls 163*b1cdbd2cSJim Jagielski } // namespace oox 164*b1cdbd2cSJim Jagielski 165*b1cdbd2cSJim Jagielski #endif 166