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/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"
50 using namespace Gtkmm2ext;
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();
66 #include "pbd/abstract_ui.cc" /* instantiate the template */
68 UI::UI (string namestr, int *argc, char ***argv)
69 : AbstractUI<UIRequest> (namestr)
73 theMain = new Main (argc, argv);
80 fatal << "duplicate UI requested" << endmsg;
84 /* the GUI event loop runs in the main thread of the app,
85 which is assumed to have called this.
88 run_loop_thread = Threads::Thread::self();
90 /* store "this" as the UI-for-thread of this thread, same argument
94 set_event_loop_for_thread (this);
96 /* attach our request source to the default main context */
98 request_channel.ios()->attach (MainContext::get_default());
100 errors = new TextViewer (800,600);
101 errors->text().set_editable (false);
102 errors->text().set_name ("ErrorText");
103 errors->signal_unmap().connect (sigc::bind (sigc::ptr_fun (&ActionManager::uncheck_toggleaction), X_("<Actions>/Editor/toggle-log-window")));
105 Glib::set_application_name(namestr);
107 WindowTitle title(Glib::get_application_name());
109 errors->set_title (title.get_string());
111 errors->dismiss_button().set_name ("ErrorLogCloseButton");
112 errors->signal_delete_event().connect (sigc::bind (sigc::ptr_fun (just_hide_it), (Window *) errors));
113 errors->set_type_hint (Gdk::WINDOW_TYPE_HINT_UTILITY);
115 //load_rcfile (rcfile);
117 /* instantiate the Application singleton */
119 Application::instance();
128 UI::caller_is_ui_thread ()
130 return Threads::Thread::self() == run_loop_thread;
134 UI::load_rcfile (string path, bool themechange)
136 /* Yes, pointers to Glib::RefPtr. If these are not kept around,
137 * a segfault somewhere deep in the wonderfully robust glib will result.
138 * This does not occur if wiget.get_style is used instead of rc.get_style below,
139 * except that doesn't actually work...
142 static Glib::RefPtr<Style>* fatal_style = 0;
143 static Glib::RefPtr<Style>* error_style = 0;
144 static Glib::RefPtr<Style>* warning_style = 0;
145 static Glib::RefPtr<Style>* info_style = 0;
147 if (path.length() == 0) {
151 if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
152 error << "UI: couldn't find rc file \""
159 RC rc (path.c_str());
160 //this is buggy in gtkmm for some reason, so use C
161 //RC::reset_styles (Gtk::Settings::get_default());
162 gtk_rc_reset_styles (gtk_settings_get_default());
164 theme_changed.emit();
167 return 0; //Don't continue on every time there is a theme change
170 /* have to pack widgets into a toplevel window so that styles will stick */
172 Window temp_window (WINDOW_TOPLEVEL);
173 temp_window.ensure_style ();
178 Label warning_widget;
180 RefPtr<Gtk::Style> style;
181 RefPtr<TextBuffer> buffer (errors->text().get_buffer());
183 box.pack_start (fatal_widget);
184 box.pack_start (error_widget);
185 box.pack_start (warning_widget);
186 box.pack_start (info_widget);
188 error_ptag = buffer->create_tag();
189 error_mtag = buffer->create_tag();
190 fatal_ptag = buffer->create_tag();
191 fatal_mtag = buffer->create_tag();
192 warning_ptag = buffer->create_tag();
193 warning_mtag = buffer->create_tag();
194 info_ptag = buffer->create_tag();
195 info_mtag = buffer->create_tag();
197 fatal_widget.set_name ("FatalMessage");
200 /* This next line and the similar ones below are sketchily
201 * guessed to fix #2885. I think maybe that problems occur
202 * because with gtk_rc_get_style (to quote its docs) "no
203 * refcount is added to the returned style". So I've switched
204 * this to use Glib::wrap with take_copy == true, which requires
205 * all the nasty casts and calls to plain-old-C GTK.
207 * At worst I think this causes a memory leak; at least it appears
210 * I could be wrong about any or all of the above.
212 fatal_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (fatal_widget.gobj())), true));
214 fatal_ptag->property_font_desc().set_value((*fatal_style)->get_font());
215 fatal_ptag->property_foreground_gdk().set_value((*fatal_style)->get_fg(STATE_ACTIVE));
216 fatal_ptag->property_background_gdk().set_value((*fatal_style)->get_bg(STATE_ACTIVE));
217 fatal_mtag->property_font_desc().set_value((*fatal_style)->get_font());
218 fatal_mtag->property_foreground_gdk().set_value((*fatal_style)->get_fg(STATE_NORMAL));
219 fatal_mtag->property_background_gdk().set_value((*fatal_style)->get_bg(STATE_NORMAL));
221 error_widget.set_name ("ErrorMessage");
223 error_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (error_widget.gobj())), true));
225 error_ptag->property_font_desc().set_value((*error_style)->get_font());
226 error_ptag->property_foreground_gdk().set_value((*error_style)->get_fg(STATE_ACTIVE));
227 error_ptag->property_background_gdk().set_value((*error_style)->get_bg(STATE_ACTIVE));
228 error_mtag->property_font_desc().set_value((*error_style)->get_font());
229 error_mtag->property_foreground_gdk().set_value((*error_style)->get_fg(STATE_NORMAL));
230 error_mtag->property_background_gdk().set_value((*error_style)->get_bg(STATE_NORMAL));
232 warning_widget.set_name ("WarningMessage");
233 delete warning_style;
234 warning_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (warning_widget.gobj())), true));
236 warning_ptag->property_font_desc().set_value((*warning_style)->get_font());
237 warning_ptag->property_foreground_gdk().set_value((*warning_style)->get_fg(STATE_ACTIVE));
238 warning_ptag->property_background_gdk().set_value((*warning_style)->get_bg(STATE_ACTIVE));
239 warning_mtag->property_font_desc().set_value((*warning_style)->get_font());
240 warning_mtag->property_foreground_gdk().set_value((*warning_style)->get_fg(STATE_NORMAL));
241 warning_mtag->property_background_gdk().set_value((*warning_style)->get_bg(STATE_NORMAL));
243 info_widget.set_name ("InfoMessage");
245 info_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (info_widget.gobj())), true));
247 info_ptag->property_font_desc().set_value((*info_style)->get_font());
248 info_ptag->property_foreground_gdk().set_value((*info_style)->get_fg(STATE_ACTIVE));
249 info_ptag->property_background_gdk().set_value((*info_style)->get_bg(STATE_ACTIVE));
250 info_mtag->property_font_desc().set_value((*info_style)->get_font());
251 info_mtag->property_foreground_gdk().set_value((*info_style)->get_fg(STATE_NORMAL));
252 info_mtag->property_background_gdk().set_value((*info_style)->get_bg(STATE_NORMAL));
258 UI::run (Receiver &old_receiver)
260 _receiver.listen_to (error);
261 _receiver.listen_to (info);
262 _receiver.listen_to (warning);
263 _receiver.listen_to (fatal);
265 /* stop the old receiver (text/console) once we hit the first idle */
267 Glib::signal_idle().connect (bind_return (mem_fun (old_receiver, &Receiver::hangup), false));
289 UIRequest *req = get_request (Quit);
298 static bool idle_quit ()
307 if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
310 Glib::signal_idle().connect (sigc::ptr_fun (idle_quit));
315 UI::touch_display (Touchable *display)
317 UIRequest *req = get_request (TouchDisplay);
323 req->display = display;
329 UI::set_tip (Widget &w, const gchar *tip)
331 set_tip(&w, tip, "");
335 UI::set_tip (Widget &w, const std::string& tip)
337 set_tip(&w, tip.c_str(), "");
341 UI::set_tip (Widget *w, const gchar *tip, const gchar *hlp)
343 UIRequest *req = get_request (SetTip);
345 std::string msg(tip);
347 Glib::RefPtr<Gtk::Action> action = w->get_action();
350 Gtkmm2ext::Activatable* activatable;
351 if ((activatable = dynamic_cast<Gtkmm2ext::Activatable*>(w))) {
352 action = activatable->get_related_action();
358 ustring ap = action->get_accel_path();
360 string shortcut = ActionManager::get_key_representation (ap, key);
361 if (!shortcut.empty()) {
362 replace_all (shortcut, "<", "");
363 replace_all (shortcut, ">", "-");
364 msg.append(_("\n\nShortcut: ")).append (shortcut);
375 req->msg = msg.c_str();
382 UI::set_state (Widget *w, StateType state)
384 UIRequest *req = get_request (StateChange);
390 req->new_state = state;
397 UI::idle_add (int (*func)(void *), void *arg)
399 UIRequest *req = get_request (AddIdle);
405 req->function = func;
411 /* END abstract_ui interfaces */
413 /** Create a PBD::EventLoop::InvalidationRecord and attach a callback
414 * to a given sigc::trackable so that PBD::EventLoop::invalidate_request
415 * is called when that trackable is destroyed.
417 PBD::EventLoop::InvalidationRecord*
418 __invalidator (sigc::trackable& trackable, const char* file, int line)
420 PBD::EventLoop::InvalidationRecord* ir = new PBD::EventLoop::InvalidationRecord;
425 trackable.add_destroy_notify_callback (ir, PBD::EventLoop::invalidate_request);
431 UI::do_request (UIRequest* req)
433 if (req->type == ErrorMessage) {
435 process_error_message (req->chn, req->msg);
436 free (const_cast<char*>(req->msg)); /* it was strdup'ed */
437 req->msg = 0; /* don't free it again in the destructor */
439 } else if (req->type == Quit) {
443 } else if (req->type == CallSlot) {
445 if (getenv ("DEBUG_THREADED_SIGNALS")) {
446 cerr << "call slot for " << name() << endl;
451 } else if (req->type == TouchDisplay) {
453 req->display->touch ();
454 if (req->display->delete_after_touch()) {
458 } else if (req->type == StateChange) {
460 req->widget->set_state (req->new_state);
462 } else if (req->type == SetTip) {
464 gtk_widget_set_tooltip_markup (req->widget->gobj(), req->msg);
468 error << "GtkUI: unknown request type "
474 /*======================================================================
476 ======================================================================*/
479 UI::receive (Transmitter::Channel chn, const char *str)
481 if (caller_is_ui_thread()) {
482 process_error_message (chn, str);
484 UIRequest* req = get_request (ErrorMessage);
491 req->msg = strdup (str);
497 #define OLD_STYLE_ERRORS 1
500 UI::process_error_message (Transmitter::Channel chn, const char *str)
503 RefPtr<TextBuffer::Tag> ptag;
504 RefPtr<TextBuffer::Tag> mtag;
507 bool fatal_received = false;
508 #ifndef OLD_STYLE_ERRORS
509 PopUp* popup = new PopUp (WIN_POS_CENTER, 0, true);
513 case Transmitter::Fatal:
514 prefix = "[FATAL]: ";
518 fatal_received = true;
520 case Transmitter::Error:
522 prefix = "[ERROR]: ";
527 popup->set_name ("ErrorMessage");
528 popup->set_text (str);
533 case Transmitter::Info:
540 popup->set_name ("InfoMessage");
541 popup->set_text (str);
547 case Transmitter::Warning:
549 prefix = "[WARNING]: ";
554 popup->set_name ("WarningMessage");
555 popup->set_text (str);
561 /* no choice but to use text/console output here */
562 cerr << "programmer error in UI::check_error_messages (channel = " << chn << ")\n";
566 errors->text().get_buffer()->begin_user_action();
568 if (fatal_received) {
572 if (!ptag || !mtag) {
573 /* oops, message sent before we set up tags - don't crash */
574 cerr << prefix << str << endl;
576 display_message (prefix, prefix_len, ptag, mtag, str);
578 if (!errors->is_visible() && chn != Transmitter::Info) {
584 errors->text().get_buffer()->end_user_action();
590 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("toggle-log-window"));
595 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
604 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("toggle-log-window"));
609 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
611 if (tact->get_active()) {
612 errors->set_position (WIN_POS_MOUSE);
620 UI::display_message (const char *prefix, gint /*prefix_len*/, RefPtr<TextBuffer::Tag> ptag, RefPtr<TextBuffer::Tag> mtag, const char *msg)
622 RefPtr<TextBuffer> buffer (errors->text().get_buffer());
624 buffer->insert_with_tag(buffer->end(), prefix, ptag);
625 buffer->insert_with_tag(buffer->end(), msg, mtag);
626 buffer->insert_with_tag(buffer->end(), "\n", mtag);
628 errors->scroll_to_bottom ();
632 UI::handle_fatal (const char *message)
635 Label label (message);
636 Button quit (_("Press To Exit"));
639 win.set_default_size (400, 100);
641 WindowTitle title(Glib::get_application_name());
642 title += ": Fatal Error";
643 win.set_title (title.get_string());
645 win.set_position (WIN_POS_MOUSE);
646 win.set_border_width (12);
648 win.get_vbox()->pack_start (label, true, true);
649 hpacker.pack_start (quit, true, false);
650 win.get_vbox()->pack_start (hpacker, false, false);
652 quit.signal_clicked().connect(mem_fun(*this,&UI::quit));
655 win.set_modal (true);
663 UI::popup_error (const string& text)
665 if (!caller_is_ui_thread()) {
666 error << "non-UI threads can't use UI::popup_error"
671 MessageDialog msg (text);
672 msg.set_title (string_compose (_("I'm sorry %1, I can't do that"), g_get_user_name()));
673 msg.set_wmclass (X_("error"), name());
674 msg.set_position (WIN_POS_MOUSE);
681 if (!caller_is_ui_thread()) {
682 error << "non-UI threads cannot call UI::flush_pending()"
687 gtk_main_iteration();
689 while (gtk_events_pending()) {
690 gtk_main_iteration();
695 UI::just_hide_it (GdkEventAny */*ev*/, Window *win)
702 UI::get_color (const string& prompt, bool& picked, const Gdk::Color* initial)
706 ColorSelectionDialog color_dialog (prompt);
708 color_dialog.set_modal (true);
709 color_dialog.get_cancel_button()->signal_clicked().connect (bind (mem_fun (*this, &UI::color_selection_done), false));
710 color_dialog.get_ok_button()->signal_clicked().connect (bind (mem_fun (*this, &UI::color_selection_done), true));
711 color_dialog.signal_delete_event().connect (mem_fun (*this, &UI::color_selection_deleted));
714 color_dialog.get_colorsel()->set_current_color (*initial);
717 color_dialog.show_all ();
718 color_picked = false;
723 color_dialog.hide_all ();
726 Gdk::Color f_rgba = color_dialog.get_colorsel()->get_current_color ();
727 color.set_red(f_rgba.get_red());
728 color.set_green(f_rgba.get_green());
729 color.set_blue(f_rgba.get_blue());
738 UI::color_selection_done (bool status)
740 color_picked = status;
745 UI::color_selection_deleted (GdkEventAny */*ev*/)