Package org.jamplate.model

A package that specifies that primary components of a processor that uses the jamplate-style processing.

See: Description

Interface Summary

Interface	Description
Compilation	A compilation is a structure holding the variables for a single compilation unit (like a file).
Document	An interface that abstracts the functionality required to deal with source-code files.
Environment	The environment is a unit holding all the data, managers and variables about a single process.
Instruction	An instruction is a function that executes depending on the state of the environment and memory given to it but does not have a state itself.
Value	The value function is a function that evaluates to a value depending on the state of the memory given to it.

Class Summary

Class	Description
Frame	An isolated part in the memory.
Memory	The memory is a structure that saves the variables at the runtime.
Reference	A source reference is a component that points to a document or a fragment of it.
Sketch	A class that holds the thoughts about a syntax or runtime component.
Tree	A tree is a point in a background structure of sketches that hold the variables of a runtime or a text component.

Enum Summary

Enum	Description
Dominance	An enumeration of how dominant a relation is over another relation.
Intersection	An enumeration of possible intersections between sources.
Relation	An enumeration of the possible directions to the relatives of a source.

Exception Summary

Exception	Description
CompileException	An exception indicating a failure while compiling.
DocumentNotFoundException	An exception that indicates that an attempt to read an unreadable document occurred.
ExecutionException	An exception indicating failure on executing an instruction.
IllegalTreeException	An exception indicating that an illegal tree was provided.
TreeClashException	An exception to indicate that a provided tree is clashing with another tree and the operation cannot continue because of that.
TreeOutOfBoundsException	An exception to indicate that a provided tree is out of the expected bounds.
TreeTakeoverException	This exception is a more specific exception of the TreeClashException.

Error Summary

Error	Description
DocumentNotFoundError	An unchecked throwable equivalent to DocumentNotFoundError.

Package org.jamplate.model Description

A package that specifies that primary components of a processor that uses the jamplate-style processing.

Enums

• Relation
  An enumeration representing a relation between two trees.
• Dominance
  An enumeration representing how dominance a tree over another.
• Intersection
  An enumeration representing how a tree intersect with another.

Constant Components:

• Document
  A constant that represents a source unit.
• Reference
  A constant that represents a range (area).

Building Components:

• Tree
  An absolute building block that reserves an area in a document.
  • Its Document.
  • Its Reference.
  • The Trees around it.
  • A Sketch representing the tree.
• Sketch
  A relative building block that represent its data without a position.
  • Its origin Tree.
  • Its component Sketchs.
  • Additional meta data.

Built Components:

• Value
  A built component that can be evaluated into a string.
• Instruction
  A built component that can be executed.
  • Its origin Tree.

Environment Components:

• Environment
  A fixed structure that holds the variables of a whole process.
  • A Diagnostic Manager.
  • A set of Compilations.
  • Additional meta data.
• Compilation
  A fixed structure that holds the variables of a whole document.
  • The represented Document.
  • A root Tree.
  • A compiled Instruction.
  • Additional meta data.

Volatile Components:

• Frame
  A highly stateful mutable structure that can store and release values/data in a stack and heap fashion.
• The host Instruction.
• A stack of values.
• A heap of values.
• Memory
  A highly stateful mutable structure that can store and release frames in a stack fashion.
  • A stack of Frames.
  • A console.

Functions:

• Initializer
  A function that initializes a Document into an Environment.
• Parser
  A function tries to constructs a set of Trees from a Tree.
• Analyzer
  A function that analyzes and modifies a Tree.
• Compiler
  A function tires to construct an Instruction from a Tree.
• Processor
  An function that processes a Compilation.

Since:

0.2.0 ~2021.01.17

Version:

0.2.0

Author:

LSafer