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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
|
/* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
/*
* Copyright (c) 2008 litl, LLC
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*/
#ifndef __GJS_JSAPI_UTIL_H__
#define __GJS_JSAPI_UTIL_H__
#if !defined (__GJS_GJS_H__) && !defined (GJS_COMPILATION)
#error "Only <gjs/gjs.h> can be included directly."
#endif
#include <jsapi.h>
#include <glib-object.h>
G_BEGIN_DECLS
#define GJS_UTIL_ERROR gjs_util_error_quark ()
GQuark gjs_util_error_quark (void);
enum {
GJS_UTIL_ERROR_NONE,
GJS_UTIL_ERROR_ARGUMENT_INVALID,
GJS_UTIL_ERROR_ARGUMENT_UNDERFLOW,
GJS_UTIL_ERROR_ARGUMENT_OVERFLOW,
GJS_UTIL_ERROR_ARGUMENT_TYPE_MISMATCH
};
typedef struct GjsRootedArray GjsRootedArray;
/* Flags that should be set on properties exported from native code modules.
* Basically set these on API, but do NOT set them on data.
*
* READONLY: forbid setting prop to another value
* PERMANENT: forbid deleting the prop
* ENUMERATE: allows copyProperties to work among other reasons to have it
*/
#define GJS_MODULE_PROP_FLAGS (JSPROP_READONLY | JSPROP_PERMANENT | JSPROP_ENUMERATE)
/* priv_from_js_with_typecheck checks that the object is in fact an
* instance of the specified class before accessing its private data.
* Keep in mind that the function can return JS_TRUE and still fill the
* out parameter with NULL if the object is the prototype for a class
* without the JSCLASS_CONSTRUCT_PROTOTYPE flag or if it the class simply
* does not have any private data.
*/
#define GJS_DEFINE_PRIV_FROM_JS(type, class) \
__attribute__((unused)) static JSBool \
priv_from_js_with_typecheck(JSContext *context, \
JSObject *object, \
type **out) \
{\
if (!out) \
return JS_FALSE; \
if (!JS_InstanceOf(context, object, &class, NULL)) \
return JS_FALSE; \
*out = JS_GetInstancePrivate(context, object, &class, NULL); \
return JS_TRUE; \
}\
static type*\
priv_from_js(JSContext *context, \
JSObject *object) \
{\
return JS_GetInstancePrivate(context, object, &class, NULL); \
}
#define GJS_DEFINE_DYNAMIC_PRIV_FROM_JS(type, class) \
__attribute__((unused)) static JSBool\
priv_from_js_with_typecheck(JSContext *context, \
JSObject *object, \
type **out) \
{\
type *result; \
if (!out) \
return JS_FALSE; \
result = gjs_get_instance_private_dynamic_with_typecheck(context, object, &class, NULL); \
if (result == NULL) \
return JS_FALSE; \
*out = result; \
return JS_TRUE; \
}\
static type*\
priv_from_js(JSContext *context, \
JSObject *object) \
{\
return gjs_get_instance_private_dynamic(context, object, &class, NULL); \
}
/**
* GJS_DEFINE_PROTO:
* @tn: The name of the prototype, as a string
* @cn: The name of the prototype, separated by _
*
* A convenience macro for prototype implementations.
*/
#define GJS_DEFINE_PROTO(tn, cn) \
static JSBool cn##_constructor(JSContext *context, \
JSObject *obj, \
uintN argc, \
jsval *argv, \
jsval *retval); \
_GJS_DEFINE_PROTO_FULL(tn, cn, cn##_constructor)
/**
* GJS_DEFINE_PROTO_ABSTRACT:
* @tn: The name of the prototype, as a string
* @cn: The name of the prototype, separated by _
*
* A convenience macro for prototype implementations.
* Similar to GJS_DEFINE_PROTO but marks the prototype as abstract,
* you won't be able to instantiate it using the new keyword
*/
#define GJS_DEFINE_PROTO_ABSTRACT(tn, cn) \
_GJS_DEFINE_PROTO_FULL(tn, cn, NULL)
#define _GJS_DEFINE_PROTO_FULL(type_name, cname, ctor) \
static JSPropertySpec cname##_proto_props[]; \
static JSFunctionSpec cname##_proto_funcs[]; \
static void cname##_finalize(JSContext *context, JSObject *obj); \
static JSBool cname##_new_resolve(JSContext *context, \
JSObject *obj, \
jsval id, \
uintN flags, \
JSObject **objp) \
{ \
return JS_TRUE; \
} \
static struct JSClass cname##_class = { \
type_name, \
JSCLASS_HAS_PRIVATE | \
JSCLASS_NEW_RESOLVE | \
JSCLASS_NEW_RESOLVE_GETS_START, \
JS_PropertyStub, \
JS_PropertyStub, \
JS_PropertyStub, \
JS_PropertyStub,\
JS_EnumerateStub,\
(JSResolveOp) cname##_new_resolve, \
JS_ConvertStub, \
cname##_finalize, \
NULL, \
NULL, \
NULL, \
NULL, NULL, NULL, NULL, NULL \
}; \
jsval cname##_create_proto(JSContext *context, JSObject *module, const char *proto_name, JSObject *parent) \
{ \
jsval rval; \
JSContext *load_context = gjs_runtime_get_load_context(JS_GetRuntime(context)); \
JSObject *global = JS_GetGlobalObject(context); \
if (!gjs_object_has_property(load_context, global, \
cname##_class.name)) { \
JSObject *prototype = JS_InitClass(load_context, global, \
parent, \
&cname##_class, \
ctor, \
0, \
&cname##_proto_props[0], \
&cname##_proto_funcs[0], \
NULL, \
NULL); \
if (prototype == NULL) { \
gjs_move_exception(load_context, context); \
return JSVAL_NULL; \
} \
if (!gjs_object_require_property( \
load_context, global, NULL, \
cname##_class.name, &rval)) { \
gjs_move_exception(load_context, context); \
return JSVAL_NULL; \
} \
} \
if (!JS_DefineProperty(context, module, proto_name, \
rval, NULL, NULL, GJS_MODULE_PROP_FLAGS)) \
return JS_FALSE; \
return rval; \
}
gboolean gjs_init_context_standard (JSContext *context);
void* gjs_runtime_get_data (JSRuntime *runtime,
const char *name);
void gjs_runtime_set_data (JSRuntime *runtime,
const char *name,
void *data,
GDestroyNotify dnotify);
JSContext* gjs_runtime_get_load_context (JSRuntime *runtime);
JSContext* gjs_runtime_peek_load_context (JSRuntime *runtime);
void gjs_runtime_clear_load_context (JSRuntime *runtime);
JSContext* gjs_runtime_get_call_context (JSRuntime *runtime);
void gjs_runtime_clear_call_context (JSRuntime *runtime);
gboolean gjs_object_has_property (JSContext *context,
JSObject *obj,
const char *property_name);
gboolean gjs_object_get_property (JSContext *context,
JSObject *obj,
const char *property_name,
jsval *value_p);
gboolean gjs_object_require_property (JSContext *context,
JSObject *obj,
const char *obj_description,
const char *property_name,
jsval *value_p);
JSObject * gjs_init_class_dynamic (JSContext *context,
JSObject *in_object,
JSObject *parent_proto,
const char *ns_name,
const char *class_name,
JSClass *clasp,
JSNative constructor,
uintN nargs,
JSPropertySpec *ps,
JSFunctionSpec *fs,
JSPropertySpec *static_ps,
JSFunctionSpec *static_fs);
gboolean gjs_check_constructing (JSContext *context);
void* gjs_get_instance_private_dynamic (JSContext *context,
JSObject *obj,
JSClass *static_clasp,
jsval *argv);
void* gjs_get_instance_private_dynamic_with_typecheck (JSContext *context,
JSObject *obj,
JSClass *static_clasp,
jsval *argv);
JSObject* gjs_construct_object_dynamic (JSContext *context,
JSObject *proto,
uintN argc,
jsval *argv);
JSObject* gjs_define_string_array (JSContext *context,
JSObject *obj,
const char *array_name,
gssize array_length,
const char **array_values,
uintN attrs);
void gjs_throw (JSContext *context,
const char *format,
...) G_GNUC_PRINTF (2, 3);
void gjs_throw_literal (JSContext *context,
const char *string);
void gjs_throw_g_error (JSContext *context,
GError *error);
JSBool gjs_log_exception (JSContext *context,
char **message_p);
JSBool gjs_log_and_keep_exception (JSContext *context,
char **message_p);
JSBool gjs_move_exception (JSContext *src_context,
JSContext *dest_context);
void gjs_log_exception_props (JSContext *context,
jsval exc);
#ifdef __GJS_UTIL_LOG_H__
void gjs_log_object_props (JSContext *context,
JSObject *obj,
GjsDebugTopic topic,
const char *prefix);
#endif
const char* gjs_value_debug_string (JSContext *context,
jsval value);
void gjs_explain_scope (JSContext *context,
const char *title);
JSBool gjs_call_function_value (JSContext *context,
JSObject *obj,
jsval fval,
uintN argc,
jsval *argv,
jsval *rval);
void gjs_error_reporter (JSContext *context,
const char *message,
JSErrorReport *report);
JSBool gjs_get_prop_verbose_stub (JSContext *context,
JSObject *obj,
jsval id,
jsval *value_p);
JSBool gjs_set_prop_verbose_stub (JSContext *context,
JSObject *obj,
jsval id,
jsval *value_p);
JSBool gjs_add_prop_verbose_stub (JSContext *context,
JSObject *obj,
jsval id,
jsval *value_p);
JSBool gjs_delete_prop_verbose_stub (JSContext *context,
JSObject *obj,
jsval id,
jsval *value_p);
JSBool gjs_string_to_utf8 (JSContext *context,
const jsval string_val,
char **utf8_string_p);
JSBool gjs_string_from_utf8 (JSContext *context,
const char *utf8_string,
gssize n_bytes,
jsval *value_p);
JSBool gjs_string_to_filename (JSContext *context,
const jsval string_val,
char **filename_string_p);
JSBool gjs_string_from_filename (JSContext *context,
const char *filename_string,
gssize n_bytes,
jsval *value_p);
const char* gjs_string_get_ascii (jsval value);
const char* gjs_string_get_ascii_checked (JSContext *context,
jsval value);
JSBool gjs_string_get_binary_data (JSContext *context,
jsval value,
char **data_p,
gsize *len_p);
JSBool gjs_string_from_binary_data (JSContext *context,
const char *data,
gsize len,
jsval *value_p);
JSBool gjs_string_get_uint16_data (JSContext *context,
jsval value,
guint16 **data_p,
gsize *len_p);
JSBool gjs_get_string_id (JSContext *context,
jsid id,
const char **name_p);
const char* gjs_get_type_name (jsval value);
jsval gjs_date_from_time_t (JSContext *context, time_t time);
JSBool gjs_parse_args (JSContext *context,
const char *function_name,
const char *format,
uintN argc,
jsval *argv,
...);
GjsRootedArray* gjs_rooted_array_new (void);
void gjs_rooted_array_append (JSContext *context,
GjsRootedArray *array,
jsval value);
jsval gjs_rooted_array_get (JSContext *context,
GjsRootedArray *array,
int i);
jsval* gjs_rooted_array_get_data (JSContext *context,
GjsRootedArray *array);
int gjs_rooted_array_get_length (JSContext *context,
GjsRootedArray *array);
jsval* gjs_rooted_array_free (JSContext *context,
GjsRootedArray *array,
gboolean free_segment);
void gjs_set_values (JSContext *context,
jsval *locations,
int n_locations,
jsval initializer);
void gjs_root_value_locations (JSContext *context,
jsval *locations,
int n_locations);
void gjs_unroot_value_locations (JSContext *context,
jsval *locations,
int n_locations);
/* Functions intended for more "internal" use */
gboolean gjs_try_string_to_filename (JSContext *context,
const jsval filename_val,
char **filename_string_p,
GError **error);
gboolean gjs_try_string_to_utf8 (JSContext *context,
const jsval string_val,
char **utf8_string_p,
GError **error);
G_END_DECLS
#endif /* __GJS_JSAPI_UTIL_H__ */
|
