/*

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 "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"

#include "blank_cursor.h"

/* 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() ) {

display = pXOpenDisplay(NULL);

if ( display != NULL ) {

pXCloseDisplay(display);

}

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)

{

#ifdef XFREE86_VM

extern int vm_error;

#endif

#ifdef XFREE86_DGAMOUSE

extern int dga_error;

#endif

#ifdef XFREE86_VM

/* 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)))) ) {

#ifdef XFREE86_DEBUG

{ char errmsg[1024];

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

}

#endif

return(0);

}

#endif /* XFREE86_VM */

#ifdef XFREE86_DGAMOUSE

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

if ( (dga_error >= 0) &&

((e->error_code > dga_error) &&

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

#ifdef XFREE86_DEBUG

{ char errmsg[1024];

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

}

#endif

return(0);

}

#endif /* XFREE86_DGAMOUSE */

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 *,char *,char *) = NULL;

static int xext_errhandler(Display *d, char *ext_name, char *reason)

{

#ifdef XFREE86_DEBUG

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

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

ext_name, reason, pXDisplayString(d));

#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... */

return Xext_handler(d, ext_name, reason);

}

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

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

{

char *spot;

#if defined(linux) || defined(__FreeBSD__)

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;

}

#endif /* linux */

/* 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;

XTextProperty titleprop, iconprop;

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)

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;

titleprop.value = iconprop.value = NULL;

if(WMwindow) {

/* All window attributes must survive the recreation */

hints = pXGetWMHints(SDL_Display, WMwindow);

pXGetWMName(SDL_Display, WMwindow, &titleprop);

pXGetWMIconName(SDL_Display, WMwindow, &iconprop);

pXDestroyWindow(SDL_Display, WMwindow);

}

/* Create the window for windowed management */

/* (reusing the xattr structure above) */

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;

}

pXSetWMHints(SDL_Display, WMwindow, hints);

pXFree(hints);

pXSetWMName(SDL_Display, WMwindow, &titleprop);

pXFree(titleprop.value);

}

if(iconprop.value) {

pXSetWMIconName(SDL_Display, WMwindow, &iconprop);

pXFree(iconprop.value);

}

FocusChangeMask | KeyPressMask | KeyReleaseMask

| PropertyChangeMask | StructureNotifyMask | KeymapStateMask);

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

{

XClassHint *classhints;

classhints->res_name = classname;

classhints->res_class = classname;

pXSetClassHint(SDL_Display, WMwindow, classhints);

pXFree(classhints);

}

}

/* Setup the communication with the IM server */

SDL_IM = NULL;

SDL_IC = NULL;

#ifdef X_HAVE_UTF8_STRING

if (SDL_IM == NULL) {

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

} else {

SDL_IC = pXCreateIC(SDL_IM,

XNClientWindow, WMwindow,

XNFocusWindow, WMwindow,

XNInputStyle, XIMPreeditNothing | XIMStatusNothing,

XNResourceName, classname,

XNResourceClass, classname,

NULL);

if (SDL_IC == NULL) {

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

pXCloseIM(SDL_IM);

SDL_IM = NULL;

}

}

#endif

WM_DELETE_WINDOW = pXInternAtom(SDL_Display, "WM_DELETE_WINDOW", False);

pXSetWMProtocols(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(pXDisplayName(display), ":", 1) == 0) ||

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

local_X11 = 1;

} else {

local_X11 = 0;

}

#if defined(__osf__) && defined(X11_DYNAMIC)

/* 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);

SDL_Display = pXOpenDisplay(display);

}

#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.

*/

if ( GFX_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 */

/* Set the X extension error handler */

Xext_handler = pXSetExtensionErrorHandler(xext_errhandler);

/* 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)

return -1;

/* 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;

}

X11_SaveVidModeGamma(this);

/* See if we have been passed a window to use */

/* 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 */

this->info.wm_available = 1;

/* We're done! */

return(0);

}

static void X11_DestroyWindow(_THIS, SDL_Surface *screen)

{

/* Clean up OpenGL */

if ( screen ) {

screen->flags &= ~(SDL_OPENGL|SDL_OPENGLBLIT);

}

X11_GL_Shutdown(this);

if ( ! SDL_windowid ) {

/* Hide the managed window */

if ( WMwindow ) {

}

if ( screen && (screen->flags & SDL_FULLSCREEN) ) {

screen->flags &= ~SDL_FULLSCREEN;

X11_LeaveFullScreen(this);

}

/* Destroy the output window */

if ( SDL_Window ) {

}

/* Free the colormap entries */

if ( SDL_XPixels ) {

int numcolors;

unsigned long pixel;

numcolors = SDL_Visual->map_entries;

for ( pixel=0; pixel<numcolors; ++pixel ) {

while ( SDL_XPixels[pixel] > 0 ) {

SDL_DisplayColormap,&pixel,1,0);

--SDL_XPixels[pixel];

}

}

SDL_XPixels = NULL;

}

/* Free the graphics context */

if ( SDL_GC ) {

SDL_GC = 0;

}

}

}

static SDL_bool X11_WindowPosition(_THIS, int *x, int *y, int w, int h)

{

const char *window = SDL_getenv("SDL_VIDEO_WINDOW_POS");

const char *center = SDL_getenv("SDL_VIDEO_CENTERED");

return SDL_TRUE;

}

center = window;

}

}

if ( center ) {

*x = (DisplayWidth(SDL_Display, SDL_Screen) - w)/2;

*y = (DisplayHeight(SDL_Display, SDL_Screen) - h)/2;

return SDL_TRUE;

}

return SDL_FALSE;

}

static void X11_SetSizeHints(_THIS, int w, int h, Uint32 flags)

{

XSizeHints *hints;

if ( hints ) {

if ( flags & SDL_RESIZABLE ) {

hints->min_width = 32;

hints->min_height = 32;

hints->max_height = 4096;

hints->max_width = 4096;

} else {

hints->min_width = hints->max_width = w;

hints->min_height = hints->max_height = h;

}

hints->flags = PMaxSize | PMinSize;

if ( flags & SDL_FULLSCREEN ) {

hints->x = 0;

hints->y = 0;

hints->flags |= USPosition;

} else

/* Center it, if desired */

/* Flush the resize event so we don't catch it later */

pXSetWMNormalHints(SDL_Display, WMwindow, hints);

pXFree(hints);

}

/* Respect the window caption style */

if ( flags & SDL_NOFRAME ) {

SDL_bool set;

Atom WM_HINTS;

/* We haven't modified the window manager hints yet */

set = SDL_FALSE;

/* First try to set MWM hints */

if ( WM_HINTS != None ) {

/* Hints used by Motif compliant window managers */

struct {

unsigned long flags;

unsigned long functions;

unsigned long decorations;

long input_mode;

unsigned long status;

} MWMHints = { (1L << 1), 0, 0, 0, 0 };

WM_HINTS, WM_HINTS, 32,

PropModeReplace,

(unsigned char *)&MWMHints,

sizeof(MWMHints)/sizeof(long));

set = SDL_TRUE;

}

/* Now try to set KWM hints */

if ( WM_HINTS != None ) {

long KWMHints = 0;

WM_HINTS, WM_HINTS, 32,

PropModeReplace,

(unsigned char *)&KWMHints,

sizeof(KWMHints)/sizeof(long));

set = SDL_TRUE;

}

/* Now try to set GNOME hints */

if ( WM_HINTS != None ) {

long GNOMEHints = 0;

WM_HINTS, WM_HINTS, 32,

PropModeReplace,

(unsigned char *)&GNOMEHints,

sizeof(GNOMEHints)/sizeof(long));

set = SDL_TRUE;

}

/* Finally set the transient hints if necessary */

if ( ! set ) {

}

} else {

SDL_bool set;

Atom WM_HINTS;

/* We haven't modified the window manager hints yet */

set = SDL_FALSE;

/* First try to unset MWM hints */

set = SDL_TRUE;

}

/* Now try to unset KWM hints */

set = SDL_TRUE;

}

/* Now try to unset GNOME hints */

set = SDL_TRUE;

}

/* Finally unset the transient hints if necessary */

if ( ! set ) {

/* NOTE: Does this work? */

}

}

}

static int X11_CreateWindow(_THIS, SDL_Surface *screen,

int w, int h, int bpp, Uint32 flags)

{

int i, depth;

Visual *vis;

int vis_change;

/* If a window is already present, destroy it and start fresh */

if ( SDL_Window ) {

X11_DestroyWindow(this, screen);

}

/* See if we have been given a window id */

if ( SDL_windowid ) {

} else {

SDL_Window = 0;

}

/* find out which visual we are going to use */

if ( flags & SDL_OPENGL ) {

XVisualInfo *vi;

vi = X11_GL_GetVisual(this);

if( !vi ) {

return -1;

}

vis = vi->visual;

depth = vi->depth;

} else if ( SDL_windowid ) {

XWindowAttributes a;

vis = a.visual;

depth = a.depth;

} else {

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

if ( this->hidden->visuals[i].bpp == bpp )

break;

}

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

SDL_SetError("No matching visual for requested depth");

return -1; /* should never happen */

}

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

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

}

#ifdef X11_DEBUG

printf("Choosing %s visual at %d bpp - %d colormap entries\n", vis->class == PseudoColor ? "PseudoColor" : (vis->class == TrueColor ? "TrueColor" : (vis->class == DirectColor ? "DirectColor" : "Unknown")), depth, vis->map_entries);

#endif

vis_change = (vis != SDL_Visual);

SDL_Visual = vis;

this->hidden->depth = depth;

/* Allocate the new pixel format for this video mode */

if ( ! SDL_ReallocFormat(screen, bpp,

vis->red_mask, vis->green_mask, vis->blue_mask, 0) )

return -1;

/* Create the appropriate colormap */

if ( SDL_XColorMap != SDL_DisplayColormap ) {