initial commit

Author: german-one

LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2024 Steffen Illhardt
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

NOTICE.md

@@ -0,0 +1,51 @@
+# NOTICES ABOUT THIRD PARTY CODE  
+Do Not Translate or Localize  
+
+This software incorporates material from third parties.  
+  
+## terminal
+  
+**Source**: [https://github.com/microsoft/terminal](https://github.com/microsoft/terminal)  
+  
+### License  
+  
+```
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
+  
+## Flexible and Economical UTF-8 Decoder  
+  
+**Source**: [https://bjoern.hoehrmann.de/utf-8/decoder/dfa/](https://bjoern.hoehrmann.de/utf-8/decoder/dfa/)  
+
+### License  
+  
+```
+Copyright (c) 2008-2010 Bjoern Hoehrmann <bjoern@hoehrmann.de>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```
+  

README.md

@@ -0,0 +1,39 @@
+## **`wtswidth` - Windows Terminal string width**  
+
+The purpose of this C library along with the released utility is to count the number of columns required to represent a string in the [Windows Terminal](https://github.com/microsoft/terminal).  
+You may use it if you want to perform some kind of tabulation or centering of text where it is necessary to know upfront how much space a string is going to occupy in the window.  
+<br>
+🔴 <span style="color:red">**NOTE**</span> 🔴 The code won't work properly for Windows Terminal releases before version 1.22.  
+<br>
+*Why is this?*  
+Recently, Windows Terminal made a huge step towards better Unicode support and Unicode correctness. This is something that I can't appreciate enough. A series of major "minor refactorings" (© @lhecker 😄) have been made to achieve that.  
+The name `wtswidth` intentionally sounds similar to the POSIX function `wcswidth()`. However, measuring the display width of a string in Windows Terminal is now not only based on the sum of expected widths of codepoints like in `wcswidth()`. The string context is taken into account, too. This leads to a far better measuring of clustered graphemes.
+<br>
+  
+*But what does that mean?*  
+Let's just perform some comparisons:  
+
+| **string** | **C syntax** | `wtswidth` **(this)** | `wcswidth()` **(wchar.h GCC)** |
+| :--- | :--- | :---: | :---: |
+| `abc` | L"abc" | 3 | 3 ✔ |
+| `हिन्दी` | L"\u0939\u093F\u0928\u094D\u0926\u0940" | 3 | 5 ❌ |
+| `😄` | L"\U0001F604" | 2 | 2 ✔ |
+| `🙋🏻‍♂️` | L"\U0001F64B\U0001F3FB\u200D\u2642\uFE0F" | 2 | 5 ❌ |
+| `❤️` | L"\u2764\uFE0F" | 2 | 1 ❌ |
+
+However, this does not quite demonstrate how it looks like in the terminal.  
+That's a screenshot of a test script in Windows Terminal Canary Version 1.22.2291.0:  
+![test output](./screenshot_v1.22.2291.0.png)  
+As you can see, the measured width matches the displayed width of the strings each.  
+I doubt it's perfect. But due to the lack of any standardization we can't even evaluate how close to perfection it actually is. At least a proposal was already submitted to the UTC (see 
+[Proper Complex Script Support in Text Terminals.](https://www.unicode.org/L2/L2023/23107-terminal-suppt.pdf)) of how this should be ideally implemented.  
+<br>
+  
+### **Most of this is not my intellectual property.**  
+
+It is basically a copy of the recently revised code for this purpose in Microsoft's open source repository. All credits go to their Terminal team and contributors. I used this code in order to actually get the same results as the internally performed measurements. For more information refer to the comments in the source files.  
+Furthermore I modified Björn Höhrmann's "Flexible and Economical UTF-8 Decoder" to process UTF-8 input.  
+  
+See: [Third Party Licenses](./NOTICE.md)  
+  
+<br>

main.c

@@ -0,0 +1,52 @@
+// Copyright (c) 2024 Steffen Illhardt,
+// Licensed under the MIT license ( https://opensource.org/license/mit/ ).
+
+#include <stdio.h>
+#include <string.h>
+#include <wchar.h>
+#include "wtswidth.h"
+
+static inline void help()
+{
+  static const char msg[] =
+    "* 'wtswidth' - Windows Terminal string width *\n"
+    "Count the number of columns required to represent a string in the Windows Terminal.\n"
+    "The return value is the width as the number of character cells the string occupies.\n"
+    "In case the wrong syntax is used, this message is displayed and -1 is returned.\n\n"
+    "Usage:\n"
+    "wtswidth \"string to measure\"\n\n";
+
+  fwrite(msg, 1, sizeof(msg) - 1, stderr);
+}
+
+#if defined(_WIN32) || defined(__CYGWIN__)
+// On Windows, the command line is always available as wide string anyway. So we just use that.
+#  include <windows.h>
+int main(void)
+{
+  int argc = 0;
+  wchar_t **const argv = CommandLineToArgvW(GetCommandLineW(), &argc);
+  if (argc != 2)
+  {
+    LocalFree(argv);
+    help();
+    return -1;
+  }
+
+  const int totalWidth = wts16width((const char16_t *)argv[1], wcslen(argv[1]));
+  LocalFree(argv);
+  return totalWidth;
+}
+#else
+// On *nix we assume to get UTF-8 as this is virtually standard.
+int main(int argc, char *argv[])
+{
+  if (argc != 2)
+  {
+    help();
+    return -1;
+  }
+
+  return wts8width(argv[1], strlen(argv[1]));
+}
+#endif