game: Improve OpenGL version detection and make requirement errors more obvious to the user (#2787)

CMakeLists.txt

@@ -184,6 +184,9 @@ include_directories(third-party/tree-sitter/tree-sitter/lib/include)
 include_directories(third-party/tree-sitter/tree-sitter-opengoal/include)
 add_subdirectory(third-party/tree-sitter EXCLUDE_FROM_ALL)
 
+# native OS dialogs for error messages
+add_subdirectory(third-party/libtinyfiledialogs)
+
 string(REPLACE " ${THIRDPARTY_IGNORED_WARNINGS} " "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
 
 # build common library

common/CMakeLists.txt

@@ -70,6 +70,7 @@ add_library(common
         util/dgo_util.cpp
         util/DgoReader.cpp
         util/DgoWriter.cpp
+        util/dialogs.cpp
         util/diff.cpp
         util/FileUtil.cpp
         util/FontUtils.cpp
@@ -85,7 +86,7 @@ add_library(common
         util/unicode_util.cpp
         versions/versions.cpp)
 
-target_link_libraries(common fmt lzokay replxx libzstd_static tree-sitter sqlite3)
+target_link_libraries(common fmt lzokay replxx libzstd_static tree-sitter sqlite3 libtinyfiledialogs)
 
 if(WIN32)
     target_link_libraries(common wsock32 ws2_32 windowsapp)

common/util/dialogs.cpp

@@ -0,0 +1,10 @@
+#include "dialogs.h"
+
+namespace dialogs {
+// char const * const aDialogType , /* "ok" "okcancel" "yesno" "yesnocancel" */
+// char const * const aIconType , /* "info" "warning" "error" "question" */
+// int const aDefaultButton ) /* 0 for cancel/no , 1 for ok/yes , 2 for no in yesnocancel */
+void create_error_message_dialog(const std::string& title, const std::string& message) {
+  tinyfd_messageBox(title.data(), message.data(), "ok", "error", 1);
+}
+}  // namespace dialogs

common/util/dialogs.h

@@ -0,0 +1,9 @@
+#pragma once
+
+#include <string>
+
+#include "third-party/libtinyfiledialogs/tinyfiledialogs.h"
+
+namespace dialogs {
+void create_error_message_dialog(const std::string& title, const std::string& message);
+}

game/CMakeLists.txt

@@ -11,6 +11,7 @@ set(RUNTIME_SOURCE
         external/discord_jak2.cpp
         graphics/display.cpp
         graphics/gfx.cpp
+        graphics/gfx_test.cpp
         graphics/jak2_texture_remap.cpp
         graphics/opengl_renderer/background/background_common.cpp
         graphics/opengl_renderer/background/Shrub.cpp

game/graphics/gfx_test.cpp

@@ -0,0 +1,50 @@
+#include "gfx_test.h"
+
+#include "game/system/hid/sdl_util.h"
+
+namespace tests {
+void to_json(json& j, const GPUTestOutput& obj) {
+  j = json{
+      {"success", obj.success},
+      {"error", obj.error},
+      {"errorCause", obj.errorCause},
+  };
+}
+
+GPUTestOutput run_gpu_test(const std::string& test_type) {
+  lg::info("Running GPU Test - {}", test_type);
+  GPUTestOutput output = {false, "", ""};
+  if (test_type == "opengl") {
+    if (SDL_Init(SDL_INIT_VIDEO) < 0) {
+      output = {false, "SDL initialization failed",
+                sdl_util::log_and_return_error("SDL initialization failed")};
+      return output;
+    }
+    SDL_GL_SetAttribute(SDL_GL_CONTEXT_PROFILE_MASK, SDL_GL_CONTEXT_PROFILE_CORE);
+    SDL_GL_SetAttribute(SDL_GL_CONTEXT_MAJOR_VERSION, 4);
+    SDL_GL_SetAttribute(SDL_GL_CONTEXT_MINOR_VERSION, 3);
+    SDL_Window* window =
+        SDL_CreateWindow("OpenGL Version", SDL_WINDOWPOS_UNDEFINED, SDL_WINDOWPOS_UNDEFINED, 800,
+                         600, SDL_WINDOW_OPENGL | SDL_WINDOW_HIDDEN);
+    if (!window) {
+      output = {false, "SDL window creation failed",
+                sdl_util::log_and_return_error("SDL initialization failed")};
+      SDL_Quit();
+      return output;
+    }
+    SDL_GLContext glContext = SDL_GL_CreateContext(window);
+    if (!glContext) {
+      output = {false, "Required OpenGL Version is not supported",
+                sdl_util::log_and_return_error("SDL initialization failed")};
+    } else {
+      output = {true, "", ""};
+      SDL_GL_DeleteContext(glContext);
+    }
+    SDL_DestroyWindow(window);
+    SDL_Quit();
+  } else {
+    lg::error("Invalid GPU test type - {}", test_type);
+  }
+  return output;
+}
+};  // namespace tests

game/graphics/gfx_test.h

@@ -0,0 +1,16 @@
+#pragma once
+
+#include <string>
+
+#include "common/util/json_util.h"
+
+namespace tests {
+struct GPUTestOutput {
+  bool success;
+  std::string error;
+  std::string errorCause;
+};
+void to_json(json& j, const GPUTestOutput& obj);
+
+GPUTestOutput run_gpu_test(const std::string& test_type);
+}  // namespace tests

game/graphics/pipelines/opengl.cpp

@@ -36,6 +36,7 @@
 #include "third-party/imgui/imgui_impl_sdl.h"
 #include "third-party/imgui/imgui_style.h"
 #define STBI_WINDOWS_UTF8
+#include "common/util/dialogs.h"
 #include "common/util/string_util.h"
 
 #include "third-party/stb_image/stb_image.h"
@@ -99,6 +100,8 @@ static int gl_init(GfxGlobalSettings& settings) {
     SDL_SetHint(SDL_HINT_NO_SIGNAL_HANDLERS, "1");
     if (SDL_Init(SDL_INIT_VIDEO | SDL_INIT_GAMECONTROLLER) != 0) {
       sdl_util::log_error("Could not initialize SDL, exiting");
+      dialogs::create_error_message_dialog("Critical Error Encountered",
+                                           "Could not initialize SDL, exiting");
       return 1;
     }
   }
@@ -216,6 +219,10 @@ static std::shared_ptr<GfxDisplay> gl_make_display(int width,
   prof().end_event();
   if (!window) {
     sdl_util::log_error("gl_make_display failed - Could not create display window");
+    dialogs::create_error_message_dialog(
+        "Critical Error Encountered",
+        "Unable to create OpenGL window.\nOpenGOAL requires OpenGL 4.3.\nEnsure your GPU "
+        "supports this and your drivers are up to date.");
     return NULL;
   }
 
@@ -225,6 +232,10 @@ static std::shared_ptr<GfxDisplay> gl_make_display(int width,
   prof().end_event();
   if (!gl_context) {
     sdl_util::log_error("gl_make_display failed - Could not create OpenGL Context");
+    dialogs::create_error_message_dialog(
+        "Critical Error Encountered",
+        "Unable to create OpenGL context.\nOpenGOAL requires OpenGL 4.3.\nEnsure your GPU "
+        "supports this and your drivers are up to date.");
     return NULL;
   }
 
@@ -232,6 +243,10 @@ static std::shared_ptr<GfxDisplay> gl_make_display(int width,
     auto p = scoped_prof("startup::sdl::assign_context");
     if (SDL_GL_MakeCurrent(window, gl_context) != 0) {
       sdl_util::log_error("gl_make_display failed - Could not associated context with window");
+      dialogs::create_error_message_dialog("Critical Error Encountered",
+                                           "Unable to create OpenGL window with context.\nOpenGOAL "
+                                           "requires OpenGL 4.3.\nEnsure your GPU "
+                                           "supports this and your drivers are up to date.");
       return NULL;
     }
   }
@@ -242,6 +257,10 @@ static std::shared_ptr<GfxDisplay> gl_make_display(int width,
       gladLoadGLLoader((GLADloadproc)SDL_GL_GetProcAddress);
       if (!gladLoadGL()) {
         lg::error("GL init fail");
+        dialogs::create_error_message_dialog("Critical Error Encountered",
+                                             "Unable to initialize OpenGL API.\nOpenGOAL requires "
+                                             "OpenGL 4.3.\nEnsure your GPU "
+                                             "supports this and your drivers are up to date.");
         return NULL;
       }
     }

game/main.cpp

@@ -12,11 +12,13 @@
 #include "common/global_profiler/GlobalProfiler.h"
 #include "common/log/log.h"
 #include "common/util/FileUtil.h"
+#include "common/util/dialogs.h"
 #include "common/util/os.h"
 #include "common/util/unicode_util.h"
 #include "common/versions/versions.h"
 
 #include "game/common/game_common_types.h"
+#include "graphics/gfx_test.h"
 
 #include "third-party/CLI11.hpp"
 
@@ -90,6 +92,8 @@ int main(int argc, char** argv) {
   bool disable_display = false;
   bool enable_debug_vm = false;
   bool enable_profiling = false;
+  std::string gpu_test = "";
+  std::string gpu_test_out_path = "";
   int port_number = -1;
   fs::path project_path_override;
   std::vector<std::string> game_args;
@@ -104,6 +108,10 @@ int main(int argc, char** argv) {
   app.add_flag("--no-display", disable_display, "Disable video display");
   app.add_flag("--vm", enable_debug_vm, "Enable debug PS2 VM (defaulted to off)");
   app.add_flag("--profile", enable_profiling, "Enables profiling immediately from startup");
+  app.add_option("--gpu-test", gpu_test,
+                 "Tests for minimum graphics requirements.  Valid Options are: [opengl]");
+  app.add_option("--gpu-test-out-path", gpu_test_out_path,
+                 "Where to store the gpu test result file");
   app.add_option("--proj-path", project_path_override,
                  "Specify the location of the 'data/' folder");
   app.footer(game_arg_documentation());
@@ -117,6 +125,17 @@ int main(int argc, char** argv) {
     return 0;
   }
 
+  if (!gpu_test.empty() && !gpu_test_out_path.empty()) {
+    const auto output = tests::run_gpu_test(gpu_test);
+    json data = output;
+    try {
+      file_util::write_text_file(gpu_test_out_path, data.dump(2));
+    } catch (std::exception& e) {
+      return 1;
+    }
+    return 0;
+  }
+
   prof().set_enable(enable_profiling);
 
   // Create struct with all non-kmachine handled args to pass to the runtime
@@ -132,6 +151,8 @@ int main(int argc, char** argv) {
   // If the CPU doesn't have AVX, GOAL code won't work and we exit.
   if (!get_cpu_info().has_avx) {
     lg::info("Your CPU does not support AVX, which is required for OpenGOAL.");
+    dialogs::create_error_message_dialog(
+        "Unmet Requirements", "Your CPU does not support AVX, which is required for OpenGOAL.");
     return -1;
   }
 

game/system/hid/sdl_util.cpp

@@ -9,6 +9,11 @@ void log_error(const std::string& msg) {
   std::string sdl_cause = SDL_GetError();
   lg::error("SDL Error: {} - Cause: {}", msg, sdl_cause.empty() ? "n/a" : sdl_cause);
 }
+std::string log_and_return_error(const std::string& msg) {
+  std::string sdl_cause = SDL_GetError();
+  lg::error("SDL Error: {} - Cause: {}", msg, sdl_cause.empty() ? "n/a" : sdl_cause);
+  return sdl_cause;
+}
 bool is_any_event_type(uint32_t event_type, const std::vector<uint32_t>& allowed_types) {
   for (const auto& allowed_type : allowed_types) {
     if (allowed_type == event_type) {

game/system/hid/sdl_util.h

@@ -9,6 +9,7 @@
 
 namespace sdl_util {
 void log_error(const std::string& msg = "");
+std::string log_and_return_error(const std::string& msg = "");
 bool is_any_event_type(uint32_t event_type, const std::vector<uint32_t>& allowed_types);
 SDL_bool sdl_bool(const bool val);
 bool from_sdl_bool(const SDL_bool val);

third-party/libtinyfiledialogs/CMakeLists.txt

@@ -0,0 +1,4 @@
+add_library(libtinyfiledialogs
+ tinyfiledialogs.c
+ tinyfiledialogs.h
+)

third-party/libtinyfiledialogs/README.md

@@ -0,0 +1,307 @@
+## Official version hosted at https://sourceforge.net/projects/tinyfiledialogs/
+
+This version is _not_ official and is currently updated as required by https://github.com/haxelime/lime only
+
+# tinyfiledialogs
+
+<pre>
+ _________
+/         \   tiny file dialogs ( cross-platform C C++ )
+|tiny file|   v2.9.3 [July 12, 2017] zlib licence
+| dialogs |   InputBox PasswordBox MessageBox ColorPicker
+\____  ___/   OpenFileDialog SaveFileDialog SelectFolderDialog		
+     \|       ASCII UTF-8 (and also MBCS UTF-16 for windows)
+              Native dialog library for WINDOWS MAC OSX GTK+ QT CONSOLE
+  
+SSH supported via automatic switch to console mode or X11 forwarding
+
+tested with C & C++ compilers on 
+    Visual Studio MinGW OSX LINUX FREEBSD OPENBSD ILLUMOS SOLARIS MINIX RASPBIAN
+using
+    Gnome Kde Mate Cinnamon Unity Lxde Lxqt Xfce Enlightenment
+    WindowMaker IceWm Cde Jds OpenBox Awesome Jwm
+
+bindings for LUA and C# dll
+included in LWJGL(java), rust, Allegrobasic
+
+                   http://tinyfiledialogs.sourceforge.net
+                git://git.code.sf.net/p/tinyfiledialogs/code
+ _________________________________________________________________________
+|                                                                         |
+| CONTACT me directly via the email address at the top of the header file |
+|_________________________________________________________________________|
+
+if you absolutely want them, the windows only wchar_t prototypes are in the header file
+
+int tinyfd_messageBox (
+    char const * const aTitle , // ""
+    char const * const aMessage , // "" may contain \n \t
+    char const * const aDialogType , // "ok" "okcancel" "yesno" "yesnocancel"
+    char const * const aIconType , // "info" "warning" "error" "question"
+    int const aDefaultButton ) ;
+        // 0 for cancel/no , 1 for ok/yes , 2 for no in yesnocancel
+
+char const * tinyfd_inputBox (
+    char const * const aTitle , // ""
+    char const * const aMessage , // "" may NOT contain \n \t on windows
+    char const * const aDefaultInput ) ; // "" , if NULL it's a passwordBox
+        // returns NULL on cancel
+
+char const * tinyfd_saveFileDialog (
+    char const * const aTitle , // ""
+    char const * const aDefaultPathAndFile , // ""
+    int const aNumOfFilterPatterns , // 0
+    char const * const * const aFilterPatterns , // NULL | {"*.txt"}
+    char const * const aSingleFilterDescription ) ; // NULL | "text files"
+        // returns NULL on cancel
+
+char const * tinyfd_openFileDialog (
+    char const * const aTitle , // ""
+    char const * const aDefaultPathAndFile , // ""
+    int const aNumOfFilterPatterns , // 0
+    char const * const * const aFilterPatterns , // NULL {"*.jpg","*.png"}
+    char const * const aSingleFilterDescription , // NULL | "image files"
+    int const aAllowMultipleSelects ) ; // 0
+        // in case of multiple files, the separator is |
+        // returns NULL on cancel
+
+char const * tinyfd_selectFolderDialog (
+    char const * const aTitle , // ""
+    char const * const aDefaultPath ) ; // ""
+        // returns NULL on cancel
+
+char const * tinyfd_colorChooser(
+    char const * const aTitle , // ""
+    char const * const aDefaultHexRGB , // NULL or "#FF0000”
+    unsigned char const aDefaultRGB[3] , // { 0 , 255 , 255 }
+    unsigned char aoResultRGB[3] ) ; // { 0 , 0 , 0 }
+        // returns the hexcolor as a string "#FF0000"
+        // aoResultRGB also contains the result
+        // aDefaultRGB is used only if aDefaultHexRGB is NULL
+        // aDefaultRGB and aoResultRGB can be the same array
+        // returns NULL on cancel
+
+- This is not for android nor ios.
+- The code is pure C, perfectly compatible with C++.
+- the windows only wchar_t (utf-16) prototypes are in the header file
+- windows is fully supported from XP to 10 (maybe even older versions)
+- C# & LUA via dll, see files in the folder EXTRAS 
+- OSX supported from 10.4 to 10.12 (maybe even older versions)
+- Avoid using " and ' in titles and messages.
+- There's one file filter only, it may contain several patterns.
+- If no filter description is provided,
+  the list of patterns will become the description.
+- char const * filterPatterns[3] = { "*.obj" , "*.stl" , "*.dxf" } ;
+- On windows link against Comdlg32.lib and Ole32.lib
+  (on windows the no linking claim is a lie)
+  This linking is not compulsary for console mode (see header file).
+- On unix: it tries command line calls, so no such need (NO LINKING).
+- On unix you need applescript, zenity, matedialog, qarma, kdialog, Xdialog,
+  python2/tkinter or dialog (will open a terminal if running without console).
+- One of those is already included on most (if not all) desktops.
+- In the absence of those it will use gdialog, gxmessage or whiptail
+  with a textinputbox.
+- If nothing is found, it switches to basic console input,
+  it opens a console if needed (requires xterm + bash).
+- Use windows separators on windows and unix separators on unix.
+- String memory is preallocated statically for all the returned values.
+- File and path names are tested before return, they are valid.
+- If you pass only a path instead of path + filename,
+  make sure it ends with a separator.
+- tinyfd_forceConsole=1; at run time, forces dialogs into console mode.
+- On windows, console mode only make sense for console applications.
+- Mutiple selects are not allowed in console mode.
+- The package dialog must be installed to run in enhanced console mode.
+  It is already installed on most unix systems.
+- On osx, the package dialog can be installed via http://macports.org
+- On windows, for enhanced console mode,
+  dialog.exe should be copied somewhere on your executable path.
+  It can be found at the bottom of the following page:
+  http://andrear.altervista.org/home/cdialog.php
+- If dialog is missing, it will switch to basic console input.
+- You can query the type of dialog that will be use.
+- MinGW needs gcc >= v4.9 otherwise some headers are incomplete.
+
+- Here is the Hello World:
+            if a console is missing, it will use graphic dialogs
+            if a graphical display is absent, it will use console dialogs
+
+
+hello.c
+#include <stdio.h>
+#include <string.h>
+#include "tinyfiledialogs.h"
+int main()
+{
+	char const * lTmp;
+	char const * lTheSaveFileName;
+	char const * lTheOpenFileName;
+	char const * lTheSelectFolderName;
+	char const * lTheHexColor;
+	char const * lWillBeGraphicMode;
+	unsigned char lRgbColor[3];
+	FILE * lIn;
+	char lBuffer[1024];
+	char lThePassword[1024];
+	char const * lFilterPatterns[2] = { "*.txt", "*.text" };
+
+	lWillBeGraphicMode = tinyfd_inputBox("tinyfd_query", NULL, NULL);
+
+	if (lWillBeGraphicMode)
+	{
+		strcpy(lBuffer, "graphic mode: ");
+	}
+	else
+	{
+		strcpy(lBuffer, "console mode: ");
+	}
+
+	strcat(lBuffer, tinyfd_response);
+	strcpy(lThePassword, "tinyfiledialogs v");
+	strcat(lThePassword, tinyfd_version);
+	tinyfd_messageBox(lThePassword, lBuffer, "ok", "info", 0);
+
+	if ( lWillBeGraphicMode && ! tinyfd_forceConsole )
+	{
+		tinyfd_forceConsole = ! tinyfd_messageBox("Hello World",
+			"graphic dialogs [yes] / console mode [no]?",
+			"yesno", "question", 1);
+	}
+
+	lTmp = tinyfd_inputBox(
+		"a password box", "your password will be revealed", NULL);
+
+	if (!lTmp) return 1 ;
+
+	/* copy lTmp because saveDialog would overwrites
+	inputBox static buffer in basicinput mode */
+
+	strcpy(lThePassword, lTmp);
+
+	lTheSaveFileName = tinyfd_saveFileDialog(
+		"let us save this password",
+		"passwordFile.txt",
+		2,
+		lFilterPatterns,
+		NULL);
+
+	if (! lTheSaveFileName)
+	{
+		tinyfd_messageBox(
+			"Error",
+			"Save file name is NULL",
+			"ok",
+			"error",
+			1);
+		return 1 ;
+	}
+
+	lIn = fopen(lTheSaveFileName, "w");
+	if (!lIn)
+	{
+		tinyfd_messageBox(
+			"Error",
+			"Can not open this file in write mode",
+			"ok",
+			"error",
+			1);
+		return 1 ;
+	}
+	fputs(lThePassword, lIn);
+	fclose(lIn);
+
+	lTheOpenFileName = tinyfd_openFileDialog(
+		"let us read the password back",
+		"",
+		2,
+		lFilterPatterns,
+		NULL,
+		0);
+
+	if (! lTheOpenFileName)
+	{
+		tinyfd_messageBox(
+			"Error",
+			"Open file name is NULL",
+			"ok",
+			"error",
+			1);
+		return 1 ;
+	}
+
+	lIn = fopen(lTheOpenFileName, "r");
+
+	if (!lIn)
+	{
+		tinyfd_messageBox(
+			"Error",
+			"Can not open this file in read mode",
+			"ok",
+			"error",
+			1);
+		return(1);
+	}
+	lBuffer[0] = '\0';
+	fgets(lBuffer, sizeof(lBuffer), lIn);
+	fclose(lIn);
+
+	tinyfd_messageBox("your password is",
+			lBuffer, "ok", "info", 1);
+
+	lTheSelectFolderName = tinyfd_selectFolderDialog(
+		"let us just select a directory", NULL);
+
+	if (!lTheSelectFolderName)
+	{
+		tinyfd_messageBox(
+			"Error",
+			"Select folder name is NULL",
+			"ok",
+			"error",
+			1);
+		return 1;
+	}
+
+	tinyfd_messageBox("The selected folder is",
+		lTheSelectFolderName, "ok", "info", 1);
+
+	lTheHexColor = tinyfd_colorChooser(
+		"choose a nice color",
+		"#FF0077",
+		lRgbColor,
+		lRgbColor);
+
+	if (!lTheHexColor)
+	{
+		tinyfd_messageBox(
+			"Error",
+			"hexcolor is NULL",
+			"ok",
+			"error",
+			1);
+		return 1;
+	}
+
+	tinyfd_messageBox("The selected hexcolor is",
+		lTheHexColor, "ok", "info", 1);
+
+	return 0;
+}
+
+
+OSX :
+$ gcc -o hello.app hello.c tinyfiledialogs.c
+
+UNIX :
+$ gcc -o hello hello.c tinyfiledialogs.c
+( or clang tcc cc CC )
+
+MinGW (needs gcc >= v4.9 otherwise some headers are incomplete):
+> gcc -o hello.exe hello.c tinyfiledialogs.c -LC:/mingw/lib -lcomdlg32 -lole32
+(unfortunately some headers are missing with tcc)
+
+VisualStudio :
+    Create a console application project,
+    it links against Comdlg32.lib & Ole32.lib.
+
+</pre>

third-party/libtinyfiledialogs/files.xml

@@ -0,0 +1,12 @@
+<xml>
+	
+	<files id="native-toolkit-tinyfiledialogs">
+		
+		<compilerflag value="-I${NATIVE_TOOLKIT_PATH}/tinyfiledialogs" />
+		<compilerflag value="-D_CRT_SECURE_NO_WARNINGS" if="windows" />
+		
+		<file name="${NATIVE_TOOLKIT_PATH}/tinyfiledialogs/tinyfiledialogs.c" />
+		
+	</files>
+	
+</xml>

third-party/libtinyfiledialogs/tinyfiledialogs.h

@@ -0,0 +1,301 @@
+/*_________
+ /         \ tinyfiledialogs.h v2.9.3 [July 12, 2017] zlib licence
+ |tiny file| Unique header file created [November 9, 2014]
+ | dialogs | Copyright (c) 2014 - 2017 Guillaume Vareille http://ysengrin.com
+ \____  ___/ http://tinyfiledialogs.sourceforge.net
+      \|
+                                git://git.code.sf.net/p/tinyfiledialogs/code
+		 ______________________________________________
+		|                                              |
+		|     email: tinyfiledialogs@ysengrin.com      |
+		|______________________________________________|
+
+A big thank you to Don Heyse http://ldglite.sf.net for
+                   his code contributions, bug corrections & thorough testing!
+		
+            git://git.code.sf.net/p/tinyfiledialogs/code
+
+Please
+	1) let me know
+	- if you are including tiny file dialogs,
+	  I'll be happy to add your link to the list of projects using it.
+	- If you are using it on different hardware / OS / compiler.
+	2) leave a review on Sourceforge. Thanks.
+
+tiny file dialogs (cross-platform C C++)
+InputBox PasswordBox MessageBox ColorPicker
+OpenFileDialog SaveFileDialog SelectFolderDialog
+Native dialog library for WINDOWS MAC OSX GTK+ QT CONSOLE & more
+SSH supported via automatic switch to console mode or X11 forwarding
+
+One C file (add it to your C or C++ project) with 6 functions:
+- message & question
+- input & password
+- save file
+- open file(s)
+- select folder
+- color picker
+
+Complements OpenGL GLFW GLUT GLUI VTK SFML TGUI SDL Ogre Unity3d ION OpenCV
+CEGUI MathGL GLM CPW GLOW IMGUI MyGUI GLT NGL STB & GUI less programs
+
+NO INIT
+NO MAIN LOOP
+NO LINKING
+NO INCLUDE
+
+The dialogs can be forced into console mode
+
+Windows (XP to 10) ASCII MBCS UTF-8 UTF-16
+- native code & vbs create the graphic dialogs
+- enhanced console mode can use dialog.exe from
+http://andrear.altervista.org/home/cdialog.php
+- basic console input
+
+Unix (command line calls) ASCII UTF-8
+- applescript
+- zenity / matedialog / qarma (zenity for qt)
+- kdialog
+- Xdialog
+- python2 tkinter
+- dialog (opens a console if needed)
+- basic console input
+The same executable can run across desktops & distributions
+
+tested with C & C++ compilers
+on VisualStudio MinGW Mac Linux Bsd Solaris Minix Raspbian
+using Gnome Kde Enlightenment Mate Cinnamon Unity
+Lxde Lxqt Xfce WindowMaker IceWm Cde Jds OpenBox Awesome Jwm
+
+bindings for LUA and C# dll
+included in LWJGL(java), rust, Allegrobasic
+
+- License -
+
+This software is provided 'as-is', without any express or implied
+warranty.  In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+claim that you wrote the original software.  If you use this software
+in a product, an acknowledgment in the product documentation would be
+appreciated but is not required.
+2. Altered source versions must be plainly marked as such, and must not be
+misrepresented as being the original software.
+3. This notice may not be removed or altered from any source distribution.
+*/
+
+#ifndef TINYFILEDIALOGS_H
+#define TINYFILEDIALOGS_H
+
+/* #define TINYFD_NOLIB */
+/* On windows, define TINYFD_NOLIB here
+if you don't want to include the code creating the graphic dialogs.
+Then you won't need to link against Comdlg32.lib and Ole32.lib */
+
+/* if tinydialogs.c is compiled with a C++ compiler rather than with a C compiler
+(ie. you change the extension from .c to .cpp), you need to comment out:
+extern "C" {
+and the corresponding closing bracket near the end of this file:
+}
+*/
+#ifdef	__cplusplus
+extern "C" {
+#endif
+
+extern char tinyfd_version[8]; /* contains tinyfd current version number */
+
+#ifdef _WIN32
+/* for UTF-16 use the functions at the end of this files */
+extern int tinyfd_winUtf8; /* 0 (default) or 1 */
+/* on windows string char can be 0:MBSC or 1:UTF-8
+unless your code is really prepared for UTF-8 on windows, leave this on MBSC.
+Or you can use the UTF-16 (wchar) prototypes at the end of ths file.*/
+#endif
+
+extern int tinyfd_forceConsole ;  /* 0 (default) or 1 */
+/* for unix & windows: 0 (graphic mode) or 1 (console mode).
+0: try to use a graphic solution, if it fails then it uses console mode.
+1: forces all dialogs into console mode even when an X server is present,
+  if the package dialog (and a console is present) or dialog.exe is installed.
+  on windows it only make sense for console applications */
+
+extern char tinyfd_response[1024];
+/* if you pass "tinyfd_query" as aTitle,
+the functions will not display the dialogs
+but will return 0 for console mode, 1 for graphic mode.
+tinyfd_response is then filled with the retain solution.
+possible values for tinyfd_response are (all lowercase)
+for the graphic mode:
+  windows applescript zenity zenity3 matedialog qarma kdialog
+  xdialog tkinter gdialog gxmessage xmessage
+for the console mode:
+  dialog whiptail basicinput */
+
+int tinyfd_messageBox (
+	char const * const aTitle , /* "" */
+	char const * const aMessage , /* "" may contain \n \t */
+	char const * const aDialogType , /* "ok" "okcancel" "yesno" "yesnocancel" */
+	char const * const aIconType , /* "info" "warning" "error" "question" */
+	int const aDefaultButton ) ;
+		/* 0 for cancel/no , 1 for ok/yes , 2 for no in yesnocancel */
+
+char const * tinyfd_inputBox (
+	char const * const aTitle , /* "" */
+	char const * const aMessage , /* "" may NOT contain \n \t on windows */
+	char const * const aDefaultInput ) ;  /* "" , if NULL it's a passwordBox */
+		/* returns NULL on cancel */
+
+char const * tinyfd_saveFileDialog (
+	char const * const aTitle , /* "" */
+	char const * const aDefaultPathAndFile , /* "" */
+	int const aNumOfFilterPatterns , /* 0 */
+	char const * const * const aFilterPatterns , /* NULL | {"*.jpg","*.png"} */
+	char const * const aSingleFilterDescription ) ; /* NULL | "text files" */
+		/* returns NULL on cancel */
+
+char const * tinyfd_openFileDialog (
+	char const * const aTitle , /* "" */
+	char const * const aDefaultPathAndFile , /* "" */
+	int const aNumOfFilterPatterns , /* 0 */
+	char const * const * const aFilterPatterns , /* NULL {"*.jpg","*.png"} */
+	char const * const aSingleFilterDescription , /* NULL | "image files" */
+	int const aAllowMultipleSelects ) ; /* 0 or 1 */
+		/* in case of multiple files, the separator is | */
+		/* returns NULL on cancel */
+
+char const * tinyfd_selectFolderDialog (
+	char const * const aTitle , /* "" */
+	char const * const aDefaultPath ) ; /* "" */
+		/* returns NULL on cancel */
+
+char const * tinyfd_colorChooser(
+	char const * const aTitle , /* "" */
+	char const * const aDefaultHexRGB , /* NULL or "#FF0000" */
+	unsigned char const aDefaultRGB[3] , /* { 0 , 255 , 255 } */
+	unsigned char aoResultRGB[3] ) ; /* { 0 , 0 , 0 } */
+		/* returns the hexcolor as a string "#FF0000" */
+		/* aoResultRGB also contains the result */
+		/* aDefaultRGB is used only if aDefaultHexRGB is NULL */
+		/* aDefaultRGB and aoResultRGB can be the same array */
+		/* returns NULL on cancel */
+
+
+/************ NOT CROSS PLATFORM SECTION STARTS HERE ************************/
+#ifdef _WIN32
+#ifndef TINYFD_NOLIB
+
+/* windows only - utf-16 version */
+int tinyfd_messageBoxW(
+	wchar_t const * const aTitle ,
+	wchar_t const * const aMessage, /* "" may contain \n \t */
+	wchar_t const * const aDialogType, /* "ok" "okcancel" "yesno" */
+	wchar_t const * const aIconType, /* "info" "warning" "error" "question" */
+	int const aDefaultButton ); /* 0 for cancel/no , 1 for ok/yes */
+		/* returns 0 for cancel/no , 1 for ok/yes */
+
+/* windows only - utf-16 version */
+wchar_t const * tinyfd_saveFileDialogW(
+	wchar_t const * const aTitle, /* NULL or "" */
+	wchar_t const * const aDefaultPathAndFile, /* NULL or "" */
+	int const aNumOfFilterPatterns, /* 0 */
+	wchar_t const * const * const aFilterPatterns, /* NULL or {"*.jpg","*.png"} */
+	wchar_t const * const aSingleFilterDescription); /* NULL or "image files" */
+		/* returns NULL on cancel */
+
+/* windows only - utf-16 version */
+wchar_t const * tinyfd_openFileDialogW(
+	wchar_t const * const aTitle, /* "" */
+	wchar_t const * const aDefaultPathAndFile, /* "" */
+	int const aNumOfFilterPatterns , /* 0 */
+	wchar_t const * const * const aFilterPatterns, /* NULL {"*.jpg","*.png"} */
+	wchar_t const * const aSingleFilterDescription, /* NULL | "image files" */
+	int const aAllowMultipleSelects ) ; /* 0 or 1 */
+		/* in case of multiple files, the separator is | */
+		/* returns NULL on cancel */
+
+/* windows only - utf-16 version */
+	wchar_t const * tinyfd_selectFolderDialogW(
+	wchar_t const * const aTitle, /* "" */
+	wchar_t const * const aDefaultPath); /* "" */
+		/* returns NULL on cancel */
+
+/* windows only - utf-16 version */
+wchar_t const * tinyfd_colorChooserW(
+	wchar_t const * const aTitle, /* "" */
+	wchar_t const * const aDefaultHexRGB, /* NULL or "#FF0000" */
+	unsigned char const aDefaultRGB[3] , /* { 0 , 255 , 255 } */
+	unsigned char aoResultRGB[3] ) ; /* { 0 , 0 , 0 } */
+		/* returns the hexcolor as a string "#FF0000" */
+		/* aoResultRGB also contains the result */
+		/* aDefaultRGB is used only if aDefaultHexRGB is NULL */
+		/* aDefaultRGB and aoResultRGB can be the same array */
+		/* returns NULL on cancel */
+
+
+#endif /*TINYFD_NOLIB*/
+#else /*_WIN32*/
+
+/* unix zenity only */
+char const * tinyfd_arrayDialog(
+	char const * const aTitle , /* "" */
+	int const aNumOfColumns , /* 2 */
+	char const * const * const aColumns, /* {"Column 1","Column 2"} */
+	int const aNumOfRows, /* 2*/
+	char const * const * const aCells);
+		/* {"Row1 Col1","Row1 Col2","Row2 Col1","Row2 Col2"} */
+
+#endif /*_WIN32 */
+
+#ifdef	__cplusplus
+}
+#endif
+
+#endif /* TINYFILEDIALOGS_H */
+
+/*
+- This is not for android nor ios.
+- The code is pure C, perfectly compatible with C++.
+- the windows only wchar_t (utf-16) prototypes are in the header file
+- windows is fully supported from XP to 10 (maybe even older versions)
+- C# & LUA via dll, see example files
+- OSX supported from 10.4 to 10.11 (maybe even older versions)
+- Avoid using " and ' in titles and messages.
+- There's one file filter only, it may contain several patterns.
+- If no filter description is provided,
+  the list of patterns will become the description.
+- char const * filterPatterns[3] = { "*.obj" , "*.stl" , "*.dxf" } ;
+- On windows link against Comdlg32.lib and Ole32.lib
+  This linking is not compulsary for console mode (see above).
+- On unix: it tries command line calls, so no such need.
+- On unix you need applescript, zenity, matedialog, qarma, kdialog, Xdialog,
+  python2/tkinter or dialog (will open a terminal if running without console).
+- One of those is already included on most (if not all) desktops.
+- In the absence of those it will use gdialog, gxmessage or whiptail
+  with a textinputbox.
+- If nothing is found, it switches to basic console input,
+  it opens a console if needed (requires xterm + bash).
+- Use windows separators on windows and unix separators on unix.
+- String memory is preallocated statically for all the returned values.
+- File and path names are tested before return, they are valid.
+- If you pass only a path instead of path + filename,
+  make sure it ends with a separator.
+- tinyfd_forceConsole=1; at run time, forces dialogs into console mode.
+- On windows, console mode only make sense for console applications.
+- Mutiple selects are not allowed in console mode.
+- The package dialog must be installed to run in enhanced console mode.
+  It is already installed on most unix systems.
+- On osx, the package dialog can be installed via http://macports.org
+- On windows, for enhanced console mode,
+  dialog.exe should be copied somewhere on your executable path.
+  It can be found at the bottom of the following page:
+  http://andrear.altervista.org/home/cdialog.php
+- If dialog is missing, it will switch to basic console input.
+- You can query the type of dialog that will be use.
+- MinGW needs gcc >= v4.9 otherwise some headers are incomplete.
+- The Hello World (and a bit more) is on the sourceforge site:
+*/

vendor.yaml

@@ -35,3 +35,7 @@ third-party/tree-sitter:
   git: https://github.com/tree-sitter/tree-sitter/tree/v0.20.8
 third-party/replxx:
   git: https://github.com/AmokHuginnsson/replxx/commit/1f149bfe20bf6e49c1afd4154eaf0032c8c2fda2
+third-party/libtinyfiledialogs:
+  git: https://github.com/native-toolkit/libtinyfiledialogs/commit/cc6b593c029110af8045826ce691f540c85e850c
+  alternatives:
+    - https://github.com/btzy/nativefiledialog-extended (only file dialog support though!)