Up

module Protocol

: sig
#
type position = Std.Lexing.position
#
type cursor_state = {
# cursor
: position;
# marker
: bool;
}
#
type completion = {
# name
: string;
# kind
: [
| `Value
| `Constructor
| `Label
| `Module
| `Modtype
| `Type
| `MethodCall
]		;
# desc
: string;
# info
: string;
}
#
type outline = item list
#
type item = {
# outline_name
: string;
# outline_kind
: [
| `Value
| `Constructor
| `Label
| `Module
| `Modtype
| `Type
| `Exn
]		;
# pos
: position;
# children
: outline;
}
#
type is_tail_position = [
| `No
| `Tail_position
| `Tail_call
]
#
type _ request =
# | Tell : [
| `Start of position option
| `Source of string
| `File of string
| `Eof
| `Marker
] -> cursor_state request
# | Type_expr : string * position option -> string request
# | Type_enclosing : (string * int) option * position -> (Location.t * string * is_tail_position) list request
# | Enclosing : position -> Location.t list request
# | Complete_prefix : string * position -> completion list request
# | Expand_prefix : string * position -> completion list request
# | Locate : string option * [
| `ML
| `MLI
] * position option -> [
| `Found of string option * Std.Lexing.position
| `Not_in_env of string
| `File_not_found of string
| `Not_found of string * string option
| `At_origin
] request
# | Case_analysis : Location.t -> (Location.t * string) request
# | Outline : outline request
# | Seek : [
| `Marker
| `Position
| `End
| `Before of position
| `Exact of position
] -> cursor_state request
# | Boundary : [
| `Prev
| `Next
| `Current
] * position -> Location.t option request
# | Reset : [
| `ML
| `MLI
| `Auto
] * string option -> cursor_state request
# | Refresh : unit request
# | Errors : Error_report.t list request
# | Dump : [
| `Env of [
| `Normal
| `Full
] * position option
| `Sig
| `Parser
| `Exn
| `Browse
| `Recover
| `Typer_input
| `Tokens
] -> Std.Json.json request
# | Which_path : string list -> string request
# | Which_with_ext : string list -> string list request
# | Flags : [
| `Add of string list
| `Clear
] -> [
| `Ok
| `Failures of (string * exn) list
] request
# | Findlib_use : string list -> [
| `Ok
| `Failures of (string * exn) list
] request
# | Findlib_list : string list request
# | Extension_list : [
| `All
| `Enabled
| `Disabled
] -> string list request
# | Extension_set : [
| `Enabled
| `Disabled
] * string list -> [
| `Ok
| `Failures of (string * exn) list
] request
# | Path : [
| `Build
| `Source
] * [
| `Add
| `Rem
] * string list -> unit request
# | Path_reset : unit request
# | Path_list : [
| `Build
| `Source
] -> string list request
# | Project_get : (string list * [
| `Ok
| `Failures of (string * exn) list
]) request
# | Occurrences : [
| `Ident_at of position
] -> Location.t list request
# | Version : string request
#
type a_request =
# | Request : 'a request -> a_request
#
type response =
# | Return : 'a request * 'a -> response
# | Failure : string -> response
# | Error : Std.Json.json -> response
# | Exception : exn -> response
end