Merge pull request #148 from StartAutomating/IrregularANSIFix

Irregular ansi fix
StartAutomating · Sep 29, 2022 · 41c3c12 · 41c3c12
2 parents aa63deb + 1161c31
commit 41c3c12
Show file tree

Hide file tree

Showing 20 changed files with 193 additions and 84 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,12 @@
-## 0.7.2:
+## 0.7.3:
+* ANSI Improvements:
+  * Fixed ?<ANSI_Style> (Fixes #143)
+  * ?<ANSI_4BitColor> now supports bright ranges (Fixes #145)
+  * ?<ANSI_8BitColor>/?<ANSI_24BitColor> now supports background colors (Fixes #144)
+  * ?<ANSI_8BitColor>/?<ANSI_24BitColor> now supports underline colors (Fixes #146)
+---
+
+## 0.7.2:
 * Lots More ANSI support:
   * ?<ANSI_Bold> (Fixes #131)
   * ?<ANSI_Blink> (Fixes #132)

diff --git a/Irregular.format.ps1xml b/Irregular.format.ps1xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-16"?>
-<!-- Generated with EZOut 1.9.3: Install-Module EZOut or https://github.com/StartAutomating/EZOut -->
+<!-- Generated with EZOut 1.9.4: Install-Module EZOut or https://github.com/StartAutomating/EZOut -->
 <Configuration>
   <ViewDefinitions>
     <View>

diff --git a/Irregular.psd1 b/Irregular.psd1
@@ -1,5 +1,5 @@
 @{
-    ModuleVersion = '0.7.2'
+    ModuleVersion = '0.7.3'
     RootModule = 'Irregular.psm1'
     Description = 'Regular Expressions made Strangely Simple'
     FormatsToProcess = 'Irregular.format.ps1xml'
@@ -14,6 +14,14 @@
             LicenseURI = 'https://github.com/StartAutomating/Irregular/blob/master/LICENSE'
             IconURI    = 'https://github.com/StartAutomating/Irregular/blob/master/Assets/Irregular_600_Square.png'        
             ReleaseNotes = @'
+## 0.7.3:
+* ANSI Improvements:
+  * Fixed ?<ANSI_Style> (Fixes #143)
+  * ?<ANSI_4BitColor> now supports bright ranges (Fixes #145)
+  * ?<ANSI_8BitColor>/?<ANSI_24BitColor> now supports background colors (Fixes #144)
+  * ?<ANSI_8BitColor>/?<ANSI_24BitColor> now supports underline colors (Fixes #146)
+---
+
 ## 0.7.2:
 * Lots More ANSI support:
   * ?<ANSI_Bold> (Fixes #131)

diff --git a/Irregular.types.ps1xml b/Irregular.types.ps1xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-16"?>
-<!-- Generated with EZOut 1.9.3: Install-Module EZOut or https://github.com/StartAutomating/EZOut -->
+<!-- Generated with EZOut 1.9.4: Install-Module EZOut or https://github.com/StartAutomating/EZOut -->
 <Types>
   <Type>
     <Name>Irregular.Match.Extract</Name>

diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 <h2>Regular Expressions made Strangely Simple</h2>
 <h3>A PowerShell module that helps you understand, use, and build Regular Expressions.</h3>
 <h4>
-<a href='https://github.com/StartAutomating/Irregular/releases/tag/v0.7.2'>v 0.7.2 </a>
+<a href='https://github.com/StartAutomating/Irregular/releases/tag/v0.7.3'>v 0.7.3 </a>
 </h4>
 <a href='https://www.powershellgallery.com/packages/Irregular/'>
 <img src='https://img.shields.io/powershellgallery/dt/Irregular' />
@@ -32,7 +32,7 @@ Once you understand some basics of that syntax, regular expressions become a lot
 3. A Regex can have comments! ( # Like this in .NET  ( or like (?#this comment) in ECMAScript ) ).
 4. You don't have to do it all in one expression! 
 
-Irregular comes with 128 useful [named expressions](SavedPatterns.md), and lets you create more.
+Irregular comes with 130 useful [named expressions](SavedPatterns.md), and lets you create more.
 
 To see the expressions that ship with Irregular, run:
 

diff --git a/RegEx/ANSI/24BitColor.regex.source.ps1 b/RegEx/ANSI/24BitColor.regex.source.ps1
@@ -4,11 +4,16 @@ $myRoot = $MyInvocation.MyCommand.ScriptBlock.File | Split-Path
 New-RegEx -Description "Matches an ANSI 24-bit color" -Modifier IgnoreCase -Not |
     New-RegEx -CharacterClass Escape -Comment 'An Escape' |
     New-RegEx -LiteralCharacter '[' -Comment 'Followed by a bracket' |
-    New-RegEx -Pattern '38;2;' |
+    New-RegEx -Atomic -Or @(
+        New-RegEx -Pattern '38' -Name IsForegroundColor
+        New-RegEx -Pattern '48' -Name IsBackgroundColor
+        New-RegEx -Pattern '58' -Name IsUnderlineColor
+    ) |
+    New-RegEx -Pattern ';2;' |
     New-RegEx -Name Color -Pattern (
         New-Regex -Name Red -Pattern '(?>[0-2][0-5][0-5]|[0-1]\d\d|\d{1,2})' -Comment 'Red is the first 0-255 value' |
         New-RegEx -Pattern ';' |
-        New-Regex -Name Red -Pattern '(?>[0-2][0-5][0-5]|[0-1]\d\d|\d{1,2})' -Comment 'Green is the second 0-255 value' |
+        New-Regex -Name Green -Pattern '(?>[0-2][0-5][0-5]|[0-1]\d\d|\d{1,2})' -Comment 'Green is the second 0-255 value' |
         New-RegEx -Pattern ';' |
         New-Regex -Name Blue -Pattern '(?>[0-2][0-5][0-5]|[0-1]\d\d|\d{1,2})' -Comment 'Blue is the third 0-255 value' |
         New-RegEx -Pattern 'm'

diff --git a/RegEx/ANSI/24BitColor.regex.txt b/RegEx/ANSI/24BitColor.regex.txt
@@ -1,7 +1,10 @@
 # Matches an ANSI 24-bit color
-(?-i)\e                                                       # An Escape
-\[                                                            # Followed by a bracket
-38;2;(?<Color>(?<Red>(?>[0-2][0-5][0-5]|[0-1]\d\d|\d{1,2}))   # Red is the first 0-255 value
-;(?<Red>(?>[0-2][0-5][0-5]|[0-1]\d\d|\d{1,2}))                # Green is the second 0-255 value
-;(?<Blue>(?>[0-2][0-5][0-5]|[0-1]\d\d|\d{1,2}))               # Blue is the third 0-255 value
+(?-i)\e                                                                                # An Escape
+\[                                                                                     # Followed by a bracket
+(?>
+  (?<IsForegroundColor>38)  |
+  (?<IsBackgroundColor>48)  |
+  (?<IsUnderlineColor>58));2;(?<Color>(?<Red>(?>[0-2][0-5][0-5]|[0-1]\d\d|\d{1,2}))    # Red is the first 0-255 value
+;(?<Green>(?>[0-2][0-5][0-5]|[0-1]\d\d|\d{1,2}))                                       # Green is the second 0-255 value
+;(?<Blue>(?>[0-2][0-5][0-5]|[0-1]\d\d|\d{1,2}))                                        # Blue is the third 0-255 value
 m)
diff --git a/RegEx/ANSI/4BitColor.regex.source.ps1 b/RegEx/ANSI/4BitColor.regex.source.ps1
@@ -5,12 +5,25 @@ New-RegEx -Description "Matches an ANSI 3 or 4-bit color" |
     New-RegEx -CharacterClass Escape -Comment 'An Escape' |
     New-RegEx -LiteralCharacter '[' -Comment 'Followed by a bracket' |
     New-RegEx -Pattern (
-        New-RegEx -Pattern 1 -Optional -Name IsBright |
-        New-RegEx -LiteralCharacter ';' -Optional |
-        New-RegEx -Pattern '3[0-7]' -Name ForegroundColor -Optional |
-        New-RegEx -If ForegroundColor -Then 'm' -Else (
-            New-RegEx -Pattern '4[0-7]' -Name BackgroundColor | 
-                New-RegEx -Pattern 'm' -Modifier IgnoreCase -Not
-        ) 
-    ) -Name Color |    
+
+        New-RegEx -Atomic -Or @(
+            New-RegEx -Pattern 1 -Optional -Name IsBright |
+                New-RegEx -LiteralCharacter ';' -Min 0 -Max 1 |    
+                New-RegEx -Pattern '3' -Name IsForegroundColor
+
+            New-RegEx -Name IsBright (
+                New-RegEx -Pattern '9' -Name IsForegroundColor
+            )
+
+            New-RegEx -Pattern 1 -Optional -Name IsBright |
+                New-RegEx -LiteralCharacter ';' -Min 0 -Max 1 |
+                New-RegEx -Pattern '4' -Name IsBackgroundColor
+
+            New-RegEx -Name IsBright (
+                New-RegEx -Pattern '10' -Name IsBackgroundColor
+            )
+        ) |
+        New-RegEx -Pattern '[0-7]' -Name ColorNumber |
+        New-RegEx -LiteralCharacter 'm'
+    ) -Name Color | #>   
     Set-Content -Path (Join-Path $myRoot $myName)
diff --git a/RegEx/ANSI/4BitColor.regex.txt b/RegEx/ANSI/4BitColor.regex.txt
@@ -1,4 +1,8 @@
 # Matches an ANSI 3 or 4-bit color
 \e # An Escape
 \[ # Followed by a bracket
-(?<Color>(?<IsBright>1)?\;?(?<ForegroundColor>3[0-7])?(?(ForegroundColor)(m)|((?<BackgroundColor>4[0-7])m)))
+(?<Color>(?>
+  (?<IsBright>1)?\;{0,1}(?<IsForegroundColor>3)  |
+  (?<IsBright>(?<IsForegroundColor>9))  |
+  (?<IsBright>1)?\;{0,1}(?<IsBackgroundColor>4)  |
+  (?<IsBright>(?<IsBackgroundColor>10)))(?<ColorNumber>[0-7])m)
diff --git a/RegEx/ANSI/8BitColor.regex.source.ps1 b/RegEx/ANSI/8BitColor.regex.source.ps1
@@ -4,7 +4,12 @@ $myRoot = $MyInvocation.MyCommand.ScriptBlock.File | Split-Path
 New-RegEx -Description "Matches an ANSI 8-bit color" -Modifier IgnoreCase -Not |
     New-RegEx -CharacterClass Escape -Comment 'An Escape' |
     New-RegEx -LiteralCharacter '[' -Comment 'Followed by a bracket' |
-    New-RegEx -Pattern '38;5;' |
+    New-RegEx -Atomic -Or @(
+        New-RegEx -Pattern '38' -Name IsForegroundColor
+        New-RegEx -Pattern '48' -Name IsBackgroundColor
+        New-RegEx -Pattern '58' -Name IsUnderlineColor
+    ) |
+    New-RegEx -Pattern ';5;' |
     New-RegEx -Name Color -Pattern (
         New-RegEx -Atomic -Or @(            
             New-Regex -Name StandardColor -Pattern '[0-7]' -Comment '0 -7 are standard colors' |

diff --git a/RegEx/ANSI/8BitColor.regex.txt b/RegEx/ANSI/8BitColor.regex.txt
@@ -1,7 +1,10 @@
-# Matches an ANSI 8 bit color
+# Matches an ANSI 8-bit color
 (?-i)\e                                                    # An Escape
 \[                                                         # Followed by a bracket
-38;5;(?<Color>(?>
+(?>
+  (?<IsForegroundColor>38)  |
+  (?<IsBackgroundColor>48)  |
+  (?<IsUnderlineColor>58));5;(?<Color>(?>
   (?<StandardColor>[0-7])                                  # 0 -7 are standard colors
 m  |
   (?<BrightColor>(?>[8-9]|1[0-5]))                         # 8-15 are bright colors

diff --git a/RegEx/ANSI/ANSI.tests.ps1 b/RegEx/ANSI/ANSI.tests.ps1
@@ -0,0 +1,27 @@
+describe 'Irregular and ANSI' {
+    it 'Can match any ANSI sequence' {
+        "$([char]0x1b)[0m" | ?<ANSI_Code> | Select-Object -ExpandProperty Length | Should -be 4
+
+        "$([char]0x1b)[1;3;5,~" | ?<ANSI_Code> | Select-Object -ExpandProperty Length | Should -be 9
+    }
+    context 'ANSI Colors' {
+        it 'Can Match a 4-bit color' {
+            $x = "$([char]0x1b)[32m" | ?<ANSI_4BitColor> -Extract
+            $x.ColorNumber | Should -Be 2
+            $x.IsForegroundColor | Should -Be 3
+        }        
+
+        it 'Can Match a 24-bit color' {
+            $x = "$([char]0x1b)[38;2;255;100;0m" | ?<ANSI_24BitColor> -Extract
+            $x.Red | Should -be 255
+            $x.Green | Should -be 100
+            $x.Blue | Should -be 0
+        }
+    }
+
+    context 'ANSI Styles' {
+        it 'Can Match ANSI Styles' {
+            @("$([char]0x1b)[3m Italics $([char]0x1b)[23m" | ?<ANSI_Style>).Count | Should -be 2
+        }
+    }
+}
diff --git a/RegEx/ANSI/README.md b/RegEx/ANSI/README.md
@@ -7,7 +7,7 @@ Note:  Using these regular expressions in the terminal may result in awkward out
 |------------------------------------------------|-------------------------------------------------------------|----------------------------------------|
 |[?<ANSI_24BitColor>](24BitColor.regex.txt)      |Matches an ANSI 24-bit color                                 |[source](24BitColor.regex.source.ps1)   |
 |[?<ANSI_4BitColor>](4BitColor.regex.txt)        |Matches an ANSI 3 or 4-bit color                             |[source](4BitColor.regex.source.ps1)    |
-|[?<ANSI_8BitColor>](8BitColor.regex.txt)        |Matches an ANSI 8 bit color                                  |[source](8BitColor.regex.source.ps1)    |
+|[?<ANSI_8BitColor>](8BitColor.regex.txt)        |Matches an ANSI 8-bit color                                  |[source](8BitColor.regex.source.ps1)    |
 |[?<ANSI_Blink>](Blink.regex.txt)                |Matches ANSI Blink Start or End                              |[source](Blink.regex.source.ps1)        |
 |[?<ANSI_Bold>](Bold.regex.txt)                  |Matches an ANSI Bold Start or End                            |[source](Bold.regex.source.ps1)         |
 |[?<ANSI_Code>](Code.regex.txt)                  |Matches an ANSI escape code                                  |[source](Code.regex.source.ps1)         |
@@ -20,6 +20,7 @@ Note:  Using these regular expressions in the terminal may result in awkward out
 |[?<ANSI_Note>](Note.regex.txt)                  |Matches an ANSI VT520 Note                                   |[source](Note.regex.source.ps1)         |
 |[?<ANSI_Reset>](Reset.regex.txt)                |Matches an ANSI Reset (this clears formatting)               |[source](Reset.regex.source.ps1)        |
 |[?<ANSI_Strikethrough>](Strikethrough.regex.txt)|Matches ANSI Strikethrough Start or End                      |[source](Strikethrough.regex.source.ps1)|
+|[?<ANSI_Style>](Style.regex.txt)                |Matches an ANSI style (color or text option)                 |[source](Style.regex.source.ps1)        |
 |[?<ANSI_Underline>](Underline.regex.txt)        |Matches ANSI Underline/DoubleUnderline Start or Underline End|[source](Underline.regex.source.ps1)    |
 
 
diff --git a/RegEx/ANSI/Style.regex.source.ps1 b/RegEx/ANSI/Style.regex.source.ps1
@@ -10,7 +10,7 @@ New-RegEx -Description "Matches an ANSI style (color or text option)" |
         New-Regex -Pattern '?<ANSI_Italic>'
         New-Regex -Pattern '?<ANSI_Invert>'
         New-Regex -Pattern '?<ANSI_Hide>'
-        New-Regex -Pattern '?<ANSI_Strikethru>'
+        New-Regex -Pattern '?<ANSI_Strikethrough>'
         New-Regex -Pattern '?<ANSI_Underline>'
         New-RegEx -Pattern '?<ANSI_24BitColor>'
         New-RegEx -Pattern '?<ANSI_8BitColor>'