]> git.wincent.com - wikitext.git/blob - ext/ary.h
Add GC_WRAP_ARY macro
[wikitext.git] / ext / ary.h
1 // Copyright 2008 Wincent Colaiuta
2 // This program is free software: you can redistribute it and/or modify
3 // it under the terms of the GNU General Public License as published by
4 // the Free Software Foundation, either version 3 of the License, or
5 // (at your option) any later version.
6 //
7 // This program is distributed in the hope that it will be useful,
8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10 // GNU General Public License for more details.
11 //
12 // You should have received a copy of the GNU General Public License
13 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
14
15 #include <ruby.h>
16
17 typedef struct
18 {
19     int     count;
20     int     max;
21     int     *entries;
22 } ary_t;
23
24 // in the test suite array count goes no higher than 25 or 26
25 #define DEFAULT_ENTRY_COUNT 64
26
27 #define NO_ITEM(item) (item == INT_MAX)
28
29 // Mark the ary struct designated by ptr as a participant in Ruby's mark-and-sweep garbage collection scheme.
30 // A variable named name is placed on the C stack to prevent the structure from being prematurely collected.
31 #define GC_WRAP_ARY(ptr, name) volatile VALUE name = Data_Wrap_Struct(rb_cObject, 0, ary_free, ptr)
32
33 inline ary_t *ary_new(void)
34 {
35     ary_t *ary      = ALLOC_N(ary_t, 1);
36     ary->count      = 0;
37     ary->max        = DEFAULT_ENTRY_COUNT;
38     ary->entries    = ALLOC_N(int, DEFAULT_ENTRY_COUNT);
39     return ary;
40 }
41
42 // this method not inlined so its address can be passed to the Data_Wrap_Struct function.
43 void ary_free(ary_t *ary);
44
45 inline int ary_entry(ary_t *ary, int idx)
46 {
47     if (idx < 0)
48         idx = ary->count + idx;
49     return (idx >= 0 && ary->count > idx) ? ary->entries[idx] : INT_MAX;
50 }
51
52 inline void ary_clear(ary_t *ary)
53 {
54     ary->count = 0;
55 }
56
57 inline int ary_pop(ary_t *ary)
58 {
59     if (ary->count > 0)
60     {
61         ary->count--;
62         return 1;
63     }
64     return 0;
65 }
66
67 inline void ary_push(ary_t *ary, int val)
68 {
69     if (ary->count == ary->max)
70     {
71         ary->max += DEFAULT_ENTRY_COUNT;
72         REALLOC_N(ary->entries, int, ary->max);
73     }
74     ary->entries[ary->count] = val;
75     ary->count++;
76 }
77
78 inline int ary_includes(ary_t *ary, int val)
79 {
80     for (int i = 0, max = ary->count; i < max; i++)
81     {
82         if (ary->entries[i] == val)
83             return 1;
84     }
85     return 0;
86 }
87
88 // returns a count indicating the number of times the value appears in the collection
89 // refactored from _Wikitext_count()
90 inline int ary_count(ary_t *ary, int item)
91 {
92     int count = 0;
93     for (int i = 0, max = ary->count; i < max; i++)
94     {
95         if (ary->entries[i] == item)
96             count++;
97     }
98     return count;
99 }
100