Stone_Red/YesNt-Interpreter
1
0
Fork 0
mirror of https://github.com/Stone-Red-Code/YesNt-Interpreter.git synced 2026-09-07 23:43:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

Generate StatementInformation classes with code generator

Browse Source
This commit is contained in:
Stone_Red
2026-06-11 14:47:59 +02:00
parent 5ad0053ef7
commit 1760b85245
8 changed files with 229 additions and 235 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/YesNt.Interpreter/Attributes/StatementAttributeContainer.cs
-109
View File
@@ -1,109 +0,0 @@
using System;
using YesNt.Interpreter.Enums;
namespace YesNt.Interpreter.Attributes;
/// <summary>
/// Marks a method as a YesNt statement handler.
/// The interpreter matches source lines against the <see cref="Name"/> keyword according to
/// <see cref="SearchMode"/> and <see cref="SpaceAround"/> rules, then invokes the decorated method
/// with the remaining argument text.
/// </summary>
/// <remarks>
/// Methods decorated with this attribute must be instance methods on a class that inherits
/// <see cref="Runtime.StatementRuntimeInformation"/> and must accept a single <see cref="string"/> parameter.
/// </remarks>
public class StatementAttributeContainer
{
/// <summary>Gets the keyword that identifies this statement in source code.</summary>
public string Name { get; }
/// <summary>Gets where in the line the keyword is searched for.</summary>
public SearchMode SearchMode { get; }
/// <summary>Gets which sides of the keyword must be padded with a space.</summary>
public SpaceAround SpaceAround { get; }
/// <summary>Gets or sets the syntax-highlight color used by the code editor.</summary>
public ConsoleColor Color { get; set; }
/// <summary>
/// Gets or sets the execution priority. Statements with a lower <see cref="Priority"/> value
/// run before those with a higher value. Defaults to <see cref="Priority.Normal"/>.
/// </summary>
public Priority Priority { get; set; } = Priority.Normal;
/// <summary>
/// Gets or sets a value indicating whether this statement is still invoked while the interpreter
/// is in search mode (scanning for a label or function definition). Defaults to <see langword="false"/>.
/// </summary>
public bool ExecuteInSearchMode { get; set; }
/// <summary>
/// Gets or sets a value indicating whether the full current line (including the keyword itself)
/// is passed as the argument, rather than stripping the keyword prefix/suffix first.
/// Defaults to <see langword="false"/>.
/// </summary>
public bool KeepStatementInArgs { get; set; }
/// <summary>
/// Gets a value indicating whether this statement should be excluded from syntax highlighting.
/// Set to <see langword="true"/> when no <see cref="Color"/> is provided.
/// </summary>
public bool IgnoreSyntaxHighlighting { get; }
/// <summary>
/// Gets or sets an optional sub-string that must also be present in the line for this statement
/// to match. Used to differentiate overloaded keywords (e.g. <c>call</c> vs <c>call … with …</c>).
/// </summary>
public string Separator { get; set; }
/// <summary>
/// Gets or sets the name of the statement that marks the end of this block.
/// Used for block boundary caching (e.g., "while" has BlockPair = "end_while").
/// </summary>
public string BlockPair { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this statement is the end of a block.
/// Used for block boundary caching (e.g., "end_while" has IsBlockEnd = true).
/// </summary>
public bool IsBlockEnd { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this statement is an intermediate part of a block
/// (e.g., "else:" between "if" and "end_if").
/// </summary>
public bool IsBlockIntermediate { get; set; }
/// <summary>
/// Initializes a new <see cref="StatementAttribute"/> with a syntax-highlight color.
/// </summary>
/// <param name="name">The keyword that identifies this statement.</param>
/// <param name="searchMode">Where in the line the keyword is matched.</param>
/// <param name="spaceAround">Which sides of the keyword require a surrounding space.</param>
/// <param name="color">The color used for syntax highlighting in the code editor.</param>
public StatementAttributeContainer(string name, SearchMode searchMode, SpaceAround spaceAround, ConsoleColor color)
{
Name = name;
SearchMode = searchMode;
SpaceAround = spaceAround;
Color = color;
}
/// <summary>
/// Initializes a new <see cref="StatementAttribute"/> without a syntax-highlight color.
/// The statement will be excluded from syntax highlighting.
/// </summary>
/// <param name="name">The keyword that identifies this statement.</param>
/// <param name="searchMode">Where in the line the keyword is matched.</param>
/// <param name="spaceAround">Which sides of the keyword require a surrounding space.</param>
public StatementAttributeContainer(string name, SearchMode searchMode, SpaceAround spaceAround)
{
Name = name;
SearchMode = searchMode;
SpaceAround = spaceAround;
IgnoreSyntaxHighlighting = true;
}
}
src/YesNt.Interpreter/Attributes/StaticStatementAttributeContainer.cs
-28
View File
@@ -1,28 +0,0 @@
using YesNt.Interpreter.Enums;
namespace YesNt.Interpreter.Attributes;
/// <summary>
/// Marks a parameterless method as a YesNt static statement handler.
/// Static statements are invoked once per line before regular statement matching begins,
/// regardless of whether the line matches any keyword. They are typically used for
/// pre-processing tasks such as transforming the current line before other statements run.
/// </summary>
/// <remarks>
/// Methods decorated with this attribute must be instance methods on a class that inherits
/// <see cref="Runtime.StatementRuntimeInformation"/> and must have no parameters.
/// </remarks>
public class StaticStatementAttributeContainer
{
/// <summary>
/// Gets or sets a value indicating whether this handler is still invoked while the interpreter
/// is in search mode (scanning for a label or function definition). Defaults to <see langword="false"/>.
/// </summary>
public bool ExecuteInSearchMode { get; set; }
/// <summary>
/// Gets or sets the execution priority relative to other static statements.
/// Defaults to <see cref="Priority.Normal"/>.
/// </summary>
public Priority Priority { get; set; } = Priority.Normal;
}
src/YesNt.Interpreter/Runtime/IStatementContext.cs
+5 -5
View File
@@ -4,7 +4,7 @@ namespace YesNt.Interpreter.Runtime;
/// <summary>
/// Exposes the script runtime state accessible to custom statement handlers registered
/// via <see cref="YesNtInterpreter.AddStatement"/>.
/// via <see cref="YesNtInterpreter.AddStatement(YesNt.Interpreter.Runtime.StatementInformation, System.Action{string, YesNt.Interpreter.Runtime.IStatementContext})"/>.
/// </summary>
public interface IStatementContext
{
@@ -24,9 +24,9 @@ public interface IStatementContext
/// <summary>Terminates execution with the given message.</summary>
/// <param name="message">The message written to debug output.</param>
/// <param name="isError">
/// <see langword="true"/> to signal an error termination;
/// <see langword="false"/> for a planned, non-error termination.
/// <param name="stopAllTasks">
/// If <see langword="true"/>, also terminates all tasks spawned by the <c>task</c> statement.
/// If <see langword="false"/>, only terminates the current execution context (main script or individual task).
/// </param>
void Exit(string message, bool isError);
void Exit(string message, bool stopAllTasks);
}
src/YesNt.Interpreter/Runtime/StatementHandler.cs
+1 -3
View File
@@ -1,10 +1,8 @@
using System;
using YesNt.Interpreter.Attributes;
namespace YesNt.Interpreter.Runtime;
/// <summary>
/// Pre-calculated statement handler information for faster matching.
/// </summary>
internal record StatementHandler(StatementAttributeContainer Attribute, Action<string> Handler, string FullName);
internal record StatementHandler(StatementInformation Attribute, Action<string> Handler, string FullName);
src/YesNt.Interpreter/Runtime/StatementInformation.cs
-35
View File
@@ -1,35 +0,0 @@
using System;
using YesNt.Interpreter.Enums;
namespace YesNt.Interpreter.Runtime;
/// <summary>
/// A read-only snapshot of a registered statement's metadata, used for tooling such as
/// syntax highlighters. Instances are obtained from <see cref="YesNtInterpreter.StatementInformation"/>.
/// </summary>
public class StatementInformation
{
/// <summary>Gets the keyword that identifies this statement in source code.</summary>
public string Name { get; internal set; }
/// <summary>Gets where in the line the keyword is searched for.</summary>
public SearchMode SearchMode { get; internal set; }
/// <summary>Gets which sides of the keyword must be padded with a space.</summary>
public SpaceAround SpaceAround { get; internal set; }
/// <summary>Gets the syntax-highlight color for this statement.</summary>
public ConsoleColor Color { get; internal set; }
/// <summary>
/// Gets a value indicating whether this statement is excluded from syntax highlighting.
/// </summary>
public bool IgnoreSyntaxHighlighting { get; internal set; }
/// <summary>
/// Gets the optional sub-string that must be present in the line for this statement to match,
/// or <see langword="null"/> if no separator is required.
/// </summary>
public string Separator { get; set; }
}
src/YesNt.Interpreter/Runtime/YesNtInterpreter.cs
+22 -41
View File
@@ -29,36 +29,17 @@ public class YesNtInterpreter
public event Action<string> OnDebugOutput;
private readonly RuntimeInformation runtimeInfo = new RuntimeInformation();
private Dictionary<StatementAttributeContainer, Action<string>> statements;
private Dictionary<StatementInformation, Action<string>> statements;
private List<StatementHandler> statementHandlers;
private List<List<StatementHandler>> lineMatchingHandlers = [];
private readonly List<KeyValuePair<StaticStatementAttributeContainer, Action>> staticStatements;
private readonly Dictionary<string, List<KeyValuePair<StatementAttributeContainer, Action<string>>>> disabledStatements = [];
private readonly List<KeyValuePair<StaticStatementInformation, Action>> staticStatements;
private readonly Dictionary<string, List<KeyValuePair<StatementInformation, Action<string>>>> disabledStatements = [];
/// <summary>
/// Gets a read-only snapshot of all currently registered statements.
/// Useful for building syntax highlighters or documentation tools.
/// </summary>
public ReadOnlyCollection<StatementInformation> StatementInformation
{
get
{
List<StatementInformation> information = statements.Select(s =>
{
return new StatementInformation()
{
Name = s.Key.Name,
SearchMode = s.Key.SearchMode,
SpaceAround = s.Key.SpaceAround,
Color = s.Key.Color,
IgnoreSyntaxHighlighting = s.Key.IgnoreSyntaxHighlighting,
Separator = s.Key.Separator
};
}).ToList();
return new ReadOnlyCollection<StatementInformation>(information);
}
}
public ReadOnlyCollection<StatementInformation> StatementInformation => statements.Keys.ToList().AsReadOnly();
/// <summary>
/// <see langword="true"/> from the moment <see cref="Prepare(string, bool)"/> (or any
@@ -96,7 +77,7 @@ public class YesNtInterpreter
}
/// <summary>
/// Registers a custom statement using a pre-built <see cref="StatementAttributeContainer"/>.
/// Registers a custom statement using a pre-built <see cref="StatementInformation"/>.
/// If a statement with the same attribute key (identical field values) already exists it will be replaced;
/// otherwise a new entry is added. Built-in statements use distinct attribute instances, so passing a
/// newly constructed attribute with the same name will <b>add</b> a second handler rather than replacing
@@ -106,13 +87,13 @@ public class YesNtInterpreter
/// <param name="attribute">The attribute describing the keyword, search mode, and priority.</param>
/// <param name="handler">
/// The delegate invoked when the statement matches. Receives the argument text
/// (the part of the line after the keyword, unless <see cref="StatementAttributeContainer.KeepStatementInArgs"/> is set).
/// (the part of the line after the keyword, unless <see cref="StatementInformation.KeepStatementInArgs"/> is set).
/// </param>
public void AddStatement(StatementAttributeContainer attribute, Action<string> handler)
public void AddStatement(StatementInformation attribute, Action<string> handler)
{
statements[attribute] = handler;
List<KeyValuePair<StatementAttributeContainer, Action<string>>> entries = [.. statements];
List<KeyValuePair<StatementInformation, Action<string>>> entries = [.. statements];
entries.Sort((a, b) =>
{
int cmp = a.Key.Priority.CompareTo(b.Key.Priority);
@@ -121,7 +102,7 @@ public class YesNtInterpreter
statements = [];
foreach (KeyValuePair<StatementAttributeContainer, Action<string>> entry in entries)
foreach (KeyValuePair<StatementInformation, Action<string>> entry in entries)
{
statements.Add(entry.Key, entry.Value);
}
@@ -139,7 +120,7 @@ public class YesNtInterpreter
/// The delegate invoked when the statement matches. Receives the argument text and the current
/// <see cref="IStatementContext"/> for reading/writing script state.
/// </param>
public void AddStatement(StatementAttributeContainer attribute, Action<string, IStatementContext> handler)
public void AddStatement(StatementInformation attribute, Action<string, IStatementContext> handler)
{
AddStatement(attribute, args => handler(args, runtimeInfo));
}
@@ -153,7 +134,7 @@ public class YesNtInterpreter
/// <param name="handler">The delegate invoked when the statement matches.</param>
public void AddStatement(string name, SearchMode searchMode, SpaceAround spaceAround, Action<string> handler)
{
AddStatement(new StatementAttributeContainer(name, searchMode, spaceAround), handler);
AddStatement(new StatementInformation(name, searchMode, spaceAround), handler);
}
/// <summary>
@@ -169,7 +150,7 @@ public class YesNtInterpreter
/// </param>
public void AddStatement(string name, SearchMode searchMode, SpaceAround spaceAround, Action<string, IStatementContext> handler)
{
AddStatement(new StatementAttributeContainer(name, searchMode, spaceAround), handler);
AddStatement(new StatementInformation(name, searchMode, spaceAround), handler);
}
/// <summary>
@@ -182,7 +163,7 @@ public class YesNtInterpreter
/// <param name="handler">The delegate invoked when the statement matches.</param>
public void AddStatement(string name, SearchMode searchMode, SpaceAround spaceAround, ConsoleColor consoleColor, Action<string> handler)
{
AddStatement(new StatementAttributeContainer(name, searchMode, spaceAround, consoleColor), handler);
AddStatement(new StatementInformation(name, searchMode, spaceAround, consoleColor), handler);
}
/// <summary>
@@ -199,7 +180,7 @@ public class YesNtInterpreter
/// </param>
public void AddStatement(string name, SearchMode searchMode, SpaceAround spaceAround, ConsoleColor consoleColor, Action<string, IStatementContext> handler)
{
AddStatement(new StatementAttributeContainer(name, searchMode, spaceAround, consoleColor), handler);
AddStatement(new StatementInformation(name, searchMode, spaceAround, consoleColor), handler);
}
/// <summary>
@@ -208,7 +189,7 @@ public class YesNtInterpreter
/// <param name="name">The keyword to remove.</param>
public void RemoveStatement(string name)
{
foreach (StatementAttributeContainer key in statements.Keys.Where(k => k.Name == name).ToList())
foreach (StatementInformation key in statements.Keys.Where(k => k.Name == name).ToList())
{
_ = statements.Remove(key);
}
@@ -231,7 +212,7 @@ public class YesNtInterpreter
return;
}
List<KeyValuePair<StatementAttributeContainer, Action<string>>> matching =
List<KeyValuePair<StatementInformation, Action<string>>> matching =
statements.Where(kv => kv.Key.Name == name).ToList();
if (matching.Count == 0)
@@ -241,7 +222,7 @@ public class YesNtInterpreter
disabledStatements[name] = matching;
foreach (KeyValuePair<StatementAttributeContainer, Action<string>> kv in matching)
foreach (KeyValuePair<StatementInformation, Action<string>> kv in matching)
{
statements[kv.Key] = _ => { };
}
@@ -257,12 +238,12 @@ public class YesNtInterpreter
/// <param name="name">The keyword of the statement(s) to re-enable.</param>
public void EnableStatement(string name)
{
if (!disabledStatements.TryGetValue(name, out List<KeyValuePair<StatementAttributeContainer, Action<string>>> saved))
if (!disabledStatements.TryGetValue(name, out List<KeyValuePair<StatementInformation, Action<string>>> saved))
{
return;
}
foreach (KeyValuePair<StatementAttributeContainer, Action<string>> kv in saved)
foreach (KeyValuePair<StatementInformation, Action<string>> kv in saved)
{
statements[kv.Key] = kv.Value;
}
@@ -479,7 +460,7 @@ public class YesNtInterpreter
};
}
foreach (KeyValuePair<StaticStatementAttributeContainer, Action> staticStatement in staticStatements)
foreach (KeyValuePair<StaticStatementInformation, Action> staticStatement in staticStatements)
{
if (!staticStatement.Key.ExecuteInSearchMode && runtimeInfo.IsSearching)
{
@@ -498,7 +479,7 @@ public class YesNtInterpreter
foreach (StatementHandler handler in handlers)
{
StatementAttributeContainer statementAttribute = handler.Attribute;
StatementInformation statementAttribute = handler.Attribute;
if (!statementAttribute.ExecuteInSearchMode && runtimeInfo.IsSearching)
{
@@ -681,7 +662,7 @@ public class YesNtInterpreter
private static bool IsPossibleMatch(string content, StatementHandler handler)
{
StatementAttributeContainer attr = handler.Attribute;
StatementInformation attr = handler.Attribute;
string fullName = handler.FullName;
return attr.SearchMode switch