Environment Class Reference

Represents an environment for variable storage in the GSC interpreter. More...

#include <environment.hpp>

Inheritance diagram for Environment:

Collaboration diagram for Environment:

Public Member Functions
	Environment ()
	Constructs a new Environment.
	Environment (std::shared_ptr< Environment > enclosing)
	Constructs a new Environment with an enclosing environment.
std::any	get (const Token &name) const
	Retrieves the value of a variable by its name.
void	assign (const Token &name, std::any value)
	Assigns a value to a variable by its name.
void	define (const std::string &name, std::any value)
	Defines a new variable in the current environment.

Private Attributes
std::shared_ptr< Environment >	enclosing
std::map< std::string, std::any >	values

Detailed Description

Represents an environment for variable storage in the GSC interpreter.

Note

This class manages variable scopes, allowing for nested environments to handle variable declarations and lookups.

Definition at line 15 of file environment.hpp.

Constructor & Destructor Documentation

Environment() [1/2]

Environment::Environment

(

)

Constructs a new Environment.

Note

This constructor creates a new environment without an enclosing environment.

Definition at line 4 of file environment.cpp.

: enclosing(nullptr) {}

Environment() [2/2]

Environment::Environment

(

std::shared_ptr< Environment >

enclosing

)

Constructs a new Environment with an enclosing environment.

Parameters

enclosing

A shared pointer to the enclosing environment.

Note

This constructor allows for nested environments, enabling variable shadowing and scope management.

Definition at line 6 of file environment.cpp.

    : enclosing(std::move(enclosing)) {}

Member Function Documentation

assign()

void Environment::assign	(	const Token &	name,
		std::any	value
	)

Assigns a value to a variable by its name.

Parameters

name	The Token representing the variable name.
value	The value to assign to the variable.

Exceptions

RuntimeError

if the variable is not defined in this or any enclosing environment.

Definition at line 21 of file environment.cpp.

                                                        {
  auto it = values.find(name.getLexeme());
  if (it != values.end()) {
    it->second = std::move(value);
    return;
  }
  if (enclosing) {
    enclosing->assign(name, std::move(value));
    return;
  }
  throw RuntimeError(std::make_shared<Token>(name),
                     "Undefined variable '" + name.getLexeme() + "'.");
}

define()

void Environment::define	(	const std::string &	name,
		std::any	value
	)

Defines a new variable in the current environment.

Parameters

name	The name of the variable to define.
value	The value to assign to the variable.

Note

This method does not check for existing variables with the same name, allowing for redefinition within the same environment.

Definition at line 35 of file environment.cpp.

                                                            {
  values[name] = std::move(value);
}

get()

std::any Environment::get

(

const Token &

name

)

const

Retrieves the value of a variable by its name.

Parameters

name	The Token representing the variable name.

Returns

The value associated with the variable.

Exceptions

RuntimeError

if the variable is not defined in this or any enclosing environment.

Definition at line 9 of file environment.cpp.

                                               {
  auto it = values.find(name.getLexeme());
  if (it != values.end()) {
    return it->second;
  }
  if (enclosing) {
    return enclosing->get(name);
  }
  throw RuntimeError(std::make_shared<Token>(name),
                     "Undefined variable '" + name.getLexeme() + "'.");
}

Member Data Documentation

enclosing

std::shared_ptr<Environment> Environment::enclosing

private

Definition at line 17 of file environment.hpp.

values

std::map<std::string, std::any> Environment::values

private

Definition at line 18 of file environment.hpp.

---

The documentation for this class was generated from the following files:

• lib/gsc/environment.hpp
• src/environment.cpp