Index of values

Get action.

Add a generated template file.

See OASISUnixPath.add_extension.

add_extension fn ext Add the extension ext to the filename fn.

Add a template to context

Run all steps: configure, build, doc, test and install.

See OASISContext.args.

Default command line arguments, computed using variable definitions.

Command line arguments to change OASISContext.default.

basename fn Return filename without its directory name.

All exported modules from base library, default content for 'setup.ml'.

Set of modules to load for the 'bundle' subcommand

Minimal set of exported modules to load the 'setup.data' files.

Hidden value to build phantom data storage, cannot set/get it using string.

Boolean value, use bool_of_string to parse.

Run the build step.

Compute the order of section building, taking into account build dependencies between sections.

Use a builtin plugin (i.e.

capitalize_file fn Return filename capitalized.

Category list value.

Check that a boolean expression only use available flags.

check_extension fn ext Check that the filen fn has the extension ext.

Choices for quickstart question.

choices nm lst Value that must be in a list of predefined choices.

choose ~printer ~name eval_tst choices Evaluate each conditions of choices and choose the last condition that evaluates to true.

Remove the last part of a version, after the last '.'.

chop_extension fn Remove the last part of the filename, after a '.', return fn if there is no extension.

Run the clean step.

Clear a data storage.

Same as OASISValues.dot_separated using ',' as separator.

Command line.

Arguments of command line programs.

.bat file comments.

Makefile comments.

META file comments.

.ml comments.

OCamlbuild comments.

Shell comments.

Apply version comparator expression.

Convert a string to comparator.

Simplify comparator, if possible.

Check that we have a version constraint.

Compare host filename.

Caseless compare function

concat fn1 fn2 Concatenate fn1 and fn2, i.e.

Run the configure step.

Copyright value.

Copy a file.

Create a read-only field.

Create a field, and optionally attached it to a schema.

Create a schema.

Create a data storage.

'.' on Unix.

Create storage for plugin data.

data_new_property plg Create a property that can store plugin data.

See OASISMessage.debug.

Compile in debug mode.

Print a debug message.

See OASISContext.default

Default context

Default filename for 'setup.ml'.

Default file for registering log.

Environment default file.

Environment default file

Directory value.

dirname fn Return directory name of fn or current_dir_name if no directory name is defined.

Run the distclean step.

Run the doc step: build all documents.

doc lst pkg extra_args Build all documents.

Compile docs.

dot_separated v When parsing split the input string using '.' separator and apply v.parse.

Save environment on disk.

List field set, not exported

No generated template files.

Data for environment.

See OASISMessage.error.

Print an error message.

escape s quote s if needed to protect spaces, '"' and '\'' so it reads as a single argument in a POSIX shell command, the content of which is identical to s (interpreted with OCaml conventions).

eval eval_tst t Evaluates the expression.

Check if an event exists in the log file.

Extra check to see if the string value, can be expanded using Buffer.add_substitute rules.

Compute the default suffix for program (e.g.

Translate a format string.

This function raise the Failure exception just as failwith except that one specify the string raised through a format string.

Retrieve a field from a PropList.Data.t.

Same as PropList.Field.fget but applies a printer to the value returned.

File value.

Test file existence, considering case even on case insensitive filesystem.

Generate a file using a template.

File with glob value.

Reset to pristine a generated file.

File list value.

Filter events of the log file.

Find a subcommand.

Get template 'setup.ml' file out of the plugin context.

Find a generated template file.

find_file paths exts Find a file among all provided paths, trying various extensiosn exts.

Findlib package name with path value, e.g.

Compute groups of libraries, associate root libraries with a tree of its children.

Findlib package name value, without its path.

Return the findlib root name of a group, it takes into account containers.

Findlib version.

fn_ fmt_singular fmt_plural n Translate a plural string using either fmt_singular or fmt_plural, depending of the plural status of number n in the target language.

Iterate through subcommands.

Fold-left files built, filter existing and non-existing files.

Fold over generated template files.

fold f acc t Apply f acc field_name field_extra field_help in turn to all fields of schema t.

See OASISParse.from_stream, apply to a filename.

from_stream ~ctxt ~ignore_plugins ~fn st Parse the OASIS file ~fn and check it.

See OASISParse.from_stream, apply to a string.

Store a field in a PropList.Data.t.

Same as PropList.Field.fset but parses a string to get the value.

Return the OCaml function corresponding to a func.

Return the OCaml function corresponding to a func.

Create a func with an argument

Generate 'setup.ml' file and the rest of the build system.

generated_unix_files ~ctxt source_file_exists has_native_dynlink is_native ext_lib ext_dll (cs, bs, lib) Compute all files expected by a build of the library.

Call generator for provided plugin

Call generator for provided plugin on a section

get t data nm Retrieve the string value of field nm from schema t stores in data.

Expand a filename containing '*.ext' into corresponding real files.

Get general help text

hook ~failsafe custom f a Apply a function nested in a custom block as defined by OASISTypes.custom.

if_then_else cond choices_if choices_else Combine choices, if_then_else style.

See OASISMessage.info.

Print information message.

Read 'setup.log' and sets variables.

Initialize some variables.

Gettext initialization.

Run the install step.

Internal library.

Check if a library/doc/exec has been built.

Test if the filename is the current directory.

Test if the filename is current dir (either '.' or '') on Unix.

Check that the platform is a native platform (can compile native exec/library).

is_varname str Check that the string str is a valid varname.

Same as PropList.Schema.fold except no accumulator are involved.

All available license, their short name, their long name, and compatible versions.

All available license exception, their name, and compatible license.

Load the log file.

Initialize environment.

Load environment.

List available plugins.

make ~std_usage name synopsis help main Create a subcommand using provided data, see SubCommand.t for their meanings.

Create a filename out of its components.

make lst Concatenate all filename components of lst.

make_relative fn_root fn Make fn relative to fn_root.

Convert a string association list to a map.

Check that the given field name exists.

Create a directory.

mkdir_parent f tgt Create a directory and its parent, call f with directory name created, in order.

Module list value.

Get the name of the schema.

Support for .cmxs.

new_field schm plugin_id name value help pivot_data sync Create a field for a plugin.

Create a conditional field for a plugin.

Same OASISValues.dot_separated using '\n' as separator.

Do nothing, but register it for translation

nsplit c s Split the string s at char c.

The ocamlc command line tool.

The ocamlfind command line tool, used to query version of package.

Dump ODN.t.

Return the ODN.t code corresponding to a func.

Dump ODN.t.

Dump ODN.t.

Dump ODN.t.

Dump Data.t to ODN, not exported.

of_executable loc_fn (cs, bs, exec) Compute at the same time events that should be registered by BaseBuilt.register and data returned by OASISExecutable.unix_exec_is.

of_library loc_fn (cs, bs, lib) Same as BaseBuilt.of_executable, but using OASISLibrary.generated_unix_files.

Create t and plugin context from an OASIS package and the matching _oasis.

Convert a unix filename into host filename.

Optional value.

Check for findlib package and version.

Get findlib package version .

'..' on Unix.

Parse command line argument, using provided arguments.

Compare plugin, caseless for name and don't take into account version if one is not set.

Test equality for plugins, a special case of OASISPlugin.plugin_compare.

Get a plugin from a string

Get a list of plugins from a string

pp_print_list pp_elem sep fmt lst Print the list lst of elements using pp_elem for each element and separate them by sep.

Print a string considering ' ' as Format space.

Display environment to user.

Display all variables, even hidden one.

Compile in profile mode.

Check the presence of a particular program.

Look for a program among a list of alternative program * the first found is returned.

Check the presence of a program or its native version.

Get quickstart completion

Quickstart question

Quiet context.

Try to reduce the size of a boolean expression.

Try to compress the filename by removing '.' and collapsing '..'.

Try to reduce the size of a choice list.

Register a subcommand.

Add an event to the log file.

Register files built.

Register the section_act or package_act datastructure.

Register a generator for package, to store data of a plugin

Register a generator for a section, to store data of a plugin

Register general help.

Register a quickstart completion for this plugin

Run the reinstall step: deinstall and install.

Remove a generated template file.

Replace variable in file %.ab to generate %.

Add or replace a generated template file.

replace_extension fn ext Add the extension ext to the filename fn.

Restore generated files, when generate has been called with ~restore:true.

Host command to delete a file.

Host command to delete a directory.

Remove a directory.

Return the root library, i.e.

run prg args extra_args Expand and run command.

Run a command.

Run a command and returns only first line.

Run a command and returns its output as a list of lines.

Translate a string.

Schema for environment.

Schema for the section.

Schema for the section.

Schema for the section.

Schema for the section.

Schema for the section.

Schema for the section.

Schema for the section.

Common section of a section

Set the common part of a section

Find a section

Key used to identify section

Extract generic information

set t data nm ~context str Parse string value str in ~context and stores it in data for field nm of schema t.

Define an error in context.

Add a string list to an existing Set.

Convert a string list to a Set.

The first function called when running 'setup.ml'.

source_unix_files (cs, bs, lib) source_file_exists Source files for this library.

Same as OASISValues.dot_separated using blanks as separator.

split s: the string s is interpreted as command line arguments and splitted into its components (un-escaped).

Split a list using ',' as separator.

Split a list using '\n' as separator.

Split a string containing '(...)' optionally.

String value.

String value, must not be "".

Transform a list of choice into a string.

Convert a comparator to string.

Convert a license to string.

Convert a license exception to string.

Get a list of plugins from a string

Convert a section to a short string (only informations returned by OASISSection.section_id

Convert a test to string.

Convert a version to string.

template_make fn cmt header body footer Create a template for which target file is fn.

template_of_ml_file fn Create an OCaml file template taking into account subtleties, like line modifier.

template_of_string_list ~ctxt ~template fn cmt lst Split a the list lst of into an header, a body and a footer, using comment cmt to determine each part.

test lst pkg extra_args Run all tests.

Run the test step: run all tests.

Check that a field name has the form to match a plugin.

Convert a string to test.

Run tests.

Mandatory tests.

Compute the target filename of an .ab file.

Convert back to plugin

Convert a DEP-5 license to string.

Transform an expression into a string.

Compute a map between sections and its build depends.

uncapitalize_file fn Return filename uncapitalized.

unescape s returns a string s' removing all backslashes preceding a char.

Run the uninstall step.

unix_exec_is (cs, bs, exec) is_native ext_dll suffix_program Compute the filename of the real executable, with full unix path.

Uninitialize environment.

Remove an event from the log file.

Unregister all files built.

Always raise OASISValues.Not_combinable.

URL value.

Parse a plugin field

License value.

Version number value.

Get all variables.

Choose a value among conditional expressions.

Choose a value among conditional expressions.

Look for the variable name in the 'ocamlc -config' output and define it.

Define a variable.

Expand variable that can be found in string.

Get variable.

Get a variable that evaluate expression that can be found in it (see Buffer.add_substitute).

Well-typed ignore for var_define.

Protect a variable content, to avoid expansion.

Define a variable or redefine it.

varname_concat ~hyphen p s Concat variable name, removing hyphen at end of p and at beginning of s.

Convert a comparator to variable name.

varname_of_string ~hyphen:c s Transform a string s into a variable name, following this convention: no digit at the beginning, lowercase, only a-z and 0-9 chars.

Display OASIS version used to generate this setup.ml

version var_pref cmp ver () Check version ver (), using cmp and OASISVersion.comparator_apply.

Check that >= 0.3, useful for oasis version comparison.

Compare versions.

Convert a string to version.

See OASISMessage.warning.

Print a warning message.

Find real filename of an executable.

with_optional_parentheses v_main v_opt Combine two values.