sw/inc/ndindex.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ndindex.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _NDINDEX_HXX
  31 #define _NDINDEX_HXX
  32
  33 #include <limits.h>
  34 #include <tools/solar.h>
  35
  36 #include "node.hxx"
  37 #include "ndarr.hxx"
  38
  39 class SwNode;
  40 class SwNodes;
  41
  42 class SW_DLLPUBLIC SwNodeIndex
  43 {
  44     friend void SwNodes::RegisterIndex( SwNodeIndex& );
  45     friend void SwNodes::DeRegisterIndex( SwNodeIndex& );
  46     friend void SwNodes::RemoveNode( ULONG, ULONG, BOOL );
  47
  48 #ifndef PRODUCT
  49     static int nSerial;
  50     int MySerial;
  51 #endif
  52
  53     SwNode* pNd;
  54     SwNodeIndex *pNext, *pPrev;
  55
  56     void Remove();                                      // Ausketten
  57
  58     // diese sind nicht erlaubt!
  59     SwNodeIndex( SwNodes& rNds, USHORT nIdx );
  60     SwNodeIndex( SwNodes& rNds, int nIdx );
  61
  62 public:
  63     SwNodeIndex( SwNodes& rNds, ULONG nIdx = 0 );
  64     SwNodeIndex( const SwNodeIndex &, long nDiff = 0 );
  65     SwNodeIndex( const SwNode&, long nDiff = 0 );
  66     ~SwNodeIndex() { Remove(); }
  67
  68     inline ULONG operator++();
  69     inline ULONG operator--();
  70 #ifndef CFRONT
  71     inline ULONG operator++(int);
  72     inline ULONG operator--(int);
  73 #endif
  74
  75     inline ULONG operator+=( ULONG );
  76     inline ULONG operator-=( ULONG );
  77     inline ULONG operator+=( const  SwNodeIndex& );
  78     inline ULONG operator-=( const SwNodeIndex& );
  79
  80     inline BOOL operator< ( const SwNodeIndex& ) const;
  81     inline BOOL operator<=( const SwNodeIndex& ) const;
  82     inline BOOL operator> ( const SwNodeIndex& ) const;
  83     inline BOOL operator>=( const SwNodeIndex& ) const;
  84     inline BOOL operator==( const SwNodeIndex& ) const;
  85     inline BOOL operator!=( const SwNodeIndex& ) const;
  86
  87     inline BOOL operator< ( ULONG nWert ) const;
  88     inline BOOL operator<=( ULONG nWert ) const;
  89     inline BOOL operator> ( ULONG nWert ) const;
  90     inline BOOL operator>=( ULONG nWert ) const;
  91     inline BOOL operator==( ULONG nWert ) const;
  92     inline BOOL operator!=( ULONG nWert ) const;
  93
  94     inline SwNodeIndex& operator=( ULONG );
  95            SwNodeIndex& operator=( const SwNodeIndex& );
  96            SwNodeIndex& operator=( const SwNode& );
  97
  98     // gebe den Wert vom Index als ULONG zurueck
  99     inline ULONG GetIndex() const;
 100
 101     // ermoeglicht Zuweisungen ohne Erzeugen eines temporaeren Objektes
 102     SwNodeIndex& Assign( SwNodes& rNds, ULONG );
 103     SwNodeIndex& Assign( const SwNode& rNd, long nOffset = 0 );
 104
 105         // Herausgabe des Pointers auf das NodesArray,
 106     inline const SwNodes& GetNodes() const;
 107     inline               SwNodes& GetNodes();
 108
 109     SwNode& GetNode() const { return *pNd; }
 110 };
 111
 112 /*
 113  * SwRange
 114  */
 115 class SW_DLLPUBLIC SwNodeRange
 116 {
 117 public:
 118     SwNodeIndex aStart;
 119     SwNodeIndex aEnd;
 120
 121     SwNodeRange( const SwNodeIndex &rS, const SwNodeIndex &rE );
 122     SwNodeRange( const SwNodeRange &rRange );
 123
 124     SwNodeRange( SwNodes& rArr, ULONG nSttIdx = 0, ULONG nEndIdx = 0 );
 125     SwNodeRange( const SwNodeIndex& rS, long nSttDiff,
 126                  const SwNodeIndex& rE, long nEndDiff = 0 );
 127     SwNodeRange( const SwNode& rS, long nSttDiff,
 128                  const SwNode& rE, long nEndDiff = 0 );
 129 };
 130
 131
 132
 133
 134 // fuer die inlines wird aber der node.hxx benoetigt. Dieses braucht aber
 135 // auch wieder dieses. Also alle Inlines, die auf pNd zugreifen werden
 136 // hier implementiert.
 137
 138 inline ULONG SwNodeIndex::GetIndex() const
 139 {
 140     return pNd->GetIndex();
 141 }
 142 inline const SwNodes& SwNodeIndex::GetNodes() const
 143 {
 144     return pNd->GetNodes();
 145 }
 146 inline SwNodes& SwNodeIndex::GetNodes()
 147 {
 148     return pNd->GetNodes();
 149 }
 150 inline BOOL SwNodeIndex::operator< ( ULONG nWert ) const
 151 {
 152     return pNd->GetIndex() < nWert;
 153 }
 154 inline BOOL SwNodeIndex::operator<=( ULONG nWert ) const
 155 {
 156     return pNd->GetIndex() <= nWert;
 157 }
 158 inline BOOL SwNodeIndex::operator> ( ULONG nWert ) const
 159 {
 160     return pNd->GetIndex() > nWert;
 161 }
 162 inline BOOL SwNodeIndex::operator>=( ULONG nWert ) const
 163 {
 164     return pNd->GetIndex() >= nWert;
 165 }
 166 inline BOOL SwNodeIndex::operator==( ULONG nWert ) const
 167 {
 168     return pNd->GetIndex() == nWert;
 169 }
 170 inline BOOL SwNodeIndex::operator!=( ULONG nWert ) const
 171 {
 172     return pNd->GetIndex() != nWert;
 173 }
 174 inline BOOL SwNodeIndex::operator<( const SwNodeIndex& rIndex ) const
 175 {
 176     return pNd->GetIndex() < rIndex.GetIndex();
 177 }
 178 inline BOOL SwNodeIndex::operator<=( const SwNodeIndex& rIndex ) const
 179 {
 180     return pNd->GetIndex() <= rIndex.GetIndex();
 181 }
 182 inline BOOL SwNodeIndex::operator>( const SwNodeIndex& rIndex ) const
 183 {
 184     return pNd->GetIndex() > rIndex.GetIndex();
 185 }
 186 inline BOOL SwNodeIndex::operator>=( const SwNodeIndex& rIndex ) const
 187 {
 188     return pNd->GetIndex() >= rIndex.GetIndex();
 189 }
 190 inline BOOL SwNodeIndex::operator==( const SwNodeIndex& rIdx ) const
 191 {
 192     return pNd == rIdx.pNd;
 193 }
 194 inline BOOL SwNodeIndex::operator!=( const SwNodeIndex& rIdx ) const
 195 {
 196     return pNd != rIdx.pNd;
 197 }
 198
 199 inline ULONG SwNodeIndex::operator++()
 200 {
 201     return ( pNd = GetNodes()[ pNd->GetIndex()+1 ] )->GetIndex();
 202 }
 203 inline ULONG SwNodeIndex::operator--()
 204 {
 205     return ( pNd = GetNodes()[ pNd->GetIndex()-1 ] )->GetIndex();
 206 }
 207 #ifndef CFRONT
 208 inline ULONG SwNodeIndex::operator++(int)
 209 {
 210     ULONG nOldIndex = pNd->GetIndex();
 211     pNd = GetNodes()[ nOldIndex + 1 ];
 212     return nOldIndex;
 213 }
 214 inline ULONG SwNodeIndex::operator--(int)
 215 {
 216     ULONG nOldIndex = pNd->GetIndex();
 217     pNd = GetNodes()[ nOldIndex - 1 ];
 218     return nOldIndex;
 219 }
 220 #endif
 221
 222 inline ULONG SwNodeIndex::operator+=( ULONG nWert )
 223 {
 224     return ( pNd = GetNodes()[ pNd->GetIndex() + nWert ] )->GetIndex();
 225 }
 226 inline ULONG SwNodeIndex::operator-=( ULONG nWert )
 227 {
 228     return ( pNd = GetNodes()[ pNd->GetIndex() - nWert ] )->GetIndex();
 229 }
 230 inline ULONG SwNodeIndex::operator+=( const  SwNodeIndex& rIndex )
 231 {
 232     return ( pNd = GetNodes()[ pNd->GetIndex() + rIndex.GetIndex() ] )->GetIndex();
 233 }
 234 inline ULONG SwNodeIndex::operator-=( const SwNodeIndex& rIndex )
 235 {
 236     return ( pNd = GetNodes()[ pNd->GetIndex() - rIndex.GetIndex() ] )->GetIndex();
 237 }
 238
 239 inline SwNodeIndex& SwNodeIndex::operator=( ULONG nWert )
 240 {
 241     pNd = GetNodes()[ nWert ];
 242     return *this;
 243 }
 244
 245
 246
 247 //JP 29.09.97: impl. steht im ndindex.hxx - sollte moeglichst bald auf die
 248 //                              neue Schnittstelle angepasst werden
 249 inline SwNode* SwNodes::operator[]( const SwNodeIndex& rIdx ) const
 250 {
 251     return &rIdx.GetNode();
 252 }
 253
 254
 255 #endif