DBUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Roey Horns
// 
// $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.
// 
// 
// Purpose:
// Utility class
// 
//========================================================================================

#ifndef __DBUTILS_
#define __DBUTILS_

#include "IDataBase.h"
#include "OMFactoryCtor.h"


class IRIDXDBInterface;
class IInvalHandler;

class DATABASE_DECL DBUtils
{
public:
 
 
 enum { 
 kMagicByteCount = 8 
 };

 typedef char MagicBytes[kMagicByteCount];
 static IDataBase *CreateDataBase(IDataBase::UndoSupport undoSupport, bool hasContentMgr = true);

 static IDataBase* CreateCloudDataBase(IDataBase::UndoSupport undoSupport, bool hasContentMgr = true,const std::string & assetRef = "");
 
 // Create a clone from a database snapshot(for internal use only)
 static IDataBase* CreateCloneFromDatabaseSnapshot(DatabaseSnapshotPtr dbSnapshot, IDataBase::UndoSupport undosupport = IDataBase::kPartialUndoSupport) ;

 static void SetMagicBytes(const MagicBytes bytes);

 static uint32 GetAvailableNewDatabases ();

 static bool16 IsValidDataBase (IDataBase *db);


 // Inval handler management fuctions.

 static bool16 AttachInvalHandler(IDataBase* db, IInvalHandler*, InvalHandlerID id);

 static void DetachInvalHandler(IDataBase* db, IInvalHandler* );

 static IInvalHandler* GetInvalHandler(const IDataBase* db, InvalHandlerID id); // For purges. When interfaces come back to life after a purge,
 // they can enquire if the were already registerred with the sequence.

 static bool16 StartCollectingInvals (IDataBase* db, IInvalHandler* handler);

 // Lazy notification functions

 static void DiscardLazyNotificationSubject(IDataBase* db, const UIDRef& subject);

 typedef void (*CUIDFilterFunction) (void *buffer, uint32 size, uint16 type);
 
 static void SetCUIDImportFilter (CUIDFilterFunction functor);
 static void SetCUIDExportFilter (CUIDFilterFunction functor);
 static CUIDFilterFunction GetCUIDImportFilter ();
 static CUIDFilterFunction GetCUIDExportFilter ();
 
 // Set the constructor function. Returns the old one.
 static BossConstructor SetObjectConstructor(BossConstructor newConstructor);

 static void GetUIDPersistedInterfaces(IDataBase *db, UID id, ClassID clsID, IPMPersist* obj, std::vector<ImplementationID>& implList);
 
 // Call this to tell the database what to stamp new files with, and 
 // what files can legally be opened.
 static void SetBuildVersion(int32 majorVersionNumber, int32 minorVersionNumber);
 // Call this to find out if the file is a valid database file. 
 // Currently this always returns true for unclear historical reasons, which makes it less than useful. [][]
 static bool16 IsValidDataBase(const IDFile *fileToCheck);
 // Defines where to put mini save files.
 // Copies the value of newPath.
 // A call with newPath = nil deletes the path (this is necessary to avoid a memory leak)
 static void SetRecoveryPath(const IDFile* newPath);
 static const IDFile *GetRecoveryPath();
 // EnableInstanceCaches enables/disables all caches and returns kTrue
 // if the caches were enabled before
 static bool16 EnableInstanceCaches(bool16 enable);
 static void AddClass(IDataBase *db, ClassID newCls, UID uid);
 // Tell the PlugInContentMgr that a new class has been added to the document.
 static void ProcessDeferredContent(IDataBase *db);

 static IDataBase::CachePolicy GetNewDataBaseCachePolicy();
 static void SetNewDataBaseCachePolicy(IDataBase::CachePolicy);
 
 // Reference Index 
 static IRIDXDBInterface *GetRIDXDBInterface ();
 static void SetRIDXDBInterface (IRIDXDBInterface *i);
 static void EnableRIDXDBInterface ();
 
#ifdef DEBUG
 // limits UID to a number smaller than 0xFFFFFFFF
 // and returns the current limit
 static UID SetMaxUID(UID newMaxUID);
 // returns the current limit for UIDs
 static UID GetMaxUID();
 
 static void SetAssertOnInstantiateFail(bool16 showAsserts);
 static bool16 ShowInstantiateAsserts();

#endif

 //internal use only
 static void ShutdownSUIDS();
 static void PreShutdownSUIDS();
 static void InitializeSUIDS();
 static uint32 GetTotalCurrentNetworkCacheSize();
};


#endif //__DBUTILS_