fix merge conflicts with master
[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         _receiver.hangup ();
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         if (starting ()) {
269                 return;
270         }
271
272         _active = true;
273         theMain->run ();
274         _active = false;
275
276         return;
277 }
278
279 bool
280 UI::running ()
281 {
282         return _active;
283 }
284
285 void
286 UI::quit ()
287 {
288         UIRequest *req = get_request (Quit);
289
290         if (req == 0) {
291                 return;
292         }
293
294         send_request (req);
295 }
296
297 static bool idle_quit ()
298 {
299         Main::quit ();
300         return true;
301 }
302
303 void
304 UI::do_quit ()
305 {
306         if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
307                 Main::quit ();
308         } else {
309                 Glib::signal_idle().connect (sigc::ptr_fun (idle_quit));
310         }
311 }
312
313 void
314 UI::touch_display (Touchable *display)
315 {
316         UIRequest *req = get_request (TouchDisplay);
317
318         if (req == 0) {
319                 return;
320         }
321
322         req->display = display;
323
324         send_request (req);
325 }
326
327 void
328 UI::set_tip (Widget &w, const gchar *tip)
329 {
330         set_tip(&w, tip, "");
331 }
332
333 void
334 UI::set_tip (Widget &w, const std::string& tip)
335 {
336         set_tip(&w, tip.c_str(), "");
337 }
338
339 void
340 UI::set_tip (Widget *w, const gchar *tip, const gchar *hlp)
341 {
342         UIRequest *req = get_request (SetTip);
343
344         std::string msg(tip);
345
346         Glib::RefPtr<Gtk::Action> action = w->get_action();
347
348         if (!action) {
349                 Gtkmm2ext::Activatable* activatable;
350                 if ((activatable = dynamic_cast<Gtkmm2ext::Activatable*>(w))) {
351                         action = activatable->get_related_action();
352                 }
353         }
354
355         if (action) {
356                 Gtk::AccelKey key;
357                 ustring ap = action->get_accel_path();
358                 if (!ap.empty()) {
359                         string shortcut = ActionManager::get_key_representation (ap, key);
360                         if (!shortcut.empty()) {
361                                 replace_all (shortcut, "<", "");
362                                 replace_all (shortcut, ">", "-");
363                                 msg.append(_("\n\nShortcut: ")).append (shortcut);
364                         }
365                 }
366         }
367
368         if (req == 0) {
369                 return;
370         }
371
372
373         req->widget = w;
374         req->msg = msg.c_str();
375         req->msg2 = hlp;
376
377         send_request (req);
378 }
379
380 void
381 UI::set_state (Widget *w, StateType state)
382 {
383         UIRequest *req = get_request (StateChange);
384
385         if (req == 0) {
386                 return;
387         }
388
389         req->new_state = state;
390         req->widget = w;
391
392         send_request (req);
393 }
394
395 void
396 UI::idle_add (int (*func)(void *), void *arg)
397 {
398         UIRequest *req = get_request (AddIdle);
399
400         if (req == 0) {
401                 return;
402         }
403
404         req->function = func;
405         req->arg = arg;
406
407         send_request (req);
408 }
409
410 /* END abstract_ui interfaces */
411
412 /** Create a PBD::EventLoop::InvalidationRecord and attach a callback
413  *  to a given sigc::trackable so that PBD::EventLoop::invalidate_request
414  *  is called when that trackable is destroyed.
415  */
416 PBD::EventLoop::InvalidationRecord*
417 __invalidator (sigc::trackable& trackable, const char* file, int line)
418 {
419         PBD::EventLoop::InvalidationRecord* ir = new PBD::EventLoop::InvalidationRecord;
420
421         ir->file = file;
422         ir->line = line;
423
424         trackable.add_destroy_notify_callback (ir, PBD::EventLoop::invalidate_request);
425
426         return ir;
427 }
428
429 void
430 UI::do_request (UIRequest* req)
431 {
432         if (req->type == ErrorMessage) {
433
434                 process_error_message (req->chn, req->msg);
435                 free (const_cast<char*>(req->msg)); /* it was strdup'ed */
436                 req->msg = 0; /* don't free it again in the destructor */
437
438         } else if (req->type == Quit) {
439
440                 do_quit ();
441
442         } else if (req->type == CallSlot) {
443 #ifndef NDEBUG
444                 if (getenv ("DEBUG_THREADED_SIGNALS")) {
445                         cerr << "call slot for " << name() << endl;
446                 }
447 #endif
448                 req->the_slot ();
449
450         } else if (req->type == TouchDisplay) {
451
452                 req->display->touch ();
453                 if (req->display->delete_after_touch()) {
454                         delete req->display;
455                 }
456
457         } else if (req->type == StateChange) {
458
459                 req->widget->set_state (req->new_state);
460
461         } else if (req->type == SetTip) {
462
463                 gtk_widget_set_tooltip_markup (req->widget->gobj(), req->msg);
464
465         } else {
466
467                 error << "GtkUI: unknown request type "
468                       << (int) req->type
469                       << endmsg;
470         }
471 }
472
473 /*======================================================================
474   Error Display
475   ======================================================================*/
476
477 void
478 UI::receive (Transmitter::Channel chn, const char *str)
479 {
480         if (caller_is_ui_thread()) {
481                 process_error_message (chn, str);
482         } else {
483                 UIRequest* req = get_request (ErrorMessage);
484
485                 if (req == 0) {
486                         return;
487                 }
488
489                 req->chn = chn;
490                 req->msg = strdup (str);
491
492                 send_request (req);
493         }
494 }
495
496 #define OLD_STYLE_ERRORS 1
497
498 void
499 UI::process_error_message (Transmitter::Channel chn, const char *str)
500 {
501         RefPtr<Style> style;
502         RefPtr<TextBuffer::Tag> ptag;
503         RefPtr<TextBuffer::Tag> mtag;
504         const char *prefix;
505         size_t prefix_len;
506         bool fatal_received = false;
507 #ifndef OLD_STYLE_ERRORS
508         PopUp* popup = new PopUp (WIN_POS_CENTER, 0, true);
509 #endif
510
511         switch (chn) {
512         case Transmitter::Fatal:
513                 prefix = "[FATAL]: ";
514                 ptag = fatal_ptag;
515                 mtag = fatal_mtag;
516                 prefix_len = 9;
517                 fatal_received = true;
518                 break;
519         case Transmitter::Error:
520 #if OLD_STYLE_ERRORS
521                 prefix = "[ERROR]: ";
522                 ptag = error_ptag;
523                 mtag = error_mtag;
524                 prefix_len = 9;
525 #else
526                 popup->set_name ("ErrorMessage");
527                 popup->set_text (str);
528                 popup->touch ();
529                 return;
530 #endif
531                 break;
532         case Transmitter::Info:
533 #if OLD_STYLE_ERRORS
534                 prefix = "[INFO]: ";
535                 ptag = info_ptag;
536                 mtag = info_mtag;
537                 prefix_len = 8;
538 #else
539                 popup->set_name ("InfoMessage");
540                 popup->set_text (str);
541                 popup->touch ();
542                 return;
543 #endif
544
545                 break;
546         case Transmitter::Warning:
547 #if OLD_STYLE_ERRORS
548                 prefix = "[WARNING]: ";
549                 ptag = warning_ptag;
550                 mtag = warning_mtag;
551                 prefix_len = 11;
552 #else
553                 popup->set_name ("WarningMessage");
554                 popup->set_text (str);
555                 popup->touch ();
556                 return;
557 #endif
558                 break;
559         default:
560                 /* no choice but to use text/console output here */
561                 cerr << "programmer error in UI::check_error_messages (channel = " << chn << ")\n";
562                 ::exit (1);
563         }
564
565         errors->text().get_buffer()->begin_user_action();
566
567         if (fatal_received) {
568                 handle_fatal (str);
569         } else {
570
571                 if (!ptag || !mtag) {
572                         /* oops, message sent before we set up tags - don't crash */
573                         cerr << prefix << str << endl;
574                 } else {
575                         display_message (prefix, prefix_len, ptag, mtag, str);
576                         
577                         if (!errors->is_visible() && chn != Transmitter::Info) {
578                                 show_errors ();
579                         }
580                 }
581         }
582
583         errors->text().get_buffer()->end_user_action();
584 }
585
586 void
587 UI::show_errors ()
588 {
589         Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("toggle-log-window"));
590         if (!act) {
591                 return;
592         }
593
594         Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
595         if (tact) {
596                 tact->set_active ();
597         }
598 }
599
600 void
601 UI::toggle_errors ()
602 {
603         Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("toggle-log-window"));
604         if (!act) {
605                 return;
606         }
607
608         Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
609         
610         if (tact->get_active()) {
611                 errors->set_position (WIN_POS_MOUSE);
612                 errors->show ();
613         } else {
614                 errors->hide ();
615         }
616 }
617
618 void
619 UI::display_message (const char *prefix, gint /*prefix_len*/, RefPtr<TextBuffer::Tag> ptag, RefPtr<TextBuffer::Tag> mtag, const char *msg)
620 {
621         RefPtr<TextBuffer> buffer (errors->text().get_buffer());
622
623         buffer->insert_with_tag(buffer->end(), prefix, ptag);
624         buffer->insert_with_tag(buffer->end(), msg, mtag);
625         buffer->insert_with_tag(buffer->end(), "\n", mtag);
626
627         errors->scroll_to_bottom ();
628 }
629
630 void
631 UI::handle_fatal (const char *message)
632 {
633         Dialog win;
634         Label label (message);
635         Button quit (_("Press To Exit"));
636         HBox hpacker;
637
638         win.set_default_size (400, 100);
639
640         WindowTitle title(Glib::get_application_name());
641         title += ": Fatal Error";
642         win.set_title (title.get_string());
643
644         win.set_position (WIN_POS_MOUSE);
645         win.set_border_width (12);
646
647         win.get_vbox()->pack_start (label, true, true);
648         hpacker.pack_start (quit, true, false);
649         win.get_vbox()->pack_start (hpacker, false, false);
650
651         quit.signal_clicked().connect(mem_fun(*this,&UI::quit));
652
653         win.show_all ();
654         win.set_modal (true);
655
656         theMain->run ();
657
658         _exit (1);
659 }
660
661 void
662 UI::popup_error (const string& text)
663 {
664         if (!caller_is_ui_thread()) {
665                 error << "non-UI threads can't use UI::popup_error"
666                       << endmsg;
667                 return;
668         }
669
670         MessageDialog msg (text);
671         msg.set_title (string_compose (_("I'm sorry %1, I can't do that"), g_get_user_name()));
672         msg.set_wmclass (X_("error"), name());
673         msg.set_position (WIN_POS_MOUSE);
674         msg.run ();
675 }
676
677 void
678 UI::flush_pending ()
679 {
680         if (!caller_is_ui_thread()) {
681                 error << "non-UI threads cannot call UI::flush_pending()"
682                       << endmsg;
683                 return;
684         }
685
686         gtk_main_iteration();
687
688         while (gtk_events_pending()) {
689                 gtk_main_iteration();
690         }
691 }
692
693 bool
694 UI::just_hide_it (GdkEventAny* /*ev*/, Window *win)
695 {
696         win->hide ();
697         return true;
698 }
699
700 Gdk::Color
701 UI::get_color (const string& prompt, bool& picked, const Gdk::Color* initial)
702 {
703         Gdk::Color color;
704
705         ColorSelectionDialog color_dialog (prompt);
706
707         color_dialog.set_modal (true);
708         color_dialog.get_cancel_button()->signal_clicked().connect (bind (mem_fun (*this, &UI::color_selection_done), false));
709         color_dialog.get_ok_button()->signal_clicked().connect (bind (mem_fun (*this, &UI::color_selection_done), true));
710         color_dialog.signal_delete_event().connect (mem_fun (*this, &UI::color_selection_deleted));
711
712         if (initial) {
713                 color_dialog.get_colorsel()->set_current_color (*initial);
714         }
715
716         color_dialog.show_all ();
717         color_picked = false;
718         picked = false;
719
720         Main::run();
721
722         color_dialog.hide_all ();
723
724         if (color_picked) {
725                 Gdk::Color f_rgba = color_dialog.get_colorsel()->get_current_color ();
726                 color.set_red(f_rgba.get_red());
727                 color.set_green(f_rgba.get_green());
728                 color.set_blue(f_rgba.get_blue());
729
730                 picked = true;
731         }
732
733         return color;
734 }
735
736 void
737 UI::color_selection_done (bool status)
738 {
739         color_picked = status;
740         Main::quit ();
741 }
742
743 bool
744 UI::color_selection_deleted (GdkEventAny* /*ev*/)
745 {
746         Main::quit ();
747         return true;
748 }