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