NeoMutt  2025-12-11-911-gd8d604
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
dump.h
Go to the documentation of this file.
1
22
23#ifndef MUTT_CONFIG_DUMP_H
24#define MUTT_CONFIG_DUMP_H
25
26#include <stdbool.h>
27#include <stdint.h>
28#include <stdio.h>
29
30struct Buffer;
31struct ConfigSet;
32struct HashElem;
33struct HashElemArray;
34
53typedef uint16_t ConfigDumpFlags;
54
55void dump_config_neo(struct ConfigSet *cs, struct HashElem *he, struct Buffer *value, struct Buffer *initial, ConfigDumpFlags flags, FILE *fp);
56bool dump_config(struct ConfigSet *cs, struct HashElemArray *hea, ConfigDumpFlags flags, FILE *fp);
57size_t escape_string(struct Buffer *buf, const char *src);
58size_t pretty_var(const char *str, struct Buffer *buf);
59
60#endif /* MUTT_CONFIG_DUMP_H */
size_t escape_string(struct Buffer *buf, const char *src)
Write a string to a buffer, escaping special characters.
Definition dump.c:47
size_t pretty_var(const char *str, struct Buffer *buf)
Escape and stringify a config item value.
Definition dump.c:87
ConfigDumpFlag
Flags for dump_config(), e.g.
Definition dump.h:39
@ CS_DUMP_HIDE_NAME
Do not print the name of the config item.
Definition dump.h:44
@ CS_DUMP_SHOW_DOCS
Show one-liner documentation for the config item.
Definition dump.h:50
@ CS_DUMP_SHOW_DISABLED
Show disabled config items, too.
Definition dump.h:47
@ CS_DUMP_NONE
No flags are set.
Definition dump.h:40
@ CS_DUMP_LINK_DOCS
Link to the online docs.
Definition dump.h:51
@ CS_DUMP_ONLY_CHANGED
Only show config that the user has changed.
Definition dump.h:41
@ CS_DUMP_SHOW_DEPRECATED
Show config items that aren't used any more.
Definition dump.h:49
@ CS_DUMP_SHOW_DEFAULTS
Show the default value for the config item.
Definition dump.h:46
@ CS_DUMP_HIDE_SENSITIVE
Obscure sensitive information like passwords.
Definition dump.h:42
@ CS_DUMP_HIDE_VALUE
Do not print the value of the config item.
Definition dump.h:45
@ CS_DUMP_SHOW_SYNONYMS
Show synonyms and the config items they're linked to.
Definition dump.h:48
@ CS_DUMP_NO_ESCAPING
Do not escape special chars, or quote the string.
Definition dump.h:43
bool dump_config(struct ConfigSet *cs, struct HashElemArray *hea, ConfigDumpFlags flags, FILE *fp)
Write all the config to a file.
Definition dump.c:198
void dump_config_neo(struct ConfigSet *cs, struct HashElem *he, struct Buffer *value, struct Buffer *initial, ConfigDumpFlags flags, FILE *fp)
Dump the config in the style of NeoMutt.
Definition dump.c:110
uint16_t ConfigDumpFlags
Definition dump.h:53
String manipulation buffer.
Definition buffer.h:36
Container for lots of config items.
Definition set.h:251
The item stored in a Hash Table.
Definition hash.h:44