mcsh / rumi

The rumi compiler

Rumi

This project is no longer maintained.

I find it difficult to allocate time to it, but it has already served its purpose as a proof of concept: the program can change a static compiler's behavior as it compiles it, using the same syntax.

Everything you possess of skill, and wealth, and handicraft, wasn't it first merely a thought and a quest? - Rumi

Rumi is a low level compiler with functional properties that can be linked with c, doesn't make local functions a nightmare and has a powerful compile time language that is the same as runtime. The ultimate goal of rumi is to make programming joyful.

The current version is written in C++, however the previous versions were written in rumi and C++ respectively. We use LLVM to compile.

Language documentation could be find here.

rumi's Issues

Importing needs more details in README and a suggestion about import syntax

Issue
You talked about importing in README and in examples "you could instead import the test_import file" but there are no examples of importing anything, I searched project files and found it the syntax is like:

import somefile

and somefile should be in your project dir or in RUMI_PATH dir. Plus, there is no info about where you can import and what happens when you import, Is it like copy and paste the code where you imported it? and you can import code in the middle of the code or at the end? or it should always be first in your file? Does it require once? or if I import something twice, it brings it twice? etc.

Suggestion:
Also, import syntax is not consistent with language syntax I think, It does not require ; at the end of it, and does not have <> " or any similar thing we use in other projects, I think it would be nice to have at least a semi-colon required at the end of the import statement to be consistent.
(I know for example C style includes are not semi-colon required too, but they are in a specific shape or "somefile" that make me think about them as special statements, but here my feeling is import is a statement [Maybe because I'm coming from a JS/TS/Java background])

vim syntax definition

I have made a simple vim plugin for syntax definitions and highlighting at https://github.com/ShahinSorkh/rumi-vim

May you wish to link to it somewhere

syntax bikeshedding

Currently functions are defined like this:

stPrinter := (m: MyStruct) -> void
...

and structures like this:

MyStruct : struct 
...

This is not the easiest style for reading. The important information (this is function, this is structure) is not the very first thing one sees, it only appears only after potentially long name.

It would be IMO slightly more readable when the type of the definition comes first:

fn stPrinter(m: MyStruct) -> void
...

struct MyStruct 
...

It would also reduce a little bit visual noise made by !@#$%^&*())__+| characters.

This also applies to declaration of stack variables and structure members.

compiler breaks when commenting ouside of functions

Following code does not compile:

import test_import

main := () -> int{
    printf("Hello world!");
    return 0;
}

// vim: foldmethod=marker foldmarker={,}

The problem is the comment on the last line. When omitted, it compiles and runs.