porffor 0.50.23 → 0.50.25

package/README.md

@@ -67,7 +67,7 @@ Expect nothing to work! Only very limited JS is currently supported. See files i
 - `-O2` to enable advanced opt (partial evaluation). unstable!
 
 ## Current limitations
-- Limited async support
+- Limited async support (`Promise` and `await` have known bugs)
 - No variables between scopes (except args and globals)
 - No `eval()`/`Function()` etc (since it is AOT)
 
@@ -98,41 +98,39 @@ Porffor can run Test262 via some hacks/transforms which remove unsupported featu
 
 ## Codebase
 - `compiler`: contains the compiler itself
-  - `2c.js`: porffor's custom wasm-to-c engine
-  - `allocators.js`: static and dynamic allocators to power various language features
-  - `assemble.js`: assembles wasm ops and metadata into a wasm module/file
+  - `builtins`: built-in apis written in typescript
+  - `2c.js`: custom wasm-to-c engine
+  - `allocator.js`: static/compile-time allocator
+  - `assemble.js`: assembles wasm ops and metadata into a spec-compliant wasm module/file
   - `builtins.js`: all manually written built-ins of the engine (spec, custom. vars, funcs)
   - `builtins_object.js`: all the various built-in objects (think `String`, `globalThis`, etc.)
   - `builtins_precompiled.js`: dynamically generated builtins from the `builtins/` folder
   - `codegen.js`: code (wasm) generation, ast -> wasm. The bulk of the effort
   - `cyclone.js`: wasm partial constant evaluator (it is fast and dangerous hence "cyclone")
   - `decompile.js`: basic wasm decompiler for debug info
-  - `diagram.js`: produces [Mermaid](https://mermaid.js.org) graphs
   - `embedding.js`: utils for embedding consts
   - `encoding.js`: utils for encoding things as bytes as wasm expects
   - `expression.js`: mapping most operators to an opcode (advanced are as built-ins eg `f64_%`)
   - `havoc.js`: wasm rewrite library (it wreaks havoc upon wasm bytecode hence "havoc")
   - `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
+  - `parse.js`: parser simply wrapping acorn (or other acorn-like parsers)
   - `pgo.js`: a profile guided optimizer
   - `precompile.js`: the tool to generate `builtins_precompied.js`
   - `prefs.js`: a utility to read command line arguments
-  - `prototype.js`: some builtin prototype functions
+  - `prototype.js`: some builtin prototype functions (~legacy)
   - `types.js`: definitions for each of the builtin types
   - `wasmSpec.js`: "enums"/info from wasm spec
   - `wrap.js`: wrapper for compiler which instantiates and produces nice exports
 
 - `runner`: contains utils for running JS with the compiler
   - `index.js`: the main file, you probably want to use this
-  - `info.js`: runs with extra info printed
   - `repl.js`: basic repl (uses `node:repl`)
 
 - `rhemyn`: contains [Rhemyn](#rhemyn) - our regex engine (used by Porffor)
-  - `compile.js`: compiles regex ast into wasm bytecode
+  - `compile.js`: compiles regex ast into wasm bytecode aot
   - `parse.js`: own regex parser
 
-- `test`: contains many test files for majority of supported features
 - `test262`: test262 runner and utils
 
 ## Usecases
@@ -143,38 +141,6 @@ Currently, Porffor is seriously limited in features and functionality, however i
 - Potential for SIMD operations and other lower level concepts.
 - More in future probably?
 
-## Todo
-No particular order and no guarantees, just what could happen soon™
-
-- Asur
-  - Support memory
-  - Support exceptions
-- Exceptions
-  - Rethrowing inside catch
-- Optimizations
-  - Rewrite local indexes per func for smallest local header and remove unused idxs
-  - Smarter inline selection (snapshots?)
-  - 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
-  - JS -> Native
-  - Precompiled TS built-ins
-  - Asur
-  - `escape()` optimization
-  - PGO
-- Self hosted testing?
-
 ## 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.
 
@@ -184,20 +150,8 @@ Porffor intentionally does not use Wasm proposals which are not commonly impleme
 - Exception handling (optional, only for errors)
 - Tail calls (opt-in, off by default)
 
-## FAQ
-
-### 1. Why the name?
+## The name
 `purple` in Welsh is `porffor`. Why purple?
 - No other JS engine is purple colored
 - Purple is pretty cool
 - Purple apparently represents "ambition", which is one word to describe this project
-
-### 2. Why at all?
-Yes!
-
-### 3. 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
-- Porffor primarily consumes JS
-- Porffor is written in pure JS and compiles itself, not using Binaryen/etc
-- (Also I didn't know it existed when I started this, lol)

package/compiler/index.js

@@ -9,7 +9,6 @@ import toc from './2c.js';
 import * as pgo from './pgo.js';
 import cyclone from './cyclone.js';
 import './prefs.js';
-import * as Diagram from './diagram.js';
 
 globalThis.decompile = decompile;
 
@@ -188,9 +187,6 @@ export default (code, module = undefined) => {
       }
     };
     print(data);
-
-    // const url = Diagram.url(Diagram.tree(data));
-    // console.log(`built-in tree: ${url}`);
   }
 
   if (logProgress) progressStart('assembling...');

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "porffor",
   "description": "a basic experimental wip aot optimizing js -> wasm engine/compiler/runtime in js",
-  "version": "0.50.23",
+  "version": "0.50.25",
   "author": "CanadaHonk",
   "license": "MIT",
   "scripts": {},

package/runner/index.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 import fs from 'node:fs';
-globalThis.version = '0.50.23';
+globalThis.version = '0.50.25';
 
 // deno compat
 if (typeof process === 'undefined' && typeof Deno !== 'undefined') {

package/compiler/diagram.js

@@ -1,31 +0,0 @@
-export const tree = data => {
-  let out = 'flowchart LR\n';
-  let ids = new Map();
-
-  const run = (x, parent = null) => {
-    for (const [ name, children ] of x) {
-      const alreadyHas = ids.has(name);
-      if (!alreadyHas) ids.set(name, ids.size);
-      const id = ids.get(name);
-
-      if (!alreadyHas || parent != null) {
-        if (parent != null) out += `${parent}-->`;
-        out += `${id}${alreadyHas ? '' : `["${name}"]`}\n`;
-      }
-
-      if (children) run(children, id);
-    }
-  };
-  run(data);
-
-  return out;
-};
-
-export const url = code => `https://mermaid.live/view#${btoa(JSON.stringify({
-  mermaid: code.length > 10000 ? { theme: 'dark', securityLevel: 'loose', maxEdges: 5000 } : { theme: 'dark' },
-  updateDiagram: true,
-  autoSync: true,
-  rough: false,
-  panZoom: true,
-  code
-}))}`;