libs/gtkmm2ext/gtk_ui.cc

   1 /*
   2     Copyright (C) 1999-2005 Paul Barton-Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18     $Id$
  19 */
  20
  21 #include <cmath>
  22 #include <fcntl.h>
  23 #include <signal.h>
  24 #include <unistd.h>
  25 #include <cerrno>
  26 #include <climits>
  27 #include <cctype>
  28
  29 #include <gtkmm.h>
  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/stacktrace.h>
  35
  36 #include <gtkmm2ext/gtk_ui.h>
  37 #include <gtkmm2ext/textviewer.h>
  38 #include <gtkmm2ext/popup.h>
  39 #include <gtkmm2ext/utils.h>
  40 #include <gtkmm2ext/window_title.h>
  41
  42 #include "i18n.h"
  43
  44 using namespace Gtkmm2ext;
  45 using namespace Gtk;
  46 using namespace Glib;
  47 using namespace PBD;
  48 using std::map;
  49
  50 pthread_t UI::gui_thread;
  51 UI       *UI::theGtkUI = 0;
  52
  53 BaseUI::RequestType Gtkmm2ext::ErrorMessage = BaseUI::new_request_type();
  54 BaseUI::RequestType Gtkmm2ext::Quit = BaseUI::new_request_type();
  55 BaseUI::RequestType Gtkmm2ext::TouchDisplay = BaseUI::new_request_type();
  56 BaseUI::RequestType Gtkmm2ext::StateChange = BaseUI::new_request_type();
  57 BaseUI::RequestType Gtkmm2ext::SetTip = BaseUI::new_request_type();
  58 BaseUI::RequestType Gtkmm2ext::AddIdle = BaseUI::new_request_type();
  59 BaseUI::RequestType Gtkmm2ext::AddTimeout = BaseUI::new_request_type();
  60
  61 #include <pbd/abstract_ui.cc>  /* instantiate the template */
  62
  63
  64 UI::UI (string namestr, int *argc, char ***argv)
  65         : AbstractUI<UIRequest> (namestr, true)
  66 {
  67         theMain = new Main (argc, argv);
  68         tips = new Tooltips;
  69
  70         _active = false;
  71
  72         if (!theGtkUI) {
  73                 theGtkUI = this;
  74                 gui_thread = pthread_self ();
  75         } else {
  76                 fatal << "duplicate UI requested" << endmsg;
  77                 /* NOTREACHED */
  78         }
  79
  80         /* add the pipe to the select/poll loop that GDK does */
  81
  82         gdk_input_add (signal_pipe[0],
  83                        GDK_INPUT_READ,
  84                        UI::signal_pipe_callback,
  85                        this);
  86
  87         errors = new TextViewer (850,100);
  88         errors->text().set_editable (false);
  89         errors->text().set_name ("ErrorText");
  90
  91         Glib::set_application_name(namestr);
  92
  93         WindowTitle title(Glib::get_application_name());
  94         title += _("Log");
  95         errors->set_title (title.get_string());
  96
  97         errors->dismiss_button().set_name ("ErrorLogCloseButton");
  98         errors->signal_delete_event().connect (bind (sigc::ptr_fun (just_hide_it), (Window *) errors));
  99
 100         register_thread (pthread_self(), X_("GUI"));
 101
 102         //load_rcfile (rcfile);
 103 }
 104
 105 UI::~UI ()
 106 {
 107 }
 108
 109
 110 bool
 111 UI::caller_is_ui_thread ()
 112 {
 113         return pthread_equal (gui_thread, pthread_self());
 114 }
 115
 116 int
 117 UI::load_rcfile (string path, bool themechange)
 118 {
 119         if (path.length() == 0) {
 120                 return -1;
 121         }
 122
 123         if (access (path.c_str(), R_OK)) {
 124                 error << "UI: couldn't find rc file \""
 125                       << path
 126                       << '"'
 127                       << endmsg;
 128                 return -1;
 129         }
 130
 131         RC rc (path.c_str());
 132         // RC::reset_styles (Gtk::Settings::get_default());
 133         gtk_rc_reset_styles (gtk_settings_get_default());
 134         theme_changed.emit();
 135
 136         if (themechange) {
 137                 return 0; //Don't continue on every time there is a theme change
 138         }
 139
 140         /* have to pack widgets into a toplevel window so that styles will stick */
 141
 142         Window temp_window (WINDOW_TOPLEVEL);
 143         HBox box;
 144         Label a_widget1;
 145         Label a_widget2;
 146         Label a_widget3;
 147         Label a_widget4;
 148         RefPtr<Gtk::Style> style;
 149         RefPtr<TextBuffer> buffer (errors->text().get_buffer());
 150
 151         box.pack_start (a_widget1);
 152         box.pack_start (a_widget2);
 153         box.pack_start (a_widget3);
 154         box.pack_start (a_widget4);
 155
 156         error_ptag = buffer->create_tag();
 157         error_mtag = buffer->create_tag();
 158         fatal_ptag = buffer->create_tag();
 159         fatal_mtag = buffer->create_tag();
 160         warning_ptag = buffer->create_tag();
 161         warning_mtag = buffer->create_tag();
 162         info_ptag = buffer->create_tag();
 163         info_mtag = buffer->create_tag();
 164
 165         a_widget1.set_name ("FatalMessage");
 166         a_widget1.ensure_style ();
 167         style = a_widget1.get_style();
 168
 169         fatal_ptag->property_font_desc().set_value(style->get_font());
 170         fatal_ptag->property_foreground_gdk().set_value(style->get_fg(STATE_ACTIVE));
 171         fatal_ptag->property_background_gdk().set_value(style->get_bg(STATE_ACTIVE));
 172         fatal_mtag->property_font_desc().set_value(style->get_font());
 173         fatal_mtag->property_foreground_gdk().set_value(style->get_fg(STATE_NORMAL));
 174         fatal_mtag->property_background_gdk().set_value(style->get_bg(STATE_NORMAL));
 175
 176         a_widget2.set_name ("ErrorMessage");
 177         a_widget2.ensure_style ();
 178         style = a_widget2.get_style();
 179
 180         error_ptag->property_font_desc().set_value(style->get_font());
 181         error_ptag->property_foreground_gdk().set_value(style->get_fg(STATE_ACTIVE));
 182         error_ptag->property_background_gdk().set_value(style->get_bg(STATE_ACTIVE));
 183         error_mtag->property_font_desc().set_value(style->get_font());
 184         error_mtag->property_foreground_gdk().set_value(style->get_fg(STATE_NORMAL));
 185         error_mtag->property_background_gdk().set_value(style->get_bg(STATE_NORMAL));
 186
 187         a_widget3.set_name ("WarningMessage");
 188         a_widget3.ensure_style ();
 189         style = a_widget3.get_style();
 190
 191         warning_ptag->property_font_desc().set_value(style->get_font());
 192         warning_ptag->property_foreground_gdk().set_value(style->get_fg(STATE_ACTIVE));
 193         warning_ptag->property_background_gdk().set_value(style->get_bg(STATE_ACTIVE));
 194         warning_mtag->property_font_desc().set_value(style->get_font());
 195         warning_mtag->property_foreground_gdk().set_value(style->get_fg(STATE_NORMAL));
 196         warning_mtag->property_background_gdk().set_value(style->get_bg(STATE_NORMAL));
 197
 198         a_widget4.set_name ("InfoMessage");
 199         a_widget4.ensure_style ();
 200         style = a_widget4.get_style();
 201
 202         info_ptag->property_font_desc().set_value(style->get_font());
 203         info_ptag->property_foreground_gdk().set_value(style->get_fg(STATE_ACTIVE));
 204         info_ptag->property_background_gdk().set_value(style->get_bg(STATE_ACTIVE));
 205         info_mtag->property_font_desc().set_value(style->get_font());
 206         info_mtag->property_foreground_gdk().set_value(style->get_fg(STATE_NORMAL));
 207         info_mtag->property_background_gdk().set_value(style->get_bg(STATE_NORMAL));
 208
 209         return 0;
 210 }
 211
 212 void
 213 UI::run (Receiver &old_receiver)
 214 {
 215         listen_to (error);
 216         listen_to (info);
 217         listen_to (warning);
 218         listen_to (fatal);
 219
 220         old_receiver.hangup ();
 221         starting ();
 222         _active = true;
 223         theMain->run ();
 224         _active = false;
 225         stopping ();
 226         hangup ();
 227         return;
 228 }
 229
 230 bool
 231 UI::running ()
 232 {
 233         return _active;
 234 }
 235
 236 void
 237 UI::kill ()
 238 {
 239         if (_active) {
 240                 pthread_kill (gui_thread, SIGKILL);
 241         }
 242 }
 243
 244 void
 245 UI::quit ()
 246 {
 247         UIRequest *req = get_request (Quit);
 248
 249         if (req == 0) {
 250                 return;
 251         }
 252
 253         send_request (req);
 254 }
 255
 256 static bool idle_quit ()
 257 {
 258         Main::quit ();
 259         return true;
 260 }
 261
 262 void
 263 UI::do_quit ()
 264 {
 265         if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
 266                 Main::quit ();
 267         } else {
 268                 Glib::signal_idle().connect (sigc::ptr_fun (idle_quit));
 269         }
 270 }
 271
 272 void
 273 UI::touch_display (Touchable *display)
 274 {
 275         UIRequest *req = get_request (TouchDisplay);
 276
 277         if (req == 0) {
 278                 return;
 279         }
 280
 281         req->display = display;
 282
 283         send_request (req);
 284 }
 285
 286 void
 287 UI::set_tip (Widget *w, const gchar *tip, const gchar *hlp)
 288 {
 289         UIRequest *req = get_request (SetTip);
 290
 291         if (req == 0) {
 292                 return;
 293         }
 294
 295         req->widget = w;
 296         req->msg = tip;
 297         req->msg2 = hlp;
 298
 299         send_request (req);
 300 }
 301
 302 void
 303 UI::set_state (Widget *w, StateType state)
 304 {
 305         UIRequest *req = get_request (StateChange);
 306
 307         if (req == 0) {
 308                 return;
 309         }
 310
 311         req->new_state = state;
 312         req->widget = w;
 313
 314         send_request (req);
 315 }
 316
 317 void
 318 UI::idle_add (int (*func)(void *), void *arg)
 319 {
 320         UIRequest *req = get_request (AddIdle);
 321
 322         if (req == 0) {
 323                 return;
 324         }
 325
 326         req->function = func;
 327         req->arg = arg;
 328
 329         send_request (req);
 330 }
 331
 332 /* END abstract_ui interfaces */
 333
 334 void
 335 UI::signal_pipe_callback (void *arg, int fd, GdkInputCondition cond)
 336 {
 337         char buf[256];
 338
 339         /* flush (nonblocking) pipe */
 340
 341         while (read (fd, buf, 256) > 0);
 342
 343         ((UI *) arg)->handle_ui_requests ();
 344 }
 345
 346 void
 347 UI::do_request (UIRequest* req)
 348 {
 349         if (req->type == ErrorMessage) {
 350
 351                 process_error_message (req->chn, req->msg);
 352                 free (const_cast<char*>(req->msg)); /* it was strdup'ed */
 353                 req->msg = 0; /* don't free it again in the destructor */
 354
 355         } else if (req->type == Quit) {
 356
 357                 do_quit ();
 358
 359         } else if (req->type == CallSlot) {
 360
 361                 req->slot ();
 362
 363         } else if (req->type == TouchDisplay) {
 364
 365                 req->display->touch ();
 366                 if (req->display->delete_after_touch()) {
 367                         delete req->display;
 368                 }
 369
 370         } else if (req->type == StateChange) {
 371
 372                 req->widget->set_state (req->new_state);
 373
 374         } else if (req->type == SetTip) {
 375
 376                 /* XXX need to figure out how this works */
 377
 378         } else {
 379
 380                 error << "GtkUI: unknown request type "
 381                       << (int) req->type
 382                       << endmsg;
 383         }
 384 }
 385
 386 /*======================================================================
 387   Error Display
 388   ======================================================================*/
 389
 390 void
 391 UI::receive (Transmitter::Channel chn, const char *str)
 392 {
 393         if (caller_is_ui_thread()) {
 394                 process_error_message (chn, str);
 395         } else {
 396                 UIRequest* req = get_request (ErrorMessage);
 397
 398                 if (req == 0) {
 399                         return;
 400                 }
 401
 402                 req->chn = chn;
 403                 req->msg = strdup (str);
 404
 405                 send_request (req);
 406         }
 407 }
 408
 409 #define OLD_STYLE_ERRORS 1
 410
 411 void
 412 UI::process_error_message (Transmitter::Channel chn, const char *str)
 413 {
 414         RefPtr<Style> style;
 415         RefPtr<TextBuffer::Tag> ptag;
 416         RefPtr<TextBuffer::Tag> mtag;
 417         const char *prefix;
 418         size_t prefix_len;
 419         bool fatal_received = false;
 420 #ifndef OLD_STYLE_ERRORS
 421         PopUp* popup = new PopUp (WIN_POS_CENTER, 0, true);
 422 #endif
 423
 424         switch (chn) {
 425         case Transmitter::Fatal:
 426                 prefix = "[FATAL]: ";
 427                 ptag = fatal_ptag;
 428                 mtag = fatal_mtag;
 429                 prefix_len = 9;
 430                 fatal_received = true;
 431                 break;
 432         case Transmitter::Error:
 433 #if OLD_STYLE_ERRORS
 434                 prefix = "[ERROR]: ";
 435                 ptag = error_ptag;
 436                 mtag = error_mtag;
 437                 prefix_len = 9;
 438 #else
 439                 popup->set_name ("ErrorMessage");
 440                 popup->set_text (str);
 441                 popup->touch ();
 442                 return;
 443 #endif
 444                 break;
 445         case Transmitter::Info:
 446 #if OLD_STYLE_ERRORS
 447                 prefix = "[INFO]: ";
 448                 ptag = info_ptag;
 449                 mtag = info_mtag;
 450                 prefix_len = 8;
 451 #else
 452                 popup->set_name ("InfoMessage");
 453                 popup->set_text (str);
 454                 popup->touch ();
 455                 return;
 456 #endif
 457
 458                 break;
 459         case Transmitter::Warning:
 460 #if OLD_STYLE_ERRORS
 461                 prefix = "[WARNING]: ";
 462                 ptag = warning_ptag;
 463                 mtag = warning_mtag;
 464                 prefix_len = 11;
 465 #else
 466                 popup->set_name ("WarningMessage");
 467                 popup->set_text (str);
 468                 popup->touch ();
 469                 return;
 470 #endif
 471                 break;
 472         default:
 473                 /* no choice but to use text/console output here */
 474                 cerr << "programmer error in UI::check_error_messages (channel = " << chn << ")\n";
 475                 ::exit (1);
 476         }
 477
 478         errors->text().get_buffer()->begin_user_action();
 479
 480         if (fatal_received) {
 481                 handle_fatal (str);
 482         } else {
 483
 484                 display_message (prefix, prefix_len, ptag, mtag, str);
 485
 486                 if (!errors->is_visible()) {
 487                         toggle_errors();
 488                 }
 489         }
 490
 491         errors->text().get_buffer()->end_user_action();
 492 }
 493
 494 void
 495 UI::toggle_errors ()
 496 {
 497         if (!errors->is_visible()) {
 498                 errors->set_position (WIN_POS_MOUSE);
 499                 errors->show ();
 500         } else {
 501                 errors->hide ();
 502         }
 503 }
 504
 505 void
 506 UI::display_message (const char *prefix, gint prefix_len, RefPtr<TextBuffer::Tag> ptag, RefPtr<TextBuffer::Tag> mtag, const char *msg)
 507 {
 508         RefPtr<TextBuffer> buffer (errors->text().get_buffer());
 509
 510         buffer->insert_with_tag(buffer->end(), prefix, ptag);
 511         buffer->insert_with_tag(buffer->end(), msg, mtag);
 512         buffer->insert_with_tag(buffer->end(), "\n", mtag);
 513
 514         errors->scroll_to_bottom ();
 515 }
 516
 517 void
 518 UI::handle_fatal (const char *message)
 519 {
 520         Window win (WINDOW_POPUP);
 521         VBox packer;
 522         Label label (message);
 523         Button quit (_("Press To Exit"));
 524
 525         win.set_default_size (400, 100);
 526
 527         string title;
 528         title = name();
 529         title += ": Fatal Error";
 530         win.set_title (title);
 531
 532         win.set_position (WIN_POS_MOUSE);
 533         win.add (packer);
 534
 535         packer.pack_start (label, true, true);
 536         packer.pack_start (quit, false, false);
 537         quit.signal_clicked().connect(mem_fun(*this,&UI::quit));
 538
 539         win.show_all ();
 540         win.set_modal (true);
 541
 542         theMain->run ();
 543
 544         exit (1);
 545 }
 546
 547 void
 548 UI::popup_error (const char *text)
 549 {
 550         PopUp *pup;
 551
 552         if (!caller_is_ui_thread()) {
 553                 error << "non-UI threads can't use UI::popup_error"
 554                       << endmsg;
 555                 return;
 556         }
 557
 558         pup = new PopUp (WIN_POS_MOUSE, 0, true);
 559         pup->set_text (text);
 560         pup->touch ();
 561 }
 562
 563 #ifdef GTKOSX
 564 extern "C" {
 565         int gdk_quartz_in_carbon_menu_event_handler ();
 566 }
 567 #endif
 568
 569 void
 570 UI::flush_pending ()
 571 {
 572 #ifdef GTKOSX
 573         /* as of february 11th 2008, gtk/osx has a problem in that mac menu events
 574            are handled using Carbon with an "internal" event handling system that
 575            doesn't pass things back to the glib/gtk main loop. this makes
 576            gtk_main_iteration() block if we call it while in a menu event handler
 577            because glib gets confused and thinks there are two threads running
 578            g_main_poll_func().
 579
 580            this hack (relies on code in gtk2_ardour/sync-menu.c) works
 581            around that.
 582         */
 583
 584         if (gdk_quartz_in_carbon_menu_event_handler()) {
 585                 return;
 586         }
 587 #endif
 588         if (!caller_is_ui_thread()) {
 589                 error << "non-UI threads cannot call UI::flush_pending()"
 590                       << endmsg;
 591                 return;
 592         }
 593
 594         gtk_main_iteration();
 595
 596         while (gtk_events_pending()) {
 597                 gtk_main_iteration();
 598         }
 599 }
 600
 601 bool
 602 UI::just_hide_it (GdkEventAny *ev, Window *win)
 603 {
 604         win->hide ();
 605         return true;
 606 }
 607
 608 Gdk::Color
 609 UI::get_color (const string& prompt, bool& picked, const Gdk::Color* initial)
 610 {
 611         Gdk::Color color;
 612
 613         ColorSelectionDialog color_dialog (prompt);
 614
 615         color_dialog.set_modal (true);
 616         color_dialog.get_cancel_button()->signal_clicked().connect (bind (mem_fun (*this, &UI::color_selection_done), false));
 617         color_dialog.get_ok_button()->signal_clicked().connect (bind (mem_fun (*this, &UI::color_selection_done), true));
 618         color_dialog.signal_delete_event().connect (mem_fun (*this, &UI::color_selection_deleted));
 619
 620         if (initial) {
 621                 color_dialog.get_colorsel()->set_current_color (*initial);
 622         }
 623
 624         color_dialog.show_all ();
 625         color_picked = false;
 626         picked = false;
 627
 628         Main::run();
 629
 630         color_dialog.hide_all ();
 631
 632         if (color_picked) {
 633                 Gdk::Color f_rgba = color_dialog.get_colorsel()->get_current_color ();
 634                 color.set_red(f_rgba.get_red());
 635                 color.set_green(f_rgba.get_green());
 636                 color.set_blue(f_rgba.get_blue());
 637
 638                 picked = true;
 639         }
 640
 641         return color;
 642 }
 643
 644 void
 645 UI::color_selection_done (bool status)
 646 {
 647         color_picked = status;
 648         Main::quit ();
 649 }
 650
 651 bool
 652 UI::color_selection_deleted (GdkEventAny *ev)
 653 {
 654         Main::quit ();
 655         return true;
 656 }