1 /* notmuch - Not much of an email program, (just index and search)
3 * Copyright © 2009 Carl Worth
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.
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.
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/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #ifndef NOTMUCH_CLIENT_H
22 #define NOTMUCH_CLIENT_H
25 #define _GNU_SOURCE /* for getline */
31 #include <gmime/gmime.h>
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).
52 #define unused(x) x __attribute__ ((unused))
54 #define STRINGIFY(s) STRINGIFY_(s)
55 #define STRINGIFY_(s) #s
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,
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,
70 void (*part_content) (GMimeObject *part);
71 void (*part_end) (GMimeObject *part);
74 const char *message_end;
75 const char *message_set_sep;
76 const char *message_set_end;
77 } notmuch_show_format_t;
79 typedef struct notmuch_show_params {
83 } notmuch_show_params_t;
85 /* There's no point in continuing when we've detected that we've done
86 * something wrong internally (as opposed to the user passing in a
89 * Note that __location__ comes from talloc.h.
91 #define INTERNAL_ERROR(format, ...) \
94 "Internal error: " format " (%s)\n", \
95 ##__VA_ARGS__, __location__); \
99 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
101 #define STRNCMP_LITERAL(var, literal) \
102 strncmp ((var), (literal), sizeof (literal) - 1)
105 chomp_newline (char *str)
107 if (str && str[strlen(str)-1] == '\n')
108 str[strlen(str)-1] = '\0';
112 notmuch_count_command (void *ctx, int argc, char *argv[]);
115 notmuch_dump_command (void *ctx, int argc, char *argv[]);
118 notmuch_new_command (void *ctx, int argc, char *argv[]);
121 notmuch_reply_command (void *ctx, int argc, char *argv[]);
124 notmuch_restore_command (void *ctx, int argc, char *argv[]);
127 notmuch_search_command (void *ctx, int argc, char *argv[]);
130 notmuch_setup_command (void *ctx, int argc, char *argv[]);
133 notmuch_show_command (void *ctx, int argc, char *argv[]);
136 notmuch_tag_command (void *ctx, int argc, char *argv[]);
139 notmuch_search_tags_command (void *ctx, int argc, char *argv[]);
142 notmuch_cat_command (void *ctx, int argc, char *argv[]);
145 notmuch_config_command (void *ctx, int argc, char *argv[]);
148 notmuch_time_relative_date (const void *ctx, time_t then);
151 notmuch_time_print_formatted_seconds (double seconds);
154 notmuch_time_elapsed (struct timeval start, struct timeval end);
157 query_string_from_args (void *ctx, int argc, char *argv[]);
160 show_message_body (const char *filename,
161 const notmuch_show_format_t *format,
162 notmuch_show_params_t *params);
165 show_one_part (const char *filename, int part);
168 json_quote_chararray (const void *ctx, const char *str, const size_t len);
171 json_quote_str (const void *ctx, const char *str);
173 /* notmuch-config.c */
175 typedef struct _notmuch_config notmuch_config_t;
178 notmuch_config_open (void *ctx,
179 const char *filename,
180 notmuch_bool_t *is_new_ret);
183 notmuch_config_close (notmuch_config_t *config);
186 notmuch_config_save (notmuch_config_t *config);
189 notmuch_config_get_database_path (notmuch_config_t *config);
192 notmuch_config_set_database_path (notmuch_config_t *config,
193 const char *database_path);
196 notmuch_config_get_user_name (notmuch_config_t *config);
199 notmuch_config_set_user_name (notmuch_config_t *config,
200 const char *user_name);
203 notmuch_config_get_user_primary_email (notmuch_config_t *config);
206 notmuch_config_set_user_primary_email (notmuch_config_t *config,
207 const char *primary_email);
210 notmuch_config_get_user_other_email (notmuch_config_t *config,
214 notmuch_config_set_user_other_email (notmuch_config_t *config,
215 const char *other_email[],
219 notmuch_config_get_new_tags (notmuch_config_t *config,
222 notmuch_config_set_new_tags (notmuch_config_t *config,
223 const char *new_tags[],
227 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
230 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
231 notmuch_bool_t synchronize_flags);
234 debugger_is_active (void);