1 /***********************************************************
2 * Artsoft Retro-Game Library *
3 *----------------------------------------------------------*
4 * (c) 1994-2001 Artsoft Entertainment *
6 * Detmolder Strasse 189 *
9 * e-mail: info@artsoft.org *
10 *----------------------------------------------------------*
12 ***********************************************************/
19 #if defined(PLATFORM_MSDOS)
30 /* ========================================================================= */
31 /* exported variables */
32 /* ========================================================================= */
34 struct ProgramInfo program;
35 struct OptionInfo options;
36 struct VideoSystemInfo video;
37 struct AudioSystemInfo audio;
39 struct ArtworkInfo artwork;
40 struct JoystickInfo joystick;
41 struct SetupInfo setup;
43 LevelDirTree *leveldir_first = NULL;
44 LevelDirTree *leveldir_current = NULL;
47 Display *display = NULL;
48 Visual *visual = NULL;
52 DrawWindow *window = NULL;
53 DrawBuffer *backbuffer = NULL;
54 DrawBuffer *drawto = NULL;
56 int button_status = MB_NOT_PRESSED;
57 boolean motion_status = FALSE;
59 int redraw_mask = REDRAW_NONE;
65 /* ========================================================================= */
66 /* init/close functions */
67 /* ========================================================================= */
69 void InitCommandName(char *argv0)
71 program.command_basename =
72 (strrchr(argv0, '/') ? strrchr(argv0, '/') + 1 : argv0);
75 void InitExitFunction(void (*exit_function)(int))
77 program.exit_function = exit_function;
79 /* set signal handlers to custom exit function */
80 signal(SIGINT, exit_function);
81 signal(SIGTERM, exit_function);
83 #if defined(TARGET_SDL)
84 /* set exit function to automatically cleanup SDL stuff after exit() */
89 void InitPlatformDependantStuff(void)
91 #if defined(PLATFORM_MSDOS)
95 #if !defined(PLATFORM_UNIX)
96 program.userdata_directory = "userdata";
100 #if defined(TARGET_SDL)
101 if (SDL_Init(SDL_INIT_EVENTTHREAD | SDL_INIT_NOPARACHUTE) < 0)
102 Error(ERR_EXIT, "SDL_Init() failed: %s", SDL_GetError());
106 void ClosePlatformDependantStuff(void)
108 #if !defined(PLATFORM_UNIX)
113 void InitProgramInfo(char *unix_userdata_directory, char *program_title,
114 char *window_title, char *icon_title,
115 char *x11_icon_filename, char *x11_iconmask_filename,
116 char *msdos_pointer_filename,
117 char *cookie_prefix, char *filename_prefix,
120 #if defined(PLATFORM_UNIX)
121 program.userdata_directory = unix_userdata_directory;
123 program.userdata_directory = "userdata";
126 program.program_title = program_title;
127 program.window_title = window_title;
128 program.icon_title = icon_title;
129 program.x11_icon_filename = x11_icon_filename;
130 program.x11_iconmask_filename = x11_iconmask_filename;
131 program.msdos_pointer_filename = msdos_pointer_filename;
133 program.cookie_prefix = cookie_prefix;
134 program.filename_prefix = filename_prefix;
136 program.version_major = VERSION_MAJOR(program_version);
137 program.version_minor = VERSION_MINOR(program_version);
138 program.version_patch = VERSION_PATCH(program_version);
141 void InitGfxFieldInfo(int sx, int sy, int sxsize, int sysize,
142 int real_sx, int real_sy,
143 int full_sxsize, int full_sysize)
149 gfx.real_sx = real_sx;
150 gfx.real_sy = real_sy;
151 gfx.full_sxsize = full_sxsize;
152 gfx.full_sysize = full_sysize;
154 SetDrawDeactivationMask(REDRAW_NONE); /* do not deactivate drawing */
157 void InitGfxDoor1Info(int dx, int dy, int dxsize, int dysize)
165 void InitGfxDoor2Info(int vx, int vy, int vxsize, int vysize)
173 void InitGfxScrollbufferInfo(int scrollbuffer_width, int scrollbuffer_height)
175 /* currently only used by MSDOS code to alloc VRAM buffer, if available */
176 gfx.scrollbuffer_width = scrollbuffer_width;
177 gfx.scrollbuffer_height = scrollbuffer_height;
180 void SetDrawDeactivationMask(int draw_deactivation_mask)
182 gfx.draw_deactivation_mask = draw_deactivation_mask;
186 /* ========================================================================= */
187 /* video functions */
188 /* ========================================================================= */
190 inline static int GetRealDepth(int depth)
192 return (depth == DEFAULT_DEPTH ? video.default_depth : depth);
195 inline void InitVideoDisplay(void)
197 #if defined(TARGET_SDL)
198 SDLInitVideoDisplay();
200 X11InitVideoDisplay();
204 inline void CloseVideoDisplay(void)
206 KeyboardAutoRepeatOn();
208 #if defined(TARGET_SDL)
209 SDL_QuitSubSystem(SDL_INIT_VIDEO);
213 XCloseDisplay(display);
217 inline void InitVideoBuffer(DrawBuffer **backbuffer, DrawWindow **window,
218 int width, int height, int depth,
222 video.height = height;
223 video.depth = GetRealDepth(depth);
224 video.fullscreen_available = FULLSCREEN_STATUS;
225 video.fullscreen_enabled = FALSE;
228 SDLInitVideoBuffer(backbuffer, window, fullscreen);
230 X11InitVideoBuffer(backbuffer, window);
234 inline Bitmap *CreateBitmapStruct(void)
237 return checked_calloc(sizeof(struct SDLSurfaceInfo));
239 return checked_calloc(sizeof(struct X11DrawableInfo));
243 inline Bitmap *CreateBitmap(int width, int height, int depth)
245 Bitmap *new_bitmap = CreateBitmapStruct();
246 int real_depth = GetRealDepth(depth);
249 SDL_Surface *surface_tmp, *surface_native;
251 if ((surface_tmp = SDL_CreateRGBSurface(SURFACE_FLAGS, width, height,
252 real_depth, 0, 0, 0, 0))
254 Error(ERR_EXIT, "SDL_CreateRGBSurface() failed: %s", SDL_GetError());
256 if ((surface_native = SDL_DisplayFormat(surface_tmp)) == NULL)
257 Error(ERR_EXIT, "SDL_DisplayFormat() failed: %s", SDL_GetError());
259 SDL_FreeSurface(surface_tmp);
261 new_bitmap->surface = surface_native;
265 if ((pixmap = XCreatePixmap(display, window->drawable,
266 width, height, real_depth))
268 Error(ERR_EXIT, "cannot create pixmap");
270 new_bitmap->drawable = pixmap;
273 Error(ERR_EXIT, "Window GC needed for Bitmap -- create Window first");
275 new_bitmap->gc = window->gc;
277 new_bitmap->line_gc[0] = window->line_gc[0];
278 new_bitmap->line_gc[1] = window->line_gc[1];
284 inline void FreeBitmap(Bitmap *bitmap)
291 SDL_FreeSurface(bitmap->surface);
292 if (bitmap->surface_masked)
293 SDL_FreeSurface(bitmap->surface_masked);
295 if (bitmap->drawable)
296 XFreePixmap(display, bitmap->drawable);
297 if (bitmap->clip_mask)
298 XFreePixmap(display, bitmap->clip_mask);
299 if (bitmap->stored_clip_gc)
300 XFreeGC(display, bitmap->stored_clip_gc);
303 if (bitmap->source_filename)
304 free(bitmap->source_filename);
309 inline void CloseWindow(DrawWindow *window)
312 if (window->drawable)
314 XUnmapWindow(display, window->drawable);
315 XDestroyWindow(display, window->drawable);
318 XFreeGC(display, window->gc);
322 inline boolean DrawingDeactivated(int x, int y, int width, int height)
324 if (gfx.draw_deactivation_mask != REDRAW_NONE)
326 if ((gfx.draw_deactivation_mask & REDRAW_FIELD) &&
327 x < gfx.sx + gfx.sxsize)
334 inline void BlitBitmap(Bitmap *src_bitmap, Bitmap *dst_bitmap,
335 int src_x, int src_y,
336 int width, int height,
337 int dst_x, int dst_y)
339 if (DrawingDeactivated(dst_x, dst_y, width, height))
343 SDLCopyArea(src_bitmap, dst_bitmap,
344 src_x, src_y, width, height, dst_x, dst_y, SDLCOPYAREA_OPAQUE);
346 XCopyArea(display, src_bitmap->drawable, dst_bitmap->drawable,
347 dst_bitmap->gc, src_x, src_y, width, height, dst_x, dst_y);
351 inline void ClearRectangle(Bitmap *bitmap, int x, int y, int width, int height)
353 if (DrawingDeactivated(x, y, width, height))
357 SDLFillRectangle(bitmap, x, y, width, height, 0x000000);
359 XFillRectangle(display, bitmap->drawable, bitmap->gc, x, y, width, height);
365 static GC last_clip_gc = 0; /* needed for XCopyArea() through clip mask */
369 inline void SetClipMask(Bitmap *bitmap, GC clip_gc, Pixmap clip_pixmap)
374 bitmap->clip_gc = clip_gc;
375 XSetClipMask(display, bitmap->clip_gc, clip_pixmap);
378 last_clip_gc = clip_gc;
383 inline void SetClipOrigin(Bitmap *bitmap, GC clip_gc, int clip_x, int clip_y)
388 bitmap->clip_gc = clip_gc;
389 XSetClipOrigin(display, bitmap->clip_gc, clip_x, clip_y);
392 last_clip_gc = clip_gc;
397 inline void BlitBitmapMasked(Bitmap *src_bitmap, Bitmap *dst_bitmap,
398 int src_x, int src_y,
399 int width, int height,
400 int dst_x, int dst_y)
402 if (DrawingDeactivated(dst_x, dst_y, width, height))
406 SDLCopyArea(src_bitmap, dst_bitmap,
407 src_x, src_y, width, height, dst_x, dst_y, SDLCOPYAREA_MASKED);
409 XCopyArea(display, src_bitmap->drawable, dst_bitmap->drawable,
410 src_bitmap->clip_gc, src_x, src_y, width, height, dst_x, dst_y);
414 inline void DrawSimpleWhiteLine(Bitmap *bitmap, int from_x, int from_y,
418 SDLDrawSimpleLine(bitmap, from_x, from_y, to_x, to_y, 0xffffff);
420 XSetForeground(display, bitmap->gc, WhitePixel(display, screen));
421 XDrawLine(display, bitmap->drawable, bitmap->gc, from_x, from_y, to_x, to_y);
422 XSetForeground(display, bitmap->gc, BlackPixel(display, screen));
426 #if !defined(TARGET_X11_NATIVE)
427 inline void DrawLine(Bitmap *bitmap, int from_x, int from_y,
428 int to_x, int to_y, Pixel pixel, int line_width)
432 for (x=0; x<line_width; x++)
434 for (y=0; y<line_width; y++)
436 int dx = x - line_width / 2;
437 int dy = y - line_width / 2;
439 if ((x == 0 && y == 0) ||
440 (x == 0 && y == line_width - 1) ||
441 (x == line_width - 1 && y == 0) ||
442 (x == line_width - 1 && y == line_width - 1))
445 #if defined(TARGET_SDL)
447 from_x + dx, from_y + dy, to_x + dx, to_y + dy, pixel);
448 #elif defined(TARGET_ALLEGRO)
449 AllegroDrawLine(bitmap->drawable, from_x + dx, from_y + dy,
450 to_x + dx, to_y + dy, pixel);
457 inline void DrawLines(Bitmap *bitmap, struct XY *points, int num_points,
460 #if !defined(TARGET_X11_NATIVE)
464 for (i=0; i<num_points - 1; i++)
465 DrawLine(bitmap, points[i].x, points[i].y,
466 points[i + 1].x, points[i + 1].y, pixel, line_width);
469 SDLDrawLines(bitmap->surface, points, num_points, pixel);
472 XSetForeground(display, bitmap->line_gc[1], pixel);
473 XDrawLines(display, bitmap->drawable, bitmap->line_gc[1],
474 (XPoint *)points, num_points, CoordModeOrigin);
476 XSetForeground(display, gc, BlackPixel(display, screen));
481 inline Pixel GetPixel(Bitmap *bitmap, int x, int y)
483 #if defined(TARGET_SDL)
484 return SDLGetPixel(bitmap, x, y);
485 #elif defined(TARGET_ALLEGRO)
486 return AllegroGetPixel(bitmap->drawable, x, y);
488 unsigned long pixel_value;
491 pixel_image = XGetImage(display, bitmap->drawable, x, y, 1, 1,
493 pixel_value = XGetPixel(pixel_image, 0, 0);
495 XDestroyImage(pixel_image);
501 inline Pixel GetPixelFromRGB(Bitmap *bitmap, unsigned int color_r,
502 unsigned int color_g, unsigned int color_b)
506 #if defined(TARGET_SDL)
507 pixel = SDL_MapRGB(bitmap->surface->format, color_r, color_g, color_b);
508 #elif defined(TARGET_ALLEGRO)
509 pixel = AllegroAllocColorCell(color_r << 8, color_g << 8, color_b << 8);
510 #elif defined(TARGET_X11_NATIVE)
513 xcolor.flags = DoRed | DoGreen | DoBlue;
514 xcolor.red = (color_r << 8);
515 xcolor.green = (color_g << 8);
516 xcolor.blue = (color_b << 8);
517 XAllocColor(display, cmap, &xcolor);
518 pixel = xcolor.pixel;
524 inline Pixel GetPixelFromRGBcompact(Bitmap *bitmap, unsigned int color)
526 unsigned int color_r = (color >> 16) & 0xff;
527 unsigned int color_g = (color >> 8) & 0xff;
528 unsigned int color_b = (color >> 0) & 0xff;
530 return GetPixelFromRGB(bitmap, color_r, color_g, color_b);
533 /* execute all pending screen drawing operations */
534 inline void FlushDisplay(void)
541 /* execute and wait for all pending screen drawing operations */
542 inline void SyncDisplay(void)
545 XSync(display, FALSE);
549 inline void KeyboardAutoRepeatOn(void)
552 SDL_EnableKeyRepeat(SDL_DEFAULT_REPEAT_DELAY / 2,
553 SDL_DEFAULT_REPEAT_INTERVAL / 2);
554 SDL_EnableUNICODE(1);
557 XAutoRepeatOn(display);
561 inline void KeyboardAutoRepeatOff(void)
564 SDL_EnableKeyRepeat(0, SDL_DEFAULT_REPEAT_INTERVAL);
565 SDL_EnableUNICODE(0);
568 XAutoRepeatOff(display);
572 inline boolean PointerInWindow(DrawWindow *window)
582 /* if XQueryPointer() returns False, the pointer
583 is not on the same screen as the specified window */
584 return XQueryPointer(display, window->drawable, &root, &child,
585 &root_x, &root_y, &win_x, &win_y, &mask);
589 inline boolean SetVideoMode(boolean fullscreen)
592 return SDLSetVideoMode(&backbuffer, fullscreen);
594 boolean success = TRUE;
596 if (fullscreen && video.fullscreen_available)
598 Error(ERR_WARN, "fullscreen not available in X11 version");
600 /* display error message only once */
601 video.fullscreen_available = FALSE;
610 inline boolean ChangeVideoModeIfNeeded(boolean fullscreen)
613 if ((fullscreen && !video.fullscreen_enabled && video.fullscreen_available)||
614 (!fullscreen && video.fullscreen_enabled))
615 fullscreen = SetVideoMode(fullscreen);
621 Bitmap *LoadImage(char *filename)
625 #if defined(TARGET_SDL)
626 new_bitmap = SDLLoadImage(filename);
628 new_bitmap = X11LoadImage(filename);
631 new_bitmap->source_filename = getStringCopy(filename);
636 Bitmap *LoadCustomImage(char *basename)
638 char *filename = getCustomImageFilename(basename);
641 if (filename == NULL)
642 Error(ERR_EXIT, "LoadCustomImage(): cannot find file '%s'", basename);
644 if ((new_bitmap = LoadImage(filename)) == NULL)
645 Error(ERR_EXIT, "LoadImage() failed: %s", GetError());
650 void ReloadCustomImage(Bitmap **bitmap, char *basename)
652 char *filename = getCustomImageFilename(basename);
653 Bitmap *old_bitmap = *bitmap;
656 if (filename == NULL) /* (should never happen) */
658 Error(ERR_WARN, "ReloadCustomImage(): cannot find file '%s'", basename);
662 if (strcmp(filename, old_bitmap->source_filename) == 0)
664 /* The old and new image are the same (have the same filename and path).
665 This usually means that this image does not exist in this graphic set
666 and a fallback to the existing image is done. */
671 if ((new_bitmap = LoadImage(filename)) == NULL)
673 Error(ERR_WARN, "LoadImage() failed: %s", GetError());
677 if (old_bitmap->width != new_bitmap->width ||
678 old_bitmap->height != new_bitmap->height)
680 Error(ERR_WARN, "ReloadCustomImage: new image has wrong dimensions");
681 FreeBitmap(new_bitmap);
685 /* copy filename for new image */
686 free(old_bitmap->source_filename);
687 old_bitmap->source_filename = getStringCopy(filename);
689 /* copy bitmap data for new image */
690 BlitBitmap(new_bitmap, old_bitmap, 0,0,
691 old_bitmap->width, old_bitmap->height, 0,0);
693 FreeBitmap(new_bitmap);
697 /* ========================================================================= */
698 /* audio functions */
699 /* ========================================================================= */
701 inline void OpenAudio(void)
703 /* always start with reliable default values */
704 audio.sound_available = FALSE;
705 audio.music_available = FALSE;
706 audio.loops_available = FALSE;
707 audio.mods_available = FALSE;
708 audio.sound_enabled = FALSE;
710 audio.soundserver_pipe[0] = audio.soundserver_pipe[1] = 0;
711 audio.soundserver_pid = 0;
712 audio.device_name = NULL;
716 audio.music_channel = 0;
719 #if defined(TARGET_SDL)
721 #elif defined(PLATFORM_UNIX)
723 #elif defined(PLATFORM_MSDOS)
728 inline void CloseAudio(void)
730 #if defined(TARGET_SDL)
732 #elif defined(PLATFORM_UNIX)
734 #elif defined(PLATFORM_MSDOS)
738 audio.sound_enabled = FALSE;
741 inline void SetAudioMode(boolean enabled)
743 if (!audio.sound_available)
746 audio.sound_enabled = enabled;
750 /* ========================================================================= */
751 /* event functions */
752 /* ========================================================================= */
754 inline void InitEventFilter(EventFilter filter_function)
757 /* set event filter to filter out certain events */
758 SDL_SetEventFilter(filter_function);
762 inline boolean PendingEvent(void)
765 return (SDL_PollEvent(NULL) ? TRUE : FALSE);
767 return (XPending(display) ? TRUE : FALSE);
771 inline void NextEvent(Event *event)
776 XNextEvent(display, event);
780 inline Key GetEventKey(KeyEvent *event, boolean with_modifiers)
784 printf("unicode == '%d', sym == '%d', mod == '0x%04x'\n",
785 (int)event->keysym.unicode,
786 (int)event->keysym.sym,
787 (int)SDL_GetModState());
790 if (with_modifiers && event->keysym.unicode != 0)
791 return event->keysym.unicode;
793 return event->keysym.sym;
796 printf("with modifiers == '0x%04x', without modifiers == '0x%04x'\n",
797 (int)XLookupKeysym(event, event->state),
798 (int)XLookupKeysym(event, 0));
802 return XLookupKeysym(event, event->state);
804 return XLookupKeysym(event, 0);
808 inline boolean CheckCloseWindowEvent(ClientMessageEvent *event)
810 if (event->type != EVENT_CLIENTMESSAGE)
813 #if defined(TARGET_SDL)
814 return TRUE; /* the only possible message here is SDL_QUIT */
815 #elif defined(PLATFORM_UNIX)
816 if ((event->window == window->drawable) &&
817 (event->data.l[0] == XInternAtom(display, "WM_DELETE_WINDOW", FALSE)))
825 /* ========================================================================= */
826 /* joystick functions */
827 /* ========================================================================= */
829 inline void InitJoysticks()
834 return; /* joysticks generally deactivated by compile-time directive */
837 /* always start with reliable default values */
838 joystick.status = JOYSTICK_NOT_AVAILABLE;
839 for (i=0; i<MAX_PLAYERS; i++)
840 joystick.fd[i] = -1; /* joystick device closed */
842 #if defined(TARGET_SDL)
844 #elif defined(PLATFORM_UNIX)
846 #elif defined(PLATFORM_MSDOS)
847 MSDOSInitJoysticks();
851 inline boolean ReadJoystick(int nr, int *x, int *y, boolean *b1, boolean *b2)
853 #if defined(TARGET_SDL)
854 return SDLReadJoystick(nr, x, y, b1, b2);
855 #elif defined(PLATFORM_UNIX)
856 return UnixReadJoystick(nr, x, y, b1, b2);
857 #elif defined(PLATFORM_MSDOS)
858 return MSDOSReadJoystick(nr, x, y, b1, b2);