Parsing and execution of STL. More...

Collaboration diagram for The Sen Type Language:

Classes
struct	sen::lang::CodeLocation
	Location of a character in a program. More...
class	sen::lang::ErrorReporter
	Utility class for reporting errors in the source code. More...
class	sen::lang::FomParser
	Parses HLA FOM files. More...
struct	sen::lang::StlUnaryExpr
	Unary operation. More...
struct	sen::lang::StlBinaryExpr
	Binary expression. More...
struct	sen::lang::StlLiteralExpr
	Literals. More...
struct	sen::lang::StlGroupingExpr
	Groups. More...
struct	sen::lang::StlLogicalExpr
	Binary logical operation. More...
struct	sen::lang::StlVariableExpr
	A variable. More...
struct	sen::lang::StlBetweenExpr
	A BETWEEN expression. More...
struct	sen::lang::StlInExpr
	A IN expression. More...
struct	sen::lang::StlExpr
	Wrapper for expression values. More...
class	sen::lang::StlParser
	Parses STL types and queries out of a list of tokens. More...
struct	sen::lang::TypeSet
	A set of types coming from a STL file. More...
struct	sen::lang::ResolverContext
	The environment where a resolution takes place. More...
class	sen::lang::TypeSetContext
	The set of types used during resolution. More...
struct	sen::lang::ClassAnnotations
struct	sen::lang::TypeSettings
class	sen::lang::StlResolver
	Resolves a list of statements into a set of types. More...
class	sen::lang::StlScanner
	Converts a string into a list of tokens. More...
struct	sen::lang::StlImportStatement
struct	sen::lang::StlPackageStatement
struct	sen::lang::StlAttribute
struct	sen::lang::StlTypeNameStatement
struct	sen::lang::StlStructFieldStatement
struct	sen::lang::StlStructStatement
struct	sen::lang::StlEnumeratorStatement
struct	sen::lang::StlEnumStatement
struct	sen::lang::StlVariantElement
struct	sen::lang::StlVariantStatement
struct	sen::lang::StlQuantityStatement
struct	sen::lang::StlSequenceStatement
struct	sen::lang::StlArrayStatement
struct	sen::lang::StlTypeAliasStatement
struct	sen::lang::StlOptionalTypeStatement
struct	sen::lang::StlArgStatement
struct	sen::lang::StlVarStatement
struct	sen::lang::StlFunctionStatement
struct	sen::lang::StlEventStatement
struct	sen::lang::StlInterfaceStatement
struct	sen::lang::StlClassStatement
struct	sen::lang::BusNameStatement
struct	sen::lang::QueryStatement
struct	sen::lang::StlToken
struct	sen::lang::VariantAccessError
	Represents a variant that could not be accessed. More...
class	sen::lang::Chunk
	A chunk of byte code. It holds code and constants needed by the code. Constants are accessed by index. More...
class	sen::lang::VM
	Virtual machine for executing Sen byte code. More...

Typedefs
using	sen::lang::StlExprVal
	A variant supporting all expressions.
using	sen::lang::StlAttributeList = std::vector<StlAttribute>
using	sen::lang::StlStatement
using	sen::lang::StlTokenList = std::vector<StlToken>
using	sen::lang::Value
	A value that can be in the stack.
using	sen::lang::ValueGetter = std::function<Value()>
	Gets a value from some source.
using	sen::lang::Environment = Span<ValueGetter>
	The environment is an indexed list of value getter functions.

Enumerations
enum class	sen::lang::StlUnaryOperator { sen::lang::StlUnaryOperator::logicalNot , sen::lang::StlUnaryOperator::negate }
	An operator on a single term. More...
enum class	sen::lang::StlBinaryOperator { sen::lang::StlBinaryOperator::add , sen::lang::StlBinaryOperator::subtract , sen::lang::StlBinaryOperator::multiply , sen::lang::StlBinaryOperator::divide , sen::lang::StlBinaryOperator::lt , sen::lang::StlBinaryOperator::le , sen::lang::StlBinaryOperator::gt , sen::lang::StlBinaryOperator::ge , sen::lang::StlBinaryOperator::eq , sen::lang::StlBinaryOperator::ne }
	Kinds of binary operations. More...
enum class	sen::lang::StlLogicalOperator { sen::lang::StlLogicalOperator::logicalAnd , sen::lang::StlLogicalOperator::logicalOr }
	Logic. More...
enum class	sen::lang::StlTokenType { sen::lang::StlTokenType::leftParen , sen::lang::StlTokenType::rightParen , sen::lang::StlTokenType::leftBrace , sen::lang::StlTokenType::rightBrace , sen::lang::StlTokenType::leftBracket , sen::lang::StlTokenType::rightBracket , sen::lang::StlTokenType::comma , sen::lang::StlTokenType::dot , sen::lang::StlTokenType::minus , sen::lang::StlTokenType::plus , sen::lang::StlTokenType::colon , sen::lang::StlTokenType::semicolon , sen::lang::StlTokenType::slash , sen::lang::StlTokenType::star , sen::lang::StlTokenType::at , sen::lang::StlTokenType::bang , sen::lang::StlTokenType::bangEqual , sen::lang::StlTokenType::equal , sen::lang::StlTokenType::equalEqual , sen::lang::StlTokenType::greater , sen::lang::StlTokenType::greaterEqual , sen::lang::StlTokenType::less , sen::lang::StlTokenType::lessEqual , sen::lang::StlTokenType::identifier , sen::lang::StlTokenType::string , sen::lang::StlTokenType::real , sen::lang::StlTokenType::integral , sen::lang::StlTokenType::keywordAbstract , sen::lang::StlTokenType::keywordAnd , sen::lang::StlTokenType::keywordClass , sen::lang::StlTokenType::keywordInterface , sen::lang::StlTokenType::keywordExtends , sen::lang::StlTokenType::keywordImplements , sen::lang::StlTokenType::keywordStruct , sen::lang::StlTokenType::keywordVariant , sen::lang::StlTokenType::keywordFalse , sen::lang::StlTokenType::keywordFunction , sen::lang::StlTokenType::keywordEvent , sen::lang::StlTokenType::keywordVar , sen::lang::StlTokenType::keywordOr , sen::lang::StlTokenType::keywordNot , sen::lang::StlTokenType::keywordTrue , sen::lang::StlTokenType::keywordImport , sen::lang::StlTokenType::keywordOptional , sen::lang::StlTokenType::keywordPackage , sen::lang::StlTokenType::keywordEnum , sen::lang::StlTokenType::keywordSequence , sen::lang::StlTokenType::keywordArray , sen::lang::StlTokenType::keywordQuantity , sen::lang::StlTokenType::keywordAlias , sen::lang::StlTokenType::keywordSelect , sen::lang::StlTokenType::keywordWhere , sen::lang::StlTokenType::keywordFrom , sen::lang::StlTokenType::keywordIn , sen::lang::StlTokenType::keywordBetween , sen::lang::StlTokenType::comment , sen::lang::StlTokenType::endOfFile }
	Supported tokens. More...
enum	sen::lang::OpCode : uint8_t { sen::lang::opReturn = 0 , sen::lang::opConstant = 1 , sen::lang::opNegate = 2 , sen::lang::opAdd = 3 , sen::lang::opSub = 4 , sen::lang::opMul = 5 , sen::lang::opDiv = 6 , sen::lang::opEqual = 7 , sen::lang::opNotEqual = 8 , sen::lang::opGreaterThan = 9 , sen::lang::opGreaterOrEqualThan = 10 , sen::lang::opLowerThan = 11 , sen::lang::opLowerOrEqualThan = 12 , sen::lang::opAnd = 13 , sen::lang::opOr = 14 , sen::lang::opJumpIfTrue = 15 , sen::lang::opJumpIfFalse = 16 , sen::lang::opFetchVariable = 17 , sen::lang::opBetween = 18 }
	Instructions that can be executed by the virtual machine. More...

Functions
TypeSetContext	sen::lang::parseFomDocuments (const std::vector< std::filesystem::path > &paths, const std::vector< std::filesystem::path > &mappings, const TypeSettings &settings)
const TypeSet *	sen::lang::readTypesFile (const std::filesystem::path &fileName, const std::vector< std::filesystem::path > &includePaths, TypeSetContext &globalTypeSetContext, const TypeSettings &settings, std::string_view from={})
	Helper function to use the resolver.
std::string	sen::lang::toString (const StlToken &token)
std::string	sen::lang::toString (StlTokenType type)
template<typename T>
T	sen::lang::extract (const Value &value)
	Get T out of the value variant.
template<typename T>
bool	sen::lang::holds (const Value &value) noexcept
	True if the variant holds T.

Variables
constexpr std::size_t	sen::lang::stackMax = 256U

Detailed Description

Parsing and execution of STL.

Class Documentation

◆ sen::lang::CodeLocation

struct sen::lang::CodeLocation

Location of a character in a program.

Class Members
const char *	src
size_t	offset	Points to the source code.

◆ sen::lang::StlUnaryExpr

struct sen::lang::StlUnaryExpr

Unary operation.

Class Members
StlUnaryOperator	op
shared_ptr< StlExpr >	expr

◆ sen::lang::StlBinaryExpr

struct sen::lang::StlBinaryExpr

Binary expression.

Class Members
shared_ptr< StlExpr >	lhs
StlBinaryOperator	op
shared_ptr< StlExpr >	rhs

◆ sen::lang::StlLiteralExpr

struct sen::lang::StlLiteralExpr

Literals.

Class Members
StlToken	value

◆ sen::lang::StlGroupingExpr

struct sen::lang::StlGroupingExpr

Groups.

Class Members
shared_ptr< StlExpr >	expr

◆ sen::lang::StlLogicalExpr

struct sen::lang::StlLogicalExpr

Binary logical operation.

Class Members
shared_ptr< StlExpr >	lhs
StlLogicalOperator	op
shared_ptr< StlExpr >	rhs

◆ sen::lang::StlVariableExpr

struct sen::lang::StlVariableExpr

A variable.

Class Members
vector< StlToken >	path
string	name

◆ sen::lang::StlBetweenExpr

struct sen::lang::StlBetweenExpr

A BETWEEN expression.

Class Members
shared_ptr< StlExpr >	lhs
shared_ptr< StlExpr >	min
shared_ptr< StlExpr >	max
bool	notBetween = false

◆ sen::lang::StlInExpr

struct sen::lang::StlInExpr

A IN expression.

Class Members
shared_ptr< StlExpr >	lhs
vector< shared_ptr< StlExpr > >	set
bool	notIn = false

◆ sen::lang::StlExpr

struct sen::lang::StlExpr

Wrapper for expression values.

Class Members
StlExprVal	value

◆ sen::lang::TypeSet

struct sen::lang::TypeSet

A set of types coming from a STL file.

Class Members
string	fileName
string	parentDirectory
vector< string >	package
vector< ConstTypeHandle< CustomType > >	types
vector< const TypeSet * >	importedSets

◆ sen::lang::ResolverContext

struct sen::lang::ResolverContext

The environment where a resolution takes place.

Class Members
path	originalFileName
path	absoluteFileName
vector< path >	includePaths

◆ sen::lang::ClassAnnotations

struct sen::lang::ClassAnnotations

Class Members
unordered_set< string >	checkedProperties
unordered_set< string >	deferredMethods

◆ sen::lang::StlImportStatement

struct sen::lang::StlImportStatement

Class Members
StlToken	fileName

◆ sen::lang::StlPackageStatement

struct sen::lang::StlPackageStatement

Class Members
vector< StlToken >	path

◆ sen::lang::StlAttribute

struct sen::lang::StlAttribute

Class Members
StlToken	name
StlToken	value

◆ sen::lang::StlTypeNameStatement

struct sen::lang::StlTypeNameStatement

Class Members
vector< StlToken >	path
string	qualifiedName

◆ sen::lang::StlStructFieldStatement

struct sen::lang::StlStructFieldStatement

Class Members
StlTypeNameStatement	typeName
StlToken	identifier
vector< StlToken >	description

◆ sen::lang::StlStructStatement

struct sen::lang::StlStructStatement

Class Members
StlToken	identifier
vector< StlToken >	description
optional< StlTypeNameStatement >	parentStructName
vector< StlStructFieldStatement >	fields

◆ sen::lang::StlEnumeratorStatement

struct sen::lang::StlEnumeratorStatement

Class Members
StlToken	identifier
vector< StlToken >	description
StlAttributeList	attributes

◆ sen::lang::StlEnumStatement

struct sen::lang::StlEnumStatement

Class Members
StlToken	identifier
vector< StlToken >	description
StlTypeNameStatement	storageTypeName
vector< StlEnumeratorStatement >	enumerators

◆ sen::lang::StlVariantElement

struct sen::lang::StlVariantElement

Class Members
StlTypeNameStatement	typeName
vector< StlToken >	description

◆ sen::lang::StlVariantStatement

struct sen::lang::StlVariantStatement

Class Members
StlToken	identifier
vector< StlToken >	description
vector< StlVariantElement >	elements

◆ sen::lang::StlQuantityStatement

struct sen::lang::StlQuantityStatement

Class Members
StlToken	identifier
vector< StlToken >	description
StlTypeNameStatement	valueTypeName
StlToken	unitName
optional< StlAttributeList >	attributes

◆ sen::lang::StlSequenceStatement

struct sen::lang::StlSequenceStatement

Class Members
StlToken	identifier
vector< StlToken >	description
StlTypeNameStatement	elementTypeName
optional< StlToken >	maxSize
optional< StlAttributeList >	attributes

◆ sen::lang::StlArrayStatement

struct sen::lang::StlArrayStatement

Class Members
StlToken	identifier
vector< StlToken >	description
StlTypeNameStatement	elementTypeName
StlToken	size
optional< StlAttributeList >	attributes

◆ sen::lang::StlTypeAliasStatement

struct sen::lang::StlTypeAliasStatement

Class Members
StlToken	identifier
StlTypeNameStatement	typeName
vector< StlToken >	description

◆ sen::lang::StlOptionalTypeStatement

struct sen::lang::StlOptionalTypeStatement

Class Members
StlToken	identifier
StlTypeNameStatement	typeName
vector< StlToken >	description

◆ sen::lang::StlArgStatement

struct sen::lang::StlArgStatement

Class Members
StlToken	identifier
StlTypeNameStatement	typeName
vector< StlToken >	description

◆ sen::lang::StlVarStatement

struct sen::lang::StlVarStatement

Class Members
StlToken	identifier
StlToken	defaultValue
vector< StlToken >	description
StlAttributeList	attributes
StlTypeNameStatement	typeName

◆ sen::lang::StlFunctionStatement

struct sen::lang::StlFunctionStatement

Class Members
StlToken	identifier
vector< StlToken >	description
StlAttributeList	attributes
StlTypeNameStatement	returnTypeName
vector< StlArgStatement >	arguments

◆ sen::lang::StlEventStatement

struct sen::lang::StlEventStatement

Class Members
StlToken	identifier
vector< StlToken >	description
StlAttributeList	attributes
vector< StlArgStatement >	arguments

◆ sen::lang::StlInterfaceStatement

struct sen::lang::StlInterfaceStatement

Class Members
StlToken	identifier
vector< StlToken >	description
vector< StlVarStatement >	properties
vector< StlFunctionStatement >	functions
vector< StlEventStatement >	events

◆ sen::lang::StlClassStatement

struct sen::lang::StlClassStatement

Class Members
bool	isAbstract = false
StlInterfaceStatement	members
StlTypeNameStatement	extends
vector< StlTypeNameStatement >	implements

◆ sen::lang::BusNameStatement

struct sen::lang::BusNameStatement

Class Members
StlToken	session
StlToken	bus

◆ sen::lang::QueryStatement

struct sen::lang::QueryStatement

Class Members
optional< StlTypeNameStatement >	type
BusNameStatement	bus
shared_ptr< StlExpr >	condition

◆ sen::lang::VariantAccessError

struct sen::lang::VariantAccessError

Represents a variant that could not be accessed.

Typedef Documentation

◆ StlExprVal

using sen::lang::StlExprVal

Initial value:

std::variant<std::monostate,
                               StlLiteralExpr,
                               StlUnaryExpr,
                               StlBinaryExpr,
                               StlGroupingExpr,
                               StlLogicalExpr,
                               StlVariableExpr,
                               StlBetweenExpr,
                               StlInExpr>

A variant supporting all expressions.

◆ StlAttributeList

using sen::lang::StlAttributeList = std::vector<StlAttribute>

◆ StlStatement

using sen::lang::StlStatement

Initial value:

std::variant<std::monostate,
                                 StlImportStatement,
                                 StlPackageStatement,
                                 StlStructStatement,
                                 StlEnumStatement,
                                 StlVariantStatement,
                                 StlSequenceStatement,
                                 StlArrayStatement,
                                 StlQuantityStatement,
                                 StlTypeAliasStatement,
                                 StlOptionalTypeStatement,
                                 StlClassStatement,
                                 StlInterfaceStatement>

◆ StlTokenList

using sen::lang::StlTokenList = std::vector<StlToken>

◆ Value

using sen::lang::Value

Initial value:

std::variant<float32_t,
                          float64_t,
                          int32_t,
                          uint32_t,
                          int64_t,
                          uint64_t,
                          bool,
                          std::string,
                          uint8_t,
                          int16_t,
                          uint16_t,
                          VariantAccessError>

A value that can be in the stack.

◆ ValueGetter

using sen::lang::ValueGetter = std::function<Value()>

Gets a value from some source.

◆ Environment

using sen::lang::Environment = Span<ValueGetter>

The environment is an indexed list of value getter functions.

Enumeration Type Documentation

◆ StlUnaryOperator

enum class sen::lang::StlUnaryOperator

strong

An operator on a single term.

Enumerator
logicalNot
negate

◆ StlBinaryOperator

enum class sen::lang::StlBinaryOperator

strong

Kinds of binary operations.

Enumerator
add
subtract
multiply
divide
lt
le
gt
ge
eq
ne

◆ StlLogicalOperator

enum class sen::lang::StlLogicalOperator

strong

Logic.

Enumerator
logicalAnd
logicalOr

◆ StlTokenType

enum class sen::lang::StlTokenType

strong

Supported tokens.

Enumerator
leftParen
rightParen
leftBrace
rightBrace
leftBracket
rightBracket
comma
dot
minus
plus
colon
semicolon
slash
star
at
bang
bangEqual
equal
equalEqual
greater
greaterEqual
less
lessEqual
identifier
string
real
integral
keywordAbstract
keywordAnd
keywordClass
keywordInterface
keywordExtends
keywordImplements
keywordStruct
keywordVariant
keywordFalse
keywordFunction
keywordEvent
keywordVar
keywordOr
keywordNot
keywordTrue
keywordImport
keywordOptional
keywordPackage
keywordEnum
keywordSequence
keywordArray
keywordQuantity
keywordAlias
keywordSelect
keywordWhere
keywordFrom
keywordIn
keywordBetween
comment
endOfFile

◆ OpCode

enum sen::lang::OpCode : uint8_t

Instructions that can be executed by the virtual machine.

Enumerator
opReturn	Finishes execution.
opConstant	Push a constant to the stack. Requires an index as the argument.
opNegate	Negates the value at the top of the stack.
opAdd	Adds the two top-most values on the stack.
opSub	Subtracts the two top-most values on the stack.
opMul	Multiplies the two top-most values on the stack.
opDiv	Divides the two top-most values on the stack.
opEqual	Compares the two top-most values for equality.
opNotEqual	Compares the two top-most values for inequality.
opGreaterThan	Compares the two top-most values for >.
opGreaterOrEqualThan	Compares the two top-most values for >=.
opLowerThan	Compares the two top-most values for <.
opLowerOrEqualThan	Compares the two top-most values for <=.
opAnd	Logical and of the two top-most values.
opOr	Logical or of the two top-most values.
opJumpIfTrue	Jumps to an offset if the top-most value is true.
opJumpIfFalse	Jumps to an offset if the top-most value is false.
opFetchVariable	Fetches a variable in a given index and pushes the value.
opBetween	Checks that the top and second values are <= and >= to the third value.

Function Documentation

◆ parseFomDocuments()

TypeSetContext sen::lang::parseFomDocuments	(	const std::vector< std::filesystem::path > &	paths,
		const std::vector< std::filesystem::path > &	mappings,
		const TypeSettings &	settings )

inline

◆ readTypesFile()

const TypeSet * sen::lang::readTypesFile	(	const std::filesystem::path &	fileName,
		const std::vector< std::filesystem::path > &	includePaths,
		TypeSetContext &	globalTypeSetContext,
		const TypeSettings &	settings,
		std::string_view	from = {} )

nodiscard

Helper function to use the resolver.

◆ toString() [1/2]

std::string sen::lang::toString ( const StlToken & token )

◆ toString() [2/2]

std::string sen::lang::toString ( StlTokenType type )

◆ extract()

template<typename T>

T sen::lang::extract ( const Value & value )

inlinenodiscard

Get T out of the value variant.

◆ holds()

template<typename T>

bool sen::lang::holds ( const Value & value )

inlinenodiscardnoexcept

True if the variant holds T.

Variable Documentation

◆ stackMax

std::size_t sen::lang::stackMax = 256U

constexpr

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Class Documentation

◆ sen::lang::CodeLocation

◆ sen::lang::StlUnaryExpr

◆ sen::lang::StlBinaryExpr

◆ sen::lang::StlLiteralExpr

◆ sen::lang::StlGroupingExpr

◆ sen::lang::StlLogicalExpr

◆ sen::lang::StlVariableExpr

◆ sen::lang::StlBetweenExpr

◆ sen::lang::StlInExpr

◆ sen::lang::StlExpr

◆ sen::lang::TypeSet

◆ sen::lang::ResolverContext

◆ sen::lang::ClassAnnotations

◆ sen::lang::StlImportStatement

◆ sen::lang::StlPackageStatement

◆ sen::lang::StlAttribute

◆ sen::lang::StlTypeNameStatement

◆ sen::lang::StlStructFieldStatement

◆ sen::lang::StlStructStatement

◆ sen::lang::StlEnumeratorStatement

◆ sen::lang::StlEnumStatement

◆ sen::lang::StlVariantElement

◆ sen::lang::StlVariantStatement

◆ sen::lang::StlQuantityStatement

◆ sen::lang::StlSequenceStatement

◆ sen::lang::StlArrayStatement

◆ sen::lang::StlTypeAliasStatement

◆ sen::lang::StlOptionalTypeStatement

◆ sen::lang::StlArgStatement

◆ sen::lang::StlVarStatement

◆ sen::lang::StlFunctionStatement

◆ sen::lang::StlEventStatement

◆ sen::lang::StlInterfaceStatement

◆ sen::lang::StlClassStatement

◆ sen::lang::BusNameStatement

◆ sen::lang::QueryStatement

◆ sen::lang::VariantAccessError

Typedef Documentation

◆ StlExprVal

◆ StlAttributeList

◆ StlStatement

◆ StlTokenList

◆ Value

◆ ValueGetter

◆ Environment

Enumeration Type Documentation

◆ StlUnaryOperator

◆ StlBinaryOperator

◆ StlLogicalOperator

◆ StlTokenType

◆ OpCode

Function Documentation

◆ parseFomDocuments()

◆ readTypesFile()

◆ toString() [1/2]

◆ toString() [2/2]

◆ extract()

◆ holds()

Variable Documentation

◆ stackMax