galago-object.h

Go to the documentation of this file.

#ifndef _GALAGO_OBJECT_H_
#define _GALAGO_OBJECT_H_

#include <libgalago/galago-types.h>

typedef struct _GalagoObjectClass         GalagoObjectClass;
typedef struct _GalagoObjectClassInfo     GalagoObjectClassInfo;
typedef struct _GalagoObjectClassPrivate  GalagoObjectClassPrivate;
typedef struct _GalagoObject              GalagoObject;
typedef struct _GalagoObjectPrivate       GalagoObjectPrivate;

typedef void (*GalagoObjectClassInitFunc)(GalagoObjectClass *klass);
typedef void (*GalagoObjectClassFinalizeFunc)(GalagoObjectClass *klass);
typedef void (*GalagoObjectInitFunc)(GalagoObject *object);

typedef enum
{
    GALAGO_FLAG_FINALIZING = 1 << 1 
} GalagoObjectFlags;

typedef enum
{
    GALAGO_FLAG_ABSTRACT = 1 << 1 
} GalagoObjectClassFlags;

#include <libgalago/galago-context-base.h>
#include <libgalago/galago-signals.h>


struct _GalagoObjectClass
{
    unsigned long magic;

    GalagoObjectClassPrivate *priv;

    GalagoSignalContext *signal_context;

    void (*finalize)(GalagoObject *object);

    void (*dbus_message_append)(DBusMessageIter *iter,
                                const GalagoObject *object);
    void *(*dbus_message_get)(DBusMessageIter *iter);
    void (*dbus_push_full)(GalagoObject *object);

    void (*reserved_1)(void);
    void (*reserved_2)(void);
    void (*reserved_3)(void);
    void (*reserved_4)(void);
};

struct _GalagoObjectClassInfo
{
    unsigned long flags;
    size_t class_size;
    GalagoObjectClassInitFunc class_init;
    GalagoObjectClassFinalizeFunc class_finalize;
    size_t object_size;
    GalagoObjectInitFunc object_init;
};

struct _GalagoObject
{
    unsigned long magic;

    GalagoObjectPrivate *priv;

    void (*reserved_1)(void);
    void (*reserved_2)(void);
    void (*reserved_3)(void);
    void (*reserved_4)(void);
};

#define GALAGO_OBJECT_MAGIC 0xB00F
#define GALAGO_CLASS_MAGIC  0xB0B0

#define GALAGO_IS_OBJECT(ptr) \
    ((ptr) != NULL && ((GalagoObject *)(ptr))->magic == GALAGO_OBJECT_MAGIC)

#define GALAGO_IS_CLASS(ptr) \
    ((ptr) != NULL && ((GalagoObjectClass *)(ptr))->magic == GALAGO_CLASS_MAGIC)

#define GALAGO_OBJECT(ptr) \
    ((ptr) == NULL ? NULL : \
     (GALAGO_IS_OBJECT(ptr) ? (GalagoObject *)(ptr) : NULL))

#define GALAGO_OBJECT_CLASS(obj) (galago_object_get_class(obj))

#define GALAGO_OBJECT_CAST(obj, klass, type) \
    ((obj) == NULL ? NULL : (type *)galago_object_check_cast((obj), (klass)))

#define GALAGO_OBJECT_GET_FLAGS(obj) (galago_object_get_flags(obj))
#define GALAGO_OBJECT_SET_FLAGS(obj, flags) \
    galago_object_set_flags((obj), (flags))

#define GALAGO_OBJECT_SET_FLAG(obj, flag) \
    GALAGO_OBJECT_SET_FLAGS((obj), GALAGO_OBJECT_GET_FLAGS(obj) | (flag))
#define GALAGO_OBJECT_UNSET_FLAG(obj, flag) \
    GALAGO_OBJECT_SET_FLAGS((obj), GALAGO_OBJECT_GET_FLAGS(obj) & ~(flag))

#define GALAGO_OBJECT_HAS_FLAG(obj, flag) \
    ((GALAGO_OBJECT_GET_FLAGS(obj) & (flag)) == (flag))

#ifdef __cplusplus
extern "C" {
#endif

/**************************************************************************/
/**************************************************************************/
GalagoObjectClass *galago_class_register(GalagoObjectClass *parent_class,
                                         const char *name,
                                         const char *dbus_iface,
                                         const GalagoObjectClassInfo *info);

GalagoObjectClass *galago_class_get_parent(const GalagoObjectClass *klass);

const char *galago_class_get_name(const GalagoObjectClass *klass);

const char *galago_class_get_dbus_iface(const GalagoObjectClass *klass);

GalagoSignalContext *galago_class_get_signal_context(
    const GalagoObjectClass *klass);

/**************************************************************************/
/**************************************************************************/
void *galago_object_new(GalagoObjectClass *klass);

void *galago_object_ref(void *object);

void *galago_object_unref(void *object);

GalagoObjectClass *galago_object_get_class(const void *object);

void galago_object_set_flags(void *object, unsigned long flags);

unsigned long galago_object_get_flags(const void *object);

void galago_object_set_dbus_path(void *object, const char *obj_path);

const char *galago_object_get_dbus_path(const void *object);

void galago_object_set_watch(void *object, galago_bool watch);

galago_bool galago_object_is_watched(const void *object);

void galago_object_set_data(void *object, const char *name, void *value);

void *galago_object_get_data(const void *object, const char *name);

GalagoContext *galago_object_get_context(const void *object);

GalagoObject *galago_object_check_cast(const void *ptr,
                                       const GalagoObjectClass *klass);

#ifdef __cplusplus
}
#endif

#endif /* _GALAGO_OBJECT_H_ */

Website design and development provided by Portal Web Design.
Layout Copyright © 2004 Portal Web Design. All rights reserved.
News powered by Movable Type.

News
About Galago
Downloads
Documentation
Screen Shots
Mailing Lists
Commits
Contact Information

Wiki
Specifications

New Bug
New Patch / Request
Bug List