2 Copyright (C) 1999-2005 Paul Barton-Davis
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.
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.
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.
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"
37 #include "gtkmm2ext/application.h"
38 #include "gtkmm2ext/bindings.h"
39 #include "gtkmm2ext/gtk_ui.h"
40 #include "gtkmm2ext/textviewer.h"
41 #include "gtkmm2ext/popup.h"
42 #include "gtkmm2ext/utils.h"
43 #include "gtkmm2ext/window_title.h"
44 #include "gtkmm2ext/actions.h"
45 #include "gtkmm2ext/activatable.h"
46 #include "gtkmm2ext/actions.h"
47 #include "gtkmm2ext/gui_thread.h"
51 using namespace Gtkmm2ext;
59 BaseUI::RequestType Gtkmm2ext::NullMessage = BaseUI::new_request_type();
60 BaseUI::RequestType Gtkmm2ext::ErrorMessage = BaseUI::new_request_type();
61 BaseUI::RequestType Gtkmm2ext::TouchDisplay = BaseUI::new_request_type();
62 BaseUI::RequestType Gtkmm2ext::StateChange = BaseUI::new_request_type();
63 BaseUI::RequestType Gtkmm2ext::SetTip = BaseUI::new_request_type();
64 BaseUI::RequestType Gtkmm2ext::AddIdle = BaseUI::new_request_type();
65 BaseUI::RequestType Gtkmm2ext::AddTimeout = BaseUI::new_request_type();
67 #include "pbd/abstract_ui.cc" /* instantiate the template */
69 template class AbstractUI<Gtkmm2ext::UIRequest>;
71 UI::UI (string application_name, string thread_name, int *argc, char ***argv)
72 : AbstractUI<UIRequest> (thread_name)
77 theMain = new Main (argc, argv);
79 pthread_set_name ("gui");
86 fatal << "duplicate UI requested" << endmsg;
87 abort(); /* NOTREACHED */
90 /* the GUI event loop runs in the main thread of the app,
91 which is assumed to have called this.
94 run_loop_thread = Threads::Thread::self();
96 /* store "this" as the UI-for-thread of this thread, same argument
100 set_event_loop_for_thread (this);
102 /* we will be receiving requests */
104 EventLoop::register_request_buffer_factory ("gui", request_buffer_factory);
106 /* attach our request source to the default main context */
108 attach_request_source ();
110 errors = new TextViewer (800,600);
111 errors->text().set_editable (false);
112 errors->text().set_name ("ErrorText");
113 errors->signal_unmap().connect (sigc::bind (sigc::ptr_fun (&ActionManager::uncheck_toggleaction), X_("<Actions>/Editor/toggle-log-window")));
115 Glib::set_application_name (application_name);
117 WindowTitle title(Glib::get_application_name());
119 errors->set_title (title.get_string());
121 errors->dismiss_button().set_name ("ErrorLogCloseButton");
122 errors->signal_delete_event().connect (sigc::bind (sigc::ptr_fun (just_hide_it), (Window *) errors));
123 errors->set_type_hint (Gdk::WINDOW_TYPE_HINT_UTILITY);
125 //load_rcfile (rcfile);
127 /* instantiate the Application singleton */
129 Application::instance();
139 UI::caller_is_ui_thread ()
141 return Threads::Thread::self() == run_loop_thread;
145 UI::load_rcfile (string path, bool themechange)
147 /* Yes, pointers to Glib::RefPtr. If these are not kept around,
148 * a segfault somewhere deep in the wonderfully robust glib will result.
149 * This does not occur if wiget.get_style is used instead of rc.get_style below,
150 * except that doesn't actually work...
153 static Glib::RefPtr<Style>* fatal_style = 0;
154 static Glib::RefPtr<Style>* error_style = 0;
155 static Glib::RefPtr<Style>* warning_style = 0;
156 static Glib::RefPtr<Style>* info_style = 0;
158 if (path.length() == 0) {
162 if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
163 error << "UI: couldn't find rc file \""
170 RC rc (path.c_str());
171 //this is buggy in gtkmm for some reason, so use C
172 //RC::reset_styles (Gtk::Settings::get_default());
173 gtk_rc_reset_styles (gtk_settings_get_default());
175 theme_changed.emit();
178 return 0; //Don't continue on every time there is a theme change
181 /* have to pack widgets into a toplevel window so that styles will stick */
183 Window temp_window (WINDOW_TOPLEVEL);
184 temp_window.ensure_style ();
189 Label warning_widget;
191 RefPtr<Gtk::Style> style;
192 RefPtr<TextBuffer> buffer (errors->text().get_buffer());
194 box.pack_start (fatal_widget);
195 box.pack_start (error_widget);
196 box.pack_start (warning_widget);
197 box.pack_start (info_widget);
199 error_ptag = buffer->create_tag();
200 error_mtag = buffer->create_tag();
201 fatal_ptag = buffer->create_tag();
202 fatal_mtag = buffer->create_tag();
203 warning_ptag = buffer->create_tag();
204 warning_mtag = buffer->create_tag();
205 info_ptag = buffer->create_tag();
206 info_mtag = buffer->create_tag();
208 fatal_widget.set_name ("FatalMessage");
211 /* This next line and the similar ones below are sketchily
212 * guessed to fix #2885. I think maybe that problems occur
213 * because with gtk_rc_get_style (to quote its docs) "no
214 * refcount is added to the returned style". So I've switched
215 * this to use Glib::wrap with take_copy == true, which requires
216 * all the nasty casts and calls to plain-old-C GTK.
218 * At worst I think this causes a memory leak; at least it appears
221 * I could be wrong about any or all of the above.
223 fatal_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (fatal_widget.gobj())), true));
225 fatal_ptag->property_font_desc().set_value((*fatal_style)->get_font());
226 fatal_ptag->property_foreground_gdk().set_value((*fatal_style)->get_fg(STATE_ACTIVE));
227 fatal_ptag->property_background_gdk().set_value((*fatal_style)->get_bg(STATE_ACTIVE));
228 fatal_mtag->property_font_desc().set_value((*fatal_style)->get_font());
229 fatal_mtag->property_foreground_gdk().set_value((*fatal_style)->get_fg(STATE_NORMAL));
230 fatal_mtag->property_background_gdk().set_value((*fatal_style)->get_bg(STATE_NORMAL));
232 error_widget.set_name ("ErrorMessage");
234 error_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (error_widget.gobj())), true));
236 error_ptag->property_font_desc().set_value((*error_style)->get_font());
237 error_ptag->property_foreground_gdk().set_value((*error_style)->get_fg(STATE_ACTIVE));
238 error_ptag->property_background_gdk().set_value((*error_style)->get_bg(STATE_ACTIVE));
239 error_mtag->property_font_desc().set_value((*error_style)->get_font());
240 error_mtag->property_foreground_gdk().set_value((*error_style)->get_fg(STATE_NORMAL));
241 error_mtag->property_background_gdk().set_value((*error_style)->get_bg(STATE_NORMAL));
243 warning_widget.set_name ("WarningMessage");
244 delete warning_style;
245 warning_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (warning_widget.gobj())), true));
247 warning_ptag->property_font_desc().set_value((*warning_style)->get_font());
248 warning_ptag->property_foreground_gdk().set_value((*warning_style)->get_fg(STATE_ACTIVE));
249 warning_ptag->property_background_gdk().set_value((*warning_style)->get_bg(STATE_ACTIVE));
250 warning_mtag->property_font_desc().set_value((*warning_style)->get_font());
251 warning_mtag->property_foreground_gdk().set_value((*warning_style)->get_fg(STATE_NORMAL));
252 warning_mtag->property_background_gdk().set_value((*warning_style)->get_bg(STATE_NORMAL));
254 info_widget.set_name ("InfoMessage");
256 info_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (info_widget.gobj())), true));
258 info_ptag->property_font_desc().set_value((*info_style)->get_font());
259 info_ptag->property_foreground_gdk().set_value((*info_style)->get_fg(STATE_ACTIVE));
260 info_ptag->property_background_gdk().set_value((*info_style)->get_bg(STATE_ACTIVE));
261 info_mtag->property_font_desc().set_value((*info_style)->get_font());
262 info_mtag->property_foreground_gdk().set_value((*info_style)->get_fg(STATE_NORMAL));
263 info_mtag->property_background_gdk().set_value((*info_style)->get_bg(STATE_NORMAL));
269 UI::run (Receiver &old_receiver)
271 _receiver.listen_to (error);
272 _receiver.listen_to (info);
273 _receiver.listen_to (warning);
274 _receiver.listen_to (fatal);
276 /* stop the old receiver (text/console) once we hit the first idle */
278 Glib::signal_idle().connect (bind_return (mem_fun (old_receiver, &Receiver::hangup), false));
300 UIRequest *req = get_request (Quit);
309 static bool idle_quit ()
318 if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
321 Glib::signal_idle().connect (sigc::ptr_fun (idle_quit));
326 UI::touch_display (Touchable *display)
328 UIRequest *req = get_request (TouchDisplay);
334 req->display = display;
340 UI::set_tip (Widget &w, const gchar *tip)
342 set_tip(&w, tip, "");
346 UI::set_tip (Widget &w, const std::string& tip)
348 set_tip(&w, tip.c_str(), "");
352 UI::set_tip (Widget *w, const gchar *tip, const gchar *hlp)
354 UIRequest *req = get_request (SetTip);
356 std::string msg(tip);
358 Glib::RefPtr<Gtk::Action> action = w->get_action();
361 Gtkmm2ext::Activatable* activatable;
362 if ((activatable = dynamic_cast<Gtkmm2ext::Activatable*>(w))) {
363 action = activatable->get_related_action();
368 Bindings* bindings = (Bindings*) w->get_data ("ardour-bindings");
370 Gtk::Window* win = (Gtk::Window*) w->get_toplevel();
372 bindings = (Bindings*) win->get_data ("ardour-bindings");
377 bindings = global_bindings;
381 Bindings::Operation op;
382 KeyboardKey kb = bindings->get_binding_for_action (action, op);
383 string shortcut = kb.display_label ();
384 if (!shortcut.empty()) {
385 replace_all (shortcut, "<", "");
386 replace_all (shortcut, ">", "-");
387 msg.append(_("\n\nShortcut: ")).append (shortcut);
398 req->msg = msg.c_str();
405 UI::set_state (Widget *w, StateType state)
407 UIRequest *req = get_request (StateChange);
413 req->new_state = state;
420 UI::idle_add (int (*func)(void *), void *arg)
422 UIRequest *req = get_request (AddIdle);
428 req->function = func;
434 /* END abstract_ui interfaces */
436 /** Create a PBD::EventLoop::InvalidationRecord and attach a callback
437 * to a given sigc::trackable so that PBD::EventLoop::invalidate_request
438 * is called when that trackable is destroyed.
440 PBD::EventLoop::InvalidationRecord*
441 __invalidator (sigc::trackable& trackable, const char* file, int line)
443 PBD::EventLoop::InvalidationRecord* ir = new PBD::EventLoop::InvalidationRecord;
448 trackable.add_destroy_notify_callback (ir, PBD::EventLoop::invalidate_request);
454 UI::do_request (UIRequest* req)
456 if (req->type == ErrorMessage) {
458 process_error_message (req->chn, req->msg);
459 free (const_cast<char*>(req->msg)); /* it was strdup'ed */
460 req->msg = 0; /* don't free it again in the destructor */
462 } else if (req->type == Quit) {
466 } else if (req->type == CallSlot) {
468 if (getenv ("DEBUG_THREADED_SIGNALS")) {
469 cerr << "call slot for " << event_loop_name() << endl;
474 } else if (req->type == TouchDisplay) {
476 req->display->touch ();
477 if (req->display->delete_after_touch()) {
481 } else if (req->type == StateChange) {
483 req->widget->set_state (req->new_state);
485 } else if (req->type == SetTip) {
487 gtk_widget_set_tooltip_markup (req->widget->gobj(), req->msg);
491 error << "GtkUI: unknown request type "
497 /*======================================================================
499 ======================================================================*/
502 UI::dump_errors (std::ostream& ostr)
504 Glib::Threads::Mutex::Lock lm (error_lock);
505 ostr << endl << X_("Errors/Messages:") << endl;
506 for (list<string>::const_iterator i = error_stack.begin(); i != error_stack.end(); ++i) {
513 UI::receive (Transmitter::Channel chn, const char *str)
516 Glib::Threads::Mutex::Lock lm (error_lock);
518 case Transmitter::Fatal:
519 error_stack.push_back (string (X_("FATAL: ")) + str);
521 case Transmitter::Error:
522 error_stack.push_back (string (X_("ERROR: ")) + str);
524 case Transmitter::Warning:
525 error_stack.push_back (string (X_("WARNING: ")) + str);
527 case Transmitter::Info:
528 error_stack.push_back (string (X_("INFO: ")) + str);
530 case Transmitter::Throw:
531 error_stack.push_back (string (X_("THROW: ")) + str);
536 if (caller_is_ui_thread()) {
537 process_error_message (chn, str);
539 UIRequest* req = get_request (ErrorMessage);
546 req->msg = strdup (str);
552 #define OLD_STYLE_ERRORS 1
555 UI::process_error_message (Transmitter::Channel chn, const char *str)
558 RefPtr<TextBuffer::Tag> ptag;
559 RefPtr<TextBuffer::Tag> mtag;
562 bool fatal_received = false;
563 #ifndef OLD_STYLE_ERRORS
564 PopUp* popup = new PopUp (WIN_POS_CENTER, 0, true);
568 case Transmitter::Fatal:
569 prefix = "[FATAL]: ";
573 fatal_received = true;
575 case Transmitter::Error:
577 prefix = "[ERROR]: ";
582 popup->set_name ("ErrorMessage");
583 popup->set_text (str);
588 case Transmitter::Info:
595 popup->set_name ("InfoMessage");
596 popup->set_text (str);
602 case Transmitter::Warning:
604 prefix = "[WARNING]: ";
609 popup->set_name ("WarningMessage");
610 popup->set_text (str);
616 /* no choice but to use text/console output here */
617 cerr << "programmer error in UI::check_error_messages (channel = " << chn << ")\n";
621 errors->text().get_buffer()->begin_user_action();
623 if (fatal_received) {
627 if (!ptag || !mtag) {
628 /* oops, message sent before we set up tags - don't crash */
629 cerr << prefix << str << endl;
631 display_message (prefix, prefix_len, ptag, mtag, str);
635 errors->text().get_buffer()->end_user_action();
641 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("toggle-log-window"));
646 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
655 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("toggle-log-window"));
660 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
662 if (tact->get_active()) {
663 errors->set_position (WIN_POS_MOUSE);
671 UI::display_message (const char *prefix, gint /*prefix_len*/, RefPtr<TextBuffer::Tag> ptag, RefPtr<TextBuffer::Tag> mtag, const char *msg)
673 RefPtr<TextBuffer> buffer (errors->text().get_buffer());
675 buffer->insert_with_tag(buffer->end(), prefix, ptag);
676 buffer->insert_with_tag(buffer->end(), msg, mtag);
677 buffer->insert_with_tag(buffer->end(), "\n", mtag);
679 errors->scroll_to_bottom ();
683 UI::handle_fatal (const char *message)
686 Label label (message);
687 Button quit (_("Press To Exit"));
690 win.set_default_size (400, 100);
692 WindowTitle title(Glib::get_application_name());
693 title += ": Fatal Error";
694 win.set_title (title.get_string());
696 win.set_position (WIN_POS_MOUSE);
697 win.set_border_width (12);
699 win.get_vbox()->pack_start (label, true, true);
700 hpacker.pack_start (quit, true, false);
701 win.get_vbox()->pack_start (hpacker, false, false);
703 quit.signal_clicked().connect(mem_fun(*this,&UI::quit));
706 win.set_modal (true);
714 UI::popup_error (const string& text)
716 if (!caller_is_ui_thread()) {
717 error << "non-UI threads can't use UI::popup_error"
722 MessageDialog msg (text);
723 msg.set_title (string_compose (_("I'm sorry %1, I can't do that"), g_get_user_name()));
724 msg.set_wmclass (X_("error"), Glib::get_application_name());
725 msg.set_position (WIN_POS_MOUSE);
730 UI::flush_pending (float timeout)
732 if (!caller_is_ui_thread()) {
733 error << "non-UI threads cannot call UI::flush_pending()"
738 int64_t end = g_get_monotonic_time () + timeout * 1e6;
740 gtk_main_iteration();
742 while (gtk_events_pending()) {
743 if (timeout > 0 && end < g_get_monotonic_time ()) {
744 cerr << "UI::flush_pending timed out after " << timeout << "s.\n";
747 gtk_main_iteration();
752 UI::just_hide_it (GdkEventAny* /*ev*/, Window *win)
759 UI::color_selection_done (bool status)
761 color_picked = status;
766 UI::color_selection_deleted (GdkEventAny* /*ev*/)