Merge pull request #8 from matyalatte/dev

matyalatte · web-flow · commit 57a15b83a114 · 2023-01-28T10:22:31.000+09:00
v0.2.2 update
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,9 +1,6 @@
 name: test
 
 on:
-  push:
-    tags:
-      - "v*"
   workflow_dispatch:
   
 env:
diff --git a/batch_files/build_exe.bat b/batch_files/build_exe.bat
@@ -1,11 +1,8 @@
 @echo off
 
-REM Builds SimpleCommandRunner with cmake.
+REM Builds SimpleCommandRunner with CMake and Visual Studio.
 REM SimpleCommandRunner.exe will be generated in Simple-Command-Runner/%BUILD_TYPE%/Release
 
-REM You need Visual Studio to use this batch file.
-REM Run it with "x64 Ntive Tools Command Prompt for VS 2022". Or fail to build.
-
 set /p WX_VERSION=< %~dp0\..\WX_VERSION.txt
 set VS_VERSION=Visual Studio 17 2022
 
diff --git a/batch_files/build_wxWidgets.bat b/batch_files/build_wxWidgets.bat
@@ -1,8 +1,6 @@
 @echo off
 
-REM Builds wxWidgets with cmake.
-REM You need Visual Studio to use this batch file.
-REM Run it with "x64 Ntive Tools Command Prompt for VS 2022". Or fail to build.
+REM Builds wxWidgets with CMake and Visual Studio.
 
 set /p WX_VERSION=< %~dp0\..\WX_VERSION.txt
 set VS_VERSION=Visual Studio 17 2022
diff --git a/batch_files/download_wxWidgets.bat b/batch_files/download_wxWidgets.bat
@@ -1,4 +1,5 @@
 @echo off
+
 REM Downloads wxWidget.
 REM Run it as admin. Or fail to install.
 
diff --git a/changelog.txt b/changelog.txt
@@ -1,3 +1,8 @@
+ver 0.2.2
+- Added "id" option to all components.
+  (It'll be used as a variable name for the command and gui_config.json)
+- Improved json validatior
+
 ver0.2.1
 - Introduced wxBoxSizer to align components automatically.
 - Added "default" option to all components.
diff --git a/docs/Build-on-Unix.md b/docs/Build-on-Unix.md
diff --git a/docs/Build-on-Windows.md b/docs/Build-on-Windows.md
@@ -6,6 +6,8 @@
 -   CMake
 -   Batch files in [`./Simple-Command-Runner/batch_files`](../batch_files)
 
+If you won't use Visual Studio 2022, you could need to edit cmake commands in batch files.
+
 ## 1. Build wxWidgets
 
 wxWidgets is a GUI framework.  
diff --git a/docs/README.md b/docs/README.md
@@ -1,4 +1,4 @@
-# Simple-Command-Runner ver 0.2.1
+# Simple-Command-Runner ver 0.2.2
 
 ![build](https://github.com/matyalatte/Simple-Command-Runner/actions/workflows/build_all.yml/badge.svg)
 ![test](https://github.com/matyalatte/Simple-Command-Runner/actions/workflows/test.yml/badge.svg)
@@ -71,14 +71,14 @@ See here for the details.
 ### Windows
 
 There is a document for Windows users.  
-[Building Workflow for Windows](./Build-With-Windows.md)  
+[Building Workflow for Windows](./Build-on-Windows.md)  
 
 It only supports Visual Studio 2022, but you can see [the batch files](../batch_files/) to find a way to build it with your environment.  
 
 ### Mac and Ubuntu
 
 There is a document for Mac and Ubuntu users.  
-[Building Workflow for Ubuntu and MacOS](./Build-With-Unix.md)  
+[Building Workflow for Ubuntu and MacOS](./Build-on-Unix.md)  
 
 And you can see [the shell scripts](../shell_scripts/) to understand the workflow.  
 
diff --git a/examples/6_id/README.md b/examples/6_id/README.md
@@ -0,0 +1,40 @@
+# ID
+
+`id` is an optional key for components.  
+Its value will be used as a veriable name in commands.  
+  
+Here is an example.  
+
+```json
+{
+    "label": "Sample GUI",
+    "command": "echo y: %something% & echo x: %x% & echo z: %bruh% & echo x: %x%",
+    "button": "Echo!",
+    "components": [
+        {
+            "type": "static_text",
+            "label": "Sample GUI for \"id\" option."
+        },
+        {
+            "type": "text",
+            "label": "Value of x",
+            "id": "x"
+        },
+        {
+            "type": "text",
+            "label": "Value of y"
+        },
+        {
+            "type": "text",
+            "label": "Value of z"
+        }
+    ]
+}
+```
+
+In this case, the value of x will be injected into both of `%x%` parts.  
+Because `x` is an ID for the first text box.  
+The value of y will be injected into `%something%`.  
+Because `something` is not any ID for components and the second text box is the first component that have no ID.  
+The value of z will be injected into `%bruh%`.  
+Because the last text box is the second component that have no ID.  
diff --git a/examples/6_id/gui_definition.json b/examples/6_id/gui_definition.json
@@ -0,0 +1,50 @@
+{
+    "gui": [
+        {
+            "label": "Sample GUI",
+            "command": "echo x: %x% & echo y: %y% & echo z: %z%",
+            "button": "Echo!",
+            "components": [
+                {
+                    "type": "static_text",
+                    "label": "Sample GUI for \"id\" option."
+                },
+                {
+                    "type": "text",
+                    "label": "Value of z",
+                    "id": "z"
+                },
+                {
+                    "type": "text",
+                    "label": "Value of y",
+                    "id": "y"
+                },
+                {
+                    "type": "text",
+                    "label": "Value of x",
+                    "id": "x"
+                }
+            ]
+        },
+        {
+            "label": "Sample GUI2",
+            "command": "echo y: %something% & echo x: %x% & echo x: %x%",
+            "button": "Echo!",
+            "components": [
+                {
+                    "type": "static_text",
+                    "label": "Sample GUI for \"id\" option."
+                },
+                {
+                    "type": "text",
+                    "label": "Value of x",
+                    "id": "x"
+                },
+                {
+                    "type": "text",
+                    "label": "Value of y"
+                }
+            ]
+        }
+    ]
+}
diff --git a/examples/7_all_keys/README.md b/examples/7_all_keys/README.md
diff --git a/examples/7_all_keys/gui_definition.json b/examples/7_all_keys/gui_definition.json
@@ -47,6 +47,7 @@
                 {
                     "type": "file",
                     "label": "PNG or JPG",
+                    "id": "file",
                     "extension": "png or jpg (*.png;*.jpg)|*.png;*.jpg",
                     "empty_message": "Drop a file here!",
                     "default": "test.txt",
@@ -55,33 +56,38 @@
                 {
                     "type": "folder",
                     "label": "Folder path",
+                    "id": "folder",
                     "empty_message": "Drop a folder here!",
                     "default": "testdir",
                     "add_quotes": true
                 },
                 {
                     "type": "check",
                     "label": "Checkbox",
+                    "id": "check",
                     "value": "flag!",
                     "default": true
                 },
                 {
                     "type": "choice",
                     "label": "Combo box",
+                    "id": "choice",
                     "items": ["item1", "item2", "item3"],
                     "values": ["value1", "value2", "value3"],
                     "default": 2
                 },
                 {
                     "type": "check_array",
                     "label": "Options",
+                    "id": "options",
                     "items": ["item1", "item2", "item3", "item4"],
                     "values": ["falg1", "falg2", "falg3", "flag4"],
                     "default": [false, false, true, false]
                 },
                 {
                     "type": "text_box",
                     "label": "Text box",
+                    "id": "text",
                     "empty_message": "type here!",
                     "default": "remove this text!"
                 }
diff --git a/include/component.h b/include/component.h
@@ -12,18 +12,19 @@
 class Component {
  protected:
     void* m_widget;
+    wxString m_label;
 
  private:
     bool m_has_string;
     bool m_add_quotes;
-    std::string m_label;
+    std::string m_id;
 
  public:
     Component(nlohmann::json j, bool has_string);
     ~Component() {}
     virtual wxString GetRawString() { return "";}
     wxString GetString();
-    std::string GetLabel();
+    std::string const GetID();
 
     virtual void SetConfig(nlohmann::json config) {}
     virtual nlohmann::json GetConfig();
diff --git a/include/main_frame.h b/include/main_frame.h
@@ -53,6 +53,7 @@ class MainFrame : public wxFrame {
     void OpenURL(wxCommandEvent& event);
     void UpdateFrame(wxCommandEvent& event);
     void ClickButton(wxCommandEvent& event);
+    wxString GetCommand();
     std::array<std::string, 2> RunCommand();
     nlohmann::json GetDefinition();
     void SaveConfig();
diff --git a/shell_scripts/build_exe.sh b/shell_scripts/build_exe.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
-#Builds an executable file with cmake.
-#SimpleCommandRunner will be generated in ../build
+# Builds an executable file with cmake.
+# SimpleCommandRunner will be generated in ../build
 
 if [ "$1" = "Debug" ];
     then build_type="Debug";
diff --git a/shell_scripts/build_wxWidgets.sh b/shell_scripts/build_wxWidgets.sh
@@ -1,8 +1,8 @@
 #!/bin/bash
-#Builds and installs wxWidgets with cmake.
+# Builds and installs wxWidgets with cmake.
 
-#you need build-essential and libgtk-3-dev for linux
-#sudo apt -y install build-essential libgtk-3-dev
+# you need build-essential and libgtk-3-dev for linux
+# sudo apt -y install build-essential libgtk-3-dev
 
 wx_version="$(cat $(dirname "$0")/../WX_VERSION.txt)"
 
diff --git a/shell_scripts/download_wxWidgets.sh b/shell_scripts/download_wxWidgets.sh
@@ -1,5 +1,5 @@
 #!/bin/bash
-#Downloads wxWidgets.
+# Downloads wxWidgets.
 
 wx_version="$(cat $(dirname "$0")/../WX_VERSION.txt)"
 
diff --git a/shell_scripts/test.sh b/shell_scripts/test.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
-#Builds an executable file with cmake.
-#SimpleCommandRunner will be generated in ../build
+# Builds an executable file with cmake.
+# SimpleCommandRunner will be generated in ../build
 
 if [ "$1" = "Debug" ];
     then build_type="Debug";
diff --git a/src/component.cpp b/src/component.cpp
@@ -4,7 +4,15 @@
 Component::Component(nlohmann::json j, bool has_string) {
     m_widget = nullptr;
     m_has_string = has_string;
-    m_label = j["label"];
+    m_label = wxString::FromUTF8(j["label"]);
+    m_id = j.value("id", "");
+    if (m_id == "") {
+        if (m_label.Length() > 128) {
+            m_id = m_label.Left(128).ToUTF8();
+        } else {
+            m_id = m_label;
+        }
+    }
     m_add_quotes = j.value("add_quotes", false);
 }
 
@@ -20,8 +28,8 @@ nlohmann::json Component::GetConfig() {
     return {};
 }
 
-std::string Component::GetLabel() {
-    return m_label;
+std::string const Component::GetID() {
+    return m_id;
 }
 
 bool Component::HasString() {
@@ -58,18 +66,13 @@ const int DEFAULT_SIZER_FLAG = wxFIXED_MINSIZE | wxALIGN_LEFT | wxBOTTOM;
 // Static Text
 StaticText::StaticText(wxWindow* panel, wxBoxSizer* sizer, nlohmann::json j)
     : Component(j, NOT_STRING) {
-    sizer->Add(
-        new wxStaticText(panel, wxID_ANY,
-            wxString::FromUTF8(j["label"])),
-            0, DEFAULT_SIZER_FLAG , 13);
+    sizer->Add(new wxStaticText(panel, wxID_ANY, m_label), 0, DEFAULT_SIZER_FLAG , 13);
 }
 
 // Base Class for strings
 StringComponentBase::StringComponentBase(wxWindow* panel, wxBoxSizer* sizer, nlohmann::json j)
     : Component(j, HAS_STRING) {
-    sizer->Add(
-        new wxStaticText(panel, wxID_ANY, wxString::FromUTF8(j["label"])),
-        0, DEFAULT_SIZER_FLAG, 3);
+    sizer->Add(new wxStaticText(panel, wxID_ANY, m_label), 0, DEFAULT_SIZER_FLAG, 3);
 }
 
 nlohmann::json StringComponentBase::GetConfig() {
@@ -146,10 +149,7 @@ Choice::Choice(wxWindow* panel, wxBoxSizer* sizer, nlohmann::json j)
     std::for_each(items.begin(), items.end(), [&](std::string i) {
         wxitems.Add(wxString::FromUTF8(i));
         });
-    sizer->Add(
-        new wxStaticText(panel, wxID_ANY,
-            wxString::FromUTF8(j["label"])),
-            0, DEFAULT_SIZER_FLAG, 3);
+    sizer->Add(new wxStaticText(panel, wxID_ANY, m_label), 0, DEFAULT_SIZER_FLAG, 3);
     wxChoice* choice = new wxChoice(panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxitems);
     sizer->Add(choice, 0, DEFAULT_SIZER_FLAG, 13);
     if (j.contains("default") && j["items"].size() > j["default"]) {
@@ -193,10 +193,9 @@ void SetDefaultForCheckBox(wxCheckBox* check, nlohmann::json j) {
 // CheckBox
 CheckBox::CheckBox(wxWindow* panel, wxBoxSizer* sizer, nlohmann::json j)
     : Component(j, HAS_STRING) {
-    wxCheckBox* check = new wxCheckBox(panel, wxID_ANY,
-                                       wxString::FromUTF8(j["label"]));
+    wxCheckBox* check = new wxCheckBox(panel, wxID_ANY, m_label);
     sizer->Add(check, 0, DEFAULT_SIZER_FLAG, 13);
-    m_value = j.value("value", j["label"]);
+    m_value = j.value("value", m_label.ToUTF8());
     if (j.contains("default")) {
         SetDefaultForCheckBox(check, j["default"]);
     }
@@ -225,10 +224,7 @@ nlohmann::json CheckBox::GetConfig() {
 // CheckArray
 CheckArray::CheckArray(wxWindow* panel, wxBoxSizer* sizer, nlohmann::json j)
     : Component(j, HAS_STRING) {
-    sizer->Add(
-        new wxStaticText(panel, wxID_ANY,
-            wxString::FromUTF8(j["label"])),
-            0, DEFAULT_SIZER_FLAG, 3);
+    sizer->Add(new wxStaticText(panel, wxID_ANY, m_label), 0, DEFAULT_SIZER_FLAG, 3);
     std::vector<wxCheckBox*>* checks = new std::vector<wxCheckBox*>();
     for (int i = 0; i < j["items"].size(); i++) {
         wxCheckBox* check = new wxCheckBox(panel, wxID_ANY,
diff --git a/src/json_utils.cpp b/src/json_utils.cpp
diff --git a/src/main_frame.cpp b/src/main_frame.cpp
diff --git a/tests/json_check/CMakeLists.txt b/tests/json_check/CMakeLists.txt
diff --git a/tests/json_check/main.cpp b/tests/json_check/main.cpp
diff --git a/tests/main_frame/CMakeLists.txt b/tests/main_frame/CMakeLists.txt
diff --git a/tests/main_frame/main.cpp b/tests/main_frame/main.cpp

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`@echo off`
	`2`	`+`
`2`	`3`	`REM Downloads wxWidget.`
`3`	`4`	`REM Run it as admin. Or fail to install.`
`4`	`5`