Release v1.1.4 (#65)

* [FEATURE]: Add Support for IEnumerable Yield (#62)

* Add Support for IEnumerable Yield (#62)
  * Added new YieldStateMachineBuilder to handle IEnumerable
  * Refactored lowering into subclasses
  * Refactored StateMachineContext
* Initial document and tests for enumerable For, Foreach, While

---------

Co-authored-by: Matt Edwards <[email protected]>

Author: MattEdwardsWaggleBee

README.md

@@ -9,6 +9,10 @@ trees to handle asynchronous workflows and other language constructs.
     * `AwaitExpression`: An expression that represents an await operation.
     * `AsyncBlockExpression`: An expression that represents an asynchronous code block.
 
+* **Yield Expressions**
+    * `YieldExpression`: An expression that represents a yield return or break statement.
+    * `EnumerableBlockExpression`: An expression that represents an enumerable code block.
+
 * **Using Expression**
     * `UsingExpression`: An expression that automatically disposes IDisposable resources.
 
@@ -81,6 +85,41 @@ public class Example
 }
 ```
 
+### Yield Expressions
+
+The following example demonstrates how to create a yield expression tree.
+
+When the expression tree is compiled, the `EnumerableBlockExpression` will auto-generate a state machine that executes
+`YieldExpressions` in the block.
+
+```csharp
+public class Example
+{
+    public void ExampleYield()
+    {
+        // Create an enumerable block that yields values
+        var index = Variable( typeof(int), "index" );
+
+        var enumerableBlock = BlockEnumerable(
+            [index],
+            For( Assign( index, Constant( 0 ) ), LessThan( index, Constant( 10 ) ), PostIncrementAssign( index ),
+                Yield( index )
+            )
+        );
+
+        // Compile and execute the enumerable block
+        var lambda = Lambda<Func<IEnumerable<int>>>( enumerableBlock );
+        var compiledLambda = lambda.Compile();
+        var enumerable = compiledLambda();
+
+        foreach( var value in enumerable )
+        {
+            Console.WriteLine( $"Yielded value: {value}" );
+        }
+    }
+}
+```
+
 ### Using Expression
 
 The following example demonstrates how to create a Using expression.

docs/docs.projitems

@@ -9,10 +9,6 @@
     <Import_RootNamespace>docs</Import_RootNamespace>
   </PropertyGroup>
   <ItemGroup>
-    <None Include="$(MSBuildThisFileDirectory)state-machine\overview.md" />
-    <None Include="$(MSBuildThisFileDirectory)state-machine\state-machine-builder.md" />
-    <None Include="$(MSBuildThisFileDirectory)state-machine\lowering-visitor.md" />
-    <None Include="$(MSBuildThisFileDirectory)state-machine\state-machine.md" />
     <None Include="$(MSBuildThisFileDirectory)index.md" />
     <None Include="$(MSBuildThisFileDirectory).todo.md" />
     <None Include="$(MSBuildThisFileDirectory)_config.yml" />

docs/index.md

@@ -14,6 +14,10 @@ trees to handle asynchronous workflows and other language constructs.
     * `AwaitExpression`: An expression that represents an await operation.
     * `AsyncBlockExpression`: An expression that represents an asynchronous code block.
 
+* **Yield Expressions**
+    * `YieldExpression`: An expression that represents a yield return or break statement.
+    * `EnumerableBlockExpression`: An expression that represents an enumerable code block.
+
 * **Using Expression**
     * `UsingExpression`: An expression that automatically disposes IDisposable resources.
 
@@ -86,6 +90,41 @@ public class Example
 }
 ```
 
+### Yield Expressions
+
+The following example demonstrates how to create a yield expression tree.
+
+When the expression tree is compiled, the `EnumerableBlockExpression` will auto-generate a state machine that executes
+`YieldExpressions` in the block.
+
+```csharp
+public class Example
+{
+    public void ExampleYield()
+    {
+        // Create an enumerable block that yields values
+        var index = Variable( typeof(int), "index" );
+
+        var enumerableBlock = BlockEnumerable(
+            [index],
+            For( Assign( index, Constant( 0 ) ), LessThan( index, Constant( 10 ) ), PostIncrementAssign( index ),
+                Yield( index )
+            )
+        );
+
+        // Compile and execute the enumerable block
+        var lambda = Lambda<Func<IEnumerable<int>>>( enumerableBlock );
+        var compiledLambda = lambda.Compile();
+        var enumerable = compiledLambda();
+
+        foreach( var value in enumerable )
+        {
+            Console.WriteLine( $"Yielded value: {value}" );
+        }
+    }
+}
+```
+
 ### Using Expression
 
 The following example demonstrates how to create a Using expression.