Class used to create and/or parse command line arguments. More...

#include "include/cef_command_line.h"

Inheritance diagram for CefCommandLine:

Public Types
typedef std::vector< CefString >	ArgumentList

typedef std::map< CefString, CefString >	SwitchMap

Public Member Functions
virtual bool	IsValid ()=0
	Returns true if this object is valid. More...

virtual bool	IsReadOnly ()=0
	Returns true if the values of this object are read-only. More...

virtual CefRefPtr< CefCommandLine >	Copy ()=0
	Returns a writable copy of this object. More...

virtual void	InitFromArgv (int argc, const char const argv)=0
	Initialize the command line with the specified \|argc\| and \|argv\| values. More...

virtual void	InitFromString (const CefString &command_line)=0
	Initialize the command line with the string returned by calling GetCommandLineW(). More...

virtual void	Reset ()=0
	Reset the command-line switches and arguments but leave the program component unchanged. More...

virtual void	GetArgv (std::vector< CefString > &argv)=0
	Retrieve the original command line string as a vector of strings. More...

virtual CefString	GetCommandLineString ()=0
	Constructs and returns the represented command line string. More...

virtual CefString	GetProgram ()=0
	Get the program part of the command line string (the first item). More...

virtual void	SetProgram (const CefString &program)=0
	Set the program part of the command line string (the first item). More...

virtual bool	HasSwitches ()=0
	Returns true if the command line has switches. More...

virtual bool	HasSwitch (const CefString &name)=0
	Returns true if the command line contains the given switch. More...

virtual CefString	GetSwitchValue (const CefString &name)=0
	Returns the value associated with the given switch. More...

virtual void	GetSwitches (SwitchMap &switches)=0
	Returns the map of switch names and values. More...

virtual void	AppendSwitch (const CefString &name)=0
	Add a switch to the end of the command line. More...

virtual void	AppendSwitchWithValue (const CefString &name, const CefString &value)=0
	Add a switch with the specified value to the end of the command line. More...

virtual bool	HasArguments ()=0
	True if there are remaining command line arguments. More...

virtual void	GetArguments (ArgumentList &arguments)=0
	Get the remaining command line arguments. More...

virtual void	AppendArgument (const CefString &argument)=0
	Add an argument to the end of the command line. More...

virtual void	PrependWrapper (const CefString &wrapper)=0
	Insert a command before the current command. More...

Public Member Functions inherited from CefBaseRefCounted
virtual void	AddRef () const =0
	Called to increment the reference count for the object. More...

virtual bool	Release () const =0
	Called to decrement the reference count for the object. More...

virtual bool	HasOneRef () const =0
	Returns true if the reference count is 1. More...

virtual bool	HasAtLeastOneRef () const =0
	Returns true if the reference count is at least 1. More...

Static Public Member Functions
static CefRefPtr< CefCommandLine >	CreateCommandLine ()
	Create a new CefCommandLine instance. More...

static CefRefPtr< CefCommandLine >	GetGlobalCommandLine ()
	Returns the singleton global CefCommandLine object. More...

Additional Inherited Members
Protected Member Functions inherited from CefBaseRefCounted
virtual	~CefBaseRefCounted ()

Detailed Description

Class used to create and/or parse command line arguments.

Arguments with "--", "-" and, on Windows, "/" prefixes are considered switches. Switches will always precede any arguments without switch prefixes. Switches can optionally have a value specified using the "=" delimiter (e.g. "-switch=value"). An argument of "--" will terminate switch parsing with all subsequent tokens, regardless of prefix, being interpreted as non-switch arguments. Switch names should be lowercase ASCII and will be converted to such if necessary. Switch values will retain the original case and UTF8 encoding. This class can be used before CefInitialize() is called.

Member Typedef Documentation

◆ ArgumentList

typedef std::vector<CefString> CefCommandLine::ArgumentList

◆ SwitchMap

typedef std::map<CefString, CefString> CefCommandLine::SwitchMap

Member Function Documentation

◆ AppendArgument()

virtual void CefCommandLine::AppendArgument ( const CefString & argument )

pure virtual

Add an argument to the end of the command line.

◆ AppendSwitch()

virtual void CefCommandLine::AppendSwitch ( const CefString & name )

pure virtual

Add a switch to the end of the command line.

If the switch has no value pass an empty value string.

◆ AppendSwitchWithValue()

virtual void CefCommandLine::AppendSwitchWithValue	(	const CefString &	name,
		const CefString &	value
	)

pure virtual

Add a switch with the specified value to the end of the command line.

◆ Copy()

virtual CefRefPtr<CefCommandLine> CefCommandLine::Copy ( )

pure virtual

Returns a writable copy of this object.

◆ CreateCommandLine()

static CefRefPtr<CefCommandLine> CefCommandLine::CreateCommandLine ( )

static

Create a new CefCommandLine instance.

◆ GetArguments()

virtual void CefCommandLine::GetArguments ( ArgumentList & arguments )

pure virtual

Get the remaining command line arguments.

◆ GetArgv()

virtual void CefCommandLine::GetArgv ( std::vector< CefString > & argv )

pure virtual

Retrieve the original command line string as a vector of strings.

The argv array: { program, [(--|-|/)switch[=value]]*, [--], [argument]* }

◆ GetCommandLineString()

virtual CefString CefCommandLine::GetCommandLineString ( )

pure virtual

Constructs and returns the represented command line string.

Use this method cautiously because quoting behavior is unclear.

◆ GetGlobalCommandLine()

static CefRefPtr<CefCommandLine> CefCommandLine::GetGlobalCommandLine ( )

static

Returns the singleton global CefCommandLine object.

The returned object will be read-only.

◆ GetProgram()

virtual CefString CefCommandLine::GetProgram ( )

pure virtual

Get the program part of the command line string (the first item).

◆ GetSwitches()

virtual void CefCommandLine::GetSwitches ( SwitchMap & switches )

pure virtual

Returns the map of switch names and values.

If a switch has no value an empty string is returned.

◆ GetSwitchValue()

virtual CefString CefCommandLine::GetSwitchValue ( const CefString & name )

pure virtual

Returns the value associated with the given switch.

If the switch has no value or isn't present this method returns the empty string.

◆ HasArguments()

virtual bool CefCommandLine::HasArguments ( )

pure virtual

True if there are remaining command line arguments.

◆ HasSwitch()

virtual bool CefCommandLine::HasSwitch ( const CefString & name )

pure virtual

Returns true if the command line contains the given switch.

◆ HasSwitches()

virtual bool CefCommandLine::HasSwitches ( )

pure virtual

Returns true if the command line has switches.

◆ InitFromArgv()

virtual void CefCommandLine::InitFromArgv	(	int	argc,
		const char const	argv
	)

pure virtual

Initialize the command line with the specified |argc| and |argv| values.

The first argument must be the name of the program. This method is only supported on non-Windows platforms.

◆ InitFromString()

virtual void CefCommandLine::InitFromString ( const CefString & command_line )

pure virtual

Initialize the command line with the string returned by calling GetCommandLineW().

This method is only supported on Windows.

◆ IsReadOnly()

virtual bool CefCommandLine::IsReadOnly ( )

pure virtual

Returns true if the values of this object are read-only.

Some APIs may expose read-only objects.

◆ IsValid()

virtual bool CefCommandLine::IsValid ( )

pure virtual

Returns true if this object is valid.

Do not call any other methods if this function returns false.

◆ PrependWrapper()

virtual void CefCommandLine::PrependWrapper ( const CefString & wrapper )

pure virtual

Insert a command before the current command.

Common for debuggers, like "valgrind" or "gdb --args".

◆ Reset()

virtual void CefCommandLine::Reset ( )

pure virtual

Reset the command-line switches and arguments but leave the program component unchanged.

◆ SetProgram()

virtual void CefCommandLine::SetProgram ( const CefString & program )

pure virtual

Set the program part of the command line string (the first item).

The documentation for this class was generated from the following file:

include/cef_command_line.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ArgumentList

◆ SwitchMap

Member Function Documentation

◆ AppendArgument()

◆ AppendSwitch()

◆ AppendSwitchWithValue()

◆ Copy()

◆ CreateCommandLine()

◆ GetArguments()

◆ GetArgv()

◆ GetCommandLineString()

◆ GetGlobalCommandLine()

◆ GetProgram()

◆ GetSwitches()

◆ GetSwitchValue()

◆ HasArguments()

◆ HasSwitch()

◆ HasSwitches()

◆ InitFromArgv()

◆ InitFromString()

◆ IsReadOnly()

◆ IsValid()

◆ PrependWrapper()

◆ Reset()

◆ SetProgram()