Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/frederiktobner/cellox

Compiler for the cellox programming language
https://github.com/frederiktobner/cellox

bytecode compiler garbage-collector interpreter programming-language scripting-language virtual-machine

Last synced: about 1 month ago
JSON representation

Compiler for the cellox programming language

Host: GitHub
URL: https://github.com/frederiktobner/cellox
Owner: FrederikTobner
License: gpl-3.0
Created: 2022-06-12T09:47:07.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2024-12-08T23:52:50.000Z (about 2 months ago)
Last Synced: 2024-12-09T00:29:20.728Z (about 2 months ago)
Topics: bytecode, compiler, garbage-collector, interpreter, programming-language, scripting-language, virtual-machine
Language: C
Homepage: https://frederiktobner.github.io/Cellox/
Size: 2.5 MB
Stars: 7
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # Cellox

[![Build Interpreter](https://github.com/FrederikTobner/Cellox/actions/workflows/build_compiler.yml/badge.svg)](https://github.com/FrederikTobner/Cellox/actions/workflows/build_compiler.yml)

[![Build Tools](https://github.com/FrederikTobner/Cellox/actions/workflows/build_tools.yml/badge.svg)](https://github.com/FrederikTobner/Cellox/actions/workflows/build_tools.yml)

[![Test](https://github.com/FrederikTobner/Cellox/actions/workflows/tests.yml/badge.svg)](https://github.com/FrederikTobner/Cellox/actions/workflows/tests.yml)

[![Analyze](https://github.com/FrederikTobner/Cellox/actions/workflows/codeql.yml/badge.svg)](https://github.com/FrederikTobner/Cellox/actions/workflows/codeql.yml)

Compiler based on the book [Crafting interpreters](https://craftinginterpreters.com/contents.html) for the programming language cellox.

Cellox is a programming language based on [lox](https://craftinginterpreters.com/the-lox-language.html) from Robert Nystrom.

## Table of Contents

* [Overview](#overview)

* [Values](#values)

* [Control structures](#control-structures)

* [Operators](#operators)

* [Objects](#objects)

* [Functions](#functions)

* [Classes](#classes)

* [Strings](#strings)

* [Arrays](#arrays)

* [Slices](#slices)

* [IDE Integration](#ide-integration)

* [How it works](#how-it-works)

* [License](#license)

## Overview

Cellox is a dynamically typed, object oriented, high-level scripting language.

It is available under windows, linux and macOS but is currently in an experimental state. Some of the language features that are currently included (especially native functions), might change or not be included in the upcoming versions of the compiler.

## Values

In cellox [values](https://github.com/FrederikTobner/Cellox/wiki/Values) are grouped into four different types:

* booleans,

* numbers,

* undefiened (null)

* and [cellox objects](https://github.com/FrederikTobner/Cellox#objects) (e.g. a string or a class instance)

## Control structures

The language provides the following control structures:

* Conditional flow structures, with [if/else statements](https://github.com/FrederikTobner/Cellox/wiki/if-else-statements)

* Repetitive flow structures, with [for](https://github.com/FrederikTobner/Cellox/wiki/For) and [while](https://github.com/FrederikTobner/Cellox/wiki/While) loops

## Operators

Cellox features [assignment](https://github.com/FrederikTobner/Cellox/wiki/Operators#assignment-operators), [binary](https://github.com/FrederikTobner/Cellox/wiki/Operators#binary-operators), [logical](https://github.com/FrederikTobner/Cellox/wiki/Operators#logical-operators) and [unary](https://github.com/FrederikTobner/Cellox/wiki/Operators#unary-operators) operators.

## Objects

In Cellox everything besides the three base data types is considered to be a cellox [object](https://github.com/FrederikTobner/Cellox/wiki/Objects).

Even functions and classes are considered to be a cellox object.

This means that you can for example get the reference to a function and assign it to a variable.

## Functions

A [Function](https://github.com/FrederikTobner/Cellox/wiki/Functions) in Cellox is a group of statements, that together perform a task.

Some functions in Cellox also access the enclosing environment of the function to for example change the value stored in variable in the enclosing environment.

These functions are called closures and the values that are accessible for the functions are called upvalues.

Cellox also offers some [native functions](https://github.com/FrederikTobner/Cellox/wiki/Native-Functions) that are implemented in C.

## Classes

Cellox is a objectoriented language, that features inheritance and methods that are bound to a [class](https://github.com/FrederikTobner/Cellox/wiki/Classes) instance.

Classes can also extend the functionality of an already existing class by using inheritance.

## Strings

A [string](https://github.com/FrederikTobner/Cellox/wiki/Strings) in cellox is a special type of object.

Strings can contain escape sequences that will be resolved at compile time.

The characters that a string contains can be accessed by the index.

## Arrays

[Arrays](https://github.com/FrederikTobner/Cellox/wiki/Arrays) have a variable-size, meaning they can shrink and grow.

There is no tradional array, with a fixed capacity that is specified at allocation.

## Slices

A [slice](https://github.com/FrederikTobner/Cellox/wiki/Slices) is a subset of an already existing array or string.

Slices are created by using the range operator.

The values stored in slice can be altered without affecting the original array.

## IDE Integration

There are plugins for vscode, vim and neovim. Another alternative is to use my own text editor YATE that has built in language support.

[![Vim](https://github-readme-stats-beryl-phi.vercel.app/api/pin/?username=FrederikTobner&repo=cellox.vim&theme=dark)](https://github.com/FrederikTobner/cellox.vim)

[![VSCcode](https://github-readme-stats-beryl-phi.vercel.app/api/pin/?username=FrederikTobner&repo=vscode-cellox&theme=dark)](https://github.com/FrederikTobner/vscode-cellox)

[![YATE](https://github-readme-stats-beryl-phi.vercel.app/api/pin/?username=FrederikTobner&repo=YATE&theme=dark)](https://github.com/FrederikTobner/YATE)

## How it works

The language provides automatic memory management to the programmer using it's own [garbage collector](https://github.com/FrederikTobner/Cellox/wiki/Garbage-Collector), that uses the mark-and-sweep algorithm.

The variables defiened in a cellox program are stored in a hashtable. The variable name is used as the key for the value stored in the hashtable.

The program is converted into bytecode and executed by a stack based [virtual machine](https://github.com/FrederikTobner/Cellox/wiki/Virtual-Machine).

The bytecode can also be stored in a [seperate file](https://github.com/FrederikTobner/Cellox/wiki/Chunk-Files) in order to be executed at a later point in time.

More information about the compiler can be found at the [technical documentation](https://frederiktobner.github.io/Cellox/).

## License

This project is licensed under the [GNU General Public License](LICENSE)