2 * $Id: ext.c 36 2005-05-11 17:19:38Z tilman $
4 * Copyright (c) 2005 Tilman Sauerbeck (tilman at code-monkey de)
6 * Permission is hereby granted, free of charge, to any person obtaining
7 * a copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sublicense, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice shall be
15 * included in all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
21 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
22 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
23 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29 #define CHECK_KEY(key) \
30 if (rb_funcall (key, id_include, 1, INT2FIX (0)) == Qtrue) \
31 rb_raise (rb_eArgError, "key must not contain binary zeroes");
33 #define CHECK_CLOSED(ef) \
35 rb_raise (rb_eIOError, "closed stream");
37 #ifdef WORDS_BIGENDIAN
39 ((((x) & 0xff000000) >> 24) | (((x) & 0x00ff0000) >> 8) | \
40 (((x) & 0x0000ff00) << 8) | (((x) & 0x000000ff) << 24))
41 #else /* !WORDS_BIGENDIAN */
42 # define BSWAP32(x) (x)
43 #endif /* WORDS_BIGENDIAN */
45 static VALUE c_close (VALUE self);
47 static VALUE id_include;
50 c_free (Eet_File **ef)
67 return Data_Make_Struct (klass, Eet_File *, NULL, c_free, ef);
72 * Eet::File.open(file [, mode] ) -> ef or nil
73 * Eet::File.open(file [, mode] ) { |ef| block } -> nil
75 * If a block isn't specified, Eet::File.open is a synonym for
77 * If a block is given, it will be invoked with the
78 * Eet::File object as a parameter, and the file will be
79 * automatically closed when the block terminates. The call always
80 * returns +nil+ in this case.
83 c_open (int argc, VALUE *argv, VALUE klass)
85 VALUE obj = rb_class_new_instance (argc, argv, klass);
87 if (rb_block_given_p ())
88 return rb_ensure (rb_yield, obj, c_close, obj);
95 * Eet::File.new(file [, mode] ) -> ef or nil
97 * Creates an Eet::File object for _file_.
99 * _file_ is opened with the specified mode (defaulting to "r").
100 * Possible values for _mode_ are "r" for read-only access,
101 * "w" for write-only access and "r+" for read/write access.
104 c_init (int argc, VALUE *argv, VALUE self)
106 VALUE file = Qnil, mode = Qnil;
107 Eet_File **ef = NULL;
108 Eet_File_Mode m = EET_FILE_MODE_READ;
109 const char *tmp, *cfile;
111 Data_Get_Struct (self, Eet_File *, ef);
113 rb_scan_args (argc, argv, "11", &file, &mode);
115 cfile = StringValuePtr (file);
118 tmp = StringValuePtr (mode);
119 if (!strcmp (tmp, "r+"))
120 m = EET_FILE_MODE_READ_WRITE;
121 else if (!strcmp (tmp, "w"))
122 m = EET_FILE_MODE_WRITE;
123 else if (strcmp (tmp, "r"))
124 rb_raise (rb_eArgError, "illegal access mode %s", tmp);
129 *ef = eet_open (cfile, m);
132 case EET_FILE_MODE_READ_WRITE:
133 case EET_FILE_MODE_WRITE:
134 tmp = "Permission denied - %s";
137 tmp = "File not found - %s";
141 rb_raise (rb_eRuntimeError, tmp, cfile);
151 * Closes _ef_ and flushes any pending writes.
152 * _ef_ is unavailable for any further data operations;
153 * an +IOError+ is raised if such an attempt is made.
155 * Eet::File objects are automatically closed when they
156 * are claimed by the garbage collector.
161 Eet_File **ef = NULL;
163 Data_Get_Struct (self, Eet_File *, ef);
176 * ef.list([glob]) -> array
178 * Returns an Array of entries in _ef_ that match the shell glob
179 * _glob_ (defaulting to "*").
182 c_list (int argc, VALUE *argv, VALUE self)
184 VALUE glob = Qnil, ret;
185 Eet_File **ef = NULL;
186 char **entries, *tmp = "*";
189 Data_Get_Struct (self, Eet_File *, ef);
192 switch (eet_mode_get (*ef)) {
193 case EET_FILE_MODE_READ:
194 case EET_FILE_MODE_READ_WRITE:
197 rb_raise (rb_eIOError, "cannot list entries");
200 rb_scan_args (argc, argv, "01", &glob);
203 tmp = StringValuePtr (glob);
207 entries = eet_list (*ef, tmp, &count);
209 for (i = 0; i < count; i++)
210 rb_ary_push (ret, rb_str_new2 (entries[i]));
219 * ef.delete(key) -> ef
221 * Deletes the entry from _ef_ that is stored as _key_.
222 * If the entry cannot be deleted, an +IOError+ is raised,
223 * otherwise _ef_ is returned.
226 c_delete (VALUE self, VALUE key)
228 Eet_File **ef = NULL;
231 Data_Get_Struct (self, Eet_File *, ef);
234 ckey = StringValuePtr (key);
237 if (!eet_delete (*ef, ckey))
238 rb_raise (rb_eIOError, "cannot delete entry - %s", ckey);
245 * ef.read(key) -> string
247 * Reads an entry from _ef_ that is stored as _key_.
248 * If the data cannot be read, an +IOError+ is raised,
249 * otherwise a String is returned that contains the data.
252 c_read (VALUE self, VALUE key)
255 Eet_File **ef = NULL;
260 Data_Get_Struct (self, Eet_File *, ef);
263 ckey = StringValuePtr (key);
266 data = eet_read (*ef, ckey, &size);
268 rb_raise (rb_eIOError, "cannot read entry - %s", ckey);
270 ret = rb_str_new (data, size);
279 * ef.write(key, data [, compress] ) -> integer
281 * Stores _data_ in _ef_ as _key_.
282 * If _compress_ is true (which is the default), the data will be
284 * If the data cannot be written, an +IOError+ is raised,
285 * otherwise a the number of bytes written is returned.
288 c_write (int argc, VALUE *argv, VALUE self)
290 VALUE key = Qnil, buf = Qnil, comp = Qnil;
291 Eet_File **ef = NULL;
295 Data_Get_Struct (self, Eet_File *, ef);
298 rb_scan_args (argc, argv, "21", &key, &buf, &comp);
303 ckey = StringValuePtr (key);
305 cbuf = StringValuePtr (buf);
307 n = eet_write (*ef, ckey,
308 cbuf, RSTRING (buf)->len,
311 rb_raise (rb_eIOError, "couldn't write to file");
318 * ef.read_image(key) -> array
320 * Reads an image entry from _ef_ that is stored as _key_.
321 * If the data cannot be read, an +IOError+ is raised,
322 * otherwise an Array is returned that contains the image data,
323 * the image width, the image height, a boolean that indicates
324 * whether the image has an alpha channel or not and a hash
325 * that contains the compression options that were used to store
326 * the image (see Eet::File#write_image).
329 c_read_image (VALUE self, VALUE key)
332 Eet_File **ef = NULL;
335 int w = 0, h = 0, has_alpha = 0, level = 0, quality = 0, lossy = 0;
337 Data_Get_Struct (self, Eet_File *, ef);
340 ckey = StringValuePtr (key);
343 data = eet_data_image_read (*ef, ckey, &w, &h,
344 &has_alpha, &level, &quality,
347 rb_raise (rb_eIOError, "cannot read entry - %s", ckey);
349 comp = rb_hash_new ();
350 rb_hash_aset (comp, ID2SYM (rb_intern ("lossy")), INT2FIX (lossy));
351 rb_hash_aset (comp, ID2SYM (rb_intern ("level")), INT2FIX (level));
352 rb_hash_aset (comp, ID2SYM (rb_intern ("quality")), INT2FIX (quality));
354 ret = rb_ary_new3 (5, rb_str_new (data, w * h * 4),
355 INT2FIX (w), INT2FIX (h),
356 has_alpha ? Qtrue : Qfalse, comp);
364 * ef.write_image(key, image_data, w, h [, alpha] [, comp] ) -> integer
366 * Stores _image_data_ with width _w_ and height _h_ in _ef_ as _key_.
367 * Pass true for _alpha_ if the image contains an alpha channel.
368 * You can control how the image is compressed by passing _comp_, which
369 * is a hash whose :lossy entry is true if the image should be
370 * compressed lossily. If :lossy is true, the :quality entry
371 * (0-100, default 100) sets the compression quality.
372 * If :lossy is false, the :level entry (0-9, default 9) sets the
373 * compression level. If _comp_ isn't passed, then the
374 * image is stored losslessly.
375 * If the data cannot be written, an +IOError+ is raised,
376 * otherwise a the number of bytes written is returned.
379 c_write_image (int argc, VALUE *argv, VALUE self)
381 VALUE key = Qnil, buf = Qnil, w = Qnil, h = Qnil, has_alpha = Qnil;
382 VALUE comp = Qnil, tmp;
383 Eet_File **ef = NULL;
385 int n, lossy = 0, level = 9, quality = 100;
387 Data_Get_Struct (self, Eet_File *, ef);
390 rb_scan_args (argc, argv, "42", &key, &buf, &w, &h, &has_alpha,
393 if (NIL_P (has_alpha))
396 ckey = StringValuePtr (key);
398 cbuf = StringValuePtr (buf);
399 Check_Type (w, T_FIXNUM);
400 Check_Type (h, T_FIXNUM);
403 Check_Type (comp, T_HASH);
405 tmp = rb_hash_aref (comp, ID2SYM (rb_intern ("lossy")));
407 lossy = FIX2INT (tmp);
409 tmp = rb_hash_aref (comp, ID2SYM (rb_intern ("level")));
411 level = FIX2INT (tmp);
413 tmp = rb_hash_aref (comp, ID2SYM (rb_intern ("quality")));
415 quality = FIX2INT (tmp);
418 if (!RSTRING (buf)->len)
421 n = eet_data_image_write (*ef, ckey, cbuf,
422 FIX2INT (w), FIX2INT (h),
424 level, quality, lossy);
426 rb_raise (rb_eIOError, "couldn't write to file");
432 stream_serialize (VALUE self)
435 struct RArray *stream;
436 static ID id_serialize;
439 ret = rb_str_new2 ("");
441 stream = RARRAY (self);
446 id_serialize = rb_intern ("serialize");
448 for (i = 0; i < stream->len; i++) {
449 VALUE str = rb_funcall (stream->ptr[i], id_serialize, 0, NULL);
451 rb_str_append (ret, str);
458 chunk_serialize (VALUE self)
461 unsigned int size, buf_len;
463 struct RString *tag, *data;
464 static ID id_tag, id_data;
467 id_tag = rb_intern ("@tag");
470 id_data = rb_intern ("@data");
472 tmp = rb_ivar_get (self, id_tag);
476 tmp = rb_ivar_get (self, id_data);
478 data = RSTRING (tmp);
480 buf_len = 9 + tag->len + data->len;
481 ret = rb_str_buf_new (buf_len);
483 buf = RSTRING (ret)->ptr;
484 RSTRING (ret)->len = buf_len;
486 memcpy (buf, "CHnK", 4);
489 size = tag->len + data->len + 1;
490 size = BSWAP32 (size);
491 memcpy (buf, &size, 4);
494 memcpy (buf, tag->ptr, tag->len);
499 memcpy (buf, data->ptr, data->len);
509 m = rb_define_module ("Eet");
511 c = rb_define_class_under (m, "File", rb_cObject);
512 rb_define_alloc_func (c, c_alloc);
513 rb_define_singleton_method (c, "open", c_open, -1);
514 rb_define_method (c, "initialize", c_init, -1);
515 rb_define_method (c, "close", c_close, 0);
516 rb_define_method (c, "list", c_list, -1);
517 rb_define_method (c, "delete", c_delete, 1);
518 rb_define_method (c, "read", c_read, 1);
519 rb_define_method (c, "write", c_write, -1);
520 rb_define_method (c, "read_image", c_read_image, 1);
521 rb_define_method (c, "write_image", c_write_image, -1);
523 c = rb_define_class_under (m, "Stream", rb_cArray);
524 rb_define_method (c, "serialize", stream_serialize, 0);
526 c = rb_define_class_under (m, "Chunk", rb_cObject);
527 rb_define_method (c, "serialize", chunk_serialize, 0);
529 id_include = rb_intern ("include?");