窗口子类化

作者：刘树伟
日期：2019/1/27 19:54

窗口子类化有两种方法：
一、常规的SetWindowLong替换窗口过程
略
二、SetWindowSubclass
这个方法极好。推荐使用。
用法：
    SetWindowSubclass(pButton1->GetSafeHwnd(), MyButtonSubclass, 5, 6);
MyButtonSubclass是pButton1的新的窗口过程，我们可以为这个新的窗口过程，设置一个ID：5，并且为值为5这个ID的MyButtonSubclass设置一个自定义数据6.
MyButtonSubclass定义如下：
LRESULT CALLBACK MyButtonSubclass(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam, UINT_PTR uIdSubclass, DWORD_PTR dwRefData)
{
    return DefSubclassProc(hWnd, uMsg, wParam, lParam);
}
这样，当调用到MyButtonSubclass时，后两个参数的值，就可以把5和6传进去。

这种方法有下面几个好处：
● 可以为一个窗口设置N个子类：
    SetWindowSubclass(pButton1->GetSafeHwnd(), MyButtonSubclass, 1, 2);
    SetWindowSubclass(pButton1->GetSafeHwnd(), MyButtonSubclass, 5, 6);
内部以链表形式储存，函数名加函数ID作为节点标识。这样，系统先调用ID为5的MyButtonSubclass，再调用ID为1的MyButtonSubclass。

● 可以方便的删除一个子类
    RemoveWindowSubclass(pButton1->GetSafeHwnd(), MyButtonSubclass, 5);

● 不用记录旧的窗口过程
在使用SetWindowLong方法替换窗口过程时，要记录旧的窗口过程，并且在新的窗口过程内，通过CallWindowProc调用旧的窗口过程，来达到链式调用的目的。而SetWindowSubclass内部，自动维护着子类节点。我们只要在每个子类函数中，调用
DefSubclassProc(hWnd, uMsg, wParam, lParam);
就达到了链式调用的目的。

● 同一个窗口过程、同一个子类ID，在内部只记录一次：
    BOOL bRet = SetWindowSubclass(pButton1->GetSafeHwnd(), MyButtonSubclass, 5, 6);
    BOOL bRet2 = SetWindowSubclass(pButton1->GetSafeHwnd(), MyButtonSubclass, 5, 6);
    BOOL bRet3 = SetWindowSubclass(pButton1->GetSafeHwnd(), MyButtonSubclass, 5, 7);
    DWORD_PTR dwRefData;
    BOOL bRet4 = GetWindowSubclass(pButton1->GetSafeHwnd(), MyButtonSubclass, 5, &dwRefData);
    _ASSERT(dwRefData == 7);

工作原理：
微软在内部，为每个HWND维护着一个下面节点的链表。
typedef struct
{
    SUBCLASSPROC    pfnSubclass;        // subclass procedure
    WPARAM          uIdSubclass;        // unique subclass identifier
    DWORD_PTR        dwRefData;          // optional ref data
} SUBCLASS_CALL;

typedef struct _SUBCLASS_HEADER
{
    UINT uRefs;                         // subclass count
    UINT uAlloc;                        // allocated subclass call nodes
    UINT uCleanup;                      // index of call node to clean up
    DWORD dwThreadId;                   // thread id of window we are hooking
    SUBCLASS_FRAME *pFrameCur;          // current subclass frame pointer
    SUBCLASS_CALL CallArray[1];         // base of packed call node array
} SUBCLASS_HEADER;

这个链表，放置在SUBCLASS_HEADER中，通过SetProp设置给HWND。
(SUBCLASS_HEADER *)GetProp(hWnd, MAKEINTATOM(g_aCC32Subclass))
函数地址和函数ID唯一标识一个节点（函数自定义参数不用来标识节点）
SetWindowSubclass内部会查找ID为5的MyButtonSubclass节点是否存在，没存在的话，就创建节点。最后为这个节点赋值，后设置的置，覆盖原先设置的值。
BOOL SetWindowSubclass(HWND hWnd, SUBCLASSPROC pfnSubclass, UINT_PTR uIdSubclass, DWORD_PTR dwRefData)
{
    SUBCLASS_HEADER *pHeader;
    SUBCLASS_CALL *pCall;
    BOOL bResult;

    // 检测参数有效性
    ...
    bResult = FALSE;    // assume failure

    //
    // we party on the subclass call chain here

    //
    // actually subclass the window
    //
    if ((pHeader = AttachSubclassHeader(hWnd)) == NULL)
        goto bail;

    //
    // find a call node for this caller，只比较函数地址和ID，不比较绑定的自定义数据
    //
    if ((pCall = FindCallRecord(pHeader, pfnSubclass, uIdSubclass)) == NULL)
    {
        //
        // not found, alloc a new one
        //
        SUBCLASS_HEADER *pHeaderT =
        ReAllocSubclassHeader(hWnd, pHeader, pHeader->uRefs + 1);

        if (!pHeaderT)
        {
            //
            // re-query in case it is already gone
            //
            if ((pHeader = FastGetSubclassHeader(hWnd)) != NULL)
                CompactSubclassHeader(hWnd, pHeader);

            goto bail;
        }

        pHeader = pHeaderT;
        pCall = pHeader->CallArray + pHeader->uRefs;
        pHeader->uRefs++;
    }

    //
    // fill in the subclass call data
    //
    pCall->pfnSubclass = pfnSubclass;
    pCall->uIdSubclass = uIdSubclass;
    pCall->dwRefData   = dwRefData;

    bResult = TRUE;

bail:
    return bResult;
}

注意：vc6使用这些函数，要通过GetProcAddress得到，除了GetWindowSubclass是comctl32.dll 6.0及以后版本提供，其它3个API在5.8版本就提供了。