debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-21 18:38:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
notmuch/sprinter-text.c

159 lines
3.2 KiB
C
Raw Normal View History

sprinter: change integer method to use int64_t In particular, timestamps beyond 2038 could overflow the sprinter interface on systems where time_t is 64-bit but 'int' is a signed 32-bit integer type.
2020-02-08 02:49:22 +01:00
#include <inttypes.h>
Add structured output formatter for JSON and plain text (but don't use them yet). Using the new structured printer support in sprinter.h, implement sprinter_json_create, which returns a new JSON structured output formatter. The formatter prints output similar to the existing JSON, but with differences in whitespace (mostly newlines, --output=summary prints the entire message summary on one line, not split across multiple lines). Also implement a "structured" formatter for plain text that prints prefixed strings, to be used with notmuch-search.c plain text output.
2012-07-23 12:39:45 +02:00
#include <stdbool.h>
#include <stdio.h>
#include <talloc.h>
#include "sprinter.h"
/* "Structured printer" interface for unstructured text printing.
* Note that --output=summary is dispatched and formatted in
* notmuch-search.c, the code in this file is only used for all other
* output types.
*/
struct sprinter_text {
struct sprinter vtable;
FILE *stream;
/* The current prefix to be printed with string/integer/boolean
* data.
*/
const char *current_prefix;
/* A flag to indicate if this is the first tag. Used in list of tags
* for summary.
*/
cli: convert notmuch_bool_t to stdbool C99 stdbool turned 18 this year. There really is no reason to use our own, except in the library interface for backward compatibility. Convert the cli and test binaries to stdbool.
2017-10-07 10:44:04 +02:00
bool first_tag;
Add structured output formatter for JSON and plain text (but don't use them yet). Using the new structured printer support in sprinter.h, implement sprinter_json_create, which returns a new JSON structured output formatter. The formatter prints output similar to the existing JSON, but with differences in whitespace (mostly newlines, --output=summary prints the entire message summary on one line, not split across multiple lines). Also implement a "structured" formatter for plain text that prints prefixed strings, to be used with notmuch-search.c plain text output.
2012-07-23 12:39:45 +02:00
};
static void
sprinter: Add a string_len method This method allows callers to output strings with specific lengths. It's useful both for strings with embedded NULs (which JSON can represent, though parser support is apparently spotty), and non-terminated strings.
2012-08-03 03:14:49 +02:00
text_string_len (struct sprinter *sp, const char *val, size_t len)
Add structured output formatter for JSON and plain text (but don't use them yet). Using the new structured printer support in sprinter.h, implement sprinter_json_create, which returns a new JSON structured output formatter. The formatter prints output similar to the existing JSON, but with differences in whitespace (mostly newlines, --output=summary prints the entire message summary on one line, not split across multiple lines). Also implement a "structured" formatter for plain text that prints prefixed strings, to be used with notmuch-search.c plain text output.
2012-07-23 12:39:45 +02:00
{
struct sprinter_text *sptxt = (struct sprinter_text *) sp;
if (sptxt->current_prefix != NULL)
fprintf (sptxt->stream, "%s:", sptxt->current_prefix);
sprinter: Add a string_len method This method allows callers to output strings with specific lengths. It's useful both for strings with embedded NULs (which JSON can represent, though parser support is apparently spotty), and non-terminated strings.
2012-08-03 03:14:49 +02:00
fwrite (val, len, 1, sptxt->stream);
}
static void
text_string (struct sprinter *sp, const char *val)
{
sprinters: bugfix when NULL passed for a string. The string function in a sprinter may be called with a NULL string pointer (eg if a header is absent). This causes a segfault. We fix this by checking for a null pointer in the string functions and update the sprinter documentation. At the moment some output when format=text is done directly rather than via an sprinter: in that case a null pointer is passed to printf or similar and a "(null)" appears in the output. That behaviour is not changed in this patch.
2012-08-08 23:23:33 +02:00
if (val == NULL)
val = "";
sprinter: Add a string_len method This method allows callers to output strings with specific lengths. It's useful both for strings with embedded NULs (which JSON can represent, though parser support is apparently spotty), and non-terminated strings.
2012-08-03 03:14:49 +02:00
text_string_len (sp, val, strlen (val));
Add structured output formatter for JSON and plain text (but don't use them yet). Using the new structured printer support in sprinter.h, implement sprinter_json_create, which returns a new JSON structured output formatter. The formatter prints output similar to the existing JSON, but with differences in whitespace (mostly newlines, --output=summary prints the entire message summary on one line, not split across multiple lines). Also implement a "structured" formatter for plain text that prints prefixed strings, to be used with notmuch-search.c plain text output.
2012-07-23 12:39:45 +02:00
}
static void
sprinter: change integer method to use int64_t In particular, timestamps beyond 2038 could overflow the sprinter interface on systems where time_t is 64-bit but 'int' is a signed 32-bit integer type.
2020-02-08 02:49:22 +01:00
text_integer (struct sprinter *sp, int64_t val)
Add structured output formatter for JSON and plain text (but don't use them yet). Using the new structured printer support in sprinter.h, implement sprinter_json_create, which returns a new JSON structured output formatter. The formatter prints output similar to the existing JSON, but with differences in whitespace (mostly newlines, --output=summary prints the entire message summary on one line, not split across multiple lines). Also implement a "structured" formatter for plain text that prints prefixed strings, to be used with notmuch-search.c plain text output.
2012-07-23 12:39:45 +02:00
{
struct sprinter_text *sptxt = (struct sprinter_text *) sp;
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory Line breaks were then adjusted manually to keep argc and argv together.
2021-03-13 13:45:34 +01:00
fprintf (sptxt->stream, "%" PRId64, val);
Add structured output formatter for JSON and plain text (but don't use them yet). Using the new structured printer support in sprinter.h, implement sprinter_json_create, which returns a new JSON structured output formatter. The formatter prints output similar to the existing JSON, but with differences in whitespace (mostly newlines, --output=summary prints the entire message summary on one line, not split across multiple lines). Also implement a "structured" formatter for plain text that prints prefixed strings, to be used with notmuch-search.c plain text output.
2012-07-23 12:39:45 +02:00
}
static void
cli: convert notmuch_bool_t to stdbool C99 stdbool turned 18 this year. There really is no reason to use our own, except in the library interface for backward compatibility. Convert the cli and test binaries to stdbool.
2017-10-07 10:44:04 +02:00
text_boolean (struct sprinter *sp, bool val)
Add structured output formatter for JSON and plain text (but don't use them yet). Using the new structured printer support in sprinter.h, implement sprinter_json_create, which returns a new JSON structured output formatter. The formatter prints output similar to the existing JSON, but with differences in whitespace (mostly newlines, --output=summary prints the entire message summary on one line, not split across multiple lines). Also implement a "structured" formatter for plain text that prints prefixed strings, to be used with notmuch-search.c plain text output.
2012-07-23 12:39:45 +02:00
{
struct sprinter_text *sptxt = (struct sprinter_text *) sp;
fputs (val ? "true" : "false", sptxt->stream);
}
static void
text_separator (struct sprinter *sp)
{
struct sprinter_text *sptxt = (struct sprinter_text *) sp;
fputc ('\n', sptxt->stream);
}
sprinter: add text0 formatter for null character separated text Same as the text formatter, but with each field separated by a null character rather than a newline character.
2012-12-16 23:05:10 +01:00
static void
text0_separator (struct sprinter *sp)
{
struct sprinter_text *sptxt = (struct sprinter_text *) sp;
fputc ('\0', sptxt->stream);
}
Add structured output formatter for JSON and plain text (but don't use them yet). Using the new structured printer support in sprinter.h, implement sprinter_json_create, which returns a new JSON structured output formatter. The formatter prints output similar to the existing JSON, but with differences in whitespace (mostly newlines, --output=summary prints the entire message summary on one line, not split across multiple lines). Also implement a "structured" formatter for plain text that prints prefixed strings, to be used with notmuch-search.c plain text output.
2012-07-23 12:39:45 +02:00
static void
text_set_prefix (struct sprinter *sp, const char *prefix)
{
struct sprinter_text *sptxt = (struct sprinter_text *) sp;
sptxt->current_prefix = prefix;
}
/* The structure functions begin_map, begin_list, end and map_key
* don't do anything in the text formatter.
*/
static void
text_begin_map (unused (struct sprinter *sp))
{
}
static void
text_begin_list (unused (struct sprinter *sp))
{
}
static void
text_end (unused (struct sprinter *sp))
{
}
static void
text_null (unused (struct sprinter *sp))
{
}
static void
text_map_key (unused (struct sprinter *sp), unused (const char *key))
{
}
struct sprinter *
sprinter_text_create (const void *ctx, FILE *stream)
{
static const struct sprinter_text template = {
.vtable = {
.begin_map = text_begin_map,
.begin_list = text_begin_list,
.end = text_end,
.string = text_string,
sprinter: Add a string_len method This method allows callers to output strings with specific lengths. It's useful both for strings with embedded NULs (which JSON can represent, though parser support is apparently spotty), and non-terminated strings.
2012-08-03 03:14:49 +02:00
.string_len = text_string_len,
Add structured output formatter for JSON and plain text (but don't use them yet). Using the new structured printer support in sprinter.h, implement sprinter_json_create, which returns a new JSON structured output formatter. The formatter prints output similar to the existing JSON, but with differences in whitespace (mostly newlines, --output=summary prints the entire message summary on one line, not split across multiple lines). Also implement a "structured" formatter for plain text that prints prefixed strings, to be used with notmuch-search.c plain text output.
2012-07-23 12:39:45 +02:00
.integer = text_integer,
.boolean = text_boolean,
.null = text_null,
.map_key = text_map_key,
.separator = text_separator,
.set_prefix = text_set_prefix,
cli: convert notmuch_bool_t to stdbool C99 stdbool turned 18 this year. There really is no reason to use our own, except in the library interface for backward compatibility. Convert the cli and test binaries to stdbool.
2017-10-07 10:44:04 +02:00
.is_text_printer = true,
Add structured output formatter for JSON and plain text (but don't use them yet). Using the new structured printer support in sprinter.h, implement sprinter_json_create, which returns a new JSON structured output formatter. The formatter prints output similar to the existing JSON, but with differences in whitespace (mostly newlines, --output=summary prints the entire message summary on one line, not split across multiple lines). Also implement a "structured" formatter for plain text that prints prefixed strings, to be used with notmuch-search.c plain text output.
2012-07-23 12:39:45 +02:00
},
};
struct sprinter_text *res;
res = talloc (ctx, struct sprinter_text);
if (! res)
return NULL;
*res = template;
res->stream = stream;
return &res->vtable;
}
sprinter: add text0 formatter for null character separated text Same as the text formatter, but with each field separated by a null character rather than a newline character.
2012-12-16 23:05:10 +01:00
struct sprinter *
sprinter_text0_create (const void *ctx, FILE *stream)
{
struct sprinter *sp;
sp = sprinter_text_create (ctx, stream);
if (! sp)
return NULL;
sp->separator = text0_separator;
return sp;
}
Reference in a new issue Copy permalink