-
Notifications
You must be signed in to change notification settings - Fork 226
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
64 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,53 +1,56 @@ | ||
# Kaleidoscope | ||
|
||
This example shows how one can implement the [Kaleidoscope programming language](https://llvm.org/docs/tutorial/index.html) using Inkwell. | ||
It implements every feature up to the [7th chapter](https://llvm.org/docs/tutorial/LangImpl07.html). | ||
|
||
The [usage](../../README.md#usage) part doesn't fit the example as it shares the same `Cargo.toml` file with the whole project. | ||
|
||
To run the example, the LLVM version is required: | ||
```sh | ||
cargo run --example kaleidoscope --features llvm$(llvm-config --version | sed 's/\./-/;s/\.[0-9]*//') | ||
``` | ||
|
||
When running this command, a prompt will be displayed; for example: | ||
|
||
``` | ||
?> 1 + 1 | ||
=> 2 | ||
?> var a = 5, b = 10 in a * b | ||
=> 50 | ||
?> def fib(n) if n < 2 then n else fib(n - 1) + fib(n - 2) | ||
?> fib(40) | ||
=> 102334155 | ||
?> | ||
``` | ||
|
||
Additional arguments can be passed to the produced executable: | ||
- `--dc`: **D**isplay **C**ompiler output | ||
- `--dp`: **D**isplay **P**arser output | ||
- `--dl`: **D**isplay **L**exer output | ||
|
||
For example, running with all three switches may lead to the following output: | ||
``` | ||
?> 1 + 2 * 2 | ||
-> Attempting to parse lexed input: | ||
[Number(1), Op('+'), Number(2), Op('*'), Number(2)] | ||
-> Expression parsed: | ||
Binary { op: '+', left: Number(1), right: Binary { op: '*', left: Number(2), right: Number(2) } } | ||
-> Expression compiled to IR: | ||
define double @anonymous() { | ||
entry: | ||
ret double 5.000000e+00 | ||
} | ||
=> 5 | ||
``` | ||
|
||
Finally, the prompt can be exited by entering "exit" or "quit". | ||
# Kaleidoscope | ||
|
||
This example shows how one can implement the [Kaleidoscope programming language](https://llvm.org/docs/tutorial/index.html) using Inkwell. | ||
It implements every feature up to the [7th chapter](https://llvm.org/docs/tutorial/MyFirstLanguageFrontend/LangImpl07.html). | ||
|
||
The [usage](../../README.md#usage) part doesn't fit the example as it shares the same `Cargo.toml` file with the whole project. | ||
|
||
To run the example, the LLVM version is required: | ||
|
||
```sh | ||
cargo run --example kaleidoscope --features llvm$(llvm-config --version | sed 's/\./-/;s/\.[0-9]*//') | ||
``` | ||
|
||
When running this command, a prompt will be displayed; for example: | ||
|
||
``` | ||
?> 1 + 1 | ||
=> 2 | ||
?> var a = 5, b = 10 in a * b | ||
=> 50 | ||
?> def fib(n) if n < 2 then n else fib(n - 1) + fib(n - 2) | ||
?> fib(40) | ||
=> 102334155 | ||
?> | ||
``` | ||
|
||
Additional arguments can be passed to the produced executable: | ||
|
||
- `--dc`: **D**isplay **C**ompiler output | ||
- `--dp`: **D**isplay **P**arser output | ||
- `--dl`: **D**isplay **L**exer output | ||
|
||
For example, running with all three switches may lead to the following output: | ||
|
||
``` | ||
?> 1 + 2 * 2 | ||
-> Attempting to parse lexed input: | ||
[Number(1), Op('+'), Number(2), Op('*'), Number(2)] | ||
-> Expression parsed: | ||
Binary { op: '+', left: Number(1), right: Binary { op: '*', left: Number(2), right: Number(2) } } | ||
-> Expression compiled to IR: | ||
define double @anonymous() { | ||
entry: | ||
ret double 5.000000e+00 | ||
} | ||
=> 5 | ||
``` | ||
|
||
Finally, the prompt can be exited by entering "exit" or "quit". |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters