]> git.notmuchmail.org Git - notmuch/blob - bindings/ruby/directory.c
python: Improve documentation
[notmuch] / bindings / ruby / directory.c
1 /* The Ruby interface to the notmuch mail library
2  *
3  * Copyright © 2010 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 http://www.gnu.org/licenses/ .
17  *
18  * Author: Ali Polatel <alip@exherbo.org>
19  */
20
21 #include "defs.h"
22
23 /*
24  * call-seq: DIR.destroy => nil
25  *
26  * Destroys the directory, freeing all resources allocated for it.
27  */
28 VALUE
29 notmuch_rb_directory_destroy(VALUE self)
30 {
31     notmuch_directory_t *dir;
32
33     Data_Get_Struct(self, notmuch_directory_t, dir);
34
35     notmuch_directory_destroy(dir);
36     DATA_PTR(self) = NULL;
37
38     return Qnil;
39 }
40
41 /*
42  * call-seq: DIR.mtime => fixnum
43  *
44  * Returns the mtime of the directory or +0+ if no mtime has been previously
45  * stored.
46  */
47 VALUE
48 notmuch_rb_directory_get_mtime(VALUE self)
49 {
50     notmuch_directory_t *dir;
51
52     Data_Get_Notmuch_Directory(self, dir);
53
54     return UINT2NUM(notmuch_directory_get_mtime(dir));
55 }
56
57 /*
58  * call-seq: DIR.mtime=(fixnum) => nil
59  *
60  * Store an mtime within the database for the directory object.
61  */
62 VALUE
63 notmuch_rb_directory_set_mtime(VALUE self, VALUE mtimev)
64 {
65     notmuch_status_t ret;
66     notmuch_directory_t *dir;
67
68     Data_Get_Notmuch_Directory(self, dir);
69
70     if (!FIXNUM_P(mtimev))
71         rb_raise(rb_eTypeError, "First argument not a fixnum");
72
73     ret = notmuch_directory_set_mtime(dir, FIX2UINT(mtimev));
74     notmuch_rb_status_raise(ret);
75
76     return Qtrue;
77 }
78
79 /*
80  * call-seq: DIR.child_files => FILENAMES
81  *
82  * Return a Notmuch::FileNames object, which is an +Enumerable+ listing all the
83  * filenames of messages in the database within the given directory.
84  */
85 VALUE
86 notmuch_rb_directory_get_child_files(VALUE self)
87 {
88     notmuch_directory_t *dir;
89     notmuch_filenames_t *fnames;
90
91     Data_Get_Notmuch_Directory(self, dir);
92
93     fnames = notmuch_directory_get_child_files(dir);
94
95     return Data_Wrap_Struct(notmuch_rb_cFileNames, NULL, NULL, fnames);
96 }
97
98 /*
99  * call-seq: DIR.child_directories => FILENAMES
100  *
101  * Return a Notmuch::FileNames object, which is an +Enumerable+ listing all the
102  * directories in the database within the given directory.
103  */
104 VALUE
105 notmuch_rb_directory_get_child_directories(VALUE self)
106 {
107     notmuch_directory_t *dir;
108     notmuch_filenames_t *fnames;
109
110     Data_Get_Notmuch_Directory(self, dir);
111
112     fnames = notmuch_directory_get_child_directories(dir);
113
114     return Data_Wrap_Struct(notmuch_rb_cFileNames, NULL, NULL, fnames);
115 }