CDataExchangeController.h

//========================================================================================
// 
// $File$
// 
// Owner: Dave Burnard
// 
// $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 __CDataExchangeController__
#define __CDataExchangeController__

#include "IDataExchangeController.h"
#include "ShuksanID.h"
#include "HelperInterface.h"

#include "K2Vector.h"
#include "IDataExchangeHandler.h"
#include "DataExchangeHandlerEntry.h"

//========================================================================================
// Forward declarations
//========================================================================================
class IDataBase;
class ICommand;
class IDocument;

class DataExchangeTestProvider;


class CDataExchangeController : public IDataExchangeController
{
 // ----- Constructors/desctructors
 public:
 CDataExchangeController(IPMUnknown *boss);
 virtual ~CDataExchangeController();
 
 virtual void ReadWrite(IPMStream* s, ImplementationID prop);

 // ----- Scrap handlers
 public:
 // ----- Registration
 virtual void RegisterAllHandlers();
 virtual bool16 RegisterDataHandler(ClassID dataClass);
 virtual IDataExchangeHandler* NewDataHandler(ClassID dataClass) const;
 // ----- Queries
 virtual IDataExchangeHandler* QueryHandler(const PMFlavor& scrapFlavor) const;
 virtual IDataExchangeHandler* QueryHandler(const ExternalPMFlavor& fromFlavor, const PMFlavor& toFlavor) const;
 virtual IDataExchangeHandler* QueryHandlerForInternalize(DataExchangeResponse& response, const PMFlavor& internalizeToThisFlavor = kNoFlavor) const = 0;

 virtual void GetInternalizeableFlavors(OrderedFlavorList &flavorList) const;

 // ----- Active handler
 public:
 virtual IDataExchangeHandler* QueryActiveHandler() const;
 virtual void SetActiveHandler(IDataExchangeHandler* activeHandler);

 virtual bool16 NeedsToInternalize() const = 0;

 // ----- Scrap database, Initialization and Cleanup
 public:
 virtual IDataBase* GetScrapDataBase() const;
 virtual ErrorCode Initialize();
 virtual bool16 IsValid() const;
 virtual void Cleanup();
 
 // ----- Memory purge
 public:
 virtual void Purge(int32 level);
 static void Purge(int32 level, void *refPtr);
 
 void AllowPurge()
 { ++fAllowPurge; }
 void DisallowPurge()
 { --fAllowPurge; }
 bool PurgeIsAllowed() const
 { return fAllowPurge == 0; }

 // ----- Support for testing
 friend class DataExchangeTest;
 
 protected:
 // ----- Internal Queries
 virtual IDataExchangeHandler* QueryHandlerToInternalizeData(IPMDataObject* whichItem, DataExchangeResponse& response, const PMFlavor& toFlavor) const;
 virtual IDataExchangeHandler* QueryHandlerToInternalizeData(DataObjectIterator& dataIter, DataExchangeResponse& response, const PMFlavor& toFlavor) const;

 // ----- Initialization
 virtual ClassID GetScrapDocBossID() const; 

 virtual PMString GetScrapDBFileName() const = 0; 
 virtual IDataBase* CreateDataBase() const = 0; 
 virtual void ResetMagicBytes() const = 0; 

 virtual ErrorCode InitializeScrap(); 
 virtual ErrorCode RevertScrap(); 
 
 virtual void RunNewScrapResponders(); //
 
 //this should be called only from clipboard interfaces for Mac and windows
 virtual bool16 IsClipboardExternal() const{
 ASSERT_FAIL("CDataExchangeController::IsClipboardExternal: should not be called here");
 return kFalse;}
 
 protected:
 // ----- Scrap database
 bool16 fInitialized;
 ErrorCode fInitializationErrorCode;
 IDataBase* fScrapDB;
 UID fScrapDocID;
 bool16 fScrapDBFailed;
 IPMUnknown* fRoot;
 int32 fAllowPurge;
 
 // ----- Scrap handlers
 bool16 fDataHandlersRegistered;
 K2Vector<DataExchangeHandlerEntry> fDataHandlers;
 
 // ----- Active handler
 IDataExchangeHandler* fActiveHandler;
 IDataExchangeHandler* GetActiveHandler() const {return fActiveHandler;}

 // ----- cached handler from last query
 virtual IDataExchangeHandler* QueryCachedHandler() const;
 virtual void SetCachedHandler(IDataExchangeHandler* handlerToCache);
 IDataExchangeHandler* fCachedHandler;

 
};



#endif