add runtime base folder button in settings panel

Author: Gin

Common/Cpp/Options/ButtonOption.h

@@ -78,15 +78,15 @@ class ButtonOption : public ButtonCell{
     ~ButtonOption();
     ButtonOption(const ButtonOption& x) = delete;
     ButtonOption(
-        std::string label,
-        std::string text,
+        std::string label,  // the description of the button, shown on the left side of the button
+        std::string text,   // the text appearing on the button
         int button_height = 0,
         int text_size = 0
     );
     ButtonOption(
-        std::string label,
+        std::string label,  // the description of the button, shown on the left side of the button
         Enabled state,
-        std::string text,
+        std::string text,   // the text appearing on the button
         int button_height = 0,
         int text_size = 0
     );

SerialPrograms/CMakeLists.txt

@@ -1,6 +1,6 @@
 # Set the minimum cmake version required
 cmake_minimum_required(VERSION 3.18.0)
-
+ 
 # Tell CMake to re-run configuration when these files change (get around Qt issues with stale CMake files)
 set(_cmake_files_to_watch
     "${CMAKE_SOURCE_DIR}/CMakeLists.txt"
@@ -77,7 +77,6 @@ else()
     set(FIRMWARE_DIR "${PACKAGES_DIR}/PABotBase/PABotBase-Switch")
     set(SCRIPTS_DIR "${PACKAGES_DIR}/SerialPrograms/Scripts")
     set(RESOURCES_DIR "${PACKAGES_DIR}/SerialPrograms/Resources")
-
     if(PACKAGE_BUILD)
         set(DEST_DIR "$<TARGET_FILE_DIR:SerialPrograms>/Output")
         set(DEPLOY_DIR "${DEST_DIR}/Binaries64")
@@ -88,7 +87,6 @@ else()
 
     set(DEPLOY_FILES TRUE)
 endif()
-
 #Find threads library
 set(THREADS_PREFER_PTHREAD_FLAG ON)
 find_package(Threads REQUIRED)
@@ -99,7 +97,7 @@ if(NOT QT_MAJOR)
 endif()
 
 # Make sure CI builds work without going overboard with per-platform directory shenanigans
-if(NOT DEPLOY_FILES)
+if(NOT WIN32 OR NOT DEPLOY_FILES)
     find_package(Qt${QT_MAJOR} COMPONENTS Widgets SerialPort Multimedia MultimediaWidgets REQUIRED)
 endif()
 

SerialPrograms/Source/CommonFramework/GlobalSettingsPanel.cpp

@@ -8,6 +8,8 @@
 #include <set>
 #include <QStandardPaths>
 #include <QCryptographicHash>
+#include <QDesktopServices>
+#include <QUrl>
 #include "Common/Cpp/Containers/Pimpl.tpp"
 #include "Common/Cpp/LifetimeSanitizer.h"
 #include "Common/Cpp/Json/JsonValue.h"
@@ -99,10 +101,15 @@ GlobalSettings& GlobalSettings::instance(){
 }
 GlobalSettings::~GlobalSettings(){
     ENABLE_LIFETIME_SANITIZER0.remove_listener(*this);
+    OPEN_BASE_FOLDER_BUTTON.remove_listener(static_cast<ButtonListener&>(*this));
 }
 GlobalSettings::GlobalSettings()
     : BatchOption(LockMode::LOCK_WHILE_RUNNING)
     , CHECK_FOR_UPDATES(CONSTRUCT_TOKEN)
+    , OPEN_BASE_FOLDER_BUTTON(
+        "<b>Runtime Base Folder:</b>",
+        "Open Folder"
+    )
     , STATS_FILE(
         false,
         "<b>Stats File:</b><br>Use the stats file here. Multiple instances of the program can use the same file.",
@@ -211,6 +218,7 @@ GlobalSettings::GlobalSettings()
         "", ""
     )
 {
+    PA_ADD_OPTION(OPEN_BASE_FOLDER_BUTTON);
     PA_ADD_OPTION(CHECK_FOR_UPDATES);
     PA_ADD_OPTION(STATS_FILE);
     PA_ADD_OPTION(TEMP_FOLDER);
@@ -257,6 +265,7 @@ GlobalSettings::GlobalSettings()
 
     GlobalSettings::on_config_value_changed(this);
     ENABLE_LIFETIME_SANITIZER0.add_listener(*this);
+    OPEN_BASE_FOLDER_BUTTON.add_listener(static_cast<ButtonListener&>(*this));
 }
 
 void GlobalSettings::load_json(const JsonValue& json){
@@ -382,6 +391,11 @@ void GlobalSettings::on_config_value_changed(void* object){
     }
 }
 
+void GlobalSettings::on_press(){
+    // Open the runtime base folder in the system file manager
+    QDesktopServices::openUrl(QUrl::fromLocalFile(QString::fromStdString(RUNTIME_BASE_PATH())));
+}
+
 
 
 

SerialPrograms/Source/CommonFramework/GlobalSettingsPanel.h

@@ -12,6 +12,7 @@
 #include "Common/Cpp/Options/ConfigOption.h"
 #include "Common/Cpp/Options/StaticTextOption.h"
 #include "Common/Cpp/Options/BooleanCheckBoxOption.h"
+#include "Common/Cpp/Options/ButtonOption.h"
 //#include "Common/Cpp/Options/SimpleIntegerOption.h"
 #include "Common/Cpp/Options/StringOption.h"
 #include "CommonFramework/Panels/SettingsPanel.h"
@@ -76,7 +77,7 @@ class PreloadSettings{
 
 
 
-class GlobalSettings : public BatchOption, private ConfigOption::Listener{
+class GlobalSettings : public BatchOption, private ConfigOption::Listener, private ButtonListener{
     ~GlobalSettings();
     GlobalSettings();
 public:
@@ -87,10 +88,12 @@ class GlobalSettings : public BatchOption, private ConfigOption::Listener{
 
 private:
     virtual void on_config_value_changed(void* object) override;
+    virtual void on_press() override;
 
 public:
     Pimpl<CheckForUpdatesOption> CHECK_FOR_UPDATES;
 
+    ButtonOption OPEN_BASE_FOLDER_BUTTON;
     StringOption STATS_FILE;
     FolderInputOption TEMP_FOLDER;
 

SerialPrograms/Source/CommonFramework/Globals.cpp

@@ -147,11 +147,6 @@ std::string get_runtime_base_path(){
     return "./";
 }
 
-const std::string& RUNTIME_BASE_PATH(){
-    static std::string path = get_runtime_base_path();
-    return path;
-}
-
 std::string get_setting_path(){
     return RUNTIME_BASE_PATH() + "UserSettings/";
 }
@@ -170,6 +165,11 @@ std::string get_user_file_path(){
 
 } // anonymous namespace
 
+const std::string& RUNTIME_BASE_PATH(){
+    static std::string path = get_runtime_base_path();
+    return path;
+}
+
 const std::string& SETTINGS_PATH(){
     static std::string path = get_setting_path();
     return path;

SerialPrograms/Source/CommonFramework/Globals.h

@@ -2,6 +2,12 @@
  *
  *  From: https://github.com/PokemonAutomation/
  *
+ *  Defines basic program related const values (version numbers, program names, URLs, etc.)
+ *  and paths to various folders (setting folder, screenshot folder, etc.).
+ *  CAUTION: since the program's runtime base path is initialized only after Qt is initialized,
+ *  do not call any path functions defined here until after Qt is initialized in the main function.
+ * 
+ *  Also defines program state enum and program feedback type enum.
  */
 
 #ifndef PokemonAutomation_Globals_H
@@ -37,6 +43,9 @@ extern const std::string COMPILER_VERSION;
 
 extern const size_t LOG_HISTORY_LINES;
 
+// Path to the parent folder that holds all other folders, e.g. settings folder, screenshot folder, etc. 
+const std::string& RUNTIME_BASE_PATH();
+
 // Folder path (end with "/") to hold program setting files.
 const std::string& SETTINGS_PATH();
 // The setting JSON file path. This path is a child of the folder SETTINGS_PATH().