File: pygobject-types.h

package info (click to toggle)
pygobject 3.55.3-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 5,728 kB
  • sloc: ansic: 39,419; python: 26,856; sh: 114; makefile: 81; xml: 35; cpp: 1
file content (215 lines) | stat: -rw-r--r-- 8,802 bytes parent folder | download | duplicates (3)
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
208
209
210
211
212
213
214
215
/* -*- Mode: C; c-basic-offset: 4 -*-
 * vim: tabstop=4 shiftwidth=4 expandtab
 *
 * Copyright (C) 2000 James Henstridge <james@daa.com.au>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __PYGOBJECT_TYPES_H__
#define __PYGOBJECT_TYPES_H__

#include <glib.h>
#include <glib-object.h>
#include <Python.h>

G_BEGIN_DECLS

/* PyGClosure is a _private_ structure */
typedef void (*PyClosureExceptionHandler) (GValue *ret, guint n_param_values,
                                           const GValue *params);
typedef struct _PyGClosure PyGClosure;
typedef struct _PyGObjectData PyGObjectData;

struct _PyGClosure {
    GClosure closure;
    PyObject *callback;
    PyObject *extra_args; /* tuple of extra args to pass to callback */
    PyObject *swap_data;  /* other object for gtk_signal_connect__object */
    PyClosureExceptionHandler exception_handler;
};

typedef enum {
    PYGOBJECT_USING_TOGGLE_REF = 1 << 0, /* No longer used DO_NOT_USE! */
} PyGObjectFlags;

/* closures is just an alias for what is found in the
   * PyGObjectData */
typedef struct {
    PyObject_HEAD
    GObject *obj;
    PyObject *inst_dict;   /* the instance dictionary -- must be last */
    PyObject *weakreflist; /* list of weak references */

                           /*< private >*/
    /* using union to preserve ABI compatibility (structure size
       * must not change) */
    union {
        GSList *closures;     /* stale field; no longer updated DO-NOT-USE! */
        PyGObjectFlags flags; /* stale field; no longer updated DO-NOT-USE! */
    } private_flags;

} PyGObject;

#define pygobject_get(v)         (((PyGObject *)(v))->obj)
#define pygobject_check(v, base) (PyObject_TypeCheck (v, base))

typedef struct {
    PyObject_HEAD
    gpointer boxed;
    GType gtype;
    gboolean free_on_dealloc;
} PyGBoxed;

#define pyg_boxed_get(v, t)     ((t *)((PyGBoxed *)(v))->boxed)
#define pyg_boxed_get_ptr(v)    (((PyGBoxed *)(v))->boxed)
#define pyg_boxed_set_ptr(v, p) (((PyGBoxed *)(v))->boxed = (gpointer)p)
#define pyg_boxed_check(v, typecode)                                          \
    (PyObject_TypeCheck (v, &PyGBoxed_Type)                                   \
     && ((PyGBoxed *)(v))->gtype == (typecode))

typedef struct {
    PyObject_HEAD
    gpointer pointer;
    GType gtype;
} PyGPointer;

#define pyg_pointer_get(v, t)     ((t *)((PyGPointer *)(v))->pointer)
#define pyg_pointer_get_ptr(v)    (((PyGPointer *)(v))->pointer)
#define pyg_pointer_set_ptr(v, p) (((PyGPointer *)(v))->pointer = (gpointer)p)
#define pyg_pointer_check(v, typecode)                                        \
    (PyObject_TypeCheck (v, &PyGPointer_Type)                                 \
     && ((PyGPointer *)(v))->gtype == (typecode))

typedef void (*PyGFatalExceptionFunc) (void);
typedef void (*PyGThreadBlockFunc) (void);

typedef int (*PyGClassInitFunc) (gpointer gclass, PyTypeObject *pyclass);
typedef PyTypeObject *(*PyGTypeRegistrationFunction) (const gchar *name,
                                                      gpointer data);

struct _PyGObject_Functions {
    /*
     * All field names in here are considered private,
     * use the macros below instead, which provides stability
     */
    void (*register_class) (PyObject *dict, const gchar *class_name,
                            GType gtype, PyTypeObject *type, PyObject *bases);
    void (*register_wrapper) (PyObject *self);
    PyTypeObject *(*lookup_class) (GType type);
    PyObject *(*newgobj) (GObject *obj);

    GClosure *(*closure_new) (PyObject *callback, PyObject *extra_args,
                              PyObject *swap_data);
    void (*object_watch_closure) (PyObject *self, GClosure *closure);
    GDestroyNotify destroy_notify;

    GType (*type_from_object) (PyObject *obj);
    PyObject *(*type_wrapper_new) (GType type);

    gint (*enum_get_value) (GType enum_type, PyObject *obj, gint *val);
    gint (*flags_get_value) (GType flag_type, PyObject *obj, guint *val);
    void (*register_gtype_custom) (
        GType gtype, PyObject *(*from_func) (const GValue *value),
        int (*to_func) (GValue *value, PyObject *obj));
    int (*value_from_pyobject) (GValue *value, PyObject *obj);
    PyObject *(*value_as_pyobject) (const GValue *value, gboolean copy_boxed);

    void (*register_interface) (PyObject *dict, const gchar *class_name,
                                GType gtype, PyTypeObject *type);

    PyTypeObject *boxed_type;
    void (*register_boxed) (PyObject *dict, const gchar *class_name,
                            GType boxed_type, PyTypeObject *type);
    PyObject *(*boxed_new) (GType boxed_type, gpointer boxed,
                            gboolean copy_boxed, gboolean own_ref);

    PyTypeObject *pointer_type;
    void (*register_pointer) (PyObject *dict, const gchar *class_name,
                              GType pointer_type, PyTypeObject *type);
    PyObject *(*pointer_new) (GType boxed_type, gpointer pointer);

    void (*enum_add_constants) (PyObject *module, GType enum_type,
                                const gchar *strip_prefix);
    void (*flags_add_constants) (PyObject *module, GType flags_type,
                                 const gchar *strip_prefix);

    const gchar *(*constant_strip_prefix) (const gchar *name,
                                           const gchar *strip_prefix);

    gboolean (*error_check) (GError **error);

    /* hooks to register handlers for getting GDK threads to cooperate
     * with python threading */
    void (*set_thread_block_funcs) (PyGThreadBlockFunc block_threads_func,
                                    PyGThreadBlockFunc unblock_threads_func);
    PyGThreadBlockFunc block_threads;
    PyGThreadBlockFunc unblock_threads;

    PyTypeObject *paramspec_type;
    PyObject *(*paramspec_new) (GParamSpec *spec);
    GParamSpec *(*paramspec_get) (PyObject *tuple);
    int (*pyobj_to_unichar_conv) (PyObject *pyobj, void *ptr);
    G_GNUC_BEGIN_IGNORE_DEPRECATIONS
    gboolean (*parse_constructor_args) (GType obj_type, char **arg_names,
                                        char **prop_names, GParameter *params,
                                        guint *nparams, PyObject **py_args);
    G_GNUC_END_IGNORE_DEPRECATIONS
    PyObject *(*param_gvalue_as_pyobject) (const GValue *gvalue,
                                           gboolean copy_boxed,
                                           const GParamSpec *pspec);
    int (*gvalue_from_param_pyobject) (GValue *value, PyObject *py_obj,
                                       const GParamSpec *pspec);
    PyTypeObject *enum_type;
    PyObject *(*enum_add) (PyObject *module, const char *type_name_,
                           const char *strip_prefix, GType gtype);
    PyObject *(*enum_from_gtype) (GType gtype, int value);

    PyTypeObject *flags_type;
    PyObject *(*flags_add) (PyObject *module, const char *type_name_,
                            const char *strip_prefix, GType gtype);
    PyObject *(*flags_from_gtype) (GType gtype, guint value);

    gboolean threads_enabled;
    int (*enable_threads) (void);

    int (*gil_state_ensure) (void);
    void (*gil_state_release) (int flag);

    void (*register_class_init) (GType gtype, PyGClassInitFunc class_init);
    void (*register_interface_info) (GType gtype, const GInterfaceInfo *info);
    void (*closure_set_exception_handler) (GClosure *closure,
                                           PyClosureExceptionHandler handler);

    void (*add_warning_redirection) (const char *domain, PyObject *warning);
    void (*disable_warning_redirections) (void);

    /* type_register_custom API is removed, but left a pointer to not break ABI. */
    void *_type_register_custom;

    gboolean (*gerror_exception_check) (GError **error);

    /* option_group_new API is removed, but left a pointer to not break ABI. */
    void *_option_group_new;

    GType (*type_from_object_strict) (PyObject *obj, gboolean strict);

    PyObject *(*newgobj_full) (GObject *obj, gboolean steal, gpointer g_class);
    PyTypeObject *object_type;
    int (*value_from_pyobject_with_error) (GValue *value, PyObject *obj);
};

G_END_DECLS

#endif /* __PYGOBJECT_TYPES_H__ */