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)
 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
 133         /* have to pack widgets into a toplevel window so that styles will stick */
 134
 135         Window temp_window (WINDOW_TOPLEVEL);
 136         HBox box;
 137         Label a_widget1;
 138         Label a_widget2;
 139         Label a_widget3;
 140         Label a_widget4;
 141         RefPtr<Gtk::Style> style;
 142         RefPtr<TextBuffer> buffer (errors->text().get_buffer());
 143
 144         box.pack_start (a_widget1);
 145         box.pack_start (a_widget2);
 146         box.pack_start (a_widget3);
 147         box.pack_start (a_widget4);
 148
 149         error_ptag = buffer->create_tag();
 150         error_mtag = buffer->create_tag();
 151         fatal_ptag = buffer->create_tag();
 152         fatal_mtag = buffer->create_tag();
 153         warning_ptag = buffer->create_tag();
 154         warning_mtag = buffer->create_tag();
 155         info_ptag = buffer->create_tag();
 156         info_mtag = buffer->create_tag();
 157
 158         a_widget1.set_name ("FatalMessage");
 159         a_widget1.ensure_style ();
 160         style = a_widget1.get_style();
 161
 162         fatal_ptag->property_font_desc().set_value(style->get_font());
 163         fatal_ptag->property_foreground_gdk().set_value(style->get_fg(STATE_ACTIVE));
 164         fatal_ptag->property_background_gdk().set_value(style->get_bg(STATE_ACTIVE));
 165         fatal_mtag->property_font_desc().set_value(style->get_font());
 166         fatal_mtag->property_foreground_gdk().set_value(style->get_fg(STATE_NORMAL));
 167         fatal_mtag->property_background_gdk().set_value(style->get_bg(STATE_NORMAL));
 168
 169         a_widget2.set_name ("ErrorMessage");
 170         a_widget2.ensure_style ();
 171         style = a_widget2.get_style();
 172
 173         error_ptag->property_font_desc().set_value(style->get_font());
 174         error_ptag->property_foreground_gdk().set_value(style->get_fg(STATE_ACTIVE));
 175         error_ptag->property_background_gdk().set_value(style->get_bg(STATE_ACTIVE));
 176         error_mtag->property_font_desc().set_value(style->get_font());
 177         error_mtag->property_foreground_gdk().set_value(style->get_fg(STATE_NORMAL));
 178         error_mtag->property_background_gdk().set_value(style->get_bg(STATE_NORMAL));
 179
 180         a_widget3.set_name ("WarningMessage");
 181         a_widget3.ensure_style ();
 182         style = a_widget3.get_style();
 183
 184         warning_ptag->property_font_desc().set_value(style->get_font());
 185         warning_ptag->property_foreground_gdk().set_value(style->get_fg(STATE_ACTIVE));
 186         warning_ptag->property_background_gdk().set_value(style->get_bg(STATE_ACTIVE));
 187         warning_mtag->property_font_desc().set_value(style->get_font());
 188         warning_mtag->property_foreground_gdk().set_value(style->get_fg(STATE_NORMAL));
 189         warning_mtag->property_background_gdk().set_value(style->get_bg(STATE_NORMAL));
 190
 191         a_widget4.set_name ("InfoMessage");
 192         a_widget4.ensure_style ();
 193         style = a_widget4.get_style();
 194
 195         info_ptag->property_font_desc().set_value(style->get_font());
 196         info_ptag->property_foreground_gdk().set_value(style->get_fg(STATE_ACTIVE));
 197         info_ptag->property_background_gdk().set_value(style->get_bg(STATE_ACTIVE));
 198         info_mtag->property_font_desc().set_value(style->get_font());
 199         info_mtag->property_foreground_gdk().set_value(style->get_fg(STATE_NORMAL));
 200         info_mtag->property_background_gdk().set_value(style->get_bg(STATE_NORMAL));
 201
 202
 203         RC::reset_styles(Gtk::Settings::get_default());
 204
 205         theme_changed.emit();
 206
 207         return 0;
 208 }
 209
 210 void
 211 UI::run (Receiver &old_receiver)
 212 {
 213         listen_to (error);
 214         listen_to (info);
 215         listen_to (warning);
 216         listen_to (fatal);
 217
 218         old_receiver.hangup ();
 219         starting ();
 220         _active = true;
 221         theMain->run ();
 222         _active = false;
 223         stopping ();
 224         hangup ();
 225         return;
 226 }
 227
 228 bool
 229 UI::running ()
 230 {
 231         return _active;
 232 }
 233
 234 void
 235 UI::kill ()
 236 {
 237         if (_active) {
 238                 pthread_kill (gui_thread, SIGKILL);
 239         }
 240 }
 241
 242 void
 243 UI::quit ()
 244 {
 245         UIRequest *req = get_request (Quit);
 246
 247         if (req == 0) {
 248                 return;
 249         }
 250
 251         send_request (req);
 252 }
 253
 254 static bool idle_quit ()
 255 {
 256         Main::quit ();
 257         return true;
 258 }
 259
 260 void
 261 UI::do_quit ()
 262 {
 263         if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
 264                 Main::quit ();
 265         } else {
 266                 Glib::signal_idle().connect (sigc::ptr_fun (idle_quit));
 267         }
 268 }
 269
 270 void
 271 UI::touch_display (Touchable *display)
 272 {
 273         UIRequest *req = get_request (TouchDisplay);
 274
 275         if (req == 0) {
 276                 return;
 277         }
 278
 279         req->display = display;
 280
 281         send_request (req);
 282 }
 283
 284 void
 285 UI::set_tip (Widget *w, const gchar *tip, const gchar *hlp)
 286 {
 287         UIRequest *req = get_request (SetTip);
 288
 289         if (req == 0) {
 290                 return;
 291         }
 292
 293         req->widget = w;
 294         req->msg = tip;
 295         req->msg2 = hlp;
 296
 297         send_request (req);
 298 }
 299
 300 void
 301 UI::set_state (Widget *w, StateType state)
 302 {
 303         UIRequest *req = get_request (StateChange);
 304
 305         if (req == 0) {
 306                 return;
 307         }
 308
 309         req->new_state = state;
 310         req->widget = w;
 311
 312         send_request (req);
 313 }
 314
 315 void
 316 UI::idle_add (int (*func)(void *), void *arg)
 317 {
 318         UIRequest *req = get_request (AddIdle);
 319
 320         if (req == 0) {
 321                 return;
 322         }
 323
 324         req->function = func;
 325         req->arg = arg;
 326
 327         send_request (req);
 328 }
 329
 330 /* END abstract_ui interfaces */
 331
 332 void
 333 UI::signal_pipe_callback (void *arg, int fd, GdkInputCondition cond)
 334 {
 335         char buf[256];
 336
 337         /* flush (nonblocking) pipe */
 338
 339         while (read (fd, buf, 256) > 0);
 340
 341         ((UI *) arg)->handle_ui_requests ();
 342 }
 343
 344 void
 345 UI::do_request (UIRequest* req)
 346 {
 347         if (req->type == ErrorMessage) {
 348
 349                 process_error_message (req->chn, req->msg);
 350                 free (const_cast<char*>(req->msg)); /* it was strdup'ed */
 351                 req->msg = 0; /* don't free it again in the destructor */
 352
 353         } else if (req->type == Quit) {
 354
 355                 do_quit ();
 356
 357         } else if (req->type == CallSlot) {
 358
 359                 req->slot ();
 360
 361         } else if (req->type == TouchDisplay) {
 362
 363                 req->display->touch ();
 364                 if (req->display->delete_after_touch()) {
 365                         delete req->display;
 366                 }
 367
 368         } else if (req->type == StateChange) {
 369
 370                 req->widget->set_state (req->new_state);
 371
 372         } else if (req->type == SetTip) {
 373
 374                 /* XXX need to figure out how this works */
 375
 376         } else {
 377
 378                 error << "GtkUI: unknown request type "
 379                       << (int) req->type
 380                       << endmsg;
 381         }
 382 }
 383
 384 /*======================================================================
 385   Error Display
 386   ======================================================================*/
 387
 388 void
 389 UI::receive (Transmitter::Channel chn, const char *str)
 390 {
 391         if (caller_is_ui_thread()) {
 392                 process_error_message (chn, str);
 393         } else {
 394                 UIRequest* req = get_request (ErrorMessage);
 395
 396                 if (req == 0) {
 397                         return;
 398                 }
 399
 400                 req->chn = chn;
 401                 req->msg = strdup (str);
 402
 403                 send_request (req);
 404         }
 405 }
 406
 407 #define OLD_STYLE_ERRORS 1
 408
 409 void
 410 UI::process_error_message (Transmitter::Channel chn, const char *str)
 411 {
 412         RefPtr<Style> style;
 413         RefPtr<TextBuffer::Tag> ptag;
 414         RefPtr<TextBuffer::Tag> mtag;
 415         char *prefix;
 416         size_t prefix_len;
 417         bool fatal_received = false;
 418 #ifndef OLD_STYLE_ERRORS
 419         PopUp* popup = new PopUp (WIN_POS_CENTER, 0, true);
 420 #endif
 421
 422         switch (chn) {
 423         case Transmitter::Fatal:
 424                 prefix = "[FATAL]: ";
 425                 ptag = fatal_ptag;
 426                 mtag = fatal_mtag;
 427                 prefix_len = 9;
 428                 fatal_received = true;
 429                 break;
 430         case Transmitter::Error:
 431 #if OLD_STYLE_ERRORS
 432                 prefix = "[ERROR]: ";
 433                 ptag = error_ptag;
 434                 mtag = error_mtag;
 435                 prefix_len = 9;
 436 #else
 437                 popup->set_name ("ErrorMessage");
 438                 popup->set_text (str);
 439                 popup->touch ();
 440                 return;
 441 #endif
 442                 break;
 443         case Transmitter::Info:
 444 #if OLD_STYLE_ERRORS
 445                 prefix = "[INFO]: ";
 446                 ptag = info_ptag;
 447                 mtag = info_mtag;
 448                 prefix_len = 8;
 449 #else
 450                 popup->set_name ("InfoMessage");
 451                 popup->set_text (str);
 452                 popup->touch ();
 453                 return;
 454 #endif
 455
 456                 break;
 457         case Transmitter::Warning:
 458 #if OLD_STYLE_ERRORS
 459                 prefix = "[WARNING]: ";
 460                 ptag = warning_ptag;
 461                 mtag = warning_mtag;
 462                 prefix_len = 11;
 463 #else
 464                 popup->set_name ("WarningMessage");
 465                 popup->set_text (str);
 466                 popup->touch ();
 467                 return;
 468 #endif
 469                 break;
 470         default:
 471                 /* no choice but to use text/console output here */
 472                 cerr << "programmer error in UI::check_error_messages (channel = " << chn << ")\n";
 473                 ::exit (1);
 474         }
 475
 476         errors->text().get_buffer()->begin_user_action();
 477
 478         if (fatal_received) {
 479                 handle_fatal (str);
 480         } else {
 481
 482                 display_message (prefix, prefix_len, ptag, mtag, str);
 483
 484                 if (!errors->is_visible()) {
 485                         toggle_errors();
 486                 }
 487         }
 488
 489         errors->text().get_buffer()->end_user_action();
 490 }
 491
 492 void
 493 UI::toggle_errors ()
 494 {
 495         if (!errors->is_visible()) {
 496                 errors->set_position (WIN_POS_MOUSE);
 497                 errors->show ();
 498         } else {
 499                 errors->hide ();
 500         }
 501 }
 502
 503 void
 504 UI::display_message (const char *prefix, gint prefix_len, RefPtr<TextBuffer::Tag> ptag, RefPtr<TextBuffer::Tag> mtag, const char *msg)
 505 {
 506         RefPtr<TextBuffer> buffer (errors->text().get_buffer());
 507
 508         buffer->insert_with_tag(buffer->end(), prefix, ptag);
 509         buffer->insert_with_tag(buffer->end(), msg, mtag);
 510         buffer->insert_with_tag(buffer->end(), "\n", mtag);
 511
 512         errors->scroll_to_bottom ();
 513 }
 514
 515 void
 516 UI::handle_fatal (const char *message)
 517 {
 518         Window win (WINDOW_POPUP);
 519         VBox packer;
 520         Label label (message);
 521         Button quit (_("Press To Exit"));
 522
 523         win.set_default_size (400, 100);
 524
 525         string title;
 526         title = name();
 527         title += ": Fatal Error";
 528         win.set_title (title);
 529
 530         win.set_position (WIN_POS_MOUSE);
 531         win.add (packer);
 532
 533         packer.pack_start (label, true, true);
 534         packer.pack_start (quit, false, false);
 535         quit.signal_clicked().connect(mem_fun(*this,&UI::quit));
 536
 537         win.show_all ();
 538         win.set_modal (true);
 539
 540         theMain->run ();
 541
 542         exit (1);
 543 }
 544
 545 void
 546 UI::popup_error (const char *text)
 547 {
 548         PopUp *pup;
 549
 550         if (!caller_is_ui_thread()) {
 551                 error << "non-UI threads can't use UI::popup_error"
 552                       << endmsg;
 553                 return;
 554         }
 555
 556         pup = new PopUp (WIN_POS_MOUSE, 0, true);
 557         pup->set_text (text);
 558         pup->touch ();
 559 }
 560
 561
 562 void
 563 UI::flush_pending ()
 564 {
 565         if (!caller_is_ui_thread()) {
 566                 error << "non-UI threads cannot call UI::flush_pending()"
 567                       << endmsg;
 568                 return;
 569         }
 570
 571         gtk_main_iteration();
 572
 573         while (gtk_events_pending()) {
 574                 gtk_main_iteration();
 575         }
 576 }
 577
 578 bool
 579 UI::just_hide_it (GdkEventAny *ev, Window *win)
 580 {
 581         win->hide_all ();
 582         return true;
 583 }
 584
 585 Gdk::Color
 586 UI::get_color (const string& prompt, bool& picked, const Gdk::Color* initial)
 587 {
 588         Gdk::Color color;
 589
 590         ColorSelectionDialog color_dialog (prompt);
 591
 592         color_dialog.set_modal (true);
 593         color_dialog.get_cancel_button()->signal_clicked().connect (bind (mem_fun (*this, &UI::color_selection_done), false));
 594         color_dialog.get_ok_button()->signal_clicked().connect (bind (mem_fun (*this, &UI::color_selection_done), true));
 595         color_dialog.signal_delete_event().connect (mem_fun (*this, &UI::color_selection_deleted));
 596
 597         if (initial) {
 598                 color_dialog.get_colorsel()->set_current_color (*initial);
 599         }
 600
 601         color_dialog.show_all ();
 602         color_picked = false;
 603         picked = false;
 604
 605         Main::run();
 606
 607         color_dialog.hide_all ();
 608
 609         if (color_picked) {
 610                 Gdk::Color f_rgba = color_dialog.get_colorsel()->get_current_color ();
 611                 color.set_red(f_rgba.get_red());
 612                 color.set_green(f_rgba.get_green());
 613                 color.set_blue(f_rgba.get_blue());
 614
 615                 picked = true;
 616         }
 617
 618         return color;
 619 }
 620
 621 void
 622 UI::color_selection_done (bool status)
 623 {
 624         color_picked = status;
 625         Main::quit ();
 626 }
 627
 628 bool
 629 UI::color_selection_deleted (GdkEventAny *ev)
 630 {
 631         Main::quit ();
 632         return true;
 633 }