From 560c26d33c76fee45b04e92ffd36ce885c357db6 Mon Sep 17 00:00:00 2001 From: Bent Bisballe Nyeng Date: Thu, 21 May 2015 20:52:08 +0200 Subject: New configfile parser with unit test. --- src/configfile.cc | 137 +++++++++++++++++++++++++++++++++++++++++++++++++----- src/configfile.h | 2 +- 2 files changed, 127 insertions(+), 12 deletions(-) (limited to 'src') diff --git a/src/configfile.cc b/src/configfile.cc index bb7155f..e659a51 100644 --- a/src/configfile.cc +++ b/src/configfile.cc @@ -46,12 +46,12 @@ #ifdef WIN32 #define SEP "\\" - #define CONFIGDIRNAME ".drumgizmo" #else #define SEP "/" - #define CONFIGDIRNAME ".drumgizmo" #endif +#define CONFIGDIRNAME ".drumgizmo" + /** * Return the path containing the config files. */ @@ -89,7 +89,7 @@ static bool createConfigPath() #else if(mkdir(configpath.c_str(), 0755) < 0) { #endif - DEBUG(pluginconfig, "Could not create config directory\n"); + DEBUG(configfile, "Could not create config directory\n"); } return false; @@ -110,7 +110,7 @@ ConfigFile::~ConfigFile() void ConfigFile::load() { - DEBUG(pluginconfig, "Loading config file...\n"); + DEBUG(configfile, "Loading config file...\n"); if(!open("r")) return; values.clear(); @@ -125,14 +125,129 @@ void ConfigFile::load() line = line.substr(0, line.size() - 1); // strip ending newline. } - std::size_t colon = line.find(':'); + std::string key; + std::string value; + enum { + before_key, + in_key, + after_key, + before_value, + in_value, + in_value_single_quoted, + in_value_double_quoted, + after_value, + } state = before_key; + + for(std::size_t p = 0; p < line.size(); ++p) { + switch(state) { + case before_key: + if(line[p] == '#') { + // Comment: Ignore line. + p = line.size(); + continue; + } + if(std::isspace(line[p])) { + continue; + } + key += line[p]; + state = in_key; + break; + + case in_key: + if(std::isspace(line[p])) { + state = after_key; + continue; + } + if(line[p] == ':' || line[p] == '=') { + state = before_value; + continue; + } + key += line[p]; + break; + + case after_key: + if(std::isspace(line[p])) { + continue; + } + if(line[p] == ':' || line[p] == '=') { + state = before_value; + continue; + } + // ERROR: Bad symbol, expecting only whitespace or key/value seperator + break; + + case before_value: + if(std::isspace(line[p])) { + continue; + } + if(line[p] == '\'') { + state = in_value_single_quoted; + continue; + } + if(line[p] == '"') { + state = in_value_double_quoted; + continue; + } + value += line[p]; + state = in_value; + break; + + case in_value: + if(std::isspace(line[p])) { + state = after_value; + continue; + } + if(line[p] == '#') { + // Comment: Ignore the rest of the line. + p = line.size(); + state = after_value; + continue; + } + value += line[p]; + break; + + case in_value_single_quoted: + if(line[p] == '\'') { + state = after_value; + continue; + } + value += line[p]; + break; + + case in_value_double_quoted: + if(line[p] == '"') { + state = after_value; + continue; + } + value += line[p]; + break; + + case after_value: + if(std::isspace(line[p])) { + continue; + } + if(line[p] == '#') { + // Comment: Ignore the rest of the line. + p = line.size(); + continue; + } + // ERROR: Bad symbol, expecting only whitespace or key/value seperator + break; + } + } - if(colon == std::string::npos) break; // malformed line + if(state == before_key) { + // Line did not contain any data (empty or comment) + continue; + } - std::string key = line.substr(0, colon); - std::string value = line.substr(colon + 1); + // If state == in_value_XXX_quoted here, the string was not terminated. + if(state != after_value && state != in_value) { + // ERROR: Malformed line. + break; + } - printf("key['%s'] value['%s']\n", key.c_str(), value.c_str()); + DEBUG(configfile, "key['%s'] value['%s']\n", key.c_str(), value.c_str()); if(key != "") { values[key] = value; @@ -144,7 +259,7 @@ void ConfigFile::load() void ConfigFile::save() { - DEBUG(pluginconfig, "Saving configuration...\n"); + DEBUG(configfile, "Saving configuration...\n"); createConfigPath(); @@ -182,7 +297,7 @@ bool ConfigFile::open(std::string mode) configfile += SEP; configfile += filename; - DEBUG(pluginconfig, "Opening config file '%s'\n", configfile.c_str()); + DEBUG(configfile, "Opening config file '%s'\n", configfile.c_str()); fp = fopen(configfile.c_str(), mode.c_str()); if(!fp) return false; diff --git a/src/configfile.h b/src/configfile.h index 21a6b88..a3fd588 100644 --- a/src/configfile.h +++ b/src/configfile.h @@ -46,7 +46,7 @@ protected: std::map values; std::string filename; - bool open(std::string mode); + virtual bool open(std::string mode); void close(); std::string readLine(); -- cgit v1.2.3 From 6e3b53cd1b0fc6dcd721fac3beb699cb722e1e23 Mon Sep 17 00:00:00 2001 From: Bent Bisballe Nyeng Date: Fri, 22 May 2015 08:30:24 +0200 Subject: Add error handling in ConfigFile parser. --- src/configfile.cc | 287 +++++++++++++++++++++++++++++------------------------- src/configfile.h | 5 +- 2 files changed, 155 insertions(+), 137 deletions(-) (limited to 'src') diff --git a/src/configfile.cc b/src/configfile.cc index e659a51..6b0d14f 100644 --- a/src/configfile.cc +++ b/src/configfile.cc @@ -108,10 +108,12 @@ ConfigFile::~ConfigFile() { } -void ConfigFile::load() +bool ConfigFile::load() { DEBUG(configfile, "Loading config file...\n"); - if(!open("r")) return; + if(!open("r")) { + return false; + } values.clear(); @@ -120,150 +122,26 @@ void ConfigFile::load() line = readLine(); if(line == "") break; - - if(line[line.size() - 1] == '\n') { - line = line.substr(0, line.size() - 1); // strip ending newline. - } - - std::string key; - std::string value; - enum { - before_key, - in_key, - after_key, - before_value, - in_value, - in_value_single_quoted, - in_value_double_quoted, - after_value, - } state = before_key; - - for(std::size_t p = 0; p < line.size(); ++p) { - switch(state) { - case before_key: - if(line[p] == '#') { - // Comment: Ignore line. - p = line.size(); - continue; - } - if(std::isspace(line[p])) { - continue; - } - key += line[p]; - state = in_key; - break; - - case in_key: - if(std::isspace(line[p])) { - state = after_key; - continue; - } - if(line[p] == ':' || line[p] == '=') { - state = before_value; - continue; - } - key += line[p]; - break; - - case after_key: - if(std::isspace(line[p])) { - continue; - } - if(line[p] == ':' || line[p] == '=') { - state = before_value; - continue; - } - // ERROR: Bad symbol, expecting only whitespace or key/value seperator - break; - - case before_value: - if(std::isspace(line[p])) { - continue; - } - if(line[p] == '\'') { - state = in_value_single_quoted; - continue; - } - if(line[p] == '"') { - state = in_value_double_quoted; - continue; - } - value += line[p]; - state = in_value; - break; - - case in_value: - if(std::isspace(line[p])) { - state = after_value; - continue; - } - if(line[p] == '#') { - // Comment: Ignore the rest of the line. - p = line.size(); - state = after_value; - continue; - } - value += line[p]; - break; - - case in_value_single_quoted: - if(line[p] == '\'') { - state = after_value; - continue; - } - value += line[p]; - break; - - case in_value_double_quoted: - if(line[p] == '"') { - state = after_value; - continue; - } - value += line[p]; - break; - - case after_value: - if(std::isspace(line[p])) { - continue; - } - if(line[p] == '#') { - // Comment: Ignore the rest of the line. - p = line.size(); - continue; - } - // ERROR: Bad symbol, expecting only whitespace or key/value seperator - break; - } - } - - if(state == before_key) { - // Line did not contain any data (empty or comment) - continue; - } - - // If state == in_value_XXX_quoted here, the string was not terminated. - if(state != after_value && state != in_value) { - // ERROR: Malformed line. - break; - } - - DEBUG(configfile, "key['%s'] value['%s']\n", key.c_str(), value.c_str()); - - if(key != "") { - values[key] = value; + + if(!parseLine(line)) { + return false; } } close(); + + return true; } -void ConfigFile::save() +bool ConfigFile::save() { DEBUG(configfile, "Saving configuration...\n"); createConfigPath(); - if(!open("w")) return; + if(!open("w")) { + return false; + } std::map::iterator v = values.begin(); for(; v != values.end(); ++v) { @@ -271,6 +149,8 @@ void ConfigFile::save() } close(); + + return true; } std::string ConfigFile::getValue(const std::string& key) @@ -328,3 +208,140 @@ std::string ConfigFile::readLine() return line; } + +bool ConfigFile::parseLine(const std::string& line) +{ + std::string key; + std::string value; + enum { + before_key, + in_key, + after_key, + before_value, + in_value, + in_value_single_quoted, + in_value_double_quoted, + after_value, + } state = before_key; + + for(std::size_t p = 0; p < line.size(); ++p) { + switch(state) { + case before_key: + if(line[p] == '#') { + // Comment: Ignore line. + p = line.size(); + continue; + } + if(std::isspace(line[p])) { + continue; + } + key += line[p]; + state = in_key; + break; + + case in_key: + if(std::isspace(line[p])) { + state = after_key; + continue; + } + if(line[p] == ':' || line[p] == '=') { + state = before_value; + continue; + } + key += line[p]; + break; + + case after_key: + if(std::isspace(line[p])) { + continue; + } + if(line[p] == ':' || line[p] == '=') { + state = before_value; + continue; + } + ERR(configfile, "Bad symbol." + " Expecting only whitespace or key/value seperator: '%s'", + line.c_str()); + return false; + + case before_value: + if(std::isspace(line[p])) { + continue; + } + if(line[p] == '\'') { + state = in_value_single_quoted; + continue; + } + if(line[p] == '"') { + state = in_value_double_quoted; + continue; + } + value += line[p]; + state = in_value; + break; + + case in_value: + if(std::isspace(line[p])) { + state = after_value; + continue; + } + if(line[p] == '#') { + // Comment: Ignore the rest of the line. + p = line.size(); + state = after_value; + continue; + } + value += line[p]; + break; + + case in_value_single_quoted: + if(line[p] == '\'') { + state = after_value; + continue; + } + value += line[p]; + break; + + case in_value_double_quoted: + if(line[p] == '"') { + state = after_value; + continue; + } + value += line[p]; + break; + + case after_value: + if(std::isspace(line[p])) { + continue; + } + if(line[p] == '#') { + // Comment: Ignore the rest of the line. + p = line.size(); + continue; + } + ERR(configfile, "Bad symbol." + " Expecting only whitespace or key/value seperator: '%s'", + line.c_str()); + return false; + } + } + + if(state == before_key) { + // Line did not contain any data (empty or comment) + return true; + } + + // If state == in_value_XXX_quoted here, the string was not terminated. + if(state != after_value && state != in_value) { + ERR(configfile,"Malformed line: '%s'", line.c_str()); + return false; + } + + DEBUG(configfile, "key['%s'] value['%s']\n", key.c_str(), value.c_str()); + + if(key != "") { + values[key] = value; + } + + return true; +} diff --git a/src/configfile.h b/src/configfile.h index a3fd588..a6c50bd 100644 --- a/src/configfile.h +++ b/src/configfile.h @@ -36,8 +36,8 @@ public: ConfigFile(std::string filename); virtual ~ConfigFile(); - virtual void load(); - virtual void save(); + virtual bool load(); + virtual bool save(); virtual std::string getValue(const std::string& key); virtual void setValue(const std::string& key, const std::string& value); @@ -49,6 +49,7 @@ protected: virtual bool open(std::string mode); void close(); std::string readLine(); + bool parseLine(const std::string& line); FILE* fp; }; -- cgit v1.2.3 From 2699cb7d324ffb1d2adc62e1f62434397aa39e2d Mon Sep 17 00:00:00 2001 From: Bent Bisballe Nyeng Date: Fri, 22 May 2015 08:35:53 +0200 Subject: Use new load return value from ConfigFile. --- src/audioinputenginemidi.cc | 10 +++++++--- src/drumkitparser.cc | 10 ++++++---- 2 files changed, 13 insertions(+), 7 deletions(-) (limited to 'src') diff --git a/src/audioinputenginemidi.cc b/src/audioinputenginemidi.cc index 5494462..7c1e13d 100644 --- a/src/audioinputenginemidi.cc +++ b/src/audioinputenginemidi.cc @@ -35,15 +35,19 @@ AudioInputEngineMidi::AudioInputEngineMidi() : refs(REFSFILE) { - refs.load(); is_valid = false; } bool AudioInputEngineMidi::loadMidiMap(std::string _f, Instruments &instruments) { std::string f = _f; - if(_f.size() > 1 && _f[0] == '@') { - f = refs.getValue(_f.substr(1)); + + if(refs.load()) { + if(_f.size() > 1 && _f[0] == '@') { + f = refs.getValue(_f.substr(1)); + } + } else { + ERR(drumkitparser, "Error reading refs.conf"); } file = ""; diff --git a/src/drumkitparser.cc b/src/drumkitparser.cc index 00232b2..f7bfe40 100644 --- a/src/drumkitparser.cc +++ b/src/drumkitparser.cc @@ -38,12 +38,14 @@ DrumKitParser::DrumKitParser(const std::string &file, DrumKit &k) : kit(k) , refs(REFSFILE) { - refs.load(); - std::string kitfile = file; - if(file.size() > 1 && file[0] == '@') { - kitfile = refs.getValue(file.substr(1)); + if(refs.load()) { + if(file.size() > 1 && file[0] == '@') { + kitfile = refs.getValue(file.substr(1)); + } + } else { + ERR(drumkitparser, "Error reading refs.conf"); } // instr = NULL; -- cgit v1.2.3