rnd-20051126-1-src
[rocksndiamonds.git] / src / libgame / system.c
1 /***********************************************************
2 * Artsoft Retro-Game Library                               *
3 *----------------------------------------------------------*
4 * (c) 1994-2002 Artsoft Entertainment                      *
5 *               Holger Schemel                             *
6 *               Detmolder Strasse 189                      *
7 *               33604 Bielefeld                            *
8 *               Germany                                    *
9 *               e-mail: info@artsoft.org                   *
10 *----------------------------------------------------------*
11 * system.c                                                 *
12 ***********************************************************/
13
14 #include <string.h>
15 #include <signal.h>
16
17 #include "platform.h"
18
19 #if defined(PLATFORM_MSDOS)
20 #include <fcntl.h>
21 #endif
22
23 #include "system.h"
24 #include "image.h"
25 #include "sound.h"
26 #include "setup.h"
27 #include "joystick.h"
28 #include "misc.h"
29
30
31 /* ========================================================================= */
32 /* exported variables                                                        */
33 /* ========================================================================= */
34
35 struct ProgramInfo      program;
36 struct OptionInfo       options;
37 struct VideoSystemInfo  video;
38 struct AudioSystemInfo  audio;
39 struct GfxInfo          gfx;
40 struct ArtworkInfo      artwork;
41 struct JoystickInfo     joystick;
42 struct SetupInfo        setup;
43
44 LevelDirTree           *leveldir_first = NULL;
45 LevelDirTree           *leveldir_current = NULL;
46 int                     level_nr;
47
48 Display                *display = NULL;
49 Visual                 *visual = NULL;
50 int                     screen = 0;
51 Colormap                cmap = None;
52
53 DrawWindow             *window = NULL;
54 DrawBuffer             *backbuffer = NULL;
55 DrawBuffer             *drawto = NULL;
56
57 int                     button_status = MB_NOT_PRESSED;
58 boolean                 motion_status = FALSE;
59
60 int                     redraw_mask = REDRAW_NONE;
61 int                     redraw_tiles = 0;
62
63 int                     FrameCounter = 0;
64
65
66 /* ========================================================================= */
67 /* init/close functions                                                      */
68 /* ========================================================================= */
69
70 void InitProgramInfo(char *argv0,
71                      char *userdata_directory, char *program_title,
72                      char *window_title, char *icon_title,
73                      char *x11_icon_filename, char *x11_iconmask_filename,
74                      char *msdos_cursor_filename,
75                      char *cookie_prefix, char *filename_prefix,
76                      int program_version)
77 {
78   program.command_basepath = getBasePath(argv0);
79   program.command_basename = getBaseName(argv0);
80
81   program.userdata_directory = userdata_directory;
82   program.program_title = program_title;
83   program.window_title = window_title;
84   program.icon_title = icon_title;
85   program.x11_icon_filename = x11_icon_filename;
86   program.x11_iconmask_filename = x11_iconmask_filename;
87   program.msdos_cursor_filename = msdos_cursor_filename;
88
89   program.cookie_prefix = cookie_prefix;
90   program.filename_prefix = filename_prefix;
91
92   program.version_major = VERSION_MAJOR(program_version);
93   program.version_minor = VERSION_MINOR(program_version);
94   program.version_patch = VERSION_PATCH(program_version);
95 }
96
97 void InitExitFunction(void (*exit_function)(int))
98 {
99   program.exit_function = exit_function;
100
101   /* set signal handlers to custom exit function */
102   signal(SIGINT, exit_function);
103   signal(SIGTERM, exit_function);
104
105 #if defined(TARGET_SDL)
106   /* set exit function to automatically cleanup SDL stuff after exit() */
107   atexit(SDL_Quit);
108 #endif
109 }
110
111 void InitPlatformDependentStuff(void)
112 {
113 #if defined(PLATFORM_MSDOS)
114   _fmode = O_BINARY;
115   initErrorFile();
116 #endif
117
118 #if defined(TARGET_SDL)
119   if (SDL_Init(SDL_INIT_EVENTTHREAD | SDL_INIT_NOPARACHUTE) < 0)
120     Error(ERR_EXIT, "SDL_Init() failed: %s", SDL_GetError());
121
122   SDLNet_Init();
123 #endif
124 }
125
126 void ClosePlatformDependentStuff(void)
127 {
128 #if defined(PLATFORM_MSDOS)
129   dumpErrorFile();
130 #endif
131 }
132
133 void InitGfxFieldInfo(int sx, int sy, int sxsize, int sysize,
134                       int real_sx, int real_sy,
135                       int full_sxsize, int full_sysize,
136                       Bitmap *field_save_buffer)
137 {
138   gfx.sx = sx;
139   gfx.sy = sy;
140   gfx.sxsize = sxsize;
141   gfx.sysize = sysize;
142   gfx.real_sx = real_sx;
143   gfx.real_sy = real_sy;
144   gfx.full_sxsize = full_sxsize;
145   gfx.full_sysize = full_sysize;
146
147   gfx.field_save_buffer = field_save_buffer;
148
149   gfx.background_bitmap = NULL;
150   gfx.background_bitmap_mask = REDRAW_NONE;
151
152   SetDrawDeactivationMask(REDRAW_NONE);         /* do not deactivate drawing */
153   SetDrawBackgroundMask(REDRAW_NONE);           /* deactivate masked drawing */
154 }
155
156 void InitGfxDoor1Info(int dx, int dy, int dxsize, int dysize)
157 {
158   gfx.dx = dx;
159   gfx.dy = dy;
160   gfx.dxsize = dxsize;
161   gfx.dysize = dysize;
162 }
163
164 void InitGfxDoor2Info(int vx, int vy, int vxsize, int vysize)
165 {
166   gfx.vx = vx;
167   gfx.vy = vy;
168   gfx.vxsize = vxsize;
169   gfx.vysize = vysize;
170 }
171
172 void InitGfxScrollbufferInfo(int scrollbuffer_width, int scrollbuffer_height)
173 {
174   /* currently only used by MSDOS code to alloc VRAM buffer, if available */
175   gfx.scrollbuffer_width = scrollbuffer_width;
176   gfx.scrollbuffer_height = scrollbuffer_height;
177 }
178
179 void SetDrawDeactivationMask(int draw_deactivation_mask)
180 {
181   gfx.draw_deactivation_mask = draw_deactivation_mask;
182 }
183
184 void SetDrawBackgroundMask(int draw_background_mask)
185 {
186   gfx.draw_background_mask = draw_background_mask;
187 }
188
189 static void DrawBitmapFromTile(Bitmap *bitmap, Bitmap *tile,
190                                int dest_x, int dest_y, int width, int height)
191 {
192   int bitmap_xsize = width;
193   int bitmap_ysize = height;
194   int tile_xsize = tile->width;
195   int tile_ysize = tile->height;
196   int tile_xsteps = (bitmap_xsize + tile_xsize - 1) / tile_xsize;
197   int tile_ysteps = (bitmap_ysize + tile_ysize - 1) / tile_ysize;
198   int x, y;
199
200   for (y = 0; y < tile_ysteps; y++)
201   {
202     for (x = 0; x < tile_xsteps; x++)
203     {
204       int draw_x = dest_x + x * tile_xsize;
205       int draw_y = dest_y + y * tile_ysize;
206       int draw_xsize = MIN(tile_xsize, bitmap_xsize - x * tile_xsize);
207       int draw_ysize = MIN(tile_ysize, bitmap_ysize - y * tile_ysize);
208
209       BlitBitmap(tile, bitmap, 0, 0, draw_xsize, draw_ysize, draw_x, draw_y);
210     }
211   }
212 }
213
214 void SetBackgroundBitmap(Bitmap *background_bitmap_tile, int mask)
215 {
216   if (background_bitmap_tile != NULL)
217     gfx.background_bitmap_mask |= mask;
218   else
219     gfx.background_bitmap_mask &= ~mask;
220
221   if (gfx.background_bitmap == NULL)
222     gfx.background_bitmap = CreateBitmap(video.width, video.height,
223                                          DEFAULT_DEPTH);
224
225   if (background_bitmap_tile == NULL)   /* empty background requested */
226     return;
227
228   if (mask == REDRAW_FIELD)
229     DrawBitmapFromTile(gfx.background_bitmap, background_bitmap_tile,
230                        gfx.real_sx, gfx.real_sy,
231                        gfx.full_sxsize, gfx.full_sysize);
232   else if (mask == REDRAW_DOOR_1)
233   {
234     DrawBitmapFromTile(gfx.background_bitmap, background_bitmap_tile,
235                        gfx.dx, gfx.dy,
236                        gfx.dxsize, gfx.dysize);
237   }
238 }
239
240 void SetMainBackgroundBitmap(Bitmap *background_bitmap_tile)
241 {
242   SetBackgroundBitmap(background_bitmap_tile, REDRAW_FIELD);
243 }
244
245 void SetDoorBackgroundBitmap(Bitmap *background_bitmap_tile)
246 {
247   SetBackgroundBitmap(background_bitmap_tile, REDRAW_DOOR_1);
248 }
249
250
251 /* ========================================================================= */
252 /* video functions                                                           */
253 /* ========================================================================= */
254
255 inline static int GetRealDepth(int depth)
256 {
257   return (depth == DEFAULT_DEPTH ? video.default_depth : depth);
258 }
259
260 inline static void sysFillRectangle(Bitmap *bitmap, int x, int y,
261                                int width, int height, Pixel color)
262 {
263 #if defined(TARGET_SDL)
264   SDLFillRectangle(bitmap, x, y, width, height, color);
265 #else
266   X11FillRectangle(bitmap, x, y, width, height, color);
267 #endif
268 }
269
270 inline static void sysCopyArea(Bitmap *src_bitmap, Bitmap *dst_bitmap,
271                                int src_x, int src_y, int width, int height,
272                                int dst_x, int dst_y, int mask_mode)
273 {
274 #if defined(TARGET_SDL)
275   SDLCopyArea(src_bitmap, dst_bitmap, src_x, src_y, width, height,
276               dst_x, dst_y, mask_mode);
277 #else
278   X11CopyArea(src_bitmap, dst_bitmap, src_x, src_y, width, height,
279               dst_x, dst_y, mask_mode);
280 #endif
281 }
282
283 inline void InitVideoDisplay(void)
284 {
285 #if defined(TARGET_SDL)
286   SDLInitVideoDisplay();
287 #else
288   X11InitVideoDisplay();
289 #endif
290 }
291
292 inline void CloseVideoDisplay(void)
293 {
294   KeyboardAutoRepeatOn();
295
296 #if defined(TARGET_SDL)
297   SDL_QuitSubSystem(SDL_INIT_VIDEO);
298 #else
299   if (display)
300     XCloseDisplay(display);
301 #endif
302 }
303
304 inline void InitVideoBuffer(DrawBuffer **backbuffer, DrawWindow **window,
305                             int width, int height, int depth,
306                             boolean fullscreen)
307 {
308   video.width = width;
309   video.height = height;
310   video.depth = GetRealDepth(depth);
311   video.fullscreen_available = FULLSCREEN_STATUS;
312   video.fullscreen_enabled = FALSE;
313
314 #if defined(TARGET_SDL)
315   SDLInitVideoBuffer(backbuffer, window, fullscreen);
316 #else
317   X11InitVideoBuffer(backbuffer, window);
318 #endif
319 }
320
321 inline Bitmap *CreateBitmapStruct(void)
322 {
323 #if defined(TARGET_SDL)
324   return checked_calloc(sizeof(struct SDLSurfaceInfo));
325 #else
326   return checked_calloc(sizeof(struct X11DrawableInfo));
327 #endif
328 }
329
330 inline Bitmap *CreateBitmap(int width, int height, int depth)
331 {
332   Bitmap *new_bitmap = CreateBitmapStruct();
333   int real_depth = GetRealDepth(depth);
334
335 #if defined(TARGET_SDL)
336   SDLCreateBitmapContent(new_bitmap, width, height, real_depth);
337 #else
338   X11CreateBitmapContent(new_bitmap, width, height, real_depth);
339 #endif
340
341   new_bitmap->width = width;
342   new_bitmap->height = height;
343
344   return new_bitmap;
345 }
346
347 inline static void FreeBitmapPointers(Bitmap *bitmap)
348 {
349   if (bitmap == NULL)
350     return;
351
352 #if defined(TARGET_SDL)
353   SDLFreeBitmapPointers(bitmap);
354 #else
355   X11FreeBitmapPointers(bitmap);
356 #endif
357
358   checked_free(bitmap->source_filename);
359   bitmap->source_filename = NULL;
360 }
361
362 inline static void TransferBitmapPointers(Bitmap *src_bitmap,
363                                           Bitmap *dst_bitmap)
364 {
365   if (src_bitmap == NULL || dst_bitmap == NULL)
366     return;
367
368   FreeBitmapPointers(dst_bitmap);
369
370   *dst_bitmap = *src_bitmap;
371 }
372
373 inline void FreeBitmap(Bitmap *bitmap)
374 {
375   if (bitmap == NULL)
376     return;
377
378   FreeBitmapPointers(bitmap);
379
380   free(bitmap);
381 }
382
383 inline void CloseWindow(DrawWindow *window)
384 {
385 #if defined(TARGET_X11)
386   if (window->drawable)
387   {
388     XUnmapWindow(display, window->drawable);
389     XDestroyWindow(display, window->drawable);
390   }
391   if (window->gc)
392     XFreeGC(display, window->gc);
393 #endif
394 }
395
396 static inline boolean CheckDrawingArea(int x, int y, int width, int height,
397                                        int draw_mask)
398 {
399   if (draw_mask == REDRAW_NONE)
400     return FALSE;
401
402   if (draw_mask & REDRAW_ALL)
403     return TRUE;
404
405   if ((draw_mask & REDRAW_FIELD) && x < gfx.real_sx + gfx.full_sxsize)
406     return TRUE;
407
408   if ((draw_mask & REDRAW_DOOR_1) && x >= gfx.dx && y < gfx.dy + gfx.dysize)
409     return TRUE;
410
411   if ((draw_mask & REDRAW_DOOR_2) && x >= gfx.dx && y >= gfx.vy)
412     return TRUE;
413
414   return FALSE;
415 }
416
417 inline boolean DrawingDeactivated(int x, int y, int width, int height)
418 {
419   return CheckDrawingArea(x, y, width, height, gfx.draw_deactivation_mask);
420 }
421
422 inline boolean DrawingOnBackground(int x, int y)
423 {
424   return (CheckDrawingArea(x, y, 1, 1, gfx.background_bitmap_mask) &&
425           CheckDrawingArea(x, y, 1, 1, gfx.draw_background_mask));
426 }
427
428 inline void BlitBitmap(Bitmap *src_bitmap, Bitmap *dst_bitmap,
429                        int src_x, int src_y, int width, int height,
430                        int dst_x, int dst_y)
431 {
432   if (DrawingDeactivated(dst_x, dst_y, width, height))
433     return;
434
435   sysCopyArea(src_bitmap, dst_bitmap, src_x, src_y, width, height,
436               dst_x, dst_y, BLIT_OPAQUE);
437 }
438
439 inline void FillRectangle(Bitmap *bitmap, int x, int y, int width, int height,
440                           Pixel color)
441 {
442   if (DrawingDeactivated(x, y, width, height))
443     return;
444
445   sysFillRectangle(bitmap, x, y, width, height, color);
446 }
447
448 inline void ClearRectangle(Bitmap *bitmap, int x, int y, int width, int height)
449 {
450   FillRectangle(bitmap, x, y, width, height, BLACK_PIXEL);
451 }
452
453 inline void ClearRectangleOnBackground(Bitmap *bitmap, int x, int y,
454                                        int width, int height)
455 {
456   if (DrawingOnBackground(x, y))
457     BlitBitmap(gfx.background_bitmap, bitmap, x, y, width, height, x, y);
458   else
459     ClearRectangle(bitmap, x, y, width, height);
460 }
461
462 inline void SetClipMask(Bitmap *bitmap, GC clip_gc, Pixmap clip_pixmap)
463 {
464 #if defined(TARGET_X11)
465   if (clip_gc)
466   {
467     bitmap->clip_gc = clip_gc;
468     XSetClipMask(display, bitmap->clip_gc, clip_pixmap);
469   }
470 #endif
471 }
472
473 inline void SetClipOrigin(Bitmap *bitmap, GC clip_gc, int clip_x, int clip_y)
474 {
475 #if defined(TARGET_X11)
476   if (clip_gc)
477   {
478     bitmap->clip_gc = clip_gc;
479     XSetClipOrigin(display, bitmap->clip_gc, clip_x, clip_y);
480   }
481 #endif
482 }
483
484 inline void BlitBitmapMasked(Bitmap *src_bitmap, Bitmap *dst_bitmap,
485                              int src_x, int src_y,
486                              int width, int height,
487                              int dst_x, int dst_y)
488 {
489   if (DrawingDeactivated(dst_x, dst_y, width, height))
490     return;
491
492   sysCopyArea(src_bitmap, dst_bitmap, src_x, src_y, width, height,
493               dst_x, dst_y, BLIT_MASKED);
494 }
495
496 inline void BlitBitmapOnBackground(Bitmap *src_bitmap, Bitmap *dst_bitmap,
497                                    int src_x, int src_y,
498                                    int width, int height,
499                                    int dst_x, int dst_y)
500 {
501   if (DrawingOnBackground(dst_x, dst_y))
502   {
503     /* draw background */
504     BlitBitmap(gfx.background_bitmap, dst_bitmap, dst_x, dst_y, width, height,
505                dst_x, dst_y);
506
507     /* draw foreground */
508     SetClipOrigin(src_bitmap, src_bitmap->stored_clip_gc,
509                   dst_x - src_x, dst_y - src_y);
510     BlitBitmapMasked(src_bitmap, dst_bitmap, src_x, src_y, width, height,
511                      dst_x, dst_y);
512   }
513   else
514     BlitBitmap(src_bitmap, dst_bitmap, src_x, src_y, width, height,
515                dst_x, dst_y);
516 }
517
518 inline void DrawSimpleWhiteLine(Bitmap *bitmap, int from_x, int from_y,
519                                 int to_x, int to_y)
520 {
521 #if defined(TARGET_SDL)
522   SDLDrawSimpleLine(bitmap, from_x, from_y, to_x, to_y, WHITE_PIXEL);
523 #else
524   X11DrawSimpleLine(bitmap, from_x, from_y, to_x, to_y, WHITE_PIXEL);
525 #endif
526 }
527
528 #if !defined(TARGET_X11_NATIVE)
529 inline void DrawLine(Bitmap *bitmap, int from_x, int from_y,
530                      int to_x, int to_y, Pixel pixel, int line_width)
531 {
532   int x, y;
533
534   for (x = 0; x < line_width; x++)
535   {
536     for (y = 0; y < line_width; y++)
537     {
538       int dx = x - line_width / 2;
539       int dy = y - line_width / 2;
540
541       if ((x == 0 && y == 0) ||
542           (x == 0 && y == line_width - 1) ||
543           (x == line_width - 1 && y == 0) ||
544           (x == line_width - 1 && y == line_width - 1))
545         continue;
546
547 #if defined(TARGET_SDL)
548       SDLDrawLine(bitmap,
549                   from_x + dx, from_y + dy, to_x + dx, to_y + dy, pixel);
550 #elif defined(TARGET_ALLEGRO)
551       AllegroDrawLine(bitmap->drawable, from_x + dx, from_y + dy,
552                       to_x + dx, to_y + dy, pixel);
553 #endif
554     }
555   }
556 }
557 #endif
558
559 inline void DrawLines(Bitmap *bitmap, struct XY *points, int num_points,
560                       Pixel pixel)
561 {
562 #if !defined(TARGET_X11_NATIVE)
563   int line_width = 4;
564   int i;
565
566   for (i = 0; i < num_points - 1; i++)
567     DrawLine(bitmap, points[i].x, points[i].y,
568              points[i + 1].x, points[i + 1].y, pixel, line_width);
569
570   /*
571   SDLDrawLines(bitmap->surface, points, num_points, pixel);
572   */
573 #else
574   XSetForeground(display, bitmap->line_gc[1], pixel);
575   XDrawLines(display, bitmap->drawable, bitmap->line_gc[1],
576              (XPoint *)points, num_points, CoordModeOrigin);
577 #endif
578 }
579
580 inline Pixel GetPixel(Bitmap *bitmap, int x, int y)
581 {
582   if (x < 0 || x >= bitmap->width ||
583       y < 0 || y >= bitmap->height)
584     return BLACK_PIXEL;
585
586 #if defined(TARGET_SDL)
587   return SDLGetPixel(bitmap, x, y);
588 #elif defined(TARGET_ALLEGRO)
589   return AllegroGetPixel(bitmap->drawable, x, y);
590 #else
591   return X11GetPixel(bitmap, x, y);
592 #endif
593 }
594
595 inline Pixel GetPixelFromRGB(Bitmap *bitmap, unsigned int color_r,
596                              unsigned int color_g, unsigned int color_b)
597 {
598 #if defined(TARGET_SDL)
599   return SDL_MapRGB(bitmap->surface->format, color_r, color_g, color_b);
600 #elif defined(TARGET_ALLEGRO)
601   return AllegroAllocColorCell(color_r << 8, color_g << 8, color_b << 8);
602 #else
603   return X11GetPixelFromRGB(color_r, color_g, color_b);
604 #endif
605 }
606
607 inline Pixel GetPixelFromRGBcompact(Bitmap *bitmap, unsigned int color)
608 {
609   unsigned int color_r = (color >> 16) & 0xff;
610   unsigned int color_g = (color >>  8) & 0xff;
611   unsigned int color_b = (color >>  0) & 0xff;
612
613   return GetPixelFromRGB(bitmap, color_r, color_g, color_b);
614 }
615
616 /* execute all pending screen drawing operations */
617 inline void FlushDisplay(void)
618 {
619 #ifndef TARGET_SDL
620   XFlush(display);
621 #endif
622 }
623
624 /* execute and wait for all pending screen drawing operations */
625 inline void SyncDisplay(void)
626 {
627 #ifndef TARGET_SDL
628   XSync(display, FALSE);
629 #endif
630 }
631
632 inline void KeyboardAutoRepeatOn(void)
633 {
634 #if defined(TARGET_SDL)
635   SDL_EnableKeyRepeat(SDL_DEFAULT_REPEAT_DELAY / 2,
636                       SDL_DEFAULT_REPEAT_INTERVAL / 2);
637   SDL_EnableUNICODE(1);
638 #else
639   if (display)
640     XAutoRepeatOn(display);
641 #endif
642 }
643
644 inline void KeyboardAutoRepeatOff(void)
645 {
646 #if defined(TARGET_SDL)
647   SDL_EnableKeyRepeat(0, SDL_DEFAULT_REPEAT_INTERVAL);
648   SDL_EnableUNICODE(0);
649 #else
650   if (display)
651     XAutoRepeatOff(display);
652 #endif
653 }
654
655 inline boolean PointerInWindow(DrawWindow *window)
656 {
657 #if defined(TARGET_SDL)
658   return TRUE;
659 #else
660   Window root, child;
661   int root_x, root_y;
662   unsigned int mask;
663   int win_x, win_y;
664
665   /* if XQueryPointer() returns False, the pointer
666      is not on the same screen as the specified window */
667   return XQueryPointer(display, window->drawable, &root, &child,
668                        &root_x, &root_y, &win_x, &win_y, &mask);
669 #endif
670 }
671
672 inline boolean SetVideoMode(boolean fullscreen)
673 {
674 #if defined(TARGET_SDL)
675   return SDLSetVideoMode(&backbuffer, fullscreen);
676 #else
677   boolean success = TRUE;
678
679   if (fullscreen && video.fullscreen_available)
680   {
681     Error(ERR_WARN, "fullscreen not available in X11 version");
682
683     /* display error message only once */
684     video.fullscreen_available = FALSE;
685
686     success = FALSE;
687   }
688
689   return success;
690 #endif
691 }
692
693 inline boolean ChangeVideoModeIfNeeded(boolean fullscreen)
694 {
695 #if defined(TARGET_SDL)
696   if ((fullscreen && !video.fullscreen_enabled && video.fullscreen_available)||
697       (!fullscreen && video.fullscreen_enabled))
698     fullscreen = SetVideoMode(fullscreen);
699 #endif
700
701   return fullscreen;
702 }
703
704 Bitmap *LoadImage(char *filename)
705 {
706   Bitmap *new_bitmap;
707
708 #if defined(TARGET_SDL)
709   new_bitmap = SDLLoadImage(filename);
710 #else
711   new_bitmap = X11LoadImage(filename);
712 #endif
713
714   if (new_bitmap)
715     new_bitmap->source_filename = getStringCopy(filename);
716
717   return new_bitmap;
718 }
719
720 Bitmap *LoadCustomImage(char *basename)
721 {
722   char *filename = getCustomImageFilename(basename);
723   Bitmap *new_bitmap;
724
725   if (filename == NULL)
726     Error(ERR_EXIT, "LoadCustomImage(): cannot find file '%s'", basename);
727
728   if ((new_bitmap = LoadImage(filename)) == NULL)
729     Error(ERR_EXIT, "LoadImage() failed: %s", GetError());
730
731   return new_bitmap;
732 }
733
734 void ReloadCustomImage(Bitmap *bitmap, char *basename)
735 {
736   char *filename = getCustomImageFilename(basename);
737   Bitmap *new_bitmap;
738
739   if (filename == NULL)         /* (should never happen) */
740   {
741     Error(ERR_WARN, "ReloadCustomImage(): cannot find file '%s'", basename);
742     return;
743   }
744
745   if (strcmp(filename, bitmap->source_filename) == 0)
746   {
747     /* The old and new image are the same (have the same filename and path).
748        This usually means that this image does not exist in this graphic set
749        and a fallback to the existing image is done. */
750
751     return;
752   }
753
754   if ((new_bitmap = LoadImage(filename)) == NULL)
755   {
756     Error(ERR_WARN, "LoadImage() failed: %s", GetError());
757     return;
758   }
759
760   if (bitmap->width != new_bitmap->width ||
761       bitmap->height != new_bitmap->height)
762   {
763     Error(ERR_WARN, "ReloadCustomImage: new image '%s' has wrong dimensions",
764           filename);
765     FreeBitmap(new_bitmap);
766     return;
767   }
768
769   TransferBitmapPointers(new_bitmap, bitmap);
770   free(new_bitmap);
771 }
772
773 Bitmap *ZoomBitmap(Bitmap *src_bitmap, int zoom_width, int zoom_height)
774 {
775   Bitmap *dst_bitmap = CreateBitmap(zoom_width, zoom_height, DEFAULT_DEPTH);
776
777 #if defined(TARGET_SDL)
778   SDLZoomBitmap(src_bitmap, dst_bitmap);
779 #else
780   X11ZoomBitmap(src_bitmap, dst_bitmap);
781 #endif
782
783   return dst_bitmap;
784 }
785
786 void CreateBitmapWithSmallBitmaps(Bitmap *old_bitmap, int zoom_factor)
787 {
788   Bitmap swap_bitmap;
789   Bitmap *new_bitmap, *tmp_bitmap_1, *tmp_bitmap_2, *tmp_bitmap_8;
790   int width_1, height_1, width_2, height_2, width_8, height_8;
791   int new_width, new_height;
792
793   width_1  = old_bitmap->width  * zoom_factor;
794   height_1 = old_bitmap->height * zoom_factor;
795   width_2  = width_1  / 2;
796   height_2 = height_1 / 2;
797   width_8  = width_1  / 8;
798   height_8 = height_1 / 8;
799
800   /* get image with normal size (this might require scaling up) */
801   if (zoom_factor != 1)
802     tmp_bitmap_1 = ZoomBitmap(old_bitmap, width_1, height_1);
803   else
804     tmp_bitmap_1 = old_bitmap;
805
806   /* get image with 1/2 of normal size (for use in the level editor) */
807   if (zoom_factor != 2)
808     tmp_bitmap_2 = ZoomBitmap(tmp_bitmap_1, width_1 / 2, height_1 / 2);
809   else
810     tmp_bitmap_2 = old_bitmap;
811
812   /* get image with 1/8 of normal size (for use on the preview screen) */
813   if (zoom_factor != 8)
814     tmp_bitmap_8 = ZoomBitmap(tmp_bitmap_1, width_1 / 8, height_1 / 8);
815   else
816     tmp_bitmap_8 = old_bitmap;
817
818   /* if image was scaled up, create new clipmask for normal size image */
819   if (zoom_factor != 1)
820   {
821 #if defined(TARGET_X11)
822     if (old_bitmap->clip_mask)
823       XFreePixmap(display, old_bitmap->clip_mask);
824
825     old_bitmap->clip_mask =
826       Pixmap_to_Mask(tmp_bitmap_1->drawable, width_1, height_1);
827
828     XSetClipMask(display, old_bitmap->stored_clip_gc, old_bitmap->clip_mask);
829 #else
830     SDL_Surface *tmp_surface_1 = tmp_bitmap_1->surface;
831
832     if (old_bitmap->surface_masked)
833       SDL_FreeSurface(old_bitmap->surface_masked);
834
835     SDL_SetColorKey(tmp_surface_1, SDL_SRCCOLORKEY,
836                     SDL_MapRGB(tmp_surface_1->format, 0x00, 0x00, 0x00));
837     if ((old_bitmap->surface_masked = SDL_DisplayFormat(tmp_surface_1)) ==NULL)
838       Error(ERR_EXIT, "SDL_DisplayFormat() failed");
839     SDL_SetColorKey(tmp_surface_1, 0, 0);       /* reset transparent pixel */
840 #endif
841   }
842
843   new_width  = width_1;
844   new_height = height_1 + (height_1 + 1) / 2;     /* prevent odd height */
845
846   new_bitmap = CreateBitmap(new_width, new_height, DEFAULT_DEPTH);
847
848   BlitBitmap(tmp_bitmap_1, new_bitmap, 0, 0, width_1, height_1, 0, 0);
849   BlitBitmap(tmp_bitmap_2, new_bitmap, 0, 0, width_1 / 2, height_1 / 2,
850              0, height_1);
851   BlitBitmap(tmp_bitmap_8, new_bitmap, 0, 0, width_1 / 8, height_1 / 8,
852              3 * width_1 / 4, height_1);
853
854   if (zoom_factor != 1)
855     FreeBitmap(tmp_bitmap_1);
856
857   if (zoom_factor != 2)
858     FreeBitmap(tmp_bitmap_2);
859
860   if (zoom_factor != 8)
861     FreeBitmap(tmp_bitmap_8);
862
863   /* replace image with extended image (containing normal, 1/2 and 1/8 size) */
864 #if defined(TARGET_SDL)
865   swap_bitmap.surface = old_bitmap->surface;
866   old_bitmap->surface = new_bitmap->surface;
867   new_bitmap->surface = swap_bitmap.surface;
868 #else
869   swap_bitmap.drawable = old_bitmap->drawable;
870   old_bitmap->drawable = new_bitmap->drawable;
871   new_bitmap->drawable = swap_bitmap.drawable;
872 #endif
873
874   old_bitmap->width  = new_bitmap->width;
875   old_bitmap->height = new_bitmap->height;
876
877   FreeBitmap(new_bitmap);
878 }
879
880
881 /* ------------------------------------------------------------------------- */
882 /* mouse pointer functions                                                   */
883 /* ------------------------------------------------------------------------- */
884
885 #if !defined(PLATFORM_MSDOS)
886 /* XPM */
887 static const char *cursor_image_playfield[] =
888 {
889   /* width height num_colors chars_per_pixel */
890   "    16    16        3            1",
891
892   /* colors */
893   "X c #000000",
894   ". c #ffffff",
895   "  c None",
896
897 #if 1
898   /* some people complained about a "white dot" on the screen and thought it
899      was a graphical error... OK, let's just remove the whole pointer :-) */
900
901   /* pixels */
902   "                ",
903   "                ",
904   "                ",
905   "                ",
906   "                ",
907   "                ",
908   "                ",
909   "                ",
910   "                ",
911   "                ",
912   "                ",
913   "                ",
914   "                ",
915   "                ",
916   "                ",
917   "                ",
918
919   /* hot spot */
920   "0,0"
921
922 #else
923
924   /* pixels */
925   " X              ",
926   "X.X             ",
927   " X              ",
928   "                ",
929   "                ",
930   "                ",
931   "                ",
932   "                ",
933   "                ",
934   "                ",
935   "                ",
936   "                ",
937   "                ",
938   "                ",
939   "                ",
940   "                ",
941
942   /* hot spot */
943   "1,1"
944 #endif
945 };
946
947 #if defined(TARGET_SDL)
948 static const int cursor_bit_order = BIT_ORDER_MSB;
949 #elif defined(TARGET_X11_NATIVE)
950 static const int cursor_bit_order = BIT_ORDER_LSB;
951 #endif
952
953 static struct MouseCursorInfo *get_cursor_from_image(const char **image)
954 {
955   struct MouseCursorInfo *cursor;
956   boolean bit_order_msb = (cursor_bit_order == BIT_ORDER_MSB);
957   int header_lines = 4;
958   int x, y, i;
959
960   cursor = checked_calloc(sizeof(struct MouseCursorInfo));
961
962   sscanf(image[0], " %d %d ", &cursor->width, &cursor->height);
963
964   i = -1;
965   for (y = 0; y < cursor->width; y++)
966   {
967     for (x = 0; x < cursor->height; x++)
968     {
969       int bit_nr = x % 8;
970       int bit_mask = 0x01 << (bit_order_msb ? 7 - bit_nr : bit_nr );
971
972       if (bit_nr == 0)
973       {
974         i++;
975         cursor->data[i] = cursor->mask[i] = 0;
976       }
977
978       switch (image[header_lines + y][x])
979       {
980         case 'X':
981           cursor->data[i] |= bit_mask;
982           cursor->mask[i] |= bit_mask;
983           break;
984
985         case '.':
986           cursor->mask[i] |= bit_mask;
987           break;
988
989         case ' ':
990           break;
991       }
992     }
993   }
994
995   sscanf(image[header_lines + y], "%d,%d", &cursor->hot_x, &cursor->hot_y);
996
997   return cursor;
998 }
999 #endif  /* !PLATFORM_MSDOS */
1000
1001 void SetMouseCursor(int mode)
1002 {
1003 #if !defined(PLATFORM_MSDOS)
1004   static struct MouseCursorInfo *cursor_playfield = NULL;
1005
1006   if (cursor_playfield == NULL)
1007     cursor_playfield = get_cursor_from_image(cursor_image_playfield);
1008
1009 #if defined(TARGET_SDL)
1010   SDLSetMouseCursor(mode == CURSOR_PLAYFIELD ? cursor_playfield : NULL);
1011 #elif defined(TARGET_X11_NATIVE)
1012   X11SetMouseCursor(mode == CURSOR_PLAYFIELD ? cursor_playfield : NULL);
1013 #endif
1014 #endif
1015 }
1016
1017
1018 /* ========================================================================= */
1019 /* audio functions                                                           */
1020 /* ========================================================================= */
1021
1022 inline void OpenAudio(void)
1023 {
1024   /* always start with reliable default values */
1025   audio.sound_available = FALSE;
1026   audio.music_available = FALSE;
1027   audio.loops_available = FALSE;
1028
1029   audio.sound_enabled = FALSE;
1030   audio.sound_deactivated = FALSE;
1031
1032   audio.mixer_pipe[0] = audio.mixer_pipe[1] = 0;
1033   audio.mixer_pid = 0;
1034   audio.device_name = NULL;
1035   audio.device_fd = -1;
1036
1037   audio.num_channels = 0;
1038   audio.music_channel = 0;
1039   audio.first_sound_channel = 0;
1040
1041 #if defined(TARGET_SDL)
1042   SDLOpenAudio();
1043 #elif defined(PLATFORM_UNIX)
1044   UnixOpenAudio();
1045 #elif defined(PLATFORM_MSDOS)
1046   MSDOSOpenAudio();
1047 #endif
1048 }
1049
1050 inline void CloseAudio(void)
1051 {
1052 #if defined(TARGET_SDL)
1053   SDLCloseAudio();
1054 #elif defined(PLATFORM_UNIX)
1055   UnixCloseAudio();
1056 #elif defined(PLATFORM_MSDOS)
1057   MSDOSCloseAudio();
1058 #endif
1059
1060   audio.sound_enabled = FALSE;
1061 }
1062
1063 inline void SetAudioMode(boolean enabled)
1064 {
1065   if (!audio.sound_available)
1066     return;
1067
1068   audio.sound_enabled = enabled;
1069 }
1070
1071
1072 /* ========================================================================= */
1073 /* event functions                                                           */
1074 /* ========================================================================= */
1075
1076 inline void InitEventFilter(EventFilter filter_function)
1077 {
1078 #if defined(TARGET_SDL)
1079   /* set event filter to filter out certain events */
1080   SDL_SetEventFilter(filter_function);
1081 #endif
1082 }
1083
1084 inline boolean PendingEvent(void)
1085 {
1086 #if defined(TARGET_SDL)
1087   return (SDL_PollEvent(NULL) ? TRUE : FALSE);
1088 #else
1089   return (XPending(display) ? TRUE : FALSE);
1090 #endif
1091 }
1092
1093 inline void NextEvent(Event *event)
1094 {
1095 #if defined(TARGET_SDL)
1096   SDLNextEvent(event);
1097 #else
1098   XNextEvent(display, event);
1099 #endif
1100 }
1101
1102 inline void PeekEvent(Event *event)
1103 {
1104 #if defined(TARGET_SDL)
1105   SDL_PeepEvents(event, 1, SDL_PEEKEVENT, SDL_ALLEVENTS);
1106 #else
1107   XPeekEvent(display, event);
1108 #endif
1109 }
1110
1111 inline Key GetEventKey(KeyEvent *event, boolean with_modifiers)
1112 {
1113 #if defined(TARGET_SDL)
1114
1115 #if 0
1116   printf("unicode == '%d', sym == '%d', mod == '0x%04x'\n",
1117          (int)event->keysym.unicode,
1118          (int)event->keysym.sym,
1119          (int)SDL_GetModState());
1120 #endif
1121
1122   if (with_modifiers &&
1123       event->keysym.unicode > 0x0000 &&
1124       event->keysym.unicode < 0x2000)
1125     return event->keysym.unicode;
1126   else
1127     return event->keysym.sym;
1128
1129 #else
1130
1131 #if 0
1132   printf("with modifiers == '0x%04x', without modifiers == '0x%04x'\n",
1133          (int)XLookupKeysym(event, event->state),
1134          (int)XLookupKeysym(event, 0));
1135 #endif
1136
1137   if (with_modifiers)
1138     return XLookupKeysym(event, event->state);
1139   else
1140     return XLookupKeysym(event, 0);
1141 #endif
1142 }
1143
1144 inline KeyMod HandleKeyModState(Key key, int key_status)
1145 {
1146   static KeyMod current_modifiers = KMOD_None;
1147
1148 #if !defined(TARGET_SDL)
1149   if (key != KSYM_UNDEFINED)    /* new key => check for modifier key change */
1150   {
1151     KeyMod new_modifier = KMOD_None;
1152
1153     switch(key)
1154     {
1155       case KSYM_Shift_L:
1156         new_modifier = KMOD_Shift_L;
1157         break;
1158       case KSYM_Shift_R:
1159         new_modifier = KMOD_Shift_R;
1160         break;
1161       case KSYM_Control_L:
1162         new_modifier = KMOD_Control_L;
1163         break;
1164       case KSYM_Control_R:
1165         new_modifier = KMOD_Control_R;
1166         break;
1167       case KSYM_Meta_L:
1168         new_modifier = KMOD_Meta_L;
1169         break;
1170       case KSYM_Meta_R:
1171         new_modifier = KMOD_Meta_R;
1172         break;
1173       case KSYM_Alt_L:
1174         new_modifier = KMOD_Alt_L;
1175         break;
1176       case KSYM_Alt_R:
1177         new_modifier = KMOD_Alt_R;
1178         break;
1179       default:
1180         break;
1181     }
1182
1183     if (key_status == KEY_PRESSED)
1184       current_modifiers |= new_modifier;
1185     else
1186       current_modifiers &= ~new_modifier;
1187   }
1188 #endif
1189
1190   return current_modifiers;
1191 }
1192
1193 inline KeyMod GetKeyModState()
1194 {
1195 #if defined(TARGET_SDL)
1196   return (KeyMod)SDL_GetModState();
1197 #else
1198   return HandleKeyModState(KSYM_UNDEFINED, 0);
1199 #endif
1200 }
1201
1202 inline boolean CheckCloseWindowEvent(ClientMessageEvent *event)
1203 {
1204   if (event->type != EVENT_CLIENTMESSAGE)
1205     return FALSE;
1206
1207 #if defined(TARGET_SDL)
1208   return TRUE;          /* the only possible message here is SDL_QUIT */
1209 #elif defined(PLATFORM_UNIX)
1210   if ((event->window == window->drawable) &&
1211       (event->data.l[0] == XInternAtom(display, "WM_DELETE_WINDOW", FALSE)))
1212     return TRUE;
1213 #endif
1214
1215   return FALSE;
1216 }
1217
1218
1219 /* ========================================================================= */
1220 /* joystick functions                                                        */
1221 /* ========================================================================= */
1222
1223 inline void InitJoysticks()
1224 {
1225   int i;
1226
1227 #if defined(NO_JOYSTICK)
1228   return;       /* joysticks generally deactivated by compile-time directive */
1229 #endif
1230
1231   /* always start with reliable default values */
1232   joystick.status = JOYSTICK_NOT_AVAILABLE;
1233   for (i = 0; i < MAX_PLAYERS; i++)
1234     joystick.fd[i] = -1;                /* joystick device closed */
1235
1236 #if defined(TARGET_SDL)
1237   SDLInitJoysticks();
1238 #elif defined(PLATFORM_UNIX)
1239   UnixInitJoysticks();
1240 #elif defined(PLATFORM_MSDOS)
1241   MSDOSInitJoysticks();
1242 #endif
1243 }
1244
1245 inline boolean ReadJoystick(int nr, int *x, int *y, boolean *b1, boolean *b2)
1246 {
1247 #if defined(TARGET_SDL)
1248   return SDLReadJoystick(nr, x, y, b1, b2);
1249 #elif defined(PLATFORM_UNIX)
1250   return UnixReadJoystick(nr, x, y, b1, b2);
1251 #elif defined(PLATFORM_MSDOS)
1252   return MSDOSReadJoystick(nr, x, y, b1, b2);
1253 #endif
1254 }