add an empty ML label image program

Author: Gin

SerialPrograms/CMakeLists.txt

@@ -871,6 +871,10 @@ file(GLOB MAIN_SOURCES
     Source/Kernels/Waterfill/Kernels_Waterfill_Session.h
     Source/Kernels/Waterfill/Kernels_Waterfill_Session.tpp
     Source/Kernels/Waterfill/Kernels_Waterfill_Types.h
+    Source/ML/ML_Panels.cpp
+    Source/ML/ML_Panels.h
+    Source/ML/Programs/ML_LabelImages.cpp
+    Source/ML/Programs/ML_LabelImages.h
     Source/NintendoSwitch/Commands/NintendoSwitch_Commands_PushButtons.cpp
     Source/NintendoSwitch/Commands/NintendoSwitch_Commands_PushButtons.h
     Source/NintendoSwitch/Commands/NintendoSwitch_Commands_Routines.cpp

SerialPrograms/Source/CommonFramework/Panels/PanelDescriptor.h

@@ -15,7 +15,9 @@ namespace PokemonAutomation{
 
 class PanelInstance;
 
-
+// Abstract base class that sets the interface for program descriptors.
+// A program descriptor contains various information (descriptions) of a program panel UI.
+// It can also use function `make_panel()` to create the corresponding panel.
 class PanelDescriptor{
 public:
     PanelDescriptor(

SerialPrograms/Source/CommonFramework/Panels/PanelTools.h

@@ -47,7 +47,8 @@ struct PanelEntry{
 };
 
 
-
+// Used by `make_panel()` to link the panel instance to the panel descriptor.
+// For more details, see `make_panel()` defined below.
 template <typename Descriptor, typename Instance>
 class PanelDescriptorWrapper : public Descriptor{
 public:
@@ -56,6 +57,17 @@ class PanelDescriptorWrapper : public Descriptor{
     }
 };
 
+// Called by a program panel list factory to create a panel descriptor.
+// A panel descriptor holds various info (title, title color, etc.) about a program panel
+// and can also create the corresponding panel.
+//
+// template type `Descriptor` a derived class of CommonFramework/Panels/PanelDescriptor.h:PanelDescriptor
+// and `Instance` is the program panel UI instance, derived class of 
+// CommonFramework/Panels/PanelInstance.h:Panelnstance.
+//
+// Each panel descriptor instance should have implemented `make_panel()` to create the panel instance.
+// But writing this creation for each unique program implementation is repetitive. In stead, this function
+// uses `PanelDescriptorWrapper` to implement `make_panel()`.
 template <typename Descriptor, typename Instance>
 std::unique_ptr<PanelDescriptor> make_panel(){
     return std::make_unique<PanelDescriptorWrapper<Descriptor, Instance>>();

SerialPrograms/Source/ML/ML_Panels.cpp

@@ -0,0 +1,39 @@
+/*  ML Panels
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ */
+
+#include "CommonFramework/GlobalSettingsPanel.h"
+#include "CommonFramework/Panels/PanelTools.h"
+#include "Pokemon/Pokemon_Strings.h"
+#include "Programs/ML_LabelImages.h"
+
+#include "ML_Panels.h"
+
+
+namespace PokemonAutomation{
+namespace ML{
+
+
+
+PanelListFactory::PanelListFactory()
+    : PanelListDescriptor("ML")
+{}
+
+std::vector<PanelEntry> PanelListFactory::make_panels() const{
+    std::vector<PanelEntry> ret;
+    if (PreloadSettings::instance().DEVELOPER_MODE){
+        ret.emplace_back("---- Developer Tools ----");
+        ret.emplace_back(make_panel<LabelImages_Descriptor, LabelImages>());
+        // ret.emplace_back(make_single_switch_program<ThreeSegmentDudunsparceFinder_Descriptor, ThreeSegmentDudunsparceFinder>());
+    }
+
+    return ret;
+}
+
+
+
+
+}
+}

SerialPrograms/Source/ML/ML_Panels.h

@@ -0,0 +1,27 @@
+/*  ML Panels
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ */
+
+#ifndef PokemonAutomation_ML_Panels_H
+#define PokemonAutomation_ML_Panels_H
+
+#include "CommonFramework/Panels/PanelList.h"
+
+namespace PokemonAutomation{
+namespace ML{
+
+
+
+class PanelListFactory : public PanelListDescriptor{
+public:
+    PanelListFactory();
+    virtual std::vector<PanelEntry> make_panels() const;
+};
+
+
+
+}
+}
+#endif

SerialPrograms/Source/ML/Programs/ML_LabelImages.cpp

@@ -0,0 +1,90 @@
+/*  Virtual Game Console
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ */
+
+#include <QVBoxLayout>
+#include <QScrollArea>
+#include "Common/Cpp/Json/JsonValue.h"
+#include "Common/Qt/CollapsibleGroupBox.h"
+#include "ML_LabelImages.h"
+#include "Pokemon/Pokemon_Strings.h"
+
+namespace PokemonAutomation{
+namespace ML{
+
+LabelImages_Descriptor::LabelImages_Descriptor()
+    : PanelDescriptor(
+        Color(),
+        "ML:LabelImages",
+        "ML", "Label Images",
+        "", // "ComputerControl/blob/master/Wiki/Programs/NintendoSwitch/LabelImages.md",
+        "Label " + Pokemon::STRING_POKEMON + " on images" 
+    )
+{}
+
+
+
+LabelImages::LabelImages(const LabelImages_Descriptor& descriptor)
+    : PanelInstance(descriptor)
+    // , m_switch({}, false)
+{}
+void LabelImages::from_json(const JsonValue& json){
+    // m_switch.load_json(json);
+}
+JsonValue LabelImages::to_json() const{
+    return {};
+    // return m_switch.to_json();
+}
+QWidget* LabelImages::make_widget(QWidget& parent, PanelHolder& holder){
+    return LabelImages_Widget::make(parent, *this, holder);
+}
+
+
+
+LabelImages_Widget* LabelImages_Widget::make(
+    QWidget& parent,
+    LabelImages& instance,
+    PanelHolder& holder
+){
+    LabelImages_Widget* widget = new LabelImages_Widget(parent, instance, holder);
+    widget->construct();
+    return widget;
+}
+LabelImages_Widget::~LabelImages_Widget(){
+    // delete m_switch;
+}
+LabelImages_Widget::LabelImages_Widget(
+    QWidget& parent,
+    LabelImages& instance,
+    PanelHolder& holder
+)
+    : PanelWidget(parent, instance, holder)
+    // , m_session(instance.m_switch, 0, 0)
+{}
+void LabelImages_Widget::construct(){
+    QVBoxLayout* layout = new QVBoxLayout(this);
+    layout->setContentsMargins(0, 0, 0, 0);
+    layout->addWidget(make_header(*this));
+
+    QScrollArea* scroll_outer = new QScrollArea(this);
+    layout->addWidget(scroll_outer);
+    scroll_outer->setWidgetResizable(true);
+
+    QWidget* scroll_inner = new QWidget(scroll_outer);
+    scroll_outer->setWidget(scroll_inner);
+    QVBoxLayout* scroll_layout = new QVBoxLayout(scroll_inner);
+    scroll_layout->setAlignment(Qt::AlignTop);
+
+    // m_switch = new SwitchSystemWidget(*this, m_session, 0);
+    // scroll_layout->addWidget(m_switch);
+}
+
+
+
+
+
+}
+}
+

SerialPrograms/Source/ML/Programs/ML_LabelImages.h

@@ -0,0 +1,68 @@
+/*  ML Label Images
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ */
+
+#ifndef PokemonAutomation_ML_LabelImages_H
+#define PokemonAutomation_ML_LabelImages_H
+
+#include "CommonFramework/Panels/PanelInstance.h"
+#include "CommonFramework/Panels/UI/PanelWidget.h"
+
+
+namespace PokemonAutomation{
+namespace ML{
+
+
+
+class LabelImages_Descriptor : public PanelDescriptor{
+public:
+    LabelImages_Descriptor();
+};
+
+
+
+class LabelImages : public PanelInstance{
+public:
+    LabelImages(const LabelImages_Descriptor& descriptor);
+    virtual QWidget* make_widget(QWidget& parent, PanelHolder& holder) override;
+
+public:
+    //  Serialization
+    virtual void from_json(const JsonValue& json) override;
+    virtual JsonValue to_json() const override;
+
+private:
+    friend class LabelImages_Widget;
+};
+
+
+
+class LabelImages_Widget : public PanelWidget{
+public:
+    static LabelImages_Widget* make(
+        QWidget& parent,
+        LabelImages& instance,
+        PanelHolder& holder
+    );
+
+private:
+    ~LabelImages_Widget();
+    LabelImages_Widget(
+        QWidget& parent,
+        LabelImages& instance,
+        PanelHolder& holder
+    );
+    void construct();
+
+private:
+};
+
+
+
+
+}
+}
+#endif
+

SerialPrograms/Source/PanelLists.cpp

@@ -12,6 +12,7 @@
 #include "CommonFramework/Windows/DpiScaler.h"
 #include "CommonFramework/Panels/UI/PanelListWidget.h"
 #include "CommonFramework/GlobalSettingsPanel.h"
+#include "ML/ML_Panels.h"
 #include "NintendoSwitch/NintendoSwitch_Panels.h"
 #include "PokemonSwSh/PokemonSwSh_Panels.h"
 #include "PokemonHome/PokemonHome_Panels.h"
@@ -54,7 +55,9 @@ ProgramSelect::ProgramSelect(QWidget& parent, PanelHolder& holder)
         add(std::make_unique<NintendoSwitch::PokemonRSE::PanelListFactory>());
     }
     add(std::make_unique<NintendoSwitch::ZeldaTotK::PanelListFactory>());
-
+    if (PreloadSettings::instance().DEVELOPER_MODE){
+        add(std::make_unique<ML::PanelListFactory>());
+    }
 
 
     //  Load the 1st list by default.

SerialPrograms/Source/PanelLists.h

@@ -15,7 +15,7 @@ class QComboBox;
 namespace PokemonAutomation{
 
 
-
+// The program selection UI on the left side of the program window
 class ProgramSelect : public QGroupBox{
 public:
     ProgramSelect(QWidget& parent, PanelHolder& holder);