Attention une mise à jour du serveur va être effectuée le vendredi 16 avril entre 12h et 12h30. Cette mise à jour va générer une interruption du service de quelques minutes.

why3ide.ml 83.6 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
external reset_gc : unit -> unit = "ml_reset_gc"

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

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


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

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

MARCHE Claude's avatar
MARCHE Claude committed
57

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

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

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

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

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

  let list_requests: ide_request list ref = ref []

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

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

  let notification_list: notification list ref = ref []

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

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

end

Clément Fumex's avatar
Clément Fumex committed
105
let get_notified = Protocol_why3ide.get_notified
Sylvain Dailler's avatar
Sylvain Dailler committed
106

107
let send_request r = Protocol_why3ide.send_request r
Sylvain Dailler's avatar
Sylvain Dailler committed
108

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

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

138
module Scheduler = struct
139

140 141
    let blocking = false

142
    let multiplier = 3
143

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

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

152
module Server = Itp_server.Make (Scheduler) (Protocol_why3ide)
153

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

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

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

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

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

  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
193

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

MARCHE Claude's avatar
MARCHE Claude committed
198

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

235 236 237 238 239 240 241 242 243 244 245 246
(****************************)
(* 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
247 248
  let error_line_tag (v: GSourceView2.source_view) = v#buffer#create_tag
      ~name:"error_line_tag" [`BACKGROUND gconfig.error_line_color] in
249
  let error_tag (v: GSourceView2.source_view) = v#buffer#create_tag
250
      ~name:"error_tag" [`BACKGROUND gconfig.error_color_bg] in
251 252 253
  let _ : GText.tag = premise_tag v in
  let _ : GText.tag = neg_premise_tag v in
  let _ : GText.tag = goal_tag v in
254
  let _ : GText.tag = error_line_tag v in
255 256 257 258 259 260 261 262 263
  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;
264 265
  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
266 267


MARCHE Claude's avatar
MARCHE Claude committed
268

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

284
(* Contains quadruples (tab page, source_view, file_has_been_modified, label_of_tab):
285 286 287 288 289 290 291 292 293
   - 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

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

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

302 303 304 305 306 307
(* 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)

308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
(* 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 () =
325 326 327 328
  send_request Check_need_saving_req

let exit_function_handler b =
  if not b && not (files_need_saving ()) then
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
    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))

356 357 358 359 360 361
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
362

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

367
let initialization_complete = ref false
368 369 370 371 372 373
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
374

375 376 377
(* Keep the current session dir in memory *)
let session_dir = ref ""

378
let () =
379
  Warning.set_hook record_warning;
380 381 382 383 384 385 386
  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
387
  session_dir := dir;
388 389 390 391 392 393 394
  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
395

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

401
let main_window : GWindow.window =
402 403
  let w = GWindow.window
            ~allow_grow:true ~allow_shrink:true
404 405
            ~width:gconfig.window_width
            ~height:gconfig.window_height
406
            ~title:window_title ()
407 408 409 410 411 412 413 414 415
  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)
416 417
  in
  w
418 419

(* the main window contains a vertical box, containing:
420 421
   1. the menu [menubar]
   2. an horizontal box [hb]
422 423 424 425 426 427 428 429 430 431
 *)

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

432
let accel_group = GtkData.AccelGroup.create ()
433

MARCHE Claude's avatar
MARCHE Claude committed
434 435 436
(* context_tools : simplified tools menu for mouse-3 *)

let context_tools_menu = GMenu.menu ()
437

MARCHE Claude's avatar
MARCHE Claude committed
438 439 440 441 442 443 444 445 446 447 448
(****************************)
(* actions of the interface *)
(****************************)


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

(* File menu signals *)

449 450 451 452 453 454 455 456
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
457 458 459 460 461 462 463
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)
464

465 466
(* 2. horizontal box contains:
   2.1 TODO: a tool box ?
467 468 469
   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]
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
*)

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

488
(** {2 view for the session tree} *)
MARCHE Claude's avatar
MARCHE Claude committed
489 490 491 492
let scrolled_session_view =
  GBin.scrolled_window
    ~hpolicy: `AUTOMATIC ~vpolicy: `AUTOMATIC
    ~shadow_type:`ETCHED_OUT
MARCHE Claude's avatar
MARCHE Claude committed
493
    ~packing:scrollview#add_with_viewport
MARCHE Claude's avatar
MARCHE Claude committed
494 495
    ()

496 497 498 499 500 501 502
(* Vertical pan *)
let vpan222 = GPack.paned `VERTICAL ~packing:hp#add ()

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

*)

503 504
(** {3 the model for tree view} *)

505
let cols = new GTree.column_list
506
(* first column: unique id of the object *)
Clément Fumex's avatar
Clément Fumex committed
507
let node_id_column = cols#add Gobject.Data.int
508 509 510 511 512
(* 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. *)
513
let status_column = cols#add Gobject.Data.gobject
514
(* fifth column: extra status info: time, obsolete status, limits *)
515
let time_column = cols#add Gobject.Data.string
MARCHE Claude's avatar
MARCHE Claude committed
516

517 518 519 520 521
(* 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
522
  v#pack icon_renderer ~expand:false;
523 524 525 526
  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;
527
  (* v#set_sizing `AUTOSIZE; *)
528
  v#set_resizable true;
529
  (*  v#set_max_width 1000;*)
530 531 532 533 534 535 536 537 538 539 540 541
  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
542 543 544

let view_time_column =
  let renderer = GTree.cell_renderer_text [`XALIGN 0.] in
545 546 547 548 549 550
  let v = GTree.view_column ~title:"Time"
                            ~renderer:(renderer, ["text", time_column]) ()
  in
  v#set_resizable false;
  v#set_visible true;
  v
551

552
let goals_model,goals_view =
553
  Debug.dprintf debug "Creating tree model...@?";
554 555 556
  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
557
(*
558
  let () = view#set_rules_hint true in
559 560
*)
  let () = view#set_enable_search false in
561
  let _: int = view#append_column view_status_column in
562
  let _: int = view#append_column view_name_column in
563
  let _: int = view#append_column view_time_column in
564
  view#set_expander_column (Some view_name_column);
565
  Debug.dprintf debug "done@.";
566
  model,view
567

568 569 570 571 572 573 574 575 576 577 578 579

(***********************************)
(* 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
580
let node_id_detached : bool Hint.t = Hint.create 17
581 582

let get_node_type id = Hint.find node_id_type id
583 584 585 586 587

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

588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
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

606 607 608
let get_node_detached id =
  Hint.find node_id_detached id

609 610 611 612 613 614 615 616 617 618 619 620 621 622
(******************************)
(* 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;
623 624
  Hint.clear node_id_pa;
  Hint.clear node_id_detached
625 626 627 628 629


(**************)
(* Menu items *)
(**************)
630

Clément Fumex's avatar
Clément Fumex committed
631
(* vpan222 contains:
632
   2.2.2.1 a notebook containing view of the current task, source code etc
633
   2.2.2.2 a vertical pan which contains [vbox2222]
Clément Fumex's avatar
Clément Fumex committed
634
     2.2.2.2.1 the input field to type commands
635
     2.2.2.2.2 a scrolled window to hold the output of the commands
636 637
 *)

638 639 640
(***********************************)
(*    notebook on the top 2.2.2.1  *)
(***********************************)
641

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

645 646 647
(********************************)
(* Task view (part of notebook) *)
(********************************)
Guillaume Melquiond's avatar
Guillaume Melquiond committed
648
let scrolled_task_view =
649
  let label = GMisc.label ~text:"Task" () in
Guillaume Melquiond's avatar
Guillaume Melquiond committed
650
  GPack.vbox ~homogeneous:false ~packing:
651 652
    (fun w -> ignore(notebook#append_page ~tab_label:label#coerce w)) ()

653 654
let scrolled_task_view =
  GBin.scrolled_window
655
    ~height:gconfig.task_height
656 657
    ~hpolicy: `AUTOMATIC ~vpolicy: `AUTOMATIC
    ~shadow_type:`ETCHED_OUT
658
    ~packing:scrolled_task_view#add ()
659

660 661 662 663 664 665 666
let (_ : GtkSignal.id) =
  scrolled_task_view#misc#connect#size_allocate
    ~callback:
    (fun {Gtk.width=_w;Gtk.height=h} ->
       gconfig.task_height <- h)


667 668 669
let task_view =
  GSourceView2.source_view
    ~editable:false
Clément Fumex's avatar
Clément Fumex committed
670
    ~cursor_visible:false
671 672 673 674
    ~show_line_numbers:true
    ~packing:scrolled_task_view#add
    ()

675

676
(* Creating a page for source code view *)
677
let create_source_view =
678
  (* Counter for pages *)
679
  let n = ref 1 in
680 681
  (* Create a page with tabname [f] and buffer equal to [content] in the
     notebook. Also add a corresponding page in source_view_table. *)
682 683 684
  let create_source_view f content =
    if not (Hstr.mem source_view_table f) then
      begin
685
        let label = GMisc.label ~text:f () in
686 687
        let source_page, scrolled_source_view =
          !n, GPack.vbox ~homogeneous:false ~packing:
688 689
            (fun w -> ignore(notebook#append_page ~tab_label:label#coerce w)) ()
        in
690 691 692 693 694 695 696
        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
697
            ~auto_indent:gconfig.allow_source_editing
698 699 700 701
            ~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 *)
702
            ~editable:gconfig.allow_source_editing
703 704
            ~packing:scrolled_source_view#add
            () in
705 706
        let has_changed = ref false in
        Hstr.add source_view_table f (source_page, source_view, has_changed, label);
707
        n := !n + 1;
708
        source_view#source_buffer#begin_not_undoable_action ();
709
        source_view#source_buffer#set_text content;
710
        source_view#source_buffer#end_not_undoable_action ();
711 712 713 714 715 716 717 718 719 720 721
        (* 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
722 723
        Gconfig.add_modifiable_mono_font_view source_view#misc;
        source_view#source_buffer#set_language why_lang;
724 725 726
        (* We have to create the tags for background colors for each view.
           They are not reusable from the other views.  *)
        create_colors source_view;
727 728 729
        Gconfig.set_fonts ()
      end in
  create_source_view
730 731 732



733 734
(* End of notebook *)

735 736 737 738 739
(*
  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
740
let vbox2222 = GPack.vbox ~packing:vpan222#add  ()
741

742 743 744 745
(* 2.2.2.2.1 Horizontal box [hbox22221]
     [monitor] number of scheduled/running provers
     [command_entry] Commands to run on the session
*)
746 747 748 749 750 751
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
752
    ~text:"  0/0/0"
753
    ~width:100
MARCHE Claude's avatar
MARCHE Claude committed
754
    ~xalign:0.0
755
    ~packing:(hbox22221#pack ?from:None ?expand:None ?fill:None ?padding:None) ()
756

757 758 759 760
let command_entry =
  GEdit.entry
    ~text:"type commands here"
    ~packing:hbox22221#add ()
MARCHE Claude's avatar
MARCHE Claude committed
761

762 763 764 765 766 767 768 769
(* 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
770
let log_view =
771
  let label = GMisc.label ~text:"Log" () in
Guillaume Melquiond's avatar
Guillaume Melquiond committed
772
  GPack.vbox ~homogeneous:false ~packing:
773 774 775
    (fun w -> ignore(messages_notebook#append_page ~tab_label:label#coerce w)) ()

(* tab 3: edited proof *)
Guillaume Melquiond's avatar
Guillaume Melquiond committed
776
let edited_tab =
777
  let label = GMisc.label ~text:"Edited proof" () in
Guillaume Melquiond's avatar
Guillaume Melquiond committed
778
  GPack.vbox ~homogeneous:false ~packing:
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
    (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 *)
Guillaume Melquiond's avatar
Guillaume Melquiond committed
794
let output_tab =
795
  let label = GMisc.label ~text:"Prover output" () in
Guillaume Melquiond's avatar
Guillaume Melquiond committed
796
  GPack.vbox ~homogeneous:false ~packing:
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
    (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:
816 817
    (fun w -> ignore(messages_notebook#append_page ~tab_label:label#coerce w)) ()

818 819 820 821 822 823 824 825 826 827 828 829
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
    ()

830 831
(* Allow colors locations on counterexample view *)
let () = create_colors counterexample_view
832

MARCHE Claude's avatar
MARCHE Claude committed
833
let message_zone =
834 835
  let sv = GBin.scrolled_window
      ~hpolicy:`AUTOMATIC ~vpolicy:`AUTOMATIC
836 837 838 839 840 841 842 843 844
      ~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 ()
845
  in
MARCHE Claude's avatar
MARCHE Claude committed
846
  GText.view ~editable:false ~cursor_visible:false
847 848
    ~packing:sv#add ()

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

853 854
(**** Message-zone printing functions *****)

MARCHE Claude's avatar
MARCHE Claude committed
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
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");
875 876
  log_zone#scroll_to_mark `INSERT

877 878
let clear_message_zone () =
  let buf = message_zone#buffer in
879
  buf#remove_tag_by_name "error_tag" ~start:buf#start_iter ~stop:buf#end_iter;
880 881
  buf#delete ~start:buf#start_iter ~stop:buf#end_iter

882
(* Function used to print stuff on the message_zone *)
MARCHE Claude's avatar
MARCHE Claude committed
883
let print_message ~kind ~notif_kind fmt =
884
  (* TODO: use kasprintf once OCaml 4.03 is used *)
885 886
  Format.kfprintf
    (fun _ -> let s = flush_str_formatter () in
MARCHE Claude's avatar
MARCHE Claude committed
887
              let s = try_convert s in
MARCHE Claude's avatar
MARCHE Claude committed
888
              add_to_log notif_kind s;
889
              let buf = message_zone#buffer in
MARCHE Claude's avatar
MARCHE Claude committed
890 891
              if kind>0 then
                begin
892 893 894
                  if Strings.ends_with notif_kind "error" ||
                     Strings.ends_with notif_kind "Error"
                  then
895
                    buf#insert ~tags:[message_zone_error_tag] (s ^ "\n")
896
                  else
897
                    buf#insert (s ^ "\n");
898
                  messages_notebook#goto_page error_page;
MARCHE Claude's avatar
MARCHE Claude committed
899
                end)
900 901 902
    str_formatter
    fmt

903 904 905 906 907 908 909
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
910
      end;
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926
      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
927

928 929 930 931
let print_message ~kind ~notif_kind fmt =
  display_warnings (); print_message ~kind ~notif_kind fmt


932

933

934
(**** Monitor *****)
Clément Fumex's avatar
Clément Fumex committed
935

936
let fan =
937
  let s = Bytes.of_string "\226\150\129" in
938
  let c = Char.code (Bytes.get s 2) in
939
  let a = Array.init 8 (fun i ->
940 941 942
    Bytes.set s 2 (Char.chr (c + i));
    Bytes.to_string s) in
  fun n ->
943 944 945
  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
946
  a.(n)
947 948 949 950 951 952

let update_monitor =
  let c = ref 0 in
  fun t s r ->
  reset_gc ();
  incr c;
953 954 955
  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
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 993 994 995 996 997 998 999 1000 1001 1002 1003
(**********************)
(* Cursor positioning *)
(**********************)

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

let move_to_line ~yalign (v : GSourceView2.source_view) line =
  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
1004

1005 1006 1007
(******************)
(* Reload actions *)
(******************)
1008

1009 1010
let reload_unsafe () =
  save_cursor_loc (); clear_message_zone (); send_request Reload_req
1011 1012 1013

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

1014 1015 1016 1017 1018 1019
(****************************)
(* command entry completion *)
(****************************)

let completion_cols = new GTree.column_list
let completion_col = completion_cols#add Gobject.Data.string
1020
let completion_desc = completion_cols#add Gobject.Data.string
1021 1022 1023
let completion_model = GTree.tree_store completion_cols

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

1026
let add_completion_entry (s,desc) =
1027
  let row = completion_model#append () in
1028
  completion_model#set ~row ~column:completion_col s;
1029
  completion_model#set ~row ~column:completion_desc desc
1030

1031 1032 1033
let match_function s iter =
  let candidate = completion_model#get ~row:iter ~column:completion_col in
  try
1034
    ignore (Str.search_forward (Str.regexp_string_case_fold s) candidate 0);
1035 1036 1037
    true
  with Not_found -> false

1038
(* see also init_completion below *)
1039

Sylvain Dailler's avatar
Sylvain Dailler committed
1040
(*********************)
1041
(* Terminal history  *)
Sylvain Dailler's avatar
Sylvain Dailler committed
1042 1043
(*********************)

1044
let list_commands = create_history()