runmat 0.3.5 → 0.4.0

package/dist/generated/builtins/tcpserver.js

@@ -0,0 +1,177 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "tcpserver",
+    "category": "io/net",
+    "keywords": [
+        "tcpserver",
+        "tcp",
+        "socket",
+        "networking",
+        "server",
+        "loopback"
+    ],
+    "summary": "Create a TCP server that listens for MATLAB-compatible client connections.",
+    "references": [
+        "https://www.mathworks.com/help/matlab/ref/tcpserver.html"
+    ],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "TCP sockets run on the host CPU. GPU-resident inputs are gathered automatically before binding sockets."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 1,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::io::net::tcpserver::tests",
+        "integration": "builtins::io::net::tcpserver::tests::tcpserver_accepts_loopback_connection"
+    },
+    "description": "`tcpserver(address, port)` creates a TCP/IP listener that waits for clients and exposes MATLAB-compatible properties describing the socket. RunMat mirrors this behaviour: addresses may be IPv4, IPv6, or hostnames, and the function returns a handle-like struct whose fields match MATLAB’s `tcpserver` object (including `ServerAddress`, `ServerPort`, `Timeout`, `UserData`, and `BytesAvailableFcn` metadata). The builtin validates inputs, binds the socket, records configuration, and raises MATLAB-style diagnostics on failure.",
+    "behaviors": [
+        "`tcpserver(address, port)` binds to the requested interface; pass `\"0.0.0.0\"` or `\"::\"` to listen on every IPv4 or IPv6 adapter respectively.",
+        "Ports must be in the range `0–65535`. Passing `0` requests an ephemeral OS-assigned port that RunMat reports in the returned struct.",
+        "Supported name-value pairs mirror MATLAB defaults: `Timeout` (non-negative seconds, default `10`), `UserData` (stored verbatim), `Name` (defaults to `\"tcpserver:<address>:<port>\"`), and `ByteOrder` (`\"little-endian\"` or `\"big-endian\"`). Unsupported options raise `RunMat:tcpserver:InvalidNameValue`.",
+        "The returned struct mirrors MATLAB properties, including connection state, callback metadata, and an internal `__tcpserver_id` identifier that future networking builtins use to locate the listener.",
+        "GPU-resident scalars are gathered automatically before binding so that socket setup always executes on the host CPU.",
+        "Bind failures raise `RunMat:tcpserver:BindFailed` with the OS-provided error message, preserving MATLAB-style diagnostics."
+    ],
+    "examples": [
+        {
+            "description": "Creating a loopback TCP server on a fixed port",
+            "input": "srv = tcpserver(\"127.0.0.1\", 55000);\ndisp(srv.ServerAddress)\ndisp(srv.ServerPort)",
+            "output": "127.0.0.1\n55000"
+        },
+        {
+            "description": "Requesting an ephemeral port and inspecting the assigned value",
+            "input": "srv = tcpserver(\"0.0.0.0\", 0);\nfprintf(\"Listening on %s:%d\\n\", srv.ServerAddress, srv.ServerPort)",
+            "output": "Listening on 0.0.0.0:54873   % actual port varies by run"
+        },
+        {
+            "description": "Configuring the timeout and storing metadata in UserData",
+            "input": "srv = tcpserver(\"localhost\", 60000, \"Timeout\", 5, \"UserData\", struct(\"name\", \"demo\"));\ndisp(srv.Timeout)\ndisp(srv.UserData.name)",
+            "output": "5\ndemo"
+        },
+        {
+            "description": "Assigning a custom server name",
+            "input": "srv = tcpserver(\"::1\", 45000, \"Name\", \"LoopbackServer\");\ndisp(srv.Name)",
+            "output": "LoopbackServer"
+        },
+        {
+            "description": "Selecting big-endian byte order for binary protocols",
+            "input": "srv = tcpserver(\"127.0.0.1\", 45001, \"ByteOrder\", \"big-endian\");\ndisp(srv.ByteOrder)",
+            "output": "big-endian"
+        },
+        {
+            "description": "Handling invalid ports with MATLAB-style diagnostics",
+            "input": "try\n    srv = tcpserver(\"127.0.0.1\", 99999);\ncatch err\n    disp(err.identifier)\n    disp(err.message)\nend",
+            "output": "RunMat:tcpserver:InvalidPort\nRunMat:tcpserver:InvalidPort: tcpserver: port 99999 is outside the valid range 0–65535"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "What range of ports can I use?",
+            "answer": "Valid ports are `0–65535`. Port `0` lets the OS choose an available ephemeral port, which RunMat reports in the returned struct."
+        },
+        {
+            "question": "How do I discover which clients are connected?",
+            "answer": "The returned struct exposes MATLAB-compatible fields (`Connected`, `ClientAddress`, `ClientPort`). Future networking builtins will use the internal `__tcpserver_id` to inspect active connections."
+        },
+        {
+            "question": "Does RunMat support IPv6?",
+            "answer": "Yes. Pass an IPv6 literal (e.g., `\"::1\"`) or hostname that resolves to IPv6. The returned `ServerAddress` reflects the bound address."
+        },
+        {
+            "question": "Can I change the timeout after creating the server?",
+            "answer": "Not yet. The current builtin records the timeout value for future builtins. A forthcoming setter will update the listener configuration."
+        },
+        {
+            "question": "Does `tcpserver` fire callbacks like MATLAB’s `BytesAvailableFcn`?",
+            "answer": "Callback-related properties are present for compatibility, and future updates will allow callers to configure them. They currently act as placeholders while connection management matures."
+        },
+        {
+            "question": "How do I close the server?",
+            "answer": "A companion builtin (planned) will accept the returned struct and release the underlying listener. Tests can invoke internal helpers until that builtin lands."
+        },
+        {
+            "question": "Can I use GPU arrays for address or port?",
+            "answer": "Yes—RunMat gathers them automatically before binding."
+        },
+        {
+            "question": "What happens if the port is already in use?",
+            "answer": "`tcpserver` raises `RunMat:tcpserver:BindFailed` with the OS error message."
+        },
+        {
+            "question": "How do I pass additional socket options?",
+            "answer": "Current support covers `Timeout`, `Name`, `UserData`, and `ByteOrder`. Additional name-value options (broadcast, reuse, keep-alive) will land alongside their corresponding provider hooks."
+        },
+        {
+            "question": "Is TLS supported?",
+            "answer": "Not directly. Combine `tcpserver` with application-layer protocol helpers or custom TLS wrappers until dedicated support lands."
+        }
+    ],
+    "links": [
+        {
+            "label": "fopen",
+            "url": "./fopen"
+        },
+        {
+            "label": "fread",
+            "url": "./fread"
+        },
+        {
+            "label": "fwrite",
+            "url": "./fwrite"
+        },
+        {
+            "label": "fprintf",
+            "url": "./fprintf"
+        },
+        {
+            "label": "accept",
+            "url": "./accept"
+        },
+        {
+            "label": "close",
+            "url": "./close"
+        },
+        {
+            "label": "read",
+            "url": "./read"
+        },
+        {
+            "label": "readline",
+            "url": "./readline"
+        },
+        {
+            "label": "tcpclient",
+            "url": "./tcpclient"
+        },
+        {
+            "label": "write",
+            "url": "./write"
+        }
+    ],
+    "source": {
+        "label": "crates/runmat-runtime/src/builtins/io/net/tcpserver.rs",
+        "url": "crates/runmat-runtime/src/builtins/io/net/tcpserver.rs"
+    },
+    "gpu_residency": "No. `tcpserver` is a host-side operation. RunMat transparently gathers GPU scalars before binding the socket, so keeping address or port values on the GPU provides no performance benefit.",
+    "gpu_behavior": [
+        "Networking occurs entirely on the host CPU. If the address or port arguments originate on the GPU, RunMat gathers them before binding the socket. The struct returned by `tcpserver` is always CPU-resident, and acceleration providers do not need to implement any hooks for this builtin."
+    ],
+    "key": "tcpserver",
+    "slug": "tcpserver",
+    "categoryPath": [
+        "io",
+        "net"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=tcpserver.js.map

package/dist/generated/builtins/tcpserver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tcpserver.js","sourceRoot":"","sources":["../../../src/generated/builtins/tcpserver.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,WAAW;IACpB,UAAU,EAAE,QAAQ;IACpB,UAAU,EAAE;QACV,WAAW;QACX,KAAK;QACL,QAAQ;QACR,YAAY;QACZ,QAAQ;QACR,UAAU;KACX;IACD,SAAS,EAAE,4EAA4E;IACvF,YAAY,EAAE;QACZ,0DAA0D;KAC3D;IACD,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,yGAAyG;KACnH;IACD,QAAQ,EAAE;QACR,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,QAAQ;KACtB;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,qCAAqC;QAC7C,aAAa,EAAE,4EAA4E;KAC5F;IACD,aAAa,EAAE,+gBAA+gB;IAC9hB,WAAW,EAAE;QACX,mJAAmJ;QACnJ,sIAAsI;QACtI,mTAAmT;QACnT,uMAAuM;QACvM,sHAAsH;QACtH,4HAA4H;KAC7H;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,gDAAgD;YAC/D,OAAO,EAAE,uFAAuF;YAChG,QAAQ,EAAE,kBAAkB;SAC7B;QACD;YACE,aAAa,EAAE,gEAAgE;YAC/E,OAAO,EAAE,yGAAyG;YAClH,QAAQ,EAAE,0DAA0D;SACrE;QACD;YACE,aAAa,EAAE,0DAA0D;YACzE,OAAO,EAAE,8IAA8I;YACvJ,QAAQ,EAAE,SAAS;SACpB;QACD;YACE,aAAa,EAAE,gCAAgC;YAC/C,OAAO,EAAE,gFAAgF;YACzF,QAAQ,EAAE,gBAAgB;SAC3B;QACD;YACE,aAAa,EAAE,sDAAsD;YACrE,OAAO,EAAE,4FAA4F;YACrG,QAAQ,EAAE,YAAY;SACvB;QACD;YACE,aAAa,EAAE,sDAAsD;YACrE,OAAO,EAAE,kHAAkH;YAC3H,QAAQ,EAAE,sHAAsH;SACjI;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,gCAAgC;YAC5C,QAAQ,EAAE,kIAAkI;SAC7I;QACD;YACE,UAAU,EAAE,gDAAgD;YAC5D,QAAQ,EAAE,qMAAqM;SAChN;QACD;YACE,UAAU,EAAE,2BAA2B;YACvC,QAAQ,EAAE,yIAAyI;SACpJ;QACD;YACE,UAAU,EAAE,qDAAqD;YACjE,QAAQ,EAAE,0IAA0I;SACrJ;QACD;YACE,UAAU,EAAE,oEAAoE;YAChF,QAAQ,EAAE,6LAA6L;SACxM;QACD;YACE,UAAU,EAAE,4BAA4B;YACxC,QAAQ,EAAE,gKAAgK;SAC3K;QACD;YACE,UAAU,EAAE,2CAA2C;YACvD,QAAQ,EAAE,uDAAuD;SAClE;QACD;YACE,UAAU,EAAE,6CAA6C;YACzD,QAAQ,EAAE,6EAA6E;SACxF;QACD;YACE,UAAU,EAAE,0CAA0C;YACtD,QAAQ,EAAE,6LAA6L;SACxM;QACD;YACE,UAAU,EAAE,mBAAmB;YAC/B,QAAQ,EAAE,iIAAiI;SAC5I;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,aAAa;SACrB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,wDAAwD;QACjE,KAAK,EAAE,wDAAwD;KAChE;IACD,eAAe,EAAE,6LAA6L;IAC9M,cAAc,EAAE;QACd,8RAA8R;KAC/R;IACD,KAAK,EAAE,WAAW;IAClB,MAAM,EAAE,WAAW;IACnB,cAAc,EAAE;QACd,IAAI;QACJ,KAAK;KACN;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins/tempdir.d.ts

@@ -0,0 +1,4 @@
+import type { BuiltinDoc } from "../../builtins.js";
+declare const builtinDoc: BuiltinDoc;
+export default builtinDoc;
+//# sourceMappingURL=tempdir.d.ts.map

package/dist/generated/builtins/tempdir.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tempdir.d.ts","sourceRoot":"","sources":["../../../src/generated/builtins/tempdir.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,QAAA,MAAM,UAAU,EAAE,UA+MjB,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins/tempdir.js

@@ -0,0 +1,212 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "tempdir",
+    "category": "io/repl_fs",
+    "keywords": [
+        "tempdir",
+        "temporary folder",
+        "temp directory",
+        "system temp",
+        "temporary path"
+    ],
+    "summary": "Return the absolute path to the system temporary folder with a trailing file separator.",
+    "references": [
+        "https://www.mathworks.com/help/matlab/ref/tempdir.html"
+    ],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Runs entirely on the host CPU. When scripts store path tokens on the GPU, RunMat gathers them automatically before interacting with the filesystem."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 0,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::io::repl_fs::tempdir::tests",
+        "integration": "builtins::io::repl_fs::tempdir::tests::tempdir_points_to_existing_directory"
+    },
+    "description": "`tempdir` returns the absolute path of the operating system's temporary folder. The returned path always ends with the platform-specific file separator (`/` on macOS and Linux, `\\` on Windows) so it is safe to concatenate file names directly, matching MATLAB behaviour.",
+    "behaviors": [
+        "The builtin accepts no input arguments; providing any arguments raises `tempdir: too many input arguments`.",
+        "The output is a character row vector (`1×N`) for compatibility with historical MATLAB code. Convert it with `string(tempdir)` if you prefer string scalars.",
+        "The path reflects the process environment, honouring variables such as `TMPDIR` (macOS/Linux) or `TMP`/`TEMP` (Windows).",
+        "When the OS reports a temporary folder that lacks a trailing separator, RunMat appends one automatically to mirror MATLAB.",
+        "The directory is not created or cleaned automatically; RunMat relies on the operating system to manage the folder lifecycle.",
+        "If RunMat cannot determine the temporary folder (rare), the builtin raises an error containing the operating system message."
+    ],
+    "examples": [
+        {
+            "description": "Get The System Temporary Folder Path",
+            "input": "folder = tempdir();\ndisp(folder)",
+            "output": "/tmp/"
+        },
+        {
+            "description": "Combine `tempdir` With `tempname` To Build Unique Paths",
+            "input": "uniqueFile = fullfile(tempdir(), \"runmat-session.log\");\nfid = fopen(uniqueFile, \"w\");\nfprintf(fid, \"Temporary log created at %s\\n\", datetime);\nfclose(fid)",
+            "output": "% Creates runmat-session.log inside the system temporary folder"
+        },
+        {
+            "description": "Create A Temporary Working Subfolder",
+            "input": "workDir = fullfile(tempdir(), \"mytask\");\nif ~exist(workDir, \"dir\")\n    mkdir(workDir);\nend\ndisp(workDir)",
+            "output": "% Prints the path to tempdir/mytask and creates the folder if needed"
+        },
+        {
+            "description": "Verify That `tempdir` Appends A File Separator",
+            "input": "folder = tempdir();\nendsWithSeparator = folder(end) == filesep;\ndisp(endsWithSeparator)",
+            "output": "     1"
+        },
+        {
+            "description": "Use `tempdir` When Creating Temporary Zip Archives",
+            "input": "archive = fullfile(tempdir(), \"results.zip\");\nzip(archive, \"results\");\ndisp(archive)",
+            "output": "% Displays the full path to results.zip inside the system temp folder"
+        },
+        {
+            "description": "Log Temporary Folder Usage For Debugging",
+            "input": "fprintf(\"RunMat temp folder: %s\\n\", tempdir())",
+            "output": "% Prints something like:\n%   RunMat temp folder: /tmp/"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Why does `tempdir` return a character vector instead of a string scalar?",
+            "answer": "MATLAB has historically returned character vectors. RunMat mirrors that behaviour for compatibility; wrap the result in `string(...)` when you need a string scalar."
+        },
+        {
+            "question": "Does the path include a trailing separator?",
+            "answer": "Yes. RunMat appends the platform-specific file separator when necessary so you can safely concatenate file names."
+        },
+        {
+            "question": "What happens if the temporary folder does not exist?",
+            "answer": "RunMat reports the folder reported by the operating system. Most platforms guarantee the folder exists; if not, subsequent calls such as `mkdir` can create it."
+        },
+        {
+            "question": "Can I change the temporary folder location?",
+            "answer": "Yes. Set `TMPDIR` (macOS/Linux) or `TEMP`/`TMP` (Windows) before starting RunMat. `tempdir` will honour those environment variables, just like MATLAB."
+        },
+        {
+            "question": "Will `tempdir` ever create or clean files automatically?",
+            "answer": "No. The builtin only reports the path. Cleanup policies remain the responsibility of the operating system or your code."
+        },
+        {
+            "question": "Is `tempdir` thread-safe?",
+            "answer": "Yes. Querying the temporary folder is read-only and does not modify global state."
+        },
+        {
+            "question": "Does `tempdir` work inside deployed or sandboxed environments?",
+            "answer": "As long as the process has permission to query the environment, it returns the best-effort location supplied by the OS."
+        },
+        {
+            "question": "Can I call `tempdir` on the GPU?",
+            "answer": "No. The function is host-only, but it also never transfers data to or from the GPU."
+        },
+        {
+            "question": "Does `tempdir` normalize path separators?",
+            "answer": "RunMat preserves the operating system’s separators (backslash on Windows, slash elsewhere) to maintain MATLAB compatibility."
+        },
+        {
+            "question": "What if I pass arguments to `tempdir` by mistake?",
+            "answer": "RunMat raises `tempdir: too many input arguments`, matching MATLAB’s diagnostic."
+        }
+    ],
+    "links": [
+        {
+            "label": "mkdir",
+            "url": "./mkdir"
+        },
+        {
+            "label": "rmdir",
+            "url": "./rmdir"
+        },
+        {
+            "label": "delete",
+            "url": "./delete"
+        },
+        {
+            "label": "dir",
+            "url": "./dir"
+        },
+        {
+            "label": "pwd",
+            "url": "./pwd"
+        },
+        {
+            "label": "addpath",
+            "url": "./addpath"
+        },
+        {
+            "label": "cd",
+            "url": "./cd"
+        },
+        {
+            "label": "copyfile",
+            "url": "./copyfile"
+        },
+        {
+            "label": "exist",
+            "url": "./exist"
+        },
+        {
+            "label": "fullfile",
+            "url": "./fullfile"
+        },
+        {
+            "label": "genpath",
+            "url": "./genpath"
+        },
+        {
+            "label": "getenv",
+            "url": "./getenv"
+        },
+        {
+            "label": "ls",
+            "url": "./ls"
+        },
+        {
+            "label": "movefile",
+            "url": "./movefile"
+        },
+        {
+            "label": "path",
+            "url": "./path"
+        },
+        {
+            "label": "rmpath",
+            "url": "./rmpath"
+        },
+        {
+            "label": "savepath",
+            "url": "./savepath"
+        },
+        {
+            "label": "setenv",
+            "url": "./setenv"
+        },
+        {
+            "label": "tempname",
+            "url": "./tempname"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/io/repl_fs/tempdir.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/io/repl_fs/tempdir.rs"
+    },
+    "gpu_residency": "No. `tempdir` is always a host operation. There is nothing to gain by moving data to the GPU, and no acceleration provider needs to implement hooks for this builtin.",
+    "gpu_behavior": [
+        "`tempdir` performs no GPU work. It queries the host environment and surfaces the result as a character array. The builtin registers a CPU-only GPU spec so the fusion planner treats it as a host-side operation. Scripts that accidentally store paths on the GPU have nothing to worry about—`tempdir` has no inputs to gather."
+    ],
+    "key": "tempdir",
+    "slug": "tempdir",
+    "categoryPath": [
+        "io",
+        "repl_fs"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=tempdir.js.map

package/dist/generated/builtins/tempdir.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tempdir.js","sourceRoot":"","sources":["../../../src/generated/builtins/tempdir.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,YAAY;IACxB,UAAU,EAAE;QACV,SAAS;QACT,kBAAkB;QAClB,gBAAgB;QAChB,aAAa;QACb,gBAAgB;KACjB;IACD,SAAS,EAAE,yFAAyF;IACpG,YAAY,EAAE;QACZ,wDAAwD;KACzD;IACD,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,qJAAqJ;KAC/J;IACD,QAAQ,EAAE;QACR,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,QAAQ;KACtB;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,uCAAuC;QAC/C,aAAa,EAAE,6EAA6E;KAC7F;IACD,aAAa,EAAE,gRAAgR;IAC/R,WAAW,EAAE;QACX,6GAA6G;QAC7G,6JAA6J;QAC7J,0HAA0H;QAC1H,4HAA4H;QAC5H,8HAA8H;QAC9H,8HAA8H;KAC/H;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,sCAAsC;YACrD,OAAO,EAAE,mCAAmC;YAC5C,QAAQ,EAAE,OAAO;SAClB;QACD;YACE,aAAa,EAAE,yDAAyD;YACxE,OAAO,EAAE,sKAAsK;YAC/K,QAAQ,EAAE,iEAAiE;SAC5E;QACD;YACE,aAAa,EAAE,sCAAsC;YACrD,OAAO,EAAE,kHAAkH;YAC3H,QAAQ,EAAE,sEAAsE;SACjF;QACD;YACE,aAAa,EAAE,gDAAgD;YAC/D,OAAO,EAAE,2FAA2F;YACpG,QAAQ,EAAE,QAAQ;SACnB;QACD;YACE,aAAa,EAAE,oDAAoD;YACnE,OAAO,EAAE,4FAA4F;YACrG,QAAQ,EAAE,uEAAuE;SAClF;QACD;YACE,aAAa,EAAE,0CAA0C;YACzD,OAAO,EAAE,mDAAmD;YAC5D,QAAQ,EAAE,yDAAyD;SACpE;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,0EAA0E;YACtF,QAAQ,EAAE,sKAAsK;SACjL;QACD;YACE,UAAU,EAAE,6CAA6C;YACzD,QAAQ,EAAE,mHAAmH;SAC9H;QACD;YACE,UAAU,EAAE,sDAAsD;YAClE,QAAQ,EAAE,iKAAiK;SAC5K;QACD;YACE,UAAU,EAAE,6CAA6C;YACzD,QAAQ,EAAE,wJAAwJ;SACnK;QACD;YACE,UAAU,EAAE,0DAA0D;YACtE,QAAQ,EAAE,yHAAyH;SACpI;QACD;YACE,UAAU,EAAE,2BAA2B;YACvC,QAAQ,EAAE,mFAAmF;SAC9F;QACD;YACE,UAAU,EAAE,gEAAgE;YAC5E,QAAQ,EAAE,yHAAyH;SACpI;QACD;YACE,UAAU,EAAE,kCAAkC;YAC9C,QAAQ,EAAE,qFAAqF;SAChG;QACD;YACE,UAAU,EAAE,2CAA2C;YACvD,QAAQ,EAAE,8HAA8H;SACzI;QACD;YACE,UAAU,EAAE,mDAAmD;YAC/D,QAAQ,EAAE,kFAAkF;SAC7F;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,MAAM;SACd;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,MAAM;SACd;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,4DAA4D;QACrE,KAAK,EAAE,yGAAyG;KACjH;IACD,eAAe,EAAE,uKAAuK;IACxL,cAAc,EAAE;QACd,mUAAmU;KACpU;IACD,KAAK,EAAE,SAAS;IAChB,MAAM,EAAE,SAAS;IACjB,cAAc,EAAE;QACd,IAAI;QACJ,SAAS;KACV;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins/tempname.d.ts

@@ -0,0 +1,4 @@
+import type { BuiltinDoc } from "../../builtins.js";
+declare const builtinDoc: BuiltinDoc;
+export default builtinDoc;
+//# sourceMappingURL=tempname.d.ts.map

package/dist/generated/builtins/tempname.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tempname.d.ts","sourceRoot":"","sources":["../../../src/generated/builtins/tempname.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,QAAA,MAAM,UAAU,EAAE,UA+MjB,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins/tempname.js

@@ -0,0 +1,212 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "tempname",
+    "category": "io/repl_fs",
+    "keywords": [
+        "tempname",
+        "temporary file",
+        "unique name",
+        "filesystem",
+        "temp directory"
+    ],
+    "summary": "Return a unique temporary file path in the system temp folder or a user-specified directory.",
+    "references": [
+        "https://www.mathworks.com/help/matlab/ref/tempname.html"
+    ],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Runs entirely on the host. When callers provide GPU-resident strings, RunMat gathers them before computing the file name."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 1,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::io::repl_fs::tempname::tests",
+        "integration": "builtins::io::repl_fs::tempname::tests::tempname_generates_unique_names"
+    },
+    "description": "`tempname` returns a unique path that you can reserve for a temporary file or folder. By default it chooses the system temporary directory. When you provide a folder argument, the path is generated inside that folder instead.",
+    "behaviors": [
+        "`tempname()` returns a character row vector (`1×N`) containing an absolute path inside the system temporary directory.",
+        "`tempname(folder)` returns a path inside `folder`, which can be absolute or relative. RunMat expands leading `~` to the home directory for convenience.",
+        "The returned path never corresponds to an existing file or directory at the time of the call.",
+        "`tempname` does not create files or directories. Use the returned value with builtins such as `fopen`, `mkdir`, or `movefile`.",
+        "The generated token begins with the MATLAB-compatible `tp` prefix followed by hexadecimal entropy, making it human-recognisable while avoiding collisions.",
+        "Providing more than one input argument raises `tempname: too many input arguments`. Non-text inputs raise a descriptive type error."
+    ],
+    "examples": [
+        {
+            "description": "Generate A Unique Temporary File Name",
+            "input": "fname = tempname();\nfprintf(\"Saving intermediate results to %s\\n\", fname)",
+            "output": "% Prints the unique file name inside the system temporary folder."
+        },
+        {
+            "description": "Create A Temporary File Name In A Custom Folder",
+            "input": "logDir = fullfile(pwd(), \"logs\");\nfname = tempname(logDir)",
+            "output": "% fname starts with the logs folder and ends with a tp******** token."
+        },
+        {
+            "description": "Append A File Extension To Tempname Results",
+            "input": "csvPath = [tempname(), \".csv\"]",
+            "output": "% csvPath is a unique .csv file path you can pass to writematrix or fprintf."
+        },
+        {
+            "description": "Reserve A Temporary Folder Path",
+            "input": "scratch = tempname();\nmkdir(scratch);\ncleanupObj = onCleanup(@() rmdir(scratch, \"s\"))",
+            "output": "% scratch now exists on disk and is removed automatically via onCleanup."
+        },
+        {
+            "description": "Use Tempname With fopen To Write Temporary Data",
+            "input": "tmpFile = tempname();\n[fid, message] = fopen(tmpFile, \"w\");\nif fid == -1\n    error(\"Failed to open temp file: %s\", message);\nend\nfprintf(fid, \"Temporary output\\n\");\nfclose(fid)",
+            "output": "% Creates a file, writes text, and leaves it for later processing."
+        },
+        {
+            "description": "Combine Tempname With gpuArray Inputs",
+            "input": "folder = gpuArray(\"scratch\");\nfname = tempname(folder)",
+            "output": "% RunMat gathers the string and returns a host-side character vector."
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `tempname` create the file or folder for me?",
+            "answer": "No. It only reserves a unique path. Call `fopen`, `mkdir`, or other functions to create the resource."
+        },
+        {
+            "question": "Can I call `tempname` with relative folders?",
+            "answer": "Yes. RunMat honours relative paths and joins the generated token using the platform’s path separator."
+        },
+        {
+            "question": "What happens if the target folder does not exist yet?",
+            "answer": "`tempname` still returns a path under that folder. It is up to your code to create intermediate directories if needed."
+        },
+        {
+            "question": "Why does the result start with `tp`?",
+            "answer": "MATLAB prefixes the token with `tp` for temporary paths. RunMat follows the same convention for familiarity."
+        },
+        {
+            "question": "Is the result guaranteed to be unique?",
+            "answer": "The builtin combines monotonic process-wide counters with high-resolution timestamps and the process ID. The result does not exist at the moment of generation; collisions are exceedingly unlikely."
+        },
+        {
+            "question": "Can I request multiple names at once?",
+            "answer": "Call `tempname` repeatedly. Each invocation returns a fresh token."
+        },
+        {
+            "question": "Does `tempname` support Unicode folder names?",
+            "answer": "Yes. Paths are stored as UTF-16 internally on Windows and UTF-8 on Unix-like systems. RunMat converts between encodings automatically."
+        },
+        {
+            "question": "How do I convert the result to a string scalar?",
+            "answer": "Wrap the output in `string(tempname())` or `string(tempname(folder))`."
+        },
+        {
+            "question": "Will GPU acceleration change the output?",
+            "answer": "No. The builtin is host-only and ignores GPU providers entirely."
+        }
+    ],
+    "links": [
+        {
+            "label": "tempdir",
+            "url": "./tempdir"
+        },
+        {
+            "label": "mkdir",
+            "url": "./mkdir"
+        },
+        {
+            "label": "fopen",
+            "url": "./fopen"
+        },
+        {
+            "label": "delete",
+            "url": "./delete"
+        },
+        {
+            "label": "movefile",
+            "url": "./movefile"
+        },
+        {
+            "label": "addpath",
+            "url": "./addpath"
+        },
+        {
+            "label": "cd",
+            "url": "./cd"
+        },
+        {
+            "label": "copyfile",
+            "url": "./copyfile"
+        },
+        {
+            "label": "dir",
+            "url": "./dir"
+        },
+        {
+            "label": "exist",
+            "url": "./exist"
+        },
+        {
+            "label": "fullfile",
+            "url": "./fullfile"
+        },
+        {
+            "label": "genpath",
+            "url": "./genpath"
+        },
+        {
+            "label": "getenv",
+            "url": "./getenv"
+        },
+        {
+            "label": "ls",
+            "url": "./ls"
+        },
+        {
+            "label": "path",
+            "url": "./path"
+        },
+        {
+            "label": "pwd",
+            "url": "./pwd"
+        },
+        {
+            "label": "rmdir",
+            "url": "./rmdir"
+        },
+        {
+            "label": "rmpath",
+            "url": "./rmpath"
+        },
+        {
+            "label": "savepath",
+            "url": "./savepath"
+        },
+        {
+            "label": "setenv",
+            "url": "./setenv"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/io/repl_fs/tempname.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/io/repl_fs/tempname.rs"
+    },
+    "gpu_residency": "No. `tempname` only manipulates paths and never benefits from GPU execution. It always returns a host-resident character array. If you accidentally store a folder name on the GPU, RunMat gathers it transparently.",
+    "gpu_behavior": [
+        "`tempname` performs all computation on the CPU. When scripts pass GPU-resident strings (for example, `gpuArray(\"scratch\")`), RunMat automatically gathers those scalars to host memory before determining the result. Acceleration providers do not implement hooks for this builtin, and there is no GPU kernel to warm up."
+    ],
+    "key": "tempname",
+    "slug": "tempname",
+    "categoryPath": [
+        "io",
+        "repl_fs"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=tempname.js.map

package/dist/generated/builtins/tempname.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tempname.js","sourceRoot":"","sources":["../../../src/generated/builtins/tempname.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,UAAU;IACnB,UAAU,EAAE,YAAY;IACxB,UAAU,EAAE;QACV,UAAU;QACV,gBAAgB;QAChB,aAAa;QACb,YAAY;QACZ,gBAAgB;KACjB;IACD,SAAS,EAAE,8FAA8F;IACzG,YAAY,EAAE;QACZ,yDAAyD;KAC1D;IACD,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,2HAA2H;KACrI;IACD,QAAQ,EAAE;QACR,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,QAAQ;KACtB;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,wCAAwC;QAChD,aAAa,EAAE,yEAAyE;KACzF;IACD,aAAa,EAAE,mOAAmO;IAClP,WAAW,EAAE;QACX,wHAAwH;QACxH,yJAAyJ;QACzJ,+FAA+F;QAC/F,gIAAgI;QAChI,4JAA4J;QAC5J,qIAAqI;KACtI;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,uCAAuC;YACtD,OAAO,EAAE,+EAA+E;YACxF,QAAQ,EAAE,mEAAmE;SAC9E;QACD;YACE,aAAa,EAAE,iDAAiD;YAChE,OAAO,EAAE,+DAA+D;YACxE,QAAQ,EAAE,uEAAuE;SAClF;QACD;YACE,aAAa,EAAE,6CAA6C;YAC5D,OAAO,EAAE,kCAAkC;YAC3C,QAAQ,EAAE,8EAA8E;SACzF;QACD;YACE,aAAa,EAAE,iCAAiC;YAChD,OAAO,EAAE,2FAA2F;YACpG,QAAQ,EAAE,0EAA0E;SACrF;QACD;YACE,aAAa,EAAE,iDAAiD;YAChE,OAAO,EAAE,+LAA+L;YACxM,QAAQ,EAAE,oEAAoE;SAC/E;QACD;YACE,aAAa,EAAE,uCAAuC;YACtD,OAAO,EAAE,2DAA2D;YACpE,QAAQ,EAAE,uEAAuE;SAClF;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,mDAAmD;YAC/D,QAAQ,EAAE,uGAAuG;SAClH;QACD;YACE,UAAU,EAAE,8CAA8C;YAC1D,QAAQ,EAAE,uGAAuG;SAClH;QACD;YACE,UAAU,EAAE,uDAAuD;YACnE,QAAQ,EAAE,wHAAwH;SACnI;QACD;YACE,UAAU,EAAE,sCAAsC;YAClD,QAAQ,EAAE,8GAA8G;SACzH;QACD;YACE,UAAU,EAAE,wCAAwC;YACpD,QAAQ,EAAE,sMAAsM;SACjN;QACD;YACE,UAAU,EAAE,uCAAuC;YACnD,QAAQ,EAAE,oEAAoE;SAC/E;QACD;YACE,UAAU,EAAE,+CAA+C;YAC3D,QAAQ,EAAE,wIAAwI;SACnJ;QACD;YACE,UAAU,EAAE,iDAAiD;YAC7D,QAAQ,EAAE,wEAAwE;SACnF;QACD;YACE,UAAU,EAAE,0CAA0C;YACtD,QAAQ,EAAE,kEAAkE;SAC7E;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,MAAM;SACd;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,MAAM;SACd;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,6DAA6D;QACtE,KAAK,EAAE,0GAA0G;KAClH;IACD,eAAe,EAAE,sNAAsN;IACvO,cAAc,EAAE;QACd,gUAAgU;KACjU;IACD,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,UAAU;IAClB,cAAc,EAAE;QACd,IAAI;QACJ,SAAS;KACV;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins/tic.d.ts

@@ -0,0 +1,4 @@
+import type { BuiltinDoc } from "../../builtins.js";
+declare const builtinDoc: BuiltinDoc;
+export default builtinDoc;
+//# sourceMappingURL=tic.d.ts.map

package/dist/generated/builtins/tic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tic.d.ts","sourceRoot":"","sources":["../../../src/generated/builtins/tic.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,QAAA,MAAM,UAAU,EAAE,UAyGjB,CAAC;AAEF,eAAe,UAAU,CAAC"}