Merge pull request #27 from matyalatte/unix_support

matyalatte · web-flow · commit dfccb8434765 · 2024-03-03T12:24:22.000+09:00
Unix support
diff --git a/docs/Build-on-Other.md b/docs/Build-on-Other.md
@@ -0,0 +1,81 @@
+# Building Workflow for Other Platforms
+
+You can build tuw on other Unix-like systems, not only Linux.  
+The workflow is the same as Linux.  
+
+## Requirements
+
+-   C++ compiler
+-   GTK+ 3.10 or later
+-   Ninja
+-   [Meson](https://github.com/mesonbuild/meson) (**0.58** or later)
+-   bash
+-   Shell scripts in [`./Tuw/shell_scripts`](../shell_scripts)
+
+## FreeBSD
+
+On FreeBSD, You can get all the required tools with `pkg`.
+
+```shell
+pkg install git bash pkgconf meson ninja
+git clone https://github.com/matyalatte/tuw.git
+cd tuw
+bash shell_scripts/build.sh
+./build/Release/Tuw
+```
+
+## OpenBSD
+
+On OpenBSD, You can get all the required tools with `pkg_add`.
+
+```shell
+pkg_add bash meson ninja
+git clone https://github.com/matyalatte/tuw.git
+cd tuw
+bash shell_scripts/build.sh
+./build/Release/Tuw
+```
+
+## NetBSD
+
+On NetBSD, You can get all the required tools with `pkgin`.
+
+```shell
+pkgin in git mozilla-rootcerts-openssl bash pkgconf meson ninja
+git clone https://github.com/matyalatte/tuw.git
+cd tuw
+bash shell_scripts/build.sh
+./build/Release/Tuw
+```
+
+If you get linker errors, try to disalble LTO with `b_lto = false` in `./presets/release.ini`.
+
+## Haiku
+
+On Haiku, You can get all the required tools with `pkgman`.
+
+```shell
+pkgman install meson ninja gtk3_devel
+git clone https://github.com/matyalatte/tuw.git
+cd tuw
+bash shell_scripts/build.sh
+./build/Release/Tuw
+```
+
+> [!WARNING]  
+> Note that GTK on Haiku is still a WIP project.
+> Some features might not work properly.
+> As far as I know, drag-drop events are not supported yet.
+
+You can also use [the Haiku theme for GTK](https://github.com/B00merang-Project/Haiku) if you don't like the default theme.  
+
+```
+mkdir -p /boot/home/config/non-packaged/data/themes
+cd /boot/home/config/non-packaged/data/themes
+git clone https://github.com/B00merang-Project/Haiku.git
+
+# replace `gtk-theme='Adwaita'` with `gtk-theme='Haiku'`
+nano /boot/system/non-packaged/data/glib-2.0/schemas/00_org.gnome.desktop.interface.gschema.override
+
+glib-compile-schemas /boot/system/non-packaged/data/glib-2.0/schemas
+```
diff --git a/docs/Building.md b/docs/Building.md
@@ -7,7 +7,7 @@ You can build it on the following platforms.
 
 -   Windows 7 or later  
 -   macOS 10.9 or later  
--   Linux with GTK+ 3.10 or later  
+-   Unix with GTK+ 3.10 or later  
 
 You can also see the list of tested platforms [here](./Test-Env.md).
 
@@ -18,6 +18,7 @@ There are platform-specific documents for building the executable with [Meson](h
 -   [Building Workflow for Windows](./Build-on-Windows.md)  
 -   [Building Workflow for macOS](./Build-on-Mac.md)  
 -   [Building Workflow for Linux](./Build-on-Linux.md)  
+-   [Building Workflow for Other Platforms](./Build-on-Other.md)  
 
 You can also see [batch files](../batch_files/) and [shell scripts](../shell_scripts/) to understand the workflow.  
 
diff --git a/docs/README.md b/docs/README.md
@@ -29,7 +29,7 @@ All you need is a JSON file and a tiny executable.
 -   [Embed JSON into exe](../examples/get_start/json_embed/)
 -   Save arguments
 -   Input paths by drag and drop
--   Cross-platform
+-   Cross-platform (Windows, macOS, Linux, BSD, etc.)
 -   Native look and feel
 -   Portable
 -   Small size
diff --git a/docs/Test-Env.md b/docs/Test-Env.md
@@ -22,3 +22,7 @@ Here is the list of test environments.
 | Alpine3.16 | x64 | gcc | musl | :heavy_check_mark: | :x: | :heavy_check_mark: |
 | Alpine3.16 | arm64 | gcc | musl | :heavy_check_mark: | :x: | :heavy_check_mark: |
 | Alpine3.18 | x64 |  | musl | :x: | :warning: | :x: |
+| FreeBSD14.0 | x64 | gcc | | :warning: | :warning: | :warning: |
+| OpenBSD7.4 | x64 | clang | | :warning: | :warning: | :warning: |
+| NetBSD9.3 | x64 | gcc | | :warning: | :warning: | :warning: |
+| Haiku R1/beta4 | x64 | gcc | | :warning: | :warning: | :x: |
diff --git a/docs/changelog.txt b/docs/changelog.txt
@@ -1,3 +1,8 @@
+ver 0.6.3
+- Supported Unix-like systems (FreeBSD, Haiku, etc).
+- Added URL validation for safety.
+  (You can not open help URLs contain some special characters.)
+
 ver 0.6.2
 - Fixed typos.
 - Fixed a bug that the menu can be empty on macOS.
diff --git a/include/main_frame.h b/include/main_frame.h
@@ -13,6 +13,9 @@ class MainFrame {
     int m_definition_id;
     rapidjson::Document m_config;
     uiWindow* m_mainwin;
+#ifdef __TUW_UNIX__
+    uiWindow* m_logwin;
+#endif
 
     std::vector<Component*> m_components;
     uiGrid* m_grid;
@@ -40,8 +43,12 @@ class MainFrame {
     void SaveConfig();
     void Fit();
     void Close() {
-        if (m_mainwin == NULL) return;
-        uiControlDestroy(uiControl(m_mainwin));
+        if (m_mainwin != NULL)
+            uiControlDestroy(uiControl(m_mainwin));
+    #ifdef __TUW_UNIX__
+        if (m_logwin != NULL)
+            uiControlDestroy(uiControl(m_logwin));
+    #endif
     }
     int IsSafeMode() { return uiMenuItemChecked(m_menu_item); }
 };
diff --git a/include/string_utils.h b/include/string_utils.h
@@ -8,7 +8,7 @@ uint32_t Fnv1Hash32(const std::string& str);
 std::string UTF16toUTF8(const wchar_t* str);
 std::wstring UTF8toUTF16(const char* str);
 void PrintFmt(const char* fmt, ...);
-#elif defined(__linux__)
+#elif defined(__TUW_UNIX__)
 void SetLogEntry(void* log_entry);
 void PrintFmt(const char* fmt, ...);
 #else
diff --git a/include/tuw_constants.h b/include/tuw_constants.h
@@ -10,8 +10,8 @@ namespace tuw_constants {
         "       CLI tools\n";
     constexpr char TOOL_NAME[] = "Tuw";
     constexpr char AUTHOR[] = "matyalatte";
-    constexpr char VERSION[] = "0.6.2";
-    constexpr int VERSION_INT = 602;
+    constexpr char VERSION[] = "0.6.3";
+    constexpr int VERSION_INT = 603;
 
 #ifdef _WIN32
     constexpr char OS[] = "win";
@@ -22,7 +22,7 @@ namespace tuw_constants {
     const int BOX_CHECKS_SPACE = 0;
     const int BTN_WIDTH = 90;
     const int BTN_HEIGHT = 24;
-#elif defined(__linux__)
+#elif defined(__TUW_UNIX__)
     constexpr char OS[] = "linux";
     const int GRID_COMP_XSPACE = 4;
     const int GRID_MAIN_SPACE = 12;
diff --git a/meson.build b/meson.build
@@ -77,10 +77,12 @@ elif tuw_OS == 'darwin'
         warning('This project has NOT been tested with your compiler. (' + tuw_compiler + ')')
     endif
 else
-    if tuw_OS != 'linux'
-        warning('This OS is unsupported. (' + tuw_OS + ')')
+    if tuw_OS == 'haiku'
+        tuw_link_args += ['-lbe']
+        tuw_cpp_args += ['-D__TUW_HAIKU__']
     endif
     tuw_link_args += ['-no-pie']
+    tuw_cpp_args += ['-D__TUW_UNIX__']
     if tuw_compiler != 'gcc'
         warning('This project has NOT been tested with your compiler. (' + tuw_compiler + ')')
     endif
@@ -98,7 +100,7 @@ if tuw_OS != 'windows'
         tuw_cpp_args += ['-ffunction-sections', '-fdata-sections']
         if tuw_compiler == 'gcc'
             tuw_link_args += ['-Wl,--gc-sections']
-        elif tuw_compiler.startswith('clang')
+        elif tuw_compiler.startswith('clang') and tuw_OS == 'darwin'
             tuw_link_args += ['-Wl,-dead_strip']
         endif
     endif
diff --git a/src/env_utils.cpp b/src/env_utils.cpp
@@ -12,6 +12,13 @@
 #ifdef __APPLE__
 #include <mach-o/dyld.h>
 #endif
+#ifdef __FreeBSD__
+#include <sys/param.h>
+#include <sys/sysctl.h>  // for GetExecutablePathFreeBSD()
+#endif
+#ifdef __TUW_HAIKU__
+#include <kernel/image.h>  // for GetExecutablePathHaiku()
+#endif
 #include <sys/stat.h>
 #include <unistd.h>
 #include <pwd.h>
@@ -99,25 +106,79 @@ namespace env_utils {
         }
     }
 
+#ifdef __TUW_UNIX__
+#ifdef __FreeBSD__
+    // FreeBSD requires sysctl to get the executable path.
+    void GetExecutablePathFreeBSD(char *path) {
+        size_t path_size = PATH_MAX;
+        int mib[] = { CTL_KERN, KERN_PROC, KERN_PROC_PATHNAME, -1 };
+        int error = sysctl(mib, 4, path, &path_size, NULL, 0);
+        if (error < 0 || path_size == 0)
+            path_size = 0;
+        path[path_size] = 0;
+    }
+
     std::string GetExecutablePath() {
         char path[PATH_MAX + 1];
         path[PATH_MAX] = 0;
-    #ifdef __linux__
-        const size_t LINKSIZE = 100;
-        char link[LINKSIZE];
-        snprintf(link, LINKSIZE, "/proc/%d/exe", getpid() );
-        int path_size = readlink(link, path, PATH_MAX);
-        if (path_size == -1)
-            path_size = 0;
+        GetExecutablePathFreeBSD(path);
+        if (path[0] == 0)
+            return "/";
+        return path;
+    }
+#elif defined(__TUW_HAIKU__)
+    // Haiku OS requires its own API to get the executable path.
+    std::string GetExecutablePath() {
+        int32_t cookie = 0;
+        image_info info;
+        while (get_next_image_info(B_CURRENT_TEAM, &cookie, &info) == B_OK) {
+            if (info.type == B_APP_IMAGE)
+                return info.name;
+        }
+        return "/";
+    }
+#else
+    // Linux distributons support readlink to get the executable path.
+    int TryReadlink(const char *link, char *path, int path_size) {
+        int new_path_size;
+        if (path_size != 0)
+            return path_size;
+        new_path_size = readlink(link, path, PATH_MAX);
+        if (new_path_size == -1)
+            new_path_size = 0;
+        return new_path_size;
+    }
+
+    void GetExecutablePathUnix(char *path) {
+        int path_size = 0;
+        path_size = TryReadlink("/proc/self/exe", path, path_size);  // Linux
+        path_size = TryReadlink("/proc/curproc/exe", path, path_size);  // NetBSD
+        path_size = TryReadlink("/proc/curproc/file", path, path_size);  // OpenBSD
         path[path_size] = 0;
-    #else
+    }
+
+    std::string GetExecutablePath() {
+        char path[PATH_MAX + 1];
+        path[PATH_MAX] = 0;
+        GetExecutablePathUnix(path);
+        if (path[0] == 0)
+            return "/";
+        return path;
+    }
+#endif
+#endif  // __TUW_UNIX__
+
+#ifdef __APPLE__
+    std::string GetExecutablePath() {
+        char path[PATH_MAX + 1];
+        path[PATH_MAX] = 0;
         uint32_t bufsize = PATH_MAX;
         _NSGetExecutablePath(path, &bufsize);
-    #endif
         if (path[0] == 0)
             return "/";
         return path;
     }
+#endif
 
     bool FileExists(const std::string& path) {
         struct stat buffer;
diff --git a/src/exec.cpp b/src/exec.cpp
@@ -134,9 +134,11 @@ ExecuteResult LaunchDefaultApp(const std::string& url) {
 #ifdef _WIN32
     std::wstring utf16_url = UTF8toUTF16(url.c_str());
     const wchar_t* argv[] = {L"cmd.exe", L"/c", L"start", utf16_url.c_str(), NULL};
-#elif defined(__linux__)
+#elif defined(__TUW_UNIX__) && !defined(__TUW_HAIKU__)
+    // Linux and BSD
     const char* argv[] = {"xdg-open", url.c_str(), NULL};
 #else
+    // macOS and Haiku OS
     const char* argv[] = {"open", url.c_str(), NULL};
 #endif
     struct subprocess_s process;
diff --git a/src/main.cpp b/src/main.cpp
@@ -25,7 +25,7 @@ int main_app() {
         return 1;
     }
 
-#ifdef __linux__
+#ifdef __TUW_UNIX__
     // Need this for uiMainStep(1)
     uiMainSteps();
 #endif
diff --git a/src/main_frame.cpp b/src/main_frame.cpp
diff --git a/src/string_utils.cpp b/src/string_utils.cpp
diff --git a/subprojects/libui.wrap b/subprojects/libui.wrap
diff --git a/tests/json_check/main.cpp b/tests/json_check/main.cpp
diff --git a/tests/main_frame/main.cpp b/tests/main_frame/main.cpp

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ int main_app() {`
`25`	`25`	`return 1;`
`26`	`26`	`}`
`27`	`27`
`28`		`-#ifdef __linux__`
	`28`	`+#ifdef __TUW_UNIX__`
`29`	`29`	`// Need this for uiMainStep(1)`
`30`	`30`	`uiMainSteps();`
`31`	`31`	`#endif`