"

COPYRIGHT (c) 1989 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

"{ Package: 'stx:libview' }"

DeviceWorkstation subclass:#XWorkstation

	instanceVariableNames:'hasShapeExtension hasShmExtension hasDPSExtension

		hasMbufExtension hasXVideoExtension hasSaveUnder hasPEXExtension

		hasImageExtension hasInputExtension ignoreBackingStore blackpixel

		whitepixel protocolsAtom deleteWindowAtom saveYourselfAtom

		quitAppAtom primaryAtom secondaryAtom cutBuffer0Atom stringAtom

		lengthAtom wmStateAtom listOfXFonts buttonsPressed eventRootX

		eventRootY displayName eventTrace dispatchingExpose rgbVisual

		virtualRootId rootId eventBuffer altModifierMask metaModifierMask

		multiClickTime deviceIOTimeoutErrorSignal activateOnClick'

	classVariableNames:'RawKeysymTranslation ConservativeSync'

	poolDictionaries:''

	category:'Interface-Graphics'

!

!XWorkstation primitiveDefinitions!

%{

#ifdef LINUX

# define SHM

#endif

#define COUNT_RESOURCES

#ifdef COUNT_RESOURCES

static int __cnt_color = 0;

static int __cnt_bitmap = 0;

static int __cnt_view = 0;

static int __cnt_gc = 0;

static int __cnt_cursor = 0;

static int __cnt_font = 0;

#endif

/*

 * x does a typedef Time - I need Object Time ...

 */

#undef Time

#define Time XTime

/*

 * x does a #define True / False

 * we are lucky - the ST/X True/False are not needed

 */

#undef True

#undef False

#ifdef memset

# undef memset

#endif

#include <stdio.h>

#include <X11/Xlib.h>

#include <X11/Xutil.h>

#include <X11/Xatom.h>

#define XK_MISCELLANY

#include <X11/keysymdef.h>

#include <X11/cursorfont.h>

#ifdef LINUX

# include <sys/socket.h>

#endif

/*

 * this define suppresses XAllocColor/XFreeColor on

 * TrueColor systems - I am not certain, if this is

 * always legal to do (it works with XFree servers).

 */

#define QUICK_TRUE_COLORS

/*

 * shape support works; enabled by -DSHAPE in makefile

 * see RoundClock and RoundGlobe examples

 */

#ifdef SHAPE

# include <X11/extensions/shape.h>

#endif

/*

 * shared memory extension access is currently not supported

 * (only query is implemented)

 */

#ifdef SHM

# include <X11/extensions/XShm.h>

#endif

/*

 * multiBuffer extension access is currently not supported

 * (only query is implemented)

 */

#ifdef MBUF

# include <X11/extensions/multibuf.h>

#endif

/*

 * XVideo extension access is currently not supported

 * (only query is implemented)

 */

#ifdef XVIDEO

# include <X11/extensions/Xv.h>

#endif

/*

 * PEX extension - if available

 */

#ifdef PEX5

# include <PEX5/PEX.h>

#endif

/*

 * XImage extension - if available

 */

#ifdef XIE

# include <X11/extensions/XIE.h>

#endif

/*

 * when I have more time to check it out, I will support display-PS

 */

#ifdef DPS

# ifdef sgi

#  include <X11/extensions/XDPS.h>

#  include <X11/extensions/XDPSlib.h>

#  include <X11/extensions/dpsXclient.h>

# else

#  include <DPS/XDPS.h>

#  include <DPS/XDPSlib.h>

#  include <DPS/dpsXclient.h>

# endif

#endif

#if defined(someMachine)

/*

 * if nformats cannot be found in the Display structure ...

 */

# define NO_PRIVATE_DISPLAY_ACCESS

#endif

#if defined(IRIX5) || defined(__VMS) || (XlibSpecificationRelease == 6)

  /*

   * accessing private data in Display ... sorry

   */

# define DISPLAYACCESS(d) ((_XPrivDisplay)d)

#else

# define DISPLAYACCESS(d) d

#endif

/*

 * some defines - tired of typing ...

 */

#define _DisplayVal(o)       (Display *)(__externalAddressVal(o))

#define _WindowVal(o)        (Window)(__externalAddressVal(o))

#define _PixmapVal(o)        (Pixmap)(__externalAddressVal(o))

#define _GCVal(o)            (GC)(__externalAddressVal(o))

#define _CursorVal(o)        (Cursor)(__externalAddressVal(o))

#define _FontVal(o)          (XFontStruct *)(__externalAddressVal(o))

#define _DPSContextVal(o)    (DPSContext)(__externalAddressVal(o))

#define __MKATOMOBJ(a)       __MKSMALLINT(a)

#define _AtomVal(o)          __intVal(o)

#define __isAtomID(o)        __isSmallInteger(o)

#define myDpy                _DisplayVal(__INST(displayId))

#define ISCONNECTED          (__INST(displayId) != nil)

#ifdef __VMS__

# include "vms_Xnames.h"

#endif

void __XTimeoutErrorHandler();

int __XErrorHandler__();

int __XIOErrorHandler__();

#if 1 /* LINUX */

# define DEFAULT_XLIB_TIMEOUT   600     /* in 50ms ticks (30 seconds) */

  static __xlibTimeout__ = DEFAULT_XLIB_TIMEOUT;

# define ENTER_XLIB()   \

    { \

	__blockingPrimitiveTimoutHandler__ = (VOIDFUNC)__XTimeoutErrorHandler; \

	__blockingPrimitiveTimeoutArg__ = (INT)self; \

	__blockingPrimitiveTimeout__ = __xlibTimeout__; \

    } {

# define LEAVE_XLIB()   \

    { \

	__blockingPrimitiveTimeout__ = 0; \

    } }

#else

# define ENTER_XLIB() {  /* as nothing */

# define LEAVE_XLIB() }  /* as nothing */

#endif

%}

! !

!XWorkstation primitiveVariables!

%{

/*

 * remembered info from private error handler

 */

static char lastErrorMsg[128] = "";

static unsigned INT lastRequestCode = 0;

static unsigned INT lastMinorCode = 0;

static unsigned INT lastResource = 0;

static int __debug__ = 0;

#define DPRINTF(x)      if (__debug__) { printf x; }

%}

! !

!XWorkstation primitiveFunctions!

%{

/*

 * some systems need a dummy reference to force the linker

 * to include that stuff. Should be #ifdef'd ...

 */

#ifndef ELF

# ifdef __GNUC__

VOLATILE 

# endif

static

dummyToForceLoading() {

	XCreateSimpleWindow(0, 0, 0, 0, 0, 0, 0, 0, 0);

	XCloseDisplay(0);

	XCreateImage(0, 0, 0 ,0 ,0 ,0 ,0 ,0 ,0 ,0);

	XSetWindowColormap(0, 0, 0);

	XQueryColors(0,0,0,0);

# ifdef SHM

	XShmAttach(0, 0);

	XShmCreateImage(0, 0, 0, 0, 0, 0, 0 ,0);

	XShmDetach(0, 0);

	XShmPutImage(0, 0, 0, 0 , 0,0,0,0,0,0,0);

	shmctl(0,0,0);

	fgetc(0);

# endif

}

#endif

/*

 * catch X-errors and forward as errorInterrupt:#DisplayError,

 * (which itself invokes my handler and optionally raises an exceptionSignal)

 * the implementation below is somewhat wrong: it will

 * report all errors for Display, even though there could be

 * more than one display connection. (being fixed, new errorInterrupt mechanism

 * allows passing an additional argument, which is the displayID ...)

 */

int

__XErrorHandler__(dpy, event)

    Display *dpy;

    XErrorEvent *event;

{

    XGetErrorText(dpy, event->error_code, lastErrorMsg, 127);

    lastErrorMsg[127] = '\0';

    if (lastErrorMsg[0] == '\0') {

	sprintf(lastErrorMsg, "code: %d", event->error_code);

    }

    lastRequestCode = event->request_code;

    lastMinorCode = event->minor_code;

    lastResource = event->resourceid;

    if ((event->error_code == BadWindow) && (lastRequestCode == 4) && (lastMinorCode == 0)) {

	/* 

	 * this is a BadWindow error for X_DestroyWindow.

	 * ignore it here, since it results from the GC freeing windows

	 * in non bottom-up window order.

	 */

	return 0;

    }

    if (@global(ErrorPrinting) == true) {

	fprintf(stderr, "XWorkstation [error]: x-error caught maj=%d (0x%x) min=%d (0x%x) resource=%x\n",

			event->request_code, event->request_code, 

			event->minor_code, event->minor_code, event->resourceid);

	fprintf(stderr, "XWorkstation [error]: x-error message is [%d] '%s'\n", 

			event->error_code, lastErrorMsg);

    }

    __errorInterruptWithIDAndParameter__(@symbol(DisplayError), __MKEXTERNALADDRESS(dpy));

    return 0;

}

/*

 * much like the above, but for IO Errors;

 * forwarded as errorInterrupt:#DisplayIOError,

 * In single display apps, handling those here does not

 * really make sense (except, for a controlled cleanup).

 * However, in multiDisplay apps, a single broken

 * connection should not affect the other users.

 */

int

__XIOErrorHandler__(dpy)

    Display *dpy;

{

    if (@global(ErrorPrinting) == true) {

	fprintf(stderr, "XWorkstation [error]: I/O error\n");

    }

    __immediateErrorInterruptWithIDAndParameter__(@symbol(DisplayIOError),

						  __MKEXTERNALADDRESS(dpy));

#if 0

    /*

     * don't do this.

     * This error is called asynchronously, and the wrong process may be terminated

     */

    /*

     * if we return from the error interrupt ...

     */

    __internalError("unhandled display I/O error");

    __terminateProcess(0);      /* soft terminate */

    __terminateProcess(1);      /* hard terminate */

    /* never reached */

#endif

    return 0;

}

/*

 * timeout error in case of Xlib request timeout.

 * forwarded as errorInterrupt:#DisplayIOTimeoutError,

 * This is generated synthetically by the VM if the

 * timeoutHandler has been set.

 */

void

__XTimeoutErrorHandler(displayDeviceInst)

    OBJ displayDeviceInst;

{

    if (@global(ErrorPrinting) == true) {

	fprintf(stderr, "XWorkstation [error]: I/O request timeout dpy=%x\n", displayDeviceInst);

    }

    if (displayDeviceInst == @global(MainDisplay)) {

	fprintf(stderr, "XWorkstation [error]: keep display connection for master display (no shutdown)\n");

	return;

    }

#if 0

This is litter: 

    1. How should I ever close the display without a displayId?

    2. This may loop for ever, if there is some data in the socket, but #eventPending returns

       false because displayId is nil.

    3. The problem is not the EventListener, which is reading (and waiting in #eventPending),

       but maybe other processes writing to the Display and blocking the system again (for 30 Seconds).

    /*

     * must immediately flush that displays deviceID - otherwise,

     * the scheduler may try to ask for pending events without a watchdog

     * timer ...

     */

    __OINST(displayDeviceInst, displayId) = nil;

#endif

    __immediateErrorInterruptWithIDAndParameter__(@symbol(DisplayIOTimeoutError), displayDeviceInst);

    /*

     * if we return from the error interrupt ...

     */

    if (__OINST(displayDeviceInst, displayId) != nil) {

	__internalError("unhandled display Timeout error");

	__terminateProcess(0);      /* soft terminate */

	__terminateProcess(1);      /* hard terminate */

    }

}

#ifdef VIRTUAL_ROOT

/*

 * added since RootWindow-macro is not sufficient

 * when virtual root-windows are involved (i.e. tvtwm)

 */

static Window

getRootWindow(dpy, screen)

    Display *dpy;

{

    Window root;

    Atom vRootAtom = None;

    int i;

    Window rootReturn, parentReturn;

    Window* children = (Window *)0;

    unsigned int numChildren;

    root = RootWindow(dpy, screen);

    /*

     * on IRIS, this creates a badwindow error - why ?

     * children contains a funny window (000034)

     */

# if !defined(IRIS) || defined(IRIX5)

    if (root) {

	if (XQueryTree(dpy, root, &rootReturn, &parentReturn, &children, &numChildren)) {

	    vRootAtom = XInternAtom(dpy, "__SWM_VROOT", True );

	    if (vRootAtom != None) {

		for (i=0; i < numChildren; i++) {

		    Atom actual_type;

		    int actual_format;

		    unsigned long nitems, bytesafter;

		    Window* newRoot = (Window*) 0;

		    if (children[i]) {

			if (XGetWindowProperty(dpy, children[i], vRootAtom,

					       0L, 1L, False, XA_WINDOW,

					       &actual_type, &actual_format, &nitems, &bytesafter,

					       (unsigned char**) &newRoot) == Success && newRoot) {

			    root = *newRoot;

			    XFree(newRoot); /* XXX */

			    break;

			}

		    }

		}

	    }

	    if (children) XFree( children );

	}

    }

# endif

    return root;

}

#endif

%}

! !

!XWorkstation class methodsFor:'documentation'!

copyright

"

COPYRIGHT (c) 1989 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

    this class provides the interface to X11. It redefines all required methods

    from DeviceWorkstation. Notice, that in Smalltalk/X you are not technically

    limited to one display - in theory, you can create Views on many displays

    simultanously. However, the default setup is for one display only.

    To support multiple displays, you will have to start another event dispatcher

    process for the other display(s) and create the other views with a slightly

    different protocol. However, 'normal' applications do not have to care for

    all of this ...

    See more documentation in my superclass, DeviceWorkstation.

    [author:]

	Claus Gittinger

"

! !

!XWorkstation class methodsFor:'initialization'!

initialize

    |d|

    super initialize.

    ConservativeSync := OperatingSystem platformName == #win32.

    RawKeysymTranslation isNil ifTrue:[

	"/ the following table maps X-keyevents to ST/X

	"/ device independed events. 

	"/ It is NOT meant as a keyboardMap replacement.