Added ReadBytesFromFile method.

neogeek · neogeek · commit 3a6c4e26d74b · 2025-01-18T17:21:53.000-05:00
Updated documentation.
diff --git a/Documentation/API/Parsers/ParseBpmFromChartSection.md b/Documentation/API/Parsers/ParseBpmFromChartSection.md
@@ -27,7 +27,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
diff --git a/Documentation/API/Parsers/ParseLyricsFromChartSection.md b/Documentation/API/Parsers/ParseLyricsFromChartSection.md
@@ -27,7 +27,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
diff --git a/Documentation/API/Parsers/ParseMetaDataFromChartSection.md b/Documentation/API/Parsers/ParseMetaDataFromChartSection.md
@@ -29,7 +29,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
diff --git a/Documentation/API/Parsers/ParseNotesFromChartSection.md b/Documentation/API/Parsers/ParseNotesFromChartSection.md
@@ -27,7 +27,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
diff --git a/Documentation/API/Parsers/ParseSectionsFromChart.md b/Documentation/API/Parsers/ParseSectionsFromChart.md
@@ -25,7 +25,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
diff --git a/Documentation/API/Parsers/ParseTimeSignaturesFromChartSection.md b/Documentation/API/Parsers/ParseTimeSignaturesFromChartSection.md
@@ -27,7 +27,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
diff --git a/README.md b/README.md
@@ -303,7 +303,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
@@ -361,7 +361,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
@@ -421,7 +421,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
@@ -481,7 +481,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
@@ -545,7 +545,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
@@ -598,7 +598,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
diff --git a/RhythmGameUtilities/README.md b/RhythmGameUtilities/README.md
@@ -303,7 +303,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
@@ -361,7 +361,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
@@ -421,7 +421,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
@@ -481,7 +481,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
@@ -545,7 +545,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
@@ -598,7 +598,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
diff --git a/UnityPackage/README.md b/UnityPackage/README.md
@@ -303,7 +303,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
@@ -361,7 +361,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
@@ -421,7 +421,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
@@ -481,7 +481,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
@@ -545,7 +545,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
@@ -598,7 +598,7 @@ using namespace RhythmGameUtilities;
 
 int main()
 {
-    auto content = ReadFromFile("./tests/Mocks/song.chart");
+    auto content = ReadStringFromFile("./tests/Mocks/song.chart");
 
     auto sections = ParseSectionsFromChart(content.c_str());
 
diff --git a/include/RhythmGameUtilities/File.hpp b/include/RhythmGameUtilities/File.hpp
@@ -3,18 +3,46 @@
 #include <fstream>
 #include <iostream>
 #include <string>
+#include <vector>
 
 namespace RhythmGameUtilities
 {
 
 /**
- * Reads the entire contents of a file.
+ * Reads the entire contents of a file as a byte array.
  *
  * @param path The path of the file to read.
  * @public
  */
 
-std::string ReadFromFile(const char *path)
+std::vector<uint8_t> ReadBytesFromFile(const char *path)
+{
+    std::ifstream file(path, std::ios::binary | std::ios::ate);
+
+    if (!file.is_open())
+    {
+        std::cerr << "Failed to open " << path << "." << std::endl;
+    }
+
+    auto fileSize = file.tellg();
+
+    std::vector<uint8_t> buffer(static_cast<size_t>(fileSize));
+
+    file.seekg(0, std::ios::beg);
+
+    file.read(reinterpret_cast<char *>(buffer.data()), fileSize);
+
+    return buffer;
+}
+
+/**
+ * Reads the entire contents of a file as a string.
+ *
+ * @param path The path of the file to read.
+ * @public
+ */
+
+std::string ReadStringFromFile(const char *path)
 {
     std::ifstream file(path);
 
diff --git a/tests/RhythmGameUtilities/File.cpp b/tests/RhythmGameUtilities/File.cpp
@@ -5,16 +5,24 @@
 
 using namespace RhythmGameUtilities;
 
-void testReadFromFile()
+void testReadBytesFromFile()
 {
-    assert(ReadFromFile("./tests/Mocks/test.txt") == "Hello, world!\n");
+    assert(size(ReadBytesFromFile("./tests/Mocks/test.txt")) == 14);
+
+    std::cout << ".";
+}
+
+void testReadStringFromFile()
+{
+    assert(ReadStringFromFile("./tests/Mocks/test.txt") == "Hello, world!\n");
 
     std::cout << ".";
 }
 
 int main()
 {
-    testReadFromFile();
+    testReadBytesFromFile();
+    testReadStringFromFile();
 
     return 0;
 }

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ using namespace RhythmGameUtilities;`
`27`	`27`
`28`	`28`	`int main()`
`29`	`29`	`{`
`30`		`- auto content = ReadFromFile("./tests/Mocks/song.chart");`
	`30`	`+ auto content = ReadStringFromFile("./tests/Mocks/song.chart");`
`31`	`31`
`32`	`32`	`auto sections = ParseSectionsFromChart(content.c_str());`
`33`	`33`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ using namespace RhythmGameUtilities;`
`29`	`29`
`30`	`30`	`int main()`
`31`	`31`	`{`
`32`		`- auto content = ReadFromFile("./tests/Mocks/song.chart");`
	`32`	`+ auto content = ReadStringFromFile("./tests/Mocks/song.chart");`
`33`	`33`
`34`	`34`	`auto sections = ParseSectionsFromChart(content.c_str());`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ using namespace RhythmGameUtilities;`
`25`	`25`
`26`	`26`	`int main()`
`27`	`27`	`{`
`28`		`- auto content = ReadFromFile("./tests/Mocks/song.chart");`
	`28`	`+ auto content = ReadStringFromFile("./tests/Mocks/song.chart");`
`29`	`29`
`30`	`30`	`auto sections = ParseSectionsFromChart(content.c_str());`
`31`	`31`
Original file line number	Diff line number	Diff line change
`@@ -303,7 +303,7 @@ using namespace RhythmGameUtilities;`
`303`	`303`
`304`	`304`	`int main()`
`305`	`305`	`{`
`306`		`- auto content = ReadFromFile("./tests/Mocks/song.chart");`
	`306`	`+ auto content = ReadStringFromFile("./tests/Mocks/song.chart");`
`307`	`307`
`308`	`308`	`auto sections = ParseSectionsFromChart(content.c_str());`
`309`	`309`
`@@ -361,7 +361,7 @@ using namespace RhythmGameUtilities;`
`361`	`361`
`362`	`362`	`int main()`
`363`	`363`	`{`
`364`		`- auto content = ReadFromFile("./tests/Mocks/song.chart");`
	`364`	`+ auto content = ReadStringFromFile("./tests/Mocks/song.chart");`
`365`	`365`
`366`	`366`	`auto sections = ParseSectionsFromChart(content.c_str());`
`367`	`367`
`@@ -421,7 +421,7 @@ using namespace RhythmGameUtilities;`
`421`	`421`
`422`	`422`	`int main()`
`423`	`423`	`{`
`424`		`- auto content = ReadFromFile("./tests/Mocks/song.chart");`
	`424`	`+ auto content = ReadStringFromFile("./tests/Mocks/song.chart");`
`425`	`425`
`426`	`426`	`auto sections = ParseSectionsFromChart(content.c_str());`
`427`	`427`
`@@ -481,7 +481,7 @@ using namespace RhythmGameUtilities;`
`481`	`481`
`482`	`482`	`int main()`
`483`	`483`	`{`
`484`		`- auto content = ReadFromFile("./tests/Mocks/song.chart");`
	`484`	`+ auto content = ReadStringFromFile("./tests/Mocks/song.chart");`
`485`	`485`
`486`	`486`	`auto sections = ParseSectionsFromChart(content.c_str());`
`487`	`487`
`@@ -545,7 +545,7 @@ using namespace RhythmGameUtilities;`
`545`	`545`
`546`	`546`	`int main()`
`547`	`547`	`{`
`548`		`- auto content = ReadFromFile("./tests/Mocks/song.chart");`
	`548`	`+ auto content = ReadStringFromFile("./tests/Mocks/song.chart");`
`549`	`549`
`550`	`550`	`auto sections = ParseSectionsFromChart(content.c_str());`
`551`	`551`
`@@ -598,7 +598,7 @@ using namespace RhythmGameUtilities;`
`598`	`598`
`599`	`599`	`int main()`
`600`	`600`	`{`
`601`		`- auto content = ReadFromFile("./tests/Mocks/song.chart");`
	`601`	`+ auto content = ReadStringFromFile("./tests/Mocks/song.chart");`
`602`	`602`
`603`	`603`	`auto sections = ParseSectionsFromChart(content.c_str());`
`604`	`604`