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)
76 theMain = new Main (argc, argv);
83 fatal << "duplicate UI requested" << endmsg;
87 /* the GUI event loop runs in the main thread of the app,
88 which is assumed to have called this.
91 run_loop_thread = Threads::Thread::self();
93 /* store "this" as the UI-for-thread of this thread, same argument
97 set_event_loop_for_thread (this);
99 /* attach our request source to the default main context */
101 attach_request_source ();
103 errors = new TextViewer (800,600);
104 errors->text().set_editable (false);
105 errors->text().set_name ("ErrorText");
106 errors->signal_unmap().connect (sigc::bind (sigc::ptr_fun (&ActionManager::uncheck_toggleaction), X_("<Actions>/Editor/toggle-log-window")));
108 Glib::set_application_name(namestr);
110 WindowTitle title(Glib::get_application_name());
112 errors->set_title (title.get_string());
114 errors->dismiss_button().set_name ("ErrorLogCloseButton");
115 errors->signal_delete_event().connect (sigc::bind (sigc::ptr_fun (just_hide_it), (Window *) errors));
116 errors->set_type_hint (Gdk::WINDOW_TYPE_HINT_UTILITY);
118 //load_rcfile (rcfile);
120 /* instantiate the Application singleton */
122 Application::instance();
132 UI::caller_is_ui_thread ()
134 return Threads::Thread::self() == run_loop_thread;
138 UI::load_rcfile (string path, bool themechange)
140 /* Yes, pointers to Glib::RefPtr. If these are not kept around,
141 * a segfault somewhere deep in the wonderfully robust glib will result.
142 * This does not occur if wiget.get_style is used instead of rc.get_style below,
143 * except that doesn't actually work...
146 static Glib::RefPtr<Style>* fatal_style = 0;
147 static Glib::RefPtr<Style>* error_style = 0;
148 static Glib::RefPtr<Style>* warning_style = 0;
149 static Glib::RefPtr<Style>* info_style = 0;
151 if (path.length() == 0) {
155 if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
156 error << "UI: couldn't find rc file \""
163 RC rc (path.c_str());
164 //this is buggy in gtkmm for some reason, so use C
165 //RC::reset_styles (Gtk::Settings::get_default());
166 gtk_rc_reset_styles (gtk_settings_get_default());
168 theme_changed.emit();
171 return 0; //Don't continue on every time there is a theme change
174 /* have to pack widgets into a toplevel window so that styles will stick */
176 Window temp_window (WINDOW_TOPLEVEL);
177 temp_window.ensure_style ();
182 Label warning_widget;
184 RefPtr<Gtk::Style> style;
185 RefPtr<TextBuffer> buffer (errors->text().get_buffer());
187 box.pack_start (fatal_widget);
188 box.pack_start (error_widget);
189 box.pack_start (warning_widget);
190 box.pack_start (info_widget);
192 error_ptag = buffer->create_tag();
193 error_mtag = buffer->create_tag();
194 fatal_ptag = buffer->create_tag();
195 fatal_mtag = buffer->create_tag();
196 warning_ptag = buffer->create_tag();
197 warning_mtag = buffer->create_tag();
198 info_ptag = buffer->create_tag();
199 info_mtag = buffer->create_tag();
201 fatal_widget.set_name ("FatalMessage");
204 /* This next line and the similar ones below are sketchily
205 * guessed to fix #2885. I think maybe that problems occur
206 * because with gtk_rc_get_style (to quote its docs) "no
207 * refcount is added to the returned style". So I've switched
208 * this to use Glib::wrap with take_copy == true, which requires
209 * all the nasty casts and calls to plain-old-C GTK.
211 * At worst I think this causes a memory leak; at least it appears
214 * I could be wrong about any or all of the above.
216 fatal_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (fatal_widget.gobj())), true));
218 fatal_ptag->property_font_desc().set_value((*fatal_style)->get_font());
219 fatal_ptag->property_foreground_gdk().set_value((*fatal_style)->get_fg(STATE_ACTIVE));
220 fatal_ptag->property_background_gdk().set_value((*fatal_style)->get_bg(STATE_ACTIVE));
221 fatal_mtag->property_font_desc().set_value((*fatal_style)->get_font());
222 fatal_mtag->property_foreground_gdk().set_value((*fatal_style)->get_fg(STATE_NORMAL));
223 fatal_mtag->property_background_gdk().set_value((*fatal_style)->get_bg(STATE_NORMAL));
225 error_widget.set_name ("ErrorMessage");
227 error_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (error_widget.gobj())), true));
229 error_ptag->property_font_desc().set_value((*error_style)->get_font());
230 error_ptag->property_foreground_gdk().set_value((*error_style)->get_fg(STATE_ACTIVE));
231 error_ptag->property_background_gdk().set_value((*error_style)->get_bg(STATE_ACTIVE));
232 error_mtag->property_font_desc().set_value((*error_style)->get_font());
233 error_mtag->property_foreground_gdk().set_value((*error_style)->get_fg(STATE_NORMAL));
234 error_mtag->property_background_gdk().set_value((*error_style)->get_bg(STATE_NORMAL));
236 warning_widget.set_name ("WarningMessage");
237 delete warning_style;
238 warning_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (warning_widget.gobj())), true));
240 warning_ptag->property_font_desc().set_value((*warning_style)->get_font());
241 warning_ptag->property_foreground_gdk().set_value((*warning_style)->get_fg(STATE_ACTIVE));
242 warning_ptag->property_background_gdk().set_value((*warning_style)->get_bg(STATE_ACTIVE));
243 warning_mtag->property_font_desc().set_value((*warning_style)->get_font());
244 warning_mtag->property_foreground_gdk().set_value((*warning_style)->get_fg(STATE_NORMAL));
245 warning_mtag->property_background_gdk().set_value((*warning_style)->get_bg(STATE_NORMAL));
247 info_widget.set_name ("InfoMessage");
249 info_style = new Glib::RefPtr<Style> (Glib::wrap (gtk_rc_get_style (reinterpret_cast<GtkWidget*> (info_widget.gobj())), true));
251 info_ptag->property_font_desc().set_value((*info_style)->get_font());
252 info_ptag->property_foreground_gdk().set_value((*info_style)->get_fg(STATE_ACTIVE));
253 info_ptag->property_background_gdk().set_value((*info_style)->get_bg(STATE_ACTIVE));
254 info_mtag->property_font_desc().set_value((*info_style)->get_font());
255 info_mtag->property_foreground_gdk().set_value((*info_style)->get_fg(STATE_NORMAL));
256 info_mtag->property_background_gdk().set_value((*info_style)->get_bg(STATE_NORMAL));
262 UI::run (Receiver &old_receiver)
264 _receiver.listen_to (error);
265 _receiver.listen_to (info);
266 _receiver.listen_to (warning);
267 _receiver.listen_to (fatal);
269 /* stop the old receiver (text/console) once we hit the first idle */
271 Glib::signal_idle().connect (bind_return (mem_fun (old_receiver, &Receiver::hangup), false));
293 UIRequest *req = get_request (Quit);
302 static bool idle_quit ()
311 if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
314 Glib::signal_idle().connect (sigc::ptr_fun (idle_quit));
319 UI::touch_display (Touchable *display)
321 UIRequest *req = get_request (TouchDisplay);
327 req->display = display;
333 UI::set_tip (Widget &w, const gchar *tip)
335 set_tip(&w, tip, "");
339 UI::set_tip (Widget &w, const std::string& tip)
341 set_tip(&w, tip.c_str(), "");
345 UI::set_tip (Widget *w, const gchar *tip, const gchar *hlp)
347 UIRequest *req = get_request (SetTip);
349 std::string msg(tip);
351 Glib::RefPtr<Gtk::Action> action = w->get_action();
354 Gtkmm2ext::Activatable* activatable;
355 if ((activatable = dynamic_cast<Gtkmm2ext::Activatable*>(w))) {
356 action = activatable->get_related_action();
362 ustring ap = action->get_accel_path();
364 string shortcut = ActionManager::get_key_representation (ap, key);
365 if (!shortcut.empty()) {
366 replace_all (shortcut, "<", "");
367 replace_all (shortcut, ">", "-");
368 msg.append(_("\n\nShortcut: ")).append (shortcut);
379 req->msg = msg.c_str();
386 UI::set_state (Widget *w, StateType state)
388 UIRequest *req = get_request (StateChange);
394 req->new_state = state;
401 UI::idle_add (int (*func)(void *), void *arg)
403 UIRequest *req = get_request (AddIdle);
409 req->function = func;
415 /* END abstract_ui interfaces */
417 /** Create a PBD::EventLoop::InvalidationRecord and attach a callback
418 * to a given sigc::trackable so that PBD::EventLoop::invalidate_request
419 * is called when that trackable is destroyed.
421 PBD::EventLoop::InvalidationRecord*
422 __invalidator (sigc::trackable& trackable, const char* file, int line)
424 PBD::EventLoop::InvalidationRecord* ir = new PBD::EventLoop::InvalidationRecord;
429 trackable.add_destroy_notify_callback (ir, PBD::EventLoop::invalidate_request);
435 UI::do_request (UIRequest* req)
437 if (req->type == ErrorMessage) {
439 process_error_message (req->chn, req->msg);
440 free (const_cast<char*>(req->msg)); /* it was strdup'ed */
441 req->msg = 0; /* don't free it again in the destructor */
443 } else if (req->type == Quit) {
447 } else if (req->type == CallSlot) {
449 if (getenv ("DEBUG_THREADED_SIGNALS")) {
450 cerr << "call slot for " << name() << endl;
455 } else if (req->type == TouchDisplay) {
457 req->display->touch ();
458 if (req->display->delete_after_touch()) {
462 } else if (req->type == StateChange) {
464 req->widget->set_state (req->new_state);
466 } else if (req->type == SetTip) {
468 gtk_widget_set_tooltip_markup (req->widget->gobj(), req->msg);
472 error << "GtkUI: unknown request type "
478 /*======================================================================
480 ======================================================================*/
483 UI::receive (Transmitter::Channel chn, const char *str)
485 if (caller_is_ui_thread()) {
486 process_error_message (chn, str);
488 UIRequest* req = get_request (ErrorMessage);
495 req->msg = strdup (str);
501 #define OLD_STYLE_ERRORS 1
504 UI::process_error_message (Transmitter::Channel chn, const char *str)
507 RefPtr<TextBuffer::Tag> ptag;
508 RefPtr<TextBuffer::Tag> mtag;
511 bool fatal_received = false;
512 #ifndef OLD_STYLE_ERRORS
513 PopUp* popup = new PopUp (WIN_POS_CENTER, 0, true);
517 case Transmitter::Fatal:
518 prefix = "[FATAL]: ";
522 fatal_received = true;
524 case Transmitter::Error:
526 prefix = "[ERROR]: ";
531 popup->set_name ("ErrorMessage");
532 popup->set_text (str);
537 case Transmitter::Info:
544 popup->set_name ("InfoMessage");
545 popup->set_text (str);
551 case Transmitter::Warning:
553 prefix = "[WARNING]: ";
558 popup->set_name ("WarningMessage");
559 popup->set_text (str);
565 /* no choice but to use text/console output here */
566 cerr << "programmer error in UI::check_error_messages (channel = " << chn << ")\n";
570 errors->text().get_buffer()->begin_user_action();
572 if (fatal_received) {
576 if (!ptag || !mtag) {
577 /* oops, message sent before we set up tags - don't crash */
578 cerr << prefix << str << endl;
580 display_message (prefix, prefix_len, ptag, mtag, str);
582 if (!errors->is_visible() && chn != Transmitter::Info) {
588 errors->text().get_buffer()->end_user_action();
594 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("toggle-log-window"));
599 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
608 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("toggle-log-window"));
613 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
615 if (tact->get_active()) {
616 errors->set_position (WIN_POS_MOUSE);
624 UI::display_message (const char *prefix, gint /*prefix_len*/, RefPtr<TextBuffer::Tag> ptag, RefPtr<TextBuffer::Tag> mtag, const char *msg)
626 RefPtr<TextBuffer> buffer (errors->text().get_buffer());
628 buffer->insert_with_tag(buffer->end(), prefix, ptag);
629 buffer->insert_with_tag(buffer->end(), msg, mtag);
630 buffer->insert_with_tag(buffer->end(), "\n", mtag);
632 errors->scroll_to_bottom ();
636 UI::handle_fatal (const char *message)
639 Label label (message);
640 Button quit (_("Press To Exit"));
643 win.set_default_size (400, 100);
645 WindowTitle title(Glib::get_application_name());
646 title += ": Fatal Error";
647 win.set_title (title.get_string());
649 win.set_position (WIN_POS_MOUSE);
650 win.set_border_width (12);
652 win.get_vbox()->pack_start (label, true, true);
653 hpacker.pack_start (quit, true, false);
654 win.get_vbox()->pack_start (hpacker, false, false);
656 quit.signal_clicked().connect(mem_fun(*this,&UI::quit));
659 win.set_modal (true);
667 UI::popup_error (const string& text)
669 if (!caller_is_ui_thread()) {
670 error << "non-UI threads can't use UI::popup_error"
675 MessageDialog msg (text);
676 msg.set_title (string_compose (_("I'm sorry %1, I can't do that"), g_get_user_name()));
677 msg.set_wmclass (X_("error"), name());
678 msg.set_position (WIN_POS_MOUSE);
685 if (!caller_is_ui_thread()) {
686 error << "non-UI threads cannot call UI::flush_pending()"
691 gtk_main_iteration();
693 while (gtk_events_pending()) {
694 gtk_main_iteration();
699 UI::just_hide_it (GdkEventAny* /*ev*/, Window *win)
706 UI::get_color (const string& prompt, bool& picked, const Gdk::Color* initial)
710 ColorSelectionDialog color_dialog (prompt);
712 color_dialog.set_modal (true);
713 color_dialog.get_cancel_button()->signal_clicked().connect (bind (mem_fun (*this, &UI::color_selection_done), false));
714 color_dialog.get_ok_button()->signal_clicked().connect (bind (mem_fun (*this, &UI::color_selection_done), true));
715 color_dialog.signal_delete_event().connect (mem_fun (*this, &UI::color_selection_deleted));
718 color_dialog.get_colorsel()->set_current_color (*initial);
721 color_dialog.show_all ();
722 color_picked = false;
727 color_dialog.hide_all ();
730 Gdk::Color f_rgba = color_dialog.get_colorsel()->get_current_color ();
731 color.set_red(f_rgba.get_red());
732 color.set_green(f_rgba.get_green());
733 color.set_blue(f_rgba.get_blue());
742 UI::color_selection_done (bool status)
744 color_picked = status;
749 UI::color_selection_deleted (GdkEventAny* /*ev*/)