cohtml::ScriptCompiler

#include <Library.h>

Public Types

	Name
enum	ScriptType { ST_Classic, ST_Module} The enumeration tells the ScriptCompiler how to compile the provided source.

Public Functions

	Name
virtual DataBuffer *	Compile(DataBuffer * utf8Source, ScriptType scriptType) =0 Compiles a script file synchronously.
virtual void	Destroy() =0 Destroys the ScriptCompiler and frees memory.
virtual DataBuffer *	CompileScript(DataBuffer * utf8Source) =0 Compiles a classic script file synchronously.
virtual DataBuffer *	CompileModule(DataBuffer * utf8Source, const char * URL) =0 Compiles a module script file synchronously.

Protected Functions

	Name
virtual	~ScriptCompiler()

Public Types Documentation

enum ScriptType

Enumerator	Value	Description
ST_Classic		Try to compile the provided source as a classic script.
ST_Module		Try to compile the provided source as a module.

The enumeration tells the ScriptCompiler how to compile the provided source.

Public Functions Documentation

function Compile

virtual DataBuffer * Compile(
    DataBuffer * utf8Source,
    ScriptType scriptType
) =0

Compiles a script file synchronously.

Parameters:

• utf8Source a data buffer, containing an utf8 encoded script source
• scriptType specify if the provided source is classic script or module

Deprecated:

Legacy compatibility API. Use CompileScript or CompileModule instead.

Return: A data buffer, containing the compiled data.

Note

• Can be used on any thread, should not be used on multiple threads simultaneously.
• Scripts can be precompiled on Windows then later used on other platforms where Cohtml works with V8’s pointer compression feature enabled. Currently, those are only Microsoft Xbox consoles.

function Destroy

virtual void Destroy() =0

Destroys the ScriptCompiler and frees memory.

function CompileScript

virtual DataBuffer * CompileScript(
    DataBuffer * utf8Source
) =0

Compiles a classic script file synchronously.

Parameters:

• utf8Source a data buffer, containing an utf8 encoded classic script source

Return: A data buffer, containing the compiled data.

Note

• Can be used on any thread, should not be used on multiple threads simultaneously.
• Scripts can be precompiled on Windows then later used on other platforms where Cohtml works with V8’s pointer compression feature enabled. Currently, those are only Microsoft Xbox consoles.

function CompileModule

virtual DataBuffer * CompileModule(
    DataBuffer * utf8Source,
    const char * URL
) =0

Compiles a module script file synchronously.

Parameters:

• utf8Source a data buffer, containing an utf8 encoded module script source
• URL the URL/origin of the module script

Return: A data buffer, containing the compiled data.

Note

• Can be used on any thread, should not be used on multiple threads simultaneously.
• Scripts can be precompiled on Windows then later used on other platforms where Cohtml works with V8’s pointer compression feature enabled. Currently, those are only Microsoft Xbox consoles.

Protected Functions Documentation

function ~ScriptCompiler

virtual ~ScriptCompiler()

---