#include <rc.h>

Public Types
typedef std::vector< std::string >	PathList

Public Member Functions
void	loadFiles ()
	Load and parse files, looking in the usual places. More...

bool	parseFile (const std::string &filespec)

bool	updateFile (const std::string &filespec)
	Writes a valid gnashrc file. If the file already exists, is is overwritten. More...

bool	updateFile ()
	Writes a gnashrc file to the file specified in the GNASHRC environment variable OR to the user's home directory. More...

bool	useSplashScreen () const

void	useSplashScreen (bool value)

bool	useActionDump () const

void	useActionDump (bool value)

bool	useParserDump () const

void	useParserDump (bool value)

bool	useWriteLog () const

void	useWriteLog (bool value)

int	getTimerDelay () const

void	setTimerDelay (int x)

bool	showASCodingErrors () const

void	showASCodingErrors (bool value)

bool	showMalformedSWFErrors () const

void	showMalformedSWFErrors (bool value)

bool	showMalformedAMFErrors () const

void	showMalformedAMFErrors (bool value)

int	getMovieLibraryLimit () const

void	setMovieLibraryLimit (int value)

bool	enableExtensions () const

bool	startStopped () const
	Return true if user is willing to start the gui in "stop" mode. More...

void	startStopped (bool value)

bool	insecureSSL () const

void	insecureSSL (bool value)

int	qualityLevel () const

void	qualityLevel (int value)

int	verbosityLevel () const

void	verbosityLevel (int value)

void	setDebugLog (const std::string &x)

const std::string &	getDebugLog () const

void	setDocumentRoot (const std::string &x)

std::string	getDocumentRoot ()

bool	useDebugger () const

void	useDebugger (bool value)

bool	useSound () const

void	useSound (bool value)

bool	usePluginSound () const

void	usePluginSound (bool value)

bool	popupMessages () const

void	interfacePopups (bool value)

bool	useLocalDomain () const

void	useLocalDomain (bool value)

bool	useLocalHost () const
	Whether to restrict access to the local host. More...

void	useLocalHost (bool value)
	Set whether to restrict access to the local host. More...

const PathList &	getWhiteList () const
	Get the current RcInitFile whitelist of domains to allow. More...

void	setWhitelist (const std::vector< std::string > &list)
	Sets the RcInitFile whitelist of domains to allow. More...

const PathList &	getBlackList () const
	Get the current RcInitFile blacklist of domains to block. More...

bool	showMouse () const

void	setBlacklist (const std::vector< std::string > &list)
	Sets the RcInitFile blacklist of domains to block. More...

const PathList &	getLocalSandboxPath () const
	Return the list of directories to be used as the 'local' sandbox. More...

void	addLocalSandboxPath (const std::string &dir)
	Add a directory to the local sandbox list. More...

void	setLocalSandboxPath (const PathList &path)

const std::string &	getFlashVersionString () const

void	setFlashVersionString (const std::string &value)

const std::string &	getFlashSystemOS () const

void	setFlashSystemOS (const std::string &value)

const std::string &	getFlashSystemManufacturer () const

void	setFlashSystemManufacturer (const std::string &value)

const std::string &	getGstAudioSink () const

void	setGstAudioSink (const std::string &value)

int	getRetries () const

void	setRetries (int x)

double	getStreamsTimeout () const
	The number of seconds of inactivity before timing out streams downloads. More...

void	setStreamsTimeout (const double &x)
	Set seconds of inactivity before timing out streams downloads. More...

const std::string &	getURLOpenerFormat () const
	Get the URL opener command format. More...

void	setURLOpenerFormat (const std::string &value)

const std::string &	getHWAccel () const

void	setHWAccel (const std::string &x)

const std::string &	getRenderer () const

void	setRenderer (const std::string &x)

const std::string &	getMediaHandler () const

void	setMediaHandler (const std::string &x)

const std::string &	getSOLSafeDir () const

void	setSOLSafeDir (const std::string &x)

bool	getSOLLocalDomain () const

void	setSOLLocalDomain (bool x)

bool	getSOLReadOnly () const

void	setSOLReadOnly (bool x)

bool	getLocalConnection () const

void	setLocalConnection (bool x)

bool	getLCTrace () const
	Enable tracing all LocalConnection traffic. More...

void	setLCTrace (bool x)

key_t	getLCShmKey () const

void	setLCShmKey (bool x)

bool	ignoreFSCommand () const

void	ignoreFSCommand (bool value)

void	saveStreamingMedia (bool value)

bool	saveStreamingMedia () const

void	saveLoadedMedia (bool value)

bool	saveLoadedMedia () const

void	setMediaDir (const std::string &value)

const std::string &	getMediaDir () const

void	setWebcamDevice (int value)

int	getWebcamDevice () const

void	setAudioInputDevice (int value)

int	getAudioInputDevice ()

const std::string &	getRootCert () const
	Get the Root SSL certificate. More...

void	setRootCert (const std::string &value)
	Set the Root SSL certificate. More...

const std::string &	getCertFile () const
	Get the Client SSL certificate. More...

void	setCertFile (const std::string &value)
	Set the Client SSL certificate. More...

const std::string &	getCertDir () const
	Get the directory for client SSL certificates. More...

void	setCertDir (const std::string &value)
	Set the directory for client SSL certificates. More...

void	ignoreShowMenu (bool value)

bool	ignoreShowMenu () const

int	getScriptsTimeout () const

void	setScriptsTimeout (int x)

int	getScriptsRecursionLimit () const

void	setScriptsRecursionLimit (int x)

void	lockScriptLimits (bool x)

bool	lockScriptLimits () const

void	dump ()

Static Public Member Functions
static RcInitFile &	getDefaultInstance ()
	Return the default instance of RC file. More...

Protected Types
typedef boost::char_separator< char >	Sep

typedef boost::tokenizer< Sep >	Tok

Protected Member Functions
void	writeList (const PathList &list, std::ostream &o)

	RcInitFile ()
	Construct only by getDefaultInstance() More...

	~RcInitFile ()
	Never destroy (TODO: add a destroyDefaultInstance) More...

void	parseList (std::vector< std::string > &list, const std::string &action, const std::string &items)
	parses a space-separated list into std::vector list More...

Static Protected Member Functions
static void	expandPath (std::string &path)

static bool	extractSetting (bool &var, const std::string &pattern, const std::string &variable, const std::string &value)
	If variable matches pattern (case-insensitive) set var according to value. More...

template<typename T >
static bool	extractNumber (T &num, const std::string &pattern, const std::string &variable, const std::string &value)
	If variable matches pattern (case-insensitive) set num according to value. More...

static bool	extractDouble (double &out, const std::string &pattern, const std::string &variable, const std::string &value)
	If variable matches pattern (case-insensitive) set out according to value. More...

Protected Attributes
std::uint32_t	_delay
	The timer delay. More...

std::uint32_t	_movieLibraryLimit
	Max number of movie clips to store in the library. More...

bool	_debug
	Enable debugging of this class. More...

bool	_debugger
	Enable the Flash movie debugger. More...

std::uint32_t	_verbosity
	Level of debugging output. More...

std::string	_urlOpenerFormat
	Command format to use to open urls. More...

std::string	_flashVersionString
	String to pass as $version in Actionscript. More...

std::string	_gstaudiosink
	String representing the first GStreamer audio output pipeline to try. More...

std::string	_flashSystemOS
	String to pass as System.capabilities.os in Actionscript. If empty, leaves detection to System.cpp (default). More...

std::string	_flashSystemManufacturer
	String to pass as System.capabilities.manufacturer in Actionscript. More...

bool	_actionDump
	Enable dumping actionscript classes. More...

bool	_parserDump
	Enable dumping parser data. More...

bool	_verboseASCodingErrors
	Enable ActionScript errors verbosity. More...

bool	_verboseMalformedSWF
	Enable Malformed SWF verbosity. More...

bool	_verboseMalformedAMF
	Enable Malformed AMF verbosity. More...

bool	_splashScreen
	Display a splash screen when loading a movie. More...

bool	_localdomainOnly
	Only access network resources in the local domain. More...

bool	_localhostOnly
	Only access network resources on the local host. More...

bool	_showMouse
	Show the mouse pointer. More...

PathList	_whitelist
	Allowed domains. More...

PathList	_blacklist
	Blocked Domains. More...

std::string	_log
	The name of the debug log. More...

bool	_writeLog
	Enable writing the debug log to disk. More...

std::string	_wwwroot
	The root path for the streaming server. More...

int	_retries
	the number of retries for a thread More...

bool	_sound
	Enable the sound handler at startup. More...

bool	_pluginSound
	Enable sound for the plugin. More...

bool	_extensionsEnabled
	Enable scanning plugin path for extensions. More...

bool	_startStopped
	Start the gui in "stop" mode. More...

bool	_insecureSSL
	Allow SSL connections without verifying the certificate. More...

double	_streamsTimeout
	The number of seconds of inactivity triggering download timeout. More...

PathList	_localSandboxPath
	Local sandbox: the set of resources on the filesystem we want to give the current movie access to. More...

std::string	_solsandbox
	SOL Sandbox: This is the only dir .sol (Shared Object) files can be written in, or read from. More...

bool	_solreadonly
	Whether SOL files can be written. More...

bool	_sollocaldomain

bool	_lcdisabled

bool	_lctrace
	Trace local connection activity (in log) More...

std::uint32_t	_lcshmkey

bool	_ignoreFSCommand

int	_quality
	The quality to display SWFs in. -1 to allow the SWF to override. More...

bool	_saveStreamingMedia

bool	_saveLoadedMedia

std::string	_mediaCacheDir

bool	_popups

int	_webcamDevice

int	_microphoneDevice

std::string	_certfile

std::string	_certdir

std::string	_rootcert

bool	_ignoreShowMenu

std::string	_hwaccel

std::string	_renderer

std::string	_mediahandler

int	_scriptsTimeout

int	_scriptsRecursionLimit
	The max actionscript function call stack depth. More...

bool	_lockScriptLimits
	Whether to ignore SWF ScriptLimits tags. More...

Member Typedef Documentation

§ PathList

typedef std::vector<std::string> gnash::RcInitFile::PathList

§ Sep

typedef boost::char_separator<char> gnash::RcInitFile::Sep

protected

§ Tok

typedef boost::tokenizer< Sep > gnash::RcInitFile::Tok

protected

Constructor & Destructor Documentation

§ RcInitFile()

gnash::RcInitFile::RcInitFile ( )

protected

Construct only by getDefaultInstance()

References _solsandbox, _urlOpenerFormat, expandPath(), loadFiles(), and LONG.

§ ~RcInitFile()

gnash::RcInitFile::~RcInitFile ( )

protected

Never destroy (TODO: add a destroyDefaultInstance)

Member Function Documentation

§ addLocalSandboxPath()

void gnash::RcInitFile::addLocalSandboxPath ( const std::string & dir )

inline

Add a directory to the local sandbox list.

Referenced by gnash::Player::setScale().

§ dump()

void gnash::RcInitFile::dump ( )

§ enableExtensions()

bool gnash::RcInitFile::enableExtensions ( ) const

inline

Referenced by gnash::createObject().

§ expandPath()

void gnash::RcInitFile::expandPath ( std::string & path )

staticprotected

Substitutes user's home directory for ~ on a path string according to POSIX standard.

Parameters

path	the path to expand.

Referenced by parseFile(), and RcInitFile().

§ extractDouble()

bool gnash::RcInitFile::extractDouble	(	double &	out,
		const std::string &	pattern,
		const std::string &	variable,
		const std::string &	value
	)

staticprotected

If variable matches pattern (case-insensitive) set out according to value.

Returns: true if variable matches pattern, false otherwise

Parameters

out	the variable to change
pattern	the pattern for matching the variable to match to pattern the value to adopt if variable matches pattern.

Referenced by parseFile().

§ extractNumber()

template<typename T >

static bool gnash::RcInitFile::extractNumber	(	T &	num,
		const std::string &	pattern,
		const std::string &	variable,
		const std::string &	value
	)

inlinestaticprotected

If variable matches pattern (case-insensitive) set num according to value.

Returns: true if variable matches pattern, false otherwise

Parameters

num	the variable to change
pattern	the pattern for matching the variable to match to pattern the value to adopt if variable matches pattern.

Referenced by parseFile().

§ extractSetting()

bool gnash::RcInitFile::extractSetting	(	bool &	var,
		const std::string &	pattern,
		const std::string &	variable,
		const std::string &	value
	)

staticprotected

If variable matches pattern (case-insensitive) set var according to value.

Returns: true if variable matches pattern, false otherwise

Parameters

var	the variable to change
pattern	the pattern for matching the variable to match to pattern the value to adopt if variable matches pattern.

Referenced by parseFile().

§ getAudioInputDevice()

int gnash::RcInitFile::getAudioInputDevice ( )

inline

§ getBlackList()

const PathList& gnash::RcInitFile::getBlackList ( ) const

inline

Get the current RcInitFile blacklist of domains to block.

Returns: a std::vector of strings containing blocked domains

§ getCertDir()

const std::string& gnash::RcInitFile::getCertDir ( ) const

inline

Get the directory for client SSL certificates.

§ getCertFile()

const std::string& gnash::RcInitFile::getCertFile ( ) const

inline

Get the Client SSL certificate.

§ getDebugLog()

const std::string& gnash::RcInitFile::getDebugLog ( ) const

inline

Referenced by gnash::Player::setScale().

§ getDefaultInstance()

RcInitFile & gnash::RcInitFile::getDefaultInstance ( )

static

Return the default instance of RC file.

Referenced by gnash::MovieFactory::clear(), gnash::createObject(), gnash::GtkGui::error(), gnash::media::gst::GstUtil::get_audiosink_element(), gnash::NetConnection_as::getStream(), gnash::movie_root::getURL(), gnash::MovieLibrary::MovieLibrary(), gnash::IncrementalRename::operator()(), gnash::registerSystemNative(), gnash::Player::run(), gnash::movie_root::setQuality(), gnash::Player::setScale(), gnash::movie_root::setScriptLimits(), gnash::GtkGui::showMenu(), and gnash::GtkGui::showMouse().

§ getDocumentRoot()

std::string gnash::RcInitFile::getDocumentRoot ( )

inline

§ getFlashSystemManufacturer()

const std::string& gnash::RcInitFile::getFlashSystemManufacturer ( ) const

inline

Referenced by gnash::registerSystemNative().

§ getFlashSystemOS()

const std::string& gnash::RcInitFile::getFlashSystemOS ( ) const

inline

§ getFlashVersionString()

const std::string& gnash::RcInitFile::getFlashVersionString ( ) const

inline

§ getGstAudioSink()

const std::string& gnash::RcInitFile::getGstAudioSink ( ) const

inline

Referenced by gnash::media::gst::GstUtil::get_audiosink_element().

§ getHWAccel()

const std::string& gnash::RcInitFile::getHWAccel ( ) const

inline

§ getLCShmKey()

key_t gnash::RcInitFile::getLCShmKey ( ) const

inline

§ getLCTrace()

bool gnash::RcInitFile::getLCTrace ( ) const

inline

Enable tracing all LocalConnection traffic.

§ getLocalConnection()

bool gnash::RcInitFile::getLocalConnection ( ) const

inline

§ getLocalSandboxPath()

const PathList& gnash::RcInitFile::getLocalSandboxPath ( ) const

inline

Return the list of directories to be used as the 'local' sandbox.

Local sendbox is the set of resources on the filesystem we want to give the current movie access to.

§ getMediaDir()

const std::string& gnash::RcInitFile::getMediaDir ( ) const

inline

Referenced by gnash::IncrementalRename::operator()().

§ getMediaHandler()

const std::string& gnash::RcInitFile::getMediaHandler ( ) const

inline

§ getMovieLibraryLimit()

int gnash::RcInitFile::getMovieLibraryLimit ( ) const

inline

Referenced by gnash::MovieLibrary::MovieLibrary().

§ getRenderer()

const std::string& gnash::RcInitFile::getRenderer ( ) const

inline

§ getRetries()

int gnash::RcInitFile::getRetries ( ) const

inline

§ getRootCert()

const std::string& gnash::RcInitFile::getRootCert ( ) const

inline

Get the Root SSL certificate.

§ getScriptsRecursionLimit()

int gnash::RcInitFile::getScriptsRecursionLimit ( ) const

inline

§ getScriptsTimeout()

int gnash::RcInitFile::getScriptsTimeout ( ) const

inline

§ getSOLLocalDomain()

bool gnash::RcInitFile::getSOLLocalDomain ( ) const

inline

§ getSOLReadOnly()

bool gnash::RcInitFile::getSOLReadOnly ( ) const

inline

§ getSOLSafeDir()

const std::string& gnash::RcInitFile::getSOLSafeDir ( ) const

inline

§ getStreamsTimeout()

double gnash::RcInitFile::getStreamsTimeout ( ) const

inline

The number of seconds of inactivity before timing out streams downloads.

§ getTimerDelay()

int gnash::RcInitFile::getTimerDelay ( ) const

inline

Referenced by gnash::Player::setScale().

§ getURLOpenerFormat()

const std::string& gnash::RcInitFile::getURLOpenerFormat ( ) const

inline

Get the URL opener command format.

The u label will need to be substituted by the actual url properly escaped.

§ getWebcamDevice()

int gnash::RcInitFile::getWebcamDevice ( ) const

inline

§ getWhiteList()

const PathList& gnash::RcInitFile::getWhiteList ( ) const

inline

Get the current RcInitFile whitelist of domains to allow.

Returns: a std::vector of strings containing allowed domains

§ ignoreFSCommand() [1/2]

bool gnash::RcInitFile::ignoreFSCommand ( ) const

inline

Referenced by gnash::Player::run().

§ ignoreFSCommand() [2/2]

void gnash::RcInitFile::ignoreFSCommand ( bool value )

inline

§ ignoreShowMenu() [1/2]

void gnash::RcInitFile::ignoreShowMenu ( bool value )

inline

Referenced by gnash::GtkGui::showMenu().

§ ignoreShowMenu() [2/2]

bool gnash::RcInitFile::ignoreShowMenu ( ) const

inline

§ insecureSSL() [1/2]

bool gnash::RcInitFile::insecureSSL ( ) const

inline

§ insecureSSL() [2/2]

void gnash::RcInitFile::insecureSSL ( bool value )

inline

§ interfacePopups()

void gnash::RcInitFile::interfacePopups ( bool value )

inline

§ loadFiles()

void gnash::RcInitFile::loadFiles ( )

Load and parse files, looking in the usual places.

References _, gnash::key::e, gnash::key::i, gnash::key::l, gnash::log_error(), parseFile(), and gnash::key::t.

Referenced by RcInitFile().

§ lockScriptLimits() [1/2]

void gnash::RcInitFile::lockScriptLimits ( bool x )

inline

References x.

§ lockScriptLimits() [2/2]

bool gnash::RcInitFile::lockScriptLimits ( ) const

inline

References gnash::key::o, and path.

§ parseFile()

bool gnash::RcInitFile::parseFile ( const std::string & filespec )

References _, _actionDump, _blacklist, _certdir, _certfile, _debugger, _delay, _extensionsEnabled, _flashSystemManufacturer, _flashSystemOS, _flashVersionString, _gstaudiosink, _hwaccel, _ignoreFSCommand, _ignoreShowMenu, _insecureSSL, _lcdisabled, _lcshmkey, _lctrace, _localdomainOnly, _localhostOnly, _localSandboxPath, _lockScriptLimits, _log, _mediaCacheDir, _mediahandler, _microphoneDevice, _movieLibraryLimit, _parserDump, _pluginSound, _popups, _quality, _renderer, _rootcert, _saveLoadedMedia, _saveStreamingMedia, _scriptsRecursionLimit, _scriptsTimeout, _showMouse, _sollocaldomain, _solreadonly, _solsandbox, _sound, _splashScreen, _startStopped, _streamsTimeout, _urlOpenerFormat, _verboseASCodingErrors, _verboseMalformedAMF, _verboseMalformedSWF, _verbosity, _webcamDevice, _whitelist, _writeLog, _wwwroot, expandPath(), extractDouble(), extractNumber(), extractSetting(), and parseList().

Referenced by loadFiles().

§ parseList()

void gnash::RcInitFile::parseList	(	std::vector< std::string > &	list,
		const std::string &	action,
		const std::string &	items
	)

protected

parses a space-separated list into std::vector list

Parameters

list	the vector to modify or generate.
action	either 'set' or 'append': whether to add to or clear the vector.
items	string of space-separated values. This gets nuked.

References gnash::key::e, gnash::key::i, and gnash::key::t.

Referenced by parseFile().

§ popupMessages()

bool gnash::RcInitFile::popupMessages ( ) const

inline

Referenced by gnash::GtkGui::error().

§ qualityLevel() [1/2]

int gnash::RcInitFile::qualityLevel ( ) const

inline

Referenced by gnash::movie_root::setQuality().

§ qualityLevel() [2/2]

void gnash::RcInitFile::qualityLevel ( int value )

inline

§ saveLoadedMedia() [1/2]

void gnash::RcInitFile::saveLoadedMedia ( bool value )

inline

Referenced by gnash::MovieFactory::clear().

§ saveLoadedMedia() [2/2]

bool gnash::RcInitFile::saveLoadedMedia ( ) const

inline

§ saveStreamingMedia() [1/2]

void gnash::RcInitFile::saveStreamingMedia ( bool value )

inline

Referenced by gnash::NetConnection_as::getStream().

§ saveStreamingMedia() [2/2]

bool gnash::RcInitFile::saveStreamingMedia ( ) const

inline

§ setAudioInputDevice()

void gnash::RcInitFile::setAudioInputDevice ( int value )

inline

§ setBlacklist()

void gnash::RcInitFile::setBlacklist ( const std::vector< std::string > & list )

inline

Sets the RcInitFile blacklist of domains to block.

Parameters

list	a std::vector of strings containing domains without protocol

§ setCertDir()

void gnash::RcInitFile::setCertDir ( const std::string & value )

inline

Set the directory for client SSL certificates.

§ setCertFile()

void gnash::RcInitFile::setCertFile ( const std::string & value )

inline

Set the Client SSL certificate.

§ setDebugLog()

void gnash::RcInitFile::setDebugLog ( const std::string & x )

inline

References x.

§ setDocumentRoot()

void gnash::RcInitFile::setDocumentRoot ( const std::string & x )

inline

References x.

§ setFlashSystemManufacturer()

void gnash::RcInitFile::setFlashSystemManufacturer ( const std::string & value )

inline

§ setFlashSystemOS()

void gnash::RcInitFile::setFlashSystemOS ( const std::string & value )

inline

§ setFlashVersionString()

void gnash::RcInitFile::setFlashVersionString ( const std::string & value )

inline

§ setGstAudioSink()

void gnash::RcInitFile::setGstAudioSink ( const std::string & value )

inline

§ setHWAccel()

void gnash::RcInitFile::setHWAccel ( const std::string & x )

inline

References x.

§ setLCShmKey()

void gnash::RcInitFile::setLCShmKey ( bool x )

inline

References x.

§ setLCTrace()

void gnash::RcInitFile::setLCTrace ( bool x )

inline

References x.

§ setLocalConnection()

void gnash::RcInitFile::setLocalConnection ( bool x )

inline

References x.

§ setLocalSandboxPath()

void gnash::RcInitFile::setLocalSandboxPath ( const PathList & path )

inline

Sets a list of sandbox paths. Gnash will only allow movies access to files in these paths. The path of the movie playing is automatically added.

Parameters

list	a std::vector of strings containing paths to allow

References path.

§ setMediaDir()

void gnash::RcInitFile::setMediaDir ( const std::string & value )

inline

§ setMediaHandler()

void gnash::RcInitFile::setMediaHandler ( const std::string & x )

inline

References x.

§ setMovieLibraryLimit()

void gnash::RcInitFile::setMovieLibraryLimit ( int value )

inline

§ setRenderer()

void gnash::RcInitFile::setRenderer ( const std::string & x )

inline

§ setRetries()

void gnash::RcInitFile::setRetries ( int x )

inline

References x.

§ setRootCert()

void gnash::RcInitFile::setRootCert ( const std::string & value )

inline

Set the Root SSL certificate.

§ setScriptsRecursionLimit()

void gnash::RcInitFile::setScriptsRecursionLimit ( int x )

inline

References x.

§ setScriptsTimeout()

void gnash::RcInitFile::setScriptsTimeout ( int x )

inline

References x.

§ setSOLLocalDomain()

void gnash::RcInitFile::setSOLLocalDomain ( bool x )

inline

References x.

§ setSOLReadOnly()

void gnash::RcInitFile::setSOLReadOnly ( bool x )

inline

References x.

§ setSOLSafeDir()

void gnash::RcInitFile::setSOLSafeDir ( const std::string & x )

inline

References x.

§ setStreamsTimeout()

void gnash::RcInitFile::setStreamsTimeout ( const double & x )

inline

Set seconds of inactivity before timing out streams downloads.

References x.

§ setTimerDelay()

void gnash::RcInitFile::setTimerDelay ( int x )

inline

References x.

§ setURLOpenerFormat()

void gnash::RcInitFile::setURLOpenerFormat ( const std::string & value )

inline

§ setWebcamDevice()

void gnash::RcInitFile::setWebcamDevice ( int value )

inline

§ setWhitelist()

void gnash::RcInitFile::setWhitelist ( const std::vector< std::string > & list )

inline

Sets the RcInitFile whitelist of domains to allow.

Parameters

list	a std::vector of strings containing domains without protocol

§ showASCodingErrors() [1/2]

bool gnash::RcInitFile::showASCodingErrors ( ) const

inline

§ showASCodingErrors() [2/2]

void gnash::RcInitFile::showASCodingErrors ( bool value )

References _verboseASCodingErrors.

§ showMalformedAMFErrors() [1/2]

bool gnash::RcInitFile::showMalformedAMFErrors ( ) const

inline

§ showMalformedAMFErrors() [2/2]

void gnash::RcInitFile::showMalformedAMFErrors ( bool value )

§ showMalformedSWFErrors() [1/2]

bool gnash::RcInitFile::showMalformedSWFErrors ( ) const

inline

§ showMalformedSWFErrors() [2/2]

void gnash::RcInitFile::showMalformedSWFErrors ( bool value )

References _verboseMalformedSWF.

§ showMouse()

bool gnash::RcInitFile::showMouse ( ) const

inline

Whether to forcibly show the mouse pointer even if the SWF file disables it. THis allows touchscreen based SWF files to work on a normal non-touchscreen desktop.

Referenced by gnash::GtkGui::showMouse().

§ startStopped() [1/2]

bool gnash::RcInitFile::startStopped ( ) const

inline

Return true if user is willing to start the gui in "stop" mode.

defaults to false.

Referenced by gnash::Player::run().

§ startStopped() [2/2]

void gnash::RcInitFile::startStopped ( bool value )

inline

§ updateFile() [1/2]

bool gnash::RcInitFile::updateFile ( const std::string & filespec )

Writes a valid gnashrc file. If the file already exists, is is overwritten.

Parameters

filespec the file to write

Returns: whether the file was successfully written.

References _, _actionDump, _blacklist, _debugger, _delay, _extensionsEnabled, _flashSystemOS, _flashVersionString, _gstaudiosink, _ignoreFSCommand, _ignoreShowMenu, _insecureSSL, _lcdisabled, _lcshmkey, _lctrace, _localdomainOnly, _localhostOnly, _lockScriptLimits, _log, _mediaCacheDir, _movieLibraryLimit, _parserDump, _pluginSound, _popups, _quality, _saveLoadedMedia, _saveStreamingMedia, _scriptsRecursionLimit, _scriptsTimeout, _showMouse, _sollocaldomain, _solreadonly, _solsandbox, _sound, _splashScreen, _startStopped, _streamsTimeout, _urlOpenerFormat, _verboseASCodingErrors, _verboseMalformedAMF, _verboseMalformedSWF, _verbosity, _whitelist, _writeLog, _wwwroot, and writeList().

§ updateFile() [2/2]

bool gnash::RcInitFile::updateFile ( )

Writes a gnashrc file to the file specified in the GNASHRC environment variable OR to the user's home directory.

Returns: whether the file was successfully written.

References _, and gnash::log_error().

§ useActionDump() [1/2]

bool gnash::RcInitFile::useActionDump ( ) const

inline

Referenced by gnash::Player::setScale().

§ useActionDump() [2/2]

void gnash::RcInitFile::useActionDump ( bool value )

References _actionDump.

§ useDebugger() [1/2]

bool gnash::RcInitFile::useDebugger ( ) const

inline

§ useDebugger() [2/2]

void gnash::RcInitFile::useDebugger ( bool value )

inline

§ useLocalDomain() [1/2]

bool gnash::RcInitFile::useLocalDomain ( ) const

inline

§ useLocalDomain() [2/2]

void gnash::RcInitFile::useLocalDomain ( bool value )

References _localdomainOnly.

§ useLocalHost() [1/2]

bool gnash::RcInitFile::useLocalHost ( ) const

inline

Whether to restrict access to the local host.

§ useLocalHost() [2/2]

void gnash::RcInitFile::useLocalHost ( bool value )

Set whether to restrict access to the local host.

References _localhostOnly.

§ useParserDump() [1/2]

bool gnash::RcInitFile::useParserDump ( ) const

inline

Referenced by gnash::Player::setScale().

§ useParserDump() [2/2]

void gnash::RcInitFile::useParserDump ( bool value )

References _parserDump.

§ usePluginSound() [1/2]

bool gnash::RcInitFile::usePluginSound ( ) const

inline

§ usePluginSound() [2/2]

void gnash::RcInitFile::usePluginSound ( bool value )

inline

§ useSound() [1/2]

bool gnash::RcInitFile::useSound ( ) const

inline

§ useSound() [2/2]

void gnash::RcInitFile::useSound ( bool value )

inline

§ useSplashScreen() [1/2]

bool gnash::RcInitFile::useSplashScreen ( ) const

inline

§ useSplashScreen() [2/2]

void gnash::RcInitFile::useSplashScreen ( bool value )

References _splashScreen.

§ useWriteLog() [1/2]

bool gnash::RcInitFile::useWriteLog ( ) const

inline

Referenced by gnash::Player::setScale().

§ useWriteLog() [2/2]

void gnash::RcInitFile::useWriteLog ( bool value )

References _writeLog.

§ verbosityLevel() [1/2]

int gnash::RcInitFile::verbosityLevel ( ) const

inline

Referenced by gnash::Player::setScale().

§ verbosityLevel() [2/2]

void gnash::RcInitFile::verbosityLevel ( int value )

inline

§ writeList()

void gnash::RcInitFile::writeList	(	const PathList &	list,
		std::ostream &	o
	)

protected

Referenced by dump(), and updateFile().

Member Data Documentation

§ _actionDump

bool gnash::RcInitFile::_actionDump

protected

Enable dumping actionscript classes.

Referenced by dump(), parseFile(), updateFile(), and useActionDump().

§ _blacklist

PathList gnash::RcInitFile::_blacklist

protected

Blocked Domains.

Referenced by dump(), parseFile(), and updateFile().

§ _certdir

gnash::RcInitFile::_certdir

protected

This is the path to the directory containing cert files

Referenced by parseFile().

§ _certfile

gnash::RcInitFile::_certfile

protected

This is the name of the client certificate file

Referenced by parseFile().

§ _debug

bool gnash::RcInitFile::_debug

protected

Enable debugging of this class.

§ _debugger

bool gnash::RcInitFile::_debugger

protected

Enable the Flash movie debugger.

Referenced by dump(), parseFile(), and updateFile().

§ _delay

std::uint32_t gnash::RcInitFile::_delay

protected

The timer delay.

Referenced by dump(), parseFile(), and updateFile().

§ _extensionsEnabled

bool gnash::RcInitFile::_extensionsEnabled

protected

Enable scanning plugin path for extensions.

Referenced by dump(), parseFile(), and updateFile().

§ _flashSystemManufacturer

std::string gnash::RcInitFile::_flashSystemManufacturer

protected

String to pass as System.capabilities.manufacturer in Actionscript.

Referenced by parseFile().

§ _flashSystemOS

std::string gnash::RcInitFile::_flashSystemOS

protected

String to pass as System.capabilities.os in Actionscript. If empty, leaves detection to System.cpp (default).

Referenced by parseFile(), and updateFile().

§ _flashVersionString

std::string gnash::RcInitFile::_flashVersionString

protected

String to pass as $version in Actionscript.

Referenced by dump(), parseFile(), and updateFile().

§ _gstaudiosink

std::string gnash::RcInitFile::_gstaudiosink

protected

String representing the first GStreamer audio output pipeline to try.

Referenced by dump(), parseFile(), and updateFile().

§ _hwaccel

std::string gnash::RcInitFile::_hwaccel

protected

Whether to use HW video decoding support, no value means disabled. The only currently supported values are: none or vaapi support is coming.

Referenced by parseFile().

§ _ignoreFSCommand

bool gnash::RcInitFile::_ignoreFSCommand

protected

Whether the player should respond to fscommands (showmenu, quit etc)

Referenced by parseFile(), and updateFile().

§ _ignoreShowMenu

bool gnash::RcInitFile::_ignoreShowMenu

protected

Whether the player will recognize changes to Stage.showMenu in AS default value is true

Referenced by parseFile(), and updateFile().

§ _insecureSSL

bool gnash::RcInitFile::_insecureSSL

protected

Allow SSL connections without verifying the certificate.

Referenced by dump(), parseFile(), and updateFile().

§ _lcdisabled

bool gnash::RcInitFile::_lcdisabled

protected

Referenced by parseFile(), and updateFile().

§ _lcshmkey

std::uint32_t gnash::RcInitFile::_lcshmkey

protected

Shared memory segment key (can be set for compatibility with other players.)

Referenced by parseFile(), and updateFile().

§ _lctrace

bool gnash::RcInitFile::_lctrace

protected

Trace local connection activity (in log)

Referenced by parseFile(), and updateFile().

§ _localdomainOnly

bool gnash::RcInitFile::_localdomainOnly

protected

Only access network resources in the local domain.

Referenced by dump(), parseFile(), updateFile(), and useLocalDomain().

§ _localhostOnly

bool gnash::RcInitFile::_localhostOnly

protected

Only access network resources on the local host.

Referenced by dump(), parseFile(), updateFile(), and useLocalHost().

§ _localSandboxPath

PathList gnash::RcInitFile::_localSandboxPath

protected

Local sandbox: the set of resources on the filesystem we want to give the current movie access to.

Referenced by dump(), and parseFile().

§ _lockScriptLimits

bool gnash::RcInitFile::_lockScriptLimits

protected

Whether to ignore SWF ScriptLimits tags.

Referenced by parseFile(), and updateFile().

§ _log

std::string gnash::RcInitFile::_log

protected

The name of the debug log.

Referenced by dump(), parseFile(), and updateFile().

§ _mediaCacheDir

std::string gnash::RcInitFile::_mediaCacheDir

protected

Referenced by parseFile(), and updateFile().

§ _mediahandler

std::string gnash::RcInitFile::_mediahandler

protected

Which media player backend to use, no value means use the default. The default is set in the MediaFactory initialization table.

Referenced by parseFile().

§ _microphoneDevice

int gnash::RcInitFile::_microphoneDevice

protected

Referenced by parseFile().

§ _movieLibraryLimit

std::uint32_t gnash::RcInitFile::_movieLibraryLimit

protected

Max number of movie clips to store in the library.

Referenced by parseFile(), and updateFile().

§ _parserDump

bool gnash::RcInitFile::_parserDump

protected

Enable dumping parser data.

Referenced by dump(), parseFile(), updateFile(), and useParserDump().

§ _pluginSound

bool gnash::RcInitFile::_pluginSound

protected

Enable sound for the plugin.

Referenced by dump(), parseFile(), and updateFile().

§ _popups

bool gnash::RcInitFile::_popups

protected

Referenced by parseFile(), and updateFile().

§ _quality

int gnash::RcInitFile::_quality

protected

The quality to display SWFs in. -1 to allow the SWF to override.

Referenced by parseFile(), and updateFile().

§ _renderer

std::string gnash::RcInitFile::_renderer

protected

Which renderer backend to use, no value means use the default. The currently supported values are agg, opengl, or cairo. AGG being the default.

Referenced by parseFile().

§ _retries

int gnash::RcInitFile::_retries

protected

the number of retries for a thread

§ _rootcert

gnash::RcInitFile::_rootcert

protected

This is the name of the root certificate

Referenced by parseFile().

§ _saveLoadedMedia

bool gnash::RcInitFile::_saveLoadedMedia

protected

Referenced by parseFile(), and updateFile().

§ _saveStreamingMedia

bool gnash::RcInitFile::_saveStreamingMedia

protected

Referenced by parseFile(), and updateFile().

§ _scriptsRecursionLimit

int gnash::RcInitFile::_scriptsRecursionLimit

protected

The max actionscript function call stack depth.

Referenced by parseFile(), and updateFile().

§ _scriptsTimeout

int gnash::RcInitFile::_scriptsTimeout

protected

The number of seconds after which action execution is considered to be slow enough to prompt the user for aborting

Referenced by parseFile(), and updateFile().

§ _showMouse

bool gnash::RcInitFile::_showMouse

protected

Show the mouse pointer.

Referenced by parseFile(), and updateFile().

§ _sollocaldomain

bool gnash::RcInitFile::_sollocaldomain

protected

Referenced by parseFile(), and updateFile().

§ _solreadonly

bool gnash::RcInitFile::_solreadonly

protected

Whether SOL files can be written.

Referenced by parseFile(), and updateFile().

§ _solsandbox

std::string gnash::RcInitFile::_solsandbox

protected

SOL Sandbox: This is the only dir .sol (Shared Object) files can be written in, or read from.

Referenced by parseFile(), RcInitFile(), and updateFile().

§ _sound

bool gnash::RcInitFile::_sound

protected

Enable the sound handler at startup.

Referenced by dump(), parseFile(), and updateFile().

§ _splashScreen

bool gnash::RcInitFile::_splashScreen

protected

Display a splash screen when loading a movie.

Referenced by dump(), parseFile(), updateFile(), and useSplashScreen().

§ _startStopped

bool gnash::RcInitFile::_startStopped

protected

Start the gui in "stop" mode.

Referenced by parseFile(), and updateFile().

§ _streamsTimeout

double gnash::RcInitFile::_streamsTimeout

protected

The number of seconds of inactivity triggering download timeout.

Referenced by parseFile(), and updateFile().

§ _urlOpenerFormat

std::string gnash::RcInitFile::_urlOpenerFormat

protected

Command format to use to open urls.

The u label will need to be substituted by the url (properly escaped)

Referenced by parseFile(), RcInitFile(), and updateFile().

§ _verboseASCodingErrors

bool gnash::RcInitFile::_verboseASCodingErrors

protected

Enable ActionScript errors verbosity.

Referenced by dump(), parseFile(), showASCodingErrors(), and updateFile().

§ _verboseMalformedAMF

bool gnash::RcInitFile::_verboseMalformedAMF

protected

Enable Malformed AMF verbosity.

Referenced by parseFile(), and updateFile().

§ _verboseMalformedSWF

bool gnash::RcInitFile::_verboseMalformedSWF

protected

Enable Malformed SWF verbosity.

Referenced by parseFile(), showMalformedSWFErrors(), and updateFile().

§ _verbosity

std::uint32_t gnash::RcInitFile::_verbosity

protected

Level of debugging output.

Referenced by dump(), parseFile(), and updateFile().

§ _webcamDevice

int gnash::RcInitFile::_webcamDevice

protected

FIXME: this should probably eventually be changed to a more readable config option instead of an integer

Referenced by parseFile().

§ _whitelist

PathList gnash::RcInitFile::_whitelist

protected

Allowed domains.

Referenced by dump(), parseFile(), and updateFile().

§ _writeLog

bool gnash::RcInitFile::_writeLog

protected

Enable writing the debug log to disk.

Referenced by dump(), parseFile(), updateFile(), and useWriteLog().

§ _wwwroot

std::string gnash::RcInitFile::_wwwroot

protected

The root path for the streaming server.

Referenced by parseFile(), and updateFile().

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

rc.h
rc.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Member Typedef Documentation

§ PathList

§ Sep

§ Tok

Constructor & Destructor Documentation

§ RcInitFile()

§ ~RcInitFile()

Member Function Documentation

§ addLocalSandboxPath()

§ dump()

§ enableExtensions()

§ expandPath()

§ extractDouble()

§ extractNumber()

§ extractSetting()

§ getAudioInputDevice()

§ getBlackList()

§ getCertDir()

§ getCertFile()

§ getDebugLog()

§ getDefaultInstance()

§ getDocumentRoot()

§ getFlashSystemManufacturer()

§ getFlashSystemOS()

§ getFlashVersionString()

§ getGstAudioSink()

§ getHWAccel()

§ getLCShmKey()

§ getLCTrace()

§ getLocalConnection()

§ getLocalSandboxPath()

§ getMediaDir()

§ getMediaHandler()

§ getMovieLibraryLimit()

§ getRenderer()

§ getRetries()

§ getRootCert()

§ getScriptsRecursionLimit()

§ getScriptsTimeout()

§ getSOLLocalDomain()

§ getSOLReadOnly()

§ getSOLSafeDir()

§ getStreamsTimeout()

§ getTimerDelay()

§ getURLOpenerFormat()

§ getWebcamDevice()

§ getWhiteList()

§ ignoreFSCommand() [1/2]

§ ignoreFSCommand() [2/2]

§ ignoreShowMenu() [1/2]

§ ignoreShowMenu() [2/2]

§ insecureSSL() [1/2]

§ insecureSSL() [2/2]

§ interfacePopups()

§ loadFiles()

§ lockScriptLimits() [1/2]

§ lockScriptLimits() [2/2]

§ parseFile()

§ parseList()

§ popupMessages()

§ qualityLevel() [1/2]

§ qualityLevel() [2/2]

§ saveLoadedMedia() [1/2]

§ saveLoadedMedia() [2/2]

§ saveStreamingMedia() [1/2]

§ saveStreamingMedia() [2/2]

§ setAudioInputDevice()

§ setBlacklist()

§ setCertDir()

§ setCertFile()

§ setDebugLog()

§ setDocumentRoot()

§ setFlashSystemManufacturer()