why3ide.ml 68.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
(********************************************************************)
(*                                                                  *)
(*  The Why3 Verification Platform   /   The Why3 Development Team  *)
(*  Copyright 2010-2017   --   INRIA - CNRS - Paris-Sud University  *)
(*                                                                  *)
(*  This software is distributed under the terms of the GNU Lesser  *)
(*  General Public License version 2.1, with the special exception  *)
(*  on linking described in file LICENSE.                           *)
(*                                                                  *)
(********************************************************************)

12
open Why3
13
open Format
14
open Gconfig
15
open Stdlib
Sylvain Dailler's avatar
Sylvain Dailler committed
16 17
open Ide_utils
open History
18 19
open Itp_communication
open Itp_server
20

21 22
external reset_gc : unit -> unit = "ml_reset_gc"

23
let debug = Debug.lookup_flag "ide_info"
24
let debug_stack_trace = Debug.lookup_flag "stack_trace"
25

26 27 28 29 30
(***************************)
(* Debugging Json protocol *)
(***************************)


31
(* TODO remove print_request_json and print_notification_json *)
32 33 34 35 36
exception Badparsing

let print_request_json fmt (r: ide_request) =
  (try (
    let s = Pp.string_of Json_util.print_request r in
37
    let x = Json_util.parse_request s in
38 39 40 41 42 43 44
    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 (
45
    let x = Json_util.parse_notification (Pp.string_of Json_util.print_notification n) in
46 47 48 49 50 51 52 53
    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
54 55 56
(*******************)
(* server protocol *)
(*******************)
57

MARCHE Claude's avatar
MARCHE Claude committed
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

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

Sylvain Dailler's avatar
Sylvain Dailler committed
68
  let print_msg_debug m =
69
    Debug.dprintf debug_proto "message %a@." print_msg m
Clément Fumex's avatar
Clément Fumex committed
70 71

  let print_notify_debug n =
72
    Debug.dprintf debug_proto "handling notification %a@." print_notify n;
73
    Debug.dprintf debug_json "%a@." print_notification_json n
Clément Fumex's avatar
Clément Fumex committed
74 75 76 77

  let list_requests: ide_request list ref = ref []

  let get_requests () =
78 79
    let n = List.length !list_requests in
    if n > 0 then
80
      Debug.dprintf debug_proto "got %d new requests@." n;
Clément Fumex's avatar
Clément Fumex committed
81 82 83 84 85
    let l = List.rev !list_requests in
    list_requests := [];
    l

  let send_request r =
86
    print_request_debug r;
Clément Fumex's avatar
Clément Fumex committed
87 88 89 90 91
    list_requests := r :: !list_requests

  let notification_list: notification list ref = ref []

  let notify n =
92
(* too early, print when handling notifications
Clément Fumex's avatar
Clément Fumex committed
93
    print_notify_debug n;
94
 *)    notification_list := n :: !notification_list
Clément Fumex's avatar
Clément Fumex committed
95 96

  let get_notified () =
97 98
    let n = List.length !notification_list in
    if n > 0 then
99
      Debug.dprintf debug_proto "got %d new notifications@." n;
Clément Fumex's avatar
Clément Fumex committed
100 101 102
    let l = List.rev !notification_list in
    notification_list := [];
    l
Sylvain Dailler's avatar
Sylvain Dailler committed
103 104 105

end

106 107 108
(* True when session differs from the saved session *)
let session_needs_saving = ref false

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

111 112 113 114 115
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
116

Clément Fumex's avatar
Clément Fumex committed
117 118 119
(****************************************)
(* server instance on the GTK scheduler *)
(****************************************)
120

121 122 123 124 125 126 127 128 129 130
(*
   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
131 132 133 134 135 136 137 138 139 140 141 142 143 144
     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
145

146
module Scheduler = struct
147

148 149
    let blocking = false

150
    let multiplier = 3
151

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

Clément Fumex's avatar
Clément Fumex committed
155
    let timeout ~ms f =
156 157
      let (_ : GMain.Timeout.id) =
        GMain.Timeout.add ~ms ~callback:(backtrace_and_exit f) in ()
Clément Fumex's avatar
Clément Fumex committed
158
end
159

160
module Server = Itp_server.Make (Scheduler) (Protocol_why3ide)
161

Clément Fumex's avatar
Clément Fumex committed
162 163 164
(************************)
(* parsing command line *)
(************************)
165

Clément Fumex's avatar
Clément Fumex committed
166 167 168
let files : string Queue.t = Queue.create ()
let opt_parser = ref None

169
let spec = [
Clément Fumex's avatar
Clément Fumex committed
170 171 172 173
  "-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
174
(*
Clément Fumex's avatar
Clément Fumex committed
175 176 177
  "-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
178
*)
Clément Fumex's avatar
Clément Fumex committed
179 180
  Termcode.arg_extra_expl_prefix
]
181

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

186 187 188
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
189 190 191
    if Queue.is_empty files then
      Whyconf.Args.exit_with_usage spec usage_str;
    Gconfig.load_config config base_config;
192
    env, Gconfig.config ()
Clément Fumex's avatar
Clément Fumex committed
193 194 195 196 197

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

198
(* Initialization of config, provers, task_driver and controller in the server *)
199 200 201 202 203 204 205 206 207 208
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
209

Clément Fumex's avatar
Clément Fumex committed
210
let () =
211
  Debug.dprintf debug "Init the GTK interface...@?";
Clément Fumex's avatar
Clément Fumex committed
212 213 214 215
  ignore (GtkMain.Main.init ());
  Debug.dprintf debug " done.@.";
  Gconfig.init ()

MARCHE Claude's avatar
MARCHE Claude committed
216

MARCHE Claude's avatar
MARCHE Claude committed
217 218 219 220
(********************************)
(* Source language highlighting *)
(********************************)

MARCHE Claude's avatar
MARCHE Claude committed
221

MARCHE Claude's avatar
MARCHE Claude committed
222
let (why_lang, any_lang) =
Clément Fumex's avatar
Clément Fumex committed
223 224
  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
225 226 227 228 229 230 231 232
  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
233
        eprintf "language file for 'why3' not found in directory %s@."
MARCHE Claude's avatar
MARCHE Claude committed
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
          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
257

258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
(****************************)
(* 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
290

291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
(*******************)
(* 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 ()

306
(* Contains quadruples (tab page, source_view, file_has_been_modified, label_of_tab):
307 308 309 310 311 312 313 314 315
   - 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

316 317 318
(* The corresponding file does not have a source view *)
exception Nosourceview of string

319 320 321 322 323
let get_source_view_table (file:string) =
  match Hstr.find source_view_table file with
  | v -> v
  | exception Not_found -> raise (Nosourceview file)

324 325 326 327 328 329
(* 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)

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 361 362 363 364 365 366 367 368 369 370 371 372 373 374
(* 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
375

376 377 378
(**********************)
(* Graphical elements *)
(**********************)
379

MARCHE Claude's avatar
MARCHE Claude committed
380

381
let main_window : GWindow.window =
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
  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:
399 400
   1. the menu [menubar]
   2. an horizontal box [hb]
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
 *)

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
417 418 419 420 421 422 423 424 425 426
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
427

428 429
let file_menu = factory#add_submenu "_File"
let file_factory = new GMenu.factory file_menu ~accel_group
MARCHE Claude's avatar
MARCHE Claude committed
430
let menu_add_file =
431
  create_menu_item file_factory "Add file to session"
MARCHE Claude's avatar
MARCHE Claude committed
432 433
                   "Insert another file in the current session"
let menu_preferences =
434
  create_menu_item file_factory "Preferences"
MARCHE Claude's avatar
MARCHE Claude committed
435 436
                   "Open Preferences Window"
let menu_save_session =
437
  create_menu_item file_factory "Save session"
MARCHE Claude's avatar
MARCHE Claude committed
438
                   "Save the current proof session on disk"
439
let menu_save_files =
440
  create_menu_item file_factory "Save files"
441 442 443
                   "Save the edited source files on disk"
let menu_save_session_and_files =
  create_menu_item file_factory ~key:GdkKeysyms._S "_Save session and files"
444 445 446 447
                   "Save the current proof session and the source files"
let menu_refresh =
  create_menu_item file_factory ~key:GdkKeysyms._R "Save all and _Refresh session"
                   "Save the current proof session and the source files, then refresh the proof session with updated source files."
448

MARCHE Claude's avatar
MARCHE Claude committed
449 450 451 452 453 454 455 456
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
457
let tools_accel_group = GtkData.AccelGroup.create ()
MARCHE Claude's avatar
MARCHE Claude committed
458

459 460 461 462 463
let strategies_factory =
  let tools_submenu_strategies = tools_factory#add_submenu "Strategies" in
  let ( _ : GMenu.menu_item) = tools_factory#add_separator () in
  new GMenu.factory tools_submenu_strategies

464 465 466 467
let provers_factory =
  let tools_submenu_provers = tools_factory#add_submenu "Provers" in
  let ( _ : GMenu.menu_item) = tools_factory#add_separator () in
  new GMenu.factory tools_submenu_provers
MARCHE Claude's avatar
MARCHE Claude committed
468

469 470


MARCHE Claude's avatar
MARCHE Claude committed
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
(* 1.3 "View" menu items *)



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









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

(* File menu signals *)

493 494 495 496 497 498 499 500
let send_session_config_to_server () =
  let nb = gconfig.session_nb_processes in
  send_request (Set_config_param("max_tasks",nb));
  let nb = gconfig.session_time_limit in
  send_request (Set_config_param("timelimit",nb));
  let nb = gconfig.session_mem_limit in
  send_request (Set_config_param("memlimit",nb))

MARCHE Claude's avatar
MARCHE Claude committed
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
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);
     *)
     *)
521 522 523 524
    Hstr.iter
      (fun _ (_,source_view,_,_) ->
       source_view#set_editable gconfig.allow_source_editing)
      source_view_table;
525
    send_session_config_to_server ()
MARCHE Claude's avatar
MARCHE Claude committed
526 527 528 529 530 531 532
  in
  connect_menu_item menu_preferences ~callback

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

534 535 536 537 538 539 540 541 542 543 544
let () =
  connect_menu_item
    menu_save_session_and_files
    ~callback:(fun () -> save_sources(); send_request Save_req)

let () =
  connect_menu_item
    menu_save_files
    ~callback:(fun () -> save_sources())


MARCHE Claude's avatar
MARCHE Claude committed
545 546 547 548
let () =
  connect_menu_item
    menu_quit
    ~callback:exit_function_safe
549

MARCHE Claude's avatar
MARCHE Claude committed
550 551 552 553 554 555 556
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)
557

558 559
(* 2. horizontal box contains:
   2.1 TODO: a tool box ?
560 561 562
   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]
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
*)

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

581
(** {2 view for the session tree} *)
MARCHE Claude's avatar
MARCHE Claude committed
582 583 584 585
let scrolled_session_view =
  GBin.scrolled_window
    ~hpolicy: `AUTOMATIC ~vpolicy: `AUTOMATIC
    ~shadow_type:`ETCHED_OUT
MARCHE Claude's avatar
MARCHE Claude committed
586
    ~packing:scrollview#add_with_viewport
MARCHE Claude's avatar
MARCHE Claude committed
587 588
    ()

589 590 591 592 593 594 595
(* Vertical pan *)
let vpan222 = GPack.paned `VERTICAL ~packing:hp#add ()

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

*)

596 597
(** {3 the model for tree view} *)

598
let cols = new GTree.column_list
599
(* first column: unique id of the object *)
Clément Fumex's avatar
Clément Fumex committed
600
let node_id_column = cols#add Gobject.Data.int
601 602 603 604 605
(* 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. *)
606
let status_column = cols#add Gobject.Data.gobject
607
(* fifth column: extra status info: time, obsolete status, limits *)
608
let time_column = cols#add Gobject.Data.string
MARCHE Claude's avatar
MARCHE Claude committed
609

610 611 612 613 614
(* 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
615
  v#pack icon_renderer ~expand:false;
616 617 618 619
  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;
620
  (* v#set_sizing `AUTOSIZE; *)
621
  v#set_resizable true;
622
  (*  v#set_max_width 1000;*)
623 624 625 626 627 628 629 630 631 632 633 634
  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
635 636 637

let view_time_column =
  let renderer = GTree.cell_renderer_text [`XALIGN 0.] in
638 639 640 641 642 643
  let v = GTree.view_column ~title:"Time"
                            ~renderer:(renderer, ["text", time_column]) ()
  in
  v#set_resizable false;
  v#set_visible true;
  v
644

645
let goals_model,goals_view =
646
  Debug.dprintf debug "Creating tree model...@?";
647 648 649
  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
650
(*
651
  let () = view#set_rules_hint true in
652 653
*)
  let () = view#set_enable_search false in
654
  let _: int = view#append_column view_status_column in
655
  let _: int = view#append_column view_name_column in
656
  let _: int = view#append_column view_time_column in
657
  view#set_expander_column (Some view_name_column);
658
  Debug.dprintf debug "done@.";
659
  model,view
660

661 662 663 664 665 666 667 668 669 670 671 672

(***********************************)
(* 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
673
let node_id_detached : bool Hint.t = Hint.create 17
674 675

let get_node_type id = Hint.find node_id_type id
676 677 678 679 680

let get_node_proved id =
  try Hint.find node_id_proved id
  with Not_found -> false

681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
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

703 704 705
let get_node_detached id =
  Hint.find node_id_detached id

706 707 708 709 710 711 712 713 714 715 716 717 718 719
(******************************)
(* 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;
720 721
  Hint.clear node_id_pa;
  Hint.clear node_id_detached
722 723 724 725 726


(**************)
(* Menu items *)
(**************)
727

728

729
let reload_unsafe () = send_request Reload_req
730

731 732
let save_and_reload () = save_sources (); reload_unsafe ()

733 734
(* Same as reload_safe but propose to save edited sources before reload *)
let reload_safe () =
735
  if files_need_saving () then
736 737 738 739
    let answer =
      GToolbox.question_box
        ~title:"Why3 saving source files"
        ~buttons:["Yes"; "No"; "Cancel"]
MARCHE Claude's avatar
MARCHE Claude committed
740
        "Do you want to save modified source files before refresh?\nBeware that unsaved modifications will be discarded."
741 742
    in
    match answer with
743
    | 1 -> save_and_reload ()
744 745
    | 2 -> reload_unsafe ()
    | _ -> ()
746 747
  else
    reload_unsafe ()
748

749
let () = connect_menu_item menu_refresh ~callback:save_and_reload
750

751

Clément Fumex's avatar
Clément Fumex committed
752
(* vpan222 contains:
753
   2.2.2.1 a notebook containing view of the current task, source code etc
754
   2.2.2.2 a vertical pan which contains [vbox2222]
Clément Fumex's avatar
Clément Fumex committed
755
     2.2.2.2.1 the input field to type commands
756
     2.2.2.2.2 a scrolled window to hold the output of the commands
757 758
 *)

759 760 761
(***********************************)
(*    notebook on the top 2.2.2.1  *)
(***********************************)
762

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

766 767 768
(********************************)
(* Task view (part of notebook) *)
(********************************)
769 770 771 772 773
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)) ()

774 775
let scrolled_task_view =
  GBin.scrolled_window
776
    ~height:gconfig.task_height
777 778
    ~hpolicy: `AUTOMATIC ~vpolicy: `AUTOMATIC
    ~shadow_type:`ETCHED_OUT
779
    ~packing:scrolled_task_view#add ()
780

781 782 783 784 785 786 787
let (_ : GtkSignal.id) =
  scrolled_task_view#misc#connect#size_allocate
    ~callback:
    (fun {Gtk.width=_w;Gtk.height=h} ->
       gconfig.task_height <- h)


788 789 790
let task_view =
  GSourceView2.source_view
    ~editable:false
Clément Fumex's avatar
Clément Fumex committed
791
    ~cursor_visible:false
792 793 794 795
    ~show_line_numbers:true
    ~packing:scrolled_task_view#add
    ()

796

797
(* Creating a page for source code view *)
798
let create_source_view =
799
  (* Counter for pages *)
800
  let n = ref 1 in
801 802
  (* Create a page with tabname [f] and buffer equal to [content] in the
     notebook. Also add a corresponding page in source_view_table. *)
803 804 805
  let create_source_view f content =
    if not (Hstr.mem source_view_table f) then
      begin
806
        let label = GMisc.label ~text:f () in
807 808
        let source_page, scrolled_source_view =
          !n, GPack.vbox ~homogeneous:false ~packing:
809 810
            (fun w -> ignore(notebook#append_page ~tab_label:label#coerce w)) ()
        in
811 812 813 814 815 816 817 818 819 820 821 822
        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 *)
823
            ~editable:gconfig.allow_source_editing
824 825
            ~packing:scrolled_source_view#add
            () in
826 827
        let has_changed = ref false in
        Hstr.add source_view_table f (source_page, source_view, has_changed, label);
828
        n := !n + 1;
829
        source_view#source_buffer#begin_not_undoable_action ();
830
        source_view#source_buffer#set_text content;
831
        source_view#source_buffer#end_not_undoable_action ();
832 833 834 835 836 837 838 839 840 841 842
        (* 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
843 844
        Gconfig.add_modifiable_mono_font_view source_view#misc;
        source_view#source_buffer#set_language why_lang;
845 846 847
        (* We have to create the tags for background colors for each view.
           They are not reusable from the other views.  *)
        create_colors source_view;
848 849 850
        Gconfig.set_fonts ()
      end in
  create_source_view
851 852 853



854 855
(* End of notebook *)

856 857 858 859 860
(*
  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
861
let vbox2222 = GPack.vbox ~packing:vpan222#add  ()
862

863 864 865 866
(* 2.2.2.2.1 Horizontal box [hbox22221]
     [monitor] number of scheduled/running provers
     [command_entry] Commands to run on the session
*)
867 868 869 870 871 872
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
873
    ~text:"  0/0/0"
874
    ~width:100
MARCHE Claude's avatar
MARCHE Claude committed
875
    ~xalign:0.0
876
    ~packing:(hbox22221#pack ?from:None ?expand:None ?fill:None ?padding:None) ()
877

878 879 880 881
let command_entry =
  GEdit.entry
    ~text:"type commands here"
    ~packing:hbox22221#add ()
MARCHE Claude's avatar
MARCHE Claude committed
882

883 884 885 886 887 888 889 890 891 892
(* Part 2.2.2.2.2 contains messages returned by the IDE/server *)
let messages_notebook = GPack.notebook ~packing:vbox2222#add ()

let error_page,error_view =
  let label = GMisc.label ~text:"Messages" () in
  0, GPack.vbox ~homogeneous:false ~packing:
    (fun w -> ignore(messages_notebook#append_page ~tab_label:label#coerce w)) ()

let log_page,log_view =
  let label = GMisc.label ~text:"Log" () in
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936
  1, GPack.vbox ~homogeneous:false ~packing:
    (fun w -> ignore(messages_notebook#append_page ~tab_label:label#coerce w)) ()

(* tab 3: edited proof *)
let edited_page,edited_tab =
  let label = GMisc.label ~text:"Edited proof" () in
  2, GPack.vbox ~homogeneous:false ~packing:
    (fun w -> ignore(messages_notebook#append_page ~tab_label:label#coerce w)) ()

let scrolled_edited_view =
  GBin.scrolled_window
    ~hpolicy: `AUTOMATIC ~vpolicy: `AUTOMATIC
    ~shadow_type:`ETCHED_OUT ~packing:edited_tab#add ()

let edited_view =
  GSourceView2.source_view
    ~editable:false
    ~show_line_numbers:true
    ~packing:scrolled_edited_view#add
    ()

(* tab 4: prover output *)
let output_page,output_tab =
  let label = GMisc.label ~text:"Prover output" () in
  3, GPack.vbox ~homogeneous:false ~packing:
    (fun w -> ignore(messages_notebook#append_page ~tab_label:label#coerce w)) ()

let scrolled_output_view =
  GBin.scrolled_window
    ~hpolicy: `AUTOMATIC ~vpolicy: `AUTOMATIC
    ~shadow_type:`ETCHED_OUT ~packing:output_tab#add ()

let output_view =
  GSourceView2.source_view
    ~editable:false
    ~show_line_numbers:true
    ~packing:scrolled_output_view#add
    ()


(* tab 5: counterexample *)
let counterexample_page,counterexample_tab =
  let label = GMisc.label ~text:"Counterexample" () in
  4, GPack.vbox ~homogeneous:false ~packing:
937 938
    (fun w -> ignore(messages_notebook#append_page ~tab_label:label#coerce w)) ()

939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
let scrolled_counterexample_view =
  GBin.scrolled_window
    ~hpolicy: `AUTOMATIC ~vpolicy: `AUTOMATIC
    ~shadow_type:`ETCHED_OUT ~packing:counterexample_tab#add ()

let counterexample_view =
  GSourceView2.source_view
    ~editable:false
    ~show_line_numbers:true
    ~packing:scrolled_counterexample_view#add
    ()





MARCHE Claude's avatar
MARCHE Claude committed
955
let message_zone =
956 957
  let sv = GBin.scrolled_window
      ~hpolicy:`AUTOMATIC ~vpolicy:`AUTOMATIC
958 959 960 961 962 963 964 965 966
      ~shadow_type:`ETCHED_OUT ~packing:error_view#add ()
  in
  GText.view ~editable:false ~cursor_visible:false
    ~packing:sv#add ()

let log_zone =
  let sv = GBin.scrolled_window
      ~hpolicy:`AUTOMATIC ~vpolicy:`AUTOMATIC
      ~shadow_type:`ETCHED_OUT ~packing:log_view#add ()
967
  in
MARCHE Claude's avatar
MARCHE Claude committed
968
  GText.view ~editable:false ~cursor_visible:false
969 970
    ~packing:sv#add ()

971 972 973 974
(* Create a tag for errors in the message zone. *)
let message_zone_error_tag = message_zone#buffer#create_tag
  ~name:"error" [`BACKGROUND gconfig.neg_premise_color]

975 976
(**** Message-zone printing functions *****)

MARCHE Claude's avatar
MARCHE Claude committed
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996
let add_to_log =
  let old = ref None in
  fun notif_kind s ->
  let (_,_,_,n) as x =
    match !old with
    | Some(line,oldnotif_kind,olds,oldn)
         when notif_kind = oldnotif_kind && s = olds ->
       let start = log_zone#buffer#get_iter (`LINE line) in
       let stop = log_zone#buffer#end_iter in
       log_zone#buffer#delete ~start ~stop;
       (line,oldnotif_kind,olds,oldn+1)
    | _ ->
       let line = log_zone#buffer#line_count in
       (line,notif_kind,s,1)
  in
  old := Some x;
  log_zone#buffer#insert ("["^ notif_kind);
  if n>1 then
    log_zone#buffer#insert (" (repeated " ^ (string_of_int n) ^ " times)");
  log_zone#buffer#insert ("] " ^ s ^ "\n");
997 998
  log_zone#scroll_to_mark `INSERT

999
(* Function used to print stuff on the message_zone *)
MARCHE Claude's avatar
MARCHE Claude committed
1000
let print_message ~kind ~notif_kind fmt =
1001 1002
  Format.kfprintf
    (fun _ -> let s = flush_str_formatter () in
MARCHE Claude's avatar
MARCHE Claude committed
1003
              add_to_log notif_kind s;
MARCHE Claude's avatar
MARCHE Claude committed
1004 1005 1006 1007 1008
              if kind>0 then
                begin
                  message_zone#buffer#set_text s;
                  messages_notebook#goto_page error_page
                end)
1009 1010 1011
    str_formatter
    fmt

1012

1013
(**** Monitor *****)
Clément Fumex's avatar
Clément Fumex committed
1014

1015
let fan =
1016
  let s = Bytes.of_string "\226\150\129" in
1017
  let c = Char.code (Bytes.get s 2) in
1018
  let a = Array.init 8 (fun i ->
1019 1020 1021
    Bytes.set s 2 (Char.chr (c + i));
    Bytes.to_string s) in
  fun n ->
1022 1023 1024
  let n = n mod 14 in
  let n = if n < 0 then n + 14 else n in
  let n = if n >= 8 then 14 - n else n in
1025
  a.(n)
1026 1027 1028 1029 1030 1031

let update_monitor =
  let c = ref 0 in
  fun t s r ->
  reset_gc ();
  incr c;
1032 1033 1034
  let f = if r = 0 then " " else fan !c in
  let text = Printf.sprintf "%s %d/%d/%d" f t s r in
  monitor#set_text text
Clément Fumex's avatar
Clément Fumex committed
1035

MARCHE Claude's avatar
MARCHE Claude committed
1036

1037 1038 1039



1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
(****************************)
(* 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

1055 1056 1057
let match_function s iter =
  let candidate = completion_model#get ~row:iter ~column:completion_col in
  try
1058
    ignore (Str.search_forward (Str.regexp_string_case_fold s) candidate 0);
1059 1060 1061
    true
  with Not_found -> false

1062
(* see also init_compeltion below *)
1063

Sylvain Dailler's avatar
Sylvain Dailler committed
1064
(*********************)
1065
(* Terminal history  *)
Sylvain Dailler's avatar
Sylvain Dailler committed
1066 1067
(*********************)

1068
let list_commands = create_history()
Sylvain Dailler's avatar
Sylvain Dailler committed
1069 1070 1071

let _ =
  command_entry#event#connect#key_press
1072 1073 1074
    ~callback:(fun (ev: 'a Gdk.event) ->
      match GdkEvent.Key.keyval ev with
      | k when k = GdkKeysyms._Up -> (* Arrow up *)
1075 1076 1077 1078 1079
          let s = print_next_command list_commands in
          (match s with
          | None -> true
          | Some s ->
              (command_entry#set_text s; true))
1080
      | k when k = GdkKeysyms._Down -> (* Arrow down *)
1081