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;
58 float UI::ui_scale = 1.0;
60 BaseUI::RequestType Gtkmm2ext::NullMessage = BaseUI::new_request_type();
61 BaseUI::RequestType Gtkmm2ext::ErrorMessage = BaseUI::new_request_type();
62 BaseUI::RequestType Gtkmm2ext::TouchDisplay = BaseUI::new_request_type();
63 BaseUI::RequestType Gtkmm2ext::StateChange = BaseUI::new_request_type();
64 BaseUI::RequestType Gtkmm2ext::SetTip = BaseUI::new_request_type();
65 BaseUI::RequestType Gtkmm2ext::AddIdle = BaseUI::new_request_type();
66 BaseUI::RequestType Gtkmm2ext::AddTimeout = BaseUI::new_request_type();
68 #include "pbd/abstract_ui.cc" /* instantiate the template */
70 template class AbstractUI<Gtkmm2ext::UIRequest>;
72 UI::UI (string application_name, string thread_name, int *argc, char ***argv)
73 : AbstractUI<UIRequest> (thread_name)
78 theMain = new Main (argc, argv);
80 pthread_set_name ("gui");
87 fatal << "duplicate UI requested" << endmsg;
88 abort(); /* NOTREACHED */
91 /* the GUI event loop runs in the main thread of the app,
92 which is assumed to have called this.
95 run_loop_thread = Threads::Thread::self();
97 /* store "this" as the UI-for-thread of this thread, same argument
101 set_event_loop_for_thread (this);
103 /* we will be receiving requests */
105 EventLoop::register_request_buffer_factory ("gui", request_buffer_factory);
107 /* attach our request source to the default main context */
109 attach_request_source ();
111 errors = new TextViewer (800,600);
112 errors->text().set_editable (false);
113 errors->text().set_name ("ErrorText");
114 errors->signal_unmap().connect (sigc::bind (sigc::ptr_fun (&ActionManager::uncheck_toggleaction), X_("<Actions>/Editor/toggle-log-window")));
116 Glib::set_application_name (application_name);
118 WindowTitle title(Glib::get_application_name());
120 errors->set_title (title.get_string());
122 errors->dismiss_button().set_name ("ErrorLogCloseButton");
123 errors->signal_delete_event().connect (sigc::bind (sigc::ptr_fun (just_hide_it), (Window *) errors));
124 errors->set_type_hint (Gdk::WINDOW_TYPE_HINT_UTILITY);
126 //load_rcfile (rcfile);
128 /* instantiate the Application singleton */
130 Application::instance();
140 UI::caller_is_ui_thread ()
142 return Threads::Thread::self() == run_loop_thread;
146 UI::load_rcfile (string path, bool themechange)
148 /* Yes, pointers to Glib::RefPtr. If these are not kept around,
149 * a segfault somewhere deep in the wonderfully robust glib will result.
150 * This does not occur if wiget.get_style is used instead of rc.get_style below,
151 * except that doesn't actually work...
154 static Glib::RefPtr<Style>* fatal_style = 0;
155 static Glib::RefPtr<Style>* error_style = 0;
156 static Glib::RefPtr<Style>* warning_style = 0;
157 static Glib::RefPtr<Style>* info_style = 0;
159 if (path.length() == 0) {
163 if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
164 error << "UI: couldn't find rc file \""
171 RC rc (path.c_str());
172 //this is buggy in gtkmm for some reason, so use C
173 //RC::reset_styles (Gtk::Settings::get_default());
174 gtk_rc_reset_styles (gtk_settings_get_default());
176 theme_changed.emit();
179 return 0; //Don't continue on every time there is a theme change
182 /* have to pack widgets into a toplevel window so that styles will stick */
184 Window temp_window (WINDOW_TOPLEVEL);
185 temp_window.ensure_style ();
190 Label warning_widget;
192 RefPtr<Gtk::Style> style;
193 RefPtr<TextBuffer> buffer (errors->text().get_buffer());
195 box.pack_start (fatal_widget);
196 box.pack_start (error_widget);
197 box.pack_start (warning_widget);
198 box.pack_start (info_widget);
200 error_ptag = buffer->create_tag();
201 error_mtag = buffer->create_tag();
202 fatal_ptag = buffer->create_tag();
203 fatal_mtag = buffer->create_tag();
204 warning_ptag = buffer->create_tag();
205 warning_mtag = buffer->create_tag();
206 info_ptag = buffer->create_tag();
207 info_mtag = buffer->create_tag();
209 fatal_widget.set_name ("FatalMessage");
212 /* This next line and the similar ones below are sketchily
213 * guessed to fix #2885. I think maybe that problems occur
214 * because with gtk_rc_get_style (to quote its docs) "no
215 * refcount is added to the returned style". So I've switched
216 * this to use Glib::wrap with take_copy == true, which requires
217 * all the nasty casts and calls to plain-old-C GTK.
219 * At worst I think this causes a memory leak; at least it appears
222 * I could be wrong about any or all of the above.
224 fatal_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (fatal_widget.gobj())), true));
226 fatal_ptag->property_font_desc().set_value((*fatal_style)->get_font());
227 fatal_ptag->property_foreground_gdk().set_value((*fatal_style)->get_fg(STATE_ACTIVE));
228 fatal_ptag->property_background_gdk().set_value((*fatal_style)->get_bg(STATE_ACTIVE));
229 fatal_mtag->property_font_desc().set_value((*fatal_style)->get_font());
230 fatal_mtag->property_foreground_gdk().set_value((*fatal_style)->get_fg(STATE_NORMAL));
231 fatal_mtag->property_background_gdk().set_value((*fatal_style)->get_bg(STATE_NORMAL));
233 error_widget.set_name ("ErrorMessage");
235 error_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (error_widget.gobj())), true));
237 error_ptag->property_font_desc().set_value((*error_style)->get_font());
238 error_ptag->property_foreground_gdk().set_value((*error_style)->get_fg(STATE_ACTIVE));
239 error_ptag->property_background_gdk().set_value((*error_style)->get_bg(STATE_ACTIVE));
240 error_mtag->property_font_desc().set_value((*error_style)->get_font());
241 error_mtag->property_foreground_gdk().set_value((*error_style)->get_fg(STATE_NORMAL));
242 error_mtag->property_background_gdk().set_value((*error_style)->get_bg(STATE_NORMAL));
244 warning_widget.set_name ("WarningMessage");
245 delete warning_style;
246 warning_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (warning_widget.gobj())), true));
248 warning_ptag->property_font_desc().set_value((*warning_style)->get_font());
249 warning_ptag->property_foreground_gdk().set_value((*warning_style)->get_fg(STATE_ACTIVE));
250 warning_ptag->property_background_gdk().set_value((*warning_style)->get_bg(STATE_ACTIVE));
251 warning_mtag->property_font_desc().set_value((*warning_style)->get_font());
252 warning_mtag->property_foreground_gdk().set_value((*warning_style)->get_fg(STATE_NORMAL));
253 warning_mtag->property_background_gdk().set_value((*warning_style)->get_bg(STATE_NORMAL));
255 info_widget.set_name ("InfoMessage");
257 info_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (info_widget.gobj())), true));
259 info_ptag->property_font_desc().set_value((*info_style)->get_font());
260 info_ptag->property_foreground_gdk().set_value((*info_style)->get_fg(STATE_ACTIVE));
261 info_ptag->property_background_gdk().set_value((*info_style)->get_bg(STATE_ACTIVE));
262 info_mtag->property_font_desc().set_value((*info_style)->get_font());
263 info_mtag->property_foreground_gdk().set_value((*info_style)->get_fg(STATE_NORMAL));
264 info_mtag->property_background_gdk().set_value((*info_style)->get_bg(STATE_NORMAL));
270 UI::run (Receiver &old_receiver)
272 _receiver.listen_to (error);
273 _receiver.listen_to (info);
274 _receiver.listen_to (warning);
275 _receiver.listen_to (fatal);
277 /* stop the old receiver (text/console) once we hit the first idle */
279 Glib::signal_idle().connect (bind_return (mem_fun (old_receiver, &Receiver::hangup), false));
301 UIRequest *req = get_request (Quit);
310 static bool idle_quit ()
319 if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
322 Glib::signal_idle().connect (sigc::ptr_fun (idle_quit));
327 UI::touch_display (Touchable *display)
329 UIRequest *req = get_request (TouchDisplay);
335 req->display = display;
341 UI::set_tip (Widget &w, const gchar *tip)
343 set_tip(&w, tip, "");
347 UI::set_tip (Widget &w, const std::string& tip)
349 set_tip(&w, tip.c_str(), "");
353 UI::set_tip (Widget *w, const gchar *tip, const gchar *hlp)
355 UIRequest *req = get_request (SetTip);
357 std::string msg(tip);
359 Glib::RefPtr<Gtk::Action> action = w->get_action();
362 Gtkmm2ext::Activatable* activatable;
363 if ((activatable = dynamic_cast<Gtkmm2ext::Activatable*>(w))) {
364 action = activatable->get_related_action();
369 Bindings* bindings = (Bindings*) w->get_data ("ardour-bindings");
371 Gtk::Window* win = (Gtk::Window*) w->get_toplevel();
373 bindings = (Bindings*) win->get_data ("ardour-bindings");
378 bindings = global_bindings;
382 Bindings::Operation op;
383 KeyboardKey kb = bindings->get_binding_for_action (action, op);
384 string shortcut = kb.display_label ();
385 if (!shortcut.empty()) {
386 replace_all (shortcut, "<", "");
387 replace_all (shortcut, ">", "-");
388 msg.append(_("\n\nShortcut: ")).append (shortcut);
399 req->msg = msg.c_str();
406 UI::set_state (Widget *w, StateType state)
408 UIRequest *req = get_request (StateChange);
414 req->new_state = state;
421 UI::idle_add (int (*func)(void *), void *arg)
423 UIRequest *req = get_request (AddIdle);
429 req->function = func;
435 /* END abstract_ui interfaces */
437 /** Create a PBD::EventLoop::InvalidationRecord and attach a callback
438 * to a given sigc::trackable so that PBD::EventLoop::invalidate_request
439 * is called when that trackable is destroyed.
441 PBD::EventLoop::InvalidationRecord*
442 __invalidator (sigc::trackable& trackable, const char* file, int line)
444 PBD::EventLoop::InvalidationRecord* ir = new PBD::EventLoop::InvalidationRecord;
449 trackable.add_destroy_notify_callback (ir, PBD::EventLoop::invalidate_request);
455 UI::do_request (UIRequest* req)
457 if (req->type == ErrorMessage) {
459 process_error_message (req->chn, req->msg);
460 free (const_cast<char*>(req->msg)); /* it was strdup'ed */
461 req->msg = 0; /* don't free it again in the destructor */
463 } else if (req->type == Quit) {
467 } else if (req->type == CallSlot) {
469 if (getenv ("DEBUG_THREADED_SIGNALS")) {
470 cerr << "call slot for " << event_loop_name() << endl;
475 } else if (req->type == TouchDisplay) {
477 req->display->touch ();
478 if (req->display->delete_after_touch()) {
482 } else if (req->type == StateChange) {
484 req->widget->set_state (req->new_state);
486 } else if (req->type == SetTip) {
488 gtk_widget_set_tooltip_markup (req->widget->gobj(), req->msg);
492 error << "GtkUI: unknown request type "
498 /*======================================================================
500 ======================================================================*/
503 UI::dump_errors (std::ostream& ostr)
505 Glib::Threads::Mutex::Lock lm (error_lock);
506 ostr << endl << X_("Errors/Messages:") << endl;
507 for (list<string>::const_iterator i = error_stack.begin(); i != error_stack.end(); ++i) {
514 UI::receive (Transmitter::Channel chn, const char *str)
517 Glib::Threads::Mutex::Lock lm (error_lock);
519 case Transmitter::Fatal:
520 error_stack.push_back (string (X_("FATAL: ")) + str);
522 case Transmitter::Error:
523 error_stack.push_back (string (X_("ERROR: ")) + str);
525 case Transmitter::Warning:
526 error_stack.push_back (string (X_("WARNING: ")) + str);
528 case Transmitter::Info:
529 error_stack.push_back (string (X_("INFO: ")) + str);
531 case Transmitter::Throw:
532 error_stack.push_back (string (X_("THROW: ")) + str);
537 if (caller_is_ui_thread()) {
538 process_error_message (chn, str);
540 UIRequest* req = get_request (ErrorMessage);
547 req->msg = strdup (str);
553 #define OLD_STYLE_ERRORS 1
556 UI::process_error_message (Transmitter::Channel chn, const char *str)
559 RefPtr<TextBuffer::Tag> ptag;
560 RefPtr<TextBuffer::Tag> mtag;
563 bool fatal_received = false;
564 #ifndef OLD_STYLE_ERRORS
565 PopUp* popup = new PopUp (WIN_POS_CENTER, 0, true);
569 case Transmitter::Fatal:
570 prefix = "[FATAL]: ";
574 fatal_received = true;
576 case Transmitter::Error:
578 prefix = "[ERROR]: ";
583 popup->set_name ("ErrorMessage");
584 popup->set_text (str);
589 case Transmitter::Info:
596 popup->set_name ("InfoMessage");
597 popup->set_text (str);
603 case Transmitter::Warning:
605 prefix = "[WARNING]: ";
610 popup->set_name ("WarningMessage");
611 popup->set_text (str);
617 /* no choice but to use text/console output here */
618 cerr << "programmer error in UI::check_error_messages (channel = " << chn << ")\n";
622 errors->text().get_buffer()->begin_user_action();
624 if (fatal_received) {
628 if (!ptag || !mtag) {
629 /* oops, message sent before we set up tags - don't crash */
630 cerr << prefix << str << endl;
632 display_message (prefix, prefix_len, ptag, mtag, str);
636 errors->text().get_buffer()->end_user_action();
642 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("toggle-log-window"));
647 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
656 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("toggle-log-window"));
661 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
663 if (tact->get_active()) {
664 errors->set_position (WIN_POS_MOUSE);
672 UI::display_message (const char *prefix, gint /*prefix_len*/, RefPtr<TextBuffer::Tag> ptag, RefPtr<TextBuffer::Tag> mtag, const char *msg)
674 RefPtr<TextBuffer> buffer (errors->text().get_buffer());
676 buffer->insert_with_tag(buffer->end(), prefix, ptag);
677 buffer->insert_with_tag(buffer->end(), msg, mtag);
678 buffer->insert_with_tag(buffer->end(), "\n", mtag);
680 errors->scroll_to_bottom ();
684 UI::handle_fatal (const char *message)
687 Label label (message);
688 Button quit (_("Press To Exit"));
691 win.set_default_size (400, 100);
693 WindowTitle title(Glib::get_application_name());
694 title += ": Fatal Error";
695 win.set_title (title.get_string());
697 win.set_position (WIN_POS_MOUSE);
698 win.set_border_width (12);
700 win.get_vbox()->pack_start (label, true, true);
701 hpacker.pack_start (quit, true, false);
702 win.get_vbox()->pack_start (hpacker, false, false);
704 quit.signal_clicked().connect(mem_fun(*this,&UI::quit));
707 win.set_modal (true);
715 UI::popup_error (const string& text)
717 if (!caller_is_ui_thread()) {
718 error << "non-UI threads can't use UI::popup_error"
723 MessageDialog msg (text);
724 msg.set_title (string_compose (_("I'm sorry %1, I can't do that"), g_get_user_name()));
725 msg.set_wmclass (X_("error"), Glib::get_application_name());
726 msg.set_position (WIN_POS_MOUSE);
733 if (!caller_is_ui_thread()) {
734 error << "non-UI threads cannot call UI::flush_pending()"
739 gtk_main_iteration();
741 while (gtk_events_pending()) {
742 gtk_main_iteration();
747 UI::just_hide_it (GdkEventAny* /*ev*/, Window *win)
754 UI::get_color (const string& prompt, bool& picked, const Gdk::Color* initial)
758 ColorSelectionDialog color_dialog (prompt);
760 color_dialog.set_modal (true);
761 color_dialog.get_cancel_button()->signal_clicked().connect (bind (mem_fun (*this, &UI::color_selection_done), false));
762 color_dialog.get_ok_button()->signal_clicked().connect (bind (mem_fun (*this, &UI::color_selection_done), true));
763 color_dialog.signal_delete_event().connect (mem_fun (*this, &UI::color_selection_deleted));
766 color_dialog.get_colorsel()->set_current_color (*initial);
769 color_dialog.show_all ();
770 color_picked = false;
775 color_dialog.hide_all ();
778 Gdk::Color f_rgba = color_dialog.get_colorsel()->get_current_color ();
779 color.set_red(f_rgba.get_red());
780 color.set_green(f_rgba.get_green());
781 color.set_blue(f_rgba.get_blue());
790 UI::color_selection_done (bool status)
792 color_picked = status;
797 UI::color_selection_deleted (GdkEventAny* /*ev*/)