Ast

MrKWatkins.Ast

Biblioteca C# para construir e manipular árvores de sintaxe abstratas ao escrever compiladores.

Fundo

Como parte do meu projeto Oakley para criar um compilador e seu projeto OakAsm associado para criar um montador (detalhes em breve), eu precisava representar árvores de sintaxe abstratas em C#. Esta biblioteca foi criada para que eu pudesse compartilhar o código entre esses dois projetos.

Uso

Crie um tipo de nó base para sua árvore de sintaxe abstrata:

 public abstract class Expression : Node < Expression >
{
}

Crie nós mais específicos:

 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 ) ;
    }
}

Ande na árvore:

 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 ) ;

Marque nós com erros, avisos e mensagens informativas:

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

Associe nós à sua posição no código-fonte durante a análise:

 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 ) ;

Erros de saída com informações de origem destacadas:

 var errors = MessageFormatter . FormatErrors ( expression ) ;

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

Manipule e copie a árvore:

sixty . ReplaceWith ( new ConstantNumber ( 55 ) ) ;

var copy = expression . Copy ( ) ;

A documentação completa estará disponível na versão 1.0.x.

Instalar

 dotnet add package MrKWatkins.Ast

Solicitações pull

Não estou aceitando solicitações pull no momento; este projeto é adaptado para alguns outros projetos meus e quero primeiro colocá-los em um estado adequado.

Sinta-se à vontade para levantar questões sobre bugs ou sugestões, mas não garanto que eles serão analisados, infelizmente!

Licença

MIT