Nous avons procédé ce jeudi matin 08 avril 2021 à une MAJ de sécurité urgente. Nous sommes passé de la version 13.9.3 à la version 13.9.5 les releases notes correspondantes sont ici:
https://about.gitlab.com/releases/2021/03/17/security-release-gitlab-13-9-4-released/
https://about.gitlab.com/releases/2021/03/31/security-release-gitlab-13-10-1-released/

why3ide.ml 30 KB
Newer Older
1
open Why3
2
open Format
3
open Gconfig
4
open Stdlib
Sylvain Dailler's avatar
Sylvain Dailler committed
5
open Ide_utils.History
6

7 8
external reset_gc : unit -> unit = "ml_reset_gc"

9 10
let debug = Debug.lookup_flag "ide_info"

11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
open Itp_server

(***************************)
(* Debugging Json protocol *)
(***************************)

(* TODO This part is temporarly here because it is the only place it can be defined
   without cyclic dependencies *)
let parse_json_object (s: string) =
  let lb = Lexing.from_string s in
  let x = Json_parser.json_object (fun x -> Json_lexer.read x) lb in
  x

let parse_notification (s: string) : notification =
  let json = parse_json_object s in
  Json_util.parse_notification json

let parse_request (s: string) : ide_request =
  let json = parse_json_object s in
  Json_util.parse_request json

(* TODO remove exception handling in print_request_json and print_notification_json *)
exception Badparsing

let print_request_json fmt (r: ide_request) =
  (try (
    let s = Pp.string_of Json_util.print_request r in
    let x = parse_request s in
    if r = x then () else raise Badparsing)
  with
    _ -> Format.eprintf "Bad parsing@.");
  Json_util.print_request fmt r

let print_notification_json fmt (n: notification) =
  (try (
    let x = parse_notification (Pp.string_of Json_util.print_notification n) in
    if n = x then () else raise Badparsing)
  with
    _ -> Format.eprintf "Bad parsing@.");
  Json_util.print_notification fmt n

let debug_json = Debug.register_flag "json_proto"
    ~desc:"Print@ json@ requests@ and@ notifications@"

Clément Fumex's avatar
Clément Fumex committed
55 56 57
(*******************)
(* server protocol *)
(*******************)
58

59
module Protocol_why3ide = struct
Clément Fumex's avatar
Clément Fumex committed
60 61

  let debug_proto = Debug.register_flag "ide_proto"
62
      ~desc:"Print@ debugging@ messages@ about@ Why3Ide@ protocol@"
Clément Fumex's avatar
Clément Fumex committed
63 64 65

  let print_request_debug r =
    Debug.dprintf debug_proto "[request]";
66 67
    Debug.dprintf debug_proto "%a@." print_request r;
    Debug.dprintf debug_json "%a@." print_request_json r
Clément Fumex's avatar
Clément Fumex committed
68

Sylvain Dailler's avatar
Sylvain Dailler committed
69 70 71
  let print_msg_debug m =
    Debug.dprintf debug_proto "[message]";
    Debug.dprintf debug_proto "%a@." print_msg m
Clément Fumex's avatar
Clément Fumex committed
72 73 74

  let print_notify_debug n =
    Debug.dprintf debug_proto "[notification]";
75 76
    Debug.dprintf debug_proto "%a@." print_notify n;
    Debug.dprintf debug_json "%a@." print_notification_json n
Clément Fumex's avatar
Clément Fumex committed
77 78 79 80 81 82 83 84 85 86 87

  let list_requests: ide_request list ref = ref []

  let get_requests () =
    if List.length !list_requests > 0 then
      Debug.dprintf debug_proto "get requests@.";
    let l = List.rev !list_requests in
    list_requests := [];
    l

  let send_request r =
88
    print_request_debug r;
Clément Fumex's avatar
Clément Fumex committed
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
    Debug.dprintf debug_proto "@.";
    list_requests := r :: !list_requests

  let notification_list: notification list ref = ref []

  let notify n =
    print_notify_debug n;
    Debug.dprintf debug_proto "@.";
    notification_list := n :: !notification_list

  let get_notified () =
    if List.length !notification_list > 0 then
      Debug.dprintf debug_proto "get notified@.";
    let l = List.rev !notification_list in
    notification_list := [];
    l
Sylvain Dailler's avatar
Sylvain Dailler committed
105 106 107

end

Clément Fumex's avatar
Clément Fumex committed
108
let get_notified = Protocol_why3ide.get_notified
Sylvain Dailler's avatar
Sylvain Dailler committed
109

Clément Fumex's avatar
Clément Fumex committed
110
let send_request = Protocol_why3ide.send_request
Sylvain Dailler's avatar
Sylvain Dailler committed
111

Clément Fumex's avatar
Clément Fumex committed
112 113 114
(****************************************)
(* server instance on the GTK scheduler *)
(****************************************)
115

Clément Fumex's avatar
Clément Fumex committed
116 117 118
module S = struct
    let idle ~prio f =
      let (_ : GMain.Idle.id) = GMain.Idle.add ~prio f in ()
119

Clément Fumex's avatar
Clément Fumex committed
120 121 122 123
    let timeout ~ms f =
      let (_ : GMain.Timeout.id) = GMain.Timeout.add ~ms ~callback:f in
      ()
end
124

125 126
module Server = Itp_server.Make (S) (Protocol_why3ide)

Clément Fumex's avatar
Clément Fumex committed
127 128 129
(************************)
(* parsing command line *)
(************************)
130

Clément Fumex's avatar
Clément Fumex committed
131 132 133 134 135 136 137 138
let files : string Queue.t = Queue.create ()
let opt_parser = ref None

let spec = Arg.align [
  "-F", Arg.String (fun s -> opt_parser := Some s),
      "<format> select input format (default: \"why\")";
  "--format", Arg.String (fun s -> opt_parser := Some s),
      " same as -F";
Sylvain Dailler's avatar
Sylvain Dailler committed
139
(*
Clément Fumex's avatar
Clément Fumex committed
140 141 142
  "-f",
   Arg.String (fun s -> input_files := s :: !input_files),
   "<file> add file to the project (ignored if it is already there)";
Sylvain Dailler's avatar
Sylvain Dailler committed
143
*)
Clément Fumex's avatar
Clément Fumex committed
144 145
  Termcode.arg_extra_expl_prefix
]
146

Clément Fumex's avatar
Clément Fumex committed
147 148 149
let usage_str = sprintf
  "Usage: %s [options] [<file.why>|<project directory>]..."
  (Filename.basename Sys.argv.(0))
MARCHE Claude's avatar
MARCHE Claude committed
150

151 152 153
let env, gconfig = try
  let config, base_config, env =
    Whyconf.Args.initialize spec (fun f -> Queue.add f files) usage_str in
Clément Fumex's avatar
Clément Fumex committed
154 155 156
    if Queue.is_empty files then
      Whyconf.Args.exit_with_usage spec usage_str;
    Gconfig.load_config config base_config;
157
    env, Gconfig.config ()
Clément Fumex's avatar
Clément Fumex committed
158 159 160 161 162

  with e when not (Debug.test_flag Debug.stack_trace) ->
    eprintf "%a@." Exn_printer.exn_printer e;
    exit 1

163 164
(* Initialization of config, provers, task_driver and controller in the server *)
let () = Server.init_server gconfig.config env
165

Clément Fumex's avatar
Clément Fumex committed
166 167 168 169 170 171
let () =
  Debug.dprintf debug "[GUI] Init the GTK interface...@?";
  ignore (GtkMain.Main.init ());
  Debug.dprintf debug " done.@.";
  Gconfig.init ()

MARCHE Claude's avatar
MARCHE Claude committed
172

MARCHE Claude's avatar
MARCHE Claude committed
173 174 175 176 177
(********************************)
(* Source language highlighting *)
(********************************)

let (why_lang, any_lang) =
Clément Fumex's avatar
Clément Fumex committed
178 179
  let main = Whyconf.get_main gconfig.config in
  let load_path = Filename.concat (Whyconf.datadir main) "lang" in
MARCHE Claude's avatar
MARCHE Claude committed
180 181 182 183 184 185 186 187
  let languages_manager =
    GSourceView2.source_language_manager ~default:true
  in
  languages_manager#set_search_path
    (load_path :: languages_manager#search_path);
  let why_lang =
    match languages_manager#language "why3" with
    | None ->
Clément Fumex's avatar
Clément Fumex committed
188
        eprintf "language file for 'why3' not found in directory %s@."
MARCHE Claude's avatar
MARCHE Claude committed
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
          load_path;
        exit 1
    | Some _ as l -> l in
  let any_lang filename =
    match languages_manager#guess_language ~filename () with
    | None -> why_lang
    | Some _ as l -> l in
  (why_lang, any_lang)

(* Borrowed from Frama-C src/gui/source_manager.ml:
Try to convert a source file either as UTF-8 or as locale. *)
let try_convert s =
  try
    if Glib.Utf8.validate s then s else Glib.Convert.locale_to_utf8 s
  with Glib.Convert.Error _ ->
    try
      Glib.Convert.convert_with_fallback
        ~fallback:"#neither UTF-8 nor locale nor ISO-8859-15#"
        ~to_codeset:"UTF-8"
        ~from_codeset:"ISO_8859-15"
        s
    with Glib.Convert.Error _ as e -> Printexc.to_string e

212 213 214
(**********************)
(* Graphical elements *)
(**********************)
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251

let main_window =
  let w = GWindow.window
            ~allow_grow:true ~allow_shrink:true
            ~width:gconfig.window_width
            ~height:gconfig.window_height
            ~title:"Why3 Interactive Proof Session" ()
  in
  (* callback to record the new size of the main window when changed, so
   that on restart the window size is the same as the last session *)
  let (_ : GtkSignal.id) =
    w#misc#connect#size_allocate
      ~callback:
      (fun {Gtk.width=w;Gtk.height=h} ->
       gconfig.window_height <- h;
       gconfig.window_width <- w)
  in w

(* the main window contains a vertical box, containing:
   1. the menu
   2. an horizontal box
 *)

let vbox = GPack.vbox ~packing:main_window#add ()

let menubar = GMenu.menu_bar
  ~packing:(vbox#pack ?from:None ?expand:None ?fill:None ?padding:None)
  ()

let hb = GPack.hbox ~packing:vbox#add ()

(* 1. Menu *)

let factory = new GMenu.factory menubar

let accel_group = factory#accel_group

MARCHE Claude's avatar
MARCHE Claude committed
252 253
(* 1.1 "File" menu *)

254 255 256 257
let file_menu = factory#add_submenu "_File"
let file_factory = new GMenu.factory file_menu ~accel_group

let exit_function ~destroy () =
Clément Fumex's avatar
Clément Fumex committed
258
  (* will this be treated before gmain quit ?!? *)
Sylvain Dailler's avatar
Sylvain Dailler committed
259
  send_request Exit_req;
260 261 262 263 264
  ignore(destroy); GMain.quit ()

let (_ : GtkSignal.id) = main_window#connect#destroy
  ~callback:(exit_function ~destroy:true)

MARCHE Claude's avatar
MARCHE Claude committed
265 266 267 268 269 270
(* 1.2 "View" menu

   the entries in that menu are defined later

*)

271 272 273 274
(* 2. horizontal box contains:
   2.1 TODO: a tool box ?
   2.2 a horizontal paned containing:
     2.2.1 a scrolled window to hold the tree view of the session
Clément Fumex's avatar
Clément Fumex committed
275
     2.2.2 a vertical paned containing
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
*)

let hp = GPack.paned `HORIZONTAL ~packing:hb#add ()

let scrollview =
  let sv =
    GBin.scrolled_window
      ~hpolicy:`AUTOMATIC ~vpolicy:`AUTOMATIC
      ~width:gconfig.tree_width ~shadow_type:`ETCHED_OUT
      ~packing:hp#add ()
  in
  let (_ : GtkSignal.id) =
    sv#misc#connect#size_allocate
      ~callback:
      (fun {Gtk.width=w;Gtk.height=_h} ->
       gconfig.tree_width <- w)
  in sv

Clément Fumex's avatar
Clément Fumex committed
294
let vpan222 = GPack.paned `VERTICAL ~packing:hp#add ()
295 296 297 298 299 300

(*  the scrolled window 2.2.1 contains a GTK tree

*)


MARCHE Claude's avatar
MARCHE Claude committed
301 302 303 304 305 306 307 308
(* view for the session tree *)
let scrolled_session_view =
  GBin.scrolled_window
    ~hpolicy: `AUTOMATIC ~vpolicy: `AUTOMATIC
    ~shadow_type:`ETCHED_OUT
    ~packing:scrollview#add
    ()

309 310
let cols = new GTree.column_list
let name_column = cols#add Gobject.Data.string
Clément Fumex's avatar
Clément Fumex committed
311
let node_id_column = cols#add Gobject.Data.int
312
let status_column = cols#add Gobject.Data.gobject
MARCHE Claude's avatar
MARCHE Claude committed
313

314 315 316 317
let name_renderer = GTree.cell_renderer_text [`XALIGN 0.]
let view_name_column = GTree.view_column ~title:"Theories/Goals" ()
let () =
  view_name_column#pack name_renderer;
318 319 320 321 322 323
  view_name_column#add_attribute name_renderer "text" name_column;
  view_name_column#set_sizing `AUTOSIZE

let status_renderer = GTree.cell_renderer_pixbuf [ ]
let view_status_column = GTree.view_column ~title:"Status"
    ~renderer:(status_renderer, ["pixbuf", status_column])()
324

325 326 327 328 329 330 331 332 333
let goals_model,goals_view =
  Debug.dprintf debug "[GUI] Creating tree model...@?";
  let model = GTree.tree_store cols in
  let view = GTree.view ~model ~packing:scrolled_session_view#add () in
(*
  let () = view#selection#set_mode (* `SINGLE *) `MULTIPLE in
  let () = view#set_rules_hint true in
 *)
  ignore (view#append_column view_name_column);
334
  ignore (view#append_column view_status_column);
335 336 337 338 339 340
(*
  ignore (view#append_column view_status_column);
  ignore (view#append_column view_time_column);
*)
  Debug.dprintf debug " done@.";
  model,view
341

342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 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 420 421 422

(***********************************)
(* Mapping session to the GTK tree *)
(***********************************)

type pa_status = Controller_itp.proof_attempt_status
      * bool   (* obsolete or not *) (* TODO *)
      * Call_provers.resource_limit

let node_id_type : node_type Hint.t = Hint.create 17
let node_id_proved : bool Hint.t = Hint.create 17
let node_id_pa : pa_status Hint.t = Hint.create 17

let get_node_type id = Hint.find node_id_type id
let get_node_proved id = Hint.find node_id_proved id
let get_node_id_pa id = Hint.find node_id_pa id

let get_obs (pa_st: pa_status) = match pa_st with
| _, b, _ -> b

let get_proof_attempt (pa_st: pa_status) = match pa_st with
| pa, _, _ -> pa

let get_limit (pa_st: pa_status) = match pa_st with
| _, _, l -> l

let get_node_obs id = get_obs (get_node_id_pa id)
let get_node_proof_attempt id = get_proof_attempt (get_node_id_pa id)
let get_node_limit id = get_limit (get_node_id_pa id)

let get_node_id iter = goals_model#get ~row:iter ~column:node_id_column

(* To each node we have the corresponding row_reference *)
let node_id_to_gtree : GTree.row_reference Hint.t = Hint.create 42
(* TODO exception for those: *)
let get_node_row id = Hint.find node_id_to_gtree id

(******************************)
(* Initialization of the tree *)
(******************************)

(* TODO root node is convenient. Symmetry with session and parent of a node can
   always be found. Can be removed. *)
(* Creating the root of the tree. *)
let create_root () =
  let root_iter = goals_model#append () in
  let root_ref = goals_model#get_row_reference
    (goals_model#get_path root_iter) in
  Hint.add node_id_to_gtree root_node root_ref

let remove_tree goals_model =
  Hint.iter (fun _x i ->
    try ignore(goals_model#remove (i#iter)) with _ -> ())
    node_id_to_gtree

let clear_tree_and_table goals_model =
  remove_tree goals_model;
  Hint.clear node_id_to_gtree;
  Hint.clear node_id_type;
  Hint.clear node_id_proved;
  Hint.clear node_id_pa

(* Actually creating root *)
let _ = create_root ()

(**************)
(* Menu items *)
(**************)
let (_ : GMenu.menu_item) =
  file_factory#add_item ~key:GdkKeysyms._S "_Save session"
    ~callback:(fun () -> send_request Save_req)

let (replay_menu_item : GMenu.menu_item) =
  file_factory#add_item ~key:GdkKeysyms._R "_Replay all"

let (_ : GMenu.menu_item) =
  file_factory#add_item ~key:GdkKeysyms._Q "_Quit"
    ~callback:(exit_function ~destroy:false)

(* TODO key stroked to be decided *)
let reload_menu_item : GMenu.menu_item =
423
  file_factory#add_item ~key:GdkKeysyms._E "r_Eload session"
424 425 426 427 428 429 430
    ~callback:(fun () ->
      (* Clearing the tree *)
      clear_tree_and_table goals_model;
      (* Adding the root again *)
      create_root ();
      send_request Reload_req)

Clément Fumex's avatar
Clément Fumex committed
431
(* vpan222 contains:
432
   2.2.2.1 a view of the current task
Clément Fumex's avatar
Clément Fumex committed
433 434
   2.2.2.2 a vertiacal pan which contains
     2.2.2.2.1 the input field to type commands
435
     2.2.2.2.2 a scrolled window to hold the output of the commands
436 437 438 439 440 441
 *)

let scrolled_task_view =
  GBin.scrolled_window
    ~hpolicy: `AUTOMATIC ~vpolicy: `AUTOMATIC
    ~shadow_type:`ETCHED_OUT
Clément Fumex's avatar
Clément Fumex committed
442
    ~packing:vpan222#add ()
443 444 445 446

let task_view =
  GSourceView2.source_view
    ~editable:false
Clément Fumex's avatar
Clément Fumex committed
447
    ~cursor_visible:false
448 449 450 451
    ~show_line_numbers:true
    ~packing:scrolled_task_view#add
    ()

Clément Fumex's avatar
Clément Fumex committed
452
let vbox2222 = GPack.vbox ~packing:vpan222#add  ()
453

454 455 456 457 458 459
let hbox22221 =
  GPack.hbox
    ~packing:(vbox2222#pack ?from:None ?expand:None ?fill:None ?padding:None) ()

let monitor =
  GMisc.label
MARCHE Claude's avatar
MARCHE Claude committed
460 461 462
    ~text:"  0/0/0"
    ~width:80
    ~xalign:0.0
463
    ~packing:(hbox22221#pack ?from:None ?expand:None ?fill:None ?padding:None) ()
464

MARCHE Claude's avatar
MARCHE Claude committed
465 466
let command_entry = GEdit.entry ~packing:hbox22221#add ()

MARCHE Claude's avatar
MARCHE Claude committed
467
let message_zone =
468 469 470 471
  let sv = GBin.scrolled_window
      ~hpolicy:`AUTOMATIC ~vpolicy:`AUTOMATIC
      ~shadow_type:`ETCHED_OUT ~packing:vbox2222#add ()
  in
MARCHE Claude's avatar
MARCHE Claude committed
472
  GText.view ~editable:false ~cursor_visible:false
473 474
    ~packing:sv#add ()

475 476 477 478 479 480 481 482 483 484 485
(**** Message-zone printing functions *****)

(* Function used to print stuff on the message_zone *)
let print_message s =
  message_zone#buffer#set_text s

let add_to_msg_zone s =
  let s = message_zone#buffer#get_text () ^ "\n" ^ s in
  message_zone#buffer#set_text s;
  message_zone#scroll_to_mark `INSERT

486
(**** Monitor *****)
Clément Fumex's avatar
Clément Fumex committed
487

488 489 490 491 492 493 494 495 496 497 498 499 500
let fan n =
  match n mod 4 with
    | 0 -> "|"
    | 1 | -3 -> "\\"
    | 2 | -2 -> "-"
    | 3 | -1 -> "/"
    | _ -> assert false

let update_monitor =
  let c = ref 0 in
  fun t s r ->
  reset_gc ();
  incr c;
MARCHE Claude's avatar
MARCHE Claude committed
501 502 503
  let f = if r=0 then "  " else fan (!c / 2) ^ " " in
  monitor#set_text
    (f ^ (string_of_int t) ^ "/" ^ (string_of_int s) ^ "/" ^ (string_of_int r))
Clément Fumex's avatar
Clément Fumex committed
504

MARCHE Claude's avatar
MARCHE Claude committed
505

506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
(****************************)
(* command entry completion *)
(****************************)

let completion_cols = new GTree.column_list
let completion_col = completion_cols#add Gobject.Data.string
let completion_model = GTree.tree_store completion_cols

let command_entry_completion : GEdit.entry_completion =
  GEdit.entry_completion ~model:completion_model ~minimum_key_length:1 ~entry:command_entry ()

let add_completion_entry s =
  let row = completion_model#append () in
  completion_model#set ~row ~column:completion_col s

521 522 523 524 525 526 527
let match_function s iter =
  let candidate = completion_model#get ~row:iter ~column:completion_col in
  try
    ignore (Str.search_forward (Str.regexp s) candidate 0);
    true
  with Not_found -> false

Clément Fumex's avatar
Clément Fumex committed
528
let init_completion provers transformations commands =
529
  (* add the names of all the the transformations *)
Clément Fumex's avatar
Clément Fumex committed
530
  List.iter add_completion_entry transformations;
531
  (* add the name of the commands *)
Clément Fumex's avatar
Clément Fumex committed
532
  List.iter add_completion_entry commands;
533 534
  (* todo: add queries *)

535
  (* add provers *)
Clément Fumex's avatar
Clément Fumex committed
536 537
  List.iter add_completion_entry provers;

538 539 540
  add_completion_entry "auto";
  add_completion_entry "auto 2";

541
  command_entry_completion#set_text_column completion_col;
542
  command_entry_completion#set_match_func match_function;
543

544
  command_entry#set_completion command_entry_completion
545

Sylvain Dailler's avatar
Sylvain Dailler committed
546
(*********************)
547
(* Terminal history  *)
Sylvain Dailler's avatar
Sylvain Dailler committed
548 549
(*********************)

550
let list_commands = create_history()
Sylvain Dailler's avatar
Sylvain Dailler committed
551 552 553

let _ =
  command_entry#event#connect#key_press
554 555 556
    ~callback:(fun (ev: 'a Gdk.event) ->
      match GdkEvent.Key.keyval ev with
      | k when k = GdkKeysyms._Up -> (* Arrow up *)
557 558 559 560 561
          let s = print_next_command list_commands in
          (match s with
          | None -> true
          | Some s ->
              (command_entry#set_text s; true))
562
      | k when k = GdkKeysyms._Down -> (* Arrow down *)
563 564 565 566 567
          let s = print_prev_command list_commands in
          (match s with
          | None -> true
          | Some s ->
              (command_entry#set_text s; true))
Sylvain Dailler's avatar
Sylvain Dailler committed
568 569 570
      | _ -> false
      )

Clément Fumex's avatar
Clément Fumex committed
571 572 573
let () =
  let n = gconfig.session_nb_processes in
  Debug.dprintf debug "[IDE] setting max proof tasks to %d@." n;
574
  send_request (Set_max_tasks_req n)
575

576 577
let (_ : GtkSignal.id) =
  replay_menu_item#connect#activate
578
    ~callback:(fun () -> send_request Replay_req)
579

580 581 582
(**************************)
(* Graphical proof status *)
(**************************)
583

Sylvain Dailler's avatar
Sylvain Dailler committed
584 585
let image_of_pa_status ~obsolete pa =
  match pa with
586 587 588 589 590 591 592
  | Controller_itp.Unedited -> !image_scheduled (* TODO !image_unedited *)
  | Controller_itp.JustEdited -> !image_scheduled (* TODO !image_edited *)
  | Controller_itp.Interrupted -> !image_scheduled (* TODO !image_interrrupted *)
  | Controller_itp.Scheduled -> !image_scheduled
  | Controller_itp.Running -> !image_running
  | Controller_itp.InternalFailure _e -> !image_failure
  | Controller_itp.Uninstalled _p -> !image_failure (* TODO !image_uninstalled *)
Sylvain Dailler's avatar
Sylvain Dailler committed
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
(*  | None -> !image_undone*)
  | Controller_itp.Done r ->
    let pr_answer = r.Call_provers.pr_answer in
    begin
      match pr_answer with
      | Call_provers.Valid ->
        if obsolete then !image_valid_obs else !image_valid
      | Call_provers.Invalid ->
        if obsolete then !image_invalid_obs else !image_invalid
      | Call_provers.Timeout ->
        if obsolete then !image_timeout_obs else !image_timeout
      | Call_provers.OutOfMemory ->
        if obsolete then !image_outofmemory_obs else !image_outofmemory
      | Call_provers.StepLimitExceeded ->
        if obsolete then !image_steplimitexceeded_obs
        else !image_steplimitexceeded
      | Call_provers.Unknown _ ->
        if obsolete then !image_unknown_obs else !image_unknown
      | Call_provers.Failure _ ->
        if obsolete then !image_failure_obs else !image_failure
      | Call_provers.HighFailure ->
        if obsolete then !image_failure_obs else !image_failure
    end
616

Clément Fumex's avatar
Clément Fumex committed
617 618
let set_status_column iter =
  let id = get_node_id iter in
619
  let proved = get_node_proved id in
Clément Fumex's avatar
Clément Fumex committed
620 621 622 623 624 625 626 627 628
  let image = match get_node_type id with
    | NRoot -> assert false
    | NFile
    | NTheory
    | NTransformation
    | NGoal ->
      if proved
      then !image_valid
      else !image_unknown
629
    | NProofAttempt ->
Sylvain Dailler's avatar
Sylvain Dailler committed
630 631 632
      let pa = get_node_proof_attempt id in
      let obs = get_node_obs id in
      image_of_pa_status ~obsolete:obs pa
633 634
  in
  goals_model#set ~row:iter ~column:status_column image
635

Sylvain Dailler's avatar
Sylvain Dailler committed
636
let new_node ?parent ?(collapse=false) id name typ proved =
Clément Fumex's avatar
Clément Fumex committed
637 638
  if not (Hint.mem node_id_to_gtree id) then begin
    Hint.add node_id_type id typ;
Sylvain Dailler's avatar
Sylvain Dailler committed
639
    Hint.add node_id_proved id proved;
Clément Fumex's avatar
Clément Fumex committed
640 641
    let parent = Opt.map (fun x -> x#iter) parent in
    let iter = goals_model#append ?parent () in
Sylvain Dailler's avatar
Sylvain Dailler committed
642
    goals_model#set ~row:iter ~column:name_column name;
Clément Fumex's avatar
Clément Fumex committed
643 644 645 646 647
    goals_model#set ~row:iter ~column:node_id_column id;
    let new_ref = goals_model#get_row_reference (goals_model#get_path iter) in
    (* By default expand_path when creating a new node *)
    if not collapse then goals_view#expand_to_path (goals_model#get_path iter);
    Hint.add node_id_to_gtree id new_ref;
648 649
    set_status_column iter;
    new_ref
Clément Fumex's avatar
Clément Fumex committed
650
  end
651 652
  else
    Hint.find node_id_to_gtree id
653

654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
(*******************************)
(* commands of the "View" menu *)
(*******************************)

let view_menu = factory#add_submenu "_View"
let view_factory = new GMenu.factory view_menu ~accel_group

(* goals view is not yet multi-selectable
let (_ : GMenu.image_menu_item) =
  view_factory#add_image_item ~key:GdkKeysyms._A
    ~label:"Select all"
    ~callback:(fun () -> goals_view#selection#select_all ()) ()
 *)

let (_ : GMenu.menu_item) =
  view_factory#add_item ~key:GdkKeysyms._plus
Clément Fumex's avatar
Clément Fumex committed
670
    ~callback:enlarge_fonts "Enlarge font"
671 672 673

let (_ : GMenu.menu_item) =
    view_factory#add_item ~key:GdkKeysyms._minus
Clément Fumex's avatar
Clément Fumex committed
674
      ~callback:reduce_fonts "Reduce font"
675 676 677 678 679

let (_ : GMenu.image_menu_item) =
  view_factory#add_image_item ~key:GdkKeysyms._E
    ~label:"Expand all" ~callback:(fun () -> goals_view#expand_all ()) ()

680
let collapse_iter iter =
681 682 683
  let path = goals_model#get_path iter in
  goals_view#collapse_row path

684
(*
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
let rec collapse_proven_goals_from_pn pn =
  match pn_proved cont pn with
  | true  -> collapse_iter (row_from_pn pn)#iter
  | false ->
    List.iter collapse_proven_goals_from_tn
      (get_transformations cont.controller_session pn)
and collapse_proven_goals_from_tn tn =
  match tn_proved cont tn with
  | true  -> collapse_iter (row_from_tn tn)#iter
  | false ->
    List.iter collapse_proven_goals_from_pn
      (get_sub_tasks cont.controller_session tn)

let collapse_proven_goals_from_th th =
  match th_proved cont th with
  | true  -> collapse_iter (row_from_th th)#iter
  | false -> List.iter collapse_proven_goals_from_pn (theory_goals th)

let collapse_proven_goals_from_file file =
  match file_proved cont file with
  | true  -> collapse_iter (row_from_file file)#iter
  | false -> List.iter collapse_proven_goals_from_th file.file_theories

let collapse_proven_goals_from_iter iter =
709
  let index = get_index iter in
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
  match index with
  | Inone              -> assert false
  | IproofAttempt _    -> ()
  | IproofNode pn      -> collapse_proven_goals_from_pn pn
  | Itransformation tn -> collapse_proven_goals_from_tn tn
  | Itheory th         -> collapse_proven_goals_from_th th
  | Ifile file         -> collapse_proven_goals_from_file file

let collapse_proven_goals () =
  match goals_model#get_iter_first with
  | None -> ()
  | Some root_iter -> collapse_proven_goals_from_iter root_iter

let (_ : GMenu.image_menu_item) =
  view_factory#add_image_item ~key:GdkKeysyms._C
Clément Fumex's avatar
Clément Fumex committed
725
    ~label:"Collapse proven goals" ~callback:(fun () -> collapse_proven_goals ()) () *)
726 727 728 729 730 731 732

let () =
  Gconfig.add_modifiable_sans_font_view goals_view#misc;
  Gconfig.add_modifiable_mono_font_view monitor#misc;
  Gconfig.add_modifiable_mono_font_view task_view#misc;
  Gconfig.add_modifiable_mono_font_view command_entry#misc;
  Gconfig.add_modifiable_mono_font_view message_zone#misc;
MARCHE Claude's avatar
MARCHE Claude committed
733
  task_view#source_buffer#set_language why_lang;
Clément Fumex's avatar
Clément Fumex committed
734
  Gconfig.set_fonts ()
735

736 737 738 739
(******************)
(*    actions     *)
(******************)

Clément Fumex's avatar
Clément Fumex committed
740 741 742 743
let get_selected_row_references () =
  List.map
    (fun path -> goals_model#get_row_reference path)
    goals_view#selection#get_selected_rows
744

745
let rec update_status_column_from_iter cont iter =
Clément Fumex's avatar
Clément Fumex committed
746
  set_status_column iter;
747
  match goals_model#iter_parent iter with
748
  | Some p -> update_status_column_from_iter cont p
749 750
  | None -> ()

751 752
let move_current_row_selection_up () =
  let current_view = List.hd (goals_view#selection#get_selected_rows) in
753 754 755
  ignore (GTree.Path.up current_view);
  let row_up = goals_model#get_row_reference current_view in
  goals_view#selection#select_iter row_up#iter
756 757 758 759 760 761 762 763 764 765 766 767 768

let move_current_row_selection_down () =
  let current_iter =
    try
      let current_view = List.hd (goals_view#selection#get_selected_rows) in
      let current_row = goals_model#get_row_reference current_view in
      Some current_row#iter
    with Not_found ->
      None
  in
  let child = goals_model#iter_children current_iter in
  goals_view#selection#select_iter child

769
let clear_command_entry () = command_entry#set_text ""
MARCHE Claude's avatar
MARCHE Claude committed
770 771

let interp cmd =
Clément Fumex's avatar
Clément Fumex committed
772 773 774 775 776 777 778 779
  (* TODO: do some preprocessing for queries, or leave everything to server ? *)
  (* TODO: treat multiple rows *)
  let rows = get_selected_row_references () in
  let id = if List.length rows > 0 then
      get_node_id ((List.hd rows)#iter)
    else
      root_node
  in
Sylvain Dailler's avatar
Sylvain Dailler committed
780
  send_request (Command_req (id, cmd));
781
  clear_command_entry ()
MARCHE Claude's avatar
MARCHE Claude committed
782 783 784

let (_ : GtkSignal.id) =
  command_entry#connect#activate
785 786
    ~callback:(fun () -> add_command list_commands command_entry#text;
      interp command_entry#text)
787

788 789
let on_selected_row r =
  try
Clément Fumex's avatar
Clément Fumex committed
790 791 792 793
    let id = get_node_id r#iter in
    let typ = get_node_type id in
    match typ with
    | NGoal ->
Sylvain Dailler's avatar
Sylvain Dailler committed
794
      send_request (Get_task id)
795 796 797
    | _ -> task_view#source_buffer#set_text ""
  with
    | Not_found -> task_view#source_buffer#set_text ""
Clément Fumex's avatar
Clément Fumex committed
798

799 800 801 802 803 804
let (_ : GtkSignal.id) =
  goals_view#selection#connect#after#changed ~callback:
    (fun () ->
      match get_selected_row_references () with
        | [r] -> on_selected_row r
        | _ -> ())
Clément Fumex's avatar
Clément Fumex committed
805

806 807 808 809 810 811 812
let remove_item: GMenu.menu_item =
  file_factory#add_item "Remove"
    ~callback:(fun () ->
      match get_selected_row_references () with
      | [r] -> let id = get_node_id r#iter in send_request (Remove_subtree id)
      | _ -> print_message "Select only one node to perform this action")

Sylvain Dailler's avatar
Sylvain Dailler committed
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859



(*************************************)
(* Commands of the Experimental menu *)
(*************************************)

let exp_menu = factory#add_submenu "_Experimental"
let exp_factory = new GMenu.factory exp_menu ~accel_group


(* Current copied node *)
let saved_copy = ref None

let copy () =
  match get_selected_row_references () with
  | [r] -> let n = get_node_id r#iter in
    saved_copy := Some n
  | _ -> ()

let paste () =
  match get_selected_row_references () with
  | [r] ->
      let m = get_node_id r#iter in
    (match !saved_copy with
    | Some n -> send_request (Copy_paste (n, m))
    | None -> ())
  | _ -> ()

let detached_copy () =
  match get_selected_row_references () with
  | [r] -> let n = get_node_id r#iter in
    send_request (Copy_detached n)
  | _ -> ()

let (_ : GMenu.menu_item) =
  exp_factory#add_item ~key:GdkKeysyms._C
    ~callback:copy "Copy"

let (_ : GMenu.menu_item) =
  exp_factory#add_item ~key:GdkKeysyms._V
    ~callback:paste "Paste"

let (_ : GMenu.menu_item) =
  exp_factory#add_item ~key:GdkKeysyms._D
    ~callback:detached_copy "Detached copy"

860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
(*********************************)
(* add a new file in the project *)
(*********************************)

let filter_all_files () =
  let f = GFile.filter ~name:"All" () in
  f#add_pattern "*" ;
  f

let filter_why_files () =
  GFile.filter
    ~name:"Why3 source files"
    ~patterns:[ "*.why"; "*.mlw"] ()

let select_file ~request =
  let d = GWindow.file_chooser_dialog ~action:`OPEN
    ~title:"Why3: Add file in project"
    ()
  in
  d#add_button_stock `CANCEL `CANCEL ;
  d#add_select_button_stock `OPEN `OPEN ;
  d#add_filter (filter_why_files ()) ;
  d#add_filter (filter_all_files ()) ;
  begin match d#run () with
  | `OPEN ->
      begin
        match d#filename with
          | None -> ()
          | Some f -> request f
      end
  | `DELETE_EVENT | `CANCEL -> ()
  end ;
  d#destroy ()

let open_item: GMenu.menu_item =
  file_factory#add_item ~key:GdkKeysyms._A "_Add file"
    ~callback:(fun () ->
      select_file ~request:(fun f -> send_request (Add_file_req f)))

let open_session: GMenu.menu_item =
  file_factory#add_item ~key:GdkKeysyms._O "Open session"
    ~callback:(fun () ->
      select_file ~request:(fun f ->
        (* Clearing the ide tree *)
        clear_tree_and_table goals_model;
        (* Adding the root again *)
        create_root ();
        send_request (Open_session_req f)))

Clément Fumex's avatar
Clément Fumex committed
909 910 911 912 913 914
(*************************)
(* Notification Handling *)
(*************************)

let treat_message_notification msg = match msg with
  (* TODO: do something ! *)
915 916 917 918 919 920 921 922
  | Proof_error (_id, s)   -> print_message s
  | Transf_error (_id, s)  -> print_message s
  | Strat_error (_id, s)   -> print_message s
  | Replay_Info s          -> print_message s
  | Query_Info (_id, s)    -> print_message s
  | Query_Error (_id, s)   -> print_message s
  | Help s                 -> print_message s
  | Information s          -> print_message s
Clément Fumex's avatar
Clément Fumex committed
923
  | Task_Monitor (t, s, r) -> update_monitor t s r
924
  | Open_File_Error s      -> print_message s
925 926
  | Error s                ->
      if Debug.test_flag debug then
927
        print_message s
928
      else
929
        print_message "Request failed."
Clément Fumex's avatar
Clément Fumex committed
930 931

let treat_notification n = match n with
Sylvain Dailler's avatar
Sylvain Dailler committed
932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
  | Node_change (id, uinfo)        ->
    begin
      match uinfo with
      | Proved b ->
        begin
          Hint.replace node_id_proved id b;
          set_status_column (get_node_row id)#iter
        end
      | Proof_status_change (pa, obs, l) ->
        begin
          let r = get_node_row id in
          Hint.replace node_id_pa id (pa, obs, l);
          goals_model#set ~row:r#iter ~column:status_column
            (image_of_pa_status ~obsolete:obs pa)
        end
    end
  | New_node (id, parent_id, typ, name) ->
949
    begin (try
Sylvain Dailler's avatar
Sylvain Dailler committed
950 951
        let parent = get_node_row parent_id in
        let row_ref = new_node ~parent id name typ false in
952 953
        (* TODO for easier testing of IDE *)
        if typ = NGoal then goals_view#selection#select_iter row_ref#iter
Clément Fumex's avatar
Clément Fumex committed
954
      with Not_found ->
Sylvain Dailler's avatar
Sylvain Dailler committed
955
        let row_ref = new_node id name typ false in
956 957
        (* TODO for easier testing of IDE *)
        if typ = NGoal then goals_view#selection#select_iter row_ref#iter);
Clément Fumex's avatar
Clément Fumex committed
958
    end
959 960 961 962 963 964 965 966 967
  | Remove id                     ->
    let n = get_node_row id in
    begin
      ignore (goals_model#remove(n#iter));
      Hint.remove node_id_to_gtree id;
      Hint.remove node_id_type id;
      Hint.remove node_id_proved id;
      Hint.remove node_id_pa id
    end
Clément Fumex's avatar
Clément Fumex committed
968 969 970 971
  | Initialized g_info            ->
    (* TODO: treat other *)
    init_completion g_info.provers g_info.transformations g_info.commands;
  | Saved                         -> (* TODO *)
972
    print_message "got a Saved notification not yet supported\n"
Clément Fumex's avatar
Clément Fumex committed
973
  | Message (msg)                 -> treat_message_notification msg
Sylvain Dailler's avatar
Sylvain Dailler committed
974
(*  | Proof_update (id, pa)         -> (* TODO *)
Clément Fumex's avatar
Clément Fumex committed
975 976 977 978 979 980
    let r = get_node_row id in
    let obsolete = match get_node_type id with
      | NProofAttempt (_, obsolete) -> obsolete
      | _ -> assert false
    in
    goals_model#set ~row:r#iter ~column:status_column
Sylvain Dailler's avatar
Sylvain Dailler committed
981
      (image_of_pa_status ~obsolete pa) *)
Clément Fumex's avatar
Clément Fumex committed
982
  | Dead _s                        -> (* TODO *)
983
    print_message "got a Dead notification not yet supported\n"
Clément Fumex's avatar
Clément Fumex committed
984 985 986 987 988
  | Task (_id, s)                  ->
    (* TODO: check that the id is the current one *)
    task_view#source_buffer#set_text s;
    (* scroll to end of text *)
    task_view#scroll_to_mark `INSERT
989 990

(***********************)
991
(* start the interface *)
992
(***********************)
993

Clément Fumex's avatar
Clément Fumex committed
994 995
let () =
  S.timeout ~ms:100 (fun () -> List.iter treat_notification (get_notified ()); true);
Sylvain Dailler's avatar
Sylvain Dailler committed
996 997 998
  let f = Queue.pop files in
  send_request (Open_session_req f);
  Queue.iter (fun f -> send_request (Add_file_req f)) files;
999
  (* temporary *)
Clément Fumex's avatar
Clément Fumex committed
1000
  vpan222#set_position 500;
1001
  goals_view#expand_all ();
1002 1003
  main_window#add_accel_group accel_group;
  main_window#set_icon (Some !Gconfig.why_icon);
1004
  message_zone#buffer#set_text "Welcome to Why3 IDE\ntype 'help' for help";
1005 1006
  main_window#show ();
  GMain.main ()