# colgm

**Repository Path**: valkmjolnir/colgm

## Basic Information

- **Project Name**: colgm
- **Description**: :sparkles: Experimental compiler project just for fun
- **Primary Language**: C++
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-03-27
- **Last Updated**: 2026-02-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# <img src="doc/logo/colgm.svg" height="45px"/> Colgm Compiler Project

[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/colgm/colgm)
[![bootstrap](https://github.com/colgm/colgm/actions/workflows/ci.yml/badge.svg)](https://github.com/colgm/colgm/actions/workflows/ci.yml)
[![nightly-build](https://github.com/colgm/colgm/actions/workflows/release.yml/badge.svg)](https://github.com/colgm/colgm/actions/workflows/release.yml)
[![discord](https://img.shields.io/discord/1369992600853020693?logo=discord&label=Colgm)](https://discord.gg/9D6yXNEQSf)

Colgm aims to be a simple, easy-to-use and easy-to-maintain programming language.
It will let you write relatively safe code without too much cognitive load.
Targets supported now are [__LLVM IR__](https://llvm.org/) and [__nasal-lang__ [WIP]](https://github.com/ValKmjolnir/Nasal-Interpreter).

Now nightly-builds are available:

- [__macos-aarch64-nightly-build__](https://github.com/colgm/colgm/releases/tag/macOS_nightly)
- [__linux-x86_64-nightly-build__](https://github.com/colgm/colgm/releases/tag/linux_nightly)
- [__windows-x86_64-nightly-build__](https://github.com/colgm/colgm/releases/tag/windows_nightly)

```rust
use std::io::{ io };

pub func main() -> i32 {
    io::stdout().out("hello world!").endln();
    return 0;
}
```

## Repo Content

- [bootstrap](./bootstrap/main.cpp) : bootstrap compiler.
- [doc](./doc) : documentation.
- [example](./example) : example programs.
- [misc](./misc/) : build and test scripts.
- [src](./src/main.colgm) : self-host compiler.
- [std](./std) : standard library.
- [test](./test): test cases.

## Language Guide

See simple language guide in:

- [language guide (English)](./doc/guide/tutorial.md)
- [语言指南（中文版）](./doc/guide/tutorial_zh.md)

See library reference in:

- [standard library reference](./doc/guide/std_library_reference.md)
- [compiler library reference](./doc/guide/compiler_library_reference.md)

### Usage

Use this command to show help:

```sh
<colgm compiler path> -h
```

#### Example

If you want to compile `test.colgm` with debug mode,
and output the executable file to `test.out`,
use this command:

```sh
<colgm compiler path> test.colgm -g -o test.out
```

#### Optimization

Colgm accepts `-O` option to enable optimization.

- `-O0`: disable optimization
- `-O1`: enable basic optimization
- `-O2`: enable advanced optimization
- `-O3`: enable maximum optimization
- `-Oz`: enable speed optimization
- `-Os`: enable size optimization

Also you could use `-O[x] -g` for release with debug info.

## Build and Development

### Requirements

Before building the project, here's the requirements:

- python >= 3.8
- llvm >= 16.0
- cmake >= 3.21
- valgrind (for memory leakage check)

### Build

We suggest you to just follow the build script at [misc/build.py](./misc/build.py).

Use this command in top level directory:

```sh
python3 misc/build.py
```

The build script will generate 3 executables in the `build`
directory:

1. `build/colgm`: bootstrap compiler (compiled by gcc/clang, should support at least c++17)
2. `build/colgm_lifted`: lifted compiler (compiled by `build/colgm`)
3. `build/colgm_selfhost`: self-host compiler (compiled by `build/colgm_lifted`)

If only want to build the bootstrap compiler, you can use this:

```sh
python3 misc/build.py -boot
```

If only want to build the self-host compiler __after running the build script once__, you can use this to just build the self-host compiler:

```sh
python3 misc/build.py -self
```

### Test

And use another script to test:

```sh
python3 misc/test.py
```

Use this script to test tcp/udp utils:

```sh
python3 misc/test_tcp_udp.py
```

To check if any memory leakage, use this script:

```sh
python3 misc/memleak_check.py
```

### Code Style

And for development, you should follow the [code style](./doc/spec/code_style.md).

## Features and Roadmap

1. feature: fuzzy match when variable is not found
2. feature: new target: [nasal](https://github.com/ValKmjolnir/Nasal-Interpreter)
3. feature: to_string method for struct/enum/tagged union
4. feature: smart pointer
5. feature: std
    - [x] Filesystem API (read, write, join, exists, etc)
    - [x] Datetime utils
    - [ ] String and Unicode Helpers
    - [x] Math Utils
    - [ ] map, filter, reduce, sort, reverse, etc
    - [x] JSON
    - [ ] TOML, YAML and other formats parsing
    - [x] networking (socket, TCP/UDP Server and Client)
    - [ ] HTTP Utilities
    - [x] OS Utils (exec, env, args, etc)
    - [ ] Deprecation Marker
    - [ ] Regex
    - [ ] Package manager
    - [ ] Docs generator
6. DCE opt
7. CSE opt
8. ref type implicit copy(include assignment/definition/struct init) detection