package ocp-index

You can search for identifiers within the package.

in-package search v0.2.0

package ocp-index

ocp-index.lib
- Dunextract
- IndexBuild
- IndexMisc
- IndexOut
  - Format
  - Print
- IndexPredefined
- IndexScope
- IndexTrie
- IndexTypes
- LibIndex
  - Format
  - Misc
  - Print

Legend:
Library
Module
Module type
Parameter
Class
Class type

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