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 (15)

Authors

Maintainers

L

louis.gesbert@ocamlpro.com

Sources

ocp-index-1.4.1.tbz

sha256=59adbd99a9c88106dcf23bc0e3424a00f840fcedee4e4b644eaf0385ada3f911

sha512=53c9b83ee7c274bf1981de716081e4d7f603d2d4cc25c83a20d2f4c599d88d2200393feef54f4cdb25e014ea058d498ac711581c40e298df30f33a7cf8f65ff6

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