Ast

MrKWatkins.Ast

Bibliothèque C# pour créer et manipuler des arbres de syntaxe abstraite lors de l'écriture de compilateurs.

Arrière-plan

Dans le cadre de mon projet Oakley visant à créer un compilateur et du projet OakAsm associé visant à créer un assembleur (détails à venir), j'avais besoin de représenter des arbres de syntaxe abstraite en C#. Cette bibliothèque a été créée pour que je puisse partager le code entre ces deux projets.

Usage

Créez un type de nœud de base pour votre arbre de syntaxe abstraite :

 public abstract class Expression : Node < Expression >
{
}

Créez des nœuds plus spécifiques :

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

Promenez-vous dans l'arbre :

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

Marquez les nœuds avec des erreurs, des avertissements et des messages d'information :

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

Associez les nœuds à leur position dans le code source lors de l'analyse :

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

Erreurs de sortie avec les informations source en surbrillance :

 var errors = MessageFormatter . FormatErrors ( expression ) ;

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

Manipulez et copiez l'arborescence :

sixty . ReplaceWith ( new ConstantNumber ( 55 ) ) ;

var copy = expression . Copy ( ) ;

Une documentation complète sera disponible avec la version 1.0.x.

Installer

 dotnet add package MrKWatkins.Ast

Demandes de tirage

Je n'accepte pas les pull request pour le moment ; ce projet est adapté à certains de mes autres projets et je veux d'abord les mettre dans un état approprié.

N'hésitez pas à signaler des bugs ou des suggestions, mais je ne garantis pas qu'ils seront examinés, j'en ai bien peur !

Licence

MIT