Automatisch Code generieren

[Zacherl]

Hallo zusammen,

in einem aktuellen Projekt benötige ich die Funktionalität Code für verschiedene Sprachen zu generieren (vorerst vor allem C, C++ und Pascal). Hierbei geht es mir im Speziellen um die Initialisierung von konstanten Structs/Records und Arrays. Außerdem müssen Typ-Aliase und Enums deklariert werden können.

Gibt es hier vielleicht schon ein fertiges Framework?
Hat hier vielleicht schon jemand etwas Ähnliches mal gemacht und kann mir Tipps zum Klassendesign / zur Umsetzung geben?

Mein momentaner Entwurf ist eine TCodeWriter Klasse:

Delphi-Quellcode:

type
  TContainerType  = (Struct, &Class, Union, &Array);
  TOrdinalBase    = (Dec, Oct, Hex);
  TSymbolModifier = (Default, Pointer, Reference);
  TStorageClass   = (Default, Auto, Register, Static, Extern);

  TCodeWriter = class abstract(TObject)
  strict private
    FWriter: TTextWriter;
    FIndent: Integer;
    FIndentString: String;
  public
    procedure IncIndent; virtual;
    procedure DecIndent; virtual;
    procedure WriteLine; virtual;
    procedure WriteIndent; inline;
    procedure WriteRaw(const AText: String); virtual; abstract;
    procedure WriteComment(const AComment: String); virtual; abstract;
    procedure WriteMultiLineComment(const AComment: String); virtual; abstract;
  public
    procedure WriteContainerBegin(AContainerType: TContainerType); virtual; abstract;
    procedure WriteContainerEnd; virtual; abstract;
    procedure WriteStructBegin; inline; // WriteContainerBegin(TContainerType.Struct)
    procedure WriteStructEnd; inline;   // WriteContainerEnd
    procedure WriteClassBegin; inline;  // WriteContainerBegin(TContainerType.Class)
    procedure WriteClassEnd; inline;    // WriteContainerEnd
    procedure WriteUnionBegin; inline;  // WriteContainerBegin(TContainerType.Union)
    procedure WriteUnionEnd; inline;    // WriteContainerEnd
    procedure WriteArrayBegin; inline;  // WriteContainerBegin(TContainerType.Array)
    procedure WriteArrayEnd; inline;    // WriteContainerEnd
  public
    procedure WriteSymbol(const ASymbol: String;
      AModifier: TSymbolModifier = TSymbolModifier.Default); virtual; abstract;

    // To be used in struct/class/union initializations only
    // Pascal: `AName:` | C/C++: `.AName =`
    procedure WriteFieldName(const AName: String); virtual; abstract;

    // To be used in struct/class/union/array initializations only
    procedure WriteValue(const AItem: String); overload; virtual; abstract;
    procedure WriteValue(AItem: Integer;
      AOrdinalBase: TOrdinalBase = TOrdinalBase.Dec); overload; virtual; abstract;
    procedure WriteValue(AItem: Boolean); overload; virtual; abstract;
    // ...
  public
    // Used to sum up multiple declarations in the same block (for languages like Pascal)
    procedure DeclarationBegin; virtual; abstract;
    procedure DeclarationEnd; virtual; abstract;

    // Strong = true  -> Pascal: `type AName = type AType` | C/C++: `typedef AType AName`
    // String = false -> Pascal: `type AName = AType`      | C/C++: `typedef AType AName`
    procedure WriteDeclareType(const AName, AType: String;
      StrongType: Boolean); virtual; abstract;

    // Strong = true  -> Pascal: `type AName = (`          | C/C++: `enum AName = {`
    // Strong = false -> Pascal: `type AName = (`          | C++  : `enum class AName : AType = {`
    procedure WriteDeclareEnum(const AName: String; const AType: String = '';
      StrongType: Boolean = true); virtual; abstract;
    procedure WriteEnumItem(const AName: String; AValue: Integer = 0;
      AOrdinalBase = TOrdinalBase.Dec); overload; virtual; abstract;
    procedure WriteEnumItem(const AName, ASymbol: String); overload; overload; virtual; abstract;
    // ...
  public
    // Used to sum up multiple constants in the same block (for languages like Pascal)
    procedure ConstantBegin(
      AStorageClass: TStorageClass = TStorageClass.Default); virtual; abstract;
    procedure ConstantEnd; virtual; abstract;

    procedure WriteDeclareConstant(const AName, AType: String); virtual; abstract;

    // Used to sum up multiple constants in the same block (for languages like Pascal)
    procedure VariableBegin(
      AStorageClass: TStorageClass = TStorageClass.Default); virtual; abstract;
    procedure VariableEnd; virtual; abstract;

    procedure WriteDeclareVariable(const AName, AType: String); virtual; abstract;
  strict protected
    constructor Create(AWriter: TTextWriter; AIndent, AInitialIndent: Integer); virtual;
  public
    destructor Destroy; override;
  public
    property Writer: TTextWriter read FWriter;
  end;

Konkrete Umsetzung ist dann leider etwas schwieriger, da ich alle Aktionen bei Ausführung erst auf Validität prüfen möchte. Dafür habe ich eine Kombination aus Stack und Statemachine ins Auge gefasst, was allerdings recht viel Aufwand ist, da die Logik für alle unterstützten Sprachen komplett individuell implementiert werden muss.

Viele Grüße
Zacherl

[TiGü]

Womit wird denn der CodeWriter gefüttert?
Ihr müsst ja eine allgemeine Beschreibungssprache haben (XML etc.) in der steht: "hier kommt jetzt eine Klasse mit den und den Elementen und Methoden und danach kommen ein paar Records".

Du könntest dir den WMI Code Generator als Inspirationsquelle für eine Delphi-Implementation anschauen:
https://github.com/RRUZ/wmi-delphi-code-creator

Der kann für Delphi, Free Pascal, Oxygene, C#, Emba und Microsoft C++ Abfragecode für WMI Klassen und Eigenschaften erstellen.

[stahli]

Ich habe in zwei Projekten etwas ähnliches im Einsatz.

In beiden Fällen wird die "Logik" (was passiert wann) in verketteten Objekten verwaltet.

Dann gibt es einen Serialisierer, der die Kette durchgeht und die Objekte auffordert, sich in Textform darzustellen.
Er muss jedoch auch noch einige Ordnungsaufgaben durchführen und den Gesamtüberblick über die einzelnen Abschnitte behalten.

Ich denke nicht, dass es Dir wirklich helfen würde, aber wenn Du magst, schicke ich Dir den Stand von dem Tool: http://www.delphipraxis.net/193733-i...stuetzung.html
Das zerlegt eine Pascal-Unit und baut sie neu zusammen.

[Sailor]

Was ist denn Deine Ausgangsbasis? Wenn es Text ist, dann sind Parsing/Abstrakter Syntaxbaum, Tree grammars, Stringtemplates gängige Praxis.

[Zacherl]

Danke schonmal für eure Antworten

Zitat von TiGü:

Womit wird denn der CodeWriter gefüttert?
Ihr müsst ja eine allgemeine Beschreibungssprache haben (XML etc.) in der steht: "hier kommt jetzt eine Klasse mit den und den Elementen und Methoden und danach kommen ein paar Records".

In der Hinsicht ist das Programm recht simpel: Diese Informationen sind nämlich hardcoded Lediglich der Inhalt der Enums und statischen Daten-Arrays ändert sich. Es kommt aber durchaus - wenn auch nicht sehr häufig - vor, dass ich hier Anpassungen an z.b. der Struktur bestimmter Records vornehmen muss.

Zitat von TiGü:

Du könntest dir den WMI Code Generator als Inspirationsquelle für eine Delphi-Implementation anschauen:
https://github.com/RRUZ/wmi-delphi-code-creator

Danke, das schaue ich mir mal an. Denke allerdings, dass deren Generator sehr speziell auf die konkrete Aufgabe zugeschnitten sein wird.

Zitat von stahli:

In beiden Fällen wird die "Logik" (was passiert wann) in verketteten Objekten verwaltet.

Dann gibt es einen Serialisierer, der die Kette durchgeht und die Objekte auffordert, sich in Textform darzustellen.
Er muss jedoch auch noch einige Ordnungsaufgaben durchführen und den Gesamtüberblick über die einzelnen Abschnitte behalten.

Das ist leider für mich nicht ohne großen Aufwand möglich, da in meinem Projekt bereits sämtliche Daten in Klassen modelliert werden (die ich nicht ohne Weiteres jetzt auf selbst-Serialisierung umbauen kann).

Zitat von Sailor:

Was ist denn Deine Ausgangsbasis? Wenn es Text ist, dann sind Parsing/Abstrakter Syntaxbaum, Tree grammars, Stringtemplates gängige Praxis.

Der Code Generator wird mit Instanzen aufbereiteter Datenklassen gefüttert (ursprünglich aus einem JSON generiert). Gramatiken sind sicherlich nützlich, um die Aktionen des Writers zu validieren (wäre tatsächlich momentan nicht extrem wichtig, da wie oben erwähnt die grobe Struktur zur Zeit hardcoded ist; möchte ich aber trotzdem einbauen, um mögliche Programmierfehler zu minimieren).

Mein Hauptproblem ist zur Zeit erstmal das generische Interface für alle Sprachen zu gestalten und trotzdem Sprach-spezifische Features an einigen Stellen zu unterstützen, die sich nicht direkt vereinheitlichen lassen.