Uses of Class
org.ek9lang.compiler.common.RuleSupport

Packages that use RuleSupport

Package	Description
org.ek9lang.compiler.common	Common parts of processing that can be reused across various phases.
org.ek9lang.compiler.phase1	E - Initial Symbol definition by traversing the 'ANTLR' - 'AST'.
org.ek9lang.compiler.phase2	F - Resolution of Explicitly Defined Type Symbols - at this point phase3 processing should have defined most of the explicitly defined symbols, so they should be resolvable.
org.ek9lang.compiler.phase3	G - Full Symbol Resolution can now take place.
org.ek9lang.compiler.phase5	I - PRE Intermediate Representation generation checks.
org.ek9lang.compiler.support	Contains critical general components used in the Ek9Compiler listeners.

Uses of RuleSupport in org.ek9lang.compiler.common

Subclasses of RuleSupport in org.ek9lang.compiler.common

Modifier and Type	Class	Description
class	AppropriateBodyOrError	Checks if the body of a method/operator is appropriate.
class	ContextSupportsAbstractMethodOrError	Checks for the containing construct type and whether it is marked as abstract or not.
final class	LhsFromPreFlowOrError	Access the Symbol for the lhs of the preflow statement.
class	OverrideOrAbstractOrError	Checks for both abstract and override.
class	ProcessSyntheticReturn	Constructs like methods and functions may or may not always return a value.
class	TypedSymbolAccess	Designed to be used in phase3 or after - FULL_RESOLUTION.

Uses of RuleSupport in org.ek9lang.compiler.phase1

Subclasses of RuleSupport in org.ek9lang.compiler.phase1

Modifier and Type	Class	Description
(package private) final class	ApplicationOnMethodOrError	Checks for the appropriate use of the APPLICATION of xyz on a method declaration.
(package private) final class	AppropriateFunctionBodyOrError	Checks if the body of a function is appropriate.
(package private) final class	MethodNotOperatorOrError	Just checks that named operator methods: mod, rem, abs, sqrt, open, close, contains, matches, empty, length are not being used as just method names.
(package private) final class	NoMethodReturnOrError	Typically used for Constructors, but could be used in other contexts where a method is not expected to return anything.
(package private) final class	OuterGenericsUseOrError	Only use when code being checked prohibits use in outer generic context.
(package private) final class	ProcessCommonMethodsOrError	Processes and checks Methods that apply in all method contexts for basic correctness.
(package private) class	ValidAggregateConstructorsOrError	Checks that if the aggregate is a generic class that the appropriate public constructors are in place.
(package private) final class	ValidMethodOrError	Checks methods from various contexts, typically this is delegated to other functions.
(package private) class	ValidPreFlowAndReturnOrError	Checks that if a return is used.

Uses of RuleSupport in org.ek9lang.compiler.phase2

Subclasses of RuleSupport in org.ek9lang.compiler.phase2

Modifier and Type	Class	Description
(package private) final class	HttpAccessOrError	Checks HTTP Access for service operations because some require HTTP_SOURCE, but others do not support it.
(package private) final class	NoDuplicatedServicePathsOrError	Examines all the service operations on a service and looks at the verbs used and the uri proto paths.
(package private) class	PopulateConstrainedTypeOrError	For Constrained Types, focus on checking it is possible to constrain the type and if so then clones the appropriate methods/operators over and alters the types as appropriate.
(package private) final class	ProcessDynamicClassOrError	Configures a dynamic class in terms of settings its super and configured traits.
(package private) final class	ProcessDynamicFunctionOrError	Configures the dynamic function with it's 'super', but also checks that the super can be used in the way the EK9 source code has been defined.
(package private) final class	ProcessFunctionDeclarationOrError	Configures a function's 'super' in the most appropriate way.
(package private) final class	ProcessTraitDeclarationOrError	Configures the trait declaration and completes a number of checks on that trait once configured.
(package private) final class	ProcessTypeDeclarationOrError	Adds various synthetic methods to type defined by the EK9 developer.
(package private) final class	ProcessVariableDeclarationOrError	Checks for inferred declarations of variables in various contexts.
(package private) final class	ProcessVariableOnlyOrError	Deals with variable only declarations.
(package private) final class	ProcessVariableOrError	Processes a variable declaration - attempts to resolve the variable type.
(package private) final class	SuitableGenusOrError	Checks for a type is resolved and is suitable genus and category.
(package private) final class	SuitableToExtendOrError	Checks for a type is resolved and is suitable to be extended from (in basic terms).
(package private) final class	ValidOperatorOrError	Checks operators from various contexts, typically this is delegated to other functions.
(package private) final class	ValidPathParameterOrError	Checks the PATH value (if this is a path parameter) and ensures that the name appears in the path itself on the operation.
(package private) final class	ValidServiceOperationOrError	Check that a service operation complies with EK9 rules and return types etc.
(package private) final class	VisibilityOfOperationsOrError	Does a simple check (excluding any inheritance) for visibility rules on methods/operators on aggregates.

Uses of RuleSupport in org.ek9lang.compiler.phase3

Subclasses of RuleSupport in org.ek9lang.compiler.phase3

Modifier and Type	Class	Description
(package private) final class	AccessLeftAndRightOrError	Just gets the left and right hand side of values in an expression.
(package private) final class	AccessTernaryExpressionsOrError	Just gets both of the ternary expression parts (not the control).
(package private) final class	AccessToSymbolOrError	Check that a symbol can be accessed issues error if not possible.
(package private) final class	AllTextBodiesPresentOrError	Checks that all the text bodies that are on the super are also present in the language variant.
(package private) final class	AssertStatementOrError	Checks that the assert statement actually has a boolean result from the expression.
(package private) final class	AssignmentExpressionOrError	Just really pulls up the appropriate symbol from the expression into this context.
(package private) final class	AssignmentOrError	Checks the assignments for operator : := = and :=? that's all.
(package private) final class	AssignmentStatementOrError	Used in the full resolution phase to check assignments.
(package private) final class	AugmentAggregateWithTraitMethods	Designed to add in methods on the aggregate where the 'traits' use is 'traits by'.
(package private) final class	AutoMatchSuperFunctionSignature	The ek9 developer does not need to redeclare incoming or returning parameters for dynamic functions.
(package private) final class	CallOrError	Designed to deal with this following part of the EK9 grammar.
(package private) final class	CheckConflictingMethods	Checks that methods from a super and one or more traits do not conflict.
(package private) class	ComparatorPresentOrError	Given a symbol, this check that the type that the symbol has can support the '<=>' operator.
(package private) final class	ConstructorCallOrError	Checks that a specific constructor can be called on a particular type of Aggregate.
(package private) final class	ControlIsBooleanOrError	Just checks that an expression used in a control for if/while etc is a Boolean type.
(package private) class	DecrementPresentOrError	Given a symbol, this check that the type that the symbol has can support the '--' operator.
(package private) final class	DefaultOperatorsOrError	Checks that operators that have been 'defaulted' could actually be implemented.
(package private) final class	DictUseOrError	Creates/Updates an ek9 Dict (Dictionary/Map) of a specific types if the expressions are typed correctly.
(package private) final class	DynamicCaptureOrError	Resolves the variables to be captured and defines new variable symbols against the appropriate scopes.
(package private) final class	DynamicFunctionBodyPresentOrError	Checks if a dynamic function body is needed and provided.
(package private) final class	EnumeratedTypeOrError	Creates/Updates an enumerated type adding methods as appropriate.
(package private) final class	ExceptionTypeOrError	Checks that the symbol passed has a type and that the type is compatible with an EK9 Exception.
(package private) final class	ExpressionOrError	Ensures that 'expression' is now resolved and 'typed' or a not resolved error.
(package private) final class	ForLoopOrError	Deals with the for loop for phase 3, which is basically working out the type of the variable being iterated over and ensuring that the expression is something that can be iterated over.
(package private) final class	ForRangeOrError	Pulls the type from the 'range' into the loop variable, so it is correctly typed or emits an error.
(package private) final class	ForStatementExpressionOrError	Deals with checking the 'for' statement/expression.
(package private) final class	FunctionDelegateOrError	Check is the data passed in enabled a delegate function to be resolved and if so return that Function.
(package private) final class	FunctionOverridesOrError	Checks that the function correctly overrides the signature if it has a super.
(package private) final class	GetIteratorType	Given a 'type' (the IAggregateSymbol passed in), see it would be possible to iterator over it with some other type.
(package private) final class	GuardExpressionOrError	Checks that the guard expression is valid.
(package private) class	HashCodePresentOrError	Given a symbol, this check that the type that the symbol has can support the '#?' operator.
(package private) final class	HeadTailSkipOrError	Checks the possible operation variable, literal or function for suitability for use with 'head', 'tail' and 'skip'.
(package private) final class	IdentifierAssignmentOrError	Deals with the checking and setting initialised of the identifier.
(package private) final class	IdentifierOrError	Used for pure identifier resolution and recording.
(package private) final class	IdentifierReferenceOrError	Ensures that 'identifierReference' is now resolved and hangs together and is 'typed' or emit "not resolved" error.
(package private) final class	IfStatementOrError	Checks the IfStatement is valid or emits errors.
(package private) class	IncrementPresentOrError	Given a symbol, this check that the type that the symbol has can support the '++' operator.
(package private) final class	InstructionBlockVariablesOrError	Checks that variable only and variable declarations have symbols that have been referenced.
(package private) class	IsConvertableToStringOrError	Checks if a type has the $ 'toString' method or a 'promotion' #? to a String method.
(package private) final class	IsSetPresentOrError	Given a symbol, this check that the type that the symbol has can support the '?' operation.
(package private) final class	LhsAndRhsAssignmentOrError	Checks the left hand side and the right hand side for assignment compatibility.
(package private) final class	ListUseOrError	Creates/Updates an ek9 list of a specific type if the expressions are typed correctly.
(package private) final class	MethodOverridesOrError	Check overrides on methods.
(package private) final class	MethodSymbolSearchForExpression	Create a MethodSearch symbol for an operation that could have a single expression or two expressions.
(package private) final class	NoDelegateMethodClashesOrError	As it is possible to have a variable that is a delegate 'function', it means that to call that function, the ek9 developer would use variable-name(parameters).
(package private) final class	NoDuplicatedPropertyNamesOrError	As all properties on records are public, it is necessary to check they do not get duplicated.
(package private) final class	NotAbstractOrError	Typically used when a direct call is being bad on the symbol.
(package private) final class	NoTraitByVariablesOrError	Used where traits are implemented 'by' a variable.
(package private) final class	ObjectAccessExpressionOrError	This is the second part of the method/function chaining resolution and can be recursive via objectAccess.
(package private) final class	ObjectAccessStartOrError	Processes the Object Access start, this is the start of chained method/function calls.
(package private) final class	OperationCallOrError	Used for resolving operation calls on aggregates, which can include properties that are delegates to functions.
(package private) class	OperatorTest	Provides a common set of operations for checking operators.
(package private) final class	ParameterTypesExactMatchOrError	Checks the number and types of the two sets of parameter list match exactly.
(package private) final class	PipelinePartOrError	Process the stream pipeline part, ensuring that it can be resolved.
(package private) final class	PreFlowStatementOrError	Checks that the pre-flow expressions are valid.
(package private) final class	PrimaryOrError	Ensures that 'primary' is now resolved and 'typed' or a not resolved error.
(package private) final class	ProcessWhileControlVariable	Deals with checking the 'while' or 'do/while control variable in the statement/expression.
(package private) final class	ProgramOrError	Checks if there is any application associated with the program.
(package private) final class	PropertyFieldOrError	Used for resolving and recoding of fields on specific types.
(package private) final class	PureModifierOrError	Checks if the pure modifier has been used correctly on methods and functions.
(package private) final class	PureProcessingInPureContextOrError	Just check that with in the current 'context' - if pure that the processing call is pure.
(package private) final class	RangeOrError	Checks the Range and ensures that there a Symbol recorded against that context.
(package private) final class	RequiredOperatorPresentOrError	To be used with operators on aggregates (except for the is-set ? operator, that has to deal with functions).
(package private) final class	ResolveByTraitVariables	Used where traits are implemented 'by' a variable.
(package private) final class	ResolveFunctionOrDelegateByNameOrError	Used for resolving a function (by just name) or a variable that is a function delegate.
(package private) final class	ResolveFunctionOrError	Check for valid function parameters.
(package private) final class	ResolveIdentifierReferenceCallOrError	Locate a possible call to an identifierReference, so some sort of call.
(package private) final class	ResolveMethodOrError	Given a search for a method from an aggregate - and include supers/traits etc., this function will try and locate the method.
(package private) final class	ServiceRegistrationOrError	Checks the use of registering a service is valid and then ensures that the 'Application' is altered from being a general application to a service application.
(package private) final class	SetTypeFromReturningParam	Looks at the returning param (if not null) and sets the symbol type as appropriate.
(package private) final class	StatementOrError	Validates that the statement is OK and emits errors if this is not the case.
class	StreamAssemblyOrError	Processes/updates and checks that a stream assembly is actually viable in terms of types.
(package private) final class	StreamCatOrError	Deals with working out what the type being 'catted' is.
(package private) final class	StreamExpressionOrError	Now does the check/processing of the whole stream pipeline.
(package private) final class	StreamExpressionTerminationOrError	Process and ensure that the stream termination can function correctly.
(package private) final class	StreamForOrError	Deals with working out what the type being "for'd" is.
(package private) final class	StreamFunctionArgumentsOrError	Checks that the arguments in the function are compatible with the current pipeline type.
(package private) final class	StreamFunctionOrError
(package private) final class	StreamStatementOrError	Now does the check/processing of the whole stream pipeline.
(package private) final class	StreamStatementTerminationOrError	Process and ensure that the stream termination can function correctly.
(package private) final class	SwitchStatementExpressionOrError	Deals with checking if the switch can be used as an expression and whether the variable being switched on has the appropriate operators to meet the case criteria.
(package private) final class	SymbolFromContextOrError	Returns the appropriate symbol from the symbol and scope management component.
(package private) final class	SymbolReferencedOrError	Checks if a symbol has been referenced or not (can be null - no error).
(package private) final class	ThisOrSuperCallOrError	Just focus on resolving 'this' or 'super' in respect to a 'call'.
(package private) final class	ThisOrSuperOrError	Checks and assigns type a 'this' or 'super' symbol, but only if it valid.
(package private) final class	ThrowStatementOrError	Checks that the throw statement actually throws and Exception type.
(package private) class	TraitAccessibleOrError	Checks that a trait access like T1.xyz() - is allowed i.e.
(package private) final class	TryStatementExpressionOrError	Deals with checking the try statement/expression.
(package private) final class	TypeConstraintOrError	Checks that any recursive type constraints on a type are valid.
(package private) final class	TypeCovarianceOrError	Checks the covariance compatibility of two variables, this will traverse them to get their types.
(package private) final class	TypesCompatibleOrError	Check that the types of two symbol ar compatible with each other.
(package private) final class	ValidDispatcherMethodsOrError	Check if any dispatcher methods on the aggregate and ensure that they are valid.
(package private) final class	ValidFunctionAbstractnessOrError	Checks if a function extends another function and if it is abstract.
(package private) final class	ValidNamedArgumentsOrError	If the Ek9 developer has used named parameters, then they must be validated.
(package private) final class	VariableAssignmentOrError	Checks on the assignment during a declaration and emits an error if not valid.
(package private) final class	VariableOnlyOrError	Focus on checking a variable only declaration, now that types are all known.
(package private) final class	WhileStatementExpressionOrError	Deals with checking the 'while' or 'do/while statement/expression.

Uses of RuleSupport in org.ek9lang.compiler.phase5

Subclasses of RuleSupport in org.ek9lang.compiler.phase5

Modifier and Type	Class	Description
(package private) class	AbstractSafeSymbolMarker	Once an expression has been assessed as being simple enough to process, this consumer is called to mark the appropriate symbol(s) used in the expression as safe if the appropriate methods are called.
(package private) final class	AssignmentStatementOrError	Check the assignment to a variable can be a single assignment or a deep copy type assignment.
(package private) final class	DynamicFunctionOrError	Deals with handling any returning values in a dynamic function.
(package private) class	ExpressionSafeSymbolMarker	Once an expression has been assessed as being simple enough to process, this consumer is called to mark the appropriate symbol(s) used in the expression as safe if the appropriate methods are called.
(package private) final class	ForStatementOrError	Checks the for structure via the code analysers.
(package private) final class	FunctionOrError	Typically checks any returning values to see if they have now been initialised on a function.
(package private) final class	GetGuardVariable	Extracts the guard variable if there is a guard expression.
class	IdentifierAsPropertyOrError	Given an identifier, this consumer checks if it is a property of some aggregate.
(package private) final class	IdentifierReferenceOrError	Emits an error if an identifier (typically a variable) has been used before being initialised.
(package private) final class	IfStatementOrError	Deals with checking if all paths through if/else/else-if/else result in variables meeting criteria.
(package private) final class	MethodOrError	Typically checks any returning values to see if they have now been initialised on a method.
(package private) final class	ObjectAccessExpressionValidOrError	In the case of specific variables of type like 'Result' and 'Optional' it is important to check if the method being called needs a previous call to isOk or isError or just '?' before accessing specific methods.
(package private) final class	OperatorOrError	Typically checks any returning values to see if they have now been initialised on an operator.
(package private) class	PossibleExpressionConstruct	Used as a base for a range of constructs that can be expressions.
(package private) final class	ProcessDynamicFunctionEntry	Deals with handling any returning values in a dynamic function.
(package private) final class	ProcessGuardExpression	Checks on a guard expression and marks the identifier variable as initialised.
(package private) final class	ReturningVariableOrError	Checks if return variables are initialised.
(package private) class	SafeSymbolAccess
(package private) final class	SafeSymbolMarker	It may be that before calling this you have determined that 'isSet' has been called or you 'know' that the value of the variable is present and set.
(package private) final class	ServiceOperationOrError	Typically checks any returning values to see if they have now been initialised on a service operation.
(package private) class	SuitablePropertyInitialisationOrError	Used with aggregates to check that is they have any properties that are not initialised at declaration there are no default or implicit constructors being used.
(package private) final class	SwitchStatementOrError	Deals with checking if all paths through switch/case/default (return) result in variables meeting criteria.
(package private) final class	SymbolHasTypeOrError	Only triggers the call the retrieve the appropriate symbol for the node.
(package private) final class	TryStatementOrError	Checks the try/catch/finally structure via the code analysers.
(package private) final class	VariableOnlyOrError	Accepts a variable only declaration and ensures the variable is recorded if appropriate, for transient flow checks.
(package private) final class	WhileStatementOrError	Checks the while statement via the code analysers.

Uses of RuleSupport in org.ek9lang.compiler.support

Subclasses of RuleSupport in org.ek9lang.compiler.support

Modifier and Type	Class	Description
class	CommonTypeOrError	Attempts to find a common type from the CommonTypeDeterminationDetails or issues errors.
class	CommonTypeSuperOrTraitOrError	Given a list of symbols (normally variables), this code will get the type from each of those symbols.
final class	ParameterisedLocator	Create a new parameterised symbol from a generic type and a set of type arguments.
class	ResolveOrDefineExplicitParameterizedType	The bulk of the processing is in the abstract base.
class	ResolveOrDefineIdentifierReference	The bulk of the processing is in the abstract base.
class	ResolveOrDefineTypeDef	The bulk of the processing is in the abstract base.
class	ResolveOrDefineTypes	This is a sort of hybrid resolver or definer function.
class	ResolverOrDefiner	Used as an abstract base for parameterised types.