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