Immutable rope.

Alias for type Rope.t

Raised by various functions to indicate out-of-bounds access. The string argument is the name of the function that raised it.

The empty rope.

of_string s creates a rope from the string s.

of_substring s start len create a rope from the substring s.[start .. start+len-1].

• raises Invalid_argument

  if start and len do not designate a valid sbstring of s.

of_char c returns a rope consisting of the unique character c. It may be useful to append a char to a given rope.

make len c returns a rope of length len filled with c.

init len f returns a rope of length len with entry of index i filled with f i.

to_string r return a string with the same content as the rope.

• raises Failure

  if the rope is too long to fit into a string.

is_empty r tells whether the rope r is empty.

length r returns the length of the rope. O(1) time.

get r i returns the ith char of the rope. Takes O(log(length r)).

sub r i start len returns the sub-rope consisting of characters from position start to start+len-1 (included) of the rope r. O(log(length r)) time.

• raises Invalid_argument

  if i < 0, len < 0 or i + len > Rope.length r.

blit src srcoff dst dstoff len copies len bytes from the rope src starting at index srcoff, to sequence dst, starting at index dstoff.

concat2 r1 r2 concatenates the ropes r1 and r2.

concat sep rl concatenates the list of ropes rl, inserting the separator string sep between each.

iter f r execute f c for c going through every character of rope r from left to right.

iter f r execute f i c for c going through every character of rope r from left to right and i the index of c.

map f r applies function f in turn to all the characters of r (in increasing index order) and stores the results in a new string that is returned.

Same as map but the function f is passed the index i of the char.

Return a copy of the argument, without leading and trailing whitespace. The characters regarded as whitespace are: ' ', '\012', '\n', '\r', and '\t'.

Return a copy of the argument, with special characters represented by escape sequences, following the lexical conventions of Objective Caml.

index r c returns the position of the leftmost occurrence of character c in rope r.

• raises Not_found

  if c does not occur in r.

index r c returns Some i where i is the position of the leftmost occurrence of character c in rope r and None if c does not occur in r.

rindex r c returns the position of the rightmost occurrence of character c in rope r.

• raises Not_found

  if c does not occur in r.

rindex_opt r c returns Some i where i is the position of the rightmost occurrence of character c in rope r or None if c does not occur in r.

Same as Rope.index, but start searching at the character position given as second argument. Rope.index r c is equivalent to Rope.index_from r 0 c.

Same as Rope.index_opt, but start searching at the character position given as second argument. Rope.index_opt r c is equivalent to Rope.index_from_opt r 0 c.

Same as Rope.rindex, but start searching at the character position given as second argument. Rope.rindex r c is equivalent to Rope.rindex_from s (Rope.length r - 1) c.

Same as Rope.rindex_opt, but start searching at the character position given as second argument. Rope.rindex_opt r c is equivalent to Rope.rindex_from_opt s (Rope.length r - 1) c.

contains r c tests if character c appears in the rope r.

contains_from r start c tests if character c appears in the subrope of r starting from start to the end of s.

• raises Invalid_argument

  if start is not a valid index of r.

rcontains_from r stop c tests if character c appears in the subrope of r starting from the beginning of r to index stop.

• raises Invalid_argument

  if stop is not a valid index of r.

search_forward_string p is a search function that, given a rope r and a start index i0, will return the position of p in r or raise Not_found if no occurrence of p in r exists. let search = search_forward_string p takes O(length p) and search r i0 takes O(length r - i0).

Return the argument with all lowercase letters translated to uppercase, including accented letters of the ISO Latin-1 (8859-1) character set.

Return the argument with all uppercase letters translated to lowercase, including accented letters of the ISO Latin-1 (8859-1) character set.

Return the argument, with the first character set to uppercase.

Return the argument with the first character set to lowercase.

• deprecated

  Use Rope.uppercase_ascii.

• deprecated

  Use Rope.lowercase_ascii.

• deprecated

  Use Rope.capitalize_ascii.

• deprecated

  Use Rope.uncapitalize_ascii.

The comparison function for ropes, with the same specification as Pervasives.compare. Along with the type t, this function compare allows the module Rope to be passed as argument to the functors Set.Make and Map.Make.

equal r1 r2 tells whether the two ropes r1 and r2 are equal. (It is equivalent to compare r1 r2 = 0, just slightly faster.)

Read characters from the given input channel, until a newline character is encountered. Return the rope of all characters read, without the newline character at the end.

• raises End_of_file

  if the end of the file is reached at the beginning of line.

Flush standard output, then read characters from standard input until a newline character is encountered. Return the rope of all characters read, without the newline character at the end.

Print a rope on standard output.

Print a rope, followed by a newline character, on standard output and flush standard output.

Print a rope on standard error.

Print a rope, followed by a newline character on standard error and flush standard error.

output_rope oc r outputs the rope r to the output channel oc. May also be used with a %a directive of printf.

Alias for Rope.output_rope to be a drop in replacement for strings.

balance r return a balanced copy of the rope r. Implicit rebalancing is done by some of the above functions to avoid gross inefficiencies but you may want to call this function explicitely to try to improve your running times.

depth r returns the depth of the rope r. This information may be useful to decide whether you want to re-balance.

The rope will be rebalanced by some functions it its height is greater or equal to rebalancing_height.

Iterators for ropes. It is more efficient to use an iterator to perform small steps and get the characters than to use Rope.get repeatedly.

This is similar to the Buffer module in the standard library except that it constructs ropes. It is recommended to use this module instead of repeatedly concatenating chars.

Toploop printer and its configuration.