geanyobject.c

Go to the documentation of this file.

/*
 *      geanyobject.c - this file is part of Geany, a fast and lightweight IDE
 *
 *      Copyright 2007 The Geany contributors
 *
 *      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.
 */
 
/* A GObject used for connecting and emitting signals when certain events happen,
 * e.g. opening a document.
 * Mainly used for plugins - see the API docs.
 *
 * Core-only signals:
 *
 * signal void save_settings(GObject *obj, GKeyFile *keyfile, gpointer user_data);
 * Emitted just before saving main keyfile settings.
 
 * signal void load_settings(GObject *obj, GKeyFile *keyfile, gpointer user_data);
 * Emitted just after loading main keyfile settings.
 */
 
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
 
#include "geanyobject.h"
 
/* extern in geany.h */
GObject *geany_object;
 
static guint geany_object_signals[GCB_MAX] = { 0 };
 
 
typedef struct _GeanyObjectPrivate GeanyObjectPrivate;
 
struct _GeanyObjectPrivate
{
    /* to avoid warnings (g_type_class_add_private: assertion `private_size > 0' failed) */
    gchar dummy;
};
 
/** @gironly
 * Get the GObject-derived GType for GeanyObject
 *
 * @return GeanyObject type */
GEANY_API_SYMBOL
GType geany_object_get_type(void);
 
G_DEFINE_TYPE(GeanyObject, geany_object, G_TYPE_OBJECT)
 
 
static gboolean boolean_handled_accumulator(GSignalInvocationHint *ihint, GValue *return_accu,
                                            const GValue *handler_return, gpointer dummy)
{
    gboolean continue_emission, signal_handled;
 
    signal_handled = g_value_get_boolean(handler_return);
    g_value_set_boolean(return_accu, signal_handled);
    continue_emission = !signal_handled;
 
    return continue_emission;
}
 
 
static void create_signals(GObjectClass *g_object_class)
{
    /* Document signals */
    geany_object_signals[GCB_DOCUMENT_NEW] = g_signal_new (
        "document-new",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, g_cclosure_marshal_VOID__BOXED,
        G_TYPE_NONE, 1,
        GEANY_TYPE_DOCUMENT);
    geany_object_signals[GCB_DOCUMENT_OPEN] = g_signal_new (
        "document-open",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, g_cclosure_marshal_VOID__BOXED,
        G_TYPE_NONE, 1,
        GEANY_TYPE_DOCUMENT);
    geany_object_signals[GCB_DOCUMENT_RELOAD] = g_signal_new (
        "document-reload",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, g_cclosure_marshal_VOID__BOXED,
        G_TYPE_NONE, 1,
        GEANY_TYPE_DOCUMENT);
    geany_object_signals[GCB_DOCUMENT_BEFORE_SAVE] = g_signal_new (
        "document-before-save",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, g_cclosure_marshal_VOID__BOXED,
        G_TYPE_NONE, 1,
        GEANY_TYPE_DOCUMENT);
    geany_object_signals[GCB_DOCUMENT_SAVE] = g_signal_new (
        "document-save",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, g_cclosure_marshal_VOID__BOXED,
        G_TYPE_NONE, 1,
        GEANY_TYPE_DOCUMENT);
    geany_object_signals[GCB_DOCUMENT_FILETYPE_SET] = g_signal_new (
        "document-filetype-set",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, NULL,
        G_TYPE_NONE, 2,
        GEANY_TYPE_DOCUMENT, GEANY_TYPE_FILETYPE);
    geany_object_signals[GCB_DOCUMENT_ACTIVATE] = g_signal_new (
        "document-activate",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, g_cclosure_marshal_VOID__BOXED,
        G_TYPE_NONE, 1,
        GEANY_TYPE_DOCUMENT);
    geany_object_signals[GCB_DOCUMENT_CLOSE] = g_signal_new (
        "document-close",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, g_cclosure_marshal_VOID__BOXED,
        G_TYPE_NONE, 1,
        GEANY_TYPE_DOCUMENT);
 
    /* Project signals */
    geany_object_signals[GCB_PROJECT_OPEN] = g_signal_new (
        "project-open",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, g_cclosure_marshal_VOID__BOXED,
        G_TYPE_NONE, 1,
        G_TYPE_KEY_FILE);
    geany_object_signals[GCB_PROJECT_SAVE] = g_signal_new (
        "project-save",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, g_cclosure_marshal_VOID__BOXED,
        G_TYPE_NONE, 1,
        G_TYPE_KEY_FILE);
    geany_object_signals[GCB_PROJECT_CLOSE] = g_signal_new (
        "project-close",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, g_cclosure_marshal_VOID__VOID,
        G_TYPE_NONE, 0);
    geany_object_signals[GCB_PROJECT_BEFORE_CLOSE] = g_signal_new (
        "project-before-close",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, g_cclosure_marshal_VOID__VOID,
        G_TYPE_NONE, 0);
    geany_object_signals[GCB_PROJECT_DIALOG_OPEN] = g_signal_new (
        "project-dialog-open",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, g_cclosure_marshal_VOID__OBJECT,
        G_TYPE_NONE, 1,
        GTK_TYPE_NOTEBOOK);
    geany_object_signals[GCB_PROJECT_DIALOG_CONFIRMED] = g_signal_new (
        "project-dialog-confirmed",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, g_cclosure_marshal_VOID__OBJECT,
        G_TYPE_NONE, 1,
        GTK_TYPE_NOTEBOOK);
    geany_object_signals[GCB_PROJECT_DIALOG_CLOSE] = g_signal_new (
        "project-dialog-close",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, g_cclosure_marshal_VOID__OBJECT,
        G_TYPE_NONE, 1,
        GTK_TYPE_NOTEBOOK);
 
    /* Editor signals */
    geany_object_signals[GCB_UPDATE_EDITOR_MENU] = g_signal_new (
        "update-editor-menu",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, NULL,
        G_TYPE_NONE, 3,
        G_TYPE_STRING, G_TYPE_INT, GEANY_TYPE_DOCUMENT);
    geany_object_signals[GCB_EDITOR_NOTIFY] = g_signal_new (
        "editor-notify",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_LAST,
        0, boolean_handled_accumulator, NULL, NULL,
        G_TYPE_BOOLEAN, 2,
        GEANY_TYPE_EDITOR, SCINTILLA_TYPE_NOTIFICATION);
 
    /* General signals */
    geany_object_signals[GCB_GEANY_STARTUP_COMPLETE] = g_signal_new (
        "geany-startup-complete",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, g_cclosure_marshal_VOID__VOID,
        G_TYPE_NONE, 0);
    geany_object_signals[GCB_BUILD_START] = g_signal_new (
        "build-start",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, g_cclosure_marshal_VOID__VOID,
        G_TYPE_NONE, 0);
 
    /* Core-only signals */
    geany_object_signals[GCB_SAVE_SETTINGS] = g_signal_new (
        "save-settings",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, g_cclosure_marshal_VOID__BOXED,
        G_TYPE_NONE, 1,
        G_TYPE_KEY_FILE);
    geany_object_signals[GCB_LOAD_SETTINGS] = g_signal_new (
        "load-settings",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_FIRST,
        0, NULL, NULL, g_cclosure_marshal_VOID__BOXED,
        G_TYPE_NONE, 1,
        G_TYPE_KEY_FILE);
 
    /* Key press signal */
    geany_object_signals[GCB_KEY_PRESS_NOTIFY] = g_signal_new (
        "key-press",
        G_OBJECT_CLASS_TYPE (g_object_class),
        G_SIGNAL_RUN_LAST,
        0, boolean_handled_accumulator, NULL, NULL,
        G_TYPE_BOOLEAN, 1,
        GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
}
 
 
static void geany_object_class_init(GeanyObjectClass *klass)
{
    GObjectClass *g_object_class;
    g_object_class = G_OBJECT_CLASS(klass);
 
    g_type_class_add_private(klass, sizeof(GeanyObjectPrivate));
 
    create_signals(g_object_class);
}
 
 
static void geany_object_init(GeanyObject *self)
{
    /* nothing to do */
}
 
 
GObject *geany_object_new(void)
{
    return g_object_new(GEANY_OBJECT_TYPE, NULL);
}