gtk_ui.h

Go to the documentation of this file.

/*
 * Copyright (C) 1999-2015 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2005-2006 Taybin Rutkin <taybin@taybin.com>
 * Copyright (C) 2007-2008 Doug McLain <doug@nostar.net>
 * Copyright (C) 2007-2013 Tim Mayberry <mojofunk@gmail.com>
 * Copyright (C) 2009-2010 David Robillard <d@drobilla.net>
 * Copyright (C) 2014-2017 Robin Gareus <robin@gareus.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include <string>
#include <map>
 
#include <stdint.h>
#include <setjmp.h>
#include <pthread.h>
 
#ifdef interface
#undef interface
#endif
 
#include <glibmm/thread.h>
 
#include <gtkmm/widget.h>
#include <gtkmm/style.h>
#ifndef GTK_NEW_TOOLTIP_API
#include <gtkmm/tooltips.h>
#endif
#include <gtkmm/textbuffer.h>
#include <gtkmm/main.h>
#include <gdkmm/color.h>
 
#ifndef ABSTRACT_UI_EXPORTS
#define ABSTRACT_UI_EXPORTS
#endif
#include "pbd/abstract_ui.h"
#include "pbd/ringbufferNPT.h"
#include "pbd/pool.h"
#include "pbd/error.h"
#include "pbd/receiver.h"
 
#include "gtkmm2ext/visibility.h"
 
class Touchable;
 
namespace Gtkmm2ext {
 
class TextViewer;
class Bindings;
 
extern BaseUI::RequestType NullMessage;
extern BaseUI::RequestType ErrorMessage;
extern BaseUI::RequestType CallSlot;
extern BaseUI::RequestType TouchDisplay;
extern BaseUI::RequestType StateChange;
extern BaseUI::RequestType SetTip;
extern BaseUI::RequestType AddIdle;
extern BaseUI::RequestType AddTimeout;
 
struct LIBGTKMM2EXT_API UIRequest : public BaseUI::BaseRequestObject {
 
     /* this once used anonymous unions to merge elements
        that are never part of the same request. that makes
        the creation of a legal copy constructor difficult
        because of the semantics of the slot member.
     */
 
    Touchable *display;
    const char *msg;
    Gtk::StateType new_state;
    int (*function)(void *);
    Gtk::Widget *widget;
    Transmitter::Channel chn;
    void *arg;
    const char *msg2;
 
    UIRequest () {
            type = NullMessage;
    }
 
    ~UIRequest () {
            if (type == ErrorMessage && msg) {
                    /* msg was strdup()'ed */
                    free (const_cast<char *>(msg));
            }
    }
};
 
class LIBGTKMM2EXT_API UI : public AbstractUI<UIRequest>
{
private:
        class MyReceiver : public Receiver {
                public:
                        MyReceiver (UI& ui) : _ui (ui) {}
                        void receive (Transmitter::Channel chn, const char *msg) {
                                _ui.receive (chn, msg);
                        }
                private:
                        UI& _ui;
        };
 
        MyReceiver _receiver;
 
public:
        UI (std::string, std::string, int *argc, char **argv[]);
        virtual ~UI ();
 
        static UI *instance() { return theGtkUI; }
 
        /* receiver interface */
 
        void receive (Transmitter::Channel, const char *);
 
        /* Abstract UI interfaces */
 
        bool caller_is_ui_thread () const;
 
        /* Gtk-UI specific interfaces */
 
        bool running ();
        void quit    ();
        int  load_rcfile (std::string, bool themechange = false);
        void run (Receiver &old_receiver);
 
        void set_state (Gtk::Widget *w, Gtk::StateType state);
        void popup_error (const std::string& text);
        void flush_pending (float timeout = 0);
        void toggle_errors ();
        void show_errors ();
        void dump_errors (std::ostream&, size_t limit = 0);
        void clear_errors () { error_stack.clear (); }
        void touch_display (Touchable *);
        void set_tip (Gtk::Widget &w, const gchar *tip);
        void set_tip (Gtk::Widget &w, const std::string &tip);
        void set_tip (Gtk::Widget *w, const gchar *tip, const gchar *hlp="");
        void idle_add (int (*func)(void *), void *arg);
 
        Gtk::Main& main() const { return *theMain; }
 
        /* starting is sent just before we enter the main loop,
         * stopping just after we return from it (at the top level)
         */
        virtual int starting() = 0;
 
        sigc::signal<void> theme_changed;
 
        static bool just_hide_it (GdkEventAny *, Gtk::Window *);
 
        Gtkmm2ext::Bindings* global_bindings;
 
protected:
        virtual void handle_fatal (const char *);
        virtual void display_message (const char *prefix, gint prefix_len,
                        Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag,
                        const char *msg);
 
private:
        static UI *theGtkUI;
 
        bool _active;
        Gtk::Main *theMain;
#ifndef GTK_NEW_TOOLTIP_API
        Gtk::Tooltips *tips;
#endif
        TextViewer *errors;
        Glib::RefPtr<Gtk::TextBuffer::Tag> fatal_ptag;
        Glib::RefPtr<Gtk::TextBuffer::Tag> fatal_mtag;
        Glib::RefPtr<Gtk::TextBuffer::Tag> error_ptag;
        Glib::RefPtr<Gtk::TextBuffer::Tag> error_mtag;
        Glib::RefPtr<Gtk::TextBuffer::Tag> warning_ptag;
        Glib::RefPtr<Gtk::TextBuffer::Tag> warning_mtag;
        Glib::RefPtr<Gtk::TextBuffer::Tag> info_ptag;
        Glib::RefPtr<Gtk::TextBuffer::Tag> info_mtag;
        Glib::RefPtr<Gtk::TextBuffer::Tag> debug_ptag;
        Glib::RefPtr<Gtk::TextBuffer::Tag> debug_mtag;
 
        static void signal_pipe_callback (void *, gint, GdkInputCondition);
        void process_error_message (Transmitter::Channel, const char *);
        void do_quit ();
 
        Glib::Threads::Mutex   error_lock;
        std::list<std::string> error_stack;
 
        void color_selection_done (bool status);
        bool color_selection_deleted (GdkEventAny *);
        bool color_picked;
 
        void do_request (UIRequest*);
};
 
} /* namespace */