Skip to content

Latest commit

 

History

History
170 lines (127 loc) · 3.63 KB

DOCUMENTATION.md

File metadata and controls

170 lines (127 loc) · 3.63 KB

Gola Language Interpreter Documentation

Gola is a lightweight and fun programming language inspired by simplicity and Bengali expressions. This documentation provides an overview of its syntax, usage, and functionality.

Features

  • Lightweight and interactive interpreter.
  • Uses Bengali-inspired keywords and syntax.
  • Supports basic arithmetic, variable assignment, and conditional execution.
  • Includes interactive and file-based execution modes.

Installation

Prerequisites

  • Go programming language installed.

Build

Run the following commands to build the interpreter for your platform:

# Build for Linux
GOOS=linux GOARCH=amd64 go build -o gola-linux-x86_64

# Build for macOS
GOOS=darwin GOARCH=amd64 go build -o gola-darwin-x86_64

Usage

Command-line Options

  • -v or --version: Display the version of the interpreter.
  • -h or --help: Display help information.

Example:

gola -v

Running Gola Code

You can execute .gola files or use the interactive mode.

File-based Execution

gola <file_name>.gola

Ensure the file has a .gola extension. For example:

gola sample.gola

Interactive Mode

Run the interpreter without arguments:

gola

Type commands interactively and press Enter to execute.

Syntax

Print Statements

  • Command: kemon achis "<message>"
  • Description: Prints the specified message to the console.

Example:

kemon achis "Hello, world!"

Variable Input

  • Command: bol bhai <variable>
  • Description: Prompts the user to input a value for the specified variable.

Example:

bol bhai x

Variable Assignment

  • Command: <variable> = <expression>
  • Description: Assigns the result of an expression to a variable.

Example:

x = 10 + 5

Conditional Execution

  • Command: dyakh jodi <condition>: <command> ar nahole: <command>
  • Description: Executes the first command if the condition is true; otherwise, executes the second command.

Example:

dyakh jodi x > 5: kemon achis "Greater" ar nahole: kemon achis "Smaller or Equal"

Error Handling

  • Error Messages: The interpreter provides Bengali-inspired error messages for invalid commands or conditions, such as:
    • bhul hoye gelo vai check kor ekbar (Check your syntax.)

Implementation Overview

Key Components

Interpreter

The core interpreter structure contains:

  • variables: A map to store variable values.

Methods

  • NewInterpreter(): Initializes the interpreter.
  • Execute(line string): Parses and executes a single line of code.
  • evaluateExpression(tokens []string): Evaluates arithmetic expressions.
  • getValue(token string): Retrieves a variable's value or parses integers.

Commands

Commands are executed based on the first token in a line:

  1. kemon achis: Print messages or variables.
  2. bol bhai: Accept user input for a variable.
  3. dyakh jodi: Execute conditional logic.
  4. Assignment (=): Assigns values to variables.

Sample Code

bol bhai x
y = x + 5
dyakh jodi y > 10: kemon achis "Value is greater" ar nahole: kemon achis "Value is smaller"

Expected Output:

Enter value for x: 6
Value is greater

Interactive Mode Example

Welcome to Gola - Bengali Edition!
Type 'exit' to quit.
>> bol bhai x
Enter value for x: 10
>> kemon achis "x is "
>> kemon achis x
10
>> exit
Jay Shree Ram Bhai!

Contributing

Feel free to contribute to this project by submitting issues or pull requests to the GitHub repository.

License

This project is licensed under the MIT License.