#153 - обобщённый поиск символа (#157)

Stepami · web-flow · commit 37b58412cbda · 2025-04-01T21:16:31.000+03:00
* #153 - ISymbolId interface * fix * #153 - symbols refactoring * #153 - SymbolTable refactoring * #153 - generic FindSymbol * #153 - use name instead of id in symbols
diff --git a/src/Application/HydraScript.Application.StaticAnalysis/IMethodStorage.cs b/src/Application/HydraScript.Application.StaticAnalysis/IMethodStorage.cs
@@ -1,5 +1,5 @@
-using HydraScript.Domain.IR.Impl.SymbolIds;
 using HydraScript.Domain.IR.Impl.Symbols;
+using HydraScript.Domain.IR.Impl.Symbols.Ids;
 using HydraScript.Domain.IR.Types;
 
 namespace HydraScript.Application.StaticAnalysis;
diff --git a/src/Application/HydraScript.Application.StaticAnalysis/Impl/FunctionWithUndefinedReturnStorage.cs b/src/Application/HydraScript.Application.StaticAnalysis/Impl/FunctionWithUndefinedReturnStorage.cs
@@ -1,6 +1,6 @@
 using HydraScript.Domain.FrontEnd.Parser.Impl.Ast.Nodes.Declarations.AfterTypesAreLoaded;
-using HydraScript.Domain.IR.Impl.SymbolIds;
 using HydraScript.Domain.IR.Impl.Symbols;
+using HydraScript.Domain.IR.Impl.Symbols.Ids;
 
 namespace HydraScript.Application.StaticAnalysis.Impl;
 
diff --git a/src/Application/HydraScript.Application.StaticAnalysis/Impl/MethodStorage.cs b/src/Application/HydraScript.Application.StaticAnalysis/Impl/MethodStorage.cs
@@ -1,5 +1,5 @@
-using HydraScript.Domain.IR.Impl.SymbolIds;
 using HydraScript.Domain.IR.Impl.Symbols;
+using HydraScript.Domain.IR.Impl.Symbols.Ids;
 using HydraScript.Domain.IR.Types;
 
 namespace HydraScript.Application.StaticAnalysis.Impl;
diff --git a/src/Application/HydraScript.Application.StaticAnalysis/Impl/TypeDeclarationsResolver.cs b/src/Application/HydraScript.Application.StaticAnalysis/Impl/TypeDeclarationsResolver.cs
@@ -1,6 +1,6 @@
 using HydraScript.Domain.FrontEnd.Parser.Impl.Ast.Nodes.Declarations;
-using HydraScript.Domain.IR.Impl.SymbolIds;
 using HydraScript.Domain.IR.Impl.Symbols;
+using HydraScript.Domain.IR.Impl.Symbols.Ids;
 
 namespace HydraScript.Application.StaticAnalysis.Impl;
 
@@ -33,7 +33,7 @@ public void Resolve()
             var declarationToResolve = _declarationsToResolve.Dequeue();
 
             var typeSymbol = symbolTables[declarationToResolve.Scope]
-                .FindSymbol<TypeSymbol>(new TypeSymbolId(declarationToResolve.TypeId))!;
+                .FindSymbol(new TypeSymbolId(declarationToResolve.TypeId))!;
 
             var resolvingCandidates = symbolTables[declarationToResolve.Scope]
                 .GetAvailableSymbols()
diff --git a/src/Application/HydraScript.Application.StaticAnalysis/Visitors/DeclarationVisitor.cs b/src/Application/HydraScript.Application.StaticAnalysis/Visitors/DeclarationVisitor.cs
@@ -4,8 +4,8 @@
 using HydraScript.Domain.FrontEnd.Parser.Impl.Ast.Nodes.Declarations.AfterTypesAreLoaded;
 using HydraScript.Domain.FrontEnd.Parser.Impl.Ast.Nodes.Expressions.ComplexLiterals;
 using HydraScript.Domain.FrontEnd.Parser.Impl.Ast.Nodes.Expressions.PrimaryExpressions;
-using HydraScript.Domain.IR.Impl.SymbolIds;
 using HydraScript.Domain.IR.Impl.Symbols;
+using HydraScript.Domain.IR.Impl.Symbols.Ids;
 using HydraScript.Domain.IR.Types;
 
 namespace HydraScript.Application.StaticAnalysis.Visitors;
diff --git a/src/Application/HydraScript.Application.StaticAnalysis/Visitors/SemanticChecker.cs b/src/Application/HydraScript.Application.StaticAnalysis/Visitors/SemanticChecker.cs
@@ -9,8 +9,8 @@
 using HydraScript.Domain.FrontEnd.Parser.Impl.Ast.Nodes.Expressions.ComplexLiterals;
 using HydraScript.Domain.FrontEnd.Parser.Impl.Ast.Nodes.Expressions.PrimaryExpressions;
 using HydraScript.Domain.FrontEnd.Parser.Impl.Ast.Nodes.Statements;
-using HydraScript.Domain.IR.Impl.SymbolIds;
 using HydraScript.Domain.IR.Impl.Symbols;
+using HydraScript.Domain.IR.Impl.Symbols.Ids;
 using HydraScript.Domain.IR.Types;
 
 namespace HydraScript.Application.StaticAnalysis.Visitors;
@@ -138,7 +138,7 @@ public Type Visit(ExpressionStatement visitable) =>
 
     public Type Visit(IdentifierReference visitable)
     {
-        var symbol = _symbolTables[visitable.Scope].FindSymbol<VariableSymbol>(new VariableSymbolId(visitable.Name));
+        var symbol = _symbolTables[visitable.Scope].FindSymbol(new VariableSymbolId(visitable.Name));
         if (symbol is { Initialized: false })
             throw new AccessBeforeInitialization(visitable);
         return symbol?.Type ?? throw new UnknownIdentifierReference(visitable);
@@ -277,9 +277,9 @@ public Type Visit(LexicalDeclaration visitable)
         for (var i = 0; i < visitable.Assignments.Count; i++)
         {
             var assignment = visitable.Assignments[i];
-            var registeredSymbol = _symbolTables[visitable.Scope].FindSymbol<VariableSymbol>(
-                new VariableSymbolId(assignment.Destination.Id))!;
+            var registeredSymbol = _symbolTables[visitable.Scope].FindSymbol(new VariableSymbolId(assignment.Destination.Id))!;
             var sourceType = assignment.Source.Accept(This);
+
             if (sourceType.Equals(undefined))
                 throw new CannotDefineType(assignment.Source.Segment);
             if (sourceType.Equals(@void))
@@ -325,8 +325,7 @@ public Type Visit(AssignmentExpression visitable)
         }
 
         var symbol =
-            _symbolTables[visitable.Scope].FindSymbol<VariableSymbol>(
-                new VariableSymbolId(visitable.Destination.Id)) ??
+            _symbolTables[visitable.Scope].FindSymbol(new VariableSymbolId(visitable.Destination.Id)) ??
             throw new UnknownIdentifierReference(visitable.Destination.Id);
 
         if (symbol.ReadOnly)
@@ -416,7 +415,7 @@ public Type Visit(CallExpression visitable)
         else
         {
             functionSymbol =
-                _symbolTables[visitable.Scope].FindSymbol<FunctionSymbol>(new FunctionSymbolId(visitable.Id, parameters))
+                _symbolTables[visitable.Scope].FindSymbol(new FunctionSymbolId(visitable.Id, parameters))
                 ?? throw new UnknownIdentifierReference(visitable.Id);
         }
 
@@ -454,7 +453,7 @@ public Type Visit(CallExpression visitable)
     public Type Visit(FunctionDeclaration visitable)
     {
         var parameters = visitable.Arguments.Select(x => x.TypeValue.Accept(_typeBuilder)).ToList();
-        var symbol = _symbolTables[visitable.Scope].FindSymbol<FunctionSymbol>(new FunctionSymbolId(visitable.Name, parameters))!;
+        var symbol = _symbolTables[visitable.Scope].FindSymbol(new FunctionSymbolId(visitable.Name, parameters))!;
         _functionStorage.RemoveIfPresent(symbol);
         visitable.Statements.Accept(This);
 
diff --git a/src/Application/HydraScript.Application.StaticAnalysis/Visitors/TypeBuilder.cs b/src/Application/HydraScript.Application.StaticAnalysis/Visitors/TypeBuilder.cs
@@ -1,7 +1,6 @@
 using HydraScript.Application.StaticAnalysis.Exceptions;
 using HydraScript.Domain.FrontEnd.Parser.Impl.Ast.Nodes.Declarations;
-using HydraScript.Domain.IR.Impl.SymbolIds;
-using HydraScript.Domain.IR.Impl.Symbols;
+using HydraScript.Domain.IR.Impl.Symbols.Ids;
 using HydraScript.Domain.IR.Types;
 
 namespace HydraScript.Application.StaticAnalysis.Visitors;
@@ -18,7 +17,7 @@ public TypeBuilder(ISymbolTableStorage symbolTables) =>
         _symbolTables = symbolTables;
 
     public Type Visit(TypeIdentValue visitable) =>
-        _symbolTables[visitable.Scope].FindSymbol<TypeSymbol>(new TypeSymbolId(visitable.TypeId))?.Type ??
+        _symbolTables[visitable.Scope].FindSymbol(new TypeSymbolId(visitable.TypeId))?.Type ??
         throw new UnknownIdentifierReference(visitable.TypeId);
 
     public ArrayType Visit(ArrayTypeValue visitable)
diff --git a/src/Application/HydraScript.Application.StaticAnalysis/Visitors/TypeSystemLoader.cs b/src/Application/HydraScript.Application.StaticAnalysis/Visitors/TypeSystemLoader.cs
@@ -2,8 +2,8 @@
 using HydraScript.Domain.FrontEnd.Parser;
 using HydraScript.Domain.FrontEnd.Parser.Impl.Ast.Nodes;
 using HydraScript.Domain.FrontEnd.Parser.Impl.Ast.Nodes.Declarations;
-using HydraScript.Domain.IR.Impl.SymbolIds;
 using HydraScript.Domain.IR.Impl.Symbols;
+using HydraScript.Domain.IR.Impl.Symbols.Ids;
 
 namespace HydraScript.Application.StaticAnalysis.Visitors;
 
diff --git a/src/Domain/HydraScript.Domain.IR/ISymbol.cs b/src/Domain/HydraScript.Domain.IR/ISymbol.cs
@@ -2,7 +2,7 @@ namespace HydraScript.Domain.IR;
 
 public interface ISymbol
 {
-    public SymbolId Id { get; }
+    public ISymbolId<ISymbol> Id { get; }
     public string Name { get; }
     public Type Type { get; }
 }
diff --git a/src/Domain/HydraScript.Domain.IR/ISymbolId.cs b/src/Domain/HydraScript.Domain.IR/ISymbolId.cs
@@ -0,0 +1,5 @@
+namespace HydraScript.Domain.IR;
+
+// ReSharper disable once UnusedTypeParameter
+public interface ISymbolId<out TSymbol> : IEquatable<ISymbolId<ISymbol>>
+    where TSymbol : class, ISymbol;
diff --git a/src/Domain/HydraScript.Domain.IR/ISymbolTable.cs b/src/Domain/HydraScript.Domain.IR/ISymbolTable.cs
@@ -23,12 +23,12 @@ public interface ISymbolTable
     /// Поиск эффективного символа
     /// </summary>
     /// <param name="id">Идентификатор символа</param>
-    public TSymbol? FindSymbol<TSymbol>(SymbolId id)
+    public TSymbol? FindSymbol<TSymbol>(ISymbolId<TSymbol> id)
         where TSymbol : class, ISymbol;
 
     /// <summary>
     /// Проверка наличия собственного символа
     /// </summary>
     /// <param name="id">Идентификатор символа</param>
-    public bool ContainsSymbol(SymbolId id);
+    public bool ContainsSymbol(ISymbolId<ISymbol> id);
 }
diff --git a/src/Domain/HydraScript.Domain.IR/Impl/SymbolIds/TypeSymbolId.cs b/src/Domain/HydraScript.Domain.IR/Impl/SymbolIds/TypeSymbolId.cs
diff --git a/src/Domain/HydraScript.Domain.IR/Impl/SymbolIds/VariableSymbolId.cs b/src/Domain/HydraScript.Domain.IR/Impl/SymbolIds/VariableSymbolId.cs
diff --git a/src/Domain/HydraScript.Domain.IR/Impl/SymbolTable.cs b/src/Domain/HydraScript.Domain.IR/Impl/SymbolTable.cs
@@ -2,7 +2,7 @@ namespace HydraScript.Domain.IR.Impl;
 
 public class SymbolTable : ISymbolTable
 {
-    private readonly Dictionary<SymbolId, ISymbol> _symbols = [];
+    private readonly Dictionary<ISymbolId<ISymbol>, ISymbol> _symbols = [];
     private ISymbolTable? _openScope;
 
     /// <inheritdoc cref="ISymbolTable.AddOpenScope"/>
@@ -17,16 +17,16 @@ public void AddSymbol(ISymbol symbol) =>
         _symbols[symbol.Id] = symbol;
 
     /// <inheritdoc cref="ISymbolTable.FindSymbol{TSymbol}"/>
-    public TSymbol? FindSymbol<TSymbol>(SymbolId id)
+    public TSymbol? FindSymbol<TSymbol>(ISymbolId<TSymbol> id)
         where TSymbol : class, ISymbol
     {
         var hasInsideTheScope = _symbols.TryGetValue(id, out var symbol);
         return !hasInsideTheScope
-            ? _openScope?.FindSymbol<TSymbol>(id)
+            ? _openScope?.FindSymbol(id)
             : symbol as TSymbol;
     }
 
     /// <inheritdoc cref="ISymbolTable.ContainsSymbol"/>
-    public bool ContainsSymbol(SymbolId id) =>
+    public bool ContainsSymbol(ISymbolId<ISymbol> id) =>
         _symbols.ContainsKey(id);
 }
diff --git a/src/Domain/HydraScript.Domain.IR/Impl/Symbols/FunctionSymbol.cs b/src/Domain/HydraScript.Domain.IR/Impl/Symbols/FunctionSymbol.cs
@@ -1,5 +1,5 @@
 using System.Text;
-using HydraScript.Domain.IR.Impl.SymbolIds;
+using HydraScript.Domain.IR.Impl.Symbols.Ids;
 
 namespace HydraScript.Domain.IR.Impl.Symbols;
 
@@ -25,7 +25,7 @@ public void DefineReturnType(Type returnType) =>
         _returnType = returnType;
 
     public override string ToString() =>
-        new StringBuilder($"function {Id}(")
+        new StringBuilder($"function {Name}(")
             .AppendJoin(',', Parameters)
             .Append($") => {Type}")
             .ToString();
diff --git a/src/Domain/HydraScript.Domain.IR/Impl/Symbols/Ids/FunctionSymbolId.cs b/src/Domain/HydraScript.Domain.IR/Impl/Symbols/Ids/FunctionSymbolId.cs
@@ -1,8 +1,8 @@
-namespace HydraScript.Domain.IR.Impl.SymbolIds;
+namespace HydraScript.Domain.IR.Impl.Symbols.Ids;
 
 public class FunctionSymbolId(
     string name,
-    IEnumerable<Type> parameters) : SymbolId
+    IEnumerable<Type> parameters) : SymbolId<FunctionSymbol>
 {
     protected override string Value { get; } =
         $"function {name}({string.Join(", ", parameters)})";
diff --git a/src/Domain/HydraScript.Domain.IR/Impl/Symbols/Ids/SymbolId.cs b/src/Domain/HydraScript.Domain.IR/Impl/Symbols/Ids/SymbolId.cs
@@ -0,0 +1,21 @@
+namespace HydraScript.Domain.IR.Impl.Symbols.Ids;
+
+public abstract class SymbolId<TSymbol> : ISymbolId<TSymbol>
+    where TSymbol : class, ISymbol
+{
+    protected abstract string Value { get; }
+
+    public bool Equals(ISymbolId<ISymbol>? other) =>
+        Value == other?.ToString();
+
+    public override bool Equals(object? obj)
+    {
+        if (obj is ISymbolId<ISymbol> other)
+            return Equals(other);
+        return false;
+    }
+
+    public override int GetHashCode() => Value.GetHashCode();
+
+    public override string ToString() => Value;
+}
diff --git a/src/Domain/HydraScript.Domain.IR/Impl/Symbols/Ids/TypeSymbolId.cs b/src/Domain/HydraScript.Domain.IR/Impl/Symbols/Ids/TypeSymbolId.cs
@@ -0,0 +1,6 @@
+namespace HydraScript.Domain.IR.Impl.Symbols.Ids;
+
+public class TypeSymbolId(string name) : SymbolId<TypeSymbol>
+{
+    protected override string Value { get; } = "type " + name;
+}
diff --git a/src/Domain/HydraScript.Domain.IR/Impl/Symbols/Ids/VariableSymbolId.cs b/src/Domain/HydraScript.Domain.IR/Impl/Symbols/Ids/VariableSymbolId.cs
@@ -0,0 +1,6 @@
+namespace HydraScript.Domain.IR.Impl.Symbols.Ids;
+
+public class VariableSymbolId(string name) : SymbolId<VariableSymbol>
+{
+    protected override string Value { get; } = "var " + name;
+}
diff --git a/src/Domain/HydraScript.Domain.IR/Impl/Symbols/Symbol.cs b/src/Domain/HydraScript.Domain.IR/Impl/Symbols/Symbol.cs
@@ -2,7 +2,7 @@ namespace HydraScript.Domain.IR.Impl.Symbols;
 
 public abstract class Symbol(string name, Type type) : ISymbol
 {
-    public abstract SymbolId Id { get; }
+    public abstract ISymbolId<ISymbol> Id { get; }
     public string Name { get; } = name;
     public virtual Type Type { get; } = type;
 }
diff --git a/src/Domain/HydraScript.Domain.IR/Impl/Symbols/TypeSymbol.cs b/src/Domain/HydraScript.Domain.IR/Impl/Symbols/TypeSymbol.cs
@@ -1,19 +1,19 @@
-using HydraScript.Domain.IR.Impl.SymbolIds;
+using HydraScript.Domain.IR.Impl.Symbols.Ids;
 
 namespace HydraScript.Domain.IR.Impl.Symbols;
 
 public class TypeSymbol(Type type, string? name = null) :
     Symbol(name ?? type.ToString(), type)
 {
-    public override SymbolId Id { get; } = new TypeSymbolId(name ?? type.ToString());
+    public override TypeSymbolId Id { get; } = new(name ?? type.ToString());
 
     public override bool Equals(object? obj) =>
         obj is TypeSymbol typeSymbol &&
-        Id == typeSymbol.Id && Type.Equals(typeSymbol.Type);
+        Name == typeSymbol.Name && Type.Equals(typeSymbol.Type);
 
     public override int GetHashCode() =>
-        HashCode.Combine(Id, Type);
+        HashCode.Combine(Name, Type);
 
     public override string ToString() =>
-        $"type {Id} = {Type}";
+        $"type {Name} = {Type}";
 }
diff --git a/src/Domain/HydraScript.Domain.IR/Impl/Symbols/VariableSymbol.cs b/src/Domain/HydraScript.Domain.IR/Impl/Symbols/VariableSymbol.cs
@@ -1,4 +1,4 @@
-using HydraScript.Domain.IR.Impl.SymbolIds;
+using HydraScript.Domain.IR.Impl.Symbols.Ids;
 
 namespace HydraScript.Domain.IR.Impl.Symbols;
 
@@ -7,13 +7,13 @@ public class VariableSymbol(
     Type type,
     bool readOnly = false) : Symbol(name, type)
 {
-    public override SymbolId Id { get; } = new VariableSymbolId(name);
+    public override VariableSymbolId Id { get; } = new(name);
 
     public bool ReadOnly { get; } = readOnly;
     public bool Initialized { get; private set; } = readOnly;
 
     public void Initialize() => Initialized = true;
 
     public override string ToString() =>
-        $"{(ReadOnly ? "const " : "")}{Id}: {Type}";
+        $"{(ReadOnly ? "const " : "")}{Name}: {Type}";
 }
diff --git a/src/Domain/HydraScript.Domain.IR/SymbolId.cs b/src/Domain/HydraScript.Domain.IR/SymbolId.cs
diff --git a/src/Domain/HydraScript.Domain.IR/Types/ObjectType.cs b/src/Domain/HydraScript.Domain.IR/Types/ObjectType.cs
@@ -1,5 +1,5 @@
 using System.Text;
-using HydraScript.Domain.IR.Impl.SymbolIds;
+using HydraScript.Domain.IR.Impl.Symbols.Ids;
 
 namespace HydraScript.Domain.IR.Types;
 
diff --git a/tests/HydraScript.UnitTests/Application/SymbolTableTests.cs b/tests/HydraScript.UnitTests/Application/SymbolTableTests.cs
@@ -15,7 +15,7 @@ public void FindSymbolTest(ISymbol symbol)
         outerScope.AddSymbol(symbol);
         innerScope.AddOpenScope(outerScope);
 
-        Assert.NotNull(innerScope.FindSymbol<ISymbol>(id));
+        Assert.NotNull(innerScope.FindSymbol(id));
         Assert.True(outerScope.ContainsSymbol(id));
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ namespace HydraScript.Domain.IR;`
`2`	`2`
`3`	`3`	`public interface ISymbol`
`4`	`4`	`{`
`5`		`- public SymbolId Id { get; }`
	`5`	`+ public ISymbolId<ISymbol> Id { get; }`
`6`	`6`	`public string Name { get; }`
`7`	`7`	`public Type Type { get; }`
`8`	`8`	`}`