SetValues.c

/* $Xorg: SetValues.c,v 1.4 2001/02/09 02:03:58 xorgcvs Exp $ */

/***********************************************************
Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts
Copyright 1993 by Sun Microsystems, Inc. Mountain View, CA.

                        All Rights Reserved

Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted,
provided that the above copyright notice appear in all copies and that
both that copyright notice and this permission notice appear in
supporting documentation, and that the names of Digital or Sun not be
used in advertising or publicity pertaining to distribution of the
software without specific, written prior permission.

DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE.

SUN DISCLAIMS ALL WARRANTIES WITH REGARD TO  THIS  SOFTWARE,
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FIT-
NESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SUN BE  LI-
ABLE  FOR  ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,  DATA  OR
PROFITS,  WHETHER  IN  AN  ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION  WITH
THE USE OR PERFORMANCE OF THIS SOFTWARE.

******************************************************************/

/*

Copyright 1987, 1988, 1994, 1998  The Open Group

Permission to use, copy, modify, distribute, and sell this software and its
documentation for any purpose is hereby granted without fee, provided that
the above copyright notice appear in all copies and that both that
copyright notice and this permission notice appear in supporting
documentation.

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of The Open Group shall not be
used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from The Open Group.

*/
/* $XFree86: xc/lib/Xt/SetValues.c,v 1.2 2001/08/22 22:52:19 dawes Exp $ */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "IntrinsicI.h"

/*
 *	XtSetValues(), XtSetSubvalues()
 */


static void SetValues(
  char*			base,		/* Base address to write values to   */
  XrmResourceList*	res,		/* The current resource values.      */
  register Cardinal	num_resources,	/* number of items in resources      */
  ArgList 		args,		/* The resource values to set        */
  Cardinal		num_args)	/* number of items in arg list       */
{
    register ArgList		arg;
    register Cardinal 	        i;
    register XrmName		argName;
    register XrmResourceList*   xrmres;

    /* Resource lists are assumed to be in compiled form already via the
       initial XtGetResources, XtGetSubresources calls */

    for (arg = args ; num_args != 0; num_args--, arg++) {
	argName = StringToName(arg->name);
	for (xrmres = res, i = 0; i < num_resources; i++, xrmres++) {
	    if (argName == (*xrmres)->xrm_name) {
		_XtCopyFromArg(arg->value,
		    base - (*xrmres)->xrm_offset - 1,
		    (*xrmres)->xrm_size);
		break;
	    }
	}
    }
} /* SetValues */

static Boolean CallSetValues (
    WidgetClass class,
    Widget      current,
    Widget      request,
    Widget      new,
    ArgList     args,
    Cardinal    num_args)
{
    Boolean redisplay = FALSE;
    WidgetClass superclass;
    XtArgsFunc set_values_hook;
    XtSetValuesFunc set_values;

    LOCK_PROCESS;
    superclass = class->core_class.superclass;
    UNLOCK_PROCESS;
    if (superclass)
        redisplay =
	    CallSetValues(superclass, current, request, new, args, num_args);

    LOCK_PROCESS;
    set_values = class->core_class.set_values;
    UNLOCK_PROCESS;
    if (set_values)
        redisplay |= (*set_values) (current, request, new, args, &num_args);

    LOCK_PROCESS;
    set_values_hook = class->core_class.set_values_hook;
    UNLOCK_PROCESS;
    if (set_values_hook)
	redisplay |= (*set_values_hook) (new, args, &num_args);
    return (redisplay);
}

static Boolean
CallConstraintSetValues (
    ConstraintWidgetClass class,
    Widget      current,
    Widget      request,
    Widget      new,
    ArgList     args,
    Cardinal    num_args)
{
    Boolean redisplay = FALSE;
    XtSetValuesFunc set_values;
    ConstraintWidgetClass superclass;

    if ((WidgetClass)class != constraintWidgetClass) {
	if (class == NULL)
	    XtAppErrorMsg(XtWidgetToApplicationContext(current),
		    "invalidClass","constraintSetValue",XtCXtToolkitError,
                 "Subclass of Constraint required in CallConstraintSetValues",
                  (String *)NULL, (Cardinal *)NULL);
	LOCK_PROCESS;
	superclass = (ConstraintWidgetClass) class->core_class.superclass;
	UNLOCK_PROCESS;
	redisplay =
	   CallConstraintSetValues(superclass,
				   current, request, new, args, num_args);
    }
    LOCK_PROCESS;
    set_values = class->constraint_class.set_values;
    UNLOCK_PROCESS;
    if (set_values)
        redisplay |= (*set_values) (current, request, new, args, &num_args);
    return (redisplay);
}

void XtSetSubvalues(
  XtPointer             base,           /* Base address to write values to   */
  register XtResourceList resources,    /* The current resource values.      */
  register Cardinal     num_resources,  /* number of items in resources      */
  ArgList               args,           /* The resource values to set        */
  Cardinal              num_args)       /* number of items in arg list       */
{
      register XrmResourceList*   xrmres;
      xrmres = _XtCreateIndirectionTable (resources, num_resources);
      SetValues((char*)base,xrmres,num_resources, args, num_args);
      XtFree((char *)xrmres);
}


void XtSetValues(
    register Widget   w,
	     ArgList  args,
	     Cardinal num_args)
{
    register Widget oldw, reqw;
    /* need to use strictest alignment rules possible in next two decls. */
    double	    oldwCache[100], reqwCache[100];
    double	    oldcCache[20], reqcCache[20];
    Cardinal	    widgetSize, constraintSize;
    Boolean	    redisplay, cleared_rect_obj = False;
    XtGeometryResult result;
    XtWidgetGeometry geoReq, geoReply;
    WidgetClass     wc;
    ConstraintWidgetClass cwc = 0;
    Boolean	    hasConstraints;
    XtAlmostProc set_values_almost;
    XtAppContext app = XtWidgetToApplicationContext(w);
    Widget hookobj = XtHooksOfDisplay(XtDisplayOfObject(w));

    LOCK_APP(app);
    wc = XtClass(w);
    if ((args == NULL) && (num_args != 0)) {
        XtAppErrorMsg(app,
		"invalidArgCount","xtSetValues",XtCXtToolkitError,
                "Argument count > 0 on NULL argument list in XtSetValues",
                 (String *)NULL, (Cardinal *)NULL);
    }

    /* Allocate and copy current widget into old widget */

    LOCK_PROCESS;
    widgetSize = wc->core_class.widget_size;
    UNLOCK_PROCESS;
    oldw = (Widget) XtStackAlloc(widgetSize, oldwCache);
    reqw = (Widget) XtStackAlloc (widgetSize, reqwCache);
    (void) memmove((char *) oldw, (char *) w, (int) widgetSize);

    /* Set resource values */

    LOCK_PROCESS;
    SetValues((char*)w, (XrmResourceList *) wc->core_class.resources,
	wc->core_class.num_resources, args, num_args);
    UNLOCK_PROCESS;

    (void) memmove ((char *) reqw, (char *) w, (int) widgetSize);

    hasConstraints = (XtParent(w) != NULL && !XtIsShell(w) && XtIsConstraint(XtParent(w)));

    /* Some widget sets apparently do ugly things by freeing the
     * constraints on some children, thus the extra test here */
    if (hasConstraints) {
	cwc = (ConstraintWidgetClass) XtClass(w->core.parent);
	if (w->core.constraints) {
	    LOCK_PROCESS;
	    constraintSize = cwc->constraint_class.constraint_size;
	    UNLOCK_PROCESS;
	} else constraintSize = 0;
    } else constraintSize = 0;

    if (constraintSize) {
	/* Allocate and copy current constraints into oldw */
	oldw->core.constraints = XtStackAlloc(constraintSize, oldcCache);
	reqw->core.constraints = XtStackAlloc(constraintSize, reqcCache);
	(void) memmove((char *) oldw->core.constraints,
		       (char *) w->core.constraints, (int) constraintSize);

	/* Set constraint values */
	LOCK_PROCESS;
	SetValues((char*)w->core.constraints,
	    (XrmResourceList *)(cwc->constraint_class.resources),
	    cwc->constraint_class.num_resources, args, num_args);
	UNLOCK_PROCESS;
	(void) memmove((char *) reqw->core.constraints,
		       (char *) w->core.constraints, (int) constraintSize);
    }

    /* Inform widget of changes, then inform parent of changes */
    redisplay = CallSetValues (wc, oldw, reqw, w, args, num_args);
    if (hasConstraints) {
	redisplay |= CallConstraintSetValues(cwc, oldw, reqw, w, args, num_args);
    }

    if (XtHasCallbacks(hookobj, XtNchangeHook) == XtCallbackHasSome) {
	XtChangeHookDataRec call_data;
	XtChangeHookSetValuesDataRec set_val;

	set_val.old = oldw;
	set_val.req = reqw;
	set_val.args = args;
	set_val.num_args = num_args;
	call_data.type = XtHsetValues;
	call_data.widget = w;
	call_data.event_data = (XtPointer) &set_val;
	XtCallCallbackList(hookobj,
		((HookObject)hookobj)->hooks.changehook_callbacks,
		(XtPointer)&call_data);
    }

    if (XtIsRectObj(w)) {
	/* Now perform geometry request if needed */
	geoReq.request_mode = 0;
	if (oldw->core.x	!= w->core.x) {
	    geoReq.x		= w->core.x;
	    w->core.x		= oldw->core.x;
	    geoReq.request_mode |= CWX;
	}
	if (oldw->core.y	!= w->core.y) {
	    geoReq.y		= w->core.y;
	    w->core.y		= oldw->core.y;
	    geoReq.request_mode |= CWY;
	}
	if (oldw->core.width	!= w->core.width) {
	    geoReq.width	= w->core.width;
	    w->core.width	= oldw->core.width;
	    geoReq.request_mode |= CWWidth;
	}
	if (oldw->core.height	!= w->core.height) {
	    geoReq.height	= w->core.height;
	    w->core.height	= oldw->core.height;
	    geoReq.request_mode |= CWHeight;
	}
	if (oldw->core.border_width != w->core.border_width) {
	    geoReq.border_width	    = w->core.border_width;
	    w->core.border_width    = oldw->core.border_width;
	    geoReq.request_mode	    |= CWBorderWidth;
	}

	if (geoReq.request_mode != 0) {
	    /* Pass on any requests for unchanged geometry values */
	    if (geoReq.request_mode !=
		(CWX | CWY | CWWidth | CWHeight | CWBorderWidth)) {
		for ( ; num_args != 0; num_args--, args++) {
		    if (! (geoReq.request_mode & CWX) &&
			strcmp(XtNx, args->name) == 0) {
			geoReq.x = w->core.x;
			geoReq.request_mode |= CWX;
		    } else if (! (geoReq.request_mode & CWY) &&
			       strcmp(XtNy, args->name) == 0) {
			geoReq.y = w->core.y;
			geoReq.request_mode |= CWY;
		    } else if (! (geoReq.request_mode & CWWidth) &&
			       strcmp(XtNwidth, args->name) == 0) {
			geoReq.width = w->core.width;
			geoReq.request_mode |= CWWidth;
		    } else if (! (geoReq.request_mode & CWHeight) &&
			       strcmp(XtNheight, args->name) == 0) {
			geoReq.height = w->core.height;
			geoReq.request_mode |= CWHeight;
		    } else if (! (geoReq.request_mode & CWBorderWidth) &&
			       strcmp(XtNborderWidth, args->name) == 0) {
			geoReq.border_width = w->core.border_width;
			geoReq.request_mode |= CWBorderWidth;
		    }
		}
	    }
	    CALLGEOTAT(_XtGeoTrace(w,
		     "\nXtSetValues sees some geometry changes for \"%s\".\n",
			   XtName(w)));
	    CALLGEOTAT(_XtGeoTab(1));
	    do {
		XtGeometryHookDataRec call_data;

		if (XtHasCallbacks(hookobj, XtNgeometryHook) == XtCallbackHasSome) {
		    call_data.type = XtHpreGeometry;
		    call_data.widget = w;
		    call_data.request = &geoReq;
		    XtCallCallbackList(hookobj,
			((HookObject)hookobj)->hooks.geometryhook_callbacks,
			(XtPointer)&call_data);
		    call_data.result = result =
			_XtMakeGeometryRequest(w, &geoReq, &geoReply,
					       &cleared_rect_obj);
		    call_data.type = XtHpostGeometry;
		    call_data.reply = &geoReply;
		    XtCallCallbackList(hookobj,
			((HookObject)hookobj)->hooks.geometryhook_callbacks,
			(XtPointer)&call_data);
		} else {
		    result = _XtMakeGeometryRequest(w, &geoReq, &geoReply,
						    &cleared_rect_obj);
		}
		if (result == XtGeometryYes || result == XtGeometryDone)
		    break;

		/* An Almost or No reply.  Call widget and let it munge
		   request, reply */
		LOCK_PROCESS;
		set_values_almost = wc->core_class.set_values_almost;
		UNLOCK_PROCESS;
		if (set_values_almost == NULL) {
		    XtAppWarningMsg(app,
			    "invalidProcedure","set_values_almost",
			  XtCXtToolkitError,
			  "set_values_almost procedure shouldn't be NULL",
			  (String *)NULL, (Cardinal *)NULL);
		    break;
		}
		if (result == XtGeometryNo) geoReply.request_mode = 0;
		CALLGEOTAT(_XtGeoTrace(w,"calling SetValuesAlmost.\n"));
		(*set_values_almost) (oldw, w, &geoReq, &geoReply);
	    } while (geoReq.request_mode != 0);
	    /* call resize proc if we changed size and parent
	     * didn't already invoke resize */
	    {
	    XtWidgetProc resize;
	    LOCK_PROCESS;
	    resize = wc->core_class.resize;
	    UNLOCK_PROCESS;
	    if ((w->core.width != oldw->core.width ||
		 w->core.height != oldw->core.height)
		&& result != XtGeometryDone
		&& resize != (XtWidgetProc) NULL) {
		CALLGEOTAT(_XtGeoTrace(w,
				 "XtSetValues calls \"%s\"'s resize proc.\n",
			       XtName(w)));
		(*resize)(w);
	      }
	    }
	    CALLGEOTAT(_XtGeoTab(-1));
	}
	/* Redisplay if needed.  No point in clearing if the window is
	 * about to disappear, as the Expose event will just go straight
	 * to the bit bucket. */
        if (XtIsWidget(w)) {
            /* widgets can distinguish between redisplay and resize, since
             the server will cause an expose on resize */
            if (redisplay && XtIsRealized(w) && !w->core.being_destroyed) {
                CALLGEOTAT(_XtGeoTrace(w,
				 "XtSetValues calls ClearArea on \"%s\".\n",
			       XtName(w)));
		XClearArea (XtDisplay(w), XtWindow(w), 0, 0, 0, 0, TRUE);
	    }
        } else { /*non-window object */
	  if (redisplay && ! cleared_rect_obj ) {
	      Widget pw = _XtWindowedAncestor(w);
	      if (XtIsRealized(pw) && !pw->core.being_destroyed) {
		  RectObj r = (RectObj)w;
		  int bw2 = r->rectangle.border_width << 1;
		  CALLGEOTAT(_XtGeoTrace(w,
		   "XtSetValues calls ClearArea on \"%s\"'s parent \"%s\".\n",
				 XtName(w),XtName(pw)));
		  XClearArea (XtDisplay (pw), XtWindow (pw),
			      r->rectangle.x, r->rectangle.y,
			      r->rectangle.width + bw2,
			      r->rectangle.height + bw2,TRUE);
	      }
	  }
        }
    }


    /* Free dynamic storage */
    if (constraintSize) {
        XtStackFree(oldw->core.constraints, oldcCache);
        XtStackFree(reqw->core.constraints, reqcCache);
    }
    XtStackFree((XtPointer)oldw, oldwCache);
    XtStackFree((XtPointer)reqw, reqwCache);
    UNLOCK_APP(app);
} /* XtSetValues */