LibreOffice Module sw (master) 1
undobj.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#ifndef INCLUDED_SW_INC_UNDOBJ_HXX
20#define INCLUDED_SW_INC_UNDOBJ_HXX
21
22#include <vector>
23#include <memory>
24
25#include <svl/undo.hxx>
26#include "SwRewriter.hxx"
27#include "swundo.hxx"
28#include "nodeoffset.hxx"
30#include <optional>
31
32class SwHistory;
33class SwPaM;
34struct SwPosition;
35class SwDoc;
37class SwFrameFormat;
38class SwFormatAnchor;
39class SwNodeIndex;
40class SwNodeRange;
41class SwRedlineData;
43enum class RedlineFlags;
44enum class RndStdIds;
45typedef struct _xmlTextWriter* xmlTextWriterPtr;
46
47namespace sw {
48 class UndoRedoContext;
49 class RepeatContext;
50}
51
52class SwUndo
53 : public SfxUndoAction
54{
59
60protected:
62 mutable std::optional<OUString> maComment;
63
64 static void RemoveIdxFromSection( SwDoc&, SwNodeOffset nSttIdx, const SwNodeOffset* pEndIdx = nullptr );
65 static void RemoveIdxFromRange( SwPaM& rPam, bool bMoveNext );
66 static void RemoveIdxRel( SwNodeOffset, const SwPosition& );
67
68 static bool CanRedlineGroup( SwRedlineSaveDatas& rCurr,
69 const SwRedlineSaveDatas& rCheck,
70 bool bCurrIsEnd );
71
77 virtual SwRewriter GetRewriter() const;
78
79 // the 4 methods that derived classes have to override
80 // base implementation does nothing
81 virtual void RepeatImpl( ::sw::RepeatContext & );
82public: // should not be public, but ran into trouble in untbl.cxx
83 virtual void UndoImpl( ::sw::UndoRedoContext & ) = 0;
84 virtual void RedoImpl( ::sw::UndoRedoContext & ) = 0;
85
86private:
88 static ViewShellId CreateViewShellId(const SwDoc* pDoc);
89 // SfxUndoAction
90 virtual void Undo() override;
91 virtual void Redo() override;
92 virtual void UndoWithContext(SfxUndoContext &) override;
93 virtual void RedoWithContext(SfxUndoContext &) override;
94 virtual void Repeat(SfxRepeatTarget &) override;
95 virtual bool CanRepeat(SfxRepeatTarget &) const override;
96
97public:
98 SwUndo(SwUndoId const nId, const SwDoc* pDoc);
99 virtual ~SwUndo() override;
100
101 SwUndoId GetId() const { return m_nId; }
102
112 virtual OUString GetComment() const override;
113
115 ViewShellId GetViewShellId() const override;
116
117 // UndoObject remembers which mode was turned on.
118 // In Undo/Redo/Repeat this remembered mode is switched on.
121
122 bool IsDelBox() const;
123
124 // Save and set Redline data.
125 static bool FillSaveData( const SwPaM& rRange, SwRedlineSaveDatas& rSData,
126 bool bDelRange = true, bool bCopyNext = true );
127 static bool FillSaveDataForFormat( const SwPaM& , SwRedlineSaveDatas& );
128 static void SetSaveData( SwDoc& rDoc, SwRedlineSaveDatas& rSData );
129 static bool HasHiddenRedlines( const SwRedlineSaveDatas& rSData );
131};
132
133enum class DelContentType : sal_uInt16
134{
135 Ftn = 0x01,
136 Fly = 0x02,
137 Bkm = 0x08,
138 AllMask = 0x0b,
139 Replace = 0x10,
140 WriterfilterHack = 0x20,
142 CheckNoCntnt = 0x80,
143};
144namespace o3tl {
145 template<> struct typed_flags<DelContentType> : is_typed_flags<DelContentType, 0xfb> {};
146}
147
149bool IsDestroyFrameAnchoredAtChar(SwPosition const & rAnchorPos,
150 SwPosition const & rStart, SwPosition const & rEnd,
151 DelContentType const nDelContentType = DelContentType::AllMask);
153bool IsSelectFrameAnchoredAtPara(SwPosition const & rAnchorPos,
154 SwPosition const & rStart, SwPosition const & rEnd,
155 DelContentType const nDelContentType = DelContentType::AllMask);
157bool IsFlySelectedByCursor(SwDoc const & rDoc,
158 SwPosition const & rStart, SwPosition const & rEnd);
159
160// This class has to be inherited into an Undo-object if it saves content
161// for Redo/Undo...
163{
164protected:
165
166 std::unique_ptr<SwHistory> m_pHistory;
167
168 // Needed for deletion of content. For Redo content is moved into the
169 // UndoNodesArray. These methods always create a new node to insert
170 // content. So the attributes do not get expanded.
171 // MoveTo: moves from the NodesArray into the UndoNodesArray.
172 // MoveFrom: moves from the UndoNodesArray into the NodesArray.
173 static void MoveToUndoNds( SwPaM& rPam,
174 SwNodeIndex* pNodeIdx,
175 SwNodeOffset* pEndNdIdx = nullptr );
176 static void MoveFromUndoNds( SwDoc& rDoc, SwNodeOffset nNodeIdx,
177 SwPosition& rInsPos,
178 const SwNodeOffset* pEndNdIdx = nullptr,
179 bool bForceCreateFrames = false);
180
181 // These two methods move the SPoint back/forth from PaM. With it
182 // a range can be spanned for Undo/Redo. (In this case the SPoint
183 // is before the manipulated range!!)
184 // The flag indicates if there is content before the SPoint.
185 static bool MovePtBackward( SwPaM& rPam );
186 static void MovePtForward( SwPaM& rPam, bool bMvBkwrd );
187
188 // Before moving stuff into UndoNodes-Array care has to be taken that
189 // the content-bearing attributes are removed from the nodes-array.
190 void DelContentIndex( const SwPosition& pMark, const SwPosition& pPoint,
191 DelContentType nDelContentType = DelContentType::AllMask );
192
193public:
195 virtual ~SwUndoSaveContent() COVERITY_NOEXCEPT_FALSE;
196 virtual void dumpAsXml(xmlTextWriterPtr pWriter) const;
197};
198
199// Save a complete section in nodes-array.
201{
202 std::unique_ptr<SwNodeIndex> m_pMovedStart;
203 std::unique_ptr<SwRedlineSaveDatas> m_pRedlineSaveData;
204 SwNodeOffset m_nMoveLen; // Index into UndoNodes-Array.
206
207protected:
208 SwNodeIndex* GetMvSttIdx() const { return m_pMovedStart.get(); }
209 SwNodeOffset GetMvNodeCnt() const { return m_nMoveLen; }
210
211public:
214
215 void SaveSection( const SwNodeIndex& rSttIdx );
216 void SaveSection(const SwNodeRange& rRange, bool bExpandNodes = true);
217 void RestoreSection( SwDoc* pDoc, SwNodeIndex* pIdx, sal_uInt16 nSectType );
218 void RestoreSection(SwDoc* pDoc, const SwNodeIndex& rInsPos, bool bForceCreateFrames = false);
219
220 const SwHistory* GetHistory() const { return m_pHistory.get(); }
221 SwHistory* GetHistory() { return m_pHistory.get(); }
222 virtual void dumpAsXml(xmlTextWriterPtr pWriter) const;
223};
224
225// This class saves the PaM as sal_uInt16's and is able to restore it
226// into a PaM.
228{
229public:
231 sal_Int32 m_nSttContent, m_nEndContent;
232
233 SwUndRng();
234 SwUndRng( const SwPaM& );
235
236 void SetValues( const SwPaM& rPam );
237 void SetPaM( SwPaM&, bool bCorrToContent = false ) const;
238 SwPaM & AddUndoRedoPaM(
239 ::sw::UndoRedoContext &, bool const bCorrToContent = false) const;
240};
241
243
244namespace sw {
245
246std::optional<std::vector<SwFrameFormat*>>
247GetFlysAnchoredAt(SwDoc & rDoc, SwNodeOffset nSttNode);
248
249}
250
251// base class for insertion of Document, Glossaries and Copy
252class SwUndoInserts : public SwUndo, public SwUndRng, private SwUndoSaveContent
253{
254 SwTextFormatColl *m_pTextFormatColl, *m_pLastNodeColl;
255 std::optional<std::vector<SwFrameFormat*>> m_pFrameFormats;
256 std::vector< std::shared_ptr<SwUndoInsLayFormat> > m_FlyUndos;
257 std::unique_ptr<SwRedlineData> m_pRedlineData;
259
260protected:
263 std::unique_ptr<SwNodeIndex> m_pUndoNodeIndex;
264 sal_uInt16 m_nSetPos; // Start in the history list.
265
266 SwUndoInserts( SwUndoId nUndoId, const SwPaM& );
267public:
268 virtual ~SwUndoInserts() override;
269
270 virtual void UndoImpl( ::sw::UndoRedoContext & ) override;
271 virtual void RedoImpl( ::sw::UndoRedoContext & ) override;
272 virtual void RepeatImpl( ::sw::RepeatContext & ) override;
273
274 // Set destination range after reading.
275 void SetInsertRange( const SwPaM&, bool bScanFlys = true,
276 SwNodeOffset nDeleteTextNodes = SwNodeOffset(1));
277
278 static bool IsCreateUndoForNewFly(SwFormatAnchor const& rAnchor,
279 SwNodeOffset const nStartNode, SwNodeOffset const nEndNode);
280 std::vector<SwFrameFormat*> * GetFlysAnchoredAt() { return m_pFrameFormats ? &*m_pFrameFormats : nullptr; }
281
282 void dumpAsXml(xmlTextWriterPtr pWriter) const override;
283};
284
285class SwUndoInsDoc final : public SwUndoInserts
286{
287public:
288 SwUndoInsDoc( const SwPaM& );
289};
290
291class SwUndoCpyDoc final : public SwUndoInserts
292{
293public:
294 SwUndoCpyDoc( const SwPaM& );
295};
296
298{
299protected:
300 SwFrameFormat* m_pFrameFormat; // The saved FlyFormat.
302 sal_Int32 m_nContentPos; // Page at/in paragraph.
304 bool m_bDelFormat; // Delete saved format.
305
306 void InsFly(::sw::UndoRedoContext & rContext, bool bShowSel = true);
307 void DelFly( SwDoc* );
308
309 SwUndoFlyBase( SwFrameFormat* pFormat, SwUndoId nUndoId );
310
313
314public:
315 virtual ~SwUndoFlyBase() override;
316 void dumpAsXml(xmlTextWriterPtr pWriter) const override;
317
318};
319
321{
323 sal_Int32 mnCursorSaveIndexPos; // for undo
324public:
325 SwUndoInsLayFormat( SwFrameFormat* pFormat, SwNodeOffset nNodeIdx, sal_Int32 nCntIdx );
326
327 virtual ~SwUndoInsLayFormat() override;
328
329 virtual void UndoImpl( ::sw::UndoRedoContext & ) override;
330 virtual void RedoImpl( ::sw::UndoRedoContext & ) override;
331 virtual void RepeatImpl( ::sw::RepeatContext & ) override;
332
333 virtual OUString GetComment() const override;
334
335};
336
338{
340public:
342
343 virtual void UndoImpl( ::sw::UndoRedoContext & ) override;
344 virtual void RedoImpl( ::sw::UndoRedoContext & ) override;
345
346 void RedoForRollback();
347
348 void ChgShowSel( bool bNew ) { m_bShowSelFrame = bNew; }
349
350 virtual SwRewriter GetRewriter() const override;
351
352};
353
354#endif
355
356/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
struct _xmlTextWriter * xmlTextWriterPtr
Definition: doc.hxx:188
FlyAnchors.
Definition: fmtanchr.hxx:35
Style of a layout element.
Definition: frmfmt.hxx:61
Marks a node in the document model.
Definition: ndindex.hxx:31
PaM is Point and Mark: a selection of the document model.
Definition: pam.hxx:138
Represents the style of a paragraph.
Definition: fmtcol.hxx:59
SwNodeOffset m_nEndNode
Definition: undobj.hxx:230
sal_Int32 m_nEndContent
Definition: undobj.hxx:231
void ChgShowSel(bool bNew)
Definition: undobj.hxx:348
RndStdIds m_nRndId
Definition: undobj.hxx:303
SwNodeOffset m_nNodePagePos
Definition: undobj.hxx:301
SwFrameFormat * m_pFrameFormat
Definition: undobj.hxx:300
bool m_bDelFormat
Definition: undobj.hxx:304
SwNodeOffset GetMvNodeCnt() const
Definition: undobj.hxx:312
sal_Int32 m_nContentPos
Definition: undobj.hxx:302
SwNodeIndex * GetMvSttIdx() const
Definition: undobj.hxx:311
SwNodeOffset mnCursorSaveIndexPara
Definition: undobj.hxx:322
sal_Int32 mnCursorSaveIndexPos
Definition: undobj.hxx:323
std::vector< std::shared_ptr< SwUndoInsLayFormat > > m_FlyUndos
Definition: undobj.hxx:256
SwNodeOffset m_nDeleteTextNodes
Definition: undobj.hxx:258
sal_uInt16 m_nSetPos
Definition: undobj.hxx:264
std::unique_ptr< SwNodeIndex > m_pUndoNodeIndex
start of Content in UndoNodes for Redo
Definition: undobj.hxx:263
SwNodeOffset m_nNodeDiff
Definition: undobj.hxx:261
SwTextFormatColl * m_pLastNodeColl
Definition: undobj.hxx:254
std::vector< SwFrameFormat * > * GetFlysAnchoredAt()
Definition: undobj.hxx:280
std::unique_ptr< SwRedlineData > m_pRedlineData
Definition: undobj.hxx:257
std::optional< std::vector< SwFrameFormat * > > m_pFrameFormats
Definition: undobj.hxx:255
static void MoveFromUndoNds(SwDoc &rDoc, SwNodeOffset nNodeIdx, SwPosition &rInsPos, const SwNodeOffset *pEndNdIdx=nullptr, bool bForceCreateFrames=false)
Definition: undobj.cxx:768
virtual ~SwUndoSaveContent() COVERITY_NOEXCEPT_FALSE
Definition: undobj.cxx:706
void DelContentIndex(const SwPosition &pMark, const SwPosition &pPoint, DelContentType nDelContentType=DelContentType::AllMask)
Definition: undobj.cxx:865
static void MoveToUndoNds(SwPaM &rPam, SwNodeIndex *pNodeIdx, SwNodeOffset *pEndNdIdx=nullptr)
Definition: undobj.cxx:731
std::unique_ptr< SwHistory > m_pHistory
Definition: undobj.hxx:166
static bool MovePtBackward(SwPaM &rPam)
Definition: undobj.cxx:827
static void MovePtForward(SwPaM &rPam, bool bMvBkwrd)
Definition: undobj.cxx:840
virtual void dumpAsXml(xmlTextWriterPtr pWriter) const
Definition: undobj.cxx:710
const SwHistory * GetHistory() const
Definition: undobj.hxx:220
std::unique_ptr< SwRedlineSaveDatas > m_pRedlineSaveData
Definition: undobj.hxx:203
std::unique_ptr< SwNodeIndex > m_pMovedStart
Definition: undobj.hxx:202
SwNodeOffset m_nStartPos
Definition: undobj.hxx:205
SwNodeIndex * GetMvSttIdx() const
Definition: undobj.hxx:208
SwNodeOffset m_nMoveLen
Definition: undobj.hxx:204
SwHistory * GetHistory()
Definition: undobj.hxx:221
SwNodeOffset GetMvNodeCnt() const
Definition: undobj.hxx:209
virtual SwRewriter GetRewriter() const
Returns the rewriter for this object.
Definition: undobj.cxx:696
std::optional< OUString > maComment
Definition: undobj.hxx:62
virtual void UndoImpl(::sw::UndoRedoContext &)=0
SwUndo(SwUndoId const nId, const SwDoc *pDoc)
Definition: undobj.cxx:161
void IgnoreRepeat()
Definition: undobj.hxx:130
void SetRedlineFlags(RedlineFlags eMode)
Definition: undobj.hxx:120
virtual void Repeat(SfxRepeatTarget &) override
Definition: undobj.cxx:247
virtual void Redo() override
Definition: undobj.cxx:224
RedlineFlags m_nOrigRedlineFlags
Definition: undobj.hxx:56
RedlineFlags GetRedlineFlags() const
Definition: undobj.hxx:119
ViewShellId GetViewShellId() const override
See SfxUndoAction::GetViewShellId().
Definition: undobj.cxx:691
virtual bool CanRepeat(SfxRepeatTarget &) const override
Definition: undobj.cxx:259
static bool FillSaveData(const SwPaM &rRange, SwRedlineSaveDatas &rSData, bool bDelRange=true, bool bCopyNext=true)
Definition: undobj.cxx:1413
virtual OUString GetComment() const override
Returns textual comment for this undo object.
Definition: undobj.cxx:662
static void RemoveIdxRel(SwNodeOffset, const SwPosition &)
Definition: undobj.cxx:153
static void RemoveIdxFromRange(SwPaM &rPam, bool bMoveNext)
Definition: undobj.cxx:126
virtual void UndoWithContext(SfxUndoContext &) override
Definition: undobj.cxx:229
bool IsDelBox() const
Definition: undobj.cxx:182
static bool HasHiddenRedlines(const SwRedlineSaveDatas &rSData)
Definition: undobj.cxx:1498
static void SetSaveData(SwDoc &rDoc, SwRedlineSaveDatas &rSData)
Definition: undobj.cxx:1478
static bool CanRedlineGroup(SwRedlineSaveDatas &rCurr, const SwRedlineSaveDatas &rCheck, bool bCurrIsEnd)
Definition: undobj.cxx:1506
SwUndoId GetId() const
Definition: undobj.hxx:101
virtual void RepeatImpl(::sw::RepeatContext &)
Definition: undobj.cxx:267
bool m_bCacheComment
Definition: undobj.hxx:61
static ViewShellId CreateViewShellId(const SwDoc *pDoc)
Try to obtain the view shell ID of the current view.
Definition: undobj.cxx:169
static bool FillSaveDataForFormat(const SwPaM &, SwRedlineSaveDatas &)
Definition: undobj.cxx:1448
virtual void RedoImpl(::sw::UndoRedoContext &)=0
static void RemoveIdxFromSection(SwDoc &, SwNodeOffset nSttIdx, const SwNodeOffset *pEndIdx=nullptr)
Definition: undobj.cxx:116
virtual void Undo() override
Definition: undobj.cxx:219
bool m_isRepeatIgnored
for multi-selection, only repeat 1st selection
Definition: undobj.hxx:58
ViewShellId m_nViewShellId
Definition: undobj.hxx:57
virtual void RedoWithContext(SfxUndoContext &) override
Definition: undobj.cxx:238
virtual ~SwUndo() override
Definition: undobj.cxx:188
SwUndoId const m_nId
Definition: undobj.hxx:55
Mode eMode
Dialog to specify the properties of date form field.
std::optional< std::vector< SwFrameFormat * > > GetFlysAnchoredAt(SwDoc &rDoc, SwNodeOffset const nSttNode)
Definition: untblk.cxx:41
o3tl::strong_int< sal_Int32, struct Tag_SwNodeOffset > SwNodeOffset
Definition: nodeoffset.hxx:16
Marks a position in the document model.
Definition: pam.hxx:37
RndStdIds
SwUndoId
Definition: swundo.hxx:30
bool IsFlySelectedByCursor(SwDoc const &rDoc, SwPosition const &rStart, SwPosition const &rEnd)
check at-char and at-para flys in rDoc
Definition: undobj.cxx:1689
struct _xmlTextWriter * xmlTextWriterPtr
Definition: undobj.hxx:45
bool IsSelectFrameAnchoredAtPara(SwPosition const &rAnchorPos, SwPosition const &rStart, SwPosition const &rEnd, DelContentType const nDelContentType=DelContentType::AllMask)
is a fly anchored at paragraph at rAnchorPos selected?
Definition: undobj.cxx:1647
bool IsDestroyFrameAnchoredAtChar(SwPosition const &rAnchorPos, SwPosition const &rStart, SwPosition const &rEnd, DelContentType const nDelContentType=DelContentType::AllMask)
will DelContentIndex destroy a frame anchored at character at rAnchorPos?
Definition: undobj.cxx:1606
DelContentType
Definition: undobj.hxx:134