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 <tools/solar.h>
27 #include "SwRewriter.hxx"
28 #include "swundo.hxx"
29 #include <o3tl/typed_flags_set.hxx>
30 #include <boost/optional.hpp>
31 
32 class SwHistory;
33 class SwPaM;
34 struct SwPosition;
35 class SwDoc;
36 class SwTextFormatColl;
37 class SwFrameFormat;
38 class SwFormatAnchor;
39 class SwNodeIndex;
40 class SwNodeRange;
41 class SwRedlineData;
42 class SwRedlineSaveDatas;
43 enum class RedlineFlags;
44 enum class RndStdIds;
45 
46 namespace sw {
47  class UndoRedoContext;
48  class RepeatContext;
49 }
50 
51 class SwUndo
52  : public SfxUndoAction
53 {
54  SwUndoId const m_nId;
58 
59 protected:
62 
63  static void RemoveIdxFromSection( SwDoc&, sal_uLong nSttIdx, const sal_uLong* pEndIdx = nullptr );
64  static void RemoveIdxFromRange( SwPaM& rPam, bool bMoveNext );
65  static void RemoveIdxRel( sal_uLong, const SwPosition& );
66 
67  static bool CanRedlineGroup( SwRedlineSaveDatas& rCurr,
68  const SwRedlineSaveDatas& rCheck,
69  bool bCurrIsEnd );
70 
76  virtual SwRewriter GetRewriter() const;
77 
78  // the 4 methods that derived classes have to override
79  // base implementation does nothing
80  virtual void RepeatImpl( ::sw::RepeatContext & );
81 public: // should not be public, but ran into trouble in untbl.cxx
82  virtual void UndoImpl( ::sw::UndoRedoContext & ) = 0;
83  virtual void RedoImpl( ::sw::UndoRedoContext & ) = 0;
84 
85 private:
87  static ViewShellId CreateViewShellId(const SwDoc* pDoc);
88  // SfxUndoAction
89  virtual void Undo() override;
90  virtual void Redo() override;
91  virtual void UndoWithContext(SfxUndoContext &) override;
92  virtual void RedoWithContext(SfxUndoContext &) override;
93  virtual void Repeat(SfxRepeatTarget &) override;
94  virtual bool CanRepeat(SfxRepeatTarget &) const override;
95 
96 public:
97  SwUndo(SwUndoId const nId, const SwDoc* pDoc);
98  virtual ~SwUndo() override;
99 
100  SwUndoId GetId() const { return m_nId; }
101 
111  virtual OUString GetComment() const override;
112 
114  ViewShellId GetViewShellId() const override;
115 
116  // UndoObject remembers which mode was turned on.
117  // In Undo/Redo/Repeat this remembered mode is switched on.
119  void SetRedlineFlags( RedlineFlags eMode ) { m_nOrigRedlineFlags = eMode; }
120 
121  bool IsDelBox() const;
122 
123  // Save and set Redline data.
124  static bool FillSaveData( const SwPaM& rRange, SwRedlineSaveDatas& rSData,
125  bool bDelRange = true, bool bCopyNext = true );
126  static bool FillSaveDataForFormat( const SwPaM& , SwRedlineSaveDatas& );
127  static void SetSaveData( SwDoc& rDoc, SwRedlineSaveDatas& rSData );
128  static bool HasHiddenRedlines( const SwRedlineSaveDatas& rSData );
129  void IgnoreRepeat() { m_isRepeatIgnored = true; }
130 };
131 
132 enum class DelContentType : sal_uInt16
133 {
134  Ftn = 0x01,
135  Fly = 0x02,
136  Bkm = 0x08,
137  AllMask = 0x0b,
139  CheckNoCntnt = 0x80,
140 };
141 namespace o3tl {
142  template<> struct typed_flags<DelContentType> : is_typed_flags<DelContentType, 0xcb> {};
143 }
144 
146 bool IsDestroyFrameAnchoredAtChar(SwPosition const & rAnchorPos,
147  SwPosition const & rStart, SwPosition const & rEnd,
148  DelContentType const nDelContentType = DelContentType::AllMask);
149 
150 // This class has to be inherited into an Undo-object if it saves content
151 // for Redo/Undo...
153 {
154 protected:
155 
156  std::unique_ptr<SwHistory> m_pHistory;
157 
158  // Needed for deletion of content. For Redo content is moved into the
159  // UndoNodesArray. These methods always create a new node to insert
160  // content. So the attributes do not get expanded.
161  // MoveTo: moves from the NodesArray into the UndoNodesArray.
162  // MoveFrom: moves from the UndoNodesArray into the NodesArray.
163  static void MoveToUndoNds( SwPaM& rPam,
164  SwNodeIndex* pNodeIdx,
165  sal_uLong* pEndNdIdx = nullptr );
166  static void MoveFromUndoNds( SwDoc& rDoc, sal_uLong nNodeIdx,
167  SwPosition& rInsPos,
168  const sal_uLong* pEndNdIdx = nullptr,
169  bool bForceCreateFrames = false);
170 
171  // These two methods move the SPoint back/forth from PaM. With it
172  // a range can be spanned for Undo/Redo. (In this case the SPoint
173  // is before the manipulated range!!)
174  // The flag indicates if there is content before the SPoint.
175  static bool MovePtBackward( SwPaM& rPam );
176  static void MovePtForward( SwPaM& rPam, bool bMvBkwrd );
177 
178  // Before moving stuff into UndoNodes-Array care has to be taken that
179  // the content-bearing attributes are removed from the nodes-array.
180  void DelContentIndex( const SwPosition& pMark, const SwPosition& pPoint,
181  DelContentType nDelContentType = DelContentType::AllMask );
182 
183 public:
185  ~SwUndoSaveContent() COVERITY_NOEXCEPT_FALSE;
186 };
187 
188 // Save a complete section in nodes-array.
190 {
191  std::unique_ptr<SwNodeIndex> m_pMovedStart;
192  std::unique_ptr<SwRedlineSaveDatas> m_pRedlineSaveData;
193  sal_uLong m_nMoveLen; // Index into UndoNodes-Array.
195 
196 protected:
197  SwNodeIndex* GetMvSttIdx() const { return m_pMovedStart.get(); }
198  sal_uLong GetMvNodeCnt() const { return m_nMoveLen; }
199 
200 public:
203 
204  void SaveSection( const SwNodeIndex& rSttIdx );
205  void SaveSection(const SwNodeRange& rRange, bool bExpandNodes = true);
206  void RestoreSection( SwDoc* pDoc, SwNodeIndex* pIdx, sal_uInt16 nSectType );
207  void RestoreSection(SwDoc* pDoc, const SwNodeIndex& rInsPos, bool bForceCreateFrames = false);
208 
209  const SwHistory* GetHistory() const { return m_pHistory.get(); }
210  SwHistory* GetHistory() { return m_pHistory.get(); }
211 };
212 
213 // This class saves the PaM as sal_uInt16's and is able to restore it
214 // into a PaM.
215 class SwUndRng
216 {
217 public:
218  sal_uLong m_nSttNode, m_nEndNode;
219  sal_Int32 m_nSttContent, m_nEndContent;
220 
221  SwUndRng();
222  SwUndRng( const SwPaM& );
223 
224  void SetValues( const SwPaM& rPam );
225  void SetPaM( SwPaM&, bool bCorrToContent = false ) const;
226  SwPaM & AddUndoRedoPaM(
227  ::sw::UndoRedoContext &, bool const bCorrToContent = false) const;
228 };
229 
230 class SwUndoInsLayFormat;
231 
232 namespace sw {
233 
234 std::unique_ptr<std::vector<SwFrameFormat*>>
235 GetFlysAnchoredAt(SwDoc & rDoc, sal_uLong nSttNode);
236 
237 }
238 
239 // base class for insertion of Document, Glossaries and Copy
240 class SwUndoInserts : public SwUndo, public SwUndRng, private SwUndoSaveContent
241 {
243  std::unique_ptr<std::vector<SwFrameFormat*>> m_pFrameFormats;
244  std::vector< std::shared_ptr<SwUndoInsLayFormat> > m_FlyUndos;
245  std::unique_ptr<SwRedlineData> m_pRedlineData;
247 protected:
250  std::unique_ptr<SwNodeIndex> m_pUndoNodeIndex;
251  sal_uInt16 m_nSetPos; // Start in the history list.
252 
253  SwUndoInserts( SwUndoId nUndoId, const SwPaM& );
254 public:
255  virtual ~SwUndoInserts() override;
256 
257  virtual void UndoImpl( ::sw::UndoRedoContext & ) override;
258  virtual void RedoImpl( ::sw::UndoRedoContext & ) override;
259  virtual void RepeatImpl( ::sw::RepeatContext & ) override;
260 
261  // Set destination range after reading.
262  void SetInsertRange( const SwPaM&, bool bScanFlys = true,
263  bool bSttWasTextNd = true );
264 
265  static bool IsCreateUndoForNewFly(SwFormatAnchor const& rAnchor,
266  sal_uLong const nStartNode, sal_uLong const nEndNode);
267  std::vector<SwFrameFormat*> * GetFlysAnchoredAt() { return m_pFrameFormats.get(); }
268 };
269 
270 class SwUndoInsDoc final : public SwUndoInserts
271 {
272 public:
273  SwUndoInsDoc( const SwPaM& );
274 };
275 
276 class SwUndoCpyDoc final : public SwUndoInserts
277 {
278 public:
279  SwUndoCpyDoc( const SwPaM& );
280 };
281 
282 class SwUndoFlyBase : public SwUndo, private SwUndoSaveSection
283 {
284 protected:
285  SwFrameFormat* m_pFrameFormat; // The saved FlyFormat.
287  sal_Int32 m_nContentPos; // Page at/in paragraph.
289  bool m_bDelFormat; // Delete saved format.
290 
291  void InsFly(::sw::UndoRedoContext & rContext, bool bShowSel = true);
292  void DelFly( SwDoc* );
293 
294  SwUndoFlyBase( SwFrameFormat* pFormat, SwUndoId nUndoId );
295 
298 
299 public:
300  virtual ~SwUndoFlyBase() override;
301 
302 };
303 
305 {
306  sal_uLong mnCursorSaveIndexPara; // Cursor position
307  sal_Int32 const mnCursorSaveIndexPos; // for undo
308 public:
309  SwUndoInsLayFormat( SwFrameFormat* pFormat, sal_uLong nNodeIdx, sal_Int32 nCntIdx );
310 
311  virtual ~SwUndoInsLayFormat() override;
312 
313  virtual void UndoImpl( ::sw::UndoRedoContext & ) override;
314  virtual void RedoImpl( ::sw::UndoRedoContext & ) override;
315  virtual void RepeatImpl( ::sw::RepeatContext & ) override;
316 
317  virtual OUString GetComment() const override;
318 
319 };
320 
321 class SwUndoDelLayFormat final : public SwUndoFlyBase
322 {
324 public:
325  SwUndoDelLayFormat( SwFrameFormat* pFormat );
326 
327  virtual void UndoImpl( ::sw::UndoRedoContext & ) override;
328  virtual void RedoImpl( ::sw::UndoRedoContext & ) override;
329 
330  void RedoForRollback();
331 
332  void ChgShowSel( bool bNew ) { m_bShowSelFrame = bNew; }
333 
334  virtual SwRewriter GetRewriter() const override;
335 
336 };
337 
338 #endif
339 
340 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
std::vector< std::shared_ptr< SwUndoInsLayFormat > > m_FlyUndos
Definition: undobj.hxx:244
sal_uLong m_nStartPos
Definition: undobj.hxx:194
std::unique_ptr< SwRedlineSaveDatas > m_pRedlineSaveData
Definition: undobj.hxx:192
Represents the style of a paragraph.
Definition: fmtcol.hxx:55
Marks a position in the document model.
Definition: pam.hxx:35
std::unique_ptr< SwHistory > m_pHistory
Definition: undobj.hxx:156
std::unique_ptr< SwRedlineData > m_pRedlineData
Definition: undobj.hxx:245
SwUndoId
Definition: swundo.hxx:29
static bool FillSaveDataForFormat(const SwPaM &, SwRedlineSaveDatas &)
Definition: undobj.cxx:1419
virtual void Repeat(SfxRepeatTarget &) override
Definition: undobj.cxx:241
sal_uIntPtr sal_uLong
std::vector< SwFrameFormat * > * GetFlysAnchoredAt()
Definition: undobj.hxx:267
static ViewShellId CreateViewShellId(const SwDoc *pDoc)
Try to obtain the view shell ID of the current view.
Definition: undobj.cxx:167
Definition: doc.hxx:185
~SwUndoSaveContent() COVERITY_NOEXCEPT_FALSE
Definition: undobj.cxx:697
void SetRedlineFlags(RedlineFlags eMode)
Definition: undobj.hxx:119
sal_Int32 m_nContentPos
Definition: undobj.hxx:287
const SwHistory * GetHistory() const
Definition: undobj.hxx:209
Dialog to specify the properties of date form field.
std::unique_ptr< std::vector< SwFrameFormat * > > m_pFrameFormats
Definition: undobj.hxx:243
sal_Int32 const mnCursorSaveIndexPos
Definition: undobj.hxx:307
static void RemoveIdxFromSection(SwDoc &, sal_uLong nSttIdx, const sal_uLong *pEndIdx=nullptr)
Definition: undobj.cxx:114
void ChgShowSel(bool bNew)
Definition: undobj.hxx:332
SwUndoId GetId() const
Definition: undobj.hxx:100
virtual void RepeatImpl(::sw::RepeatContext &)
Definition: undobj.cxx:261
SwUndoId const m_nId
Definition: undobj.hxx:54
sal_uLong m_nMoveLen
Definition: undobj.hxx:193
RedlineFlags m_nOrigRedlineFlags
Definition: undobj.hxx:55
virtual SwRewriter GetRewriter() const
Returns the rewriter for this object.
Definition: undobj.cxx:687
static bool CanRedlineGroup(SwRedlineSaveDatas &rCurr, const SwRedlineSaveDatas &rCheck, bool bCurrIsEnd)
Definition: undobj.cxx:1476
SwHistory * GetHistory()
Definition: undobj.hxx:210
static void MoveToUndoNds(SwPaM &rPam, SwNodeIndex *pNodeIdx, sal_uLong *pEndNdIdx=nullptr)
Definition: undobj.cxx:709
static void RemoveIdxFromRange(SwPaM &rPam, bool bMoveNext)
Definition: undobj.cxx:124
virtual bool CanRepeat(SfxRepeatTarget &) const override
Definition: undobj.cxx:253
RedlineFlags GetRedlineFlags() const
Definition: undobj.hxx:118
sal_uLong m_nNodePagePos
Definition: undobj.hxx:286
SwNodeIndex * GetMvSttIdx() const
Definition: undobj.hxx:296
static void MovePtForward(SwPaM &rPam, bool bMvBkwrd)
Definition: undobj.cxx:818
PaM is Point and Mark: a selection of the document model.
Definition: pam.hxx:136
virtual void UndoImpl(::sw::UndoRedoContext &)=0
Style of a layout element.
Definition: frmfmt.hxx:57
static bool HasHiddenRedlines(const SwRedlineSaveDatas &rSData)
Definition: undobj.cxx:1468
SwFrameFormat * m_pFrameFormat
Definition: undobj.hxx:285
void DelContentIndex(const SwPosition &pMark, const SwPosition &pPoint, DelContentType nDelContentType=DelContentType::AllMask)
Definition: undobj.cxx:843
static void SetSaveData(SwDoc &rDoc, SwRedlineSaveDatas &rSData)
Definition: undobj.cxx:1449
FlyAnchors.
Definition: fmtanchr.hxx:34
virtual void UndoWithContext(SfxUndoContext &) override
Definition: undobj.cxx:223
bool m_bDelFormat
Definition: undobj.hxx:289
boost::optional< OUString > maComment
Definition: undobj.hxx:61
RndStdIds m_nRndId
Definition: undobj.hxx:288
Marks a node in the document model.
Definition: ndindex.hxx:31
bool m_bCacheComment
Definition: undobj.hxx:60
static bool MovePtBackward(SwPaM &rPam)
Definition: undobj.cxx:805
sal_uLong m_nNodeDiff
Definition: undobj.hxx:248
virtual OUString GetComment() const override
Returns textual comment for this undo object.
Definition: undobj.cxx:653
std::unique_ptr< SwNodeIndex > m_pMovedStart
Definition: undobj.hxx:191
sal_uLong GetMvNodeCnt() const
Definition: undobj.hxx:297
sal_uLong m_nSttNode
Definition: undobj.hxx:218
sal_uLong GetMvNodeCnt() const
Definition: undobj.hxx:198
static void MoveFromUndoNds(SwDoc &rDoc, sal_uLong nNodeIdx, SwPosition &rInsPos, const sal_uLong *pEndNdIdx=nullptr, bool bForceCreateFrames=false)
Definition: undobj.cxx:746
DelContentType
Definition: undobj.hxx:132
ViewShellId const m_nViewShellId
Definition: undobj.hxx:56
virtual ~SwUndo() override
Definition: undobj.cxx:186
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:1547
SwTextFormatColl * m_pTextFormatColl
Definition: undobj.hxx:242
SwUndo(SwUndoId const nId, const SwDoc *pDoc)
Definition: undobj.cxx:159
bool m_isRepeatIgnored
for multi-selection, only repeat 1st selection
Definition: undobj.hxx:57
virtual void Redo() override
Definition: undobj.cxx:218
void IgnoreRepeat()
Definition: undobj.hxx:129
SwNodeIndex * GetMvSttIdx() const
Definition: undobj.hxx:197
virtual void RedoWithContext(SfxUndoContext &) override
Definition: undobj.cxx:232
static void RemoveIdxRel(sal_uLong, const SwPosition &)
Definition: undobj.cxx:151
std::unique_ptr< std::vector< SwFrameFormat * > > GetFlysAnchoredAt(SwDoc &rDoc, sal_uLong const nSttNode)
Definition: untblk.cxx:39
virtual void RedoImpl(::sw::UndoRedoContext &)=0
virtual void Undo() override
Definition: undobj.cxx:213
bool m_bStartWasTextNode
Definition: undobj.hxx:246
RndStdIds
static bool FillSaveData(const SwPaM &rRange, SwRedlineSaveDatas &rSData, bool bDelRange=true, bool bCopyNext=true)
Definition: undobj.cxx:1384
ViewShellId GetViewShellId() const override
See SfxUndoAction::GetViewShellId().
Definition: undobj.cxx:682
sal_uInt16 m_nSetPos
Definition: undobj.hxx:251
bool IsDelBox() const
Definition: undobj.cxx:180
sal_Int32 m_nSttContent
Definition: undobj.hxx:219
sal_uLong mnCursorSaveIndexPara
Definition: undobj.hxx:306
std::unique_ptr< SwNodeIndex > m_pUndoNodeIndex
start of Content in UndoNodes for Redo
Definition: undobj.hxx:250