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.3.tar.gz

md5=738dd32765ce0b6b6423620cc62b7db9

sha512=6360240c951ac64baf9b3736c9a37c41a5ac8c5ddf52e723019fb5ef294e786e245712fd88f408bd8f6881d8741ab152872181062acd81443eec07d1d703e85a

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

Module `IndexScope`Source

Sourcetype t

Sourceval empty : t

The empty scope

Sourcetype env =

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

The type of gathered information within a scope

Sourceval from_dot_merlin : string -> env list

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

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

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

Sourceval read_string : string -> t

Compute the environment from a string

Source

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)

Source

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

Sourceval to_list : t -> env list

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