aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-object.h
blob: 0578db77a83c4f0b043ae58e0960c6a78ec15cb8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-object.h: Base class for Camel */

/*
 * Author:
 *  Dan Winship <danw@ximian.com>
 *  Michael Zucchi <notzed@ximian.com>
 *
 * Copyright 2000 Ximian, Inc. (www.ximian.com)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 */

#ifndef CAMEL_OBJECT_H
#define CAMEL_OBJECT_H 1

#ifdef __cplusplus
extern "C" {
#pragma }
#endif              /* __cplusplus } */

#include <stdlib.h>     /* size_t */
#include <glib.h>
#include <stdarg.h>
#include <camel/camel-arg.h>
#include <camel/camel-types.h>  /* this is a @##$@#SF stupid header */

/* this crap shouldn't be here */
#include <libgnome/gnome-defs.h>
#include <libgnome/gnome-i18n.h>

#ifdef ENABLE_THREADS
#include <pthread.h>
#endif

/* turn on so that camel_object_class_dump_tree() dumps object instances as well */
/*#define CAMEL_OBJECT_TRACK_INSTANCES*/

typedef struct _CamelObjectClass *CamelType;

#ifdef G_DISABLE_CHECKS
#define CAMEL_CHECK_CAST( obj, ctype, ptype )         ((ptype *) obj)
#define CAMEL_CHECK_CLASS_CAST( class, ctype, ptype ) ((ptype *) class)
#else
#define CAMEL_CHECK_CAST( obj, ctype, ptype )         ((ptype *) camel_object_cast( (CamelObject *)(obj), (CamelType)(ctype) ))
#define CAMEL_CHECK_CLASS_CAST( class, ctype, ptype ) ((ptype *) camel_object_class_cast( (CamelObjectClass *)(class), (CamelType)(ctype) ))
#endif
#define CAMEL_CHECK_TYPE( obj, ctype )                (camel_object_is( (CamelObject *)(obj), (CamelType)(ctype) ))
#define CAMEL_CHECK_CLASS_TYPE( class, ctype )        (camel_object_class_is( (CamelObjectClass *)(class), (CamelType)(ctype) ))

extern CamelType camel_object_type;

#define CAMEL_OBJECT_TYPE        (camel_object_type)

/* we can't check casts till we've got the type, use the global type variable because its cheaper */
#define CAMEL_OBJECT(obj)        (CAMEL_CHECK_CAST((obj), camel_object_type, CamelObject))
#define CAMEL_OBJECT_CLASS(k)    (CAMEL_CHECK_CLASS_CAST ((k), camel_object_type, CamelObjectClass))
#define CAMEL_IS_OBJECT(o)       (CAMEL_CHECK_TYPE((o), camel_object_type))
#define CAMEL_IS_OBJECT_CLASS(k) (CAMEL_CHECK_CLASS_TYPE((k), camel_object_type))

#define CAMEL_OBJECT_GET_CLASS(o) ((CamelObjectClass *)(CAMEL_OBJECT(o))->klass)
#define CAMEL_OBJECT_GET_TYPE(o)  ((CamelType)(CAMEL_OBJECT(o))->klass)

typedef struct _CamelObjectClass CamelObjectClass;
typedef struct _CamelObject CamelObject;
typedef unsigned int CamelObjectHookID;

typedef void (*CamelObjectClassInitFunc) (CamelObjectClass *);
typedef void (*CamelObjectClassFinalizeFunc) (CamelObjectClass *);
typedef void (*CamelObjectInitFunc) (CamelObject *, CamelObjectClass *);
typedef void (*CamelObjectFinalizeFunc) (CamelObject *);

typedef gboolean (*CamelObjectEventPrepFunc) (CamelObject *, gpointer);
typedef void (*CamelObjectEventHookFunc) (CamelObject *, gpointer, gpointer);

#define CAMEL_INVALID_TYPE (NULL)

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

/* TODO: create a simpleobject which has no events on it, or an interface for events */
struct _CamelObject {
    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
};

struct _CamelObjectClass
{
    struct _CamelObjectClass *parent;

    guint32 magic;      /* in same spot for validation */

    struct _CamelObjectClass *next, *child; /* maintain heirarchy, just for kicks */

    const char *name;

    void *lock;     /* lock when used in threading, else just pads struct */

    /*unsigned short version, revision;*/

    /* if the object's bigger than 64K, it could use redesigning */
    unsigned short object_size/*, object_data*/;
    unsigned short klass_size/*, klass_data*/;

    /* available hooks for this class */
    struct _CamelHookPair *hooks;

    /* memchunks for this type */
    struct _EMemChunk *instance_chunks;
#ifdef CAMEL_OBJECT_TRACK_INSTANCES
    struct _CamelObject *instances;
#endif

    /* init class */
    void (*klass_init)(struct _CamelObjectClass *);
    void (*klass_finalise)(struct _CamelObjectClass *);

    /* init/finalise object */
    void (*init)(struct _CamelObject *, struct _CamelObjectClass *);
    void (*finalise)(struct _CamelObject *);

    /* get/set interface */
    int (*setv)(struct _CamelObject *, struct _CamelException *ex, CamelArgV *args);
    int (*getv)(struct _CamelObject *, struct _CamelException *ex, CamelArgGetV *args);
};

/* The type system .... it's pretty simple..... */
void camel_type_init (void);
CamelType camel_type_register(CamelType parent, const char * name, /*unsigned int ver, unsigned int rev,*/
                  size_t instance_size,
                  size_t classfuncs_size,
                  CamelObjectClassInitFunc class_init,
                  CamelObjectClassFinalizeFunc  class_finalize,
                  CamelObjectInitFunc instance_init,
                  CamelObjectFinalizeFunc instance_finalize);

/* deprecated interface */
#define camel_type_get_global_classfuncs(x) ((CamelObjectClass *)(x))

/* object class methods (types == classes now) */
const char *camel_type_to_name (CamelType type);
CamelType camel_name_to_type(const char *name);
void camel_object_class_add_event (CamelObjectClass *class, const char * name, CamelObjectEventPrepFunc prep);

void camel_object_class_dump_tree(CamelType root);

/* casting */
CamelObject *camel_object_cast(CamelObject * obj, CamelType ctype);
gboolean camel_object_is(CamelObject * obj, CamelType ctype);

CamelObjectClass *camel_object_class_cast (CamelObjectClass *k, CamelType ctype);
gboolean camel_object_class_is (CamelObjectClass * class, CamelType ctype);

CamelType camel_object_get_type (void);

CamelObject *camel_object_new (CamelType type);
CamelObject *camel_object_new_name (const char *name);

void camel_object_ref (CamelObject *obj);
void camel_object_unref (CamelObject *obj);

#ifdef CAMEL_DEBUG
#define camel_object_ref(o) (printf("%s (%s:%d):ref (%p)\n", __FUNCTION__, __FILE__, __LINE__, o), camel_object_ref(o))
#define camel_object_unref(o) (printf("%s (%s:%d):unref (%p)\n", __FUNCTION__, __FILE__, __LINE__, o), camel_object_unref (o))
#endif

/* hooks */
CamelObjectHookID camel_object_hook_event(CamelObject *obj, const char *name, CamelObjectEventHookFunc hook, void *data);
void camel_object_remove_event(CamelObject *obj, CamelObjectHookID id);
void camel_object_unhook_event(CamelObject *obj, const char *name, CamelObjectEventHookFunc hook, void *data);
void camel_object_trigger_event(CamelObject *obj, const char *name, void *event_data);

/* get/set methods */
int camel_object_set(CamelObject *obj, struct _CamelException *ex, ...);
int camel_object_setv(CamelObject *obj, struct _CamelException *ex, CamelArgV *);
int camel_object_get(CamelObject *obj, struct _CamelException *ex, ...);
int camel_object_getv(CamelObject *obj, struct _CamelException *ex, CamelArgGetV *);

#ifdef __cplusplus
}
#endif              /* __cplusplus */

#endif              /* CAMEL_OBJECT_H */