CCommandLineArgs.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael Burbidge
// 
// $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 __CCommandLineArgs_h__
#define __CCommandLineArgs_h__

#include "IDFile.h"

#include <string>
#include <vector>


class CCommandLineArgs
{
public:
 enum { kInvalidPort = -1 };

 enum { kInvalidTimeValue = -1 };

 enum SessionSupportTimeoutType
 {
 kTimeoutSessionIdle,
 kTimeoutReceiveIdle,
 kSSTimeoutUnknown
 };
 
 CCommandLineArgs();
 virtual ~CCommandLineArgs();
 
 virtual void Terminate();
 
 virtual int32 GetArgCnt();
 
 virtual const PMString& GetNthArg(const int32& nth);
 
 virtual int GetPortNumber();

 virtual int GetAdminPortNumber();
 
 virtual bool ShouldCreateConsole();
 
 virtual PMString GetConfigurationName();
 
 virtual const PMString& GetExecutablePath();
 
 virtual int32 GetMaxErrors();

 virtual void SetMaxErrors(int32 newMaxErrors );

 virtual bool ShouldPostToErrorList();

 virtual void SetPostToErrorList(bool16 bShouldPost);
 
 virtual bool ShouldUseSEH();
 
 virtual bool ArePreviewsOn();
 
 virtual PMString GetHomeFolder();
 
 virtual PMString GetPluginPath();
 
 virtual PMString GetIORFile();

 virtual PMString GetHostName();
 
 virtual bool ShouldLogToSystemEventLog();
 
 virtual bool ShouldSendCrashLogs();

 virtual int GetSessionSupportTimeout(SessionSupportTimeoutType type);

 virtual int GetHeartbeatUpdateInterval();

 virtual bool ExecuteOnMainThreadOnly();

 virtual bool IsSessionSupportNonBlocking();

 virtual uint16 GetMaximumWaitForBeginSession();

 virtual bool ProcessArgs() { return (ProcessArgsEarly() && ProcessArgsLate()); };
 virtual bool ProcessArgsEarly(); // may be called before initialization is complete
 virtual bool ProcessArgsLate(); // may only be called after initialization (especially CoolType) is complete
 
 virtual void ShowUsage();

 virtual bool GetUseVersionCue();

private:
 virtual void Abort(const PMString& msg = "", bool bShowUsage = kTrue);

 virtual bool AcquireSingleInstance() = 0;
 virtual void ReleaseSingleInstance() = 0;
 
 virtual bool AcquirePort(const int& portNumber) = 0;
 virtual void ReleasePort() = 0;
 
 virtual bool AcquireConfiguration(const PMString& configurationName) = 0;
 virtual void ReleaseConfiguration() = 0;
 
 virtual bool PortIsInUse(const int& portNumber) = 0;

protected:
 virtual IDFile MakeFileInSemaphoreFolder(const PMString& filename);

 std::vector<PMString> fArgs; // used by M/WCommandLineArgs

private:
 enum Status { kNotProcessed, kPartiallyProcessed, kProcessedSuccess, kProcessedFailure };
 
 PMString fConfigurationName;
 PMString fExecutablePath;
 PMString fHomeFolder;
 PMString fPluginPath;
 PMString fIORFile;
 PMString fHostName;

 int fPortNumber;
 int fAdminPortNumber;
 int32 fMaxErrors;

 Status fStatus;
 bool fShouldCreateConsole;
 bool fShouldPostToErrorList;
 bool fShouldUseSEH;
 bool fPreviews;
 bool fBShouldLogToSystemEventLog;
 bool fBConfigurationAcquired;
 bool fBSendCrashLogs;

 int fSessionSupportSessionIdleTimeout;
 int fSessionSupportReceiveIdleTimeout;
 int fHeartbeatUpdateTimeInterval;

 bool fExecuteOnMainThreadOnly;
 bool fNonBlockingSessionSupport;
 int16 fMaxWaitTimeForBeginSession;
 bool fBShouldUseVersionCue;
};

extern CCommandLineArgs* gCommandLineArgs;

#endif