mirror of
https://github.com/roc-lang/roc.git
synced 2024-09-21 15:59:20 +03:00
65 lines
2.3 KiB
Markdown
65 lines
2.3 KiB
Markdown
# Web REPL
|
|
|
|
## Running locally
|
|
|
|
### 1. Run the build script
|
|
|
|
This builds the compiler as a `.wasm` file, and generates JS glue code.
|
|
It will `cargo install` the `wasm-pack` command line tool if you don't already have it.
|
|
You should run it from the project root directory.
|
|
|
|
```bash
|
|
./repl_www/build.sh
|
|
```
|
|
|
|
All the final assets for the web REPL will end up in `./repl_www/build/`
|
|
|
|
### 2. Run a local HTTP server
|
|
|
|
Browsers won't load .wasm files over the `file://` protocol, so you need to serve the files in `./repl_www/build/` from a local web server.
|
|
Any server will do, but this example should work on any system that has Python 3 installed:
|
|
|
|
```bash
|
|
cd repl_www/build
|
|
python3 -m http.server
|
|
```
|
|
|
|
### 3. Open your browser
|
|
You should be able to find the Roc REPL at http://127.0.0.1:8000/repl (or whatever port your web server mentioned when it started up.)
|
|
|
|
**Warning:** This is work in progress! Not all language features are implemented yet, error messages don't look nice yet, up/down arrows don't work for history, etc.
|
|
|
|
|
|
|
|
## How it works
|
|
|
|
- User types text into the HTML `<input />` tag
|
|
- JS detects the `onchange` event and passes the input text to the Roc compiler WebAssembly module
|
|
- Roc compiler WebAssembly module
|
|
- Parses the text (currently just a single line)
|
|
- Type checks
|
|
- Monomorphizes
|
|
- Generates WebAssembly using the development backend (not LLVM)
|
|
- Returns a slice of bytes to JavaScript
|
|
- JavaScript
|
|
- Takes the slice of bytes and creates a `WebAssembly.Instance`
|
|
- Runs the WebAssembly app
|
|
- Gets the memory address of the result and makes a copy of the app's entire memory buffer
|
|
- Passes the result address and the memory buffer to the compiler for analysis
|
|
- Roc compiler WebAssembly module
|
|
- Analyses the bytes of the result, based on the known return type from earlier
|
|
- Traverses the copied memory buffer to find any child values
|
|
- Produces a user-friendly String and passes it to JavaScript
|
|
- JavaScript
|
|
- Displays the input and output text on the web page
|
|
|
|
|
|
|
|
## Related crates
|
|
|
|
There are several directories/packages involved here:
|
|
|
|
- `repl_www`: The web page with its JavaScript and a build script
|
|
- `repl_wasm`: The Rust crate that becomes the "compiler" WebAssembly module
|
|
- `repl_eval`: REPL logic shared between `repl_cli` and `repl_wasm`
|