sc/inc/reftokenhelper.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: token.hxx,v $
  10  * $Revision: 1.15.32.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SC_REFTOKENHELPER_HXX
  32 #define SC_REFTOKENHELPER_HXX
  33
  34 #include "token.hxx"
  35
  36 #include <vector>
  37
  38 namespace rtl {
  39     class OUString;
  40 }
  41
  42 class ScDocument;
  43 class ScRange;
  44 class ScRangeList;
  45
  46 class ScRefTokenHelper
  47 {
  48 private:
  49     ScRefTokenHelper();
  50     ScRefTokenHelper(const ScRefTokenHelper&);
  51     ~ScRefTokenHelper();
  52
  53 public:
  54     /**
  55      * Compile an array of reference tokens from a data source range string.
  56      * The source range may consist of multiple ranges separated by ';'s.
  57      */
  58     static void compileRangeRepresentation(
  59         ::std::vector<ScSharedTokenRef>& rRefTokens, const ::rtl::OUString& rRangeStr, ScDocument* pDoc,
  60         ::formula::FormulaGrammar::Grammar eGrammar = ::formula::FormulaGrammar::GRAM_ENGLISH);
  61
  62     static bool getRangeFromToken(ScRange& rRange, const ScSharedTokenRef& pToken, bool bExternal = false);
  63
  64     static void getRangeListFromTokens(ScRangeList& rRangeList, const ::std::vector<ScSharedTokenRef>& pTokens);
  65
  66     /**
  67      * Create a double reference token from a range object.
  68      */
  69     static void getTokenFromRange(ScSharedTokenRef& pToken, const ScRange& rRange);
  70
  71     static void getTokensFromRangeList(::std::vector<ScSharedTokenRef>& pTokens, const ScRangeList& rRanges);
  72
  73     static bool isRef(const ScSharedTokenRef& pToken);
  74     static bool isExternalRef(const ScSharedTokenRef& pToken);
  75
  76     static bool intersects(const ::std::vector<ScSharedTokenRef>& rTokens, const ScSharedTokenRef& pToken);
  77
  78     static void join(::std::vector<ScSharedTokenRef>& rTokens, const ScSharedTokenRef& pToken);
  79
  80     static bool getDoubleRefDataFromToken(ScComplexRefData& rData, const ScSharedTokenRef& pToken);
  81
  82     static ScSharedTokenRef createRefToken(const ScAddress& rAddr);
  83     static ScSharedTokenRef createRefToken(const ScRange& rRange);
  84 };
  85
  86 #endif