Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

DefaultAstNode Class

Namespace:
ActiproSoftware.Text.Parsing.Implementation
Assembly:
ActiproSoftware.Text.WinForms.dll

Represents an AST (abstract syntax tree) node implementation that has a string value and optional child nodes.

public class DefaultAstNode : IAstNode
Inheritance:
object object
Implements:
IAstNode

Constructors

DefaultAstNode()

Initializes an instance of the class.

public DefaultAstNode()

Properties

Children

The list containing the child AST nodes.

public IList<IAstNode> Children { get; }

Property Value

IList<IAstNode>

EndOffset

The end offset of this AST node, if known.

public int? EndOffset { get; set; }

Property Value

int?

HasChildren

Indicates whether the AST node contains any child AST nodes.

public bool HasChildren { get; }

Property Value

bool:

true if the AST node contains any child AST nodes; otherwise, false.

Id

An integer value that identifies the type of AST node, if known.

public virtual int Id { get; }

Property Value

int

Remarks

This class' default implementation always returns 0.

Length

The character length of this AST node, if known.

public int Length { get; }

Property Value

int

Parent

The parent IAstNode of this AST node, if known.

public IAstNode? Parent { get; set; }

Property Value

IAstNode

StartOffset

The start offset of this AST node, if known.

public int? StartOffset { get; set; }

Property Value

int?

Value

The string-based value for the AST node.

public string? Value { get; set; }

Property Value

string

Methods

Contains(int)

Returns whether the AST node contains the specified offset.

public bool Contains(int offset)
Parameter Type Description
offset int

The offset to examine.

Returns

bool:

true if the AST node contains the specified offset; otherwise, false.

Remarks

This method returns false if the offset falls on the EndOffset offset since this method indicates if the offset is encompassed by the AST node. This method also returns false if the AST node doesn't have known offsets.

FindChildNode(int)

Searches through the child nodes for a node that contains the specified offset.

public IAstNode? FindChildNode(int offset)
Parameter Type Description
offset int

The offset to check.

Returns

IAstNode:

The child IAstNode that contains the specified offset, if any.

FindDescendantNode(int)

Recursively searches through the descendant nodes for a node that contains the specified offset.

public IAstNode? FindDescendantNode(int offset)
Parameter Type Description
offset int

The offset to check.

Returns

IAstNode:

The descendant IAstNode that contains the specified offset, if any.

ToString()

Returns the string representation of this object.

public override string ToString()

Returns

string:

The string representation of this object.

ToTreeString(int)

Outputs the contents of the AST node in tree form.

public string ToTreeString(int indentLevel)
Parameter Type Description
indentLevel int

The indentation level.

Returns

string

Inherited Members

Extension Methods