/* 

 * Motif

 *

 * Copyright (c) 1987-2012, The Open Group. All rights reserved.

 *

 * These libraries and programs are free software; you can

 * redistribute them and/or modify them under the terms of the GNU

 * Lesser General Public License as published by the Free Software

 * Foundation; either version 2 of the License, or (at your option)

 * any later version.

 *

 * These libraries and programs are distributed in the hope that

 * they will be useful, but WITHOUT ANY WARRANTY; without even the

 * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR

 * PURPOSE. See the GNU Lesser General Public License for more

 * details.

 *

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

 * License along with these librararies and programs; if not, write

 * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth

 * Floor, Boston, MA 02110-1301 USA

*/ 

/* 

 * Motif Release 1.2.3

*/ 

#ifdef HAVE_CONFIG_H

#include <config.h>

#endif

#ifdef REV_INFO

#ifndef lint

static char rcsid[] = "$TOG: WmProperty.c /main/7 1997/12/02 10:00:00 bill $"

#endif

#endif

/*

 * (c) Copyright 1987, 1988, 1989, 1990, 1993 HEWLETT-PACKARD COMPANY */

/*

 * Included Files:

 */

#include "WmGlobal.h"

#include "WmICCC.h"

#include <stdio.h>

#ifdef WSM

#include 

#include <X11/Xatom.h>

#endif /* WSM */

/*

 * include extern functions

 */

#include "WmColormap.h"

#include "WmError.h"

#include "WmResParse.h"

/*

 * Function Declarations:

 */

#include "WmProperty.h"

/*

 * Global Variables:

 */

static SizeHints sizeHints;

/*************************************<->*************************************

 *

 *  SizeHints *

 *  GetNormalHints (pCD)

 *

 *

 *  Description:

 *  -----------

 *  This function replaces the XGetNormalHints Xlib function.  This function

 *  gets the information in the WM_NORMAL_HINTS property on the client window.

 *  The property encoding can be any of the supported versions (R2, R3+).

 *

 *

 *  Inputs:

 *  ------

 *  pCD = (client)

 *

 * 

 *  Outputs:

 *  -------

 *  Return = A pointer to a filled out SizeHints structure is returned.

 *           Default values are set if the WM_NORMAL_HINTS property could

 *           not be retrieved.

 *

 *************************************<->***********************************/

SizeHints * 

GetNormalHints(

        ClientData *pCD )

{

    PropSizeHints *property = NULL;

    Atom actualType;

    int actualFormat;

    unsigned long leftover;

    unsigned long nitems;

    /*

     * Retrieve the property data.

     *

     *     ICCC_R2 version:  nitems = PROP_SIZE_HINTS_ELEMENTS - 3

     *     ICCC_CURRENT version: nitems = PROP_SIZE_HINTS_ELEMENTS

     */

#ifdef WSM

    if ((!HasProperty (pCD, XA_WM_NORMAL_HINTS)) ||

	((Success != XGetWindowProperty (DISPLAY, pCD->client,

			XA_WM_NORMAL_HINTS, 0L, (long)PROP_SIZE_HINTS_ELEMENTS,

			False, XA_WM_SIZE_HINTS, &actualType, &actualFormat,

			&nitems, &leftover, (unsigned char **)&property)) ||

	  (actualType != XA_WM_SIZE_HINTS) ||

	  (nitems < (PROP_SIZE_HINTS_ELEMENTS - 3)) ||

	  (actualFormat != 32)))

#else /* WSM */

    if ((Success != XGetWindowProperty (DISPLAY, pCD->client,

			XA_WM_NORMAL_HINTS, 0L, (long)PROP_SIZE_HINTS_ELEMENTS,

			False, XA_WM_SIZE_HINTS, &actualType, &actualFormat,

			&nitems, &leftover, (unsigned char **)&property)) ||

	 (actualType != XA_WM_SIZE_HINTS) ||

	 (nitems < (PROP_SIZE_HINTS_ELEMENTS - 3)) ||

	 (actualFormat != 32))

#endif /* WSM */

    {

	/*

	 * Indicate no property values were retrieved:

	 */

	sizeHints.icccVersion = ICCC_UNKNOWN;

	sizeHints.flags = 0;

    }

    else

    {

	/*

	 * Parse the hint values out of the property data:

	 */

	sizeHints.flags = property->flags;

	sizeHints.x = property->x;

	sizeHints.y = property->y;

	sizeHints.width = property->width;

	sizeHints.height = property->height;

	sizeHints.min_width = property->minWidth;

	sizeHints.min_height = property->minHeight;

	sizeHints.max_width = property->maxWidth;

	sizeHints.max_height = property->maxHeight;

	sizeHints.width_inc = property->widthInc;

	sizeHints.height_inc = property->heightInc;

	sizeHints.min_aspect.x = (int)property->minAspectX;

	sizeHints.min_aspect.y = (int)property->minAspectY;

	sizeHints.max_aspect.x = (int)property->maxAspectX;

	sizeHints.max_aspect.y = (int)property->maxAspectY;

	if (nitems == (PROP_SIZE_HINTS_ELEMENTS - 3))

	{

	    /*

	     *  This is ICCC_R2.

	     */

	    sizeHints.icccVersion = ICCC_R2;

	}

	else

	{

	    /*

	     *  This is ICCC_CURRENT.

	     */

	    sizeHints.icccVersion = ICCC_CURRENT;

	    sizeHints.base_width = property->baseWidth;

	    sizeHints.base_height = property->baseHeight;

	    sizeHints.win_gravity = property->winGravity;

	}

    }

    /*

     * Free the property data buffer:

     */

    if (property)

    {

	XFree ((char *)property);

    }

    /*

     * Return the hints values:

     */

    return (&sizeHints);

} /* END OF FUNCTION GetNormalHints */

/*************************************<->*************************************

 *

 *  ProcessWmProtocols (pCD)

 *

 *

 *  Description:

 *  -----------

 *  This function reads and processes the WM_PROTOCOLS property that is

 *  associated with a client window.

 *

 *  ICCC_COMPLIANT check added to allow older clients to work, for now...

 *  eventually, this code should be removed.

 *

 *  Inputs:

 *  ------

 *  pCD = pointer to client data

 *

 * 

 *  Outputs:

 *  -------

 *  pCD = (clientProtocols, clientProtocolCount, protocolFlags)

 *

 *************************************<->***********************************/

void ProcessWmProtocols (ClientData *pCD)

{

    int rValue;

    Atom *property = NULL;

#ifndef ICCC_COMPLIANT

    Atom actualType;

    int actualFormat;

    unsigned long leftover;

    unsigned long nitems;

#else

    int nitems;

#endif /* ICCC_COMPLIANT */

    int i;

    if (pCD->clientProtocols)

    {

	XtFree ((char *)pCD->clientProtocols);

	pCD->clientProtocols = NULL;

    }

    pCD->clientProtocolCount = 0;

    pCD->protocolFlags = 0;

    /*

     * Read the WM_PROTOCOLS property.

     */

#ifndef ICCC_COMPLIANT

#ifdef WSM

    if (!HasProperty (pCD, wmGD.xa_WM_PROTOCOLS))

	rValue = -1;

    else

#endif /* WSM */

    rValue = XGetWindowProperty (DISPLAY, pCD->client, wmGD.xa_WM_PROTOCOLS, 0L,

		 (long)MAX_CLIENT_PROTOCOL_COUNT, False, AnyPropertyType,

		 &actualType, &actualFormat, &nitems, &leftover,

		 (unsigned char **)&property);

    if ((rValue != Success) || (actualType == None) || (actualFormat != 32))

#else

#ifdef WSM

    if (!HasProperty (pCD, wmGD.xa_WM_PROTOCOLS))

	rValue = -1;

    else

#endif /* WSM */

    rValue = XGetWMProtocols (DISPLAY, pCD->client, 

		 (Atom **)&property, &nitems);

    if (0 == rValue) 

#endif /* ICCC_COMPLIANT */

    {

	/*

	 * WM_PROTOCOLS does not exist or it is an invalid type or size.

	 */

	pCD->clientProtocols = NULL;

    }

    else

    {

        if (!(pCD->clientProtocols = (Atom *)XtMalloc (nitems * sizeof (Atom))))

        {

	    /* unable to allocate space */

	    Warning (((char *)GETMESSAGE(54, 1, "Insufficient memory for window management data")));

        }

	else

	{

	    /*

	     * Save the protocols in the client data and look for predefined

	     * protocols.

	     */

    	    pCD->clientProtocolCount = nitems;

    	    for (i = 0; i < nitems; i++)

    	    {

		pCD->clientProtocols[i] = property[i];

		if (property[i] == wmGD.xa_WM_SAVE_YOURSELF)

		{

		    pCD->protocolFlags |= PROTOCOL_WM_SAVE_YOURSELF;

		}

		else if (property[i] == wmGD.xa_WM_TAKE_FOCUS)

		{

		    pCD->protocolFlags |= PROTOCOL_WM_TAKE_FOCUS;

		}

		else if (property[i] == wmGD.xa_WM_DELETE_WINDOW)

		{

		    pCD->protocolFlags |= PROTOCOL_WM_DELETE_WINDOW;

		}

		else if (property[i] == wmGD.xa_MWM_MESSAGES)

		{

		    pCD->protocolFlags |= PROTOCOL_MWM_MESSAGES;

		}

    	    }

	}

    }

    if (property)

    {

	XFree ((char *)property);

    }

} /* END OF FUNCTION ProcessWmProtocols */

/*************************************<->*************************************

 *

 *  ProcessMwmMessages (pCD)

 *

 *

 *  Description:

 *  -----------

 *  This function reads and processes the _MWM_MESSAGES property that is

 *  associated with a client window.

 *

 *

 *  Inputs:

 *  ------

 *  pCD = pointer to client data

 *

 * 

 *  Outputs:

 *  -------

 *  pCD = (mwmMessagesCount, mwmMessages)

 *

 *************************************<->***********************************/

void ProcessMwmMessages (ClientData *pCD)

{

    int rValue;

    long *property = NULL;

    Atom actualType;

    int actualFormat;

    unsigned long leftover;

    unsigned long nitems;

    int i;

    if (pCD->mwmMessages)

    {

	XtFree ((char *)pCD->mwmMessages);

	pCD->mwmMessages = NULL;

    }

    pCD->mwmMessagesCount = 0;

    /*

     * Read the _MWM_MESSAGES property.

     */

#ifdef WSM

    if (!HasProperty (pCD, wmGD.xa_MWM_MESSAGES))

        rValue = ~Success;

    else

#endif /* WSM */

    rValue = XGetWindowProperty (DISPLAY, pCD->client, wmGD.xa_MWM_MESSAGES, 0L,

		 (long)MAX_MWM_MESSAGES_COUNT, False, AnyPropertyType,

		 &actualType, &actualFormat, &nitems, &leftover,

		 (unsigned char **)&property);

    if ((rValue != Success) || (actualType == None) || (actualFormat != 32)

	|| (nitems == 0))

    {

	/*

	 * _MWM_MESSAGES does not exist or it is an invalid type.

	 */

	pCD->mwmMessages = NULL;

    }

    else

    {

        if (!(pCD->mwmMessages = (long *)XtMalloc (nitems * sizeof (long))))

        {

	    /* unable to allocate space */

	    Warning (((char *)GETMESSAGE(54, 2, "Insufficient memory for window management data")));

        }

	else

	{

	    /*

	     * Save the protocols in the client data and look for predefined

	     * protocols.

	     */

    	    pCD->mwmMessagesCount = nitems;

    	    for (i = 0; i < nitems; i++)

    	    {

		if ((pCD->mwmMessages[i] = property[i]) == wmGD.xa_MWM_OFFSET)

		{

		    pCD->protocolFlags |= PROTOCOL_MWM_OFFSET;

		}

    	    }

	}

    }

    if (property)

    {

	XFree ((char *)property);

    }

} /* END OF FUNCTION ProcessMwmMessages */

/*************************************<->*************************************

 *

 *  SetMwmInfo (propWindow, flags, wmWindow)

 *

 *

 *  Description:

 *  -----------

 *  This function sets up the _MOTIF_WM_INFO property on the specified (usually

 *  the root) window.

 *

 *

 *  Inputs:

 *  ------

 *  propWindow = window on which the _MOTIF_WM_INFO property is to be set

 *

 *  flags = motifWmInfo.flags value

 *

 *  wmWindow = motifWmInfo.wmWindow value

 *

 * 

 *  Outputs:

 *  -------

 *  _MWM_INFO = this property is set on the specified window

 *

 *************************************<->***********************************/

void SetMwmInfo (Window propWindow, long flags, Window wmWindow)

{

    PropMwmInfo property;

    property.flags = flags;

    property.wmWindow = wmWindow;

    XChangeProperty (DISPLAY, propWindow, wmGD.xa_MWM_INFO, wmGD.xa_MWM_INFO,

	32, PropModeReplace, (unsigned char *)&property,

	PROP_MWM_INFO_ELEMENTS);

} /* END OF FUNCTION SetMwmInfo */

#ifdef WSM

/*************************************<->*************************************

 *

 *  SetMwmSaveSessionInfo (wmWindow)

 *

 *

 *  Description:

 *  -----------

 *  This function sets up the WM_SAVE_YOURSELF property on the wm window

 *

 *

 *  Inputs:

 *  ------

 *  wmWindow = motifWmInfo.wmWindow

 *

 * 

 *  Outputs:

 *  -------

 *  WM_SAVE_YOURSELF = this property is set on the wm window

 *

 *************************************<->***********************************/

void SetMwmSaveSessionInfo (Window wmWindow)

{

    Atom  property;

    property = wmGD.xa_WM_SAVE_YOURSELF;

    XChangeProperty (DISPLAY, wmWindow, 

		     wmGD.xa_WM_PROTOCOLS, XA_ATOM,

		     32, PropModeReplace,

		     (unsigned char *) &property, 1);

    SetWMState(wmWindow, NORMAL_STATE, 0);

} /* END OF FUNCTION SetMwmSaveSessionInfo */

#endif /* WSM */

/*************************************<->*************************************

 *

 *  GetWMState (window)

 *

 *

 *  Description:

 *  -----------

 *  This function gets the WM_STATE property on a client top-level

 *  window.

 *

 *

 *  Inputs:

 *  ------

 *  window = client window from which the WM_STATE property is to be retrieved

 *

 * 

 *  Outputs:

 *  -------

 *  RETURN = a pointer to the WM_STATE property value (NULL if not defined)

 *

 *

 *  Comments:

 *  --------

 *  This function will eventually be superceded when WM_STATE support is

 *  added to the official X release.

 * 

 *************************************<->***********************************/

PropWMState *

GetWMState(

        Window window )

{

    int ret_val;

    PropWMState *property = NULL;

    Atom actual_type;

    int actual_format;

    unsigned long nitems;

    unsigned long leftover;

    ret_val = XGetWindowProperty (DISPLAY, window, wmGD.xa_WM_STATE, 

		  0L, PROP_WM_STATE_ELEMENTS,

		  False, wmGD.xa_WM_STATE, 

		  &actual_type, &actual_format, 

		  &nitems, &leftover, (unsigned char **)&property);

    if (!((ret_val == Success) && (actual_type == wmGD.xa_WM_STATE) &&

         (nitems == PROP_WM_STATE_ELEMENTS)))

    {

        /*

         * The property could not be retrieved or is not correctly set up.

         */

        if (property)

        {

	    XFree ((char *)property);

	    property = NULL;

        }

    }

    return (property);

} /* END OF FUNCTION GetWMState */

/*************************************<->*************************************

 *

 *  SetWMState (window, state, icon)

 *

 *

 *  Description:

 *  -----------

 *  This function sets up the WM_STATE property on a client top-level

 *  window.

 *

 *

 *  Inputs:

 *  ------

 *  window = client window on which the WM_STATE property is to be set

 *

 *  state = state of the client application

 *

 *  icon = window manager's icon window

 *

 * 

 *  Outputs:

 *  -------

 *  WM_STATE = this property is set on the client window

 *

 *

 *  Comments:

 *  --------

 *  This function will eventually be superceded when WM_STATE support is

 *  added to the official X release.

 * 

 *************************************<->***********************************/

void SetWMState (Window window, int state, Window icon)

{

    PropWMState property;

    property.state = state;

    property.icon = icon;

    XChangeProperty (DISPLAY, window, wmGD.xa_WM_STATE, wmGD.xa_WM_STATE, 32,

	PropModeReplace, (unsigned char *)&property, PROP_WM_STATE_ELEMENTS);

} /* END OF FUNCTION SetWMState */

/*************************************<->*************************************

 *

 *  PropMwmHints *

 *  GetMwmHints (pCD)

 *

 *

 *  Description:

 *  -----------

 *  This function reads any _MWM_HINTS property that is associated with a 

 *  client window.

 *

 *  Inputs:

 *  ------

 *  pCD = pointer to client data

 * 

 *  Outputs:

 *  -------

 *  RETURN = ptr to mwm hints property, or NULL ptr if failure

 *

 *************************************<->***********************************/

PropMwmHints *

GetMwmHints(

        ClientData *pCD )

{

    int ret_val;

    PropMwmHints *property = NULL;

    Atom actual_type;

    int actual_format;

    unsigned long nitems;

    unsigned long leftover;

#ifdef WSM

    if (!HasProperty(pCD, wmGD.xa_MWM_HINTS))

	ret_val = ~Success;

    else

#endif /* WSM */

    ret_val = XGetWindowProperty (DISPLAY, pCD->client, wmGD.xa_MWM_HINTS, 

		  0L, PROP_MWM_HINTS_ELEMENTS,

		  False, wmGD.xa_MWM_HINTS, 

		  &actual_type, &actual_format, 

		  &nitems, &leftover, (unsigned char **)&property);

    /*

     * Retrieve the property data.

     *

     *     Motif 1.1.n clients:	nitems	= PROP_MWM_HINTS_ELEMENTS

     *     Motif 1.2 clients:	nitems 	= PROP_MWM_HINTS_ELEMENTS + 2

     *

     * NOTES:  We don't need to check (nitems == PROP_MWM_HINTS_ELEMENTS)

     *         since...

     *

     * If running Motif 1.1.n client with Mwm 1.2, then ignore extra elements

     *    since property.flags won't have extra elements set.

     *

     * If running Motif 1.2 client with Mwm 1.1.n, then ignore extra elements

     *    since Mwm 1.1.n won't try to access the extra elements.

     */

    if ((ret_val == Success) && (actual_type == wmGD.xa_MWM_HINTS))

    {

	return (property);			/* indicate success */

    }

    /*

     * The property could not be retrieved or is not correctly set up.

     */

    if (property)

    {

	XFree ((char *)property);

    }

    return (NULL);			/* indicate failure */

} /* END OF FUNCTION GetMwmHints */

/*************************************<->*************************************

 *

 *  PropMwmInfo *

 *  GetMwmInfo (rootWindowOfScreen)

 *

 *

 *  Description:

 *  -----------

 *  This function reads the _MOTIF_WM_INFO property from the root window if

 *  it is setup.

 * 

 *  Inputs:

 *  ------

 *  pSD = pointer to screen data 

 *

 *  Outputs:

 *  -------

 *  RETURN = ptr to motif wm info property, or NULL ptr if no property

 *

 *************************************<->***********************************/

PropMwmInfo *GetMwmInfo (Window rootWindowOfScreen)

{

    int ret_val;

    PropMwmInfo *property = NULL;

    Atom actual_type;

    int actual_format;

    unsigned long nitems;

    unsigned long leftover;

    ret_val = XGetWindowProperty (DISPLAY, rootWindowOfScreen,

                                     wmGD.xa_MWM_INFO,

                                     0L, PROP_MWM_INFO_ELEMENTS,

                                     False, wmGD.xa_MWM_INFO,

                                     &actual_type, &actual_format,

                                     &nitems, &leftover,

                                     (unsigned char **)&property);

    if ((ret_val == Success) && (actual_type == wmGD.xa_MWM_INFO) &&

        (nitems == PROP_MWM_INFO_ELEMENTS)) 

    {

	return (property);			/* indicate success */

    }

    /*

     * The property could not be retrieved or is not correctly set up.

     */

    if (property)

    {

	XFree ((char *)property);

    }

    return (NULL);			/* indicate failure */

} /* END OF FUNCTION GetMwmInfo */

/*************************************<->*************************************

 *

 *  ProcessWmColormapWindows (pCD)

 *

 *

 *  Description:

 *  -----------

 *  This function retrieves and processes the WM_COLORMAP_WINDOWS client

 *  window property.

 *

 *

 *  Inputs:

 *  ------

 *  pCD = pointer to client data

 *

 * 

 *  Outputs:

 *  -------

 *  pCD = (cmapWindows, clientCmapList, clientCmapCount, clientCmapIndex)

 *

 *************************************<->***********************************/

void ProcessWmColormapWindows (ClientData *pCD)

{

    int rValue;

    Window *property = NULL;

    Atom actualType;

    int actualFormat;

    unsigned long leftover;

    unsigned long nitems;

    int i;

    Window *pWindows;

    Colormap *pColormaps;

    int colormapCount;

    XWindowAttributes wAttributes;

    ClientData *pcd;

    XSetWindowAttributes sAttributes;

#ifndef OLD_COLORMAP /* colormaps */

    int *pCmapFlags;

#endif

    /*

     * pCD->clientCmapCount and pCD->clientCmapIndex are initialized in

     * WmWinInfo.c.

     */

    /*

     * Read the WM_COLORMAP_WINDOWS property.

     */

    rValue = XGetWindowProperty (DISPLAY, pCD->client,

		 wmGD.xa_WM_COLORMAP_WINDOWS, 0L,

		 (long)MAX_COLORMAP_WINDOWS_COUNT, False, AnyPropertyType,

		 &actualType, &actualFormat, &nitems, &leftover,

		 (unsigned char **)&property);

    if ((rValue == Success) && (actualType != None) && (actualFormat == 32) &&

	(nitems > 0))

    {

	/*

	 * WM_COLORMAP_WINDOWS exists and is a valid type.

	 */

        if (!(pWindows = (Window *)XtMalloc ((nitems * sizeof (Window)) + 1)) ||

            !(pColormaps = (Colormap *)XtMalloc ((nitems*sizeof(Colormap)) + 1)))

        {

	    /* unable to allocate space */

	    Warning (((char *)GETMESSAGE(54, 3, "Insufficient memory for window management data")));

	    if (pWindows)

	    {

		XtFree ((char *)pWindows);

	    }

        }

#ifndef OLD_COLORMAP /* colormap */

	/* Is the above OSF code a bug -- allocates one extra byte, rather */

	/* than one extra element, for the top window if needed? */

	else if ( ! (pCmapFlags = (int *)XtCalloc(nitems+1,sizeof(int)))) {

			/* unable to allocate space */

			Warning (((char *)GETMESSAGE(54, 4, "Insufficient memory for window manager flags")));

			XtFree ((char *)pWindows); XtFree ((char *)pColormaps);

	}

#endif

	else

	{

	    /*

	     * Check to see if the top-level client window is in the list.

	     * If it is not then add it to the head of the list.

	     */

    	    for (i = 0; i < nitems; i++)

	    {

		if (property[i] == pCD->client)

		{

		    break;