]> git.cworth.org Git - notmuch/blob - bindings/ruby/tags.c
ruby: add tags helper
[notmuch] / bindings / ruby / tags.c
1 /* The Ruby interface to the notmuch mail library
2  *
3  * Copyright © 2010, 2011 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 #include "defs.h"
22
23 VALUE
24 notmuch_rb_tags_get (notmuch_tags_t *tags)
25 {
26     return Data_Wrap_Notmuch_Object (notmuch_rb_cTags, &notmuch_rb_tags_type, tags);
27 }
28
29 /*
30  * call-seq: TAGS.destroy! => nil
31  *
32  * Destroys the tags, freeing all resources allocated for it.
33  */
34 VALUE
35 notmuch_rb_tags_destroy (VALUE self)
36 {
37     notmuch_rb_object_destroy (self, &notmuch_rb_tags_type);
38
39     return Qnil;
40 }
41
42 /*
43  * call-seq: TAGS.each {|item| block } => TAGS
44  *
45  * Calls +block+ once for each element in +self+, passing that element as a
46  * parameter.
47  */
48 VALUE
49 notmuch_rb_tags_each (VALUE self)
50 {
51     const char *tag;
52     notmuch_tags_t *tags;
53
54     Data_Get_Notmuch_Tags (self, tags);
55
56     for (; notmuch_tags_valid (tags); notmuch_tags_move_to_next (tags)) {
57         tag = notmuch_tags_get (tags);
58         rb_yield (rb_str_new2 (tag));
59     }
60
61     return self;
62 }