porffor 0.2.0-c1d7382 → 0.2.0-c56b8bf

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 CanadaHonk
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2023 CanadaHonk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -77,10 +77,15 @@ Please note that further examples below will just use `./porf`, you need to use
 - Literal callees only in calls (eg `print()` works, `a = print; a()` does not)
 - No `eval()` etc (since it is AOT)
 
-## Rhemyn
+## Sub-engines
+
+### Asur
+Asur is Porffor's own Wasm engine; it is an intentionally simple interpreter written in JS. It is very WIP. See [its readme](asur/README.md) for more details.
+
+### Rhemyn
 Rhemyn is Porffor's own regex engine; it compiles literal regex to Wasm bytecode AOT (remind you of anything?). It is quite basic and WIP. See [its readme](rhemyn/README.md) for more details.
 
-## 2c
+### 2c
 2c is Porffor's own Wasm -> C compiler, using generated Wasm bytecode and internal info to generate specific and efficient/fast C code. Little boilerplate/preluded code or required external files, just for CLI binaries (not like wasm2c very much).
 
 ## Supported
@@ -145,20 +150,29 @@ These include some early (stage 1/0) and/or dead (last commit years ago) proposa
 - `for...of` (arrays and strings)
 - 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 (`Math.sqrt`, `Math.abs`, `Math.floor`, `Math.sign`, `Math.round`, `Math.trunc`, `Math.clz32`, `Math.fround`, `Math.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 `String.prototype` (`at`, `charAt`, `charCodeAt`)
+- 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`)
+- 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
 
@@ -167,44 +181,6 @@ These include some early (stage 1/0) and/or dead (last commit years ago) proposa
 - Intrinsic functions (see below)
 - Inlining wasm via ``asm`...``\` "macro"
 
-## Todo
-No particular order and no guarentees, just what could happen soon™
-
-- Arrays
-  - More of `Array` prototype
-  - Arrays/strings inside arrays
-  - Destructuring
-- Objects
-  - Basic object expressions (eg `{}`, `{ a: 0 }`)
-- Wasm
-  - *Basic* Wasm engine (interpreter) in JS
-- More math operators (`**`, etc)
-- `do { ... } while (...)`
-- Typed export inputs (array)
-- Exceptions
-  - Rewrite to use actual strings (optional?)
-  - `try { } finally { }`
-  - Rethrowing inside catch
-- Optimizations
-  - Rewrite local indexes per func for smallest local header and remove unused idxs
-  - Smarter inline selection (snapshots?)
-  - Remove const ifs (`if (true)`, etc)
-  - Memory alignment
-- Runtime
-  - WASI target
-  - Run precompiled Wasm file if given
-- 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)
-  - [Array Equality](https://github.com/tc39/proposal-array-equality)
-  - [Declarations in Conditionals](https://github.com/tc39/proposal-Declarations-in-Conditionals)
-  - [Seeded Pseudo-Random Numbers](https://github.com/tc39/proposal-seeded-random)
-  - [`do` expressions](https://github.com/tc39/proposal-do-expressions)
-  - [String Trim Characters](https://github.com/Kingwl/proposal-string-trim-characters)
-- Posts
-  - Inlining investigation
-- Self hosted testing?
-
 ## Performance
 *For the features it supports most of the time*, Porffor is *blazingly fast* compared to most interpreters and common engines running without JIT. For those with JIT, it is usually slower by default, but can catch up with compiler arguments and typed input, even more so when compiling to native binaries.
 
@@ -241,7 +217,7 @@ Porffor can run Test262 via some hacks/transforms which remove unsupported featu
 ## Codebase
 - `compiler`: contains the compiler itself
   - `builtins.js`: all built-ins of the engine (spec, custom. vars, funcs)
-  - `codeGen.js`: code (wasm) generation, ast -> wasm. The bulk of the effort
+  - `codegen.js`: code (wasm) generation, ast -> wasm. The bulk of the effort
   - `decompile.js`: basic wasm decompiler for debug info
   - `embedding.js`: utils for embedding consts
   - `encoding.js`: utils for encoding things as bytes as wasm expects
@@ -249,7 +225,7 @@ Porffor can run Test262 via some hacks/transforms which remove unsupported featu
   - `index.js`: doing all the compiler steps, takes code in, wasm out
   - `opt.js`: self-made wasm bytecode optimizer
   - `parse.js`: parser simply wrapping acorn
-  - `sections.js`: assembles wasm ops and metadata into a wasm module/file
+  - `assemble.js`: assembles wasm ops and metadata into a wasm module/file
   - `wasmSpec.js`: "enums"/info from wasm spec
   - `wrap.js`: wrapper for compiler which instantiates and produces nice exports
 
@@ -271,8 +247,62 @@ Basically none right now (other than giving people headaches). Potential ideas:
 - Compiling JS to native binaries. This is still very early!
 - More in future probably?
 
+## Todo
+No particular order and no guarentees, just what could happen soon™
+
+- Arrays
+  - More of `Array` prototype
+  - Arrays/strings inside arrays
+  - Destructuring
+- Objects
+  - Basic object expressions (eg `{}`, `{ a: 0 }`)
+- Asur
+  - Support memory
+  - Support exceptions
+- More math operators (`**`, etc)
+- Typed export inputs (array)
+- Exceptions
+  - Rewrite to use actual strings (optional?)
+  - `try { } finally { }`
+  - Rethrowing inside catch
+- Optimizations
+  - Rewrite local indexes per func for smallest local header and remove unused idxs
+  - Smarter inline selection (snapshots?)
+  - Remove const ifs (`if (true)`, etc)
+  - Memory alignment
+  - Add general pref for always using "fast" (non-short circuiting) or/and
+- Runtime
+  - WASI target
+  - Run precompiled Wasm file if given
+- Docs
+  - Update codebase readme section
+- 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)
+  - [Array Equality](https://github.com/tc39/proposal-array-equality)
+  - [Declarations in Conditionals](https://github.com/tc39/proposal-Declarations-in-Conditionals)
+  - [Seeded Pseudo-Random Numbers](https://github.com/tc39/proposal-seeded-random)
+  - [`do` expressions](https://github.com/tc39/proposal-do-expressions)
+  - [String Trim Characters](https://github.com/Kingwl/proposal-string-trim-characters)
+- Posts
+  - Inlining investigation
+  - JS -> Native
+  - Precompiled TS built-ins
+  - Asur
+  - `escape()` optimization
+- Self hosted testing?
+
 ## VSCode extension
-There is a vscode extension in `porffor-for-vscode` which tweaks JS syntax highlighting to be nicer with porffor features (eg highlighting wasm inside of inline asm).
+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:

package/asur/README.md

@@ -0,0 +1,2 @@
+# asur
+a basic experimental wip wasm engine/interpreter in js. wasm engine for porffor. not serious/intended for (real) use