Files
pyxis/lib/microreticulum-shim/FileStream.h
T
torlando-agent[bot]andClaude Opus 4.8 70d4aa6be9 feat: graft pyxis onto upstream microReticulum 0.4.1
Repins microReticulum + microLXMF onto the upstream-0.4.1 graft and adapts
pyxis to the new src/microReticulum/ layout and 0.4.x APIs. The far-diverged
0.3.0 fork's Resource/Transport/Identity work is subsumed by upstream's
reimplementation; only the still-needed fixes ride on the pinned branches
(PKCS7/HMAC/X25519 crypto -- proven byte-identical to python RNS 1.3.1 --
Packet link-proof callback, Identity short-sig guard, and the bz2 layer +
decompress-on-receive in Resource::assemble()).

Consumer-side changes:
- platformio.ini: pin microReticulum @2f21fee (pyxis-fixes-on-0.4.1) and
  microLXMF @33760d0 (chore/microreticulum-0.4.1-layout); bump microStore
  ceea8f5 -> c5fb69d (0.4.x requires the new BasicFileStore::init API);
  -std=gnu++11 -> gnu++17 (upstream requires C++17).
- Namespace all microReticulum includes (angle + quote) to <microReticulum/...>
  for the relocated layout; shim-local Utilities/Stream.h|Print.h preserved.
- Interface::send_outgoing now returns bool: update TCP/BLE/SX1262/Auto
  overrides with correct success/failure returns.
- SDArchiveFileSystem::init(bool reformatOnFail=true) to match new microStore.
- Static Transport::get_path_table() -> path_table(); instance getter unchanged.
- Remove duplicate shim Cryptography/BZ2 (microReticulum provides it now; keep
  lib/libbz2 as the ESP32 bzlib provider).
- patch_littlefs_paths.py: normalize microStore's LittleFS adapter paths to a
  leading "/" -- ESP32 Arduino LittleFS rejects "./"-prefixed paths, which
  silently broke the path store (no peer paths learned, all messaging blocked).

Validated on T-Deck Plus: builds (RAM 27.5% / Flash 77.7%), boots stable
(no WDT/panic), and a full on-device LXMF e2e (DIRECT + OPPORTUNISTIC +
bz2-compressed-Resource receive) passes 5/5.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UWZuYkHBRqNb6BZHV8sTG5
2026-06-19 15:49:44 -04:00

145 lines
4.4 KiB
C++

#pragma once
#include <microReticulum/Utilities/Crc.h>
#include <microReticulum/Log.h>
#include <microReticulum/Bytes.h>
#include <microReticulum/Type.h>
#ifdef ARDUINO
#include <Stream.h>
#else
#include "Utilities/Stream.h"
#endif
#include <list>
#include <memory>
#include <cassert>
#include <stdint.h>
namespace RNS {
class FileStreamImpl {
protected:
FileStreamImpl() { MEMF("FileStreamImpl object created, this: 0x%X", this); }
public:
virtual ~FileStreamImpl() { MEMF("FileStreamImpl object destroyed, this: 0x%X", this); }
protected:
// CBA TODO Can these be pure-virtual???
virtual const char* name() = 0;
virtual size_t size() = 0;
virtual void close() = 0;
// Print overrides
virtual size_t write(uint8_t byte) = 0;
virtual size_t write(const uint8_t *buffer, size_t size) = 0;
// Stream overrides
virtual int available() = 0;
virtual int read() = 0;
virtual int peek() = 0;
virtual void flush() = 0;
friend class FileStream;
};
class FileStream : public Stream {
public:
enum MODE {
MODE_READ,
MODE_WRITE,
MODE_APPEND,
};
public:
FileStream(Type::NoneConstructor none) {
MEMF("FileStream NONE object created, this: 0x%X, impl: 0x%X", this, _impl.get());
}
FileStream(const FileStream& obj) : _impl(obj._impl), _crc(obj._crc) {
MEMF("FileStream object copy created, this: 0x%X, impl: 0x%X", this, _impl.get());
}
FileStream(FileStreamImpl* impl) : _impl(impl) {
MEMF("FileStream object impl created, this: 0x%X, impl: 0x%X", this, _impl.get());
}
virtual ~FileStream() {
MEMF("FileStream object destroyed, this: 0x%X, impl: 0x%X", this, _impl.get());
}
inline virtual FileStream& operator = (const FileStream& obj) {
_impl = obj._impl;
_crc = obj._crc;
MEMF("FileStream object copy created by assignment, this: 0x%X, impl: 0x%X", this, _impl.get());
return *this;
}
inline FileStream& operator = (FileStreamImpl* impl) {
_impl.reset(impl);
MEMF("FileStream object copy created by impl assignment, this: 0x%X, impl: 0x%X", this, _impl.get());
return *this;
}
inline operator bool() const {
MEMF("FileStream object bool, this: 0x%X, impl: 0x%X", this, _impl.get());
return _impl.get() != nullptr;
}
inline bool operator < (const FileStream& obj) const {
MEMF("FileStream object <, this: 0x%X, impl: 0x%X", this, _impl.get());
return _impl.get() < obj._impl.get();
}
inline bool operator > (const FileStream& obj) const {
MEMF("FileStream object <, this: 0x%X, impl: 0x%X", this, _impl.get());
return _impl.get() > obj._impl.get();
}
inline bool operator == (const FileStream& obj) const {
MEMF("FileStream object ==, this: 0x%X, impl: 0x%X", this, _impl.get());
return _impl.get() == obj._impl.get();
}
inline bool operator != (const FileStream& obj) const {
MEMF("FileStream object !=, this: 0x%X, impl: 0x%X", this, _impl.get());
return _impl.get() != obj._impl.get();
}
inline FileStreamImpl* get() {
return _impl.get();
}
inline void clear() {
_impl.reset();
}
public:
inline uint32_t crc() { return _crc; }
inline size_t write(const char* str) { return write((const uint8_t*)str, strlen(str)); }
// File overrides
inline const char* name() { assert(_impl); return _impl->name(); }
inline size_t size() { assert(_impl); return _impl->size(); }
inline void close() { assert(_impl); _impl->close(); }
// Print overrides
inline size_t write(uint8_t byte) { assert(_impl); _crc = Utilities::Crc::crc32(_crc, byte); return _impl->write(byte); }
inline size_t write(const uint8_t *buffer, size_t size) { assert(_impl); _crc = Utilities::Crc::crc32(_crc, buffer, size); return _impl->write(buffer, size); }
// Stream overrides
inline int available() { assert(_impl); return _impl->available(); }
inline int read() { assert(_impl); if (_impl->available() <= 0) return EOF; int ch = _impl->read(); uint8_t byte = (uint8_t)ch; _crc = Utilities::Crc::crc32(_crc, byte); return ch; }
inline int peek() { assert(_impl); return _impl->peek(); }
inline void flush() { assert(_impl); _impl->flush(); }
// getters/setters
protected:
public:
#ifndef NDEBUG
inline std::string debugString() const {
std::string dump;
dump = "FileStream object, this: " + std::to_string((uintptr_t)this) + ", data: " + std::to_string((uintptr_t)_impl.get());
return dump;
}
#endif
protected:
std::shared_ptr<FileStreamImpl> _impl;
uint32_t _crc = 0;
};
}