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_RANGENAM_HXX
25*b1cdbd2cSJim Jagielski #define SC_RANGENAM_HXX
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski #include "global.hxx" // -> enum UpdateRefMode
28*b1cdbd2cSJim Jagielski #include "address.hxx"
29*b1cdbd2cSJim Jagielski #include "collect.hxx"
30*b1cdbd2cSJim Jagielski #include "formula/grammar.hxx"
31*b1cdbd2cSJim Jagielski #include "scdllapi.h"
32*b1cdbd2cSJim Jagielski
33*b1cdbd2cSJim Jagielski #include <map>
34*b1cdbd2cSJim Jagielski
35*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------
36*b1cdbd2cSJim Jagielski
37*b1cdbd2cSJim Jagielski class ScDocument;
38*b1cdbd2cSJim Jagielski
39*b1cdbd2cSJim Jagielski namespace rtl {
40*b1cdbd2cSJim Jagielski class OUStringBuffer;
41*b1cdbd2cSJim Jagielski }
42*b1cdbd2cSJim Jagielski
43*b1cdbd2cSJim Jagielski
44*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------
45*b1cdbd2cSJim Jagielski
46*b1cdbd2cSJim Jagielski typedef sal_uInt16 RangeType;
47*b1cdbd2cSJim Jagielski
48*b1cdbd2cSJim Jagielski #define RT_NAME ((RangeType)0x0000)
49*b1cdbd2cSJim Jagielski #define RT_DATABASE ((RangeType)0x0001)
50*b1cdbd2cSJim Jagielski #define RT_CRITERIA ((RangeType)0x0002)
51*b1cdbd2cSJim Jagielski #define RT_PRINTAREA ((RangeType)0x0004)
52*b1cdbd2cSJim Jagielski #define RT_COLHEADER ((RangeType)0x0008)
53*b1cdbd2cSJim Jagielski #define RT_ROWHEADER ((RangeType)0x0010)
54*b1cdbd2cSJim Jagielski #define RT_ABSAREA ((RangeType)0x0020)
55*b1cdbd2cSJim Jagielski #define RT_REFAREA ((RangeType)0x0040)
56*b1cdbd2cSJim Jagielski #define RT_ABSPOS ((RangeType)0x0080)
57*b1cdbd2cSJim Jagielski #define RT_SHARED ((RangeType)0x0100)
58*b1cdbd2cSJim Jagielski #define RT_SHAREDMOD ((RangeType)0x0200)
59*b1cdbd2cSJim Jagielski
60*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------
61*b1cdbd2cSJim Jagielski
62*b1cdbd2cSJim Jagielski class ScTokenArray;
63*b1cdbd2cSJim Jagielski
64*b1cdbd2cSJim Jagielski class ScRangeData : public ScDataObject
65*b1cdbd2cSJim Jagielski {
66*b1cdbd2cSJim Jagielski private:
67*b1cdbd2cSJim Jagielski String aName;
68*b1cdbd2cSJim Jagielski String aUpperName; // #i62977# for faster searching (aName is never modified after ctor)
69*b1cdbd2cSJim Jagielski ScTokenArray* pCode;
70*b1cdbd2cSJim Jagielski ScAddress aPos;
71*b1cdbd2cSJim Jagielski RangeType eType;
72*b1cdbd2cSJim Jagielski ScDocument* pDoc;
73*b1cdbd2cSJim Jagielski sal_uInt16 nIndex;
74*b1cdbd2cSJim Jagielski sal_Bool bModified; // wird bei UpdateReference gesetzt/geloescht
75*b1cdbd2cSJim Jagielski
76*b1cdbd2cSJim Jagielski // max row and column to use for wrapping of references. If -1 use the
77*b1cdbd2cSJim Jagielski // application's default.
78*b1cdbd2cSJim Jagielski SCROW mnMaxRow;
79*b1cdbd2cSJim Jagielski SCCOL mnMaxCol;
80*b1cdbd2cSJim Jagielski SCTAB aRangeNameScope; // table index reference as range name scope. 0 - sheet1, 1- sheet2. MAXTABCOUNT - Global
81*b1cdbd2cSJim Jagielski
82*b1cdbd2cSJim Jagielski friend class ScRangeName;
83*b1cdbd2cSJim Jagielski ScRangeData( sal_uInt16 nIndex );
84*b1cdbd2cSJim Jagielski public:
85*b1cdbd2cSJim Jagielski typedef ::std::map<sal_uInt16, sal_uInt16> IndexMap;
86*b1cdbd2cSJim Jagielski
87*b1cdbd2cSJim Jagielski SC_DLLPUBLIC ScRangeData( ScDocument* pDoc,
88*b1cdbd2cSJim Jagielski const String& rName,
89*b1cdbd2cSJim Jagielski const String& rSymbol,
90*b1cdbd2cSJim Jagielski const ScAddress& rAdr = ScAddress(),
91*b1cdbd2cSJim Jagielski RangeType nType = RT_NAME,
92*b1cdbd2cSJim Jagielski const formula::FormulaGrammar::Grammar eGrammar = formula::FormulaGrammar::GRAM_DEFAULT );
93*b1cdbd2cSJim Jagielski SC_DLLPUBLIC ScRangeData( ScDocument* pDoc,
94*b1cdbd2cSJim Jagielski const String& rName,
95*b1cdbd2cSJim Jagielski const ScTokenArray& rArr,
96*b1cdbd2cSJim Jagielski const ScAddress& rAdr = ScAddress(),
97*b1cdbd2cSJim Jagielski RangeType nType = RT_NAME );
98*b1cdbd2cSJim Jagielski SC_DLLPUBLIC ScRangeData( ScDocument* pDoc,
99*b1cdbd2cSJim Jagielski const String& rName,
100*b1cdbd2cSJim Jagielski const ScAddress& rTarget );
101*b1cdbd2cSJim Jagielski // rTarget ist ABSPOS Sprungmarke
102*b1cdbd2cSJim Jagielski ScRangeData(const ScRangeData& rScRangeData);
103*b1cdbd2cSJim Jagielski
104*b1cdbd2cSJim Jagielski SC_DLLPUBLIC virtual ~ScRangeData();
105*b1cdbd2cSJim Jagielski
106*b1cdbd2cSJim Jagielski
107*b1cdbd2cSJim Jagielski virtual ScDataObject* Clone() const;
108*b1cdbd2cSJim Jagielski
109*b1cdbd2cSJim Jagielski sal_Bool operator== (const ScRangeData& rData) const;
110*b1cdbd2cSJim Jagielski
GetName(String & rName) const111*b1cdbd2cSJim Jagielski void GetName( String& rName ) const { rName = aName; }
GetName(void) const112*b1cdbd2cSJim Jagielski const String& GetName( void ) const { return aName; }
GetUpperName(void) const113*b1cdbd2cSJim Jagielski const String& GetUpperName( void ) const { return aUpperName; }
114*b1cdbd2cSJim Jagielski SC_DLLPUBLIC bool SetRangeScope( SCTAB Scope ); // 0 - sheet1, 1 - sheet2, MAXTABCOUNT - global
GetRangeScope() const115*b1cdbd2cSJim Jagielski SCTAB GetRangeScope() const { return aRangeNameScope; }
116*b1cdbd2cSJim Jagielski String GetScopeSheetName( void ) const;
GetPos() const117*b1cdbd2cSJim Jagielski ScAddress GetPos() const { return aPos; }
118*b1cdbd2cSJim Jagielski // Der Index muss eindeutig sein. Ist er 0, wird ein neuer Index vergeben
SetIndex(sal_uInt16 nInd)119*b1cdbd2cSJim Jagielski void SetIndex( sal_uInt16 nInd ) { nIndex = nInd; }
GetIndex() const120*b1cdbd2cSJim Jagielski sal_uInt16 GetIndex() const { return nIndex; }
GetCode()121*b1cdbd2cSJim Jagielski ScTokenArray* GetCode() { return pCode; }
122*b1cdbd2cSJim Jagielski sal_uInt16 GetErrCode();
123*b1cdbd2cSJim Jagielski sal_Bool HasReferences() const;
SetDocument(ScDocument * pDocument)124*b1cdbd2cSJim Jagielski void SetDocument( ScDocument* pDocument){ pDoc = pDocument; }
GetDocument() const125*b1cdbd2cSJim Jagielski ScDocument* GetDocument() const { return pDoc; }
SetType(RangeType nType)126*b1cdbd2cSJim Jagielski void SetType( RangeType nType ) { eType = nType; }
AddType(RangeType nType)127*b1cdbd2cSJim Jagielski void AddType( RangeType nType ) { eType = eType|nType; }
GetType() const128*b1cdbd2cSJim Jagielski RangeType GetType() const { return eType; }
129*b1cdbd2cSJim Jagielski sal_Bool HasType( RangeType nType ) const;
130*b1cdbd2cSJim Jagielski SC_DLLPUBLIC void GetSymbol( String& rSymbol, const formula::FormulaGrammar::Grammar eGrammar = formula::FormulaGrammar::GRAM_DEFAULT ) const;
131*b1cdbd2cSJim Jagielski void UpdateSymbol( rtl::OUStringBuffer& rBuffer, const ScAddress&,
132*b1cdbd2cSJim Jagielski const formula::FormulaGrammar::Grammar eGrammar = formula::FormulaGrammar::GRAM_DEFAULT );
133*b1cdbd2cSJim Jagielski void UpdateReference( UpdateRefMode eUpdateRefMode,
134*b1cdbd2cSJim Jagielski const ScRange& r,
135*b1cdbd2cSJim Jagielski SCsCOL nDx, SCsROW nDy, SCsTAB nDz );
IsModified() const136*b1cdbd2cSJim Jagielski sal_Bool IsModified() const { return bModified; }
137*b1cdbd2cSJim Jagielski
138*b1cdbd2cSJim Jagielski SC_DLLPUBLIC void GuessPosition();
139*b1cdbd2cSJim Jagielski
140*b1cdbd2cSJim Jagielski void UpdateTranspose( const ScRange& rSource, const ScAddress& rDest );
141*b1cdbd2cSJim Jagielski void UpdateGrow( const ScRange& rArea, SCCOL nGrowX, SCROW nGrowY );
142*b1cdbd2cSJim Jagielski
143*b1cdbd2cSJim Jagielski SC_DLLPUBLIC sal_Bool IsReference( ScRange& rRef ) const;
144*b1cdbd2cSJim Jagielski sal_Bool IsReference( ScRange& rRef, const ScAddress& rPos ) const;
145*b1cdbd2cSJim Jagielski sal_Bool IsValidReference( ScRange& rRef ) const;
146*b1cdbd2cSJim Jagielski
147*b1cdbd2cSJim Jagielski //UNUSED2009-05 sal_Bool IsRangeAtCursor( const ScAddress&, sal_Bool bStartOnly ) const;
148*b1cdbd2cSJim Jagielski sal_Bool IsRangeAtBlock( const ScRange& ) const;
149*b1cdbd2cSJim Jagielski
150*b1cdbd2cSJim Jagielski void UpdateTabRef(SCTAB nOldTable, sal_uInt16 nFlag, SCTAB nNewTable);
151*b1cdbd2cSJim Jagielski void TransferTabRef( SCTAB nOldTab, SCTAB nNewTab );
152*b1cdbd2cSJim Jagielski
153*b1cdbd2cSJim Jagielski void ValidateTabRefs();
154*b1cdbd2cSJim Jagielski
155*b1cdbd2cSJim Jagielski void ReplaceRangeNamesInUse( const IndexMap& rMap );
156*b1cdbd2cSJim Jagielski
157*b1cdbd2cSJim Jagielski static void MakeValidName( String& rName );
158*b1cdbd2cSJim Jagielski SC_DLLPUBLIC static sal_Bool IsNameValid( const String& rName, ScDocument* pDoc );
159*b1cdbd2cSJim Jagielski
160*b1cdbd2cSJim Jagielski SC_DLLPUBLIC void SetMaxRow(SCROW nRow);
161*b1cdbd2cSJim Jagielski SCROW GetMaxRow() const;
162*b1cdbd2cSJim Jagielski SC_DLLPUBLIC void SetMaxCol(SCCOL nCol);
163*b1cdbd2cSJim Jagielski SCCOL GetMaxCol() const;
164*b1cdbd2cSJim Jagielski };
165*b1cdbd2cSJim Jagielski
HasType(RangeType nType) const166*b1cdbd2cSJim Jagielski inline sal_Bool ScRangeData::HasType( RangeType nType ) const
167*b1cdbd2cSJim Jagielski {
168*b1cdbd2cSJim Jagielski return ( ( eType & nType ) == nType );
169*b1cdbd2cSJim Jagielski }
170*b1cdbd2cSJim Jagielski
171*b1cdbd2cSJim Jagielski extern "C" int SAL_CALL ScRangeData_QsortNameCompare( const void*, const void* );
172*b1cdbd2cSJim Jagielski
173*b1cdbd2cSJim Jagielski #if defined( ICC ) && defined( OS2 )
ICCQsortNameCompare(const void * a,const void * b)174*b1cdbd2cSJim Jagielski static int _Optlink ICCQsortNameCompare( const void* a, const void* b)
175*b1cdbd2cSJim Jagielski { return ScRangeData_QsortNameCompare(a,b); }
176*b1cdbd2cSJim Jagielski #endif
177*b1cdbd2cSJim Jagielski
178*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------
179*b1cdbd2cSJim Jagielski
180*b1cdbd2cSJim Jagielski class ScRangeName : public ScSortedCollection
181*b1cdbd2cSJim Jagielski {
182*b1cdbd2cSJim Jagielski private:
183*b1cdbd2cSJim Jagielski ScDocument* pDoc;
184*b1cdbd2cSJim Jagielski sal_uInt16 nSharedMaxIndex;
185*b1cdbd2cSJim Jagielski
186*b1cdbd2cSJim Jagielski using ScSortedCollection::Clone; // calcwarnings: shouldn't be used
187*b1cdbd2cSJim Jagielski
188*b1cdbd2cSJim Jagielski public:
ScRangeName(sal_uInt16 nLim=4,sal_uInt16 nDel=4,sal_Bool bDup=sal_False,ScDocument * pDocument=NULL)189*b1cdbd2cSJim Jagielski ScRangeName(sal_uInt16 nLim = 4, sal_uInt16 nDel = 4, sal_Bool bDup = sal_False,
190*b1cdbd2cSJim Jagielski ScDocument* pDocument = NULL) :
191*b1cdbd2cSJim Jagielski ScSortedCollection ( nLim, nDel, bDup ),
192*b1cdbd2cSJim Jagielski pDoc ( pDocument ),
193*b1cdbd2cSJim Jagielski nSharedMaxIndex ( 1 ) {} // darf nicht 0 sein!!
194*b1cdbd2cSJim Jagielski
195*b1cdbd2cSJim Jagielski ScRangeName(const ScRangeName& rScRangeName, ScDocument* pDocument);
196*b1cdbd2cSJim Jagielski
Clone(ScDocument * pDocP) const197*b1cdbd2cSJim Jagielski virtual ScDataObject* Clone(ScDocument* pDocP) const
198*b1cdbd2cSJim Jagielski { return new ScRangeName(*this, pDocP); }
operator [](const sal_uInt16 nIndex) const199*b1cdbd2cSJim Jagielski ScRangeData* operator[]( const sal_uInt16 nIndex) const
200*b1cdbd2cSJim Jagielski { return (ScRangeData*)At(nIndex); }
201*b1cdbd2cSJim Jagielski virtual short Compare(ScDataObject* pKey1, ScDataObject* pKey2) const;
202*b1cdbd2cSJim Jagielski virtual sal_Bool IsEqual(ScDataObject* pKey1, ScDataObject* pKey2) const;
203*b1cdbd2cSJim Jagielski
204*b1cdbd2cSJim Jagielski //UNUSED2009-05 ScRangeData* GetRangeAtCursor( const ScAddress&, sal_Bool bStartOnly ) const;
205*b1cdbd2cSJim Jagielski SC_DLLPUBLIC ScRangeData* GetRangeAtBlock( const ScRange& ) const;
206*b1cdbd2cSJim Jagielski
207*b1cdbd2cSJim Jagielski SC_DLLPUBLIC bool SearchName( const String& rName, sal_uInt16& rPos, SCTAB Scope=MAXTABCOUNT) const;
208*b1cdbd2cSJim Jagielski // SearchNameUpper must be called with an upper-case search string
209*b1cdbd2cSJim Jagielski bool SearchNameUpper( const String& rUpperName, sal_uInt16& rPos, SCTAB Scope=MAXTABCOUNT ) const;
210*b1cdbd2cSJim Jagielski /* added by for scope support */
211*b1cdbd2cSJim Jagielski bool HasRangeinSheetScope( SCTAB Scope );
212*b1cdbd2cSJim Jagielski bool RemoveRangeinScope(SCTAB Scope);
213*b1cdbd2cSJim Jagielski bool CopyRangeinScope(SCTAB oldScope, SCTAB newScope);
214*b1cdbd2cSJim Jagielski /* end add */
215*b1cdbd2cSJim Jagielski void UpdateReference(UpdateRefMode eUpdateRefMode,
216*b1cdbd2cSJim Jagielski const ScRange& rRange,
217*b1cdbd2cSJim Jagielski SCsCOL nDx, SCsROW nDy, SCsTAB nDz );
218*b1cdbd2cSJim Jagielski void UpdateTabRef(SCTAB nTable, sal_uInt16 nFlag, SCTAB nNewTable = 0);
219*b1cdbd2cSJim Jagielski void UpdateTranspose( const ScRange& rSource, const ScAddress& rDest );
220*b1cdbd2cSJim Jagielski void UpdateGrow( const ScRange& rArea, SCCOL nGrowX, SCROW nGrowY );
221*b1cdbd2cSJim Jagielski virtual sal_Bool Insert(ScDataObject* pScDataObject);
222*b1cdbd2cSJim Jagielski SC_DLLPUBLIC ScRangeData* FindIndex(sal_uInt16 nIndex);
GetSharedMaxIndex()223*b1cdbd2cSJim Jagielski sal_uInt16 GetSharedMaxIndex() { return nSharedMaxIndex; }
SetSharedMaxIndex(sal_uInt16 nInd)224*b1cdbd2cSJim Jagielski void SetSharedMaxIndex(sal_uInt16 nInd) { nSharedMaxIndex = nInd; }
225*b1cdbd2cSJim Jagielski sal_uInt16 GetEntryIndex();
226*b1cdbd2cSJim Jagielski };
227*b1cdbd2cSJim Jagielski
228*b1cdbd2cSJim Jagielski #endif
229*b1cdbd2cSJim Jagielski
230