session_itp.mli 6.73 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16




(** {1 New Proof sessions ("Refectoire")} *)


(** {2 upper level structure of sessions}

   A [session] contains a collection of files, a [file] contains a
collection of theories, a [theory] contains a collection of goals. The
structure of goals remain abstract, each goal being identified by
unique identifiers of type [proofNodeId]

*)

Clément Fumex's avatar
Clément Fumex committed
17
type session
18

19
val dummy_session: session
20

Clément Fumex's avatar
Clément Fumex committed
21
type proofNodeID
MARCHE Claude's avatar
MARCHE Claude committed
22
val print_proofNodeID : Format.formatter -> proofNodeID -> unit
23
type transID
24
type proofAttemptID
25 26 27

module Hpn: Exthtbl.S with type key = proofNodeID
module Htn: Exthtbl.S with type key = transID
28
module Hpan: Exthtbl.S with type key = proofAttemptID
29

Clément Fumex's avatar
Clément Fumex committed
30 31
val init_Hpn: session ->'a Hpn.t -> 'a -> unit
val init_Htn: session ->'a Htn.t -> 'a -> unit
32 33 34 35

type theory

type file = private {
Clément Fumex's avatar
Clément Fumex committed
36 37 38 39
  file_name              : string;
  file_format            : string option;
  file_theories          : theory list;
  file_detached_theories : theory list;
40 41
}

42 43 44 45 46 47 48
type any =
  | AFile of file
  | ATh of theory
  | ATn of transID
  | APn of proofNodeID
  | APa of proofAttemptID

49 50 51 52 53
val theory_name : theory -> Ident.ident
val theory_goals : theory -> proofNodeID list
val theory_detached_goals : theory -> proofNodeID list
val theory_parent : session -> theory -> file

54
val get_files : session -> file Stdlib.Hstr.t
Clément Fumex's avatar
Clément Fumex committed
55 56
val get_dir : session -> string
val get_shape_version : session -> int
57

58 59
type proof_attempt_node = {
  parent              : proofNodeID;
60 61 62 63
  prover              : Whyconf.prover;
  limit               : Call_provers.resource_limit;
  mutable proof_state : Call_provers.prover_result option;
  (* None means that the call was not done or never returned *)
Clément Fumex's avatar
Clément Fumex committed
64
  mutable proof_obsolete      : bool;
65 66
  proof_script        : string option;  (* non empty for external ITP *)
}
MARCHE Claude's avatar
MARCHE Claude committed
67

68 69
val session_iter_proof_attempt:
    (proofAttemptID -> proof_attempt_node -> unit) -> session -> unit
MARCHE Claude's avatar
MARCHE Claude committed
70

Sylvain Dailler's avatar
Sylvain Dailler committed
71 72 73
(* [is_below s a b] true if a is below b in the session tree *)
val is_below: session -> any -> any -> bool

74
type proof_parent = Trans of transID | Theory of theory
75

76
val get_task : session -> proofNodeID -> Task.task
77
val get_table : session -> proofNodeID -> Task.names_table option
78

Clément Fumex's avatar
Clément Fumex committed
79
val get_transformations : session -> proofNodeID -> transID list
80 81
val get_proof_attempt_ids :
  session -> proofNodeID -> proofAttemptID Whyconf.Hprover.t
82
val get_proof_attempt_node : session -> proofAttemptID -> proof_attempt_node
MARCHE Claude's avatar
MARCHE Claude committed
83
val get_proof_attempt_parent : session -> proofAttemptID -> proofNodeID
84
val get_proof_attempts : session -> proofNodeID -> proof_attempt_node list
Clément Fumex's avatar
Clément Fumex committed
85
val get_sub_tasks : session -> transID -> proofNodeID list
Clément Fumex's avatar
Clément Fumex committed
86
val get_detached_sub_tasks : session -> transID -> proofNodeID list
MARCHE Claude's avatar
MARCHE Claude committed
87

88 89 90
val get_transf_args : session -> transID -> string list
val get_transf_name : session -> transID -> string

91 92
val get_proof_name : session -> proofNodeID -> Ident.ident

93 94 95
val get_proof_parent : session -> proofNodeID -> proof_parent
val get_trans_parent : session -> transID -> proofNodeID

96
val get_detached_trans : session -> proofNodeID -> transID list
Sylvain Dailler's avatar
Sylvain Dailler committed
97 98
val get_any_parent: session -> any -> any option

99 100 101
(* Answers true if a node is in a detached subtree *)
val is_detached: session -> any -> bool

102
exception BadCopyDetached of string
Sylvain Dailler's avatar
Sylvain Dailler committed
103 104 105 106 107

(** [copy s pn] copy pn and add the copy as detached subgoal of its parent *)
val copy_proof_node_as_detached: session -> proofNodeID -> proofNodeID
val copy_structure: notification:(parent:any -> any -> unit) -> session -> any -> any -> unit

Clément Fumex's avatar
Clément Fumex committed
108 109 110
val empty_session : ?shape_version:int -> string -> session
(** create an empty_session in the directory specified by the
    argument *)
MARCHE Claude's avatar
MARCHE Claude committed
111 112

val add_file_section :
113 114
  use_shapes:bool -> session -> string -> (Theory.theory list) ->
  Env.fformat option -> unit
Clément Fumex's avatar
Clément Fumex committed
115 116
(** [add_file_section ~merge:(old_s,old_ths,env) s fn ths] adds a new
    'file' section in session [s], named [fn], containing fresh theory
MARCHE Claude's avatar
MARCHE Claude committed
117
    subsections corresponding to theories [ths]. The tasks of each
118 119 120 121 122 123 124 125 126 127 128 129 130
    theory nodes generated are computed using [Task.split_theory]. *)

val merge_file_section :
  use_shapes:bool -> old_ses:session -> old_theories:theory list ->
  env:Env.env -> session -> string -> Theory.theory list ->
  Env.fformat option -> unit
(** [merge_file_section ~old_s ~old_theories ~env ~pn_callpack s fn
    ths] adds a new 'file' section in session [s], named [fn],
    containing fresh theory subsections corresponding to theories
    [ths]. For each theory whose name is identical to one theory of
    old_ths, it is attempted to associate the old goals,
    proof_attempts and transformations to the goals of the new
    theory *)
MARCHE Claude's avatar
MARCHE Claude committed
131

Clément Fumex's avatar
Clément Fumex committed
132
val graft_proof_attempt : session -> proofNodeID -> Whyconf.prover ->
133 134 135
  limit:Call_provers.resource_limit -> proofAttemptID
(** [graft_proof_attempt s id pr l] adds a proof attempt with prover
    [pr] and limits [l] in the session [s] as a child of the task
136
    [id]. If there already a proof attempt with the same prover, it
137
    updates it with the limits. It returns the id of the
138
    generated proof attempt. *)
Clément Fumex's avatar
Clément Fumex committed
139 140

val update_proof_attempt : session -> proofNodeID -> Whyconf.prover ->
141
  Call_provers.prover_result -> unit
Clément Fumex's avatar
Clément Fumex committed
142 143
(** [update_proof_attempt s id pr st] update the status of the
    corresponding proof attempt with [st]. *)
MARCHE Claude's avatar
MARCHE Claude committed
144

145
val graft_transf : session -> proofNodeID -> string -> string list ->
Clément Fumex's avatar
Clément Fumex committed
146
  Task.task list -> transID
147
(** [graft_transf s id name l tl] adds the transformation [name] as a
Clément Fumex's avatar
Clément Fumex committed
148
    child of the task [id] of the session [s]. [l] is the list of
149
    arguments of the transformation, and [tl] is the list of subtasks.
Clément Fumex's avatar
Clément Fumex committed
150
*)
MARCHE Claude's avatar
MARCHE Claude committed
151

Clément Fumex's avatar
Clément Fumex committed
152 153 154
val remove_proof_attempt : session -> proofNodeID -> Whyconf.prover -> unit
(** [remove_proof_attempt s id pr] removes the proof attempt from the
    prover [pr] from the proof node [id] of the session [s] *)
MARCHE Claude's avatar
MARCHE Claude committed
155

Clément Fumex's avatar
Clément Fumex committed
156 157 158
val remove_transformation : session -> transID -> unit
(** [remove_transformation s id] removes the transformation [id]
    from the session [s] *)
159

160 161 162
val mark_obsolete: session -> proofAttemptID -> unit
(** [mark_obsolete s id] marks [id] as obsolete in [s] *)

Clément Fumex's avatar
Clément Fumex committed
163 164
val save_session : session -> unit
(** [save_session s] Save the session [s] *)
MARCHE Claude's avatar
MARCHE Claude committed
165

Clément Fumex's avatar
Clément Fumex committed
166
val load_session : string -> session * bool
Clément Fumex's avatar
Clément Fumex committed
167
(** [load_session dir] load a session in directory [dir]; all the
Clément Fumex's avatar
Clément Fumex committed
168 169 170 171 172 173 174 175 176 177
    tasks are initialised to None

    The returned boolean is set when there was shapes read from disk.

    raises [SessionFileError msg] if the database file cannot be read
    correctly.

    raises [ShapesFileError msg] if the database extra file for shapes
    cannot be read.
 *)
178 179 180 181 182 183 184 185

exception RemoveError

val remove_subtree: session -> any -> notification:(any -> unit) -> unit
(** [remove_subtree s a notification] remove the subtree originating from a in
    session s then call the notification function (used to notify the ide.

    If called on a theory or proof node, raise RemoveError *)
186 187 188

val fold_all_any: session -> ('a -> any -> 'a) -> 'a -> any -> 'a
(** [fold_all_any s f acc any] folds on all the subnodes of any *)