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.
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>
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>
47 using namespace Gtkmm2ext;
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();
63 #include "pbd/abstract_ui.cc" /* instantiate the template */
65 UI::UI (string namestr, int *argc, char ***argv)
66 : AbstractUI<UIRequest> (namestr)
68 theMain = new Main (argc, argv);
75 fatal << "duplicate UI requested" << endmsg;
79 /* the GUI event loop runs in the main thread of the app,
80 which is assumed to have called this.
83 run_loop_thread = Thread::self();
85 /* store "this" as the UI-for-thread of this thread, same argument
89 set_event_loop_for_thread (this);
91 /* attach our request source to the default main context */
93 request_channel.ios()->attach (MainContext::get_default());
95 errors = new TextViewer (800,600);
96 errors->text().set_editable (false);
97 errors->text().set_name ("ErrorText");
98 errors->signal_unmap().connect (sigc::bind (sigc::ptr_fun (&ActionManager::uncheck_toggleaction), X_("<Actions>/Editor/toggle-log-window")));
100 Glib::set_application_name(namestr);
102 WindowTitle title(Glib::get_application_name());
104 errors->set_title (title.get_string());
106 errors->dismiss_button().set_name ("ErrorLogCloseButton");
107 errors->signal_delete_event().connect (sigc::bind (sigc::ptr_fun (just_hide_it), (Window *) errors));
108 errors->set_type_hint (Gdk::WINDOW_TYPE_HINT_UTILITY);
110 //load_rcfile (rcfile);
112 /* instantiate the Application singleton */
114 Application::instance();
123 UI::caller_is_ui_thread ()
125 return Thread::self() == run_loop_thread;
129 UI::load_rcfile (string path, bool themechange)
131 /* Yes, pointers to Glib::RefPtr. If these are not kept around,
132 * a segfault somewhere deep in the wonderfully robust glib will result.
133 * This does not occur if wiget.get_style is used instead of rc.get_style below,
134 * except that doesn't actually work...
137 static Glib::RefPtr<Style>* fatal_style = 0;
138 static Glib::RefPtr<Style>* error_style = 0;
139 static Glib::RefPtr<Style>* warning_style = 0;
140 static Glib::RefPtr<Style>* info_style = 0;
142 if (path.length() == 0) {
146 if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
147 error << "UI: couldn't find rc file \""
154 RC rc (path.c_str());
155 //this is buggy in gtkmm for some reason, so use C
156 //RC::reset_styles (Gtk::Settings::get_default());
157 gtk_rc_reset_styles (gtk_settings_get_default());
159 theme_changed.emit();
162 return 0; //Don't continue on every time there is a theme change
165 /* have to pack widgets into a toplevel window so that styles will stick */
167 Window temp_window (WINDOW_TOPLEVEL);
168 temp_window.ensure_style ();
173 Label warning_widget;
175 RefPtr<Gtk::Style> style;
176 RefPtr<TextBuffer> buffer (errors->text().get_buffer());
178 box.pack_start (fatal_widget);
179 box.pack_start (error_widget);
180 box.pack_start (warning_widget);
181 box.pack_start (info_widget);
183 error_ptag = buffer->create_tag();
184 error_mtag = buffer->create_tag();
185 fatal_ptag = buffer->create_tag();
186 fatal_mtag = buffer->create_tag();
187 warning_ptag = buffer->create_tag();
188 warning_mtag = buffer->create_tag();
189 info_ptag = buffer->create_tag();
190 info_mtag = buffer->create_tag();
192 fatal_widget.set_name ("FatalMessage");
195 /* This next line and the similar ones below are sketchily
196 * guessed to fix #2885. I think maybe that problems occur
197 * because with gtk_rc_get_style (to quote its docs) "no
198 * refcount is added to the returned style". So I've switched
199 * this to use Glib::wrap with take_copy == true, which requires
200 * all the nasty casts and calls to plain-old-C GTK.
202 * At worst I think this causes a memory leak; at least it appears
205 * I could be wrong about any or all of the above.
207 fatal_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (fatal_widget.gobj())), true));
209 fatal_ptag->property_font_desc().set_value((*fatal_style)->get_font());
210 fatal_ptag->property_foreground_gdk().set_value((*fatal_style)->get_fg(STATE_ACTIVE));
211 fatal_ptag->property_background_gdk().set_value((*fatal_style)->get_bg(STATE_ACTIVE));
212 fatal_mtag->property_font_desc().set_value((*fatal_style)->get_font());
213 fatal_mtag->property_foreground_gdk().set_value((*fatal_style)->get_fg(STATE_NORMAL));
214 fatal_mtag->property_background_gdk().set_value((*fatal_style)->get_bg(STATE_NORMAL));
216 error_widget.set_name ("ErrorMessage");
218 error_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (error_widget.gobj())), true));
220 error_ptag->property_font_desc().set_value((*error_style)->get_font());
221 error_ptag->property_foreground_gdk().set_value((*error_style)->get_fg(STATE_ACTIVE));
222 error_ptag->property_background_gdk().set_value((*error_style)->get_bg(STATE_ACTIVE));
223 error_mtag->property_font_desc().set_value((*error_style)->get_font());
224 error_mtag->property_foreground_gdk().set_value((*error_style)->get_fg(STATE_NORMAL));
225 error_mtag->property_background_gdk().set_value((*error_style)->get_bg(STATE_NORMAL));
227 warning_widget.set_name ("WarningMessage");
228 delete warning_style;
229 warning_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (warning_widget.gobj())), true));
231 warning_ptag->property_font_desc().set_value((*warning_style)->get_font());
232 warning_ptag->property_foreground_gdk().set_value((*warning_style)->get_fg(STATE_ACTIVE));
233 warning_ptag->property_background_gdk().set_value((*warning_style)->get_bg(STATE_ACTIVE));
234 warning_mtag->property_font_desc().set_value((*warning_style)->get_font());
235 warning_mtag->property_foreground_gdk().set_value((*warning_style)->get_fg(STATE_NORMAL));
236 warning_mtag->property_background_gdk().set_value((*warning_style)->get_bg(STATE_NORMAL));
238 info_widget.set_name ("InfoMessage");
240 info_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (info_widget.gobj())), true));
242 info_ptag->property_font_desc().set_value((*info_style)->get_font());
243 info_ptag->property_foreground_gdk().set_value((*info_style)->get_fg(STATE_ACTIVE));
244 info_ptag->property_background_gdk().set_value((*info_style)->get_bg(STATE_ACTIVE));
245 info_mtag->property_font_desc().set_value((*info_style)->get_font());
246 info_mtag->property_foreground_gdk().set_value((*info_style)->get_fg(STATE_NORMAL));
247 info_mtag->property_background_gdk().set_value((*info_style)->get_bg(STATE_NORMAL));
253 UI::run (Receiver &old_receiver)
260 /* stop the old receiver (text/console) once we hit the first idle */
262 Glib::signal_idle().connect (bind_return (mem_fun (old_receiver, &Receiver::hangup), false));
282 UIRequest *req = get_request (Quit);
291 static bool idle_quit ()
300 if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
303 Glib::signal_idle().connect (sigc::ptr_fun (idle_quit));
308 UI::touch_display (Touchable *display)
310 UIRequest *req = get_request (TouchDisplay);
316 req->display = display;
322 UI::set_tip (Widget &w, const gchar *tip)
324 set_tip(&w, tip, "");
328 UI::set_tip (Widget &w, const std::string& tip)
330 set_tip(&w, tip.c_str(), "");
334 UI::set_tip (Widget *w, const gchar *tip, const gchar *hlp)
336 UIRequest *req = get_request (SetTip);
338 std::string msg(tip);
340 Glib::RefPtr<Gtk::Action> action = w->get_action();
343 Gtkmm2ext::Activatable* activatable;
344 if ((activatable = dynamic_cast<Gtkmm2ext::Activatable*>(w))) {
345 action = activatable->get_related_action();
351 ustring ap = action->get_accel_path();
353 bool has_key = ActionManager::lookup_entry(ap, key);
355 string abbrev = key.get_abbrev();
356 if (!abbrev.empty()) {
357 replace_all (abbrev, "<", "");
358 replace_all (abbrev, ">", "-");
359 msg.append("\n\nKey: ").append (abbrev);
371 req->msg = msg.c_str();
378 UI::set_state (Widget *w, StateType state)
380 UIRequest *req = get_request (StateChange);
386 req->new_state = state;
393 UI::idle_add (int (*func)(void *), void *arg)
395 UIRequest *req = get_request (AddIdle);
401 req->function = func;
407 /* END abstract_ui interfaces */
409 /** Create a PBD::EventLoop::InvalidationRecord and attach a callback
410 * to a given sigc::trackable so that PBD::EventLoop::invalidate_request
411 * is called when that trackable is destroyed.
413 PBD::EventLoop::InvalidationRecord*
414 __invalidator (sigc::trackable& trackable, const char* file, int line)
416 PBD::EventLoop::InvalidationRecord* ir = new PBD::EventLoop::InvalidationRecord;
421 trackable.add_destroy_notify_callback (ir, PBD::EventLoop::invalidate_request);
427 UI::do_request (UIRequest* req)
429 if (req->type == ErrorMessage) {
431 process_error_message (req->chn, req->msg);
432 free (const_cast<char*>(req->msg)); /* it was strdup'ed */
433 req->msg = 0; /* don't free it again in the destructor */
435 } else if (req->type == Quit) {
439 } else if (req->type == CallSlot) {
441 if (getenv ("DEBUG_THREADED_SIGNALS")) {
442 cerr << "call slot for " << name() << endl;
447 } else if (req->type == TouchDisplay) {
449 req->display->touch ();
450 if (req->display->delete_after_touch()) {
454 } else if (req->type == StateChange) {
456 req->widget->set_state (req->new_state);
458 } else if (req->type == SetTip) {
460 gtk_widget_set_tooltip_markup (req->widget->gobj(), req->msg);
464 error << "GtkUI: unknown request type "
470 /*======================================================================
472 ======================================================================*/
475 UI::receive (Transmitter::Channel chn, const char *str)
477 if (caller_is_ui_thread()) {
478 process_error_message (chn, str);
480 UIRequest* req = get_request (ErrorMessage);
487 req->msg = strdup (str);
493 #define OLD_STYLE_ERRORS 1
496 UI::process_error_message (Transmitter::Channel chn, const char *str)
499 RefPtr<TextBuffer::Tag> ptag;
500 RefPtr<TextBuffer::Tag> mtag;
503 bool fatal_received = false;
504 #ifndef OLD_STYLE_ERRORS
505 PopUp* popup = new PopUp (WIN_POS_CENTER, 0, true);
509 case Transmitter::Fatal:
510 prefix = "[FATAL]: ";
514 fatal_received = true;
516 case Transmitter::Error:
518 prefix = "[ERROR]: ";
523 popup->set_name ("ErrorMessage");
524 popup->set_text (str);
529 case Transmitter::Info:
536 popup->set_name ("InfoMessage");
537 popup->set_text (str);
543 case Transmitter::Warning:
545 prefix = "[WARNING]: ";
550 popup->set_name ("WarningMessage");
551 popup->set_text (str);
557 /* no choice but to use text/console output here */
558 cerr << "programmer error in UI::check_error_messages (channel = " << chn << ")\n";
562 errors->text().get_buffer()->begin_user_action();
564 if (fatal_received) {
568 display_message (prefix, prefix_len, ptag, mtag, str);
570 if (!errors->is_visible() && chn != Transmitter::Info) {
575 errors->text().get_buffer()->end_user_action();
581 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("toggle-log-window"));
586 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
595 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("toggle-log-window"));
600 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
602 if (tact->get_active()) {
603 errors->set_position (WIN_POS_MOUSE);
611 UI::display_message (const char *prefix, gint /*prefix_len*/, RefPtr<TextBuffer::Tag> ptag, RefPtr<TextBuffer::Tag> mtag, const char *msg)
613 RefPtr<TextBuffer> buffer (errors->text().get_buffer());
615 buffer->insert_with_tag(buffer->end(), prefix, ptag);
616 buffer->insert_with_tag(buffer->end(), msg, mtag);
617 buffer->insert_with_tag(buffer->end(), "\n", mtag);
619 errors->scroll_to_bottom ();
623 UI::handle_fatal (const char *message)
626 Label label (message);
627 Button quit (_("Press To Exit"));
630 win.set_default_size (400, 100);
632 WindowTitle title(Glib::get_application_name());
633 title += ": Fatal Error";
634 win.set_title (title.get_string());
636 win.set_position (WIN_POS_MOUSE);
637 win.set_border_width (12);
639 win.get_vbox()->pack_start (label, true, true);
640 hpacker.pack_start (quit, true, false);
641 win.get_vbox()->pack_start (hpacker, false, false);
643 quit.signal_clicked().connect(mem_fun(*this,&UI::quit));
646 win.set_modal (true);
654 UI::popup_error (const string& text)
656 if (!caller_is_ui_thread()) {
657 error << "non-UI threads can't use UI::popup_error"
662 MessageDialog msg (text);
663 msg.set_title (string_compose (_("I'm sorry %1, I can't do that"), g_get_user_name()));
664 msg.set_wmclass (X_("error"), name());
665 msg.set_position (WIN_POS_MOUSE);
672 if (!caller_is_ui_thread()) {
673 error << "non-UI threads cannot call UI::flush_pending()"
678 gtk_main_iteration();
680 while (gtk_events_pending()) {
681 gtk_main_iteration();
686 UI::just_hide_it (GdkEventAny */*ev*/, Window *win)
693 UI::get_color (const string& prompt, bool& picked, const Gdk::Color* initial)
697 ColorSelectionDialog color_dialog (prompt);
699 color_dialog.set_modal (true);
700 color_dialog.get_cancel_button()->signal_clicked().connect (bind (mem_fun (*this, &UI::color_selection_done), false));
701 color_dialog.get_ok_button()->signal_clicked().connect (bind (mem_fun (*this, &UI::color_selection_done), true));
702 color_dialog.signal_delete_event().connect (mem_fun (*this, &UI::color_selection_deleted));
705 color_dialog.get_colorsel()->set_current_color (*initial);
708 color_dialog.show_all ();
709 color_picked = false;
714 color_dialog.hide_all ();
717 Gdk::Color f_rgba = color_dialog.get_colorsel()->get_current_color ();
718 color.set_red(f_rgba.get_red());
719 color.set_green(f_rgba.get_green());
720 color.set_blue(f_rgba.get_blue());
729 UI::color_selection_done (bool status)
731 color_picked = status;
736 UI::color_selection_deleted (GdkEventAny */*ev*/)