package zed

  1. Overview
  2. Docs
Abstract engine for text edition in OCaml

Install

Dune Dependency

Authors

Maintainers

Sources

1.5.tar.gz
md5=a68d8a3fca3331b87e93ceb35483f09d

Description

Zed is an abstract engine for text edition. It can be used to write text editors, edition widgets, readlines, ...

Zed uses Camomile to fully support the Unicode specification, and implements an UTF-8 encoded string type with validation, and a rope datastructure to achieve efficient operations on large Unicode buffers. Zed also features a regular expression search on ropes.

To support efficient text edition capabilities, Zed provides macro recording and cursor management facilities.

Published: 27 Apr 2017

README

Zed

Zed is an abstract engine for text edition. It can be used to write text editors, edition widgets, readlines, ... You just have to connect an engine to your inputs and rendering functions to get an editor.

Zed provides:

  • edition state management,

  • multiple cursor support,

  • key-binding helpers,

  • general purpose unicode rope manipulation functions.

Dependencies

For building the development version, you also need to install oasis (>= 0.3.0).

Installation

To build and install zed:

$ ./configure
$ make
$ make install

Documentation (optional)

To build the documentation:

$ make doc

It will then be installed by make install.

Tests (optionnal)

To build and execute tests:

$ ./configure --enable-tests
$ make test

Modules

  • Zed_edit: the main module, it defines edition engines.

  • Zed_cursor: manages cursors. Cursors are automatically updated when the text is modified.

  • Zed_lines: maintains the offsets of beginning of lines.

  • Zed_input: helpers for implementing key bindings.

  • Zed_macro: helpers for writing macro systems.

  • Zed_utf8: general purpose UTF-8 strings manipulation.

  • Zed_rope: general purpose unicode ropes manipulation.

Dependencies (5)

  1. react
  2. camomile >= "0.8" & < "2.0.0"
  3. base-bytes
  4. jbuilder >= "1.0+beta7"
  5. ocaml >= "4.02.3" & < "4.06.0"

Dev Dependencies

None

Used by (2)

  1. lambda-term < "2.0"
  2. utop < "1.4.0"

Conflicts

None

OCaml

Innovation. Community. Security.