git.cworth.org Git - notmuch/blob - bindings/ruby/defs.h

   1 /* The Ruby interface to the notmuch mail library
   2  *
   3  * Copyright © 2010, 2011, 2012 Ali Polatel
   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 https://www.gnu.org/licenses/ .
  17  *
  18  * Author: Ali Polatel <alip@exherbo.org>
  19  */
  20
  21 #ifndef DEFS_H
  22 #define DEFS_H
  23
  24 #include <notmuch.h>
  25 #include <ruby.h>
  26 #include <talloc.h>
  27
  28 extern VALUE notmuch_rb_cDatabase;
  29 extern VALUE notmuch_rb_cDirectory;
  30 extern VALUE notmuch_rb_cFileNames;
  31 extern VALUE notmuch_rb_cQuery;
  32 extern VALUE notmuch_rb_cThreads;
  33 extern VALUE notmuch_rb_cThread;
  34 extern VALUE notmuch_rb_cMessages;
  35 extern VALUE notmuch_rb_cMessage;
  36
  37 extern VALUE notmuch_rb_eBaseError;
  38 extern VALUE notmuch_rb_eDatabaseError;
  39 extern VALUE notmuch_rb_eMemoryError;
  40 extern VALUE notmuch_rb_eReadOnlyError;
  41 extern VALUE notmuch_rb_eXapianError;
  42 extern VALUE notmuch_rb_eFileError;
  43 extern VALUE notmuch_rb_eFileNotEmailError;
  44 extern VALUE notmuch_rb_eNullPointerError;
  45 extern VALUE notmuch_rb_eTagTooLongError;
  46 extern VALUE notmuch_rb_eUnbalancedFreezeThawError;
  47 extern VALUE notmuch_rb_eUnbalancedAtomicError;
  48
  49 extern ID ID_call;
  50 extern ID ID_db_create;
  51 extern ID ID_db_mode;
  52
  53 /* RSTRING_PTR() is new in ruby-1.9 */
  54 #if !defined(RSTRING_PTR)
  55 # define RSTRING_PTR(v) (RSTRING((v))->ptr)
  56 #endif /* !defined (RSTRING_PTR) */
  57
  58 extern const rb_data_type_t notmuch_rb_object_type;
  59 extern const rb_data_type_t notmuch_rb_database_type;
  60 extern const rb_data_type_t notmuch_rb_directory_type;
  61 extern const rb_data_type_t notmuch_rb_query_type;
  62 extern const rb_data_type_t notmuch_rb_threads_type;
  63 extern const rb_data_type_t notmuch_rb_thread_type;
  64 extern const rb_data_type_t notmuch_rb_messages_type;
  65 extern const rb_data_type_t notmuch_rb_message_type;
  66 extern const rb_data_type_t notmuch_rb_tags_type;
  67
  68 #define Data_Get_Notmuch_Rb_Object(obj, type, ptr)                                  \
  69     do {                                                                            \
  70         (ptr) = rb_check_typeddata ((obj), (type));                                 \
  71         if (RB_UNLIKELY (!(ptr))) {                                                 \
  72             VALUE cname = rb_class_name (CLASS_OF ((obj)));                         \
  73             rb_raise (rb_eRuntimeError, "%"PRIsVALUE" object destroyed", cname);    \
  74         }                                                                           \
  75     } while (0)
  76
  77 #define Data_Get_Notmuch_Object(obj, type, ptr)                 \
  78     do {                                                        \
  79         notmuch_rb_object_t *rb_wrapper;                        \
  80         Data_Get_Notmuch_Rb_Object ((obj), (type), rb_wrapper); \
  81         (ptr) = rb_wrapper->nm_object;                          \
  82     } while (0)
  83
  84 #define Data_Wrap_Notmuch_Object(klass, type, ptr) \
  85     TypedData_Wrap_Struct ((klass), (type), notmuch_rb_object_create ((ptr), "notmuch_rb_object: " __location__))
  86
  87 #define Data_Get_Notmuch_Database(obj, ptr) \
  88     Data_Get_Notmuch_Object ((obj), &notmuch_rb_database_type, (ptr))
  89
  90 #define Data_Get_Notmuch_Directory(obj, ptr) \
  91     Data_Get_Notmuch_Object ((obj), &notmuch_rb_directory_type, (ptr))
  92
  93 #define Data_Get_Notmuch_Query(obj, ptr) \
  94     Data_Get_Notmuch_Object ((obj), &notmuch_rb_query_type, (ptr))
  95
  96 #define Data_Get_Notmuch_Threads(obj, ptr) \
  97     Data_Get_Notmuch_Object ((obj), &notmuch_rb_threads_type, (ptr))
  98
  99 #define Data_Get_Notmuch_Messages(obj, ptr) \
 100     Data_Get_Notmuch_Object ((obj), &notmuch_rb_messages_type, (ptr))
 101
 102 #define Data_Get_Notmuch_Thread(obj, ptr) \
 103     Data_Get_Notmuch_Object ((obj), &notmuch_rb_thread_type, (ptr))
 104
 105 #define Data_Get_Notmuch_Message(obj, ptr) \
 106     Data_Get_Notmuch_Object ((obj), &notmuch_rb_message_type, (ptr))
 107
 108 #define Data_Get_Notmuch_Tags(obj, ptr) \
 109     Data_Get_Notmuch_Object ((obj), &notmuch_rb_tags_type, (ptr))
 110
 111 typedef struct {
 112     void *nm_object;
 113 } notmuch_rb_object_t;
 114
 115 static inline void *
 116 notmuch_rb_object_create (void *nm_object, const char *name)
 117 {
 118     notmuch_rb_object_t *rb_wrapper = talloc_named_const (NULL, sizeof (*rb_wrapper), name);
 119
 120     if (RB_UNLIKELY (!rb_wrapper))
 121         return NULL;
 122
 123     rb_wrapper->nm_object = nm_object;
 124     talloc_steal (rb_wrapper, nm_object);
 125     return rb_wrapper;
 126 }
 127
 128 static inline void
 129 notmuch_rb_object_free (void *rb_wrapper)
 130 {
 131     talloc_free (rb_wrapper);
 132 }
 133
 134 static inline void
 135 notmuch_rb_object_destroy (VALUE rb_object, const rb_data_type_t *type)
 136 {
 137     notmuch_rb_object_t *rb_wrapper;
 138
 139     Data_Get_Notmuch_Rb_Object (rb_object, type, rb_wrapper);
 140
 141     /* Call the corresponding notmuch_*_destroy function */
 142     ((void (*)(void *)) type->data) (rb_wrapper->nm_object);
 143     notmuch_rb_object_free (rb_wrapper);
 144     DATA_PTR (rb_object) = NULL;
 145 }
 146
 147 /* status.c */
 148 void
 149 notmuch_rb_status_raise (notmuch_status_t status);
 150
 151 /* database.c */
 152 VALUE
 153 notmuch_rb_database_alloc (VALUE klass);
 154
 155 VALUE
 156 notmuch_rb_database_destroy (VALUE self);
 157
 158 VALUE
 159 notmuch_rb_database_initialize (int argc, VALUE *argv, VALUE klass);
 160
 161 VALUE
 162 notmuch_rb_database_open (int argc, VALUE *argv, VALUE klass);
 163
 164 VALUE
 165 notmuch_rb_database_close (VALUE self);
 166
 167 VALUE
 168 notmuch_rb_database_path (VALUE self);
 169
 170 VALUE
 171 notmuch_rb_database_version (VALUE self);
 172
 173 VALUE
 174 notmuch_rb_database_needs_upgrade (VALUE self);
 175
 176 VALUE
 177 notmuch_rb_database_upgrade (VALUE self);
 178
 179 VALUE
 180 notmuch_rb_database_begin_atomic (VALUE self);
 181
 182 VALUE
 183 notmuch_rb_database_end_atomic (VALUE self);
 184
 185 VALUE
 186 notmuch_rb_database_get_directory (VALUE self, VALUE pathv);
 187
 188 VALUE
 189 notmuch_rb_database_add_message (VALUE self, VALUE pathv);
 190
 191 VALUE
 192 notmuch_rb_database_remove_message (VALUE self, VALUE pathv);
 193
 194 VALUE
 195 notmuch_rb_database_find_message (VALUE self, VALUE idv);
 196
 197 VALUE
 198 notmuch_rb_database_find_message_by_filename (VALUE self, VALUE pathv);
 199
 200 VALUE
 201 notmuch_rb_database_get_all_tags (VALUE self);
 202
 203 VALUE
 204 notmuch_rb_database_query_create (int argc, VALUE *argv, VALUE self);
 205
 206 /* directory.c */
 207 VALUE
 208 notmuch_rb_directory_destroy (VALUE self);
 209
 210 VALUE
 211 notmuch_rb_directory_get_mtime (VALUE self);
 212
 213 VALUE
 214 notmuch_rb_directory_set_mtime (VALUE self, VALUE mtimev);
 215
 216 VALUE
 217 notmuch_rb_directory_get_child_files (VALUE self);
 218
 219 VALUE
 220 notmuch_rb_directory_get_child_directories (VALUE self);
 221
 222 /* filenames.c */
 223 VALUE
 224 notmuch_rb_filenames_get (notmuch_filenames_t *fnames);
 225
 226 /* query.c */
 227 VALUE
 228 notmuch_rb_query_destroy (VALUE self);
 229
 230 VALUE
 231 notmuch_rb_query_get_sort (VALUE self);
 232
 233 VALUE
 234 notmuch_rb_query_set_sort (VALUE self, VALUE sortv);
 235
 236 VALUE
 237 notmuch_rb_query_get_string (VALUE self);
 238
 239 VALUE
 240 notmuch_rb_query_add_tag_exclude (VALUE self, VALUE tagv);
 241
 242 VALUE
 243 notmuch_rb_query_set_omit_excluded (VALUE self, VALUE omitv);
 244
 245 VALUE
 246 notmuch_rb_query_search_threads (VALUE self);
 247
 248 VALUE
 249 notmuch_rb_query_search_messages (VALUE self);
 250
 251 VALUE
 252 notmuch_rb_query_count_messages (VALUE self);
 253
 254 VALUE
 255 notmuch_rb_query_count_threads (VALUE self);
 256
 257 /* threads.c */
 258 VALUE
 259 notmuch_rb_threads_destroy (VALUE self);
 260
 261 VALUE
 262 notmuch_rb_threads_each (VALUE self);
 263
 264 /* messages.c */
 265 VALUE
 266 notmuch_rb_messages_destroy (VALUE self);
 267
 268 VALUE
 269 notmuch_rb_messages_each (VALUE self);
 270
 271 VALUE
 272 notmuch_rb_messages_collect_tags (VALUE self);
 273
 274 /* thread.c */
 275 VALUE
 276 notmuch_rb_thread_destroy (VALUE self);
 277
 278 VALUE
 279 notmuch_rb_thread_get_thread_id (VALUE self);
 280
 281 VALUE
 282 notmuch_rb_thread_get_total_messages (VALUE self);
 283
 284 VALUE
 285 notmuch_rb_thread_get_toplevel_messages (VALUE self);
 286
 287 VALUE
 288 notmuch_rb_thread_get_messages (VALUE self);
 289
 290 VALUE
 291 notmuch_rb_thread_get_matched_messages (VALUE self);
 292
 293 VALUE
 294 notmuch_rb_thread_get_authors (VALUE self);
 295
 296 VALUE
 297 notmuch_rb_thread_get_subject (VALUE self);
 298
 299 VALUE
 300 notmuch_rb_thread_get_oldest_date (VALUE self);
 301
 302 VALUE
 303 notmuch_rb_thread_get_newest_date (VALUE self);
 304
 305 VALUE
 306 notmuch_rb_thread_get_tags (VALUE self);
 307
 308 /* message.c */
 309 VALUE
 310 notmuch_rb_message_destroy (VALUE self);
 311
 312 VALUE
 313 notmuch_rb_message_get_message_id (VALUE self);
 314
 315 VALUE
 316 notmuch_rb_message_get_thread_id (VALUE self);
 317
 318 VALUE
 319 notmuch_rb_message_get_replies (VALUE self);
 320
 321 VALUE
 322 notmuch_rb_message_get_filename (VALUE self);
 323
 324 VALUE
 325 notmuch_rb_message_get_filenames (VALUE self);
 326
 327 VALUE
 328 notmuch_rb_message_get_flag (VALUE self, VALUE flagv);
 329
 330 VALUE
 331 notmuch_rb_message_set_flag (VALUE self, VALUE flagv, VALUE valuev);
 332
 333 VALUE
 334 notmuch_rb_message_get_date (VALUE self);
 335
 336 VALUE
 337 notmuch_rb_message_get_header (VALUE self, VALUE headerv);
 338
 339 VALUE
 340 notmuch_rb_message_get_tags (VALUE self);
 341
 342 VALUE
 343 notmuch_rb_message_add_tag (VALUE self, VALUE tagv);
 344
 345 VALUE
 346 notmuch_rb_message_remove_tag (VALUE self, VALUE tagv);
 347
 348 VALUE
 349 notmuch_rb_message_remove_all_tags (VALUE self);
 350
 351 VALUE
 352 notmuch_rb_message_maildir_flags_to_tags (VALUE self);
 353
 354 VALUE
 355 notmuch_rb_message_tags_to_maildir_flags (VALUE self);
 356
 357 VALUE
 358 notmuch_rb_message_freeze (VALUE self);
 359
 360 VALUE
 361 notmuch_rb_message_thaw (VALUE self);
 362
 363 /* tags.c */
 364 VALUE
 365 notmuch_rb_tags_get (notmuch_tags_t *tags);
 366
 367 /* init.c */
 368 void
 369 Init_notmuch (void);
 370
 371 #endif