mirror of
https://github.com/crosspoint-reader/crosspoint-reader.git
synced 2026-08-13 14:21:57 -07:00
Justin Mitchell
9220e5a301
Replace inline findPluginDir with scanPlugins() that returns structured Entry objects containing plugin metadata (plugin.js, device.json, manifest.json markers). This centralizes plugin discovery logic and provides a single source of truth for what constitutes a valid plugin across all roots.
106 lines
3.5 KiB
C++
106 lines
3.5 KiB
C++
#pragma once
|
|
|
|
#include <Print.h>
|
|
#include <common/FsApiConstants.h> // for oflag_t
|
|
#include <freertos/semphr.h>
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
class HalFile;
|
|
|
|
class HalStorage {
|
|
public:
|
|
HalStorage();
|
|
bool begin();
|
|
bool ready() const;
|
|
std::vector<String> listFiles(const char* path = "/", int maxFiles = 200);
|
|
// Read the entire file at `path` into a String. Returns empty string on failure.
|
|
String readFile(const char* path);
|
|
// Low-memory helpers:
|
|
// Stream the file contents to a `Print` (e.g. `Serial`, or any `Print`-derived object).
|
|
// Returns true on success, false on failure.
|
|
bool readFileToStream(const char* path, Print& out, size_t chunkSize = 256);
|
|
// Read up to `bufferSize-1` bytes into `buffer`, null-terminating it. Returns bytes read.
|
|
size_t readFileToBuffer(const char* path, char* buffer, size_t bufferSize, size_t maxBytes = 0);
|
|
// Read the whole file at `path` into `out`. Fails (without allocating) on
|
|
// missing, directory, empty, above-`cap`, or short-read files.
|
|
bool readFileToString(const char* moduleName, const std::string& path, size_t cap, std::string& out);
|
|
// Write a string to `path` on the SD card. Overwrites existing file.
|
|
// Returns true on success.
|
|
bool writeFile(const char* path, const String& content);
|
|
// Ensure a directory exists, creating it if necessary. Returns true on success.
|
|
bool ensureDirectoryExists(const char* path);
|
|
|
|
HalFile open(const char* path, const oflag_t oflag = O_RDONLY);
|
|
bool mkdir(const char* path, const bool pFlag = true);
|
|
bool exists(const char* path);
|
|
bool remove(const char* path);
|
|
bool rename(const char* oldPath, const char* newPath);
|
|
bool rmdir(const char* path);
|
|
|
|
bool openFileForRead(const char* moduleName, const char* path, HalFile& file);
|
|
bool openFileForRead(const char* moduleName, const std::string& path, HalFile& file);
|
|
bool openFileForRead(const char* moduleName, const String& path, HalFile& file);
|
|
bool openFileForWrite(const char* moduleName, const char* path, HalFile& file);
|
|
bool openFileForWrite(const char* moduleName, const std::string& path, HalFile& file);
|
|
bool openFileForWrite(const char* moduleName, const String& path, HalFile& file);
|
|
bool removeDir(const char* path);
|
|
|
|
static HalStorage& getInstance() { return instance; }
|
|
|
|
class StorageLock; // private class, used internally
|
|
|
|
private:
|
|
static HalStorage instance;
|
|
|
|
bool initialized = false;
|
|
SemaphoreHandle_t storageMutex = nullptr;
|
|
};
|
|
|
|
#define Storage HalStorage::getInstance()
|
|
|
|
class HalFile : public Print {
|
|
friend class HalStorage;
|
|
class Impl;
|
|
std::unique_ptr<Impl> impl;
|
|
explicit HalFile(std::unique_ptr<Impl> impl);
|
|
|
|
public:
|
|
HalFile();
|
|
~HalFile();
|
|
HalFile(HalFile&&);
|
|
HalFile& operator=(HalFile&&);
|
|
HalFile(const HalFile&) = delete;
|
|
HalFile& operator=(const HalFile&) = delete;
|
|
|
|
void flush();
|
|
size_t getName(char* name, size_t len);
|
|
size_t size();
|
|
size_t fileSize();
|
|
uint64_t fileSize64();
|
|
bool seek(size_t pos);
|
|
bool seek64(uint64_t pos);
|
|
bool seekCur(int64_t offset);
|
|
bool seekSet(size_t offset);
|
|
int available() const;
|
|
size_t position() const;
|
|
int read(void* buf, size_t count);
|
|
int read(); // read a single byte
|
|
size_t write(const void* buf, size_t count);
|
|
size_t write(uint8_t b) override;
|
|
bool rename(const char* newPath);
|
|
bool isDirectory() const;
|
|
void rewindDirectory();
|
|
bool close();
|
|
HalFile openNextFile();
|
|
bool isOpen() const;
|
|
operator bool() const;
|
|
};
|
|
|
|
// Downstream code must use Storage instead of SdMan
|
|
#ifdef SdMan
|
|
#undef SdMan
|
|
#endif
|