why3ide.ml 81.3 KB
Newer Older
1 2 3
(********************************************************************)
(*                                                                  *)
(*  The Why3 Verification Platform   /   The Why3 Development Team  *)
Guillaume Melquiond's avatar
Guillaume Melquiond committed
4
(*  Copyright 2010-2018   --   Inria - CNRS - Paris-Sud University  *)
5 6 7 8 9 10 11
(*                                                                  *)
(*  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 Wstdlib
Sylvain Dailler's avatar
Sylvain Dailler committed
16 17
open Ide_utils
open History
18
open Itp_communication
19

20 21
module GSourceView = GSourceView2

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

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

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


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

let print_request_json fmt (r: ide_request) =
  (try (
    let s = Pp.string_of Json_util.print_request r in
38
    let x = Json_util.parse_request s in
39 40 41 42 43 44 45
    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 (
46
    let x = Json_util.parse_notification (Pp.string_of Json_util.print_notification n) in
47 48 49 50 51 52 53 54
    if n = x then () else raise Badparsing)
  with
    _ -> Format.eprintf "Bad parsing@.");
  Json_util.print_notification fmt n

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

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

MARCHE Claude's avatar
MARCHE Claude committed
59

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

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

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

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

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

  let list_requests: ide_request list ref = ref []

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

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

  let notification_list: notification list ref = ref []

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

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

end

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

109
let send_request r = Protocol_why3ide.send_request r
Sylvain Dailler's avatar
Sylvain Dailler committed
110

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

115 116 117 118 119 120 121 122 123 124
(*
   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
125 126 127 128 129 130 131 132 133 134 135 136 137 138
     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
139

140
module Scheduler = struct
141

142 143
    let blocking = false

144
    let multiplier = 3
145

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

Clément Fumex's avatar
Clément Fumex committed
149
    let timeout ~ms f =
150 151
      let (_ : GMain.Timeout.id) =
        GMain.Timeout.add ~ms ~callback:(backtrace_and_exit f) in ()
Clément Fumex's avatar
Clément Fumex committed
152
end
153

154
module Server = Itp_server.Make (Scheduler) (Protocol_why3ide)
155

Clément Fumex's avatar
Clément Fumex committed
156 157 158
(************************)
(* parsing command line *)
(************************)
159

Clément Fumex's avatar
Clément Fumex committed
160 161
let files : string Queue.t = Queue.create ()
let opt_parser = ref None
162
let opt_batch = ref None
Clément Fumex's avatar
Clément Fumex committed
163

164
let spec = [
Clément Fumex's avatar
Clément Fumex committed
165 166 167 168
  "-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
169
(*
Clément Fumex's avatar
Clément Fumex committed
170 171 172
  "-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
173
*)
174 175
  Termcode.arg_extra_expl_prefix;
  "--batch", Arg.String (fun s -> opt_batch := Some s), "";
Clément Fumex's avatar
Clément Fumex committed
176
]
177

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

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

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


MARCHE Claude's avatar
MARCHE Claude committed
195

MARCHE Claude's avatar
MARCHE Claude committed
196 197 198 199
(********************************)
(* Source language highlighting *)
(********************************)

MARCHE Claude's avatar
MARCHE Claude committed
200

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

237 238 239 240 241 242
(****************************)
(* Color handling in source *)
(****************************)

(* For each view, we have to recreate the tags *)
let create_colors v =
243
  let premise_tag (v: GSourceView.source_view) = v#buffer#create_tag
244
      ~name:"premise_tag" [`BACKGROUND gconfig.premise_color] in
245
  let neg_premise_tag (v: GSourceView.source_view) = v#buffer#create_tag
246
      ~name:"neg_premise_tag" [`BACKGROUND gconfig.neg_premise_color] in
247
  let goal_tag (v: GSourceView.source_view) = v#buffer#create_tag
248
      ~name:"goal_tag" [`BACKGROUND gconfig.goal_color] in
249
  let error_line_tag (v: GSourceView.source_view) = v#buffer#create_tag
250
      ~name:"error_line_tag" [`BACKGROUND gconfig.error_line_color] in
251
  let error_tag (v: GSourceView.source_view) = v#buffer#create_tag
252
      ~name:"error_tag" [`BACKGROUND gconfig.error_color_bg] in
253 254 255
  let _ : GText.tag = premise_tag v in
  let _ : GText.tag = neg_premise_tag v in
  let _ : GText.tag = goal_tag v in
256
  let _ : GText.tag = error_line_tag v in
257 258 259 260
  let _ : GText.tag = error_tag v in
  ()

(* Erase all the source location tags in a source file *)
261
let erase_color_loc (v:GSourceView.source_view) =
262 263 264 265
  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;
266 267
  buf#remove_tag_by_name "error_tag" ~start:buf#start_iter ~stop:buf#end_iter;
  buf#remove_tag_by_name "error_line_tag" ~start:buf#start_iter ~stop:buf#end_iter
268 269


MARCHE Claude's avatar
MARCHE Claude committed
270

271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
(*******************)
(* 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 ()

286
(* Contains quadruples (tab page, source_view, file_has_been_modified, label_of_tab):
287 288 289 290 291 292
   - 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
*)
293
let source_view_table : (int * GSourceView.source_view * bool ref * GMisc.label) Hstr.t =
294 295
  Hstr.create 14

296 297 298
(* The corresponding file does not have a source view *)
exception Nosourceview of string

299 300 301 302 303
let get_source_view_table (file:string) =
  match Hstr.find source_view_table file with
  | v -> v
  | exception Not_found -> raise (Nosourceview file)

304
(* This returns the source_view of a file *)
305
let get_source_view (file: string) : GSourceView.source_view =
306 307 308 309
  match Hstr.find source_view_table file with
  | (_, v, _, _) -> v
  | exception Not_found -> raise (Nosourceview file)

310 311 312
(* Saving function for sources *)
let save_sources () =
  Hstr.iter
313
    (fun k (_n, (s: GSourceView.source_view), b, _l) ->
314 315 316 317 318 319 320 321 322 323 324 325 326
      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 () =
327 328 329 330
  send_request Check_need_saving_req

let exit_function_handler b =
  if not b && not (files_need_saving ()) then
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
    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))

358 359 360 361 362 363
let make_sources_editable b =
  Hstr.iter
    (fun _ (_,source_view,_,_) ->
      source_view#set_editable b;
      source_view#set_auto_indent b)
    source_view_table
MARCHE Claude's avatar
MARCHE Claude committed
364

365 366 367
(**********************)
(* Graphical elements *)
(**********************)
368

369
let initialization_complete = ref false
370 371 372 373 374 375
let warnings = Queue.create ()

let record_warning ?loc msg =
  Format.eprintf "%awarning: %s@."
    (Pp.print_option Loc.report_position) loc msg;
  Queue.push (loc,msg) warnings
376 377

let () =
378
  Warning.set_hook record_warning;
379 380 381 382 383 384 385 386 387 388 389 390 391 392
  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;
  send_request Get_global_infos;
  Debug.dprintf debug "Init the GTK interface...@?";
  ignore (GtkMain.Main.init ());
  Debug.dprintf debug " done.@.";
  Gconfig.init ()
MARCHE Claude's avatar
MARCHE Claude committed
393

394
let window_title =
395
  match !opt_batch with
396 397
  | Some _ -> "Why3 Batch Mode"
  | None -> "Why3 Interactive Proof Session"
398

399
let main_window : GWindow.window =
400 401
  let w = GWindow.window ~title:window_title () in
  w#resize ~width:gconfig.window_width ~height:gconfig.window_height;
402 403 404 405 406 407 408 409
  (* 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)
410 411
  in
  w
412 413

(* the main window contains a vertical box, containing:
414 415
   1. the menu [menubar]
   2. an horizontal box [hb]
416 417 418 419 420 421 422 423 424 425
 *)

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

426
let accel_group = GtkData.AccelGroup.create ()
427

MARCHE Claude's avatar
MARCHE Claude committed
428 429 430
(* context_tools : simplified tools menu for mouse-3 *)

let context_tools_menu = GMenu.menu ()
431

MARCHE Claude's avatar
MARCHE Claude committed
432 433 434 435 436 437 438 439 440 441 442
(****************************)
(* actions of the interface *)
(****************************)


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

(* File menu signals *)

443 444 445 446 447 448 449 450
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
451 452 453 454 455 456 457
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)
458

459 460
(* 2. horizontal box contains:
   2.1 TODO: a tool box ?
461 462 463
   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]
464 465 466 467
*)

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

468 469
(** {2 view for the session tree} *)
let scrolled_session_view =
470 471 472
  let sv =
    GBin.scrolled_window
      ~hpolicy:`AUTOMATIC ~vpolicy:`AUTOMATIC
473
      ~shadow_type:`ETCHED_OUT
474 475
      ~packing:hp#add ()
  in
476
  hp#set_position gconfig.tree_width;
477 478 479 480 481 482 483
  let (_ : GtkSignal.id) =
    sv#misc#connect#size_allocate
      ~callback:
      (fun {Gtk.width=w;Gtk.height=_h} ->
       gconfig.tree_width <- w)
  in sv

484 485 486 487 488 489 490
(* Vertical pan *)
let vpan222 = GPack.paned `VERTICAL ~packing:hp#add ()

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

*)

491 492
(** {3 the model for tree view} *)

493
let cols = new GTree.column_list
494
(* first column: unique id of the object *)
Clément Fumex's avatar
Clément Fumex committed
495
let node_id_column = cols#add Gobject.Data.int
496 497 498 499 500
(* 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. *)
501
let status_column = cols#add Gobject.Data.gobject
502
(* fifth column: extra status info: time, obsolete status, limits *)
503
let time_column = cols#add Gobject.Data.string
MARCHE Claude's avatar
MARCHE Claude committed
504

505 506 507 508 509
(* 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
510
  v#pack icon_renderer ~expand:false;
511 512 513 514
  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;
515
  (* v#set_sizing `AUTOSIZE; *)
516
  v#set_resizable true;
517
  (*  v#set_max_width 1000;*)
518 519 520 521 522 523 524 525 526 527 528 529
  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
530 531 532

let view_time_column =
  let renderer = GTree.cell_renderer_text [`XALIGN 0.] in
533 534 535 536 537 538
  let v = GTree.view_column ~title:"Time"
                            ~renderer:(renderer, ["text", time_column]) ()
  in
  v#set_resizable false;
  v#set_visible true;
  v
539

540
let goals_model,goals_view =
541
  Debug.dprintf debug "Creating tree model...@?";
542 543 544
  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
545
(*
546
  let () = view#set_rules_hint true in
547 548
*)
  let () = view#set_enable_search false in
549
  let _: int = view#append_column view_status_column in
550
  let _: int = view#append_column view_name_column in
551
  let _: int = view#append_column view_time_column in
552
  view#set_expander_column (Some view_name_column);
553
  Debug.dprintf debug "done@.";
554
  model,view
555

556 557 558 559 560 561 562 563 564 565 566 567

(***********************************)
(* 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
568
let node_id_detached : bool Hint.t = Hint.create 17
569 570

let get_node_type id = Hint.find node_id_type id
571 572 573 574 575

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

576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
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_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_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

594 595 596
let get_node_detached id =
  Hint.find node_id_detached id

597 598 599 600 601 602 603 604 605 606 607 608 609 610
(******************************)
(* 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;
611 612
  Hint.clear node_id_pa;
  Hint.clear node_id_detached
613 614 615 616 617


(**************)
(* Menu items *)
(**************)
618

Clément Fumex's avatar
Clément Fumex committed
619
(* vpan222 contains:
620
   2.2.2.1 a notebook containing view of the current task, source code etc
621
   2.2.2.2 a vertical pan which contains [vbox2222]
Clément Fumex's avatar
Clément Fumex committed
622
     2.2.2.2.1 the input field to type commands
623
     2.2.2.2.2 a scrolled window to hold the output of the commands
624 625
 *)

626 627 628
(***********************************)
(*    notebook on the top 2.2.2.1  *)
(***********************************)
629

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

633 634 635
(********************************)
(* Task view (part of notebook) *)
(********************************)
Guillaume Melquiond's avatar
Guillaume Melquiond committed
636
let scrolled_task_view =
637
  let label = GMisc.label ~text:"Task" () in
Guillaume Melquiond's avatar
Guillaume Melquiond committed
638
  GPack.vbox ~homogeneous:false ~packing:
639 640
    (fun w -> ignore(notebook#append_page ~tab_label:label#coerce w)) ()

641 642
let scrolled_task_view =
  GBin.scrolled_window
643
    ~height:gconfig.task_height
644 645
    ~hpolicy: `AUTOMATIC ~vpolicy: `AUTOMATIC
    ~shadow_type:`ETCHED_OUT
646
    ~packing:scrolled_task_view#add ()
647

648 649 650 651 652 653 654
let (_ : GtkSignal.id) =
  scrolled_task_view#misc#connect#size_allocate
    ~callback:
    (fun {Gtk.width=_w;Gtk.height=h} ->
       gconfig.task_height <- h)


655
let task_view =
656
  GSourceView.source_view
657
    ~editable:false
Clément Fumex's avatar
Clément Fumex committed
658
    ~cursor_visible:false
659 660 661 662
    ~show_line_numbers:true
    ~packing:scrolled_task_view#add
    ()

663

664
(* Creating a page for source code view *)
665
let create_source_view =
666
  (* Counter for pages *)
667
  let n = ref 1 in
668 669
  (* Create a page with tabname [f] and buffer equal to [content] in the
     notebook. Also add a corresponding page in source_view_table. *)
670 671 672
  let create_source_view f content =
    if not (Hstr.mem source_view_table f) then
      begin
MARCHE Claude's avatar
MARCHE Claude committed
673 674
        let label = GMisc.label ~text:(Filename.basename f) () in
        label#misc#set_tooltip_markup f;
675 676
        let source_page, scrolled_source_view =
          !n, GPack.vbox ~homogeneous:false ~packing:
677 678
            (fun w -> ignore(notebook#append_page ~tab_label:label#coerce w)) ()
        in
679 680 681 682 683 684
        let scrolled_source_view =
          GBin.scrolled_window
            ~hpolicy: `AUTOMATIC ~vpolicy: `AUTOMATIC
            ~shadow_type:`ETCHED_OUT
            ~packing:scrolled_source_view#add () in
        let source_view =
685
          GSourceView.source_view
686
            ~auto_indent:gconfig.allow_source_editing
687 688 689 690
            ~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 *)
691
            ~editable:gconfig.allow_source_editing
692 693
            ~packing:scrolled_source_view#add
            () in
694 695
        let has_changed = ref false in
        Hstr.add source_view_table f (source_page, source_view, has_changed, label);
696
        n := !n + 1;
697
        source_view#source_buffer#begin_not_undoable_action ();
698
        source_view#source_buffer#set_text content;
699
        source_view#source_buffer#end_not_undoable_action ();
700 701 702 703 704 705 706 707 708 709 710
        (* 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
711 712
        Gconfig.add_modifiable_mono_font_view source_view#misc;
        source_view#source_buffer#set_language why_lang;
713 714 715
        (* We have to create the tags for background colors for each view.
           They are not reusable from the other views.  *)
        create_colors source_view;
716 717 718
        Gconfig.set_fonts ()
      end in
  create_source_view
719 720 721



722 723
(* End of notebook *)

724 725 726 727 728
(*
  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
729
let vbox2222 = GPack.vbox ~packing:vpan222#add  ()
730

731 732 733 734
(* 2.2.2.2.1 Horizontal box [hbox22221]
     [monitor] number of scheduled/running provers
     [command_entry] Commands to run on the session
*)
735 736 737 738 739 740
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
741
    ~text:"  0/0/0"
742
    ~width:100
MARCHE Claude's avatar
MARCHE Claude committed
743
    ~xalign:0.0
744
    ~packing:(hbox22221#pack ?from:None ?expand:None ?fill:None ?padding:None) ()
745

746 747 748 749
let command_entry =
  GEdit.entry
    ~text:"type commands here"
    ~packing:hbox22221#add ()
MARCHE Claude's avatar
MARCHE Claude committed
750

751 752 753 754 755 756 757 758
(* 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)) ()

Guillaume Melquiond's avatar
Guillaume Melquiond committed
759
let log_view =
760
  let label = GMisc.label ~text:"Log" () in
Guillaume Melquiond's avatar
Guillaume Melquiond committed
761
  GPack.vbox ~homogeneous:false ~packing:
762 763 764
    (fun w -> ignore(messages_notebook#append_page ~tab_label:label#coerce w)) ()

(* tab 3: edited proof *)
Guillaume Melquiond's avatar
Guillaume Melquiond committed
765
let edited_tab =
766
  let label = GMisc.label ~text:"Edited proof" () in
Guillaume Melquiond's avatar
Guillaume Melquiond committed
767
  GPack.vbox ~homogeneous:false ~packing:
768 769 770 771 772 773 774 775
    (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 =
776
  GSourceView.source_view
777 778 779 780 781 782
    ~editable:false
    ~show_line_numbers:true
    ~packing:scrolled_edited_view#add
    ()

(* tab 4: prover output *)
Guillaume Melquiond's avatar
Guillaume Melquiond committed
783
let output_tab =
784
  let label = GMisc.label ~text:"Prover output" () in
Guillaume Melquiond's avatar
Guillaume Melquiond committed
785
  GPack.vbox ~homogeneous:false ~packing:
786 787 788 789 790 791 792 793
    (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 =
794
  GSourceView.source_view
795 796 797 798 799 800 801 802 803 804
    ~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:
805 806
    (fun w -> ignore(messages_notebook#append_page ~tab_label:label#coerce w)) ()

807 808 809 810 811 812
let scrolled_counterexample_view =
  GBin.scrolled_window
    ~hpolicy: `AUTOMATIC ~vpolicy: `AUTOMATIC
    ~shadow_type:`ETCHED_OUT ~packing:counterexample_tab#add ()

let counterexample_view =
813
  GSourceView.source_view
814 815 816 817 818
    ~editable:false
    ~show_line_numbers:true
    ~packing:scrolled_counterexample_view#add
    ()

819 820
(* Allow colors locations on counterexample view *)
let () = create_colors counterexample_view
821

MARCHE Claude's avatar
MARCHE Claude committed
822
let message_zone =
823 824
  let sv = GBin.scrolled_window
      ~hpolicy:`AUTOMATIC ~vpolicy:`AUTOMATIC
825 826 827 828 829 830 831 832 833
      ~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 ()
834
  in
MARCHE Claude's avatar
MARCHE Claude committed
835
  GText.view ~editable:false ~cursor_visible:false
836 837
    ~packing:sv#add ()

838 839
(* Create a tag for errors in the message zone. *)
let message_zone_error_tag = message_zone#buffer#create_tag
840
  ~name:"error_tag" [`BACKGROUND gconfig.error_color_bg; `FOREGROUND gconfig.error_color]
841

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

MARCHE Claude's avatar
MARCHE Claude committed
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
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");
864 865
  log_zone#scroll_to_mark `INSERT

866 867
let clear_message_zone () =
  let buf = message_zone#buffer in
868
  buf#remove_tag_by_name "error_tag" ~start:buf#start_iter ~stop:buf#end_iter;
869 870
  buf#delete ~start:buf#start_iter ~stop:buf#end_iter

871
(* Function used to print stuff on the message_zone *)
MARCHE Claude's avatar
MARCHE Claude committed
872
let print_message ~kind ~notif_kind fmt =
873
  (* TODO: use kasprintf once OCaml 4.03 is used *)
874 875
  Format.kfprintf
    (fun _ -> let s = flush_str_formatter () in
MARCHE Claude's avatar
MARCHE Claude committed
876
              let s = try_convert s in
MARCHE Claude's avatar
MARCHE Claude committed
877
              add_to_log notif_kind s;
878
              let buf = message_zone#buffer in
MARCHE Claude's avatar
MARCHE Claude committed
879 880
              if kind>0 then
                begin
881 882 883
                  if Strings.ends_with notif_kind "error" ||
                     Strings.ends_with notif_kind "Error"
                  then
884
                    buf#insert ~tags:[message_zone_error_tag] (s ^ "\n")
885
                  else
886
                    buf#insert (s ^ "\n");
887
                  messages_notebook#goto_page error_page;
MARCHE Claude's avatar
MARCHE Claude committed
888
                end)
889 890 891
    str_formatter
    fmt

892 893 894 895 896 897 898
let display_warnings fmt warnings =
  let nwarn = ref 0 in
  try
    Queue.iter (fun (loc,msg) ->
      if !nwarn = 4 then begin
        Format.fprintf fmt "[%d more warnings. See stderr for details]@\n" (Queue.length warnings - !nwarn);
        raise Exit
899
      end;
900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
      incr nwarn;
      match loc with
      | None ->
        Format.fprintf fmt "%s@\n@\n" msg
      | Some l ->
        (* scroll_to_loc ~color:error_tag ~yalign:0.5 loc; *)
        Format.fprintf fmt "%a: %s@\n@\n" Loc.gen_report_position l msg
    ) warnings;
  with Exit -> ()

let display_warnings () =
  if Queue.is_empty warnings then ()
  else begin
    print_message ~kind:1 ~notif_kind:"warning" "%a" display_warnings warnings;
    Queue.clear warnings;
  end
916

917 918 919 920
let print_message ~kind ~notif_kind fmt =
  display_warnings (); print_message ~kind ~notif_kind fmt


921

922

923
(**** Monitor *****)
Clément Fumex's avatar
Clément Fumex committed
924

925
let fan =
926
  let s = Bytes.of_string "\226\150\129" in
927
  let c = Char.code (Bytes.get s 2) in
928
  let a = Array.init 8 (fun i ->
929 930 931
    Bytes.set s 2 (Char.chr (c + i));
    Bytes.to_string s) in
  fun n ->
932 933 934
  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
935
  a.(n)
936 937 938 939 940 941

let update_monitor =
  let c = ref 0 in
  fun t s r ->
  reset_gc ();
  incr c;
942 943 944
  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
945

946 947 948 949 950 951 952
(**********************)
(* Cursor positioning *)
(**********************)

(* Current position in the source files *)
let current_cursor_loc = ref None

953
let move_to_line ~yalign (v : GSourceView.source_view) line =
954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
  let line = max 0 (line - 1) in
  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

(* Scroll to a specific locations *)
let scroll_to_loc ~force_tab_switch loc_of_goal =
  match loc_of_goal with
  | None -> ()
  | Some loc ->
    let f, l, _, _ = Loc.get loc in
    try
      let (n, v, _, _) = get_source_view_table f in
      if force_tab_switch then
        begin
          Debug.dprintf debug "tab switch to page %d@." n;
          notebook#goto_page n;
        end;
      move_to_line ~yalign:0.0 v l
    with Nosourceview f ->
      Debug.dprintf debug "scroll_to_loc: no source know for file %s@." f

(* Reposition the cursor to the place it was saved *)
let reposition_ide_cursor () =
  scroll_to_loc ~force_tab_switch:false !current_cursor_loc

(* Save the current location of the cursor to be reused after reload *)
let save_cursor_loc () =
  let n = notebook#current_page in
  let acc = ref None in
  Hstr.iter (fun k (x, v, _, _) -> if x = n then acc := Some (k, v)) source_view_table;
  match !acc with
  | None -> ()
  | Some (cur_file, view) ->
    (* Get current line *)
    let line = (view#buffer#get_iter_at_mark `INSERT)#line + 1 in
    current_cursor_loc := Some (Loc.user_position cur_file line 1 1)
MARCHE Claude's avatar
MARCHE Claude committed
993

994 995 996
(******************)
(* Reload actions *)
(******************)
997

998 999
let reload_unsafe () =
  save_cursor_loc (); clear_message_zone (); send_request Reload_req
1000 1001 1002

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

1003 1004 1005 1006 1007 1008
(****************************)
(* command entry completion *)
(****************************)

let completion_cols = new GTree.column_list
let completion_col = completion_cols#add Gobject.Data.string
1009
let completion_desc = completion_cols#add Gobject.Data.string
1010 1011 1012
let completion_model = GTree.tree_store completion_cols

let command_entry_completion : GEdit.entry_completion =
1013
  GEdit.entry_completion ~model:completion_model ~minimum_key_length:2 ~entry:command_entry ()
1014

1015
let add_completion_entry (s,desc) =
1016
  let row = completion_model#append () in
1017
  completion_model#set ~row ~column:completion_col s;
1018
  completion_model#set ~row ~column:completion_desc desc
1019

1020 1021 1022
let match_function s iter =
  let candidate = completion_model#get ~row:iter ~column:completion_col in
  try
1023
    ignore (Str.search_forward (Str.regexp_string_case_fold s) candidate 0);
1024 1025 1026
    true
  with Not_found -> false

1027
(* see also init_completion below *)
1028

Sylvain Dailler's avatar
Sylvain Dailler committed
1029
(*********************)
1030
(* Terminal history  *)
Sylvain Dailler's avatar
Sylvain Dailler committed
1031 1032
(*********************)

1033
let list_commands = create_history()
Sylvain Dailler's avatar
Sylvain Dailler committed
1034 1035 1036

let _ =
  command_entry#event#connect#key_press
MARCHE Claude's avatar