unleashed-firmware/lib/flipper_format/flipper_format_stream.h
hedger 4d6b170769
[FL-2520] FW build with -Wextra (#1185)
* Fixing compiler warnings with -Wextra
* More warnings suppression, WIP
* Even more warning fixes
* Added new lines at end of text files.
* Padding fix
* Additional fixes to warnings on different build configurations; added -Wextra to default build pipeline
* Fixes for Secplus v1
* -additional warnings
* +-Wredundant-decls fixes
* FuriHal: print stack overflow task name in console
* FuriHal: add missing include

Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
2022-05-06 16:37:10 +03:00

95 lines
1.9 KiB
C

#pragma once
#include <stdlib.h>
#include <stdbool.h>
#include <toolbox/stream/stream.h>
#include <mlib/m-string.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef enum {
FlipperStreamValueIgnore,
FlipperStreamValueStr,
FlipperStreamValueHex,
FlipperStreamValueFloat,
FlipperStreamValueInt32,
FlipperStreamValueUint32,
FlipperStreamValueBool,
} FlipperStreamValue;
typedef struct {
const char* key;
FlipperStreamValue type;
const void* data;
size_t data_size;
} FlipperStreamWriteData;
/**
* Writes a key/value pair to the stream.
* @param stream
* @param write_data
* @return true
* @return false
*/
bool flipper_format_stream_write_value_line(Stream* stream, FlipperStreamWriteData* write_data);
/**
* Reads a value by key from a stream.
* @param stream
* @param key
* @param type
* @param _data
* @param data_size
* @param strict_mode
* @return true
* @return false
*/
bool flipper_format_stream_read_value_line(
Stream* stream,
const char* key,
FlipperStreamValue type,
void* _data,
size_t data_size,
bool strict_mode);
/**
* Get the count of values by key from a stream.
* @param stream
* @param key
* @param count
* @param strict_mode
* @return true
* @return false
*/
bool flipper_format_stream_get_value_count(
Stream* stream,
const char* key,
uint32_t* count,
bool strict_mode);
/**
* Removes a key and the corresponding value string from the stream and inserts a new key/value pair.
* @param stream
* @param write_data
* @param strict_mode
* @return true
* @return false
*/
bool flipper_format_stream_delete_key_and_write(
Stream* stream,
FlipperStreamWriteData* write_data,
bool strict_mode);
/**
* Writes a comment string to the stream.
* @param stream
* @param data
* @return true
* @return false
*/
bool flipper_format_stream_write_comment_cstr(Stream* stream, const char* data);
#ifdef __cplusplus
}
#endif