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

md5=b1770f0fd784ff29173d5b4090ccff2c

sha512=32c800c404ae0f32a6cdb8f5f62bac56b23b017dd27674834e4d063df7d49bca272fc39ba2905b8404b5e3d1b154f1ffd2924705e34e1d1ac56242260b81a5c4

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