(Simple String Format) is an syntax of format and a library for parse this.
SSFMT is NOT an API/library for parse {fmt} syntax !
The syntax of SSFMT is very simple, its use braces { } for "declare" a format, and an identifier inside the braces block for identifie the format.
Example: {name} (is a format with "name" like indentifier)
You can escape braces with backslash
\for do not consider the followed braces like an format but like a braces.
Example:
\{name\}(Here, "name" will not be interpreted like as format)
An identifier have a limit of 255 charaters. If an identifer length greater than this limit, only the first 255 chararacters are compared.
A identifier can be represented with any of ascii table characters, but its better to use only alphabet [a-z]+upper/lower, digits [0-9]+ and underscore _.
git clone https://github.com/ownesis/ssfmt.git
cd ssfmt/
mkdir build && cd build/
cmake .. && make
as root
make install
This copies:
- Header file
ssfmt.hinside/usr/local/include.
- Shared object library
libssfmt.soinside/usr/local/lib. - Static object library
libssfmt.ainside/usr/local/lib.
as root
ldconfig /usr/local/lib
This adding
/usr/local/libto dynamic library path.
To change a format with its value, you must specify a "dictionnary" with identifier/value correspondence.
The "dictionnary" is a structure with two char * fields (for the identifier and its value).
struct SSFMTDict {
char *identifier;
char *value;
};Now, you need to specify the "dictionnary" array in the context structure: ssfmt_ctx_t (struct SSFMT_ctx).
struct SSFMT_ctx {
struct SSFMTDict *array;
size_t array_len;
_Bool case_sensitibe;
};This context structure take 3 fields:
array: (struct SSFMTDict *), This pointer take the array address of SSFMTDict structure.array_len: (size_t), This object take the array length.case_sensitive: (_Bool), If set to1the identifer will become case sensitive; If set to0the identifer will become not case sensitive.
The library propose a macro function for init a context:
#define SSFMT_INIT(a, l, c) \
{ .array = (a), .array_len = (l), .case_sensitve = (c) }Example of use:
ssfm_ctx_t ctx = SSFMT_INIT(the_dict_array, 5, 0);For parsing and get a string with the identifier replaced with its value, you must to call a function for do this.
char *ssfmt_parser(const ssfmt_ctx_t *ctx, const char *format, char *buf, size_t buf_len);This function take 4 arguments:
ctx: (const ssfmt_ctx_t *), is an input argument, it's the address of the initializedstruct SSFMT_ctx.format: (const char *), is an input argument, is a null terminated string with formats to replace.buf: (char *buf), is an output argument, it takes a buffer which will store the result of the formatted character stringformat.buf_len: (size_t): is an input argument, it's the size of the bufferbuf.
The return value is the address of buf or NULL if an error occured.
if a format is used with a unknown identifier (a identifer not in dictionnary array), it's just been ignored and will be removed of the result string.
If the length result formatted string is greater than buf_size, the buf will have the result of the formats that have been formatted and a finished with a null byte '\0'.
#include <stdio.h>
#include <ssfmt.h>
#define ARRAY_SIZE 4
#define BUF_SIZE 1024
#define FORMAT "{lastname} {firstname}:\n - Planet: {planet} ({dimension})"
int main(void) {
char buf[BUF_SIZE] = {0};
struct SSFMTDict array[ARRAY_SIZE] = {
[0] = {
.identifier = "firstname",
.value = "Rick"
},
[1] = {
.identifier = "lastname",
.value = "Sanchez"
},
[2] = {
.identifier = "dimension",
.value = "C-137"
},
[3] = {
.identifier = "planet",
.value = "Earth"
}
};
ssfmt_ctx_t ctx = SSFMT_INIT(array, ARRAY_SIZE, 1);
ssfmt_parser(&ctx, FORMAT, buf, BUF_SIZE);
puts(buf);
return 0;
}gcc -o example example_code.c -I/usr/local/include/ -L/usr/local/lib -lssfmt