package inquire

  1. Overview
  2. Docs
An OCaml library to create beautiful interactive CLIs

Install

Dune Dependency

Authors

Maintainers

Sources

inquire-0.2.1.tbz
sha256=0b88d89e24d4cbc0560a7c8d8ec51388990e1b27f24685029997afa52a7c720f
sha512=8b62860a8d15e41528a404a6f1b9968c3d79755607b5ea319af2e3e45516e672a785361d278279910928db4054e1800e87bcee0210ff3eabfb330713b368c827

doc/inquire.zed/Zed_rope/Zip_raw/index.html

Module Zed_rope.Zip_rawSource

Sourcetype t

Type of zippers. A zipper allow to naviguate in a rope in a convenient and efficient manner. Note that a zipper points to a position between two characters, not to a character, so in a rope of length len there is len + 1 positions.

Sourceval make_f : rope -> int -> t

make_f rope pos creates a new zipper pointing to raw positon pos of rope.

Sourceval make_b : rope -> int -> t

make_b rope pos creates a new zipper pointing to raw positon length rope - pos of rope.

Sourceval offset : t -> int

Returns the raw position of the zipper in the rope.

Sourceval next : t -> Uchar.t * t

next zipper returns the code point at the right of the zipper and a zipper to the next raw position. It raises Out_of_bounds if the zipper points to the end of the rope.

Sourceval prev : t -> Uchar.t * t

prev zipper returns the code point at the left of the zipper and a zipper to the previous raw position. It raises Out_of_bounds if the zipper points to the beginning of the rope.

Sourceval move : int -> t -> t

move n zip moves the zipper by n characters. If n is negative it is moved to the left and if it is positive it is moved to the right. It raises Out_of_bounds if the result is outside the bounds of the rope.

Sourceval at_bos : t -> bool

at_bos zipper returns true if zipper points to the beginning of the rope.

Sourceval at_eos : t -> bool

at_eos zipper returns true if zipper points to the end of the rope.

Sourceval find_f : (Uchar.t -> bool) -> t -> t

find_f f zip search forward for a character to satisfy f. It returns a zipper pointing to the left of the first character to satisfy f, or a zipper pointing to the end of the rope if no such character exists.

Sourceval find_b : (Uchar.t -> bool) -> t -> t

find_b f zip search backward for a character to satisfy f. It returns a zipper pointing to the right of the first character to satisfy f, or a zipper pointing to the beginning of the rope if no such character exists.

OCaml

Innovation. Community. Security.