1 /* -*- mode: C++; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
2 // SPDX-License-Identifier: MIT OR LGPL-2.0-or-later
3 // SPDX-FileCopyrightText: 2017 Philip Chimento <philip.chimento@gmail.com>
4 // SPDX-FileCopyrightText: 2020 Evan Welsh <contact@evanwelsh.com>
5
6 #ifndef GJS_GLOBAL_H_
7 #define GJS_GLOBAL_H_
8
9 #include <config.h>
10
11 #include <js/RootingAPI.h> // for Handle
12 #include <js/TypeDecls.h>
13 #include <js/Value.h>
14
15 #include <stdint.h>
16
17 #include "gjs/macros.h"
18
19 namespace JS {
20 struct PropertyKey;
21 }
22
23 enum class GjsGlobalType {
24 DEFAULT,
25 DEBUGGER,
26 INTERNAL,
27 };
28
29 enum class GjsBaseGlobalSlot : uint32_t {
30 GLOBAL_TYPE = 0,
31 LAST,
32 };
33
34 enum class GjsDebuggerGlobalSlot : uint32_t {
35 LAST = static_cast<uint32_t>(GjsBaseGlobalSlot::LAST),
36 };
37
38 enum class GjsGlobalSlot : uint32_t {
39 IMPORTS = static_cast<uint32_t>(GjsBaseGlobalSlot::LAST),
40 // Stores an object with methods to resolve and load modules
41 MODULE_LOADER,
42 // Stores the module registry (a Map object)
43 MODULE_REGISTRY,
44 NATIVE_REGISTRY,
45 PROTOTYPE_gtype,
46 PROTOTYPE_importer,
47 PROTOTYPE_function,
48 PROTOTYPE_ns,
49 PROTOTYPE_cairo_context,
50 PROTOTYPE_cairo_gradient,
51 PROTOTYPE_cairo_image_surface,
52 PROTOTYPE_cairo_linear_gradient,
53 PROTOTYPE_cairo_path,
54 PROTOTYPE_cairo_pattern,
55 PROTOTYPE_cairo_pdf_surface,
56 PROTOTYPE_cairo_ps_surface,
57 PROTOTYPE_cairo_radial_gradient,
58 PROTOTYPE_cairo_region,
59 PROTOTYPE_cairo_solid_pattern,
60 PROTOTYPE_cairo_surface,
61 PROTOTYPE_cairo_surface_pattern,
62 PROTOTYPE_cairo_svg_surface,
63 LAST,
64 };
65
66 enum class GjsInternalGlobalSlot : uint32_t {
67 LAST = static_cast<uint32_t>(GjsGlobalSlot::LAST),
68 };
69
70 bool gjs_global_is_type(JSContext* cx, GjsGlobalType type);
71 GjsGlobalType gjs_global_get_type(JSContext* cx);
72 GjsGlobalType gjs_global_get_type(JSObject* global);
73
74 GJS_JSAPI_RETURN_CONVENTION
75 bool gjs_global_registry_set(JSContext* cx, JS::HandleObject registry,
76 JS::PropertyKey key, JS::HandleObject value);
77 GJS_JSAPI_RETURN_CONVENTION
78 bool gjs_global_registry_get(JSContext* cx, JS::HandleObject registry,
79 JS::PropertyKey key,
80 JS::MutableHandleObject value);
81
82 GJS_JSAPI_RETURN_CONVENTION
83 JSObject* gjs_create_global_object(JSContext* cx, GjsGlobalType global_type,
84 JS::HandleObject existing_global = nullptr);
85
86 GJS_JSAPI_RETURN_CONVENTION
87 bool gjs_define_global_properties(JSContext* cx, JS::HandleObject global,
88 GjsGlobalType global_type,
89 const char* realm_name,
90 const char* bootstrap_script);
91
92 namespace detail {
93 void set_global_slot(JSObject* global, uint32_t slot, JS::Value value);
94 JS::Value get_global_slot(JSObject* global, uint32_t slot);
95 } // namespace detail
96
97 template <typename Slot>
gjs_set_global_slot(JSObject * global,Slot slot,JS::Value value)98 inline void gjs_set_global_slot(JSObject* global, Slot slot, JS::Value value) {
99 static_assert(std::is_same_v<GjsBaseGlobalSlot, Slot> ||
100 std::is_same_v<GjsGlobalSlot, Slot> ||
101 std::is_same_v<GjsInternalGlobalSlot, Slot> ||
102 std::is_same_v<GjsDebuggerGlobalSlot, Slot>,
103 "Must use a GJS global slot enum");
104 detail::set_global_slot(global, static_cast<uint32_t>(slot), value);
105 }
106
107 template <typename Slot>
gjs_get_global_slot(JSObject * global,Slot slot)108 inline JS::Value gjs_get_global_slot(JSObject* global, Slot slot) {
109 static_assert(std::is_same_v<GjsBaseGlobalSlot, Slot> ||
110 std::is_same_v<GjsGlobalSlot, Slot> ||
111 std::is_same_v<GjsInternalGlobalSlot, Slot> ||
112 std::is_same_v<GjsDebuggerGlobalSlot, Slot>,
113 "Must use a GJS global slot enum");
114 return detail::get_global_slot(global, static_cast<uint32_t>(slot));
115 }
116
117 #endif // GJS_GLOBAL_H_
118