why3ide.ml 51.8 KB
Newer Older
1
open Why3
2
open Format
3
open Gconfig
4
open Stdlib
Sylvain Dailler's avatar
Sylvain Dailler committed
5 6
open Ide_utils
open History
7 8
open Itp_communication
open Itp_server
9

10 11
external reset_gc : unit -> unit = "ml_reset_gc"

12
let debug = Debug.lookup_flag "ide_info"
13
let debug_stack_trace = Debug.lookup_flag "stack_trace"
14

15 16 17 18 19
(***************************)
(* Debugging Json protocol *)
(***************************)


20
(* TODO remove print_request_json and print_notification_json *)
21 22 23 24 25
exception Badparsing

let print_request_json fmt (r: ide_request) =
  (try (
    let s = Pp.string_of Json_util.print_request r in
26
    let x = Json_util.parse_request s in
27 28 29 30 31 32 33
    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 (
34
    let x = Json_util.parse_notification (Pp.string_of Json_util.print_notification n) in
35 36 37 38 39 40 41 42
    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
43 44 45
(*******************)
(* server protocol *)
(*******************)
46

47
module Protocol_why3ide = struct
Clément Fumex's avatar
Clément Fumex committed
48 49

  let debug_proto = Debug.register_flag "ide_proto"
50
      ~desc:"Print@ debugging@ messages@ about@ Why3Ide@ protocol@"
Clément Fumex's avatar
Clément Fumex committed
51 52 53

  let print_request_debug r =
    Debug.dprintf debug_proto "[request]";
54 55
    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
56

Sylvain Dailler's avatar
Sylvain Dailler committed
57 58 59
  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
60 61 62

  let print_notify_debug n =
    Debug.dprintf debug_proto "[notification]";
63 64
    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
65 66 67 68 69 70 71 72 73 74 75

  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 =
76
    print_request_debug r;
Clément Fumex's avatar
Clément Fumex committed
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
    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
93 94 95

end

96 97 98
(* True when session differs from the saved session *)
let session_needs_saving = ref false

Clément Fumex's avatar
Clément Fumex committed
99
let get_notified = Protocol_why3ide.get_notified
Sylvain Dailler's avatar
Sylvain Dailler committed
100

101 102 103 104 105
let send_request r =
  (* If request changes the session then session needs saving *)
  if modify_session r then
    session_needs_saving := true;
  Protocol_why3ide.send_request r
Sylvain Dailler's avatar
Sylvain Dailler committed
106

Clément Fumex's avatar
Clément Fumex committed
107 108 109
(****************************************)
(* server instance on the GTK scheduler *)
(****************************************)
110

111 112 113 114 115 116 117 118 119 120
(*
   The gtk scheduler is catching all exceptions avoiding the printing of the
   backtrace that is normally done by debug option stack_trace. To recover this
   behavior we catch exceptions ourselves. If "stack_trace" is on, we exit on
   first exception and print backtrace on standard output otherwise we raise
   the exception again (with information on error output).
*)
let backtrace_and_exit f () =
  try f () with
  | e ->
MARCHE Claude's avatar
MARCHE Claude committed
121 122 123 124 125 126 127 128 129 130 131 132 133 134
     if Debug.test_flag debug_stack_trace then
       begin
         Printexc.print_backtrace stderr;
         Format.eprintf "exception '%a' was raised in a LablGtk callback.@."
                        Exn_printer.exn_printer e;
         exit 1
       end
     else
       begin
         Format.eprintf "exception '%a' was raised in a LablGtk callback.@."
                        Exn_printer.exn_printer e;
         Format.eprintf "This should not happen. Please report. @.";
         raise e
       end
135

136
module Scheduler = struct
137

Clément Fumex's avatar
Clément Fumex committed
138
    let idle ~prio f =
139
      let (_ : GMain.Idle.id) = GMain.Idle.add ~prio (backtrace_and_exit f) in ()
140

Clément Fumex's avatar
Clément Fumex committed
141
    let timeout ~ms f =
142 143
      let (_ : GMain.Timeout.id) =
        GMain.Timeout.add ~ms ~callback:(backtrace_and_exit f) in ()
Clément Fumex's avatar
Clément Fumex committed
144
end
145

146
module Server = Itp_server.Make (Scheduler) (Protocol_why3ide)
147

Clément Fumex's avatar
Clément Fumex committed
148 149 150
(************************)
(* parsing command line *)
(************************)
151

Clément Fumex's avatar
Clément Fumex committed
152 153 154 155 156 157 158 159
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
160
(*
Clément Fumex's avatar
Clément Fumex committed
161 162 163
  "-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
164
*)
Clément Fumex's avatar
Clément Fumex committed
165 166
  Termcode.arg_extra_expl_prefix
]
167

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

172 173 174
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
175 176 177
    if Queue.is_empty files then
      Whyconf.Args.exit_with_usage spec usage_str;
    Gconfig.load_config config base_config;
178
    env, Gconfig.config ()
Clément Fumex's avatar
Clément Fumex committed
179 180 181 182 183

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

184
(* Initialization of config, provers, task_driver and controller in the server *)
185 186 187 188 189 190 191 192 193 194
let () =
  let dir =
    try
      Server_utils.get_session_dir ~allow_mkdir:true files
    with Invalid_argument s ->
      Format.eprintf "Error: %s@." s;
      Whyconf.Args.exit_with_usage spec usage_str
  in
  Server.init_server gconfig.config env dir;
  Queue.iter (fun f -> send_request (Add_file_req f)) files
195

Clément Fumex's avatar
Clément Fumex committed
196 197 198 199 200 201
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
202

MARCHE Claude's avatar
MARCHE Claude committed
203 204 205 206
(********************************)
(* Source language highlighting *)
(********************************)

MARCHE Claude's avatar
MARCHE Claude committed
207

MARCHE Claude's avatar
MARCHE Claude committed
208
let (why_lang, any_lang) =
Clément Fumex's avatar
Clément Fumex committed
209 210
  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
211 212 213 214 215 216 217 218
  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
219
        eprintf "language file for 'why3' not found in directory %s@."
MARCHE Claude's avatar
MARCHE Claude committed
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
          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

MARCHE Claude's avatar
MARCHE Claude committed
243

244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
(****************************)
(* Color handling in source *)
(****************************)

(* For each view, we have to recreate the tags *)
let create_colors v =
  let premise_tag (v: GSourceView2.source_view) = v#buffer#create_tag
      ~name:"premise_tag" [`BACKGROUND gconfig.premise_color] in

  let neg_premise_tag (v: GSourceView2.source_view) = v#buffer#create_tag
      ~name:"neg_premise_tag" [`BACKGROUND gconfig.neg_premise_color] in

  let goal_tag (v: GSourceView2.source_view) = v#buffer#create_tag
      ~name:"goal_tag" [`BACKGROUND gconfig.goal_color] in

  let error_tag (v: GSourceView2.source_view) = v#buffer#create_tag
      ~name:"error_tag" [`BACKGROUND gconfig.error_color] in
  let _ : GText.tag = premise_tag v in
  let _ : GText.tag = neg_premise_tag v in
  let _ : GText.tag = goal_tag v in
  let _ : GText.tag = error_tag v in
  ()

(* Erase all the source location tags in a source file *)
let erase_color_loc (v:GSourceView2.source_view) =
  let buf = v#buffer in
  buf#remove_tag_by_name "premise_tag" ~start:buf#start_iter ~stop:buf#end_iter;
  buf#remove_tag_by_name "neg_premise_tag" ~start:buf#start_iter ~stop:buf#end_iter;
  buf#remove_tag_by_name "goal_tag" ~start:buf#start_iter ~stop:buf#end_iter;
  buf#remove_tag_by_name "error_tag" ~start:buf#start_iter ~stop:buf#end_iter


MARCHE Claude's avatar
MARCHE Claude committed
276

277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
(*******************)
(* Graphical tools *)
(*******************)

(* Elements needed for usage of graphical elements *)

(* [quit_on_saved] set to true by exit function to delay quiting after Saved
   notification is received *)
let quit_on_saved = ref false

(* Exit brutally without asking anything *)
let exit_function_unsafe () =
  send_request Exit_req;
  GMain.quit ()

(* Contains a quadruplets (tab page, source_view, file_has_been_modified, label_of_tab):
   - tab_page is a unique number for each pages of the notebook
   - source_view is the graphical element inside a tab
   - has_been_modified is a reference to a boolean stating if the current tab
     source has been modified
   - label_of_tab is the mutable title of the tab
*)
let source_view_table : (int * GSourceView2.source_view * bool ref * GMisc.label) Hstr.t =
  Hstr.create 14

302 303 304
(* The corresponding file does not have a source view *)
exception Nosourceview of string

305 306 307 308 309
let get_source_view_table (file:string) =
  match Hstr.find source_view_table file with
  | v -> v
  | exception Not_found -> raise (Nosourceview file)

310 311 312 313 314 315
(* This returns the source_view of a file *)
let get_source_view (file: string) : GSourceView2.source_view =
  match Hstr.find source_view_table file with
  | (_, v, _, _) -> v
  | exception Not_found -> raise (Nosourceview file)

316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
(* Saving function for sources *)
let save_sources () =
  Hstr.iter
    (fun k (_n, (s: GSourceView2.source_view), b, _l) ->
      if !b then
        let text_to_save = s#source_buffer#get_text () in
        send_request (Save_file_req (k, text_to_save))
    )
    source_view_table

(* True if there exist a file which needs saving *)
let files_need_saving () =
  Hstr.fold (fun _k (_, _, b, _) acc -> !b || acc) source_view_table false

(* Ask if the user wants to save session before exit. Exit is then delayed until
   the [Saved] notification is received *)
let exit_function_safe () =
  if not !session_needs_saving && not (files_need_saving ()) then
    exit_function_unsafe ()
  else
    let answer =
      GToolbox.question_box
        ~title:"Why3 saving session and files"
        ~buttons:["Yes"; "No"; "Cancel"]
        "Do you want to save the session and unsaved files?"
    in
    begin
      match answer with
      | 1 -> save_sources(); send_request Save_req; quit_on_saved := true
      | 2 -> exit_function_unsafe ()
      | _ -> ()
    end

(* Update name of the tab when the label changes so that it has a * as prefix *)
let update_label_change (label: GMisc.label) =
  let s = label#text in
  if not (Strings.has_prefix "*" s) then
    label#set_text ("*" ^ s)

(* Update name of the tab when the label is saved. Removes * prefix *)
let update_label_saved (label: GMisc.label) =
  let s = label#text in
  if (Strings.has_prefix "*" s) then
    label#set_text (String.sub s 1 (String.length s - 1))

MARCHE Claude's avatar
MARCHE Claude committed
361

362 363 364
(**********************)
(* Graphical elements *)
(**********************)
365

MARCHE Claude's avatar
MARCHE Claude committed
366

367
let main_window : GWindow.window =
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
  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:
385 386
   1. the menu [menubar]
   2. an horizontal box [hb]
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
 *)

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
403 404 405 406 407 408 409 410 411 412
let create_menu_item (factory:GMenu.menu GMenu.factory)
                     ?key label tooltip =
  let i = factory#add_item ?key label in
  i#misc#set_tooltip_markup tooltip;
  i

let connect_menu_item i ~callback =
  let (_ : GtkSignal.id) = i#connect#activate ~callback in ()

(* 1.1 "File" menu items *)
MARCHE Claude's avatar
MARCHE Claude committed
413

414 415
let file_menu = factory#add_submenu "_File"
let file_factory = new GMenu.factory file_menu ~accel_group
MARCHE Claude's avatar
MARCHE Claude committed
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
let menu_add_file =
  create_menu_item file_factory "_Add file to session"
                   "Insert another file in the current session"
let menu_preferences =
  create_menu_item file_factory "_Preferences"
                   "Open Preferences Window"
let menu_refresh =
  create_menu_item file_factory ~key:GdkKeysyms._R "_Refresh session"
                   "Refresh the proof session with updated source files."
let menu_save_session =
  create_menu_item file_factory "_Save session"
                   "Save the current proof session on disk"
let menu_quit =
  create_menu_item file_factory ~key:GdkKeysyms._Q "_Quit"
                   "Quit the interface. See the Preferences for setting the policy on automatic file saving at exit."

(* 1.2 "Tools" menu items *)

let tools_menu = factory#add_submenu "_Tools"
let tools_factory = new GMenu.factory tools_menu ~accel_group

let replay_menu_item =
  create_menu_item tools_factory ~key:GdkKeysyms._R "_Replay obsolete"
                   "Replay all obsolete proofs"
let clean_menu_item =
  create_menu_item tools_factory  "Clean"
                   "Remove unsuccessful proofs or transformations that are below a proved goal"

let remove_item =
  create_menu_item tools_factory "Remove"
                   "Remove the selected proof attempts or transformations"

let mark_obsolete_item =
  create_menu_item tools_factory "Mark obsolete"
                   "Mark all proof nodes below the current selected nodes as obsolete"

Sylvain Dailler's avatar
Sylvain Dailler committed
452 453 454 455 456 457 458
let focus_item =
  create_menu_item tools_factory "Focus"
    "Focus on proof node"

let unfocus_item =
  create_menu_item tools_factory "Unfocus"
    "Unfocus"
MARCHE Claude's avatar
MARCHE Claude committed
459

460 461


MARCHE Claude's avatar
MARCHE Claude committed
462 463 464 465 466 467 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
(* 1.3 "View" menu items *)



(****************************)
(* actions of the interface *)
(****************************)









(***********************************)
(* connection of actions to signals *)
(***********************************)

(* File menu signals *)

let () =
  let callback () =
    Gconfig.preferences gconfig;
    (* TODO:
      begin
        match !current_env_session with
          | None -> ()
          | Some e ->
              Session.update_env_session_config e gconfig.config;
              Session.unload_provers e
      end;
      recreate_gui ();
(*
      Mprover.iter
        (fun p pi ->
          Debug.dprintf debug "editor for %a : %s@." Whyconf.print_prover p
            pi.editor)
        (Whyconf.get_provers gconfig.config);
     *)
     *)
    let nb = gconfig.session_nb_processes in
    send_request (Set_max_tasks_req nb)
  in
  connect_menu_item menu_preferences ~callback

let () =
  connect_menu_item
    menu_save_session
    ~callback:(fun () -> send_request Save_req)
513

MARCHE Claude's avatar
MARCHE Claude committed
514 515 516 517
let () =
  connect_menu_item
    menu_quit
    ~callback:exit_function_safe
518

MARCHE Claude's avatar
MARCHE Claude committed
519 520 521 522 523 524 525
let (_ : GtkSignal.id) =
  main_window#connect#destroy
    ~callback:exit_function_safe

let (_ : GtkSignal.id) =
  main_window#event#connect#delete
    ~callback:(fun _ -> exit_function_safe (); true)
526

527 528
(* 2. horizontal box contains:
   2.1 TODO: a tool box ?
529 530 531
   2.2 a horizontal paned [hp] containing:
     2.2.1 a scrolled window to hold the tree view of the session [scrolledview]
     2.2.2 a vertical paned containing [vpan222]
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
*)

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

550
(** {2 view for the session tree} *)
MARCHE Claude's avatar
MARCHE Claude committed
551 552 553 554 555 556 557
let scrolled_session_view =
  GBin.scrolled_window
    ~hpolicy: `AUTOMATIC ~vpolicy: `AUTOMATIC
    ~shadow_type:`ETCHED_OUT
    ~packing:scrollview#add
    ()

558 559 560 561 562 563 564
(* Vertical pan *)
let vpan222 = GPack.paned `VERTICAL ~packing:hp#add ()

(*  the scrolled window 2.2.1 [scrolled_session_view] contains a GTK tree

*)

565 566
(** {3 the model for tree view} *)

567
let cols = new GTree.column_list
568
(* first column: unique id of the object *)
Clément Fumex's avatar
Clément Fumex committed
569
let node_id_column = cols#add Gobject.Data.int
570 571 572 573 574
(* second column: an icon identifying the object: file,theory, goal, transformation *)
let icon_column = cols#add Gobject.Data.gobject
(* third column: name of the object *)
let name_column = cols#add Gobject.Data.string
(* fourth column: icon status for the object: proved/unproved, unknown, timeout, etc. *)
575
let status_column = cols#add Gobject.Data.gobject
576
(* fifth column: extra status info: time, obsolete status, limits *)
577
let time_column = cols#add Gobject.Data.string
MARCHE Claude's avatar
MARCHE Claude committed
578

579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
(* first view column: icon and name *)
let view_name_column =
  let v = GTree.view_column ~title:"Theories/Goals" () in
  (* icon attribute *)
  let icon_renderer = GTree.cell_renderer_pixbuf [ ] in
  v#pack icon_renderer ;
  v#add_attribute icon_renderer "pixbuf" icon_column;
  let name_renderer = GTree.cell_renderer_text [`XALIGN 0.] in
  v#pack name_renderer;
  v#add_attribute name_renderer "text" name_column;
(*  v#set_sizing `AUTOSIZE; *)
  v#set_resizable true;
  v#set_max_width 500;
  v

(* second view column: status *)
let view_status_column =
  let status_renderer = GTree.cell_renderer_pixbuf [ ] in
  let v = GTree.view_column ~title:"Status"
                            ~renderer:(status_renderer, ["pixbuf", status_column])
                            ()
  in
  v#set_resizable false;
  v#set_visible true;
  v
604 605 606

let view_time_column =
  let renderer = GTree.cell_renderer_text [`XALIGN 0.] in
607 608 609 610 611 612
  let v = GTree.view_column ~title:"Time"
                            ~renderer:(renderer, ["text", time_column]) ()
  in
  v#set_resizable false;
  v#set_visible true;
  v
613

614 615 616 617 618
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
619
(*
620
  let () = view#set_rules_hint true in
621 622
*)
  let () = view#set_enable_search false in
623 624 625
  let _: int = view#append_column view_name_column in
  let _: int = view#append_column view_status_column in
  let _: int = view#append_column view_time_column in
626
  Debug.dprintf debug "[GTK IDE] done@.";
627
  model,view
628

629 630 631 632 633 634 635 636 637 638 639 640

(***********************************)
(* 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
641
let node_id_detached : bool Hint.t = Hint.create 17
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666

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

667 668 669
let get_node_detached id =
  Hint.find node_id_detached id

670 671 672 673 674 675 676 677 678 679 680 681 682 683
(******************************)
(* Initialization of the tree *)
(******************************)

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;
684 685
  Hint.clear node_id_pa;
  Hint.clear node_id_detached
686 687 688 689 690


(**************)
(* Menu items *)
(**************)
691

692

693 694 695 696 697 698 699
let reload_unsafe () =
  (* Clearing the tree *)
  clear_tree_and_table goals_model;
  send_request Reload_req

(* Same as reload_safe but propose to save edited sources before reload *)
let reload_safe () =
700
  if files_need_saving () then
701 702 703 704
    let answer =
      GToolbox.question_box
        ~title:"Why3 saving source files"
        ~buttons:["Yes"; "No"; "Cancel"]
MARCHE Claude's avatar
MARCHE Claude committed
705
        "Do you want to save modified source files before refresh?\nBeware that unsaved modifications will be discarded."
706 707 708 709 710
    in
    match answer with
    | 1 -> save_sources (); reload_unsafe ()
    | 2 -> reload_unsafe ()
    | _ -> ()
711 712
  else
    reload_unsafe ()
713

MARCHE Claude's avatar
MARCHE Claude committed
714
let () = connect_menu_item menu_refresh ~callback:reload_safe
715

716

Clément Fumex's avatar
Clément Fumex committed
717
(* vpan222 contains:
718
   2.2.2.1 a notebook containing view of the current task, source code etc
719
   2.2.2.2 a vertical pan which contains [vbox2222]
Clément Fumex's avatar
Clément Fumex committed
720
     2.2.2.2.1 the input field to type commands
721
     2.2.2.2.2 a scrolled window to hold the output of the commands
722 723
 *)

724 725 726
(***********************************)
(*    notebook on the top 2.2.2.1  *)
(***********************************)
727

728
(* notebook is composed of a Task page and several source files pages *)
729 730
let notebook = GPack.notebook ~packing:vpan222#add ()

731 732 733
(********************************)
(* Task view (part of notebook) *)
(********************************)
734 735 736 737 738
let task_page,scrolled_task_view =
  let label = GMisc.label ~text:"Task" () in
  0, GPack.vbox ~homogeneous:false ~packing:
    (fun w -> ignore(notebook#append_page ~tab_label:label#coerce w)) ()

739 740 741 742
let scrolled_task_view =
  GBin.scrolled_window
    ~hpolicy: `AUTOMATIC ~vpolicy: `AUTOMATIC
    ~shadow_type:`ETCHED_OUT
743
    ~packing:scrolled_task_view#add ()
744

745
(* Showing current task *)
746 747 748
let task_view =
  GSourceView2.source_view
    ~editable:false
Clément Fumex's avatar
Clément Fumex committed
749
    ~cursor_visible:false
750 751 752 753
    ~show_line_numbers:true
    ~packing:scrolled_task_view#add
    ()

754
(* Creating a page for source code view *)
755
let create_source_view =
756
  (* Counter for pages *)
757
  let n = ref 1 in
758 759
  (* Create a page with tabname [f] and buffer equal to [content] in the
     notebook. Also add a corresponding page in source_view_table. *)
760 761 762
  let create_source_view f content =
    if not (Hstr.mem source_view_table f) then
      begin
763
        let label = GMisc.label ~text:f () in
764 765
        let source_page, scrolled_source_view =
          !n, GPack.vbox ~homogeneous:false ~packing:
766 767
            (fun w -> ignore(notebook#append_page ~tab_label:label#coerce w)) ()
        in
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
        let scrolled_source_view =
          GBin.scrolled_window
            ~hpolicy: `AUTOMATIC ~vpolicy: `AUTOMATIC
            ~shadow_type:`ETCHED_OUT
            ~packing:scrolled_source_view#add () in
        let source_view =
          GSourceView2.source_view
            ~auto_indent:true
            ~insert_spaces_instead_of_tabs:true ~tab_width:2
            ~show_line_numbers:true
            ~right_margin_position:80 ~show_right_margin:true
            (* ~smart_home_end:true *)
            ~editable:true
            ~packing:scrolled_source_view#add
            () in
783 784
        let has_changed = ref false in
        Hstr.add source_view_table f (source_page, source_view, has_changed, label);
785 786
        n := !n + 1;
        source_view#source_buffer#set_text content;
787 788 789 790 791 792 793 794 795 796 797
        (* At initialization, file has not changed. When it changes, changes the
           name of the tab and update has_changed boolean. *)
        let (_: GtkSignal.id) = source_view#source_buffer#connect#changed
          ~callback:(fun () ->
            try
              let _source_page, _source_view, has_changed, label =
                Hstr.find source_view_table f in
              update_label_change label;
              has_changed := true;
              ()
            with Not_found -> () ) in
798 799
        Gconfig.add_modifiable_mono_font_view source_view#misc;
        source_view#source_buffer#set_language why_lang;
800 801 802
        (* We have to create the tags for background colors for each view.
           They are not reusable from the other views.  *)
        create_colors source_view;
803 804 805 806 807
        Gconfig.set_fonts ()
      end in
  create_source_view
(* End of notebook *)

808 809 810 811 812
(*
  2.2.2.2 a vertical pan which contains [vbox2222]
    2.2.2.2.1 the input field to type commands [hbox22221]
    2.2.2.2.2 a scrolled window to hold the output of the commands [message_zone]
*)
Clément Fumex's avatar
Clément Fumex committed
813
let vbox2222 = GPack.vbox ~packing:vpan222#add  ()
814

815 816 817 818
(* 2.2.2.2.1 Horizontal box [hbox22221]
     [monitor] number of scheduled/running provers
     [command_entry] Commands to run on the session
*)
819 820 821 822 823 824
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
825
    ~text:"  0/0/0"
826
    ~width:100
MARCHE Claude's avatar
MARCHE Claude committed
827
    ~xalign:0.0
828
    ~packing:(hbox22221#pack ?from:None ?expand:None ?fill:None ?padding:None) ()
829

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

832
(* Part 2.2.2.2.2 contains message returned by the IDE/server *)
MARCHE Claude's avatar
MARCHE Claude committed
833
let message_zone =
834 835 836 837
  let sv = GBin.scrolled_window
      ~hpolicy:`AUTOMATIC ~vpolicy:`AUTOMATIC
      ~shadow_type:`ETCHED_OUT ~packing:vbox2222#add ()
  in
MARCHE Claude's avatar
MARCHE Claude committed
838
  GText.view ~editable:false ~cursor_visible:false
839 840
    ~packing:sv#add ()

841 842 843
(**** Message-zone printing functions *****)

(* Function used to print stuff on the message_zone *)
MARCHE Claude's avatar
MARCHE Claude committed
844
let print_message fmt =
845 846 847 848 849 850
  Format.kfprintf
    (fun _ -> let s = flush_str_formatter () in
              message_zone#buffer#set_text s)
    str_formatter
    fmt

851 852 853 854 855
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

856
(**** Monitor *****)
Clément Fumex's avatar
Clément Fumex committed
857

858 859 860 861 862 863 864 865 866 867 868 869 870
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
871 872 873
  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
874

MARCHE Claude's avatar
MARCHE Claude committed
875

876 877 878



879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
(****************************)
(* 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

894 895 896 897 898 899 900
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

901
(* see also init_compeltion below *)
902

Sylvain Dailler's avatar
Sylvain Dailler committed
903
(*********************)
904
(* Terminal history  *)
Sylvain Dailler's avatar
Sylvain Dailler committed
905 906
(*********************)

907
let list_commands = create_history()
Sylvain Dailler's avatar
Sylvain Dailler committed
908 909 910

let _ =
  command_entry#event#connect#key_press
911 912 913
    ~callback:(fun (ev: 'a Gdk.event) ->
      match GdkEvent.Key.keyval ev with
      | k when k = GdkKeysyms._Up -> (* Arrow up *)
914 915 916 917 918
          let s = print_next_command list_commands in
          (match s with
          | None -> true
          | Some s ->
              (command_entry#set_text s; true))
919
      | k when k = GdkKeysyms._Down -> (* Arrow down *)
920 921 922 923 924
          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
925 926 927
      | _ -> false
      )

Clément Fumex's avatar
Clément Fumex committed
928 929 930
let () =
  let n = gconfig.session_nb_processes in
  Debug.dprintf debug "[IDE] setting max proof tasks to %d@." n;
931
  send_request (Set_max_tasks_req n)
932

933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
(********************)
(* Locations colors *)
(********************)

(* This apply a background [color] on a location given by its file view [v] line
   [l] beginning char [b] and end char [e]. *)
let color_loc (v:GSourceView2.source_view) ~color l b e =
  let buf = v#buffer in
  let top = buf#start_iter in
  let start = top#forward_lines (l-1) in
  let start = start#forward_chars b in
  let stop = start#forward_chars (e-b) in
  buf#apply_tag_by_name ~start ~stop color

let convert_color (color: color): string =
  match color with
  | Neg_premise_color -> "neg_premise_tag"
  | Premise_color -> "premise_tag"
  | Goal_color -> "goal_tag"

953
let move_to_line ~yalign (v : GSourceView2.source_view) line =
954
  let line = max 0 (line - 1) in
955 956 957 958 959 960 961 962 963 964
  let line = min line v#buffer#line_count in
  let it = v#buffer#get_iter (`LINE line) in
  v#buffer#place_cursor ~where:it;
  let mark = `MARK (v#buffer#create_mark it) in
  v#scroll_to_mark ~use_align:true ~yalign mark

(* TODO Do we want an option to choose if we aggressivily switch to the correct
   source location each time we receive locations with task or not *)
let always_scroll = false

965 966 967 968 969
(* Add a color tag on the right locations on the correct file.
   If the file was not open yet, nothing is done *)
let color_loc ~color loc =
  let f, l, b, e = Loc.get loc in
  try
970 971 972 973 974 975 976
    let (n, v, _, _) = get_source_view_table f in
    if color = Goal_color then
      begin
        if always_scroll then
          notebook#goto_page n;
        move_to_line ~yalign:0.0 v l;
      end;
977 978 979 980 981 982 983 984 985 986 987 988 989 990
    let color = convert_color color in
    color_loc ~color v l b e
  with
  | Nosourceview _ ->
      (* If the file is not present do nothing *)
      ()

(* Erase the colors and apply the colors given by l (which come from the task)
   to appropriate source files *)
let apply_loc_on_source (l: (Loc.position * color) list) =
  Hstr.iter (fun _ (_, v, _, _) -> erase_color_loc v) source_view_table;
  List.iter (fun (loc, color) ->
    color_loc ~color loc) l

991 992 993
(**************************)
(* Graphical proof status *)
(**************************)
994

Sylvain Dailler's avatar
Sylvain Dailler committed
995 996
let image_of_pa_status ~obsolete pa =
  match pa with
997 998
  | Controller_itp.Unedited -> !image_scheduled (* TODO !image_unedited *)
  | Controller_itp.JustEdited -> !image_scheduled (* TODO !image_edited *)
999
  | Controller_itp.Interrupted -> !image_undone
1000 1001 1002
  | Controller_itp.Scheduled -> !image_scheduled
  | Controller_itp.Running -> !image_running
  | Controller_itp.InternalFailure _e -> !image_failure
1003
  | Controller_itp.Uninstalled _p -> !image_undone (* TODO !image_uninstalled *)
Sylvain Dailler's avatar
Sylvain Dailler committed
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
  | 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
1026

Clément Fumex's avatar
Clément Fumex committed
1027 1028
let set_status_column iter =
  let id = get_node_id iter in
1029
  let proved = get_node_proved id in
1030
  let detached = get_node_detached id in
Clément Fumex's avatar
Clément Fumex committed
1031 1032 1033 1034 1035 1036
  let image = match get_node_type id with
    | NRoot -> assert false
    | NFile
    | NTheory
    | NTransformation
    | NGoal ->
1037 1038 1039 1040 1041 1042
      if detached then
        !image_valid_obs
      else
        if proved
        then !image_valid
        else !image_unknown
1043
    | NProofAttempt ->
Sylvain Dailler's avatar
Sylvain Dailler committed
1044 1045 1046
      let pa = get_node_proof_attempt id in
      let obs = get_node_obs id in
      image_of_pa_status ~obsolete:obs pa
1047 1048
  in
  goals_model#set ~row:iter ~column:status_column image
1049

1050
let new_node ?parent ?(collapse=false) id name typ proved detached =
Clément Fumex's avatar
Clément Fumex committed
1051 1052
  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
1053
    Hint.add node_id_proved id proved;
1054
    Hint.add node_id_detached id detached;
Sylvain Dailler's avatar
Sylvain Dailler committed
1055 1056 1057 1058 1059 1060 1061
    (* The tree does not have a root by default so the task is a forest with
       several root files *)
    let iter =
      match parent with
      | None -> goals_model#append ()
      | Some p -> goals_model#append ~parent:p#iter ()
    in
Sylvain Dailler's avatar
Sylvain Dailler committed
1062
    goals_model#set ~row:iter ~column:name_column name;
Clément Fumex's avatar
Clément Fumex committed
1063
    goals_model#set ~row:iter ~column:node_id_column id;
1064 1065 1066 1067 1068 1069 1070
    goals_model#set ~row:iter ~column:icon_column
      (match typ with
         | NGoal -> !image_goal
         | NRoot | NFile -> !image_file
         | NTheory -> !image_theory
         | NTransformation -> !image_transf
         | NProofAttempt -> !image_prover);
Clément Fumex's avatar
Clément Fumex committed
1071 1072 1073 1074
    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;
1075 1076
    set_status_column iter;
    new_ref
Clément Fumex's avatar
Clément Fumex committed
1077
  end
1078 1079
  else
    Hint.find node_id_to_gtree id
1080

1081 1082 1083
(*******************)
(* The "View" menu *)
(*******************)
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096

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
1097
    ~callback:enlarge_fonts "Enlarge font"
1098 1099 1100

let (_ : GMenu.menu_item) =
    view_factory#add_item ~key:GdkKeysyms._minus
Clément Fumex's avatar
Clément Fumex committed
1101
      ~callback:reduce_fonts "Reduce font"
1102 1103 1104 1105 1106

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

1107
let collapse_iter iter =
1108 1109 1110
  let path = goals_model#get_path iter in
  goals_view#collapse_row path

1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
let rec collapse_proven_goals_from_iter iter =
  let node_id = get_node_id iter in
  let is_proved = get_node_proved node_id in
  if is_proved then
    collapse_iter iter
  else
    let n = goals_model#iter_n_children (Some iter) in
    for i = 0 to (n - 1) do
      collapse_proven_goals_from_iter (goals_model#iter_children ?nth:(Some i) (Some iter))
    done
1121 1122 1123 1124 1125 1126 1127 1128

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
1129
    ~label:"Collapse proven goals" ~callback:(fun () -> collapse_proven_goals ()) ()
1130 1131 1132 1133 1134 1135 1136

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
1137
  task_view#source_buffer#set_language why_lang;
Clément Fumex's avatar
Clément Fumex committed
1138
  Gconfig.set_fonts ()
1139

MARCHE Claude's avatar
MARCHE Claude committed
1140 1141 1142



1143 1144 1145 1146
(******************)
(*    actions     *)
(******************)

Clément Fumex's avatar
Clément Fumex committed
1147 1148 1149 1150
let get_selected_row_references () =
  List.map
    (fun path -> goals_model#get_row_reference path)
    goals_view#selection#get_selected_rows
1151

1152
let rec update_status_column_from_iter cont iter =
Clément Fumex's avatar
Clément Fumex committed
1153
  set_status_column iter;
1154
  match goals_model#iter_parent iter with
1155
  | Some p -> update_status_column_from_iter cont p
1156 1157
  | None -> ()

1158
(* TODO Unused functions. Map these to a key or remove it *)
1159 1160
let move_current_row_selection_up () =
  let current_view = List.hd (goals_view#selection#get_selected_rows) in
1161 1162 1163
  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