https://github.com/bytexenon/the-tiny-lua-compiler
⛄ Possibly the smallest Lua compiler ever
https://github.com/bytexenon/the-tiny-lua-compiler
compiler lexer lua lua-compiler lua-the-tiny-compiler lua-tiny-compiler luau tiny-compiler tokenizer
Last synced: 5 months ago
JSON representation
⛄ Possibly the smallest Lua compiler ever
- Host: GitHub
- URL: https://github.com/bytexenon/the-tiny-lua-compiler
- Owner: ByteXenon
- License: cc-by-4.0
- Created: 2024-05-21T22:37:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-22T09:07:42.000Z (over 1 year ago)
- Last Synced: 2024-05-23T02:36:27.731Z (over 1 year ago)
- Topics: compiler, lexer, lua, lua-compiler, lua-the-tiny-compiler, lua-tiny-compiler, luau, tiny-compiler, tokenizer
- Language: Lua
- Homepage:
- Size: 14.6 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**A minimal, educational Lua 5.1 compiler written in Lua**
_Inspired by [Jamie Kyle's The Super Tiny Compiler](https://github.com/jamiebuilds/the-super-tiny-compiler) written in JavaScript_
## Features
- **Educational**: Reading through the guided code will help you learn about how _most_ compilers work from end to end.
- [**Self-compiling**](): This compiler can compile itself!
- **Zero dependencies**: This compiler is written in pure Lua and has no dependencies.
- **Speed**: Even though speed is not the main priority, the compiler is still pretty fast compared to other Lua compilers written in Lua.
- **100% test coverage**: TLC has a test suite that covers 100% of the code. Want to see it in action? Run `sh tests/test.sh` in your terminal.
### [Want to jump into the code? Click here](https://github.com/bytexenon/The-Tiny-Lua-Compiler/blob/main/the-tiny-lua-compiler.lua)
---
### Why should I care?
That's fair, most people don't really have to think about compilers in their day
jobs. However, compilers are all around you, tons of the tools you use are based
on concepts borrowed from compilers.
### Why Lua?
Lua is a simple programming language that is easy to learn and use. It doesn't
have complex syntax or a lot of features, which makes it a great language to
make a compiler for.
### But compilers are scary!
Yes, they are. But that's our fault (the people who write compilers), we've
taken something that is reasonably straightforward and made it so scary that
most think of it as this totally unapproachable thing that only the nerdiest of
the nerds are able to understand.
### Example usage?
The compiler is written in a way that it can be used as a library.
Here is an example of how you can use it:
```lua
local tlc = require("the-tiny-lua-compiler")
local code = [[
for i = 1, 3 do
print("Hello from TLC! " .. i)
end
]]
-- Tokenize the code
local tokens = tlc.Tokenizer.new(code):tokenize()
-- Convert tokens into an Abstract Syntax Tree (AST)
local abstractSyntaxTree = tlc.Parser.new(tokens):parse()
-- Generate executable code
local prototype = tlc.CodeGenerator.new(abstractSyntaxTree):generate()
local bytecode = tlc.Compiler.new(prototype):compile()
-- Load and execute the compiled function.
-- Only works in Lua 5.1 (as it generates Lua 5.1 bytecode)
local compiledFunction = loadstring(bytecode)
compiledFunction()
```
### Okay so where do I begin?
Awesome! Head on over to the [the-tiny-lua-compiler.lua](https://github.com/bytexenon/The-Tiny-Lua-Compiler/blob/main/the-tiny-lua-compiler.lua) file.
### Tests
Run the test suite with:
```bash
sh tests/test.sh
```
### Support The Tiny Lua Compiler (TLC)
I don't take donations, but you can support TLC by starring the repository and sharing it with others.
If you find a bug or have a feature request, feel free to open an issue or submit a pull request.
---
[](http://creativecommons.org/licenses/by/4.0/)