Index of values


A
action [Gramext]
add [Quotation]
add name exp adds the quotation name associated with the expander exp.
add [Plexing.Lexbuf]
add_directive [Pcaml]
add_option [Pcaml]
Add an option to the command line options.
after [Ploc]
Ploc.after loc sh len is the location just after loc (starting at the end position of loc) shifted with sh characters and of length len.
after_loc [Stdpp]
Use now Ploc.after
app [Fstream]
apply [Extfun]
Apply an extensible function
apply [Eprinter]
Applies a printer, returning the printed string of the parameter.
apply_level [Eprinter]
Applies a printer at some specific level.

B
b_act [Fstream]
b_or [Fstream]
b_seq [Fstream]
b_term [Fstream]
backtrack_parse [Grammar]
If True, the default parsing uses full backtracking.
backtrack_stalling_limit [Grammar]
Limitation of backtracking to prevent stalling in case of syntax error.
bcontinue [Fstream]
bol_pos [Ploc]
Ploc.bol_pos loc returns the position of the beginning of the line of the location in number of characters since the beginning of the stream, or 0 if the location does not contain a line number (i.e.
bol_pos [Token]
Use now Plexing.bol_pos
bol_pos [Stdpp]
Use now Ploc.bol_pos
bol_pos [Plexing]
Special variables used to reinitialize line numbers and position of beginning of line with their correct current values when a parser is called several times with the same character stream.
bparse_all [Fstream]

C
call_with [Ploc]
Ploc.call_with r v f a sets the reference r to the value v, then call f a, and resets r to its initial value.
class_expr [Pcaml]
class_sig_item [Pcaml]
class_str_item [Pcaml]
class_type [Pcaml]
Some entries of the language, set by pa_o.cmo and pa_r.cmo.
clear [Eprinter]
Clears a printer, removing all its levels and rules.
clear_entry [Grammar.S.Unsafe]
clear_entry [Grammar.Unsafe]
comm_bef [Prtools]
comm_bef pc loc get the comment from the source just before the given location loc.
cons [Fstream]
constructor_declaration [Pcaml]
count [Fstream]
count_unfrozen [Fstream]
create [Grammar.S.Entry]
create [Grammar.Entry]
create_local_entry [Grammar]
ctyp [Pcaml]

D
default [Quotation]
default holds the default quotation name.
default_match [Token]
Use now Plexing.default_match
default_match [Plexing]
A simple tok_match function, appling to the token type (string * string)
delete_rule [Grammar.S]
delete_rule [Grammar]
delete_rule_in_level_list [Gramext]
dollar_for_antiquotation [Plexer]
When True (default), the next call to Plexer.gmake () returns a lexer where the dollar sign is used for antiquotations.
dummy [Ploc]
Ploc.dummy is a dummy location, used in situations when location has no meaning.
dummy_loc [Token]
dummy_loc [Stdpp]
Use now Ploc.dummy

E
empty [Extfun]
Empty extensible function
empty [Plexing.Lexbuf]
empty [Fstream]
empty_pc [Pprintf]
Empty printer context, equal to: {ind = 0; bef = ""; aft = ""; dang = ""}
encl [Ploc]
Ploc.encl loc1 loc2 returns the location starting at the smallest start of loc1 and loc2 and ending at the greatest end of them.
encl_loc [Stdpp]
Use now Ploc.encl
eq_class_expr [Pcaml]
eq_class_sig_item [Pcaml]
eq_class_str_item [Pcaml]
eq_class_type [Pcaml]
eq_ctyp [Pcaml]
eq_expr [Pcaml]
eq_module_expr [Pcaml]
eq_module_type [Pcaml]
eq_patt [Pcaml]
eq_sig_item [Pcaml]
eq_str_item [Pcaml]
eq_symbol [Gramext]
error_verbose [Grammar]
Flag for displaying more information in case of parsing error; default = False
eval_char [Token]
Use now Plexing.eval_char
eval_char [Plexing]
eval_string [Token]
Use now Plexing.eval_string
eval_string [Plexing]
Convert a char or a string token, where the backslashes had not been interpreted into a real char or string; raise Failure if bad backslash sequence found; Plexing.eval_char (Char.escaped c) would return c and Plexing.eval_string (String.escaped s) would return s
expr [Pcaml]
extend [Grammar.S]
extend [Grammar]

F
f [Diff]
Diff.f a1 a2 returns a couple of two arrays of booleans (d1, d2).
fast [Ast2pt]
Flag to generate fast (unsafe) access to arrays.
find [Quotation]
find name returns the expander of the given quotation name.
find [Grammar.Entry]
find_directive [Pcaml]
first_pos [Ploc]
Ploc.first_pos loc returns the position of the begin of the location in number of characters since the beginning of the stream.
first_pos [Stdpp]
Use now Ploc.first_pos
flatten_sequence [Prtools]
flatten_sequence e.
flazy [Fstream]
fold_entry [Grammar]
Grammar.fold_entry f e init computes (f eN .. (f e2 (f e1 init))), where e1 .. eN are e and transitively all entries called by e.
force_antiquot_loc [Plexer]
from [Fstream]
from_file [Ploc]
Ploc.from_file fname loc reads the file fname up to the location loc and returns the real input file, the line number and the characters location in the line; the real input file can be different from fname because of possibility of line directives typically generated by /lib/cpp.

G
gcreate [Grammar]
Create a new grammar, without keywords, using the lexer given as parameter.
get [Plexing.Lexbuf]
glexer [Grammar.S]
glexer [Grammar]
Return the lexer used by the grammar
gmake [Plexer]
gmake () returns a lexer compatible with the extensible grammars.
gram [Pcaml]
Grammar variable of the OCaml language
gram_reinit [Grammar.S.Unsafe]
gram_reinit [Grammar.Unsafe]

H
handle_expr_quotation [Pcaml]
handle_patt_quotation [Pcaml]
hlist [Prtools]
horizontal list hlist elem pc e returns the horizontally pretty printed string of a list of elements; elements are separated with spaces.
hlist2 [Prtools]
horizontal list with different function from 2nd element on
hlistl [Prtools]
horizontal list with different function for the last element
horiz_vertic [Pretty]
horiz_vertic h v first calls h to print the data horizontally, i.e.
horizontally [Pretty]
horizontally () returns the fact that the context is an horizontal print.
hvlistl [Prtools]
applies hlistl if the context is horizontal; else applies vlistl

I
implem [Pcaml]
implem [Ast2pt]
implem fname ast return the OCaml equivalent AST of an implementation (ml file), fname being the input file name.
input_file [Pcaml]
The file currently being parsed.
inter_phrases [Pcaml]
String displayed between two consecutive phrases.
interf [Pcaml]
interf [Ast2pt]
interf fname ast return the OCaml equivalent AST of an interface (mli file), fname being the input file name.
ipatt [Pcaml]
iter [Fstream]
iter_entry [Grammar]
Grammar.iter_entry f e applies f to the entry e and transitively all entries called by e.

L
last_pos [Ploc]
Ploc.last_pos loc returns the position of the first character not of the location in number of characters since the beginning of the stream.
last_pos [Stdpp]
Use now Ploc.last_pos
let_binding [Pcaml]
levels_of_rules [Gramext]
lexer [Grammar.GLexerType]
lexer_func_of_ocamllex [Token]
Use now Plexing.lexer_func_of_ocamllex
lexer_func_of_ocamllex [Plexing]
A lexer function from a lexer created by ocamllex
lexer_func_of_parser [Token]
Use now Plexing.lexer_func_of_parser
lexer_func_of_parser [Plexing]
A lexer function from a lexer written as a char stream parser returning the next token and its location.
lexer_text [Token]
Use now Plexing.lexer_text
lexer_text [Plexing]
A simple tok_text function.
line_length [Pretty]
line_length is the maximum length (in characters) of the line.
line_nb [Ploc]
Ploc.line_nb loc returns the line number of the location or -1 if the location does not contain a line number (i.e.
line_nb [Token]
Use now Plexing.line_nb
line_nb [Stdpp]
Use now Ploc.last_pos
line_nb [Plexing]
line_of_loc [Stdpp]
Use now Ploc.from_file
loc_name [Stdpp]
Use now Ploc.name
loc_of_class_expr [MLast]
loc_of_class_sig_item [MLast]
loc_of_class_str_item [MLast]
loc_of_class_type [MLast]
loc_of_ctyp [MLast]
loc_of_expr [MLast]
loc_of_module_expr [MLast]
loc_of_module_type [MLast]
loc_of_patt [MLast]
loc_of_sig_item [MLast]
loc_of_str_item [MLast]
loc_of_token_interval [Grammar]

M
make [Ploc]
Ploc.make line_nb bol_pos (bp, ep) creates a location starting at line number line_nb, where the position of the beginning of the line is bol_pos and between the positions bp (included) and ep excluded.
make [Eprinter]
Builds a printer.
make_lined_loc [Stdpp]
Use now Ploc.make
make_loc [Token]
make_loc [Stdpp]
Use now Ploc.make_unlined
make_stream_and_location [Token]
Use now Plexing.make_stream_and_location
make_stream_and_location [Plexing]
General function
make_unlined [Ploc]
Ploc.make_unlined is like Ploc.make except that the line number is not provided (to be used e.g.
match_case [Pcaml]
mkloc [Ast2pt]
Convert a Camlp5 location into a OCaml location.
module_expr [Pcaml]
module_type [Pcaml]

N
name [Ploc]
Ploc.name.val is the name of the location variable used in grammars and in the predefined quotations for OCaml syntax trees.
name [Grammar.S.Entry]
name [Grammar.Entry]
next [Fstream]
nil [Fstream]
no_constructors_arity [Pcaml]
True: dont generate constructor arity.
no_constructors_arity [Ast2pt]
Flag to generate nodes telling that constructor arity is not taken into account in the AST (e.g.
no_quotations [Plexer]
When True, all lexers built by Plexer.gmake () do not lex the quotation syntax.

O
obj [Grammar.S.Entry]
obj [Grammar.Entry]
of_channel [Fstream]
of_entry [Grammar]
Return the grammar associated with an entry.
of_list [Fstream]
of_parser [Grammar.S.Entry]
of_parser [Grammar.Entry]
of_string [Fstream]
output_file [Pcaml]
The output file, stdout if None (default)

P
parsable [Grammar.S]
parsable [Grammar]
Type and value allowing to keep the same token stream between several calls of entries of the same grammar, to prevent possible loss of tokens.
parse [Grammar.S.Entry]
parse [Grammar.Entry]
parse_all [Grammar.Entry]
parse_implem [Pcaml]
Called when parsing an interface (mli file) or an implementation (ml file) to build the syntax tree; the returned list contains the phrases (signature items or structure items) and their locations; the boolean tells that the parser has encountered a directive; in this case, since the directive may change the syntax, the parsing stops, the directive is evaluated, and this function is called again.
parse_interf [Pcaml]
parse_parsable [Grammar.Entry]
parse_token [Grammar.S.Entry]
parse_token [Grammar.Entry]
parse_top_symb [Grammar]
patt [Pcaml]
phrase [Ast2pt]
phrase sil return the OCaml equivalent AST of a toplevel phrase.
plist [Prtools]
paragraph list plist elem sh pc el returns the pretty printed string of a list of elements with separators.
plistb [Prtools]
paragraph list with possible cut already after the beginner plist elem sh pc el returns the pretty printed string of the list of elements, like with plist but the value of pc.bef corresponds to an element already printed, as it were on the list.
plistbf [Prtools]
plistbf sh pc fl acts like plistb except that the list is a list of functions returning the pretty printed string.
plistf [Prtools]
plistf sh pc fl acts like plist except that the list is a list of functions returning the pretty printed string.
plistl [Prtools]
paragraph list with a different function for the last element
poly_variant [Pcaml]
pr_class_expr [Pcaml]
Some printers, set by pr_dump.cmo, pr_o.cmo and pr_r.cmo.
pr_class_sig_item [Pcaml]
pr_class_str_item [Pcaml]
pr_class_type [Pcaml]
pr_ctyp [Pcaml]
pr_expr [Pcaml]
pr_expr_fun_args [Pcaml]
pr_module_expr [Pcaml]
pr_module_type [Pcaml]
pr_patt [Pcaml]
pr_sig_item [Pcaml]
pr_str_item [Pcaml]
print [Extfun]
Print patterns in the order they are recorded
print [Grammar.S.Entry]
print [Grammar.Entry]
print [Eprinter]
Print printer patterns, in the order they are recorded, for debugging purposes.
print_entry [Grammar]
General printer for all kinds of entries (obj entries)
print_implem [Pcaml]
print_interf [Pcaml]

Q
quotation_dump_file [Pcaml]
quotation_dump_file optionally tells the compiler to dump the result of an expander (of kind "generating a string") if this result is syntactically incorrect.
quotation_location [Pcaml]
while expanding a quotation, returns the location of the quotation text (between the quotation quotes) in the source; raises Failure if not in the context of a quotation expander.

R
raise [Ploc]
Ploc.raise loc e, if e is already the exception Ploc.Exc, re-raise it (ignoring the new location loc), else raise the exception Ploc.Exc loc e.
raise_with_loc [Stdpp]
Use now Ploc.raise
reinit_entry_functions [Grammar]
restore_lexing_info [Token]
Use now Plexing.restore_lexing_info
restore_lexing_info [Plexing]

S
set_algorithm [Grammar.S]
set_algorithm [Grammar]
Set the parsing algorithm for all entries of a given grammar.
set_comm_min_pos [Prtools]
Set the minimum position of the source where comments can be found, (to prevent possible duplication of comments).
sfold0 [Extfold]
sfold0sep [Extfold]
sfold1 [Extfold]
sfold1sep [Extfold]
shift [Ploc]
Ploc.shift sh loc returns the location loc shifted with sh characters.
shift_loc [Stdpp]
Use now Ploc.shift
sig_item [Pcaml]
skip_item [Grammar]
Grammar.skip_item x can be called in a semantic action of a grammar rule to ask the grammar to skip that item if it is called in a list (LIST0 or LIST1).
slist0 [Extfold]
slist0sep [Extfold]
slist1 [Extfold]
slist1sep [Extfold]
sopt [Extfold]
source [Prtools]
The initial source string, which must be set by the pretty printing kit.
specific_space_dot [Plexer]
When False (default), the next call to Plexer.gmake () returns a lexer where there is no difference between dots which have spaces before and dots which don't have spaces before.
sprint_break [Pprintf]
sprint_break nspaces offset pc f g concat the two strings returned by f and g, either in one line, if it holds without overflowing (see module Pretty), with nspaces spaces betwen them, or in two lines with offset spaces added in the indentation for the second line.
sprint_break_all [Pprintf]
sprint_break_all force_newlines pc f fl concat all strings returned by the list with separators f-fl, the separators being the number of spaces and the offset like in the function sprint_break.
sprintf [Pretty]
sprintf fmt ... formats some string like Printf.sprintf does, except that, if it is called in the context of the *first* function of horiz_vertic above, it checks whether the resulting string has chances to fit in the line.
srules [Gramext]
str_item [Pcaml]
strict_mode [Pcaml]
strict_parsing [Grammar]
Flag to apply strict parsing, without trying to recover errors; default = False
sub [Ploc]
Ploc.sub loc sh len is the location loc shifted with sh characters and with length len.
sub_loc [Stdpp]
Use now Ploc.sub
symb_failed_txt [Grammar]
syntax_name [Pcaml]

T
tab [Prtools]
tokens [Grammar.S]
tokens [Grammar]
Given a grammar and a token pattern constructor, returns the list of the corresponding values currently used in all entries of this grammar.
top_phrase [Pcaml]
translate [Quotation]
function translating quotation names; default = identity
type_declaration [Pcaml]

U
unvala [Pcaml]
use_file [Pcaml]

V
vala_map [Pcaml]
vala_mapa [Pcaml]
version [Pcaml]
The current version of Camlp5.
vlist [Prtools]
vertical list vlist elem pc e returns the vertically pretty printed string of a list of elements; elements are separated with newlines and indentations.
vlist2 [Prtools]
vertical list with different function from 2nd element on.
vlist3 [Prtools]
vertical list with different function from 2nd element on, the boolean value being True if it is the last element of the list.
vlistf [Prtools]
vlistf pc fl acts like vlist except that the list is a list of functions returning the pretty printed string.
vlistl [Prtools]
vertical list with different function for the last element

W
warning_verbose [Gramext]
warning_verbose [Grammar]
Flag for displaying warnings while extension; default = True
with_constr [Pcaml]