sw/source/core/inc/UndoCore.hxx

   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 #ifndef INCLUDED_SW_SOURCE_CORE_INC_UNDOCORE_HXX
  21 #define INCLUDED_SW_SOURCE_CORE_INC_UNDOCORE_HXX
  22
  23 #include <undobj.hxx>
  24 #include <calbck.hxx>
  25 #include <rtl/ustring.hxx>
  26 #include <redline.hxx>
  27 #include <numrule.hxx>
  28
  29 #include <memory>
  30 #include <vector>
  31
  32 class SfxItemSet;
  33 class SwFormatColl;
  34 class SwFormatAnchor;
  35 class SdrMarkList;
  36 class SwUndoDelete;
  37
  38 namespace sw {
  39     class UndoManager;
  40     class IShellCursorSupplier;
  41 }
  42
  43 class SwRedlineSaveData final : public SwUndRng, public SwRedlineData, private SwUndoSaveSection
  44 {
  45 public:
  46     SwRedlineSaveData(
  47         SwComparePosition eCmpPos,
  48         const SwPosition& rSttPos,
  49         const SwPosition& rEndPos,
  50         SwRangeRedline& rRedl,
  51         bool bCopyNext );
  52
  53     ~SwRedlineSaveData();
  54
  55     void RedlineToDoc( SwPaM const & rPam );
  56
  57     const SwNodeIndex* GetMvSttIdx() const
  58     {
  59         return SwUndoSaveSection::GetMvSttIdx();
  60     }
  61
  62 #if OSL_DEBUG_LEVEL > 0
  63     sal_uInt16 m_nRedlineCount;
  64     bool m_bRedlineMoved;
  65 #endif
  66 };
  67
  68 class SwRedlineSaveDatas {
  69 private:
  70     std::vector<std::unique_ptr<SwRedlineSaveData>> m_Data;
  71
  72 public:
  73     SwRedlineSaveDatas() : m_Data() {}
  74
  75     void clear() { m_Data.clear(); }
  76     bool empty() const { return m_Data.empty(); }
  77     size_t size() const { return m_Data.size(); }
  78     void push_back(std::unique_ptr<SwRedlineSaveData> pNew) { m_Data.push_back(std::move(pNew)); }
  79     const SwRedlineSaveData& operator[](size_t const nIdx) const { return *m_Data[ nIdx ]; }
  80     SwRedlineSaveData& operator[](size_t const nIdx) { return *m_Data[ nIdx ]; }
  81 };
  82
  83 namespace sw {
  84 class UndoRedoContext final
  85     : public SfxUndoContext
  86 {
  87 public:
  88     UndoRedoContext(SwDoc & rDoc, IShellCursorSupplier & rCursorSupplier)
  89         : m_rDoc(rDoc)
  90         , m_rCursorSupplier(rCursorSupplier)
  91         , m_pSelFormat(nullptr)
  92         , m_pMarkList(nullptr)
  93     { }
  94
  95     SwDoc & GetDoc() const { return m_rDoc; }
  96
  97     IShellCursorSupplier & GetCursorSupplier() { return m_rCursorSupplier; }
  98
  99     void SetSelections(SwFrameFormat *const pSelFormat, SdrMarkList *const pMarkList)
 100     {
 101         m_pSelFormat = pSelFormat;
 102         m_pMarkList = pMarkList;
 103     }
 104     void GetSelections(SwFrameFormat *& o_rpSelFormat, SdrMarkList *& o_rpMarkList)
 105     {
 106         o_rpSelFormat = m_pSelFormat;
 107         o_rpMarkList = m_pMarkList;
 108     }
 109
 110     void SetUndoOffset(size_t nUndoOffset) { m_nUndoOffset = nUndoOffset; }
 111
 112     size_t GetUndoOffset() override { return m_nUndoOffset; }
 113
 114 private:
 115     SwDoc & m_rDoc;
 116     IShellCursorSupplier & m_rCursorSupplier;
 117     SwFrameFormat * m_pSelFormat;
 118     SdrMarkList * m_pMarkList;
 119     size_t m_nUndoOffset = 0;
 120 };
 121
 122 class RepeatContext final
 123     : public SfxRepeatTarget
 124 {
 125 public:
 126     RepeatContext(SwDoc & rDoc, SwPaM & rPaM)
 127         : m_rDoc(rDoc)
 128         , m_pCurrentPaM(& rPaM)
 129         , m_bDeleteRepeated(false)
 130     { }
 131
 132     SwDoc & GetDoc() const { return m_rDoc; }
 133
 134     SwPaM & GetRepeatPaM()
 135     {
 136         return *m_pCurrentPaM;
 137     }
 138
 139 private:
 140     friend class ::sw::UndoManager;
 141     friend class ::SwUndoDelete;
 142
 143     SwDoc & m_rDoc;
 144     SwPaM * m_pCurrentPaM;
 145     bool m_bDeleteRepeated; /// has a delete action been repeated?
 146 };
 147
 148 } // namespace sw
 149
 150 class SwUndoFormatColl final : public SwUndo, private SwUndRng
 151 {
 152     OUString maFormatName;
 153     std::unique_ptr<SwHistory> mpHistory;
 154     // for correct <ReDo(..)> and <Repeat(..)>
 155     // boolean, which indicates that the attributes are reset at the nodes
 156     // before the format has been applied.
 157     const bool mbReset;
 158     // boolean, which indicates that the list attributes had been reset at
 159     // the nodes before the format has been applied.
 160     const bool mbResetListAttrs;
 161
 162     void DoSetFormatColl(SwDoc & rDoc, SwPaM const & rPaM);
 163
 164 public:
 165     SwUndoFormatColl( const SwPaM&, const SwFormatColl*,
 166                    const bool bReset,
 167                    const bool bResetListAttrs );
 168     virtual ~SwUndoFormatColl() override;
 169
 170     virtual void UndoImpl( ::sw::UndoRedoContext & ) override;
 171     virtual void RedoImpl( ::sw::UndoRedoContext & ) override;
 172     virtual void RepeatImpl( ::sw::RepeatContext & ) override;
 173
 174     /**
 175        Returns the rewriter for this undo object.
 176
 177        The rewriter contains one rule:
 178
 179            $1 -> <name of format collection>
 180
 181        <name of format collection> is the name of the format
 182        collection that is applied by the action recorded by this undo
 183        object.
 184
 185        @return the rewriter for this undo object
 186     */
 187     virtual SwRewriter GetRewriter() const override;
 188
 189     SwHistory* GetHistory() { return mpHistory.get(); }
 190
 191 };
 192
 193 class SwUndoSetFlyFormat final : public SwUndo, public SwClient
 194 {
 195     SwFrameFormat* m_pFrameFormat;                  // saved FlyFormat
 196     const OUString m_DerivedFromFormatName;
 197     const OUString m_NewFormatName;
 198     std::optional<SfxItemSet> m_oItemSet;               // the re-/ set attributes
 199     SwNodeOffset m_nOldNode, m_nNewNode;
 200     sal_Int32 m_nOldContent, m_nNewContent;
 201     RndStdIds m_nOldAnchorType, m_nNewAnchorType;
 202     bool m_bAnchorChanged;
 203
 204     void PutAttr( sal_uInt16 nWhich, const SfxPoolItem* pItem );
 205     void SwClientNotify(const SwModify&, const SfxHint&) override;
 206     void GetAnchor( SwFormatAnchor& rAnhor, SwNodeOffset nNode, sal_Int32 nContent );
 207
 208 public:
 209     SwUndoSetFlyFormat( SwFrameFormat& rFlyFormat, const SwFrameFormat& rNewFrameFormat );
 210     virtual ~SwUndoSetFlyFormat() override;
 211
 212     virtual void UndoImpl( ::sw::UndoRedoContext & ) override;
 213     virtual void RedoImpl( ::sw::UndoRedoContext & ) override;
 214
 215     virtual SwRewriter GetRewriter() const override;
 216 };
 217
 218 class SwUndoOutlineLeftRight final : public SwUndo, private SwUndRng
 219 {
 220     short m_nOffset;
 221
 222 public:
 223     SwUndoOutlineLeftRight( const SwPaM& rPam, short nOffset );
 224
 225     virtual void UndoImpl( ::sw::UndoRedoContext & ) override;
 226     virtual void RedoImpl( ::sw::UndoRedoContext & ) override;
 227     virtual void RepeatImpl( ::sw::RepeatContext & ) override;
 228 };
 229
 230 class SwUndoOutlineEdit final : public SwUndo, private SwUndRng
 231 {
 232     SwNumRule m_aNewNumRule;
 233     SwNumRule m_aOldNumRule;
 234
 235 public:
 236     SwUndoOutlineEdit(const SwNumRule& rOldRule, const SwNumRule& rNewRule, const SwDoc& rDoc);
 237
 238     virtual void UndoImpl(::sw::UndoRedoContext&) override;
 239     virtual void RedoImpl(::sw::UndoRedoContext&) override;
 240     virtual void RepeatImpl(::sw::RepeatContext&) override;
 241 };
 242
 243 const int nUndoStringLength = 20;
 244
 245 /**
 246    Shortens a string to a maximum length.
 247
 248    @param rStr      the string to be shortened
 249    @param nLength   the maximum length for rStr
 250    @param aFillStr  string to replace cut out characters with
 251
 252    If rStr has less than nLength characters it will be returned unaltered.
 253
 254    If rStr has more than nLength characters the following algorithm
 255    generates the shortened string:
 256
 257        frontLength = (nLength - length(aFillStr)) / 2
 258        rearLength = nLength - length(aFillStr) - frontLength
 259        shortenedString = concat(<first frontLength characters of rStr,
 260                                 aFillStr,
 261                                 <last rearLength characters of rStr>)
 262
 263    Preconditions:
 264       - nLength - length(aFillStr) >= 2
 265
 266    @return the shortened string
 267  */
 268 OUString
 269 ShortenString(const OUString & rStr, sal_Int32 nLength, std::u16string_view aFillStr);
 270 /**
 271    Denotes special characters in a string.
 272
 273    The rStr is split into parts containing special characters and
 274    parts not containing special characters. In a part containing
 275    special characters all characters are equal. These parts are
 276    maximal.
 277
 278    @param aStr     the string to denote in
 279    @param bQuoted  add quotation marks to the text
 280
 281    The resulting string is generated by concatenating the found
 282    parts. The parts without special characters are surrounded by
 283    "'". The parts containing special characters are denoted as "n x",
 284    where n is the length of the part and x is the representation of
 285    the special character (i. e. "tab(s)").
 286
 287    @return the denoted string
 288 */
 289 OUString DenoteSpecialCharacters(std::u16string_view aStr, bool bQuoted = true);
 290
 291 #endif // INCLUDED_SW_SOURCE_CORE_INC_UNDOCORE_HXX
 292
 293 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */