MathLang Compiler

MathLang is a programming language designed for mathematical expressions and computations. This repository contains the source code for the MathLang compiler, which translates MathLang code into bytecode for execution on a virtual machine.

This project is still a work in progress. If you are interested in contributing or collaborating, please feel free to reach out or submit a pull request.

Current features

1. Bytecode Compiler: MathLang features a bytecode compiler that translates MathLang code into bytecode for execution on a virtual machine.

2. Virtual Machine: The bytecode generated by the compiler is executed on the MathLang Virtual Machine (MLVM), providing a runtime environment for MathLang programs.

3. Arithmetic Expressions: MathLang supports the basic arithmetic operations, including addition, subtraction, multiplication, division, and exponentiation.

4. Comments: MathLang supports single-line comments only for now.

   Syntax:

    // single-line comment
   

5. Supported Literals: MathLang currently only supports the following literals:

   • Integer Literals: Whole numbers without decimal points
   • Real Literals: Numbers with decimal points

6. Built-in Operators: The language comes with built-in operators for arithmetic operations:

   • Addition: + (binary and unary),
   • Subtraction: - (binary and unary),
   • Multiplication: * (binary),
   • Division: / (binary),
   • Exponentiation: ^ (binary),
   • Print: print (unary)

   and more. These operators can be overloaded or extended (a planned features).

7. Variable Declaration: MathLang allows you to declare variables using the let keyword followed by the variable type and identifier. Optionally, you can initialize the variable with an expression using the := operator.

   Syntax:

    let <type> <identifier>;
   

   or,

    let <type> <identifier> := <expression>;
   

8. Variable Assignment: MathLang allows you to assign values to variables using the = operator.

   Syntax:

    <identifier> = <expression>;
   

9. const Keyword: MathLang allows you to declare constants using the const keyword followed by the constant type and identifier. Optionally, you can initialize the constant with an expression using the := operator. It can also be used with function parameters to indicate that the parameter is a constant.

   Syntax:

    let const <type> <identifier>;
   

   or,

    let const <type> <identifier> := <expression>;
   

   Note: Constants cannot be reassigned. The compiler will throw an error if you try to reassign a constant.

10. Functions: MathLang allows you to define functions using the define keyword followed by the function name, parameter list, and return type. Optionally, you can specify the return type using the -> operator (the type will be none if not specified).

    Syntax:

    define <name> (<param-list>) [-> <return-type>] {...}
    

    You can use the return keyword to return from a non-returning function. As for returning functions, you can use the :-> operator to return a value from the function.

    Syntax:

    return;
    

    or,

    :-> <return-value>;
    

    Note: Default parameters are not supported yet. This feature is planned for future versions of MathLang.

11. Function Calls: MathLang allows you to call functions using the function name and followed by a parameter list encapsulated in parentheses.

    Syntax:

    <name>(<param-list>);
    

12. Function Overloading: MathLang allows you to overload functions with the same name but different parameter lists. The compiler will select the appropriate function based on the number and types of the arguments passed to the function.

Future Features

REPL

A Read-Eval-Print Loop (REPL) is in development. It will provide an interactive environment for users to experiment with MathLang code, execute expressions, and receive immediate feedback.

More literal types

Future versions of MathLang will introduce more literal types, expanding the language's support for various data types.

• Strings
• Boolean

Conditional Statements

Conditional statements, such as If and Else, will be introduced to enable branching based on logical conditions.

Syntax:

If [<condition1>] {...}
Else If [<condition2>] {...}
...
Else {...}

Classes and MathObjs

Classes and MathObjs is a planned feature in MathLang that will introduce object-oriented programming capabilities to the language. With this feature, users will be able to define classes, create objects, and perform operations on those objects using methods and properties. This will enable users to organize their code into reusable and modular components, enhancing code readability and maintainability.

User-Defined Operators

MathLang will also allow users to define their own operators, that are at most four characters long, with custom behavior. This feature will provide flexibility and extensibility to the language, allowing developers to create domain-specific operators or redefine existing operators.

Symbolic Expressions

Symbolic Expressions is an upcoming feature in MathLang that allows users to manipulate mathematical expressions symbolically, rather than numerically. With this feature, users will be able to work with variables, constants, and mathematical operations to create and manipulate complex mathematical expressions.

How to Contribute

1. Fork the Repository: Fork the MathLang repository to your GitHub account. This will create a copy of the project under your account.

2. Clone your Fork: Clone the forked repository to your local machine using the following command:

    git clone https://github.com/PhoenXHO/MathLang.git
   

3. Create a Branch: Create a new branch for your changes. Use a descriptive name for your branch to indicate the purpose of your contribution:

    git checkout -b feature/<new-feature>
   

4. Commit Changes: Commit your changes with a clear and concise commit message:

    git commit -m "add new feature" -s
   

The -s flag adds a "Signed-off-by" line to the commit, indicating that you agree to the Developer Certificate of Origin (DCO).

5. Push Changes: Push your changes to your forked repository on GitHub:

    git push origin feature/new-feature
   

6. Submit a Pull Request (PR): Open a pull request on the MathLang repository. Provide a detailed description of your changes and explain the purpose of the pull request.

Make sure to follow the existing code style and formatting conventions used in the project. Consistent code style makes it easier for collaborators to understand and maintain the codebase.

Collaborators

MathLang Compiler is an open-source project, and collaboration is encouraged. If you are interested in becoming a collaborator, please reach out to @PhoenXHO via GitHub or email. Collaborators have direct write access to the repository and play a vital role in shaping the future of MathLang.