Something went wrong. Try again.
forked from coq/coq
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321(************************************************************************)(* * The Rocq Prover / The Rocq Development Team *)(* v * Copyright INRIA, CNRS and contributors *)(* <O___,, * (see version control and CREDITS file for authors & dates) *)(* \VV/ **************************************************************)(* // * This file is distributed under the terms of the *)(* * GNU Lesser General Public License Version 2.1 *)(* * (see LICENSE file for the text of the license) *)(************************************************************************)
(** * Declarative part of the interface of RocqIDE calls to Rocq *)
(** * Generic structures *)
type raw = booltype verbose = bool
(** The type of rocqtop goals *)type goal = { goal_id : string; (** Unique goal identifier *) goal_hyp : Pp.t list; (** List of hypotheses *) goal_ccl : Pp.t; (** Goal conclusion *) goal_name : string option; (** User-level goal name *)}
type evar = { evar_info : string; (** A string describing an evar: type, number, environment *)}
type status = { status_path : string list; (** Module path of the current proof *) status_proofname : string option; (** Current proof name. [None] if no focused proof is in progress *) status_allproofs : string list; (** List of all pending proofs. Order is not significant *) status_proofnum : int; (** An id describing the state of the current proof. *)}
type 'a pre_goals = { fg_goals : 'a list; (** List of the focused goals *) bg_goals : ('a list * 'a list) list; (** Zipper representing the unfocused background goals *) shelved_goals : 'a list; (** List of the goals on the shelf. *) given_up_goals : 'a list; (** List of the goals that have been given up *)}
type goals = goal pre_goals
type hint = (string * string) list(** A list of tactics applicable and their appearance *)
type option_name = string list
type option_value = | BoolValue of bool | IntValue of int option | StringValue of string | StringOptValue of string option
(** Summary of an option status *)type option_state = { opt_sync : bool; (** Whether an option is synchronous *) opt_depr : bool; (** Whether an option is deprecated *) opt_value : option_value; (** The current value of the option *)}
type search_constraint =| Name_Pattern of string(** Whether the name satisfies a regexp (uses Ocaml Str syntax) *)
| Type_Pattern of string(** Whether the object type satisfies a pattern *)
| SubType_Pattern of string(** Whether some subtype of object type satisfies a pattern *)
| In_Module of string list(** Whether the object pertains to a module *)
| Include_Blacklist(** Bypass the Search blacklist *)
(** A list of search constraints; the boolean flag is set to [false] whenever the flag should be negated. *)type search_flags = (search_constraint * bool) list
(** Subset of goals to print. *)type goal_flags = { gf_mode : string; gf_fg : bool; gf_bg : bool; gf_shelved : bool; gf_given_up : bool;}
(** A named object in Rocq. [coq_object_qualid] is the shortest path defined for the user. [coq_object_prefix] is the missing part to recover the fully qualified name, i.e [fully_qualified = coq_object_prefix + coq_object_qualid]. [coq_object_object] is the actual content of the object. *)type 'a coq_object = { coq_object_prefix : string list; coq_object_qualid : string list; coq_object_object : 'a;}
type coq_info = { coqtop_version : string; protocol_version : string; release_date : string; compile_date : string;}
(* a subset of DebugHook.Action.t *)type db_continue_opt = | StepIn | StepOver | StepOut | Continue | Interrupt
(** Calls result *)
type location = Loc.t optiontype state_id = Stateid.ttype route_id = Feedback.route_id
(* Obsolete *)type edit_id = int
(* The fail case carries the current state_id of the prover, the GUI should probably retract to that point *)type 'a value = | Good of 'a | Fail of (state_id * location * Pp.t)
type ('a, 'b) union = ('a, 'b) Util.union
(* Request/Reply message protocol between Rocq and RocqIDE *)
(** [add ((((s,eid),(sid,v)), bp), (line_nb, bol_pos) ] adds the phrase [s] with edit id [eid] on top of the current edit position (that is asserted to be [sid]). [v] set to true indicates "verbose". The response [(id,rc)] is the new state [id] assigned to the phrase. [rc] is [Inl] if the new state id is the tip of the edit point, or [Inr tip] if the new phrase closes a focus and [tip] is the new edit tip. [bp], [line_nb] and [bol_pos] are the Loc.t values for the phrase in the buffer, needed to return the correct location for [s] to the debugger *)type add_sty = (((string * edit_id) * (state_id * verbose)) * int) * (int * int)type add_rty = state_id * (unit, state_id) union
(** [edit_at id] declares the user wants to edit just after [id]. The response is [Inl] if the document has been rewound to that point, [Inr (start,(stop,tip))] if [id] is in a zone that can be focused. In that case the zone is delimited by [start] and [stop] while [tip] is the new document [tip]. Edits made by subsequent [add] are always performed on top of [id]. *)type edit_at_sty = state_idtype edit_at_rty = (unit, state_id * (state_id * state_id)) union
(** [query s id] executes [s] at state [id].
query used to reply with the contents of Rocq's console output, and has been deprecated in favor of sending the query answers as feedback. It will be removed in a future version of the protocol.*)type query_sty = route_id * (string * state_id)type query_rty = unit
(** Fetching the list of current goals. Return [None] if no proof is in progress, [Some gl] otherwise. *)type goals_sty = unittype goals_rty = goals option
(** Same as above, but specific kind of goals can be retrieved by setting the flags. *)type subgoals_sty = goal_flagstype subgoals_rty = goals option
(** Retrieve the list of uninstantiated evars in the current proof. [None] if no proof is in progress. *)type evars_sty = unittype evars_rty = evar list option
(** Retrieving the tactics applicable to the current goal. [None] if there is no proof in progress. *)type hints_sty = unittype hints_rty = (hint list * hint) option
(** The status, for instance "Ready in SomeSection, proving Foo", the input boolean (if true) forces the evaluation of all unevaluated statements *)type status_sty = booltype status_rty = status
(** Search for objects satisfying the given search flags. *)type search_sty = search_flagstype search_rty = string coq_object list
(** Diffs between the proof term at a given stateid and the previous one *)type proof_diff_sty = string * Stateid.ttype proof_diff_rty = Pp.t
(** A debugger command *)type db_cmd_sty = stringtype db_cmd_rty = unit
(** update one or more breakpoints in the specified file *)type db_upd_bpts_sty = ((string * int) * bool) listtype db_upd_bpts_rty = unit
(** continue execution (in various ways) *)type db_continue_sty = db_continue_opttype db_continue_rty = unit
(** fetch the stack *)type db_stack_sty = unittype db_stack_rty = (string * (string * int list) option) list
(** fetch variable names and values for a stack frame *)type db_vars_sty = inttype db_vars_rty = (string * Pp.t) list
(** indicate debugger config is complete *)type db_configd_sty = unittype db_configd_rty = unit
(** Retrieve the list of options of the current toplevel *)type get_options_sty = unittype get_options_rty = (option_name * option_state) list
(** Set the options to the given values. Warning: this is not atomic, so whenever the call fails, the option state can be messed up... This is the caller duty to check that everything is correct. *)type set_options_sty = (option_name * option_value) listtype set_options_rty = unit
(** Create a "match" template for a given inductive type. For each branch of the match, we list the constructor name followed by enough pattern variables. *)type mkcases_sty = stringtype mkcases_rty = string list list
(** Quit gracefully the interpreter. *)type quit_sty = unittype quit_rty = unit
(* Initialize, and return the initial state id. The argument is the filename. * If its directory is not in dirpath, it adds it. It also loads * compilation hints for the filename. *)type init_sty = string optiontype init_rty = state_id
type about_sty = unittype about_rty = coq_info
type handle_exn_sty = Exninfo.iexntype handle_exn_rty = state_id * location * Pp.t
(* Retrocompatibility stuff *)type interp_sty = (raw * verbose) * string(* spiwack: [Inl] for safe and [Inr] for unsafe. *)type interp_rty = state_id * (string,string) Util.union
type stop_worker_sty = stringtype stop_worker_rty = unit
type print_ast_sty = state_idtype print_ast_rty = Xml_datatype.xml
type annotate_sty = stringtype annotate_rty = Xml_datatype.xml
type wait_sty = unittype wait_rty = unit
type handler = { add : add_sty -> add_rty; edit_at : edit_at_sty -> edit_at_rty; query : query_sty -> query_rty; goals : goals_sty -> goals_rty; evars : evars_sty -> evars_rty; hints : hints_sty -> hints_rty; status : status_sty -> status_rty; search : search_sty -> search_rty; get_options : get_options_sty -> get_options_rty; set_options : set_options_sty -> set_options_rty; mkcases : mkcases_sty -> mkcases_rty; about : about_sty -> about_rty; stop_worker : stop_worker_sty -> stop_worker_rty; print_ast : print_ast_sty -> print_ast_rty; annotate : annotate_sty -> annotate_rty; proof_diff : proof_diff_sty -> proof_diff_rty; db_cmd : db_cmd_sty -> db_cmd_rty; db_upd_bpts : db_upd_bpts_sty -> db_upd_bpts_rty; db_continue : db_continue_sty -> db_continue_rty; db_stack : db_stack_sty -> db_stack_rty; db_vars : db_vars_sty -> db_vars_rty; db_configd : db_configd_sty -> db_configd_rty; handle_exn : handle_exn_sty -> handle_exn_rty; init : init_sty -> init_rty; quit : quit_sty -> quit_rty; (* for internal use (fake_id) only, do not use *) wait : wait_sty -> wait_rty; (* Retrocompatibility stuff *) interp : interp_sty -> interp_rty; subgoals : subgoals_sty -> subgoals_rty;}