Ast

MrKWatkins.Ast

Библиотека C# для построения абстрактных синтаксических деревьев и управления ими при написании компиляторов.

Фон

В рамках моего проекта Oakley по созданию компилятора и связанного с ним проекта OakAsm по созданию ассемблера (подробности скоро появятся) мне нужно было представить абстрактные синтаксические деревья на C#. Эта библиотека была создана для того, чтобы я мог использовать код между этими двумя проектами.

Использование

Создайте базовый тип узла для вашего абстрактного синтаксического дерева:

 public abstract class Expression : Node < Expression >
{
}

Создайте более конкретные узлы:

 public sealed class ConstantNumber : Expression
{
    public ConstantNumber ( int value )
    {
        Value = value ;
    }

    public int Value
    {
        get => Properties . GetOrThrow < int > ( nameof ( Value ) ) ;
        init => Properties . Set ( nameof ( Value ) , value ) ;
    }
}

public sealed class Addition : Expression
{
    public Addition ( ConstantNumber x , ConstantNumber y )
    {
        Children . Add ( x ) ;
        Children . Add ( y ) ;
    }
}

Пройдитесь по дереву:

 var fifty = new ConstantNumber ( 50 ) ;
var sixty = new ConstantNumber ( 60 ) ;
var expression = new Addition ( fifty , sixty ) ;

var allNodes = expression . ThisAndDescendents ;
var fiftyAndParent = fifty . ThisAndAncestors ;
var fiftyAndSixty = fifty . ThisAndNextSiblings ;
var justSixty = sixty . PreviousSibling ;
var result = expression . Children . OfType < ConstantNumber > ( ) . Sum ( n => n . Value ) ;

Отмечайте узлы с ошибками, предупреждениями и информационными сообщениями:

sixty . AddError ( " Value must be less than 55. " ) ;
var expressionHasErrors = expression . HasErrors ; // true.

Свяжите узлы с их положением в исходном коде во время синтаксического анализа:

 var source = new TextFile ( new FileInfo ( " MySource.code " ) ) ;   // Contains "50 + 60".
expression . SourcePosition = source . CreatePosition ( 0 , 7 , 0 , 0 ) ; // startIndex, length, startLineIndex, startColumnIndex.
fifty . SourcePosition = source . CreatePosition ( 0 , 2 , 0 , 0 ) ;
sixty . SourcePosition = source . CreatePosition ( 5 , 2 , 0 , 5 ) ;

Ошибки вывода с выделенной исходной информацией:

 var errors = MessageFormatter . FormatErrors ( expression ) ;

// MySource.code (1, 6): Error: Parent Value must be less than 55.
// 50 + 60
//      --

Манипулируйте и копируйте дерево:

sixty . ReplaceWith ( new ConstantNumber ( 55 ) ) ;

var copy = expression . Copy ( ) ;

Полная документация будет доступна в версии 1.0.x.

Установить

 dotnet add package MrKWatkins.Ast

Запросы на извлечение

В настоящее время я не принимаю запросы на включение; этот проект адаптирован для некоторых других моих проектов, и я хочу сначала привести их в подходящее состояние.

Не стесняйтесь поднимать вопросы об ошибках или предлагать предложения, но я не гарантирую, что они будут рассмотрены, боюсь!

Лицензия

Массачусетский технологический институт