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
|
/* -*- mode: C++; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
// SPDX-License-Identifier: MIT OR LGPL-2.0-or-later
// SPDX-FileCopyrightText: 2008 litl, LLC
#include <config.h>
#include <string.h>
#include <vector>
#include <glib.h>
#include <js/CallArgs.h>
#include <js/Class.h>
#include <js/ComparisonOperators.h>
#include <js/ErrorReport.h> // for JS_ReportOutOfMemory
#include <js/GCVector.h> // for MutableHandleIdVector
#include <js/Id.h>
#include <js/PropertyDescriptor.h> // for JSPROP_READONLY
#include <js/PropertySpec.h>
#include <js/RootingAPI.h>
#include <js/TypeDecls.h>
#include <js/Utility.h> // for UniqueChars
#include <jsapi.h> // for JS_NewObjectWithGivenProto
#include <mozilla/Maybe.h>
#include "gi/cwrapper.h"
#include "gi/info.h"
#include "gi/ns.h"
#include "gi/repo.h"
#include "gjs/atoms.h"
#include "gjs/auto.h"
#include "gjs/context-private.h"
#include "gjs/deprecation.h"
#include "gjs/global.h"
#include "gjs/jsapi-util.h"
#include "gjs/macros.h"
#include "gjs/mem-private.h"
#include "util/log.h"
using mozilla::Maybe;
// helper function
void platform_specific_warning_glib(JSContext* cx, const char* prefix,
const char* platform,
const char* resolved_name) {
if (!g_str_has_prefix(resolved_name, prefix))
return;
const char* base_name = resolved_name + strlen(prefix);
Gjs::AutoChar old_name{g_strdup_printf("GLib.%s", resolved_name)};
Gjs::AutoChar new_name{g_strdup_printf("GLib%s.%s", platform, base_name)};
_gjs_warn_deprecated_once_per_callsite(
cx, GjsDeprecationMessageId::PlatformSpecificTypelib,
{old_name.get(), new_name.get()});
}
class Ns : private Gjs::AutoChar, public CWrapper<Ns> {
friend CWrapperPointerOps<Ns>;
friend CWrapper<Ns>;
static constexpr auto PROTOTYPE_SLOT = GjsGlobalSlot::PROTOTYPE_ns;
static constexpr GjsDebugTopic DEBUG_TOPIC = GJS_DEBUG_GNAMESPACE;
explicit Ns(const char* ns_name)
: Gjs::AutoChar(const_cast<char*>(ns_name), Gjs::TakeOwnership{}) {
GJS_INC_COUNTER(ns);
m_is_glib = strcmp(ns_name, "GLib") == 0;
}
~Ns() { GJS_DEC_COUNTER(ns); }
bool m_is_glib : 1;
// JSClass operations
// The *resolved out parameter, on success, should be false to indicate that
// id was not resolved; and true if id was resolved.
GJS_JSAPI_RETURN_CONVENTION
bool resolve_impl(JSContext* cx, JS::HandleObject obj, JS::HandleId id,
bool* resolved) {
if (!id.isString()) {
*resolved = false;
return true; // not resolved, but no error
}
// let Object.prototype resolve these
const GjsAtoms& atoms = GjsContextPrivate::atoms(cx);
if (id == atoms.to_string() || id == atoms.value_of()) {
*resolved = false;
return true;
}
JS::UniqueChars name;
if (!gjs_get_string_id(cx, id, &name))
return false;
if (!name) {
*resolved = false;
return true; // not resolved, but no error
}
Maybe<GI::AutoBaseInfo> info{
GI::Repository{}.find_by_name(get(), name.get())};
if (!info) {
*resolved = false; // No property defined, but no error either
return true;
}
gjs_debug(GJS_DEBUG_GNAMESPACE,
"Found info type %s for '%s' in namespace '%s'",
info->type_string(), info->name(), info->ns());
if (m_is_glib) {
platform_specific_warning_glib(cx, "Unix", "Unix", name.get());
platform_specific_warning_glib(cx, "unix_", "Unix", name.get());
platform_specific_warning_glib(cx, "Win32", "Win32", name.get());
platform_specific_warning_glib(cx, "win32_", "Win32", name.get());
}
bool defined;
if (!gjs_define_info(cx, obj, info.ref(), &defined)) {
gjs_debug(GJS_DEBUG_GNAMESPACE, "Failed to define info '%s'",
info->name());
return false;
}
// we defined the property in this object?
*resolved = defined;
return true;
}
GJS_JSAPI_RETURN_CONVENTION
bool new_enumerate_impl(JSContext* cx,
JS::HandleObject obj [[maybe_unused]],
JS::MutableHandleIdVector properties,
bool only_enumerable [[maybe_unused]]) {
GI::Repository::Iterator infos{GI::Repository{}.infos(get())};
if (!properties.reserve(properties.length() + infos.size())) {
JS_ReportOutOfMemory(cx);
return false;
}
for (GI::AutoBaseInfo info : infos) {
if (!info.is_enumerable())
continue;
jsid id = gjs_intern_string_to_id(cx, info.name());
if (id.isVoid())
return false;
properties.infallibleAppend(id);
}
return true;
}
static void finalize_impl(JS::GCContext*, Ns* priv) {
g_assert(priv && "Finalize called on wrong object");
delete priv;
}
// Properties and methods
GJS_JSAPI_RETURN_CONVENTION
static bool get_name(JSContext* cx, unsigned argc, JS::Value* vp) {
GJS_CHECK_WRAPPER_PRIV(cx, argc, vp, args, this_obj, Ns, priv);
return gjs_string_from_utf8(cx, priv->get(), args.rval());
}
GJS_JSAPI_RETURN_CONVENTION
static bool get_version(JSContext* cx, unsigned argc, JS::Value* vp) {
GJS_CHECK_WRAPPER_PRIV(cx, argc, vp, args, this_obj, Ns, priv);
const char* version = GI::Repository{}.get_version(priv->get());
return gjs_string_from_utf8(cx, version, args.rval());
}
static constexpr JSClassOps class_ops = {
nullptr, // addProperty
nullptr, // deleteProperty
nullptr, // enumerate
&Ns::new_enumerate,
&Ns::resolve,
nullptr, // mayResolve
&Ns::finalize,
};
// clang-format off
static constexpr JSPropertySpec proto_props[] = {
JS_STRING_SYM_PS(toStringTag, "GIRepositoryNamespace", JSPROP_READONLY),
JS_PSG("__name__", &Ns::get_name, GJS_MODULE_PROP_FLAGS),
JS_PSG("__version__", &Ns::get_version, GJS_MODULE_PROP_FLAGS & ~JSPROP_ENUMERATE),
JS_PS_END};
// clang-format on
static constexpr js::ClassSpec class_spec = {
nullptr, // createConstructor
nullptr, // createPrototype
nullptr, // constructorFunctions
nullptr, // constructorProperties
nullptr, // prototypeFunctions
Ns::proto_props,
nullptr, // finishInit
js::ClassSpec::DontDefineConstructor};
static constexpr JSClass klass = {
"GIRepositoryNamespace",
JSCLASS_HAS_RESERVED_SLOTS(1) | JSCLASS_FOREGROUND_FINALIZE,
&Ns::class_ops, &Ns::class_spec};
public:
GJS_JSAPI_RETURN_CONVENTION
static JSObject* create(JSContext* cx, const char* ns_name) {
JS::RootedObject proto(cx, Ns::create_prototype(cx));
if (!proto)
return nullptr;
JS::RootedObject ns(cx,
JS_NewObjectWithGivenProto(cx, &Ns::klass, proto));
if (!ns)
return nullptr;
auto* priv = new Ns(ns_name);
Ns::init_private(ns, priv);
gjs_debug_lifecycle(GJS_DEBUG_GNAMESPACE,
"ns constructor, obj %p priv %p", ns.get(), priv);
return ns;
}
};
JSObject*
gjs_create_ns(JSContext *context,
const char *ns_name)
{
return Ns::create(context, ns_name);
}
|