MessageStateAnalyzer.c File Reference

#include "precomp.h"
#include "undocuser.h"
#include "winxx.h"
#include <strsafe.h>
#include "msgdump.h"

Include dependency graph for MessageStateAnalyzer.c:

Go to the source code of this file.

Classes
struct	STAGE

Macros
#define	MSGDUMP_TPRINTF   MsgDumpPrintf
#define	MSGDUMP_PREFIX   s_prefix
#define	TIMEOUT_TIMER   999
#define	TOTAL_TIMEOUT   (5 * 1000)
#define	WIDTH   300
#define	HEIGHT   200
#define	PARENT_MSG   s_msgStack[s_nLevel - 1]

Typedefs
typedef enum STAGE_TYPE	STAGE_TYPE
typedef struct STAGE	STAGE
typedef enum ACTION	ACTION

Enumerations
enum	STAGE_TYPE { STAGE_TYPE_SEQUENCE, STAGE_TYPE_COUNTING }
enum	ACTION {   ACTION_ZERO = 0, ACTION_FIRSTMINMAX, ACTION_NCCREATE, ACTION_SHOW,   ACTION_IME_SETCONTEXT_OPEN, ACTION_IME_NOTIFY_OPEN, ACTION_DESTROY, ACTION_IME_SETCONTEXT_CLOSE,   ACTION_IME_NOTIFY_CLOSE, ACTION_HIDE, ACTION_DEACTIVATE, ACTION_ACTIVATE }

Functions
static void	MsgDumpPrintf (LPCSTR fmt,...)
static void	DoInitialize (const STAGE *pStages, INT cStages)
static void	DoFinish (void)
static void	DoAction (HWND hwnd, INT iAction, WPARAM wParam, LPARAM lParam)
static void	NextStage (HWND hwnd)
static void	DoStage (HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
static LRESULT CALLBACK	InnerWindowProc (HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
static void	DoBuildPrefix (void)
static LRESULT CALLBACK	WindowProc (HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
static void	General_DoTest (void)
static void	IME_DoTest (void)
	START_TEST (MessageStateAnalyzer)

Variables
static char	s_prefix [16] = ""
static INT	s_iStage
static INT	s_iStep
static INT	s_nLevel
static BOOL	s_bNextStage
static INT	s_nCounters [10]
static UINT	s_msgStack [32]
static const STAGE *	s_pStages
static INT	s_cStages
static const STAGE	s_GeneralStages []
static const STAGE	s_IMEStages []

Macro Definition Documentation

HEIGHT

#define HEIGHT   200

Definition at line 60 of file MessageStateAnalyzer.c.

MSGDUMP_PREFIX

#define MSGDUMP_PREFIX   s_prefix

Definition at line 24 of file MessageStateAnalyzer.c.

MSGDUMP_TPRINTF

#define MSGDUMP_TPRINTF   MsgDumpPrintf

Definition at line 22 of file MessageStateAnalyzer.c.

PARENT_MSG

#define PARENT_MSG   s_msgStack[s_nLevel - 1]

Definition at line 61 of file MessageStateAnalyzer.c.

TIMEOUT_TIMER

#define TIMEOUT_TIMER   999

Definition at line 57 of file MessageStateAnalyzer.c.

TOTAL_TIMEOUT

#define TOTAL_TIMEOUT   (5 * 1000)

Definition at line 58 of file MessageStateAnalyzer.c.

WIDTH

#define WIDTH   300

Definition at line 59 of file MessageStateAnalyzer.c.

Typedef Documentation

ACTION

typedef enum ACTION ACTION

STAGE

typedef struct STAGE STAGE

STAGE_TYPE

typedef enum STAGE_TYPE STAGE_TYPE

Enumeration Type Documentation

ACTION

enum ACTION

Enumerator
ACTION_ZERO
ACTION_FIRSTMINMAX
ACTION_NCCREATE
ACTION_SHOW
ACTION_IME_SETCONTEXT_OPEN
ACTION_IME_NOTIFY_OPEN
ACTION_DESTROY
ACTION_IME_SETCONTEXT_CLOSE
ACTION_IME_NOTIFY_CLOSE
ACTION_HIDE
ACTION_DEACTIVATE
ACTION_ACTIVATE

Definition at line 82 of file MessageStateAnalyzer.c.

{
    ACTION_ZERO = 0,
    ACTION_FIRSTMINMAX,
    ACTION_NCCREATE,
    ACTION_SHOW,
    ACTION_IME_SETCONTEXT_OPEN,
    ACTION_IME_NOTIFY_OPEN,
    ACTION_DESTROY,
    ACTION_IME_SETCONTEXT_CLOSE,
    ACTION_IME_NOTIFY_CLOSE,
    ACTION_HIDE,
    ACTION_DEACTIVATE,
    ACTION_ACTIVATE
} ACTION;

STAGE_TYPE

enum STAGE_TYPE

Enumerator
STAGE_TYPE_SEQUENCE
STAGE_TYPE_COUNTING

Definition at line 27 of file MessageStateAnalyzer.c.

{
    STAGE_TYPE_SEQUENCE,
    STAGE_TYPE_COUNTING
} STAGE_TYPE;

Function Documentation

DoAction()

static void DoAction ( HWND  hwnd, INT  iAction, WPARAM  wParam, LPARAM  lParam  )

static

Definition at line 98 of file MessageStateAnalyzer.c.

{
    RECT rc;
    switch (iAction)
    {
        case ACTION_ZERO:
            /* does nothing */
            break;
        case ACTION_FIRSTMINMAX:
            GetWindowRect(hwnd, &rc);
            ok_long(rc.right - rc.left, 0);
            ok_long(rc.bottom - rc.top, 0);
            ok_int(IsWindowVisible(hwnd), FALSE);
            break;
        case ACTION_NCCREATE:
            GetWindowRect(hwnd, &rc);
            ok_long(rc.right - rc.left, WIDTH);
            ok_long(rc.bottom - rc.top, HEIGHT);
            ok_int(IsWindowVisible(hwnd), FALSE);
            break;
        case ACTION_SHOW:
            ShowWindow(hwnd, SW_SHOWNORMAL);
            break;
        case ACTION_IME_SETCONTEXT_OPEN:
            ok(wParam == 1, "Step %d: wParam was %p\n", s_iStep, (void *)wParam);
            ok(lParam == 0xC000000F, "Step %d: lParam was %p\n", s_iStep, (void *)lParam);
            break;
        case ACTION_IME_NOTIFY_OPEN:
            ok(wParam == 2, "Step %d: wParam was %p\n", s_iStep, (void *)wParam);
            ok(lParam == 0, "Step %d: lParam was %p\n", s_iStep, (void *)lParam);
            break;
        case ACTION_DESTROY:
            DestroyWindow(hwnd);
            break;
        case ACTION_IME_SETCONTEXT_CLOSE:
            ok(wParam == 0, "Step %d: wParam was %p\n", s_iStep, (void *)wParam);
            ok(lParam == 0xC000000F, "Step %d: lParam was %p\n", s_iStep, (void *)lParam);
            break;
        case ACTION_IME_NOTIFY_CLOSE:
            ok(wParam == 1, "Step %d: wParam was %p\n", s_iStep, (void *)wParam);
            ok(lParam == 0, "Step %d: lParam was %p\n", s_iStep, (void *)lParam);
            break;
        case ACTION_HIDE:
            ShowWindow(hwnd, SW_HIDE);
            break;
        case ACTION_DEACTIVATE:
            SetForegroundWindow(GetDesktopWindow());
            break;
        case ACTION_ACTIVATE:
            SetForegroundWindow(hwnd);
            break;
    }
}

Referenced by DoStage(), InnerWindowProc(), SetupDiInstallDevice(), and SetupDiRegisterCoDeviceInstallers().

DoBuildPrefix()

static void DoBuildPrefix ( void  )

static

Definition at line 278 of file MessageStateAnalyzer.c.

{
    DWORD Flags = InSendMessageEx(NULL);
    INT i = 0;

    if (Flags & ISMEX_CALLBACK)
        s_prefix[i++] = 'C';
    if (Flags & ISMEX_NOTIFY)
        s_prefix[i++] = 'N';
    if (Flags & ISMEX_REPLIED)
        s_prefix[i++] = 'R';
    if (Flags & ISMEX_SEND)
        s_prefix[i++] = 'S';
    if (i == 0)
        s_prefix[i++] = 'P';

    s_prefix[i++] = ':';
    s_prefix[i++] = ' ';
    s_prefix[i] = 0;
}

Referenced by WindowProc().

DoFinish()

static void DoFinish ( void  )

static

Definition at line 73 of file MessageStateAnalyzer.c.

{
    ok_int(s_iStage, s_cStages);
    if (s_iStage != s_cStages)
    {
        skip("Some stage(s) skipped (Step: %d)\n", s_iStep);
    }
}

Referenced by General_DoTest(), and IME_DoTest().

DoInitialize()

static void DoInitialize ( const STAGE *  pStages, INT  cStages  )

static

Definition at line 63 of file MessageStateAnalyzer.c.

{
    s_iStage = s_iStep = s_nLevel = 0;
    s_bNextStage = FALSE;
    ZeroMemory(s_nCounters, sizeof(s_nCounters));
    ZeroMemory(s_msgStack, sizeof(s_msgStack));
    s_pStages = pStages;
    s_cStages = cStages;
}

Referenced by General_DoTest(), and IME_DoTest().

DoStage()

static void DoStage ( HWND  hwnd, UINT  uMsg, WPARAM  wParam, LPARAM  lParam  )

static

Definition at line 188 of file MessageStateAnalyzer.c.

{
    INT i, iAction;
    const STAGE *pStage;
    s_bNextStage = FALSE;

    if (s_iStage >= s_cStages)
        return;

    pStage = &s_pStages[s_iStage];
    switch (pStage->nType)
    {
        case STAGE_TYPE_SEQUENCE:
            if (pStage->uMessages[s_iStep] == uMsg)
            {
                ok_int(1, 1);
                ok(s_nLevel == pStage->nLevel,
                   "Line %d, Step %d: Level expected %d but %d.\n",
                   pStage->nLine, s_iStep, pStage->nLevel, s_nLevel);
                ok(PARENT_MSG == pStage->uParentMsg,
                   "Line %d, Step %d: PARENT_MSG expected %u but %u.\n",
                   pStage->nLine, s_iStep, pStage->uParentMsg, PARENT_MSG);

                iAction = pStage->iActions[s_iStep];
                if (iAction)
                    DoAction(hwnd, iAction, wParam, lParam);

                ++s_iStep;
                if (s_iStep >= pStage->nCount)
                    s_bNextStage = TRUE;
            }
            break;
        case STAGE_TYPE_COUNTING:
            for (i = 0; i < pStage->nCount; ++i)
            {
                if (pStage->uMessages[i] == uMsg)
                {
                    ok_int(1, 1);
                    ok(s_nLevel == pStage->nLevel,
                       "Line %d: Level expected %d but %d.\n",
                       pStage->nLine, pStage->nLevel, s_nLevel);
                    ok(PARENT_MSG == pStage->uParentMsg,
                       "Line %d: PARENT_MSG expected %u but %u.\n",
                       pStage->nLine, pStage->uParentMsg, PARENT_MSG);

                    iAction = pStage->iActions[i];
                    if (iAction)
                        DoAction(hwnd, iAction, wParam, lParam);

                    ++s_nCounters[i];

                    if (i == pStage->nCount - 1)
                        s_bNextStage = TRUE;
                    break;
                }
            }
            break;
    }

    if (s_bNextStage)
    {
        NextStage(hwnd);
    }
}

Referenced by WindowProc().

General_DoTest()

static void General_DoTest ( void  )

static

Definition at line 357 of file MessageStateAnalyzer.c.

{
    WNDCLASSA wc;
    HWND hwnd;
    MSG msg;
    static const char s_szName[] = "MessageStateAnalyzerGeneral";

    trace("General_DoTest\n");
    DoInitialize(s_GeneralStages, ARRAYSIZE(s_GeneralStages));

    /* register window class */
    ZeroMemory(&wc, sizeof(wc));
    wc.style = CS_HREDRAW | CS_VREDRAW | CS_DBLCLKS;
    wc.lpfnWndProc = WindowProc;
    wc.hInstance = GetModuleHandleA(NULL);
    wc.hIcon = LoadIcon(NULL, IDI_APPLICATION);
    wc.hCursor = LoadCursor(NULL, IDC_ARROW);
    wc.hbrBackground = (HBRUSH)(COLOR_3DFACE + 1);
    wc.lpszClassName = s_szName;
    if (!RegisterClassA(&wc))
    {
        skip("RegisterClassW failed.\n");
        return;
    }

    /* create a window */
    hwnd = CreateWindowA(s_szName, s_szName, WS_OVERLAPPEDWINDOW,
                         0, 0, WIDTH, HEIGHT, NULL, NULL,
                         GetModuleHandleW(NULL), NULL);
    if (!hwnd)
    {
        skip("CreateWindowW failed.\n");
        return;
    }

    /* message loop */
    while (GetMessageA(&msg, NULL, 0, 0))
    {
        TranslateMessage(&msg);
        DispatchMessageA(&msg);
    }

    ok_int(UnregisterClassA(s_szName, GetModuleHandleA(NULL)), TRUE);

    DoFinish();
}

Referenced by START_TEST().

IME_DoTest()

static void IME_DoTest ( void  )

static

Definition at line 523 of file MessageStateAnalyzer.c.

{
    WNDCLASSA wc;
    HWND hwnd;
    MSG msg;
    static const char s_szName[] = "MessageStateAnalyzerIME";

    trace("IME_DoTest\n");
    DoInitialize(s_IMEStages, ARRAYSIZE(s_IMEStages));

    /* register window class */
    ZeroMemory(&wc, sizeof(wc));
    wc.style = CS_HREDRAW | CS_VREDRAW | CS_DBLCLKS;
    wc.lpfnWndProc = WindowProc;
    wc.hInstance = GetModuleHandleA(NULL);
    wc.hIcon = LoadIcon(NULL, IDI_APPLICATION);
    wc.hCursor = LoadCursor(NULL, IDC_ARROW);
    wc.hbrBackground = (HBRUSH)(COLOR_3DFACE + 1);
    wc.lpszClassName = s_szName;
    if (!RegisterClassA(&wc))
    {
        skip("RegisterClassW failed.\n");
        return;
    }

    /* create a window */
    hwnd = CreateWindowA(s_szName, s_szName, WS_OVERLAPPEDWINDOW,
                         0, 0, WIDTH, HEIGHT, NULL, NULL,
                         GetModuleHandleW(NULL), NULL);
    if (!hwnd)
    {
        skip("CreateWindowW failed.\n");
        return;
    }

    /* message loop */
    while (GetMessageA(&msg, NULL, 0, 0))
    {
        TranslateMessage(&msg);
        DispatchMessageA(&msg);
    }

    ok_int(UnregisterClassA(s_szName, GetModuleHandleA(NULL)), TRUE);

    DoFinish();
}

Referenced by START_TEST().

InnerWindowProc()

static LRESULT CALLBACK InnerWindowProc ( HWND  hwnd, UINT  uMsg, WPARAM  wParam, LPARAM  lParam  )

static

Definition at line 254 of file MessageStateAnalyzer.c.

{
    switch (uMsg)
    {
        case WM_COMMAND:
            DoAction(hwnd, LOWORD(wParam), 0, 0);
            break;
        case WM_TIMER:
            KillTimer(hwnd, (UINT)wParam);
            if (wParam == TIMEOUT_TIMER)
                DestroyWindow(hwnd);
            break;
        case WM_DESTROY:
            PostQuitMessage(0);
            break;
        case WM_NCCREATE:
            SetTimer(hwnd, TIMEOUT_TIMER, TOTAL_TIMEOUT, NULL);
            /* FALL THROUGH */
        default:
            return DefWindowProc(hwnd, uMsg, wParam, lParam);
    }
    return 0;
}

Referenced by WindowProc().

MsgDumpPrintf()

static void MsgDumpPrintf ( LPCSTR  fmt,   ...  )

static

Definition at line 13 of file MessageStateAnalyzer.c.

{
    static char s_szText[1024];
    va_list va;
    va_start(va, fmt);
    StringCbVPrintfA(s_szText, sizeof(s_szText), fmt, va);
    trace("%s", s_szText);
    va_end(va);
}

NextStage()

static void NextStage ( HWND  hwnd )

static

Definition at line 152 of file MessageStateAnalyzer.c.

{
    INT i, iAction;
    const STAGE *pStage = &s_pStages[s_iStage];

    if (pStage->nType == STAGE_TYPE_COUNTING)
    {
        /* check counters */
        for (i = 0; i < pStage->nCount; ++i)
        {
            if (pStage->nCounters[i] > 0)
            {
                ok(pStage->nCounters[i] == s_nCounters[i],
                   "Line %d: s_nCounters[%d] expected %d but %d.\n",
                   pStage->nLine, i, pStage->nCounters[i], s_nCounters[i]);
            }
        }
    }

    /* go to next stage */
    ++s_iStage;
    if (s_iStage >= s_cStages)
    {
        DestroyWindow(hwnd);
        return;
    }
    trace("Stage %d (Line %d)\n", s_iStage, s_pStages[s_iStage].nLine);

    s_iStep = 0;
    ZeroMemory(s_nCounters, sizeof(s_nCounters));

    iAction = s_pStages[s_iStage].iFirstAction;
    if (iAction)
        PostMessage(hwnd, WM_COMMAND, iAction, 0);
}

Referenced by DoStage().

START_TEST()

START_TEST

(

MessageStateAnalyzer

)

Definition at line 570 of file MessageStateAnalyzer.c.

{
    General_DoTest();
    IME_DoTest();
}

WindowProc()

static LRESULT CALLBACK WindowProc ( HWND  hwnd, UINT  uMsg, WPARAM  wParam, LPARAM  lParam  )

static

Definition at line 329 of file MessageStateAnalyzer.c.

{
    LRESULT lResult;

    /* Skip asynchronous WM_TIMER messages */
    if (uMsg == WM_TIMER) return InnerWindowProc(hwnd, uMsg, wParam, lParam);

    /* build s_prefix */
    DoBuildPrefix();

    /* message dump */
    MD_msgdump(hwnd, uMsg, wParam, lParam);

    ++s_nLevel;
    s_msgStack[s_nLevel] = uMsg;
    {
        /* do inner task */
        DoStage(hwnd, uMsg, wParam, lParam);
        lResult = InnerWindowProc(hwnd, uMsg, wParam, lParam);
    }
    --s_nLevel;

    /* message return */
    StringCbCopyA(s_prefix, sizeof(s_prefix), "R: ");
    MD_msgresult(hwnd, uMsg, wParam, lParam, lResult);
    return lResult;
}

Referenced by General_DoTest(), and IME_DoTest().

Variable Documentation

s_bNextStage

BOOL s_bNextStage

static

Definition at line 50 of file MessageStateAnalyzer.c.

Referenced by DoInitialize(), and DoStage().

s_cStages

INT s_cStages

static

Definition at line 54 of file MessageStateAnalyzer.c.

Referenced by DoFinish(), DoInitialize(), DoStage(), and NextStage().

s_GeneralStages

const STAGE s_GeneralStages[]

static

Initial value:

=
{
    
    {
        __LINE__, WM_NULL, 1, STAGE_TYPE_SEQUENCE, 0,
        4,
        { WM_GETMINMAXINFO, WM_NCCREATE, WM_NCCALCSIZE, WM_CREATE },
        { ACTION_FIRSTMINMAX, ACTION_NCCREATE, 0, 0 },
    },
    
    {
        __LINE__, WM_COMMAND, 2, STAGE_TYPE_SEQUENCE, ACTION_SHOW,
        6,
        { WM_SHOWWINDOW, WM_WINDOWPOSCHANGING, WM_WINDOWPOSCHANGING,
          WM_ACTIVATEAPP, WM_NCACTIVATE, WM_ACTIVATE },
    },
    {
        __LINE__, WM_COMMAND, 2, STAGE_TYPE_SEQUENCE, ACTION_DESTROY,
        6,
        { WM_WINDOWPOSCHANGING, WM_WINDOWPOSCHANGED, WM_NCACTIVATE,
          WM_ACTIVATE, WM_ACTIVATEAPP, WM_KILLFOCUS },
    },
    {
        __LINE__, WM_COMMAND, 2, STAGE_TYPE_SEQUENCE, 0,
        2,
        { WM_DESTROY, WM_NCDESTROY },
    },
}

Definition at line 299 of file MessageStateAnalyzer.c.

Referenced by General_DoTest().

s_IMEStages

const STAGE s_IMEStages[]

static

Definition at line 404 of file MessageStateAnalyzer.c.

Referenced by IME_DoTest().

s_iStage

INT s_iStage

static

Definition at line 47 of file MessageStateAnalyzer.c.

Referenced by DoFinish(), DoInitialize(), DoStage(), and NextStage().

s_iStep

INT s_iStep

static

Definition at line 48 of file MessageStateAnalyzer.c.

Referenced by DoAction(), DoFinish(), DoInitialize(), DoStage(), and NextStage().

s_msgStack

UINT s_msgStack[32]

static

Definition at line 52 of file MessageStateAnalyzer.c.

Referenced by DoInitialize(), and WindowProc().

s_nCounters

INT s_nCounters[10]

static

Definition at line 51 of file MessageStateAnalyzer.c.

Referenced by DoInitialize(), DoStage(), and NextStage().

s_nLevel

INT s_nLevel

static

Definition at line 49 of file MessageStateAnalyzer.c.

Referenced by DoInitialize(), DoStage(), and WindowProc().

s_prefix

char s_prefix[16] = ""

static

Definition at line 23 of file MessageStateAnalyzer.c.

Referenced by DoBuildPrefix(), and WindowProc().

s_pStages

const STAGE* s_pStages

static

Definition at line 53 of file MessageStateAnalyzer.c.

Referenced by DoInitialize(), DoStage(), and NextStage().