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 static void FreeBitmapPointers(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);
301 /* the other GCs are only pointers to GCs used elsewhere */
304 if (bitmap->source_filename)
305 free(bitmap->source_filename);
308 inline void TransferBitmapPointers(Bitmap *src_bitmap, Bitmap *dst_bitmap)
310 if (src_bitmap == NULL || dst_bitmap == NULL)
313 FreeBitmapPointers(dst_bitmap);
315 *dst_bitmap = *src_bitmap;
318 inline void FreeBitmap(Bitmap *bitmap)
323 FreeBitmapPointers(bitmap);
328 inline void CloseWindow(DrawWindow *window)
331 if (window->drawable)
333 XUnmapWindow(display, window->drawable);
334 XDestroyWindow(display, window->drawable);
337 XFreeGC(display, window->gc);
341 inline boolean DrawingDeactivated(int x, int y, int width, int height)
343 if (gfx.draw_deactivation_mask != REDRAW_NONE)
345 if ((gfx.draw_deactivation_mask & REDRAW_FIELD) &&
346 x < gfx.sx + gfx.sxsize)
353 inline void BlitBitmap(Bitmap *src_bitmap, Bitmap *dst_bitmap,
354 int src_x, int src_y,
355 int width, int height,
356 int dst_x, int dst_y)
358 if (DrawingDeactivated(dst_x, dst_y, width, height))
362 SDLCopyArea(src_bitmap, dst_bitmap,
363 src_x, src_y, width, height, dst_x, dst_y, SDLCOPYAREA_OPAQUE);
365 XCopyArea(display, src_bitmap->drawable, dst_bitmap->drawable,
366 dst_bitmap->gc, src_x, src_y, width, height, dst_x, dst_y);
370 inline void ClearRectangle(Bitmap *bitmap, int x, int y, int width, int height)
372 if (DrawingDeactivated(x, y, width, height))
376 SDLFillRectangle(bitmap, x, y, width, height, 0x000000);
378 XFillRectangle(display, bitmap->drawable, bitmap->gc, x, y, width, height);
384 static GC last_clip_gc = 0; /* needed for XCopyArea() through clip mask */
388 inline void SetClipMask(Bitmap *bitmap, GC clip_gc, Pixmap clip_pixmap)
393 bitmap->clip_gc = clip_gc;
394 XSetClipMask(display, bitmap->clip_gc, clip_pixmap);
397 last_clip_gc = clip_gc;
402 inline void SetClipOrigin(Bitmap *bitmap, GC clip_gc, int clip_x, int clip_y)
407 bitmap->clip_gc = clip_gc;
408 XSetClipOrigin(display, bitmap->clip_gc, clip_x, clip_y);
411 last_clip_gc = clip_gc;
416 inline void BlitBitmapMasked(Bitmap *src_bitmap, Bitmap *dst_bitmap,
417 int src_x, int src_y,
418 int width, int height,
419 int dst_x, int dst_y)
421 if (DrawingDeactivated(dst_x, dst_y, width, height))
425 SDLCopyArea(src_bitmap, dst_bitmap,
426 src_x, src_y, width, height, dst_x, dst_y, SDLCOPYAREA_MASKED);
428 XCopyArea(display, src_bitmap->drawable, dst_bitmap->drawable,
429 src_bitmap->clip_gc, src_x, src_y, width, height, dst_x, dst_y);
433 inline void DrawSimpleWhiteLine(Bitmap *bitmap, int from_x, int from_y,
437 SDLDrawSimpleLine(bitmap, from_x, from_y, to_x, to_y, 0xffffff);
439 XSetForeground(display, bitmap->gc, WhitePixel(display, screen));
440 XDrawLine(display, bitmap->drawable, bitmap->gc, from_x, from_y, to_x, to_y);
441 XSetForeground(display, bitmap->gc, BlackPixel(display, screen));
445 #if !defined(TARGET_X11_NATIVE)
446 inline void DrawLine(Bitmap *bitmap, int from_x, int from_y,
447 int to_x, int to_y, Pixel pixel, int line_width)
451 for (x=0; x<line_width; x++)
453 for (y=0; y<line_width; y++)
455 int dx = x - line_width / 2;
456 int dy = y - line_width / 2;
458 if ((x == 0 && y == 0) ||
459 (x == 0 && y == line_width - 1) ||
460 (x == line_width - 1 && y == 0) ||
461 (x == line_width - 1 && y == line_width - 1))
464 #if defined(TARGET_SDL)
466 from_x + dx, from_y + dy, to_x + dx, to_y + dy, pixel);
467 #elif defined(TARGET_ALLEGRO)
468 AllegroDrawLine(bitmap->drawable, from_x + dx, from_y + dy,
469 to_x + dx, to_y + dy, pixel);
476 inline void DrawLines(Bitmap *bitmap, struct XY *points, int num_points,
479 #if !defined(TARGET_X11_NATIVE)
483 for (i=0; i<num_points - 1; i++)
484 DrawLine(bitmap, points[i].x, points[i].y,
485 points[i + 1].x, points[i + 1].y, pixel, line_width);
488 SDLDrawLines(bitmap->surface, points, num_points, pixel);
491 XSetForeground(display, bitmap->line_gc[1], pixel);
492 XDrawLines(display, bitmap->drawable, bitmap->line_gc[1],
493 (XPoint *)points, num_points, CoordModeOrigin);
495 XSetForeground(display, gc, BlackPixel(display, screen));
500 inline Pixel GetPixel(Bitmap *bitmap, int x, int y)
502 #if defined(TARGET_SDL)
503 return SDLGetPixel(bitmap, x, y);
504 #elif defined(TARGET_ALLEGRO)
505 return AllegroGetPixel(bitmap->drawable, x, y);
507 unsigned long pixel_value;
510 pixel_image = XGetImage(display, bitmap->drawable, x, y, 1, 1,
512 pixel_value = XGetPixel(pixel_image, 0, 0);
514 XDestroyImage(pixel_image);
520 inline Pixel GetPixelFromRGB(Bitmap *bitmap, unsigned int color_r,
521 unsigned int color_g, unsigned int color_b)
525 #if defined(TARGET_SDL)
526 pixel = SDL_MapRGB(bitmap->surface->format, color_r, color_g, color_b);
527 #elif defined(TARGET_ALLEGRO)
528 pixel = AllegroAllocColorCell(color_r << 8, color_g << 8, color_b << 8);
529 #elif defined(TARGET_X11_NATIVE)
532 xcolor.flags = DoRed | DoGreen | DoBlue;
533 xcolor.red = (color_r << 8);
534 xcolor.green = (color_g << 8);
535 xcolor.blue = (color_b << 8);
536 XAllocColor(display, cmap, &xcolor);
537 pixel = xcolor.pixel;
543 inline Pixel GetPixelFromRGBcompact(Bitmap *bitmap, unsigned int color)
545 unsigned int color_r = (color >> 16) & 0xff;
546 unsigned int color_g = (color >> 8) & 0xff;
547 unsigned int color_b = (color >> 0) & 0xff;
549 return GetPixelFromRGB(bitmap, color_r, color_g, color_b);
552 /* execute all pending screen drawing operations */
553 inline void FlushDisplay(void)
560 /* execute and wait for all pending screen drawing operations */
561 inline void SyncDisplay(void)
564 XSync(display, FALSE);
568 inline void KeyboardAutoRepeatOn(void)
571 SDL_EnableKeyRepeat(SDL_DEFAULT_REPEAT_DELAY / 2,
572 SDL_DEFAULT_REPEAT_INTERVAL / 2);
573 SDL_EnableUNICODE(1);
576 XAutoRepeatOn(display);
580 inline void KeyboardAutoRepeatOff(void)
583 SDL_EnableKeyRepeat(0, SDL_DEFAULT_REPEAT_INTERVAL);
584 SDL_EnableUNICODE(0);
587 XAutoRepeatOff(display);
591 inline boolean PointerInWindow(DrawWindow *window)
601 /* if XQueryPointer() returns False, the pointer
602 is not on the same screen as the specified window */
603 return XQueryPointer(display, window->drawable, &root, &child,
604 &root_x, &root_y, &win_x, &win_y, &mask);
608 inline boolean SetVideoMode(boolean fullscreen)
611 return SDLSetVideoMode(&backbuffer, fullscreen);
613 boolean success = TRUE;
615 if (fullscreen && video.fullscreen_available)
617 Error(ERR_WARN, "fullscreen not available in X11 version");
619 /* display error message only once */
620 video.fullscreen_available = FALSE;
629 inline boolean ChangeVideoModeIfNeeded(boolean fullscreen)
632 if ((fullscreen && !video.fullscreen_enabled && video.fullscreen_available)||
633 (!fullscreen && video.fullscreen_enabled))
634 fullscreen = SetVideoMode(fullscreen);
640 Bitmap *LoadImage(char *filename)
644 #if defined(TARGET_SDL)
645 new_bitmap = SDLLoadImage(filename);
647 new_bitmap = X11LoadImage(filename);
650 new_bitmap->source_filename = getStringCopy(filename);
655 Bitmap *LoadCustomImage(char *basename)
657 char *filename = getCustomImageFilename(basename);
660 if (filename == NULL)
661 Error(ERR_EXIT, "LoadCustomImage(): cannot find file '%s'", basename);
663 if ((new_bitmap = LoadImage(filename)) == NULL)
664 Error(ERR_EXIT, "LoadImage() failed: %s", GetError());
669 Bitmap *ReloadCustomImage(Bitmap **bitmap, char *basename)
671 char *filename = getCustomImageFilename(basename);
672 Bitmap *old_bitmap = *bitmap;
675 if (filename == NULL) /* (should never happen) */
677 Error(ERR_WARN, "ReloadCustomImage(): cannot find file '%s'", basename);
681 if (strcmp(filename, old_bitmap->source_filename) == 0)
683 /* The old and new image are the same (have the same filename and path).
684 This usually means that this image does not exist in this graphic set
685 and a fallback to the existing image is done. */
690 if ((new_bitmap = LoadImage(filename)) == NULL)
692 Error(ERR_WARN, "LoadImage() failed: %s", GetError());
696 if (old_bitmap->width != new_bitmap->width ||
697 old_bitmap->height != new_bitmap->height)
699 Error(ERR_WARN, "ReloadCustomImage: new image has wrong dimensions");
700 FreeBitmap(new_bitmap);
705 /* copy filename for new image */
706 free(old_bitmap->source_filename);
707 old_bitmap->source_filename = getStringCopy(filename);
709 /* copy bitmap data for new image */
710 BlitBitmap(new_bitmap, old_bitmap, 0,0,
711 old_bitmap->width, old_bitmap->height, 0,0);
713 FreeBitmap(new_bitmap);
716 *bitmap = new_bitmap;
723 /* ========================================================================= */
724 /* audio functions */
725 /* ========================================================================= */
727 inline void OpenAudio(void)
729 /* always start with reliable default values */
730 audio.sound_available = FALSE;
731 audio.music_available = FALSE;
732 audio.loops_available = FALSE;
733 audio.mods_available = FALSE;
734 audio.sound_enabled = FALSE;
736 audio.soundserver_pipe[0] = audio.soundserver_pipe[1] = 0;
737 audio.soundserver_pid = 0;
738 audio.device_name = NULL;
742 audio.music_channel = 0;
745 #if defined(TARGET_SDL)
747 #elif defined(PLATFORM_UNIX)
749 #elif defined(PLATFORM_MSDOS)
754 inline void CloseAudio(void)
756 #if defined(TARGET_SDL)
758 #elif defined(PLATFORM_UNIX)
760 #elif defined(PLATFORM_MSDOS)
764 audio.sound_enabled = FALSE;
767 inline void SetAudioMode(boolean enabled)
769 if (!audio.sound_available)
772 audio.sound_enabled = enabled;
776 /* ========================================================================= */
777 /* event functions */
778 /* ========================================================================= */
780 inline void InitEventFilter(EventFilter filter_function)
783 /* set event filter to filter out certain events */
784 SDL_SetEventFilter(filter_function);
788 inline boolean PendingEvent(void)
791 return (SDL_PollEvent(NULL) ? TRUE : FALSE);
793 return (XPending(display) ? TRUE : FALSE);
797 inline void NextEvent(Event *event)
802 XNextEvent(display, event);
806 inline Key GetEventKey(KeyEvent *event, boolean with_modifiers)
810 printf("unicode == '%d', sym == '%d', mod == '0x%04x'\n",
811 (int)event->keysym.unicode,
812 (int)event->keysym.sym,
813 (int)SDL_GetModState());
816 if (with_modifiers && event->keysym.unicode != 0)
817 return event->keysym.unicode;
819 return event->keysym.sym;
822 printf("with modifiers == '0x%04x', without modifiers == '0x%04x'\n",
823 (int)XLookupKeysym(event, event->state),
824 (int)XLookupKeysym(event, 0));
828 return XLookupKeysym(event, event->state);
830 return XLookupKeysym(event, 0);
834 inline boolean CheckCloseWindowEvent(ClientMessageEvent *event)
836 if (event->type != EVENT_CLIENTMESSAGE)
839 #if defined(TARGET_SDL)
840 return TRUE; /* the only possible message here is SDL_QUIT */
841 #elif defined(PLATFORM_UNIX)
842 if ((event->window == window->drawable) &&
843 (event->data.l[0] == XInternAtom(display, "WM_DELETE_WINDOW", FALSE)))
851 /* ========================================================================= */
852 /* joystick functions */
853 /* ========================================================================= */
855 inline void InitJoysticks()
860 return; /* joysticks generally deactivated by compile-time directive */
863 /* always start with reliable default values */
864 joystick.status = JOYSTICK_NOT_AVAILABLE;
865 for (i=0; i<MAX_PLAYERS; i++)
866 joystick.fd[i] = -1; /* joystick device closed */
868 #if defined(TARGET_SDL)
870 #elif defined(PLATFORM_UNIX)
872 #elif defined(PLATFORM_MSDOS)
873 MSDOSInitJoysticks();
877 inline boolean ReadJoystick(int nr, int *x, int *y, boolean *b1, boolean *b2)
879 #if defined(TARGET_SDL)
880 return SDLReadJoystick(nr, x, y, b1, b2);
881 #elif defined(PLATFORM_UNIX)
882 return UnixReadJoystick(nr, x, y, b1, b2);
883 #elif defined(PLATFORM_MSDOS)
884 return MSDOSReadJoystick(nr, x, y, b1, b2);