Fix escape sequences + update INI documentation

Author: Krazal

Legacy-v2.1/Src/WebEditUVer.ob2

@@ -1,6 +1,6 @@
 MODULE WebEditUVer;
 
 CONST
-   String* = '2.8.1.1';
+   String* = '2.8.1.2';
 
 END WebEditUVer.

Legacy-v2.1/Src/WebEditUVer.rc

@@ -1,6 +1,6 @@
 MAINICON ICON "..\..\Logo.ico"
-#define WEBEDIT_VERSION_STRING "2.8.1.1\000"
-#define WEBEDIT_VERSION_WORDS 2,8,1,1
+#define WEBEDIT_VERSION_STRING "2.8.1.2\000"
+#define WEBEDIT_VERSION_WORDS 2,8,1,2
 
 1 VERSIONINFO
 FILEVERSION WEBEDIT_VERSION_WORDS
@@ -18,7 +18,7 @@ BLOCK "StringFileInfo"
       VALUE "LegalCopyright", "� 2008 - 2010 by Alexander Iljin\000"
       VALUE "FileDescription", "WebEdit plugin for Notepad++ (Unicode).\000"
       VALUE "FileVersion", WEBEDIT_VERSION_STRING
-      VALUE "ProductVersion", "2.8.1.1\000"
+      VALUE "ProductVersion", "2.8.1.2\000"
       VALUE "ProductName", "WebEdit\000"
       VALUE "InternalName", "WebEdit\000"
       VALUE "OriginalFilename", "WebEditU.dll\000"

ReadMe.txt

@@ -9,7 +9,7 @@ v2.8 — New features (examples)
     - Replaced with the current Windows user name (the user account running Notepad++).
     - Example tag line in `WebEdit.ini`:
       user=Author: \u|
-  - \d:"format"
+  - \d:"format" (experimental)
     - Replaced with the local date/time. An optional .NET-style date/time format string may be supplied in quotes.
     - Examples:
       - `datetime=Created: \d:"yyyy-MM-dd HH:mm:ss"` → inserts date/time in 24h ISO-like format.

WebEdit/Properties/AssemblyInfo.cs

@@ -27,6 +27,6 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("2.8.1.1")]
-[assembly: AssemblyFileVersion("2.8.1.1")]
-[assembly: AssemblyInformationalVersion("2.8.1.1")]
+[assembly: AssemblyVersion("2.8.1.2")]
+[assembly: AssemblyFileVersion("2.8.1.2")]
+[assembly: AssemblyInformationalVersion("2.8.1.2")]

WebEdit/Resources/WebEdit.ini

@@ -57,16 +57,23 @@ T&r=<tr>|</tr>
 ; characters. The number of Tags is not limited. The pipe character "|" marks
 ; the caret position after the tag replacement.
 ; Known escape sequences:
-; \c = system clipboard contents
-; \i = indentation
+; \r = carriage return (for Windows line endings)
 ; \n = new line
 ; \t = tab character
-; \d:"..." = Local date/time in the format specified between the quotes, e.g. \d:"Y-m-d H:i:s" (2025-12-31 23:59:59)
+; \i = indentation
+; \c = system clipboard contents
 ; \u = Windows username
+; \x = current filename (without path) / document name
+; \p = current full file path (including filename) / document name
+; \d:"..." = Local date/time in the format specified between the quotes, e.g. \d:"yyyy-MM-dd HH:mm:ss" (2025-12-31 23:59:59)
 ; \| = |
-; \\ = \
+; \\ = \ (for the sequences above, e.g. \\c, \\i etc. -- except.: \|, as it is already escaped)
 
 ; MIXED
+docs=/**\n *  @file   \x\n *  @brief  Description|\n *  @author \u <mail@example.com>\n *  @date   \d:"yyyy-MM-dd"\n */
+dox={**\n *  @file   \x\n *  @brief  Description|\n *  @author \u <mail@example.com>\n *  @date   \d:"yyyy-MM-dd"\n *\n *  @param string $param Parameter_Description\n *  @param etc.\n *\n *  @details For more imformation see: \n *}
+func=/**\n *  Description|\n *\n *  @param string $var1 param1\n *  @param bool   $var2 param2\n *  @return True on success, false otherwise\n *\n *  @details Throw an exception in case of error!\n */
+param=*  @param string $var| Parameter_Description
 yx="|" => "",
 ar=array();
 arr=array(|)
@@ -89,7 +96,6 @@ ne=!= "|"
 neq=!= "|"
 iq=== "|"
 eq=== "|"
-; gt --> gte, lt --> lte
 gt=>= 
 ltt=<= 
 iff=if (|) \n\i\n
@@ -116,6 +122,8 @@ nn= . "\\n";
 k=/* | */
 g=global $|;
 gl=global $|;
+lorem=Lorem ipsum dolor sit amet
+lipsum=Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla fringilla pharetra fermentum.\nVestibulum neque erat, bibendum ac sagittis et, pulvinar at urna. Donec sit amet ipsum quis velit cursus ultrices elementum id lacus.\nSed vel massa vitae turpis viverra adipiscing at nec odio. Quisque ac ligula metus. Vestibulum suscipit elit eget lacus pellentesque tempus. Suspendisse potenti.
 
 ; ECHOING
 1='|'
@@ -704,8 +712,6 @@ SUB=SUBSTRING(date|, 1, -3)
 SI=SUBSTRING_INDEX(datetime|, ' ', 1)
 POS=SUBSTRING_INDEX(datetime|, ' ', 1)
 STR=LOCATE('|', )
-INV=SELECT * FROM t11_order_headers oh LEFT JOIN t11_order_items oi ON oi.header_id = oh.id WHERE | IN (
-SOH=SELECT * FROM t11_order_headers oh LEFT JOIN t11_order_items oi ON oi.header_id = oh.id WHERE |
 LEN=LENGTH(|) = 
 REP=REPLACE(colname|, 'from', 'to')
 CAST=CAST(| AS UNSIGNED);

WebEdit/Tags.cs

@@ -17,7 +17,7 @@ partial class Tags(long tabStartPos, long tabEndPos)
     /// \n with a new line string determined by current EOL mode
     /// \t with the tab character
     /// \| with |
-    /// \\ with \
+    /// \\ with \ (UNNECESSARY/DEPRECATED)
     /// </code>
     /// </summary>
     /// <param name="value">Input string from the ini-file's value of the tag.</param>
@@ -27,19 +27,24 @@ partial class Tags(long tabStartPos, long tabEndPos)
     /// </remarks>
     internal string Unescape(string value)
     {
-      StringBuilder text = new(value);
       ScintillaGateway sci = new(Utils.GetCurrentScintilla());
       sci.SetTargetRange(_tabStartPos, _tabEndPos);
       string indent = sci.GetTargetText();
-      // literal DOS EOL
-      text.Replace("\\r\\n", $"\r\n{indent}");
-      // literal carriage return
-      text.Replace("\\r", $"\r{indent}");
-      // document-specific EOL
-      text.Replace("\\n", $"{sci.LineDelimiter}{indent}");
-      text.Replace("\\t", "\t");
-      text.Replace("\\|", "|");
-      text.Replace("\\\\", "\\");
+      value = Regex.Replace(value, "(?<!\\\\)\\\\r(?<!\\\\)\\\\n", $"\r\n{indent}"); // literal DOS EOL
+      value = Regex.Replace(value, "(?<!\\\\)\\\\r", $"\r{indent}"); // literal carriage return
+      value = Regex.Replace(value, "(?<!\\\\)\\\\n", $"\n{indent}"); // document-specific EOL
+      value = Regex.Replace(value, "(?<!\\\\)\\\\t", $"\t{indent}"); // tab character
+      value = Regex.Replace(value, "(?<!\\\\)\\|",   $"|{indent}");  // cursor
+      // value = Regex.Replace(value, "\\\\", "\\");                 // escape character (not needed)
+
+      // Handle escaped sequences
+      StringBuilder text = new(value);
+      text.Replace("\\\\r\\\\n", "\\r\\n"); // literal DOS EOL (escaped)
+      text.Replace("\\\\r", "\\r");  // literal carriage return (escaped)
+      text.Replace("\\\\n", "\\n");  // document-specific EOL (escaped)
+      text.Replace("\\\\t", "\\t");  // tab character (escaped)
+      text.Replace("\\|", "|");      // cursor (escaped)
+      // text.Replace("\\\\", "\\"); // escape character (not needed)
       return text.ToString();
     }
 
@@ -70,12 +75,11 @@ internal bool FindAndReplace(long startPos)
       {
         {"\\f", PasteFileContents},
         {"\\c", sci.Paste},
-        {"\\d", PasteDateTime},
         {"\\u", PasteUserName},
         {"\\x", PasteFileName},
         {"\\p", PasteFilePath},
-        // must come last as the caret will be restored here
-        {"\\i", sci.Tab}
+        {"\\d", PasteDateTime},
+        {"\\i", sci.Tab} // must come last as the caret will be restored here!
       };
 
       foreach ((string seq, var replaceFunc) in replacements)
@@ -93,9 +97,23 @@ internal bool FindAndReplace(long startPos)
             seqStart += sci.CodePage.GetByteCount(tmpTargetText) - tmpTargetText.Length; // Adjust for multi-byte characters
           long selStart = sci.GetTargetStart() + seqStart;
           sci.SetSelection(selStart, selStart + seq.Length); // sci.CodePage.GetByteCount(seq)
-          replaceFunc();
+          if (seqStart == 0 || sci.GetCharAt(selStart - 1) != 92) // Backspace (\)
+          {
+            replaceFunc();
+          }
+          else
+          {
+            sci.SetSelection(selStart - 1, selStart + seq.Length);
+            sci.ReplaceSel(seq);
+            rangeEnd--;
+          }
+          sci.SetCurrentPos(sci.GetSelectionEnd());
           rangeEnd += (sci.GetSelectionEnd() - selStart) - seq.Length; // sci.CodePage.GetByteCount(seq)
 
+          // Capture the first date only!
+          if (seq == "\\d")
+            break; // TODO: replacing the first occurrence (Unicode issue?) -- rangeEnd may be wrong as using `seq.Length`!
+
           // capture the caret position produced by the first '\i' replacement
           if (seq == "\\i" && firstIndentCaret == -1)
             firstIndentCaret = sci.GetSelectionEnd();
@@ -200,7 +218,8 @@ private void PasteDateTime()
         int matchEnd = matchStart + match.Length;
         sci.SetSelection(sci.GetTargetStart() + matchStart, sci.GetTargetStart() + matchEnd);
         sci.ReplaceSel(formattedDate);
-        offset += formattedDate.Length - match.Length;
+        return; // Hotfix: only replace the first occurrence (Unicode issue?)
+        // offset += (formattedDate.Length - match.Length);
       }
 
     }
@@ -249,7 +268,7 @@ private void PasteFilePath()
     /// <remarks>
     /// For custom date/time format strings see: <see href="https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings"/>
     /// </remarks>
-    [GeneratedRegex(@"\\d:[""']([^""']+)[""']")]
+    [GeneratedRegex(@"(?<!\\)\\d:[""']([^""']+)[""']")]
     private static partial Regex UserDefinedDateRegex();
 
     private readonly long _tabStartPos = tabStartPos;