session.ml 80.1 KB
Newer Older
François Bobot's avatar
François Bobot committed
1
2
(**************************************************************************)
(*                                                                        *)
MARCHE Claude's avatar
MARCHE Claude committed
3
(*  Copyright (C) 2010-2012                                               *)
François Bobot's avatar
François Bobot committed
4
5
6
(*    François Bobot                                                      *)
(*    Jean-Christophe Filliâtre                                           *)
(*    Claude Marché                                                       *)
MARCHE Claude's avatar
MARCHE Claude committed
7
(*    Guillaume Melquiond                                                 *)
François Bobot's avatar
François Bobot committed
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
(*    Andrei Paskevich                                                    *)
(*                                                                        *)
(*  This software is free software; you can redistribute it and/or        *)
(*  modify it under the terms of the GNU Library General Public           *)
(*  License version 2.1, with the special exception on linking            *)
(*  described in file LICENSE.                                            *)
(*                                                                        *)
(*  This software is distributed in the hope that it will be useful,      *)
(*  but WITHOUT ANY WARRANTY; without even the implied warranty of        *)
(*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *)
(*                                                                        *)
(**************************************************************************)

open Stdlib
open Debug
23
open Util
François Bobot's avatar
François Bobot committed
24
25
26
27
28
29
open Ty
open Ident
open Decl
open Term
open Theory
open Task
François Bobot's avatar
François Bobot committed
30

31
32
33
34
module Mprover = Whyconf.Mprover
module Sprover = Whyconf.Sprover
module PHprover = Whyconf.Hprover
module C = Whyconf
35
module Tc = Termcode
36

37
let debug = Debug.register_info_flag "session"
38
  ~desc:"About the why3 session creation, reading and writing."
François Bobot's avatar
François Bobot committed
39
40
41
42
43
44
45
46
47
48

(** {2 Type definitions} *)

module PHstr = Util.Hstr

type undone_proof =
    | Scheduled (** external proof attempt is scheduled *)
    | Interrupted
    | Running (** external proof attempt is in progress *)
    | Unedited
49
    | JustEdited
François Bobot's avatar
François Bobot committed
50
51
52
53
54
55
56
57

type proof_attempt_status =
    | Undone of undone_proof
    | Done of Call_provers.prover_result (** external proof done *)
    | InternalFailure of exn (** external proof aborted by internal error *)

type task_option = Task.task option

François Bobot's avatar
François Bobot committed
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
type pos_task =
  { pos_decl  : int; (* nth decl in the task from top *)
    pos_def   : int; (* nth def in the decl *)
    pos_const : int; (* nth constructor in the type def *)
    pos_proj  : int; (* nth proj for the constructor (-1 for the constructor) *)
    pos_checksum : Termcode.checksum;
  (** the checksum of the prefix of the task starting at this decl *)
  }

let compare_pos_task x y =
  let c = compare x.pos_decl y.pos_decl in
  if c <> 0 then -c else (* in order to be bottom up *)
  let c = compare x.pos_def y.pos_def in
  if c <> 0 then c else
  let c = compare x.pos_const y.pos_const in
  if c <> 0 then c else
  let c = compare x.pos_proj y.pos_proj in
  if c <> 0 then c
  else if x.pos_checksum <> y.pos_checksum
  then invalid_arg "Session : virtual_metas of different task have been mixed"
  else c (* 0 *)

let empty_pos =
  { pos_decl  = -1;
    pos_def   = -1;
    pos_const = -1;
    pos_proj  = -1;
    pos_checksum = Termcode.dumb_checksum;
  }

module Pos = struct
  type t = pos_task
  let compare = compare_pos_task
  let equal x y = (x : t) = y
  let hash x = Hashtbl.hash (x : t)
end

module Mpos = Map.Make(Pos)
module Spos = Mpos.Set
module Hpos = Hashtbl.Make(Pos)

(* type virtual_ty = *)
(*   | Vtyvar of int (\* debruin id *\) *)
(*   | Vtyapp of virtual_ident * virtual_ty list *)

(* let rec compare_vty x y = *)
(*   match x,y with *)
(*   | Vtyvar xi, Vtyvar yi -> compare xi yi *)
(*   | Vtyapp (xi, xl), Vtyapp (yi, yl) -> *)
(*     let c = compare_vi xi yi in *)
(*     if c <> 0 then c else *)
(*       list_compare compare_vty xl yl *)
(*   | Vtyvar _, _ ->  1 *)
(*   | _, Vtyvar _ -> -1 *)

(* type virtual_meta_arg = *)
(*   | VMAty  of virtual_ty *)
(*   | VMAts  of virtual_ident *)
(*   | VMAls  of virtual_ident *)
(*   | VMApr  of virtual_ident *)
(*   | VMAstr of string *)
(*   | VMAint of int *)

(* type virtual_meta = *)
(*   { *)
(*     (\* why3 name of the meta *\) *)
(*     vm_name : string; *)
(*     vm_args : virtual_meta_arg list; *)
(*   } *)

type meta_args = meta_arg list

module Mmeta_args = Map.Make(struct
  type t = meta_args

  let meta_arg_id = function
    | MAty _  -> 0
    | MAts _  -> 1
    | MAls _  -> 2
    | MApr _  -> 3
    | MAstr _ -> 4
    | MAint _ -> 5

  let compare_meta_arg x y =
    match x,y with
  (** These hash are in fact tag *)
    | MAty  x, MAty  y -> compare (ty_hash x) (ty_hash y)
    | MAts  x, MAts  y -> compare (ts_hash x) (ts_hash y)
    | MAls  x, MAls  y -> compare (ls_hash x) (ls_hash y)
    | MApr  x, MApr  y -> compare (pr_hash x) (pr_hash y)
    | MAstr x, MAstr y -> String.compare x y
    | MAint x, MAint y -> compare x y
    | _ -> compare (meta_arg_id x) (meta_arg_id y)

  let compare = list_compare compare_meta_arg
end)
module Smeta_args = Mmeta_args.Set

type metas_args =  Smeta_args.t Mstr.t
module Mmetas_args = Map.Make(struct
  type t = metas_args
  let compare = Mstr.compare Smeta_args.compare
end)

type idpos = {
  idpos_ts : pos_task Mts.t;
  idpos_ls : pos_task Mls.t;
  idpos_pr : pos_task Mpr.t;
}

let empty_idpos =
  {
    idpos_ts = Mts.empty;
    idpos_ls = Mls.empty;
    idpos_pr = Mpr.empty;
  }

let posid_of_idpos idpos =
  let posid = Mpos.empty in
  let posid = Mts.fold (fun ts pos ->
    Mpos.add pos (MAts ts)) idpos.idpos_ts posid  in
  let posid = Mls.fold (fun ls pos ->
    Mpos.add pos (MAls ls)) idpos.idpos_ls posid  in
  let posid = Mpr.fold (fun pr pos ->
    Mpos.add pos (MApr pr)) idpos.idpos_pr posid  in
  posid

François Bobot's avatar
François Bobot committed
185
type 'a goal =
186
187
188
189
190
191
192
193
194
195
196
  { mutable goal_key  : 'a;
    goal_name : Ident.ident;
    goal_expl : string option;
    goal_parent : 'a goal_parent;
    mutable goal_checksum : Tc.checksum;
    mutable goal_shape : Tc.shape;
    mutable goal_verified : bool;
    goal_task: task_option;
    mutable goal_expanded : bool;
    goal_external_proofs : 'a proof_attempt PHprover.t;
    goal_transformations : 'a transf PHstr.t;
François Bobot's avatar
François Bobot committed
197
    mutable goal_metas : 'a metas Mmetas_args.t;
198
  }
François Bobot's avatar
François Bobot committed
199
200

and 'a proof_attempt =
201
202
203
204
205
206
207
208
209
210
  { proof_key : 'a;
    mutable proof_prover : Whyconf.prover;
    proof_parent : 'a goal;
    mutable proof_state : proof_attempt_status;
    mutable proof_timelimit : int;
    mutable proof_memlimit : int;
    mutable proof_obsolete : bool;
    mutable proof_archived : bool;
    mutable proof_edited_as : string option;
  }
François Bobot's avatar
François Bobot committed
211
212
213
214

and 'a goal_parent =
  | Parent_theory of 'a theory
  | Parent_transf of 'a transf
François Bobot's avatar
François Bobot committed
215
216
217
218
219
220
221
222
223
224
225
226
  | Parent_metas  of 'a metas

and 'a metas =
  { mutable metas_key : 'a;
    metas_added : metas_args;
    metas_idpos : idpos;
    metas_parent : 'a goal;
    mutable metas_verified : bool;
    mutable metas_goal : 'a goal;
    (** Not mutated after the creation *)
    mutable metas_expanded : bool;
  }
François Bobot's avatar
François Bobot committed
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250

and 'a transf =
    { mutable transf_key : 'a;
      transf_name : string;
      (** Why3 tranformation name *)
      transf_parent : 'a goal;
      mutable transf_verified : bool;
      mutable transf_goals : 'a goal list;
      (** Not mutated after the creation of the session *)
      mutable transf_expanded : bool;
    }

and 'a theory =
    { mutable theory_key : 'a;
      theory_name : Ident.ident;
      theory_parent : 'a file;
      mutable theory_goals : 'a goal list;
      mutable theory_verified : bool;
      mutable theory_expanded : bool;
    }

and 'a file =
    { mutable file_key : 'a;
      file_name : string;
251
      file_format : string option;
François Bobot's avatar
François Bobot committed
252
253
254
255
256
257
258
259
260
      file_parent : 'a session;
      mutable file_theories: 'a theory list;
      (** Not mutated after the creation *)
      mutable file_verified : bool;
      mutable file_expanded : bool;
    }

and 'a session =
    { session_files : 'a file PHstr.t;
MARCHE Claude's avatar
MARCHE Claude committed
261
      mutable session_shape_version : int;
François Bobot's avatar
François Bobot committed
262
263
264
265
266
267
268
      session_dir   : string; (** Absolute path *)
    }

type loaded_prover =
    { prover_config : Whyconf.config_prover;
      prover_driver : Driver.driver}

269
type loaded_provers = loaded_prover option PHprover.t
François Bobot's avatar
François Bobot committed
270
271
272

type 'a env_session =
    { env : Env.env;
273
      mutable whyconf : Whyconf.config;
François Bobot's avatar
François Bobot committed
274
275
276
      loaded_provers : loaded_provers;
      session : 'a session}

277
let update_env_session_config e c = e.whyconf <- c
François Bobot's avatar
François Bobot committed
278
279
280
281
282
283
284
285
286
287

(*************************)
(**       Iterators      *)
(*************************)
type 'a any =
  | File of 'a file
  | Theory of 'a theory
  | Goal of 'a goal
  | Proof_attempt of 'a proof_attempt
  | Transf of 'a transf
François Bobot's avatar
François Bobot committed
288
  | Metas of 'a metas
François Bobot's avatar
François Bobot committed
289
290
291

let rec goal_iter_proof_attempt f g =
  PHprover.iter (fun _ a -> f a) g.goal_external_proofs;
François Bobot's avatar
François Bobot committed
292
293
  PHstr.iter (fun _ t -> transf_iter_proof_attempt f t) g.goal_transformations;
  Mmetas_args.iter (fun _ t -> metas_iter_proof_attempt f t) g.goal_metas;
François Bobot's avatar
François Bobot committed
294
295
296
297

and transf_iter_proof_attempt f t =
  List.iter (goal_iter_proof_attempt f) t.transf_goals

François Bobot's avatar
François Bobot committed
298
299
300
and metas_iter_proof_attempt f t =
  goal_iter_proof_attempt f t.metas_goal

François Bobot's avatar
François Bobot committed
301
302
303
let theory_iter_proof_attempt f t =
  List.iter (goal_iter_proof_attempt f) t.theory_goals

François Bobot's avatar
François Bobot committed
304
305
306
let metas_iter_proof_attempt f m =
  goal_iter_proof_attempt f m.metas_goal

François Bobot's avatar
François Bobot committed
307
308
309
310
311
312
313
314
315
316
317
318
let file_iter_proof_attempt f t =
  List.iter (theory_iter_proof_attempt f) t.file_theories

let session_iter_proof_attempt f s =
  PHstr.iter (fun _ file -> file_iter_proof_attempt f file) s.session_files

let rec iter_proof_attempt f = function
    | Goal g -> goal_iter_proof_attempt f g
    | Theory th -> theory_iter_proof_attempt f th
    | File file -> file_iter_proof_attempt f file
    | Proof_attempt a -> f a
    | Transf tr -> transf_iter_proof_attempt f tr
François Bobot's avatar
François Bobot committed
319
    | Metas m -> metas_iter_proof_attempt f m
François Bobot's avatar
François Bobot committed
320
321
322
323
324
325
326
327
328
329
330

let rec goal_iter_leaf_goal ~unproved_only f g =
  if not (g.goal_verified && unproved_only) then
    let r = ref true in
    PHstr.iter
      (fun _ t -> r := false;
        List.iter (goal_iter_leaf_goal ~unproved_only f) t.transf_goals)
      g.goal_transformations;
    if !r then f g

(** iterators not reccursive *)
François Bobot's avatar
François Bobot committed
331
let iter_goal fp ft fm g =
François Bobot's avatar
François Bobot committed
332
  PHprover.iter (fun _ a -> fp a) g.goal_external_proofs;
François Bobot's avatar
François Bobot committed
333
334
  PHstr.iter (fun _ t -> ft t) g.goal_transformations;
  Mmetas_args.iter (fun _ t -> fm t) g.goal_metas
François Bobot's avatar
François Bobot committed
335
336
337
338

let iter_transf f t =
  List.iter (fun g -> f g) t.transf_goals

François Bobot's avatar
François Bobot committed
339
340
let iter_metas f t = f t.metas_goal

François Bobot's avatar
François Bobot committed
341
let goal_iter f g =
342
343
  PHprover.iter
    (fun _ a -> f (Proof_attempt a)) g.goal_external_proofs;
François Bobot's avatar
François Bobot committed
344
345
346
  PHstr.iter (fun _ t -> f (Transf t)) g.goal_transformations;
  Mmetas_args.iter (fun _ t -> f (Metas t)) g.goal_metas

François Bobot's avatar
François Bobot committed
347
348
349
350

let transf_iter f t =
  List.iter (fun g -> f (Goal g)) t.transf_goals

François Bobot's avatar
François Bobot committed
351
352
353
let metas_iter f t =
  f (Goal t.metas_goal)

François Bobot's avatar
François Bobot committed
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
let theory_iter f t =
  List.iter (fun g -> f (Goal g)) t.theory_goals

let file_iter f t =
  List.iter (fun th -> f (Theory th)) t.file_theories

let session_iter f s =
  PHstr.iter (fun _ file -> f (File file)) s.session_files

let iter f = function
    | Goal g -> goal_iter f g
    | Theory th -> theory_iter f th
    | File file -> file_iter f file
    | Proof_attempt _ -> ()
    | Transf tr -> transf_iter f tr
François Bobot's avatar
François Bobot committed
369
    | Metas m -> metas_iter f m
François Bobot's avatar
François Bobot committed
370
371
372
373
374
375
376
377
378

(** Print session *)


module PTreeT = struct
  type 'a t = | Any of 'a any | Session of 'a session
  let decomp = function
    | Any t ->
      let s = match t with
379
380
381
382
383
384
385
386
        | File f ->
          if f.file_verified
          then f.file_name
          else f.file_name^"?"
        | Theory th ->
          if th.theory_verified
          then th.theory_name.Ident.id_string
          else th.theory_name.Ident.id_string^"?"
François Bobot's avatar
François Bobot committed
387
        | Goal g ->
388
389
390
          if g.goal_verified
          then g.goal_name.Ident.id_string
          else g.goal_name.Ident.id_string^"?"
391
        | Proof_attempt pr ->
392
          Pp.sprintf_wnl "%a%s%s%s%s"
393
            Whyconf.print_prover pr.proof_prover
394
395
396
397
            (match pr.proof_state with
              | Done { Call_provers.pr_answer = Call_provers.Valid} -> ""
              | InternalFailure _ -> "!"
              | _ -> "?")
398
399
400
            (if pr.proof_obsolete || pr.proof_archived then " " else "")
            (if pr.proof_obsolete then "O" else "")
            (if pr.proof_archived then "A" else "")
401
402
403
        | Transf tr ->
          if tr.transf_verified
          then tr.transf_name
François Bobot's avatar
François Bobot committed
404
405
406
407
408
409
          else tr.transf_name^"?"
        | Metas metas ->
          if metas.metas_verified
          then "metas..."
          else "metas..."^"?"
      in
François Bobot's avatar
François Bobot committed
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
      let l = ref [] in
      iter (fun a -> l := (Any a)::!l) t;
      s,!l
    | Session s ->
      let l = ref [] in
      session_iter (fun a -> l := (Any a)::!l) s;
      Filename.basename s.session_dir,!l

end

module PTree = Print_tree.PMake(PTreeT)

let print_any fmt any = PTree.print fmt (PTreeT.Any any)

let print_session fmt s = PTree.print fmt (PTreeT.Session s)

(** 2 Create a session *)

MARCHE Claude's avatar
MARCHE Claude committed
428
429
430
431
432
433
434
435
436
437
438
let empty_session ?shape_version dir =
  let shape_version = match shape_version with
    | Some v -> v
    | None -> Termcode.current_shape_version
  in
  { session_files = PHstr.create 3;
    session_shape_version = shape_version;
    session_dir   = dir;
  }

let create_session ?shape_version project_dir =
François Bobot's avatar
François Bobot committed
439
440
441
442
443
444
445
  if not (Sys.file_exists project_dir) then
    begin
      dprintf debug
        "[Info] '%s' does not exists. Creating directory of that name \
 for the project@." project_dir;
      Unix.mkdir project_dir 0o777
    end;
MARCHE Claude's avatar
MARCHE Claude committed
446
  empty_session ?shape_version project_dir
François Bobot's avatar
François Bobot committed
447
448
449
450
451
452
453
454
455


let load_env_session ?(includes=[]) session conf_path_opt =
  let config = Whyconf.read_config conf_path_opt in
  let loadpath = (Whyconf.loadpath (Whyconf.get_main config)) @ includes in
  let env = Env.create_env loadpath in
  { session = session;
    env = env;
    whyconf = config;
456
    loaded_provers = PHprover.create 5;
François Bobot's avatar
François Bobot committed
457
458
459
460
461
462
463
464
465
466
467
468
469
470
  }

(************************)
(* session accessor     *)
(************************)

let get_session_file file = file.file_parent

let get_session_theory th = get_session_file th.theory_parent

let rec get_session_goal goal =
  match goal.goal_parent with
    | Parent_transf trans -> get_session_trans trans
    | Parent_theory th    -> get_session_theory th
François Bobot's avatar
François Bobot committed
471
    | Parent_metas  metas -> get_session_metas metas
François Bobot's avatar
François Bobot committed
472
473
474

and get_session_trans transf = get_session_goal transf.transf_parent

François Bobot's avatar
François Bobot committed
475
476
and get_session_metas metas = get_session_goal metas.metas_parent

François Bobot's avatar
François Bobot committed
477
478
let get_session_proof_attempt pa = get_session_goal pa.proof_parent

479
let get_used_provers session =
François Bobot's avatar
François Bobot committed
480
481
482
483
484
485
486
487
488
489
490
  let sprover = ref Sprover.empty in
  session_iter_proof_attempt
    (fun pa -> sprover := Sprover.add pa.proof_prover !sprover)
    session;
  !sprover

exception NoTask

let goal_task g = Util.exn_option NoTask g.goal_task
let goal_task_option g = g.goal_task

491
let goal_expl g = Util.def_option g.goal_name.Ident.id_string g.goal_expl
François Bobot's avatar
François Bobot committed
492
493
494
495
496
497
498
499

(************************)
(* saving state on disk *)
(************************)
open Format

let db_filename = "why3session.xml"

MARCHE Claude's avatar
MARCHE Claude committed
500
501
502
503
504
505
506
507
508
509
510
511
let save_string fmt s =
  for i=0 to String.length s - 1 do
    match String.get s i with
      | '\"' -> pp_print_string fmt "&quot;"
      | '\'' -> pp_print_string fmt "&apos;"
      | '<' -> pp_print_string fmt "&lt;"
      | '>' -> pp_print_string fmt "&gt;"
      | '&' -> pp_print_string fmt "&amp;"
      | c -> pp_print_char fmt c
  done


François Bobot's avatar
François Bobot committed
512
513
514
515
516
517
518
519
let save_result fmt r =
  fprintf fmt "@\n<result status=\"%s\" time=\"%.2f\"/>"
    (match r.Call_provers.pr_answer with
       | Call_provers.Valid -> "valid"
       | Call_provers.Failure _ -> "failure"
       | Call_provers.Unknown _ -> "unknown"
       | Call_provers.HighFailure -> "highfailure"
       | Call_provers.Timeout -> "timeout"
520
       | Call_provers.OutOfMemory -> "outofmemory"
François Bobot's avatar
François Bobot committed
521
522
523
524
525
526
527
528
529
530
       | Call_provers.Invalid -> "invalid")
    r.Call_provers.pr_time

let save_status fmt s =
  match s with
    | Undone Unedited ->
        fprintf fmt "<unedited/>@\n"
    | Undone _ ->
        fprintf fmt "<undone/>@\n"
    | InternalFailure msg ->
MARCHE Claude's avatar
MARCHE Claude committed
531
532
        fprintf fmt "<internalfailure reason=\"%a\"/>@\n"
          save_string (Printexc.to_string msg)
François Bobot's avatar
François Bobot committed
533
534
535
536
537
    | Done r -> save_result fmt r


let opt lab fmt = function
  | None -> ()
MARCHE Claude's avatar
MARCHE Claude committed
538
  | Some s -> fprintf fmt "%s=\"%a\"@ " lab save_string s
François Bobot's avatar
François Bobot committed
539
540
541

let save_proof_attempt provers fmt _key a =
  fprintf fmt
542
543
    "@\n@[<v 1><proof@ prover=\"%i\"@ timelimit=\"%d\"@ \
memlimit=\"%d\"@ %aobsolete=\"%b\"@ archived=\"%b\">"
François Bobot's avatar
François Bobot committed
544
    (Mprover.find a.proof_prover provers) a.proof_timelimit
545
    a.proof_memlimit
546
547
    (opt "edited") a.proof_edited_as a.proof_obsolete
    a.proof_archived;
François Bobot's avatar
François Bobot committed
548
549
550
551
  save_status fmt a.proof_state;
  fprintf fmt "@]@\n</proof>"

let save_ident fmt id =
MARCHE Claude's avatar
MARCHE Claude committed
552
  fprintf fmt "name=\"%a\"" save_string id.Ident.id_string;
François Bobot's avatar
François Bobot committed
553
554
555
556
557
  match id.Ident.id_loc with
    | None -> ()
    | Some loc ->
      let file,lnum,cnumb,cnume = Loc.get loc in
      fprintf fmt
MARCHE Claude's avatar
MARCHE Claude committed
558
559
        "@ locfile=\"%a\"@ loclnum=\"%i\" loccnumb=\"%i\" loccnume=\"%i\""
        save_string file lnum cnumb cnume
François Bobot's avatar
François Bobot committed
560
561

let save_label fmt s =
MARCHE Claude's avatar
MARCHE Claude committed
562
  fprintf fmt "@\n@[<v 1><label@ name=\"%a\"/>@]" save_string s.Ident.lab_string
563

François Bobot's avatar
François Bobot committed
564
let rec save_goal provers fmt g =
565
  assert (Tc.string_of_shape g.goal_shape <> "");
François Bobot's avatar
François Bobot committed
566
  fprintf fmt
MARCHE Claude's avatar
MARCHE Claude committed
567
    "@\n@[<v 1><goal@ %a@ %asum=\"%a\"@ proved=\"%b\"@ \
568
expanded=\"%b\"@ shape=\"%a\">"
François Bobot's avatar
François Bobot committed
569
570
    save_ident g.goal_name
    (opt "expl") g.goal_expl
571
572
573
    save_string (Tc.string_of_checksum g.goal_checksum)
    g.goal_verified  g.goal_expanded
    save_string (Tc.string_of_shape g.goal_shape);
574
  Ident.Slab.iter (save_label fmt) g.goal_name.Ident.id_label;
François Bobot's avatar
François Bobot committed
575
576
  PHprover.iter (save_proof_attempt provers fmt) g.goal_external_proofs;
  PHstr.iter (save_trans provers fmt) g.goal_transformations;
François Bobot's avatar
François Bobot committed
577
  Mmetas_args.iter (save_metas provers fmt) g.goal_metas;
François Bobot's avatar
François Bobot committed
578
579
580
  fprintf fmt "@]@\n</goal>"

and save_trans provers fmt _ t =
MARCHE Claude's avatar
MARCHE Claude committed
581
582
  fprintf fmt "@\n@[<v 1><transf@ name=\"%a\"@ proved=\"%b\"@ expanded=\"%b\">"
    save_string t.transf_name t.transf_verified t.transf_expanded;
François Bobot's avatar
François Bobot committed
583
584
585
  List.iter (save_goal provers fmt) t.transf_goals;
  fprintf fmt "@]@\n</transf>"

François Bobot's avatar
François Bobot committed
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
and save_metas provers fmt _ m =
  fprintf fmt "@\n@[<v 1><metas@ proved=\"%b\"@ expanded=\"%b\">"
    m.metas_verified m.metas_expanded;
  let save_pos fmt pos =
    fprintf fmt "decl=\"%i\"@ \
    def=\"%i\"@ const=\"%i\"@ proj=\"%i\"@ \
    sum=\"%a\""
      pos.pos_decl pos.pos_def pos.pos_const pos.pos_proj
      save_string (Tc.string_of_checksum pos.pos_checksum) in
  let save_ts_pos fmt ts pos =
    fprintf fmt "@\n@[<v 1><ts_pos@ name=\"%a\"@ arity=\"%i\"@ \
    id=\"%i\"@ %a/>@]"
      save_string ts.ts_name.id_string (List.length ts.ts_args)
      (ts_hash ts) save_pos pos in
  let save_ls_pos fmt ls pos =
    (** TODO: add the signature? *)
    fprintf fmt "@\n@[<v 1><ls_pos@ name=\"%a\"@ id=\"%i\"@ decl=\"%i\"@ \
    def=\"%i\"@ const=\"%i\"@ proj=\"%i\"@ \
    sum=\"%a\"/>@]"
      save_string ls.ls_name.id_string
      (ls_hash ls) pos.pos_decl pos.pos_def pos.pos_const pos.pos_proj
      save_string (Tc.string_of_checksum pos.pos_checksum)
  in
  let save_pr_pos fmt pr pos =
    fprintf fmt "@\n@[<v 1><pr_pos@ name=\"%a\"@ id=\"%i\"@ decl=\"%i\"@ \
    def=\"%i\"@ const=\"%i\"@ proj=\"%i\"@ \
    sum=\"%a\"/>@]"
      save_string pr.pr_name.id_string
      (pr_hash pr) pos.pos_decl pos.pos_def pos.pos_const pos.pos_proj
      save_string (Tc.string_of_checksum pos.pos_checksum)
  in
  Mts.iter (save_ts_pos fmt) m.metas_idpos.idpos_ts;
  Mls.iter (save_ls_pos fmt) m.metas_idpos.idpos_ls;
  Mpr.iter (save_pr_pos fmt) m.metas_idpos.idpos_pr;
  Mstr.iter (fun s smeta_args ->
    Smeta_args.iter (save_meta_args fmt s) smeta_args) m.metas_added;
  save_goal provers fmt m.metas_goal;
  fprintf fmt "@]@\n</metas>"

and save_meta_args fmt s l =
  fprintf fmt "@\n@[<v 1><meta@ name=\"%a\">" save_string s;
  let save_meta_arg fmt = function
    | MAty ty -> fprintf fmt "@\n@[<v 1><meta_arg_ty/>";
      save_ty fmt ty;
      fprintf fmt "@]@\n</meta_arg_ty>"
    | MAts ts ->
      fprintf fmt "@\n@[<v 1><meta_arg_ts@ id=\"%i\"/>@]" (ts_hash ts)
    | MAls ls ->
      fprintf fmt "@\n@[<v 1><meta_arg_ls@ id=\"%i\"/>@]" (ls_hash ls)
    | MApr pr ->
      fprintf fmt "@\n@[<v 1><meta_arg_pr@ id=\"%i\"/>@]" (pr_hash pr)
    | MAstr s ->
      fprintf fmt "@\n@[<v 1><meta_arg_str@ val=\"%s\"/>@]" s
    | MAint i ->
      fprintf fmt "@\n@[<v 1><meta_arg_int@ val=\"%i\"/>@]" i
  in
  List.iter (save_meta_arg fmt) l;
  fprintf fmt "@]@\n</meta_args>"

and save_ty fmt ty =
  match ty.ty_node with
  | Tyvar tv ->
    fprintf fmt "@\n@[<v 1><ty_var@ id=\"%i\"/>@]" (tv_hash tv)
  | Tyapp (ts,l) ->
    fprintf fmt "@\n@[<v 1><ty_app@ id=\"%i\"/>" (ts_hash ts);
    List.iter (save_ty fmt) l;
    fprintf fmt "@]@\n</ty_app>"

François Bobot's avatar
François Bobot committed
654
655
656
657
658
let save_theory provers fmt t =
  fprintf fmt
    "@\n@[<v 1><theory@ %a@ verified=\"%b\"@ expanded=\"%b\">"
    save_ident t.theory_name
    t.theory_verified t.theory_expanded;
659
  Ident.Slab.iter (save_label fmt) t.theory_name.Ident.id_label;
François Bobot's avatar
François Bobot committed
660
661
662
663
  List.iter (save_goal provers fmt) t.theory_goals;
  fprintf fmt "@]@\n</theory>"

let save_file provers fmt _ f =
664
665
666
667
  fprintf fmt
    "@\n@[<v 1><file@ name=\"%a\"@ %averified=\"%b\"@ expanded=\"%b\">"
    save_string f.file_name (opt "format")
    f.file_format f.file_verified f.file_expanded;
François Bobot's avatar
François Bobot committed
668
669
670
671
  List.iter (save_theory provers fmt) f.file_theories;
  fprintf fmt "@]@\n</file>"

let save_prover fmt p (provers,id) =
672
  fprintf fmt "@\n@[<v 1><prover@ id=\"%i\"@ \
MARCHE Claude's avatar
MARCHE Claude committed
673
674
name=\"%a\"@ version=\"%a\"%a/>@]"
    id save_string p.C.prover_name save_string p.C.prover_version
675
676
    (fun fmt s -> if s <> "" then fprintf fmt "@ alternative=\"%a\""
        save_string s)
677
    p.C.prover_altern;
François Bobot's avatar
François Bobot committed
678
679
  Mprover.add p id provers, id+1

MARCHE Claude's avatar
MARCHE Claude committed
680
let save fname config session =
François Bobot's avatar
François Bobot committed
681
682
683
  let ch = open_out fname in
  let fmt = formatter_of_out_channel ch in
  fprintf fmt "<?xml version=\"1.0\" encoding=\"UTF-8\"?>@\n";
MARCHE Claude's avatar
MARCHE Claude committed
684
  fprintf fmt "<!DOCTYPE why3session SYSTEM \"%a\">@\n"
685
686
    save_string (Filename.concat (Whyconf.datadir (Whyconf.get_main config))
                   "why3session.dtd");
MARCHE Claude's avatar
MARCHE Claude committed
687
688
  fprintf fmt "@[<v 1><why3session@ name=\"%a\" shape_version=\"%d\">"
    save_string fname session.session_shape_version;
689
  let provers,_ = Sprover.fold (save_prover fmt) (get_used_provers session)
François Bobot's avatar
François Bobot committed
690
691
692
693
694
695
    (Mprover.empty,0) in
  PHstr.iter (save_file provers fmt) session.session_files;
  fprintf fmt "@]@\n</why3session>";
  fprintf fmt "@.";
  close_out ch

MARCHE Claude's avatar
MARCHE Claude committed
696
let save_session config session =
François Bobot's avatar
François Bobot committed
697
698
  let f = Filename.concat session.session_dir db_filename in
  Sysutil.backup_file f;
MARCHE Claude's avatar
MARCHE Claude committed
699
  save f config session
François Bobot's avatar
François Bobot committed
700
701
702
703
704
705
706
707
708
709

(*******************************)
(*          explanations       *)
(*******************************)

let expl_regexp = Str.regexp "expl:\\(.*\\)"

exception Found of string

let check_expl lab =
Andrei Paskevich's avatar
Andrei Paskevich committed
710
  let lab = lab.Ident.lab_string in
François Bobot's avatar
François Bobot committed
711
712
713
714
  if Str.string_match expl_regexp lab 0 then
    raise (Found (Str.matched_group 1 lab))

let rec get_expl_fmla f =
715
  Ident.Slab.iter check_expl f.Term.t_label;
François Bobot's avatar
François Bobot committed
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
  (match f.Term.t_node with
    | Term.Tbinop(Term.Timplies,_,f) -> get_expl_fmla f
    | Term.Tquant(Term.Tforall,fq) ->
      let (_,_,f) = Term.t_open_quant fq in get_expl_fmla f
    | Term.Tlet(_,fb) ->
      let (_,f) = Term.t_open_bound fb in get_expl_fmla f
    | Term.Tcase(_,[fb]) ->
      let (_,f) = Term.t_open_branch fb in get_expl_fmla f
    | _ -> ())

type expl = string option

let get_explanation id task =
  let fmla = Task.task_goal_fmla task in
  try
    get_expl_fmla fmla;
732
    Ident.Slab.iter check_expl id.Ident.id_label;
François Bobot's avatar
François Bobot committed
733
734
735
736
737
738
739
740
741
742
    None
  with Found e -> Some e


(*****************************)
(*   update verified field   *)
(*****************************)
type 'a notify = 'a any -> unit
let notify : 'a notify = fun _ -> ()

743
744
let file_verified f =
  List.for_all (fun t -> t.theory_verified) f.file_theories
François Bobot's avatar
François Bobot committed
745

746
747
748
749
750
let theory_verified t =
  List.for_all (fun g -> g.goal_verified) t.theory_goals

let transf_verified t =
  List.for_all (fun g -> g.goal_verified) t.transf_goals
François Bobot's avatar
François Bobot committed
751

François Bobot's avatar
François Bobot committed
752
753
let metas_verified m = m.metas_goal.goal_verified

François Bobot's avatar
François Bobot committed
754
755
756
757
758
759
let proof_verified a =
  (not a.proof_obsolete) &&
    match a.proof_state with
      | Done { Call_provers.pr_answer = Call_provers.Valid} -> true
      | _ -> false

760
let goal_verified g =
François Bobot's avatar
François Bobot committed
761
762
763
764
765
766
767
768
769
    try
      PHprover.iter
        (fun _ a ->
          if proof_verified a
          then raise Exit)
        g.goal_external_proofs;
      PHstr.iter
        (fun _ t -> if t.transf_verified then raise Exit)
        g.goal_transformations;
François Bobot's avatar
François Bobot committed
770
771
772
      Mmetas_args.iter
        (fun _ t -> if t.metas_verified then raise Exit)
        g.goal_metas;
François Bobot's avatar
François Bobot committed
773
774
      false
    with Exit -> true
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792

let check_file_verified notify f =
  let b = file_verified f in
  if f.file_verified <> b then begin
    f.file_verified <- b;
    notify (File f)
  end

let check_theory_proved notify t =
  let b = theory_verified t in
  if t.theory_verified <> b then begin
    t.theory_verified <- b;
    notify (Theory t);
    check_file_verified notify t.theory_parent
  end

let rec check_goal_proved notify g =
  let b = goal_verified g in
François Bobot's avatar
François Bobot committed
793
794
795
796
797
798
  if g.goal_verified <> b then begin
    g.goal_verified <- b;
    notify (Goal g);
    match g.goal_parent with
      | Parent_theory t -> check_theory_proved notify t
      | Parent_transf t -> check_transf_proved notify t
François Bobot's avatar
François Bobot committed
799
      | Parent_metas t -> check_metas_proved notify t
François Bobot's avatar
François Bobot committed
800
801
802
  end

and check_transf_proved notify t =
803
  let b = transf_verified t in
François Bobot's avatar
François Bobot committed
804
805
806
807
808
809
  if t.transf_verified <> b then begin
    t.transf_verified <- b;
    notify (Transf t);
    check_goal_proved notify t.transf_parent
  end

François Bobot's avatar
François Bobot committed
810
811
812
813
814
815
816
817
818

and check_metas_proved notify m =
  let b = metas_verified m in
  if m.metas_verified <> b then begin
    m.metas_verified <- b;
    notify (Metas m);
    check_goal_proved notify m.metas_parent
  end

François Bobot's avatar
François Bobot committed
819
820
821
822
823
824
825
(******************************)
(* raw additions to the model *)
(******************************)
type 'a keygen = ?parent:'a -> unit -> 'a

let add_external_proof
    ?(notify=notify)
826
    ~(keygen:'a keygen) ~obsolete
827
    ~archived ~timelimit ~memlimit ~edit (g:'a goal) p result =
828
  assert (edit <> Some "");
François Bobot's avatar
François Bobot committed
829
830
831
832
833
  let key = keygen ~parent:g.goal_key () in
  let a = { proof_prover = p;
            proof_parent = g;
            proof_key = key;
            proof_obsolete = obsolete;
834
            proof_archived = archived;
François Bobot's avatar
François Bobot committed
835
836
            proof_state = result;
            proof_timelimit = timelimit;
837
            proof_memlimit = memlimit;
François Bobot's avatar
François Bobot committed
838
839
840
            proof_edited_as = edit;
          }
  in
841
  PHprover.replace g.goal_external_proofs p a;
François Bobot's avatar
François Bobot committed
842
843
844
845
846
847
848
849
850
  check_goal_proved notify g;
  a

let remove_external_proof ?(notify=notify) a =
  let g = a.proof_parent in
  PHprover.remove g.goal_external_proofs a.proof_prover;
  check_goal_proved notify g


851
let set_proof_state ?(notify=notify) ~obsolete ~archived res a =
François Bobot's avatar
François Bobot committed
852
853
  a.proof_state <- res;
  a.proof_obsolete <- obsolete;
854
  a.proof_archived <- archived;
François Bobot's avatar
François Bobot committed
855
856
857
  notify (Proof_attempt a);
  check_goal_proved notify a.proof_parent

858
859
860
861
862
863
let change_prover a p =
  let g = a.proof_parent in
  PHprover.remove g.goal_external_proofs a.proof_prover;
  PHprover.add g.goal_external_proofs p a;
  a.proof_prover <- p;
  a.proof_obsolete <- true
864

François Bobot's avatar
François Bobot committed
865
866
867
let set_edited_as edited_as a = a.proof_edited_as <- edited_as

let set_timelimit timelimit a = a.proof_timelimit <- timelimit
868
let set_memlimit memlimit a = a.proof_memlimit <- memlimit
François Bobot's avatar
François Bobot committed
869

870
871
872
873
874
let set_obsolete ?(notify=notify) a =
  a.proof_obsolete <- true;
  notify (Proof_attempt a);
  check_goal_proved notify a.proof_parent

875
let set_archived a b = a.proof_archived <- b
876

877
878
879
let get_edited_as_abs session pr =
  option_map (Filename.concat session.session_dir) pr.proof_edited_as

François Bobot's avatar
François Bobot committed
880
881
882
883
884
885
886
(* [raw_add_goal parent name expl sum t] adds a goal to the given parent
   DOES NOT record the new goal in its parent, thus this should not be exported
*)
let raw_add_no_task ~(keygen:'a keygen) parent name expl sum shape exp =
  let parent_key = match parent with
    | Parent_theory mth -> mth.theory_key
    | Parent_transf mtr -> mtr.transf_key
François Bobot's avatar
François Bobot committed
887
    | Parent_metas  mms -> mms.metas_key
François Bobot's avatar
François Bobot committed
888
889
890
891
892
893
894
895
896
897
898
  in
  let key = keygen ~parent:parent_key () in
  let goal = { goal_name = name;
               goal_expl = expl;
               goal_parent = parent;
               goal_task = None ;
               goal_checksum = sum;
               goal_shape = shape;
               goal_key = key;
               goal_external_proofs = PHprover.create 7;
               goal_transformations = PHstr.create 3;
François Bobot's avatar
François Bobot committed
899
               goal_metas = Mmetas_args.empty;
François Bobot's avatar
François Bobot committed
900
901
902
903
904
905
               goal_verified = false;
               goal_expanded = exp;
             }
  in
  goal

906
let raw_add_task ~version ~(keygen:'a keygen) parent name expl t exp =
François Bobot's avatar
François Bobot committed
907
908
909
  let parent_key = match parent with
    | Parent_theory mth -> mth.theory_key
    | Parent_transf mtr -> mtr.transf_key
François Bobot's avatar
François Bobot committed
910
    | Parent_metas  mms -> mms.metas_key
François Bobot's avatar
François Bobot committed
911
912
  in
  let key = keygen ~parent:parent_key () in
913
914
  let sum = Termcode.task_checksum ~version t in
  let shape = Termcode.t_shape_buf ~version
915
    (Task.task_goal_fmla t) in
François Bobot's avatar
François Bobot committed
916
917
918
919
920
921
922
923
924
  let goal = { goal_name = name;
               goal_expl = expl;
               goal_parent = parent;
               goal_task = Some t ;
               goal_checksum = sum;
               goal_shape = shape;
               goal_key = key;
               goal_external_proofs = PHprover.create 7;
               goal_transformations = PHstr.create 3;
François Bobot's avatar
François Bobot committed
925
               goal_metas = Mmetas_args.empty;
François Bobot's avatar
François Bobot committed
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
               goal_verified = false;
               goal_expanded = exp;
             }
  in
  goal


(* [raw_add_transformation g name adds a transformation to the given goal g
   Adds no subgoals, thus this should not be exported
*)
let raw_add_transformation ~(keygen:'a keygen) g name exp =
  let parent = g.goal_key in
  let key = keygen ~parent () in
  let tr = { transf_name = name;
             transf_parent = g;
             transf_verified = false;
             transf_key = key;
             transf_goals = [];
             transf_expanded = exp;
           }
  in
947
  PHstr.replace g.goal_transformations name tr;
François Bobot's avatar
François Bobot committed
948
949
  tr

François Bobot's avatar
François Bobot committed
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
let raw_add_metas ~(keygen:'a keygen) g added idpos exp =
  let parent = g.goal_key in
  let key = keygen ~parent () in
  let ms = { metas_added = added;
             metas_idpos = idpos;
             metas_parent = g;
             metas_verified = false;
             metas_key = key;
             metas_goal = g;
             metas_expanded = exp;
           }
  in
  g.goal_metas <- Mmetas_args.add added ms g.goal_metas;
  ms

François Bobot's avatar
François Bobot committed
965
966
967
968
969
970
let raw_add_theory ~(keygen:'a keygen) mfile thname exp =
  let parent = mfile.file_key in
  let key = keygen ~parent () in
  let mth = { theory_name = thname;
              theory_key = key;
              theory_parent = mfile;
971
              theory_goals = [];
François Bobot's avatar
François Bobot committed
972
973
974
975
976
977
              theory_verified = false;
              theory_expanded = exp;
            }
  in
  mth

978
let raw_add_file ~(keygen:'a keygen) session f fmt exp =
François Bobot's avatar
François Bobot committed
979
980
981
  let key = keygen () in
  let mfile = { file_name = f;
                file_key = key;
982
983
                file_format = fmt;
                file_theories = [];
François Bobot's avatar
François Bobot committed
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
                file_verified = false;
                file_expanded = exp;
                file_parent  = session;
              }
  in
  PHstr.replace session.session_files f mfile;
  mfile


(****************************)
(*     session opening      *)
(****************************)

exception LoadError of Xml.element * string
(** LoadError (xml,messg) *)

let bool_attribute field r def =
For faster browsing, not all history is shown. View entire blame