porffor 0.2.0-b9abe0d → 0.2.0-bae0c5b

package/README.md

@@ -14,60 +14,75 @@ Porffor is primarily built from scratch, the only thing that is not is the parse
 Expect nothing to work! Only very limited JS is currently supported. See files in `bench` for examples.
 
 ### Setup
-1. Clone this repo (`git clone https://github.com/CanadaHonk/porffor.git`)
-2. `npm install` - for parser(s)
+**`npm install -g porffor`**. It's that easy (hopefully) :)
 
-### Running a file
-The repos comes with easy alias files for Unix and Windows, which you can use like so:
-- Unix: `./porf path/to/script.js`
-- Windows: `.\porf path/to/script.js`
+### Trying a REPL
+**`porf`**. Just run it with no script file argument.
 
-Please note that further examples below will just use `./porf`, you need to use `.\porf` on Windows. You can also swap out `node` in the alias to use another runtime like Deno (`deno run -A`) or Bun (`bun ...`), or just use it yourself (eg `node runner/index.js ...`, `bun runner/index.js ...`). Node and Bun should work great, Deno support is WIP.
+### Running a JS file
+**`porf path/to/script.js`**
 
-### Trying a REPL
-**`./porf`**. Just run it with no script file argument.
+### Compiling to Wasm
+**`porf wasm path/to/script.js out.wasm`**. Currently it does not use an import standard like WASI, so it is mostly unusable on its own.
 
 ### Compiling to native binaries
 > [!WARNING]
 > Compiling to native binaries uses [2c](#2c), Porffor's own Wasm -> C compiler, which is experimental.
 
-**`./porf native path/to/script.js out(.exe)`**. You can specify the compiler with `-compiler=clang/zig/gcc`, and which opt level to use with `-cO=O3` (`Ofast` by default). Output binaries are also stripped by default.
+**`porf native path/to/script.js out(.exe)`**. You can specify the compiler with `--compiler=clang/zig/gcc`, and which opt level to use with `--cO=O3` (`Ofast` by default). Output binaries are also stripped by default.
 
 ### Compiling to C
 > [!WARNING]
 > Compiling to C uses [2c](#2c), Porffor's own Wasm -> C compiler, which is experimental.
 
-**`./porf c path/to/script.js (out.c)`**. When not including an output file, it will be printed to stdout instead.
+**`porf c path/to/script.js (out.c)`**. When not including an output file, it will be printed to stdout instead.
+
+### Profiling a JS file
+> [!WARNING]
+> Very experimental WIP feature!
+
+**`porf profile path/to/script.js`**
+
+### Debugging a JS file
+> [!WARNING]
+> Very experimental WIP feature!
+
+**`porf debug path/to/script.js`**
+
+### Profiling the generated Wasm of a JS file
+> [!WARNING]
+> Very experimental WIP feature!
+
+**`porf debug-wasm path/to/script.js`**
 
-### Compiling to a Wasm binary
-**`./porf compile path/to/script.js out.wasm`**. Currently it does not use an import standard like WASI, so it is mostly unusable.
 
 ### Options
-- `-target=wasm|c|native` (default: `wasm`) to set target output (native compiles c output to binary, see args below)
-- `-target=c|native` only:
-  - `-o=out.c|out.exe|out` to set file to output c or binary
-- `-target=native` only:
-  - `-compiler=clang` to set compiler binary (path/name) to use to compile
-  - `-cO=O3` to set compiler opt argument
-- `-parser=acorn|@babel/parser|meriyah|hermes-parser` (default: `acorn`) to set which parser to use
-- `-parse-types` to enable parsing type annotations/typescript. if `-parser` is unset, changes default to `@babel/parser`. does not type check
-- `-opt-types` to perform optimizations using type annotations as compiler hints. does not type check
-- `-valtype=i32|i64|f64` (default: `f64`) to set valtype
+- `--parser=acorn|@babel/parser|meriyah|hermes-parser` (default: `acorn`) to set which parser to use
+- `--parse-types` to enable parsing type annotations/typescript. if `-parser` is unset, changes default to `@babel/parser`. does not type check
+- `--opt-types` to perform optimizations using type annotations as compiler hints. does not type check
+- `--valtype=i32|i64|f64` (default: `f64`) to set valtype
 - `-O0` to disable opt
 - `-O1` (default) to enable basic opt (simplify insts, treeshake wasm imports)
 - `-O2` to enable advanced opt (inlining). unstable
 - `-O3` to enable advanceder opt (precompute const math). unstable
-- `-no-run` to not run wasm output, just compile
-- `-opt-log` to log some opts
-- `-code-log` to log some codegen (you probably want `-funcs`)
-- `-regex-log` to log some regex
-- `-funcs` to log funcs
-- `-ast-log` to log AST
-- `-opt-funcs` to log funcs after opt
-- `-sections` to log sections as hex
-- `-opt-no-inline` to not inline any funcs
-- `-tail-call` to enable tail calls (experimental + not widely implemented)
-- `-compile-hints` to enable V8 compilation hints (experimental + doesn't seem to do much?)
+- `--no-run` to not run wasm output, just compile
+- `--opt-log` to log some opts
+- `--code-log` to log some codegen (you probably want `-funcs`)
+- `--regex-log` to log some regex
+- `--funcs` to log funcs
+- `--ast-log` to log AST
+- `--opt-funcs` to log funcs after opt
+- `--sections` to log sections as hex
+- `--opt-no-inline` to not inline any funcs
+- `--tail-call` to enable tail calls (experimental + not widely implemented)
+- `--compile-hints` to enable V8 compilation hints (experimental + doesn't seem to do much?)
+
+### Running in the repo
+The repo comes with easy alias files for Unix and Windows, which you can use like so:
+- Unix: `./porf path/to/script.js`
+- Windows: `.\porf path/to/script.js`
+
+Please note that further examples below will just use `./porf`, you need to use `.\porf` on Windows. You can also swap out `node` in the alias to use another runtime like Deno (`deno run -A`) or Bun (`bun ...`), or just use it yourself (eg `node runner/index.js ...`, `bun runner/index.js ...`). Node and Bun should work great, Deno support is WIP.
 
 ## Limitations
 - No full object support yet
@@ -151,23 +166,28 @@ These include some early (stage 1/0) and/or dead (last commit years ago) proposa
 - Array member setting (`arr[0] = 2`, `arr[0] += 2`, etc)
 - Array constructor (`Array(5)`, `new Array(1, 2, 3)`)
 - Labelled statements (`foo: while (...)`)
+- `do...while` loops
 
 ### Built-ins
 
-- `NaN` and `Infinity` (f64 only)
-- `isNaN()` and `isFinite()` (f64 only)
-- Most of `Number` (`MAX_VALUE`, `MIN_VALUE`, `MAX_SAFE_INTEGER`, `MIN_SAFE_INTEGER`, `POSITIVE_INFINITY`, `NEGATIVE_INFINITY`, `EPSILON`, `NaN`, `isNaN`, `isFinite`, `isInteger`, `isSafeInteger`) (some f64 only)
-- Some `Math` funcs (`sqrt`, `abs`, `floor`, `sign`, `round`, `trunc`, `clz32`, `fround`, `random`) (f64 only)
+- `NaN` and `Infinity`
+- `isNaN()` and `isFinite()`
+- Most of `Number` (`MAX_VALUE`, `MIN_VALUE`, `MAX_SAFE_INTEGER`, `MIN_SAFE_INTEGER`, `POSITIVE_INFINITY`, `NEGATIVE_INFINITY`, `EPSILON`, `NaN`, `isNaN`, `isFinite`, `isInteger`, `isSafeInteger`)
+- Some `Math` funcs (`sqrt`, `abs`, `floor`, `sign`, `round`, `trunc`, `clz32`, `fround`, `random`)
 - Basic `globalThis` support
 - Basic `Boolean` and `Number`
 - Basic `eval` for literals
 - `Math.random()` using self-made xorshift128+ PRNG
-- Some of `performance` (`now()`)
-- Some of `Array.prototype` (`at`, `push`, `pop`, `shift`, `fill`)
+- Some of `performance` (`now()`, `timeOrigin`)
+- Some of `Array.prototype` (`at`, `push`, `pop`, `shift`, `fill`, `slice`, `indexOf`, `lastIndexOf`, `includes`, `with`, `reverse`, `toReversed`)
 - Some of `Array` (`of`, `isArray`)
-- Some of `String.prototype` (`at`, `charAt`, `charCodeAt`)
+- Most of `String.prototype` (`at`, `charAt`, `charCodeAt`, `toUpperCase`, `toLowerCase`, `startsWith`, `endsWith`, `indexOf`, `lastIndexOf`, `includes`, `padStart`, `padEnd`, `substring`, `substr`, `slice`, `trimStart`, `trimEnd`, `trim`, `toString`, `big`, `blink`, `bold`, `fixed`, `italics`, `small`, `strike`, `sub`, `sup`,  `trimLeft`, `trimRight`, )
 - Some of `crypto` (`randomUUID`)
 - `escape`
+- `btoa`
+- Most of `Number.prototype` (`toString`, `toFixed`, `toExponential`)
+- `parseInt`
+- Spec-compliant `Date`
 
 ### Custom
 
@@ -185,7 +205,7 @@ Mostly for reducing size. I do not really care about compiler perf/time as long
 ### Traditional opts
 - Inlining functions (WIP, limited)
 - Inline const math ops
-- Tail calls (behind flag `-tail-call`)
+- Tail calls (behind flag `--tail-call`)
 
 ### Wasm transforms
 - `local.set`, `local.get` -> `local.tee`
@@ -271,8 +291,6 @@ No particular order and no guarentees, just what could happen soon™
   - Run precompiled Wasm file if given
 - Docs
   - Update codebase readme section
-- REPL
-  - Basic polyfill of `node:repl` for non-Node runtimes to work
 - Cool proposals
   - [Optional Chaining Assignment](https://github.com/tc39/proposal-optional-chaining-assignment)
   - [Modulus and Additional Integer Math](https://github.com/tc39/proposal-integer-and-modulus-math)
@@ -292,6 +310,15 @@ No particular order and no guarentees, just what could happen soon™
 ## VSCode extension
 There is a vscode extension in `vscode-ext` which tweaks JS syntax highlighting to be nicer with porffor features (eg highlighting wasm inside of inline asm).
 
+## Wasm proposals used
+Porffor intentionally does not use Wasm proposals which are not commonly implemented yet (eg GC) so it can be used in as many places as possible.
+
+- Multi-value **(required)**
+- Non-trapping float-to-int conversions **(required)**
+- Bulk memory operations (required, but uncommonly used)
+- Exception handling (optional, for errors)
+- Tail calls (opt-in, off by default)
+
 ## Isn't this the same as AssemblyScript/other Wasm langs?
 No. they are not alike at all internally and have very different goals/ideals:
 - Porffor is made as a generic JS engine, not for Wasm stuff specifically

package/asur/index.js

@@ -1244,7 +1244,7 @@ paused = _paused;`);
 });
 
 export const instantiate = async (binary, importImpls) => {
-  const _vm = process?.argv?.includes('-wasm-debug') ? await wasmDebugVm() : vm;
+  const _vm = process?.argv?.includes('--wasm-debug') ? await wasmDebugVm() : vm;
 
   const parsed = parse(binary);
   const exports = {};

package/compiler/assemble.js

@@ -154,7 +154,7 @@ export default (funcs, globals, tags, pages, data, flags) => {
 
   const exports = funcs.filter(x => x.export).map((x, i) => [ ...encodeString(x.name === 'main' ? 'm' : x.name), ExportDesc.func, x.index ]);
 
-  if (Prefs.alwaysMemory && pages.size === 0) pages.set('-always-memory', 0);
+  if (Prefs.alwaysMemory && pages.size === 0) pages.set('--always-memory', 0);
   if (optLevel === 0) pages.set('O0 precaution', 0);
 
   const usesMemory = pages.size > 0;