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