/*
 * Extended system tray widget for XCenter/eCenter
 *
 * Internal declarations
 *
 * Made by netlabs.org
 *
 * Author: Dmitry A. Kuminov
 *
 * This software is public domain.
 *
 * WITHOUT ANY WARRANTY..., AT YOUR OWN RISC... ETC.
 *
 */

#ifndef XSYSTRAY_HEADER_INCLUDED
#define XSYSTRAY_HEADER_INCLUDED

#include "xsystray_api.h"

#include <sys/builtin.h>        // atomics

#define XSYSTRAY_VERSION_MAJOR 0
#define XSYSTRAY_VERSION_MINOR 1
#define XSYSTRAY_VERSION_REVISION 0

#define WNDCLASS_WIDGET_XSYSTRAY_SERVER "XWPCenterExtendedSysTrayServer"

#define WNDCLASS_WIDGET_XSYSTRAY        "XWPCenterExtendedSysTray"
#define INTCLASS_WIDGET_XSYSTRAY        "ExtendedSysTray"
#define HUMANSTR_WIDGET_XSYSTRAY        "Extended system tray"

#define WM_XST_CREATED_ATOM             "ExtendedSysTray.WM_XST_CREATED"
#define WM_XST_NOTIFY_ATOM              "ExtendedSysTray.WM_XST_NOTIFY"

#define WM_XST_CONTROL  (WM_USER + 0)

typedef enum
{
    SYSTRAYCMD_GETVERSION,
    SYSTRAYCMD_ADDICON,
    SYSTRAYCMD_REMOVEICON,
    SYSTRAYCMD_SETTOOLTIP,
    SYSTRAYCMD_SHOWBALLOON,
    SYSTRAYCMD_HIDEBALLOON,
} SYSTRAYCMD;

/*
 *@@ SYSTRAYCTLDATA:
 *      Structure holding information accompanying WM_XST_CONTROL messages sent
 *      to the system tray server by clients (windows associated with system
 *      tray icons).
 *
 *      NOTE: When you change the size of this structure, you may also need to
 *      change CLIENT_MEMORYPOOL_SIZE value (see the comments there for
 *      details).
 */

typedef struct
{
    SYSTRAYCMD  ulCommand;
                // command to execute, must always be set
    HWND        hwndSender;
                // sender window, a must for SYSTRAYCMD_ADDICON, REMOVEICON,
                // SETTOOLTIP, SHOWBALLOON, HIDEBALLOON
    union
    {
        struct
        {
            ULONG ulMajor;
            ULONG ulMinor;
            ULONG ulRevision;
        } version;
          // used by SYSTRAYCMD_GETVERSION

        struct
        {
            USHORT      usId;
            HPOINTER    hIcon;
            ULONG       ulMsgId;
        } icon;
          // used by SYSTRAYCMD_ADDICON, SYSTRAYCMD_REMOVEICON

        struct
        {
            USHORT  usId;
            CHAR    szText[512];
        } tooltip;

    } u;

    BOOL    bAcknowledged : 1;
            // set to true by the recipient if it processes the message

} SYSTRAYCTLDATA, *PSYSTRAYCTLDATA;

/*
 *@@ NOTIFYDATA:
 *      Structure holding information acompanying notification messages
 *      posted to clients (windows associated with system tray icons) about
 *      icon events. This structure unions all public notification code
 *      dependent structures defined in xsystray_api.h (starting with XST*).
 *
 *      All messages posted to the client have an ID corresponding to the
 *      WM_XST_NOTIFY_ATOM in the system atom table. The client-side API
 *      implementation intercepts these messages (using HK_INPUT), composes a
 *      new message given the information in NOTIFYDATA, frees the NOTIFYDATA
 *      pointer using FreeNotifyDataPtr() and then sends the composed message to
 *      the appropriate window.
 *
 *      The layout of the XST_NOTIFY message is as follows:
 *
 *          param1
 *              PNOTIFYDATA pNotifyData     pointer to the NOTIFYDATA structure
 *
 *          param2
 *              PVOID       pvMemoryPool    server memory pool (for the
 *                                          FreeNotifyDataPtr() call)
 *
 *      NOTE: When you change the size of this structure, you may also need to
 *      change SERVER_MEMORYPOOL_SIZE value in xsystray.c (see the comments
 *      there for details).
 */

typedef struct
{
    ULONG   msg;
            // ID of the message that is to be sent to the target window
    MPARAM  mp1;
            // message parameter (usually: USHORT usIconId, USHORT usNotifyCode)
    MPARAM  mp2;
            // message parameter (usually, a pointer to a struct from the union)
    union
    {
        XSTMOUSEMSG     MouseMsg;
        XSTCONTEXTMSG   ContextMsg;
        XSTWHEELMSG     WheelMsg;
    } u;

} NOTIFYDATA, *PNOTIFYDATA;

// Header of the server-side memory pool
typedef struct
{
    volatile HWND   hwnd;        // owner of the block or NULLHANDLE if free
    NOTIFYDATA      NotifyData;  // data

} MEMPOOLBLK, *PMEMPOOLBLK;

// allocation unit in the server-side memory pool
typedef struct
{
    ULONG ulBeyond;         // address of the first byte beyond the memory pool

    volatile ULONG ulNeedsCommit;   // address of the first decommitted byte
    volatile ULONG ulNext;          // address of next possibly free block

    MEMPOOLBLK aBlocks[0];          // fake array for easier addressing

} MEMPOOLHDR, *PMEMPOOLHDR;

/*
 *@@ FreeNotifyDataPtr:
 *      Frees the NOTIFYDATA structure allocated by AllocNotifyDataPtr().
 *
 *      See AllocNotifyDataPtr() for more details about allocating these
 *      structures.dd
 */

inline
VOID FreeNotifyDataPtr(PVOID pvMemoryPool,  // in: memory pool base address
                       HWND hwndOwner,      // in: owner of the struct to free
                       PNOTIFYDATA pData)   // in: address of the struct to free
{
    PMEMPOOLHDR pHdr = (PMEMPOOLHDR)pvMemoryPool;
    PMEMPOOLBLK pBlk = (PMEMPOOLBLK)((ULONG)pData - sizeof(HWND));

    ULONG ulNext = pHdr->ulNext;

    __atomic_cmpxchg32((uint32_t *)&pBlk->hwnd, NULLHANDLE, hwndOwner);

    // if the next possible free block is greater than we just freed,
    // set it to us (to minimize the amount of committed pages)
    if (ulNext > (ULONG)pBlk)
        __atomic_cmpxchg32((uint32_t *)&pHdr->ulNext, (ULONG)pBlk, ulNext);
}

#endif // XSYSTRAY_HEADER_INCLUDED