BUG: Fix launching with CTKAPPLAUNCHER_WITHOUT_CONSOLE_IO_SUPPORT on Windows

Application path and command-line arguments can now contain special characters.

Note: console launcher on Windows still has not been fixed. wmain would need to be used instead of main and wide characters should be converted to utf8.

Author: lassoan

Base/ctkCommandLineParser.cpp

@@ -819,106 +819,62 @@ void ctkCommandLineParser::setStrictModeEnabled(bool strictMode)
   this->Internal->StrictMode = strictMode;
 }
 
+#if defined (_WIN32)
 // --------------------------------------------------------------------------
 void ctkCommandLineParser::convertWindowsCommandLineToUnixArguments(
-  const char *cmd_line, int *argc, char ***argv)
+  PWSTR cmd_line, int* argc, char*** argv)
 {
   if (!cmd_line || !argc || !argv)
     {
     return;
     }
+  *argc = 0;
+  *argv = nullptr;
 
-  // A space delimites an argument except when it is inside a quote
-
-  (*argc) = 1;
-
-  size_t cmd_line_len = strlen(cmd_line);
-
-  size_t i;
-  for (i = 0; i < cmd_line_len; i++)
-    {
-    while (isspace(cmd_line[i]) && i < cmd_line_len)
-      {
-      i++;
-      }
-    if (i < cmd_line_len)
-      {
-      if (cmd_line[i] == '\"')
-        {
-        i++;
-        while (cmd_line[i] != '\"' && i < cmd_line_len)
-          {
-          i++;
-          }
-        (*argc)++;
-        }
-      else
-        {
-        while (!isspace(cmd_line[i]) && i < cmd_line_len)
-          {
-          i++;
-          }
-        (*argc)++;
-        }
-      }
-    }
-
-  (*argv) = new char* [(*argc) + 1];
-  (*argv)[(*argc)] = NULL;
-
-  // Set the first arg to be the exec name
-
-  (*argv)[0] = new char [1024];
-#ifdef _WIN32
-  ::GetModuleFileName(0, (*argv)[0], 1024);
-#else
-  (*argv)[0][0] = '\0';
-#endif
+  // Split the command line to separate arguments
+  int numArgs = 0;
+  LPWSTR* wideArgs = CommandLineToArgvW(cmd_line, &numArgs);
+  if (wideArgs == nullptr)
+  {
+    return;
+  }
 
-  // Allocate the others
+  // Allocate space for pointers in argv
+  (*argc) = numArgs + 1; // +1 because the first argument is the executable name
+  (*argv) = new char* [numArgs + 1];
+  for (int i = 0; i < numArgs + 1; i++)
+  {
+    (*argv)[i] = nullptr;
+  }
 
-  int j;
-  for (j = 1; j < (*argc); j++)
+  // Convert each argument to UTF8 and save it in argv
+  for (int i = 0; i < numArgs; ++i)
+  {
+    BOOL lpUsedDefaultChar = false;
+    // Get length
+    int utf8length = WideCharToMultiByte(CP_UTF8, 0, wideArgs[i], -1, NULL, 0, NULL, &lpUsedDefaultChar);
+    char* utf8buffer = new char[utf8length + 1];
+    int retval = WideCharToMultiByte(CP_UTF8, 0, wideArgs[i], -1, utf8buffer, utf8length, NULL, &lpUsedDefaultChar);
+    if (!SUCCEEDED(retval))
     {
-    (*argv)[j] = new char [cmd_line_len + 10];
+      // set to empty string in case of encoding error
+      utf8buffer[0] = '\0';
+      continue;
     }
+    utf8buffer[utf8length] = '\0'; // Make sure the string is null-terminated
+    (*argv)[i + 1] = utf8buffer; // +1 because the first argument is the executable name
+  }
 
-  // Grab the args
-
-  size_t pos;
-  int argc_idx = 1;
-
-  for (i = 0; i < cmd_line_len; i++)
-    {
-    while (isspace(cmd_line[i]) && i < cmd_line_len)
-      {
-      i++;
-      }
-    if (i < cmd_line_len)
-      {
-      if (cmd_line[i] == '\"')
-        {
-        i++;
-        pos = i;
-        while (cmd_line[i] != '\"' && i < cmd_line_len)
-          {
-          i++;
-          }
-        memcpy((*argv)[argc_idx], &cmd_line[pos], i - pos);
-        (*argv)[argc_idx][i - pos] = '\0';
-        argc_idx++;
-        }
-      else
-        {
-        pos = i;
-        while (!isspace(cmd_line[i]) && i < cmd_line_len)
-          {
-          i++;
-          }
-        memcpy((*argv)[argc_idx], &cmd_line[pos], i - pos);
-        (*argv)[argc_idx][i - pos] = '\0';
-        argc_idx++;
-        }
-      }
-    }
+  LocalFree(wideArgs);
+
+  // Get the application name
+  wchar_t wideBuffer[MAX_PATH];
+  DWORD wideLength = GetModuleFileNameW(NULL, wideBuffer, MAX_PATH);
+  // Convert the wide string to UTF-8
+  int utf8length = WideCharToMultiByte(CP_UTF8, 0, wideBuffer, wideLength, NULL, 0, NULL, NULL);
+  char* utf8buffer = new char[utf8length + 1];
+  WideCharToMultiByte(CP_UTF8, 0, wideBuffer, wideLength, utf8buffer, utf8length, NULL, NULL);
+  utf8buffer[utf8length] = '\0'; // Make sure the string is null-terminated
+  (*argv)[0] = utf8buffer;
  }
+#endif

Base/ctkCommandLineParser.h

@@ -1,6 +1,10 @@
 #ifndef __ctkCommandLineParser_h
 #define __ctkCommandLineParser_h
 
+#if defined (_WIN32)
+#include <windows.h>
+#endif
+
 // Qt includes
 #include <QString>
 #include <QStringList>
@@ -383,14 +387,18 @@ class /*CTK_CORE_EXPORT*/ ctkCommandLineParser
     */
   void setStrictModeEnabled(bool strictMode);
 
+#if defined (_WIN32)
   /**
    * Convert windows-style arguments given as a command-line string
    * into more traditional argc/argv arguments.
+   * If an argument is failed to be retrieved (for example, due to character encoding error)
+   * then the corresponding argv pointer is set to point to an empty string.
    *
    * @note argv[0] will be assigned the executable name using the ::GetModuleFileName function.
    */
   static void convertWindowsCommandLineToUnixArguments(
-    const char *cmd_line, int *argc, char ***argv);
+    PWSTR cmd_line, int* argc, char*** argv);
+#endif
 
 private:
   class ctkInternal;

Main.cpp

@@ -182,15 +182,23 @@ int appLauncherMain(int argc, char** argv)
 
 // --------------------------------------------------------------------------
 #ifndef CTKAPPLAUNCHER_WITHOUT_CONSOLE_IO_SUPPORT
+// NOTE: On Windows, wmain should be used to allow non-ASCII characters in command-line arguments
 int main(int argc, char *argv[])
 {
+  // Uncomment the next two lines to stop at application start (to give a chance to connect with a debugger)
+  // std::cout << "Attach debugger and hit Enter" << std::endl;
+  // std::cin.get();
+
   return appLauncherMain(argc, argv);
 }
 #elif defined Q_OS_WIN32
-int __stdcall WinMain(HINSTANCE hInstance,
+int __stdcall wWinMain(HINSTANCE hInstance,
                       HINSTANCE hPrevInstance,
-                      LPSTR lpCmdLine, int nShowCmd)
+                      PWSTR lpCmdLine, int nShowCmd)
 {
+  // Uncomment the next line to stop at application start (to give a chance to connect with a debugger)
+  // int msgboxID = MessageBox(NULL, "Attach your debugger", "Debug", MB_ICONWARNING);
+
   Q_UNUSED(hInstance);
   Q_UNUSED(hPrevInstance);
   Q_UNUSED(nShowCmd);