@camjn/getargv 0.0.3 → 0.0.5

package/LICENSE.txt

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2022, 2023
+Camden Narzt <getargv@narzt.cam>. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -5,11 +5,24 @@
 
 This module allows you to query the arguments of other processes on macOS.
 
-## Installation
+## Module Installation
 
-Install the module and add to the application's package.json by executing:
+ - Install `libgetargv` to your system (see below).
+ - Install the module and add to the application's package.json by executing:
 
-    $ npm i @camjn/getargv
+    $ npm install --save-optional @camjn/getargv
+
+Saving this module as optional is important because it can only build on macOS, so npm needs to be able to exclude it on other OSs.
+
+## Library Installation
+
+ - To get access to `libgetargv`, sign up for an appropriate [sponsorship tier](https://github.com/sponsors/CamJN).
+ - Clone the `libgetargv` repo: `git clone https://github.com/getargv/getargv.git`.
+ - Running `make install_dylib`, installs the library to the `/usr/local/` prefix by default; you can change the install location with the `PREFIX` `make` variable: `make PREFIX=/opt install_dylib`.
+
+## Building `libgetargv`
+
+I've built `libgetargv` on macOS 10.7-13, using only the <abbr title="Command Line Tools">CLT</abbr> package, not the full Xcode install. If you need to override variables, do so inside the `make` command, eg: `make EXTRA_CPPFLAGS=-DMACRO EXTRA_CFLAGS=-std=c17 dylib`.
 
 ## Usage
 

package/dist/binding.d.ts

@@ -1,8 +1,11 @@
+type Labels = "866" | "ansi_x3.4-1968" | "arabic" | "ascii" | "asmo-708" | "big5" | "big5-hkscs" | "chinese" | "cn-big5" | "cp1250" | "cp1251" | "cp1252" | "cp1253" | "cp1254" | "cp1255" | "cp1256" | "cp1257" | "cp1258" | "cp819" | "cp866" | "csbig5" | "cseuckr" | "cseucpkdfmtjapanese" | "csgb2312" | "csibm866" | "csiso2022jp" | "csiso2022kr" | "csiso58gb231280" | "csiso88596e" | "csiso88596i" | "csiso88598e" | "csiso88598i" | "csisolatin1" | "csisolatin2" | "csisolatin3" | "csisolatin4" | "csisolatin5" | "csisolatin6" | "csisolatin9" | "csisolatinarabic" | "csisolatincyrillic" | "csisolatingreek" | "csisolatinhebrew" | "cskoi8r" | "csksc56011987" | "csmacintosh" | "csshiftjis" | "cyrillic" | "dos-874" | "ecma-114" | "ecma-118" | "elot_928" | "euc-jp" | "euc-kr" | "gb18030" | "gb2312" | "gb_2312" | "gb_2312-80" | "gbk" | "greek" | "greek8" | "hebrew" | "hz-gb-2312" | "ibm819" | "ibm866" | "iso-2022-cn" | "iso-2022-cn-ext" | "iso-2022-jp" | "iso-2022-kr" | "iso-8859-1" | "iso-8859-10" | "iso-8859-11" | "iso-8859-13" | "iso-8859-14" | "iso-8859-15" | "iso-8859-16" | "iso-8859-2" | "iso-8859-3" | "iso-8859-4" | "iso-8859-5" | "iso-8859-6" | "iso-8859-6-e" | "iso-8859-6-i" | "iso-8859-7" | "iso-8859-8" | "iso-8859-8-e" | "iso-8859-8-i" | "iso-8859-9" | "iso-ir-100" | "iso-ir-101" | "iso-ir-109" | "iso-ir-110" | "iso-ir-126" | "iso-ir-127" | "iso-ir-138" | "iso-ir-144" | "iso-ir-148" | "iso-ir-149" | "iso-ir-157" | "iso-ir-58" | "iso8859-1" | "iso8859-10" | "iso8859-11" | "iso8859-13" | "iso8859-14" | "iso8859-15" | "iso8859-2" | "iso8859-3" | "iso8859-4" | "iso8859-6" | "iso8859-7" | "iso8859-8" | "iso8859-9" | "iso88591" | "iso885910" | "iso885911" | "iso885913" | "iso885914" | "iso885915" | "iso88592" | "iso88593" | "iso88594" | "iso88595" | "iso88596" | "iso88597" | "iso88598" | "iso88599" | "iso_8859-1" | "iso_8859-1:1987" | "iso_8859-2" | "iso_8859-2:1987" | "iso_8859-3" | "iso_8859-3:1988" | "iso_8859-4" | "iso_8859-4:1988" | "iso_8859-5" | "iso_8859-5:1988" | "iso_8859-6" | "iso_8859-6:1987" | "iso_8859-7" | "iso_8859-7:1987" | "iso_8859-8" | "iso_8859-8:1988" | "iso_8859-9" | "iso_8859-9:1989" | "koi" | "koi8" | "koi8-r" | "koi8-u" | "koi8_r" | "korean" | "ks_c_5601-1987" | "ks_c_5601-1989" | "ksc5601" | "ksc_5601" | "l1" | "l2" | "l3" | "l4" | "l5" | "l6" | "l9" | "latin1" | "latin2" | "latin3" | "latin4" | "latin5" | "latin6" | "latin9" | "logical" | "mac" | "macintosh" | "ms_kanji" | "shift-jis" | "shift_jis" | "sjis" | "sun_eu_greek" | "tis-620" | "unicode-1-1-utf-8" | "us-ascii" | "utf-16" | "utf-16be" | "utf-16le" | "utf-8" | "utf8" | "visual" | "windows-1250" | "windows-1251" | "windows-1252" | "windows-1253" | "windows-1254" | "windows-1255" | "windows-1256" | "windows-1257" | "windows-1258" | "windows-31j" | "windows-874" | "windows-949" | "x-cp1250" | "x-cp1251" | "x-cp1252" | "x-cp1253" | "x-cp1254" | "x-cp1255" | "x-cp1256" | "x-cp1257" | "x-cp1258" | "x-euc-jp" | "x-gbk" | "x-mac-cyrillic" | "x-mac-roman" | "x-mac-ukrainian" | "x-sjis" | "x-user-defined" | "x-x-big5";
 interface GetArgv {
     readonly PID_MAX: number;
     readonly ARG_MAX: number;
-    get_argv_of_pid(pid: number, nuls: boolean, skip: number): string;
-    get_argv_and_argc_of_pid(pid: number): Array<string>;
+    get_argv_of_pid(pid: number, nuls: boolean, skip: number): ArrayBuffer;
+    as_string(pid: number, encoding: Labels, nuls: boolean, skip: number): String;
+    get_argv_and_argc_of_pid(pid: number): Array<ArrayBuffer>;
+    as_array(pid: number, encoding: Labels): Array<string>;
 }
 declare const addon: GetArgv;
 export = addon;

package/dist/binding.js

@@ -1,3 +1,31 @@
 "use strict";
 const addon = require('../build/Release/getargv_native');
+addon.as_string = function as_string(pid, encoding, nuls, skip) {
+    if (!pid) {
+        throw new TypeError('The "pid" argument must be specified');
+    }
+    if (!encoding) {
+        throw new TypeError('The "encoding" argument must be specified');
+    }
+    const decoder = new TextDecoder(encoding);
+    const array = addon.get_argv_of_pid(pid, nuls !== null && nuls !== void 0 ? nuls : false, skip !== null && skip !== void 0 ? skip : 0);
+    return decoder.decode(array);
+};
+addon.as_array = function as_array(pid, encoding) {
+    if (!pid) {
+        throw new TypeError('The "pid" argument must be specified');
+    }
+    if (!encoding) {
+        throw new TypeError('The "encoding" argument must be specified');
+    }
+    const decoder = new TextDecoder(encoding);
+    const array = addon.get_argv_and_argc_of_pid(pid);
+    return array.map(b => decoder.decode(b));
+};
+exports.PID_MAX = addon.PID_MAX;
+exports.ARG_MAX = addon.ARG_MAX;
+exports.get_argv_of_pid = addon.get_argv_of_pid;
+exports.as_string = addon.as_string;
+exports.get_argv_and_argc_of_pid = addon.get_argv_and_argc_of_pid;
+exports.as_array = addon.as_array;
 module.exports = addon;

package/package.json

@@ -3,8 +3,8 @@
         "getargv": "lib/cli.js"
     },
     "devDependencies": {
-        "@types/node": "^18.11.18",
-        "typescript": "^4.9.4"
+        "@types/node": "^18.14.6",
+        "typescript": "^4.9.5"
     },
     "os": [
         "darwin"
@@ -16,17 +16,20 @@
     "name": "@camjn/getargv",
     "homepage": "https://getargv.narzt.cam/",
     "author": "Camden Narzt <getargv@narzt.cam>",
-    "version": "0.0.3",
+    "version": "0.0.5",
     "description": "This library allows you to query the arguments of other processes on macOS.",
     "main": "dist/binding.js",
     "scripts": {
+        "prebuild": "tsc",
         "build": "node-gyp configure build",
-        "pretest": "tsc",
+        "pretest": "npm run build",
         "test": "node --napi-modules ./test/test_binding.js",
-        "precli": "tsc",
-        "prepack": "tsc",
+        "prepack": "npm run build",
+        "precli": "npm run build",
         "cli": "node dist/cli.js",
-        "console": "node --napi-modules -r ./build/Release/getargv_native -e 'const GetArgv = require.cache[Object.keys(require.cache)[0]].exports;' -i"
+        "preconsole": "npm run build",
+        "console": "node --napi-modules -r ./dist/binding.js -e 'const GetArgv = require.cache[Object.keys(require.cache)[0]].exports;' -i",
+        "start": "npm run console"
     },
     "files": [
         "/README.md",

package/src/getargv.c

@@ -19,7 +19,7 @@ napi_value get_undefined(napi_env env) {
 }
 
 napi_value create_system_error(napi_env env, errno_t err) {
-  //we skip checking status in here because we already have a failure
+  // we skip checking status in here because we already have a failure
   napi_value code;
   napi_create_string_utf8(env, "ERR_SYSTEM_ERROR", NAPI_AUTO_LENGTH, &code);
 
@@ -129,15 +129,16 @@ napi_value GetArgvOfPid(napi_env env, napi_callback_info info) {
 
     napi_throw(env, error);
   } else {
-    if (napi_create_string_utf8(env, result.start_pointer,
+    char *innerbuff = NULL;
+    if (napi_create_arraybuffer(env,
                                 result.end_pointer - result.start_pointer + 1,
-                                &args) != napi_ok) {
-      // args not guaranteed to be utf8 or even latin1/ascii, but ruby, swift,
-      // and node all want strings to be properly encoded
+                                (void **)&innerbuff, &args) != napi_ok) {
       napi_throw_error(env, "ERR_INTERNAL_ASSERTION",
                        "Unable to create return value");
+    } else {
+      memcpy(innerbuff, result.start_pointer, result.end_pointer - result.start_pointer + 1);
     }
-    free(result.buffer);
+    free_ArgvResult(&result);
   }
 
   return args;
@@ -158,24 +159,24 @@ napi_value GetArgvAndArgcOfPid(napi_env env, napi_callback_info info) {
                        "Unable to create return value");
     } else {
       for (size_t i = 0; i < result.argc; i++) {
-        napi_value string;
-        // args not guaranteed to be utf8 or even latin1/ascii, but ruby, swift,
-        // and node all want strings to be properly encoded...
-        if (napi_ok != napi_create_string_utf8(env, result.argv[i],
-                                               NAPI_AUTO_LENGTH, &string)) {
+        napi_value buffer;
+        char *innerbuff = NULL;
+        size_t len = strlen(result.argv[i]) + 1;
+        if (napi_create_arraybuffer(env, len, (void **)&innerbuff, &buffer) !=
+            napi_ok) {
           napi_throw_error(env, "ERR_INTERNAL_ASSERTION",
-                           "Unable to create string");
+                           "Unable to create ArrayBuffer");
           break;
         }
-        if (napi_ok != napi_set_element(env, args, i, string)) {
+        memcpy(innerbuff, result.argv[i], len);
+        if (napi_ok != napi_set_element(env, args, i, buffer)) {
           napi_throw_error(env, "ERR_INTERNAL_ASSERTION",
                            "Unable to populate array");
           break;
         }
       }
     }
-    free(result.argv);
-    free(result.buffer);
+    free_ArgvArgcResult(&result);
   }
 
   return args;