Awesome

📑 Documentation | 💾 Installation | 🤝 Contributing | 📜 License | 🔄 State

CSpydr is a low-level, static typed, free and open-source, compiled programming language inspired by Rust and C. This repository contains cspc (the CSpydr Programming Language Compiler), as well as CSpydr's Standard Library, a code-linting utility, some code examples and unit tests.

Code Examples

helloworld.csp

fibonacci.csp

lambda.csp

read_file.csp

random.csp

time.csp

More examples can be found in the examples directory

Current State

A list of all the features, that are already implemented or planned.

cspc Compiler features:

• Assembly code generator for x86_64 linux
• LLVM codegen target (maybe even WASM?)
• move to an intermediate bytecode compiler
• AST to JSON converter (in progress)
• C transpiler
• lexing tokens
• macro and import preprocessor
• parsing an AST, validation of syntax and semantics
• type evaluator & checking
• implicit type casts
• "projects" - prebuild libraries such as the stdlib
• CLI and error handling
• memory management

CSpydr Language features:

• primitive data types i8 i16 i32 i64 u8 u16 u32 u64 f32 f64 f80 bool char void
• pointers, arrays and c-like arrays & [] 'c[]
• custom data types struct union enum {} (tuples)
• control statements if match for while loop ret break continue noop with do-while do-unless defer
• different loop types: for, while, do-while and loop
• expressions
• extern functions and globals
• type-related keywords sizeof typeof alignof len
• file imports
• macros and macro-overloading
• default macros __version__ __system__ __architecture__ __time__ __compile_type__ __main_file__ __file__ __line__ __func__
• namespaces, functions, globals, typedefs
• inline asm code blocks
• lambda expressions
• templates in fuctions and structs
• va lists
• interfaces, vtables and dynamic-dispatch for functions
• dynamic-dispatch for constants
• functions as struct members

CSpydr Standard library features

• basic c17 libc-header implementation
• glfw and OpenGL/GLU header files
• cURL header implementation
• from-the-ground custom written stdlib based on linux syscalls (in progress)

Installation

Please refer to INSTALL.md for installation instructions and information about compatability

Hello, World!

A simple hello-world program:

import "io.csp";

fn main(): i32
{
    std::io::puts("Hello, World!");
    <- 0;
}

Running this program is as easy as entering the following command:

$ cspc run hello-world.csp

Examples

For more examples, please refer to the examples/ directory in this repository.

Usage

To compile a CSpydr program use the following command:

$ cspc build <your file>

To directly run a program use this command:

$ cspc run <your file>

To launch a special debug shell, start your program using the debug action: <br/> (not finished yet!)

$ cspc debug <your file>

Get help using this command:

$ cspc --help

(I will write a proper documentation in the future!)

Editor support

Editor support is found in the editors/ subdirectory.

Supported editors include:

• NeoVim/Vim
• VSCode

Note For quick installation, use the install.sh script in the respective subdirectory.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update the unit tests as appropriate.

View CONTRIBUTING.md for more information

License

CSpydr is licensed under the MIT License.

Resources | Reference | Inspiration

• chibicc C compiler: https://github.com/rui314/chibicc.git
• vcc: https://github.com/lemoncmd/vcc.git
• tac programming language: https://github.com/sebbekarlsson/tac.git
• summus programming language: https://github.com/igor84/summus.git
• porth programming language: https://gitlab.com/tsoding/porth.git
• cURL C library for transferring data: https://github.com/curl/curl
• tiny-regex-c as the main inspiration behind regex.csp: https://github.com/kokke/tiny-regex-c.git
• logo inspiration: IntelliJ IDEs (https://www.jetbrains.com/), Haskell-Intellij Plugin (https://plugins.jetbrains.com/plugin/8258-intellij-haskell)