package coq-lsp

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Coq.WorkspaceSource

Sourcemodule Flags : sig ... end
Sourcemodule Warning : sig ... end
Sourcemodule Require : sig ... end
Sourcetype t = private {
  1. coqlib : string;
    (*

    Path to coqlib

    *)
  2. findlib_config : string option;
    (*

    Path to findlib config file, if None, default

    *)
  3. ocamlpath : string list;
    (*

    extra ocamlpath paths, for example for local plugins

    *)
  4. vo_load_path : Loadpath.vo_path list;
    (*

    List of -R / -Q flags passed to Coq, usually theories we depend on

    *)
  5. require_libs : Require.t list;
    (*

    Modules to preload, usually Coq.Init.Prelude

    *)
  6. flags : Flags.t;
    (*

    Coq-specific flags

    *)
  7. warnings : Warning.t list;
  8. kind : string;
    (*

    How the workspace was built

    *)
  9. debug : bool;
    (*

    Enable backtraces

    *)
}
Sourceval inject_requires : extra_requires:Require.t list -> t -> t

Inject some requires

Sourceval compare : t -> t -> int

compare

Sourceval hash : t -> int

hash

Sourceval describe : t -> string * string

describe w return user, extra, where user is the relevant user message, and extra contains lower-level debug data such as all findlib packages in scope, etc... data

Sourceval describe_guess : (t, string) Result.t -> string * string
Sourcemodule CmdLine : sig ... end
Sourceval guess : token:Limits.Token.t -> debug:bool -> cmdline:CmdLine.t -> dir:string -> (t, string) Result.t
Sourceval default : debug:bool -> cmdline:CmdLine.t -> t
Sourceval apply : intern:Library.Intern.t -> uri:Lang.LUri.File.t -> t -> unit

apply libname w will prepare Coq for a new file libname on workspace w

Sourceval dirpath_of_uri : uri:Lang.LUri.File.t -> Names.DirPath.t
OCaml

Innovation. Community. Security.