sw/inc/ndindex.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 #ifndef INCLUDED_SW_INC_NDINDEX_HXX
  20 #define INCLUDED_SW_INC_NDINDEX_HXX
  21
  22 #include <iostream>
  23
  24 #include <tools/solar.h>
  25
  26 #include "node.hxx"
  27 #include "ring.hxx"
  28 #include "ndarr.hxx"
  29
  30 /// Marks a node in the document model.
  31 class SW_DLLPUBLIC SwNodeIndex final : public sw::Ring<SwNodeIndex>
  32 {
  33     SwNode * m_pNode;
  34
  35     // These are not allowed!
  36     SwNodeIndex( SwNodes& rNds, sal_uInt16 nIdx ) = delete;
  37     SwNodeIndex( SwNodes& rNds, int nIdx ) = delete;
  38     void RegisterIndex( SwNodes& rNodes )
  39     {
  40         if(!rNodes.m_vIndices)
  41             rNodes.m_vIndices = this;
  42         MoveTo(rNodes.m_vIndices);
  43     }
  44     void DeRegisterIndex( SwNodes& rNodes )
  45     {
  46         if(rNodes.m_vIndices == this)
  47             rNodes.m_vIndices = GetNextInRing();
  48         MoveTo(nullptr);
  49         if(rNodes.m_vIndices == this)
  50             rNodes.m_vIndices = nullptr;
  51     }
  52
  53 public:
  54     SwNodeIndex( SwNodes& rNds, sal_uLong nIdx = 0 )
  55         : m_pNode( rNds[ nIdx ] )
  56     {
  57         RegisterIndex( rNds );
  58     };
  59     SwNodeIndex( const SwNodeIndex& rIdx, tools::Long nDiff = 0 )
  60         : sw::Ring<SwNodeIndex>()
  61     {
  62         if( nDiff )
  63             m_pNode = rIdx.GetNodes()[ rIdx.GetIndex() + nDiff ];
  64         else
  65             m_pNode = rIdx.m_pNode;
  66         RegisterIndex( m_pNode->GetNodes() );
  67     }
  68
  69     SwNodeIndex( const SwNode& rNd, tools::Long nDiff = 0 )
  70     {
  71         if( nDiff )
  72             m_pNode = rNd.GetNodes()[ rNd.GetIndex() + nDiff ];
  73         else
  74             m_pNode = const_cast<SwNode*>(&rNd);
  75         RegisterIndex( m_pNode->GetNodes() );
  76     }
  77
  78     virtual  ~SwNodeIndex() override
  79         { DeRegisterIndex( m_pNode->GetNodes() ); }
  80
  81     inline sal_uLong operator++();
  82     inline sal_uLong operator--();
  83     inline sal_uLong operator++(int);
  84     inline sal_uLong operator--(int);
  85
  86     inline sal_uLong operator+=( sal_uLong );
  87     inline sal_uLong operator-=( sal_uLong );
  88
  89     inline bool operator< ( const SwNodeIndex& ) const;
  90     inline bool operator<=( const SwNodeIndex& ) const;
  91     inline bool operator> ( const SwNodeIndex& ) const;
  92     inline bool operator>=( const SwNodeIndex& ) const;
  93     inline bool operator==( const SwNodeIndex& ) const;
  94     inline bool operator!=( const SwNodeIndex& ) const;
  95
  96     inline bool operator< ( sal_uLong ) const;
  97     inline bool operator<=( sal_uLong ) const;
  98     inline bool operator> ( sal_uLong ) const;
  99     inline bool operator>=( sal_uLong ) const;
 100     inline bool operator==( sal_uLong ) const;
 101     inline bool operator!=( sal_uLong ) const;
 102
 103     inline SwNodeIndex& operator=( sal_uLong );
 104     inline SwNodeIndex& operator=( const SwNodeIndex& );
 105     inline SwNodeIndex& operator=( const SwNode& );
 106
 107     // Return value of index as sal_uLong.
 108     inline sal_uLong GetIndex() const;
 109
 110     // Enables assignments without creation of a temporary object.
 111     inline SwNodeIndex& Assign( SwNodes const & rNds, sal_uLong );
 112     inline SwNodeIndex& Assign( const SwNode& rNd, tools::Long nOffset = 0 );
 113
 114     // Gets pointer on NodesArray.
 115     inline const SwNodes& GetNodes() const;
 116     inline       SwNodes& GetNodes();
 117
 118     SwNodeIndex* GetNext() { return GetNextInRing(); }
 119     SwNode& GetNode() const { return *m_pNode; }
 120 };
 121
 122 inline std::ostream &operator <<(std::ostream& s, const SwNodeIndex& index)
 123 {
 124     return s << "SwNodeIndex (node " << index.GetIndex() << ")";
 125 };
 126
 127 // SwRange
 128
 129 class SW_DLLPUBLIC SwNodeRange
 130 {
 131 public:
 132     SwNodeIndex aStart;
 133     SwNodeIndex aEnd;
 134
 135     SwNodeRange( const SwNodeIndex &rS, const SwNodeIndex &rE )
 136         : aStart( rS ), aEnd( rE ) {};
 137     SwNodeRange( const SwNodeRange &rRange )
 138         : aStart( rRange.aStart ), aEnd( rRange.aEnd ) {};
 139
 140     SwNodeRange( SwNodes& rNds, sal_uLong nSttIdx, sal_uLong nEndIdx = 0 )
 141         : aStart( rNds, nSttIdx ), aEnd( rNds, nEndIdx ) {};
 142
 143     SwNodeRange( const SwNodeIndex& rS, tools::Long nSttDiff, const SwNodeIndex& rE, tools::Long nEndDiff = 0 )
 144         : aStart( rS, nSttDiff ), aEnd( rE, nEndDiff ) {};
 145     SwNodeRange( const SwNode& rS, tools::Long nSttDiff, const SwNode& rE, tools::Long nEndDiff = 0 )
 146         : aStart( rS, nSttDiff ), aEnd( rE, nEndDiff ) {};
 147 };
 148
 149 // For inlines node.hxx is needed which in turn needs this one.
 150 // Therefore all inlines accessing m_pNode are implemented here.
 151
 152 inline sal_uLong SwNodeIndex::GetIndex() const
 153 {
 154     return m_pNode->GetIndex();
 155 }
 156 inline const SwNodes& SwNodeIndex::GetNodes() const
 157 {
 158     return m_pNode->GetNodes();
 159 }
 160 inline SwNodes& SwNodeIndex::GetNodes()
 161 {
 162     return m_pNode->GetNodes();
 163 }
 164 inline bool SwNodeIndex::operator< ( sal_uLong const nOther ) const
 165 {
 166     return m_pNode->GetIndex() < nOther;
 167 }
 168 inline bool SwNodeIndex::operator<=( sal_uLong const nOther ) const
 169 {
 170     return m_pNode->GetIndex() <= nOther;
 171 }
 172 inline bool SwNodeIndex::operator> ( sal_uLong const nOther ) const
 173 {
 174     return m_pNode->GetIndex() > nOther;
 175 }
 176 inline bool SwNodeIndex::operator>=( sal_uLong const nOther ) const
 177 {
 178     return m_pNode->GetIndex() >= nOther;
 179 }
 180 inline bool SwNodeIndex::operator==( sal_uLong const nOther ) const
 181 {
 182     return m_pNode->GetIndex() == nOther;
 183 }
 184 inline bool SwNodeIndex::operator!=( sal_uLong const nOther ) const
 185 {
 186     return m_pNode->GetIndex() != nOther;
 187 }
 188 inline bool SwNodeIndex::operator<( const SwNodeIndex& rIndex ) const
 189 {
 190     return m_pNode->GetIndex() < rIndex.GetIndex();
 191 }
 192 inline bool SwNodeIndex::operator<=( const SwNodeIndex& rIndex ) const
 193 {
 194     return m_pNode->GetIndex() <= rIndex.GetIndex();
 195 }
 196 inline bool SwNodeIndex::operator>( const SwNodeIndex& rIndex ) const
 197 {
 198     return m_pNode->GetIndex() > rIndex.GetIndex();
 199 }
 200 inline bool SwNodeIndex::operator>=( const SwNodeIndex& rIndex ) const
 201 {
 202     return m_pNode->GetIndex() >= rIndex.GetIndex();
 203 }
 204 inline bool SwNodeIndex::operator==( const SwNodeIndex& rIdx ) const
 205 {
 206     return m_pNode == rIdx.m_pNode;
 207 }
 208 inline bool SwNodeIndex::operator!=( const SwNodeIndex& rIdx ) const
 209 {
 210     return m_pNode != rIdx.m_pNode;
 211 }
 212
 213 inline sal_uLong SwNodeIndex::operator++()
 214 {
 215     m_pNode = GetNodes()[ m_pNode->GetIndex()+1 ];
 216     return m_pNode->GetIndex();
 217 }
 218 inline sal_uLong SwNodeIndex::operator--()
 219 {
 220     m_pNode = GetNodes()[ m_pNode->GetIndex()-1 ];
 221     return m_pNode->GetIndex();
 222 }
 223 inline sal_uLong SwNodeIndex::operator++(int)
 224 {
 225     sal_uLong nOldIndex = m_pNode->GetIndex();
 226     m_pNode = GetNodes()[ nOldIndex + 1 ];
 227     return nOldIndex;
 228 }
 229 inline sal_uLong SwNodeIndex::operator--(int)
 230 {
 231     sal_uLong nOldIndex = m_pNode->GetIndex();
 232     m_pNode = GetNodes()[ nOldIndex - 1 ];
 233     return nOldIndex;
 234 }
 235
 236 inline sal_uLong SwNodeIndex::operator+=( sal_uLong const nOffset )
 237 {
 238     m_pNode = GetNodes()[ m_pNode->GetIndex() + nOffset ];
 239     return m_pNode->GetIndex();
 240 }
 241 inline sal_uLong SwNodeIndex::operator-=( sal_uLong const nOffset )
 242 {
 243     m_pNode = GetNodes()[ m_pNode->GetIndex() - nOffset ];
 244     return m_pNode->GetIndex();
 245 }
 246
 247 inline SwNodeIndex& SwNodeIndex::operator=( sal_uLong const nNew )
 248 {
 249     m_pNode = GetNodes()[ nNew ];
 250     return *this;
 251 }
 252
 253 SwNodeIndex& SwNodeIndex::operator=( const SwNodeIndex& rIdx )
 254 {
 255     *this = *(rIdx.m_pNode);
 256     return *this;
 257 }
 258
 259 SwNodeIndex& SwNodeIndex::operator=( const SwNode& rNd )
 260 {
 261     if (&m_pNode->GetNodes() != &rNd.GetNodes())
 262     {
 263         DeRegisterIndex( m_pNode->GetNodes() );
 264         m_pNode = const_cast<SwNode*>(&rNd);
 265         RegisterIndex( m_pNode->GetNodes() );
 266     }
 267     else
 268         m_pNode = const_cast<SwNode*>(&rNd);
 269     return *this;
 270 }
 271
 272 SwNodeIndex& SwNodeIndex::Assign( SwNodes const & rNds, sal_uLong nIdx )
 273 {
 274     *this = *rNds[ nIdx ];
 275     return *this;
 276 }
 277
 278 SwNodeIndex& SwNodeIndex::Assign( const SwNode& rNd, tools::Long nOffset )
 279 {
 280     *this = rNd;
 281
 282     if( nOffset )
 283         m_pNode = m_pNode->GetNodes()[ m_pNode->GetIndex() + nOffset ];
 284
 285     return *this;
 286 }
 287
 288 #endif
 289
 290 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */