Make maildir synchronization configurable
[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 /* There's no point in continuing when we've detected that we've done
58  * something wrong internally (as opposed to the user passing in a
59  * bogus value).
60  *
61  * Note that __location__ comes from talloc.h.
62  */
63 #define INTERNAL_ERROR(format, ...)                     \
64     do {                                                \
65         fprintf(stderr,                                 \
66                 "Internal error: " format " (%s)\n",    \
67                 ##__VA_ARGS__, __location__);           \
68         exit (1);                                       \
69     } while (0)
70
71 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
72
73 #define STRNCMP_LITERAL(var, literal) \
74     strncmp ((var), (literal), sizeof (literal) - 1)
75
76 static inline void
77 chomp_newline (char *str)
78 {
79     if (str && str[strlen(str)-1] == '\n')
80         str[strlen(str)-1] = '\0';
81 }
82
83 int
84 notmuch_count_command (void *ctx, int argc, char *argv[]);
85
86 int
87 notmuch_dump_command (void *ctx, int argc, char *argv[]);
88
89 int
90 notmuch_new_command (void *ctx, int argc, char *argv[]);
91
92 int
93 notmuch_reply_command (void *ctx, int argc, char *argv[]);
94
95 int
96 notmuch_restore_command (void *ctx, int argc, char *argv[]);
97
98 int
99 notmuch_search_command (void *ctx, int argc, char *argv[]);
100
101 int
102 notmuch_setup_command (void *ctx, int argc, char *argv[]);
103
104 int
105 notmuch_show_command (void *ctx, int argc, char *argv[]);
106
107 int
108 notmuch_tag_command (void *ctx, int argc, char *argv[]);
109
110 int
111 notmuch_search_tags_command (void *ctx, int argc, char *argv[]);
112
113 int
114 notmuch_cat_command (void *ctx, int argc, char *argv[]);
115
116 int
117 notmuch_part_command (void *ctx, int argc, char *argv[]);
118
119 int
120 notmuch_config_command (void *ctx, int argc, char *argv[]);
121
122 const char *
123 notmuch_time_relative_date (const void *ctx, time_t then);
124
125 void
126 notmuch_time_print_formatted_seconds (double seconds);
127
128 double
129 notmuch_time_elapsed (struct timeval start, struct timeval end);
130
131 char *
132 query_string_from_args (void *ctx, int argc, char *argv[]);
133
134 notmuch_status_t
135 show_message_body (const char *filename,
136                    void (*show_part) (GMimeObject *part, int *part_count));
137
138 notmuch_status_t
139 show_one_part (const char *filename, int part);
140
141 char *
142 json_quote_chararray (const void *ctx, const char *str, const size_t len);
143
144 char *
145 json_quote_str (const void *ctx, const char *str);
146
147 /* notmuch-config.c */
148
149 typedef struct _notmuch_config notmuch_config_t;
150
151 notmuch_config_t *
152 notmuch_config_open (void *ctx,
153                      const char *filename,
154                      notmuch_bool_t *is_new_ret);
155
156 void
157 notmuch_config_close (notmuch_config_t *config);
158
159 int
160 notmuch_config_save (notmuch_config_t *config);
161
162 const char *
163 notmuch_config_get_database_path (notmuch_config_t *config);
164
165 void
166 notmuch_config_set_database_path (notmuch_config_t *config,
167                                   const char *database_path);
168
169 const char *
170 notmuch_config_get_user_name (notmuch_config_t *config);
171
172 void
173 notmuch_config_set_user_name (notmuch_config_t *config,
174                               const char *user_name);
175
176 const char *
177 notmuch_config_get_user_primary_email (notmuch_config_t *config);
178
179 void
180 notmuch_config_set_user_primary_email (notmuch_config_t *config,
181                                        const char *primary_email);
182
183 const char **
184 notmuch_config_get_user_other_email (notmuch_config_t *config,
185                                      size_t *length);
186
187 void
188 notmuch_config_set_user_other_email (notmuch_config_t *config,
189                                      const char *other_email[],
190                                      size_t length);
191
192 const char **
193 notmuch_config_get_new_tags (notmuch_config_t *config,
194                              size_t *length);
195 void
196 notmuch_config_set_new_tags (notmuch_config_t *config,
197                              const char *new_tags[],
198                              size_t length);
199
200 notmuch_bool_t
201 notmuch_config_get_maildir_sync (notmuch_config_t *config);
202
203 void
204 notmuch_config_set_maildir_sync (notmuch_config_t *config,
205                                  notmuch_bool_t maildir_sync);
206
207 notmuch_bool_t
208 debugger_is_active (void);
209
210 #endif