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