Accessors are used to read and write data. They are primarily used to access variables.
There are three types of accessors: getters, setters, and definitions.
An access path is the first part of an accessor that specifies what is being accessed. They consist of
/-delimited series of identifiers, keys, and indices.
Attributes are special variables that specify how the next block will resolve. They are stored in frames in the attribute stack.
Attributes can be set through attribute functions.
A full set of all available attributes. The attribute stack contains one or more frames, which can be consumed by blocks.
A function that reads or writes an attribute.
Attribute functions can only modify the attributes in the topmost frame.
Rant maintains an "attribute stack" that stores attributes and provides them to blocks. When a block starts resolving, it consumes the attributes in the topmost frame of the attribute stack, replacing them with their default values.
The user can add and remove frames from the attribute stack to preserve attribute frames for later use.
Auto-hinting refers to using the
@text keyword to mark variables, function parameters, and function return values as text, eliminating the need to add hints to each usage of them.
A block is a section of a Rant program subdivided into zero or more parts. Blocks act as variable scopes and can be combined with various constructs to produce a wide variety of behaviors.
A closure is a function that captures one or more variables from its enclosing scope.
A definition is an accessor type that creates a new variable.
Descoping is a type of variable access that explicitly retrieves a variable from a parent scope, overriding shadowing.
A dynamic key is an access path key, consisting of a single-element block, that must be resolved before the containing path can be read. The block resolves to the final key or index that will be inserted into the path.
Nothing refers to the name and value of the
An expression is a sequence of Rant expression units.
An expression unit is the smallest component of a Rant program. Examples of expression units inclide fragments, accessors, function calls, and blocks.
A formatter is a runtime component that passively changes the output in some way.
A fragment is a sequence of any non-whitespace, non-reserved characters found in a Rant program.
Function percolation is the ability of function calls to access functions from parent scopes despite shadowing by non-function variables. It is an implicit form of descoping.
A getter is an accessor that reads the value at the specified access path and prints it.
A compile-time flag that marks the following expression unit as text.
A name assigned to a variable or module.
Identifiers enforce specific formatting requirements to ensure consistency:
- Must contain at least one alphanumeric character.
- Must only contain alphanumeric characters, underscores, and hyphens.
A lambda expression is an anonymous (nameless) function.
A list is an ordered collection of values, accessible by index.
A map is a collection of key-value pairs, also known as an "associative array".
A module is a library of Rant functions that can be loaded into another program with
Pipeval is short for "Pipe value" and refers to the return value of a piped function that has been passed to the next function in a piped call.
A looping block that uses attributes. Blocks can be made to loop by setting the repetition count with
Resolution refers to the process of Rant selecting which branch to run on a block.
The component of the Rant runtime that handles block resolution.
A variable is shadowed (hidden) when it is overridden by a variable of the same name in a child scope.
A setter is an accessor type that changes the value at the specified access path.
A compile-time flag that marks the following expression unit as non-text.
A slice is an arbitrary range of elements in an ordered collection.
A splice is a setter that modifies a slice of an ordered collection.
Varity is the classification of a function parameter relating to the number of values it expects and can accept.
Rant has four varity types:
- Required (accepts one value)
- Optional (accepts zero or one values)
- Optional-variadic (accepts zero or more values)
- Required-variadic (accepts one or more values)