unleashed-firmware/lib/toolbox/stream/stream_i.h
SG 274c12fc56
[FL-2274] Inventing streams and moving FFF to them (#981)
* Streams: string stream
* String stream: updated insert/delete api
* Streams: generic stream interface and string stream implementation
* Streams: helpers for insert and delete_and_insert
* FFF: now compatible with streams
* MinUnit: introduced tests with arguments
* FFF: stream access violation
* Streams: copy data between streams
* Streams: file stream
* FFF: documentation
* FFStream: documentation
* FFF: alloc as file
* MinUnit: support for nested tests
* Streams: changed delete_and_insert, now it returns success flag. Added ability dump stream inner parameters and data to cout.
* FFF: simplified file open function
* Streams: unit tests
* FFF: tests
* Streams: declare cache_size constant as define, to allow variable modified arrays
* FFF: lib moved to a separate folder
* iButton: new FFF
* RFID: new FFF
* Animations: new FFF
* IR: new FFF
* NFC: new FFF
* Flipper file format: delete lib
* U2F: new FFF
* Subghz: new FFF and streams
* Streams: read line
* Streams: split
* FuriCore: implement memset with extra asserts
* FuriCore: implement extra heap asserts without inventing memset
* Scene manager: protected access to the scene id stack with a size check
* NFC worker: dirty fix for issue where hal_nfc was busy on app start
* Furi: update allocator to erase memory on allocation. Replace furi_alloc with malloc.
* FuriCore: cleanup memmgr code.
* Furi HAL: furi_hal_init is split into critical and non-critical parts. The critical part is currently clock and console.
* Memmgr: added ability to track allocations and deallocations through console.
* FFStream: some speedup
* Streams, FF: minor fixes
* Tests: restore
* File stream: a slightly more thread-safe version of file_stream_delete_and_insert

Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
2022-02-18 22:53:46 +03:00

46 lines
1.2 KiB
C

#pragma once
#include <stdint.h>
#include <stdbool.h>
#include "stream.h"
#ifdef __cplusplus
extern "C" {
#endif
#define STREAM_CACHE_SIZE 512
typedef struct StreamVTable StreamVTable;
typedef void (*StreamFreeFn)(Stream* stream);
typedef bool (*StreamEOFFn)(Stream* stream);
typedef void (*StreamCleanFn)(Stream* stream);
typedef bool (*StreamSeekFn)(Stream* stream, int32_t offset, StreamOffset offset_type);
typedef size_t (*StreamTellFn)(Stream* stream);
typedef size_t (*StreamSizeFn)(Stream* stream);
typedef size_t (*StreamWriteFn)(Stream* stream, const uint8_t* data, size_t size);
typedef size_t (*StreamReadFn)(Stream* stream, uint8_t* data, size_t count);
typedef bool (*StreamDeleteAndInsertFn)(
Stream* stream,
size_t delete_size,
StreamWriteCB write_cb,
const void* ctx);
struct StreamVTable {
const StreamFreeFn free;
const StreamEOFFn eof;
const StreamCleanFn clean;
const StreamSeekFn seek;
const StreamTellFn tell;
const StreamSizeFn size;
const StreamWriteFn write;
const StreamReadFn read;
const StreamDeleteAndInsertFn delete_and_insert;
};
struct Stream {
const StreamVTable* vtable;
};
#ifdef __cplusplus
}
#endif