Index of values


A
action_of_name [Zed_edit]
action_of_name str converts the given action name into an action.
actions [Zed_edit]
List of actions with their names, except Insert.
add [Zed_macro]
add recorder x adds x to the recorder if it is recording a macro.
add [Zed_input.S]
add events x bindings binds events to x.
add [Zed_rope.Buffer]
add buffer x add x at the end of buffer.
add [Zed_utf8]
add buf ch is the same as Buffer.add_string buf (singleton ch) but is more efficient.
add_counter [Zed_macro]
Adds the given value to the macro counter.
add_escaped [Zed_utf8]
add_escaped_char buf text is the same as Buffer.add_string buf (escaped text) but a bit more efficient.
add_escaped_char [Zed_utf8]
add_escaped_char buf ch is the same as Buffer.add_string buf (escaped_char ch) but a bit more efficient.
add_escaped_string [Zed_utf8]
add_escaped_char buf enc text is the same as Buffer.add_string buf (escaped_string enc text) but a bit more efficient.
after [Zed_rope]
after rope pos returns the sub-string after pos in rope.
after [Zed_utf8]
after str pos returns the sub-string after pos in str
append [Zed_lines]
append s1 s2 concatenates two sets of line positions.
append [Zed_rope]
Concatenates the two given ropes.
at_bol [Zed_edit]
at_bol ctx returns true iff the cursor is at the beginning of the current line.
at_bos [Zed_rope.Zip]
at_bos zipper returns true iff zipper points to the beginning of the rope.
at_bot [Zed_edit]
at_bot ctx returns true iff the cursor is at the beginning of the text.
at_eol [Zed_edit]
at_eol ctx returns true iff the cursor is at the end of the current line.
at_eos [Zed_rope.Zip]
at_eos zipper returns true iff zipper points to the end of the rope.
at_eot [Zed_edit]
at_eot ctx returns true iff the cursor is at the end of the text.

B
before [Zed_rope]
before rope pos returns the sub-rope before pos in rope.
before [Zed_utf8]
before str pos returns the sub-string before pos in str
bindings [Zed_input.S]
bindings set returns all bindings of set.
break [Zed_rope]
break rope pos returns the sub-ropes before and after pos in rope.
break [Zed_utf8]
break str pos returns the sub-strings before and after pos in str.

C
cancel [Zed_macro]
Cancels the current macro if recording one.
capitalize_word [Zed_edit]
capitalize_word ctx capitalizes the first word after the cursor.
changes [Zed_edit]
changes edit returns an event which occurs with values of the form (start, added, removed) when the contents of the engine changes.
check [Zed_edit]
check ctx returns whether the context has been created with the check flag.
check [Zed_utf8]
check str checks that str is a valid UTF-8 encoded string.
clear_data [Zed_edit]
clear_data edit removes the custom data of engine.
column [Zed_cursor]
column cursor returns the signal holding the current column of the cursor.
column [Zed_edit]
column ctx returns the column of the cursor.
compare [Zed_rope]
Compares two ropes (in code point order).
compare [Zed_utf8]
Compares two strings (in code point order).
compile [Zed_re]
compile regexp compiles the given regular expression.
concat [Zed_rope]
concat sep l concatenates all strings of l separating them by sep.
concat [Zed_utf8]
concat sep l returns the concatenation of all strings of l separated by sep.
contains [Zed_utf8]
contains text sub returns whether sub appears in text
contents [Zed_macro]
Returns the currently recorded macro.
contents [Zed_rope.Buffer]
contents buffer returns the contents of buffer as a rope.
context [Zed_edit]
context ?check edit cursor creates a new context with given parameters.
coordinates [Zed_cursor]
coordinates cursor returns the signal holding the current line & column of the cursor.
copy [Zed_cursor]
copy cursor creates a copy of the given cursor.
copy [Zed_edit]
copy ctx copies the current selectionned region to the clipboard.
count [Zed_macro]
The number of actions in the macro recorder.
count [Zed_lines]
Returns the number of newlines in the set.
count [Zed_utf8]
count f text returhs the number of characters of text verifying f.
counter [Zed_macro]
The contents of the macro counter.
create [Zed_macro]
create macro create a new macro recorder, with initial contents macro.
create [Zed_cursor]
create length changes get_lines position wanted_column creates a new cursor pointing to position position.
create [Zed_edit]
create ?editable ?move ?clipboard () creates a new edition engine in the initial state.
create [Zed_rope.Buffer]
Create a new empty buffer.
cursor [Zed_edit]
cursor ctx returns the cursor used by this context.

D
delete_next_char [Zed_edit]
delete_next_char ctx deletes the character after the cursor, if any.
delete_next_line [Zed_edit]
delete_next_line ctx delete everything until the end of the current line.
delete_next_word [Zed_edit]
delete_next_word ctx deletes the word after the cursor.
delete_prev_char [Zed_edit]
delete_prev_char ctx delete the character before the cursor.
delete_prev_line [Zed_edit]
delete_next_line ctx delete everything until the beginning of the current line.
delete_prev_word [Zed_edit]
delete_prev_word ctx deletes the word before the cursor.
doc_of_action [Zed_edit]
doc_of_action action returns a short description of the action.

E
edit [Zed_edit]
edit ctx returns the edition engine used by the given context.
empty [Zed_input.S]
The empty set of bindings.
empty [Zed_lines]
The empty set.
empty [Zed_rope]
The empty rope.
ends_with [Zed_utf8]
ends_with text suffix returns true iff s ends with suffix.
equal [Zed_rope]
equal r1 r2 retuns true iff r1 is equal to r2.
erase_mode [Zed_edit]
erase_mode edit returns the ``erase'' mode of the buffer.
escaped [Zed_utf8]
escaped text escape all characters of text as with escape_char.
escaped_char [Zed_utf8]
escaped_char ch returns a string containg ch or an escaped version of ch if: ch is a control character (code < 32), ch is the character with code 127, ch is a non-ascii, non-alphabetic character It uses the syntax \xXX, \uXXXX, \UXXXXXX or a specific escape sequence \n, \r, ....
escaped_string [Zed_utf8]
escaped_string enc str escape the string str which is encoded with encoding enc.
exists [Zed_utf8]
exists f text returns whether at least one character of text verify f.
explode [Zed_utf8]
explode str returns the list of all characters of str.
extract [Zed_utf8]
extract str ofs returns the code-point at offset ofs in str.
extract_next [Zed_utf8]
extract_next str ofs returns the code-point at offset ofs in str and the offset the next character.
extract_prev [Zed_utf8]
extract_prev str ofs returns the code-point at the previous offset in str and this offset.

F
filter [Zed_utf8]
filter f str filters characters of str with f.
filter_map [Zed_utf8]
filter_map f str filters and maps characters of str with f.
filter_map_concat [Zed_utf8]
filter_map f str filters and maps characters of str with f and concatenate the result.
find_b [Zed_rope.Zip]
find_b f zip search backward for a character to satisfy f.
find_f [Zed_rope.Zip]
find_f f zip search forward for a character to satisfy f.
fold [Zed_input.S]
fold f set acc executes f on all sequence of set, accumulating a value.
fold [Zed_rope]
fold f rope acc applies f on all characters of rope starting from the left, accumulating a value.
fold [Zed_utf8]
fold f str acc applies f on all characters of str starting from the left, accumulating a value.
fold_leaf [Zed_rope]
fold f rope acc applies f on all leaves of rope starting from the left, accumulating a value.
for_all [Zed_utf8]
for_all f text returns whether all characters of text verify the predicate f.

G
get [Zed_rope]
get str rope returns the character at index idx in rope.
get [Zed_utf8]
get str idx returns the character at index idx in str.
get_action [Zed_edit]
get_action action returns the function associated to the given action.
get_column [Zed_cursor]
get_column cursor returns the current column of the cursor.
get_coordinates [Zed_cursor]
get_coordinates cursor returns the current line & column of the cursor.
get_count [Zed_macro]
Returns the current number of actions in the macro recorder.
get_counter [Zed_macro]
Gets the contents of the macro counter.
get_data [Zed_edit]
get_data edit returns the custom data attached to the engine.
get_erase_mode [Zed_edit]
erase_mode edit returns the current erase mode of the buffer.
get_line [Zed_cursor]
get_line cursor returns the current line of the cursor.
get_line [Zed_edit]
get_line edit n returns the rope corresponding to the nth line without the newline character.
get_position [Zed_cursor]
get_position cursor returns the current position of cursor.
get_recording [Zed_macro]
Returns the current state of the recorder.
get_selection [Zed_edit]
selection edit returns the current selection state.
get_wanted_column [Zed_cursor]
get_wanted_column cursor returns the column on which the cursor wants to be.
goto [Zed_cursor]
goto cursor position moves the given cursor to the given position.
goto [Zed_edit]
goto ctx ?set_column position moves the cursor to the given position.
goto_bol [Zed_edit]
goto_bol ctx moves the cursor to the beginning of the current line.
goto_bot [Zed_edit]
goto_bot ctx moves the cursor to the beginning of the text.
goto_eol [Zed_edit]
goto_eol ctx moves the cursor to the end of the current line.
goto_eot [Zed_edit]
goto_eot ctx moves the cursor to the end of the text.
goto_mark [Zed_edit]
goto_mark ctx moves the cursor to the mark.

I
implode [Zed_utf8]
implode l returns the concatenation of all characters of l.
init [Zed_rope]
init n f returns the contenation of singleton (f 0), singleton (f 1), ..., singleton (f (n - 1)).
init [Zed_utf8]
init n f returns the contenation of singleton (f 0), singleton (f 1), ..., singleton (f (n - 1)).
insert [Zed_lines]
insert set offset set' inserts set at given positon in set'.
insert [Zed_edit]
insert ctx rope inserts the given rope at current position.
insert [Zed_rope]
insert rope pos sub inserts sub in rope at position pos.
insert [Zed_utf8]
insert str pos sub inserts sub in str at position pos.
insert_no_erase [Zed_edit]
insert ctx rope inserts the given rope at current position but do not erase text if the buffer is currently in erase mode.
is_empty [Zed_rope]
is_empty rope returns whether str is the empty rope or not.
iter [Zed_rope]
iter f rope applies f on all characters of rope starting from the left.
iter [Zed_utf8]
iter f str applies f an all characters of str starting from the left.
iter_leaf [Zed_rope]
iter_leaf f rope applies f on all leaves of rope starting from the left.

K
kill [Zed_edit]
kill ctx copies the current selectionned region to the clipboard and remove it.
kill_next_line [Zed_edit]
kill_next_line ctx delete everything until the end of the current line and save it to the clipboard.
kill_next_word [Zed_edit]
kill_next_word ctx deletes the word after the cursor and save it to the clipboard.
kill_prev_line [Zed_edit]
kill_next_line ctx delete everything until the beginning of the current line and save it to the clipboard.
kill_prev_word [Zed_edit]
kill_prev_word ctx deletes the word before the cursor and save it to the clipboard.

L
lchop [Zed_rope]
lchop rope returns rope without is first character.
lchop [Zed_utf8]
lchop t returns t without is first character.
length [Zed_lines]
Returns the length of the set, i.e.
length [Zed_rope]
Returns the length of the given rope.
length [Zed_utf8]
Returns the length of the given string.
line [Zed_cursor]
line cursor returns the signal holding the current line on which the cursor is.
line [Zed_edit]
line ctx returns the line of the cursor.
line_index [Zed_lines]
line_index set ofs returns the line number of the line containing ofs.
line_length [Zed_lines]
line_length set idx returns the length of the idxth line of set .
line_start [Zed_lines]
line_start set idx returns the offset of the beginning of the idxth line of set .
line_stop [Zed_lines]
line_stop set idx returns the offset of the end of the idxth line of set .
lines [Zed_edit]
lines edit returns the set of line position of text edit.
lowercase_word [Zed_edit]
lowercase_word ctx converts the first word after the cursor to lowercase.
lstrip [Zed_utf8]
lstrip ?predicate text is the same as Zed_utf8.strip but it only removes characters at the left of text.

M
make [Zed_rope]
make length char creates a rope of length length containing only char.
make [Zed_utf8]
make n ch creates a string of length n filled with ch.
make_b [Zed_rope.Zip]
make_f rope pos creates a new zipper pointing to positon length rope - pos of rope.
make_f [Zed_rope.Zip]
make_f rope pos creates a new zipper pointing to positon pos of rope.
map [Zed_rope]
map f rope maps all characters of rope with f.
map [Zed_utf8]
map f str maps all characters of str with f.
map_concat [Zed_utf8]
map f str maps all characters of str with f and concatenate the result.
mark [Zed_edit]
mark edit returns the cursor used to for the mark in the given engine.
match_by_regexp [Zed_edit]
match_by_regexp re creates a word-matching function using a regular expression.
move [Zed_cursor]
move cursor delta moves the given cursor by the given number of characters.
move [Zed_edit]
move ctx ?set_wanted_column delta moves the cursor by the given number of characters.
move [Zed_rope.Zip]
move n zip moves the zipper by n characters.
move_line [Zed_edit]
move_line ctx ?set_wanted_column delta moves the cursor by the given number of lines.

N
name_of_action [Zed_edit]
name_of_action act returns the name of the given action.
new_clipboard [Zed_edit]
new_clipboard () creates a new clipboard using a reference.
new_cursor [Zed_edit]
new_cursor edit creates a new cursor for the given edition engine.
newline [Zed_edit]
Insert a newline character.
next [Zed_rope.Zip]
next zipper returns the code point at the right of the zipper and a zipper to the next position.
next [Zed_utf8]
next str ofs returns the offset of the next character in str.
next_char [Zed_edit]
next_char ctx moves the cursor to the next character.
next_error [Zed_utf8]
next_error str ofs returns (ofs', count, msg) where ofs' is the offset of the start of the first invalid sequence after ofs (inclusive) in str, count is the number of unicode character between ofs and ofs' (exclusive) and msg is an error message.
next_line [Zed_edit]
next_line ctx moves the cursor to the next line.
next_word [Zed_edit]
next_word ctx moves the cursor to the end of the next word.

O
of_rope [Zed_lines]
of_rope rope returns the set of newline positions in rope.
of_string [Zed_rope]
of_string str creates a rope from a string.
offset [Zed_rope.Zip]
Returns the position of the zipper in the rope.

P
pack [Zed_input.S]
pack f set creates a pack.
position [Zed_cursor]
position cursor returns the signal holding the current position of the given cursor.
position [Zed_edit]
position ctx returns the position of the cursor.
prev [Zed_rope.Zip]
prev zipper returns the code point at the left of the zipper and a zipper to the previous position.
prev [Zed_utf8]
prev str ofs returns the offset of the previous character in str.
prev_char [Zed_edit]
prev_char ctx moves the cursor to the previous character.
prev_line [Zed_edit]
prev_line ctx moves the cursor to the previous line.
prev_word [Zed_edit]
prev_word ctx moves the cursor to the beginning of the previous word.

R
rchop [Zed_rope]
rchop rope returns rope without is last character.
rchop [Zed_utf8]
rchop t returns t without is last character.
recording [Zed_macro]
Whether the recorder is recording a macro.
regexp_match [Zed_re]
regexp_match ?sem regexp rope pos tries to match regexp on given rope, starting at pos.
remove [Zed_input.S]
remove events bindings unbinds events.
remove [Zed_lines]
remove set offet length removes length characters at offset in set.
remove [Zed_edit]
remove [Zed_rope]
remove rope pos len removes the len characters at position pos in rope
remove [Zed_utf8]
remove str pos len removes the len characters at position pos in str
remove_next [Zed_edit]
remove_next ctx n removes n characters at current position.
remove_prev [Zed_edit]
remove_prev ctx n removes n characters before current position.
replace [Zed_lines]
replace set offset length repl replaces the subset at offset offset and length length by repl in set.
replace [Zed_edit]
replace ctx n rope does the same as:
replace [Zed_rope]
replace rope pos len repl replaces the len characters at position pos in rope by repl.
replace [Zed_utf8]
replace str pos len repl replaces the len characters at position pos in str by repl.
reset [Zed_rope.Buffer]
reset buffer resets buffer to its initial state.
resolve [Zed_input.S]
resolve event resolver tries to resolve event using resolver.
resolver [Zed_input.S]
resolver packs creates a resolver from a list of pack.
rev [Zed_utf8]
rev str reverses all characters of str.
rev_concat [Zed_utf8]
concat sep l returns the concatenation of all strings of l in reverse order separated by sep.
rev_explode [Zed_utf8]
rev_explode str returns the list of all characters of str in reverse order.
rev_filter [Zed_utf8]
rev_filter f str filters characters of str with f in reverse order.
rev_filter_map [Zed_utf8]
rev_filter_map f str filters and maps characters of str with f in reverse order.
rev_filter_map_concat [Zed_utf8]
rev_filter_map f str filters and maps characters of str with f in reverse order and concatenate the result.
rev_fold [Zed_rope]
rev_fold f rope acc applies f on all characters of rope starting from the right, accumulating a value.
rev_fold [Zed_utf8]
rev_fold f str acc applies f on all characters of str starting from the right, accumulating a value.
rev_fold_leaf [Zed_rope]
rev_fold f rope acc applies f on all leaves of rope starting from the right, accumulating a value.
rev_implode [Zed_utf8]
rev_implode l is the same as implode (List.rev l) but more efficient.
rev_init [Zed_rope]
rev_init n f returns the contenation of singleton (f (n - 1)), ..., singleton (f 1), singleton (f 0).
rev_init [Zed_utf8]
rev_init n f returns the contenation of singleton (f (n - 1)), ..., singleton (f 1), singleton (f 0).
rev_iter [Zed_rope]
rev_iter f rope applies f an all characters of rope starting from the right.
rev_iter [Zed_utf8]
rev_iter f str applies f an all characters of str starting from the right.
rev_iter_leaf [Zed_rope]
iter_leaf f rope applies f on all leaves of rope starting from the right.
rev_map [Zed_rope]
rev_map f str maps all characters of rope with f in reverse order.
rev_map [Zed_utf8]
rev_map f str maps all characters of str with f in reverse order.
rev_map_concat [Zed_utf8]
rev_map f str maps all characters of str with f in reverse order and concatenate the result.
rstrip [Zed_utf8]
lstrip ?predicate text is the same as Zed_utf8.strip but it only removes characters at the right of text.

S
search_backward [Zed_re]
search_backward ?sem regexp rope pos searches the given regular expression in rope starting at pos, in reverse order.
search_forward [Zed_re]
search_forward ?sem regexp rope pos searches the given regular expression in rope starting at pos.
selection [Zed_edit]
selection edit returns the signal holding the current selection state.
set_counter [Zed_macro]
Sets the macro counter to the given value.
set_data [Zed_edit]
set_data edit data attach data to the engine.
set_erase_mode [Zed_edit]
set_erase_mode edit state sets the status of the erase mode for the given engine.
set_mark [Zed_edit]
set_mark ctx sets the mark at current position.
set_recording [Zed_macro]
Starts or stops the macro recorder.
set_selection [Zed_edit]
set_selection edit state sets the selection state.
set_wanted_column [Zed_cursor]
set_wanted_column cursor sets the column on which the cursor want to be.
singleton [Zed_rope]
singleton ch creates a rope of length 1 containing only ch.
singleton [Zed_utf8]
singleton ch creates a string of length 1 containing only the given character.
slice [Zed_rope.Zip]
slice zipper1 zipper2 returns the rope between zipper1 and zipper2.
starts_with [Zed_utf8]
starts_with text prefix returns true iff s starts with prefix.
strip [Zed_utf8]
strip ?predicate text returns text without its firsts and lasts characters that match predicate.
sub [Zed_rope.Zip]
sub zipper len returns the sub-rope of length len pointed by zipper.
sub [Zed_rope]
sub rope ofs len Returns the sub-rope of rope starting at ofs and of length len.
sub [Zed_utf8]
sub str ofs len Returns the sub-string of str starting at ofs and of length len.
switch_erase_mode [Zed_edit]
switch_erase_mode ctx switch the current erase mode.

T
text [Zed_edit]
text edit returns the signal holding the current contents of the buffer.
to_string [Zed_rope]
to_string rope flatten a rope into a string encoded in UTF-8.

U
undo [Zed_edit]
undo ctx reverts the last performed action.
unsafe_extract [Zed_utf8]
unsafe_extract str ofs returns the code-point at offset ofs in str.
unsafe_extract_next [Zed_utf8]
unsafe_extract_next str ofs returns the code-point at offset ofs in str and the offset the next character.
unsafe_extract_prev [Zed_utf8]
unsafe_extract_prev str ofs returns the code-point at the previous offset in str and this offset.
unsafe_next [Zed_utf8]
unsafe_next str ofs returns the offset of the next character in str.
unsafe_prev [Zed_utf8]
unsafe_prev str ofs returns the offset of the previous character in str.
update [Zed_edit]
update edit cursors returns an event which occurs each the rendering of the engine should be updated.
uppercase_word [Zed_edit]
uppercase_word ctx converts the first word after the cursor to uppercase.

V
validate [Zed_utf8]
Same as check but raises an exception in case the argument is not a valid text, otherwise returns the length of the string.

W
wanted_column [Zed_cursor]
wanted_column cursor returns the signal holding the column on which the cursor wants to be.
with_check [Zed_edit]
with_check check ctx retuns ctx with the check flag set to check.

Y
yank [Zed_edit]
yank ctx inserts the contents of the clipboard at current position.