Scilab Website | Contribute with GitLab | Mailing list archives | ATOMS toolboxes
Scilab Online Help
6.0.0 - English

Change language to:
Français - 日本語 - Português - Русский

Please note that the recommended version of Scilab is 2025.0.0. This page might be outdated.
See the recommended documentation of this function

Scilab Help >> Modules manager > tbx_builder_macros

tbx_builder_macros

Create library(es) of a toolbox for its functions in Scilab language

Syntax

tbx_builder_macros(toolbox_path)

Arguments

toolbox_path

Root directory of the toolbox. build script will be searched in the toolbox_path/macros subdirectory.

Description

This function is usually called from builder.sce scripts when creating or updating a toolbox.

The short name (id) tbx_name of the toolbox is retrieved as the basename of the file toolbox_path/etc/*.start. This file must exists, even if it is empty.

tbx_builder_macros scans the toolbox_path directory for a macros subdirectory.

  • If macros is found, tbx_builder_macros looks for a script *.sce whose name starts with build:
    • If a toolbox/macros/build*.sce file is found, tbx_builder_macros executes it, and that's it.
    • Otherwise, tbx_builder_macros compiles each thisfile.sci file found in the toolbox_path/macros/ subdirectory, and yields every related thisfile.bin binary files. All these *.bin are then bundled into a library of macros recorded in the file toolbox_path/macros/lib.
  • Otherwise, tbx_builder_macros exists silently.

When a library is actually built, its default name is set to tbx_namelib, in the toolbox_path/macros/lib file.

Examples

// Recommended usage, from a builder.sce script
tbx_builder_macros(get_absolute_file_path('builder.sce'))

History

VersionDescription
6.0.0

A default behaviour generating a lib from all macros inside the macros directory is now implemented. An explicit builder script is no longer mandatory.

No longer restricts the build scripts to buildmacros.sce. Now any scripts called buildmacros*.sce or builder*.sce are valid for macros generation.

Report an issue
<< tbx_builder_help Modules manager tbx_builder_src >>

Copyright (c) 2022-2024 (Dassault Systèmes)
Copyright (c) 2017-2022 (ESI Group)
Copyright (c) 2011-2017 (Scilab Enterprises)
Copyright (c) 1989-2012 (INRIA)
Copyright (c) 1989-2007 (ENPC)
with contributors
Last updated:
Tue Feb 14 15:03:08 CET 2017