/*

SDL - Simple DirectMedia Layer

This library is free software; you can redistribute it and/or

This library is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

You should have received a copy of the GNU Lesser General Public

License along with this library; if not, write to the Free Software

Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Sam Lantinga

/* X11 based SDL video driver implementation.

Note: This implementation does not currently need X11 thread locking,

since the event thread uses a separate X connection and any

additional locking necessary is handled internally. However,

if full locking is neccessary, take a look at XInitThreads().

*/

#include <unistd.h>

#include <sys/ioctl.h>

#ifdef MTRR_SUPPORT

#include <asm/mtrr.h>

#include <sys/fcntl.h>

#endif

#include "SDL_timer.h"

#include "SDL_thread.h"

#include "SDL_video.h"

#include "SDL_mouse.h"

#include "../SDL_sysvideo.h"

#include "../SDL_pixels_c.h"

#include "../../events/SDL_events_c.h"

#include "SDL_x11video.h"

#include "SDL_x11wm_c.h"

#include "SDL_x11mouse_c.h"

#include "SDL_x11events_c.h"

#include "SDL_x11modes_c.h"

#include "SDL_x11image_c.h"

#include "SDL_x11yuv_c.h"

#include "SDL_x11gl_c.h"

#include "SDL_x11gamma_c.h"

#ifdef X_HAVE_UTF8_STRING

#include <locale.h>

#endif

/* Initialization/Query functions */

static int X11_VideoInit(_THIS, SDL_PixelFormat *vformat);

static SDL_Surface *X11_SetVideoMode(_THIS, SDL_Surface *current, int width, int height, int bpp, Uint32 flags);

static int X11_ToggleFullScreen(_THIS, int on);

static void X11_UpdateMouse(_THIS);

static int X11_SetColors(_THIS, int firstcolor, int ncolors,

SDL_Color *colors);

static int X11_SetGammaRamp(_THIS, Uint16 *ramp);

static void X11_VideoQuit(_THIS);

/* X11 driver bootstrap functions */

static int X11_Available(void)

{

Display *display = NULL;

if ( SDL_X11_LoadSymbols() ) {

}

SDL_X11_UnloadSymbols();

}

return(display != NULL);

}

static void X11_DeleteDevice(SDL_VideoDevice *device)

{

if ( device ) {

if ( device->hidden ) {

}

if ( device->gl_data ) {

}

}

static SDL_VideoDevice *X11_CreateDevice(int devindex)

{

SDL_VideoDevice *device = NULL;

if ( SDL_X11_LoadSymbols() ) {

/* Initialize all variables that we clean on shutdown */

}

if ( (device == NULL) || (device->hidden == NULL) ||

(device->gl_data == NULL) ) {

SDL_OutOfMemory();

X11_DeleteDevice(device); /* calls SDL_X11_UnloadSymbols(). */

return(0);

}

SDL_memset(device->hidden, 0, (sizeof *device->hidden));

SDL_memset(device->gl_data, 0, (sizeof *device->gl_data));

/* Set the driver flags */

device->handles_any_size = 1;

/* Set the function pointers */

device->VideoInit = X11_VideoInit;

device->ListModes = X11_ListModes;

device->SetVideoMode = X11_SetVideoMode;

device->ToggleFullScreen = X11_ToggleFullScreen;

device->UpdateMouse = X11_UpdateMouse;

device->SetColors = X11_SetColors;

device->UpdateRects = NULL;

device->VideoQuit = X11_VideoQuit;

device->AllocHWSurface = X11_AllocHWSurface;

device->CheckHWBlit = NULL;

device->FillHWRect = NULL;

device->SetHWColorKey = NULL;

device->SetHWAlpha = NULL;

device->LockHWSurface = X11_LockHWSurface;

device->UnlockHWSurface = X11_UnlockHWSurface;

device->FlipHWSurface = X11_FlipHWSurface;

device->FreeHWSurface = X11_FreeHWSurface;

device->SetGamma = X11_SetVidModeGamma;

device->GetGamma = X11_GetVidModeGamma;

device->SetGammaRamp = X11_SetGammaRamp;

device->GetGammaRamp = NULL;

device->GL_LoadLibrary = X11_GL_LoadLibrary;

device->GL_GetProcAddress = X11_GL_GetProcAddress;

device->GL_GetAttribute = X11_GL_GetAttribute;

device->GL_MakeCurrent = X11_GL_MakeCurrent;

device->GL_SwapBuffers = X11_GL_SwapBuffers;

device->SetCaption = X11_SetCaption;

device->SetIcon = X11_SetIcon;

device->IconifyWindow = X11_IconifyWindow;

device->GrabInput = X11_GrabInput;

device->GetWMInfo = X11_GetWMInfo;

device->FreeWMCursor = X11_FreeWMCursor;

device->CreateWMCursor = X11_CreateWMCursor;

device->ShowWMCursor = X11_ShowWMCursor;

device->WarpWMCursor = X11_WarpWMCursor;

device->CheckMouseMode = X11_CheckMouseMode;

device->InitOSKeymap = X11_InitOSKeymap;

device->PumpEvents = X11_PumpEvents;

device->free = X11_DeleteDevice;

}

return device;

}

VideoBootStrap X11_bootstrap = {

"x11", "X Window System",

X11_Available, X11_CreateDevice

};

/* Normal X11 error handler routine */

static int (*X_handler)(Display *, XErrorEvent *) = NULL;

static int x_errhandler(Display *d, XErrorEvent *e)

{

extern int vm_error;

#endif

extern int dga_error;

#endif

/* VidMode errors are non-fatal. :) */

/* Are the errors offset by one from the error base?

e.g. the error base is 143, the code is 148, and the

actual error is XF86VidModeExtensionDisabled (4) ?

*/

if ( (vm_error >= 0) &&

(((e->error_code == BadRequest)&&(e->request_code == vm_error)) ||

((e->error_code > vm_error) &&

(e->error_code <= (vm_error+XF86VidModeNumberErrors)))) ) {

printf("VidMode error: %s\n", errmsg);

}

#endif

return(0);

}

/* DGA errors can be non-fatal. :) */

if ( (dga_error >= 0) &&

((e->error_code > dga_error) &&

(e->error_code <= (dga_error+XF86DGANumberErrors))) ) {

printf("DGA error: %s\n", errmsg);

}

#endif

return(0);

}

return(X_handler(d,e));

}

/* X11 I/O error handler routine */

static int (*XIO_handler)(Display *) = NULL;

static int xio_errhandler(Display *d)

{

/* Ack! Lost X11 connection! */

/* We will crash if we try to clean up our display */

if ( current_video->hidden->Ximage ) {

SDL_VideoSurface->pixels = NULL;

}

current_video->hidden->X11_Display = NULL;

/* Continue with the standard X11 error handler */

return(XIO_handler(d));

}

static int (*Xext_handler)(Display *, _Xconst char *, _Xconst char *) = NULL;

static int xext_errhandler(Display *d, _Xconst char *ext, _Xconst char *reason)

printf("Xext error inside SDL (may be harmless):\n");

printf(" Extension \"%s\" %s on display \"%s\".\n",

#endif

/*

* Since the query itself, elsewhere, can handle a missing extension

* and the default behaviour in Xlib is to write to stderr, which

* generates unnecessary bug reports, we just ignore these.

*/

return 0;

}

/* Everything else goes to the default handler... */

}

/* Find out what class name we should use */

static char *get_classname(char *classname, int maxlen)

{

char *spot;

char procfile[1024];

char linkfile[1024];

int linksize;

#endif

/* First allow environment variable override */

return classname;

}

/* Next look at the application's executable name */

#if defined(__LINUX__) || defined(__FREEBSD__)

#if defined(__LINUX__)

#else

#error Where can we find the executable name?

#endif

linksize = readlink(procfile, linkfile, sizeof(linkfile)-1);

if ( linksize > 0 ) {

linkfile[linksize] = '\0';

}

return classname;

}

/* Finally use the default we've used forever */

return classname;

}

/* Create auxiliary (toplevel) windows with the current visual */

static void create_aux_windows(_THIS)

{

XSetWindowAttributes xattr;

XWMHints *hints;

int def_vis = (SDL_Visual == DefaultVisual(SDL_Display, SDL_Screen));

/* Don't create any extra windows if we are being managed */

if ( SDL_windowid ) {

FSwindow = 0;

return;

}

if(FSwindow)

if ( use_xinerama ) {

x = xinerama_info.x_org;

y = xinerama_info.y_org;

}

#endif

xattr.override_redirect = True;

xattr.background_pixel = def_vis ? BlackPixel(SDL_Display, SDL_Screen) : 0;

xattr.border_pixel = 0;

xattr.colormap = SDL_XColorMap;

this->hidden->depth, InputOutput, SDL_Visual,

CWOverrideRedirect | CWBackPixel | CWBorderPixel

| CWColormap,

&xattr);

/* Tell KDE to keep the fullscreen window on top */

{

XEvent ev;

long mask;

ev.xclient.type = ClientMessage;

ev.xclient.window = SDL_Root;

"KWM_KEEP_ON_TOP", False);

ev.xclient.format = 32;

ev.xclient.data.l[0] = FSwindow;

ev.xclient.data.l[1] = CurrentTime;

mask = SubstructureRedirectMask;

}

hints = NULL;

if(WMwindow) {

/* All window attributes must survive the recreation */

hints = XGetWMHints(SDL_Display, WMwindow);

XDestroyWindow(SDL_Display, WMwindow);

}

/* Create the window for windowed management */

/* (reusing the xattr structure above) */

WMwindow = XCreateWindow(SDL_Display, SDL_Root,

x, y, 32, 32, 0,

this->hidden->depth, InputOutput, SDL_Visual,

CWBackPixel | CWBorderPixel | CWColormap,

&xattr);

/* Set the input hints so we get keyboard input */

if(!hints) {

hints->input = True;

hints->flags = InputHint;

}

XSetWMHints(SDL_Display, WMwindow, hints);

XFree(hints);

app_event_mask = FocusChangeMask | KeyPressMask | KeyReleaseMask

| PropertyChangeMask | StructureNotifyMask | KeymapStateMask;

XSelectInput(SDL_Display, WMwindow, app_event_mask);

/* Set the class hints so we can get an icon (AfterStep) */

{

XClassHint *classhints;

classhints->res_name = classname;

classhints->res_class = classname;

XSetClassHint(SDL_Display, WMwindow, classhints);

XFree(classhints);

}

}

/* create_aux_windows may be called several times against the same

Display. We should reuse the SDL_IM if one has been opened for

the Display, so we should not simply reset SDL_IM here. */

#ifdef X_HAVE_UTF8_STRING

if (SDL_X11_HAVE_UTF8) {

/* Discard obsolete resources if any. */

if (SDL_IM != NULL && SDL_Display != XDisplayOfIM(SDL_IM)) {

/* Just a double check. I don't think this

code is ever executed. */

SDL_SetError("display has changed while an IM is kept");

if (SDL_IC) {

XUnsetICFocus(SDL_IC);

XDestroyIC(SDL_IC);

SDL_IC = NULL;

}

XCloseIM(SDL_IM);

SDL_IM = NULL;

}

/* Open an input method. */

if (SDL_IM == NULL) {

char *old_locale, *old_modifiers;

/* I'm not comfortable to do locale setup

here. However, we need C library locale

(and xlib modifiers) to be set based on the

user's preference to use XIM, and many

existing game programs doesn't take care of

users' locale preferences, so someone other

than the game program should do it.

Moreover, ones say that some game programs

heavily rely on the C locale behaviour,

e.g., strcol()'s, and we can't change the C

library locale. Given the situation, I

couldn't find better place to do the

job... */

/* Save the current (application program's)

locale settings. */

old_locale = setlocale(LC_ALL, NULL);

old_modifiers = XSetLocaleModifiers(NULL);

if (old_locale == NULL || old_modifiers == NULL) {

/* The specs guarantee that the query

calls to above functions never

fail, so we should never come

here. */

SDL_SetError("failed to retreive current locale settings");

old_locale = NULL;

old_modifiers = NULL;

} else {

/* Save retreived values in our own

storage, since they may be

overwritten by the successive calls

to

setlocale/XSetLocaleModifiers. */

char const *p;

p = old_locale;

old_locale = SDL_malloc(strlen(p) + 1);

strcpy(old_locale, p);

p = old_modifiers;

old_modifiers = SDL_malloc(strlen(p) + 1);

strcpy(old_modifiers, p);

}

/* Fetch the user's preferences and open the

input method with them. */

setlocale(LC_ALL, "");

XSetLocaleModifiers("");

SDL_IM = XOpenIM(SDL_Display, NULL, classname, classname);

/* Restore the application's locale settings

so that we don't break the application's

expected behaviour. */

if (old_locale != NULL && old_modifiers != NULL) {

/* We need to restore the C library

locale first, since the

interpretation of the X modifier

may depend on it. */

setlocale(LC_ALL, old_locale);

SDL_free(old_locale);

XSetLocaleModifiers(old_modifiers);

SDL_free(old_modifiers);

}

}

/* Create a new input context for the new window just created. */

SDL_IM = XOpenIM(SDL_Display, NULL, classname, classname);

if (SDL_IM == NULL) {

SDL_SetError("no input method could be opened");

} else {

if (SDL_IC != NULL) {

/* Discard the old IC before creating new one. */

XUnsetICFocus(SDL_IC);

XDestroyIC(SDL_IC);

}

/* Theoretically we should check the current IM supports

PreeditNothing+StatusNothing style (i.e., root window method)

before creating the IC. However, it is the bottom line method,

and we supports any other options. If the IM didn't support

root window method, the following call fails, and SDL falls

back to pre-XIM keyboard handling. */

SDL_IC = pXCreateIC(SDL_IM,

XNClientWindow, WMwindow,

XNFocusWindow, WMwindow,

XNResourceName, classname,

XNResourceClass, classname,

NULL);

if (SDL_IC == NULL) {

SDL_SetError("no input context could be created");

XCloseIM(SDL_IM);

SDL_IM = NULL;

} else {

/* We need to receive X events that an IM wants and to pass

them to the IM through XFilterEvent. The set of events may

vary depending on the IM implementation and the options

specified through various routes. Although unlikely, the

xlib specification allows IM to change the event requirement

with its own circumstances, it is safe to call SelectInput

whenever we re-create an IC. */

unsigned long mask = 0;

char *ret = pXGetICValues(SDL_IC, XNFilterEvents, &mask, NULL);

&ic_event_mask, NULL);

XSelectInput(SDL_Display, WMwindow, app_event_mask | mask);

XSetICFocus(SDL_IC);

}

}

/* Allow the window to be deleted by the window manager */

XSetWMProtocols(SDL_Display, WMwindow, &WM_DELETE_WINDOW, 1);

}

static int X11_VideoInit(_THIS, SDL_PixelFormat *vformat)

{

char *display;

int i;

/* Open the X11 display */

display = NULL; /* Get it from DISPLAY environment variable */

if ( (SDL_strncmp(XDisplayName(display), ":", 1) == 0) ||

(SDL_strncmp(XDisplayName(display), "unix:", 5) == 0) ) {

local_X11 = 1;

} else {

local_X11 = 0;

}

/* On Tru64 if linking without -lX11, it fails and you get following message.

* Xlib: connection to ":0.0" refused by server

* Xlib: XDM authorization key matches an existing client!

*

* It succeeds if retrying 1 second later

* or if running xhost +localhost on shell.

*

*/

if ( SDL_Display == NULL ) {

SDL_Delay(1000);

}

#endif

if ( SDL_Display == NULL ) {

SDL_SetError("Couldn't open X11 display");

return(-1);

}

#ifdef X11_DEBUG

#endif

/* Create an alternate X display for graphics updates -- allows us

to do graphics updates in a separate thread from event handling.

Thread-safe X11 doesn't seem to exist.

*/

XCloseDisplay(SDL_Display);

SDL_Display = NULL;

SDL_SetError("Couldn't open X11 display");

return(-1);

}

/* Set the normal X error handler */

/* Set the error handler if we lose the X display */

/* use default screen (from $DISPLAY) */

SDL_Screen = DefaultScreen(SDL_Display);

#ifndef NO_SHARED_MEMORY

/* Check for MIT shared memory extension */

}

#endif /* NO_SHARED_MEMORY */

/* Get the available video modes */

if(X11_GetVideoModes(this) < 0) {

XCloseDisplay(GFX_Display);

GFX_Display = NULL;

XCloseDisplay(SDL_Display);

SDL_Display = NULL;

/* Determine the current screen size */

this->info.current_w = DisplayWidth(SDL_Display, SDL_Screen);

this->info.current_h = DisplayHeight(SDL_Display, SDL_Screen);

/* Determine the default screen depth:

Use the default visual (or at least one with the same depth) */

SDL_DisplayColormap = DefaultColormap(SDL_Display, SDL_Screen);

for(i = 0; i < this->hidden->nvisuals; i++)

if(this->hidden->visuals[i].depth == DefaultDepth(SDL_Display,

SDL_Screen))

break;

if(i == this->hidden->nvisuals) {

/* default visual was useless, take the deepest one instead */

i = 0;

}

SDL_Visual = this->hidden->visuals[i].visual;

if ( SDL_Visual == DefaultVisual(SDL_Display, SDL_Screen) ) {

SDL_XColorMap = SDL_DisplayColormap;

} else {

SDL_Visual, AllocNone);

}

this->hidden->depth = this->hidden->visuals[i].depth;

vformat->BitsPerPixel = this->hidden->visuals[i].bpp;

if ( vformat->BitsPerPixel > 8 ) {

vformat->Rmask = SDL_Visual->red_mask;

vformat->Gmask = SDL_Visual->green_mask;

vformat->Bmask = SDL_Visual->blue_mask;

}

if ( this->hidden->depth == 32 ) {

vformat->Amask = (0xFFFFFFFF & ~(vformat->Rmask|vformat->Gmask|vformat->Bmask));

}

X11_SaveVidModeGamma(this);

/* Create the fullscreen and managed windows */

create_aux_windows(this);

/* Create the blank cursor */

SDL_BlankCursor = this->CreateWMCursor(this, blank_cdata, blank_cmask,

BLANK_CWIDTH, BLANK_CHEIGHT,

BLANK_CHOTX, BLANK_CHOTY);

/* Fill in some window manager capabilities */