diff options
Diffstat (limited to 'sc/source/filter/inc/xeformula.hxx')
-rw-r--r-- | sc/source/filter/inc/xeformula.hxx | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/sc/source/filter/inc/xeformula.hxx b/sc/source/filter/inc/xeformula.hxx new file mode 100644 index 000000000000..698ca9b0f494 --- /dev/null +++ b/sc/source/filter/inc/xeformula.hxx @@ -0,0 +1,100 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef SC_XEFORMULA_HXX +#define SC_XEFORMULA_HXX + +#include "xlformula.hxx" +#include "xeroot.hxx" +#include <boost/shared_ptr.hpp> + +// External reference log ===================================================== + +/** Log entry for external references in a formula, used i.e. in change tracking. */ +struct XclExpRefLogEntry +{ + const XclExpString* mpUrl; /// URL of the document containing the first sheet. + const XclExpString* mpFirstTab; /// Name of the first sheet. + const XclExpString* mpLastTab; /// Name of the last sheet. + sal_uInt16 mnFirstXclTab; /// Calc index of the first sheet. + sal_uInt16 mnLastXclTab; /// Calc index of the last sheet. + + explicit XclExpRefLogEntry(); +}; + +/** Vector containing a log for all external references in a formula, used i.e. in change tracking. */ +typedef ::std::vector< XclExpRefLogEntry > XclExpRefLog; + +// Formula compiler =========================================================== + +class ScRangeList; +class XclExpFmlaCompImpl; + +/** The formula compiler to create Excel token arrays from Calc token arrays. */ +class XclExpFormulaCompiler : protected XclExpRoot +{ +public: + explicit XclExpFormulaCompiler( const XclExpRoot& rRoot ); + virtual ~XclExpFormulaCompiler(); + + /** Creates and returns the token array of a formula. */ + XclTokenArrayRef CreateFormula( + XclFormulaType eType, const ScTokenArray& rScTokArr, + const ScAddress* pScBasePos = 0, XclExpRefLog* pRefLog = 0 ); + + /** Creates and returns a token array containing a single cell address. */ + XclTokenArrayRef CreateFormula( XclFormulaType eType, const ScAddress& rScPos ); + + /** Creates and returns a token array containing a single cell range address. */ + XclTokenArrayRef CreateFormula( XclFormulaType eType, const ScRange& rScRange ); + + /** Creates and returns the token array for a cell range list. */ + XclTokenArrayRef CreateFormula( XclFormulaType eType, const ScRangeList& rScRanges ); + + /** Creates a single error token containing the passed error code. */ + XclTokenArrayRef CreateErrorFormula( sal_uInt8 nErrCode ); + + /** Creates a single token for a special cell reference. + @descr This is used for array formulas and shared formulas (token tExp), + and multiple operation tables (token tTbl). */ + XclTokenArrayRef CreateSpecialRefFormula( sal_uInt8 nTokenId, const XclAddress& rXclPos ); + + /** Creates a single tNameXR token for a reference to an external name. + @descr This is used i.e. for linked macros in push buttons. */ + XclTokenArrayRef CreateNameXFormula( sal_uInt16 nExtSheet, sal_uInt16 nExtName ); + +private: + typedef boost::shared_ptr< XclExpFmlaCompImpl > XclExpFmlaCompImplRef; + XclExpFmlaCompImplRef mxImpl; +}; + +// ============================================================================ + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |