xref: /aoo41x/main/sc/inc/reftokenhelper.hxx (revision 38d50f7b)
1*38d50f7bSAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*38d50f7bSAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*38d50f7bSAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*38d50f7bSAndrew Rist  * distributed with this work for additional information
6*38d50f7bSAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*38d50f7bSAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*38d50f7bSAndrew Rist  * "License"); you may not use this file except in compliance
9*38d50f7bSAndrew Rist  * with the License.  You may obtain a copy of the License at
10*38d50f7bSAndrew Rist  *
11*38d50f7bSAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*38d50f7bSAndrew Rist  *
13*38d50f7bSAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*38d50f7bSAndrew Rist  * software distributed under the License is distributed on an
15*38d50f7bSAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*38d50f7bSAndrew Rist  * KIND, either express or implied.  See the License for the
17*38d50f7bSAndrew Rist  * specific language governing permissions and limitations
18*38d50f7bSAndrew Rist  * under the License.
19*38d50f7bSAndrew Rist  *
20*38d50f7bSAndrew Rist  *************************************************************/
21*38d50f7bSAndrew Rist 
22*38d50f7bSAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef SC_REFTOKENHELPER_HXX
25cdf0e10cSrcweir #define SC_REFTOKENHELPER_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir #include "token.hxx"
28cdf0e10cSrcweir 
29cdf0e10cSrcweir #include <vector>
30cdf0e10cSrcweir 
31cdf0e10cSrcweir namespace rtl {
32cdf0e10cSrcweir     class OUString;
33cdf0e10cSrcweir }
34cdf0e10cSrcweir 
35cdf0e10cSrcweir class ScDocument;
36cdf0e10cSrcweir class ScRange;
37cdf0e10cSrcweir class ScRangeList;
38cdf0e10cSrcweir 
39cdf0e10cSrcweir class ScRefTokenHelper
40cdf0e10cSrcweir {
41cdf0e10cSrcweir private:
42cdf0e10cSrcweir     ScRefTokenHelper();
43cdf0e10cSrcweir     ScRefTokenHelper(const ScRefTokenHelper&);
44cdf0e10cSrcweir     ~ScRefTokenHelper();
45cdf0e10cSrcweir 
46cdf0e10cSrcweir public:
47cdf0e10cSrcweir     /**
48cdf0e10cSrcweir      * Compile an array of reference tokens from a data source range string.
49cdf0e10cSrcweir      * The source range may consist of multiple ranges separated by ';'s.
50cdf0e10cSrcweir      */
51cdf0e10cSrcweir     static void compileRangeRepresentation(
52cdf0e10cSrcweir         ::std::vector<ScSharedTokenRef>& rRefTokens, const ::rtl::OUString& rRangeStr, ScDocument* pDoc,
53cdf0e10cSrcweir         ::formula::FormulaGrammar::Grammar eGrammar = ::formula::FormulaGrammar::GRAM_ENGLISH);
54cdf0e10cSrcweir 
55cdf0e10cSrcweir     static bool getRangeFromToken(ScRange& rRange, const ScSharedTokenRef& pToken, bool bExternal = false);
56cdf0e10cSrcweir 
57cdf0e10cSrcweir     static void getRangeListFromTokens(ScRangeList& rRangeList, const ::std::vector<ScSharedTokenRef>& pTokens);
58cdf0e10cSrcweir 
59cdf0e10cSrcweir     /**
60cdf0e10cSrcweir      * Create a double reference token from a range object.
61cdf0e10cSrcweir      */
62cdf0e10cSrcweir     static void getTokenFromRange(ScSharedTokenRef& pToken, const ScRange& rRange);
63cdf0e10cSrcweir 
64cdf0e10cSrcweir     static void getTokensFromRangeList(::std::vector<ScSharedTokenRef>& pTokens, const ScRangeList& rRanges);
65cdf0e10cSrcweir 
66cdf0e10cSrcweir     static bool SC_DLLPUBLIC isRef(const ScSharedTokenRef& pToken);
67cdf0e10cSrcweir     static bool SC_DLLPUBLIC isExternalRef(const ScSharedTokenRef& pToken);
68cdf0e10cSrcweir 
69cdf0e10cSrcweir     static bool SC_DLLPUBLIC intersects(const ::std::vector<ScSharedTokenRef>& rTokens, const ScSharedTokenRef& pToken);
70cdf0e10cSrcweir 
71cdf0e10cSrcweir     static void SC_DLLPUBLIC join(::std::vector<ScSharedTokenRef>& rTokens, const ScSharedTokenRef& pToken);
72cdf0e10cSrcweir 
73cdf0e10cSrcweir     static bool getDoubleRefDataFromToken(ScComplexRefData& rData, const ScSharedTokenRef& pToken);
74cdf0e10cSrcweir };
75cdf0e10cSrcweir 
76cdf0e10cSrcweir #endif
77