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