Remove QWidget from ConfigOption.

Author: Mysticial

Common/Cpp/Options/ConfigOption.h

@@ -13,8 +13,6 @@
 #include "Common/Cpp/Containers/Pimpl.h"
 #include "Common/Cpp/UiWrapper.h"
 
-class QWidget;
-
 namespace PokemonAutomation{
 
 class JsonValue;
@@ -139,7 +137,6 @@ class ConfigOption{
 
 public:
     virtual UiWrapper make_UiComponent(void* params) = 0;
-    ConfigWidget* make_QtWidget(QWidget& parent);
 
 private:
     struct Data;
@@ -159,7 +156,13 @@ class ConfigOption{
 template <typename OptionType>
 using ConfigUiFactory = UiWrapper (*)(OptionType& option, void* params);
 
-
+//
+//  This is a convenience class that implementations should inherit from instead
+//  of directly inheriting from ConfigOption or another option type.
+//
+//  This provides the per-type UI factory as well as the "make_UiComponent"
+//  override. This saves a ton of copy-paste as those are the same eveywhere.
+//
 template <typename ConfigType, typename ParentType = ConfigOption>
 class ConfigOptionImpl : public ParentType{
 public:

Common/Cpp/UiWrapper.h

@@ -25,20 +25,11 @@ class UiComponent{
 //  Lightweight smart pointer to avoid pulling in <memory>.
 class UiWrapper{
 public:
-    UiWrapper()
-        : m_owns(false)
-        , m_component(nullptr)
-    {}
-    UiWrapper(bool take_ownership, UiComponent* component)
-        : m_owns(take_ownership)
-        , m_component(component)
-    {}
     ~UiWrapper(){
         if (m_owns){
             delete m_component;
         }
     }
-
     UiWrapper(UiWrapper&& x)
         : m_owns(x.m_owns)
         , m_component(x.m_component)
@@ -60,6 +51,25 @@ class UiWrapper{
     void operator=(const UiWrapper& x) = delete;
 
 
+public:
+    UiWrapper()
+        : m_owns(false)
+        , m_component(nullptr)
+    {}
+    UiWrapper(bool take_ownership, UiComponent* component)
+        : m_owns(take_ownership)
+        , m_component(component)
+    {}
+
+    bool is_owning() const{
+        return m_owns;
+    }
+    UiComponent* release(){
+        m_owns = false;
+        return m_component;
+    }
+
+
 public:
     operator bool() const{
         return m_component != nullptr;

Common/Qt/Options/ConfigWidget.cpp

@@ -17,32 +17,15 @@ namespace PokemonAutomation{
 
 
 ConfigWidget* ConfigWidget::make_from_option(ConfigOption& option, QWidget* parent){
-    ConfigWidget* widget = nullptr;
-
-    //  This always returns a widget that is owned by a parent.
-    //  So the pointer can be released here.
     UiWrapper wrapper = option.make_UiComponent(parent);
-    if (wrapper){
-        widget = dynamic_cast<ConfigWidget*>(wrapper.get());
-    }
-    if (widget){
-        return widget;
-    }
-
-    if (widget == nullptr){
+    if (!wrapper){
         throw InternalProgramError(
             nullptr,
             PA_CURRENT_FUNCTION,
             std::string("UI component not registered for type: ") + typeid(option).name()
         );
     }
-
-    return widget;
-}
-
-
-ConfigWidget* ConfigOption::make_QtWidget(QWidget& parent){
-    return ConfigWidget::make_from_option(*this, &parent);
+    return dynamic_cast<ConfigWidget*>(wrapper.release());
 }
 
 

Common/Qt/Options/ConfigWidget.h

@@ -9,6 +9,8 @@
 
 #include "Common/Cpp/Options/ConfigOption.h"
 
+class QWidget;
+
 namespace PokemonAutomation{
 
 
@@ -25,7 +27,6 @@ namespace PokemonAutomation{
 //  pointer can get the actual QWidget.
 class ConfigWidget : public UiComponent, protected ConfigOption::Listener{
 public:
-    //  Temporary for refactoring.
     static ConfigWidget* make_from_option(ConfigOption& option, QWidget* parent);
 
 

SerialPrograms/Source/CommonFramework/Panels/UI/SettingsPanelWidget.cpp

@@ -56,9 +56,8 @@ QWidget* SettingsPanelWidget::make_options(QWidget& parent){
     QVBoxLayout* options_layout = new QVBoxLayout(options_widget);
     options_layout->setAlignment(Qt::AlignTop);
 
-
     SettingsPanelInstance& instance = static_cast<SettingsPanelInstance&>(m_instance);
-    m_options = static_cast<BatchWidget*>(instance.m_options.make_QtWidget(parent));
+    m_options = static_cast<BatchWidget*>(ConfigWidget::make_from_option(instance.m_options, &parent));
     options_layout->addWidget(m_options);
     options_layout->addStretch();
 

SerialPrograms/Source/ComputerPrograms/Framework/ComputerProgramWidget.cpp

@@ -59,7 +59,7 @@ ComputerProgramWidget::ComputerProgramWidget(
         QVBoxLayout* scroll_layout = new QVBoxLayout(scroll_inner);
         scroll_layout->setAlignment(Qt::AlignTop);
 
-        m_options = option.options().make_QtWidget(*this);
+        m_options = ConfigWidget::make_from_option(option.options(), this);
         scroll_layout->addWidget(&m_options->widget());
 
         scroll_layout->addStretch(1);

SerialPrograms/Source/ML/Programs/ML_LabelImagesWidget.cpp

@@ -112,14 +112,14 @@ LabelImages_Widget::LabelImages_Widget(
     scroll_layout->addLayout(annotation_row);
 
     // add a dropdown menu for user to pick whether to choose from pokemon form label or custom label
-    ConfigWidget* label_type_widget = program.LABEL_TYPE.make_QtWidget(*scroll_inner);
+    ConfigWidget* label_type_widget = ConfigWidget::make_from_option(program.LABEL_TYPE, scroll_inner);
     annotation_row->addWidget(&label_type_widget->widget(), 0);
 
-    ConfigWidget* pokemon_label_widget = program.FORM_LABEL.make_QtWidget(*scroll_inner);
+    ConfigWidget* pokemon_label_widget = ConfigWidget::make_from_option(program.FORM_LABEL, scroll_inner);
     annotation_row->addWidget(&pokemon_label_widget->widget(), 2);
-    ConfigWidget* custom_label_widget = program.CUSTOM_SET_LABEL.make_QtWidget(*scroll_inner);
+    ConfigWidget* custom_label_widget = ConfigWidget::make_from_option(program.CUSTOM_SET_LABEL, scroll_inner);
     annotation_row->addWidget(&custom_label_widget->widget(), 2);
-    ConfigWidget* manual_input_label_widget = program.MANUAL_LABEL.make_QtWidget(*scroll_inner);
+    ConfigWidget* manual_input_label_widget = ConfigWidget::make_from_option(program.MANUAL_LABEL, scroll_inner);
     annotation_row->addWidget(&manual_input_label_widget->widget(), 2);
     QPushButton* load_custom_set_button = new QPushButton("Load Custom Set", scroll_inner);
     annotation_row->addWidget(load_custom_set_button, 2);

SerialPrograms/Source/NintendoSwitch/Framework/UI/NintendoSwitch_CommandRow.cpp

@@ -52,7 +52,7 @@ CommandRow::CommandRow(
     layout0->addLayout(layout1, CONSOLE_SETTINGS_STRETCH_L0_RIGHT);
     layout1->setContentsMargins(0, 0, 0, 0);
 
-    ConfigWidget* console_type_box = console_type.make_QtWidget(*this);
+    ConfigWidget* console_type_box = ConfigWidget::make_from_option(console_type, this);
     layout1->addWidget(&console_type_box->widget());
 
 

SerialPrograms/Source/NintendoSwitch/Framework/UI/NintendoSwitch_MultiSwitchProgramWidget.cpp

@@ -90,7 +90,7 @@ MultiSwitchProgramWidget2::MultiSwitchProgramWidget2(
         m_system = new MultiSwitchSystemWidget(*this, m_session.system(), m_session.instance_id());
         scroll_layout->addWidget(m_system);
 
-        m_options = option.options().make_QtWidget(*this);
+        m_options = ConfigWidget::make_from_option(option.options(), this);
         scroll_layout->addWidget(&m_options->widget());
 
         scroll_layout->addStretch(1);

SerialPrograms/Source/NintendoSwitch/Framework/UI/NintendoSwitch_SingleSwitchProgramWidget.cpp

@@ -93,7 +93,7 @@ SingleSwitchProgramWidget2::SingleSwitchProgramWidget2(
         );
         scroll_layout->addWidget(m_system);
 
-        m_options = option.options().make_QtWidget(*this);
+        m_options = ConfigWidget::make_from_option(option.options(), this);
         scroll_layout->addWidget(&m_options->widget());
 
         scroll_layout->addStretch(1);