pass entire format structure to various show_message functions
[notmuch] / notmuch-client.h
1 /* notmuch - Not much of an email program, (just index and search)
2  *
3  * Copyright © 2009 Carl Worth
4  *
5  * This program is free software: you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation, either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program.  If not, see http://www.gnu.org/licenses/ .
17  *
18  * Author: Carl Worth <cworth@cworth.org>
19  */
20
21 #ifndef NOTMUCH_CLIENT_H
22 #define NOTMUCH_CLIENT_H
23
24 #ifndef _GNU_SOURCE
25 #define _GNU_SOURCE /* for getline */
26 #endif
27 #include <stdio.h>
28
29 #include "compat.h"
30
31 #include <gmime/gmime.h>
32
33 #include "notmuch.h"
34
35 /* This is separate from notmuch-private.h because we're trying to
36  * keep notmuch.c from looking into any internals, (which helps us
37  * develop notmuch.h into a plausible library interface).
38  */
39 #include "xutil.h"
40
41 #include <stddef.h>
42 #include <string.h>
43 #include <sys/stat.h>
44 #include <sys/time.h>
45 #include <unistd.h>
46 #include <dirent.h>
47 #include <errno.h>
48 #include <signal.h>
49
50 #include <talloc.h>
51
52 #define unused(x) x __attribute__ ((unused))
53
54 #define STRINGIFY(s) STRINGIFY_(s)
55 #define STRINGIFY_(s) #s
56
57 typedef struct notmuch_show_format {
58     const char *message_set_start;
59     const char *message_start;
60     void (*message) (const void *ctx,
61                      notmuch_message_t *message,
62                      int indent);
63     const char *header_start;
64     void (*header) (const void *ctx,
65                     notmuch_message_t *message);
66     const char *header_end;
67     const char *body_start;
68     void (*part) (GMimeObject *part,
69                   int *part_count,
70                   int first);
71     void (*part_end) (GMimeObject *part);
72     const char *body_end;
73     const char *message_end;
74     const char *message_set_sep;
75     const char *message_set_end;
76 } notmuch_show_format_t;
77
78 /* There's no point in continuing when we've detected that we've done
79  * something wrong internally (as opposed to the user passing in a
80  * bogus value).
81  *
82  * Note that __location__ comes from talloc.h.
83  */
84 #define INTERNAL_ERROR(format, ...)                     \
85     do {                                                \
86         fprintf(stderr,                                 \
87                 "Internal error: " format " (%s)\n",    \
88                 ##__VA_ARGS__, __location__);           \
89         exit (1);                                       \
90     } while (0)
91
92 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
93
94 #define STRNCMP_LITERAL(var, literal) \
95     strncmp ((var), (literal), sizeof (literal) - 1)
96
97 static inline void
98 chomp_newline (char *str)
99 {
100     if (str && str[strlen(str)-1] == '\n')
101         str[strlen(str)-1] = '\0';
102 }
103
104 int
105 notmuch_count_command (void *ctx, int argc, char *argv[]);
106
107 int
108 notmuch_dump_command (void *ctx, int argc, char *argv[]);
109
110 int
111 notmuch_new_command (void *ctx, int argc, char *argv[]);
112
113 int
114 notmuch_reply_command (void *ctx, int argc, char *argv[]);
115
116 int
117 notmuch_restore_command (void *ctx, int argc, char *argv[]);
118
119 int
120 notmuch_search_command (void *ctx, int argc, char *argv[]);
121
122 int
123 notmuch_setup_command (void *ctx, int argc, char *argv[]);
124
125 int
126 notmuch_show_command (void *ctx, int argc, char *argv[]);
127
128 int
129 notmuch_tag_command (void *ctx, int argc, char *argv[]);
130
131 int
132 notmuch_search_tags_command (void *ctx, int argc, char *argv[]);
133
134 int
135 notmuch_cat_command (void *ctx, int argc, char *argv[]);
136
137 int
138 notmuch_part_command (void *ctx, int argc, char *argv[]);
139
140 int
141 notmuch_config_command (void *ctx, int argc, char *argv[]);
142
143 const char *
144 notmuch_time_relative_date (const void *ctx, time_t then);
145
146 void
147 notmuch_time_print_formatted_seconds (double seconds);
148
149 double
150 notmuch_time_elapsed (struct timeval start, struct timeval end);
151
152 char *
153 query_string_from_args (void *ctx, int argc, char *argv[]);
154
155 notmuch_status_t
156 show_message_body (const char *filename,
157                    const notmuch_show_format_t *format);
158
159 notmuch_status_t
160 show_one_part (const char *filename, int part);
161
162 char *
163 json_quote_chararray (const void *ctx, const char *str, const size_t len);
164
165 char *
166 json_quote_str (const void *ctx, const char *str);
167
168 /* notmuch-config.c */
169
170 typedef struct _notmuch_config notmuch_config_t;
171
172 notmuch_config_t *
173 notmuch_config_open (void *ctx,
174                      const char *filename,
175                      notmuch_bool_t *is_new_ret);
176
177 void
178 notmuch_config_close (notmuch_config_t *config);
179
180 int
181 notmuch_config_save (notmuch_config_t *config);
182
183 const char *
184 notmuch_config_get_database_path (notmuch_config_t *config);
185
186 void
187 notmuch_config_set_database_path (notmuch_config_t *config,
188                                   const char *database_path);
189
190 const char *
191 notmuch_config_get_user_name (notmuch_config_t *config);
192
193 void
194 notmuch_config_set_user_name (notmuch_config_t *config,
195                               const char *user_name);
196
197 const char *
198 notmuch_config_get_user_primary_email (notmuch_config_t *config);
199
200 void
201 notmuch_config_set_user_primary_email (notmuch_config_t *config,
202                                        const char *primary_email);
203
204 const char **
205 notmuch_config_get_user_other_email (notmuch_config_t *config,
206                                      size_t *length);
207
208 void
209 notmuch_config_set_user_other_email (notmuch_config_t *config,
210                                      const char *other_email[],
211                                      size_t length);
212
213 const char **
214 notmuch_config_get_new_tags (notmuch_config_t *config,
215                              size_t *length);
216 void
217 notmuch_config_set_new_tags (notmuch_config_t *config,
218                              const char *new_tags[],
219                              size_t length);
220
221 notmuch_bool_t
222 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
223
224 void
225 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
226                                               notmuch_bool_t synchronize_flags);
227
228 notmuch_bool_t
229 debugger_is_active (void);
230
231 #endif