/usr/include/gjs-1.0/gjs/jsapi-util.h is in libgjs-dev 1.44.0-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 | /* -*- 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_MODULE_H__) && !defined (GJS_COMPILATION)
#error "Only <gjs/gjs-module.h> can be included directly."
#endif
#include <gjs/compat.h>
#include <gjs/runtime.h>
#include <glib-object.h>
#include <gi/gtype.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 enum {
GJS_GLOBAL_SLOT_IMPORTS,
GJS_GLOBAL_SLOT_KEEP_ALIVE,
GJS_GLOBAL_SLOT_BYTE_ARRAY_PROTOTYPE,
GJS_GLOBAL_SLOT_LAST,
} GjsGlobalSlot;
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_PERMANENT | JSPROP_ENUMERATE)
/*
* Helper methods to access private data:
*
* do_base_typecheck: checks that object has the right JSClass, and possibly
* throw a TypeError exception if the check fails
* priv_from_js: accesses the object private field; as a debug measure,
* it also checks that the object is of a compatible
* JSClass, but it doesn't raise an exception (it
* wouldn't be of much use, if subsequent code crashes on
* NULL)
* priv_from_js_with_typecheck: a convenience function to call
* do_base_typecheck and priv_from_js
*/
#define GJS_DEFINE_PRIV_FROM_JS(type, klass) \
__attribute__((unused)) static inline JSBool \
do_base_typecheck(JSContext *context, \
JSObject *object, \
JSBool throw_error) \
{ \
return gjs_typecheck_instance(context, object, &klass, throw_error); \
} \
static inline type * \
priv_from_js(JSContext *context, \
JSObject *object) \
{ \
type *priv; \
JS_BeginRequest(context); \
priv = (type*) JS_GetInstancePrivate(context, object, &klass, NULL); \
JS_EndRequest(context); \
return priv; \
} \
__attribute__((unused)) static JSBool \
priv_from_js_with_typecheck(JSContext *context, \
JSObject *object, \
type **out) \
{ \
if (!do_base_typecheck(context, object, JS_FALSE)) \
return JS_FALSE; \
*out = priv_from_js(context, object); \
return JS_TRUE; \
}
/**
* GJS_DEFINE_PROTO:
* @tn: The name of the prototype, as a string
* @cn: The name of the prototype, separated by _
* @flags: additional JSClass flags, such as JSCLASS_BACKGROUND_FINALIZE
*
* A convenience macro for prototype implementations.
*/
#define GJS_DEFINE_PROTO(tn, cn, flags) \
GJS_NATIVE_CONSTRUCTOR_DECLARE(cn); \
_GJS_DEFINE_PROTO_FULL(tn, cn, gjs_##cn##_constructor, G_TYPE_NONE, flags)
/**
* 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, flags) \
_GJS_DEFINE_PROTO_FULL(tn, cn, NULL, G_TYPE_NONE, flags)
#define GJS_DEFINE_PROTO_WITH_GTYPE(tn, cn, gtype, flags) \
GJS_NATIVE_CONSTRUCTOR_DECLARE(cn); \
_GJS_DEFINE_PROTO_FULL(tn, cn, gjs_##cn##_constructor, gtype, flags)
#define GJS_DEFINE_PROTO_ABSTRACT_WITH_GTYPE(tn, cn, gtype, flags) \
_GJS_DEFINE_PROTO_FULL(tn, cn, NULL, gtype, flags)
#define _GJS_DEFINE_PROTO_FULL(type_name, cname, ctor, gtype, jsclass_flags) \
extern JSPropertySpec gjs_##cname##_proto_props[]; \
extern JSFunctionSpec gjs_##cname##_proto_funcs[]; \
static void gjs_##cname##_finalize(JSFreeOp *fop, JSObject *obj); \
static JSBool gjs_##cname##_new_resolve(JSContext *context, \
JSObject *obj, \
jsval id, \
unsigned flags, \
JSObject **objp) \
{ \
return JS_TRUE; \
} \
static struct JSClass gjs_##cname##_class = { \
type_name, \
JSCLASS_HAS_PRIVATE | \
JSCLASS_NEW_RESOLVE | jsclass_flags, \
JS_PropertyStub, \
JS_DeletePropertyStub, \
JS_PropertyStub, \
JS_StrictPropertyStub, \
JS_EnumerateStub,\
(JSResolveOp) gjs_##cname##_new_resolve, \
JS_ConvertStub, \
gjs_##cname##_finalize, \
NULL, \
NULL, \
NULL, NULL, NULL \
}; \
jsval gjs_##cname##_create_proto(JSContext *context, JSObject *module, const char *proto_name, JSObject *parent) \
{ \
jsval rval; \
JSObject *global = gjs_get_import_global(context); \
jsid class_name = gjs_intern_string_to_id(context, gjs_##cname##_class.name); \
if (!JS_GetPropertyById(context, global, class_name, &rval)) \
return JSVAL_NULL; \
if (JSVAL_IS_VOID(rval)) { \
jsval value; \
JSObject *prototype = JS_InitClass(context, global, \
parent, \
&gjs_##cname##_class, \
ctor, \
0, \
&gjs_##cname##_proto_props[0], \
&gjs_##cname##_proto_funcs[0], \
NULL, \
NULL); \
if (prototype == NULL) { \
return JSVAL_NULL; \
} \
if (!gjs_object_require_property( \
context, global, NULL, \
class_name, &rval)) { \
return JSVAL_NULL; \
} \
if (!JS_DefineProperty(context, module, proto_name, \
rval, NULL, NULL, GJS_MODULE_PROP_FLAGS)) \
return JSVAL_NULL; \
if (gtype != G_TYPE_NONE) { \
value = OBJECT_TO_JSVAL(gjs_gtype_create_gtype_wrapper(context, gtype)); \
JS_DefineProperty(context, JSVAL_TO_OBJECT(rval), "$gtype", value, \
NULL, NULL, JSPROP_PERMANENT); \
} \
} \
return rval; \
}
gboolean gjs_init_context_standard (JSContext *context,
JSObject **global_out);
JSObject* gjs_get_import_global (JSContext *context);
jsval gjs_get_global_slot (JSContext *context,
GjsGlobalSlot slot);
void gjs_set_global_slot (JSContext *context,
GjsGlobalSlot slot,
jsval value);
gboolean gjs_object_require_property (JSContext *context,
JSObject *obj,
const char *obj_description,
jsid property_name,
jsval *value_p);
JSObject *gjs_new_object_for_constructor (JSContext *context,
JSClass *clasp,
jsval *vp);
JSBool gjs_init_class_dynamic (JSContext *context,
JSObject *in_object,
JSObject *parent_proto,
const char *ns_name,
const char *class_name,
JSClass *clasp,
JSNative constructor,
unsigned nargs,
JSPropertySpec *ps,
JSFunctionSpec *fs,
JSPropertySpec *static_ps,
JSFunctionSpec *static_fs,
JSObject **constructor_p,
JSObject **prototype_p);
void gjs_throw_constructor_error (JSContext *context);
void gjs_throw_abstract_constructor_error (JSContext *context,
jsval *vp);
JSBool gjs_typecheck_instance (JSContext *context,
JSObject *obj,
JSClass *static_clasp,
JSBool _throw);
JSObject* gjs_construct_object_dynamic (JSContext *context,
JSObject *proto,
unsigned argc,
jsval *argv);
JSObject* gjs_build_string_array (JSContext *context,
gssize array_length,
char **array_values);
JSObject* gjs_define_string_array (JSContext *context,
JSObject *obj,
const char *array_name,
gssize array_length,
const char **array_values,
unsigned attrs);
void gjs_throw (JSContext *context,
const char *format,
...) G_GNUC_PRINTF (2, 3);
void gjs_throw_custom (JSContext *context,
const char *error_class,
const char *format,
...) G_GNUC_PRINTF (3, 4);
void gjs_throw_literal (JSContext *context,
const char *string);
void gjs_throw_g_error (JSContext *context,
GError *error);
JSBool gjs_log_exception (JSContext *context);
JSBool gjs_log_and_keep_exception (JSContext *context);
JSBool gjs_move_exception (JSContext *src_context,
JSContext *dest_context);
JSBool gjs_log_exception_full (JSContext *context,
jsval exc,
JSString *message);
#ifdef __GJS_UTIL_LOG_H__
void gjs_log_object_props (JSContext *context,
JSObject *obj,
GjsDebugTopic topic,
const char *prefix);
#endif
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,
unsigned argc,
jsval *argv,
jsval *rval);
void gjs_error_reporter (JSContext *context,
const char *message,
JSErrorReport *report);
JSObject* gjs_get_global_object (JSContext *cx);
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);
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,
char **name_p);
jsid gjs_intern_string_to_id (JSContext *context,
const char *string);
gboolean gjs_unichar_from_string (JSContext *context,
jsval string,
gunichar *result);
const char* gjs_get_type_name (jsval value);
JSBool gjs_value_to_int64 (JSContext *context,
const jsval val,
gint64 *result);
JSBool gjs_parse_args (JSContext *context,
const char *function_name,
const char *format,
unsigned argc,
jsval *argv,
...);
JSBool gjs_parse_call_args (JSContext *context,
const char *function_name,
const char *format,
JS::CallArgs &args,
...);
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 */
void gjs_maybe_gc (JSContext *context);
JSBool gjs_context_get_frame_info (JSContext *context,
jsval *stack,
jsval *fileName,
jsval *lineNumber);
JSBool gjs_eval_with_scope (JSContext *context,
JSObject *object,
const char *script,
gssize script_len,
const char *filename,
jsval *retval_p);
typedef enum {
GJS_STRING_CONSTRUCTOR,
GJS_STRING_PROTOTYPE,
GJS_STRING_LENGTH,
GJS_STRING_IMPORTS,
GJS_STRING_PARENT_MODULE,
GJS_STRING_MODULE_INIT,
GJS_STRING_SEARCH_PATH,
GJS_STRING_KEEP_ALIVE_MARKER,
GJS_STRING_PRIVATE_NS_MARKER,
GJS_STRING_GI_MODULE,
GJS_STRING_GI_VERSIONS,
GJS_STRING_GI_OVERRIDES,
GJS_STRING_GOBJECT_INIT,
GJS_STRING_INSTANCE_INIT,
GJS_STRING_NEW_INTERNAL,
GJS_STRING_NEW,
GJS_STRING_MESSAGE,
GJS_STRING_CODE,
GJS_STRING_STACK,
GJS_STRING_FILENAME,
GJS_STRING_LINE_NUMBER,
GJS_STRING_NAME,
GJS_STRING_X,
GJS_STRING_Y,
GJS_STRING_WIDTH,
GJS_STRING_HEIGHT,
GJS_STRING_LAST
} GjsConstString;
jsid gjs_context_get_const_string (JSContext *context,
GjsConstString string);
gboolean gjs_object_get_property_const (JSContext *context,
JSObject *obj,
GjsConstString property_name,
jsval *value_p);
const char * gjs_strip_unix_shebang(const char *script,
gssize *script_len,
int *new_start_line_number);
G_END_DECLS
#endif /* __GJS_JSAPI_UTIL_H__ */
|