package sturgeon

  1. Overview
  2. Docs

Module Sturgeon_stuiSource

An API to interconnect Sturgeon and Inuit.

Sourcetype flag = [
  1. | `Clickable
  2. | `Clicked
  3. | `Editable
  4. | `Prompt
  5. | `Focus
  6. | `Custom of string * Sturgeon_sexp.basic
]

Set of flags recognized by Sturgeon interface.

Sourcetype shell

A buffer shell is the abstract object representing the connection to the user-interface display. Through a shell, you can create one or more buffers.

TODO:

  • bind message function from emacs for reporting information
Sourceval buffer_greetings : unit -> Sturgeon_session.t * shell

buffer_greetings provide you with a session and a shell. Send the session as a greetings to emacs instance and the shell will open and display buffers in this instance.

Sourceval message : shell -> string -> unit
Sourcetype buffer
Sourceval create_buffer : shell -> name:string -> buffer

Create patch socket (low-level) from a shell.

Sourceval open_cursor : buffer -> flag Inuit.cursor
Sourceval manual_connect : buffer -> flag Inuit.patch Inuit.socket -> unit
Sourceval create_cursor : shell -> name:string -> flag Inuit.cursor

Create cursor ready to output in a buffer.

Auxiliary interactions

Sourcetype 'a menu = string * [ `Item of 'a | `Sub of 'a menu list ]
Sourceval popup_menu : shell -> string -> 'a menu list -> 'a Sturgeon_session.cont -> unit
Sourceval read_file_name : shell -> prompt:string -> ?dir:string -> ?default:string -> string Sturgeon_session.cont -> unit
Sourceval fit_to_window : buffer -> unit
Sourceval split : buffer -> name:string -> [ `Left | `Right | `Top | `Bottom ] -> buffer