git.notmuchmail.org Git - notmuch/blob - bindings/python-cffi/notmuch2/_build.py

   1 import cffi
   2
   3
   4 ffibuilder = cffi.FFI()
   5 ffibuilder.set_source(
   6     'notmuch2._capi',
   7     r"""
   8     #include <stdlib.h>
   9     #include <time.h>
  10     #include <notmuch.h>
  11
  12     #if LIBNOTMUCH_MAJOR_VERSION < 5
  13         #error libnotmuch version not supported by notmuch2 python bindings
  14     #endif
  15     #if LIBNOTMUCH_MINOR_VERSION < 1
  16         #ERROR libnotmuch  version < 5.1 not supported
  17     #endif
  18     """,
  19     include_dirs=['../../lib'],
  20     library_dirs=['../../lib'],
  21     libraries=['notmuch'],
  22 )
  23 ffibuilder.cdef(
  24     r"""
  25     void free(void *ptr);
  26     typedef int... time_t;
  27
  28     #define LIBNOTMUCH_MAJOR_VERSION ...
  29     #define LIBNOTMUCH_MINOR_VERSION ...
  30     #define LIBNOTMUCH_MICRO_VERSION ...
  31
  32     #define NOTMUCH_TAG_MAX ...
  33
  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_NO_CONFIG,
  54         NOTMUCH_STATUS_DATABASE_EXISTS,
  55         NOTMUCH_STATUS_LAST_STATUS
  56     } notmuch_status_t;
  57     typedef enum {
  58         NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
  59         NOTMUCH_DATABASE_MODE_READ_WRITE
  60     } notmuch_database_mode_t;
  61     typedef int notmuch_bool_t;
  62     typedef enum _notmuch_message_flag {
  63         NOTMUCH_MESSAGE_FLAG_MATCH,
  64         NOTMUCH_MESSAGE_FLAG_EXCLUDED,
  65         NOTMUCH_MESSAGE_FLAG_GHOST,
  66     } notmuch_message_flag_t;
  67     typedef enum {
  68         NOTMUCH_SORT_OLDEST_FIRST,
  69         NOTMUCH_SORT_NEWEST_FIRST,
  70         NOTMUCH_SORT_MESSAGE_ID,
  71         NOTMUCH_SORT_UNSORTED
  72     } notmuch_sort_t;
  73     typedef enum {
  74         NOTMUCH_EXCLUDE_FLAG,
  75         NOTMUCH_EXCLUDE_TRUE,
  76         NOTMUCH_EXCLUDE_FALSE,
  77         NOTMUCH_EXCLUDE_ALL
  78     } notmuch_exclude_t;
  79     typedef enum {
  80         NOTMUCH_DECRYPT_FALSE,
  81         NOTMUCH_DECRYPT_TRUE,
  82         NOTMUCH_DECRYPT_AUTO,
  83         NOTMUCH_DECRYPT_NOSTASH,
  84     } notmuch_decryption_policy_t;
  85
  86     // These are fully opaque types for us, we only ever use pointers.
  87     typedef struct _notmuch_database notmuch_database_t;
  88     typedef struct _notmuch_query notmuch_query_t;
  89     typedef struct _notmuch_threads notmuch_threads_t;
  90     typedef struct _notmuch_thread notmuch_thread_t;
  91     typedef struct _notmuch_messages notmuch_messages_t;
  92     typedef struct _notmuch_message notmuch_message_t;
  93     typedef struct _notmuch_tags notmuch_tags_t;
  94     typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
  95     typedef struct _notmuch_directory notmuch_directory_t;
  96     typedef struct _notmuch_filenames notmuch_filenames_t;
  97     typedef struct _notmuch_config_list notmuch_config_list_t;
  98     typedef struct _notmuch_indexopts notmuch_indexopts_t;
  99
 100     const char *
 101     notmuch_status_to_string (notmuch_status_t status);
 102
 103     notmuch_status_t
 104     notmuch_database_create_verbose (const char *path,
 105                                      notmuch_database_t **database,
 106                                      char **error_message);
 107     notmuch_status_t
 108     notmuch_database_create (const char *path, notmuch_database_t **database);
 109     notmuch_status_t
 110     notmuch_database_open_verbose (const char *path,
 111                                    notmuch_database_mode_t mode,
 112                                    notmuch_database_t **database,
 113                                    char **error_message);
 114     notmuch_status_t
 115     notmuch_database_open (const char *path,
 116                            notmuch_database_mode_t mode,
 117                            notmuch_database_t **database);
 118     notmuch_status_t
 119     notmuch_database_close (notmuch_database_t *database);
 120     notmuch_status_t
 121     notmuch_database_destroy (notmuch_database_t *database);
 122     const char *
 123     notmuch_database_get_path (notmuch_database_t *database);
 124     unsigned int
 125     notmuch_database_get_version (notmuch_database_t *database);
 126     notmuch_bool_t
 127     notmuch_database_needs_upgrade (notmuch_database_t *database);
 128     notmuch_status_t
 129     notmuch_database_begin_atomic (notmuch_database_t *notmuch);
 130     notmuch_status_t
 131     notmuch_database_end_atomic (notmuch_database_t *notmuch);
 132     unsigned long
 133     notmuch_database_get_revision (notmuch_database_t *notmuch,
 134                                    const char **uuid);
 135     notmuch_status_t
 136     notmuch_database_index_file (notmuch_database_t *database,
 137                                  const char *filename,
 138                                  notmuch_indexopts_t *indexopts,
 139                                  notmuch_message_t **message);
 140     notmuch_status_t
 141     notmuch_database_remove_message (notmuch_database_t *database,
 142                                      const char *filename);
 143     notmuch_status_t
 144     notmuch_database_find_message (notmuch_database_t *database,
 145                                    const char *message_id,
 146                                    notmuch_message_t **message);
 147     notmuch_status_t
 148     notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
 149                                                const char *filename,
 150                                                notmuch_message_t **message);
 151     notmuch_tags_t *
 152     notmuch_database_get_all_tags (notmuch_database_t *db);
 153
 154     notmuch_query_t *
 155     notmuch_query_create (notmuch_database_t *database,
 156                           const char *query_string);
 157     const char *
 158     notmuch_query_get_query_string (const notmuch_query_t *query);
 159     notmuch_database_t *
 160     notmuch_query_get_database (const notmuch_query_t *query);
 161     void
 162     notmuch_query_set_omit_excluded (notmuch_query_t *query,
 163                                      notmuch_exclude_t omit_excluded);
 164     void
 165     notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
 166     notmuch_sort_t
 167     notmuch_query_get_sort (const notmuch_query_t *query);
 168     notmuch_status_t
 169     notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
 170     notmuch_status_t
 171     notmuch_query_search_threads (notmuch_query_t *query,
 172                                   notmuch_threads_t **out);
 173     notmuch_status_t
 174     notmuch_query_search_messages (notmuch_query_t *query,
 175                                    notmuch_messages_t **out);
 176     notmuch_status_t
 177     notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);
 178     notmuch_status_t
 179     notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);
 180     void
 181     notmuch_query_destroy (notmuch_query_t *query);
 182
 183     notmuch_bool_t
 184     notmuch_threads_valid (notmuch_threads_t *threads);
 185     notmuch_thread_t *
 186     notmuch_threads_get (notmuch_threads_t *threads);
 187     void
 188     notmuch_threads_move_to_next (notmuch_threads_t *threads);
 189     void
 190     notmuch_threads_destroy (notmuch_threads_t *threads);
 191
 192     const char *
 193     notmuch_thread_get_thread_id (notmuch_thread_t *thread);
 194     notmuch_messages_t *
 195     notmuch_message_get_replies (notmuch_message_t *message);
 196     int
 197     notmuch_thread_get_total_messages (notmuch_thread_t *thread);
 198     notmuch_messages_t *
 199     notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
 200     notmuch_messages_t *
 201     notmuch_thread_get_messages (notmuch_thread_t *thread);
 202     int
 203     notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
 204     const char *
 205     notmuch_thread_get_authors (notmuch_thread_t *thread);
 206     const char *
 207     notmuch_thread_get_subject (notmuch_thread_t *thread);
 208     time_t
 209     notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
 210     time_t
 211     notmuch_thread_get_newest_date (notmuch_thread_t *thread);
 212     notmuch_tags_t *
 213     notmuch_thread_get_tags (notmuch_thread_t *thread);
 214     void
 215     notmuch_thread_destroy (notmuch_thread_t *thread);
 216
 217     notmuch_bool_t
 218     notmuch_messages_valid (notmuch_messages_t *messages);
 219     notmuch_message_t *
 220     notmuch_messages_get (notmuch_messages_t *messages);
 221     void
 222     notmuch_messages_move_to_next (notmuch_messages_t *messages);
 223     void
 224     notmuch_messages_destroy (notmuch_messages_t *messages);
 225     notmuch_tags_t *
 226     notmuch_messages_collect_tags (notmuch_messages_t *messages);
 227
 228     const char *
 229     notmuch_message_get_message_id (notmuch_message_t *message);
 230     const char *
 231     notmuch_message_get_thread_id (notmuch_message_t *message);
 232     const char *
 233     notmuch_message_get_filename (notmuch_message_t *message);
 234     notmuch_filenames_t *
 235     notmuch_message_get_filenames (notmuch_message_t *message);
 236     notmuch_bool_t
 237     notmuch_message_get_flag (notmuch_message_t *message,
 238                               notmuch_message_flag_t flag);
 239     void
 240     notmuch_message_set_flag (notmuch_message_t *message,
 241                               notmuch_message_flag_t flag,
 242                               notmuch_bool_t value);
 243     time_t
 244     notmuch_message_get_date  (notmuch_message_t *message);
 245     const char *
 246     notmuch_message_get_header (notmuch_message_t *message,
 247                                 const char *header);
 248     notmuch_tags_t *
 249     notmuch_message_get_tags (notmuch_message_t *message);
 250     notmuch_status_t
 251     notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
 252     notmuch_status_t
 253     notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
 254     notmuch_status_t
 255     notmuch_message_remove_all_tags (notmuch_message_t *message);
 256     notmuch_status_t
 257     notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
 258     notmuch_status_t
 259     notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
 260     notmuch_status_t
 261     notmuch_message_freeze (notmuch_message_t *message);
 262     notmuch_status_t
 263     notmuch_message_thaw (notmuch_message_t *message);
 264     notmuch_status_t
 265     notmuch_message_get_property (notmuch_message_t *message,
 266                                   const char *key, const char **value);
 267     notmuch_status_t
 268     notmuch_message_add_property (notmuch_message_t *message,
 269                                   const char *key, const char *value);
 270     notmuch_status_t
 271     notmuch_message_remove_property (notmuch_message_t *message,
 272                                      const char *key, const char *value);
 273     notmuch_status_t
 274     notmuch_message_remove_all_properties (notmuch_message_t *message,
 275                                            const char *key);
 276     notmuch_message_properties_t *
 277     notmuch_message_get_properties (notmuch_message_t *message,
 278                                     const char *key, notmuch_bool_t exact);
 279     notmuch_bool_t
 280     notmuch_message_properties_valid (notmuch_message_properties_t
 281                                           *properties);
 282     void
 283     notmuch_message_properties_move_to_next (notmuch_message_properties_t
 284                                                  *properties);
 285     const char *
 286     notmuch_message_properties_key (notmuch_message_properties_t *properties);
 287     const char *
 288     notmuch_message_properties_value (notmuch_message_properties_t
 289                                           *properties);
 290     void
 291     notmuch_message_properties_destroy (notmuch_message_properties_t
 292                                             *properties);
 293     void
 294     notmuch_message_destroy (notmuch_message_t *message);
 295
 296     notmuch_bool_t
 297     notmuch_tags_valid (notmuch_tags_t *tags);
 298     const char *
 299     notmuch_tags_get (notmuch_tags_t *tags);
 300     void
 301     notmuch_tags_move_to_next (notmuch_tags_t *tags);
 302     void
 303     notmuch_tags_destroy (notmuch_tags_t *tags);
 304
 305     notmuch_bool_t
 306     notmuch_filenames_valid (notmuch_filenames_t *filenames);
 307     const char *
 308     notmuch_filenames_get (notmuch_filenames_t *filenames);
 309     void
 310     notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
 311     void
 312     notmuch_filenames_destroy (notmuch_filenames_t *filenames);
 313     notmuch_indexopts_t *
 314     notmuch_database_get_default_indexopts (notmuch_database_t *db);
 315     notmuch_status_t
 316     notmuch_indexopts_set_decrypt_policy (notmuch_indexopts_t *indexopts,
 317                                           notmuch_decryption_policy_t decrypt_policy);
 318     notmuch_decryption_policy_t
 319     notmuch_indexopts_get_decrypt_policy (const notmuch_indexopts_t *indexopts);
 320     void
 321     notmuch_indexopts_destroy (notmuch_indexopts_t *options);
 322
 323     notmuch_status_t
 324     notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
 325     notmuch_status_t
 326     notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
 327     notmuch_status_t
 328     notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix, notmuch_config_list_t **out);
 329     notmuch_bool_t
 330     notmuch_config_list_valid (notmuch_config_list_t *config_list);
 331     const char *
 332     notmuch_config_list_key (notmuch_config_list_t *config_list);
 333     const char *
 334     notmuch_config_list_value (notmuch_config_list_t *config_list);
 335     void
 336     notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
 337     void
 338     notmuch_config_list_destroy (notmuch_config_list_t *config_list);
 339     """
 340 )
 341
 342
 343 if __name__ == '__main__':
 344     ffibuilder.compile(verbose=True)