4 ffibuilder = cffi.FFI()
12 #if LIBNOTMUCH_MAJOR_VERSION < 5
13 #error libnotmuch version not supported by notmuch2 python bindings
15 #if LIBNOTMUCH_MINOR_VERSION < 1
16 #ERROR libnotmuch version < 5.1 not supported
19 include_dirs=['../../lib'],
20 library_dirs=['../../lib'],
21 libraries=['notmuch'],
26 typedef int... time_t;
28 #define LIBNOTMUCH_MAJOR_VERSION ...
29 #define LIBNOTMUCH_MINOR_VERSION ...
30 #define LIBNOTMUCH_MICRO_VERSION ...
32 #define NOTMUCH_TAG_MAX ...
34 typedef enum _notmuch_status {
35 NOTMUCH_STATUS_SUCCESS = 0,
36 NOTMUCH_STATUS_OUT_OF_MEMORY,
37 NOTMUCH_STATUS_READ_ONLY_DATABASE,
38 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
39 NOTMUCH_STATUS_FILE_ERROR,
40 NOTMUCH_STATUS_FILE_NOT_EMAIL,
41 NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
42 NOTMUCH_STATUS_NULL_POINTER,
43 NOTMUCH_STATUS_TAG_TOO_LONG,
44 NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
45 NOTMUCH_STATUS_UNBALANCED_ATOMIC,
46 NOTMUCH_STATUS_UNSUPPORTED_OPERATION,
47 NOTMUCH_STATUS_UPGRADE_REQUIRED,
48 NOTMUCH_STATUS_PATH_ERROR,
49 NOTMUCH_STATUS_ILLEGAL_ARGUMENT,
50 NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL,
51 NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION,
52 NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL,
53 NOTMUCH_STATUS_LAST_STATUS
56 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
57 NOTMUCH_DATABASE_MODE_READ_WRITE
58 } notmuch_database_mode_t;
59 typedef int notmuch_bool_t;
60 typedef enum _notmuch_message_flag {
61 NOTMUCH_MESSAGE_FLAG_MATCH,
62 NOTMUCH_MESSAGE_FLAG_EXCLUDED,
63 NOTMUCH_MESSAGE_FLAG_GHOST,
64 } notmuch_message_flag_t;
66 NOTMUCH_SORT_OLDEST_FIRST,
67 NOTMUCH_SORT_NEWEST_FIRST,
68 NOTMUCH_SORT_MESSAGE_ID,
74 NOTMUCH_EXCLUDE_FALSE,
78 NOTMUCH_DECRYPT_FALSE,
81 NOTMUCH_DECRYPT_NOSTASH,
82 } notmuch_decryption_policy_t;
84 // These are fully opaque types for us, we only ever use pointers.
85 typedef struct _notmuch_database notmuch_database_t;
86 typedef struct _notmuch_query notmuch_query_t;
87 typedef struct _notmuch_threads notmuch_threads_t;
88 typedef struct _notmuch_thread notmuch_thread_t;
89 typedef struct _notmuch_messages notmuch_messages_t;
90 typedef struct _notmuch_message notmuch_message_t;
91 typedef struct _notmuch_tags notmuch_tags_t;
92 typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
93 typedef struct _notmuch_directory notmuch_directory_t;
94 typedef struct _notmuch_filenames notmuch_filenames_t;
95 typedef struct _notmuch_config_list notmuch_config_list_t;
96 typedef struct _notmuch_indexopts notmuch_indexopts_t;
99 notmuch_status_to_string (notmuch_status_t status);
102 notmuch_database_create_verbose (const char *path,
103 notmuch_database_t **database,
104 char **error_message);
106 notmuch_database_create (const char *path, notmuch_database_t **database);
108 notmuch_database_open_verbose (const char *path,
109 notmuch_database_mode_t mode,
110 notmuch_database_t **database,
111 char **error_message);
113 notmuch_database_open (const char *path,
114 notmuch_database_mode_t mode,
115 notmuch_database_t **database);
117 notmuch_database_close (notmuch_database_t *database);
119 notmuch_database_destroy (notmuch_database_t *database);
121 notmuch_database_get_path (notmuch_database_t *database);
123 notmuch_database_get_version (notmuch_database_t *database);
125 notmuch_database_needs_upgrade (notmuch_database_t *database);
127 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
129 notmuch_database_end_atomic (notmuch_database_t *notmuch);
131 notmuch_database_get_revision (notmuch_database_t *notmuch,
134 notmuch_database_index_file (notmuch_database_t *database,
135 const char *filename,
136 notmuch_indexopts_t *indexopts,
137 notmuch_message_t **message);
139 notmuch_database_remove_message (notmuch_database_t *database,
140 const char *filename);
142 notmuch_database_find_message (notmuch_database_t *database,
143 const char *message_id,
144 notmuch_message_t **message);
146 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
147 const char *filename,
148 notmuch_message_t **message);
150 notmuch_database_get_all_tags (notmuch_database_t *db);
153 notmuch_query_create (notmuch_database_t *database,
154 const char *query_string);
156 notmuch_query_get_query_string (const notmuch_query_t *query);
158 notmuch_query_get_database (const notmuch_query_t *query);
160 notmuch_query_set_omit_excluded (notmuch_query_t *query,
161 notmuch_exclude_t omit_excluded);
163 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
165 notmuch_query_get_sort (const notmuch_query_t *query);
167 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
169 notmuch_query_search_threads (notmuch_query_t *query,
170 notmuch_threads_t **out);
172 notmuch_query_search_messages (notmuch_query_t *query,
173 notmuch_messages_t **out);
175 notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);
177 notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);
179 notmuch_query_destroy (notmuch_query_t *query);
182 notmuch_threads_valid (notmuch_threads_t *threads);
184 notmuch_threads_get (notmuch_threads_t *threads);
186 notmuch_threads_move_to_next (notmuch_threads_t *threads);
188 notmuch_threads_destroy (notmuch_threads_t *threads);
191 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
193 notmuch_message_get_replies (notmuch_message_t *message);
195 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
197 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
199 notmuch_thread_get_messages (notmuch_thread_t *thread);
201 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
203 notmuch_thread_get_authors (notmuch_thread_t *thread);
205 notmuch_thread_get_subject (notmuch_thread_t *thread);
207 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
209 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
211 notmuch_thread_get_tags (notmuch_thread_t *thread);
213 notmuch_thread_destroy (notmuch_thread_t *thread);
216 notmuch_messages_valid (notmuch_messages_t *messages);
218 notmuch_messages_get (notmuch_messages_t *messages);
220 notmuch_messages_move_to_next (notmuch_messages_t *messages);
222 notmuch_messages_destroy (notmuch_messages_t *messages);
224 notmuch_messages_collect_tags (notmuch_messages_t *messages);
227 notmuch_message_get_message_id (notmuch_message_t *message);
229 notmuch_message_get_thread_id (notmuch_message_t *message);
231 notmuch_message_get_filename (notmuch_message_t *message);
232 notmuch_filenames_t *
233 notmuch_message_get_filenames (notmuch_message_t *message);
235 notmuch_message_get_flag (notmuch_message_t *message,
236 notmuch_message_flag_t flag);
238 notmuch_message_set_flag (notmuch_message_t *message,
239 notmuch_message_flag_t flag,
240 notmuch_bool_t value);
242 notmuch_message_get_date (notmuch_message_t *message);
244 notmuch_message_get_header (notmuch_message_t *message,
247 notmuch_message_get_tags (notmuch_message_t *message);
249 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
251 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
253 notmuch_message_remove_all_tags (notmuch_message_t *message);
255 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
257 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
259 notmuch_message_freeze (notmuch_message_t *message);
261 notmuch_message_thaw (notmuch_message_t *message);
263 notmuch_message_get_property (notmuch_message_t *message,
264 const char *key, const char **value);
266 notmuch_message_add_property (notmuch_message_t *message,
267 const char *key, const char *value);
269 notmuch_message_remove_property (notmuch_message_t *message,
270 const char *key, const char *value);
272 notmuch_message_remove_all_properties (notmuch_message_t *message,
274 notmuch_message_properties_t *
275 notmuch_message_get_properties (notmuch_message_t *message,
276 const char *key, notmuch_bool_t exact);
278 notmuch_message_properties_valid (notmuch_message_properties_t
281 notmuch_message_properties_move_to_next (notmuch_message_properties_t
284 notmuch_message_properties_key (notmuch_message_properties_t *properties);
286 notmuch_message_properties_value (notmuch_message_properties_t
289 notmuch_message_properties_destroy (notmuch_message_properties_t
292 notmuch_message_destroy (notmuch_message_t *message);
295 notmuch_tags_valid (notmuch_tags_t *tags);
297 notmuch_tags_get (notmuch_tags_t *tags);
299 notmuch_tags_move_to_next (notmuch_tags_t *tags);
301 notmuch_tags_destroy (notmuch_tags_t *tags);
304 notmuch_filenames_valid (notmuch_filenames_t *filenames);
306 notmuch_filenames_get (notmuch_filenames_t *filenames);
308 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
310 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
311 notmuch_indexopts_t *
312 notmuch_database_get_default_indexopts (notmuch_database_t *db);
314 notmuch_indexopts_set_decrypt_policy (notmuch_indexopts_t *indexopts,
315 notmuch_decryption_policy_t decrypt_policy);
316 notmuch_decryption_policy_t
317 notmuch_indexopts_get_decrypt_policy (const notmuch_indexopts_t *indexopts);
319 notmuch_indexopts_destroy (notmuch_indexopts_t *options);
322 notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
324 notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
326 notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix, notmuch_config_list_t **out);
328 notmuch_config_list_valid (notmuch_config_list_t *config_list);
330 notmuch_config_list_key (notmuch_config_list_t *config_list);
332 notmuch_config_list_value (notmuch_config_list_t *config_list);
334 notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
336 notmuch_config_list_destroy (notmuch_config_list_t *config_list);
341 if __name__ == '__main__':
342 ffibuilder.compile(verbose=True)