Struct Semantics

pub struct Semantics {
    pub source: Source,
    pub program: Program,
    pub parse_error: Option<ParseError>,
    pub names: Names,
    pub issues: IssueCollection,
}

The Semantics struct encapsulates all the information obtained after performing semantic analysis on a PHP source code file. It includes the original source code, the parsed abstract syntax tree (AST), any parse errors encountered, resolved names, the symbol table, and a collection of semantic issues.

Fields

source: Source

The original PHP source code, including its name and content.

program: Program

The abstract syntax tree (AST) resulting from parsing the source code.

parse_error: Option<ParseError>

An optional parse error, if one occurred during parsing.

names: Names

The resolved names within the source code, used for identifier resolution.

issues: IssueCollection

A collection of semantic issues found during analysis, such as invalid inheritance, improper returns, duplicate names, etc.

Implementations

impl Semantics

pub fn build( interner: &ThreadedInterner, version: PHPVersion, source: Source, ) -> Self

Builds the Semantics object by performing parsing, name resolution, symbol table construction, and semantic analysis on the provided PHP source code.

Parameters

• interner: A reference to a ThreadedInterner used for string interning, which helps in efficiently handling string comparisons and memory usage.
• version: The PHP version to use for semantic analysis.
• source: The Source object representing the PHP source code to be analyzed.

Returns

A Semantics object containing the results of the semantic analysis, including the AST, any parse errors, resolved names, the symbol table, and any semantic issues found.

Steps

1. Parsing: The source code is parsed into an abstract syntax tree (AST). If there are syntax errors, they are captured in parse_error.
2. Name Resolution: Resolves all the names in the AST, linking identifiers to their declarations.
3. Symbol Table Construction: Builds a symbol table containing all the symbols (classes, functions, constants, etc.) defined in the source code.
4. Semantic Analysis: Checks the AST for semantic correctness, such as type checking, scope rules, etc., and collects any issues.

pub fn is_valid(&self) -> bool

Determines whether the semantic analysis was successful, i.e., no parse errors or semantic issues were found.

pub fn has_parse_error(&self) -> bool

Determines whether the source code contains any parse errors.

pub fn has_issues(&self) -> bool

Determines whether the source code contains any semantic issues.

pub fn category(&self) -> SourceCategory

Retrieves the category of the source code.

Trait Implementations

impl Clone for Semantics

fn clone(&self) -> Semantics

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Semantics

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Semantics

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Semantics

fn eq(&self, other: &Semantics) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Semantics

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Semantics

impl StructuralPartialEq for Semantics