[FL-1371] New LF-RFID app. Second encounter. (#547)
* File worker: file operations helper. * Notification app: removed yield * File worker: write operations, calls to system file widgets * App ibutton: use file worker * Lfrfid: generic key loading, add path helper and hex conversion to lib * FileWorker: plain C verison * FileWorker: add to lib.mk * FileWorker: add to C sources, instead of CPP * Lfrfid: save scene * App lfrfid: add key scene, saved key menu * App lfrfid: saved key info scene * App lfrfid: delete key scene
This commit is contained in:
SG
GitHub
@@ -1,151 +1,170 @@
|
||||
#pragma once
|
||||
#include "record-controller.hpp"
|
||||
#include <sd-card-api.h>
|
||||
#include <filesystem-api.h>
|
||||
#include <m-string.h>
|
||||
#include <filesystem-api.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief File operations helper class.
|
||||
* Automatically opens API records, shows error message on error.
|
||||
*/
|
||||
class FileWorker {
|
||||
public:
|
||||
FileWorker(bool silent = false);
|
||||
~FileWorker();
|
||||
typedef struct FileWorker FileWorker;
|
||||
|
||||
RecordController<FS_Api> fs_api;
|
||||
RecordController<SdCard_Api> sd_ex_api;
|
||||
/**
|
||||
* @brief Allocate FileWorker
|
||||
*
|
||||
* @param silent do not show errors except from file_worker_show_error fn
|
||||
* @return FileWorker*
|
||||
*/
|
||||
FileWorker* file_worker_alloc(bool silent);
|
||||
|
||||
/**
|
||||
* @brief Open file
|
||||
*
|
||||
* @param filename
|
||||
* @param access_mode
|
||||
* @param open_mode
|
||||
* @return true on success
|
||||
*/
|
||||
bool open(const char* filename, FS_AccessMode access_mode, FS_OpenMode open_mode);
|
||||
/**
|
||||
* @brief free FileWorker
|
||||
*
|
||||
* @param file_worker
|
||||
*/
|
||||
void file_worker_free(FileWorker* file_worker);
|
||||
|
||||
/**
|
||||
* @brief Close file
|
||||
*
|
||||
* @return true on success
|
||||
*/
|
||||
bool close();
|
||||
/**
|
||||
* @brief Open file
|
||||
*
|
||||
* @param file_worker FileWorker instance
|
||||
* @param filename
|
||||
* @param access_mode
|
||||
* @param open_mode
|
||||
* @return true on success
|
||||
*/
|
||||
bool file_worker_open(
|
||||
FileWorker* file_worker,
|
||||
const char* filename,
|
||||
FS_AccessMode access_mode,
|
||||
FS_OpenMode open_mode);
|
||||
|
||||
/**
|
||||
* @brief Creates a directory. Doesn't show error if directory exist.
|
||||
*
|
||||
* @param dirname
|
||||
* @return true on success
|
||||
*/
|
||||
bool mkdir(const char* dirname);
|
||||
/**
|
||||
* @brief Close file
|
||||
*
|
||||
* @param file_worker FileWorker instance
|
||||
* @return true on success
|
||||
*/
|
||||
bool file_worker_close(FileWorker* file_worker);
|
||||
|
||||
/**
|
||||
* @brief Removes the file. Doesn't show error if file doesn't exist.
|
||||
*
|
||||
* @param filename
|
||||
* @return true on success
|
||||
*/
|
||||
bool remove(const char* filename);
|
||||
/**
|
||||
* @brief Creates a directory. Doesn't show error if directory exist.
|
||||
*
|
||||
* @param file_worker FileWorker instance
|
||||
* @param dirname
|
||||
* @return true on success
|
||||
*/
|
||||
bool file_worker_mkdir(FileWorker* file_worker, const char* dirname);
|
||||
|
||||
/**
|
||||
* @brief Reads data from a file.
|
||||
*
|
||||
* @param buffer
|
||||
* @param bytes_to_read
|
||||
* @return true on success
|
||||
*/
|
||||
bool read(void* buffer, uint16_t bytes_to_read = 1);
|
||||
/**
|
||||
* @brief Removes the file. Doesn't show error if file doesn't exist.
|
||||
*
|
||||
* @param file_worker FileWorker instance
|
||||
* @param filename
|
||||
* @return true on success
|
||||
*/
|
||||
bool file_worker_remove(FileWorker* file_worker, const char* filename);
|
||||
|
||||
/**
|
||||
* @brief Reads data from a file until separator or EOF is found.
|
||||
* Moves seek pointer to the next symbol after the separator. The separator is not included in the result.
|
||||
*
|
||||
* @param result
|
||||
* @param separator
|
||||
* @return true on success
|
||||
*/
|
||||
bool read_until(string_t result, char separator = '\n');
|
||||
/**
|
||||
* @brief Reads data from a file.
|
||||
*
|
||||
* @param file_worker FileWorker instance
|
||||
* @param buffer
|
||||
* @param bytes_to_read
|
||||
* @return true on success
|
||||
*/
|
||||
bool file_worker_read(FileWorker* file_worker, void* buffer, uint16_t bytes_to_read);
|
||||
|
||||
/**
|
||||
* @brief Reads data in hexadecimal space-delimited format. For example "AF FF" in a file - [175, 255] in a read buffer.
|
||||
*
|
||||
* @param buffer
|
||||
* @param bytes_to_read
|
||||
* @return true on success
|
||||
*/
|
||||
bool read_hex(uint8_t* buffer, uint16_t bytes_to_read = 1);
|
||||
/**
|
||||
* @brief Reads data from a file until separator or EOF is found.
|
||||
* Moves seek pointer to the next symbol after the separator. The separator is not included in the result.
|
||||
*
|
||||
* @param file_worker FileWorker instance
|
||||
* @param result
|
||||
* @param separator
|
||||
* @return true on success
|
||||
*/
|
||||
bool file_worker_read_until(FileWorker* file_worker, string_t result, char separator);
|
||||
|
||||
/**
|
||||
* @brief Read seek pointer value
|
||||
*
|
||||
* @param position
|
||||
* @return true on success
|
||||
*/
|
||||
bool tell(uint64_t* position);
|
||||
/**
|
||||
* @brief Reads data in hexadecimal space-delimited format. For example "AF FF" in a file - [175, 255] in a read buffer.
|
||||
*
|
||||
* @param file_worker FileWorker instance
|
||||
* @param buffer
|
||||
* @param bytes_to_read
|
||||
* @return true on success
|
||||
*/
|
||||
bool file_worker_read_hex(FileWorker* file_worker, uint8_t* buffer, uint16_t bytes_to_read);
|
||||
|
||||
/**
|
||||
* @brief Set seek pointer value
|
||||
*
|
||||
* @param position
|
||||
* @param from_start
|
||||
* @return true on success
|
||||
*/
|
||||
bool seek(uint64_t position, bool from_start);
|
||||
/**
|
||||
* @brief Read seek pointer value
|
||||
*
|
||||
* @param file_worker FileWorker instance
|
||||
* @param position
|
||||
* @return true on success
|
||||
*/
|
||||
bool file_worker_tell(FileWorker* file_worker, uint64_t* position);
|
||||
|
||||
/**
|
||||
* @brief Write data to file.
|
||||
*
|
||||
* @param buffer
|
||||
* @param bytes_to_write
|
||||
* @return true on success
|
||||
*/
|
||||
bool write(const void* buffer, uint16_t bytes_to_write = 1);
|
||||
/**
|
||||
* @brief Set seek pointer value
|
||||
*
|
||||
* @param file_worker FileWorker instance
|
||||
* @param position
|
||||
* @param from_start
|
||||
* @return true on success
|
||||
*/
|
||||
bool file_worker_seek(FileWorker* file_worker, uint64_t position, bool from_start);
|
||||
|
||||
/**
|
||||
* @brief Write data to file in hexadecimal space-delimited format. For example [175, 255] in a write buffer - "AF FF" in a file.
|
||||
*
|
||||
* @param buffer
|
||||
* @param bytes_to_write
|
||||
* @return true on success
|
||||
*/
|
||||
bool write_hex(const uint8_t* buffer, uint16_t bytes_to_write = 1);
|
||||
/**
|
||||
* @brief Write data to file.
|
||||
*
|
||||
* @param file_worker FileWorker instance
|
||||
* @param buffer
|
||||
* @param bytes_to_write
|
||||
* @return true on success
|
||||
*/
|
||||
bool file_worker_write(FileWorker* file_worker, const void* buffer, uint16_t bytes_to_write);
|
||||
|
||||
/**
|
||||
* @brief Show system file error message
|
||||
*
|
||||
* @param error_text
|
||||
*/
|
||||
void show_error(const char* error_text);
|
||||
/**
|
||||
* @brief Write data to file in hexadecimal space-delimited format. For example [175, 255] in a write buffer - "AF FF" in a file.
|
||||
*
|
||||
* @param file_worker FileWorker instance
|
||||
* @param buffer
|
||||
* @param bytes_to_write
|
||||
* @return true on success
|
||||
*/
|
||||
bool file_worker_write_hex(FileWorker* file_worker, const uint8_t* buffer, uint16_t bytes_to_write);
|
||||
|
||||
/**
|
||||
* @brief Show system file select widget
|
||||
*
|
||||
* @param path
|
||||
* @param extension
|
||||
* @param result
|
||||
* @param result_size
|
||||
* @param selected_filename
|
||||
* @return true if file was selected
|
||||
*/
|
||||
bool file_select(
|
||||
const char* path,
|
||||
const char* extension,
|
||||
char* result,
|
||||
uint8_t result_size,
|
||||
char* selected_filename);
|
||||
/**
|
||||
* @brief Show system file error message
|
||||
*
|
||||
* @param file_worker FileWorker instance
|
||||
* @param error_text
|
||||
*/
|
||||
void file_worker_show_error(FileWorker* file_worker, const char* error_text);
|
||||
|
||||
private:
|
||||
File file;
|
||||
bool silent;
|
||||
/**
|
||||
* @brief Show system file select widget
|
||||
*
|
||||
* @param file_worker FileWorker instance
|
||||
* @param path
|
||||
* @param extension
|
||||
* @param result
|
||||
* @param result_size
|
||||
* @param selected_filename
|
||||
* @return true if file was selected
|
||||
*/
|
||||
bool file_worker_file_select(
|
||||
FileWorker* file_worker,
|
||||
const char* path,
|
||||
const char* extension,
|
||||
char* result,
|
||||
uint8_t result_size,
|
||||
char* selected_filename);
|
||||
|
||||
bool check_common_errors();
|
||||
|
||||
void show_error_internal(const char* error_text);
|
||||
|
||||
bool read_internal(void* buffer, uint16_t bytes_to_read = 1);
|
||||
bool write_internal(const void* buffer, uint16_t bytes_to_write = 1);
|
||||
bool tell_internal(uint64_t* position);
|
||||
bool seek_internal(uint64_t position, bool from_start);
|
||||
};
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
Reference in New Issue
Block a user