Package it.unive.lisa.program.language.validation

Class BaseValidationLogic

java.lang.Object

it.unive.lisa.program.language.validation.BaseValidationLogic

All Implemented Interfaces:

ProgramValidationLogic

public class BaseValidationLogic
extends java.lang.Object
implements ProgramValidationLogic

A simple implementation of ProgramValidationLogic, providing the minimum reasoning for considering a Program valid for LiSA. Each validation method can be overridden by subclasses to define language-specific validation logic.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ABSTRACT_METHODS	Error message format for AbstractCodeMembers in non-AbstractClassUnits.
static java.lang.String	ABSTRACT_NON_INSTANCE	Error message format for AbstractCodeMember that is not instance.
static java.lang.String	ABSTRACT_SEALED_UNIT	Error message format for sealed AbstractClassUnits.
static java.lang.String	CANNOT_OVERRIDE	Error message format for the overriding of a non-overridable CodeMember.
static java.lang.String	CONST_INSTANCE_GLOBAL	Error message format for a ConstantGlobal being an instance global.
static java.lang.String	DUPLICATE_MEMBER	Error message format for duplicated CodeMembers in the same Unit.
static java.lang.String	EXIT_WITH_FOLLOWERS	Error message format for terminating Statements with followers.
static java.lang.String	GLOBAL_INSTANCE_MISMATCH	Error message format for a Global not matching its instance flag.
static java.lang.String	INHERIT_FROM_SEALED	Error message format for inheritance from a sealed CompilationUnit.
static java.lang.String	INTERFACE_WITH_GLOBALS	Error message format for Globals inside InterfaceUnits.
static java.lang.String	INVALID_CFSTRUCTURE	Error message format for invalid ControlFlowStructures.
static java.lang.String	INVALID_NODE_LIST	Error message format for invalid NodeLists.
static java.lang.String	MEMBER_MISMATCH	Error message format for a CodeMember not matching its own signature.
static java.lang.String	MISSING_OVERRIDE	Error message format for missing override of an AbstractCodeMember.
static java.lang.String	MULTIPLE_OVERRIDES	Error message format for multiple overrides of the same CodeMember inside the same CompilationUnit.
static java.lang.String	NO_FOLLOWERS	Error message format for Statements with no followers.
java.util.Set<java.lang.String>	processedUnits	The set of CompilationUnits, represented by their names, that have been already processed by validateAndFinalize(CompilationUnit).
static java.lang.String	UNKNOWN_ENTRYPOINTS	Error message format for entrypoints not defined inside the Program.

Constructor Summary

Constructors

Constructor	Description
BaseValidationLogic()

Method Summary

Modifier and Type	Method	Description
void	validate(CodeMember member, boolean instance)	Validates the given CodeMember, checking that no other code member exists in its containing Unit with the same signature, according to CodeMemberDescriptor.matchesSignature(CodeMemberDescriptor).
void	validate(Global global, boolean isInstance)	Validates the given Global.
void	validateAndFinalize(AbstractClassUnit unit)	Validates the given AbstractClassUnit.
void	validateAndFinalize(ClassUnit unit)	Validates the given ClassUnit.
void	validateAndFinalize(CodeUnit unit)	Validates the given CodeUnit.
void	validateAndFinalize(CompilationUnit unit)	Validates the given CompilationUnit.
void	validateAndFinalize(InterfaceUnit unit)	Validates the given InterfaceUnit.
void	validateAndFinalize(Program program)	Validates the given Program, ensuring its consistency.
void	validateAndFinalize(Unit unit)	Validates the given unit, ensuring its consistency.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DUPLICATE_MEMBER

public static final java.lang.String DUPLICATE_MEMBER

Error message format for duplicated CodeMembers in the same Unit.

See Also:

Constant Field Values

INVALID_NODE_LIST

public static final java.lang.String INVALID_NODE_LIST

Error message format for invalid NodeLists.

See Also:

Constant Field Values

INVALID_CFSTRUCTURE

public static final java.lang.String INVALID_CFSTRUCTURE

Error message format for invalid ControlFlowStructures.

See Also:

Constant Field Values

EXIT_WITH_FOLLOWERS

public static final java.lang.String EXIT_WITH_FOLLOWERS

Error message format for terminating Statements with followers.

See Also:

Constant Field Values

NO_FOLLOWERS

public static final java.lang.String NO_FOLLOWERS

Error message format for Statements with no followers.

See Also:

Constant Field Values

UNKNOWN_ENTRYPOINTS

public static final java.lang.String UNKNOWN_ENTRYPOINTS

Error message format for entrypoints not defined inside the Program.

See Also:

Constant Field Values

INTERFACE_WITH_GLOBALS

public static final java.lang.String INTERFACE_WITH_GLOBALS

Error message format for Globals inside InterfaceUnits.

See Also:

Constant Field Values

ABSTRACT_SEALED_UNIT

public static final java.lang.String ABSTRACT_SEALED_UNIT

Error message format for sealed AbstractClassUnits.

See Also:

Constant Field Values

ABSTRACT_METHODS

public static final java.lang.String ABSTRACT_METHODS

Error message format for AbstractCodeMembers in non-AbstractClassUnits.

See Also:

Constant Field Values

INHERIT_FROM_SEALED

public static final java.lang.String INHERIT_FROM_SEALED

Error message format for inheritance from a sealed CompilationUnit.

See Also:

Constant Field Values

MISSING_OVERRIDE

public static final java.lang.String MISSING_OVERRIDE

Error message format for missing override of an AbstractCodeMember.

See Also:

Constant Field Values

CANNOT_OVERRIDE

public static final java.lang.String CANNOT_OVERRIDE

Error message format for the overriding of a non-overridable CodeMember.

See Also:

Constant Field Values

MULTIPLE_OVERRIDES

public static final java.lang.String MULTIPLE_OVERRIDES

Error message format for multiple overrides of the same CodeMember inside the same CompilationUnit.

See Also:

Constant Field Values

ABSTRACT_NON_INSTANCE

public static final java.lang.String ABSTRACT_NON_INSTANCE

Error message format for AbstractCodeMember that is not instance.

See Also:

Constant Field Values

MEMBER_MISMATCH

public static final java.lang.String MEMBER_MISMATCH

Error message format for a CodeMember not matching its own signature.

See Also:

Constant Field Values

GLOBAL_INSTANCE_MISMATCH

public static final java.lang.String GLOBAL_INSTANCE_MISMATCH

Error message format for a Global not matching its instance flag.

See Also:

Constant Field Values

CONST_INSTANCE_GLOBAL

public static final java.lang.String CONST_INSTANCE_GLOBAL

Error message format for a ConstantGlobal being an instance global.

See Also:

Constant Field Values

processedUnits

public final java.util.Set<java.lang.String> processedUnits

The set of CompilationUnits, represented by their names, that have been already processed by validateAndFinalize(CompilationUnit). This is used to avoid duplicate validation of the same unit in multiple inheritance chains.

Constructor Detail

BaseValidationLogic

public BaseValidationLogic()

Method Detail

validateAndFinalize

public void validateAndFinalize(Program program)
                         throws ProgramValidationException

Validates the given Program, ensuring its consistency. This identifies erroneous situations (e.g., code members with the same signature) that can crash the analysis. During validation, the program is also finalized by populating additional data structures (e.g., computing the instances of all CompilationUnits defined in the program).

Validating a program simply causes the validation of all the Units and CodeMembers defined inside it, and ensures that all entrypoints (Program.getEntryPoints()) are defined.

Specified by:

validateAndFinalize in interface ProgramValidationLogic

Parameters:

program - the program to validate

Throws:

ProgramValidationException - if the program has an invalid structure

validateAndFinalize

public void validateAndFinalize(Unit unit)
                         throws ProgramValidationException

Validates the given unit, ensuring its consistency. This ensures that all of its CodeMembers are valid through validate(CodeMember, boolean). Further validation logic is deferred to this method's overloads accepting more specific types of units (e.g., validateAndFinalize(ClassUnit)).

Parameters:

unit - the unit to validate

Throws:

ProgramValidationException - if the unit has an invalid structure

validate

public void validate(Global global,
                     boolean isInstance)
              throws ProgramValidationException

Validates the given Global. This method checks that ConstantGlobals are not instance ones, and then Global.isInstance() agrees with isInstance.

Parameters:

global - the global to validate

isInstance - whether or not the given global is part of the instance variables of its container

Throws:

ProgramValidationException - if the global has an invalid structure

validateAndFinalize

public void validateAndFinalize(CodeUnit unit)
                         throws ProgramValidationException

Validates the given CodeUnit. This method checks that no instance Globals are defined in the unit, and then delegates validation to validateAndFinalize(CompilationUnit).

Parameters:

unit - the unit to validate

Throws:

ProgramValidationException - if the unit has an invalid structure

validateAndFinalize

public void validateAndFinalize(ClassUnit unit)
                         throws ProgramValidationException

Validates the given ClassUnit. This method checks that no AbstractCodeMember is defined in the unit, and then delegates validation to validateAndFinalize(CompilationUnit).

Parameters:

unit - the unit to validate

Throws:

ProgramValidationException - if the unit has an invalid structure

validateAndFinalize

public void validateAndFinalize(AbstractClassUnit unit)
                         throws ProgramValidationException

Validates the given AbstractClassUnit. This method checks the unit is not sealed (CompilationUnit.isSealed()), and then delegates validation to validateAndFinalize(CompilationUnit).

Parameters:

unit - the unit to validate

Throws:

ProgramValidationException - if the unit has an invalid structure

validateAndFinalize

public void validateAndFinalize(InterfaceUnit unit)
                         throws ProgramValidationException

Validates the given InterfaceUnit. This method checks that no instance Globals are defined in the unit, and then delegates validation to validateAndFinalize(CompilationUnit).

Parameters:

unit - the unit to validate

Throws:

ProgramValidationException - if the unit has an invalid structure

validateAndFinalize

public void validateAndFinalize(CompilationUnit unit)
                         throws ProgramValidationException

Validates the given CompilationUnit. This causes the validation of all its super units transitively and the population of the set of instances (CompilationUnit.getInstances()) of each element in its hierarchy. Moreover, all instance CodeMembers are validated through validate(CodeMember, boolean). These are also linked to other ones in the hierarchy, populating the collections CodeMemberDescriptor.overriddenBy() and CodeMemberDescriptor.overrides() and raising errors if AbstractCodeMembers do not have an implementation in instantiable (Unit.canBeInstantiated()) units. Lastly, annotations are propagated along the inheritance hierarchy.

Parameters:

unit - the unit to validate

Throws:

ProgramValidationException - if the unit has an invalid structure

validate

public void validate(CodeMember member,
                     boolean instance)
              throws ProgramValidationException

Validates the given CodeMember, checking that no other code member exists in its containing Unit with the same signature, according to CodeMemberDescriptor.matchesSignature(CodeMemberDescriptor). This avoids ambiguous call resolution. Moreover, this ensures that all CFGs are valid, according to CFG.validate().

Parameters:

member - the code member to validate

instance - if true, duplicates will be searched in instance members instead

Throws:

ProgramValidationException - if the member has an invalid structure