Merge branch 'master' into windows+cc
[ardour.git] / libs / gtkmm2ext / gtk_ui.cc
1 /*
2     Copyright (C) 1999-2005 Paul Barton-Davis
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18     $Id$
19 */
20
21 #include <cmath>
22 #include <fcntl.h>
23 #include <signal.h>
24 #include <unistd.h>
25 #include <cerrno>
26 #include <climits>
27 #include <cctype>
28
29 #include <gtkmm.h>
30
31 #include "pbd/error.h"
32 #include "pbd/touchable.h"
33 #include "pbd/failed_constructor.h"
34 #include "pbd/pthread_utils.h"
35 #include "pbd/replace_all.h"
36
37 #include "gtkmm2ext/application.h"
38 #include "gtkmm2ext/gtk_ui.h"
39 #include "gtkmm2ext/textviewer.h"
40 #include "gtkmm2ext/popup.h"
41 #include "gtkmm2ext/utils.h"
42 #include "gtkmm2ext/window_title.h"
43 #include "gtkmm2ext/actions.h"
44 #include "gtkmm2ext/activatable.h"
45 #include "gtkmm2ext/actions.h"
46
47 #include "i18n.h"
48
49 using namespace Gtkmm2ext;
50 using namespace Gtk;
51 using namespace Glib;
52 using namespace PBD;
53 using std::map;
54
55 UI       *UI::theGtkUI = 0;
56
57 BaseUI::RequestType Gtkmm2ext::NullMessage = BaseUI::new_request_type();
58 BaseUI::RequestType Gtkmm2ext::ErrorMessage = BaseUI::new_request_type();
59 BaseUI::RequestType Gtkmm2ext::TouchDisplay = BaseUI::new_request_type();
60 BaseUI::RequestType Gtkmm2ext::StateChange = BaseUI::new_request_type();
61 BaseUI::RequestType Gtkmm2ext::SetTip = BaseUI::new_request_type();
62 BaseUI::RequestType Gtkmm2ext::AddIdle = BaseUI::new_request_type();
63 BaseUI::RequestType Gtkmm2ext::AddTimeout = BaseUI::new_request_type();
64
65 #include "pbd/abstract_ui.cc"  /* instantiate the template */
66
67 UI::UI (string namestr, int *argc, char ***argv)
68         : AbstractUI<UIRequest> (namestr)
69         , _receiver (*this)
70           
71 {
72         theMain = new Main (argc, argv);
73
74         _active = false;
75
76         if (!theGtkUI) {
77                 theGtkUI = this;
78         } else {
79                 fatal << "duplicate UI requested" << endmsg;
80                 /* NOTREACHED */
81         }
82
83         /* the GUI event loop runs in the main thread of the app,
84            which is assumed to have called this.
85         */
86
87         run_loop_thread = Threads::Thread::self();
88         
89         /* store "this" as the UI-for-thread of this thread, same argument
90            as for previous line.
91         */
92
93         set_event_loop_for_thread (this);
94
95         /* attach our request source to the default main context */
96
97         attach_request_source ();
98
99         errors = new TextViewer (800,600);
100         errors->text().set_editable (false);
101         errors->text().set_name ("ErrorText");
102         errors->signal_unmap().connect (sigc::bind (sigc::ptr_fun (&ActionManager::uncheck_toggleaction), X_("<Actions>/Editor/toggle-log-window")));
103
104         Glib::set_application_name(namestr);
105
106         WindowTitle title(Glib::get_application_name());
107         title += _("Log");
108         errors->set_title (title.get_string());
109
110         errors->dismiss_button().set_name ("ErrorLogCloseButton");
111         errors->signal_delete_event().connect (sigc::bind (sigc::ptr_fun (just_hide_it), (Window *) errors));
112         errors->set_type_hint (Gdk::WINDOW_TYPE_HINT_UTILITY);
113
114         //load_rcfile (rcfile);
115
116         /* instantiate the Application singleton */
117
118         Application::instance();
119 }
120
121 UI::~UI ()
122 {
123 }
124
125
126 bool
127 UI::caller_is_ui_thread ()
128 {
129         return Threads::Thread::self() == run_loop_thread;
130 }
131
132 int
133 UI::load_rcfile (string path, bool themechange)
134 {
135         /* Yes, pointers to Glib::RefPtr.  If these are not kept around,
136          * a segfault somewhere deep in the wonderfully robust glib will result.
137          * This does not occur if wiget.get_style is used instead of rc.get_style below,
138          * except that doesn't actually work... 
139          */
140         
141         static Glib::RefPtr<Style>* fatal_style   = 0;
142         static Glib::RefPtr<Style>* error_style   = 0;
143         static Glib::RefPtr<Style>* warning_style = 0;
144         static Glib::RefPtr<Style>* info_style    = 0;
145
146         if (path.length() == 0) {
147                 return -1;
148         }
149
150         if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
151                 error << "UI: couldn't find rc file \""
152                       << path
153                       << '"'
154                       << endmsg;
155                 return -1;
156         }
157
158         RC rc (path.c_str());
159         //this is buggy in gtkmm for some reason, so use C
160         //RC::reset_styles (Gtk::Settings::get_default());
161         gtk_rc_reset_styles (gtk_settings_get_default());
162
163         theme_changed.emit();
164
165         if (themechange) {
166                 return 0; //Don't continue on every time there is a theme change
167         }
168
169         /* have to pack widgets into a toplevel window so that styles will stick */
170
171         Window temp_window (WINDOW_TOPLEVEL);
172         temp_window.ensure_style ();
173
174         HBox box;
175         Label fatal_widget;
176         Label error_widget;
177         Label warning_widget;
178         Label info_widget;
179         RefPtr<Gtk::Style> style;
180         RefPtr<TextBuffer> buffer (errors->text().get_buffer());
181
182         box.pack_start (fatal_widget);
183         box.pack_start (error_widget);
184         box.pack_start (warning_widget);
185         box.pack_start (info_widget);
186
187         error_ptag = buffer->create_tag();
188         error_mtag = buffer->create_tag();
189         fatal_ptag = buffer->create_tag();
190         fatal_mtag = buffer->create_tag();
191         warning_ptag = buffer->create_tag();
192         warning_mtag = buffer->create_tag();
193         info_ptag = buffer->create_tag();
194         info_mtag = buffer->create_tag();
195
196         fatal_widget.set_name ("FatalMessage");
197         delete fatal_style;
198
199         /* This next line and the similar ones below are sketchily
200          * guessed to fix #2885.  I think maybe that problems occur
201          * because with gtk_rc_get_style (to quote its docs) "no
202          * refcount is added to the returned style".  So I've switched
203          * this to use Glib::wrap with take_copy == true, which requires
204          * all the nasty casts and calls to plain-old-C GTK.
205          *
206          * At worst I think this causes a memory leak; at least it appears
207          * to fix the bug.
208          *
209          * I could be wrong about any or all of the above.
210          */
211         fatal_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (fatal_widget.gobj())), true));
212
213         fatal_ptag->property_font_desc().set_value((*fatal_style)->get_font());
214         fatal_ptag->property_foreground_gdk().set_value((*fatal_style)->get_fg(STATE_ACTIVE));
215         fatal_ptag->property_background_gdk().set_value((*fatal_style)->get_bg(STATE_ACTIVE));
216         fatal_mtag->property_font_desc().set_value((*fatal_style)->get_font());
217         fatal_mtag->property_foreground_gdk().set_value((*fatal_style)->get_fg(STATE_NORMAL));
218         fatal_mtag->property_background_gdk().set_value((*fatal_style)->get_bg(STATE_NORMAL));
219
220         error_widget.set_name ("ErrorMessage");
221         delete error_style;
222         error_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (error_widget.gobj())), true));
223
224         error_ptag->property_font_desc().set_value((*error_style)->get_font());
225         error_ptag->property_foreground_gdk().set_value((*error_style)->get_fg(STATE_ACTIVE));
226         error_ptag->property_background_gdk().set_value((*error_style)->get_bg(STATE_ACTIVE));
227         error_mtag->property_font_desc().set_value((*error_style)->get_font());
228         error_mtag->property_foreground_gdk().set_value((*error_style)->get_fg(STATE_NORMAL));
229         error_mtag->property_background_gdk().set_value((*error_style)->get_bg(STATE_NORMAL));
230
231         warning_widget.set_name ("WarningMessage");
232         delete warning_style;
233         warning_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (warning_widget.gobj())), true));
234
235         warning_ptag->property_font_desc().set_value((*warning_style)->get_font());
236         warning_ptag->property_foreground_gdk().set_value((*warning_style)->get_fg(STATE_ACTIVE));
237         warning_ptag->property_background_gdk().set_value((*warning_style)->get_bg(STATE_ACTIVE));
238         warning_mtag->property_font_desc().set_value((*warning_style)->get_font());
239         warning_mtag->property_foreground_gdk().set_value((*warning_style)->get_fg(STATE_NORMAL));
240         warning_mtag->property_background_gdk().set_value((*warning_style)->get_bg(STATE_NORMAL));
241
242         info_widget.set_name ("InfoMessage");
243         delete info_style;
244         info_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (info_widget.gobj())), true));
245
246         info_ptag->property_font_desc().set_value((*info_style)->get_font());
247         info_ptag->property_foreground_gdk().set_value((*info_style)->get_fg(STATE_ACTIVE));
248         info_ptag->property_background_gdk().set_value((*info_style)->get_bg(STATE_ACTIVE));
249         info_mtag->property_font_desc().set_value((*info_style)->get_font());
250         info_mtag->property_foreground_gdk().set_value((*info_style)->get_fg(STATE_NORMAL));
251         info_mtag->property_background_gdk().set_value((*info_style)->get_bg(STATE_NORMAL));
252
253         return 0;
254 }
255
256 void
257 UI::run (Receiver &old_receiver)
258 {
259         _receiver.listen_to (error);
260         _receiver.listen_to (info);
261         _receiver.listen_to (warning);
262         _receiver.listen_to (fatal);
263
264         /* stop the old receiver (text/console) once we hit the first idle */
265
266         Glib::signal_idle().connect (bind_return (mem_fun (old_receiver, &Receiver::hangup), false));
267
268         starting ();
269         _active = true;
270         theMain->run ();
271         _active = false;
272         stopping ();
273         _receiver.hangup ();
274         return;
275 }
276
277 bool
278 UI::running ()
279 {
280         return _active;
281 }
282
283 void
284 UI::quit ()
285 {
286         UIRequest *req = get_request (Quit);
287
288         if (req == 0) {
289                 return;
290         }
291
292         send_request (req);
293 }
294
295 static bool idle_quit ()
296 {
297         Main::quit ();
298         return true;
299 }
300
301 void
302 UI::do_quit ()
303 {
304         if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
305                 Main::quit ();
306         } else {
307                 Glib::signal_idle().connect (sigc::ptr_fun (idle_quit));
308         }
309 }
310
311 void
312 UI::touch_display (Touchable *display)
313 {
314         UIRequest *req = get_request (TouchDisplay);
315
316         if (req == 0) {
317                 return;
318         }
319
320         req->display = display;
321
322         send_request (req);
323 }
324
325 void
326 UI::set_tip (Widget &w, const gchar *tip)
327 {
328         set_tip(&w, tip, "");
329 }
330
331 void
332 UI::set_tip (Widget &w, const std::string& tip)
333 {
334         set_tip(&w, tip.c_str(), "");
335 }
336
337 void
338 UI::set_tip (Widget *w, const gchar *tip, const gchar *hlp)
339 {
340         UIRequest *req = get_request (SetTip);
341
342         std::string msg(tip);
343
344         Glib::RefPtr<Gtk::Action> action = w->get_action();
345
346         if (!action) {
347                 Gtkmm2ext::Activatable* activatable;
348                 if ((activatable = dynamic_cast<Gtkmm2ext::Activatable*>(w))) {
349                         action = activatable->get_related_action();
350                 }
351         }
352
353         if (action) {
354                 Gtk::AccelKey key;
355                 ustring ap = action->get_accel_path();
356                 if (!ap.empty()) {
357                         string shortcut = ActionManager::get_key_representation (ap, key);
358                         if (!shortcut.empty()) {
359                                 replace_all (shortcut, "<", "");
360                                 replace_all (shortcut, ">", "-");
361                                 msg.append(_("\n\nShortcut: ")).append (shortcut);
362                         }
363                 }
364         }
365
366         if (req == 0) {
367                 return;
368         }
369
370
371         req->widget = w;
372         req->msg = msg.c_str();
373         req->msg2 = hlp;
374
375         send_request (req);
376 }
377
378 void
379 UI::set_state (Widget *w, StateType state)
380 {
381         UIRequest *req = get_request (StateChange);
382
383         if (req == 0) {
384                 return;
385         }
386
387         req->new_state = state;
388         req->widget = w;
389
390         send_request (req);
391 }
392
393 void
394 UI::idle_add (int (*func)(void *), void *arg)
395 {
396         UIRequest *req = get_request (AddIdle);
397
398         if (req == 0) {
399                 return;
400         }
401
402         req->function = func;
403         req->arg = arg;
404
405         send_request (req);
406 }
407
408 /* END abstract_ui interfaces */
409
410 /** Create a PBD::EventLoop::InvalidationRecord and attach a callback
411  *  to a given sigc::trackable so that PBD::EventLoop::invalidate_request
412  *  is called when that trackable is destroyed.
413  */
414 PBD::EventLoop::InvalidationRecord*
415 __invalidator (sigc::trackable& trackable, const char* file, int line)
416 {
417         PBD::EventLoop::InvalidationRecord* ir = new PBD::EventLoop::InvalidationRecord;
418
419         ir->file = file;
420         ir->line = line;
421
422         trackable.add_destroy_notify_callback (ir, PBD::EventLoop::invalidate_request);
423
424         return ir;
425 }
426
427 void
428 UI::do_request (UIRequest* req)
429 {
430         if (req->type == ErrorMessage) {
431
432                 process_error_message (req->chn, req->msg);
433                 free (const_cast<char*>(req->msg)); /* it was strdup'ed */
434                 req->msg = 0; /* don't free it again in the destructor */
435
436         } else if (req->type == Quit) {
437
438                 do_quit ();
439
440         } else if (req->type == CallSlot) {
441 #ifndef NDEBUG
442                 if (getenv ("DEBUG_THREADED_SIGNALS")) {
443                         cerr << "call slot for " << name() << endl;
444                 }
445 #endif
446                 req->the_slot ();
447
448         } else if (req->type == TouchDisplay) {
449
450                 req->display->touch ();
451                 if (req->display->delete_after_touch()) {
452                         delete req->display;
453                 }
454
455         } else if (req->type == StateChange) {
456
457                 req->widget->set_state (req->new_state);
458
459         } else if (req->type == SetTip) {
460
461                 gtk_widget_set_tooltip_markup (req->widget->gobj(), req->msg);
462
463         } else {
464
465                 error << "GtkUI: unknown request type "
466                       << (int) req->type
467                       << endmsg;
468         }
469 }
470
471 /*======================================================================
472   Error Display
473   ======================================================================*/
474
475 void
476 UI::receive (Transmitter::Channel chn, const char *str)
477 {
478         if (caller_is_ui_thread()) {
479                 process_error_message (chn, str);
480         } else {
481                 UIRequest* req = get_request (ErrorMessage);
482
483                 if (req == 0) {
484                         return;
485                 }
486
487                 req->chn = chn;
488                 req->msg = strdup (str);
489
490                 send_request (req);
491         }
492 }
493
494 #define OLD_STYLE_ERRORS 1
495
496 void
497 UI::process_error_message (Transmitter::Channel chn, const char *str)
498 {
499         RefPtr<Style> style;
500         RefPtr<TextBuffer::Tag> ptag;
501         RefPtr<TextBuffer::Tag> mtag;
502         const char *prefix;
503         size_t prefix_len;
504         bool fatal_received = false;
505 #ifndef OLD_STYLE_ERRORS
506         PopUp* popup = new PopUp (WIN_POS_CENTER, 0, true);
507 #endif
508
509         switch (chn) {
510         case Transmitter::Fatal:
511                 prefix = "[FATAL]: ";
512                 ptag = fatal_ptag;
513                 mtag = fatal_mtag;
514                 prefix_len = 9;
515                 fatal_received = true;
516                 break;
517         case Transmitter::Error:
518 #if OLD_STYLE_ERRORS
519                 prefix = "[ERROR]: ";
520                 ptag = error_ptag;
521                 mtag = error_mtag;
522                 prefix_len = 9;
523 #else
524                 popup->set_name ("ErrorMessage");
525                 popup->set_text (str);
526                 popup->touch ();
527                 return;
528 #endif
529                 break;
530         case Transmitter::Info:
531 #if OLD_STYLE_ERRORS
532                 prefix = "[INFO]: ";
533                 ptag = info_ptag;
534                 mtag = info_mtag;
535                 prefix_len = 8;
536 #else
537                 popup->set_name ("InfoMessage");
538                 popup->set_text (str);
539                 popup->touch ();
540                 return;
541 #endif
542
543                 break;
544         case Transmitter::Warning:
545 #if OLD_STYLE_ERRORS
546                 prefix = "[WARNING]: ";
547                 ptag = warning_ptag;
548                 mtag = warning_mtag;
549                 prefix_len = 11;
550 #else
551                 popup->set_name ("WarningMessage");
552                 popup->set_text (str);
553                 popup->touch ();
554                 return;
555 #endif
556                 break;
557         default:
558                 /* no choice but to use text/console output here */
559                 cerr << "programmer error in UI::check_error_messages (channel = " << chn << ")\n";
560                 ::exit (1);
561         }
562
563         errors->text().get_buffer()->begin_user_action();
564
565         if (fatal_received) {
566                 handle_fatal (str);
567         } else {
568
569                 if (!ptag || !mtag) {
570                         /* oops, message sent before we set up tags - don't crash */
571                         cerr << prefix << str << endl;
572                 } else {
573                         display_message (prefix, prefix_len, ptag, mtag, str);
574                         
575                         if (!errors->is_visible() && chn != Transmitter::Info) {
576                                 show_errors ();
577                         }
578                 }
579         }
580
581         errors->text().get_buffer()->end_user_action();
582 }
583
584 void
585 UI::show_errors ()
586 {
587         Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("toggle-log-window"));
588         if (!act) {
589                 return;
590         }
591
592         Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
593         if (tact) {
594                 tact->set_active ();
595         }
596 }
597
598 void
599 UI::toggle_errors ()
600 {
601         Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("toggle-log-window"));
602         if (!act) {
603                 return;
604         }
605
606         Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
607         
608         if (tact->get_active()) {
609                 errors->set_position (WIN_POS_MOUSE);
610                 errors->show ();
611         } else {
612                 errors->hide ();
613         }
614 }
615
616 void
617 UI::display_message (const char *prefix, gint /*prefix_len*/, RefPtr<TextBuffer::Tag> ptag, RefPtr<TextBuffer::Tag> mtag, const char *msg)
618 {
619         RefPtr<TextBuffer> buffer (errors->text().get_buffer());
620
621         buffer->insert_with_tag(buffer->end(), prefix, ptag);
622         buffer->insert_with_tag(buffer->end(), msg, mtag);
623         buffer->insert_with_tag(buffer->end(), "\n", mtag);
624
625         errors->scroll_to_bottom ();
626 }
627
628 void
629 UI::handle_fatal (const char *message)
630 {
631         Dialog win;
632         Label label (message);
633         Button quit (_("Press To Exit"));
634         HBox hpacker;
635
636         win.set_default_size (400, 100);
637
638         WindowTitle title(Glib::get_application_name());
639         title += ": Fatal Error";
640         win.set_title (title.get_string());
641
642         win.set_position (WIN_POS_MOUSE);
643         win.set_border_width (12);
644
645         win.get_vbox()->pack_start (label, true, true);
646         hpacker.pack_start (quit, true, false);
647         win.get_vbox()->pack_start (hpacker, false, false);
648
649         quit.signal_clicked().connect(mem_fun(*this,&UI::quit));
650
651         win.show_all ();
652         win.set_modal (true);
653
654         theMain->run ();
655
656         _exit (1);
657 }
658
659 void
660 UI::popup_error (const string& text)
661 {
662         if (!caller_is_ui_thread()) {
663                 error << "non-UI threads can't use UI::popup_error"
664                       << endmsg;
665                 return;
666         }
667
668         MessageDialog msg (text);
669         msg.set_title (string_compose (_("I'm sorry %1, I can't do that"), g_get_user_name()));
670         msg.set_wmclass (X_("error"), name());
671         msg.set_position (WIN_POS_MOUSE);
672         msg.run ();
673 }
674
675 void
676 UI::flush_pending ()
677 {
678         if (!caller_is_ui_thread()) {
679                 error << "non-UI threads cannot call UI::flush_pending()"
680                       << endmsg;
681                 return;
682         }
683
684         gtk_main_iteration();
685
686         while (gtk_events_pending()) {
687                 gtk_main_iteration();
688         }
689 }
690
691 bool
692 UI::just_hide_it (GdkEventAny* /*ev*/, Window *win)
693 {
694         win->hide ();
695         return true;
696 }
697
698 Gdk::Color
699 UI::get_color (const string& prompt, bool& picked, const Gdk::Color* initial)
700 {
701         Gdk::Color color;
702
703         ColorSelectionDialog color_dialog (prompt);
704
705         color_dialog.set_modal (true);
706         color_dialog.get_cancel_button()->signal_clicked().connect (bind (mem_fun (*this, &UI::color_selection_done), false));
707         color_dialog.get_ok_button()->signal_clicked().connect (bind (mem_fun (*this, &UI::color_selection_done), true));
708         color_dialog.signal_delete_event().connect (mem_fun (*this, &UI::color_selection_deleted));
709
710         if (initial) {
711                 color_dialog.get_colorsel()->set_current_color (*initial);
712         }
713
714         color_dialog.show_all ();
715         color_picked = false;
716         picked = false;
717
718         Main::run();
719
720         color_dialog.hide_all ();
721
722         if (color_picked) {
723                 Gdk::Color f_rgba = color_dialog.get_colorsel()->get_current_color ();
724                 color.set_red(f_rgba.get_red());
725                 color.set_green(f_rgba.get_green());
726                 color.set_blue(f_rgba.get_blue());
727
728                 picked = true;
729         }
730
731         return color;
732 }
733
734 void
735 UI::color_selection_done (bool status)
736 {
737         color_picked = status;
738         Main::quit ();
739 }
740
741 bool
742 UI::color_selection_deleted (GdkEventAny* /*ev*/)
743 {
744         Main::quit ();
745         return true;
746 }