Terminal node (#1224)

* migrating `Identifier` and `YulIdentifier` to `TerminalNode`

* Migrating all `variant` values with the possibility to be a string to TerminalNode for easier printing logic

Author: Janther

src/slang-nodes/AbicoderPragma.ts

@@ -1,6 +1,6 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { SlangNode } from './SlangNode.js';
-import { Identifier } from './Identifier.js';
+import { TerminalNode } from './TerminalNode.js';
 
 import type * as ast from '@nomicfoundation/slang/ast';
 import type { AstPath, Doc } from 'prettier';
@@ -9,12 +9,12 @@ import type { PrintFunction } from '../types.d.ts';
 export class AbicoderPragma extends SlangNode {
   readonly kind = NonterminalKind.AbicoderPragma;
 
-  version: Identifier;
+  version: TerminalNode;
 
   constructor(ast: ast.AbicoderPragma) {
     super(ast);
 
-    this.version = new Identifier(ast.version);
+    this.version = new TerminalNode(ast.version);
   }
 
   print(path: AstPath<AbicoderPragma>, print: PrintFunction): Doc {

src/slang-nodes/AssignmentExpression.ts

@@ -1,8 +1,9 @@
-import { NonterminalKind, TerminalKind } from '@nomicfoundation/slang/cst';
+import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { isBinaryOperation } from '../slang-utils/is-binary-operation.js';
 import { printIndentedGroupOrSpacedDocument } from '../slang-printers/print-indented-group-or-spaced-document.js';
 import { SlangNode } from './SlangNode.js';
 import { Expression } from './Expression.js';
+import { TerminalNode } from './TerminalNode.js';
 
 import type * as ast from '@nomicfoundation/slang/ast';
 import type { AstPath, Doc, ParserOptions } from 'prettier';
@@ -35,7 +36,7 @@ export class AssignmentExpression extends SlangNode {
       ` ${this.operator}`,
       printIndentedGroupOrSpacedDocument(
         path.call(print, 'rightOperand'),
-        rightOperandVariant.kind !== TerminalKind.Identifier &&
+        !(rightOperandVariant instanceof TerminalNode) &&
           isBinaryOperation(rightOperandVariant)
       )
     ];

src/slang-nodes/CatchClauseError.ts

@@ -1,7 +1,7 @@
 import { doc } from 'prettier';
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { SlangNode } from './SlangNode.js';
-import { Identifier } from './Identifier.js';
+import { TerminalNode } from './TerminalNode.js';
 import { ParametersDeclaration } from './ParametersDeclaration.js';
 
 import type * as ast from '@nomicfoundation/slang/ast';
@@ -14,15 +14,15 @@ const { group } = doc.builders;
 export class CatchClauseError extends SlangNode {
   readonly kind = NonterminalKind.CatchClauseError;
 
-  name?: Identifier;
+  name?: TerminalNode;
 
   parameters: ParametersDeclaration;
 
   constructor(ast: ast.CatchClauseError, options: ParserOptions<AstNode>) {
     super(ast);
 
     if (ast.name) {
-      this.name = new Identifier(ast.name);
+      this.name = new TerminalNode(ast.name);
     }
     this.parameters = new ParametersDeclaration(ast.parameters, options);
 

src/slang-nodes/ConstantDefinition.ts

@@ -1,7 +1,7 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { SlangNode } from './SlangNode.js';
 import { TypeName } from './TypeName.js';
-import { Identifier } from './Identifier.js';
+import { TerminalNode } from './TerminalNode.js';
 import { Expression } from './Expression.js';
 
 import type * as ast from '@nomicfoundation/slang/ast';
@@ -14,15 +14,15 @@ export class ConstantDefinition extends SlangNode {
 
   typeName: TypeName;
 
-  name: Identifier;
+  name: TerminalNode;
 
   value: Expression;
 
   constructor(ast: ast.ConstantDefinition, options: ParserOptions<AstNode>) {
     super(ast);
 
     this.typeName = new TypeName(ast.typeName, options);
-    this.name = new Identifier(ast.name);
+    this.name = new TerminalNode(ast.name);
     this.value = new Expression(ast.value, options);
 
     this.updateMetadata(this.typeName, this.value);

src/slang-nodes/ConstructorAttribute.ts

@@ -1,7 +1,10 @@
-import { NonterminalKind, TerminalNode } from '@nomicfoundation/slang/cst';
-import { printVariant } from '../slang-printers/print-variant.js';
+import {
+  NonterminalKind,
+  TerminalNode as SlangTerminalNode
+} from '@nomicfoundation/slang/cst';
 import { SlangNode } from './SlangNode.js';
 import { ModifierInvocation } from './ModifierInvocation.js';
+import { TerminalNode } from './TerminalNode.js';
 
 import type * as ast from '@nomicfoundation/slang/ast';
 import type { AstPath, Doc, ParserOptions } from 'prettier';
@@ -11,14 +14,14 @@ import type { PrintFunction } from '../types.d.ts';
 export class ConstructorAttribute extends SlangNode {
   readonly kind = NonterminalKind.ConstructorAttribute;
 
-  variant: ModifierInvocation | string;
+  variant: ModifierInvocation | TerminalNode;
 
   constructor(ast: ast.ConstructorAttribute, options: ParserOptions<AstNode>) {
     super(ast);
 
     const variant = ast.variant;
-    if (variant instanceof TerminalNode) {
-      this.variant = variant.unparse();
+    if (variant instanceof SlangTerminalNode) {
+      this.variant = new TerminalNode(variant);
       return;
     }
     this.variant = new ModifierInvocation(variant, options);
@@ -27,6 +30,6 @@ export class ConstructorAttribute extends SlangNode {
   }
 
   print(path: AstPath<ConstructorAttribute>, print: PrintFunction): Doc {
-    return printVariant(this, path, print);
+    return path.call(print, 'variant');
   }
 }

src/slang-nodes/ContractDefinition.ts

@@ -2,7 +2,7 @@ import { doc } from 'prettier';
 import { satisfies } from 'semver';
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { SlangNode } from './SlangNode.js';
-import { Identifier } from './Identifier.js';
+import { TerminalNode } from './TerminalNode.js';
 import { ContractSpecifiers } from './ContractSpecifiers.js';
 import { ContractMembers } from './ContractMembers.js';
 
@@ -18,7 +18,7 @@ export class ContractDefinition extends SlangNode {
 
   abstractKeyword?: string;
 
-  name: Identifier;
+  name: TerminalNode;
 
   specifiers: ContractSpecifiers;
 
@@ -28,7 +28,7 @@ export class ContractDefinition extends SlangNode {
     super(ast);
 
     this.abstractKeyword = ast.abstractKeyword?.unparse();
-    this.name = new Identifier(ast.name);
+    this.name = new TerminalNode(ast.name);
     this.specifiers = new ContractSpecifiers(ast.specifiers, options);
     this.members = new ContractMembers(ast.members, options);
 

src/slang-nodes/ElementaryType.ts

@@ -1,7 +1,10 @@
-import { NonterminalKind, TerminalNode } from '@nomicfoundation/slang/cst';
-import { printVariant } from '../slang-printers/print-variant.js';
+import {
+  NonterminalKind,
+  TerminalNode as SlangTerminalNode
+} from '@nomicfoundation/slang/cst';
 import { SlangNode } from './SlangNode.js';
 import { AddressType } from './AddressType.js';
+import { TerminalNode } from './TerminalNode.js';
 
 import type * as ast from '@nomicfoundation/slang/ast';
 import type { AstPath, Doc } from 'prettier';
@@ -10,14 +13,14 @@ import type { PrintFunction } from '../types.d.ts';
 export class ElementaryType extends SlangNode {
   readonly kind = NonterminalKind.ElementaryType;
 
-  variant: AddressType | string;
+  variant: AddressType | TerminalNode;
 
   constructor(ast: ast.ElementaryType) {
     super(ast);
 
     const variant = ast.variant;
-    if (variant instanceof TerminalNode) {
-      this.variant = variant.unparse();
+    if (variant instanceof SlangTerminalNode) {
+      this.variant = new TerminalNode(variant);
       return;
     }
     this.variant = new AddressType(variant);
@@ -26,6 +29,6 @@ export class ElementaryType extends SlangNode {
   }
 
   print(path: AstPath<ElementaryType>, print: PrintFunction): Doc {
-    return printVariant(this, path, print);
+    return path.call(print, 'variant');
   }
 }

src/slang-nodes/EnumDefinition.ts

@@ -1,6 +1,6 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { SlangNode } from './SlangNode.js';
-import { Identifier } from './Identifier.js';
+import { TerminalNode } from './TerminalNode.js';
 import { EnumMembers } from './EnumMembers.js';
 
 import type * as ast from '@nomicfoundation/slang/ast';
@@ -10,14 +10,14 @@ import type { PrintFunction } from '../types.d.ts';
 export class EnumDefinition extends SlangNode {
   readonly kind = NonterminalKind.EnumDefinition;
 
-  name: Identifier;
+  name: TerminalNode;
 
   members: EnumMembers;
 
   constructor(ast: ast.EnumDefinition) {
     super(ast);
 
-    this.name = new Identifier(ast.name);
+    this.name = new TerminalNode(ast.name);
     this.members = new EnumMembers(ast.members);
 
     this.updateMetadata(this.members);

src/slang-nodes/EnumMembers.ts

@@ -2,7 +2,7 @@ import { doc } from 'prettier';
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { printSeparatedList } from '../slang-printers/print-separated-list.js';
 import { SlangNode } from './SlangNode.js';
-import { Identifier } from './Identifier.js';
+import { TerminalNode } from './TerminalNode.js';
 
 import type * as ast from '@nomicfoundation/slang/ast';
 import type { AstPath, Doc } from 'prettier';
@@ -13,12 +13,12 @@ const { hardline } = doc.builders;
 export class EnumMembers extends SlangNode {
   readonly kind = NonterminalKind.EnumMembers;
 
-  items: Identifier[];
+  items: TerminalNode[];
 
   constructor(ast: ast.EnumMembers) {
     super(ast, true);
 
-    this.items = ast.items.map((item) => new Identifier(item));
+    this.items = ast.items.map((item) => new TerminalNode(item));
   }
 
   print(path: AstPath<EnumMembers>, print: PrintFunction): Doc {

src/slang-nodes/ErrorDefinition.ts

@@ -1,6 +1,6 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { SlangNode } from './SlangNode.js';
-import { Identifier } from './Identifier.js';
+import { TerminalNode } from './TerminalNode.js';
 import { ErrorParametersDeclaration } from './ErrorParametersDeclaration.js';
 
 import type * as ast from '@nomicfoundation/slang/ast';
@@ -11,14 +11,14 @@ import type { PrintFunction } from '../types.d.ts';
 export class ErrorDefinition extends SlangNode {
   readonly kind = NonterminalKind.ErrorDefinition;
 
-  name: Identifier;
+  name: TerminalNode;
 
   members: ErrorParametersDeclaration;
 
   constructor(ast: ast.ErrorDefinition, options: ParserOptions<AstNode>) {
     super(ast);
 
-    this.name = new Identifier(ast.name);
+    this.name = new TerminalNode(ast.name);
     this.members = new ErrorParametersDeclaration(ast.members, options);
 
     this.updateMetadata(this.members);