add unit tests for parsing ANSI with non-ASCII

also update CI build to address latest dependabot PR

Author: molsonkiko

.github/workflows/CI_build.yml

@@ -32,14 +32,14 @@ jobs:
 
     - name: Archive artifacts for x64
       if: matrix.build_platform == 'x64' && matrix.build_configuration == 'Release'
-      uses: actions/upload-artifact@v5
+      uses: actions/upload-artifact@v7
       with:
           name: plugin_dll_x64
           path: JsonToolsNppPlugin\bin\${{ matrix.build_configuration }}-x64\JsonTools.dll
 
     - name: Archive artifacts for x86
       if: matrix.build_platform == 'x86' && matrix.build_configuration == 'Release'
-      uses: actions/upload-artifact@v5
+      uses: actions/upload-artifact@v7
       with:
           name: plugin_dll_x86
           path: JsonToolsNppPlugin\bin\${{ matrix.build_configuration }}\JsonTools.dll

JsonToolsNppPlugin/PluginInfrastructure/Msgs_h.cs

@@ -873,4 +873,33 @@ public enum StatusBarSection
         UnicodeType,
         TypingMode,
     }
+
+    /// <summary>
+    /// based on the UniMode enum in NppConstants.h
+    /// </summary>
+    public enum BufferEncoding
+    {
+        /// <summary>
+        /// returned when something was wrong in Notepad++
+        /// </summary>
+        invalid = -1,     
+        /// <summary>ANSI</summary>
+        uni8Bit = 0,
+        /// <summary>UTF-8 with BOM</summary>
+        uniUTF8 = 1,
+        /// <summary>UTF-16 Big Endian with BOM</summary>
+        uni16BE = 2,        
+        /// <summary>UTF-16 Little Endian with BOM</summary>
+        uni16LE = 3,        
+        /// <summary>UTF-8 without BOM</summary>
+        uniUTF8_NoBOM = 4,  
+        /// <summary>0 - 127 ASCII</summary>
+        uni7Bit = 5,
+        /// <summary>UTF-16 Big Endian without BOM</summary>
+        uni16BE_NoBOM = 6,
+        /// <summary>UTF-16 Little Endian without BOM</summary>
+        uni16LE_NoBOM = 7,
+        /// <summary>indicates the maximum BufferEncoding value, has no real meaning</summary>
+        uniEnd = 8
+    };
 }

JsonToolsNppPlugin/PluginInfrastructure/NotepadPPGateway.cs

@@ -57,6 +57,12 @@ public interface INotepadPPGateway
         /// <returns></returns>
         bool AllocateIndicators(int numberOfIndicators, out int[] indicators);
 
+		BufferEncoding GetBufferEncoding(IntPtr bufferID);
+
+		void SetBufferEncoding(IntPtr bufferID, BufferEncoding bufferEncoding);
+
+		IntPtr GetCurrentBufferID();
+
     }
 
 	/// <summary>
@@ -305,6 +311,26 @@ public unsafe bool AllocateIndicators(int numberOfIndicators, out int[] indicato
                 return success != IntPtr.Zero;
             }
         }
+
+		public BufferEncoding GetBufferEncoding(IntPtr bufferID)
+		{
+			long result = (long)Win32.SendMessage(PluginBase.nppData._nppHandle, (uint)NppMsg.NPPM_GETBUFFERENCODING, bufferID, 0);
+			if (result >= (long)BufferEncoding.uniEnd || result < 0)
+				return BufferEncoding.invalid;
+			return (BufferEncoding)result;
+		}
+
+		public void SetBufferEncoding(IntPtr bufferID, BufferEncoding encoding)
+		{
+			if (encoding <= BufferEncoding.invalid || encoding >= BufferEncoding.uniEnd)
+				return;
+			Win32.SendMessage(PluginBase.nppData._nppHandle, (uint)NppMsg.NPPM_SETBUFFERENCODING, bufferID, (int)encoding);
+		}
+
+		public IntPtr GetCurrentBufferID()
+		{
+			return Win32.SendMessage(PluginBase.nppData._nppHandle, (uint)NppMsg.NPPM_GETCURRENTBUFFERID, 0, 0);
+		}
     }
 
 	/// <summary>

JsonToolsNppPlugin/PluginInfrastructure/ScintillaGateway.cs

@@ -467,6 +467,7 @@ public int GetNextTabStop(int line, int x)
         /// The SC_CP_UTF8 value can be used to enter Unicode mode.
         /// (Scintilla feature 2037)
         /// </summary>
+        /// <remarks>WARNING: this method should probably <em>not</em> be used to set a document's encoding. Use <see cref="NotepadPPGateway.SetBufferEncoding(IntPtr, BufferEncoding)"/> instead.</remarks>
         public void SetCodePage(int codePage)
         {
             Win32.SendMessage(scintilla, SciMsg.SCI_SETCODEPAGE, (IntPtr) codePage, (IntPtr) Unused);

JsonToolsNppPlugin/Properties/AssemblyInfo.cs

@@ -28,5 +28,5 @@
 //      Build Number
 //      Revision
 //
-[assembly: AssemblyVersion("8.4.0.7")]
-[assembly: AssemblyFileVersion("8.4.0.7")]
+[assembly: AssemblyVersion("8.4.0.8")]
+[assembly: AssemblyFileVersion("8.4.0.8")]

JsonToolsNppPlugin/Tests/UserInterfaceTests.cs

@@ -7,6 +7,7 @@
 using JSON_Tools.JSON_Tools;
 using JSON_Tools.Utils;
 using Kbg.NppPluginNET;
+using Kbg.NppPluginNET.PluginInfrastructure;
 
 namespace JSON_Tools.Tests
 {
@@ -366,6 +367,13 @@ public static bool ExecuteFileManipulation(string command, List<string> messages
                 }
                 messages.Add($"Set document type to {newDocumentTypeName} with the treeview's combo box");
                 break;
+            case "set_buffer_encoding":
+                BufferEncoding newEncoding = (BufferEncoding)args[0];
+                if (newEncoding >= BufferEncoding.uniEnd || newEncoding < 0)
+                    newEncoding = BufferEncoding.invalid;
+                IntPtr curBuffID = Npp.notepad.GetCurrentBufferID();
+                Npp.notepad.SetBufferEncoding(curBuffID, newEncoding);
+                break;
             default:
                 throw new ArgumentException($"Unrecognized command {command}");
             }
@@ -880,6 +888,14 @@ public static bool Test()
                 ("compare_text", new object[]{"[2,\"bar\",false]\n[1,\"foo\",true]"}),
                 ("sort_form_run", new object[]{"[0]", false, true, 3, "s_len(str(@))"}),
                 ("compare_text", new object[]{"[false,\"bar\",2]\n[1,\"foo\",true]"}),
+                // TEST PARSE ANSI DOCUMENTS WITH NON-ASCII CHARACTERS
+                ("file_open", new object[]{3, "json"}),
+                ("set_buffer_encoding", new object[]{BufferEncoding.uni8Bit}),
+                ("overwrite", new object[]{"[\r\n    [\"µ ØÅ\", 1, \"a\"], // foo\r\n    [\"ü\", 2, \"b\"], // bÆr\r\n    [\"ß\", 3, \"c\"], // baz\r\n]//a"}),
+                ("pretty_print", new object[]{true, true, PrettyPrintStyle.Google}),
+                ("compare_text", new object[]{"[\r\n\t[\r\n\t\t\"µ ØÅ\",\r\n\t\t1,\r\n\t\t\"a\"\r\n\t],\r\n\t// foo\r\n\t[\r\n\t\t\"ü\",\r\n\t\t2,\r\n\t\t\"b\"\r\n\t],\r\n\t// bÆr\r\n\t[\r\n\t\t\"ß\",\r\n\t\t3,\r\n\t\t\"c\"\r\n\t]\r\n]\r\n// baz\r\n//a\r\n"}),
+                ("pretty_print", new object[]{true}),
+                ("compare_text", new object[]{"[\r\n\t[\"µ ØÅ\", 1, \"a\"],\r\n\t[\"ü\", 2, \"b\"],\r\n\t[\"ß\", 3, \"c\"]\r\n]"}),
             };
 
             var messages = new List<string>();
@@ -927,6 +943,7 @@ public static bool Test()
                 string[] oneArray2000xPPrintSelections = ((JArray)remesParser.Search("(range(2000) * 13)[:]{@, @ + 11}{s_join(`,`, str(@))}[0]", new JNode())).children
                     .Select(x => (string)x.value)
                     .ToArray();
+                testcases.Add(("file_open", new object[] { 2 }));
                 testcases.Add(("overwrite", new object[] { oneArray2000xStr }));
                 testcases.Add(("select_every_valid", new object[] { }));
                 testcases.Add(("compare_selections", new object[] { oneArray2000xSelections }));