Index of values

bindings b are the uninterpreted path bindings found in b.

bool asks for a boolean value.

builtins are the built-in variable definitions.

compare p p' is Pervasives.compare p p'.

content b is the bone's content.

doc b is the synopsis and documentation of b.

dom p is the set of variable references in p.

empty is an empty builtin pattern.

env () is a Cmdliner term that has all the options to setup a carcass environment.

env ~undef m is an evaluation environment in which variables are defined according to the map m.

env_var_value env var is value of variable var in env, if defined.

env_with_cli_flesh ~pos is like Carcass_cli.env but also defines flesh as positional command line arguments starting at pos.

equal p p' is p = p'.

etc_dir is the path to the install's etc directory.

eval env b evaluates b to a string in the pattern evaluation environment env.

eval env pat is the evaluation of pattern pat in environment env.

eval_bones env penv m evaluates all the bone ids in the path map m to their content and executable status using env to look them up and penv to evaluate textual bones.

eval_paths env penv id b evaluates all the paths of bone b's bindings and maps them to their bone id using env to lookup sub-bodies and penv to evaluate the path patterns.

find env id finds the full path to the bone identified by id in environment env.

find env id finds the full path to the bone identified by id in environment env.

for_builtin s is a builtin location for string s.

for_cli s is a cli location for string s.

for_path ~range p is the range range (defaults to Carcass.Loc.zero_range) of p.

id b is the body's id.

id b is the bone's id.

is_exec b is true if the bone is executable.

list ~hidden env maps body ids found in the environment env to their path.

list ~hidden env maps bone identifiers found in the environment env to their path.

nil is an invalid builtin location.

nil_pos is an invalid position.

nil_range is an invalid range.

nil is an empty trace.

of_env init env are the variable bindings available in environment env added to init (defaults to Carcass.Flesh.builtins).

of_input ~src input id reads a body with id id from input.

of_input ~src input is_exec id reads a bone with id id from input.

of_input ~init ~src input reads flesh variable bindings from input and adds them to init (defaults to Carcass.Flesh.builtins).

of_input ~flesh ~src i considers i as a single atom and returns its pattern.

of_path p id reads a body with id id from path p using Carcass.Body.of_input.

of_path ~trim p reads a bone with id id from path p using Carcass.Bone.of_input.

pattern asks for a pattern.

pp formats flesh as valid carcass flesh syntax.

pp formats patterns verbatim like Carcass.Pat.to_string.

pp formats locations according to GNU conventions.

pp_def formats a pattern like a flesh variable definition.

pp_eval is a formatter for evaluation errors.

pp_eval_err is a formatter for evaluation error cases.

pp_eval_def is a formatter for evaluated identifiers.

pp_parse is a formatter for parse errors.

pp_parse_err is a formatter for parse error cases.

pp_trace formats traces using Carcass.Loc.pp.

pp_transform is a pretty printer for transforms.

query ~init p s returns an environment mapping each pattern variable of p to its matched part in s, if s matches p.

string asks for a string value.

subst defs p substitutes variables in p by the value they map to in defs.

to_string ~flesh p converts p to a string according the carcass syntax for variable references.

transform_of_string s parses a transform from s.

transform_of_string t parses a transform from s.

user_dir is the path to the user's carcass directory.

v ~no_user_dir ~no_dot_dirs ~dirs ~flesh ~cli is an environment such that looks up are done, in order: For flesh, first in cli, followed by flesh files (starting from the last one), followed by files d/flesh with d in dirs (starting from the last one)., For bones and bodies, first in directory dirs (starting from the last one), then in .carcass directories from current directory up to root (except if no_dot_dirs is true), then in ~/.carcass (except if no_user_dir is true).

value ~parse asks for a value parsed according to parse.

var_docs b maps a selection of variables to a documentation string.

write ~log ~over ~dst m writes the paths defined in m (creating directories if needed) relative to dst according to the content they map to and setting the executable bit according to the boolean.

zero_pos is (1,0).

zero_range is (zero_pos, zero_pos).