Module qilletni.api

Package dev.qilletni.api.lang.table

Interface Scope

public interface Scope

Represents a scope in the Qilletni type system. A scope is a mapping of names to symbols and functions, allowing the resolution and definition of variables and functions within different levels of visibility, such as global, local, or within specific entities. This interface provides methods for looking up symbols and functions, defining new variables or functions, and retrieving metadata about the scope.

Scopes have parents, and depending on the condition, will look up to their parent to see if a symbol exists.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Scope.ScopeType	How the scope is used or defined.

Method Summary

Modifier and Type	Method	Description
<T extends QilletniType> void	define(Symbol<T> symbol)	Defines the given symbol this scope.
void	defineFunction(Symbol<FunctionType> functionSymbol)	Defines the given function in this scope.
Map<String,List<Symbol<FunctionType>>>	getAllFunctionSymbols()	Gets all function symbols in the current scope, as a map of names and list of matching functions with the name.
Map<String,Symbol<?>>	getAllSymbols()	Gets all symbols in the current scope, as a map of names and values.
String	getDebugDesc()	Gets a unique readable name of the scope, for debugging purposes.
Scope	getParent()	Gets the parent scope, if any.
Scope.ScopeType	getScopeType()	Gets the type of the scope, meaning how it is used or defined.
boolean	isDefined(String name)	Checks if the given symbol name is defined in this scope or any applicable parent scopes.
boolean	isDirectlyDefined(String name)	Checks if the given symbol name is defined in this direct scope.
boolean	isFunctionDefined(String name)	Checks if the given function name is defined in this scope or any applicable parent scopes.
<T extends QilletniType> Symbol<T>	lookup(String name)	Looks up a symbol or function in the current scope and any parents by name.
List<Symbol<FunctionType>>	lookupFunction(String name)	Looks up all functions with the given name.
Symbol<FunctionType>	lookupFunction(String name, int params)	Looks up a function with a given name and number of parameters.
Symbol<FunctionType>	lookupFunction(String name, int params, QilletniTypeClass<?> onType)	Looks up a function with a given name and number of parameters, that is on a type (either defined in an entity or is an extension method).
Optional<Symbol<FunctionType>>	lookupFunctionOptionally(String name, int params, QilletniTypeClass<?> onType)	Looks up a function with a given name and number of parameters.
void	setDebugDesc(String desc)	Sets the debug description, for identification.

Method Details

lookup

<T extends QilletniType> Symbol<T> lookup(String name)

Looks up a symbol or function in the current scope and any parents by name. If the name begins with a _ the parent scope (if any) will not be checked. If the symbol is not found, an exception is thrown. To check beforehand if the variable would be found, check isDefined(String).

Type Parameters:

T - The type of the symbol

Parameters:

name - The name of the symbol to look up

Returns:

The found symbol

lookupFunction

Symbol<FunctionType> lookupFunction(String name,
 int params)

Looks up a function with a given name and number of parameters. If the function is not found, an exception is thrown. To check beforehand if the variable would be found, check isFunctionDefined(String).

Parameters:

name - The name of the function

params - The number of parameters the function has

Returns:

The found symbol

lookupFunction

Symbol<FunctionType> lookupFunction(String name,
 int params,
 QilletniTypeClass<?> onType)

Looks up a function with a given name and number of parameters, that is on a type (either defined in an entity or is an extension method). If the function is not found, an exception is thrown. To check beforehand if the variable would be found, check isFunctionDefined(String).

Parameters:

name - The name of the function

params - The number of parameters the function has

Returns:

The found symbol

lookupFunctionOptionally

Optional<Symbol<FunctionType>> lookupFunctionOptionally(String name,
 int params,
 QilletniTypeClass<?> onType)

Looks up a function with a given name and number of parameters. If the onType is not null, it will look one up that is on a type (either defined in an entity or is an extension method). If the function is not found, an empty optional is returned.

Parameters:

name - The name of the function

params - The number of parameters the function has

Returns:

The found symbol, if any

lookupFunction

List<Symbol<FunctionType>> lookupFunction(String name)

Looks up all functions with the given name. Each one will have different parameters.

Parameters:

name - The name of the function

Returns:

All found symbols, or an empty list

isDefined

boolean isDefined(String name)

Checks if the given symbol name is defined in this scope or any applicable parent scopes.

Parameters:

name - The name of the symbol to look up

Returns:

If the symbol is defined

isDirectlyDefined

boolean isDirectlyDefined(String name)

Checks if the given symbol name is defined in this direct scope. This does not check any parents.

Parameters:

name - The name of the symbol to look up

Returns:

If the symbol is defined

isFunctionDefined

boolean isFunctionDefined(String name)

Checks if the given function name is defined in this scope or any applicable parent scopes.

Parameters:

name - The name of the function to look up

Returns:

If the function is defined

define

<T extends QilletniType> void define(Symbol<T> symbol)

Defines the given symbol this scope. An exception will be thrown if the symbol is already defined.

Type Parameters:

T - The type of the symbol

Parameters:

symbol - The symbol to define

defineFunction

void defineFunction(Symbol<FunctionType> functionSymbol)

Defines the given function in this scope. An exception will be thrown if the function is already defined with the same signature.

Parameters:

functionSymbol - The function to define

getAllSymbols

Map<String,Symbol<?>> getAllSymbols()

Gets all symbols in the current scope, as a map of names and values.

Returns:

The map of symbols

getAllFunctionSymbols

Map<String,List<Symbol<FunctionType>>> getAllFunctionSymbols()

Gets all function symbols in the current scope, as a map of names and list of matching functions with the name. The value is a list because multiple functions with different argument counts can have the same name.

Returns:

The map of function symbols

getScopeType

Scope.ScopeType getScopeType()

Gets the type of the scope, meaning how it is used or defined.

Returns:

The type of the scope

getParent

Scope getParent()

Gets the parent scope, if any. Some methods look into the parent scope to find symbols.

Returns:

The parent Scope

getDebugDesc

String getDebugDesc()

Gets a unique readable name of the scope, for debugging purposes.

Returns:

The identifying string, for debugging

setDebugDesc

void setDebugDesc(String desc)

Sets the debug description, for identification.

Parameters:

desc - The new description