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/LibIndex/index.html

Module `LibIndex`Source

Main types

Sourcetype t

Lazy trie structure holding the info on all identifiers

Sourcetype orig_file = private IndexTypes.orig_file =

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

The type of files we get our data from

Sourceexception Bad_format of string

Sourcetype 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

Sourceand 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

Sourcemodule Misc : sig ... end

Building

Sourceval load : qualify:bool -> string list -> t

Sourceval add_file : qualify:bool -> t -> string -> t

Load a single file into a trie

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

Source

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

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

Querying

Sourceval all : t -> info list

Returns all bindings in the trie

Sourceval get : t -> string -> info

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

Sourceval get_all : t -> string -> info list

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

Output

include module type of IndexOut

Sourcemodule Format : sig ... end

Sourcemodule Print : sig ... end

On This Page

Main types
Utility functions
Building
Querying
Output