porffor 0.2.0-e04e26f → 0.2.0-e62542f
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CONTRIBUTING.md +254 -0
- package/README.md +63 -44
- package/asur/index.js +1 -1
- package/compiler/assemble.js +1 -1
- package/compiler/builtins/annexb_string.js +2 -2
- package/compiler/builtins/annexb_string.ts +5 -6
- package/compiler/builtins/array.ts +10 -10
- package/compiler/builtins/base64.ts +4 -79
- package/compiler/builtins/crypto.ts +1 -1
- package/compiler/builtins/date.ts +1292 -349
- package/compiler/builtins/escape.ts +2 -2
- package/compiler/builtins/int.ts +3 -3
- package/compiler/builtins/number.ts +1 -1
- package/compiler/builtins/porffor.d.ts +21 -4
- package/compiler/builtins/string.ts +22 -22
- package/compiler/builtins/tostring.ts +4 -4
- package/compiler/builtins.js +6 -30
- package/compiler/codegen.js +138 -68
- package/compiler/decompile.js +0 -1
- package/compiler/generated_builtins.js +499 -154
- package/compiler/parse.js +4 -2
- package/compiler/precompile.js +7 -2
- package/compiler/prefs.js +6 -5
- package/compiler/prototype.js +14 -14
- package/compiler/types.js +1 -1
- package/compiler/wrap.js +3 -3
- package/package.json +1 -1
- package/rhemyn/compile.js +42 -25
- package/rhemyn/parse.js +4 -5
- package/runner/index.js +45 -4
- package/runner/repl.js +2 -2
- package/runner/sizes.js +1 -1
package/CONTRIBUTING.md
ADDED
@@ -0,0 +1,254 @@
|
|
1
|
+
# Contributing to Porffor
|
2
|
+
|
3
|
+
Hello! Thanks for your potential interest in contributing to Porffor :)
|
4
|
+
|
5
|
+
This document hopes to help you understand Porffor-specific TS, specifically for writing built-ins (inside `compiler/builtins/*.ts` eg `btoa`, `String.prototype.trim`, ...). This guide isn't really meant for modifying the compiler itself yet (eg `compiler/codegen.js`), as built-ins are ~easier to implement and more useful at the moment.
|
6
|
+
|
7
|
+
I mostly presume decent JS knowledge, with some basic TS too but nothing complicated. Knowing low-level stuff generally (pointers, etc) and/or Wasm (bytecode) is also a plus but hopefully not required.
|
8
|
+
|
9
|
+
If you have any questions you can ask in [the Porffor Discord](https://discord.gg/6crs9Znx9R), please feel free to ask anything if you get stuck :)
|
10
|
+
|
11
|
+
Please read this entire document before beginning as there are important things throughout.
|
12
|
+
|
13
|
+
<br>
|
14
|
+
|
15
|
+
## Setup
|
16
|
+
|
17
|
+
1. Clone the repo and enter the repo (`git clone https://github.com/CanadaHonk/porffor.git`)
|
18
|
+
2. `npm install`
|
19
|
+
|
20
|
+
The repo comes with easy alias scripts for Unix and Windows, which you can use like so:
|
21
|
+
- Unix: `./porf path/to/script.js`
|
22
|
+
- Windows: `.\porf path/to/script.js`
|
23
|
+
|
24
|
+
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, Deno, Bun should work.
|
25
|
+
|
26
|
+
|
27
|
+
### Precompile
|
28
|
+
|
29
|
+
**If you update any file inside `compiler/builtins` you will need to do this for it to update inside Porffor otherwise your changes will have no effect.** Run `node compiler/precompile.js` to precompile. It may error during this, if so, you might have an error in your code or there could be a compiler error with Porffor (feel free to ask for help as soon as you encounter any errors with it).
|
30
|
+
|
31
|
+
<br>
|
32
|
+
|
33
|
+
## Types
|
34
|
+
|
35
|
+
Porffor has usual JS types (or at least the ones it supports), but also internal types for various reasons.
|
36
|
+
|
37
|
+
### ByteString
|
38
|
+
|
39
|
+
The most important and widely used internal type is ByteString. Regular strings in Porffor are UTF-16 encoded, so each character uses 2 bytes. ByteStrings are special strings which are used when the characters in a string only use ASCII/LATIN-1 characters, so the lower byte of the UTF-16 characters are unused. Instead of wasting memory with all the unused memory, ByteStrings instead use 1 byte per character. This halves memory usage of such strings and also makes operating on them faster. The downside is that many Porffor built-ins have to be written twice, slightly different, for both `String` and `ByteString` types.
|
40
|
+
|
41
|
+
### i32
|
42
|
+
|
43
|
+
This is complicated internally but essentially, only use it for pointers. (This is not signed or unsigned, instead it is the Wasm valtype `i32` so the signage is ~instruction dependant).
|
44
|
+
|
45
|
+
<br>
|
46
|
+
|
47
|
+
## Pointers
|
48
|
+
|
49
|
+
Pointers are the main (and most difficult) unique feature you ~need to understand when dealing with objects (arrays, strings, ...).
|
50
|
+
|
51
|
+
We'll explain things per common usage you will likely need to know:
|
52
|
+
|
53
|
+
## Commonly used Wasm code
|
54
|
+
|
55
|
+
### Get a pointer
|
56
|
+
|
57
|
+
```js
|
58
|
+
Porffor.wasm`local.get ${foobar}`
|
59
|
+
```
|
60
|
+
|
61
|
+
Gets the pointer to the variable `foobar`. You don't really need to worry about how it works in detail, but essentially it gets the pointer as a number (type) instead of as the object it is.
|
62
|
+
|
63
|
+
### Store a character in a ByteString
|
64
|
+
|
65
|
+
```js
|
66
|
+
Porffor.wasm.i32.store8(pointer, characterCode, 0, 4)
|
67
|
+
```
|
68
|
+
|
69
|
+
Stores the character code `characterCode` at the pointer `pointer` **for a ByteString**.[^1]
|
70
|
+
|
71
|
+
### Store a character in a String
|
72
|
+
|
73
|
+
```js
|
74
|
+
Porffor.wasm.i32.store16(pointer, characterCode, 0, 4)
|
75
|
+
```
|
76
|
+
|
77
|
+
Stores the character code `characterCode` at the pointer `pointer` **for a String**.[^1]
|
78
|
+
|
79
|
+
### Load a character from a ByteString
|
80
|
+
|
81
|
+
```js
|
82
|
+
Porffor.wasm.i32.load8_u(pointer, 0, 4)
|
83
|
+
```
|
84
|
+
|
85
|
+
Loads the character code at the pointer `pointer` **for a ByteString**.[^1]
|
86
|
+
|
87
|
+
### Load a character from a String
|
88
|
+
|
89
|
+
```js
|
90
|
+
Porffor.wasm.i32.load16_u(pointer, 0, 4)
|
91
|
+
```
|
92
|
+
|
93
|
+
Loads the character code at the pointer `pointer` **for a String**.[^1]
|
94
|
+
|
95
|
+
### Manually store the length of an object
|
96
|
+
|
97
|
+
```js
|
98
|
+
Porffor.wasm.i32.store(pointer, length, 0, 0)
|
99
|
+
```
|
100
|
+
|
101
|
+
Stores the length `length` at pointer `pointer`, setting the length of an object. This is mostly unneeded today as you can just do `obj.length = length`. [^2]
|
102
|
+
|
103
|
+
<br>
|
104
|
+
|
105
|
+
## Example
|
106
|
+
|
107
|
+
Here is the code for `ByteString.prototype.toUpperCase()`:
|
108
|
+
|
109
|
+
```ts
|
110
|
+
export const __ByteString_prototype_toUpperCase = (_this: bytestring) => {
|
111
|
+
const len: i32 = _this.length;
|
112
|
+
|
113
|
+
let out: bytestring = '';
|
114
|
+
Porffor.wasm.i32.store(out, len, 0, 0);
|
115
|
+
|
116
|
+
let i: i32 = Porffor.wasm`local.get ${_this}`,
|
117
|
+
j: i32 = Porffor.wasm`local.get ${out}`;
|
118
|
+
|
119
|
+
const endPtr: i32 = i + len;
|
120
|
+
while (i < endPtr) {
|
121
|
+
let chr: i32 = Porffor.wasm.i32.load8_u(i++, 0, 4);
|
122
|
+
|
123
|
+
if (chr >= 97) if (chr <= 122) chr -= 32;
|
124
|
+
|
125
|
+
Porffor.wasm.i32.store8(j++, chr, 0, 4);
|
126
|
+
}
|
127
|
+
|
128
|
+
return out;
|
129
|
+
};
|
130
|
+
```
|
131
|
+
|
132
|
+
Now let's go through it section by section:
|
133
|
+
|
134
|
+
```ts
|
135
|
+
export const __ByteString_prototype_toUpperCase = (_this: bytestring) => {
|
136
|
+
```
|
137
|
+
|
138
|
+
Here we define a built-in for Porffor. Notably:
|
139
|
+
- We do not use `a.b.c`, instead we use `__a_b_c`
|
140
|
+
- We use a `_this` argument, as `this` does not exist in Porffor yet
|
141
|
+
- We use an arrow function
|
142
|
+
|
143
|
+
---
|
144
|
+
|
145
|
+
```ts
|
146
|
+
const len: i32 = _this.length;
|
147
|
+
|
148
|
+
let out: bytestring = '';
|
149
|
+
Porffor.wasm.i32.store(out, len, 0, 0);
|
150
|
+
```
|
151
|
+
|
152
|
+
This sets up the `out` variable we are going to write to for the output of this function. We set the length in advance to be the same as `_this`, as `foo.length == foo.toLowerCase().length`, because we will later be manually writing to it using Wasm intrinsics, which will not update the length themselves.
|
153
|
+
|
154
|
+
---
|
155
|
+
|
156
|
+
```ts
|
157
|
+
let i: i32 = Porffor.wasm`local.get ${_this}`,
|
158
|
+
j: i32 = Porffor.wasm`local.get ${out}`;
|
159
|
+
```
|
160
|
+
|
161
|
+
Get the pointers for `_this` and `out` as `i32`s (~`number`s).
|
162
|
+
|
163
|
+
---
|
164
|
+
|
165
|
+
```ts
|
166
|
+
const endPtr: i32 = i + len;
|
167
|
+
while (i < endPtr) {
|
168
|
+
```
|
169
|
+
|
170
|
+
Set up an end target pointer as the pointer variable for `_this` plus the length of it. Loop below until that pointer reaches the end target, so we iterate through the entire string.
|
171
|
+
|
172
|
+
---
|
173
|
+
|
174
|
+
```ts
|
175
|
+
let chr: i32 = Porffor.wasm.i32.load8_u(i++, 0, 4);
|
176
|
+
```
|
177
|
+
|
178
|
+
Read the character (code) from the current `_this` pointer variable, and increment it so next iteration it reads the next character, etc.
|
179
|
+
|
180
|
+
---
|
181
|
+
|
182
|
+
```ts
|
183
|
+
if (chr >= 97) if (chr <= 122) chr -= 32;
|
184
|
+
```
|
185
|
+
|
186
|
+
If the character code is >= 97 (`a`) and <= 122 (`z`), decrease it by 32, making it an upper case character. eg: 97 (`a`) - 32 = 65 (`A`).
|
187
|
+
|
188
|
+
---
|
189
|
+
|
190
|
+
```ts
|
191
|
+
Porffor.wasm.i32.store8(j++, chr, 0, 4);
|
192
|
+
```
|
193
|
+
|
194
|
+
Store the character code into the `out` pointer variable, and increment it.
|
195
|
+
|
196
|
+
<br>
|
197
|
+
|
198
|
+
## Porffor-specific TS notes
|
199
|
+
|
200
|
+
- For declaring variables, you must use explicit type annotations currently (eg `let a: number = 1`, not `let a = 1`)
|
201
|
+
- You might spot `Porffor.fastOr`/`Porffor.fastAnd`, these are non-short circuiting versions of `||`/`&&`, taking any number of conditions as arguments. You shouldn't don't need to use or worry about these.
|
202
|
+
- **There are ~no objects, you cannot use them/literals.**
|
203
|
+
- Attempt to avoid string/array-heavy code and use more variables instead if possible, easier on memory and CPU/perf.
|
204
|
+
|
205
|
+
<br>
|
206
|
+
|
207
|
+
## Formatting/linting
|
208
|
+
|
209
|
+
There is 0 setup for this (right now). You can try looking through the other built-ins files but do not worry about it a lot, I honestly do not mind going through and cleaning up after a PR as long as the code itself is good :^)
|
210
|
+
|
211
|
+
<br>
|
212
|
+
|
213
|
+
## Commit (message) style
|
214
|
+
|
215
|
+
You should ideally have one commit per notable change (using amend/force push). Commit messages should be like `${file}: ${description}`. Don't be afraid to use long titles if needed, but try and be short if possible. Bonus points for detail in commit description. ~~Gold star for jokes in description too.~~
|
216
|
+
|
217
|
+
Examples:
|
218
|
+
```
|
219
|
+
builtins/date: impl toJSON
|
220
|
+
builtins/date: fix ToIntegerOrInfinity returning -0
|
221
|
+
codegen: fix inline wasm for unreachable
|
222
|
+
builtins/array: wip toReversed
|
223
|
+
builtins/tostring_number: impl radix
|
224
|
+
```
|
225
|
+
|
226
|
+
<br>
|
227
|
+
|
228
|
+
## Test262
|
229
|
+
|
230
|
+
Make sure you have Test262 cloned already **inside of `test262/`** (`git clone https://github.com/tc39/test262.git test262/test262`).
|
231
|
+
|
232
|
+
Run `node test262` to run all the tests and get an output of total overall test results. The main thing you want to pay attention to is the emoji summary (lol):
|
233
|
+
```
|
234
|
+
🧪 50005 | 🤠 7007 (-89) | ❌ 1914 (-32) | 💀 13904 (-61) | 📝 23477 (-120) | ⏰ 2 | 🏗 2073 (+302) | 💥 1628
|
235
|
+
```
|
236
|
+
|
237
|
+
To break this down:
|
238
|
+
🧪 total 🤠 pass ❌ fail 💀 runtime error 📝 todo (error) ⏰ timeout 🏗️ wasm compile error 💥 compile error
|
239
|
+
|
240
|
+
The diff compared to the last commit (with test262 data) is shown in brackets. Basically, you can passes 🤠 up, and errors 💀📝🏗💥 down. It is fine if some errors change balance/etc, as long as they are not new failures.
|
241
|
+
|
242
|
+
It will also log new passes/fails. Be careful as sometimes the overall passes can increase, but other files have also regressed into failures which you might miss. Also keep in mind some tests may have been false positives before, but we can investigate the diff together :)
|
243
|
+
|
244
|
+
### Debugging tips
|
245
|
+
|
246
|
+
- Use `node test262 path/to/tests` to run specific test262 dirs/files (eg `node test262 built-ins/Date`).
|
247
|
+
- Use `--log-errors` to log the errors of individual tests.
|
248
|
+
- Use `--debug-asserts` to log expected/actual of assertion failures (experimental).
|
249
|
+
|
250
|
+
<br>
|
251
|
+
|
252
|
+
[^1]: The `0, 4` args are necessary for the Wasm instruction, but you don't need to worry about them (`0` alignment, `4` byte offset for length).
|
253
|
+
|
254
|
+
[^2]: The `0, 4` args are necessary for the Wasm instruction, but you don't need to worry about them (`0` alignment, `0` byte offset).
|
package/README.md
CHANGED
@@ -14,60 +14,68 @@ Porffor is primarily built from scratch, the only thing that is not is the parse
|
|
14
14
|
Expect nothing to work! Only very limited JS is currently supported. See files in `bench` for examples.
|
15
15
|
|
16
16
|
### Setup
|
17
|
-
|
18
|
-
2. `npm install` - for parser(s)
|
17
|
+
**`npm install -g porffor`**. It's that easy (hopefully) :)
|
19
18
|
|
20
|
-
###
|
21
|
-
|
22
|
-
- Unix: `./porf path/to/script.js`
|
23
|
-
- Windows: `.\porf path/to/script.js`
|
19
|
+
### Trying a REPL
|
20
|
+
**`porf`**. Just run it with no script file argument.
|
24
21
|
|
25
|
-
|
22
|
+
### Running a JS file
|
23
|
+
**`porf path/to/script.js`**
|
26
24
|
|
27
|
-
###
|
28
|
-
|
25
|
+
### Compiling to Wasm
|
26
|
+
**`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.
|
29
27
|
|
30
28
|
### Compiling to native binaries
|
31
29
|
> [!WARNING]
|
32
30
|
> Compiling to native binaries uses [2c](#2c), Porffor's own Wasm -> C compiler, which is experimental.
|
33
31
|
|
34
|
-
|
32
|
+
**`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.
|
35
33
|
|
36
34
|
### Compiling to C
|
37
35
|
> [!WARNING]
|
38
36
|
> Compiling to C uses [2c](#2c), Porffor's own Wasm -> C compiler, which is experimental.
|
39
37
|
|
40
|
-
|
38
|
+
**`porf c path/to/script.js (out.c)`**. When not including an output file, it will be printed to stdout instead.
|
39
|
+
|
40
|
+
### Profiling a JS file
|
41
|
+
> [!WARNING]
|
42
|
+
> Very experimental WIP feature!
|
43
|
+
|
44
|
+
**`porf profile path/to/script.js`**
|
45
|
+
|
46
|
+
### Debugging a JS file
|
47
|
+
> [!WARNING]
|
48
|
+
> Very experimental WIP feature!
|
49
|
+
|
50
|
+
**`porf debug path/to/script.js`**
|
51
|
+
|
52
|
+
### Profiling the generated Wasm of a JS file
|
53
|
+
> [!WARNING]
|
54
|
+
> Very experimental WIP feature!
|
55
|
+
|
56
|
+
**`porf debug-wasm path/to/script.js`**
|
41
57
|
|
42
|
-
### Compiling to a Wasm binary
|
43
|
-
**`./porf compile path/to/script.js out.wasm`**. Currently it does not use an import standard like WASI, so it is mostly unusable.
|
44
58
|
|
45
59
|
### Options
|
46
|
-
-
|
47
|
-
- `-
|
48
|
-
|
49
|
-
-
|
50
|
-
- `-compiler=clang` to set compiler binary (path/name) to use to compile
|
51
|
-
- `-cO=O3` to set compiler opt argument
|
52
|
-
- `-parser=acorn|@babel/parser|meriyah|hermes-parser` (default: `acorn`) to set which parser to use
|
53
|
-
- `-parse-types` to enable parsing type annotations/typescript. if `-parser` is unset, changes default to `@babel/parser`. does not type check
|
54
|
-
- `-opt-types` to perform optimizations using type annotations as compiler hints. does not type check
|
55
|
-
- `-valtype=i32|i64|f64` (default: `f64`) to set valtype
|
60
|
+
- `--parser=acorn|@babel/parser|meriyah|hermes-parser` (default: `acorn`) to set which parser to use
|
61
|
+
- `--parse-types` to enable parsing type annotations/typescript. if `-parser` is unset, changes default to `@babel/parser`. does not type check
|
62
|
+
- `--opt-types` to perform optimizations using type annotations as compiler hints. does not type check
|
63
|
+
- `--valtype=i32|i64|f64` (default: `f64`) to set valtype
|
56
64
|
- `-O0` to disable opt
|
57
65
|
- `-O1` (default) to enable basic opt (simplify insts, treeshake wasm imports)
|
58
66
|
- `-O2` to enable advanced opt (inlining). unstable
|
59
67
|
- `-O3` to enable advanceder opt (precompute const math). unstable
|
60
|
-
-
|
61
|
-
-
|
62
|
-
-
|
63
|
-
-
|
64
|
-
-
|
65
|
-
-
|
66
|
-
-
|
67
|
-
-
|
68
|
-
-
|
69
|
-
-
|
70
|
-
-
|
68
|
+
- `--no-run` to not run wasm output, just compile
|
69
|
+
- `--opt-log` to log some opts
|
70
|
+
- `--code-log` to log some codegen (you probably want `-funcs`)
|
71
|
+
- `--regex-log` to log some regex
|
72
|
+
- `--funcs` to log funcs
|
73
|
+
- `--ast-log` to log AST
|
74
|
+
- `--opt-funcs` to log funcs after opt
|
75
|
+
- `--sections` to log sections as hex
|
76
|
+
- `--opt-no-inline` to not inline any funcs
|
77
|
+
- `--tail-call` to enable tail calls (experimental + not widely implemented)
|
78
|
+
- `--compile-hints` to enable V8 compilation hints (experimental + doesn't seem to do much?)
|
71
79
|
|
72
80
|
## Limitations
|
73
81
|
- No full object support yet
|
@@ -151,24 +159,28 @@ These include some early (stage 1/0) and/or dead (last commit years ago) proposa
|
|
151
159
|
- Array member setting (`arr[0] = 2`, `arr[0] += 2`, etc)
|
152
160
|
- Array constructor (`Array(5)`, `new Array(1, 2, 3)`)
|
153
161
|
- Labelled statements (`foo: while (...)`)
|
154
|
-
- `do...while`
|
162
|
+
- `do...while` loops
|
155
163
|
|
156
164
|
### Built-ins
|
157
165
|
|
158
|
-
- `NaN` and `Infinity`
|
159
|
-
- `isNaN()` and `isFinite()`
|
160
|
-
- Most of `Number` (`MAX_VALUE`, `MIN_VALUE`, `MAX_SAFE_INTEGER`, `MIN_SAFE_INTEGER`, `POSITIVE_INFINITY`, `NEGATIVE_INFINITY`, `EPSILON`, `NaN`, `isNaN`, `isFinite`, `isInteger`, `isSafeInteger`)
|
161
|
-
- Some `Math` funcs (`sqrt`, `abs`, `floor`, `sign`, `round`, `trunc`, `clz32`, `fround`, `random`)
|
166
|
+
- `NaN` and `Infinity`
|
167
|
+
- `isNaN()` and `isFinite()`
|
168
|
+
- Most of `Number` (`MAX_VALUE`, `MIN_VALUE`, `MAX_SAFE_INTEGER`, `MIN_SAFE_INTEGER`, `POSITIVE_INFINITY`, `NEGATIVE_INFINITY`, `EPSILON`, `NaN`, `isNaN`, `isFinite`, `isInteger`, `isSafeInteger`)
|
169
|
+
- Some `Math` funcs (`sqrt`, `abs`, `floor`, `sign`, `round`, `trunc`, `clz32`, `fround`, `random`)
|
162
170
|
- Basic `globalThis` support
|
163
171
|
- Basic `Boolean` and `Number`
|
164
172
|
- Basic `eval` for literals
|
165
173
|
- `Math.random()` using self-made xorshift128+ PRNG
|
166
174
|
- Some of `performance` (`now()`, `timeOrigin`)
|
167
|
-
- Some of `Array.prototype` (`at`, `push`, `pop`, `shift`, `fill`)
|
175
|
+
- Some of `Array.prototype` (`at`, `push`, `pop`, `shift`, `fill`, `slice`, `indexOf`, `lastIndexOf`, `includes`, `with`, `reverse`, `toReversed`)
|
168
176
|
- Some of `Array` (`of`, `isArray`)
|
169
|
-
-
|
177
|
+
- 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`, )
|
170
178
|
- Some of `crypto` (`randomUUID`)
|
171
179
|
- `escape`
|
180
|
+
- `btoa`
|
181
|
+
- Most of `Number.prototype` (`toString`, `toFixed`, `toExponential`)
|
182
|
+
- `parseInt`
|
183
|
+
- Spec-compliant `Date`
|
172
184
|
|
173
185
|
### Custom
|
174
186
|
|
@@ -186,7 +198,7 @@ Mostly for reducing size. I do not really care about compiler perf/time as long
|
|
186
198
|
### Traditional opts
|
187
199
|
- Inlining functions (WIP, limited)
|
188
200
|
- Inline const math ops
|
189
|
-
- Tail calls (behind flag
|
201
|
+
- Tail calls (behind flag `--tail-call`)
|
190
202
|
|
191
203
|
### Wasm transforms
|
192
204
|
- `local.set`, `local.get` -> `local.tee`
|
@@ -272,8 +284,6 @@ No particular order and no guarentees, just what could happen soon™
|
|
272
284
|
- Run precompiled Wasm file if given
|
273
285
|
- Docs
|
274
286
|
- Update codebase readme section
|
275
|
-
- REPL
|
276
|
-
- Basic polyfill of `node:repl` for non-Node runtimes to work
|
277
287
|
- Cool proposals
|
278
288
|
- [Optional Chaining Assignment](https://github.com/tc39/proposal-optional-chaining-assignment)
|
279
289
|
- [Modulus and Additional Integer Math](https://github.com/tc39/proposal-integer-and-modulus-math)
|
@@ -293,6 +303,15 @@ No particular order and no guarentees, just what could happen soon™
|
|
293
303
|
## VSCode extension
|
294
304
|
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).
|
295
305
|
|
306
|
+
## Wasm proposals used
|
307
|
+
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.
|
308
|
+
|
309
|
+
- Multi-value **(required)**
|
310
|
+
- Non-trapping float-to-int conversions **(required)**
|
311
|
+
- Bulk memory operations (required, but uncommonly used)
|
312
|
+
- Exception handling (optional, for errors)
|
313
|
+
- Tail calls (opt-in, off by default)
|
314
|
+
|
296
315
|
## Isn't this the same as AssemblyScript/other Wasm langs?
|
297
316
|
No. they are not alike at all internally and have very different goals/ideals:
|
298
317
|
- Porffor is made as a generic JS engine, not for Wasm stuff specifically
|
package/asur/index.js
CHANGED
@@ -1244,7 +1244,7 @@ paused = _paused;`);
|
|
1244
1244
|
});
|
1245
1245
|
|
1246
1246
|
export const instantiate = async (binary, importImpls) => {
|
1247
|
-
const _vm = process?.argv?.includes('
|
1247
|
+
const _vm = process?.argv?.includes('--wasm-debug') ? await wasmDebugVm() : vm;
|
1248
1248
|
|
1249
1249
|
const parsed = parse(binary);
|
1250
1250
|
const exports = {};
|
package/compiler/assemble.js
CHANGED
@@ -154,7 +154,7 @@ export default (funcs, globals, tags, pages, data, flags) => {
|
|
154
154
|
|
155
155
|
const exports = funcs.filter(x => x.export).map((x, i) => [ ...encodeString(x.name === 'main' ? 'm' : x.name), ExportDesc.func, x.index ]);
|
156
156
|
|
157
|
-
if (Prefs.alwaysMemory && pages.size === 0) pages.set('
|
157
|
+
if (Prefs.alwaysMemory && pages.size === 0) pages.set('--always-memory', 0);
|
158
158
|
if (optLevel === 0) pages.set('O0 precaution', 0);
|
159
159
|
|
160
160
|
const usesMemory = pages.size > 0;
|
@@ -1,5 +1,5 @@
|
|
1
1
|
export default () => {
|
2
|
-
let out = `// @porf
|
2
|
+
let out = `// @porf --funsafe-no-unlikely-proto-checks --valtype=i32
|
3
3
|
`;
|
4
4
|
|
5
5
|
const annexB_noArgs = (a0, a1) => out += `
|
@@ -31,7 +31,7 @@ ${[...a1].map((x, i) => ` Porffor.wasm.i32.store16(outPtr, ${x.charCodeAt(0)},
|
|
31
31
|
|
32
32
|
return out;
|
33
33
|
};
|
34
|
-
export const
|
34
|
+
export const __ByteString_prototype_${a0} = (_this: bytestring) => {
|
35
35
|
let out: bytestring = Porffor.bs\`<${a1}>\`;
|
36
36
|
|
37
37
|
let outPtr: i32 = Porffor.wasm\`local.get \${out}\` + ${2 + a1.length};
|
@@ -1,12 +1,11 @@
|
|
1
|
-
// @porf
|
1
|
+
// @porf --funsafe-no-unlikely-proto-checks --valtype=i32
|
2
2
|
|
3
|
-
// todo: trimLeft, trimRight
|
4
3
|
export const __String_prototype_trimLeft = (_this: string) => {
|
5
4
|
return __String_prototype_trimStart(_this);
|
6
5
|
};
|
7
6
|
|
8
|
-
export const
|
9
|
-
return
|
7
|
+
export const __ByteString_prototype_trimLeft = (_this: string) => {
|
8
|
+
return __ByteString_prototype_trimStart(_this);
|
10
9
|
};
|
11
10
|
|
12
11
|
|
@@ -14,6 +13,6 @@ export const __String_prototype_trimRight = (_this: string) => {
|
|
14
13
|
return __String_prototype_trimEnd(_this);
|
15
14
|
};
|
16
15
|
|
17
|
-
export const
|
18
|
-
return
|
16
|
+
export const __ByteString_prototype_trimEnd = (_this: string) => {
|
17
|
+
return __ByteString_prototype_trimRight(_this);
|
19
18
|
};
|
@@ -1,10 +1,10 @@
|
|
1
|
-
// @porf
|
1
|
+
// @porf --funsafe-no-unlikely-proto-checks
|
2
2
|
|
3
3
|
export const __Array_isArray = (x: unknown): boolean =>
|
4
|
-
// Porffor.wasm`local.get ${x+1}` == Porffor.TYPES.
|
5
|
-
Porffor.rawType(x) == Porffor.TYPES.
|
4
|
+
// Porffor.wasm`local.get ${x+1}` == Porffor.TYPES.array;
|
5
|
+
Porffor.rawType(x) == Porffor.TYPES.array;
|
6
6
|
|
7
|
-
export const
|
7
|
+
export const __Array_prototype_slice = (_this: any[], start: number, end: number) => {
|
8
8
|
const len: i32 = _this.length;
|
9
9
|
if (Porffor.rawType(end) == Porffor.TYPES.undefined) end = len;
|
10
10
|
|
@@ -44,7 +44,7 @@ export const ___array_prototype_slice = (_this: any[], start: number, end: numbe
|
|
44
44
|
return out;
|
45
45
|
};
|
46
46
|
|
47
|
-
export const
|
47
|
+
export const __Array_prototype_indexOf = (_this: any[], searchElement: any, position: number) => {
|
48
48
|
const len: i32 = _this.length;
|
49
49
|
if (position > 0) {
|
50
50
|
if (position > len) position = len;
|
@@ -58,7 +58,7 @@ export const ___array_prototype_indexOf = (_this: any[], searchElement: any, pos
|
|
58
58
|
return -1;
|
59
59
|
};
|
60
60
|
|
61
|
-
export const
|
61
|
+
export const __Array_prototype_lastIndexOf = (_this: any[], searchElement: any, position: number) => {
|
62
62
|
const len: i32 = _this.length;
|
63
63
|
if (position > 0) {
|
64
64
|
if (position > len) position = len;
|
@@ -72,7 +72,7 @@ export const ___array_prototype_lastIndexOf = (_this: any[], searchElement: any,
|
|
72
72
|
return -1;
|
73
73
|
};
|
74
74
|
|
75
|
-
export const
|
75
|
+
export const __Array_prototype_includes = (_this: any[], searchElement: any, position: number) => {
|
76
76
|
const len: i32 = _this.length;
|
77
77
|
if (position > 0) {
|
78
78
|
if (position > len) position = len;
|
@@ -86,7 +86,7 @@ export const ___array_prototype_includes = (_this: any[], searchElement: any, po
|
|
86
86
|
return false;
|
87
87
|
};
|
88
88
|
|
89
|
-
export const
|
89
|
+
export const __Array_prototype_with = (_this: any[], index: number, value: any) => {
|
90
90
|
const len: i32 = _this.length;
|
91
91
|
if (index < 0) {
|
92
92
|
index = len + index;
|
@@ -111,7 +111,7 @@ export const ___array_prototype_with = (_this: any[], index: number, value: any)
|
|
111
111
|
return out;
|
112
112
|
};
|
113
113
|
|
114
|
-
export const
|
114
|
+
export const __Array_prototype_reverse = (_this: any[]) => {
|
115
115
|
const len: i32 = _this.length;
|
116
116
|
|
117
117
|
let start: i32 = 0;
|
@@ -127,7 +127,7 @@ export const ___array_prototype_reverse = (_this: any[]) => {
|
|
127
127
|
};
|
128
128
|
|
129
129
|
// todo: this has memory/allocation bugs so sometimes crashes :(
|
130
|
-
export const
|
130
|
+
export const __Array_prototype_toReversed = (_this: any[]) => {
|
131
131
|
const len: i32 = _this.length;
|
132
132
|
|
133
133
|
let start: i32 = 0;
|
@@ -1,82 +1,4 @@
|
|
1
|
-
// @porf
|
2
|
-
|
3
|
-
// while (len >= 8) {
|
4
|
-
// Porffor.wasm`
|
5
|
-
// local tmp i64
|
6
|
-
// local.get ${i}
|
7
|
-
// i64.load 0 4
|
8
|
-
// local.set tmp
|
9
|
-
|
10
|
-
// local k i64
|
11
|
-
// i64.const 0
|
12
|
-
// local.set k
|
13
|
-
|
14
|
-
// loop 64
|
15
|
-
// local.get ${j}
|
16
|
-
|
17
|
-
// local.get ${keyStrPtr}
|
18
|
-
|
19
|
-
// local.get tmp
|
20
|
-
|
21
|
-
// ;; k * 6
|
22
|
-
// i64.const 58
|
23
|
-
|
24
|
-
// local.get k
|
25
|
-
// i64.const 6
|
26
|
-
// i64.mul
|
27
|
-
|
28
|
-
// i64.sub
|
29
|
-
|
30
|
-
// ;; tmp >> (58 - (k * 6))
|
31
|
-
// i64.shr_u
|
32
|
-
|
33
|
-
// ;; (tmp >> (58 - (k * 6))) & 0x3f
|
34
|
-
// i64.const 63
|
35
|
-
// i64.and
|
36
|
-
|
37
|
-
// i32.wrap_i64
|
38
|
-
|
39
|
-
// ;; keyStrPtr + ...
|
40
|
-
// i32.add
|
41
|
-
|
42
|
-
// ;; load character from keyStr
|
43
|
-
// i32.load8_u 0 4
|
44
|
-
|
45
|
-
// ;; store in output at j
|
46
|
-
// i32.store8 0 4
|
47
|
-
|
48
|
-
// local.get ${j}
|
49
|
-
// i32.const 1
|
50
|
-
// i32.add
|
51
|
-
// local.set ${j}
|
52
|
-
|
53
|
-
// local.get k
|
54
|
-
// i64.const 1
|
55
|
-
// i64.add
|
56
|
-
// local.tee k
|
57
|
-
|
58
|
-
// i64.const 8
|
59
|
-
// i64.lt_s
|
60
|
-
// br_if 0
|
61
|
-
// end
|
62
|
-
|
63
|
-
// `;
|
64
|
-
|
65
|
-
// // len -= 6;
|
66
|
-
// i += 6;
|
67
|
-
// }
|
68
|
-
|
69
|
-
// // while (k < 8) {
|
70
|
-
// // Porffor.wasm.i32.store8(j++, Porffor.wasm.i32.load8_u(keyStrPtr + Porffor.wasm.i32.wrap_i64(Porffor.wasm.i64.and(
|
71
|
-
// // Porffor.wasm.i64.shr_u(tmp, Porffor.wasm.i64.extend_i32_u(58 - k * 6)),
|
72
|
-
// // Porffor.wasm.i64.const(0x3f)
|
73
|
-
// // )), 0, 4), 0, 4);
|
74
|
-
// // k += 1;
|
75
|
-
// // }
|
76
|
-
|
77
|
-
// i += 6;
|
78
|
-
// len -= 6;
|
79
|
-
// }
|
1
|
+
// @porf --funsafe-no-unlikely-proto-checks --valtype=i32
|
80
2
|
|
81
3
|
export const btoa = (input: bytestring): bytestring => {
|
82
4
|
const keyStr: bytestring = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';
|
@@ -89,6 +11,8 @@ export const btoa = (input: bytestring): bytestring => {
|
|
89
11
|
let i: i32 = Porffor.wasm`local.get ${input}`,
|
90
12
|
j: i32 = Porffor.wasm`local.get ${output}`;
|
91
13
|
|
14
|
+
// todo/perf: add some per 6 char variant using bitwise magic
|
15
|
+
|
92
16
|
const endPtr = i + len;
|
93
17
|
while (i < endPtr) {
|
94
18
|
const chr1: i32 = Porffor.wasm.i32.load8_u(i++, 0, 4);
|
@@ -116,6 +40,7 @@ export const btoa = (input: bytestring): bytestring => {
|
|
116
40
|
return output;
|
117
41
|
};
|
118
42
|
|
43
|
+
// todo: impl atob by converting below to "porf ts"
|
119
44
|
/* var atob = function (input) {
|
120
45
|
const keyStr = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=";
|
121
46
|
|