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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef SC_DOCITER_HXX
#define SC_DOCITER_HXX
#include "address.hxx"
#include <tools/solar.h>
#include "global.hxx"
#include "scdllapi.h"
class ScDocument;
class ScBaseCell;
class ScPatternAttr;
class ScAttrArray;
class ScAttrIterator;
class ScRange;
class ScDocumentIterator // alle nichtleeren Zellen durchgehen
{
private:
ScDocument* pDoc;
SCTAB nStartTab;
SCTAB nEndTab;
const ScPatternAttr* pDefPattern;
SCCOL nCol;
SCROW nRow;
SCTAB nTab;
ScBaseCell* pCell;
const ScPatternAttr* pPattern;
SCSIZE nColPos;
SCSIZE nAttrPos;
BOOL GetThis();
BOOL GetThisCol();
public:
ScDocumentIterator( ScDocument* pDocument, SCTAB nStartTable, SCTAB nEndTable );
~ScDocumentIterator();
BOOL GetFirst();
BOOL GetNext();
ScBaseCell* GetCell();
const ScPatternAttr* GetPattern();
void GetPos( SCCOL& rCol, SCROW& rRow, SCTAB& rTab );
};
class ScValueIterator // alle Zahlenwerte in einem Bereich durchgehen
{
private:
double fNextValue;
ScDocument* pDoc;
const ScAttrArray* pAttrArray;
ULONG nNumFormat; // fuer CalcAsShown
ULONG nNumFmtIndex;
SCCOL nStartCol;
SCROW nStartRow;
SCTAB nStartTab;
SCCOL nEndCol;
SCROW nEndRow;
SCTAB nEndTab;
SCCOL nCol;
SCROW nRow;
SCTAB nTab;
SCSIZE nColRow;
SCROW nNextRow;
SCROW nAttrEndRow;
short nNumFmtType;
BOOL bNumValid;
BOOL bSubTotal;
BOOL bNextValid;
BOOL bCalcAsShown;
BOOL bTextAsZero;
BOOL GetThis(double& rValue, USHORT& rErr);
public:
//UNUSED2008-05 ScValueIterator(ScDocument* pDocument,
//UNUSED2008-05 SCCOL nSCol, SCROW nSRow, SCTAB nSTab,
//UNUSED2008-05 SCCOL nECol, SCROW nERow, SCTAB nETab,
//UNUSED2008-05 BOOL bSTotal = FALSE, BOOL bTextAsZero = FALSE);
ScValueIterator(ScDocument* pDocument,
const ScRange& rRange, BOOL bSTotal = FALSE,
BOOL bTextAsZero = FALSE );
void GetCurNumFmtInfo( short& nType, ULONG& nIndex );
/// Does NOT reset rValue if no value found!
BOOL GetFirst(double& rValue, USHORT& rErr);
/// Does NOT reset rValue if no value found!
BOOL GetNext(double& rValue, USHORT& rErr)
{
return bNextValid ? ( bNextValid = FALSE, rValue = fNextValue,
rErr = 0, nRow = nNextRow,
++nColRow, bNumValid = FALSE, TRUE )
: ( ++nRow, GetThis(rValue, rErr) );
}
};
class ScQueryValueIterator // alle Zahlenwerte in einem Bereich durchgehen
{
private:
ScQueryParam aParam;
ScDocument* pDoc;
const ScAttrArray* pAttrArray;
ULONG nNumFormat; // fuer CalcAsShown
ULONG nNumFmtIndex;
SCCOL nCol;
SCROW nRow;
SCSIZE nColRow;
SCROW nAttrEndRow;
SCTAB nTab;
short nNumFmtType;
BOOL bCalcAsShown;
BOOL GetThis(double& rValue, USHORT& rErr);
public:
ScQueryValueIterator(ScDocument* pDocument, SCTAB nTable,
const ScQueryParam& aParam);
/// Does NOT reset rValue if no value found!
BOOL GetFirst(double& rValue, USHORT& rErr);
/// Does NOT reset rValue if no value found!
BOOL GetNext(double& rValue, USHORT& rErr);
void GetCurNumFmtInfo( short& nType, ULONG& nIndex )
{ nType = nNumFmtType; nIndex = nNumFmtIndex; }
};
class ScCellIterator // alle Zellen in einem Bereich durchgehen
{ // bei SubTotal aber keine ausgeblendeten und
private: // SubTotalZeilen
ScDocument* pDoc;
SCCOL nStartCol;
SCROW nStartRow;
SCTAB nStartTab;
SCCOL nEndCol;
SCROW nEndRow;
SCTAB nEndTab;
SCCOL nCol;
SCROW nRow;
SCTAB nTab;
SCSIZE nColRow;
BOOL bSubTotal;
ScBaseCell* GetThis();
public:
ScCellIterator(ScDocument* pDocument,
SCCOL nSCol, SCROW nSRow, SCTAB nSTab,
SCCOL nECol, SCROW nERow, SCTAB nETab,
BOOL bSTotal = FALSE);
ScCellIterator(ScDocument* pDocument,
const ScRange& rRange, BOOL bSTotal = FALSE);
ScBaseCell* GetFirst();
ScBaseCell* GetNext();
SCCOL GetCol() const { return nCol; }
SCROW GetRow() const { return nRow; }
SCTAB GetTab() const { return nTab; }
ScAddress GetPos() const { return ScAddress( nCol, nRow, nTab ); }
};
class ScQueryCellIterator // alle nichtleeren Zellen in einem Bereich
{ // durchgehen
enum StopOnMismatchBits
{
nStopOnMismatchDisabled = 0x00,
nStopOnMismatchEnabled = 0x01,
nStopOnMismatchOccured = 0x02,
nStopOnMismatchExecuted = nStopOnMismatchEnabled | nStopOnMismatchOccured
};
enum TestEqualConditionBits
{
nTestEqualConditionDisabled = 0x00,
nTestEqualConditionEnabled = 0x01,
nTestEqualConditionMatched = 0x02,
nTestEqualConditionFulfilled = nTestEqualConditionEnabled | nTestEqualConditionMatched
};
private:
ScQueryParam aParam;
ScDocument* pDoc;
const ScAttrArray* pAttrArray;
ULONG nNumFormat;
SCTAB nTab;
SCCOL nCol;
SCROW nRow;
SCSIZE nColRow;
SCROW nAttrEndRow;
BYTE nStopOnMismatch;
BYTE nTestEqualCondition;
BOOL bAdvanceQuery;
BOOL bIgnoreMismatchOnLeadingStrings;
ScBaseCell* GetThis();
/* Only works if no regular expression is involved, only
searches for rows in one column, and only the first
query entry is considered with simple conditions
SC_LESS_EQUAL (sorted ascending) or SC_GREATER_EQUAL
(sorted descending). Check these things before
invocation! Delivers a starting point, continue with
GetThis() and GetNext() afterwards. Introduced for
FindEqualOrSortedLastInRange()
*/
ScBaseCell* BinarySearch();
public:
ScQueryCellIterator(ScDocument* pDocument, SCTAB nTable,
const ScQueryParam& aParam, BOOL bMod = TRUE);
// fuer bMod = FALSE muss der QueryParam
// weiter aufgefuellt sein (bIsString)
ScBaseCell* GetFirst();
ScBaseCell* GetNext();
SCCOL GetCol() { return nCol; }
SCROW GetRow() { return nRow; }
ULONG GetNumberFormat();
// setzt alle Entry.nField einen weiter, wenn Spalte
// wechselt, fuer ScInterpreter ScHLookup()
void SetAdvanceQueryParamEntryField( BOOL bVal )
{ bAdvanceQuery = bVal; }
void AdvanceQueryParamEntryField();
/** If set, iterator stops on first non-matching cell
content. May be used in SC_LESS_EQUAL queries where a
cell range is assumed to be sorted; stops on first
value being greater than the queried value and
GetFirst()/GetNext() return NULL. StoppedOnMismatch()
returns TRUE then.
However, the iterator's conditions are not set to end
all queries, GetCol() and GetRow() return values for
the non-matching cell, further GetNext() calls may be
executed. */
void SetStopOnMismatch( BOOL bVal )
{
nStopOnMismatch = sal::static_int_cast<BYTE>(bVal ? nStopOnMismatchEnabled :
nStopOnMismatchDisabled);
}
BOOL StoppedOnMismatch() const
{ return nStopOnMismatch == nStopOnMismatchExecuted; }
/** If set, an additional test for SC_EQUAL condition is
executed in ScTable::ValidQuery() if SC_LESS_EQUAL or
SC_GREATER_EQUAL conditions are to be tested. May be
used where a cell range is assumed to be sorted to stop
if an equal match is found. */
void SetTestEqualCondition( BOOL bVal )
{
nTestEqualCondition = sal::static_int_cast<BYTE>(bVal ?
nTestEqualConditionEnabled :
nTestEqualConditionDisabled);
}
BOOL IsEqualConditionFulfilled() const
{ return nTestEqualCondition == nTestEqualConditionFulfilled; }
/** In a range assumed to be sorted find either the last of
a sequence of equal entries or the last being less than
(or greater than) the queried value. Used by the
interpreter for [HV]?LOOKUP() and MATCH(). Column and
row position of the found entry are returned, otherwise
invalid.
@param bSearchForEqualAfterMismatch
Continue searching for an equal entry even if the
last entry matching the range was found, in case
the data is not sorted. Is always done if regular
expressions are involved.
@param bIgnoreMismatchOnLeadingStrings
Normally strings are sorted behind numerical
values. If this parameter is TRUE, the search does
not stop when encountering a string and does not
assume that no values follow anymore.
If querying for a string a mismatch on the first
entry, e.g. column header, is ignored.
@ATTENTION! StopOnMismatch, TestEqualCondition and
the internal IgnoreMismatchOnLeadingStrings and query
params are in an undefined state upon return! The
iterator is not usable anymore except for obtaining the
number format!
*/
BOOL FindEqualOrSortedLastInRange( SCCOL& nFoundCol,
SCROW& nFoundRow, BOOL bSearchForEqualAfterMismatch = FALSE,
BOOL bIgnoreMismatchOnLeadingStrings = TRUE );
};
class ScDocAttrIterator // alle Attribut-Bereiche
{
private:
ScDocument* pDoc;
SCTAB nTab;
SCCOL nEndCol;
SCROW nStartRow;
SCROW nEndRow;
SCCOL nCol;
ScAttrIterator* pColIter;
public:
ScDocAttrIterator(ScDocument* pDocument, SCTAB nTable,
SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2);
~ScDocAttrIterator();
const ScPatternAttr* GetNext( SCCOL& rCol, SCROW& rRow1, SCROW& rRow2 );
};
class ScAttrRectIterator // alle Attribut-Bereiche, auch Bereiche ueber mehrere Spalten
{
private:
ScDocument* pDoc;
SCTAB nTab;
SCCOL nEndCol;
SCROW nStartRow;
SCROW nEndRow;
SCCOL nIterStartCol;
SCCOL nIterEndCol;
ScAttrIterator* pColIter;
public:
ScAttrRectIterator(ScDocument* pDocument, SCTAB nTable,
SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2);
~ScAttrRectIterator();
void DataChanged();
const ScPatternAttr* GetNext( SCCOL& rCol1, SCCOL& rCol2, SCROW& rRow1, SCROW& rRow2 );
};
class ScHorizontalCellIterator // alle nichtleeren Zellen in einem Bereich
{ // zeilenweise durchgehen
private:
ScDocument* pDoc;
SCTAB nTab;
SCCOL nStartCol;
SCCOL nEndCol;
SCROW nEndRow;
SCROW* pNextRows;
SCSIZE* pNextIndices;
SCCOL nCol;
SCROW nRow;
BOOL bMore;
public:
ScHorizontalCellIterator(ScDocument* pDocument, SCTAB nTable,
SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2);
~ScHorizontalCellIterator();
ScBaseCell* GetNext( SCCOL& rCol, SCROW& rRow );
BOOL ReturnNext( SCCOL& rCol, SCROW& rRow );
private:
void Advance();
};
//
// gibt alle Bereiche mit nicht-Default-Formatierung zurueck (horizontal)
//
class ScHorizontalAttrIterator
{
private:
ScDocument* pDoc;
SCTAB nTab;
SCCOL nStartCol;
SCROW nStartRow;
SCCOL nEndCol;
SCROW nEndRow;
SCROW* pNextEnd;
SCSIZE* pIndices;
const ScPatternAttr** ppPatterns;
SCCOL nCol;
SCROW nRow;
BOOL bRowEmpty;
public:
ScHorizontalAttrIterator( ScDocument* pDocument, SCTAB nTable,
SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2 );
~ScHorizontalAttrIterator();
const ScPatternAttr* GetNext( SCCOL& rCol1, SCCOL& rCol2, SCROW& rRow );
};
//
// gibt nichtleere Zellen und Bereiche mit Formatierung zurueck (horizontal)
//
class SC_DLLPUBLIC ScUsedAreaIterator
{
private:
ScHorizontalCellIterator aCellIter;
ScHorizontalAttrIterator aAttrIter;
SCCOL nNextCol;
SCROW nNextRow;
SCCOL nCellCol;
SCROW nCellRow;
const ScBaseCell* pCell;
SCCOL nAttrCol1;
SCCOL nAttrCol2;
SCROW nAttrRow;
const ScPatternAttr* pPattern;
SCCOL nFoundStartCol; // Ergebnisse nach GetNext
SCCOL nFoundEndCol;
SCROW nFoundRow;
const ScPatternAttr* pFoundPattern;
const ScBaseCell* pFoundCell;
public:
ScUsedAreaIterator( ScDocument* pDocument, SCTAB nTable,
SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2 );
~ScUsedAreaIterator();
BOOL GetNext();
SCCOL GetStartCol() const { return nFoundStartCol; }
SCCOL GetEndCol() const { return nFoundEndCol; }
SCROW GetRow() const { return nFoundRow; }
const ScPatternAttr* GetPattern() const { return pFoundPattern; }
const ScBaseCell* GetCell() const { return pFoundCell; }
};
#endif
|