itp_server.ml 48.4 KB
Newer Older
1
open Format
Sylvain Dailler's avatar
Sylvain Dailler committed
2
open Stdlib
3 4
open Session_itp
open Controller_itp
Sylvain Dailler's avatar
Sylvain Dailler committed
5
open Server_utils
6
open Itp_communication
7

Sylvain Dailler's avatar
Sylvain Dailler committed
8
exception Bad_prover_name of string
9 10 11 12 13 14 15 16 17

(**********************************)
(* list unproven goal and related *)
(**********************************)

(* If the transformation is proved, return acc.
   Else, return the concatenation of the reversed list of unproven
   goals below the transformation and acc *)
let rec unproven_goals_below_tn cont acc tn =
18 19
  let s = cont.controller_session in
  if tn_proved s tn then
20 21
    acc                         (* we ignore "dead" goals *)
  else
22
    let sub_tasks = get_sub_tasks s tn in
23 24 25 26 27
    List.fold_left (unproven_goals_below_pn cont) acc sub_tasks

(* Same as unproven_goals_below_tn; note that if goal is not proved
   and there is no transformation, goal is returned (else it is not) *)
and unproven_goals_below_pn cont acc goal =
28 29
  let s = cont.controller_session in
  if pn_proved s goal then
30 31
    acc                         (* we ignore "dead" transformations *)
  else
32
    match get_transformations s goal with
33 34 35 36 37
    | [] -> goal :: acc
    | tns -> List.fold_left (unproven_goals_below_tn cont) acc tns

(* Same as unproven_goals_below_tn *)
let unproven_goals_below_th cont acc th =
38 39
  let s = cont.controller_session in
  if th_proved s th then
40 41 42 43 44 45 46
    acc
  else
    let goals = theory_goals th in
    List.fold_left (unproven_goals_below_pn cont) acc goals

(* Same as unproven_goals_below_tn *)
let unproven_goals_below_file cont file =
47 48
  let s = cont.controller_session in
  if file_proved s file then
49 50
    []
  else
51
    let theories = file_theories file in
52 53
    List.fold_left (unproven_goals_below_th cont) [] theories

54 55 56 57 58 59 60 61 62 63 64 65 66
let unproven_goals_below_id cont id =
  match id  with
  | APn pnid   -> [pnid]
  | APa panid  ->
     let ses = cont.controller_session in
     [get_proof_attempt_parent ses panid]
  | ATn tn     ->
     List.rev (unproven_goals_below_tn cont [] tn)
  | AFile file ->
     List.rev (unproven_goals_below_file cont file)
  | ATh th     ->
     List.rev (unproven_goals_below_th cont [] th)

Sylvain Dailler's avatar
Sylvain Dailler committed
67 68 69 70
(*******************)
(* Strategies list *)
(*******************)
let loaded_strategies = ref []
71 72 73 74

(****** Exception handling *********)

let print_term s id fmt t =
75
  let tables = match (Session_itp.get_table s id) with
76 77 78 79 80
  | None -> Args_wrapper.build_name_tables (Session_itp.get_task s id)
  | Some tables -> tables in
  Why3printer.print_term tables fmt t

let print_type s id fmt t =
81
  let tables = match (Session_itp.get_table s id) with
82 83 84 85 86
  | None -> Args_wrapper.build_name_tables (Session_itp.get_task s id)
  | Some tables -> tables in
  Why3printer.print_ty tables fmt t

let print_ts s id fmt t =
87
  let tables = match (Session_itp.get_table s id) with
88 89 90 91 92
  | None -> Args_wrapper.build_name_tables (Session_itp.get_task s id)
  | Some tables -> tables in
  Why3printer.print_ts tables fmt t

let print_ls s id fmt t =
93
  let tables = match (Session_itp.get_table s id) with
94 95 96 97 98
  | None -> Args_wrapper.build_name_tables (Session_itp.get_task s id)
  | Some tables -> tables in
  Why3printer.print_ls tables fmt t

let print_tv s id fmt t =
99
  let tables = match (Session_itp.get_table s id) with
100 101 102 103 104
  | None -> Args_wrapper.build_name_tables (Session_itp.get_task s id)
  | Some tables -> tables in
  Why3printer.print_tv tables fmt t

let print_vsty s id fmt t =
105
  let tables = match (Session_itp.get_table s id) with
106 107 108 109 110
  | None -> Args_wrapper.build_name_tables (Session_itp.get_task s id)
  | Some tables -> tables in
  Why3printer.print_forget_vsty tables fmt t

let print_pr s id fmt t =
111
  let tables = match (Session_itp.get_table s id) with
112 113 114 115 116
  | None -> Args_wrapper.build_name_tables (Session_itp.get_task s id)
  | Some tables -> tables in
  Why3printer.print_pr tables fmt t

let print_pat s id fmt t =
117
  let tables = match (Session_itp.get_table s id) with
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 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
  | None -> Args_wrapper.build_name_tables (Session_itp.get_task s id)
  | Some tables -> tables in
  Why3printer.print_pat tables fmt t

(* Exception reporting *)

(* TODO remove references to id.id_string in this function *)
let bypass_pretty s id =
  begin fun fmt exn -> match exn with
  | Ty.TypeMismatch (t1,t2) ->
      fprintf fmt "Type mismatch between %a and %a"
        (print_type s id) t1 (print_type s id) t2
  | Ty.BadTypeArity ({Ty.ts_args = []} as ts, _) ->
      fprintf fmt "Type symbol %a expects no arguments" (print_ts s id) ts
  | Ty.BadTypeArity (ts, app_arg) ->
      let i = List.length ts.Ty.ts_args in
      fprintf fmt "Type symbol %a expects %i argument%s but is applied to %i"
        (print_ts s id) ts i (if i = 1 then "" else "s") app_arg
  | Ty.DuplicateTypeVar tv ->
      fprintf fmt "Type variable %a is used twice" (print_tv s id) tv
  | Ty.UnboundTypeVar tv ->
      fprintf fmt "Unbound type variable: %a" (print_tv s id) tv
  | Ty.UnexpectedProp ->
      fprintf fmt "Unexpected propositional type"
  | Term.BadArity ({Term.ls_args = []} as ls, _) ->
      fprintf fmt "%s %a expects no arguments"
        (if ls.Term.ls_value = None then "Predicate" else "Function") (print_ls s id) ls
  | Term.BadArity (ls, app_arg) ->
      let i = List.length ls.Term.ls_args in
      fprintf fmt "%s %a expects %i argument%s but is applied to %i"
        (if ls.Term.ls_value = None then "Predicate" else "Function")
        (print_ls s id) ls i (if i = 1 then "" else "s") app_arg
  | Term.EmptyCase ->
      fprintf fmt "Empty match expression"
  | Term.DuplicateVar vs ->
      fprintf fmt "Variable %a is used twice" (print_vsty s id) vs
  | Term.UncoveredVar vs ->
      fprintf fmt "Variable %a uncovered in \"or\"-pattern" (print_vsty s id) vs
  | Term.FunctionSymbolExpected ls ->
      fprintf fmt "Not a function symbol: %a" (print_ls s id) ls
  | Term.PredicateSymbolExpected ls ->
      fprintf fmt "Not a predicate symbol: %a" (print_ls s id) ls
  | Term.ConstructorExpected ls ->
      fprintf fmt "%s %a is not a constructor"
        (if ls.Term.ls_value = None then "Predicate" else "Function") (print_ls s id) ls
  | Term.TermExpected t ->
      fprintf fmt "Not a term: %a" (print_term s id) t
  | Term.FmlaExpected t ->
      fprintf fmt "Not a formula: %a" (print_term s id) t
  | Pattern.ConstructorExpected (ls,ty) ->
      fprintf fmt "%s %a is not a constructor of type %a"
        (if ls.Term.ls_value = None then "Predicate" else "Function") (print_ls s id) ls
        (print_type s id) ty
  | Pattern.NonExhaustive pl ->
      fprintf fmt "Pattern not covered by a match:@\n  @[%a@]"
        (print_pat s id) (List.hd pl)
  | Decl.BadConstructor ls ->
      fprintf fmt "Bad constructor: %a" (print_ls s id) ls
  | Decl.BadRecordField ls ->
      fprintf fmt "Not a record field: %a" (print_ls s id) ls
  | Decl.RecordFieldMissing (_cs,ls) ->
      fprintf fmt "Field %a is missing" (print_ls s id) ls
  | Decl.DuplicateRecordField (_cs,ls) ->
      fprintf fmt "Field %a is used twice in the same constructor" (print_ls s id) ls
  | Decl.IllegalTypeAlias ts ->
      fprintf fmt
        "Type symbol %a is a type alias and cannot be declared as algebraic"
        (print_ts s id) ts
  | Decl.NonFoundedTypeDecl ts ->
      fprintf fmt "Cannot construct a value of type %a" (print_ts s id) ts
  | Decl.NonPositiveTypeDecl (_ts, ls, ty) ->
      fprintf fmt "Constructor %a \
          contains a non strictly positive occurrence of type %a"
        (print_ls s id) ls (print_type s id) ty
  | Decl.InvalidIndDecl (_ls, pr) ->
      fprintf fmt "Ill-formed inductive clause %a"
        (print_pr s id) pr
  | Decl.NonPositiveIndDecl (_ls, pr, ls1) ->
      fprintf fmt "Inductive clause %a contains \
          a non strictly positive occurrence of symbol %a"
        (print_pr s id) pr (print_ls s id) ls1
  | Decl.BadLogicDecl (ls1,ls2) ->
      fprintf fmt "Ill-formed definition: symbols %a and %a are different"
        (print_ls s id) ls1 (print_ls s id) ls2
  | Decl.UnboundVar vs ->
      fprintf fmt "Unbound variable: %a" (print_vsty s id) vs
  | Decl.ClashIdent id ->
      fprintf fmt "Ident %s is defined twice" id.Ident.id_string
  | Decl.EmptyDecl ->
      fprintf fmt "Empty declaration"
  | Decl.EmptyAlgDecl ts ->
      fprintf fmt "Algebraic type %a has no constructors" (print_ts s id) ts
  | Decl.EmptyIndDecl ls ->
      fprintf fmt "Inductive predicate %a has no constructors" (print_ls s id) ls
  | Decl.KnownIdent id ->
      fprintf fmt "Ident %s is already declared" id.Ident.id_string
  | Decl.UnknownIdent id ->
      fprintf fmt "Ident %s is not yet declared" id.Ident.id_string
  | Decl.RedeclaredIdent id ->
      fprintf fmt "Ident %s is already declared, with a different declaration"
        id.Ident.id_string
  | Decl.NoTerminationProof ls ->
      fprintf fmt "Cannot prove the termination of %a" (print_ls s id) ls
  | _ -> Format.fprintf fmt "Uncaught: %a" Exn_printer.exn_printer exn
  end

let get_exception_message ses id fmt e =
  match e with
226 227
  | Controller_itp.Noprogress ->
      Format.fprintf fmt "Transformation made no progress\n"
228 229 230 231 232 233 234 235
  | Case.Arg_trans_type (s, ty1, ty2) ->
      Format.fprintf fmt "Error in transformation %s during unification of the following terms:\n %a \n %a"
        s (print_type ses id) ty1 (print_type ses id) ty2
  | Case.Arg_trans_term (s, t1, t2) ->
      Format.fprintf fmt "Error in transformation %s during unification of following two terms:\n %a \n %a" s
        (print_term ses id) t1 (print_term ses id) t2
  | Case.Arg_trans (s) ->
      Format.fprintf fmt "Error in transformation function: %s \n" s
Sylvain Dailler's avatar
Sylvain Dailler committed
236
  | Args_wrapper.Arg_hyp_not_found (s) ->
237 238 239 240 241 242 243 244
      Format.fprintf fmt "Following hypothesis was not found: %s \n" s
  | Args_wrapper.Arg_theory_not_found (s) ->
      Format.fprintf fmt "Theory not found: %s" s
  | e ->
      bypass_pretty ses id fmt e



Clément Fumex's avatar
Clément Fumex committed
245 246


Sylvain Dailler's avatar
Sylvain Dailler committed
247
(* Debugging functions *)
248 249
let print_request fmt r =
  match r with
250 251 252 253
  | Command_req (_nid, s)           -> fprintf fmt "command \"%s\"" s
  | Prove_req (_nid, prover, _rl)   -> fprintf fmt "prove with %s" prover
  | Transform_req (_nid, tr, _args) -> fprintf fmt "transformation :%s" tr
  | Strategy_req (_nid, st)         -> fprintf fmt "strategy %s" st
Sylvain Dailler's avatar
Sylvain Dailler committed
254
  | Edit_req (_nid, prover)         -> fprintf fmt "edit with %s" prover
255
(*
256
  | Open_session_req f              -> fprintf fmt "open session file %s" f
257
*)
258 259
  | Add_file_req f                  -> fprintf fmt "open file %s" f
  | Set_max_tasks_req i             -> fprintf fmt "set max tasks %i" i
260
  | Get_file_contents _f            -> fprintf fmt "get file contents"
261
  | Get_first_unproven_node _nid    -> fprintf fmt "get first unproven node"
262
  | Get_task _nid                   -> fprintf fmt "get task"
Sylvain Dailler's avatar
Sylvain Dailler committed
263 264
  | Focus_req _nid                  -> fprintf fmt "focus"
  | Unfocus_req                     -> fprintf fmt "unfocus"
265
  | Remove_subtree _nid             -> fprintf fmt "remove subtree"
Sylvain Dailler's avatar
Sylvain Dailler committed
266 267
  | Copy_paste _                    -> fprintf fmt "copy paste"
  | Copy_detached _                 -> fprintf fmt "copy detached"
268
  | Get_Session_Tree_req            -> fprintf fmt "get session tree"
269
  | Save_file_req _                 -> fprintf fmt "save file"
270
  | Mark_obsolete_req _             -> fprintf fmt "mark obsolete"
271
  | Clean_req                       -> fprintf fmt "clean"
272 273 274 275
  | Save_req                        -> fprintf fmt "save"
  | Reload_req                      -> fprintf fmt "reload"
  | Replay_req                      -> fprintf fmt "replay"
  | Exit_req                        -> fprintf fmt "exit"
276
  | Interrupt_req                   -> fprintf fmt "interrupt"
277

Sylvain Dailler's avatar
Sylvain Dailler committed
278 279
let print_msg fmt m =
  match m with
Sylvain Dailler's avatar
Sylvain Dailler committed
280 281 282 283 284 285 286 287 288 289 290 291 292
  | Proof_error (_ids, s)      -> fprintf fmt "proof error %s" s
  | Transf_error (_ids, s)     -> fprintf fmt "transf error %s" s
  | Strat_error (_ids, s)      -> fprintf fmt "start error %s" s
  | Replay_Info s              -> fprintf fmt "replay info %s" s
  | Query_Info (_ids, s)       -> fprintf fmt "query info %s" s
  | Query_Error (_ids, s)      -> fprintf fmt "query error %s" s
  | Help _s                    -> fprintf fmt "help"
  | Information s              -> fprintf fmt "info %s" s
  | Task_Monitor _             -> fprintf fmt "task montor"
  | Parse_Or_Type_Error (_, s) -> fprintf fmt "parse_or_type_error:\n %s" s
  | File_Saved s               -> fprintf fmt "file saved %s" s
  | Error s                    -> fprintf fmt "%s" s
  | Open_File_Error s          -> fprintf fmt "%s" s
Sylvain Dailler's avatar
Sylvain Dailler committed
293

294 295 296 297 298 299 300 301 302 303 304
(* TODO ad hoc printing. Should reuse print_loc. *)
let print_loc fmt (loc: Loc.position) =
  let (f,l,b,e) = Loc.get loc in
   fprintf fmt "File \"%s\", line %d, characters %d-%d" f l b e

let print_list_loc fmt l =
  Pp.print_list
    (fun _fmt () -> ())
    (fun fmt (loc, _c) -> Format.fprintf fmt "(%a, color)" print_loc loc)
    fmt l

Sylvain Dailler's avatar
Sylvain Dailler committed
305 306
let print_notify fmt n =
  match n with
307 308 309 310
  | Node_change (ni, nf)               ->
      begin
        match nf with
        | Proved b -> fprintf fmt "node change %d Proved %b" ni b
311
(*
312
        | Obsolete b -> fprintf fmt "node change %d Obsolete %b" ni b
313
*)
314 315 316
        | Proof_status_change(st,b,_lim) ->
           fprintf fmt "node change %d Proof_status_change res=%a obsolete=%b limits=<TODO>"
                   ni Controller_itp.print_status st b
317
      end
318 319
  | New_node (ni, _pni, _nt,  _nf, _d) -> fprintf fmt "new node %d" ni
  | Remove _ni                         -> fprintf fmt "remove"
320
  | Next_Unproven_Node_Id (_ni, _nj)   -> fprintf fmt "next unproven node_id"
321 322 323
  | Initialized _gi                    -> fprintf fmt "initialized"
  | Saved                              -> fprintf fmt "saved"
  | Message msg                        ->
Sylvain Dailler's avatar
Sylvain Dailler committed
324
      print_msg fmt msg
325
  | Dead s                             -> fprintf fmt "dead :%s" s
326
  | File_contents (_f, _s)             -> fprintf fmt "file contents"
327 328 329
  | Task (ni, _s, list_loc)            ->
      fprintf fmt "task for node_ID %d which contains a list of loc %a"
        ni print_list_loc list_loc
Sylvain Dailler's avatar
Sylvain Dailler committed
330

Clément Fumex's avatar
Clément Fumex committed
331
module type Protocol = sig
Clément Fumex's avatar
Clément Fumex committed
332 333
  val get_requests : unit -> ide_request list
  val notify : notification -> unit
Clément Fumex's avatar
Clément Fumex committed
334 335
end

Sylvain Dailler's avatar
Sylvain Dailler committed
336
module Make (S:Controller_itp.Scheduler) (Pr:Protocol) = struct
337 338

  module C = Controller_itp.Make(S)
Clément Fumex's avatar
Clément Fumex committed
339

340
let debug = Debug.register_flag "itp_server" ~desc:"ITP server"
Clément Fumex's avatar
Clément Fumex committed
341

342 343 344 345 346

(****************)
(* Command list *)
(****************)

347
let interrupt_query _cont _args = C.interrupt (); "interrupted"
348

349 350 351 352 353 354 355 356 357 358 359 360 361
let commands_table = Stdlib.Hstr.create 17

let register_command c d f = Stdlib.Hstr.add commands_table c (d,f)

let () =
  List.iter (fun (c,d,f) -> register_command c d f)
    [
    "interrupt", "interrupt all scheduled or running proof tasks",
    Qnotask interrupt_query;
    "list-transforms", "list available transformations",
    Qnotask list_transforms_query;
    "list-provers", "list available provers",
    Qnotask list_provers;
362 363 364
(*
    "list-strategies", "list available strategies", list_strategies;
*)
365 366 367 368
    "print", "<id> print the declaration where <id> was defined",
    Qtask print_id;
    "search", "<is> print declarations where <id> appears",
    Qtask search_id;
369 370 371 372 373 374 375 376 377 378 379 380
(*
    "r", "reload the session (test only)", test_reload;
    "s", "save the current session", test_save_session;
    "ng", "go to the next goal", then_print (move_to_goal_ret_p next_node);
    "pg", "go to the prev goal", then_print (move_to_goal_ret_p prev_node);
    "gu", "go to the goal up",  then_print (move_to_goal_ret_p zipper_up);
    "gd", "go to the goal down",  then_print (move_to_goal_ret_p zipper_down);
    "gr", "go to the goal right",  then_print (move_to_goal_ret_p zipper_right);
    "gl", "go to the goal left",  then_print (move_to_goal_ret_p zipper_left)
 *)
  ]

381
  type server_data =
382
    { task_driver : Driver.driver;
383 384
      cont : Controller_itp.controller;
    }
Clément Fumex's avatar
Clément Fumex committed
385

386
  let server_data = ref None
Clément Fumex's avatar
Clément Fumex committed
387

388
  let get_server_data () =
389 390 391 392 393
    match !server_data with
    | None ->
       Format.eprintf "[ITP server] not yet initialized@.";
       exit 1
    | Some x -> x
Clément Fumex's avatar
Clément Fumex committed
394

Sylvain Dailler's avatar
Sylvain Dailler committed
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
(* fresh gives new fresh "names" for node_ID using a counter.
   reset resets the counter so that we can regenerate node_IDs as if session
   was fresh *)
  let reset, fresh =
    let count = ref 0 in
    (fun () ->
      count := 0),
    fun () ->
      count := !count + 1;
      !count

  let model_any : any Hint.t = Hint.create 17

  let any_from_node_ID (nid:node_ID) : any = Hint.find model_any nid

  let pan_to_node_ID  : node_ID Hpan.t = Hpan.create 17
  let pn_to_node_ID   : node_ID Hpn.t = Hpn.create 17
  let tn_to_node_ID   : node_ID Htn.t = Htn.create 17
  let th_to_node_ID   : node_ID Ident.Hid.t = Ident.Hid.create 7
  let file_to_node_ID : node_ID Hstr.t = Hstr.create 3

  let node_ID_from_pan  pan  = Hpan.find pan_to_node_ID pan
  let node_ID_from_pn   pn   = Hpn.find pn_to_node_ID pn
  let node_ID_from_tn   tn   = Htn.find tn_to_node_ID tn
  let node_ID_from_th   th   = Ident.Hid.find th_to_node_ID (theory_name th)
420
  let node_ID_from_file file = Hstr.find file_to_node_ID (file_name file)
Sylvain Dailler's avatar
Sylvain Dailler committed
421 422 423 424 425 426 427 428 429 430 431 432

  let node_ID_from_any  any  =
    match any with
    | AFile file -> node_ID_from_file file
    | ATh th     -> node_ID_from_th th
    | ATn tn     -> node_ID_from_tn tn
    | APn pn     -> node_ID_from_pn pn
    | APa pan    -> node_ID_from_pan pan

  let remove_any_node_ID any =
    match any with
    | AFile file ->
433
        let nid = Hstr.find file_to_node_ID (file_name file) in
Sylvain Dailler's avatar
Sylvain Dailler committed
434
        Hint.remove model_any nid;
435
        Hstr.remove file_to_node_ID (file_name file)
Sylvain Dailler's avatar
Sylvain Dailler committed
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
    | ATh th     ->
        let nid = Ident.Hid.find th_to_node_ID (theory_name th) in
        Hint.remove model_any nid;
        Ident.Hid.remove th_to_node_ID (theory_name th)
    | ATn tn     ->
        let nid = Htn.find tn_to_node_ID tn in
        Hint.remove model_any nid;
        Htn.remove tn_to_node_ID tn
    | APn pn     ->
        let nid = Hpn.find pn_to_node_ID pn in
        Hint.remove model_any nid;
        Hpn.remove pn_to_node_ID pn
    | APa pa     ->
        let nid = Hpan.find pan_to_node_ID pa in
        Hint.remove model_any nid;
        Hpan.remove pan_to_node_ID pa

  let get_prover p =
    let d = get_server_data () in
    match return_prover p d.cont.controller_config with
    | None -> raise (Bad_prover_name p)
    | Some c -> c

  let add_node_to_table node new_id =
    match node with
461
    | AFile file -> Hstr.add file_to_node_ID (file_name file) new_id
Sylvain Dailler's avatar
Sylvain Dailler committed
462 463 464 465 466 467
    | ATh th     -> Ident.Hid.add th_to_node_ID (theory_name th) new_id
    | ATn tn     -> Htn.add tn_to_node_ID tn new_id
    | APn pn     -> Hpn.add pn_to_node_ID pn new_id
    | APa pan    -> Hpan.add pan_to_node_ID pan new_id


468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
(*******************************)
(* Compute color for locations *)
(*******************************)

(* This section is used to get colored source as a function of the task *)


(* These functions append stuff to a list which will then be passed to the
   Task notification. *)
let color_loc list ~color ~loc =
  let d = get_server_data () in
  let (f,l,b,e) = Loc.get loc in
  let f = Sysutil.relativize_filename
    (Session_itp.get_dir d.cont.controller_session) f in
  let loc = Loc.user_position f l b e in
  list := (loc, color) :: !list

let rec color_locs list ~color formula =
  let b = ref false in
  Opt.iter (fun loc -> color_loc list ~color ~loc; b := true) formula.Term.t_loc;
  Term.t_fold (fun b subf -> color_locs list ~color subf || b) !b formula

let rec color_t_locs list f =
  let premise_tag = function
    | { Term.t_node = Term.Tnot _; t_loc = None } -> Neg_premise_color
    | _ -> Premise_color
  in
  match f.Term.t_node with
    | Term.Tbinop (Term.Timplies,f1,f2) ->
        let b = color_locs list ~color:(premise_tag f1) f1 in
        color_t_locs list f2 || b
    | Term.Tlet (t,fb) ->
        let _,f1 = Term.t_open_bound fb in
        let b = color_locs list ~color:(premise_tag t) t in
        color_t_locs list f1 || b
    | Term.Tquant (Term.Tforall,fq) ->
        let _,_,f1 = Term.t_open_quant fq in
        color_t_locs list f1
    | _ ->
        color_locs list ~color:Goal_color f

exception No_loc_on_goal

let color_goal list loc =
  match loc with
513 514 515 516 517 518 519 520
  | None ->
      (* This case can happen when after some transformations: for example, in
         an assert, the new goal asserted is not tagged with locations *)
      (* This error is harmless but we want to detect it when debugging. *)
      if Debug.test_flag Debug.stack_trace then
        raise No_loc_on_goal
      else
        ()
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
  | Some loc -> color_loc list ~color:Goal_color ~loc

let get_locations list (task: Task.task) =
  let goal_id : Ident.ident = (Task.task_goal task).Decl.pr_name in
  color_goal list goal_id.Ident.id_loc;
  match task with
    | Some
        { Task.task_decl =
            { Theory.td_node =
                Theory.Decl { Decl.d_node = Decl.Dprop (Decl.Pgoal, _, f)}}} ->
        if not (color_t_locs list f) then
          Opt.iter (fun loc -> color_loc list ~color:Goal_color ~loc) goal_id.Ident.id_loc
    | _ ->
        assert false

let get_locations t =
  let l = ref [] in
  get_locations l t;
  !l

Sylvain Dailler's avatar
Sylvain Dailler committed
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
let get_modified_node n =
  match n with
  | New_node (nid, _, _, _, _) -> Some nid
  | Node_change  (nid, _) -> Some nid
  | Remove nid -> Some nid
  | Next_Unproven_Node_Id (_, nid) -> Some nid
  | Initialized _ -> None
  | Saved -> None
  | Message _ -> None
  | Dead _ -> None
  | Task (nid, _, _) -> Some nid
  | File_contents _ -> None

(* Focus on a node *)
let focused_node = ref None

(* TODO *)
module P = struct

  let get_requests = Pr.get_requests

562 563 564 565 566 567 568 569
  (* true if nid is below f_node or does not exists (in which case the
     notification is a remove). false if not below.  *)
  let is_below s nid f_node =
    let any = try Some (any_from_node_ID nid) with _ -> None in
    match any with
    | None -> true
    | Some any -> Session_itp.is_below s any f_node

Sylvain Dailler's avatar
Sylvain Dailler committed
570 571 572 573 574 575 576 577 578
  let notify n =
    let d = get_server_data() in
    let s = d.cont.controller_session in
    match !focused_node with
    | None -> Pr.notify n
    | Some f_node ->
        let updated_node = get_modified_node n in
        match updated_node with
        | None -> Pr.notify n
579 580
        | Some nid when is_below s nid f_node ->
            Pr.notify n
Sylvain Dailler's avatar
Sylvain Dailler committed
581 582 583 584
        | _ -> ()

end

585 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
  (*********************)
  (* File input/output *)
  (*********************)

  let read_and_send f =
    try
      let d = get_server_data() in
      let fn = Sysutil.absolutize_filename
          (Session_itp.get_dir d.cont.controller_session) f in
      let s = Sysutil.file_contents fn in
      P.notify (File_contents (f, s))
    with Invalid_argument s ->
      P.notify (Message (Error s))

  let save_file f file_content =
    try
      let d = get_server_data() in
      let fn = Sysutil.absolutize_filename
          (Session_itp.get_dir d.cont.controller_session) f in
      Sysutil.write_file fn file_content;
      P.notify (Message (File_Saved f))
    with Invalid_argument s ->
      P.notify (Message (Error s))

  (* Send source file from the controller to the IDE even if the controller's
     status is not correct *)
  let load_files_session () =
    let d = get_server_data () in
    let s = d.cont.controller_session in
    let files = Session_itp.get_files s in
615
    Stdlib.Hstr.iter (fun _ f ->
616 617
                      Format.eprintf "File : %s@." (file_name f);
                      read_and_send (file_name f)) files
618

Sylvain Dailler's avatar
Sylvain Dailler committed
619 620 621 622 623
  let relativize_location s loc =
    let f, l, b, e = Loc.get loc in
    let f = Sysutil.relativize_filename (Session_itp.get_dir s) f in
    Loc.user_position f l b e

624 625 626
  (* Reload_files that is used even if the controller is not correct. It can
     be incorrect and end up in a correct state. *)
  let reload_files cont ~use_shapes =
627
    try reload_files cont ~use_shapes; true with
Sylvain Dailler's avatar
Sylvain Dailler committed
628 629 630 631 632 633
    | Loc.Located (loc, e) ->
      let loc = relativize_location cont.controller_session loc in
      let s = Format.asprintf "%a at %a@."
          Exn_printer.exn_printer e Pretty.print_loc loc in
      P.notify (Message (Parse_Or_Type_Error (loc, s)));
      false
634 635
    | e ->
      let s = Format.asprintf "%a@." Exn_printer.exn_printer e in
Sylvain Dailler's avatar
Sylvain Dailler committed
636
      P.notify (Message (Parse_Or_Type_Error (Loc.dummy_position, s)));
637 638
      false

Sylvain Dailler's avatar
Sylvain Dailler committed
639 640 641 642 643 644 645 646
  let add_file cont ?format fname =
    try add_file cont ?format fname; true with
    | Loc.Located (loc, e) ->
      let loc = relativize_location cont.controller_session loc in
      let s = Format.asprintf "%a at %a@."
          Exn_printer.exn_printer e Pretty.print_loc loc in
      P.notify (Message (Parse_Or_Type_Error (loc, s)));
      false
647
    | e ->
Sylvain Dailler's avatar
Sylvain Dailler committed
648 649 650
      let s = Format.asprintf "%a@." Exn_printer.exn_printer e in
      P.notify (Message (Parse_Or_Type_Error (Loc.dummy_position, s)));
      false
651

652
  let task_driver config env =
653 654
    try
      let main = Whyconf.get_main config in
MARCHE Claude's avatar
MARCHE Claude committed
655 656
      let d = "why3_itp" in
      let d = Whyconf.load_driver main env d [] in
657 658 659
      Debug.dprintf debug "[ITP server] driver for task printing loaded@.";
      d
    with e ->
660 661
      Format.eprintf "Fatal error while loading itp driver: %a@." Exn_printer.exn_printer e;
      exit 1
Clément Fumex's avatar
Clément Fumex committed
662

Sylvain Dailler's avatar
Sylvain Dailler committed
663 664

  (* -----------------------------------   ------------------------------------- *)
Clément Fumex's avatar
Clément Fumex committed
665

666 667 668
  let get_node_type (node: any) =
    match node with
    | AFile _ -> NFile
Sylvain Dailler's avatar
Sylvain Dailler committed
669 670 671 672
    | ATh _   -> NTheory
    | ATn _   -> NTransformation
    | APn _   -> NGoal
    | APa _   -> NProofAttempt
673 674

  let get_node_name (node: any) =
675
    let d = get_server_data () in
676
    match node with
677 678
    | AFile file -> file_name file
    | ATh th -> (theory_name th).Ident.id_string
679
    | ATn tn ->
680 681 682 683 684 685
       let name = get_transf_name d.cont.controller_session tn in
       let args = get_transf_args d.cont.controller_session tn in
       let full = String.concat " " (name :: args) in
       if String.length full >= 40 then
         String.sub full 0 40 ^ " ..."
       else full
686
    | APn pn ->
687
       let name = (get_proof_name d.cont.controller_session pn).Ident.id_string in
MARCHE Claude's avatar
MARCHE Claude committed
688
       let expl = get_proof_expl d.cont.controller_session pn in
689
       if expl = "" then name else name ^ " [" ^ expl ^ "]"
690
    | APa pa ->
691
      let pa = get_proof_attempt_node d.cont.controller_session pa in
692 693
      Pp.string_of Whyconf.print_prover pa.prover

694 695 696 697
  let get_node_detached (node: any) =
    let d = get_server_data () in
    is_detached d.cont.controller_session node

698 699 700
  let get_node_proved new_id (node: any) =
    let d = get_server_data () in
    let cont = d.cont in
701
    let s = cont.controller_session in
702
    match node with
703
    | AFile file ->
704
      P.notify (Node_change (new_id, Proved (file_proved s file)))
705
    | ATh th ->
706
      P.notify (Node_change (new_id, Proved (th_proved s th)))
707
    | ATn tn ->
708
      P.notify (Node_change (new_id, Proved (tn_proved s tn)))
709
    | APn pn ->
710
      P.notify (Node_change (new_id, Proved (pn_proved s pn)))
711
    | APa pa ->
712
      let pa = get_proof_attempt_node s pa in
713 714 715
      let obs = pa.proof_obsolete in
      let limit = pa.limit in
      let res =
716
        match pa.Session_itp.proof_state with
717 718 719 720 721
        | Some pa -> Done pa
        | _ -> InternalFailure Not_found
      in
      P.notify (Node_change (new_id, Proof_status_change(res, obs, limit)))

722

723
(*
Sylvain Dailler's avatar
Sylvain Dailler committed
724 725 726 727 728
  let get_info_and_type ses (node: any) =
    match node with
    | AFile file ->
        let name = file.file_name in
        let proved = file_proved cont file in
729
        NFile, {name; proved}
Sylvain Dailler's avatar
Sylvain Dailler committed
730 731 732
    | ATh th     ->
        let name = (theory_name th).Ident.id_string in
        let proved = th_proved cont th in
733
        NTheory, {name; proved}
Sylvain Dailler's avatar
Sylvain Dailler committed
734 735 736
    | ATn tn     ->
        let name = get_transf_name ses tn in
        let proved = tn_proved cont tn in
737
        NTransformation, {name; proved}
Sylvain Dailler's avatar
Sylvain Dailler committed
738 739 740
    | APn pn     ->
        let name = (get_proof_name ses pn).Ident.id_string in
        let proved = pn_proved cont pn in
741
          NGoal, {name; proved}
Sylvain Dailler's avatar
Sylvain Dailler committed
742 743 744
    | APa pan    ->
        let pa = get_proof_attempt_node ses pan in
        let name = Pp.string_of Whyconf.print_prover pa.prover in
Clément Fumex's avatar
Clément Fumex committed
745 746 747
        let pr, proved = match pa.Session_itp.proof_state with
        | Some pr -> Some pr.pr_answer, pr.pr_answer = Valid
        | None -> None, false
Sylvain Dailler's avatar
Sylvain Dailler committed
748
        in
Clément Fumex's avatar
Clément Fumex committed
749 750
        (NProofAttempt (pr, pa.proof_obsolete)),
        {name; proved}
751
*)
Sylvain Dailler's avatar
Sylvain Dailler committed
752

Sylvain Dailler's avatar
Sylvain Dailler committed
753
  (* Create a new node in the_tree, update the tables and send a
Clément Fumex's avatar
Clément Fumex committed
754
     notification about it *)
Sylvain Dailler's avatar
Sylvain Dailler committed
755
  let new_node ~parent node : node_ID =
756 757
    let new_id = fresh () in
      Hint.add model_any new_id node;
758 759
      let node_type = get_node_type node in
      let node_name = get_node_name node in
760
      let node_detached = get_node_detached node in
Sylvain Dailler's avatar
Sylvain Dailler committed
761
      add_node_to_table node new_id;
762
      P.notify (New_node (new_id, parent, node_type, node_name, node_detached));
763 764
      if node_type = NFile then
        read_and_send node_name;
765
      get_node_proved new_id node;
Clément Fumex's avatar
Clément Fumex committed
766 767
      new_id

Sylvain Dailler's avatar
Sylvain Dailler committed
768 769 770
  (****************************)
  (* Iter on the session tree *)
  (****************************)
Sylvain Dailler's avatar
Sylvain Dailler committed
771

772 773 774 775
  (* Iter on the session tree with a function [f parent current] with type
     node_ID -> any -> unit *)
  let iter_subtree_proof_attempt_from_goal
    (f: parent:node_ID -> any -> unit) parent id =
776
    let d = get_server_data () in
Clément Fumex's avatar
Clément Fumex committed
777
    Whyconf.Hprover.iter
778
      (fun _pa panid -> f ~parent (APa panid))
779
      (get_proof_attempt_ids d.cont.controller_session id)
Clément Fumex's avatar
Clément Fumex committed
780

781 782
  let rec iter_subtree_from_goal
    (f: parent:node_ID -> any -> unit) parent id =
783 784
    let d = get_server_data () in
    let ses = d.cont.controller_session in
785 786
    f ~parent (APn id);
    let nid = node_ID_from_pn id in
Clément Fumex's avatar
Clément Fumex committed
787
    List.iter
788
      (fun trans_id -> iter_subtree_from_trans f nid trans_id)
Clément Fumex's avatar
Clément Fumex committed
789
      (get_transformations ses id);
790
    iter_subtree_proof_attempt_from_goal f nid id
Clément Fumex's avatar
Clément Fumex committed
791

792 793
  and iter_subtree_from_trans
    (f: parent:node_ID -> any -> unit) parent trans_id =
794 795
    let d = get_server_data () in
    let ses = d.cont.controller_session in
796 797
    f ~parent (ATn trans_id);
    let nid = node_ID_from_tn trans_id in
Clément Fumex's avatar
Clément Fumex committed
798
    List.iter
799
      (fun goal_id -> (iter_subtree_from_goal f nid goal_id))
Sylvain Dailler's avatar
Sylvain Dailler committed
800
      (get_sub_tasks ses trans_id)
Clément Fumex's avatar
Clément Fumex committed
801

802 803 804 805 806 807 808 809 810 811 812
  let iter_subtree_from_theory
    (f: parent:node_ID -> any -> unit) parent theory_id =
    f ~parent (ATh theory_id);
    let nid = node_ID_from_th theory_id in
    List.iter (iter_subtree_from_goal f nid)
               (theory_goals theory_id)

  let iter_subtree_from_file
    (f: parent:node_ID -> any -> unit) parent file =
    f ~parent (AFile file);
    let nid = node_ID_from_file file in
813
    List.iter (iter_subtree_from_theory f nid) (file_theories file)
814 815

  let iter_the_files (f: parent:node_ID -> any -> unit) parent : unit =
816 817
    let d = get_server_data () in
    let ses = d.cont.controller_session in
Clément Fumex's avatar
Clément Fumex committed
818 819 820
    let files = get_files ses in
    Stdlib.Hstr.iter
      (fun _ file ->
821
        iter_subtree_from_file f parent file)
Sylvain Dailler's avatar
Sylvain Dailler committed
822
      files
Clément Fumex's avatar
Clément Fumex committed
823

Sylvain Dailler's avatar
Sylvain Dailler committed
824 825 826 827
  (**********************************)
  (* Initialization of session tree *)
  (**********************************)

828 829
  let _init_the_tree (): unit =
    let f ~parent node_id = ignore (new_node ~parent node_id) in
Sylvain Dailler's avatar
Sylvain Dailler committed
830
    iter_the_files f root_node
831 832

  let init_and_send_subtree_from_trans parent trans_id : unit =
Clément Fumex's avatar
Clément Fumex committed
833 834
    iter_subtree_from_trans
      (fun ~parent id -> ignore (new_node ~parent id)) parent trans_id
835

Sylvain Dailler's avatar
Sylvain Dailler committed
836 837
  let init_and_send_file f =
    iter_subtree_from_file (fun ~parent id -> ignore (new_node ~parent id))
Sylvain Dailler's avatar
Sylvain Dailler committed
838
      root_node f
Sylvain Dailler's avatar
Sylvain Dailler committed
839

840
  let init_and_send_the_tree (): unit =
Sylvain Dailler's avatar
Sylvain Dailler committed
841
    iter_the_files (fun ~parent id -> ignore (new_node ~parent id)) root_node
842 843 844 845

  let resend_the_tree (): unit =
    let send_node ~parent any =
      let node_id = node_ID_from_any any in
846 847
      let node_name = get_node_name any in
      let node_type = get_node_type any in
848
      let node_detached = get_node_detached any in
849 850
      P.notify (New_node (node_id, parent, node_type, node_name, node_detached));
      get_node_proved node_id any in
Sylvain Dailler's avatar
Sylvain Dailler committed
851
    iter_the_files send_node root_node
852

853

Clément Fumex's avatar
Clément Fumex committed
854
  (* -- send the task -- *)
855 856
  let task_of_id d id =
    let task = get_task d.cont.controller_session id in
857
    let tables = get_table d.cont.controller_session id in
858 859
    (* This function also send source locations associated to the task *)
    let loc_color_list = get_locations task in
860 861
    Pp.string_of
      (Driver.print_task ~cntexample:false ?name_table:tables d.task_driver)
862
      task, loc_color_list
863

Clément Fumex's avatar
Clément Fumex committed
864
  let send_task nid =
865
    let d = get_server_data () in
Clément Fumex's avatar
Clément Fumex committed
866 867
    match any_from_node_ID nid with
    | APn id ->
868 869
       let s, list_loc = task_of_id d id in
       P.notify (Task (nid, s, list_loc))
870
    | ATh t ->
871
       P.notify (Task (nid, "Theory " ^ (theory_name t).Ident.id_string, []))
872
    | APa pid ->
873 874 875
       let pa = get_proof_attempt_node  d.cont.controller_session pid in
       let parid = pa.parent in
       let name = Pp.string_of Whyconf.print_prover pa.prover in
876 877
       let s, list_loc = task_of_id d parid in
       P.notify (Task (nid,s ^ "\n====================> Prover: " ^ name ^ "\n", list_loc))
878
    | AFile f ->
879
       P.notify (Task (nid, "File " ^ file_name f, []))
880 881 882
    | ATn tid ->
       let name = get_transf_name d.cont.controller_session tid in
       let args = get_transf_args d.cont.controller_session tid in
883
       let parid = get_trans_parent d.cont.controller_session tid in
884 885
       let s, list_loc = task_of_id d parid in
       P.notify (Task (nid, s ^ "\n====================> Transformation: " ^ String.concat " " (name :: args) ^ "\n", list_loc))
886

Sylvain Dailler's avatar
Sylvain Dailler committed
887 888 889 890 891 892 893
  (* -------------------- *)

  (* Add a file into the session when (Add_file_req f) is sent *)
  (* Note that f is the path from execution directory to the file and fn is the
     path from the session directory to the file. *)
  let add_file_to_session cont f =
    let fn = Sysutil.relativize_filename
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
      (get_dir cont.controller_session) f in
    let fn_exists =
      try Some (get_file cont.controller_session fn)
      with | Not_found -> None
    in
    match fn_exists with
    | None ->
        if (Sys.file_exists f) then
          begin
            let b = add_file cont f in
            if b then
              let file = get_file cont.controller_session fn in
              init_and_send_file file
          end
        else
          P.notify (Message (Open_File_Error ("File not found: " ^ f)))
    | Some _ -> P.notify (Message (Open_File_Error ("File already in session: " ^ fn)))
911 912


913
  (* ------------ init server ------------ *)
914

915 916 917 918 919 920 921 922 923
  let init_server config env f =
    Debug.dprintf debug "[ITP server] loading session %s@." f;
    let ses,use_shapes = Session_itp.load_session f in
    Debug.dprintf debug "[ITP server] creating controller@.";
    let c = create_controller config env ses in
    let task_driver = task_driver config env in
    server_data := Some
                     { task_driver = task_driver;
                       cont = c };
924
    let d = get_server_data () in
MARCHE Claude's avatar
MARCHE Claude committed
925 926 927 928 929
    let prover_list =
      Mstr.fold (fun x p acc ->
                 let n = Pp.sprintf "%a" Whyconf.print_prover p in
                 (x,n) :: acc) (Whyconf.get_prover_shortcuts config) []
    in
930 931
    let transformation_list = List.map fst (list_transforms ()) in
    let strategies_list =
932
      let l = strategies d.cont.controller_env config loaded_strategies in
933 934 935 936 937 938 939 940
      List.map (fun (a,_,_,_) -> a) l
    in
    let infos =
      {
        provers = prover_list;
        transformations = transformation_list;
        strategies = strategies_list;
        commands =
941
          Hstr.fold (fun c _ acc -> c :: acc) commands_table []
942 943
      }
    in
944 945 946 947 948 949 950 951 952
    Debug.dprintf debug "[ITP server] sending initialization infos@.";
    P.notify (Initialized infos);
    Debug.dprintf debug "[ITP server] reloading source files@.";
    let b = reload_files d.cont ~use_shapes in
    if b then
      init_and_send_the_tree ()
    else
      load_files_session ()

953

Clément Fumex's avatar
Clément Fumex committed
954 955 956 957 958
  (* ----------------- Schedule proof attempt -------------------- *)

  (* Callback of a proof_attempt *)
  let callback_update_tree_proof cont panid pa_status =
    let ses = cont.controller_session in
Clément Fumex's avatar
Clément Fumex committed
959
    begin match pa_status with
Clément Fumex's avatar
Clément Fumex committed
960 961 962 963 964 965 966 967 968 969
    | Scheduled ->
      begin
        try
          ignore (node_ID_from_pan panid)
        (* TODO: do we notify here ? *)
        with Not_found ->
          let parent_id = get_proof_attempt_parent ses panid in
          let parent = node_ID_from_pn parent_id in
          ignore (new_node ~parent (APa panid))
      end
970
    | _  -> () (* TODO ? status like Uninstalled should not generate a Notification *)
Clément Fumex's avatar
Clément Fumex committed
971
    end;
972 973 974
    let limit = (get_proof_attempt_node cont.controller_session panid).limit in
    let new_status = Proof_status_change (pa_status, false, limit) in
    P.notify (Node_change (node_ID_from_pan panid, new_status))
Clément Fumex's avatar
Clément Fumex committed
975

976 977
  let notify_change_proved c x =
    try
978
      let node_ID = node_ID_from_any x in
979
      let b = any_proved c.controller_session x in
980 981 982
      P.notify (Node_change (node_ID, Proved b));
      match x with
      | APa pa ->
983 984 985 986 987 988 989 990
         let pa = get_proof_attempt_node c.controller_session pa in
         let res = match pa.Session_itp.proof_state with
           | None -> InternalFailure Not_found
           | Some r -> Done r
         in
         let obs = pa.proof_obsolete in
         let limit = pa.limit in
         P.notify (Node_change (node_ID, Proof_status_change(res, obs, limit)))
991
      | _ -> ()
992 993 994
    with Not_found ->
      Format.eprintf "Anomaly: Itp_server.notify_change_proved@.";
      exit 1
995

996
  let schedule_proof_attempt ~counterexmp nid (p: Whyconf.config_prover) limit =
997
    let d = get_server_data () in
Clément Fumex's avatar
Clément Fumex committed
998
    let prover = p.Whyconf.prover in
999
    let callback = callback_update_tree_proof d.cont in