evan/esp32-lua-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: lsp + format

Browse Source
This commit is contained in:
Evan Reichard
2026-08-04 10:21:18 -04:00
parent fa35c3c326
commit 4533c7f61f
30 changed files with 1151 additions and 678 deletions
Download Patch File Download Diff File Expand all files Collapse all files
native/include/lua/providers.h
+101 -65
View File
@@ -7,11 +7,12 @@
namespace esp32lua {
// Every value crossing this seam is int32_t because the interpreter is built with
// LUA_32BITS: the ESP32 is a 32-bit core with no hardware float64, so a wider lua_Integer
// would cost size and speed on every value in the heap. The ceilings that follows from it
// are sys.getMillis() wrapping after ~24.9 days of uptime and file offsets stopping at
// 2 GB, neither of which a battery-powered handheld reading an SD card reaches.
// Every value crossing this seam is int32_t because the interpreter is built
// with LUA_32BITS: the ESP32 is a 32-bit core with no hardware float64, so a
// wider lua_Integer would cost size and speed on every value in the heap. The
// ceilings that follows from it are sys.getMillis() wrapping after ~24.9 days
// of uptime and file offsets stopping at 2 GB, neither of which a
// battery-powered handheld reading an SD card reaches.
struct Status {
bool ok;
std::string error;
@@ -23,7 +24,7 @@ struct Status {
enum class LogLevel { Debug, Info, Error };
class LogProvider {
public:
public:
virtual ~LogProvider() = default;
virtual void write(LogLevel level, const std::string& message) = 0;
};
@@ -35,7 +36,7 @@ struct MemoryInfo {
};
class SettingsProvider {
public:
public:
virtual ~SettingsProvider() = default;
virtual int32_t rotation() const = 0;
virtual Status setRotation(int32_t degrees) = 0;
@@ -43,46 +44,57 @@ class SettingsProvider {
virtual Status setTimezone(const std::string& timezone) = 0;
};
// Only what the firmware alone can answer. App identity, titles, data paths, feature reporting
// and navigation are the runtime's, because it owns app loading and knows which providers exist.
// Only what the firmware alone can answer. App identity, titles, data paths,
// feature reporting and navigation are the runtime's, because it owns app
// loading and knows which providers exist.
class SysProvider {
public:
public:
virtual ~SysProvider() = default;
virtual int32_t millis() const = 0;
virtual MemoryInfo memory() const = 0;
virtual bool isClockSynced() const = 0;
};
// Scripts are streamed rather than slurped: a whole module in one buffer needs that many bytes
// contiguous, and once WiFi is up the largest free block is far smaller than the free heap.
// Scripts are streamed rather than slurped: a whole module in one buffer needs
// that many bytes contiguous, and once WiFi is up the largest free block is far
// smaller than the free heap.
class FileReader {
public:
public:
virtual ~FileReader() = default;
// Bytes read, zero at end of file, negative on failure.
virtual int32_t read(char* out, int32_t maxBytes) = 0;
};
class FsProvider {
public:
public:
virtual ~FsProvider() = default;
// Null when the path is missing or is a directory. The caller owns the reader.
// Null when the path is missing or is a directory. The caller owns the
// reader.
virtual FileReader* openRead(const std::string& path) = 0;
virtual bool exists(const std::string& path) const = 0;
virtual Status fileSize(const std::string& path, int32_t& size) const = 0;
virtual Status listDirs(const std::string& path, std::vector<std::string>& names) const = 0;
virtual Status listFiles(const std::string& path, std::vector<std::string>& names) const = 0;
virtual Status listDirs(const std::string& path,
std::vector<std::string>& names) const = 0;
virtual Status listFiles(const std::string& path,
std::vector<std::string>& names) const = 0;
virtual Status mkdir(const std::string& path) = 0;
virtual Status readFile(const std::string& path, int32_t maxBytes, std::string& content) const = 0;
// A line past the end reports ok with `found` false, which the binding returns as a bare nil.
virtual Status readLineAt(const std::string& path, int32_t offset, int32_t maxBytes, bool& found,
std::string& line, int32_t& nextOffset) const = 0;
virtual Status readFile(const std::string& path, int32_t maxBytes,
std::string& content) const = 0;
// A line past the end reports ok with `found` false, which the binding
// returns as a bare nil.
virtual Status readLineAt(const std::string& path, int32_t offset,
int32_t maxBytes, bool& found, std::string& line,
int32_t& nextOffset) const = 0;
virtual Status remove(const std::string& path) = 0;
virtual Status removeTree(const std::string& path) = 0;
virtual Status rename(const std::string& source, const std::string& destination) = 0;
virtual Status writeFile(const std::string& path, const std::string& content) = 0;
virtual Status rename(const std::string& source,
const std::string& destination) = 0;
virtual Status writeFile(const std::string& path,
const std::string& content) = 0;
};
// Native identifiers the firmware assigns to the portable font roles and text styles.
// Native identifiers the firmware assigns to the portable font roles and text
// styles.
struct FontIds {
int32_t small;
int32_t ui;
@@ -93,7 +105,7 @@ struct FontIds {
};
class GuiProvider {
public:
public:
virtual ~GuiProvider() = default;
virtual FontIds fonts() const = 0;
virtual int32_t width() const = 0;
@@ -102,31 +114,44 @@ class GuiProvider {
virtual void setRotation(int32_t degrees) = 0;
virtual int32_t color(int32_t r, int32_t g, int32_t b) const = 0;
virtual void clear(int32_t color) = 0;
virtual void fillRect(int32_t x, int32_t y, int32_t w, int32_t h, int32_t color) = 0;
virtual void drawRect(int32_t x, int32_t y, int32_t w, int32_t h, int32_t color) = 0;
virtual void drawLine(int32_t x1, int32_t y1, int32_t x2, int32_t y2, int32_t color, int32_t width) = 0;
virtual void fillRect(int32_t x, int32_t y, int32_t w, int32_t h,
int32_t color) = 0;
virtual void drawRect(int32_t x, int32_t y, int32_t w, int32_t h,
int32_t color) = 0;
virtual void drawLine(int32_t x1, int32_t y1, int32_t x2, int32_t y2,
int32_t color, int32_t width) = 0;
virtual void drawPixel(int32_t x, int32_t y, int32_t color) = 0;
virtual void drawCircle(int32_t x, int32_t y, int32_t radius, int32_t color, int32_t width) = 0;
virtual void fillCircle(int32_t x, int32_t y, int32_t radius, int32_t color, const int32_t* background) = 0;
// Fill, gradient, and border come from one distance field, so they cannot disagree at the
// corners. A null top paints no fill, a null border paints no outline, and a panel with no
// gradient of its own is free to ignore `bottom` the way color() quantizes to grayscale.
virtual void roundRect(int32_t x, int32_t y, int32_t w, int32_t h, int32_t radius, int32_t background,
const int32_t* top, const int32_t* bottom, const int32_t* border) = 0;
// Hands the app the whole panel, including whatever chrome the firmware paints.
virtual void drawCircle(int32_t x, int32_t y, int32_t radius, int32_t color,
int32_t width) = 0;
virtual void fillCircle(int32_t x, int32_t y, int32_t radius, int32_t color,
const int32_t* background) = 0;
// Fill, gradient, and border come from one distance field, so they cannot
// disagree at the corners. A null top paints no fill, a null border paints no
// outline, and a panel with no gradient of its own is free to ignore `bottom`
// the way color() quantizes to grayscale.
virtual void roundRect(int32_t x, int32_t y, int32_t w, int32_t h,
int32_t radius, int32_t background, const int32_t* top,
const int32_t* bottom, const int32_t* border) = 0;
// Hands the app the whole panel, including whatever chrome the firmware
// paints.
virtual void setFullscreen(bool on) = 0;
// Applies everything drawn since the last commit. The runtime supplies only the timing -- the
// end of a callback batch -- because that is the one fact a driver cannot know; which region to
// touch, which waveform, and whether to clean up ghosting all stay here. A live LCD has nothing
// pending and does nothing.
// Applies everything drawn since the last commit. The runtime supplies only
// the timing -- the end of a callback batch -- because that is the one fact a
// driver cannot know; which region to touch, which waveform, and whether to
// clean up ghosting all stay here. A live LCD has nothing pending and does
// nothing.
virtual void commit() = 0;
virtual void fillPolygon(const int32_t* xs, const int32_t* ys, size_t count, int32_t color) = 0;
virtual void fillPolygon(const int32_t* xs, const int32_t* ys, size_t count,
int32_t color) = 0;
// Null coordinates centre the image; null bounds fall back to the panel size.
virtual Status drawBmp(const std::string& path, const int32_t* x, const int32_t* y, const int32_t* maxWidth,
virtual Status drawBmp(const std::string& path, const int32_t* x,
const int32_t* y, const int32_t* maxWidth,
const int32_t* maxHeight) = 0;
virtual int32_t textWidth(int32_t font, const std::string& text, int32_t style) const = 0;
virtual int32_t textWidth(int32_t font, const std::string& text,
int32_t style) const = 0;
virtual int32_t fontHeight(int32_t font, int32_t style) const = 0;
virtual void drawText(int32_t font, int32_t x, int32_t y, const std::string& text, int32_t color, int32_t style,
virtual void drawText(int32_t font, int32_t x, int32_t y,
const std::string& text, int32_t color, int32_t style,
const int32_t* background) = 0;
};
@@ -142,25 +167,29 @@ struct HttpResponse {
struct HttpDownload {
int32_t maxBytes;
int32_t expectedSize; // Zero when the caller did not declare one.
std::string sha256; // Empty when the caller did not declare one.
int32_t expectedSize; // Zero when the caller did not declare one.
std::string sha256; // Empty when the caller did not declare one.
};
class HttpProvider {
public:
public:
virtual ~HttpProvider() = default;
virtual Status request(const std::string& method, const std::string& url, const std::string& body,
const std::vector<HttpHeader>& headers, int32_t maxBytes, HttpResponse& response) = 0;
virtual Status download(const std::string& url, const std::string& destination, const HttpDownload& options,
virtual Status request(const std::string& method, const std::string& url,
const std::string& body,
const std::vector<HttpHeader>& headers,
int32_t maxBytes, HttpResponse& response) = 0;
virtual Status download(const std::string& url,
const std::string& destination,
const HttpDownload& options,
int32_t& bytesWritten) = 0;
};
using TimerId = int32_t;
// The firmware schedules deadlines and calls Runtime::callTimer() on the Lua thread; the
// runtime owns the identifiers and the retained callbacks.
// The firmware schedules deadlines and calls Runtime::callTimer() on the Lua
// thread; the runtime owns the identifiers and the retained callbacks.
class TimerProvider {
public:
public:
virtual ~TimerProvider() = default;
virtual Status schedule(TimerId id, int32_t intervalMs, bool repeating) = 0;
virtual void cancel(TimerId id) = 0;
@@ -173,18 +202,19 @@ struct WifiNetwork {
};
struct WifiStatus {
std::string state; // One of the WifiState alias values.
std::string state; // One of the WifiState alias values.
std::string ssid;
std::string ip;
int32_t rssi;
};
class WifiProvider {
public:
public:
virtual ~WifiProvider() = default;
virtual Status scan(std::vector<WifiNetwork>& networks) = 0;
// Null credentials reconnect whatever the firmware has saved.
virtual Status connect(const std::string* ssid, const std::string* password) = 0;
virtual Status connect(const std::string* ssid,
const std::string* password) = 0;
virtual WifiStatus status() const = 0;
virtual void disconnect() = 0;
virtual Status forget() = 0;
@@ -197,7 +227,7 @@ struct BleDevice {
};
class BleProvider {
public:
public:
virtual ~BleProvider() = default;
virtual Status init(const std::string* name) = 0;
virtual void deinit() = 0;
@@ -205,8 +235,12 @@ class BleProvider {
virtual Status connect(const std::string& address) = 0;
virtual void disconnect() = 0;
virtual bool isConnected() const = 0;
virtual Status read(const std::string& service, const std::string& characteristic, std::string& value) = 0;
virtual Status write(const std::string& service, const std::string& characteristic, const std::string& value) = 0;
virtual Status read(const std::string& service,
const std::string& characteristic,
std::string& value) = 0;
virtual Status write(const std::string& service,
const std::string& characteristic,
const std::string& value) = 0;
virtual Status startAdvertising(const std::string* name) = 0;
virtual void stopAdvertising() = 0;
};
@@ -214,19 +248,21 @@ class BleProvider {
enum class TouchPhase { Down, Move, Up };
class TouchProvider {
public:
public:
virtual ~TouchProvider() = default;
virtual bool touch(int32_t& x, int32_t& y) const = 0;
virtual bool rawTouch(int32_t& x, int32_t& y) const = 0;
virtual bool isTouched() const = 0;
virtual Status setCalibration(int32_t x0, int32_t y0, int32_t x1, int32_t y1) = 0;
virtual Status setCalibration(int32_t x0, int32_t y0, int32_t x1,
int32_t y1) = 0;
};
class ButtonsProvider {
public:
public:
virtual ~ButtonsProvider() = default;
// The roles this device maps physical buttons onto, drawn from the Button union. Hardware
// variety lives in the mapping; the vocabulary stays closed so an app stays portable.
// The roles this device maps physical buttons onto, drawn from the Button
// union. Hardware variety lives in the mapping; the vocabulary stays closed
// so an app stays portable.
virtual std::vector<std::string> buttons() const = 0;
virtual bool isAnyPressed() const = 0;
virtual bool isPressed(const std::string& button) const = 0;
@@ -234,4 +270,4 @@ class ButtonsProvider {
virtual bool wasReleased(const std::string& button) const = 0;
};
} // namespace esp32lua
} // namespace esp32lua