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 Dependency

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

Authors

Maintainers

L

louis.gesbert@ocamlpro.com

Sources

1.3.2.tar.gz

md5=8ade4807d4ed12b824fc060de06c7c1b

sha512=40c8609100dc733b49ba09fb2f6d647fcf9e943d1b97551fef8daae79cdb215c37a12f93e1b19f8ac3f4624b324bc128f88967c40e27555c0dbfd93ba23c0eef

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 from_dot_merlin : string -> env list

From a directory name, look for a .merlin file and check for open flags in it

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