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

add yaml2shell -f filter option #50

Merged
merged 2 commits into from
Nov 27, 2024
Merged

add yaml2shell -f filter option #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86a95ed
add yaml2shell -f filter option
flipflip8952 Nov 27, 2024
f952f8a
add yaml2shell -f filter option
flipflip8952 Nov 27, 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
2 changes: 1 addition & 1 deletion fpsdk_apps/yaml2shell/test1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
foo: 123
bar:
a: gugus
a: foo
b: false
empty:
xyz:
Expand Down
46 changes: 37 additions & 9 deletions fpsdk_apps/yaml2shell/yaml2shell.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
#include <fstream>
#include <iostream>
#include <memory>
#include <regex>
#include <string>
#include <vector>

Expand Down Expand Up @@ -51,7 +52,7 @@ class YamlToShellOptions : public ProgramOptions
public:
YamlToShellOptions() // clang-format off
: ProgramOptions("yaml2shell",
{ { 'p', true }, { 'o', true }, { 'n', true }, { 's', true }, { 'u', false } })
{ { 'p', true }, { 'o', true }, { 'n', true }, { 's', true }, { 'u', false }, { 'f', true } })
{} // clang-format on

std::string input_;
Expand All @@ -60,6 +61,7 @@ class YamlToShellOptions : public ProgramOptions
bool upper_ = false;
uint32_t max_num_ = 0;
uint32_t max_size_ = 1024 * 1024;
std::string filter_;

void PrintHelp() final
{
Expand All @@ -82,6 +84,8 @@ class YamlToShellOptions : public ProgramOptions
" -u -- Uppercase variable names\n"
" -n <num> -- Maximum number of variables to output (default: 0, i.e. unlimited)\n"
" -s <size> -- Maximum size of output [bytes], 0 = unlimited (default: 1 MiB)\n"
" -f <re> -- Filter output (on variable name) using a regex, case insensitive unless uppercase\n"
" chars are used in the <re> string\n"
"\n"
"If <some.yaml> is given the program reads the YAML from that file. Otherwise it processes YAML\n"
"from stdin. For example:\n"
Expand All @@ -93,21 +97,21 @@ class YamlToShellOptions : public ProgramOptions
"\n"
" foo: 123\n"
" bar:\n"
" a: gugus\n"
" a: foo\n"
" b: false\n"
" empty:\n"
" xyz:\n"
" - 2\n"
" - 3\n"
"\n"
" Output (default): (with '-p cfg_') (with '-p cfg -u')\n"
" Output (default): (with '-p cfg_') (with '-p cfg -u') (with '-f ^(foo|empty) -u')\n"
" \n"
" foo='123' cfg_foo='123' CFG_FOO='123'\n"
" bar_a='gugus' cfg_bar_a='gugus' CFG_BAR_A='gugus'\n"
" bar_b='false' cfg_bar_b='false' CFG_BAR_B='false'\n"
" empty='' cfg_empty='' CFG_EMPTY=''\n"
" xyz_0='2' cfg_xyz_0='2' CFG_XYZ_0='2'\n"
" xyz_1='3' cfg_xyz_1='3' CFG_XYZ_1='3'\n"
" foo='123' cfg_foo='123' CFG_FOO='123' FOO='123'\n"
" bar_a='foo' cfg_bar_a='foo' CFG_BAR_A='foo' EMPTY=''\n"
" bar_b='false' cfg_bar_b='false' CFG_BAR_B='false'\n"
" empty='' cfg_empty='' CFG_EMPTY=''\n"
" xyz_0='2' cfg_xyz_0='2' CFG_XYZ_0='2'\n"
" xyz_1='3' cfg_xyz_1='3' CFG_XYZ_1='3'\n"
"\n", stdout);
// clang-format on
}
Expand All @@ -131,6 +135,9 @@ class YamlToShellOptions : public ProgramOptions
case 'u':
upper_ = true;
break;
case 'f':
filter_ = argument;
break;
default:
ok = false;
break;
Expand All @@ -154,6 +161,7 @@ class YamlToShellOptions : public ProgramOptions
DEBUG("upper = %s", upper_ ? "true" : "false");
DEBUG("max_num_ = %" PRIu32, max_num_);
DEBUG("max_size = %" PRIu32, max_size_);
DEBUG("filter = %s", filter_.c_str());

return ok;
}
Expand All @@ -170,6 +178,20 @@ class YamlToShell

bool Run()
{
// Have filter?
if (!opts_.filter_.empty()) {
try {
filter_ = std::make_unique<std::regex>(opts_.filter_,
opts_.filter_ == StrToLower(opts_.filter_) ? std::regex_constants::icase
: (std::regex_constants::syntax_option_type)0);
} catch (std::exception& ex) {
WARNING("Bad filter %s: %s", opts_.filter_.c_str(), ex.what());
return false;
}
}

// std::regex_constants::icase

// Read data, input cannot be larger than max allowed output
std::vector<uint8_t> data;
// - from file
Expand Down Expand Up @@ -239,6 +261,7 @@ class YamlToShell
std::size_t size_ = 0;
std::unique_ptr<std::ofstream> out_;
static constexpr int MAX_DEPTH = 10000;
std::unique_ptr<std::regex> filter_;

bool Dump(const YAML::Node& node, const std::string& prefix, const int depth = 0)
{
Expand Down Expand Up @@ -299,6 +322,11 @@ class YamlToShell
var.insert(var.begin(), '_');
}

// Filter?
if (filter_ && !std::regex_match(var, *filter_)) {
return ok;
}

// Sanitise variable value
// - "Escape" single quotes
StrReplace(val, "'", "'\"'\"'");
Expand Down
Loading