hl2sdk/public/tier0/icommandline.h

//===== Copyright © 1996-2005, Valve Corporation, All rights reserved. ======//
//
// Purpose: 
//
//===========================================================================//

#ifndef TIER0_ICOMMANDLINE_H
#define TIER0_ICOMMANDLINE_H
#ifdef _WIN32
#pragma once
#endif

#include "tier0/platform.h"
#include "tier1/utlstringtoken.h"

class CBufferString;

//-----------------------------------------------------------------------------
// Purpose: Interface to engine command line
//-----------------------------------------------------------------------------
abstract_class ICommandLine
{
public:
	virtual void		CreateCmdLine( const char *commandline ) = 0;
	virtual void		CreateCmdLine( int argc, char **argv ) = 0;
	virtual void		CreateCmdLinePrependAppName( const char *commandline ) = 0;

	// Check whether a particular parameter exists
	virtual	const char	*CheckParm( CUtlStringToken param, const char **ppszValue = 0 ) const = 0;
	virtual bool		HasParm( CUtlStringToken param ) const = 0;
	
	// Gets at particular parameters
	virtual int			ParmCount() const = 0;
	virtual int			FindParm( CUtlStringToken param ) const = 0;	// Returns 0 if not found.
	virtual const char* GetParm( int nIndex ) const = 0;

	// Returns the argument after the one specified, or the default if not found
	virtual const char	*ParmValue( CUtlStringToken param, const char *pDefaultVal = 0 ) const = 0;
	virtual int			ParmValue( CUtlStringToken param, int nDefaultVal ) const = 0;
	virtual float		ParmValue( CUtlStringToken param, float flDefaultVal ) const = 0;
	virtual bool		ParmValue( CUtlStringToken param, const char *pDefaultVal, CBufferString *bufOut ) = 0;

	virtual const char **GetParms() const = 0;
	virtual const char *GetCmdLine( void ) const = 0;
	virtual void		AppendParm( CUtlStringToken param, const char *pszValues ) = 0;
	
	// Returns true if there's atleast one parm available
	virtual bool		HasParms( void ) const = 0;

	virtual const char *GetUnkString() = 0;
};

//-----------------------------------------------------------------------------
// Gets a singleton to the commandline interface
// NOTE: The #define trickery here is necessary for backwards compat:
// this interface used to lie in the vstdlib library.
//-----------------------------------------------------------------------------
PLATFORM_INTERFACE ICommandLine *CommandLine();

#endif // TIER0_ICOMMANDLINE_H