C3 Language

C3 is a C-like language striving to be an evolution of C, rather than a completely new language. As an alternative in the C/C++ niche it aims to be fast and close to the metal.

The manual for C3 can be found at www.c3-lang.org.

Thanks to full ABI compatibility with C, it's possible to mix C and C3 in the same project with no effort. As a demonstration, vkQuake was compiled with a small portion of the code converted to C3 and compiled with the c3c compiler. (The fork can be found at https://github.com/c3lang/vkQuake)

Design Principles

Procedural "get things done"-type of language.
Try to stay close to C - only change what's really necessary.
C ABI compatibility and excellent C integration.
Learning C3 should be easy for a C programmer.
Data is inert.
Avoid "big ideas" & the "more is better" fallacy.
Introduce some higher level conveniences where the value is great.

C3 owes its inspiration to the C2 language: to iterate on top of C without trying to be a whole new language.

Example code

The following code shows generic modules (more examples can be found at http://www.c3-lang.org/examples/).

module stack <Type>;
// Above: the parameterized type is applied to the entire module.

struct Stack
{
    usize capacity;
    usize size;
    Type* elems;
}

// The type methods offers dot syntax calls,
// so this function can either be called 
// Stack.push(&my_stack, ...) or
// my_stack.push(...)
fn void Stack.push(Stack* this, Type element)
{
    if (this.capacity == this.size)
    {
        this.capacity *= 2;
        this.elems = mem::realloc(this.elems, Type.sizeof * this.capacity);
    }
    this.elems[this.size++] = element;
}

fn Type Stack.pop(Stack* this)
{
    assert(this.size > 0);
    return this.elems[--this.size];
}

fn bool Stack.empty(Stack* this)
{
    return !this.size;
}

Testing it out:

import stack;

// Define our new types, the first will implicitly create 
// a complete copy of the entire Stack module with "Type" set to "int"
define IntStack = Stack<int>;
// The second creates another copy with "Type" set to "double"
define DoubleStack = Stack<double>;

// If we had added "define IntStack2 = Stack<int>"
// no additional copy would have been made (since we already
// have an parameterization of Stack<int>) so it would
// be same as declaring IntStack2 an alias of IntStack

// Importing an external C function is straightforward
// here is an example of importing libc's printf:
extern fn int printf(char* format, ...);

fn void test()
{
    IntStack stack;
    // Note that C3 uses zero initialization by default
    // so the above is equivalent to IntStack stack = {};
    
    stack.push(1);
    // The above can also be written IntStack.push(&stack, 1); 
    
    stack.push(2);
    
    // Prints pop: 2
    printf("pop: %d\n", stack.pop());
    // Prints pop: 1
    printf("pop: %d\n", stack.pop());
    
    DoubleStack dstack;
    dstack.push(2.3);
    dstack.push(3.141);
    dstack.push(1.1235);
    // Prints pop: 1.1235
    printf("pop: %f\n", dstack.pop());
}

In what ways do C3 differ from C?

No mandatory header files
New semantic macro system
Module based name spacing
Subarrays (slices)
Compile time reflection
Enhanced compile time execution
Generics based on generic modules
"Result"-based zero overhead error handling
Defer
Value methods
Associated enum data
No preprocessor
Less undefined behaviour and runtime checks in "safe" mode
Limited operator overloading to enable userland dynamic arrays
Optional pre and post conditions

Current status

The current version of the compiler is alpha release 0.2.

It's possible to try out the current C3 compiler in the browser: https://ide.judge0.com/ – this is courtesy of the developer of Judge0.

Design work on C3 complete aside from fleshing out details, such as inline asm. As the standard library work progresses, changes and improvements to the language will happen continuously. Follow the issues here.

If you have suggestions on how to improve the language, either file an issue or discuss C3 on its dedicated Discord: https://discord.gg/qN76R87.

The compiler is currently verified to compile on Linux, Windows and MacOS.

What can you help with?

If you wish to contribute with ideas, please file issues or discuss on Discord.
Interested in contributing to the stdlib? Please get in touch on Discord.
Install instructions for other Linux and Unix variants are appreciated.
Would you like to contribute bindings to some library? It would be nice to have support for SDL, Raylib and more.
Build something with C3 and show it off and give feedback. The language is still open for significant tweaks.
Start work on the C -> C3 converter which takes C code and does a "best effort" to translate it to C3. The first version only needs to work on C headers.
Do you have some specific area you have deep knowledge of and could help make C3 even better at doing? File or comment on issues.

Installing

Installing on Windows

Make sure you have Visual Studio 17 2022 installed.
Install CMake
Clone the C3C github repository: git clone https://github.com/c3lang/c3c.git
Enter the C3C directory cd c3c.
Set up the CMake build cmake -B build -G "Visual Studio 17 2022" -A x64 -DCMAKE_BUILD_TYPE=Release
Build: cmake --build build --config Release
You should now have the c3c.exe

You should now have a c3c executable.

You can try it out by running some sample code: c3c.exe compile ../resources/examples/hash.c3

Installing on Ubuntu 20.10

Make sure you have a C compiler that handles C11 and a C++ compiler, such as GCC or Clang. Git also needs to be installed.
Install CMake: sudo apt install cmake
Install LLVM 12 (or greater: C3C supports LLVM 12-15): sudo apt-get install clang-12 zlib1g zlib1g-dev libllvm12 llvm-12 llvm-12-dev llvm-12-runtime liblld-12-dev liblld-12
Clone the C3C github repository: git clone https://github.com/c3lang/c3c.git
Enter the C3C directory cd c3c.
Create a build directory mkdir build
Change directory to the build directory cd build
Set up CMake build: cmake ..
Build: cmake --build .

You should now have a c3c executable.

You can try it out by running some sample code: ./c3c compile ../resources/examples/hash.c3

Building via Docker

You can build c3c using either an Ubuntu 18.04 or 20.04 container:

./build-with-docker.sh 18

Replace 18 with 20 to build through Ubuntu 20.04.

For a release build specify:

./build-with-docker.sh 20 Release

A c3c executable will be found under bin/.

Installing on OS X using Homebrew

Install CMake: brew install cmake
Install LLVM 13: brew install llvm
Clone the C3C github repository: git clone https://github.com/c3lang/c3c.git
Enter the C3C directory cd c3c.
Create a build directory mkdir build
Change directory to the build directory cd build
Set up CMake build for debug: cmake ..
Build: cmake --build .

Installing on other Linux / Unix variants

Install CMake.
Install or compile LLVM and LLD libraries (version 12+ or higher)
Clone the C3C github repository: git clone https://github.com/c3lang/c3c.git
Enter the C3C directory cd c3c.
Create a build directory mkdir build
Change directory to the build directory cd build
Set up CMake build for debug: cmake ... At this point you may need to manually provide the link path to the LLVM CMake directories, e.g. cmake -DLLVM_DIR=/usr/local/opt/llvm/lib/cmake/llvm/ ..
Build: cmake --build .

Getting started with a "hello world"

Create a main.c3 file with:

module hello_world;
import std::io;

fn void main()
{
   io::println("Hello, world!");
}

Make sure you have the standard libraries at either ../lib/std/ or /lib/std/.

Then run

c3c compile main.c3

The generated binary will be called a.out.

Licensing

The C3 compiler is licensed under LGPL 3.0, the standard library itself is MIT licensed.

Editor plugins

Editor plugins can be found at https://github.com/c3lang/editor-plugins.

PixelRifts/c3c