Up  

Index of values

A
add [Data.Map]
add [Data.Enum]

Same as tag but to not return the associated tag.

add [Server.Data.Map]
add [Server.Data.Enum]

Same as tag but to not return the associated tag.

add [Map.S]

add key data m returns a map containing the same bindings as m, plus a binding of key to data.

add_seq [Map.S]

Add the given bindings to the map, in order.

append [Jbuffer]
append [Server.Jbuffer]
array [Kernel_ast.Functions]
array [Server.Kernel_ast.Functions]
B
bindings [Map.S]

Return the list of all bindings of the given map.

bprintf [Jbuffer]

Prints into the buffer formatter.

bprintf [Server.Jbuffer]

Prints into the buffer formatter.

C
cardinal [Map.S]

Return the number of bindings of a map.

chapter [Server_doc]
choose [Map.S]

Return one binding of the given map, or raise Not_found if the map is empty.

choose_opt [Map.S]

Return one binding of the given map, or None if the map is empty.

clear [Data.Index]

Clear index tables.

clear [Server.Data.Index]

Clear index tables.

column [States]

Populate an array model with a new field.

column [Server.States]

Populate an array model with a new field.

compare [Map.S]

Total ordering between maps.

contents [Jbuffer]

Flushes the buffer and returns its JSON enoding.

contents [Server.Jbuffer]

Flushes the buffer and returns its JSON enoding.

create [Kernel_ast.Marker]

Memoized unique identifier.

create [Main]

Run a server with the provided low-level network primitives to actually exchange data.

create [Package.Scope]
create [Jbuffer]

Create a formatter with ~indent maximum indentation and ~margin right-margin.

create [Server.Kernel_ast.Marker]

Memoized unique identifier.

create [Server.Main]

Run a server with the provided low-level network primitives to actually exchange data.

create [Server.Jbuffer]

Create a formatter with ~indent maximum indentation and ~margin right-margin.

create [Server.Package.Scope]
D
data [Package.Derived]
data [Server.Package.Derived]
declare [Data]

Declare a new type and returns its alias.

declare [Package.Scope]

Must _not_ be call after use

declare [Package]

Register the declaration in the Server API.

declare [Server.Data]

Declare a new type and returns its alias.

declare [Server.Package.Scope]

Must _not_ be call after use

declare [Server.Package]

Register the declaration in the Server API.

declare_id [Package]

Same as declare but returns the associated identifier.

declare_id [Server.Package]

Same as declare but returns the associated identifier.

decode [Package.Derived]
decode [Server.Package.Derived]
default [Data.Record.S]
default [Server.Data.Record.S]
derived [Data]

Declare the derived names for the provided type.

derived [Package]
derived [Server.Data]

Declare the derived names for the provided type.

derived [Server.Package]
dictionary [Request]

Register a GET request dictionary.<name> to retrieve all tags registered in the dictionary.

dictionary [Data.Enum]

Creates an opened, empty dictionary.

dictionary [Server.Request]

Register a GET request dictionary.<name> to retrieve all tags registered in the dictionary.

dictionary [Server.Data.Enum]

Creates an opened, empty dictionary.

dump [Server_doc]

Dumps all published pages of documentations.

E
emit [Request]

Emit the signal to the client.

emit [Main]

Emit the server signal to the client.

emit [Server.Main]

Emit the server signal to the client.

emit [Server.Request]

Emit the signal to the client.

empty [Data.Map]
empty [Server.Data.Map]
empty [Map.S]

The empty map.

equal [Map.S]

equal cmp m1 m2 tests whether the maps m1 and m2 are equal, that is, contain equal keys and associate them with equal data.

exec [Main]
exec [Server.Main]
exists [Map.S]

exists f m checks if at least one binding of the map satisfies the predicate f.

extends [Data.Enum]

Publish a new instance in the documentation.

extends [Server.Data.Enum]

Publish a new instance in the documentation.

F
failure [Data]
failure [Server.Data]
failure_from_type_error [Data]
failure_from_type_error [Server.Data]
fetch [Package.Derived]
fetch [Server.Package.Derived]
field [Data.Record]

Adds a field to an opened record.

field [Package]
field [Server.Data.Record]

Adds a field to an opened record.

field [Server.Package]
filter [Map.S]

filter f m returns the map with all the bindings in m that satisfy predicate p.

filter_map [Map.S]

filter_map f m applies the function f to every binding of m, and builds a map from the results.

find [Main]
find [Data.Map]
find [Data.Index]
find [Data.Enum]

Returns the value associated to some tag.

find [Server.Main]
find [Server.Data.Map]
find [Server.Data.Index]
find [Server.Data.Enum]

Returns the value associated to some tag.

find [Map.S]

find x m returns the current value of x in m, or raises Not_found if no binding for x exists.

find_first [Map.S]

find_first f m, where f is a monotonically increasing function, returns the binding of m with the lowest key k such that f k, or raises Not_found if no such key exists.

find_first_opt [Map.S]

find_first_opt f m, where f is a monotonically increasing function, returns an option containing the binding of m with the lowest key k such that f k, or None if no such key exists.

find_last [Map.S]

find_last f m, where f is a monotonically decreasing function, returns the binding of m with the highest key k such that f k, or raises Not_found if no such key exists.

find_last_opt [Map.S]

find_last_opt f m, where f is a monotonically decreasing function, returns an option containing the binding of m with the highest key k such that f k, or None if no such key exists.

find_opt [Map.S]

find_opt x m returns Some v if the current value of x in m is v, or None if no binding for x exists.

find_tag [Data.Enum]

Returns the tag from its name.

find_tag [Server.Data.Enum]

Returns the tag from its name.

flush [Jbuffer]
flush [Server.Jbuffer]
fold [Map.S]

fold f m init computes (f kN dN ... (f k1 d1 init)...), where k1 ... kN are the keys of all bindings in m (in increasing order), and d1 ... dN are the associated data.

for_all [Map.S]

for_all f m checks if all the bindings of the map satisfy the predicate f.

format [Jbuffer]

All-in-one formatter.

format [Server.Jbuffer]

All-in-one formatter.

formatter [Jbuffer]

The underlying formatter of a buffer.

formatter [Server.Jbuffer]

The underlying formatter of a buffer.

fprintf [Jbuffer]

Prints back a JSON encoding into the provided formatter.

fprintf [Server.Jbuffer]

Prints back a JSON encoding into the provided formatter.

G
get [Data.Index]
get [Data.Record.S]
get [Server.Data.Index]
get [Server.Data.Record.S]
get_range [Parameter_sig.Int]

What is the possible range of values for this parameter.

getter [Package.Derived]
getter [Server.Package.Derived]
H
has [Data.Record.S]
has [Server.Data.Record.S]
has_relative_filepath [Server_parameters]
href [Server_doc]
I
id [Data.IdentifiedType]
id [Server.Data.IdentifiedType]
incr [Parameter_sig.Int]

Increment the integer.

instance [Data.Enum]

Returns the tag for a value associated with the given prefix.

instance [Server.Data.Enum]

Returns the tag for a value associated with the given prefix.

isRecursive [Package]
isRecursive [Server.Package]
is_empty [Jbuffer]

When is_empty js holds, the JSON is sure to be empty.

is_empty [Parameter_sig.Filepath]

Whether the Filepath is empty.

is_empty [Server.Jbuffer]

When is_empty js holds, the JSON is sure to be empty.

is_empty [Map.S]

Test whether a map is empty or not.

iter [Package]
iter [Map.S]

iter f m applies f to all bindings in map m.

iter [Server.Package]
J
jalist [Data]
jalist [Server.Data]
jalpha [Data]
jalpha [Server.Data]
jany [Data]
jany [Server.Data]
jarray [Data]
jarray [Server.Data]
jbool [Data]
jbool [Server.Data]
jdecl [Kernel_ast.Marker]
jdecl [Server.Kernel_ast.Marker]
jexpr [Kernel_ast.Marker]
jexpr [Server.Kernel_ast.Marker]
jfloat [Data]
jfloat [Server.Data]
jglobal [Kernel_ast.Marker]
jglobal [Server.Kernel_ast.Marker]
jindex [Data]
jindex [Server.Data]
jint [Data]
jint [Server.Data]
jkey [Data]
jkey [Server.Data]
jlist [Data]
jlist [Server.Data]
jlval [Kernel_ast.Marker]
jlval [Server.Kernel_ast.Marker]
joption [Data]
joption [Server.Data]
jpretty [Data]

All-in-one formatter.

jpretty [Server.Data]

All-in-one formatter.

jproperty [Kernel_ast.Marker]
jproperty [Server.Kernel_ast.Marker]
jstmt [Kernel_ast.Marker]
jstmt [Server.Kernel_ast.Marker]
jstring [Data]
jstring [Server.Data]
jterm [Kernel_ast.Marker]
jterm [Server.Kernel_ast.Marker]
jtype [Request.Output]
jtype [Request.Input]
jtype [Data.S]
jtype [Server.Request.Output]
jtype [Server.Request.Input]
jtype [Server.Data.S]
junit [Data]
junit [Server.Data]
K
kill [Main]

Kill the currently running request by raising an exception.

kill [Server.Main]

Kill the currently running request by raising an exception.

L
litteral [Package]

Quoted string

litteral [Server.Package]

Quoted string

lookup [Kernel_ast.Marker]

Get back the localizable, if any.

lookup [Data.Enum]

Returns the tag associated to a value.

lookup [Server.Kernel_ast.Marker]

Get back the localizable, if any.

lookup [Server.Data.Enum]

Returns the tag associated to a value.

loose [Package.Derived]
loose [Server.Package.Derived]
M
map [Map.S]

map f m returns a map with same domain as m, where the associated value a of all bindings of m has been replaced by the result of the application of f to a.

mapi [Map.S]

Same as Map.S.map, but the function receives as arguments both the key and the associated value for each binding of the map.

max_binding [Map.S]

Same as Map.S.min_binding, but returns the binding with the largest key in the given map.

max_binding_opt [Map.S]

Same as Map.S.min_binding_opt, but returns the binding with the largest key in the given map.

md_fields [Package]
md_fields [Server.Package]
md_jtype [Package]
md_jtype [Server.Package]
md_tags [Package]
md_tags [Server.Package]
mem [Map.S]

mem x m returns true if m contains a binding for x, and false otherwise.

merge [Map.S]

merge f m1 m2 computes a map whose keys are a subset of the keys of m1 and of m2.

min_binding [Map.S]

Return the binding with the smallest key in a given map (with respect to the Ord.compare ordering), or raise Not_found if the map is empty.

min_binding_opt [Map.S]

Return the binding with the smallest key in the given map (with respect to the Ord.compare ordering), or None if the map is empty.

model [States]

Creates an empty array model.

model [Server.States]

Creates an empty array model.

N
name [Data.Info]
name [Server.Data.Info]
name_of_ident [Package]
name_of_ident [Server.Package]
name_of_package [Package]
name_of_package [Server.Package]
name_of_pkg [Package]
name_of_pkg [Server.Package]
name_of_pkginfo [Package]
name_of_pkginfo [Server.Package]
O
of_json [Request.Input]
of_json [Data.S]
of_json [Server.Request.Input]
of_json [Server.Data.S]
of_seq [Map.S]

Build a map from the given bindings

off [Parameter_sig.Bool]

Set the boolean to false.

on [Main]

Register a callback to listen for server activity.

on [Parameter_sig.Bool]

Set the boolean to true.

on [Server.Main]

Register a callback to listen for server activity.

on_signal [Request]

Callback invoked each time the client is starting or stopping to listen to the given signal.

on_signal [Main]

Register a callback on signal listening.

on_signal [Server.Main]

Register a callback on signal listening.

on_signal [Server.Request]

Callback invoked each time the client is starting or stopping to listen to the given signal.

option [States]

Populate an array model with a new optional field.

option [Data.Record]

Adds a optional field to an opened record.

option [Server.States]

Populate an array model with a new optional field.

option [Server.Data.Record]

Adds a optional field to an opened record.

order [Package.Derived]
order [Server.Package.Derived]
P
package [Server_doc]

Publish a package.

package [Package]
package [Server.Package]
page [Server_doc]

Obtain the given page in the server documentation.

param [Request]

Named input parameter.

param [Server.Request]

Named input parameter.

param_opt [Request]

Named optional input parameter.

param_opt [Server.Request]

Named optional input parameter.

partition [Map.S]

partition f m returns a pair of maps (m1, m2), where m1 contains all the bindings of m that satisfy the predicate f, and m2 is the map with all the bindings of m that do not satisfy f.

path [Server_doc]
pop_tag [Jbuffer]
pop_tag [Server.Jbuffer]
pp_ident [Package]
pp_ident [Server.Package]
pp_jtype [Package]
pp_jtype [Server.Package]
pp_kind [Main]
pp_kind [Server.Main]
pp_pkgname [Package]
pp_pkgname [Server.Package]
pp_plugin [Package]
pp_plugin [Server.Package]
prefix [Data.Enum]

Register a new prefix tag in the dictionary.

prefix [Server.Data.Enum]

Register a new prefix tag in the dictionary.

pretty [Data]
pretty [Server.Data]
protocole [Server_doc]

Publish a protocole.

publish [Server_doc]

Adds a section in the corresponding page.

publish [Data.Enum]

Publish the dictionary.

publish [Data.Record]

Publish and close an opened record.

publish [Server.Data.Enum]

Publish the dictionary.

publish [Server.Data.Record]

Publish and close an opened record.

push_tag [Jbuffer]
push_tag [Server.Jbuffer]
R
register [Kernel_ast.Information]

Registers a marker information printer.

register [Request]

Register a simple request of type (a -> b) which depends on the given signals

register [Main]
register [Server.Kernel_ast.Information]

Registers a marker information printer.

register [Server.Main]
register [Server.Request]

Register a simple request of type (a -> b) which depends on the given signals

register_array [States]

Register everything necessary to synchronize an array with the client: Signal <name>.sig is emitted on array updates;, GET Request <name>.fetch is registered to get updates;, GET Request <name>.reload is registered to trigger a full reload. The ~key parameter is used to identify array entries, and used to fill the reserved column "id" of entries.

register_array [Server.States]

Register everything necessary to synchronize an array with the client: Signal <name>.sig is emitted on array updates;, GET Request <name>.fetch is registered to get updates;, GET Request <name>.reload is registered to trigger a full reload. The ~key parameter is used to identify array entries, and used to fill the reserved column "id" of entries.

register_propkind [Kernel_properties]

Documentation of ACSL extensions for propkind server data.

register_propkind [Server.Kernel_properties]

Documentation of ACSL extensions for propkind server data.

register_sig [Request]

Register the request JSON processing function.

register_sig [Server.Request]

Register the request JSON processing function.

register_state [States]

Register a (projectified) state and generates the associated signal and requests: Signal <name>.sig is emitted on value updates;, GET Request <name>.get returns the current value;, SET Request <name>.set modifies the server value. If provided, the ~add_hook option is used to register a hook to notify the server of value updates.

register_state [Server.States]

Register a (projectified) state and generates the associated signal and requests: Signal <name>.sig is emitted on value updates;, GET Request <name>.get returns the current value;, SET Request <name>.set modifies the server value. If provided, the ~add_hook option is used to register a hook to notify the server of value updates.

register_value [States]

Register a (projectified) value and generates the associated signal and request: Signal <name>.sig is emitted on value updates;, GET Request <name>.get returns the current value. If provided, the ~add_hook option is used to register a hook to notify the server of value updates.

register_value [Server.States]

Register a (projectified) value and generates the associated signal and request: Signal <name>.sig is emitted on value updates;, GET Request <name>.get returns the current value. If provided, the ~add_hook option is used to register a hook to notify the server of value updates.

reload [Kernel_properties]

Trigger a full reload for the table of property status.

reload [States]

Mark the array to be fully reloaded.

reload [Package.Derived]
reload [Server.Kernel_properties]

Trigger a full reload for the table of property status.

reload [Server.States]

Mark the array to be fully reloaded.

reload [Server.Package.Derived]
remove [States]

Mark an array entry as removed.

remove [Server.States]

Mark an array entry as removed.

remove [Map.S]

remove x m returns a map containing the same bindings as m, except for x which is unbound in the returned map.

reserve [Package.Scope]

Must _not_ be call after use

reserve [Server.Package.Scope]

Must _not_ be call after use

resolve [Package.Scope]
resolve [Package]

Assigns non-classing names for each identifier.

resolve [Server.Package.Scope]
resolve [Server.Package]

Assigns non-classing names for each identifier.

result [Request]

Named output parameter.

result [Server.Request]

Named output parameter.

result_opt [Request]

Named optional output parameter.

result_opt [Server.Request]

Named optional output parameter.

run [Main]

Run the server forever.

run [Server.Main]

Run the server forever.

S
safe [Package.Derived]
safe [Server.Package.Derived]
set [Data.Record.S]
set [Server.Data.Record.S]
set_lookup [Data.Enum]

Set tagging function for values.

set_lookup [Server.Data.Enum]

Set tagging function for values.

set_range [Parameter_sig.Int]

Set what is the possible range of values for this parameter.

setter [Package.Derived]
setter [Server.Package.Derived]
signal [Kernel_ast.Information]

Updated information signal

signal [States]

Get the signal associated with the array.

signal [Request]

Register a server signal.

signal [Main]
signal [Package.Derived]
signal [Server.Kernel_ast.Information]

Updated information signal

signal [Server.Main]
signal [Server.States]

Get the signal associated with the array.

signal [Server.Request]

Register a server signal.

signal [Server.Package.Derived]
signal_name [Main]
signal_name [Server.Main]
signature [Request]

Create an opened request signature.

signature [Data.Record]

Create a new, opened record type.

signature [Server.Request]

Create an opened request signature.

signature [Server.Data.Record]

Create a new, opened record type.

singleton [Map.S]

singleton x y returns the one-element map that contains a binding y for x.

split [Map.S]

split x m returns a triple (l, data, r), where l is the map with all the bindings of m whose key is strictly less than x; r is the map with all the bindings of m whose key is strictly greater than x; data is None if m contains no binding for x, or Some v if m binds v to x.

start [Main]

Start the server in background.

start [Server.Main]

Start the server in background.

stop [Main]

Stop the server if it is running in background.

stop [Server.Main]

Stop the server if it is running in background.

string_of_kind [Main]
string_of_kind [Server.Main]
T
tag [Data.Enum]

Register a new tag in the dictionary.

tag [Server.Data.Enum]

Register a new tag in the dictionary.

tag_name [Data.Enum]
tag_name [Server.Data.Enum]
tags [Data.Enum]

Obtain all the tags registered in the dictionary so far.

tags [Server.Data.Enum]

Obtain all the tags registered in the dictionary so far.

to_json [Request.Output]
to_json [Data.S]
to_json [Jbuffer]

All-in-one formatter.

to_json [Server.Request.Output]
to_json [Server.Data.S]
to_json [Server.Jbuffer]

All-in-one formatter.

to_rev_seq [Map.S]

Iterate on the whole map, in descending order of keys

to_seq [Map.S]

Iterate on the whole map, in ascending order of keys

to_seq_from [Map.S]

to_seq_from k m iterates on a subset of the bindings of m, in ascending order of keys, from key k or above.

U
union [Map.S]

union f m1 m2 computes a map whose keys are a subset of the keys of m1 and of m2.

update [Kernel_ast.Information]

Emits a signal to server clients to reload AST marker information.

update [States]

Mark an array entry as updated.

update [Package]

Replace the declaration for the given name in the package.

update [Server.Kernel_ast.Information]

Emits a signal to server clients to reload AST marker information.

update [Server.States]

Mark an array entry as updated.

update [Map.S]

update key f m returns a map containing the same bindings as m, except for the binding of key.

update [Server.Package]

Replace the declaration for the given name in the package.

use [Package.Scope]
use [Server.Package.Scope]
V
visit_decl [Package]
visit_decl [Server.Package]
visit_dkind [Package]
visit_dkind [Server.Package]
visit_field [Package]
visit_field [Server.Package]
visit_jtype [Package]
visit_jtype [Server.Package]
visit_package_decl [Package]
visit_package_decl [Server.Package]
visit_package_used [Package]
visit_package_used [Server.Package]
visit_param [Package]
visit_param [Server.Package]
visit_request [Package]
visit_request [Server.Package]
W
with_unfold_precond [Printer_tag.S_pp]
wkind [Server_parameters]

Inconsistent category warning

wname [Server_parameters]

Invalid name warning

wpage [Server_parameters]

Inconsistent page warning