TODO: Add a bunch of ideas that have been on my mind lately.
[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
25 #ifndef _GNU_SOURCE
26 #define _GNU_SOURCE /* for getline */
27 #endif
28 #include <stdio.h>
29
30 #include <gmime/gmime.h>
31
32 #include "notmuch.h"
33
34 /* This is separate from notmuch-private.h because we're trying to
35  * keep notmuch.c from looking into any internals, (which helps us
36  * develop notmuch.h into a plausible library interface).
37  */
38 #include "xutil.h"
39
40 #include <stddef.h>
41 #include <string.h>
42 #include <sys/stat.h>
43 #include <sys/time.h>
44 #include <unistd.h>
45 #include <dirent.h>
46 #include <errno.h>
47 #include <signal.h>
48
49 #include <talloc.h>
50
51 #define unused(x) x __attribute__ ((unused))
52
53 /* There's no point in continuing when we've detected that we've done
54  * something wrong internally (as opposed to the user passing in a
55  * bogus value).
56  *
57  * Note that __location__ comes from talloc.h.
58  */
59 #define INTERNAL_ERROR(format, ...)                     \
60     do {                                                \
61         fprintf(stderr,                                 \
62                 "Internal error: " format " (%s)\n",    \
63                 ##__VA_ARGS__, __location__);           \
64         exit (1);                                       \
65     } while (0)
66
67 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
68
69 #define STRNCMP_LITERAL(var, literal) \
70     strncmp ((var), (literal), sizeof (literal) - 1)
71
72 typedef void (*add_files_callback_t) (notmuch_message_t *message);
73
74 typedef struct {
75     int ignore_read_only_directories;
76     int saw_read_only_directory;
77
78     int total_files;
79     int processed_files;
80     int added_messages;
81     struct timeval tv_start;
82
83     add_files_callback_t callback;
84 } add_files_state_t;
85
86 static inline void
87 chomp_newline (char *str)
88 {
89     if (str && str[strlen(str)-1] == '\n')
90         str[strlen(str)-1] = '\0';
91 }
92
93 int
94 notmuch_dump_command (void *ctx, int argc, char *argv[]);
95
96 int
97 notmuch_new_command (void *ctx, int argc, char *argv[]);
98
99 int
100 notmuch_reply_command (void *ctx, int argc, char *argv[]);
101
102 int
103 notmuch_restore_command (void *ctx, int argc, char *argv[]);
104
105 int
106 notmuch_search_command (void *ctx, int argc, char *argv[]);
107
108 int
109 notmuch_setup_command (void *ctx, int argc, char *argv[]);
110
111 int
112 notmuch_show_command (void *ctx, int argc, char *argv[]);
113
114 int
115 notmuch_tag_command (void *ctx, int argc, char *argv[]);
116
117 const char *
118 notmuch_time_relative_date (const void *ctx, time_t then);
119
120 void
121 notmuch_time_print_formatted_seconds (double seconds);
122
123 double
124 notmuch_time_elapsed (struct timeval start, struct timeval end);
125
126 notmuch_status_t
127 add_files (notmuch_database_t *notmuch, const char *path,
128            add_files_state_t *state);
129
130 char *
131 query_string_from_args (void *ctx, int argc, char *argv[]);
132
133 notmuch_status_t
134 show_message_body (const char *filename,
135                    void (*show_part) (GMimeObject *part, int *part_count));
136
137 /* notmuch-config.c */
138
139 typedef struct _notmuch_config notmuch_config_t;
140
141 notmuch_config_t *
142 notmuch_config_open (void *ctx,
143                      const char *filename,
144                      notmuch_bool_t *is_new_ret);
145
146 void
147 notmuch_config_close (notmuch_config_t *config);
148
149 int
150 notmuch_config_save (notmuch_config_t *config);
151
152 const char *
153 notmuch_config_get_database_path (notmuch_config_t *config);
154
155 void
156 notmuch_config_set_database_path (notmuch_config_t *config,
157                                   const char *database_path);
158
159 const char *
160 notmuch_config_get_user_name (notmuch_config_t *config);
161
162 void
163 notmuch_config_set_user_name (notmuch_config_t *config,
164                               const char *user_name);
165
166 const char *
167 notmuch_config_get_user_primary_email (notmuch_config_t *config);
168
169 void
170 notmuch_config_set_user_primary_email (notmuch_config_t *config,
171                                        const char *primary_email);
172
173 char **
174 notmuch_config_get_user_other_email (notmuch_config_t *config,
175                                      size_t *length);
176
177 void
178 notmuch_config_set_user_other_email (notmuch_config_t *config,
179                                      const char *other_email[],
180                                      size_t length);
181
182 notmuch_bool_t
183 debugger_is_active (void);
184
185 #endif