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
|
/* -*- 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 .
*/
#ifndef INCLUDED_SW_INC_PAM_HXX
#define INCLUDED_SW_INC_PAM_HXX
#include <stddef.h>
#include <sal/types.h>
#include <tools/mempool.hxx>
#include <cshtyp.hxx>
#include <ring.hxx>
#include <index.hxx>
#include <ndindex.hxx>
#include "swdllapi.h"
#include <iostream>
class SwFormat;
class SfxPoolItem;
class SfxItemSet;
class SwDoc;
class SwNode;
class SwContentNode;
class SwPaM;
class Point;
namespace com { namespace sun { namespace star { namespace util {
struct SearchOptions2;
} } } }
namespace utl {
class TextSearch;
}
/// Marks a position in the document model.
struct SW_DLLPUBLIC SwPosition
{
SwNodeIndex nNode;
SwIndex nContent;
SwPosition( const SwNodeIndex &rNode, const SwIndex &rContent );
explicit SwPosition( const SwNodeIndex &rNode );
explicit SwPosition( const SwNode& rNode );
explicit SwPosition( SwContentNode& rNode, const sal_Int32 nOffset = 0 );
SwPosition( const SwPosition & );
SwPosition &operator=(const SwPosition &);
/**
Returns the document this position is in.
@return the document this position is in.
*/
SwDoc * GetDoc() const;
bool operator < (const SwPosition &) const;
bool operator > (const SwPosition &) const;
bool operator <=(const SwPosition &) const;
bool operator >=(const SwPosition &) const;
bool operator ==(const SwPosition &) const;
bool operator !=(const SwPosition &) const;
void dumpAsXml(struct _xmlTextWriter* pWriter) const;
};
SW_DLLPUBLIC std::ostream &operator <<(std::ostream& s, const SwPosition& position);
// Result of comparing positions.
enum SwComparePosition {
POS_BEFORE, ///< Pos1 before Pos2.
POS_BEHIND, ///< Pos1 behind Pos2.
POS_INSIDE, ///< Pos1 completely contained in Pos2.
POS_OUTSIDE, ///< Pos2 completely contained in Pos1.
POS_EQUAL, ///< Pos1 is as large as Pos2.
POS_OVERLAP_BEFORE, ///< Pos1 overlaps Pos2 at the beginning.
POS_OVERLAP_BEHIND, ///< Pos1 overlaps Pos2 at the end.
POS_COLLIDE_START, ///< Pos1 start touches at Pos2 end.
POS_COLLIDE_END ///< Pos1 end touches at Pos2 start.
};
template<typename T>
SwComparePosition ComparePosition(
const T& rStt1, const T& rEnd1,
const T& rStt2, const T& rEnd2 )
{
SwComparePosition nRet;
if( rStt1 < rStt2 )
{
if( rEnd1 > rStt2 )
{
if( rEnd1 >= rEnd2 )
nRet = POS_OUTSIDE;
else
nRet = POS_OVERLAP_BEFORE;
}
else if( rEnd1 == rStt2 )
nRet = POS_COLLIDE_END;
else
nRet = POS_BEFORE;
}
else if( rEnd2 > rStt1 )
{
if( rEnd2 >= rEnd1 )
{
if( rEnd2 == rEnd1 && rStt2 == rStt1 )
nRet = POS_EQUAL;
else
nRet = POS_INSIDE;
}
else
{
if (rStt1 == rStt2)
nRet = POS_OUTSIDE;
else
nRet = POS_OVERLAP_BEHIND;
}
}
else if( rEnd2 == rStt1 )
nRet = POS_COLLIDE_START;
else
nRet = POS_BEHIND;
return nRet;
}
/// SwPointAndMark / SwPaM
struct SwMoveFnCollection;
typedef SwMoveFnCollection* SwMoveFn;
SW_DLLPUBLIC extern SwMoveFn fnMoveForward; ///< SwPam::Move()/Find() default argument.
SW_DLLPUBLIC extern SwMoveFn fnMoveBackward;
// also works: using SwGoInDoc = bool (*) (SwPaM& rPam, SwMoveFn fnMove);
// no works: using SwGoInDoc = [](SwPaM& rPam, SwMoveFn fnMove) -> bool;
using SwGoInDoc = auto (*)(SwPaM& rPam, SwMoveFn fnMove) -> bool;
SW_DLLPUBLIC extern SwGoInDoc fnGoDoc;
extern SwGoInDoc fnGoSection;
SW_DLLPUBLIC extern SwGoInDoc fnGoNode;
SW_DLLPUBLIC extern SwGoInDoc fnGoContent; ///< SwPam::Move() default argument.
extern SwGoInDoc fnGoContentCells;
extern SwGoInDoc fnGoContentSkipHidden;
extern SwGoInDoc fnGoContentCellsSkipHidden;
class SwPaM;
/// PaM is Point and Mark: a selection of the document model.
class SW_DLLPUBLIC SwPaM : public sw::Ring<SwPaM>
{
SwPosition m_Bound1;
SwPosition m_Bound2;
SwPosition * m_pPoint; ///< points at either m_Bound1 or m_Bound2
SwPosition * m_pMark; ///< points at either m_Bound1 or m_Bound2
bool m_bIsInFrontOfLabel;
SwPaM* MakeRegion( SwMoveFn fnMove, const SwPaM * pOrigRg );
SwPaM(SwPaM const& rPaM) = delete;
public:
explicit SwPaM( const SwPosition& rPos, SwPaM* pRing = nullptr );
SwPaM( const SwPosition& rMk, const SwPosition& rPt, SwPaM* pRing = nullptr );
SwPaM( const SwNodeIndex& rMk, const SwNodeIndex& rPt,
long nMkOffset = 0, long nPtOffset = 0, SwPaM* pRing = nullptr );
SwPaM( const SwNode& rMk, const SwNode& rPt,
long nMkOffset = 0, long nPtOffset = 0, SwPaM* pRing = nullptr );
SwPaM( const SwNodeIndex& rMk, sal_Int32 nMkContent,
const SwNodeIndex& rPt, sal_Int32 nPtContent, SwPaM* pRing = nullptr );
SwPaM( const SwNode& rMk, sal_Int32 nMkContent,
const SwNode& rPt, sal_Int32 nPtContent, SwPaM* pRing = nullptr );
SwPaM( const SwNode& rNd, sal_Int32 nContent = 0, SwPaM* pRing = nullptr );
SwPaM( const SwNodeIndex& rNd, sal_Int32 nContent = 0, SwPaM* pRing = nullptr );
virtual ~SwPaM();
/// this takes a second parameter, which indicates the Ring that
/// the new PaM should be part of (may be null)
SwPaM(SwPaM const& rPaM, SwPaM * pRing);
/// @@@ semantic: no copy assignment for super class Ring.
SwPaM& operator=( const SwPaM & );
/// Movement of cursor.
bool Move( SwMoveFn fnMove = fnMoveForward,
SwGoInDoc fnGo = fnGoContent );
/// Search.
bool Find( const css::util::SearchOptions2& rSearchOpt,
bool bSearchInNotes,
utl::TextSearch& rSText,
SwMoveFn fnMove = fnMoveForward,
const SwPaM *pPam =nullptr, bool bInReadOnly = false);
bool Find( const SwFormat& rFormat,
SwMoveFn fnMove = fnMoveForward,
const SwPaM *pPam =nullptr, bool bInReadOnly = false);
bool Find( const SfxPoolItem& rAttr, bool bValue,
SwMoveFn fnMove = fnMoveForward,
const SwPaM *pPam =nullptr, bool bInReadOnly = false );
bool Find( const SfxItemSet& rAttr, bool bNoColls,
SwMoveFn fnMove,
const SwPaM *pPam, bool bInReadOnly, bool bMoveFirst );
bool DoSearch( const css::util::SearchOptions2& rSearchOpt, utl::TextSearch& rSText,
SwMoveFn fnMove, bool bSrchForward, bool bRegSearch, bool bChkEmptyPara, bool bChkParaEnd,
sal_Int32 &nStart, sal_Int32 &nEnd, sal_Int32 nTextLen, SwNode* pNode, SwPaM* pPam);
inline bool IsInFrontOfLabel() const { return m_bIsInFrontOfLabel; }
inline void SetInFrontOfLabel_( bool bNew ) { m_bIsInFrontOfLabel = bNew; }
/// Unless this is called, the getter method of Mark will return Point.
virtual void SetMark();
void DeleteMark()
{
if (m_pMark != m_pPoint)
{
/** clear the mark position; this helps if mark's SwIndex is
registered at some node, and that node is then deleted */
*m_pMark = SwPosition( SwNodeIndex( GetNode().GetNodes() ) );
m_pMark = m_pPoint;
}
}
#ifdef DBG_UTIL
void Exchange();
#else
void Exchange()
{
if (m_pPoint != m_pMark)
{
SwPosition *pTmp = m_pPoint;
m_pPoint = m_pMark;
m_pMark = pTmp;
}
}
#endif
/** A PaM marks a selection if Point and Mark are distinct positions.
@return true if the PaM spans a selection
*/
bool HasMark() const { return m_pPoint != m_pMark; }
const SwPosition *GetPoint() const { return m_pPoint; }
SwPosition *GetPoint() { return m_pPoint; }
const SwPosition *GetMark() const { return m_pMark; }
SwPosition *GetMark() { return m_pMark; }
const SwPosition *Start() const
{ return (*m_pPoint) <= (*m_pMark) ? m_pPoint : m_pMark; }
SwPosition *Start()
{ return (*m_pPoint) <= (*m_pMark) ? m_pPoint : m_pMark; }
const SwPosition *End() const
{ return (*m_pPoint) > (*m_pMark) ? m_pPoint : m_pMark; }
SwPosition *End()
{ return (*m_pPoint) > (*m_pMark) ? m_pPoint : m_pMark; }
/// @return current Node at Point/Mark
SwNode & GetNode ( bool bPoint = true ) const
{
return ( bPoint ? m_pPoint->nNode : m_pMark->nNode ).GetNode();
}
/// @return current ContentNode at Point/Mark
SwContentNode* GetContentNode( bool bPoint = true ) const
{
return GetNode(bPoint).GetContentNode();
}
/**
Normalizes PaM, i.e. sort point and mark.
@param bPointFirst true: If the point is behind the mark then swap.
false: If the mark is behind the point then swap.
*/
void Normalize(bool bPointFirst = true);
/// @return the document (SwDoc) at which the PaM is registered
SwDoc* GetDoc() const { return m_pPoint->nNode.GetNode().GetDoc(); }
SwPosition& GetBound( bool bOne = true )
{ return bOne ? m_Bound1 : m_Bound2; }
const SwPosition& GetBound( bool bOne = true ) const
{ return bOne ? m_Bound1 : m_Bound2; }
/// Get number of page which contains cursor.
sal_uInt16 GetPageNum( bool bAtPoint = true, const Point* pLayPos = nullptr );
/** Is in something protected (readonly) or selection contains
something protected. */
bool HasReadonlySel( bool bFormView, bool bAnnotationMode = false ) const;
bool ContainsPosition(const SwPosition & rPos) const
{
return *Start() <= rPos && rPos <= *End();
}
DECL_FIXEDMEMPOOL_NEWDEL(SwPaM);
OUString GetText() const;
void InvalidatePaM();
SwPaM* GetNext()
{ return GetNextInRing(); }
const SwPaM* GetNext() const
{ return GetNextInRing(); }
SwPaM* GetPrev()
{ return GetPrevInRing(); }
const SwPaM* GetPrev() const
{ return GetPrevInRing(); }
bool IsMultiSelection() const
{ return !unique(); }
void dumpAsXml(struct _xmlTextWriter* pWriter) const;
};
SW_DLLPUBLIC std::ostream &operator <<(std::ostream& s, const SwPaM& pam);
bool CheckNodesRange( const SwNodeIndex&, const SwNodeIndex&, bool bChkSection );
#endif // INCLUDED_SW_INC_PAM_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|