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);
294 bitmap->surface = NULL;
295 bitmap->surface_masked = NULL;
297 /* The X11 version seems to have a memory leak here -- although
298 "XFreePixmap()" is called, the correspondig memory seems not
299 to be freed (according to "ps"). The SDL version apparently
300 does not have this problem. */
302 if (bitmap->drawable)
303 XFreePixmap(display, bitmap->drawable);
304 if (bitmap->clip_mask)
305 XFreePixmap(display, bitmap->clip_mask);
306 if (bitmap->stored_clip_gc)
307 XFreeGC(display, bitmap->stored_clip_gc);
308 /* the other GCs are only pointers to GCs used elsewhere */
309 bitmap->drawable = None;
310 bitmap->clip_mask = None;
311 bitmap->stored_clip_gc = None;
314 if (bitmap->source_filename)
315 free(bitmap->source_filename);
316 bitmap->source_filename = NULL;
319 inline static void TransferBitmapPointers(Bitmap *src_bitmap,
322 if (src_bitmap == NULL || dst_bitmap == NULL)
325 FreeBitmapPointers(dst_bitmap);
327 *dst_bitmap = *src_bitmap;
330 inline void FreeBitmap(Bitmap *bitmap)
335 FreeBitmapPointers(bitmap);
340 inline void CloseWindow(DrawWindow *window)
343 if (window->drawable)
345 XUnmapWindow(display, window->drawable);
346 XDestroyWindow(display, window->drawable);
349 XFreeGC(display, window->gc);
353 inline boolean DrawingDeactivated(int x, int y, int width, int height)
355 if (gfx.draw_deactivation_mask != REDRAW_NONE)
357 if ((gfx.draw_deactivation_mask & REDRAW_FIELD) &&
358 x < gfx.sx + gfx.sxsize)
365 inline void BlitBitmap(Bitmap *src_bitmap, Bitmap *dst_bitmap,
366 int src_x, int src_y,
367 int width, int height,
368 int dst_x, int dst_y)
370 if (DrawingDeactivated(dst_x, dst_y, width, height))
374 SDLCopyArea(src_bitmap, dst_bitmap,
375 src_x, src_y, width, height, dst_x, dst_y, SDLCOPYAREA_OPAQUE);
377 XCopyArea(display, src_bitmap->drawable, dst_bitmap->drawable,
378 dst_bitmap->gc, src_x, src_y, width, height, dst_x, dst_y);
382 inline void ClearRectangle(Bitmap *bitmap, int x, int y, int width, int height)
384 if (DrawingDeactivated(x, y, width, height))
388 SDLFillRectangle(bitmap, x, y, width, height, 0x000000);
390 XFillRectangle(display, bitmap->drawable, bitmap->gc, x, y, width, height);
396 static GC last_clip_gc = 0; /* needed for XCopyArea() through clip mask */
400 inline void SetClipMask(Bitmap *bitmap, GC clip_gc, Pixmap clip_pixmap)
405 bitmap->clip_gc = clip_gc;
406 XSetClipMask(display, bitmap->clip_gc, clip_pixmap);
409 last_clip_gc = clip_gc;
414 inline void SetClipOrigin(Bitmap *bitmap, GC clip_gc, int clip_x, int clip_y)
419 bitmap->clip_gc = clip_gc;
420 XSetClipOrigin(display, bitmap->clip_gc, clip_x, clip_y);
423 last_clip_gc = clip_gc;
428 inline void BlitBitmapMasked(Bitmap *src_bitmap, Bitmap *dst_bitmap,
429 int src_x, int src_y,
430 int width, int height,
431 int dst_x, int dst_y)
433 if (DrawingDeactivated(dst_x, dst_y, width, height))
437 SDLCopyArea(src_bitmap, dst_bitmap,
438 src_x, src_y, width, height, dst_x, dst_y, SDLCOPYAREA_MASKED);
440 XCopyArea(display, src_bitmap->drawable, dst_bitmap->drawable,
441 src_bitmap->clip_gc, src_x, src_y, width, height, dst_x, dst_y);
445 inline void DrawSimpleWhiteLine(Bitmap *bitmap, int from_x, int from_y,
449 SDLDrawSimpleLine(bitmap, from_x, from_y, to_x, to_y, 0xffffff);
451 XSetForeground(display, bitmap->gc, WhitePixel(display, screen));
452 XDrawLine(display, bitmap->drawable, bitmap->gc, from_x, from_y, to_x, to_y);
453 XSetForeground(display, bitmap->gc, BlackPixel(display, screen));
457 #if !defined(TARGET_X11_NATIVE)
458 inline void DrawLine(Bitmap *bitmap, int from_x, int from_y,
459 int to_x, int to_y, Pixel pixel, int line_width)
463 for (x=0; x<line_width; x++)
465 for (y=0; y<line_width; y++)
467 int dx = x - line_width / 2;
468 int dy = y - line_width / 2;
470 if ((x == 0 && y == 0) ||
471 (x == 0 && y == line_width - 1) ||
472 (x == line_width - 1 && y == 0) ||
473 (x == line_width - 1 && y == line_width - 1))
476 #if defined(TARGET_SDL)
478 from_x + dx, from_y + dy, to_x + dx, to_y + dy, pixel);
479 #elif defined(TARGET_ALLEGRO)
480 AllegroDrawLine(bitmap->drawable, from_x + dx, from_y + dy,
481 to_x + dx, to_y + dy, pixel);
488 inline void DrawLines(Bitmap *bitmap, struct XY *points, int num_points,
491 #if !defined(TARGET_X11_NATIVE)
495 for (i=0; i<num_points - 1; i++)
496 DrawLine(bitmap, points[i].x, points[i].y,
497 points[i + 1].x, points[i + 1].y, pixel, line_width);
500 SDLDrawLines(bitmap->surface, points, num_points, pixel);
503 XSetForeground(display, bitmap->line_gc[1], pixel);
504 XDrawLines(display, bitmap->drawable, bitmap->line_gc[1],
505 (XPoint *)points, num_points, CoordModeOrigin);
507 XSetForeground(display, gc, BlackPixel(display, screen));
512 inline Pixel GetPixel(Bitmap *bitmap, int x, int y)
514 #if defined(TARGET_SDL)
515 return SDLGetPixel(bitmap, x, y);
516 #elif defined(TARGET_ALLEGRO)
517 return AllegroGetPixel(bitmap->drawable, x, y);
519 unsigned long pixel_value;
522 pixel_image = XGetImage(display, bitmap->drawable, x, y, 1, 1,
524 pixel_value = XGetPixel(pixel_image, 0, 0);
526 XDestroyImage(pixel_image);
532 inline Pixel GetPixelFromRGB(Bitmap *bitmap, unsigned int color_r,
533 unsigned int color_g, unsigned int color_b)
537 #if defined(TARGET_SDL)
538 pixel = SDL_MapRGB(bitmap->surface->format, color_r, color_g, color_b);
539 #elif defined(TARGET_ALLEGRO)
540 pixel = AllegroAllocColorCell(color_r << 8, color_g << 8, color_b << 8);
541 #elif defined(TARGET_X11_NATIVE)
544 xcolor.flags = DoRed | DoGreen | DoBlue;
545 xcolor.red = (color_r << 8);
546 xcolor.green = (color_g << 8);
547 xcolor.blue = (color_b << 8);
548 XAllocColor(display, cmap, &xcolor);
549 pixel = xcolor.pixel;
555 inline Pixel GetPixelFromRGBcompact(Bitmap *bitmap, unsigned int color)
557 unsigned int color_r = (color >> 16) & 0xff;
558 unsigned int color_g = (color >> 8) & 0xff;
559 unsigned int color_b = (color >> 0) & 0xff;
561 return GetPixelFromRGB(bitmap, color_r, color_g, color_b);
564 /* execute all pending screen drawing operations */
565 inline void FlushDisplay(void)
572 /* execute and wait for all pending screen drawing operations */
573 inline void SyncDisplay(void)
576 XSync(display, FALSE);
580 inline void KeyboardAutoRepeatOn(void)
583 SDL_EnableKeyRepeat(SDL_DEFAULT_REPEAT_DELAY / 2,
584 SDL_DEFAULT_REPEAT_INTERVAL / 2);
585 SDL_EnableUNICODE(1);
588 XAutoRepeatOn(display);
592 inline void KeyboardAutoRepeatOff(void)
595 SDL_EnableKeyRepeat(0, SDL_DEFAULT_REPEAT_INTERVAL);
596 SDL_EnableUNICODE(0);
599 XAutoRepeatOff(display);
603 inline boolean PointerInWindow(DrawWindow *window)
613 /* if XQueryPointer() returns False, the pointer
614 is not on the same screen as the specified window */
615 return XQueryPointer(display, window->drawable, &root, &child,
616 &root_x, &root_y, &win_x, &win_y, &mask);
620 inline boolean SetVideoMode(boolean fullscreen)
623 return SDLSetVideoMode(&backbuffer, fullscreen);
625 boolean success = TRUE;
627 if (fullscreen && video.fullscreen_available)
629 Error(ERR_WARN, "fullscreen not available in X11 version");
631 /* display error message only once */
632 video.fullscreen_available = FALSE;
641 inline boolean ChangeVideoModeIfNeeded(boolean fullscreen)
644 if ((fullscreen && !video.fullscreen_enabled && video.fullscreen_available)||
645 (!fullscreen && video.fullscreen_enabled))
646 fullscreen = SetVideoMode(fullscreen);
652 Bitmap *LoadImage(char *filename)
656 #if defined(TARGET_SDL)
657 new_bitmap = SDLLoadImage(filename);
659 new_bitmap = X11LoadImage(filename);
662 new_bitmap->source_filename = getStringCopy(filename);
667 Bitmap *LoadCustomImage(char *basename)
669 char *filename = getCustomImageFilename(basename);
672 if (filename == NULL)
673 Error(ERR_EXIT, "LoadCustomImage(): cannot find file '%s'", basename);
675 if ((new_bitmap = LoadImage(filename)) == NULL)
676 Error(ERR_EXIT, "LoadImage() failed: %s", GetError());
681 void ReloadCustomImage(Bitmap *bitmap, char *basename)
683 char *filename = getCustomImageFilename(basename);
686 if (filename == NULL) /* (should never happen) */
688 Error(ERR_WARN, "ReloadCustomImage(): cannot find file '%s'", basename);
692 if (strcmp(filename, bitmap->source_filename) == 0)
694 /* The old and new image are the same (have the same filename and path).
695 This usually means that this image does not exist in this graphic set
696 and a fallback to the existing image is done. */
701 if ((new_bitmap = LoadImage(filename)) == NULL)
703 Error(ERR_WARN, "LoadImage() failed: %s", GetError());
707 if (bitmap->width != new_bitmap->width ||
708 bitmap->height != new_bitmap->height)
710 Error(ERR_WARN, "ReloadCustomImage: new image has wrong dimensions");
711 FreeBitmap(new_bitmap);
715 TransferBitmapPointers(new_bitmap, bitmap);
720 /* ========================================================================= */
721 /* audio functions */
722 /* ========================================================================= */
724 inline void OpenAudio(void)
726 /* always start with reliable default values */
727 audio.sound_available = FALSE;
728 audio.music_available = FALSE;
729 audio.loops_available = FALSE;
730 audio.mods_available = FALSE;
731 audio.sound_enabled = FALSE;
733 audio.soundserver_pipe[0] = audio.soundserver_pipe[1] = 0;
734 audio.soundserver_pid = -1;
735 audio.device_name = NULL;
739 audio.music_channel = 0;
742 #if defined(TARGET_SDL)
744 #elif defined(PLATFORM_UNIX)
746 #elif defined(PLATFORM_MSDOS)
751 inline void CloseAudio(void)
753 #if defined(TARGET_SDL)
755 #elif defined(PLATFORM_UNIX)
757 #elif defined(PLATFORM_MSDOS)
761 audio.sound_enabled = FALSE;
764 inline void SetAudioMode(boolean enabled)
766 if (!audio.sound_available)
769 audio.sound_enabled = enabled;
773 /* ========================================================================= */
774 /* event functions */
775 /* ========================================================================= */
777 inline void InitEventFilter(EventFilter filter_function)
780 /* set event filter to filter out certain events */
781 SDL_SetEventFilter(filter_function);
785 inline boolean PendingEvent(void)
788 return (SDL_PollEvent(NULL) ? TRUE : FALSE);
790 return (XPending(display) ? TRUE : FALSE);
794 inline void NextEvent(Event *event)
799 XNextEvent(display, event);
803 inline Key GetEventKey(KeyEvent *event, boolean with_modifiers)
807 printf("unicode == '%d', sym == '%d', mod == '0x%04x'\n",
808 (int)event->keysym.unicode,
809 (int)event->keysym.sym,
810 (int)SDL_GetModState());
813 if (with_modifiers && event->keysym.unicode != 0)
814 return event->keysym.unicode;
816 return event->keysym.sym;
819 printf("with modifiers == '0x%04x', without modifiers == '0x%04x'\n",
820 (int)XLookupKeysym(event, event->state),
821 (int)XLookupKeysym(event, 0));
825 return XLookupKeysym(event, event->state);
827 return XLookupKeysym(event, 0);
831 inline boolean CheckCloseWindowEvent(ClientMessageEvent *event)
833 if (event->type != EVENT_CLIENTMESSAGE)
836 #if defined(TARGET_SDL)
837 return TRUE; /* the only possible message here is SDL_QUIT */
838 #elif defined(PLATFORM_UNIX)
839 if ((event->window == window->drawable) &&
840 (event->data.l[0] == XInternAtom(display, "WM_DELETE_WINDOW", FALSE)))
848 /* ========================================================================= */
849 /* joystick functions */
850 /* ========================================================================= */
852 inline void InitJoysticks()
857 return; /* joysticks generally deactivated by compile-time directive */
860 /* always start with reliable default values */
861 joystick.status = JOYSTICK_NOT_AVAILABLE;
862 for (i=0; i<MAX_PLAYERS; i++)
863 joystick.fd[i] = -1; /* joystick device closed */
865 #if defined(TARGET_SDL)
867 #elif defined(PLATFORM_UNIX)
869 #elif defined(PLATFORM_MSDOS)
870 MSDOSInitJoysticks();
874 inline boolean ReadJoystick(int nr, int *x, int *y, boolean *b1, boolean *b2)
876 #if defined(TARGET_SDL)
877 return SDLReadJoystick(nr, x, y, b1, b2);
878 #elif defined(PLATFORM_UNIX)
879 return UnixReadJoystick(nr, x, y, b1, b2);
880 #elif defined(PLATFORM_MSDOS)
881 return MSDOSReadJoystick(nr, x, y, b1, b2);