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

md5=299f0dd7de61cc7a7afc70cec7ad7fab

sha512=dfbf205351aa463530d8831527fb1c7f6564c88aaff050d6f36cb3a71e26ff4df3425e4adda86923f037dffacd316d5ad5009a64845265cdd9b6b25af34287a7

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

Module `LibIndex`

Main types

type t

Lazy trie structure holding the info on all identifiers

type orig_file = private IndexTypes.orig_file =

| Cmt of string
| Cmti of string
| Cmi of string

The type of files we get our data from

exception Bad_format of string

type info = private IndexTypes.info = {

path : string list;
orig_path : string list;
kind : kind;
name : string;
ty : IndexTypes.ty option;
loc_sig : Location.t Lazy.t;
loc_impl : Location.t Lazy.t;
doc : string option Lazy.t;
file : orig_file;

}

Contains the information on a given identifier

and kind = private IndexTypes.kind =

| Type
| Value
| Exception
| OpenType
| Field of info
| Variant of info
| Method of info
| Module
| ModuleType
| Class
| ClassType
| Keyword

The kind of elements that can be stored in the trie

Utility functions

module Misc : sig ... end

Building

val load : string list -> t

val add_file : t -> string -> t

Load a single file into a trie

val open_module : ?cleanup_path:bool -> t -> string list -> t

val fully_open_module : ?cleanup_path:bool -> t -> string list -> t

val alias : ?cleanup_path:bool -> t -> string list -> string list -> t

Querying

val all : t -> info list

Returns all bindings in the trie

val get : t -> string -> info

Lookup an identifier in a trie (eg. option or List.map)

val get_all : t -> string -> info list

val complete : t -> ?filter:(info -> bool) -> string -> info list

Output

include module type of IndexOut

module Format : sig ... end

module Print : sig ... end

On This Page

Main types
Utility functions
Building
Querying
Output