Skip to content

Commit a4e5377

Browse files
Griger5slayoo
Griger5
and
slayoo
authored
Input guard for flagging used input (JSON entries), raising exception when some remain unused (#395)
Co-authored-by: Sylwester Arabas <[email protected]>
1 parent 0144d1a commit a4e5377

18 files changed

+400
-53
lines changed

‎.zenodo.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@
2525
"affiliation": "University of California, Davis, CA, USA",
2626
"name": "Ware, Emma"
2727
},
28+
{
29+
"affiliation": "AGH University of Krakow, Kraków, Poland",
30+
"name": "Adamus, Gracjan"
31+
},
2832
{
2933
"affiliation": "University of Illinois Urbana-Champaign",
3034
"name": "Riemer, Nicole",

‎examples/additive_coag_comparison.ipynb‎

Lines changed: 72 additions & 42 deletions
Large diffs are not rendered by default.

‎src/aero_data.hpp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ struct AeroData {
4646

4747
JSONResourceGuard<InputJSONResource> guard(json);
4848
f_aero_data_from_json(this->ptr.f_arg());
49+
guard.check_parameters();
4950
}
5051

5152
AeroData() :

‎src/aero_dist.hpp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ struct AeroDist {
5454

5555
JSONResourceGuard<InputJSONResource> guard(json, "", "mode_name", 1);
5656
f_aero_dist_from_json(ptr.f_arg_non_const(), aero_data->ptr.f_arg_non_const());
57+
guard.check_parameters();
5758
}
5859

5960
AeroDist() :

‎src/aero_mode.hpp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,7 @@ struct AeroMode {
147147
check_mode_json(json.begin().value());
148148
JSONResourceGuard<InputJSONResource> guard(json, "", "mode_name");
149149
f_aero_mode_from_json(ptr.f_arg_non_const(), aero_data.ptr.f_arg_non_const());
150+
guard.check_parameters();
150151
}
151152

152153
static void check_mode_json(const nlohmann::json &mode) {

‎src/env_state.hpp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ struct EnvState {
3434
{
3535
JSONResourceGuard<InputJSONResource> guard(json);
3636
f_env_state_from_json(this->ptr.f_arg());
37+
guard.check_parameters();
3738
}
3839

3940
EnvState() :

‎src/gas_data.hpp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ struct GasData {
3939

4040
JSONResourceGuard<InputJSONResource> guard(json_array);
4141
f_gas_data_from_json(this->ptr.f_arg());
42+
guard.check_parameters();
4243
}
4344

4445
GasData() :

‎src/gas_state.hpp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,5 +125,6 @@ struct GasState {
125125
self.ptr.f_arg(),
126126
self.gas_data->ptr.f_arg()
127127
);
128+
guard.check_parameters();
128129
}
129130
};

‎src/input_guard.hpp‎

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
#include <iostream>
2+
#include <set>
3+
#include <map>
4+
#include <string>
5+
#include <sstream>
6+
#include "pybind11_json/pybind11_json.hpp"
7+
#include "nlohmann/json.hpp"
8+
9+
struct InputGuard {
10+
public:
11+
InputGuard(const nlohmann::json &j) {
12+
process_json(j);
13+
14+
this->dict_key_present = false;
15+
}
16+
17+
~InputGuard() {}
18+
19+
void check_used_inputs() {
20+
for (auto item : this->used_inputs) {
21+
if (!item.second) {
22+
std::string err = std::string("WARNING: \"") + item.first + std::string("\" parameter remains unused.");
23+
throw std::runtime_error(err);
24+
}
25+
}
26+
}
27+
28+
void mark_used_input(const std::string &input_name) {
29+
if (this->prefixes.find(input_name) == this->prefixes.end()) {
30+
std::string prefix = combine_str_vec(this->curr_prefix);
31+
32+
if (!prefix.empty()) {
33+
this->used_inputs[prefix + "/" + input_name] = true;
34+
}
35+
else {
36+
this->used_inputs[input_name] = true;
37+
}
38+
}
39+
}
40+
41+
void update_dict_key(std::string dict_key) {
42+
this->curr_dict_key = dict_key;
43+
}
44+
45+
void check_read_line(std::string line) {
46+
if (line == "mode_name") {
47+
if (this->dict_key_present) {
48+
this->curr_prefix.pop_back();
49+
}
50+
this->curr_prefix.push_back(this->curr_dict_key);
51+
this->dict_key_present = true;
52+
}
53+
else if (line.empty()) {
54+
this->curr_prefix.pop_back();
55+
this->dict_key_present = false;
56+
}
57+
}
58+
59+
void open_spec_file(std::string spec_file_name) {
60+
this->curr_prefix.push_back(spec_file_name);
61+
}
62+
63+
void close_spec_file() {
64+
this->curr_prefix.pop_back();
65+
}
66+
67+
private:
68+
std::map<std::string, bool> used_inputs;
69+
70+
std::set<std::string> prefixes;
71+
std::string curr_dict_key;
72+
std::vector<std::string> curr_prefix;
73+
74+
bool dict_key_present;
75+
76+
void process_json(const nlohmann::json &j) {
77+
nlohmann::json flat = j.flatten();
78+
79+
// JSON Pointer, as in a string syntax for identifying a specific value in JSON
80+
std::vector<std::string> json_pointers;
81+
82+
for (auto f : flat.items()) {
83+
json_pointers.push_back(clean_string(f.key()));
84+
}
85+
86+
std::set<std::string> json_pointers_set(json_pointers.begin(), json_pointers.end());
87+
88+
for (auto s : json_pointers_set) {
89+
this->used_inputs[s] = false;
90+
}
91+
92+
get_prefixes(json_pointers_set);
93+
}
94+
95+
std::string clean_string(std::string str) {
96+
bool after_slash = false;
97+
98+
for (size_t i = 0; i < str.size(); i++) {
99+
if (str.at(i) == '/' && i+1 < str.size()) {
100+
if (isdigit(str.at(i+1))) {
101+
after_slash = true;
102+
str.erase(i, 1);
103+
i -= 1;
104+
}
105+
}
106+
else if (isdigit(str.at(i)) && after_slash) {
107+
str.erase(i, 1);
108+
i -= 1;
109+
}
110+
else {
111+
after_slash = false;
112+
}
113+
}
114+
115+
str.erase(0, 1);
116+
117+
return str;
118+
}
119+
120+
std::string combine_str_vec(std::vector<std::string> vec) {
121+
if (vec.size() == 0) return "";
122+
123+
std::string temp = vec[0];
124+
125+
for (size_t i = 1; i < vec.size(); i++) {
126+
temp += "/";
127+
temp += vec[i];
128+
}
129+
130+
return temp;
131+
}
132+
133+
void get_prefixes(std::set<std::string> json_pointers_set) {
134+
std::string temp;
135+
std::vector<std::string> temp_vec;
136+
137+
for (auto s : json_pointers_set) {
138+
std::stringstream line(s);
139+
140+
while(getline(line, temp, '/')) {
141+
temp_vec.push_back(temp);
142+
}
143+
144+
if (temp_vec.size() > 1) {
145+
temp_vec.pop_back();
146+
147+
for (auto v : temp_vec) {
148+
this->prefixes.insert(v);
149+
}
150+
}
151+
152+
temp_vec.clear();
153+
}
154+
}
155+
};

‎src/json_resource.hpp‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,20 @@
1010
#include <sstream>
1111
#include <set>
1212
#include <stack>
13+
#include <map>
1314
#include "nlohmann/json.hpp"
1415
#include <tcb/span.hpp>
1516
#include <bpstd/string_view.hpp>
17+
#include "input_guard.hpp"
1618

1719
struct JSONResource {
1820
private:
1921
std::set<std::string> vars;
2022
const nlohmann::json *json;
2123
std::stack<const nlohmann::json*> json_parent;
2224

25+
std::unique_ptr<InputGuard> input_guard_ptr;
26+
2327
void warn(const std::exception &exception) {
2428
std::cerr << "WARN: " << exception.what() << std::endl;
2529
// assert(false);
@@ -35,6 +39,8 @@ struct JSONResource {
3539
for (auto &entry : this->json->items()) {
3640
this->vars.insert(entry.key());
3741
}
42+
43+
input_guard_ptr = std::make_unique<InputGuard>(json);
3844
};
3945

4046
void set_current_json_ptr(const nlohmann::json *ptr) {
@@ -65,6 +71,9 @@ struct JSONResource {
6571
key = item.key();
6672
}
6773
}
74+
75+
input_guard_ptr->update_dict_key(key);
76+
6877
return key;
6978
}
7079

@@ -212,6 +221,10 @@ struct JSONResource {
212221
return it;
213222
}
214223

224+
InputGuard *get_input_guard_ptr() {
225+
return input_guard_ptr.get();
226+
}
227+
215228
virtual std::string str() const = 0;
216229

217230
virtual bool read_line(std::string &name, std::string &data) = 0;
@@ -342,5 +355,9 @@ struct JSONResourceGuard {
342355
~JSONResourceGuard() {
343356
json_resource_ptr().reset();
344357
}
358+
359+
void check_parameters() {
360+
json_resource_ptr()->get_input_guard_ptr()->check_used_inputs();
361+
}
345362
};
346363

0 commit comments

Comments
 (0)