Release 0.9.13

Author: metayeti

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.9.13 (April 25, 2022)
+- `BUGFIX` - Writer now understands UTF-8 BOM-encoded files. ([#7](https://github.com/pulzed/mINI/issues/17))
+- `BUGFIX` - Fixes a bug introduced in 0.9.12 where reader would break when reading empty files.
+
 ## 0.9.12 (April 24, 2022)
 - `BUGFIX` - Fixes parser breaking for UTF-8 BOM-encoded files. ([#7](https://github.com/pulzed/mINI/issues/17))
 

README.md

@@ -1,6 +1,6 @@
 # mINI
 
-v0.9.12
+v0.9.13
 
 ## Info
 

src/mini/ini.h

@@ -23,7 +23,7 @@
 
 ///////////////////////////////////////////////////////////////////////////////
 //
-//  /mINI/ v0.9.12
+//  /mINI/ v0.9.13
 //  An INI file reader and writer for the modern age.
 //
 ///////////////////////////////////////////////////////////////////////////////
@@ -332,19 +332,31 @@ namespace mINI
 		using T_LineData = std::vector<std::string>;
 		using T_LineDataPtr = std::shared_ptr<T_LineData>;
 
+		bool isBOM = false;
+
 	private:
 		std::ifstream fileReadStream;
 		T_LineDataPtr lineData;
 
 		T_LineData readFile()
 		{
-			const char header[3] = {(char)fileReadStream.get(), (char)fileReadStream.get(), (char)fileReadStream.get()};
-			const bool isBOM = header[0] == (char)0xEF && header[1] == (char)0xBB && header[2] == (char)0xBF;
-			std::string fileContents;
 			fileReadStream.seekg(0, std::ios::end);
-			fileContents.resize(static_cast<std::size_t>(fileReadStream.tellg()));
+			const std::size_t fileSize = static_cast<std::size_t>(fileReadStream.tellg());
+			fileReadStream.seekg(0, std::ios::beg);
+			if (fileSize >= 3) {
+				const char header[3] = {
+					static_cast<char>(fileReadStream.get()),
+					static_cast<char>(fileReadStream.get()),
+					static_cast<char>(fileReadStream.get())
+				};
+				isBOM = header[0] == (char)0xEF && header[1] == (char)0xBB && header[2] == (char)0xBF;
+			}
+			else {
+				isBOM = false;
+			}
+			std::string fileContents;
+			fileContents.resize(fileSize);
 			fileReadStream.seekg(isBOM ? 3 : 0, std::ios::beg);
-			std::size_t fileSize = fileContents.size();
 			fileReadStream.read(&fileContents[0], fileSize);
 			fileReadStream.close();
 			T_LineData output;
@@ -678,11 +690,13 @@ namespace mINI
 			INIStructure originalData;
 			T_LineDataPtr lineData;
 			bool readSuccess = false;
+			bool fileIsBOM = false;
 			{
 				INIReader reader(filename, true);
 				if ((readSuccess = reader >> originalData))
 				{
 					lineData = reader.getLines();
+					fileIsBOM = reader.isBOM;
 				}
 			}
 			if (!readSuccess)
@@ -693,6 +707,10 @@ namespace mINI
 			std::ofstream fileWriteStream(filename, std::ios::out | std::ios::binary);
 			if (fileWriteStream.is_open())
 			{
+				if (fileIsBOM) {
+					const char utf8_BOM[3] = {(char)0xEF, (char)0xBB, (char)0xBF};
+					fileWriteStream.write(utf8_BOM, 3);
+				}
 				if (output.size())
 				{
 					auto line = output.begin();

tests/testutf8.cpp

@@ -109,6 +109,17 @@ const lest::test mINI_tests[] = {
 		EXPECT(ini["section"]["key"] == "value");
 		EXPECT(ini["section"]["key2"] == "value2");
 		EXPECT(ini["section2"]["key"] == "value");
+	},
+	CASE("Test: Write to UTF-8 BOM encoded file")
+	{
+		mINI::INIFile file("utf8bom.ini");
+		mINI::INIStructure ini;
+		EXPECT(file.read(ini) == true);
+		// update
+		ini["section"]["key"] = "something else";
+		// write
+		EXPECT(file.write(ini) == true);
+		// todo expect BOM encoding
 	}
 };