allegro4r 0.0.1

data/ext/a4r_API_palette_routines.c

@@ -0,0 +1,112 @@
+#include "allegro4r.h"
+
+/*
+ * call-seq:
+ *   set_palette(p) -> nil
+ *
+ * Sets the entire palette of 256 colors. You should provide an array of 256 RGB
+ * structures. Unlike set_color, there is no need to call vsync before this
+ * function. Example:
+ *   palette = PALETTE.new
+ *   ...
+ *   bmp = load_bitmap(filename, palette)
+ *   abort_on_error("Couldn't load bitmap!") if bmp.nil?
+ *   set_palette(palette)
+ */
+VALUE a4r_API_set_palette(VALUE self, VALUE p)
+{
+  // TODO: Check data type of palette? Also, allow array of 256 RGBs
+  PALETTE *pal;
+  Data_Get_Struct(p, PALETTE, pal);
+  set_palette(*pal);
+  return Qnil;
+}
+
+/*
+ * call_seq:
+ *   get_palette(p) -> nil
+ *
+ * Retrieves the entire palette of 256 colors. You should provide an array of
+ * 256 RGB structures to store it in. Example:
+ *   pal = PALETTE.new
+ *   ...
+ *   get_palette(pal)
+ */
+VALUE a4r_API_get_palette(VALUE self, VALUE p)
+{
+  // TODO: Check data type of p?
+  PALETTE *pal;
+  Data_Get_Struct(p, PALETTE, pal);
+  get_palette(*pal);
+  return Qnil;
+}
+
+/*
+ * call-seq:
+ *   default_palette -> pal
+ *
+ * The default IBM BIOS palette. This will be automatically selected whenever
+ * you set a new graphics mode. The palette contains 16 basic colors plus many
+ * gradients between them. If you want to see the values, you can write a small
+ * Allegro program which saves a screenshot with this palette, or open the
+ * grabber tool provided with Allegro and create a new palette object, which
+ * will use this palette by default.
+ */
+VALUE a4r_API_default_palette(VALUE self)
+{
+  // TODO: Convert to data struct or cached or hooked variable?
+  PALETTE *pal = &default_palette;
+  VALUE obj = Data_Wrap_Struct(cAPI_PALETTE, 0, 0, pal);
+  return obj;
+}
+
+/*
+ * call-seq:
+ *   black_palette -> pal
+ *
+ * A palette containing solid black colors, used by the fade routines.
+ */
+VALUE a4r_API_black_palette(VALUE self)
+{
+  // TODO: Convert to data struct or cached or hooked variable?
+  PALETTE *pal = &black_palette;
+  VALUE obj = Data_Wrap_Struct(cAPI_PALETTE, 0, 0, pal);
+  return obj;
+}
+
+/*
+ * call-seq:
+ *   desktop_palette -> pal
+ *
+ * The palette used by the Atari ST low resolution desktop. I'm not quite sure
+ * why this is still here, except that the grabber and test programs use it. It
+ * is probably the only Atari legacy code left in Allegro, and it would be a
+ * shame to remove it :-)
+ *
+ * The contents of this palette are 16 colors repeated 16 times. Color entry
+ * zero is equal to color entry 16, which is equal to color entry 24, etc.
+ *   Index      Color       RGB values
+ *     0     White          63  63  63
+ *     1     Red            63   0   0
+ *     2     Green           0  63   0
+ *     3     Yellow         63  63   0
+ *     4     Blue            0   0  63
+ *     5     Pink           63   0  63
+ *     6     Cyan            0  63  63
+ *     7     Grey           16  16  16
+ *     8     Light grey     31  31  31
+ *     9     Light red      63  31  31
+ *    10     Light green    31  63  31
+ *    11     Light yellow   63  63  31
+ *    12     Light blue     31  31  63
+ *    13     Light pink     63  31  63
+ *    14     Light cyan     31  63  63
+ *    15     Black           0   0   0
+ */
+VALUE a4r_API_desktop_palette(VALUE self)
+{
+  // TODO: Convert to data struct or cached or hooked variable?
+  PALETTE *pal = &desktop_palette;
+  VALUE obj = Data_Wrap_Struct(cAPI_PALETTE, 0, 0, pal);
+  return obj;
+}

data/ext/a4r_API_sound_init_routines.c

@@ -0,0 +1,29 @@
+#include "allegro4r.h"
+
+/*
+ * call-seq:
+ *   install_sound(digi, midi, cfg_path) -> int
+ *
+ * Initialises the sound module. You should normally pass DIGI_AUTODETECT and
+ * MIDI_AUTODETECT as the driver parameters to this function, in which case
+ * Allegro will read hardware settings from the current configuration file. This
+ * allows the user to select different values with the setup utility: see the
+ * config section for details. Alternatively, see the platform specific
+ * documentation for a list of the available drivers. The cfg_path parameter is
+ * only present for compatibility with previous versions of Allegro, and has no
+ * effect on anything.
+ *
+ * Return value: Returns zero if the sound is successfully installed, and -1 on
+ * failure. If it fails it will store a description of the problem in
+ * allegro_error.
+ */
+VALUE a4r_API_install_sound(VALUE self, VALUE digi, VALUE midi, VALUE cfg_path)
+{
+  char *c;
+  if (cfg_path == Qnil)
+    c = NULL;
+  else
+    c = StringValuePtr(cfg_path);
+
+  return INT2FIX(install_sound(FIX2INT(digi), FIX2INT(midi), c));
+}

data/ext/a4r_API_text_output.c

@@ -0,0 +1,178 @@
+#include "allegro4r.h"
+
+/*
+ * call-seq:
+ *   font -> a_fnt
+ *
+ * A simple 8x8 fixed size font (the mode 13h BIOS default). If you want to
+ * alter the font used by the GUI routines, change this to point to one of your
+ * own fonts. This font contains the standard ASCII (U+20 to U+7F), Latin-1
+ * (U+A1 to U+FF), and Latin Extended-A (U+0100 to U+017F) character ranges.
+ */
+VALUE a4r_API_font(VALUE self)
+{
+  // TODO: Convert to data struct or cached or hooked variable?
+  FONT *fnt = font;
+  VALUE obj = Data_Wrap_Struct(cAPI_FONT, 0, 0, fnt);
+  return obj;
+}
+
+/*
+ * call-seq:
+ *   font = fnt -> fnt
+ *
+ * See font.
+ */
+VALUE a4r_API_font_set(VALUE self, VALUE f)
+{
+  FONT *fnt;
+  Data_Get_Struct(f, FONT, fnt);
+  font = fnt;
+  return f;
+}
+
+/*
+ * call-seq:
+ *   text_length(f, str) -> int
+ *
+ * Returns the length (in pixels) of a string in the specified font. Example:
+ *   width = text_length(font, "I love spam")
+ *   ...
+ *   bmp = create_bitmap(width, height)
+ */
+VALUE a4r_API_text_length(VALUE self, VALUE f, VALUE str)
+{
+  FONT *fnt;
+  Data_Get_Struct(f, FONT, fnt);
+  return INT2FIX(text_length(fnt, StringValuePtr(str)));
+}
+
+/*
+ * call-seq:
+ *   text_height(f) -> int
+ *
+ * Returns the height (in pixels) of the specified font. Example:
+ *   height = text_height(font)
+ *   ...
+ *   bmp = create_bitmap(width, height)
+ */
+VALUE a4r_API_text_height(VALUE self, VALUE f)
+{
+  FONT *fnt;
+  Data_Get_Struct(f, FONT, fnt);
+  return INT2FIX(text_height(fnt));
+}
+
+/*
+ * call-seq:
+ *   textout_ex(bmp, f, s, x, y, color, bg) -> nil
+ *
+ * Writes the string 's' onto the bitmap at position x, y, using the specified
+ * font, foreground color and background color. If the background color is -1,
+ * then the text is written transparently. If the foreground color is -1 and a
+ * color font is in use, it will be drawn using the colors from the original
+ * font bitmap (the one you imported into the grabber program), which allows
+ * multicolored text output. For high and true color fonts, the foreground color
+ * is ignored and always treated as -1. Example:
+ *   # Show the program's version in blue letters.
+ *   textout_ex(screen, font, "v4.2.0-beta2", 10, 10,
+ *              makecol(0, 0, 255), -1)
+ */
+VALUE a4r_API_textout_ex(VALUE self, VALUE bmp, VALUE f, VALUE s, VALUE x, VALUE y, VALUE color, VALUE bg)
+{
+  BITMAP *b;
+  Data_Get_Struct(bmp, BITMAP, b);
+  FONT *fnt;
+  Data_Get_Struct(f, FONT, fnt);
+  textout_ex(b, fnt, StringValuePtr(s), FIX2INT(x), FIX2INT(y), FIX2INT(color), FIX2INT(bg));
+  return Qnil;
+}
+
+/*
+ * call-seq:
+ *   textout_centre_ex(bmp, f, s, x, y, color, bg) -> nil
+ *
+ * Like textout_ex, but interprets the x coordinate as the centre rather than
+ * the left edge of the string. Example:
+ *   # Important texts go in the middle.
+ *   width = text_length("GAME OVER")
+ *   textout_centre_ex(screen, font, "GAME OVER",
+ *                     SCREEN_W / 2, SCREEN_H / 2,
+ *                     makecol(255, 0, 0), makecol(0, 0, 0))
+ */
+VALUE a4r_API_textout_centre_ex(VALUE self, VALUE bmp, VALUE f, VALUE s, VALUE x, VALUE y, VALUE color, VALUE bg)
+{
+  BITMAP *b;
+  Data_Get_Struct(bmp, BITMAP, b);
+  FONT *fnt;
+  Data_Get_Struct(f, FONT, fnt);
+  textout_centre_ex(b, fnt, StringValuePtr(s), FIX2INT(x), FIX2INT(y), FIX2INT(color), FIX2INT(bg));
+  return Qnil;
+}
+
+/*
+ * call-seq:
+ *   textprintf_ex(bmp, f, x, y, color, by, fmt) -> nil
+ *
+ * Formatted text output, using a printf style format string. Due to an internal
+ * limitation, this function can't be used for extremely long texts. If you
+ * happen to reach this limit, you can work around it by using uszprintf and
+ * textout_ex, which don't have any. Example:
+ *   textprintf_ex(screen, font, 10, 10, makecol(255, 100, 200),
+ *                 -1, "Score: %d" % player_score)
+ */
+VALUE a4r_API_textprintf_ex(VALUE self, VALUE bmp, VALUE f, VALUE x, VALUE y, VALUE color, VALUE bg, VALUE fmt)
+{
+  // TODO: Make this actually work like printf with arbitrary number of parameters
+  BITMAP *b;
+  Data_Get_Struct(bmp, BITMAP, b);
+  FONT *fnt;
+  Data_Get_Struct(f, FONT, fnt);
+  textprintf_ex(b, fnt, FIX2INT(x), FIX2INT(y), FIX2INT(color), FIX2INT(bg), StringValuePtr(fmt));
+  return Qnil;
+}
+
+/*
+ * call-seq:
+ *   textprintf_centre_ex(bmp, f, x, y, color, bg, fmt) -> nil
+ *
+ * Like textprintf_ex, but interprets the x coordinate as the centre rather than
+ * the left edge of the string. This function shares the text length limitation
+ * of textprintf_ex. Example:
+ *   textprintf_centre_ex(screen, font, SCREEN_W / 2, 120,
+ *                        makecol(0, 100, 243), -1,
+ *                        "Your best score so far was %d!" %
+ *                        total_max_points)
+ */
+VALUE a4r_API_textprintf_centre_ex(VALUE self, VALUE bmp, VALUE f, VALUE x, VALUE y, VALUE color, VALUE bg, VALUE fmt)
+{
+  // TODO: Make this actually work like printf with arbitrary number of parameters
+  BITMAP *b;
+  Data_Get_Struct(bmp, BITMAP, b);
+  FONT *fnt;
+  Data_Get_Struct(f, FONT, fnt);
+  textprintf_centre_ex(b, fnt, FIX2INT(x), FIX2INT(y), FIX2INT(color), FIX2INT(bg), StringValuePtr(fmt));
+  return Qnil;
+}
+
+/*
+ * call-seq:
+ *   textprintf_right_ex(bmp, f, x, y, color, bg, fmt) -> nil
+ *
+ * Like textprintf_ex, but interprets the x coordinate as the right rather than
+ * the left edge of the string. This function shares the text length limitation
+ * of textprintf_ex. Example:
+ *   textprintf_right_ex(screen, font, SCREEN_W - 10, 10,
+ *                       makecol(200, 200, 20), -1,
+ *                       "%d bullets left" % player_ammo)
+ */
+VALUE a4r_API_textprintf_right_ex(VALUE self, VALUE bmp, VALUE f, VALUE x, VALUE y, VALUE color, VALUE bg, VALUE fmt)
+{
+  // TODO: Make this actually work like printf with arbitrary number of parameters
+  BITMAP *b;
+  Data_Get_Struct(bmp, BITMAP, b);
+  FONT *fnt;
+  Data_Get_Struct(f, FONT, fnt);
+  textprintf_right_ex(b, fnt, FIX2INT(x), FIX2INT(y), FIX2INT(color), FIX2INT(bg), StringValuePtr(fmt));
+  return Qnil;
+}

data/ext/a4r_API_timer_routines.c

@@ -0,0 +1,250 @@
+#include "allegro4r.h"
+
+/*
+ * call-seq:
+ *   install_timer -> int
+ *
+ * Installs the Allegro timer interrupt handler. You must do this before
+ * installing any user timer routines, and also before displaying a mouse
+ * pointer, playing FLI animations or MIDI music, and using any of the GUI
+ * routines.
+ *
+ * Return value: Returns zero on success, or a negative number on failure (but
+ * you may decide not to check the return value as this function is very
+ * unlikely to fail).
+ */
+VALUE a4r_API_install_timer(VALUE self)
+{
+  return INT2FIX(install_timer());
+}
+
+/*
+ * call-seq:
+ *   install_int(name, speed) -> int
+ *
+ * Installs a user timer handler, with the speed given as the number of
+ * milliseconds between ticks. This is the same thing as install_int_ex(name,
+ * MSEC_TO_TIMER(speed)). If you call this routine without having first
+ * installed the timer module, install_timer will be called automatically.
+ * Calling again this routine with the same timer handler as parameter allows
+ * you to adjust its speed.
+ *
+ * Return value: Returns zero on success, or a negative number if there is no
+ * room to add a new user timer.
+ *
+ * *** The Ruby method differs from the Allegro method. The Allegro method takes
+ * a function pointer as the first parameter, which it will use as the timer
+ * interrupt callback.  The Ruby method takes a name which will be used to
+ * identify a predefined counter routine which will be used as the interrupt
+ * callback. To get the value for that counter, call timer_counter_get with the
+ * name.
+ */
+VALUE a4r_API_install_int(VALUE self, VALUE name, VALUE speed)
+{
+  VALUE t_speed = LONG2NUM(MSEC_TO_TIMER(FIX2INT(speed)));
+  return a4r_API_install_int_ex(self, name, t_speed);
+}
+
+/*
+ * call-seq:
+ *   install_int_ex(name, speed) -> int
+ *
+ * Adds a function to the list of user timer handlers or, if it is already
+ * installed, retroactively adjusts its speed (i.e makes as though the speed
+ * change occurred precisely at the last tick). The speed is given in hardware
+ * clock ticks, of which there are 1193181 a second. You can convert from other
+ * time formats to hardware clock ticks with the macros:
+ *   SECS_TO_TIMER(secs)  - give the number of seconds between each tick
+ *   MSEC_TO_TIMER(msec)  - give the number of milliseconds between ticks
+ *   BPS_TO_TIMER(bps)    - give the number of ticks each second
+ *   BPM_TO_TIMER(bpm)    - give the number of ticks per minute
+ *
+ * There can only be sixteen timers in use at a time, and some other parts of
+ * Allegro (the GUI code, the mouse pointer display routines, rest, the FLI
+ * player, and the MIDI player) need to install handlers of their own, so you
+ * should avoid using too many at the same time. If you call this routine
+ * without having first installed the timer module, install_timer will be called
+ * automatically. 
+ *
+ * Return value: Returns zero on success, or a negative number if there is no
+ * room to add a new user timer.
+ *
+ * *** The Ruby method differs from the Allegro method. The Allegro method takes
+ * a function pointer as the first parameter, which it will use as the timer
+ * interrupt callback.  The Ruby method takes a name which will be used to
+ * identify a predefined counter routine which will be used as the interrupt
+ * callback. To get the value for that counter, call timer_counter_get with the
+ * name.
+ */
+VALUE a4r_API_install_int_ex(VALUE self, VALUE name, VALUE speed)
+{
+  VALUE i = find_timer_counter(name);
+  if (i == Qnil)
+  {
+    i = find_free_timer_counter();
+    rb_hash_aset(timer_counter_names, name, i);
+    timer_counters[FIX2INT(i)] = 0;
+  }
+
+  return INT2FIX(install_param_int_ex(&timer_counter_incr, (void *)&(timer_counters[FIX2INT(i)]), NUM2INT(speed)));
+}
+
+/*
+ * call-seq:
+ *   LOCK_VARIABLE(variable_name) -> nil
+ *
+ * Due to interrupts, you are required to lock all the memory used by your timer
+ * routines. See the description of install_int_ex for a more detailed
+ * explanation and usage example.
+ *
+ * *** The Ruby method differs from the Allegro method. Due to the use of
+ * predefined timer routines, LOCK_VARIABLE and LOCK_FUNCTION do nothing, and
+ * are here simply for API consistency. They will raise warnings if the Ruby
+ * script is run with -w.
+ */
+VALUE a4r_API_LOCK_VARIABLE(VALUE self, VALUE variable_name)
+{
+  rb_warning("Allegro4r::API::LOCK_VARIABLE does nothing.");
+  return Qnil;
+}
+
+/*
+ * call-seq:
+ *   LOCK_FUNCTION(function_name) -> nil
+ *
+ * See LOCK_VARIABLE.
+ */
+VALUE a4r_API_LOCK_FUNCTION(VALUE self, VALUE function_name)
+{
+  rb_warning("Allegro4r::API::LOCK_FUNCTION does nothing.");
+  return Qnil;
+}
+
+/*
+ * call-seq:
+ *   retrace_count -> int
+ *
+ * If the retrace simulator is installed, this count is incremented on each
+ * vertical retrace; otherwise, if the refresh rate is known, the count is
+ * incremented at the same rate (ignoring retraces); otherwise, it is
+ * incremented 70 times a second. This provides a way of controlling the speed
+ * of your program without installing user timer functions.
+ */
+VALUE a4r_API_retrace_count(VALUE self)
+{
+  // TODO: Convert to data struct or cached or hooked variable?
+  return INT2FIX(retrace_count);
+}
+
+/*
+ * call-seq:
+ *   rest(time) -> nil
+ *
+ * This function waits for the specified number of milliseconds.
+ *
+ * Passing 0 as parameter will not wait, but just yield. This can be useful in
+ * order to "play nice" with other processes. Other values will cause CPU time
+ * to be dropped on most platforms. This will look better to users, and also
+ * does things like saving battery power and making fans less noisy.
+ *
+ * Note that calling this inside your active game loop is a bad idea, as you
+ * never know when the OS will give you the CPU back, so you could end up
+ * missing the vertical retrace and skipping frames. On the other hand, on
+ * multitasking operating systems it is good form to give up the CPU for a while
+ * if you will not be using it.
+ */
+VALUE a4r_API_rest(VALUE self, VALUE time)
+{
+  rest(NUM2UINT(time));
+  return Qnil;
+}
+
+/*
+ * call-seq:
+ *   SECS_TO_TIMER(secs) -> num
+ *
+ * Give the number of seconds between each tick
+ */
+VALUE a4r_API_SECS_TO_TIMER(VALUE self, VALUE secs)
+{
+  return LONG2NUM(SECS_TO_TIMER(NUM2LONG(secs)));
+}
+
+/*
+ * call-seq:
+ *   MSEC_TO_TIMER(msec) -> num
+ *
+ * Give the number of milliseconds between ticks
+ */
+VALUE a4r_API_MSEC_TO_TIMER(VALUE self, VALUE msec)
+{
+  return LONG2NUM(MSEC_TO_TIMER(NUM2LONG(msec)));
+}
+
+/*
+ * call-seq:
+ *   BPS_TO_TIMER(bps) -> num
+ *
+ * Give the number of ticks each second
+ */
+VALUE a4r_API_BPS_TO_TIMER(VALUE self, VALUE bps)
+{
+  return LONG2NUM(BPS_TO_TIMER(NUM2LONG(bps)));
+}
+
+/*
+ * call-seq:
+ *   BPM_TO_TIMER(bpm) -> num
+ *
+ * Give the number of ticks per minute
+ */
+VALUE a4r_API_BPM_TO_TIMER(VALUE self, VALUE bpm)
+{
+  return LONG2NUM(BPM_TO_TIMER(NUM2LONG(bpm)));
+}
+
+/******************************************************************************/
+// Predefined timer counter routines
+
+VALUE timer_counter_names;
+volatile int timer_counters[MAX_TIMER_COUNTERS];
+
+void timer_counter_incr(void *param)
+{
+  *((int *)param) += 1;
+}
+END_OF_FUNCTION(timer_counter_incr)
+
+VALUE find_timer_counter(VALUE name)
+{
+  return rb_hash_aref(timer_counter_names, name);
+}
+
+VALUE find_free_timer_counter()
+{
+  int i;
+  ID f = rb_intern("has_value?");
+  for (i = 0; i < MAX_TIMER_COUNTERS; i++)
+    if (rb_funcall(timer_counter_names, f, 1, INT2FIX(i)) == Qfalse)
+      break;
+
+  if (i == MAX_TIMER_COUNTERS)
+    return Qnil;
+  return INT2FIX(i);
+}
+
+/*
+ * call-seq:
+ *   timer_counter_get(name) -> int
+ *
+ * Returns the value of the specified timer counter.
+ * 
+ * *** This is not an Allegro method. See the Ruby note under install_int_ex.
+ */
+VALUE a4r_API_timer_counter_get(VALUE self, VALUE name)
+{
+  VALUE i = find_timer_counter(name);
+  if (i == Qnil)
+    return i;
+  return INT2FIX(timer_counters[FIX2INT(i)]);
+}