why3ide.ml 39.3 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 121 122 123 124 125 126 127 128 129 130 131 132 133
(*
   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 ->
      if Debug.test_flag debug_stack_trace then
        begin
          Printexc.print_backtrace stdout;
          exit 1
        end
      else
        begin
          Format.eprintf "Following exception %a was catched by Labelgtk."
            Exn_printer.exn_printer e;
          Format.eprintf "This should not happen. Please report. @.";
          raise e
        end

Clément Fumex's avatar
Clément Fumex committed
134
module S = struct
135

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

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

144 145
module Server = Itp_server.Make (S) (Protocol_why3ide)

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

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

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

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

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

182 183
(* Initialization of config, provers, task_driver and controller in the server *)
let () = Server.init_server gconfig.config env
184

Clément Fumex's avatar
Clément Fumex committed
185 186 187 188 189 190
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
191

MARCHE Claude's avatar
MARCHE Claude committed
192 193 194 195 196
(********************************)
(* Source language highlighting *)
(********************************)

let (why_lang, any_lang) =
Clément Fumex's avatar
Clément Fumex committed
197 198
  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
199 200 201 202 203 204 205 206
  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
207
        eprintf "language file for 'why3' not found in directory %s@."
MARCHE Claude's avatar
MARCHE Claude committed
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
          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

231 232 233
(**********************)
(* Graphical elements *)
(**********************)
234

235
let main_window : GWindow.window =
236 237 238 239 240 241 242 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
  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
271 272
(* 1.1 "File" menu *)

273 274 275
let file_menu = factory#add_submenu "_File"
let file_factory = new GMenu.factory file_menu ~accel_group

276 277 278 279
let quit_on_saved = ref false

(* Exit brutally without asking anything *)
let exit_function_unsafe () =
Sylvain Dailler's avatar
Sylvain Dailler committed
280
  send_request Exit_req;
281 282
  GMain.quit ()

283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
(* Contains a quadruplets (tab page, source_view, file_has_been_modified, label_of_tab) *)
let source_view_table : (int * GSourceView2.source_view * bool ref * GMisc.label) Hstr.t =
  Hstr.create 14

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 some files need saving *)
let files_need_saving () =
  Hstr.fold (fun _k (_, _, b, _) acc -> !b || acc) source_view_table false

300 301
(* Ask if the user wants to save session before exit *)
let exit_function_safe () =
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
  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
317 318

let (_ : GtkSignal.id) = main_window#connect#destroy
319 320
  ~callback:exit_function_safe

321

MARCHE Claude's avatar
MARCHE Claude committed
322 323 324 325 326 327
(* 1.2 "View" menu

   the entries in that menu are defined later

*)

328 329 330 331
(* 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
332
     2.2.2 a vertical paned containing
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
*)

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
351
let vpan222 = GPack.paned `VERTICAL ~packing:hp#add ()
352 353 354 355 356 357

(*  the scrolled window 2.2.1 contains a GTK tree

*)


358
(** {2 view for the session tree} *)
MARCHE Claude's avatar
MARCHE Claude committed
359 360 361 362 363 364 365
let scrolled_session_view =
  GBin.scrolled_window
    ~hpolicy: `AUTOMATIC ~vpolicy: `AUTOMATIC
    ~shadow_type:`ETCHED_OUT
    ~packing:scrollview#add
    ()

366 367
(** {3 the model for tree view} *)

368
let cols = new GTree.column_list
369
(* first column: unique id of the object *)
Clément Fumex's avatar
Clément Fumex committed
370
let node_id_column = cols#add Gobject.Data.int
371 372 373 374 375
(* 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. *)
376
let status_column = cols#add Gobject.Data.gobject
377
(* fifth column: extra status info: time, obsolete status, limits *)
378
let time_column = cols#add Gobject.Data.string
MARCHE Claude's avatar
MARCHE Claude committed
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
(* 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
406 407 408

let view_time_column =
  let renderer = GTree.cell_renderer_text [`XALIGN 0.] in
409 410 411 412 413 414
  let v = GTree.view_column ~title:"Time"
                            ~renderer:(renderer, ["text", time_column]) ()
  in
  v#set_resizable false;
  v#set_visible true;
  v
415

416 417 418 419 420 421 422
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
423 424
*)
  let () = view#set_enable_search false in
425
  ignore (view#append_column view_name_column);
426
  ignore (view#append_column view_status_column);
427
  ignore (view#append_column view_time_column);
428
  Debug.dprintf debug "[GTK IDE] done@.";
429
  model,view
430

431 432 433 434 435 436 437 438 439 440 441 442

(***********************************)
(* 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
443
let node_id_detached : bool Hint.t = Hint.create 17
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468

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

469 470 471
let get_node_detached id =
  Hint.find node_id_detached id

472 473 474 475 476 477 478 479 480 481 482 483 484 485
(******************************)
(* 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;
486 487
  Hint.clear node_id_pa;
  Hint.clear node_id_detached
488 489


490

491 492 493
(**************)
(* Menu items *)
(**************)
494 495 496


let (_ : GMenu.image_menu_item) =
497 498 499
  let callback () =
    Gconfig.preferences gconfig;
    (* TODO:
500 501 502 503 504 505 506 507 508 509 510 511 512 513
      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);
514 515 516 517 518 519
     *)
     *)
    let nb = gconfig.session_nb_processes in
    send_request (Set_max_tasks_req nb)
  in
  file_factory#add_image_item ~label:"_Preferences" ~callback ()
520

521 522 523 524
let (_ : GMenu.menu_item) =
  file_factory#add_item ~key:GdkKeysyms._S "_Save session"
    ~callback:(fun () -> send_request Save_req)

525
let replay_menu_item : GMenu.menu_item =
526 527
  file_factory#add_item ~key:GdkKeysyms._R "_Replay all"

528 529 530 531
let clean_menu_item : GMenu.menu_item =
  file_factory#add_item ~key:GdkKeysyms._L "C_Lean all"
    ~callback:(fun _ -> send_request Clean_req)

532 533
let (_ : GMenu.menu_item) =
  file_factory#add_item ~key:GdkKeysyms._Q "_Quit"
534
    ~callback:exit_function_safe
535

536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
let exist_modified_sources () =
  Hstr.fold
    (fun _ (_, _, b, _) acc -> !b || acc)
    source_view_table
    false

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 () =
  if exist_modified_sources () then
    let answer =
      GToolbox.question_box
        ~title:"Why3 saving source files"
        ~buttons:["Yes"; "No"; "Cancel"]
        "Do you want to save unsaved source files before reload? \n Modifications that are not saved will be cleared by reload."
    in
    match answer with
    | 1 -> save_sources (); reload_unsafe ()
    | 2 -> reload_unsafe ()
    | _ -> ()

561 562
(* TODO key stroked to be decided *)
let reload_menu_item : GMenu.menu_item =
563
  file_factory#add_item ~key:GdkKeysyms._E "r_Eload session"
564
    ~callback:reload_safe
565

566

Clément Fumex's avatar
Clément Fumex committed
567
(* vpan222 contains:
568
   2.2.2.1 a notebook containing view of the current task, source code etc
Clément Fumex's avatar
Clément Fumex committed
569 570
   2.2.2.2 a vertiacal pan which contains
     2.2.2.2.1 the input field to type commands
571
     2.2.2.2.2 a scrolled window to hold the output of the commands
572 573
 *)

574 575 576 577 578 579 580 581 582 583 584
(*************************************)
(*    notebook on the right 2.2.2.1  *)
(*************************************)

let notebook = GPack.notebook ~packing:vpan222#add ()

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)) ()

585 586 587 588
let scrolled_task_view =
  GBin.scrolled_window
    ~hpolicy: `AUTOMATIC ~vpolicy: `AUTOMATIC
    ~shadow_type:`ETCHED_OUT
589
    ~packing:scrolled_task_view#add ()
590

591
(* Showing current task *)
592 593 594
let task_view =
  GSourceView2.source_view
    ~editable:false
Clément Fumex's avatar
Clément Fumex committed
595
    ~cursor_visible:false
596 597 598 599
    ~show_line_numbers:true
    ~packing:scrolled_task_view#add
    ()

600 601 602 603 604 605 606 607 608 609 610
(* 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))
611 612 613 614 615 616

let create_source_view =
  let n = ref 1 in
  let create_source_view f content =
    if not (Hstr.mem source_view_table f) then
      begin
617
        let label = GMisc.label ~text:f () in
618 619
        let source_page, scrolled_source_view =
          !n, GPack.vbox ~homogeneous:false ~packing:
620 621
            (fun w -> ignore(notebook#append_page ~tab_label:label#coerce w)) ()
        in
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
        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
637 638
        let has_changed = ref false in
        Hstr.add source_view_table f (source_page, source_view, has_changed, label);
639 640
        n := !n + 1;
        source_view#source_buffer#set_text content;
641 642 643 644 645 646 647 648 649 650 651
        (* 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
652 653 654 655 656 657 658 659 660
        Gconfig.add_modifiable_mono_font_view source_view#misc;
        source_view#source_buffer#set_language why_lang;
        Gconfig.set_fonts ()
      end in
  create_source_view

(* End of notebook *)


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

663 664 665 666 667 668
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
669
    ~text:"  0/0/0"
670
    ~width:100
MARCHE Claude's avatar
MARCHE Claude committed
671
    ~xalign:0.0
672
    ~packing:(hbox22221#pack ?from:None ?expand:None ?fill:None ?padding:None) ()
673

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

MARCHE Claude's avatar
MARCHE Claude committed
676
let message_zone =
677 678 679 680
  let sv = GBin.scrolled_window
      ~hpolicy:`AUTOMATIC ~vpolicy:`AUTOMATIC
      ~shadow_type:`ETCHED_OUT ~packing:vbox2222#add ()
  in
MARCHE Claude's avatar
MARCHE Claude committed
681
  GText.view ~editable:false ~cursor_visible:false
682 683
    ~packing:sv#add ()

684 685 686
(**** Message-zone printing functions *****)

(* Function used to print stuff on the message_zone *)
MARCHE Claude's avatar
MARCHE Claude committed
687
let print_message fmt =
688
  (* Format.kasprintf is not available in Ocaml 4.02.3 :-(
MARCHE Claude's avatar
MARCHE Claude committed
689 690 691
  Format.kasprintf
    message_zone#buffer#set_text
    fmt
692 693 694 695 696 697 698
   *)
  Format.kfprintf
    (fun _ -> let s = flush_str_formatter () in
              message_zone#buffer#set_text s)
    str_formatter
    fmt

699 700 701 702 703 704

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

705
(**** Monitor *****)
Clément Fumex's avatar
Clément Fumex committed
706

707 708 709 710 711 712 713 714 715 716 717 718 719
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
720 721 722
  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
723

MARCHE Claude's avatar
MARCHE Claude committed
724

725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
(****************************)
(* 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

740 741 742 743 744 745 746
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
747
let init_completion provers transformations commands =
748
  (* add the names of all the the transformations *)
Clément Fumex's avatar
Clément Fumex committed
749
  List.iter add_completion_entry transformations;
750
  (* add the name of the commands *)
Clément Fumex's avatar
Clément Fumex committed
751
  List.iter add_completion_entry commands;
752 753
  (* todo: add queries *)

754
  (* add provers *)
Clément Fumex's avatar
Clément Fumex committed
755 756
  List.iter add_completion_entry provers;

757 758 759
  add_completion_entry "auto";
  add_completion_entry "auto 2";

760
  command_entry_completion#set_text_column completion_col;
761
  command_entry_completion#set_match_func match_function;
762

763
  command_entry#set_completion command_entry_completion
764

Sylvain Dailler's avatar
Sylvain Dailler committed
765
(*********************)
766
(* Terminal history  *)
Sylvain Dailler's avatar
Sylvain Dailler committed
767 768
(*********************)

769
let list_commands = create_history()
Sylvain Dailler's avatar
Sylvain Dailler committed
770 771 772

let _ =
  command_entry#event#connect#key_press
773 774 775
    ~callback:(fun (ev: 'a Gdk.event) ->
      match GdkEvent.Key.keyval ev with
      | k when k = GdkKeysyms._Up -> (* Arrow up *)
776 777 778 779 780
          let s = print_next_command list_commands in
          (match s with
          | None -> true
          | Some s ->
              (command_entry#set_text s; true))
781
      | k when k = GdkKeysyms._Down -> (* Arrow down *)
782 783 784 785 786
          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
787 788 789
      | _ -> false
      )

Clément Fumex's avatar
Clément Fumex committed
790 791 792
let () =
  let n = gconfig.session_nb_processes in
  Debug.dprintf debug "[IDE] setting max proof tasks to %d@." n;
793
  send_request (Set_max_tasks_req n)
794

795 796
let (_ : GtkSignal.id) =
  replay_menu_item#connect#activate
797
    ~callback:(fun () -> send_request Replay_req)
798

799 800 801
(**************************)
(* Graphical proof status *)
(**************************)
802

Sylvain Dailler's avatar
Sylvain Dailler committed
803 804
let image_of_pa_status ~obsolete pa =
  match pa with
805 806
  | Controller_itp.Unedited -> !image_scheduled (* TODO !image_unedited *)
  | Controller_itp.JustEdited -> !image_scheduled (* TODO !image_edited *)
807
  | Controller_itp.Interrupted -> !image_undone
808 809 810 811
  | 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
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
(*  | 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
835

Clément Fumex's avatar
Clément Fumex committed
836 837
let set_status_column iter =
  let id = get_node_id iter in
838
  let proved = get_node_proved id in
839
  let detached = get_node_detached id in
Clément Fumex's avatar
Clément Fumex committed
840 841 842 843 844 845
  let image = match get_node_type id with
    | NRoot -> assert false
    | NFile
    | NTheory
    | NTransformation
    | NGoal ->
846 847 848 849 850 851
      if detached then
        !image_valid_obs
      else
        if proved
        then !image_valid
        else !image_unknown
852
    | NProofAttempt ->
Sylvain Dailler's avatar
Sylvain Dailler committed
853 854 855
      let pa = get_node_proof_attempt id in
      let obs = get_node_obs id in
      image_of_pa_status ~obsolete:obs pa
856 857
  in
  goals_model#set ~row:iter ~column:status_column image
858

859
let new_node ?parent ?(collapse=false) id name typ proved detached =
Clément Fumex's avatar
Clément Fumex committed
860 861
  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
862
    Hint.add node_id_proved id proved;
863
    Hint.add node_id_detached id detached;
Sylvain Dailler's avatar
Sylvain Dailler committed
864 865 866 867 868 869 870
    (* 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
871
    goals_model#set ~row:iter ~column:name_column name;
Clément Fumex's avatar
Clément Fumex committed
872
    goals_model#set ~row:iter ~column:node_id_column id;
873 874 875 876 877 878 879
    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
880 881 882 883
    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;
884 885
    set_status_column iter;
    new_ref
Clément Fumex's avatar
Clément Fumex committed
886
  end
887 888
  else
    Hint.find node_id_to_gtree id
889

890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
(*******************************)
(* 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
906
    ~callback:enlarge_fonts "Enlarge font"
907 908 909

let (_ : GMenu.menu_item) =
    view_factory#add_item ~key:GdkKeysyms._minus
Clément Fumex's avatar
Clément Fumex committed
910
      ~callback:reduce_fonts "Reduce font"
911 912 913 914 915

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

916
let collapse_iter iter =
917 918 919
  let path = goals_model#get_path iter in
  goals_view#collapse_row path

920 921 922 923 924 925 926 927 928 929
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
930 931 932 933 934 935 936 937

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
938
    ~label:"Collapse proven goals" ~callback:(fun () -> collapse_proven_goals ()) ()
939 940 941 942 943 944 945

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

949 950 951 952
(******************)
(*    actions     *)
(******************)

Clément Fumex's avatar
Clément Fumex committed
953 954 955 956
let get_selected_row_references () =
  List.map
    (fun path -> goals_model#get_row_reference path)
    goals_view#selection#get_selected_rows
957

958
let rec update_status_column_from_iter cont iter =
Clément Fumex's avatar
Clément Fumex committed
959
  set_status_column iter;
960
  match goals_model#iter_parent iter with
961
  | Some p -> update_status_column_from_iter cont p
962 963
  | None -> ()

964 965
let move_current_row_selection_up () =
  let current_view = List.hd (goals_view#selection#get_selected_rows) in
966 967 968
  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
969 970 971 972 973 974 975 976 977 978 979 980 981

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

982
let clear_command_entry () = command_entry#set_text ""
MARCHE Claude's avatar
MARCHE Claude committed
983 984

let interp cmd =
Clément Fumex's avatar
Clément Fumex committed
985 986 987 988 989 990
  (* 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
Sylvain Dailler's avatar
Sylvain Dailler committed
991
      (* If no nodes are in the tree send command on default root node *)
Clément Fumex's avatar
Clément Fumex committed
992 993
      root_node
  in
Sylvain Dailler's avatar
Sylvain Dailler committed
994
  send_request (Command_req (id, cmd));
995
  clear_command_entry ()
MARCHE Claude's avatar
MARCHE Claude committed
996 997 998

let (_ : GtkSignal.id) =
  command_entry#connect#activate
999 1000
    ~callback:(fun () -> add_command list_commands command_entry#text;
      interp command_entry#text)
1001

1002 1003
let on_selected_row r =
  try
Clément Fumex's avatar
Clément Fumex committed
1004 1005 1006 1007
    let id = get_node_id r#iter in
    let typ = get_node_type id in
    match typ with
    | NGoal ->
1008 1009 1010 1011 1012
      let detached = get_node_detached id in
      if detached then
        task_view#source_buffer#set_text ""
      else
        send_request (Get_task id)
1013
    | _ ->  send_request (Get_task id)
1014 1015
  with
    | Not_found -> task_view#source_buffer#set_text ""
Clément Fumex's avatar
Clément Fumex committed
1016

1017 1018 1019
let (_ : GtkSignal.id) =
  goals_view#selection#connect#after#changed ~callback:
    (fun () ->
MARCHE Claude's avatar
MARCHE Claude committed
1020 1021 1022 1023 1024 1025
     begin
       match get_selected_row_references () with
       | [r] -> on_selected_row r
       | _ -> ()
     end (* ;
     command_entry#misc#grab_focus () *))
Clément Fumex's avatar
Clément Fumex committed
1026

1027 1028 1029 1030 1031 1032 1033
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
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
(*************************************)
(* 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"

1078 1079 1080 1081 1082
(* TODO replace this with menu items *)
let (_ : GMenu.menu_item) =
  exp_factory#add_item ~key:GdkKeysyms._X "Save files"
    ~callback:(fun () -> save_sources ())

1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
(*********************************)
(* 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;
        send_request (Open_session_req f)))

Clément Fumex's avatar
Clément Fumex committed
1130 1131 1132 1133 1134 1135
(*************************)
(* Notification Handling *)
(*************************)

let treat_message_notification msg = match msg with
  (* TODO: do something ! *)
MARCHE Claude's avatar
MARCHE Claude committed
1136 1137 1138 1139 1140 1141 1142 1143
  | Proof_error (_id, s)   -> print_message "%s" s
  | Transf_error (_id, s)  -> print_message "%s" s
  | Strat_error (_id, s)   -> print_message "%s" s
  | Replay_Info s          -> print_message "%s" s
  | Query_Info (_id, s)    -> print_message "%s" s
  | Query_Error (_id, s)   -> print_message "%s" s
  | Help s<