https://github.com/willothy/letter

Letter is a compiler project built in TypeScript using LLVM node bindings.
https://github.com/willothy/letter

compiler llvm llvm-javascript parser programming-language typescript

Last synced: 4 months ago
JSON representation

Letter is a compiler project built in TypeScript using LLVM node bindings.

• Host: GitHub
• URL: https://github.com/willothy/letter
• Owner: willothy
• Created: 2022-04-01T19:55:19.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-09-01T18:36:55.000Z (over 2 years ago)
• Last Synced: 2024-10-04T13:10:06.384Z (4 months ago)
• Topics: compiler, llvm, llvm-javascript, parser, programming-language, typescript
• Language: TypeScript
• Homepage:
• Size: 12.6 MB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Letter

[![CodeQL](https://github.com/willothy/Letter/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/willothy/Letter/actions/workflows/codeql-analysis.yml)

[![DeepSource](https://deepsource.io/gh/willothy/Letter.svg/?label=active+issues&show_trend=true&token=s7FPYpp55Oo71OQtpE1BL1Hm)](https://deepsource.io/gh/willothy/Letter/?ref=repository-badge)

[![DeepSource](https://deepsource.io/gh/willothy/Letter.svg/?label=resolved+issues&show_trend=true&token=s7FPYpp55Oo71OQtpE1BL1Hm)](https://deepsource.io/gh/willothy/Letter/?ref=repository-badge)

Letter is a compiler project built in TypeScript using the [llvm-bindings](https://github.com/ApsarasX/llvm-bindings) module. The parser is based off of lectures by [Dmitry Soshnikov](https://github.com/DmitrySoshnikov/). Letter compiles to LLVM IR, which can then be compiled with Clang.

Letter is functional-only at the moment, though the parser supports objects and I plan on implementing them.

Since Letter compiles using LLVM, it is compatible with C and C++. This hasn't been tested much, but there's an example of a Letter function being called from a C program in the `/example/c-link/` folder.

Letter requires an installation of LLVM 13. The [llvm-bindings](https://github.com/ApsarasX/llvm-bindings) readme has good installation instructions.

Features that are working now: 

- Main function as entry point

- Preprocessor (import, define)

- Math operations

- Extern functions

- Function definitions

    - Void type

    - Overloading

- If statements

- Implicit typecasting of numbers

- Printing values using print.lt (printf wrapper)

- Strings, Floats, Doubles, Booleans, Integers 




Use:


The released version is outdated: I'll update this when there's a release with LLVM working fully. For now, it must be run from node.

Run the compiler using `npm run compile `. This will run letter and clang, prividing an executable.


To build an object file, run `npm run object `.

The below flags don't work with this command - only with `npx ts-node ./letter.ts -f  ` which will generate llvm IR.

You then need to compile this IR using clang.




Current flags available:

Tested:

- `-s, --stack`: Prints the full JS stack on error. Normally, errors just print the message without stack trace when no debug flags are set.

- `-t, --tokens`: Prints a list of all tokens in the program, including from imported files.

- `-a, --ast`: Prints the full program's AST representation in JSON.

- `-i, --emit-ir`: Emits LLVM IR for compilation.

Untested with new versions:

- `-m, --minify`: Combines all code into one file, and turns it into one line.

    - Recommended use: `./bin/letter.rdp -f filename --minify > file.min.lt`

Sample programs and are included in the `/example/` folder.