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

md5=f8850fe552b1a8d29d5e4cf9a2d8a54a

sha512=2165da986f65b5aeac83abd3bed9b8d9a8d2d7e54ef8a7a6d051c0a2ccb6d8ce8ff37104037f8c8a4c9c9accbe2c6fced497cdbd6ea14ff063fabba9c5e54260

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 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