LCOV - code coverage report
Current view: top level - gjs - byteArray.cpp (source / functions) Hit Total Coverage
Test: gjs- Code Coverage Lines: 89 103 86.4 %
Date: 2024-02-27 17:05:05 Functions: 11 11 100.0 %
Legend: Lines: hit not hit | Branches: + taken - not taken # not executed Branches: 30 52 57.7 %

           Branch data     Line data    Source code
       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: 2010 litl, LLC
       4                 :            : 
       5                 :            : #include <config.h>
       6                 :            : 
       7                 :            : #include <stdint.h>
       8                 :            : 
       9                 :            : #include <glib-object.h>
      10                 :            : #include <glib.h>
      11                 :            : 
      12                 :            : #include <js/ArrayBuffer.h>
      13                 :            : #include <js/CallArgs.h>
      14                 :            : #include <js/PropertyAndElement.h>
      15                 :            : #include <js/PropertySpec.h>
      16                 :            : #include <js/RootingAPI.h>
      17                 :            : #include <js/TypeDecls.h>
      18                 :            : #include <js/Utility.h>   // for UniqueChars
      19                 :            : #include <js/experimental/TypedData.h>
      20                 :            : #include <jsapi.h>  // for JS_NewPlainObject
      21                 :            : 
      22                 :            : #include "gi/boxed.h"
      23                 :            : #include "gjs/atoms.h"
      24                 :            : #include "gjs/byteArray.h"
      25                 :            : #include "gjs/context-private.h"
      26                 :            : #include "gjs/deprecation.h"
      27                 :            : #include "gjs/jsapi-util-args.h"
      28                 :            : #include "gjs/jsapi-util.h"
      29                 :            : #include "gjs/macros.h"
      30                 :            : #include "gjs/text-encoding.h"
      31                 :            : #include "util/misc.h"  // for _gjs_memdup2
      32                 :            : 
      33                 :            : // Callback to use with JS::NewExternalArrayBuffer()
      34                 :            : 
      35                 :        348 : static void bytes_unref_arraybuffer(void* contents [[maybe_unused]],
      36                 :            :                                     void* user_data) {
      37                 :        348 :     auto* gbytes = static_cast<GBytes*>(user_data);
      38                 :        348 :     g_bytes_unref(gbytes);
      39                 :        348 : }
      40                 :            : 
      41                 :            : GJS_JSAPI_RETURN_CONVENTION
      42                 :          9 : static bool to_string_func(JSContext* cx, unsigned argc, JS::Value* vp) {
      43                 :          9 :     JS::CallArgs args = JS::CallArgsFromVp(argc, vp);
      44                 :          9 :     JS::UniqueChars encoding;
      45                 :          9 :     JS::RootedObject byte_array(cx);
      46                 :            : 
      47         [ -  + ]:          9 :     if (!gjs_parse_call_args(cx, "toString", args, "o|s", "byteArray",
      48                 :            :                              &byte_array, "encoding", &encoding))
      49                 :          0 :         return false;
      50                 :            : 
      51         [ +  + ]:          9 :     const char* actual_encoding = encoding ? encoding.get() : "utf-8";
      52                 :            :     JS::RootedString str(
      53                 :          9 :         cx, gjs_decode_from_uint8array(cx, byte_array, actual_encoding,
      54                 :          9 :                                        GjsStringTermination::ZERO_TERMINATED, true));
      55         [ +  + ]:          9 :     if (!str)
      56                 :          1 :         return false;
      57                 :            : 
      58                 :          8 :     args.rval().setString(str);
      59                 :          8 :     return true;
      60                 :          9 : }
      61                 :            : 
      62                 :            : /* Workaround to keep existing code compatible. This function is tacked onto
      63                 :            :  * any Uint8Array instances created in situations where previously a ByteArray
      64                 :            :  * would have been created. It logs a compatibility warning. */
      65                 :            : GJS_JSAPI_RETURN_CONVENTION
      66                 :          2 : static bool instance_to_string_func(JSContext* cx, unsigned argc,
      67                 :            :                                     JS::Value* vp) {
      68         [ -  + ]:          2 :     GJS_GET_THIS(cx, argc, vp, args, this_obj);
      69                 :          2 :     JS::UniqueChars encoding;
      70                 :            : 
      71                 :          2 :     _gjs_warn_deprecated_once_per_callsite(
      72                 :            :         cx, GjsDeprecationMessageId::ByteArrayInstanceToString);
      73                 :            : 
      74         [ -  + ]:          2 :     if (!gjs_parse_call_args(cx, "toString", args, "|s", "encoding", &encoding))
      75                 :          0 :         return false;
      76                 :            : 
      77         [ -  + ]:          2 :     const char* actual_encoding = encoding ? encoding.get() : "utf-8";
      78                 :            :     JS::RootedString str(
      79                 :          2 :         cx, gjs_decode_from_uint8array(cx, this_obj, actual_encoding,
      80                 :          2 :                                        GjsStringTermination::ZERO_TERMINATED, true));
      81         [ -  + ]:          2 :     if (!str)
      82                 :          0 :         return false;
      83                 :            : 
      84                 :          2 :     args.rval().setString(str);
      85                 :          2 :     return true;
      86                 :          2 : }
      87                 :            : 
      88                 :            : GJS_JSAPI_RETURN_CONVENTION
      89                 :        370 : static bool define_legacy_tostring(JSContext* cx, JS::HandleObject array) {
      90                 :        370 :     const GjsAtoms& atoms = GjsContextPrivate::atoms(cx);
      91                 :        370 :     return JS_DefineFunctionById(cx, array, atoms.to_string(),
      92                 :        370 :                                  instance_to_string_func, 1, 0);
      93                 :            : }
      94                 :            : 
      95                 :            : /* fromString() function implementation */
      96                 :            : GJS_JSAPI_RETURN_CONVENTION
      97                 :         21 : static bool from_string_func(JSContext* cx, unsigned argc, JS::Value* vp) {
      98                 :         21 :     JS::CallArgs args = JS::CallArgsFromVp(argc, vp);
      99                 :         21 :     JS::RootedString str(cx);
     100                 :         21 :     JS::UniqueChars encoding;
     101         [ -  + ]:         21 :     if (!gjs_parse_call_args(cx, "fromString", args, "S|s", "string", &str,
     102                 :            :                              "encoding", &encoding))
     103                 :          0 :         return false;
     104                 :            : 
     105         [ +  + ]:         21 :     const char* actual_encoding = encoding ? encoding.get() : "utf-8";
     106                 :            :     JS::RootedObject uint8array(
     107                 :         21 :         cx, gjs_encode_to_uint8array(cx, str, actual_encoding,
     108                 :         21 :                                      GjsStringTermination::ZERO_TERMINATED));
     109   [ +  -  -  +  :         21 :     if (!uint8array || !define_legacy_tostring(cx, uint8array))
                   -  + ]
     110                 :          0 :         return false;
     111                 :            : 
     112                 :         21 :     args.rval().setObject(*uint8array);
     113                 :         21 :     return true;
     114                 :         21 : }
     115                 :            : 
     116                 :            : GJS_JSAPI_RETURN_CONVENTION
     117                 :            : static bool
     118                 :        349 : from_gbytes_func(JSContext *context,
     119                 :            :                  unsigned   argc,
     120                 :            :                  JS::Value *vp)
     121                 :            : {
     122                 :        349 :     JS::CallArgs argv = JS::CallArgsFromVp (argc, vp);
     123                 :        349 :     JS::RootedObject bytes_obj(context);
     124                 :            :     GBytes *gbytes;
     125                 :            : 
     126         [ -  + ]:        349 :     if (!gjs_parse_call_args(context, "fromGBytes", argv, "o",
     127                 :            :                              "bytes", &bytes_obj))
     128                 :          0 :         return false;
     129                 :            : 
     130         [ -  + ]:        349 :     if (!BoxedBase::typecheck(context, bytes_obj, nullptr, G_TYPE_BYTES))
     131                 :          0 :         return false;
     132                 :            : 
     133                 :        349 :     gbytes = BoxedBase::to_c_ptr<GBytes>(context, bytes_obj);
     134         [ -  + ]:        349 :     if (!gbytes)
     135                 :          0 :         return false;
     136                 :            : 
     137                 :            :     size_t len;
     138                 :        349 :     const void* data = g_bytes_get_data(gbytes, &len);
     139         [ +  + ]:        349 :     if (len == 0) {
     140                 :          1 :         JS::RootedObject empty_array(context, JS_NewUint8Array(context, 0));
     141   [ +  -  -  +  :          1 :         if (!empty_array || !define_legacy_tostring(context, empty_array))
                   -  + ]
     142                 :          0 :             return false;
     143                 :            : 
     144                 :          1 :         argv.rval().setObject(*empty_array);
     145                 :          1 :         return true;
     146                 :          1 :     }
     147                 :            : 
     148                 :            :     JS::RootedObject array_buffer(
     149                 :            :         context,
     150                 :        348 :         JS::NewExternalArrayBuffer(
     151                 :            :             context, len,
     152                 :            :             const_cast<void*>(data),  // the ArrayBuffer won't modify the data
     153                 :        348 :             bytes_unref_arraybuffer, gbytes));
     154         [ -  + ]:        348 :     if (!array_buffer)
     155                 :          0 :         return false;
     156                 :        348 :     g_bytes_ref(gbytes);  // now owned by both ArrayBuffer and BoxedBase
     157                 :            : 
     158                 :            :     JS::RootedObject obj(
     159                 :        348 :         context, JS_NewUint8ArrayWithBuffer(context, array_buffer, 0, -1));
     160   [ +  -  -  +  :        348 :     if (!obj || !define_legacy_tostring(context, obj))
                   -  + ]
     161                 :          0 :         return false;
     162                 :            : 
     163                 :        348 :     argv.rval().setObject(*obj);
     164                 :        348 :     return true;
     165                 :        349 : }
     166                 :            : 
     167                 :         15 : JSObject* gjs_byte_array_from_data(JSContext* cx, size_t nbytes, void* data) {
     168                 :         15 :     JS::RootedObject array_buffer(cx);
     169                 :            :     // a null data pointer takes precedence over whatever `nbytes` says
     170         [ +  - ]:         15 :     if (data)
     171                 :         30 :         array_buffer = JS::NewArrayBufferWithContents(
     172                 :         15 :             cx, nbytes, _gjs_memdup2(data, nbytes));
     173                 :            :     else
     174                 :          0 :         array_buffer = JS::NewArrayBuffer(cx, 0);
     175         [ -  + ]:         15 :     if (!array_buffer)
     176                 :          0 :         return nullptr;
     177                 :            : 
     178                 :            :     JS::RootedObject array(cx,
     179                 :         15 :                            JS_NewUint8ArrayWithBuffer(cx, array_buffer, 0, -1));
     180                 :            : 
     181                 :         15 :     const GjsAtoms& atoms = GjsContextPrivate::atoms(cx);
     182         [ -  + ]:         15 :     if (!JS_DefineFunctionById(cx, array, atoms.to_string(),
     183                 :            :                                instance_to_string_func, 1, 0))
     184                 :          0 :         return nullptr;
     185                 :         15 :     return array;
     186                 :         15 : }
     187                 :            : 
     188                 :         11 : JSObject* gjs_byte_array_from_byte_array(JSContext* cx, GByteArray* array) {
     189                 :         11 :     return gjs_byte_array_from_data(cx, array->len, array->data);
     190                 :            : }
     191                 :            : 
     192                 :         47 : GBytes* gjs_byte_array_get_bytes(JSObject* obj) {
     193                 :            :     bool is_shared_memory;
     194                 :            :     size_t len;
     195                 :            :     uint8_t* data;
     196                 :            : 
     197                 :         47 :     js::GetUint8ArrayLengthAndData(obj, &len, &is_shared_memory, &data);
     198                 :         47 :     return g_bytes_new(data, len);
     199                 :            : }
     200                 :            : 
     201                 :         10 : GByteArray* gjs_byte_array_get_byte_array(JSObject* obj) {
     202                 :         10 :     return g_bytes_unref_to_array(gjs_byte_array_get_bytes(obj));
     203                 :            : }
     204                 :            : 
     205                 :            : static JSFunctionSpec gjs_byte_array_module_funcs[] = {
     206                 :            :     JS_FN("fromString", from_string_func, 2, 0),
     207                 :            :     JS_FN("fromGBytes", from_gbytes_func, 1, 0),
     208                 :            :     JS_FN("toString", to_string_func, 2, 0),
     209                 :            :     JS_FS_END};
     210                 :            : 
     211                 :            : bool
     212                 :         63 : gjs_define_byte_array_stuff(JSContext              *cx,
     213                 :            :                             JS::MutableHandleObject module)
     214                 :            : {
     215                 :         63 :     module.set(JS_NewPlainObject(cx));
     216                 :         63 :     return JS_DefineFunctions(cx, module, gjs_byte_array_module_funcs);
     217                 :            : }

Generated by: LCOV version 1.14