Line data Source code
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 :
20 : #include <UndoManager.hxx>
21 :
22 : #include <vcl/wrkwin.hxx>
23 : #include <svx/svdmodel.hxx>
24 : #include <swmodule.hxx>
25 : #include <doc.hxx>
26 : #include <drawdoc.hxx>
27 : #include <ndarr.hxx>
28 : #include <pam.hxx>
29 : #include <ndtxt.hxx>
30 : #include <swundo.hxx>
31 : #include <UndoCore.hxx>
32 : #include <rolbck.hxx>
33 : #include <undo.hrc>
34 : #include <editsh.hxx>
35 : #include <unobaseclass.hxx>
36 : #include <limits>
37 : #include <IDocumentDrawModelAccess.hxx>
38 : #include <IDocumentRedlineAccess.hxx>
39 : #include <IDocumentState.hxx>
40 :
41 : using namespace ::com::sun::star;
42 :
43 : // the undo array should never grow beyond this limit:
44 : #define UNDO_ACTION_LIMIT (USHRT_MAX - 1000)
45 :
46 : namespace sw {
47 :
48 2958 : UndoManager::UndoManager(boost::shared_ptr<SwNodes> xUndoNodes,
49 : IDocumentDrawModelAccess & rDrawModelAccess,
50 : IDocumentRedlineAccess & rRedlineAccess,
51 : IDocumentState & rState)
52 : : m_rDrawModelAccess(rDrawModelAccess)
53 : , m_rRedlineAccess(rRedlineAccess)
54 : , m_rState(rState)
55 : , m_xUndoNodes(xUndoNodes)
56 : , m_bGroupUndo(true)
57 : , m_bDrawUndo(true)
58 : , m_bLockUndoNoModifiedPosition(false)
59 2958 : , m_UndoSaveMark(MARK_INVALID)
60 : {
61 : OSL_ASSERT(m_xUndoNodes.get());
62 : // writer expects it to be disabled initially
63 : // Undo is enabled by SwEditShell constructor
64 2958 : SdrUndoManager::EnableUndo(false);
65 2958 : }
66 :
67 0 : SwNodes const& UndoManager::GetUndoNodes() const
68 : {
69 0 : return *m_xUndoNodes;
70 : }
71 :
72 41676 : SwNodes & UndoManager::GetUndoNodes()
73 : {
74 41676 : return *m_xUndoNodes;
75 : }
76 :
77 8366 : bool UndoManager::IsUndoNodes(SwNodes const& rNodes) const
78 : {
79 8366 : return & rNodes == m_xUndoNodes.get();
80 : }
81 :
82 91701 : void UndoManager::DoUndo(bool const bDoUndo)
83 : {
84 91701 : if(!isTextEditActive())
85 : {
86 91701 : EnableUndo(bDoUndo);
87 :
88 91701 : SwDrawModel*const pSdrModel = m_rDrawModelAccess.GetDrawModel();
89 91701 : if( pSdrModel )
90 : {
91 85785 : pSdrModel->EnableUndo(bDoUndo);
92 : }
93 : }
94 91701 : }
95 :
96 2051662 : bool UndoManager::DoesUndo() const
97 : {
98 2051662 : if(isTextEditActive())
99 : {
100 4 : return false;
101 : }
102 : else
103 : {
104 2051658 : return IsUndoEnabled();
105 : }
106 : }
107 :
108 237204 : void UndoManager::DoGroupUndo(bool const bDoUndo)
109 : {
110 237204 : m_bGroupUndo = bDoUndo;
111 237204 : }
112 :
113 127131 : bool UndoManager::DoesGroupUndo() const
114 : {
115 127131 : return m_bGroupUndo;
116 : }
117 :
118 1089 : void UndoManager::DoDrawUndo(bool const bDoUndo)
119 : {
120 1089 : m_bDrawUndo = bDoUndo;
121 1089 : }
122 :
123 6194 : bool UndoManager::DoesDrawUndo() const
124 : {
125 6194 : return m_bDrawUndo;
126 : }
127 :
128 5842 : bool UndoManager::IsUndoNoResetModified() const
129 : {
130 5842 : return MARK_INVALID == m_UndoSaveMark;
131 : }
132 :
133 41 : void UndoManager::SetUndoNoResetModified()
134 : {
135 41 : if (MARK_INVALID != m_UndoSaveMark)
136 : {
137 41 : RemoveMark(m_UndoSaveMark);
138 41 : m_UndoSaveMark = MARK_INVALID;
139 : }
140 41 : }
141 :
142 38030 : void UndoManager::SetUndoNoModifiedPosition()
143 : {
144 38030 : if (!m_bLockUndoNoModifiedPosition)
145 : {
146 37818 : m_UndoSaveMark = MarkTopUndoAction();
147 : }
148 38030 : }
149 :
150 70 : void UndoManager::LockUndoNoModifiedPosition()
151 : {
152 70 : m_bLockUndoNoModifiedPosition = true;
153 70 : }
154 :
155 27 : void UndoManager::UnLockUndoNoModifiedPosition()
156 : {
157 27 : m_bLockUndoNoModifiedPosition = false;
158 27 : }
159 :
160 671 : SwUndo* UndoManager::GetLastUndo()
161 : {
162 671 : if (!SdrUndoManager::GetUndoActionCount(CurrentLevel))
163 : {
164 536 : return 0;
165 : }
166 135 : SfxUndoAction *const pAction( SdrUndoManager::GetUndoAction(0) );
167 135 : return dynamic_cast<SwUndo*>(pAction);
168 : }
169 :
170 35432 : void UndoManager::AppendUndo(SwUndo *const pUndo)
171 : {
172 35432 : AddUndoAction(pUndo);
173 35432 : }
174 :
175 18368 : void UndoManager::ClearRedo()
176 : {
177 18368 : return SdrUndoManager::ImplClearRedo_NoLock(TopLevel);
178 : }
179 :
180 3241 : void UndoManager::DelAllUndoObj()
181 : {
182 3241 : ::sw::UndoGuard const undoGuard(*this);
183 :
184 3241 : SdrUndoManager::ClearAllLevels();
185 :
186 3241 : m_UndoSaveMark = MARK_INVALID;
187 3241 : }
188 :
189 : SwUndoId
190 121956 : UndoManager::StartUndo(SwUndoId const i_eUndoId,
191 : SwRewriter const*const pRewriter)
192 : {
193 121956 : if (!IsUndoEnabled())
194 : {
195 113806 : return UNDO_EMPTY;
196 : }
197 :
198 8150 : SwUndoId const eUndoId( (i_eUndoId == UNDO_EMPTY) ? UNDO_START : i_eUndoId );
199 :
200 : OSL_ASSERT(UNDO_END != eUndoId);
201 : OUString comment( (UNDO_START == eUndoId)
202 : ? OUString("??")
203 8150 : : OUString(SW_RES(UNDO_BASE + eUndoId)) );
204 8150 : if (pRewriter)
205 : {
206 : OSL_ASSERT(UNDO_START != eUndoId);
207 1806 : comment = pRewriter->Apply(comment);
208 : }
209 :
210 8150 : SdrUndoManager::EnterListAction(comment, comment, eUndoId);
211 :
212 8150 : return eUndoId;
213 : }
214 :
215 : SwUndoId
216 119556 : UndoManager::EndUndo(SwUndoId const i_eUndoId, SwRewriter const*const pRewriter)
217 : {
218 119556 : if (!IsUndoEnabled())
219 : {
220 111406 : return UNDO_EMPTY;
221 : }
222 :
223 7878 : SwUndoId const eUndoId( ((i_eUndoId == UNDO_EMPTY) || (UNDO_START == i_eUndoId))
224 16027 : ? UNDO_END : i_eUndoId );
225 : OSL_ENSURE(!((UNDO_END == eUndoId) && pRewriter),
226 : "EndUndo(): no Undo ID, but rewriter given?");
227 :
228 : SfxUndoAction *const pLastUndo(
229 8150 : (0 == SdrUndoManager::GetUndoActionCount(CurrentLevel))
230 8150 : ? 0 : SdrUndoManager::GetUndoAction(0) );
231 :
232 8150 : int const nCount = LeaveListAction();
233 :
234 8150 : if (nCount) // otherwise: empty list action not inserted!
235 : {
236 : OSL_ASSERT(pLastUndo);
237 : OSL_ASSERT(UNDO_START != eUndoId);
238 7437 : SfxUndoAction *const pUndoAction(SdrUndoManager::GetUndoAction(0));
239 : SfxListUndoAction *const pListAction(
240 7437 : dynamic_cast<SfxListUndoAction*>(pUndoAction));
241 : OSL_ASSERT(pListAction);
242 7437 : if (pListAction)
243 : {
244 7437 : if (UNDO_END != eUndoId)
245 : {
246 : OSL_ENSURE(pListAction->GetId() == eUndoId,
247 : "EndUndo(): given ID different from StartUndo()");
248 : // comment set by caller of EndUndo
249 3518 : OUString comment = SW_RES(UNDO_BASE + eUndoId);
250 3518 : if (pRewriter)
251 : {
252 1 : comment = pRewriter->Apply(comment);
253 : }
254 3518 : pListAction->SetComment(comment);
255 : }
256 3919 : else if ((UNDO_START != pListAction->GetId()))
257 : {
258 : // comment set by caller of StartUndo: nothing to do here
259 : }
260 2110 : else if (pLastUndo)
261 : {
262 : // comment was not set at StartUndo or EndUndo:
263 : // take comment of last contained action
264 : // (note that this works recursively, i.e. the last contained
265 : // action may be a list action created by StartUndo/EndUndo)
266 2110 : OUString const comment(pLastUndo->GetComment());
267 2110 : pListAction->SetComment(comment);
268 : }
269 : else
270 : {
271 : OSL_ENSURE(false, "EndUndo(): no comment?");
272 : }
273 : }
274 : }
275 :
276 8150 : return eUndoId;
277 : }
278 :
279 : bool
280 1435 : UndoManager::GetLastUndoInfo(
281 : OUString *const o_pStr, SwUndoId *const o_pId) const
282 : {
283 : // this is actually expected to work on the current level,
284 : // but that was really not obvious from the previous implementation...
285 1435 : if (!SdrUndoManager::GetUndoActionCount(CurrentLevel))
286 : {
287 450 : return false;
288 : }
289 :
290 985 : SfxUndoAction *const pAction( SdrUndoManager::GetUndoAction(0) );
291 :
292 985 : if (o_pStr)
293 : {
294 491 : *o_pStr = pAction->GetComment();
295 : }
296 985 : if (o_pId)
297 : {
298 3 : sal_uInt16 const nId(pAction->GetId());
299 3 : *o_pId = static_cast<SwUndoId>(nId);
300 : }
301 :
302 985 : return true;
303 : }
304 :
305 0 : SwUndoComments_t UndoManager::GetUndoComments() const
306 : {
307 : OSL_ENSURE(!SdrUndoManager::IsInListAction(),
308 : "GetUndoComments() called while in list action?");
309 :
310 0 : SwUndoComments_t ret;
311 0 : const size_t nUndoCount(SdrUndoManager::GetUndoActionCount(TopLevel));
312 0 : for (size_t n = 0; n < nUndoCount; ++n)
313 : {
314 : OUString const comment(
315 0 : SdrUndoManager::GetUndoActionComment(n, TopLevel));
316 0 : ret.push_back(comment);
317 0 : }
318 :
319 0 : return ret;
320 : }
321 :
322 958 : bool UndoManager::GetFirstRedoInfo(OUString *const o_pStr,
323 : SwUndoId *const o_pId) const
324 : {
325 958 : if (!SdrUndoManager::GetRedoActionCount(CurrentLevel))
326 : {
327 921 : return false;
328 : }
329 :
330 37 : SfxUndoAction *const pAction( SdrUndoManager::GetRedoAction(0, CurrentLevel) );
331 37 : if ( pAction == NULL )
332 : {
333 0 : return false;
334 : }
335 :
336 37 : if (o_pStr)
337 : {
338 18 : *o_pStr = pAction->GetComment();
339 : }
340 37 : if (o_pId)
341 : {
342 1 : sal_uInt16 const nId(pAction->GetId());
343 1 : *o_pId = static_cast<SwUndoId>(nId);
344 : }
345 :
346 37 : return true;
347 : }
348 :
349 0 : SwUndoComments_t UndoManager::GetRedoComments() const
350 : {
351 : OSL_ENSURE(!SdrUndoManager::IsInListAction(),
352 : "GetRedoComments() called while in list action?");
353 :
354 0 : SwUndoComments_t ret;
355 0 : const size_t nRedoCount(SdrUndoManager::GetRedoActionCount(TopLevel));
356 0 : for (size_t n = 0; n < nRedoCount; ++n)
357 : {
358 : OUString const comment(
359 0 : SdrUndoManager::GetRedoActionComment(n, TopLevel));
360 0 : ret.push_back(comment);
361 0 : }
362 :
363 0 : return ret;
364 : }
365 :
366 9 : SwUndoId UndoManager::GetRepeatInfo(OUString *const o_pStr) const
367 : {
368 9 : SwUndoId nRepeatId(UNDO_EMPTY);
369 9 : GetLastUndoInfo(o_pStr, & nRepeatId);
370 9 : if( REPEAT_START <= nRepeatId && REPEAT_END > nRepeatId )
371 : {
372 0 : return nRepeatId;
373 : }
374 9 : if (o_pStr) // not repeatable -> clear comment
375 : {
376 0 : o_pStr->clear();
377 : }
378 9 : return UNDO_EMPTY;
379 : }
380 :
381 0 : SwUndo * UndoManager::RemoveLastUndo()
382 : {
383 0 : if (SdrUndoManager::GetRedoActionCount(CurrentLevel) ||
384 0 : SdrUndoManager::GetRedoActionCount(TopLevel))
385 : {
386 : OSL_ENSURE(false, "RemoveLastUndoAction(): there are Redo actions?");
387 0 : return 0;
388 : }
389 0 : if (!SdrUndoManager::GetUndoActionCount(CurrentLevel))
390 : {
391 : OSL_ENSURE(false, "RemoveLastUndoAction(): no Undo actions");
392 0 : return 0;
393 : }
394 0 : SfxUndoAction *const pLastUndo(GetUndoAction(0));
395 0 : SdrUndoManager::RemoveLastUndoAction();
396 0 : return dynamic_cast<SwUndo *>(pLastUndo);
397 : }
398 :
399 : // svl::IUndoManager
400 :
401 91707 : void UndoManager::EnableUndo(bool bEnable)
402 : {
403 : // SdrUndoManager does not have a counter anymore, but reverted to the old behavior of
404 : // having a simple boolean flag for locking. So, simply forward.
405 91707 : SdrUndoManager::EnableUndo(bEnable);
406 91707 : }
407 :
408 35473 : void UndoManager::AddUndoAction(SfxUndoAction *pAction, bool bTryMerge)
409 : {
410 35473 : SwUndo *const pUndo( dynamic_cast<SwUndo *>(pAction) );
411 35473 : if (pUndo)
412 : {
413 35432 : if (nsRedlineMode_t::REDLINE_NONE == pUndo->GetRedlineMode())
414 : {
415 35426 : pUndo->SetRedlineMode( m_rRedlineAccess.GetRedlineMode() );
416 : }
417 : }
418 35473 : SdrUndoManager::AddUndoAction(pAction, bTryMerge);
419 : // if the undo nodes array is too large, delete some actions
420 70946 : while (UNDO_ACTION_LIMIT < GetUndoNodes().Count())
421 : {
422 0 : RemoveOldestUndoActions(1);
423 : }
424 35473 : }
425 :
426 : class CursorGuard
427 : {
428 : public:
429 37 : CursorGuard(SwEditShell & rShell, bool const bSave)
430 : : m_rShell(rShell)
431 37 : , m_bSaveCursor(bSave)
432 : {
433 37 : if (m_bSaveCursor)
434 : {
435 0 : m_rShell.Push(); // prevent modification of current cursor
436 : }
437 37 : }
438 37 : ~CursorGuard()
439 : {
440 37 : if (m_bSaveCursor)
441 : {
442 0 : m_rShell.Pop( false );
443 : }
444 37 : }
445 : private:
446 : SwEditShell & m_rShell;
447 : bool const m_bSaveCursor;
448 : };
449 :
450 46 : bool UndoManager::impl_DoUndoRedo(UndoOrRedo_t const undoOrRedo)
451 : {
452 46 : SwDoc & rDoc(*GetUndoNodes().GetDoc());
453 :
454 46 : UnoActionContext c(& rDoc); // exception-safe StartAllAction/EndAllAction
455 :
456 46 : SwEditShell *const pEditShell( rDoc.GetEditShell() );
457 :
458 : OSL_ENSURE(pEditShell, "sw::UndoManager needs a SwEditShell!");
459 46 : if (!pEditShell)
460 : {
461 9 : throw uno::RuntimeException();
462 : }
463 :
464 : // in case the model has controllers locked, the Undo should not
465 : // change the view cursors!
466 37 : bool const bSaveCursors(pEditShell->CursorsLocked());
467 74 : CursorGuard aCursorGuard(*pEditShell, bSaveCursors);
468 37 : if (!bSaveCursors)
469 : {
470 : // (in case Undo was called via API) clear the cursors:
471 37 : pEditShell->KillPams();
472 37 : pEditShell->SetMark();
473 37 : pEditShell->ClearMark();
474 : }
475 :
476 37 : bool bRet(false);
477 :
478 74 : ::sw::UndoRedoContext context(rDoc, *pEditShell);
479 :
480 : // N.B. these may throw!
481 37 : if (UNDO == undoOrRedo)
482 : {
483 31 : bRet = SdrUndoManager::UndoWithContext(context);
484 : }
485 : else
486 : {
487 6 : bRet = SdrUndoManager::RedoWithContext(context);
488 : }
489 :
490 33 : if (bRet)
491 : {
492 : // if we are at the "last save" position, the document is not modified
493 33 : if (SdrUndoManager::HasTopUndoActionMark(m_UndoSaveMark))
494 : {
495 2 : m_rState.ResetModified();
496 : }
497 : else
498 : {
499 31 : m_rState.SetModified();
500 : }
501 : }
502 :
503 33 : pEditShell->HandleUndoRedoContext(context);
504 :
505 79 : return bRet;
506 : }
507 :
508 40 : bool UndoManager::Undo()
509 : {
510 40 : if(isTextEditActive())
511 : {
512 0 : return SdrUndoManager::Undo();
513 : }
514 : else
515 : {
516 40 : return impl_DoUndoRedo(UNDO);
517 : }
518 : }
519 :
520 6 : bool UndoManager::Redo()
521 : {
522 6 : if(isTextEditActive())
523 : {
524 0 : return SdrUndoManager::Redo();
525 : }
526 : else
527 : {
528 6 : return impl_DoUndoRedo(REDO);
529 : }
530 : }
531 :
532 : /** N.B.: this does _not_ call SdrUndoManager::Repeat because it is not
533 : possible to wrap a list action around it:
534 : calling EnterListAction here will cause SdrUndoManager::Repeat
535 : to repeat the list action!
536 : */
537 0 : bool UndoManager::Repeat(::sw::RepeatContext & rContext,
538 : sal_uInt16 const nRepeatCount)
539 : {
540 0 : if (SdrUndoManager::IsInListAction())
541 : {
542 : OSL_ENSURE(false, "repeat in open list action???");
543 0 : return false;
544 : }
545 0 : if (!SdrUndoManager::GetUndoActionCount(TopLevel))
546 : {
547 0 : return false;
548 : }
549 0 : SfxUndoAction *const pRepeatAction(GetUndoAction(0));
550 : OSL_ASSERT(pRepeatAction);
551 0 : if (!pRepeatAction || !pRepeatAction->CanRepeat(rContext))
552 : {
553 0 : return false;
554 : }
555 :
556 0 : OUString const comment(pRepeatAction->GetComment());
557 0 : OUString const rcomment(pRepeatAction->GetRepeatComment(rContext));
558 0 : sal_uInt16 const nId(pRepeatAction->GetId());
559 0 : if (DoesUndo())
560 : {
561 0 : EnterListAction(comment, rcomment, nId);
562 : }
563 :
564 0 : SwPaM* pTmp = rContext.m_pCurrentPaM;
565 0 : for(SwPaM& rPaM : rContext.GetRepeatPaM().GetRingContainer())
566 : { // iterate over ring
567 0 : rContext.m_pCurrentPaM = &rPaM;
568 0 : for (sal_uInt16 nRptCnt = nRepeatCount; nRptCnt > 0; --nRptCnt)
569 : {
570 0 : pRepeatAction->Repeat(rContext);
571 : }
572 0 : rContext.m_bDeleteRepeated = false; // reset for next PaM
573 : }
574 0 : rContext.m_pCurrentPaM = pTmp;
575 :
576 0 : if (DoesUndo())
577 : {
578 0 : LeaveListAction();
579 : }
580 0 : return true;
581 : }
582 :
583 177 : } // namespace sw
584 :
585 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
