helm/matita/matitaGtkMisc.ml

   1 (* Copyright (C) 2004-2005, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://helm.cs.unibo.it/
  24  *)
  25
  26 exception PopupClosed
  27 open Printf
  28
  29 open MatitaTypes
  30
  31 let wrap_callback f = f
  32
  33 let connect_button (button: #GButton.button) callback =
  34   ignore (button#connect#clicked (wrap_callback callback))
  35
  36 let connect_toggle_button (button: #GButton.toggle_button) callback =
  37   ignore (button#connect#toggled (wrap_callback callback))
  38
  39 let connect_menu_item (menu_item: #GMenu.menu_item) callback =
  40   ignore (menu_item#connect#activate (wrap_callback callback))
  41
  42 let connect_key (ev:GObj.event_ops) ?(modifiers = []) ?(stop = false) key
  43   callback
  44 =
  45   ignore (ev#connect#key_press (fun key' ->
  46     let modifiers' = GdkEvent.Key.state key' in
  47     (match key' with
  48     | key' when GdkEvent.Key.keyval key' = key
  49           && List.for_all (fun m -> List.mem m modifiers') modifiers ->
  50         callback ();
  51         stop
  52     | _ -> false)))
  53
  54 let toggle_widget_visibility ~(widget: GObj.widget)
  55                               ~(check: GMenu.check_menu_item)
  56 =
  57   ignore (check#connect#toggled (fun _ ->
  58     if check#active then widget#misc#show () else widget#misc#hide ()))
  59
  60 let toggle_window_visibility ~(window: GWindow.window)
  61                               ~(check: GMenu.check_menu_item)
  62 =
  63   ignore (check#connect#toggled (fun _ ->
  64     if check#active then window#show () else window#misc#hide ()));
  65   ignore (window#event#connect#delete (fun _ ->
  66     window#misc#hide ();
  67     check#set_active false;
  68     true))
  69
  70 let toggle_win ?(check: GMenu.check_menu_item option) (win: GWindow.window) () =
  71   if win#is_active then win#misc#hide () else win#show ();
  72   match check with
  73   | None -> ()
  74   | Some check -> check#set_active (not check#active)
  75
  76 let toggle_callback ~callback ~(check: GMenu.check_menu_item) =
  77   ignore (check#connect#toggled (fun _ -> callback check#active))
  78
  79 let add_key_binding key callback (evbox: GBin.event_box) =
  80   ignore (evbox#event#connect#key_press (function
  81     | key' when GdkEvent.Key.keyval key' = key ->
  82         callback ();
  83         false
  84     | _ -> false))
  85
  86 class multiStringListModel ~cols (tree_view: GTree.view) =
  87   let column_list = new GTree.column_list in
  88   let text_columns =
  89     let rec aux = function
  90       | 0 -> []
  91       | n -> column_list#add Gobject.Data.string :: aux (n - 1)
  92     in
  93     aux cols
  94   in
  95   let list_store = GTree.list_store column_list in
  96   let renderers =
  97     List.map
  98     (fun text_column ->
  99       (GTree.cell_renderer_text [], ["text", text_column]))
 100     text_columns
 101   in
 102   let view_columns =
 103     List.map
 104       (fun renderer -> GTree.view_column ~renderer ())
 105       renderers
 106   in
 107   object (self)
 108     val text_columns = text_columns
 109
 110     initializer
 111       tree_view#set_model (Some (list_store :> GTree.model));
 112       List.iter
 113         (fun view_column -> ignore (tree_view#append_column view_column))
 114         view_columns
 115
 116     method list_store = list_store
 117
 118     method easy_mappend slist =
 119       let tree_iter = list_store#append () in
 120       List.iter2
 121         (fun s text_column ->
 122         list_store#set ~row:tree_iter ~column:text_column s)
 123         slist text_columns
 124
 125     method easy_minsert pos s =
 126       let tree_iter = list_store#insert pos in
 127       List.iter2
 128         (fun s text_column ->
 129         list_store#set ~row:tree_iter ~column:text_column s)
 130         s text_columns
 131
 132     method easy_mselection () =
 133       List.map
 134         (fun tree_path ->
 135           let iter = list_store#get_iter tree_path in
 136           List.map
 137             (fun text_column ->
 138             list_store#get ~row:iter ~column:text_column)
 139           text_columns)
 140         tree_view#selection#get_selected_rows
 141   end
 142
 143 class stringListModel (tree_view: GTree.view) =
 144   object (self)
 145     inherit multiStringListModel ~cols:1 tree_view as multi
 146
 147     method list_store = multi#list_store
 148
 149     method easy_append s =
 150       multi#easy_mappend [s]
 151
 152     method easy_insert pos s =
 153       multi#easy_minsert pos [s]
 154
 155     method easy_selection () =
 156       let m = List.map
 157         (fun tree_path ->
 158           let iter = self#list_store#get_iter tree_path in
 159           List.map
 160             (fun text_column ->
 161             self#list_store#get ~row:iter ~column:text_column)
 162           text_columns)
 163         tree_view#selection#get_selected_rows
 164       in
 165       List.map (function [x] -> x | _ -> assert false) m
 166   end
 167
 168 class taggedStringListModel ~(tags:(string * GdkPixbuf.pixbuf) list)
 169   (tree_view: GTree.view)
 170 =
 171   let column_list = new GTree.column_list in
 172   let tag_column = column_list#add Gobject.Data.gobject in
 173   let text_column = column_list#add Gobject.Data.string in
 174   let list_store = GTree.list_store column_list in
 175   let text_renderer = (GTree.cell_renderer_text [], ["text", text_column]) in
 176   let tag_renderer = (GTree.cell_renderer_pixbuf [], ["pixbuf", tag_column]) in
 177   let text_vcolumn = GTree.view_column ~renderer:text_renderer () in
 178   let tag_vcolumn = GTree.view_column ~renderer:tag_renderer () in
 179   let lookup_pixbuf tag =
 180     try List.assoc tag tags with Not_found -> assert false
 181   in
 182   object (self)
 183     initializer
 184       tree_view#set_model (Some (list_store :> GTree.model));
 185       ignore (tree_view#append_column tag_vcolumn);
 186       ignore (tree_view#append_column text_vcolumn)
 187
 188     method list_store = list_store
 189
 190     method easy_append ~tag s =
 191       let tree_iter = list_store#append () in
 192       list_store#set ~row:tree_iter ~column:text_column s;
 193       list_store#set ~row:tree_iter ~column:tag_column (lookup_pixbuf tag)
 194
 195     method easy_insert pos ~tag s =
 196       let tree_iter = list_store#insert pos in
 197       list_store#set ~row:tree_iter ~column:text_column s;
 198       list_store#set ~row:tree_iter ~column:tag_column (lookup_pixbuf tag)
 199
 200     method easy_selection () =
 201       List.map
 202         (fun tree_path ->
 203           let iter = list_store#get_iter tree_path in
 204           list_store#get ~row:iter ~column:text_column)
 205         tree_view#selection#get_selected_rows
 206   end
 207
 208 class recordModel (tree_view:GTree.view) =
 209   let cols_list = new GTree.column_list in
 210   let text_col = cols_list#add Gobject.Data.string in
 211 (*   let combo_col = cols_list#add (Gobject.Data.gobject_by_name "GtkListStore") in *)
 212   let combo_col = cols_list#add Gobject.Data.int in
 213   let toggle_col = cols_list#add Gobject.Data.boolean in
 214   let list_store = GTree.list_store cols_list in
 215   let text_rend = (GTree.cell_renderer_text [], ["text", text_col]) in
 216   let combo_rend = GTree.cell_renderer_combo [] in
 217 (*   let combo_rend = (GTree.cell_renderer_combo [], [|+"model", combo_col+|]) in *)
 218   let toggle_rend =
 219     (GTree.cell_renderer_toggle [`ACTIVATABLE true], ["active", toggle_col])
 220   in
 221   let text_vcol = GTree.view_column ~renderer:text_rend () in
 222   let combo_vcol = GTree.view_column ~renderer:(combo_rend, []) () in
 223   let _ =
 224     combo_vcol#set_cell_data_func combo_rend
 225       (fun _ _ ->
 226         prerr_endline "qui";
 227         let model, col =
 228           GTree.store_of_list Gobject.Data.string ["a"; "b"; "c"]
 229         in
 230         combo_rend#set_properties [
 231           `MODEL (Some (model :> GTree.model));
 232           `TEXT_COLUMN col
 233         ])
 234   in
 235   let toggle_vcol = GTree.view_column ~renderer:toggle_rend () in
 236   object (self)
 237     initializer
 238       tree_view#set_model (Some (list_store :> GTree.model));
 239       ignore (tree_view#append_column text_vcol);
 240       ignore (tree_view#append_column combo_vcol);
 241       ignore (tree_view#append_column toggle_vcol)
 242
 243     method list_store = list_store
 244
 245     method easy_append s (combo:int) (toggle:bool) =
 246       let tree_iter = list_store#append () in
 247       list_store#set ~row:tree_iter ~column:text_col s;
 248       list_store#set ~row:tree_iter ~column:combo_col combo;
 249       list_store#set ~row:tree_iter ~column:toggle_col toggle
 250   end
 251
 252 class type gui =
 253   object
 254     method newUriDialog:          unit -> MatitaGeneratedGui.uriChoiceDialog
 255     method newRecordDialog:       unit -> MatitaGeneratedGui.recordChoiceDialog
 256     method newConfirmationDialog: unit -> MatitaGeneratedGui.confirmationDialog
 257     method newEmptyDialog:        unit -> MatitaGeneratedGui.emptyDialog
 258   end
 259
 260 let popup_message
 261   ~title ~message ~buttons ~callback
 262   ?(message_type=`QUESTION) ?parent ?(use_markup=true)
 263   ?(destroy_with_parent=true) ?(allow_grow=false) ?(allow_shrink=false)
 264   ?icon ?(modal=true) ?(resizable=false) ?screen ?type_hint
 265   ?(position=`CENTER_ON_PARENT) ?wm_name ?wm_class ?border_width ?width
 266   ?height ?(show=true) ()
 267 =
 268   let m =
 269     GWindow.message_dialog
 270       ~message ~use_markup ~message_type ~buttons ?parent ~destroy_with_parent
 271       ~title ~allow_grow ~allow_shrink ?icon ~modal ~resizable ?screen
 272       ?type_hint ~position ?wm_name ?wm_class ?border_width ?width ?height
 273       ~show ()
 274   in
 275   ignore(m#connect#response
 276     ~callback:(fun a ->  GMain.Main.quit ();callback a));
 277   ignore(m#connect#close
 278     ~callback:(fun _ -> GMain.Main.quit ();raise PopupClosed));
 279   GtkThread.main ();
 280   m#destroy ()
 281
 282 let popup_message_lowlevel
 283   ~title ~message ?(no_separator=true) ~callback ~message_type ~buttons
 284   ?parent  ?(destroy_with_parent=true) ?(allow_grow=false) ?(allow_shrink=false)
 285   ?icon ?(modal=true) ?(resizable=false) ?screen ?type_hint
 286   ?(position=`CENTER_ON_PARENT) ?wm_name ?wm_class ?border_width ?width
 287   ?height ?(show=true) ()
 288 =
 289   let m =
 290     GWindow.dialog
 291       ~no_separator
 292       ?parent ~destroy_with_parent
 293       ~title ~allow_grow ~allow_shrink ?icon ~modal ~resizable ?screen
 294       ?type_hint ~position ?wm_name ?wm_class ?border_width ?width ?height
 295       ~show:false ()
 296   in
 297   let stock =
 298     match message_type with
 299     | `WARNING -> `DIALOG_WARNING
 300     | `INFO -> `DIALOG_INFO
 301     | `ERROR ->`DIALOG_ERROR
 302     | `QUESTION -> `DIALOG_QUESTION
 303   in
 304   let image = GMisc.image ~stock ~icon_size:`DIALOG () in
 305   let label = GMisc.label ~markup:message () in
 306   label#set_line_wrap true;
 307   let hbox = GPack.hbox ~spacing:10 () in
 308   hbox#pack ~from:`START ~expand:true ~fill:true (image:>GObj.widget);
 309   hbox#pack ~from:`START ~expand:true ~fill:true (label:>GObj.widget);
 310   m#vbox#pack ~from:`START
 311     ~padding:20 ~expand:true ~fill:true (hbox:>GObj.widget);
 312   List.iter (fun (x, y) ->
 313     m#add_button_stock x y;
 314     if y = `CANCEL then
 315       m#set_default_response y
 316   ) buttons;
 317   ignore(m#connect#response
 318     ~callback:(fun a ->  GMain.Main.quit ();callback a));
 319   ignore(m#connect#close
 320     ~callback:(fun _ -> GMain.Main.quit ();callback `POPUPCLOSED));
 321   if show = true then
 322       m#show ();
 323   GtkThread.main ();
 324   m#destroy ()
 325
 326
 327 let ask_confirmation ~title ~message ?parent () =
 328   let rc = ref `YES in
 329   let callback =
 330     function
 331     | `YES -> rc := `YES
 332     | `NO -> rc := `NO
 333     | `CANCEL -> rc := `CANCEL
 334     | `DELETE_EVENT -> rc := `CANCEL
 335     | `POPUPCLOSED -> rc := `CANCEL
 336   in
 337   let buttons = [`YES,`YES ; `NO,`NO ; `CANCEL,`CANCEL] in
 338     popup_message_lowlevel
 339       ~title ~message ~message_type:`WARNING ~callback ~buttons ?parent ();
 340     !rc
 341
 342 let report_error ~title ~message ?parent () =
 343   let rc = ref false in
 344   let callback _ = () in
 345   let buttons = GWindow.Buttons.ok in
 346   try
 347     popup_message
 348       ~title ~message ~message_type:`ERROR ~callback ~buttons ?parent ()
 349   with
 350   | PopupClosed -> ()
 351
 352
 353 let ask_text ~(gui:#gui) ?(title = "") ?(message = "") ?(multiline = false)
 354   ?default ()
 355 =
 356   let dialog = gui#newEmptyDialog () in
 357   dialog#emptyDialog#set_title title;
 358   dialog#emptyDialogLabel#set_label message;
 359   let result = ref None in
 360   let return r =
 361     result := r;
 362     dialog#emptyDialog#destroy ();
 363     GMain.Main.quit ()
 364   in
 365   ignore (dialog#emptyDialog#event#connect#delete (fun _ -> true));
 366   if multiline then begin (* multiline input required: use a TextView widget *)
 367     let win =
 368       GBin.scrolled_window ~width:400 ~height:150 ~hpolicy:`NEVER
 369         ~vpolicy:`ALWAYS ~packing:dialog#emptyDialogVBox#add ()
 370     in
 371     let view = GText.view ~wrap_mode:`CHAR ~packing:win#add () in
 372     let buffer = view#buffer in
 373     (match default with
 374     | None -> ()
 375     | Some text ->
 376         buffer#set_text text;
 377         buffer#select_range buffer#start_iter buffer#end_iter);
 378     view#misc#grab_focus ();
 379     connect_button dialog#emptyDialogOkButton (fun _ ->
 380       return (Some (buffer#get_text ())))
 381   end else begin (* monoline input required: use a TextEntry widget *)
 382     let entry = GEdit.entry ~packing:dialog#emptyDialogVBox#add () in
 383     (match default with
 384     | None -> ()
 385     | Some text ->
 386         entry#set_text text;
 387         entry#select_region ~start:0 ~stop:max_int);
 388     entry#misc#grab_focus ();
 389     connect_button dialog#emptyDialogOkButton (fun _ ->
 390       return (Some entry#text))
 391   end;
 392   connect_button dialog#emptyDialogCancelButton (fun _ ->return None);
 393   dialog#emptyDialog#show ();
 394   GtkThread.main ();
 395   (match !result with None -> raise Cancel | Some r -> r)
 396
 397 type combo_status = Free of string | Locked of string
 398
 399 let ask_record_choice ~(gui:#gui) ?(title= "") ?(message = "")
 400   ~fields ~records ()
 401 =
 402   let fields = Array.of_list fields in
 403   let fields_no = Array.length fields in
 404   assert (fields_no > 0);
 405   let dialog = gui#newRecordDialog () in
 406   dialog#recordChoiceDialog#set_title title;
 407   dialog#recordChoiceDialogLabel#set_label message;
 408   let model = new recordModel dialog#recordChoiceTreeView in
 409   dialog#recordChoiceTreeView#set_headers_visible true;
 410   let combos =
 411     Array.init fields_no
 412       (fun _ -> GTree.store_of_list Gobject.Data.string ["a"; "b"; "c"])
 413   in
 414   let (store, col) = combos.(0) in
 415   store#set ~row:(store#append ()) ~column:col "uno";
 416   store#set ~row:(store#append ()) ~column:col "due";
 417   let toggles = Array.init fields_no (fun _ -> false) in
 418   Array.iteri
 419     (fun i f -> model#easy_append f i toggles.(i))
 420     fields;
 421   let status = Array.map (fun s -> Free s) fields in
 422   let record_no = ref None in
 423   let return _ =
 424     dialog#recordChoiceDialog#destroy ();
 425     GMain.Main.quit ()
 426   in
 427   let fail _ = record_no := None; return () in
 428   ignore (dialog#recordChoiceDialog#event#connect#delete (fun _ -> true));
 429   connect_button dialog#recordChoiceOkButton (fun _ ->
 430     match !record_no with None -> () | Some _ -> return ());
 431   connect_button dialog#recordChoiceCancelButton fail;
 432 (*   ignore (dialog#recordChoiceTreeView#connect#row_activated (fun path _ ->
 433     interp_no := Some (model#get_interp_no path);
 434     return ()));
 435   let selection = dialog#recordChoiceTreeView#selection in
 436   ignore (selection#connect#changed (fun _ ->
 437     match selection#get_selected_rows with
 438     | [path] -> interp_no := Some (model#get_interp_no path)
 439     | _ -> assert false)); *)
 440   dialog#recordChoiceDialog#show ();
 441   GtkThread.main ();
 442   (match !record_no with Some n -> n | _ -> raise MatitaTypes.Cancel)
 443