session_itp.mli 5.47 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
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

47
val get_files : session -> file Stdlib.Hstr.t
Clément Fumex's avatar
Clément Fumex committed
48 49
val get_dir : session -> string
val get_shape_version : session -> int
50

51 52
type proof_attempt_node = {
  parent              : proofNodeID;
53 54 55 56
  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
57
  mutable proof_obsolete      : bool;
58 59
  proof_script        : string option;  (* non empty for external ITP *)
}
MARCHE Claude's avatar
MARCHE Claude committed
60

61
val session_iter_proof_attempt: (proofNodeID -> proof_attempt_node -> unit) -> session -> unit
MARCHE Claude's avatar
MARCHE Claude committed
62

63
type proof_parent = Trans of transID | Theory of theory
64

65
val get_task : session -> proofNodeID -> Task.task
66
val get_tables: session -> proofNodeID -> Task.name_tables option
67

Clément Fumex's avatar
Clément Fumex committed
68
val get_transformations : session -> proofNodeID -> transID list
69 70
val get_proof_attempt_ids :
  session -> proofNodeID -> proofAttemptID Whyconf.Hprover.t
71
val get_proof_attempt_node : session -> proofAttemptID -> proof_attempt_node
MARCHE Claude's avatar
MARCHE Claude committed
72
val get_proof_attempt_parent : session -> proofAttemptID -> proofNodeID
73
val get_proof_attempts : session -> proofNodeID -> proof_attempt_node list
Clément Fumex's avatar
Clément Fumex committed
74
val get_sub_tasks : session -> transID -> proofNodeID list
Clément Fumex's avatar
Clément Fumex committed
75
val get_detached_sub_tasks : session -> transID -> proofNodeID list
MARCHE Claude's avatar
MARCHE Claude committed
76

77 78 79
val get_transf_args : session -> transID -> string list
val get_transf_name : session -> transID -> string

80 81
val get_proof_name : session -> proofNodeID -> Ident.ident

82 83 84
val get_proof_parent : session -> proofNodeID -> proof_parent
val get_trans_parent : session -> transID -> proofNodeID

Clément Fumex's avatar
Clément Fumex committed
85 86 87
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
88 89

val add_file_section :
90 91
  use_shapes:bool -> session -> string -> (Theory.theory list) ->
  Env.fformat option -> unit
Clément Fumex's avatar
Clément Fumex committed
92 93
(** [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
94
    subsections corresponding to theories [ths]. The tasks of each
95 96 97 98 99 100 101 102 103 104 105 106 107
    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
108

Clément Fumex's avatar
Clément Fumex committed
109
val graft_proof_attempt : session -> proofNodeID -> Whyconf.prover ->
110
  timelimit:int -> proofAttemptID
Clément Fumex's avatar
Clément Fumex committed
111 112
(** [graft_proof_attempt s id pr t] adds a proof attempt with prover
    [pr] and timelimit [t] in the session [s] as a child of the task
113 114 115
    [id]. If there already a proof attempt with the same prover, it
    updates it with the new timelimit. It returns the id of the
    generated proof attempt. *)
Clément Fumex's avatar
Clément Fumex committed
116 117

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

122
val graft_transf : session -> proofNodeID -> string -> string list ->
Clément Fumex's avatar
Clément Fumex committed
123
  Task.task list -> transID
124
(** [graft_transf s id name l tl] adds the transformation [name] as a
Clément Fumex's avatar
Clément Fumex committed
125
    child of the task [id] of the session [s]. [l] is the list of
126
    arguments of the transformation, and [tl] is the list of subtasks.
Clément Fumex's avatar
Clément Fumex committed
127
*)
MARCHE Claude's avatar
MARCHE Claude committed
128

Clément Fumex's avatar
Clément Fumex committed
129 130 131
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
132

Clément Fumex's avatar
Clément Fumex committed
133 134 135
val remove_transformation : session -> transID -> unit
(** [remove_transformation s id] removes the transformation [id]
    from the session [s] *)
136

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

Clément Fumex's avatar
Clément Fumex committed
140
val load_session : string -> session * bool
Clément Fumex's avatar
Clément Fumex committed
141
(** [load_session dir] load a session in directory [dir]; all the
Clément Fumex's avatar
Clément Fumex committed
142 143 144 145 146 147 148 149 150 151
    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.
 *)