geometrize::script Namespace Reference

Namespaces
	bindings

Classes
class	Command
	The Command class provides a convenient way for a script to tell an object about something For example, this can be used to give scripts a way to control the Geometrize user interface. More...
class	CommandHandler
	The CommandHandler class provides an interface that all objects that can handle/process script commands implement. This is used do things like provide a way for scripts to send commands to the Geometrize user interface. More...
class	GeometrizerEngine
	The GeometrizerEngine class encapsulates script-based setup and mutation methods for geometrizing shapes. More...

Functions
std::unique_ptr< chaiscript::ChaiScript >	createDefaultEngine ()
	createDefaultEngine Creates a default Chaiscript engine object, with the default bindings (Geometrize-specific utility functions etc). More...
std::unique_ptr< chaiscript::ChaiScript >	createLaunchWindowEngine ()
	createLaunchWindowEngine Creates a Chaiscript engine object for the launch window script console. More...
std::unique_ptr< chaiscript::ChaiScript >	createImageTaskEngine ()
	createImageTaskEngine Creates a Chaiscript engine for an image task window script console. More...
std::unique_ptr< chaiscript::ChaiScript >	createBatchImageTaskEngine ()
	createBatchImageTaskEngine Creates a Chaiscript engine for creating and processing multiple image tasks. More...
std::unique_ptr< chaiscript::ChaiScript >	createShapeMutatorEngine ()
	createShapeMutatorEngine Creates a Chaiscript engine object for mutating shapes. More...
std::unique_ptr< chaiscript::ChaiScript >	createFunctionalTestRunnerEngine ()
	createFunctionalTestRunnerEngine Creates a Chaiscript engine object for running functional tests. More...
void	runScript (const std::string &code, chaiscript::ChaiScript &runner)
	runScript Evaluates the provided script code. More...
void	runScript (const std::string &code)
	runScript Evaluates the provided script code, creating a fresh engine to evaluate the script. More...
void	sleep (std::size_t ms)
	sleep Causes the calling thread to sleep for the given length of time. More...
std::vector< std::string >	getEngineFunctionNames (const chaiscript::ChaiScript &engine)
	getEngineFunctionNames Gets the names of the functions registered with the given engine. More...
std::map< std::string, std::string >	getScripts (const std::string &folder)
	getDefaultScripts Gets a map of the scripts in the given folder. More...
std::map< std::string, std::string >	getDefaultShapeMutatorScripts ()
	getDefaultScripts Gets a map of the default scripts used for shape creation and mutation in image tasks. More...
std::map< std::string, std::string >	getPointerAreaOfInterestShapeMutatorScripts ()
	getPointerAreaOfInterestScripts Gets a map of the scripts used for shape creation and mutation based around user input/pointer interaction. More...
std::map< std::string, std::string >	getBeforeStepCallbackScripts ()
	getBeforeStepCallbackScripts Gets a map of scripts that are useful to call prior to stepping an image task (i.e. before starting work to find a shape to add). More...
std::map< std::string, std::string >	getAfterStepCallbackScripts ()
	getAfterStepCallbackScripts Gets a map of scripts that are useful to call after stepping an image task (i.e. after completing work to find a shape to add). More...
std::map< std::string, std::string >	getStopConditionScripts ()
	getStopConditionScripts Gets a map of scripts that get to true/false, and can be used to check whether to stop an image task (usually after stepping). More...
std::map< std::string, std::string >	getOnStopConditionMetScripts ()
	getOnStopConditionMetScripts Gets a map of scripts that are useful to call after the stop condition for an image task is met. More...
std::map< std::string, std::string >	getAddShapePreconditionScripts ()
	getAddShapePreconditionScripts Gets a map of scripts that are used to decide whether to add a shape to an image or not More...
std::map< std::string, std::string >	getBeforeAddShapeCallbackScripts ()
	getBeforeAddShapeCallbackScripts Gets a map of scripts that are useful to call before adding a shape to the image task views. More...
std::map< std::string, std::string >	getAfterAddShapeCallbackScripts ()
	getAfterAddShapeCallbackScripts Gets a map of scripts that are useful to call after adding a shape to the image task views. More...
std::map< std::string, std::string >	getOnPenInputCallbackScripts ()
	getOnPenInputCallbackScripts Gets a map of scripts that are useful to call after receiving pen input to the image task views. More...
std::map< std::string, std::string >	getOnPenProximityEnterCallbackScripts ()
	getOnPenProximityEnterCallbackScripts Gets a map of scripts that are useful to call after receiving a pen proximity enter event. This is application global, not bound to a particular view. More...
std::map< std::string, std::string >	getOnPenProximityExitCallbackScripts ()
	getOnPenProximityExitCallbackScripts Gets a map of scripts that are useful to call after receiving a pen proximity exit event. This is application global, not bound to a particular view. More...
std::map< std::string, std::string >	getOnKeyDownEventScripts ()
	getOnKeyDownEventScripts Gets a map of scripts that are useful to call after receiving a key down event to the image task views. More...
std::map< std::string, std::string >	getOnKeyUpEventScripts ()
	getOnKeyUpEventScripts Gets a map of scripts that are useful to call after receiving a key up event to the image task views. More...
std::map< std::string, std::string >	getOnMouseDownEventScripts ()
	getOnMouseDownEventScripts Gets a map of scripts that are useful to call after receiving a mouse down event to the image task views. More...
std::map< std::string, std::string >	getOnMouseUpEventScripts ()
	getOnMouseUpEventScripts Gets a map of scripts that are useful to call after receiving a mouse up event to the image task views. More...
std::map< std::string, std::string >	getOnMouseMoveEventScripts ()
	getOnMouseMoveEventScripts Gets a map of scripts that are useful to call after receiving a mouse move event to the image task views. More...
std::map< std::string, std::string >	getOnMouseWheelEventScripts ()
	getOnMouseWheelEventScripts Gets a map of scripts that are useful to call after receiving a mouse wheel event to the image task views. More...
std::map< std::string, std::string >	getOnTimedUpdateEventScripts ()
	getOnTimedUpdateEventScripts Gets a map of scripts that are useful to regularly periodically call i.e. on update More...
std::map< std::string, std::string >	getTaskQueueBatchProcessingScripts ()
	getTaskQueueBatchProcessingScripts Gets a map of scripts used for batch processing multiple images on the task queue More...

Function Documentation

createBatchImageTaskEngine()

std::unique_ptr< chaiscript::ChaiScript > geometrize::script::createBatchImageTaskEngine

(

)

createBatchImageTaskEngine Creates a Chaiscript engine for creating and processing multiple image tasks.

Returns

The Chaiscript engine object.

{
    std::unique_ptr<chaiscript::ChaiScript> chai = std::make_unique<chaiscript::ChaiScript>();
 
    chai->add(bindings::createDefaultBindings());
    chai->add(bindings::createGeometrizeLibraryBindings());
 
    chai->add(bindings::createImageBindings());
    chai->add(bindings::createImageTaskBindings());
    chai->add(bindings::createSynchronousImageTaskBindings());
    chai->add(bindings::createImageTaskWindowBindings());
    chai->add(bindings::createImageExportBindings());
 
    addPrintRedirect(chai);
 
    return chai;
}

Here is the call graph for this function:

Here is the caller graph for this function:

createDefaultEngine()

std::unique_ptr< chaiscript::ChaiScript > geometrize::script::createDefaultEngine

(

)

createDefaultEngine Creates a default Chaiscript engine object, with the default bindings (Geometrize-specific utility functions etc).

Returns

The Chaiscript engine object.

{
    std::unique_ptr<chaiscript::ChaiScript> chai = std::make_unique<chaiscript::ChaiScript>();
 
    chai->add(bindings::createDefaultBindings());
 
    addPrintRedirect(chai);
 
    return chai;
}

Here is the call graph for this function:

Here is the caller graph for this function:

createFunctionalTestRunnerEngine()

std::unique_ptr< chaiscript::ChaiScript > geometrize::script::createFunctionalTestRunnerEngine

(

)

createFunctionalTestRunnerEngine Creates a Chaiscript engine object for running functional tests.

Returns

The Chaiscript engine object.

{
    std::unique_ptr<chaiscript::ChaiScript> chai = std::make_unique<chaiscript::ChaiScript>();
 
    chai->add(bindings::createDefaultBindings());
    chai->add(bindings::createQWidgetBindings());
    chai->add(bindings::createLaunchWindowBindings());
    chai->add(bindings::createImageTaskBindings());
    chai->add(bindings::createSynchronousImageTaskBindings());
    chai->add(bindings::createUserInterfacePuppeteerBindings());
    chai->add(bindings::createFunctionalTestHelperBindings());
 
    return chai;
}

Here is the call graph for this function:

createImageTaskEngine()

std::unique_ptr< chaiscript::ChaiScript > geometrize::script::createImageTaskEngine

(

)

createImageTaskEngine Creates a Chaiscript engine for an image task window script console.

Returns

The Chaiscript engine object.

{
    std::unique_ptr<chaiscript::ChaiScript> chai = std::make_unique<chaiscript::ChaiScript>();
 
    chai->add(bindings::createDefaultBindings());
    chai->add(bindings::createGeometrizeLibraryBindings());
 
    chai->add(bindings::createImageBindings());
    chai->add(bindings::createImageTaskBindings());
    chai->add(bindings::createSynchronousImageTaskBindings());
    chai->add(bindings::createImageExportBindings());
    chai->add(bindings::createAnimatedGifExportBindings());
 
    addPrintRedirect(chai);
 
    return chai;
}

Here is the call graph for this function:

createLaunchWindowEngine()

std::unique_ptr< chaiscript::ChaiScript > geometrize::script::createLaunchWindowEngine

(

)

createLaunchWindowEngine Creates a Chaiscript engine object for the launch window script console.

Returns

The Chaiscript engine object.

{
    std::unique_ptr<chaiscript::ChaiScript> chai = std::make_unique<chaiscript::ChaiScript>();
 
    chai->add(bindings::createDefaultBindings());
    chai->add(bindings::createQWidgetBindings());
    chai->add(bindings::createLaunchWindowBindings());
    chai->add(bindings::createImageTaskWindowBindings());
    chai->add(bindings::createSynchronousImageTaskBindings());
 
    addPrintRedirect(chai);
 
    return chai;
}

Here is the call graph for this function:

createShapeMutatorEngine()

std::unique_ptr< chaiscript::ChaiScript > geometrize::script::createShapeMutatorEngine

(

)

createShapeMutatorEngine Creates a Chaiscript engine object for mutating shapes.

Returns

The Chaiscript engine object.

{
    std::unique_ptr<chaiscript::ChaiScript> chai = std::make_unique<chaiscript::ChaiScript>();
 
    chai->add(bindings::createDefaultBindings());
    chai->add(bindings::createGeometrizeLibraryBindings());
    chai->add(bindings::createMathBindings());
    chai->add(bindings::createTabletEventBindings());
    chai->add(bindings::createImageExportBindings());
    chai->add(bindings::createImageTaskBindings());
 
    return chai;
}

Here is the call graph for this function:

Here is the caller graph for this function:

getAddShapePreconditionScripts()

std::map< std::string, std::string > geometrize::script::getAddShapePreconditionScripts

(

)

getAddShapePreconditionScripts Gets a map of scripts that are used to decide whether to add a shape to an image or not

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/add_shape_precondition_callbacks/");
}

Here is the caller graph for this function:

getAfterAddShapeCallbackScripts()

std::map< std::string, std::string > geometrize::script::getAfterAddShapeCallbackScripts

(

)

getAfterAddShapeCallbackScripts Gets a map of scripts that are useful to call after adding a shape to the image task views.

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/after_add_shape_callbacks/");
}

Here is the caller graph for this function:

getAfterStepCallbackScripts()

std::map< std::string, std::string > geometrize::script::getAfterStepCallbackScripts

(

)

getAfterStepCallbackScripts Gets a map of scripts that are useful to call after stepping an image task (i.e. after completing work to find a shape to add).

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/after_step_callbacks/");
}

Here is the caller graph for this function:

getBeforeAddShapeCallbackScripts()

std::map< std::string, std::string > geometrize::script::getBeforeAddShapeCallbackScripts

(

)

getBeforeAddShapeCallbackScripts Gets a map of scripts that are useful to call before adding a shape to the image task views.

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/before_add_shape_callbacks/");
}

Here is the caller graph for this function:

getBeforeStepCallbackScripts()

std::map< std::string, std::string > geometrize::script::getBeforeStepCallbackScripts

(

)

getBeforeStepCallbackScripts Gets a map of scripts that are useful to call prior to stepping an image task (i.e. before starting work to find a shape to add).

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/before_step_callbacks/");
}

Here is the caller graph for this function:

getDefaultShapeMutatorScripts()

std::map< std::string, std::string > geometrize::script::getDefaultShapeMutatorScripts

(

)

getDefaultScripts Gets a map of the default scripts used for shape creation and mutation in image tasks.

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/default_shape_mutators/");
}

Here is the caller graph for this function:

getEngineFunctionNames()

std::vector< std::string > geometrize::script::getEngineFunctionNames

(

const chaiscript::ChaiScript &

engine

)

getEngineFunctionNames Gets the names of the functions registered with the given engine.

Parameters

engine

The engine whose function names will be fetched.

Returns

The names registered with the given engine.

{
    std::vector<std::string> functions;
    const auto funcs{engine.get_state().engine_state.m_functions};
    for(auto it = funcs.begin(); it != funcs.end(); ++it) {
        functions.push_back(it->first);
    }
    return functions;
}

Here is the caller graph for this function:

getOnKeyDownEventScripts()

std::map< std::string, std::string > geometrize::script::getOnKeyDownEventScripts

(

)

getOnKeyDownEventScripts Gets a map of scripts that are useful to call after receiving a key down event to the image task views.

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/on_key_down_callbacks/");
}

Here is the caller graph for this function:

getOnKeyUpEventScripts()

std::map< std::string, std::string > geometrize::script::getOnKeyUpEventScripts

(

)

getOnKeyUpEventScripts Gets a map of scripts that are useful to call after receiving a key up event to the image task views.

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/on_key_up_callbacks/");
}

Here is the caller graph for this function:

getOnMouseDownEventScripts()

std::map< std::string, std::string > geometrize::script::getOnMouseDownEventScripts

(

)

getOnMouseDownEventScripts Gets a map of scripts that are useful to call after receiving a mouse down event to the image task views.

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/on_mouse_down_callbacks/");
}

Here is the caller graph for this function:

getOnMouseMoveEventScripts()

std::map< std::string, std::string > geometrize::script::getOnMouseMoveEventScripts

(

)

getOnMouseMoveEventScripts Gets a map of scripts that are useful to call after receiving a mouse move event to the image task views.

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/on_mouse_move_callbacks/");
}

Here is the caller graph for this function:

getOnMouseUpEventScripts()

std::map< std::string, std::string > geometrize::script::getOnMouseUpEventScripts

(

)

getOnMouseUpEventScripts Gets a map of scripts that are useful to call after receiving a mouse up event to the image task views.

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/on_mouse_up_callbacks/");
}

Here is the caller graph for this function:

getOnMouseWheelEventScripts()

std::map< std::string, std::string > geometrize::script::getOnMouseWheelEventScripts

(

)

getOnMouseWheelEventScripts Gets a map of scripts that are useful to call after receiving a mouse wheel event to the image task views.

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/on_mouse_wheel_callbacks/");
}

Here is the caller graph for this function:

getOnPenInputCallbackScripts()

std::map< std::string, std::string > geometrize::script::getOnPenInputCallbackScripts

(

)

getOnPenInputCallbackScripts Gets a map of scripts that are useful to call after receiving pen input to the image task views.

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/on_pen_input_callbacks/");
}

Here is the caller graph for this function:

getOnPenProximityEnterCallbackScripts()

std::map< std::string, std::string > geometrize::script::getOnPenProximityEnterCallbackScripts

(

)

getOnPenProximityEnterCallbackScripts Gets a map of scripts that are useful to call after receiving a pen proximity enter event. This is application global, not bound to a particular view.

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/on_pen_proximity_enter_callbacks/");
}

Here is the caller graph for this function:

getOnPenProximityExitCallbackScripts()

std::map< std::string, std::string > geometrize::script::getOnPenProximityExitCallbackScripts

(

)

getOnPenProximityExitCallbackScripts Gets a map of scripts that are useful to call after receiving a pen proximity exit event. This is application global, not bound to a particular view.

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/on_pen_proximity_exit_callbacks/");
}

Here is the caller graph for this function:

getOnStopConditionMetScripts()

std::map< std::string, std::string > geometrize::script::getOnStopConditionMetScripts

(

)

getOnStopConditionMetScripts Gets a map of scripts that are useful to call after the stop condition for an image task is met.

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/on_stop_condition_met_callbacks/");
}

Here is the caller graph for this function:

getOnTimedUpdateEventScripts()

std::map< std::string, std::string > geometrize::script::getOnTimedUpdateEventScripts

(

)

getOnTimedUpdateEventScripts Gets a map of scripts that are useful to regularly periodically call i.e. on update

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/on_update_callbacks/");
}

Here is the caller graph for this function:

getPointerAreaOfInterestShapeMutatorScripts()

std::map< std::string, std::string > geometrize::script::getPointerAreaOfInterestShapeMutatorScripts

(

)

getPointerAreaOfInterestScripts Gets a map of the scripts used for shape creation and mutation based around user input/pointer interaction.

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/pointer_area_of_interest_mutators/");
}

Here is the caller graph for this function:

getScripts()

std::map< std::string, std::string > geometrize::script::getScripts

(

const std::string &

folder

)

getDefaultScripts Gets a map of the scripts in the given folder.

Parameters

folder

Path to the folder containing the ChaiScript scripts to retrieve. The files must have the ".chai" file extension.

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(QString::fromStdString(folder));
}

Here is the caller graph for this function:

getStopConditionScripts()

std::map< std::string, std::string > geometrize::script::getStopConditionScripts

(

)

getStopConditionScripts Gets a map of scripts that get to true/false, and can be used to check whether to stop an image task (usually after stepping).

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/scripts/stop_condition_callbacks/");
}

Here is the caller graph for this function:

getTaskQueueBatchProcessingScripts()

std::map< std::string, std::string > geometrize::script::getTaskQueueBatchProcessingScripts

(

)

getTaskQueueBatchProcessingScripts Gets a map of scripts used for batch processing multiple images on the task queue

Returns

A map of Chaiscript script function names to function bodies.

{
    return getScriptsFromFolder(":/scripts/task_queue_scripts/");
}

Here is the caller graph for this function:

runScript() [1/2]

void geometrize::script::runScript

(

const std::string &

code

)

runScript Evaluates the provided script code, creating a fresh engine to evaluate the script.

Parameters

code	The script code to evaluate.

{
    auto engine{createDefaultEngine()};
    runScript(script, *engine);
}

Here is the call graph for this function:

runScript() [2/2]

void geometrize::script::runScript	(	const std::string &	code,
		chaiscript::ChaiScript &	runner
	)

runScript Evaluates the provided script code.

Parameters

code	The script code to evaluate.
runner	The engine that will evaluate the script.

{
    const QString errorTitle{QCoreApplication::translate("Script evaluation error dialog title", "Script evaluation failure", "Title of an error message dialog shown when the app fails to run a script")};
    const QString errorPreamble{QCoreApplication::translate("Script evaluation error message", "Could not evaluate script: %1", "Error message text shown when the app fails to run a script")};
    const QString unknownError{QCoreApplication::translate("Script evaluation unknown error", "Unknown script evaluation error", "Error message shown when the app fails to run a script, and has no additional information about the error")};
 
    try {
        runner.eval(code);
    } catch (const std::string& s) {
        QMessageBox::warning(nullptr, errorTitle, errorPreamble.arg(QString::fromStdString(s)));
    } catch (const std::exception& e) {
        QMessageBox::warning(nullptr, errorTitle, errorPreamble.arg(QString::fromStdString(e.what())));
    } catch (...) {
        QMessageBox::warning(nullptr, errorTitle, errorPreamble.arg(unknownError));
    }
}

Here is the caller graph for this function:

sleep()

void geometrize::script::sleep

(

std::size_t

ms

)

sleep Causes the calling thread to sleep for the given length of time.

Parameters

ms	The number of milliseconds to sleep for.

{
    std::this_thread::sleep_for(std::chrono::milliseconds(ms));
}

Here is the caller graph for this function: