fix minor bugs with JsonGrepper, ScintillaGateway

FIX: bug where JsonTools was supposed to send a NULL-terminated string
    to Notepad++ in the SetText and InsertText methods,
    but I was not appending the NULL char.
    By addressing this issue, I removed the necessity for the RemoveTrailingSOH method,
    which means that JsonTools can output files ending with the SOH character.
FIX: Issue with JsonGrepperTests where I was expecting JSON from a weather.gov API
    that had switched to returning HTML.
FIX: Potential race condition with the automatic-parse-after-edit thread
    during plugin cleanup.

Author: molsonkiko

CHANGELOG.md

@@ -48,6 +48,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - GrepperForm loses its JSON permanently when the buffer associated with its treeview is deleted.
 - Since v7.0, holding down `Enter` in a multiline textbox (like the [tree viewer query box](/docs/README.md#remespath)) only adds one newline when the key is lifted.
 - Maybe use pre-7.1 (dictionary-based rather than indicator-based) [selection remembering](/docs/README.md#working-with-selections) for Notepad++ 8.5.5 and earlier? Indicators are risky with those older NPP's because of the lack of `NPPM_ALLOCATEINDICATOR`.
+- Hard-to-reproduce issue where sometimes clicking a treenode in regex search results does not navigate to the correct location in the document (should navigate to the start of the match). Appears to only happen when there is no capture group. It's an all-or-nothing issue; either none of the treenodes navigate to the correct location or all of them do.
+
+## [9.0.0] - (UNRELEASED) YYYY-MM-DD
+
+### Fixed
+
+1. Bug where JsonTools could not set the text of a file to end with the SOH character (ASCII code `\x01`)
+2. Bug where some JsonGrepper tests would always fail because they queried an external API that had previously returned JSON but now returns HTML.
 
 ## [8.4.0] - 2025-05-04
 

JsonToolsNppPlugin/Main.cs

@@ -452,6 +452,8 @@ static internal void FileRenameCancel(IntPtr bufferRenamedId)
 
         static internal void PluginCleanUp()
         {
+            // turn off auto-validation because we're about to remove jsonFileInfos
+            settings.auto_validate = false;
             if (grepperForm != null && !grepperForm.IsDisposed)
             {
                 grepperForm.Close();

JsonToolsNppPlugin/PluginInfrastructure/ScintillaGateway.cs

@@ -47,6 +47,22 @@ private unsafe string GetNullStrippedStringFromMessageThatReturnsLength(SciMsg m
             }
         }
 
+        /// <summary>
+        /// the same byte[] buffer that would be returned by Encoding.UTF8.GetBytes(text),
+        /// but with +1 length and a NULL byte at the end
+        /// </summary>
+        /// <param name="text"></param>
+        /// <returns></returns>
+        private byte[] GetNullTerminatedUTF8Bytes(string text)
+        {
+            int length = Encoding.UTF8.GetByteCount(text);
+            byte[] bytes = new byte[length + 1];
+            int lengthWritten = Encoding.UTF8.GetBytes(text, 0, text.Length, bytes, 0);
+            //if (lengthWritten != length)
+            //    throw new Exception("not sure what we would do here");
+            return bytes;
+        }
+
         public ScintillaGateway(IntPtr scintilla)
         {
             this.scintilla = scintilla;
@@ -131,7 +147,7 @@ public unsafe void AddStyledText(int length, Cells c)
         /// <summary>Insert string at a position. (Scintilla feature 2003)</summary>
         public unsafe void InsertText(int pos, string text)
         {
-            fixed (byte* textPtr = Encoding.UTF8.GetBytes(text))
+            fixed (byte* textPtr = GetNullTerminatedUTF8Bytes(text))
             {
                 Win32.SendMessage(scintilla, SciMsg.SCI_INSERTTEXT, (IntPtr) pos, (IntPtr) textPtr);
             }
@@ -1781,12 +1797,7 @@ public void Clear()
         /// <summary>Replace the contents of the document with the argument text. (Scintilla feature 2181)</summary>
         public unsafe void SetText(string text)
         {
-            if (text.Length == 0)
-            {
-                ClearAll();
-                return;
-            }
-            fixed (byte* textPtr = Encoding.UTF8.GetBytes(text))
+            fixed (byte* textPtr = GetNullTerminatedUTF8Bytes(text))
             {
                 Win32.SendMessage(scintilla, SciMsg.SCI_SETTEXT, (IntPtr) Unused, (IntPtr) textPtr);
             }

JsonToolsNppPlugin/Properties/AssemblyInfo.cs

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

JsonToolsNppPlugin/Tests/JsonGrepperTests.cs

@@ -146,8 +146,10 @@ public static async Task<bool> TestApiRequester()
             int ii = 0;
             int testsFailed = 0;
 
+            string firstUrlStr = "https://api.weather.gov/stations/KCCR";
+
             string[] urls = new string[] {
-                "https://api.weather.gov",
+                firstUrlStr,
                 "https://api.weather.gov/points/37.68333333333334,-121.92500000000001", // Alameda
                 "https://api.weather.gov/points/37.75833333333334,-122.43333333333334", // San Francisco
             };
@@ -156,7 +158,7 @@ public static async Task<bool> TestApiRequester()
             ii = testResult[0];
             testsFailed = testResult[1];
             // test when requesting from only one url
-            string[] firstUrl = new string[] { "https://api.weather.gov" };
+            string[] firstUrl = new string[] { firstUrlStr };
             testResult = await TestApiRequesterHelper(firstUrl, ii, testsFailed, grepper);
             ii = testResult[0];
             testsFailed = testResult[1];

JsonToolsNppPlugin/Tests/UserInterfaceTests.cs

@@ -778,6 +778,9 @@ public static bool Test()
                 ("treenode_click", new object[]{new string[] { "3 : \"{\\\"5\\\": [6]}\"" } }),
                 ("tree_query", new object[]{"@ = ``"}), // test that using RemesPath to clear text of document works
                 ("compare_text", new object[]{""}),
+                // TEST DOC CAN END WITH SOH CHAR
+                ("tree_query", new object[]{"@ = j`\"foo\\r\\n\\u0001\"`"}),
+                ("compare_text", new object[]{"foo\r\n\x01"}),
                 // TEST SORT FORM ON JSON LINES
                 ("overwrite", new object[]{"[1,'foo',true]\n[2,'bar',false]"}),
                 ("set_document_type", new object[]{"JSONL"}),

JsonToolsNppPlugin/Utils/Npp.cs

@@ -235,6 +235,10 @@ public static void CreateConfigSubDirectoryIfNotExists()
         /// </summary>
         public static void RemoveTrailingSOH()
         {
+            // hopefully using a NULL-terminated string in SetText and AppendText makes this method unnecessary
+            bool isNecessaryRemoveSOH = false;
+            if (!isNecessaryRemoveSOH)
+                return;
             if (!TryGetLengthAsInt(out int lastPos, false))
                 return;
             lastPos--;