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 template class AbstractUI<Gtkmm2ext::UIRequest>;
70 UI::UI (string namestr, int *argc, char ***argv)
71 : AbstractUI<UIRequest> (namestr)
75 theMain = new Main (argc, argv);
82 fatal << "duplicate UI requested" << endmsg;
86 /* the GUI event loop runs in the main thread of the app,
87 which is assumed to have called this.
90 run_loop_thread = Threads::Thread::self();
92 /* store "this" as the UI-for-thread of this thread, same argument
96 set_event_loop_for_thread (this);
98 /* attach our request source to the default main context */
100 attach_request_source ();
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")));
107 Glib::set_application_name(namestr);
109 WindowTitle title(Glib::get_application_name());
111 errors->set_title (title.get_string());
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);
117 //load_rcfile (rcfile);
119 /* instantiate the Application singleton */
121 Application::instance();
130 UI::caller_is_ui_thread ()
132 return Threads::Thread::self() == run_loop_thread;
136 UI::load_rcfile (string path, bool themechange)
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...
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;
149 if (path.length() == 0) {
153 if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
154 error << "UI: couldn't find rc file \""
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());
166 theme_changed.emit();
169 return 0; //Don't continue on every time there is a theme change
172 /* have to pack widgets into a toplevel window so that styles will stick */
174 Window temp_window (WINDOW_TOPLEVEL);
175 temp_window.ensure_style ();
180 Label warning_widget;
182 RefPtr<Gtk::Style> style;
183 RefPtr<TextBuffer> buffer (errors->text().get_buffer());
185 box.pack_start (fatal_widget);
186 box.pack_start (error_widget);
187 box.pack_start (warning_widget);
188 box.pack_start (info_widget);
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();
199 fatal_widget.set_name ("FatalMessage");
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.
209 * At worst I think this causes a memory leak; at least it appears
212 * I could be wrong about any or all of the above.
214 fatal_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (fatal_widget.gobj())), true));
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));
223 error_widget.set_name ("ErrorMessage");
225 error_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (error_widget.gobj())), true));
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));
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));
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));
245 info_widget.set_name ("InfoMessage");
247 info_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (info_widget.gobj())), true));
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));
260 UI::run (Receiver &old_receiver)
262 _receiver.listen_to (error);
263 _receiver.listen_to (info);
264 _receiver.listen_to (warning);
265 _receiver.listen_to (fatal);
267 /* stop the old receiver (text/console) once we hit the first idle */
269 Glib::signal_idle().connect (bind_return (mem_fun (old_receiver, &Receiver::hangup), false));
291 UIRequest *req = get_request (Quit);
300 static bool idle_quit ()
309 if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
312 Glib::signal_idle().connect (sigc::ptr_fun (idle_quit));
317 UI::touch_display (Touchable *display)
319 UIRequest *req = get_request (TouchDisplay);
325 req->display = display;
331 UI::set_tip (Widget &w, const gchar *tip)
333 set_tip(&w, tip, "");
337 UI::set_tip (Widget &w, const std::string& tip)
339 set_tip(&w, tip.c_str(), "");
343 UI::set_tip (Widget *w, const gchar *tip, const gchar *hlp)
345 UIRequest *req = get_request (SetTip);
347 std::string msg(tip);
349 Glib::RefPtr<Gtk::Action> action = w->get_action();
352 Gtkmm2ext::Activatable* activatable;
353 if ((activatable = dynamic_cast<Gtkmm2ext::Activatable*>(w))) {
354 action = activatable->get_related_action();
360 ustring ap = action->get_accel_path();
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);
377 req->msg = msg.c_str();
384 UI::set_state (Widget *w, StateType state)
386 UIRequest *req = get_request (StateChange);
392 req->new_state = state;
399 UI::idle_add (int (*func)(void *), void *arg)
401 UIRequest *req = get_request (AddIdle);
407 req->function = func;
413 /* END abstract_ui interfaces */
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.
419 PBD::EventLoop::InvalidationRecord*
420 __invalidator (sigc::trackable& trackable, const char* file, int line)
422 PBD::EventLoop::InvalidationRecord* ir = new PBD::EventLoop::InvalidationRecord;
427 trackable.add_destroy_notify_callback (ir, PBD::EventLoop::invalidate_request);
433 UI::do_request (UIRequest* req)
435 if (req->type == ErrorMessage) {
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 */
441 } else if (req->type == Quit) {
445 } else if (req->type == CallSlot) {
447 if (getenv ("DEBUG_THREADED_SIGNALS")) {
448 cerr << "call slot for " << name() << endl;
453 } else if (req->type == TouchDisplay) {
455 req->display->touch ();
456 if (req->display->delete_after_touch()) {
460 } else if (req->type == StateChange) {
462 req->widget->set_state (req->new_state);
464 } else if (req->type == SetTip) {
466 gtk_widget_set_tooltip_markup (req->widget->gobj(), req->msg);
470 error << "GtkUI: unknown request type "
476 /*======================================================================
478 ======================================================================*/
481 UI::receive (Transmitter::Channel chn, const char *str)
483 if (caller_is_ui_thread()) {
484 process_error_message (chn, str);
486 UIRequest* req = get_request (ErrorMessage);
493 req->msg = strdup (str);
499 #define OLD_STYLE_ERRORS 1
502 UI::process_error_message (Transmitter::Channel chn, const char *str)
505 RefPtr<TextBuffer::Tag> ptag;
506 RefPtr<TextBuffer::Tag> mtag;
509 bool fatal_received = false;
510 #ifndef OLD_STYLE_ERRORS
511 PopUp* popup = new PopUp (WIN_POS_CENTER, 0, true);
515 case Transmitter::Fatal:
516 prefix = "[FATAL]: ";
520 fatal_received = true;
522 case Transmitter::Error:
524 prefix = "[ERROR]: ";
529 popup->set_name ("ErrorMessage");
530 popup->set_text (str);
535 case Transmitter::Info:
542 popup->set_name ("InfoMessage");
543 popup->set_text (str);
549 case Transmitter::Warning:
551 prefix = "[WARNING]: ";
556 popup->set_name ("WarningMessage");
557 popup->set_text (str);
563 /* no choice but to use text/console output here */
564 cerr << "programmer error in UI::check_error_messages (channel = " << chn << ")\n";
568 errors->text().get_buffer()->begin_user_action();
570 if (fatal_received) {
574 if (!ptag || !mtag) {
575 /* oops, message sent before we set up tags - don't crash */
576 cerr << prefix << str << endl;
578 display_message (prefix, prefix_len, ptag, mtag, str);
580 if (!errors->is_visible() && chn != Transmitter::Info) {
586 errors->text().get_buffer()->end_user_action();
592 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("toggle-log-window"));
597 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
606 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("toggle-log-window"));
611 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
613 if (tact->get_active()) {
614 errors->set_position (WIN_POS_MOUSE);
622 UI::display_message (const char *prefix, gint /*prefix_len*/, RefPtr<TextBuffer::Tag> ptag, RefPtr<TextBuffer::Tag> mtag, const char *msg)
624 RefPtr<TextBuffer> buffer (errors->text().get_buffer());
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);
630 errors->scroll_to_bottom ();
634 UI::handle_fatal (const char *message)
637 Label label (message);
638 Button quit (_("Press To Exit"));
641 win.set_default_size (400, 100);
643 WindowTitle title(Glib::get_application_name());
644 title += ": Fatal Error";
645 win.set_title (title.get_string());
647 win.set_position (WIN_POS_MOUSE);
648 win.set_border_width (12);
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);
654 quit.signal_clicked().connect(mem_fun(*this,&UI::quit));
657 win.set_modal (true);
665 UI::popup_error (const string& text)
667 if (!caller_is_ui_thread()) {
668 error << "non-UI threads can't use UI::popup_error"
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);
683 if (!caller_is_ui_thread()) {
684 error << "non-UI threads cannot call UI::flush_pending()"
689 gtk_main_iteration();
691 while (gtk_events_pending()) {
692 gtk_main_iteration();
697 UI::just_hide_it (GdkEventAny* /*ev*/, Window *win)
704 UI::get_color (const string& prompt, bool& picked, const Gdk::Color* initial)
708 ColorSelectionDialog color_dialog (prompt);
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));
716 color_dialog.get_colorsel()->set_current_color (*initial);
719 color_dialog.show_all ();
720 color_picked = false;
725 color_dialog.hide_all ();
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());
740 UI::color_selection_done (bool status)
742 color_picked = status;
747 UI::color_selection_deleted (GdkEventAny* /*ev*/)