Falcon::Engine Namespace Reference

Classes
class	AutoInit
Functions
FALCON_DYN_SYM bool	addVFS (const String &name, VFSProvider *prv)
FALCON_DYN_SYM void	getEncodings (String &sSrcEnc, String &sIOEnc)
	Utility function recording the preferential encodings for sources and VM I/O.
FALCON_DYN_SYM const String &	getMessage (uint32 id)
FALCON_DYN_SYM String	getSearchPath ()
	Returns the application-wide default search path by copy.
FALCON_DYN_SYM VFSProvider *	getVFS (const String &name)
FALCON_DYN_SYM void	Init ()
FALCON_DYN_SYM void	setEncodings (const String &sSrcEnc, const String &sIOEnc)
	Utility function recording the preferential encodings for sources and VM I/O.
FALCON_DYN_SYM bool	setLanguage (const String &language)
FALCON_DYN_SYM void	setSearchPath (const String &path)
	Set application wide search path.
FALCON_DYN_SYM bool	setTable (StringTable *tab)
FALCON_DYN_SYM void	Shutdown ()

---

Function Documentation

FALCON_DYN_SYM bool Falcon::Engine::addVFS	(	const String &	name,
		VFSProvider *	prv
	)

FALCON_DYN_SYM void Falcon::Engine::getEncodings	(	String &	sSrcEnc,
		String &	sIOEnc
	)

Utility function recording the preferential encodings for sources and VM I/O.

See also:

recordEncodings

Parameters:

	sSrcEnc	The encoding preferentially used by source files.
	sIOEnc	The encoding preferentially used in I/O streams different from sources.

FALCON_DYN_SYM const String& Falcon::Engine::getMessage

(

uint32

id

)

FALCON_DYN_SYM String Falcon::Engine::getSearchPath

(

)

Returns the application-wide default search path by copy.

Referenced by Falcon::ModuleLoader::getSearchPath().

FALCON_DYN_SYM VFSProvider* Falcon::Engine::getVFS

(

const String &

name

)

FALCON_DYN_SYM void Falcon::Engine::Init

(

)

Referenced by Falcon::Engine::AutoInit::AutoInit().

FALCON_DYN_SYM void Falcon::Engine::setEncodings	(	const String &	sSrcEnc,
		const String &	sIOEnc
	)

Utility function recording the preferential encodings for sources and VM I/O.

When the engine has to create its own VMs and streams, i.e. to fulfil interactive compiler requests, it uses this encodings that can be defined and changed by the application at any time.

The values can be used also by the calling application as a convenient inter-moule communication area for this critical aspect of preferential encoding.

Parameters:

	sSrcEnc	The encoding preferentially used by source files.
	sIOEnc	The encoding preferentially used in I/O streams different from sources.

FALCON_DYN_SYM bool Falcon::Engine::setLanguage

(

const String &

language

)

FALCON_DYN_SYM void Falcon::Engine::setSearchPath

(

const String &

path

)

Set application wide search path.

This is used by default in new VMs, module loaders and metacompilers.

FALCON_DYN_SYM bool Falcon::Engine::setTable

(

StringTable *

tab

)

FALCON_DYN_SYM void Falcon::Engine::Shutdown

(

)

Referenced by Falcon::Engine::AutoInit::~AutoInit().