sw/inc/IDocumentMarkAccess.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_INC_IDOCUMENTMARKACCESS_HXX
  21 #define INCLUDED_SW_INC_IDOCUMENTMARKACCESS_HXX
  22
  23 #include <sal/types.h>
  24 #include "IMark.hxx"
  25 #include <memory>
  26 #include <optional>
  27
  28 class SwPaM;
  29 struct SwPosition;
  30 class SwTextNode;
  31 class SwCursorShell;
  32
  33 namespace sw::mark {
  34     class SaveBookmark; // FIXME: Ugly: SaveBookmark is a core-internal class, and should not be used in the interface
  35     class MarkBase;
  36 }
  37
  38 /** Provides access to the marks of a document.
  39 */
  40 class IDocumentMarkAccess
  41 {
  42     public:
  43         enum class MarkType
  44         {
  45             UNO_BOOKMARK,
  46             DDE_BOOKMARK,
  47             BOOKMARK,
  48             CROSSREF_HEADING_BOOKMARK,
  49             CROSSREF_NUMITEM_BOOKMARK,
  50             ANNOTATIONMARK,
  51             TEXT_FIELDMARK,
  52             CHECKBOX_FIELDMARK,
  53             DROPDOWN_FIELDMARK,
  54             DATE_FIELDMARK,
  55             NAVIGATOR_REMINDER
  56         };
  57
  58         /** wrapper iterator: wraps iterator of implementation while hiding
  59             MarkBase class; only IMark instances can be retrieved directly.
  60          */
  61         class SW_DLLPUBLIC iterator
  62         {
  63             private:
  64                 std::optional<std::vector<::sw::mark::MarkBase*>::const_iterator> m_pIter;
  65
  66             public:
  67                 // MarkManager implementation needs to get the real iterator
  68                 std::vector<::sw::mark::MarkBase*>::const_iterator const& get() const;
  69
  70                 typedef std::ptrdiff_t difference_type;
  71                 typedef ::sw::mark::IMark* value_type;
  72                 typedef ::sw::mark::IMark* const* pointer;
  73                 typedef ::sw::mark::IMark* const& reference;
  74                 typedef std::random_access_iterator_tag iterator_category;
  75
  76                 iterator();
  77                 iterator(std::vector<::sw::mark::MarkBase*>::const_iterator const& rIter);
  78                 iterator(iterator const& rOther);
  79                 iterator& operator=(iterator const& rOther);
  80                 iterator(iterator && rOther) noexcept;
  81                 iterator& operator=(iterator && rOther) noexcept;
  82
  83                 // FIXME unfortunately there's a requirement on input iterator
  84                 // and forward iterator to return reference, which isn't
  85                 // possible because we have to return a temp value;
  86                 // let's try value_type instead, perhaps it's sufficient,
  87                 // for a const_iterator...
  88                 ::sw::mark::IMark* /*const&*/ operator*() const;
  89                 // nope can't do that :(
  90                 //::sw::mark::IMark* /* const* */ operator->() const;
  91                 iterator& operator++();
  92                 iterator operator++(int);
  93                 bool operator==(iterator const& rOther) const;
  94                 bool operator!=(iterator const& rOther) const;
  95                 iterator& operator--();
  96                 iterator operator--(int);
  97                 iterator& operator+=(difference_type);
  98                 iterator operator+(difference_type) const;
  99                 iterator& operator-=(difference_type);
 100                 iterator operator-(difference_type) const;
 101                 difference_type operator-(iterator const&) const;
 102                 value_type operator[](difference_type) const;
 103                 bool operator<(iterator const& rOther) const;
 104                 bool operator>(iterator const& rOther) const;
 105                 bool operator<=(iterator const& rOther) const;
 106                 bool operator>=(iterator const& rOther) const;
 107         };
 108
 109         typedef iterator const_iterator_t;
 110
 111         /// To avoid recursive calls of deleteMark, the removal of dummy
 112         /// characters of fieldmarks has to be delayed; this is the baseclass
 113         /// that can be subclassed for that purpose.
 114         struct ILazyDeleter { virtual ~ILazyDeleter() { } };
 115
 116         /** Generates a new mark in the document for a certain selection.
 117
 118            @param rPaM
 119            [in] the selection being marked.
 120
 121            @param rProposedName
 122            [in] the proposed name of the new mark.
 123
 124            @param eMark
 125            [in] the type of the new mark.
 126
 127            @param eMode
 128            [in] is the new mark part of a text copy operation
 129
 130            @returns
 131            a pointer to the new mark (name might have changed).
 132         */
 133         virtual ::sw::mark::IMark* makeMark(const SwPaM& rPaM,
 134             const OUString& rProposedName,
 135             MarkType eMark, ::sw::mark::InsertMode eMode,
 136             SwPosition const* pSepPos = nullptr) = 0;
 137
 138         virtual sw::mark::IFieldmark* makeFieldBookmark( const SwPaM& rPaM,
 139             const OUString& rName,
 140             const OUString& rType,
 141             SwPosition const* pSepPos = nullptr) = 0;
 142         virtual sw::mark::IFieldmark* makeNoTextFieldBookmark( const SwPaM& rPaM,
 143             const OUString& rName,
 144             const OUString& rType) = 0;
 145
 146         virtual sw::mark::IMark* makeAnnotationMark(
 147             const SwPaM& rPaM,
 148             const OUString& rName ) = 0;
 149
 150         /** Returns a mark in the document for a paragraph.
 151             If there is none, a mark will be created.
 152
 153            @param rTextNode
 154            [in] the paragraph being marked (a selection over the paragraph is marked)
 155
 156            @param eMark
 157            [in] the type of the new mark.
 158
 159            @returns
 160            a pointer to the new mark (name might have changed).
 161         */
 162         virtual ::sw::mark::IMark* getMarkForTextNode(const SwTextNode& rTextNode,
 163             MarkType eMark) =0;
 164
 165         /** Moves an existing mark to a new selection and performs needed updates.
 166             @param io_pMark
 167             [in/out] the mark to be moved
 168
 169             @param rPaM
 170             [in] new selection to be marked
 171         */
 172
 173         virtual void repositionMark(::sw::mark::IMark* io_pMark,
 174             const SwPaM& rPaM) =0;
 175
 176         /** Renames an existing Mark, if possible.
 177             @param io_pMark
 178             [in/out] the mark to be renamed
 179
 180             @param rNewName
 181             [in] new name for the mark
 182
 183             @returns false, if renaming failed (because the name is already in use)
 184         */
 185         virtual bool renameMark(::sw::mark::IMark* io_pMark,
 186                 const OUString& rNewName) =0;
 187
 188         /** Corrects marks (absolute)
 189             This method ignores the previous position of the mark in the paragraph
 190
 191             @param rOldNode
 192             [in] the node from which nodes should be moved
 193
 194             @param rNewPos
 195             [in] new position to which marks will be moved, if nOffset == 0
 196
 197             @param nOffset
 198             [in] the offset by which the mark gets positioned of rNewPos
 199         */
 200         virtual void correctMarksAbsolute(const SwNodeIndex& rOldNode,
 201             const SwPosition& rNewPos,
 202             const sal_Int32 nOffset) =0;
 203
 204         /** Corrects marks (relative)
 205             This method uses the previous position of the mark in the paragraph as offset
 206
 207             @param rOldNode
 208             [in] the node from which nodes should be moved
 209
 210             @param rNewPos
 211             [in] new position to which marks from the start of the paragraph will be
 212                  moved, if nOffset == 0
 213
 214             @param nOffset
 215             [in] the offset by which the mark gets positioned of rNewPos in addition to
 216                  its old position in the paragraph
 217         */
 218         virtual void correctMarksRelative(const SwNodeIndex& rOldNode,
 219             const SwPosition& rNewPos,
 220             const sal_Int32 nOffset) =0;
 221
 222         /** Deletes marks in a range
 223
 224             Note: navigator reminders are excluded
 225
 226         */
 227         virtual void deleteMarks(
 228             const SwNodeIndex& rStt,
 229             const SwNodeIndex& rEnd,
 230             std::vector< ::sw::mark::SaveBookmark>* pSaveBkmk, // Ugly: SaveBookmark is core-internal
 231             const SwIndex* pSttIdx,
 232             const SwIndex* pEndIdx) =0;
 233
 234         /** Deletes a mark.
 235
 236             @param ppMark
 237             [in] an iterator pointing to the Mark to be deleted.
 238             @param isMoveNodes
 239             [in] the mark is deleted only temporarily for a node move, do not
 240                  remove fieldmark chars.
 241         */
 242         virtual std::unique_ptr<ILazyDeleter>
 243             deleteMark(const IDocumentMarkAccess::const_iterator_t& ppMark, bool isMoveNodes) =0;
 244
 245         /** Deletes a mark.
 246
 247             @param ppMark
 248             [in] the name of the mark to be deleted.
 249         */
 250         virtual void deleteMark(const ::sw::mark::IMark* const pMark) =0;
 251
 252         /** Clear (deletes) all marks.
 253         */
 254         virtual void clearAllMarks() =0;
 255
 256         virtual void assureSortedMarkContainers() const = 0;
 257
 258         /** returns a STL-like random access iterator to the begin of the sequence of marks.
 259         */
 260         virtual const_iterator_t getAllMarksBegin() const =0;
 261
 262         /** returns a STL-like random access iterator to the end of the sequence of marks.
 263         */
 264         virtual const_iterator_t getAllMarksEnd() const =0;
 265
 266         /** returns the number of marks.
 267
 268             Note: annotation marks are excluded
 269         */
 270         virtual sal_Int32 getAllMarksCount() const =0;
 271
 272         /** Finds a mark by name.
 273
 274             @param rName
 275             [in] the name of the mark to find.
 276
 277             @returns
 278             an iterator pointing to the mark, or pointing to getAllMarksEnd() if nothing was found.
 279         */
 280         virtual const_iterator_t findMark(const OUString& rMark) const =0;
 281
 282         // interface IBookmarks (BOOKMARK, CROSSREF_NUMITEM_BOOKMARK, CROSSREF_HEADING_BOOKMARK )
 283
 284         /** check if the selection would delete a BOOKMARK */
 285         virtual bool isBookmarkDeleted(SwPaM const& rPaM) const =0;
 286
 287         /** returns a STL-like random access iterator to the begin of the sequence the IBookmarks.
 288         */
 289         virtual const_iterator_t getBookmarksBegin() const =0;
 290
 291         /** returns a STL-like random access iterator to the end of the sequence of IBookmarks.
 292         */
 293         virtual const_iterator_t getBookmarksEnd() const =0;
 294
 295         /** returns the number of IBookmarks.
 296         */
 297         virtual sal_Int32 getBookmarksCount() const =0;
 298
 299         /** Finds a bookmark by name.
 300
 301             @param rName
 302             [in] the name of the bookmark to find.
 303
 304             @returns
 305             an iterator pointing to the bookmark, or getBookmarksEnd() if nothing was found.
 306         */
 307         virtual const_iterator_t findBookmark(const OUString& rMark) const =0;
 308
 309         /** Finds the first mark that is starting after.
 310
 311             @returns
 312             an iterator pointing to the mark, or pointing to getBookmarksEnd() if nothing was found.
 313         */
 314         virtual const_iterator_t findFirstBookmarkStartsAfter(const SwPosition& rPos) const =0;
 315
 316
 317         // Fieldmarks
 318         /** returns a STL-like random access iterator to the begin of the sequence of fieldmarks.
 319         */
 320         virtual const_iterator_t getFieldmarksBegin() const =0;
 321
 322         /** returns a STL-like random access iterator to the end of the sequence of fieldmarks.
 323         */
 324         virtual const_iterator_t getFieldmarksEnd() const =0;
 325
 326         /// get Fieldmark for CH_TXT_ATR_FIELDSTART/CH_TXT_ATR_FIELDEND at rPos
 327         virtual ::sw::mark::IFieldmark* getFieldmarkAt(const SwPosition& rPos) const =0;
 328         virtual ::sw::mark::IFieldmark* getFieldmarkFor(const SwPosition& pos) const =0;
 329         virtual ::sw::mark::IFieldmark* getFieldmarkBefore(const SwPosition& pos) const =0;
 330         virtual ::sw::mark::IFieldmark* getFieldmarkAfter(const SwPosition& pos) const =0;
 331
 332         virtual ::sw::mark::IFieldmark* getDropDownFor(const SwPosition& pos) const=0;
 333         virtual std::vector<::sw::mark::IFieldmark*> getNoTextFieldmarksIn(const SwPaM &rPaM) const=0;
 334
 335         virtual void deleteFieldmarkAt(const SwPosition& rPos) = 0;
 336         virtual ::sw::mark::IFieldmark* changeFormFieldmarkType(::sw::mark::IFieldmark* pFieldmark, const OUString& rNewType) = 0;
 337
 338         virtual void NotifyCursorUpdate(const SwCursorShell& rCursorShell) = 0;
 339         virtual void ClearFieldActivation() = 0;
 340
 341         // Annotation Marks
 342         virtual const_iterator_t getAnnotationMarksBegin() const = 0;
 343         virtual const_iterator_t getAnnotationMarksEnd() const = 0;
 344         virtual sal_Int32 getAnnotationMarksCount() const = 0;
 345         virtual const_iterator_t findAnnotationMark( const OUString& rName ) const = 0;
 346         virtual sw::mark::IMark* getAnnotationMarkFor(const SwPosition& rPosition) const = 0;
 347         // handle and restore text ranges of annotations of tracked deletions
 348         // based on the helper bookmarks (which can survive I/O and hiding redlines)
 349         virtual ::sw::mark::IMark* makeAnnotationBookmark(const SwPaM& rPaM,
 350             const OUString& rProposedName,
 351             MarkType eMark, ::sw::mark::InsertMode eMode,
 352             SwPosition const* pSepPos = nullptr) = 0;
 353         virtual const_iterator_t findAnnotationBookmark( const OUString& rName ) const = 0;
 354         virtual void restoreAnnotationMarks(bool bDelete = true) = 0;
 355         /** Finds the first mark that is starting after.
 356
 357             @returns
 358             an iterator pointing to the mark, or pointing to getAnnotationMarksEnd() if nothing was found.
 359         */
 360         virtual const_iterator_t findFirstAnnotationStartsAfter(const SwPosition& rPos) const =0;
 361
 362         /** Returns the MarkType used to create the mark
 363         */
 364         static SW_DLLPUBLIC MarkType GetType(const ::sw::mark::IMark& rMark);
 365
 366         static SW_DLLPUBLIC OUString GetCrossRefHeadingBookmarkNamePrefix();
 367         static SW_DLLPUBLIC bool IsLegalPaMForCrossRefHeadingBookmark( const SwPaM& rPaM );
 368         static void DeleteFieldmarkCommand(::sw::mark::IFieldmark const& rMark);
 369
 370     protected:
 371         virtual ~IDocumentMarkAccess() {};
 372 };
 373
 374 #endif // IDOCUMENTBOOKMARKACCESS_HXX_INCLUDED
 375
 376 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */