/*
 *
 * This software is released under the provisions of the GPL version 2.
 * see file "COPYING".  If that file is not available, the full statement 
 * of the license can be found at
 *
 * http://www.fsf.org/licensing/licenses/gpl.txt
 *
 * Portions Copyright (c) 1995-2004 RealNetworks, Inc. All Rights Reserved.
 *
 */

#ifndef _HXWINTYP_H_
#define _HXWINTYP_H_

#include "hxtypes.h" /* Needed at least for various defines and types. */

#ifdef _WIN16
#define BI_BITFIELDS	3L
#endif

/****************************************************************************
 * 
 *  Structure:
 *
 *	HXxSize
 *
 *  Purpose:
 *
 *	Cross Platform definition of a size.
 *
 */
typedef struct HXEXPORT_CLASS _HXxSize
{
    INT32   cx;
    INT32   cy;
} HXxSize;

#ifdef __cplusplus

inline HXBOOL operator ==( const HXxSize& a, const HXxSize& b )
{
    return ( a.cx == b.cx ) && ( a.cy == b.cy );
}

inline HXBOOL operator !=( const HXxSize& a, const HXxSize& b )
{
    return !( a == b );
}

#endif // __cplusplus

/****************************************************************************
 * 
 *  Structure:
 *
 *	HXxPoint
 *
 *  Purpose:
 *
 *	Cross Platform definition of a point.
 *
 */
typedef struct HXEXPORT_CLASS _HXxPoint
{
    INT32   x;
    INT32   y;
} HXxPoint;

#ifdef __cplusplus

inline HXBOOL operator ==( const HXxPoint& a, const HXxPoint& b )
{
    return ( a.x == b.x ) && ( a.y == b.y );
}

inline HXBOOL operator !=( const HXxPoint& a, const HXxPoint& b )
{
    return !( a == b );
}

#endif // __cplusplus



/****************************************************************************
 * 
 *  Structure:
 *
 *	HXxRect
 *
 *  Purpose:
 *
 *	Cross Platform definition of a rectangle.
 *
 */
typedef struct HXEXPORT_CLASS _HXxRect
{
    INT32   left;
    INT32   top;
    INT32   right;
    INT32   bottom;
} HXxRect;

#define HXxRECT_WIDTH(r)	((r).right - (r).left)
#define HXxRECT_HEIGHT(r)	((r).bottom - (r).top)

#ifdef __cplusplus

inline HXBOOL operator ==( const HXxRect& a, const HXxRect& b )
{
    return ( a.left == b.left ) && 
	    ( a.top == b.top ) && 
	    ( a.right == b.right ) && 
	    ( a.bottom == b.bottom );
}

inline HXBOOL operator !=( const HXxRect& a, const HXxRect& b )
{
    return !( a == b );
}

inline HXBOOL HXxRect_IsEmpty( const HXxRect& rect )
{
    return ( rect.left >= rect.right  ) ||
	   ( rect.top  >= rect.bottom );
}

inline void HXxRect_Intersection( const HXxRect& r1, const HXxRect& r2, HXxRect* result )
{
    result->left   = ( r1.left   > r2.left   ) ? r1.left   : r2.left;
    result->top    = ( r1.top    > r2.top    ) ? r1.top    : r2.top;
    result->right  = ( r1.right  < r2.right  ) ? r1.right  : r2.right;
    result->bottom = ( r1.bottom < r2.bottom ) ? r1.bottom : r2.bottom;
}

#endif // __cplusplus

/****************************************************************************
 * 
 *  Structure:
 *
 *	HXxWindow
 *
 *  Purpose:
 *
 *	Cross Platform definition of a window. This struct is sufficiently
 *	wide to describe parent or child windows in Windows, MacOS, and
 *	various flavors of X-Windows.
 *
 *  Data Members:
 *
 *	void*	window
 *	platform specific window handle
 *	
 *	ULONG32	x, y
 *	position of top left corner relative to a client page
 *	
 *	ULONG32	width, height
 *	maximum window size
 *	
 *	HXxRect clipRect;            
 *	clipping rectangle in port coordinates
 *
 */
typedef struct HXEXPORT_CLASS _HXxWindow
{
    /* NOTE: The window parameter is NOT guaranteed to be unique for every
       corresponding CHXWindow. Use HXxWindowID if this is desired. */
    void*       window;
    ULONG32     x;
    ULONG32     y;                   
    ULONG32     width;
    ULONG32     height;
    HXxRect     clipRect;
#ifdef _UNIX
    void *      display;
#endif
} HXxWindow;

typedef void* HXxWindowID;

/****************************************************************************
 * 
 *  Structure:
 *
 *	HXxEvent
 *
 *  Purpose:
 *
 *	Cross Platform definition of a event. This struct is sufficiently
 *	wide to describe an event in Windows, MacOS, and various flavors of 
 *	X-Windows.
 *
 *  Data Members:
 *
 *	void*	event
 *	platform specific event ID, can also be one of the several HXxMSG_*
 *	event IDs which map onto existing platform specific event IDs
 *      UNIX: X Event Type
 *	
 *	void*	window
 *	platform specific window handle
 *      UNIX: X Window ID
 *	
 *	void*	param1
 *	message specific parameter
 *      UNIX: Display*
 *	
 *	void*	param2
 *      Mac:  for UpdateEvt, either NULL or RgnHandle to be filled with updated area
 *      UNIX: Native              XEvent*
 *            HX_SURFACE_UPDATE  HXxWindow*
 *	
 */
typedef struct HXEXPORT_CLASS _HXxEvent
{
    ULONG32	event;	    /* IN  */
    void*	window;	    /* IN  */
    void*	param1;	    /* IN  */
    void*	param2;	    /* IN  */

    UINT32	result;	    /* OUT */
    HXBOOL	handled;    /* OUT */
} HXxEvent;


/****************************************************************************
 * 
 *  typedef:
 *
 *	HXxRegion
 *
 *  Purpose:
 *
 *	Cross Platform definition of a region. This typedef is redefined as
 *	appropriate to describe a region in Windows, MacOS, and various 
 *	flavors of X-Windows.
 *
 */
typedef void* HXxRegion;

/****************************************************************************
 * 
 *  typedef:
 *
 *	HXxDC
 *
 *  Purpose:
 *
 *	Cross Platform definition of a device context. This typedef is redefined as
 *	appropriate to describe a device context in Windows, MacOS, and various 
 *	flavors of X-Windows.
 *
 */
typedef void* HXxDC;

/****************************************************************************
 * 
 *  typedef:
 *
 *	HXxFont
 *
 *  Purpose:
 *
 *	Cross Platform definition of a font. This typedef is redefined as
 *	appropriate to describe a font in Windows, MacOS, and various 
 *	flavors of X-Windows.
 *
 */
typedef void* HXxFont;

/****************************************************************************
 * 
 *  typedef:
 *
 *	HXxColor
 *
 *  Purpose:
 *
 *	Cross Platform definition of a color. This typedef is redefined as
 *	appropriate to describe a font in Windows, MacOS, and various 
 *	flavors of X-Windows.
 *
 */
typedef ULONG32 HXxColor;

/****************************************************************************
 * 
 *  typedef:
 *
 *	HXxIcon
 *
 *  Purpose:
 *
 *	Cross Platform definition of a icon. This typedef is redefined as
 *	appropriate to describe a font in Windows, MacOS, and various 
 *	flavors of X-Windows.
 *
 */
typedef void* HXxIcon;

/****************************************************************************
 * 
 *  typedef:
 *
 *	HXxMenu
 *
 *  Purpose:
 *
 *	Cross Platform definition of a menu. This typedef is redefined as
 *	appropriate to describe a font in Windows, MacOS, and various 
 *	flavors of X-Windows.
 *
 */
typedef void* HXxMenu;

/****************************************************************************
 * 
 *  typedef:
 *
 *	HXxCursor
 *
 *  Purpose:
 *
 *	Cross Platform definition of a cursor. This typedef is redefined as
 *	appropriate to describe a cursor in Windows, MacOS, and various 
 *	flavors of X-Windows.
 *
 */
typedef void* HXxCursor;


/****************************************************************************
 * 
 *  Structure:
 *
 *	HXREGION
 *
 *  Purpose:
 *
 *	Cross Platform Region definition.
 */
typedef struct HXEXPORT_CLASS _HXBox
{
    short x1, x2, y1, y2;
} HXBOX, *HXBoxPtr;

typedef struct HXEXPORT_CLASS _HXxRegion
{
    HXBOX* rects;
    long    numRects;
} HXxBoxRegion, *HXxRegionPtr;

//Definition of the ExposeInfo structure pass with HX_SURFACE_UPDATE2.
typedef struct HXEXPORT_CLASS _HXxExposeInfo
{
    HXxRect     extents;  //The bounding rect of all dirty rects.
    HXxBoxRegion* pRegion;  //Pointer to dirty region. DO NOT MODIFY.
    HXxWindow*  pWindow;  //Pointer to the HXxWindow for this site.
    void*       pParam1;  //Reserved
    void*       pParam2;  //Reserved
} HXxExposeInfo;

#endif /* _HXWINTYP_H_ */