GNOME Documentation Library

CAMEL_OBJECT_TRACK_INSTANCES

#define CAMEL_OBJECT_TRACK_INSTANCES

CamelType

typedef struct _CamelObjectClass *CamelType;

CamelObject

typedef struct {
	struct _CamelObjectClass *klass;

	guint32 magic;		/* only really needed for debugging ... */

	/* current hooks on this object */
	struct _CamelHookList *hooks;

	guint32 ref_count:24;
	guint32 flags:8;

#ifdef CAMEL_OBJECT_TRACK_INSTANCES
	struct _CamelObject *next, *prev;
#endif
} CamelObject;

CAMEL_CHECK_CAST()

#define             CAMEL_CHECK_CAST(obj, ctype, ptype)

CAMEL_CHECK_CLASS_CAST()

#define             CAMEL_CHECK_CLASS_CAST(klass, ctype, ptype)

CAMEL_CHECK_TYPE()

#define CAMEL_CHECK_TYPE(obj, ctype)                (camel_object_is ((CamelObject *)(obj), (CamelType)(ctype) ))

CAMEL_CHECK_CLASS_TYPE()

#define CAMEL_CHECK_CLASS_TYPE(klass, ctype)        (camel_object_class_is ((CamelObjectClass *)(klass), (CamelType)(ctype)))

camel_object_type

extern CamelType camel_object_type;

CAMEL_OBJECT_TYPE

#define CAMEL_OBJECT_TYPE        (camel_object_type)

CAMEL_OBJECT_GET_TYPE()

#define CAMEL_OBJECT_GET_TYPE(o)  ((CamelType)(CAMEL_OBJECT(o))->klass)

CamelObjectHookID

typedef unsigned int CamelObjectHookID;

CamelObjectMeta

typedef struct {
	struct _CamelObjectMeta *next;

	char *value;
	char name[1];		/* allocated as part of structure */
} CamelObjectMeta;

camel_interface_type

extern CamelType camel_interface_type;

CAMEL_INTERFACE_TYPE

#define CAMEL_INTERFACE_TYPE (camel_interface_type)

CamelInterface

typedef struct {
	struct _CamelObjectClass type;
} CamelInterface;

CamelObjectClassInitFunc ()

void                (*CamelObjectClassInitFunc)         (CamelObjectClass *);

CamelObjectClassFinalizeFunc ()

void                (*CamelObjectClassFinalizeFunc)     (CamelObjectClass *);

CamelObjectInitFunc ()

void                (*CamelObjectInitFunc)              (CamelObject *,
                                                         CamelObjectClass *);

CamelObjectFinalizeFunc ()

void                (*CamelObjectFinalizeFunc)          (CamelObject *);

CamelObjectEventPrepFunc ()

gboolean            (*CamelObjectEventPrepFunc)         (CamelObject *,
                                                         gpointer );

CamelObjectEventHookFunc ()

void                (*CamelObjectEventHookFunc)         (CamelObject *,
                                                         gpointer ,
                                                         gpointer );

CAMEL_INVALID_TYPE

#define CAMEL_INVALID_TYPE (NULL)

enum CamelObjectFlags

typedef enum _CamelObjectFlags {
	CAMEL_OBJECT_DESTROY = (1<<0)
} CamelObjectFlags;

camel_type_init ()

void                camel_type_init                     (void);

camel_type_register ()

CamelType           camel_type_register                 (CamelType parent,
                                                         const char *name,
                                                         size_t instance_size,
                                                         size_t classfuncs_size,
                                                         CamelObjectClassInitFunc class_init,
                                                         CamelObjectClassFinalizeFunc class_finalize,
                                                         CamelObjectInitFunc instance_init,
                                                         CamelObjectFinalizeFunc instance_finalize);

camel_interface_register ()

CamelType           camel_interface_register            (CamelType parent,
                                                         const char *name,
                                                         size_t classfuncs_size,
                                                         CamelObjectClassInitFunc class_init,
                                                         CamelObjectClassFinalizeFunc class_finalize);

camel_type_get_global_classfuncs()

#define camel_type_get_global_classfuncs(x) ((CamelObjectClass *)(x))

camel_type_to_name ()

const char*         camel_type_to_name                  (CamelType type);

camel_name_to_type ()

CamelType           camel_name_to_type                  (const char *name);

camel_object_class_add_event ()

void                camel_object_class_add_event        (CamelObjectClass *klass,
                                                         const char *name,
                                                         CamelObjectEventPrepFunc prep);

camel_object_class_add_interface ()

void                camel_object_class_add_interface    (CamelObjectClass *klass,
                                                         CamelType itype);

camel_object_class_dump_tree ()

void                camel_object_class_dump_tree        (CamelType root);

camel_object_cast ()

CamelObject*        camel_object_cast                   (CamelObject *obj,
                                                         CamelType ctype);

camel_object_is ()

gboolean            camel_object_is                     (CamelObject *obj,
                                                         CamelType ctype);

camel_object_class_cast ()

CamelObjectClass*   camel_object_class_cast             (CamelObjectClass *klass,
                                                         CamelType ctype);

camel_object_class_is ()

gboolean            camel_object_class_is               (CamelObjectClass *klass,
                                                         CamelType ctype);

camel_interface_cast ()

CamelObjectClass*   camel_interface_cast                (CamelObjectClass *klass,
                                                         CamelType ctype);

camel_interface_is ()

gboolean            camel_interface_is                  (CamelObjectClass *k,
                                                         CamelType ctype);

camel_object_new ()

CamelObject*        camel_object_new                    (CamelType type);

camel_object_new_name ()

CamelObject*        camel_object_new_name               (const char *name);

camel_object_ref ()

void                camel_object_ref                    (void *);

camel_object_unref ()

void                camel_object_unref                  (void *);

camel_object_hook_event ()

CamelObjectHookID   camel_object_hook_event             (void *obj,
                                                         const char *name,
                                                         CamelObjectEventHookFunc hook,
                                                         void *data);

camel_object_remove_event ()

void                camel_object_remove_event           (void *obj,
                                                         CamelObjectHookID id);

camel_object_unhook_event ()

void                camel_object_unhook_event           (void *obj,
                                                         const char *name,
                                                         CamelObjectEventHookFunc hook,
                                                         void *data);

camel_object_trigger_event ()

void                camel_object_trigger_event          (void *obj,
                                                         const char *name,
                                                         void *event_data);

camel_object_get_interface ()

void*               camel_object_get_interface          (void *vo,
                                                         CamelType itype);

camel_object_set ()

int                 camel_object_set                    (void *obj,
                                                         struct _CamelException *ex,
                                                         ...);

camel_object_setv ()

int                 camel_object_setv                   (void *obj,
                                                         struct _CamelException *ex,
                                                         CamelArgV *);

camel_object_get ()

int                 camel_object_get                    (void *obj,
                                                         struct _CamelException *ex,
                                                         ...);

camel_object_getv ()

int                 camel_object_getv                   (void *obj,
                                                         struct _CamelException *ex,
                                                         CamelArgGetV *);

camel_object_get_ptr ()

void*               camel_object_get_ptr                (void *vo,
                                                         CamelException *ex,
                                                         int tag);

camel_object_get_int ()

int                 camel_object_get_int                (void *vo,
                                                         CamelException *ex,
                                                         int tag);

camel_object_meta_get ()

char*               camel_object_meta_get               (void *vo,
                                                         const char *name);

Get a meta-data on an object.

camel_object_meta_set ()

gboolean            camel_object_meta_set               (void *vo,
                                                         const char *name,
                                                         const char *value);

Set a meta-data item on an object. If the object supports persistent data, then the meta-data will be persistent across sessions.

If the meta-data changes, is added, or removed, then a "meta_changed" event will be triggered with the name of the changed data.

camel_object_state_read ()

int                 camel_object_state_read             (void *vo);

Read persistent object state from object_set(CAMEL_OBJECT_STATE_FILE).

camel_object_state_write ()

int                 camel_object_state_write            (void *vo);

Write persistent state to the file as set by object_set(CAMEL_OBJECT_STATE_FILE).

camel_object_free ()

void                camel_object_free                   (void *vo,
                                                         guint32 tag,
                                                         void *value);

CamelObjectBag

typedef struct _CamelObjectBag CamelObjectBag;

CamelCopyFunc ()

void*               (*CamelCopyFunc)                    (const void *vo);

camel_object_bag_new ()

CamelObjectBag*     camel_object_bag_new                (GHashFunc hash,
                                                         GEqualFunc equal,
                                                         CamelCopyFunc keycopy,
                                                         GFreeFunc keyfree);

Allocate a new object bag. Object bag's are key'd hash tables of camel-objects which can be updated atomically using transaction semantics.

camel_object_bag_get ()

void*               camel_object_bag_get                (CamelObjectBag *bag,
                                                         const void *key);

Lookup an object by key. If the key is currently reserved, then wait until the key has been committed before continuing.

camel_object_bag_peek ()

void*               camel_object_bag_peek               (CamelObjectBag *bag,
                                                         const void *key);

Lookup the object key in bag, ignoring any reservations. If it isn't committed, then it isn't considered. This should only be used where reliable transactional-based state is not required.

Unlike other 'peek' operations, the object is still reffed if found.

camel_object_bag_reserve ()

void*               camel_object_bag_reserve            (CamelObjectBag *bag,
                                                         const void *key);

Reserve a key in the object bag. If the key is already reserved in another thread, then wait until the reservation has been committed.

After reserving a key, you either get a reffed pointer to the object corresponding to the key, similar to object_bag_get, or you get NULL, signifying that you then MIST call either object_bag_add or object_bag_abort.

You may reserve multiple keys from the same thread, but they should always be reserved in the same order, to avoid deadlocks.

camel_object_bag_add ()

void                camel_object_bag_add                (CamelObjectBag *bag,
                                                         const void *key,
                                                         void *o);

Add an object vo to the object bag bag. The key MUST have previously been reserved using camel_object_bag_reserve().

camel_object_bag_abort ()

void                camel_object_bag_abort              (CamelObjectBag *bag,
                                                         const void *key);

Abort a key reservation.

camel_object_bag_rekey ()

void                camel_object_bag_rekey              (CamelObjectBag *bag,
                                                         void *o,
                                                         const void *newkey);

Re-key an object, atomically. The key for object o is set to newkey, in an atomic manner.

It is an api (fatal) error if o is not currently in the bag.

camel_object_bag_list ()

GPtrArray*          camel_object_bag_list               (CamelObjectBag *bag);

camel_object_bag_remove ()

void                camel_object_bag_remove             (CamelObjectBag *bag,
                                                         void *o);

camel_object_bag_destroy ()

void                camel_object_bag_destroy            (CamelObjectBag *bag);

CAMEL_MAKE_CLASS()

#define             CAMEL_MAKE_CLASS(type, tname, parent, pname)

CamelIteratorVTable

typedef struct {
	/* free fields, dont free base object */
	void (*free)(void *it);
	/* go to the next messageinfo */
	const void *(*next)(void *it, CamelException *ex);
	/* go back to the start */
	void (*reset)(void *it);
	/* *ESTIMATE* how many results are in the iterator */
	int (*length)(void *it);
} CamelIteratorVTable;

CamelIterator

typedef struct {
	CamelIteratorVTable *klass;

	/* subclasses adds new fields afterwards */
} CamelIterator;

camel_iterator_new ()

void*               camel_iterator_new                  (CamelIteratorVTable *klass,
                                                         size_t size);

camel_iterator_free ()

void                camel_iterator_free                 (void *it);

camel_iterator_next ()

const void*         camel_iterator_next                 (void *it,
                                                         CamelException *ex);

camel_iterator_reset ()

void                camel_iterator_reset                (void *it);

camel_iterator_length ()

int                 camel_iterator_length               (void *it);