test: save buffer content to file instead of printing it in Emacs tests
[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_start) (GMimeObject *part,
69                         int *part_count);
70     void (*part_encstatus) (int status);
71     void (*part_sigstatus) (const GMimeSignatureValidity* validity);
72     void (*part_content) (GMimeObject *part);
73     void (*part_end) (GMimeObject *part);
74     const char *part_sep;
75     const char *body_end;
76     const char *message_end;
77     const char *message_set_sep;
78     const char *message_set_end;
79 } notmuch_show_format_t;
80
81 typedef struct notmuch_show_params {
82     int entire_thread;
83     int raw;
84     int part;
85     GMimeCipherContext* cryptoctx;
86     int decrypt;
87 } notmuch_show_params_t;
88
89 /* There's no point in continuing when we've detected that we've done
90  * something wrong internally (as opposed to the user passing in a
91  * bogus value).
92  *
93  * Note that __location__ comes from talloc.h.
94  */
95 #define INTERNAL_ERROR(format, ...)                     \
96     do {                                                \
97         fprintf(stderr,                                 \
98                 "Internal error: " format " (%s)\n",    \
99                 ##__VA_ARGS__, __location__);           \
100         exit (1);                                       \
101     } while (0)
102
103 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
104
105 #define STRNCMP_LITERAL(var, literal) \
106     strncmp ((var), (literal), sizeof (literal) - 1)
107
108 static inline void
109 chomp_newline (char *str)
110 {
111     if (str && str[strlen(str)-1] == '\n')
112         str[strlen(str)-1] = '\0';
113 }
114
115 int
116 notmuch_count_command (void *ctx, int argc, char *argv[]);
117
118 int
119 notmuch_dump_command (void *ctx, int argc, char *argv[]);
120
121 int
122 notmuch_new_command (void *ctx, int argc, char *argv[]);
123
124 int
125 notmuch_reply_command (void *ctx, int argc, char *argv[]);
126
127 int
128 notmuch_restore_command (void *ctx, int argc, char *argv[]);
129
130 int
131 notmuch_search_command (void *ctx, int argc, char *argv[]);
132
133 int
134 notmuch_setup_command (void *ctx, int argc, char *argv[]);
135
136 int
137 notmuch_show_command (void *ctx, int argc, char *argv[]);
138
139 int
140 notmuch_tag_command (void *ctx, int argc, char *argv[]);
141
142 int
143 notmuch_search_tags_command (void *ctx, int argc, char *argv[]);
144
145 int
146 notmuch_cat_command (void *ctx, int argc, char *argv[]);
147
148 int
149 notmuch_config_command (void *ctx, int argc, char *argv[]);
150
151 const char *
152 notmuch_time_relative_date (const void *ctx, time_t then);
153
154 void
155 notmuch_time_print_formatted_seconds (double seconds);
156
157 double
158 notmuch_time_elapsed (struct timeval start, struct timeval end);
159
160 char *
161 query_string_from_args (void *ctx, int argc, char *argv[]);
162
163 notmuch_status_t
164 show_message_body (const char *filename,
165                    const notmuch_show_format_t *format,
166                    notmuch_show_params_t *params);
167
168 notmuch_status_t
169 show_one_part (const char *filename, int part);
170
171 char *
172 json_quote_chararray (const void *ctx, const char *str, const size_t len);
173
174 char *
175 json_quote_str (const void *ctx, const char *str);
176
177 /* notmuch-config.c */
178
179 typedef struct _notmuch_config notmuch_config_t;
180
181 notmuch_config_t *
182 notmuch_config_open (void *ctx,
183                      const char *filename,
184                      notmuch_bool_t *is_new_ret);
185
186 void
187 notmuch_config_close (notmuch_config_t *config);
188
189 int
190 notmuch_config_save (notmuch_config_t *config);
191
192 const char *
193 notmuch_config_get_database_path (notmuch_config_t *config);
194
195 void
196 notmuch_config_set_database_path (notmuch_config_t *config,
197                                   const char *database_path);
198
199 const char *
200 notmuch_config_get_user_name (notmuch_config_t *config);
201
202 void
203 notmuch_config_set_user_name (notmuch_config_t *config,
204                               const char *user_name);
205
206 const char *
207 notmuch_config_get_user_primary_email (notmuch_config_t *config);
208
209 void
210 notmuch_config_set_user_primary_email (notmuch_config_t *config,
211                                        const char *primary_email);
212
213 const char **
214 notmuch_config_get_user_other_email (notmuch_config_t *config,
215                                      size_t *length);
216
217 void
218 notmuch_config_set_user_other_email (notmuch_config_t *config,
219                                      const char *other_email[],
220                                      size_t length);
221
222 const char **
223 notmuch_config_get_new_tags (notmuch_config_t *config,
224                              size_t *length);
225 void
226 notmuch_config_set_new_tags (notmuch_config_t *config,
227                              const char *new_tags[],
228                              size_t length);
229
230 notmuch_bool_t
231 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
232
233 void
234 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
235                                               notmuch_bool_t synchronize_flags);
236
237 notmuch_bool_t
238 debugger_is_active (void);
239
240 #endif