VOSSimpleCursor.h

//========================================================================================
// 
// $File$
// 
// Owner: EricM
// 
// $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 __VOSSIMPLECURSOR__
#define __VOSSIMPLECURSOR__

#include "VOSObject.h"

class IVOSDiskPage;
class VOS_SavedData;



class VOS_SimpleCursor
{
 public:
 VOS_SimpleCursor(IPMUnknown* cache);
 VOS_SimpleCursor(IPMUnknown* cache, IVOSDiskPage* block, int32 offset);

 ~VOS_SimpleCursor();

 VOS_SimpleCursor(const VOS_SimpleCursor& other);
 VOS_SimpleCursor& operator=(const VOS_SimpleCursor& other);

 VOS_SimpleCursor GetPreviousSimple(bool16 *prevExists = nil) const;
 VOS_SimpleCursor GetNextSimple(bool16 *nextExists = nil) const;

 bool16 MoveToNext();
 bool16 MoveToPrevious();

 bool16 AtBeginning() const;
 bool16 AtEnd() const;

 int32 LocalOffset() const
 { return fObjOffset; }

 void IncrementOffset(int32 delta)
 { fObjOffset += delta; ASSERT_MSG(fObjOffset >= 0, "offset should be positive"); }

 void SetOffset(int32 off)
 { fObjOffset = off; ASSERT_MSG(fObjOffset >= 0, "offset should be positive"); }

 int32 ObjectLength() const
 { return (fObject ? fObject->VirtualLength() : 0); }

 void DirtyObject()
 { if (fObject) fObject->PreDirty(); }

 VOS_Object* QueryObject()
 { if (fObject)
 fObject->AddRef();
 return fObject; }

 static void ReleaseObject(VOS_Object *obj)
 { if (obj) obj->Release(); }

 bool16 IsEmpty() const
 { return fObject == nil; }

 bool16 RemoveObject(bool16 deleteIt = kTrue);

 void RemoveObjects(int32 *pLen2Del, VOS_SavedData *data);

 void CopyObjects(int32 *pLen2Copy, VOS_SavedData *copyInto = nil);

 void Rationalize();
 void Clear();

 IPMUnknown* QueryOwningObject()
 { if (fOwner)
 fOwner->AddRef();
 return fOwner; }

 protected:
 void AddUndoObject(bool16 front, VOS_SavedData *undo, bool16 *nextExists, int32 len2Del);

 void CopyObject(bool16 front, VOS_SavedData *copy, bool16 *nextExists, int32 len2Copy);

 void CopyPageRef(VOS_SavedData *copy, bool16 *unused, int32 len2Copy);

 IPMUnknown *fOwner;
 VOS_Object *fObject;
 int32 fObjOffset;
};


#endif // __VOSSIMPLECURSOR__