Guile scripting interface. module

Contents

Functions

auto guile_init(int argc, char** argv) -> int
Inits the guile subsystem.
void guile_define_modules(void)
Defines all available modules to be used by scripts.
auto guile_run_script(const char* script) -> char*
Runs the script and returns the output message in Pango markup.
auto guile_script_succeeded(const char* pango_markup) -> bool
Returns whether the script succeeded based on the markup.
auto guile_project_generator_generate_project_from_string(const char* script, const char* prj_path) -> int
Generates a Zrythm project from the script contained in script.
auto guile_project_generator_generate_project_from_file(const char* filepath, const char* prj_path) -> int
Generates a Zrythm project from the filepath containing a generator script.

Variables

SCM position_type
Guile function prefix.

Function documentation

int guile_init(int argc, char** argv)

Inits the guile subsystem.

void guile_define_modules(void)

Defines all available modules to be used by scripts.

This must be called in guile mode.

char* guile_run_script(const char* script)

Runs the script and returns the output message in Pango markup.

bool guile_script_succeeded(const char* pango_markup)

Returns whether the script succeeded based on the markup.

int guile_project_generator_generate_project_from_string(const char* script, const char* prj_path)

Generates a Zrythm project from the script contained in script.

Parameters
script Script content.
prj_path Path to save the project at.
Returns Non-zero if fail.

int guile_project_generator_generate_project_from_file(const char* filepath, const char* prj_path)

Generates a Zrythm project from the filepath containing a generator script.

Parameters
filepath Path of the script file.
prj_path Path to save the project at.
Returns Non-zero if fail.

Variable documentation

SCM position_type

Guile function prefix.

Macro.