Merge branch 'release/Initial-Release'

Author: dadul96

README.md

@@ -1,12 +1,13 @@
 # raw_config_file_handling
-This small single header library allows handling of ini-style config-files. In addition to the standard ini-format, this library allows values with more than one parameter (separation with commas).
+This small single header library allows handling of ini-style config-files. In addition to the standard ini-format, this library allows values with more than one parameter (separation with commas). Comments in the config-file are getting ignored. The standard comment-character is the semicolon (;), but also custom characters could be set.
 Example of this config-file format:
 ```ini
-[GENERAL]
-BALL_COUNT=2
+;Comment1
+[GENERAL];Comment2
+BALL_COUNT=2;Comment3
 
 [BALL]
-BALL_COLOR_RGB=0,0,255
+BALL_RGB_COLOR=0,0,255
 ...
 ```
 ### Installation
@@ -21,7 +22,7 @@ struct Configuration { //program configuration
   vector<int> BallColorRGB;
 };
 ```
-2. Inherit from the base class (RawConfigFileHandler) and implement setConfig/getConfig Methods and optional features (for a more advanced use, see the example folder):
+3. Inherit from the base class (RawConfigFileHandler) and implement setConfig/getConfig Methods and optional features (for a more advanced use, see the example folder):
 ```cpp
 class ConfigFileHandler : public RawConfigFileHandler {
 public:
@@ -86,9 +87,6 @@ public:
 ### Built With
 * [Visual Studio 2019](https://visualstudio.microsoft.com/)
 
-### Note
-The example solution was built with Visual Studio 2019. If you are using other versions of VS you might need to change some settings.
-
 ### Author
 **Daniel Duller** - [dadul96](https://github.com/dadul96)
 

raw_config_file_handling/example/example.cpp

@@ -1,4 +1,4 @@
-#include "raw_config_file_handling.hpp"
+#include "../raw_config_file_handling.hpp"
 
 //set up a structure that includes all desired config-parameters:
 struct Configuration { //program configuration
@@ -20,7 +20,7 @@ class ConfigFileHandler : public RawConfigFileHandler {
 	//constructor for initializing the flags:
 	ConfigFileHandler() : SuccessfulReading(false), SuccessfulWriting(false) {}
 
-	//create a function that assigns the RawConfigData (from base class) to the Configuration-struct:
+	//create a method that assigns the RawConfigData (from base class) to the Configuration-struct:
 	void getConfig() {
 		constexpr int DesiredParameterCount = 2; //number of expected parameters (for checking if the reading was successful)
 		int ParameterCount = 0;
@@ -56,7 +56,7 @@ class ConfigFileHandler : public RawConfigFileHandler {
 		}
 	}
 
-	//create a function that assigns the Configuration-struct to the RawConfigData (in base class) in order to write a config file:
+	//create a method that assigns the Configuration-struct to the RawConfigData (in base class) in order to write a config file:
 	void setConfig() {
 		int i = 0;
 		RawConfigData.clear();
@@ -85,8 +85,12 @@ class ConfigFileHandler : public RawConfigFileHandler {
 int main() {
 	ConfigFileHandler ConfigHandler1;
 
+	ConfigHandler1.setCommentChar('#'); //changing the comment character from ";" (default) to "#"
+
 	ConfigHandler1.setFilePath("C:\\dev\\VS2019_repos\\raw_config_file_handling\\raw_config_file_handling\\example\\example_config.ini"); //setting the path of the config-file (enter your desired path)
 
+	cout << ConfigHandler1.getCommentChar() << endl; //printing the set comment character
+
 	cout << ConfigHandler1.getFilePath() << endl; //printing the path of the config-file
 
 	ConfigHandler1.getConfig(); //reading config-file

raw_config_file_handling/example/example_config.ini

@@ -1,5 +1,6 @@
-[GENERAL]
-BALL_COUNT=2
+#Comment1
+[GENERAL]#Comment2
+BALL_COUNT=2#Comment3
 
 [BALL]
 BALL_RGB_COLOR=0,0,255

raw_config_file_handling/example/raw_config_file_handling.hpp renamed to raw_config_file_handling/raw_config_file_handling.hpp

@@ -22,6 +22,7 @@ struct ConfigDataStruct {
 class RawConfigFileHandler {
 private:
 	string FilePath;
+	char CommentChar;
 
 protected:
 	vector<ConfigDataStruct> RawConfigData;
@@ -41,13 +42,19 @@ class RawConfigFileHandler {
 
 			while (getline(inFile, Input))
 			{
+				int CommentCharPos = -1;
 				int Char1Pos = -1;
 				int Char2Pos = -1;
 
 				string Key;
 				string RawValue;
 				vector<string> Value;
 
+				if ((CommentCharPos = Input.find(CommentChar)) >= 0)
+				{
+					Input.erase(CommentCharPos, Input.size());
+				}
+
 				if ((Char1Pos = Input.find(Char1)) > 0)
 				{
 					Key = RawValue = Input;
@@ -126,7 +133,7 @@ class RawConfigFileHandler {
 	}
 
 public:
-	RawConfigFileHandler() : FilePath("config.ini") {}
+	RawConfigFileHandler() : FilePath("config.ini"), CommentChar(';') {}
 
 	void setFilePath(string pFilePath) {
 		FilePath = pFilePath;
@@ -136,6 +143,14 @@ class RawConfigFileHandler {
 		return FilePath;
 	}
 
+	void setCommentChar(char pCommentChar) {
+		CommentChar = pCommentChar;
+	}
+
+	char getCommentChar() {
+		return CommentChar;
+	}
+
 	void printRawConfigData() {
 		for (size_t i = 0; i < RawConfigData.size(); i++)
 		{