Upgraded to use Scanners v1.1.0 with configurable comments.

Author: promicsw

Docs/FexScannerExt.md

@@ -6,17 +6,32 @@ to add Op(operators) and other methods bound to FexScanner (i.e. the Context).
 
 > **Note:** Several methods record the scanned text in Token (of the underlying scanner)
 > and can be accessed via:
-> - ActToken / ActTrimToken / ActStripToken / ActTrimStripToken.
-> - Act(c => c.Token...).
+> - `ActToken / ActTrimToken / ActStripToken / ActTrimStripToken`.
+> - `Act(c => c.Token...)`.
 
 Basic extension example:
 ```csharp
 public static FexBuilder<T> Ch<T>(this FexBuilder<T> exp, char ch) where T : FexScanner 
     => exp.Op(o => o.IsCh(ch)); // IsCh is a FexScanner method
 ```
-<br/>
-
-**Extensions Reference:**
+---
+### Comments:
+FexScanner can skip line and block comments via `SkipWSC`:
+- Default line comment starts with `//`.
+- Default block comment `/* ... */`.
+- These comments can be configured (or switched off) via the `FexScanner.ConfigComments(...)` method.
+```csharp
+// Set comment configuration:
+// - For block comments Start and End must both be valid to enable block comments. 
+//
+// lineComment:       Line comment (null/empty for none).
+// blockCommentStart: Block comment start (null/empty for none).
+// blockCommentEnd:   Block comment end (null/empty for none).
+// Returns: FexScanner for fluent chaining.
+public FexScanner ConfigComment(string lineComment = "//", string blockCommentStart = "/*", string blockCommentEnd = "*/")
+```
+---
+### Extensions Reference:
 
 | Extensions | Description |
 | :---- | :------ |
@@ -75,7 +90,7 @@ public static FexBuilder<T> Ch<T>(this FexBuilder<T> exp, char ch) where T : Fex
 | ***Whitespace and Comment Skipping:*** |  |
 | ``E:  OptSp(string spaceChars = " \t")`` | Optionally skip given space characters (default = " \t") - creates optional (Opt) Op.<br/> |
 | ``E:  SkipWS(string wsChars = " \r\n\t", bool opt = false)`` | Skip given White Space characters (default: " \r\n\t").<br/><br/>**Parameters:**<br/><code>opt:</code> Make the Op optional or not.<br/><br/>**Returns:**<br/>True if not at Eos after skipping or opt == true else False. |
-| ``E:  SkipWSC(bool termNL = false, string spaceChars = " \t", bool opt = false)`` | Skip given space characters (default = " \t"), newlines (if termNL = false) and comments //... or /\*..\*/ (handles nested comments):<br/>- White space: spaceChars + "\r\n" if termNL is false.<br/>- Set termNL to position Index at the next newline not inside a block comment (/\*..\*/), else the newlines are also skipped.<br/><br/>**Parameters:**<br/><code>opt:</code> Make the Op optional or not.<br/><br/>**Returns:**<br/>True: Whitespace and comments skipped and Index directly after, or no comment error and opt == true.<br/>  False: Eos or comment error (bad comment error is Logged. Use IsScanError() to check) - Index unchanged. |
+| ``E:  SkipWSC(bool termNL = false, string spaceChars = " \t", bool opt = false)`` | Skip White Space and comments:<br/>- White space: spaceChars + "\r\n" if termNL is false.<br/>- Block comments handle nesting and comments embedded in delimited strings.<br/>- Set termNL to true to stop at a newline, including the newline at the end of a line comment.<br/><br/>**Parameters:**<br/><code>termNL:</code> True to stop at a newline, including the newline at the end of a line comment.<br/><code>spaceChars:</code> Characters to regard as white-space (default: " \t").<br/><code>opt:</code> Make the Op optional or not.<br/><br/>**Returns:**<br/>True: Whitespace and comments skipped and Index directly after, or no comment error and opt == true.<br/>  False: Eos or comment error (bad comment error is Logged. Use IsScanError() to check) - Index unchanged. |
 | ``E:  Sp(string spaceChars = " \t")`` | Skip given space characters (default = " \t").<br/><br/>**Returns:**<br/>True if not at Eos after skipping else False. |
 | ***Error Messages:*** |  |
 | ``E:  OnFail(string errorMsg, string errorSource = "Parse error")`` | For convenience, bind OnFail to ErrorLog.<br/> |

FexSampleSet/Program.cs

@@ -364,20 +364,28 @@ void ExpressionREPL() {
 
     Stack<double> numStack = new Stack<double>();
 
+    void OpPush(Func<double, double, double> op) 
+        => numStack.Push(op(numStack.Pop(), numStack.Pop()));
+
     var expr = fex.Seq(s => s
         .Ref("factor")
         .RepOneOf(0, -1, r => r
-            .Seq(s => s.Ch('+').Ref("factor").Act(c => numStack.Push(numStack.Pop() + numStack.Pop())))
-            .Seq(s => s.Ch('-').Ref("factor").Act(c => numStack.Push(-numStack.Pop() + numStack.Pop())))
+            //.Seq(s => s.Ch('+').Ref("factor").Act(c => numStack.Push(numStack.Pop() + numStack.Pop())))
+            .Seq(s => s.Ch('+').Ref("factor").Act(c => OpPush((s0, s1) => s0 + s1)))
+            //.Seq(s => s.Ch('-').Ref("factor").Act(c => numStack.Push(-numStack.Pop() + numStack.Pop())))
+            .Seq(s => s.Ch('-').Ref("factor").Act(c => OpPush((s0, s1) => s1 - s0)))
          ));
 
     var factor = fex.Seq(s => s.RefName("factor")
         .Ref("unary")
         .RepOneOf(0, -1, r => r
-            .Seq(s => s.Ch('*').Ref("unary").Act(c => numStack.Push(numStack.Pop() * numStack.Pop())))
+            //.Seq(s => s.Ch('*').Ref("unary").Act(c => numStack.Push(numStack.Pop() * numStack.Pop())))
+            .Seq(s => s.Ch('*').Ref("unary").Act(c => OpPush((s0, s1) => s0 * s1)))
+            .Seq(s => s.Ch('^').Ref("unary").Act(c => OpPush((s0, s1) => Math.Pow(s1, s0))))
             .Seq(s => s.Ch('/').Ref("unary")
                        .Op(c => numStack.Peek() != 0).OnFail("Division by 0") // Trap division by 0
-                       .Act(c => numStack.Push(1 / numStack.Pop() * numStack.Pop())))
+                       //.Act(c => numStack.Push(1 / numStack.Pop() * numStack.Pop())))
+                       .Act(c => OpPush((s0, s1) => s1 / s0)))
          ));
 
     var unary = fex.Seq(s => s.RefName("unary")
@@ -389,8 +397,9 @@ void ExpressionREPL() {
     var primary = fex.Seq(s => s.RefName("primary")
         .OneOf(o => o
             .Seq(e => e.Ch('(').Fex(expr).Ch(')').OnFail(") expected"))
-            .Seq(s => s.NumDecimal(n => numStack.Push(n)))
+            .Seq(s => s.IsString("pi").Act(c => numStack.Push(Math.PI)))  // Pi
             .Seq(s => s.Ch('a').Act(c => numStack.Push(ans)))  // a is previous answer
+            .Seq(s => s.NumDecimal(n => numStack.Push(n)))
          ).OnFail("Primary expected"));
 
     var exprEval = fex.Seq(s => s.GlobalPreOp(c => c.SkipSp()).Fex(expr).IsEos().OnFail("invalid expression"));

Psw.FlowExpressions/FexScanner.cs

@@ -15,5 +15,18 @@ namespace Psw.FlowExpressions
     public class FexScanner : ScriptScanner
     {
         public FexScanner(string source = "", ScanErrorLog errorLog = null) : base(source, errorLog) { }
+
+        /// <summary>
+        /// Set comment configuration:<br/>
+        /// - For block comments Start and End must both be valid to enable block comments. 
+        /// </summary>
+        /// <param name="lineComment">Line comment (null/empty for none).</param>
+        /// <param name="blockCommentStart">Block comment start (null/empty for none).</param>
+        /// <param name="blockCommentEnd">Block comment end (null/empty for none).</param>
+        /// <returns>FexScanner for fluent chaining.</returns>
+        public FexScanner ConfigComment(string lineComment = "//", string blockCommentStart = "/*", string blockCommentEnd = "*/") {
+            SetScriptComment(lineComment, blockCommentStart, blockCommentEnd);
+            return this; ;
+        }
     }
 }

Psw.FlowExpressions/FexScannerExt.cs

@@ -17,17 +17,32 @@ namespace Psw.FlowExpressions
     /// 
     /// > **Note:** Several methods record the scanned text in Token (of the underlying scanner)
     /// > and can be accessed via:
-    /// > - ActToken / ActTrimToken / ActStripToken / ActTrimStripToken.
-    /// > - Act(c => c.Token...).
+    /// > - `ActToken / ActTrimToken / ActStripToken / ActTrimStripToken`.
+    /// > - `Act(c => c.Token...)`.
     /// 
     /// Basic extension example:
     /// ```csharp
     /// public static FexBuilder<T> Ch<T>(this FexBuilder<T> exp, char ch) where T : FexScanner 
     ///     => exp.Op(o => o.IsCh(ch)); // IsCh is a FexScanner method
     /// ```
-    /// <br/>
-    /// 
-    /// **Extensions Reference:**
+    /// ---
+    /// ### Comments:
+    /// FexScanner can skip line and block comments via `SkipWSC`:
+    /// - Default line comment starts with `//`.
+    /// - Default block comment `/* ... */`.
+    /// - These comments can be configured (or switched off) via the `FexScanner.ConfigComments(...)` method.
+    /// ```csharp
+    /// // Set comment configuration:
+    /// // - For block comments Start and End must both be valid to enable block comments. 
+    /// //
+    /// // lineComment:       Line comment (null/empty for none).
+    /// // blockCommentStart: Block comment start (null/empty for none).
+    /// // blockCommentEnd:   Block comment end (null/empty for none).
+    /// // Returns: FexScanner for fluent chaining.
+    /// public FexScanner ConfigComment(string lineComment = "//", string blockCommentStart = "/*", string blockCommentEnd = "*/")
+    /// ```
+    /// ---
+    /// ### Extensions Reference:
     /// </mdoc>
     public static class FexScannerExt
     {
@@ -505,10 +520,13 @@ public static FexBuilder<T> SkipWS<T>(this FexBuilder<T> exp, string wsChars = "
             => exp.Op(c => c.SkipWS(wsChars) || opt);
 
         /// <summary>
-        /// Skip given space characters (default = " \t"), newlines (if termNL = false) and comments //... or /*..*/ (handles nested comments):<br/>
+        /// Skip White Space and comments:<br/>
         /// - White space: spaceChars + "\r\n" if termNL is false.<br/>
-        /// - Set termNL to position Index at the next newline not inside a block comment (/*..*/), else the newlines are also skipped.
+        /// - Block comments handle nesting and comments embedded in delimited strings.<br/>
+        /// - Set termNL to true to stop at a newline, including the newline at the end of a line comment.
         /// </summary>
+        /// <param name="termNL">True to stop at a newline, including the newline at the end of a line comment.</param>
+        /// <param name="spaceChars">Characters to regard as white-space (default: " \t").</param>
         /// <param name="opt">Make the Op optional or not.</param>
         /// <returns>
         ///   True: Whitespace and comments skipped and Index directly after, or no comment error and opt == true.<br/>

Psw.FlowExpressions/Psw.FlowExpressions.csproj

@@ -13,13 +13,13 @@
     <PackageProjectUrl>https://github.com/promicsw/flow-expressions</PackageProjectUrl>
     <RepositoryUrl>https://github.com/promicsw/flow-expressions</RepositoryUrl>
     <PackageTags>parser;parser-builder;flow-logic;c#;flow-expression;</PackageTags>
-    <PackageReleaseNotes>Skip feature added for common skipping actions during parsing.</PackageReleaseNotes>
+    <PackageReleaseNotes>Upgraded to use Scanners v1.1.0 which has configurable comments.</PackageReleaseNotes>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
     <PackageReadmeFile>Nuget.md</PackageReadmeFile>
     <PackageOutputPath>d:\PromicSW_GitHub\LocalNuget\</PackageOutputPath>
     <PackageIcon>PswLogo.png</PackageIcon>
-    <Version>1.0.1</Version>
+    <Version>1.0.2</Version>
   </PropertyGroup>
 
   <ItemGroup>
@@ -38,7 +38,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Psw.Scanners" Version="1.0.3" />
+    <PackageReference Include="Psw.Scanners" Version="1.1.0" />
   </ItemGroup>
 
 </Project>