Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow to define GUI elements in root object. #52

Merged
merged 3 commits into from
Oct 26, 2024
Merged

Allow to define GUI elements in root object. #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f78331
allow to define gui elements in root object
matyalatte Oct 25, 2024
9433531
update json schema, add tests
matyalatte Oct 25, 2024
86d0a39
update changelog
matyalatte Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/changelog.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
- Array brackets can now be omitted when there is only one element.
- GUI elements can now be defined in root object.

ver 0.7.2
- Added "optional" to ignore some options when a text box is empty.
- Added "prefix" and "suffix" options to append strings to user inputs.
Expand Down
62 changes: 41 additions & 21 deletions schema/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,33 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"recommended": { "$ref": "#/definitions/types/version" },
"recommended_version": { "$ref": "#/definitions/types/version" },
"minimum_required": { "$ref": "#/definitions/types/version" },
"minimum_required_version": { "$ref": "#/definitions/types/version" },
"gui": {
"if": { "type": "object" },
"then": { "$ref": "#/definitions/types/gui_item" },
"else": {
"type": "array",
"items": { "$ref": "#/definitions/types/gui_item" }
}
},
"help": {
"if": { "type": "object" },
"then": { "$ref": "#/definitions/types/help_item" },
"else": {
"type": "array",
"items": { "$ref": "#/definitions/types/help_item" }
}
"if": {
"required": [ "gui" ]
},
"then": {
"properties": {
"recommended": { "$ref": "#/definitions/types/version" },
"recommended_version": { "$ref": "#/definitions/types/version" },
"minimum_required": { "$ref": "#/definitions/types/version" },
"minimum_required_version": { "$ref": "#/definitions/types/version" },
"gui": { "$ref": "#/definitions/types/gui_array" },
"help": { "$ref": "#/definitions/types/help_array" }
}
},
"required": [ "gui" ],
"else": {
"allOf": [
{ "$ref": "#/definitions/types/gui_item" },
{
"properties": {
"recommended": { "$ref": "#/definitions/types/version" },
"recommended_version": { "$ref": "#/definitions/types/version" },
"minimum_required": { "$ref": "#/definitions/types/version" },
"minimum_required_version": { "$ref": "#/definitions/types/version" },
"help": { "$ref": "#/definitions/types/help_array" }
}
}
]
},
"definitions": {
"types": {
"version": {
Expand Down Expand Up @@ -183,6 +187,14 @@
}
]
},
"gui_array": {
"if": { "type": "object" },
"then": { "$ref": "#/definitions/types/gui_item" },
"else": {
"type": "array",
"items": { "$ref": "#/definitions/types/gui_item" }
}
},
"help_item": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -221,6 +233,14 @@
}
}
]
},
"help_array": {
"if": { "type": "object" },
"then": { "$ref": "#/definitions/types/help_item" },
"else": {
"type": "array",
"items": { "$ref": "#/definitions/types/help_item" }
}
}
},
"components": {
Expand Down
15 changes: 11 additions & 4 deletions src/json_utils.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ namespace json_utils {

// get default definition of gui
void GetDefaultDefinition(rapidjson::Document& definition) {
static const char* def_str = "{\"gui\":{"
static const char* def_str = "{"
"\"label\":\"Default GUI\","
#ifdef _WIN32
"\"command\":\"dir\","
Expand All @@ -239,7 +239,7 @@ namespace json_utils {
"\"button\":\"run 'ls'\","
#endif
"\"components\":[]"
"}}";
"}";
rapidjson::ParseResult ok = definition.Parse(def_str);
assert(ok);
JsonResult result = JSON_RESULT_OK;
Expand Down Expand Up @@ -685,7 +685,14 @@ namespace json_utils {
}

void CheckDefinition(JsonResult& result, rapidjson::Document& definition) {
CheckJsonArrayType(result, definition, "gui", JsonType::JSON, definition.GetAllocator());
rapidjson::Document::AllocatorType& alloc = definition.GetAllocator();
if (!definition.HasMember("gui")) {
// definition["gui"] = definition
rapidjson::Value n(rapidjson::kObjectType);
n.CopyFrom(definition, alloc);
definition.AddMember("gui", n, alloc);
}
CheckJsonArrayType(result, definition, "gui", JsonType::JSON, alloc);
if (!result.ok) return;
if (definition["gui"].Size() == 0) {
result.ok = false;
Expand All @@ -694,7 +701,7 @@ namespace json_utils {

for (rapidjson::Value& sub_d : definition["gui"].GetArray()) {
if (!result.ok) return;
CheckSubDefinition(result, sub_d, definition.GetAllocator());
CheckSubDefinition(result, sub_d, alloc);
}
}

Expand Down
12 changes: 8 additions & 4 deletions tests/json/relaxed.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,12 @@
/*
* Multi-line comments
*/
"ary": [
"",
"trailing_comma",
]
"label": "test",
"command": "echo hello",
"components": [],
"help": {
"label": "test",
"type": "url",
"url": "example.com",
},
}
18 changes: 17 additions & 1 deletion tests/json_check_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,14 @@ TEST(JsonCheckTest, checkGUISuccess4) {
EXPECT_TRUE(result.ok);
}

TEST(JsonCheckTest, checkGUISuccessRelaxed) {
rapidjson::Document test_json;
json_utils::JsonResult result = json_utils::LoadJson(JSON_RELAXED, test_json);
EXPECT_TRUE(result.ok);
json_utils::CheckDefinition(result, test_json);
EXPECT_TRUE(result.ok);
}

void CheckGUIError(rapidjson::Document& test_json, const char* expected) {
json_utils::JsonResult result = JSON_RESULT_OK;
json_utils::CheckDefinition(result, test_json);
Expand All @@ -82,7 +90,7 @@ TEST(JsonCheckTest, checkGUIFail) {
rapidjson::Document test_json;
GetTestJson(test_json);
test_json.RemoveMember("gui");
CheckGUIError(test_json, "['gui'] not found.");
CheckGUIError(test_json, "['components'] not found.");
}

TEST(JsonCheckTest, checkGUIFail2) {
Expand Down Expand Up @@ -135,6 +143,14 @@ TEST(JsonCheckTest, checkGUIFail7) {
" & echo textbox: __comp8__ & echo int: __comp9__ & echo float: __comp???__");
}

TEST(JsonCheckTest, checkGUIFailRelaxed) {
rapidjson::Document test_json;
json_utils::JsonResult result = json_utils::LoadJson(JSON_RELAXED, test_json);
EXPECT_TRUE(result.ok);
test_json.AddMember("exit_success", "a", test_json.GetAllocator());
CheckGUIError(test_json, "['exit_success'] should be an int.");
}

TEST(JsonCheckTest, checkHelpSuccess) {
rapidjson::Document test_json;
GetTestJson(test_json);
Expand Down
Loading