Ast

MrKWatkins.Ast

Biblioteca C# para crear y manipular árboles de sintaxis abstracta al escribir compiladores.

Fondo

Como parte de mi proyecto Oakley para crear un compilador y su proyecto OakAsm asociado para crear un ensamblador (los detalles estarán disponibles próximamente), necesitaba representar árboles de sintaxis abstracta en C#. Esta biblioteca fue creada para poder compartir el código entre esos dos proyectos.

Uso

Cree un tipo de nodo base para su árbol de sintaxis abstracta:

 public abstract class Expression : Node < Expression >
{
}

Crea nodos más 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 ) ;
    }
}

Camina por el árbol:

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

Marcar nodos con errores, advertencias y mensajes de información:

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

Asociar nodos con su posición en el código fuente durante el análisis:

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

Errores de salida con información de origen resaltada:

 var errors = MessageFormatter . FormatErrors ( expression ) ;

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

Manipular y copiar el árbol:

sixty . ReplaceWith ( new ConstantNumber ( 55 ) ) ;

var copy = expression . Copy ( ) ;

La documentación completa estará disponible con la versión 1.0.x.

Instalar

 dotnet add package MrKWatkins.Ast

Solicitudes de extracción

No acepto solicitudes de extracción en este momento; Este proyecto está diseñado para otros proyectos míos y primero quiero ponerlos en un estado adecuado.

Siéntase libre de plantear problemas en busca de errores o sugerencias, pero me temo que no garantizo que serán analizados.

Licencia

MIT