Index of values


A
act [OASISPlugin.PLUGINS]
Get action.
add [OASISFileTemplate]
Add a generated template file.
add_file [OASISPlugin]
Add a template to context
all [BaseSetup]
Run all steps: configure, build, doc, test and install.
all_plugins [OASISPlugin]
apache [OASISLicense]
architecture [BaseStandardVar]
args [BaseContext]
args [BaseEnv]
Default command line arguments, computed using variable definitions.
args [OASISContext]
Command line arguments to change OASISContext.default.
artistic [OASISLicense]

B
basename [BaseFilePath.Unix]
basename [OASISUnixPath]
basename fn Return filename without its directory name.
basesys_ml [BaseData]
All exported modules from base library, default content for 'setup.ml'.
basesysenvironment_ml [BaseData]
Minimal set of exported modules to load the 'setup.data' files.
bindir [BaseStandardVar]
blackbox [OASISValues]
Hidden value to build phantom data storage, cannot set/get it using string.
boolean [OASISValues]
Boolean value, use bool_of_string to parse.
bsd3 [OASISLicense]
bsd4 [OASISLicense]
build [BaseSetup]
Run the build step.
build_order [OASISBuildSection]
Compute the order of section building, taking into account build dependencies between sections.
builtin [OASISPlugin]
Use a builtin plugin (i.e.
bytecomp_c_compiler [BaseStandardVar]

C
categories [OASISValues]
Category list value.
cc0 [OASISLicense]
cc_by [OASISLicense]
cc_by_nc [OASISLicense]
cc_by_nc_nd [OASISLicense]
cc_by_nc_sa [OASISLicense]
cc_by_nd [OASISLicense]
cc_by_sa [OASISLicense]
ccomp_type [BaseStandardVar]
cddl [OASISLicense]
cecill [OASISLicense]
cecillb [OASISLicense]
cecillc [OASISLicense]
check [OASISExpr]
Check that a boolean expression only use available flags.
choices [OASISLicense]
Choices for quickstart question.
choices [OASISValues]
choices nm lst Value that must be in a list of predefined choices.
choose [OASISExpr]
choose ~printer ~name eval_tst choices Evaluate each conditions of choices and choose the last condition that evaluates to true.
chop [OASISVersion]
Remove the last part of a version, after the last '.'.
chop_extension [BaseFilePath.Unix]
chop_extension [OASISUnixPath]
chop_extension fn Remove the last part of the filename, after a '.', return fn if there is no extension.
clean [BaseSetup]
Run the clean step.
clear [PropList.Data]
Clear a data storage.
comma_separated [OASISValues]
Same as OASISValues.dot_separated using ',' as separator.
command_line [OASISValues]
Command line.
comment_bat [OASISFileTemplate]
.bat file comments.
comment_makefile [OASISFileTemplate]
Makefile comments.
comment_meta [OASISFileTemplate]
META file comments.
comment_ml [OASISFileTemplate]
.ml comments.
comment_ocamlbuild [OASISFileTemplate]
OCamlbuild comments.
comment_sh [OASISFileTemplate]
Shell comments.
comparator_apply [OASISVersion]
Apply version comparator expression.
comparator_of_string [OASISVersion]
Convert a string to comparator.
comparator_reduce [OASISVersion]
Simplify comparator, if possible.
comparator_value [OASISVersion]
Check that we have a version constraint.
compare_csl [OASISUtils]
Caseless compare function
concat [BaseFilePath.Unix]
concat [OASISUnixPath]
concat fn1 fn2 Concatenate fn1 and fn2, i.e.
configure [BaseSetup]
Run the configure step.
copyright [OASISValues]
Copyright value.
cp [BaseFileUtil]
Copy a file.
cpl [OASISLicense]
create [OASISPlugin.PLUGINS]
create [PropList.FieldRO]
Create a read-only field.
create [PropList.Field]
Create a field, and optionally attached it to a schema.
create [PropList.Schema]
Create a schema.
create [PropList.Data]
Create a data storage.
current_dir_name [OASISUnixPath]
'.' on Unix.

D
data_create [OASISPlugin]
Create storage for plugin data.
data_new_property [OASISPlugin]
data_new_property plg Create a property that can store plugin data.
datadir [BaseStandardVar]
datarootdir [BaseStandardVar]
debug [BaseMessage]
debug [BaseStandardVar]
Compile in debug mode.
debug [OASISMessage]
Print a debug message.
default [BaseContext]
default [OASISContext]
Default context
default_executable_name [BaseStandardVar]
default_filename [BaseSetup]
Default filename for 'setup.ml'.
default_filename [BaseLog]
Default file for registering log.
default_filename [BaseEnv]
Environment default file.
default_filename [BaseEnvLight]
Environment default file
destdir [BaseStandardVar]
directory [OASISValues]
Directory value.
dirname [BaseFilePath.Unix]
dirname [OASISUnixPath]
dirname fn Return directory name of fn or current_dir_name if no directory name is defined.
distclean [BaseSetup]
Run the distclean step.
doc [BaseSetup]
Run the doc step: build all documents.
doc [BaseDoc]
doc lst pkg extra_args Build all documents.
docdir [BaseStandardVar]
dot_separated [OASISValues]
dot_separated v When parsing split the input string using '.' separator and apply v.parse.
dump [BaseEnv]
Save environment on disk.
dvidir [BaseStandardVar]

E
eiffel [OASISLicense]
empty [OASISFileTemplate]
No generated template files.
error [BaseMessage]
error [OASISMessage]
Print an error message and exit.
eval [OASISExpr]
eval eval_tst t Evaluates the expression.
exec_prefix [BaseStandardVar]
exists [BaseLog]
Check if an event exists in the log file.
expandable [OASISValues]
Extra check to see if the string value, can be expanded using Buffer.add_substitute rules.
expat [OASISLicense]
ext_asm [BaseStandardVar]
ext_dll [BaseStandardVar]
ext_lib [BaseStandardVar]
ext_obj [BaseStandardVar]
ext_program [BaseStandardVar]
Compute the default suffix for program (e.g.

F
f_ [OASISGettext]
Translate a format string.
failwithf1 [OASISUtils]
failwithf2 [OASISUtils]
failwithf3 [OASISUtils]
failwithf4 [OASISUtils]
failwithf5 [OASISUtils]
fget [PropList.Field]
Retrieve a field from a PropList.Data.t.
fgets [PropList.Field]
Same as PropList.Field.fget but applies a printer to the value returned.
file [OASISValues]
File value.
file_generate [OASISFileTemplate]
Generate a file using a template.
file_glob [OASISValues]
File with glob value.
file_rollback [OASISFileTemplate]
Reset to pristine a generated file.
files [OASISValues]
File list value.
filter [BaseLog]
Filter events of the log file.
find [SubCommand]
Find a subcommand.
find [BaseSetup]
Get template 'setup.ml' file out of the plugin context.
find [OASISFileTemplate]
Find a generated template file.
find_file [BaseFileUtil]
find_file paths exts Find a file among all provided paths, trying various extensiosn exts.
findlib_full [OASISValues]
Findlib package name with path value, e.g.
findlib_name [OASISValues]
Findlib package name value, without its path.
findlib_name_map [OASISLibrary]
Compute internal to findlib library matchings, including subpackage and return a map of it.
findlib_of_group [OASISLibrary]
Return the findlib root name of a group, it takes into account containers.
findlib_of_name [OASISLibrary]
Return the findlib name of the library without parents
findlib_version [BaseStandardVar]
Findlib version.
fn_ [OASISGettext]
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.
fold [SubCommand]
Iterate through subcommands.
fold [BaseBuilt]
Fold-left files built, filter existing and non-existing files.
fold [OASISFileTemplate]
Fold over generated template files.
fold [PropList.Schema]
fold f acc t Apply f acc field_name field_extra field_help in turn to all fields of schema t.
freebsd [OASISLicense]
from_file [OASISParse]
See OASISParse.from_stream, apply to a filename.
from_stream [OASISParse]
from_stream ~ctxt ~ignore_plugins ~fn st Parse the OASIS file ~fn and check it.
from_string [OASISParse]
See OASISParse.from_stream, apply to a string.
fset [PropList.Field]
Store a field in a PropList.Data.t.
fsets [PropList.Field]
Same as PropList.Field.fset but parses a string to get the value.
func [ODNFunc]
Return the OCaml function corresponding to a func.
func_call [ODNFunc]
Return the OCaml function corresponding to a func.
func_with_arg [ODNFunc]
Create a func with an argument

G
generate [BaseGenerate]
Generate 'setup.ml' file and the rest of the build system.
generated_unix_files [OASISLibrary]
generated_unix_files ~ctxt (cs, bs, lib) source_file_exists is_native ext_lib ext_dll Compute all files expected by a build of the library.
generator_package [OASISPlugin]
Call generator for provided plugin
get [PropList.Schema]
get t data nm Retrieve the string value of field nm from schema t stores in data.
gfdl [OASISLicense]
gfdl_niv [OASISLicense]
glob [BaseFileUtil]
Expand a filename containing '*.ext' into corresponding real files.
gpl [OASISLicense]
group_libs [OASISLibrary]
Compute groups of libraries, associate root libraries with a tree of its children.

H
help [OASISPlugin]
Get general help text
help_default [OASISPlugin]
hook [BaseCustom]
hook ~failsafe custom f a Apply a function nested in a custom block as defined by OASISTypes.custom.
htmldir [BaseStandardVar]

I
info [BaseMessage]
info [OASISMessage]
Print information message.
infodir [BaseStandardVar]
init [BaseDynVar]
Read 'setup.log' and sets variables.
init [BaseStandardVar]
Initialize some variables.
init [OASISGettext]
Gettext initialization.
install [BaseSetup]
Run the install step.
internal_library [OASISValues]
Internal library.
is_built [BaseBuilt]
Check if a library/doc/exec has been built.
is_native [BaseStandardVar]
Check that the platform is a native platform (can compile native exec/library).
is_varname [OASISUtils]
is_varname str Check that the string str is a valid varname.
isc [OASISLicense]
iter [PropList.Schema]
Same as PropList.Schema.fold except no accumulator are involved.

L
lgpl [OASISLicense]
libdir [BaseStandardVar]
libexecdir [BaseStandardVar]
license_data [OASISLicense]
All available license, their short name, their long name, and compatible versions.
license_exception_data [OASISLicense]
All available license exception, their name, and compatible license.
load [BaseLog]
Load the log file.
load [BaseEnv]
Initialize environment.
load [BaseEnvLight]
Load environment.
localedir [BaseStandardVar]
localstatedir [BaseStandardVar]
lppl [OASISLicense]
ls [OASISPlugin]
List available plugins.

M
make [SubCommand]
make ~std_usage name synopsis help main Create a subcommand using provided data, see SubCommand.t for their meanings.
make [BaseFilePath.Unix]
make [BaseFilePath]
Create a filename out of its components.
make [BaseDev]
Create a 'setup.ml' that calls BaseDev.update_and_run.
make [OASISUnixPath]
make lst Concatenate all filename components of lst.
mandir [BaseStandardVar]
map_string_of_assoc [OASISUtils]
Convert a string association list to a map.
mem [PropList.Schema]
Check that the given field name exists.
mit [OASISLicense]
mkdir [BaseFileUtil]
Create a directory.
mkdir_parent [BaseFileUtil]
mkdir_parent f tgt Create a directory and its parent, call f with directory name created, in order.
model [BaseStandardVar]
modules [OASISValues]
Module list value.
mpl [OASISLicense]

N
name [PropList.Schema]
Get the name of the schema.
name_findlib_map [OASISLibrary]
Compute findlib to internal library matching.
native_c_compiler [BaseStandardVar]
new_field [OASISSchema]
new_field schm plugin_id name value help pivot_data sync Create a field for a plugin.
new_field_conditional [OASISSchema]
Create a conditional field for a plugin.
ns_ [OASISGettext]
Do nothing, but register it for translation

O
ocaml_linking_exception [OASISLicense]
ocaml_version [BaseStandardVar]
ocamlbuild [BaseStandardVar]
ocamlc [BaseStandardVar]
ocamlc [BaseOCamlcConfig]
The ocamlc command line tool.
ocamlfind [BaseStandardVar]
ocamlfind [BaseCheck]
The ocamlfind command line tool, used to query version of package.
ocamlopt [BaseStandardVar]
odn_of_arg [OASISTypes]
odn_of_args [OASISTypes]
odn_of_choices [OASISExpr]
odn_of_command_line [OASISTypes]
odn_of_comparator [OASISVersion]
Dump ODN.t.
odn_of_conditional [OASISTypes]
odn_of_findlib_full [OASISTypes]
odn_of_findlib_name [OASISTypes]
odn_of_func [ODNFunc]
Return the ODN.t code corresponding to a func.
odn_of_name [OASISTypes]
odn_of_package [OASISTypes]
odn_of_package_name [OASISTypes]
odn_of_prog [OASISTypes]
odn_of_t [BaseDev]
Dump ODN.t.
odn_of_t [OASISLicense]
Dump ODN.t.
odn_of_t [OASISVersion]
Dump ODN.t.
odn_of_t [OASISExpr]
Dump ODN.t.
odn_of_t [PropList.Data]
Dump Data.t to ODN, not exported.
odn_of_unix_dirname [OASISTypes]
odn_of_unix_filename [OASISTypes]
odn_of_url [OASISTypes]
of_executable [BaseBuilt]
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 [BaseBuilt]
of_library loc_fn (cs, bs, lib) Same as BaseBuilt.of_executable, but using OASISLibrary.generated_unix_files.
of_package [BaseSetup]
Create t and plugin context from an OASIS package.
of_unix [BaseFilePath]
Convert a unix filename into host filename.
opt [OASISValues]
Optional value.
os_type [BaseStandardVar]

P
package [BaseCheck]
Check for findlib package and version.
package_version [BaseCheck]
Get findlib package version .
parent_dir_name [OASISUnixPath]
'..' on Unix.
parse [BaseArgExt]
Parse command line argument, using provided arguments.
pdfdir [BaseStandardVar]
perl [OASISLicense]
pkg_name [BaseStandardVar]
pkg_version [BaseStandardVar]
plugin_compare [OASISPlugin]
Compare plugin, caseless for name and don't take into account version if one is not set.
plugin_equal [OASISPlugin]
Test equality for plugins, a special case of OASISPlugin.plugin_compare.
plugin_of_string [OASISPlugin]
Get a plugin from a string
plugins_of_string [OASISPlugin]
Get a list of plugins from a string
pp_print_list [FormatExt]
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.
pp_print_string_spaced [FormatExt]
Print a string considering ' ' as Format space.
prefix [BaseStandardVar]
print [BaseEnv]
Display environment to user.
print_hidden [BaseEnv]
Display all variables, even hidden one.
profile [BaseStandardVar]
Compile in profile mode.
prog [BaseCheck]
Check the presence of a particular program.
prog_best [BaseCheck]
Look for a program among a list of alternative program * the first found is returned.
prog_opt [BaseCheck]
Check the presence of a program or its native version.
proprietary [OASISLicense]
psdir [BaseStandardVar]
psf [OASISLicense]
public_domain [OASISLicense]

Q
qpl [OASISLicense]
quickstart_completion [OASISPlugin]
Get quickstart completion
quickstart_question [OASISPlugin.PLUGINS]
Quickstart question
quiet [OASISContext]
Quiet context.

R
reduce [OASISExpr]
Try to reduce the size of a boolean expression.
reduce_choices [OASISExpr]
Try to reduce the size of a choice list.
regexp [OASISValues]
regexp r nm Check that input string match r.
register [SubCommand]
Register a subcommand.
register [BaseLog]
Add an event to the log file.
register [BaseBuilt]
Register files built.
register_act [OASISPlugin.PLUGINS]
Register the section_act or package_act datastructure.
register_generator_package [OASISPlugin]
Register a generator for package, to store data of a plugin
register_help [OASISPlugin]
Register general help.
register_quickstart_completion [OASISPlugin]
Register a quickstart completion for this plugin
reinstall [BaseSetup]
Run the reinstall step: deinstall and install.
remove [OASISFileTemplate]
Remove a generated template file.
replace [BaseFileAB]
Replace variable in file %.ab to generate %.
replace [OASISFileTemplate]
Add or replace a generated template file.
restore [BaseGenerate]
Restore generated files, when generate has been called with ~restore:true.
rm [BaseStandardVar]
Host command to delete a file.
rmdir [BaseStandardVar]
Host command to delete a directory.
rmdir [BaseFileUtil]
Remove a directory.
root_of_group [OASISLibrary]
Return the root library, i.e.
run [BaseExec]
Run a command.
run [BaseCustom]
run prg args extra_args Expand and run command.
run_read_one_line [BaseExec]
Run a command and returns only first line.
run_read_output [BaseExec]
Run a command and returns its output.

S
s_ [OASISGettext]
Translate a string.
sbindir [BaseStandardVar]
schema [BaseEnv]
Schema for environment.
schema [OASISTest]
Schema for the section.
schema [OASISSourceRepository]
Schema for the section.
schema [OASISPackage]
Schema for the section.
schema [OASISLibrary]
Schema for the section.
schema [OASISFlag]
Schema for the section.
schema [OASISExecutable]
Schema for the section.
schema [OASISDocument]
Schema for the section.
set [PropList.Schema]
set t data nm ~context str Parse string value str in ~context and stores it in data for field nm of schema t.
set_error [OASISPlugin]
Define an error in context.
set_string_add_list [OASISUtils]
Add a string list to an existing Set.
set_string_of_list [OASISUtils]
Convert a string list to a Set.
setup [BaseSetup]
The first function called when running 'setup.ml'.
sharedstatedir [BaseStandardVar]
space_separated [OASISValues]
Same as OASISValues.dot_separated using blanks as separator.
split [OASISUtils]
split c s Split the string s at char c.
split_comma [OASISUtils]
Split a list using ',' as separator.
split_optional_parentheses [OASISUtils]
Split a string containing '(...)' optionally.
standard_library [BaseStandardVar]
standard_library_default [BaseStandardVar]
standard_runtime [BaseStandardVar]
string [OASISValues]
String value.
string_not_empty [OASISValues]
String value, must not be "".
string_of_comparator [OASISVersion]
Convert a comparator to string.
string_of_exception [BaseMessage]
string_of_exception [OASISMessage]
Convert an exception to a string readable by user.
string_of_exception [PropList]
Convert an exception in string.
string_of_license [OASISLicense]
Convert a license to string.
string_of_license_exception [OASISLicense]
Convert a license exception to string.
string_of_plugin [OASISPlugin]
Get a list of plugins from a string
string_of_test [OASISExpr]
Convert a test to string.
string_of_version [OASISVersion]
Convert a version to string.
sysconfdir [BaseStandardVar]
system [BaseStandardVar]
systhread_supported [BaseStandardVar]

T
template_make [OASISFileTemplate]
template_make fn cmt header body footer Create a template for which target file is fn.
template_of_mlfile [OASISFileTemplate]
template_of_ml_file fn Create an OCaml file template taking into account subtleties, like line modifier.
template_of_string_list [OASISFileTemplate]
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 [BaseTest]
test lst pkg extra_args Run all tests.
test [BaseSetup]
Run the test step: run all tests.
test_field_name [OASISPlugin]
Check that a field name has the form to match a plugin.
test_of_string [OASISExpr]
Convert a string to test.
tests [OASISExpr]
Mandatory tests.
to_filename [BaseFileAB]
Compute the target filename of an .ab file.
to_plugin [OASISPlugin]
Convert back to plugin
to_string [OASISLicense]
Convert a DEP-5 license to string.
transitive_build_depends [OASISBuildSection]
Compute a map between sections and its build depends.

U
uninstall [BaseSetup]
Run the uninstall step.
unix_exec_is [OASISExecutable]
unix_exec_is (cs, bs, exec) is_native ext_dll suffix_program Compute the filename of the real executable, with full unix path.
unload [BaseEnv]
Uninitialize environment.
unregister [BaseLog]
Remove an event from the log file.
unregister [BaseBuilt]
Unregister all files built.
update_and_run [BaseDev]
Run 'oasis setup' command line tool to regenerate a build system and and run it.
update_fail [OASISValues]
url [OASISValues]
URL value.

V
value [OASISPlugin.PLUGINS]
Parse a plugin field
value [OASISLicense]
License value.
value [OASISVersion]
Version number value.
var_all [BaseEnv]
Get all variables.
var_choose [BaseEnv]
Choose a value among conditional expressions.
var_choose [BaseEnvLight]
Choose a value among conditional expressions.
var_define [BaseOCamlcConfig]
Look for the variable name in the 'ocamlc -config' output and define it.
var_define [BaseEnv]
Define a variable.
var_expand [BaseEnv]
Expand variable that can be found in string.
var_get [BaseEnv]
Get variable.
var_get [BaseEnvLight]
Get a variable that evaluate expression that can be found in it (see Buffer.add_substitute).
var_ignore [BaseEnv]
Well-typed ignore for var_define.
var_protect [BaseEnv]
Protect a variable content, to avoid expansion.
var_redefine [BaseEnv]
Define a variable or redefine it.
varname_concat [OASISUtils]
varname_concat ~hyphen p s Concat variable name, removing hyphen at end of p and at beginning of s.
varname_of_comparator [OASISVersion]
Convert a comparator to variable name.
varname_of_string [OASISUtils]
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.
version [BaseSetup]
Display OASIS version used to generate this setup.ml
version [BaseCheck]
version var_pref cmp ver () Check version ver (), using cmp and OASISVersion.comparator_apply.
version_compare [OASISVersion]
Compare versions.
version_of_string [OASISVersion]
Convert a string to version.

W
w3c_software [OASISLicense]
warning [BaseMessage]
warning [OASISMessage]
Print a warning message.
which [BaseFileUtil]
Find real filename of an executable.
with_optional_parentheses [OASISValues]
with_optional_parentheses v_main v_opt Combine two values.

Z
zlib [OASISLicense]
zope [OASISLicense]