feat: add method ReadAsBase64 for binary/PNG files

Allows to read a binary file encoded to Base64. Support for both File and AsyncFile, thread-safe.
Update CHANGELOG.

Author: poirierlouis

CHANGELOG.md

@@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- read binary file encoded to Base64 using `ReadAsBase64()`, in both `File` and
+  `AsyncFile`. This is mainly intended to read PNG files (with a screenshot 
+  feature).
 
 ------------------------
 

scripts/RedFileSystem/AsyncFile.reds

@@ -12,6 +12,7 @@ public native class AsyncFile {
   public native func GetSize() -> Uint64;
 
   public native func ReadAsText(promise: FilePromise) -> Void;
+  public native func ReadAsBase64(promise: FilePromise) -> Void;
   public native func ReadAsLines(promise: FilePromise) -> Void;
   @if(ModuleExists("RedData.Json"))
   public native func ReadAsJson(promise: FilePromise) -> Void;

scripts/RedFileSystem/File.reds

@@ -12,6 +12,7 @@ public native class File {
   public native func GetSize() -> Uint64;
 
   public native func ReadAsText() -> String;
+  public native func ReadAsBase64() -> String;
   public native func ReadAsLines() -> array<String>;
   @if(ModuleExists("RedData.Json"))
   public native func ReadAsJson() -> ref<JsonVariant>;

src/AsyncFile.cpp

@@ -5,6 +5,8 @@
 #include <fstream>
 #include <utility>
 
+#include "Base64.h"
+
 namespace RedFS {
 AsyncFile::AsyncFile(SharedMutex p_mutex, std::filesystem::path p_path,
                      std::filesystem::path p_absolute_path)
@@ -58,6 +60,21 @@ void AsyncFile::read_as_text(const FilePromise& p_promise) {
   });
 }
 
+void AsyncFile::read_as_base64(const FilePromise& p_promise) {
+  Red::JobQueue job_queue;
+
+  job_queue.Dispatch([*this, p_promise]() -> void {
+    mutex->lock();
+    std::ifstream stream(absolute_path, std::ios::binary);
+    const std::string buffer(std::istreambuf_iterator(stream), {});
+
+    mutex->unlock();
+    const Red::CString data = base64::to_base64(buffer);
+
+    p_promise.resolve(data);
+  });
+}
+
 void AsyncFile::read_as_lines(const FilePromise& p_promise) {
   Red::JobQueue job_queue;
 

src/AsyncFile.h

@@ -31,6 +31,7 @@ class AsyncFile : public Red::IScriptable {
   [[nodiscard]] uint64_t get_size() const;
 
   void read_as_text(const FilePromise& p_promise);
+  void read_as_base64(const FilePromise& p_promise);
   void read_as_lines(const FilePromise& p_promise);
   void read_as_json(const FilePromise& p_promise);
 
@@ -59,6 +60,7 @@ RTTI_DEFINE_CLASS(RedFS::AsyncFile, {
   RTTI_METHOD(get_size, "GetSize");
 
   RTTI_METHOD(read_as_text, "ReadAsText");
+  RTTI_METHOD(read_as_base64, "ReadAsBase64");
   RTTI_METHOD(read_as_lines, "ReadAsLines");
   RTTI_METHOD(read_as_json, "ReadAsJson");
 

src/File.cpp

@@ -7,6 +7,8 @@
 #include <RedData.hpp>
 #include <RedLib.hpp>
 
+#include "Base64.h"
+
 namespace RedFS {
 
 File::File(SharedMutex p_mutex, std::filesystem::path p_path,
@@ -54,6 +56,16 @@ Red::CString File::read_as_text() {
   return data.str();
 }
 
+Red::CString File::read_as_base64() {
+  mutex->lock();
+  std::ifstream stream(absolute_path, std::ios::binary);
+  const std::string buffer(std::istreambuf_iterator(stream), {});
+
+  mutex->unlock();
+  Red::CString data = base64::to_base64(buffer);
+  return data;
+}
+
 Red::DynArray<Red::CString> File::read_as_lines() {
   mutex->lock();
   std::ifstream stream;

src/File.h

@@ -33,6 +33,7 @@ class File : public Red::IScriptable {
   [[nodiscard]] uint64_t get_size() const;
 
   Red::CString read_as_text();
+  Red::CString read_as_base64();
   Red::DynArray<Red::CString> read_as_lines();
   Red::Handle<Red::IScriptable> read_as_json();
 
@@ -59,6 +60,7 @@ RTTI_DEFINE_CLASS(RedFS::File, {
   RTTI_METHOD(get_size, "GetSize");
 
   RTTI_METHOD(read_as_text, "ReadAsText");
+  RTTI_METHOD(read_as_base64, "ReadAsBase64");
   RTTI_METHOD(read_as_lines, "ReadAsLines");
   RTTI_METHOD(read_as_json, "ReadAsJson");