1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#pragma once
#include "global.hxx"
#include "address.hxx"
#include <formula/grammar.hxx>
#include "scdllapi.h"
#include "calcmacros.hxx"
#include <memory>
#include <map>
#include <vector>
class ScDocument;
class ScTokenArray;
namespace sc {
struct RefUpdateContext;
struct RefUpdateInsertTabContext;
struct RefUpdateDeleteTabContext;
struct RefUpdateMoveTabContext;
class CompileFormulaContext;
}
class ScRangeData
{
public:
enum class Type //specialization to typed_flags outside of class
{
Name = 0x0000,
Database = 0x0001,
Criteria = 0x0002,
PrintArea = 0x0004,
ColHeader = 0x0008,
RowHeader = 0x0010,
AbsArea = 0x0020,
RefArea = 0x0040,
AbsPos = 0x0080
};
enum class IsNameValidType
{
NAME_VALID,
NAME_INVALID_CELL_REF,
NAME_INVALID_BAD_STRING
};
private:
OUString aName;
OUString aUpperName; // #i62977# for faster searching (aName is never modified after ctor)
OUString maNewName; ///< used for formulas after changing names in the dialog
std::unique_ptr<ScTokenArray>
pCode;
ScAddress aPos;
Type eType;
ScDocument& rDoc;
formula::FormulaGrammar::Grammar eTempGrammar; // needed for unresolved XML compiles
sal_uInt16 nIndex;
bool bModified; // is set/cleared by UpdateReference
void CompileRangeData( const OUString& rSymbol, bool bSetError );
void InitCode();
public:
SC_DLLPUBLIC ScRangeData( ScDocument& rDoc,
const OUString& rName,
const OUString& rSymbol,
const ScAddress& rAdr = ScAddress(),
Type nType = Type::Name,
const formula::FormulaGrammar::Grammar eGrammar = formula::FormulaGrammar::GRAM_DEFAULT );
SC_DLLPUBLIC ScRangeData( ScDocument& rDoc,
const OUString& rName,
const ScTokenArray& rArr,
const ScAddress& rAdr = ScAddress(),
Type nType = Type::Name );
SC_DLLPUBLIC ScRangeData( ScDocument& rDoc,
const OUString& rName,
const ScAddress& rTarget );
// rTarget is ABSPOS jump label
/* Exact copy, not recompiled, no other index (!), nothing... except if
* pDocument or pPos are passed, those values are assigned instead of the
* copies. */
ScRangeData( const ScRangeData& rScRangeData, ScDocument* pDocument = nullptr, const ScAddress* pPos = nullptr );
SC_DLLPUBLIC ~ScRangeData();
bool operator== (const ScRangeData& rData) const;
void GetName( OUString& rName ) const { rName = maNewName.isEmpty() ? aName : maNewName; }
const OUString& GetName() const { return maNewName.isEmpty() ? aName : maNewName; }
const OUString& GetUpperName() const { return aUpperName; }
const ScAddress& GetPos() const { return aPos; }
// The index has to be unique. If index=0 a new index value is assigned.
void SetIndex( sal_uInt16 nInd ) { nIndex = nInd; }
sal_uInt16 GetIndex() const { return nIndex; }
/// Does not change the name, but sets maNewName for formula update after dialog.
void SetNewName( const OUString& rNewName ) { maNewName = rNewName; }
ScTokenArray* GetCode() { return pCode.get(); }
SC_DLLPUBLIC void SetCode( const ScTokenArray& );
const ScTokenArray* GetCode() const { return pCode.get(); }
SC_DLLPUBLIC FormulaError GetErrCode() const;
bool HasReferences() const;
void AddType( Type nType );
Type GetType() const { return eType; }
bool HasType( Type nType ) const;
sal_uInt32 GetUnoType() const;
SC_DLLPUBLIC void GetSymbol( OUString& rSymbol, const formula::FormulaGrammar::Grammar eGrammar = formula::FormulaGrammar::GRAM_DEFAULT ) const;
SC_DLLPUBLIC void GetSymbol( OUString& rSymbol, const ScAddress& rPos, const formula::FormulaGrammar::Grammar eGrammar = formula::FormulaGrammar::GRAM_DEFAULT ) const;
void UpdateSymbol( OUStringBuffer& rBuffer, const ScAddress& );
/**
* @param nLocalTab sheet index where this name belongs, or -1 for global
* name.
*/
void UpdateReference( sc::RefUpdateContext& rCxt, SCTAB nLocalTab );
bool IsModified() const { return bModified; }
SC_DLLPUBLIC void GuessPosition();
void UpdateTranspose( const ScRange& rSource, const ScAddress& rDest );
void UpdateGrow( const ScRange& rArea, SCCOL nGrowX, SCROW nGrowY );
SC_DLLPUBLIC bool IsReference( ScRange& rRef ) const;
bool IsReference( ScRange& rRef, const ScAddress& rPos ) const;
SC_DLLPUBLIC bool IsValidReference( ScRange& rRef ) const;
bool IsRangeAtBlock( const ScRange& ) const;
void UpdateInsertTab( sc::RefUpdateInsertTabContext& rCxt, SCTAB nLocalTab );
void UpdateDeleteTab( sc::RefUpdateDeleteTabContext& rCxt, SCTAB nLocalTab );
void UpdateMoveTab( sc::RefUpdateMoveTabContext& rCxt, SCTAB nLocalTab );
void ValidateTabRefs();
static void MakeValidName( const ScDocument& rDoc, OUString& rName );
SC_DLLPUBLIC static IsNameValidType IsNameValid( const OUString& rName, const ScDocument& rDoc );
void CompileUnresolvedXML( sc::CompileFormulaContext& rCxt );
#if DEBUG_FORMULA_COMPILER
void Dump() const;
#endif
};
namespace o3tl
{
template<> struct typed_flags<ScRangeData::Type> : is_typed_flags<ScRangeData::Type, 0xff> {};
}
inline void ScRangeData::AddType( Type nType )
{
eType = eType|nType;
}
inline bool ScRangeData::HasType( Type nType ) const
{
return ( ( eType & nType ) == nType );
}
extern "C" int ScRangeData_QsortNameCompare( const void*, const void* );
class ScRangeName
{
private:
typedef std::vector<ScRangeData*> IndexDataType;
typedef ::std::map<OUString, std::unique_ptr<ScRangeData>> DataType;
DataType m_Data;
IndexDataType maIndexToData;
public:
/// Map that stores non-managed pointers to ScRangeName instances.
typedef ::std::map<SCTAB, const ScRangeName*> TabNameCopyMap;
typedef DataType::const_iterator const_iterator;
typedef DataType::iterator iterator;
ScRangeName();
SC_DLLPUBLIC ScRangeName(const ScRangeName& r);
SC_DLLPUBLIC const ScRangeData* findByRange(const ScRange& rRange) const;
SC_DLLPUBLIC ScRangeData* findByUpperName(const OUString& rName);
SC_DLLPUBLIC const ScRangeData* findByUpperName(const OUString& rName) const;
SC_DLLPUBLIC ScRangeData* findByIndex(sal_uInt16 i) const;
void UpdateReference( sc::RefUpdateContext& rCxt, SCTAB nLocalTab = -1 );
void UpdateInsertTab( sc::RefUpdateInsertTabContext& rCxt, SCTAB nLocalTab = -1 );
void UpdateDeleteTab( sc::RefUpdateDeleteTabContext& rCxt, SCTAB nLocalTab = -1 );
void UpdateMoveTab( sc::RefUpdateMoveTabContext& rCxt, SCTAB nLocalTab = -1 );
void UpdateTranspose(const ScRange& rSource, const ScAddress& rDest);
void UpdateGrow(const ScRange& rArea, SCCOL nGrowX, SCROW nGrowY);
/** Compile those names that couldn't be resolved during loading and
inserting because they may have referred a name that was inserted later.
*/
void CompileUnresolvedXML( sc::CompileFormulaContext& rCxt );
/** Copy names while copying a sheet if they reference the sheet to be copied.
Assumes that new sheet was already inserted, global names have been
updated/adjusted, but sheet-local names on nOldTab are not, as is the
case in ScDocument::CopyTab()
@param nLocalTab
-1 when operating on global names, else sheet/tab of
sheet-local name scope. The already adjusted tab on which to
find the name.
@param nOldTab
The original unadjusted tab position.
@param nNewTab
The new tab position.
*/
void CopyUsedNames( const SCTAB nLocalTab, const SCTAB nOldTab, const SCTAB nNewTab,
const ScDocument& rOldDoc, ScDocument& rNewDoc, const bool bGlobalNamesToLocal ) const;
SC_DLLPUBLIC const_iterator begin() const;
SC_DLLPUBLIC const_iterator end() const;
SC_DLLPUBLIC iterator begin();
SC_DLLPUBLIC iterator end();
SC_DLLPUBLIC size_t size() const;
SC_DLLPUBLIC size_t index_size() const;
bool empty() const;
/** Insert object into set.
@ATTENTION: The underlying ::std::map<std::unique_ptr>::insert(p) takes
ownership of p and if it can't insert it deletes the object! So, if
this insert here returns false the object where p pointed to is gone!
@param bReuseFreeIndex
If the ScRangeData p points to has an index value of 0:
If `TRUE` then reuse a free index slot if available.
If `FALSE` then assign a new index slot. The Manage Names
dialog uses this so that deleting and adding ranges in the same
run is guaranteed to not reuse previously assigned indexes.
*/
SC_DLLPUBLIC bool insert( ScRangeData* p, bool bReuseFreeIndex = true );
void erase(const ScRangeData& r);
void erase(const OUString& rName);
/**
* Erase by iterator position. Note that this method doesn't check for
* iterator's validity. The caller must make sure that the iterator is
* valid.
*/
void erase(const iterator& itr);
void clear();
bool operator== (const ScRangeName& r) const;
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
