VOSObject.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 __VOSOBJECT__
#define __VOSOBJECT__

#include "IVOSDiskPage.h"
#include "PersistUtils.h"
#include "SnapshotInfo.h"

class scoped_snapshotdataref; 
class VOS_Cursor;
class VOS_SavedData;
class ISnapshotCache;
template <typename ItemIDType, typename ItemDataType> class ISaLRICache;



class VOS_Object
{
 protected:
 VOS_Object(const VOS_Object& copy);
 public:
 VOS_Object();
 VOS_Object& operator=(const VOS_Object& rhs) = delete;
 virtual ~VOS_Object();

 //-------------------------------------------------------------------------------

 SnapshotID GetSnapshotID() const; 
 void SetSnapshot(scoped_snapshotdataref& snapshot);
 bool16 IsSnapshotUptodate() const;
 void SetSnapshotNotuptodate();




 virtual int32 VirtualLength() const = 0;

 virtual VOS_Object* Duplicate() const = 0;

 virtual VOS_Object* Divide(int32 atOffset) = 0;

 virtual bool16 JoinWith(VOS_Object* next) = 0;

 virtual void ReadWrite(IPMStream *s, ImplementationID prop) = 0;

 virtual void Release();

 virtual void AddRef();

 virtual void SetDiskPage(IVOSDiskPage *block);

 IVOSDiskPage* GrabDiskPage()
 { return fDiskPage; }

 IDataBase* GetDataBase() const
 { return fDiskPage ? ::GetDataBase(fDiskPage) : nil; }

#ifdef DEBUG

 virtual void InsertObj(VOS_Object *newone);
 virtual void AppendObj(VOS_Object *newone);
#else

 void InsertObj(VOS_Object *newone)
 { if (fDiskPage != nil) fDiskPage->InsertObj(newone, this); }

 void AppendObj(VOS_Object *newone)
 { if (fDiskPage != nil) fDiskPage->AppendObj(newone, this); }
#endif


 void AdjustObjectLength(int32 delta)
 { if (fDiskPage != nil) fDiskPage->AdjustLength(delta); }


 void PreDirty( bool8 dbModified = kTrue);

 bool16 IsDirty() const;


 int32 VirtualKey() const
 { return fDiskPage ? fDiskPage->LocateObjectStart(this) : 0; }


 static void InsertSavedData(VOS_Cursor& cursor, VOS_SavedData *datalist);

 private:
 IVOSDiskPage *fDiskPage;
 mutable int32 fDiskPageRefCount;
 SnapshotID fSnapshotID;
 ISnapshotCache* fSnapshotCache;
 bool8 fSnapshotIsUptodate;
#ifdef INTERFACEPROXIES_SUPPORTED
 IVOSDiskPage *fDiskPageProxy;
#endif
};


#endif // __VOSOBJECT__