CxInspection

Description

abstract class Tinman.Core.Cx.Inspections.CxInspection

Represents an inspection that may be performed on PSI nodes.

An inspection is performed by calling the Check method. The given CxNode is inspected and zero or more messages are output to the specified Validator.

By failing, an inspection indicates that a problem exists which will have consequences as described by Flags. Each inspection has a unique identifier (see Identifier), which is included in the string tag (see object.ToString), for example: 'CX0001'.

Public / Constants

CX0001

[ShutdownSurvive]
public static readonly attribute CX0001 → (CxInspection)

[CX0001] bad code model: ...

The code model contains critical semantic errors:

  • …​invalid name
    A PSI node contains a CxId or CxName value that is invalid, see CxId.Invalid resp. CxName.Invalid. Invalid names cannot be parsed, so this problem may only occur when building a PSI model from code. Using invalid names in source code will trigger syntax errors.

Inspection flags:
CxInspectionFlags.All

CX0002

[ShutdownSurvive]
public static readonly attribute CX0002 → (CxInspection)

[CX0002] unresolved reference: ...

A PSI node that implements th ICxReference has not been resolved completely, i.e. IPsiNode.IsResolved returns false.

The code model must be modified in order to fix this, either by adding missing code parts or by repairing broken code references.

Inspection flags:
CxInspectionFlags.All

Public / Methods

Check

[ThreadSafe]
public abstract method Check → (2)

node in : CxNode

[not-null]
The PSI node to check.

validator in : Validator

[not-null]
The validator to use for outputting messages.

returns → CxInspectionResult

The result of the inspection.

Performs this inspection on the given node in.

Public / Attributes

Flags

[Constant]
public attribute Flags → (get)

value : CxInspectionFlags

The inspection flags.

Returns the inspection flags.

Identifier

[Constant]
public attribute Identifier → (get)

value : int32

[1..9999]
The inspection identifier.

Returns the inspection identifier.

Protected / Constructors

Cx​Inspection

protected constructor CxInspection → (2)

identifier in : int32

[1..9999]
The value for Identifier.

flags in : CxInspectionFlags

The value for Flags.

Creates a new instance of CxInspection.

Protected / Methods

Message

protected method Message → (2)

node in : CxNode

[not-null]
The node for which the inspection has failed.

message in : string

[not-null]
The inspection message.

returns → ValidateMessage

The validation message.

Generates a validation message for a failed inspection.