package ocp-index

You can search for identifiers within the package.

in-package search v0.2.0

Lightweight completion and documentation browsing for OCaml libraries

Install

dune-project

Dependency

www.typerex.org Readme Changelog Edit opam file Versions (14)

Authors

Maintainers

L

louis.gesbert@ocamlpro.com

Sources

1.2.1.tar.gz

md5=f5e0bba2b6bbdf5489f313e3c3dcdbec

sha512=82618bef74f00474dc909c01e4ba8f8e235fc420d99a1fe0bf6508745d3f0a75a0b0c25c43e89ae01aa7fb86eae667ff0e0498216881022f900d050541f7a8b5

doc/ocp-index.lib/IndexScope/index.html

Module `IndexScope`

type t

val empty : t

The empty scope

type env =

| Alias of string * string list
| Open of string list

The type of gathered information within a scope

val read : ?line:int -> ?column:int -> in_channel -> t

Compute the environment from an input channel, at an optional position or at EOF

val read_string : string -> t

Compute the environment from a string

val fold : 
  ('a -> t -> Approx_lexer.token -> (int * int * int) -> 'a) ->
  'a ->
  ?init:env list ->
  ?stop:(Lexing.position -> bool) ->
  in_channel ->
  'a

Lower-level function for processing on the environment at every token. The position is given in the form (line, column, length)

val fold_string : 
  ('a -> t -> Approx_lexer.token -> (int * int * int) -> 'a) ->
  'a ->
  ?init:env list ->
  ?stop:(Lexing.position -> bool) ->
  string ->
  'a

The same from a string

val to_list : t -> env list

Returns the env declarations in scope t, in source file order