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 +- test/Makefile.am | 11 +++- test/configtest.cc | 183 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 320 insertions(+), 13 deletions(-) create mode 100644 test/configtest.cc 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(); diff --git a/test/Makefile.am b/test/Makefile.am index 5aaf33f..90373e1 100644 --- a/test/Makefile.am +++ b/test/Makefile.am @@ -1,7 +1,7 @@ # Rules for the test code (use `make check` to execute) include $(top_srcdir)/src/Makefile.am.drumgizmo -TESTS = engine gui resampler lv2 +TESTS = engine gui resampler lv2 configfile check_PROGRAMS = $(TESTS) @@ -40,3 +40,12 @@ lv2_SOURCES = \ test.cc \ lv2_test_host.cc \ lv2.cc + +configfile_CXXFLAGS = -DOUTPUT=\"configfile\" $(CPPUNIT_CFLAGS) \ + -I$(top_srcdir)/hugin +configfile_LDFLAGS = $(CPPUNIT_LIBS) +configfile_SOURCES = \ + $(top_srcdir)/src/configfile.cc \ + $(top_srcdir)/hugin/hugin.c \ + test.cc \ + configtest.cc diff --git a/test/configtest.cc b/test/configtest.cc new file mode 100644 index 0000000..c05299f --- /dev/null +++ b/test/configtest.cc @@ -0,0 +1,183 @@ +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/*************************************************************************** + * configtest.cc + * + * Thu May 14 20:58:29 CEST 2015 + * Copyright 2015 Bent Bisballe Nyeng + * deva@aasimon.org + ****************************************************************************/ + +/* + * This file is part of DrumGizmo. + * + * DrumGizmo is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * DrumGizmo is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with DrumGizmo; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. + */ +#include + +#include +#include + +#include "../src/configfile.h" + +class TestConfigFile : public ConfigFile { +public: + TestConfigFile() : ConfigFile("") {} + +protected: + // Overload the built-in open method to use local file instead of homedir. + virtual bool open(std::string mode) override + { + fp = fopen("test.conf", mode.c_str()); + return fp != nullptr; + } +}; + +class test_configtest : public CppUnit::TestFixture +{ + CPPUNIT_TEST_SUITE(test_configtest); + CPPUNIT_TEST(loading_no_newline); + CPPUNIT_TEST(loading_equal_sign); + CPPUNIT_TEST(loading_newline); + CPPUNIT_TEST(loading_padding_space); + CPPUNIT_TEST(loading_padding_space_newline); + CPPUNIT_TEST(loading_padding_tab); + CPPUNIT_TEST(loading_padding_tab_newline); + CPPUNIT_TEST(loading_comment); + CPPUNIT_TEST(loading_inline_comment); + CPPUNIT_TEST(loading_single_quoted_string); + CPPUNIT_TEST(loading_double_quoted_string); + CPPUNIT_TEST_SUITE_END(); + +public: + void setUp() + { + } + + void tearDown() + { + unlink("test.conf"); + } + + void writeFile(const char* str) + { + FILE* fp = fopen("test.conf", "w"); + fprintf(fp, "%s", str); + fclose(fp); + } + + void loading_no_newline() + { + writeFile("a:b"); + + TestConfigFile cf; + cf.load(); + CPPUNIT_ASSERT_EQUAL(std::string("b"), cf.getValue("a")); + } + + void loading_equal_sign() + { + writeFile(" a =\tb\t\n"); + + TestConfigFile cf; + cf.load(); + CPPUNIT_ASSERT_EQUAL(std::string("b"), cf.getValue("a")); + } + + void loading_newline() + { + writeFile("a:b\n"); + + TestConfigFile cf; + cf.load(); + CPPUNIT_ASSERT_EQUAL(std::string("b"), cf.getValue("a")); + } + + void loading_padding_space() + { + writeFile(" a : b "); + + TestConfigFile cf; + cf.load(); + CPPUNIT_ASSERT_EQUAL(std::string("b"), cf.getValue("a")); + } + + void loading_padding_tab() + { + writeFile("\ta\t:\tb\t"); + + TestConfigFile cf; + cf.load(); + CPPUNIT_ASSERT_EQUAL(std::string("b"), cf.getValue("a")); + } + + void loading_padding_space_newline() + { + writeFile(" a : b \n"); + + TestConfigFile cf; + cf.load(); + CPPUNIT_ASSERT_EQUAL(std::string("b"), cf.getValue("a")); + } + + void loading_padding_tab_newline() + { + writeFile("\ta\t:\tb\t\n"); + + TestConfigFile cf; + cf.load(); + CPPUNIT_ASSERT_EQUAL(std::string("b"), cf.getValue("a")); + } + + void loading_comment() + { + writeFile("# comment\na:b\n"); + + TestConfigFile cf; + cf.load(); + CPPUNIT_ASSERT_EQUAL(std::string("b"), cf.getValue("a")); + } + + void loading_inline_comment() + { + writeFile("a:b #comment\n"); + + TestConfigFile cf; + cf.load(); + CPPUNIT_ASSERT_EQUAL(std::string("b"), cf.getValue("a")); + } + + void loading_single_quoted_string() + { + writeFile("a: '#\"b\" ' \n"); + + TestConfigFile cf; + cf.load(); + CPPUNIT_ASSERT_EQUAL(std::string("#\"b\" "), cf.getValue("a")); + } + + void loading_double_quoted_string() + { + writeFile("a: \"#'b' \" \n"); + + TestConfigFile cf; + cf.load(); + CPPUNIT_ASSERT_EQUAL(std::string("#'b' "), cf.getValue("a")); + } +}; + +// Registers the fixture into the 'registry' +CPPUNIT_TEST_SUITE_REGISTRATION(test_configtest); + + -- cgit v1.2.3