core/settings

setting variable support

Dependency Graph

core/settings: Library Dependencies

View color source code (raw) for this file

View reStructuredText (rst) source code for this page

Settings Configuration

$settings_dump

If true, settings are printed using debug.

Default: $config_debug

$settings_types[]

Lists the known types of settings: vars arrays assocs funcs.

Setting Lists

settings_varname()

Prints the name of a settings list, given the namespace ($1) and the setting type ($2).

add them to the script settings array

settings_add()

Adds the named settings ($@) to the given data type ($1). Declares the settings ($@) with the given declare options ($2) in the given script namespace ($3).

declare all of the nammed settings as globals

Setting Attributes

settings_list_all()

Prints list of all known settings in the given namespace ($1).

settings_list_vars()

Prints list of known atomic settings in the given namespace ($1).

settings_list_funcs()

Prints list of known functions in the given namespace ($1).

settings_list_assocs()

Prints list of known associate arrays in the given namespace ($1).

settings_list_arrays()

Prints list of known indexed arrays in the given namespace ($1).

settings_list_readonly()()

Prints list of read-only settings in the given namespace ($1).

settings_list_null()()

Prints list of settings that may be null in the given namespace ($1).

settings_list_has_attr()

Checks if a given library ($2) setting ($1) exists in the given attribute list ($3).

$1 - Setting name

$2 - Library name

$3 - Attribute list to check

is_setting_readonly()

Checks if a setting ($1) in the given namespace ($2) is read-only.

is_setting_nullable()

Checks if a setting ($1) in the given namespace ($2) may be configured with a null value.

Setting Attribute Display

settings_dump()

Dumps configuration settings for debugging

settings_dump_lib()

Dumps configuration settings for a library script ($1).

settings_dump_tool()

Dumps configuration settings for a tool script ($1).

Setting Attribute Verification

settings_check()

Verifies that all configuration settings are valid.

settings_check_lib()

Verifies that configuration settings are valid for a library script ($1).

settings_check_tool()

Verifies that configuration settings are valid for a tool script ($1).

Settings Attribute Finalization

settings_final()

Finalizes all library and script settings.

settings_final_lib()

Finalizes settings for a library script ($1) by applying or checking their configured variable attributes (e.g. readonly and nullable).


View the Developer Guide Index

View the Reference Manual Index


Generated on Fri Jul 28 14:37:19 PDT 2017 by mcsh d14 v0.23.0.