XMLContentIterator.h

//========================================================================================
// 
// $File$
// 
// Owner: Lonnie Millett
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __XMLContentIterator__
#define __XMLContentIterator__

#include "IIDXMLElement.h"
#include "TextRange.h"

class XMLContentIterator
{
 public:

 typedef InDesign::TextRange value_type;
 typedef std::ptrdiff_t difference_type;
 typedef const value_type* pointer;
 typedef const value_type& reference;
 friend class const_iterator;
 typedef std::bidirectional_iterator_tag iterator_category;

 XMLContentIterator();

 XMLContentIterator(const XMLContentIterator&);

 XMLContentIterator(const IIDXMLElement* element, int32 position);

 ~XMLContentIterator();
 

 const InDesign::TextRange& operator * () const { ASSERT(fCurrent.IsValid()); return fCurrent;}

 const InDesign::TextRange* operator -> () const { ASSERT(fCurrent.IsValid()); return &fCurrent;}

 XMLContentIterator& operator = (const XMLContentIterator& rhs);

 XMLContentIterator& operator ++ ();

 XMLContentIterator operator ++ (int) {XMLContentIterator tmp(*this); ++(*this); return tmp;}

 XMLContentIterator& operator -- ();

 XMLContentIterator operator -- (int) {XMLContentIterator tmp(*this); --(*this); return tmp;}

 XMLContentIterator& operator += (int32 n);

 XMLContentIterator operator + (int32 n) const {return XMLContentIterator(*this) += n;}

 XMLContentIterator& operator -= (int32 n);

 XMLContentIterator operator - (int32 n) const {return XMLContentIterator(*this) -= n;}

 int32 Position() const {return fPosition;}

 //const InDesign::TextRange operator [] (int32 i) const {XMLContentIterator tmp(*this); tmp += i; return *tmp;}

 bool16 IsValid() const { return fCurrent.IsValid(); }
 
 friend XMLContentIterator operator + (int32 n, const XMLContentIterator& rhs) {return XMLContentIterator(rhs) += n;}
 friend bool operator ==(const XMLContentIterator& x, const XMLContentIterator& y) {return x.fCurrent.Start() == y.fCurrent.Start() && x.fCurrent.End() == y.fCurrent.End();} 
 friend bool operator !=(const XMLContentIterator& x, const XMLContentIterator& y) {return x.fCurrent.Start() != y.fCurrent.Start() || x.fCurrent.End() != y.fCurrent.End();}
 friend bool operator < (const XMLContentIterator& x, const XMLContentIterator& y) {return x.fPosition < y.fPosition;}
 friend bool operator <=(const XMLContentIterator& x, const XMLContentIterator& y) {return x.fPosition <= y.fPosition;}
 friend bool operator > (const XMLContentIterator& x, const XMLContentIterator& y) {return x.fPosition > y.fPosition;}
 friend bool operator >=(const XMLContentIterator& x, const XMLContentIterator& y) {return x.fPosition >= y.fPosition;}
 
 private:
 void CalcCurrentTextRange();
 bool16 GetElementMarkerPositions(ITextModel *textModel, IIDXMLElement *element, TextIndex *startIndex, TextIndex *endIndex);
 
 InterfacePtr<const IIDXMLElement> fElement;
 TextIndex fStartIndex;
 TextIndex fEndIndex;
 InDesign::TextRange fCurrent;
 int32 fPosition;
};

#endif