CmdUtils.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.
// 
//========================================================================================

#ifndef __CMDUTILS__
#define __CMDUTILS__

// these really shouldn't be here - but a lot of files rely on them (- Roey)
#include "ISession.h"
#include "CreateObject.h"


#include "PMTypes.h"
#include "CommandID.h"
#include "ICommand.h"
#include "ICommandSequence.h"
#include "ICommandProcessor.h"


#include "CmdUtilsMacros.h"



class CmdUtils {
public:
 // -----------------------------------------
 // command creation
 // -----------------------------------------
 
 static ICommand *CreateCommand(ClassID cmdType);
 
 // -----------------------------------------
 // command execution
 // -----------------------------------------
 
 static ErrorCode ProcessCommand(ICommand *cmd);
 
 static ErrorCode ScheduleCommand(ICommand *cmd, ICommand::Priority priority = ICommand::kLowPriority);

 static ErrorCode ExecuteDynamicCommand(ICommand *cmd);
 static ErrorCode ExecuteDynamicCommand(ICommand *cmd, bool16 isActive);
 
 static bool16 ProcessScheduledCmds(ICommand::Priority downToPriority = ICommand::kLowestPriority);
 
 // -----------------------------------------
 // command sequences
 // -----------------------------------------

 static ICommandSequence *BeginCommandSequence(const char* trackingData = nullptr);

 static ErrorCode EndCommandSequence(ICommandSequence *sequence);
 
 static IAbortableCmdSeq *BeginAbortableCmdSeq(const char* trackingData = nullptr);

 static ErrorCode EndCommandSequence(IAbortableCmdSeq *sequence);

 static ErrorCode AbortCommandSequence(IAbortableCmdSeq *sequence);

 static SequenceMark SetSequenceMark(const IAbortableCmdSeq *sequence);

 static ErrorCode RollBackCommandSequence(const IAbortableCmdSeq *sequence, SequenceMark upToMark = SequenceMark());

 static void EnableBusyCursor(bool16 bEnable);

 static bool16 IsBusyCursorEnabled();

 static int32 GetMaxStackHeight();
 
 class SequenceContext
 {
 public:
 SequenceContext(const PMString *name = nil);
 ~SequenceContext();
 bool16 Success() { return kSuccess == State(); }
 ErrorCode State();

 private:
 ICommandSequence* fSequence; 
 };
 
 class SequencePtr
 {
 public:
 explicit SequencePtr() :
 fSequence(CmdUtils::BeginCommandSequence(CONCAT_NAMES(__FILE__, __LINE__)))
 {}
 ~SequencePtr();

 bool16 Success() { return kSuccess == State(); }
 ErrorCode State();
 ICommandSequence* operator->() { return fSequence; }

 private:
 //These are not implemented. They are private to prevent use.
 SequencePtr(const SequencePtr&);
 SequencePtr& operator=(const SequencePtr&);

 private:
 ICommandSequence* fSequence;
 };

 static ErrorCode ExecuteCommand(ICommand *cmd);
 static ErrorCode LWProcessCommand(ICommand *cmd);
 static bool8 IsCommandLWProcessed(ICommand *cmd);
 
 static IAutoUndoSequence *BeginAutoUndoSequence(IDataBase* target, const char* trackingData=nullptr);

 static ErrorCode EndAutoUndoSequence(IAutoUndoSequence *arg);

 class AutoUndoSequencePtr
 {
 
 public:
 explicit AutoUndoSequencePtr(IDataBase* target)
 : fCookie(nil)
 {
 if (target)
 fCookie = CmdUtils::BeginAutoUndoSequence(target, CONCAT_NAMES(__FILE__, __LINE__));
 }
 ~AutoUndoSequencePtr()
 {
 if (fCookie)
 CmdUtils::EndAutoUndoSequence(fCookie);
 }
 
 private:
 //These are not implemented. They are private to prevent use.
 AutoUndoSequencePtr(const AutoUndoSequencePtr&);
 AutoUndoSequencePtr& operator=(const AutoUndoSequencePtr&);

 private:
 IAutoUndoSequence* fCookie;
 };

private:
#ifdef DEBUG

 enum { kMaxStackHeight = 1500 };
#else
 #ifdef MACINTOSH
 enum { kMaxStackHeight = 25000 };
 #else 
 #ifdef _M_IX86 
 enum { kMaxStackHeight = 10000 };
 #else
 enum { kMaxStackHeight = 25000 };
 #endif
 #endif
#endif
};


#endif // __CMDUTILS__