Skip to content

[feat] Added ReadBytesFromFile method. #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 18, 2025
Merged

[feat] Added ReadBytesFromFile method. #92

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Documentation/API/Parsers/ParseBpmFromChartSection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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());

Expand Down
2 changes: 1 addition & 1 deletion Documentation/API/Parsers/ParseLyricsFromChartSection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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());

Expand Down
2 changes: 1 addition & 1 deletion Documentation/API/Parsers/ParseMetaDataFromChartSection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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());

Expand Down
2 changes: 1 addition & 1 deletion Documentation/API/Parsers/ParseNotesFromChartSection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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());

Expand Down
2 changes: 1 addition & 1 deletion Documentation/API/Parsers/ParseSectionsFromChart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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());

Expand Down
2 changes: 1 addition & 1 deletion Documentation/API/Parsers/ParseTimeSignaturesFromChartSection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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());

Expand Down
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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());

Expand Down Expand Up @@ -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());

Expand Down Expand Up @@ -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());

Expand Down Expand Up @@ -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());

Expand Down Expand Up @@ -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());

Expand Down Expand Up @@ -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());

Expand Down
12 changes: 6 additions & 6 deletions RhythmGameUtilities/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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());

Expand Down Expand Up @@ -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());

Expand Down Expand Up @@ -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());

Expand Down Expand Up @@ -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());

Expand Down Expand Up @@ -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());

Expand Down Expand Up @@ -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());

Expand Down
12 changes: 6 additions & 6 deletions UnityPackage/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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());

Expand Down Expand Up @@ -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());

Expand Down Expand Up @@ -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());

Expand Down Expand Up @@ -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());

Expand Down Expand Up @@ -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());

Expand Down Expand Up @@ -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());

Expand Down
33 changes: 31 additions & 2 deletions include/RhythmGameUtilities/File.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,49 @@
#pragma once

#include <cstdint>
#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);

Expand Down
14 changes: 11 additions & 3 deletions tests/RhythmGameUtilities/File.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Loading