IVOSDiskPage.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.
// 
// 
// This is an interface that manages the virtual-memory-paging scheme
// used by the text storage system. A large story is stored in a list
// of IVOSDiskPage s. Each "page" stores a list of VOS_Object s. These
// VOS_Objects are abstract classes that represent a block of data, like a
// single run. If enough VOS_Objects are added to a single page, it splits
// into 2 pages. Currently they don't recombine, but they could/should.
// Each VOS_Object has a conceptual length called "VirtualLength" that
// represents the number of characters that the VOS_Object represents. The pages
// know how much VirtualLength is contained therein allowing for quicker searching.
// Knowing that, most of the routines are obvious. The odd ones are Get/SetStrand()
// which is used to connect strands to the first page of data (which may change
// during delete or split operations)
// 
//========================================================================================

#ifndef __IVOSDiskPage__
#define __IVOSDiskPage__

#include "IPMUnknown.h"
#include "TextID.h"
#include "UIDList.h"

class VOS_Object;
class VOS_SavedData;

class IVOSDiskPage : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IVOSDISKPAGE };

 virtual void SetStrand(UID strandID) = 0;

 virtual UID GetStrand() const = 0;

 virtual UID NextPage() const = 0;

 virtual UID PrevPage() const = 0;

 virtual void SetNextPage(UID page) = 0;

 virtual void SetPrevPage(UID page) = 0;

 virtual void AddRefObj(VOS_Object* object) = 0;

 virtual void ReleaseObj(VOS_Object* object) = 0;

 virtual VOS_Object* QueryFindObject(int32 *offset) = 0;

 virtual int32 LocateObjectStart(const VOS_Object *object) = 0;

 virtual VOS_Object* QueryFirstObj() = 0;

 virtual VOS_Object* QueryLastObj() = 0;

 virtual VOS_Object* QueryNextObj(VOS_Object *object) = 0;

 virtual VOS_Object* QueryPrevObj(VOS_Object *obj) = 0;

 virtual int32 ObjectIndexOnPage(const VOS_Object *object) = 0;

 virtual void InsertObj(VOS_Object *newOne, VOS_Object *before = nil) = 0;

 virtual void AppendObj(VOS_Object *newOne, VOS_Object *after = nil) = 0;

 virtual void RemoveObj(VOS_Object *theOne, bool16 deleteIt = kTrue) = 0;

 virtual void ReplaceObj(VOS_Object *replaceMe, VOS_Object *replaceWith, bool16 deleteIt = kTrue) = 0;

 virtual void RemovePage() = 0;

 virtual void InsertPage(UID newPage, VOS_Object *before = nil) = 0;

 virtual int32 TotalLength() = 0;

 virtual int32 TotalObjects() = 0;

 virtual ClassID GetClassOfObjectsInStrand() const = 0;

 virtual void AdjustLength(int32 delta) = 0;

 virtual void DirtyPage(Bool16 markDoc = kTrue) = 0;

 virtual UID RemoveOneOrMorePages(int32 *length,
 K2Vector<UID> *pageIDList,
 K2Vector<int32> *pageLenList) = 0;
};

#endif
 // __IVOSDiskPage__