xref: /aoo4110/main/sc/inc/reftokenhelper.hxx (revision b1cdbd2c)
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 SC_REFTOKENHELPER_HXX
25*b1cdbd2cSJim Jagielski #define SC_REFTOKENHELPER_HXX
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski #include "token.hxx"
28*b1cdbd2cSJim Jagielski 
29*b1cdbd2cSJim Jagielski #include <vector>
30*b1cdbd2cSJim Jagielski 
31*b1cdbd2cSJim Jagielski namespace rtl {
32*b1cdbd2cSJim Jagielski     class OUString;
33*b1cdbd2cSJim Jagielski }
34*b1cdbd2cSJim Jagielski 
35*b1cdbd2cSJim Jagielski class ScDocument;
36*b1cdbd2cSJim Jagielski class ScRange;
37*b1cdbd2cSJim Jagielski class ScRangeList;
38*b1cdbd2cSJim Jagielski 
39*b1cdbd2cSJim Jagielski class ScRefTokenHelper
40*b1cdbd2cSJim Jagielski {
41*b1cdbd2cSJim Jagielski private:
42*b1cdbd2cSJim Jagielski     ScRefTokenHelper();
43*b1cdbd2cSJim Jagielski     ScRefTokenHelper(const ScRefTokenHelper&);
44*b1cdbd2cSJim Jagielski     ~ScRefTokenHelper();
45*b1cdbd2cSJim Jagielski 
46*b1cdbd2cSJim Jagielski public:
47*b1cdbd2cSJim Jagielski     /**
48*b1cdbd2cSJim Jagielski      * Compile an array of reference tokens from a data source range string.
49*b1cdbd2cSJim Jagielski      * The source range may consist of multiple ranges separated by ';'s.
50*b1cdbd2cSJim Jagielski      */
51*b1cdbd2cSJim Jagielski     static void compileRangeRepresentation(
52*b1cdbd2cSJim Jagielski         ::std::vector<ScSharedTokenRef>& rRefTokens, const ::rtl::OUString& rRangeStr, ScDocument* pDoc,
53*b1cdbd2cSJim Jagielski         ::formula::FormulaGrammar::Grammar eGrammar = ::formula::FormulaGrammar::GRAM_ENGLISH);
54*b1cdbd2cSJim Jagielski 
55*b1cdbd2cSJim Jagielski     static bool getRangeFromToken(ScRange& rRange, const ScSharedTokenRef& pToken, bool bExternal = false);
56*b1cdbd2cSJim Jagielski 
57*b1cdbd2cSJim Jagielski     static void getRangeListFromTokens(ScRangeList& rRangeList, const ::std::vector<ScSharedTokenRef>& pTokens);
58*b1cdbd2cSJim Jagielski 
59*b1cdbd2cSJim Jagielski     /**
60*b1cdbd2cSJim Jagielski      * Create a double reference token from a range object.
61*b1cdbd2cSJim Jagielski      */
62*b1cdbd2cSJim Jagielski     static void getTokenFromRange(ScSharedTokenRef& pToken, const ScRange& rRange);
63*b1cdbd2cSJim Jagielski 
64*b1cdbd2cSJim Jagielski     static void getTokensFromRangeList(::std::vector<ScSharedTokenRef>& pTokens, const ScRangeList& rRanges);
65*b1cdbd2cSJim Jagielski 
66*b1cdbd2cSJim Jagielski     static bool SC_DLLPUBLIC isRef(const ScSharedTokenRef& pToken);
67*b1cdbd2cSJim Jagielski     static bool SC_DLLPUBLIC isExternalRef(const ScSharedTokenRef& pToken);
68*b1cdbd2cSJim Jagielski 
69*b1cdbd2cSJim Jagielski     static bool SC_DLLPUBLIC intersects(const ::std::vector<ScSharedTokenRef>& rTokens, const ScSharedTokenRef& pToken);
70*b1cdbd2cSJim Jagielski 
71*b1cdbd2cSJim Jagielski     static void SC_DLLPUBLIC join(::std::vector<ScSharedTokenRef>& rTokens, const ScSharedTokenRef& pToken);
72*b1cdbd2cSJim Jagielski 
73*b1cdbd2cSJim Jagielski     static bool getDoubleRefDataFromToken(ScComplexRefData& rData, const ScSharedTokenRef& pToken);
74*b1cdbd2cSJim Jagielski };
75*b1cdbd2cSJim Jagielski 
76*b1cdbd2cSJim Jagielski #endif
77