sw/source/core/inc/docfld.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_DOCFLD_HXX
  21 #define INCLUDED_SW_SOURCE_CORE_INC_DOCFLD_HXX
  22
  23 #include <calc.hxx>
  24 #include <doc.hxx>
  25 #include <IDocumentTimerAccess.hxx>
  26 #include <IMark.hxx>
  27 #include <o3tl/sorted_vector.hxx>
  28 #include <memory>
  29 #include <optional>
  30
  31 class SwTextField;
  32 class SwContentIndex;
  33 class SwNodeIndex;
  34 class SwContentFrame;
  35 class SwSectionNode;
  36 class SwSection;
  37 class SwTextTOXMark;
  38 class SwTableBox;
  39 class SwTextINetFormat;
  40 class SwFlyFrameFormat;
  41 class SwNode;
  42 struct SwPosition;
  43 enum class SwFieldIds : sal_uInt16;
  44
  45 // Update expression fields
  46 class SetGetExpField
  47 {
  48     // TODO: in case of multiple layouts, storing this only once isn't going to work (although already a problem for cached field value)
  49     sal_uInt16 m_nPageNumber = 0;
  50     SwNodeOffset m_nNode;
  51     union {
  52         const SwTextField* pTextField;
  53         const SwSection* pSection;
  54         const SwPosition* pPos;
  55         const SwTextTOXMark* pTextTOX;
  56         const SwTableBox* pTBox;
  57         const SwTextINetFormat* pTextINet;
  58         const SwFlyFrameFormat* pFlyFormat;
  59         ::sw::mark::IBookmark const* pBookmark;
  60     } m_CNTNT;
  61     sal_Int32 m_nContent;
  62     enum SetGetExpFieldType
  63         {
  64             TEXTFIELD, TEXTTOXMARK, SECTIONNODE, BOOKMARK, CRSRPOS, TABLEBOX,
  65             TEXTINET, FLYFRAME
  66         } m_eSetGetExpFieldType;
  67
  68 public:
  69     SetGetExpField( const SwNode& rNd, const SwTextField* pField = nullptr,
  70                     std::optional<sal_Int32> oContentIdx = std::nullopt,
  71                     sal_uInt16 nPageNumber = 0);
  72
  73     SetGetExpField( const SwNode& rNd, const SwTextINetFormat& rINet );
  74
  75     SetGetExpField( const SwSectionNode& rSectNode,
  76                     const SwPosition* pPos = nullptr,
  77                     sal_uInt16 nPageNumber = 0);
  78
  79     SetGetExpField( ::sw::mark::IBookmark const& rBookmark,
  80                     SwPosition const* pPos = nullptr,
  81                     sal_uInt16 nPageNumber = 0);
  82
  83     SetGetExpField( const SwTableBox& rTableBox  );
  84
  85     SetGetExpField( const SwNode& rNd, const SwTextTOXMark& rTOX );
  86
  87     SetGetExpField( const SwPosition& rPos );
  88
  89     SetGetExpField( const SwFlyFrameFormat& rFlyFormat, const SwPosition* pPos );
  90
  91     bool operator==( const SetGetExpField& rField ) const;
  92     bool operator<( const SetGetExpField& rField ) const;
  93
  94     const SwTextField* GetTextField() const
  95         { return TEXTFIELD == m_eSetGetExpFieldType ? m_CNTNT.pTextField : nullptr; }
  96     const SwSection* GetSection() const
  97         { return SECTIONNODE == m_eSetGetExpFieldType ? m_CNTNT.pSection : nullptr; }
  98     ::sw::mark::IBookmark const* GetBookmark() const
  99         { return BOOKMARK == m_eSetGetExpFieldType ? m_CNTNT.pBookmark : nullptr; }
 100     const SwTextINetFormat* GetINetFormat() const
 101         { return TEXTINET == m_eSetGetExpFieldType ? m_CNTNT.pTextINet : nullptr; }
 102     const SwFlyFrameFormat* GetFlyFormat() const
 103         { return FLYFRAME == m_eSetGetExpFieldType ? m_CNTNT.pFlyFormat : nullptr; }
 104
 105     SwNodeOffset GetNode() const { return m_nNode; }
 106     sal_Int32 GetContent() const { return m_nContent; }
 107     const void* GetPointer() const { return m_CNTNT.pTextField; }
 108
 109     void GetPosOfContent( SwPosition& rPos ) const;
 110
 111     const SwNode* GetNodeFromContent() const;
 112     sal_Int32 GetCntPosFromContent() const;
 113
 114     void SetBodyPos( const SwContentFrame& rFrame );
 115 };
 116
 117 class SetGetExpFields : public o3tl::sorted_vector<std::unique_ptr<SetGetExpField>, o3tl::less_uniqueptr_to<SetGetExpField> >
 118 {
 119 };
 120
 121 // struct for saving strings from the SetExp's string fields
 122 struct HashStr final : public SwHash
 123 {
 124     OUString aSetStr;
 125     HashStr( const OUString& rName, OUString aText, HashStr* );
 126 };
 127
 128 struct SwCalcFieldType final : public SwHash
 129 {
 130     const SwFieldType* pFieldType;
 131
 132     SwCalcFieldType( const OUString& rStr, const SwFieldType* pFieldTyp )
 133         : SwHash( rStr ), pFieldType( pFieldTyp )
 134     {}
 135 };
 136
 137 // search for the string that was saved under rName in the hash table
 138 OUString LookString( SwHashTable<HashStr> const & rTable, const OUString& rName );
 139
 140 const int GETFLD_ALL        = 3;        // combine flags via OR
 141 const int GETFLD_CALC       = 1;
 142 const int GETFLD_EXPAND     = 2;
 143
 144 class SwDocUpdateField
 145 {
 146     std::unique_ptr<SetGetExpFields> m_pFieldSortList; ///< current field list for calculation
 147     SwHashTable<SwCalcFieldType> m_FieldTypeTable;
 148
 149     SwNodeOffset m_nNodes; ///< to check if the node count changed
 150     int m_nFieldListGetMode;
 151     SwDoc& m_rDoc;
 152
 153     bool m_bInUpdateFields : 1; ///< currently in an UpdateFields call
 154     bool m_bFieldsDirty : 1;    ///< some fields are invalid
 155
 156     void MakeFieldList_( SwDoc& pDoc, int eGetMode );
 157     void GetBodyNode( const SwTextField& , SwFieldIds nFieldWhich );
 158     template<typename T>
 159     void GetBodyNodeGeneric(SwNode const& rNode, T const&);
 160
 161 public:
 162     SwDocUpdateField(SwDoc& rDocument);
 163     ~SwDocUpdateField();
 164
 165     const SetGetExpFields* GetSortList() const { return m_pFieldSortList.get(); }
 166
 167     void MakeFieldList( SwDoc& rDoc, bool bAll, int eGetMode );
 168
 169     void InsDelFieldInFieldLst( bool bIns, const SwTextField& rField );
 170
 171     void InsertFieldType( const SwFieldType& rType );
 172     void RemoveFieldType( const SwFieldType& rType );
 173
 174     bool IsInUpdateFields() const         { return m_bInUpdateFields; }
 175     void SetInUpdateFields( bool b )      { m_bInUpdateFields = b; }
 176
 177     bool IsFieldsDirty() const          { return m_bFieldsDirty; }
 178     void SetFieldsDirty( bool b )
 179     {
 180         m_bFieldsDirty = b;
 181
 182         if (b)
 183         {
 184             m_rDoc.getIDocumentTimerAccess().StartIdling();
 185         }
 186     }
 187
 188     SwHashTable<SwCalcFieldType> const& GetFieldTypeTable() const { return m_FieldTypeTable; }
 189 };
 190
 191 #endif
 192
 193 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */