msg.h File Reference

#include <assert.h>
#include <windows.h>
#include "wine/heap.h"
#include "wine/test.h"

Include dependency graph for msg.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	message
struct	msg_sequence

Macros
#define	SWP_NOCLIENTSIZE   0x0800
#define	SWP_NOCLIENTMOVE   0x1000
#define	ok_sequence(seq, index, exp, contx, todo)    ok_sequence_(seq, index, (exp), (contx), (todo), __FILE__, __LINE__)

Enumerations
enum	msg_flags_t {   sent = 0x1 , posted = 0x2 , parent = 0x4 , wparam = 0x8 ,   lparam = 0x10 , defwinproc = 0x20 , beginpaint = 0x40 , optional = 0x80 ,   hook = 0x100 , winevent_hook = 0x200 , kbd_hook = 0x400 , sent = 0x1 ,   posted = 0x2 , parent = 0x4 , wparam = 0x8 , lparam = 0x10 ,   defwinproc = 0x20 , beginpaint = 0x40 , optional = 0x80 , hook = 0x100 ,   winevent_hook =0x200 , id = 0x400 , custdraw = 0x800 , sent = 0x1 ,   posted = 0x2 , parent = 0x4 , wparam = 0x8 , lparam = 0x10 ,   defwinproc = 0x20 , beginpaint = 0x40 , optional = 0x80 , hook = 0x100 ,   winevent_hook =0x200 , id = 0x400 , sent =0x1 , posted =0x2 ,   parent =0x4 , wparam =0x8 , lparam =0x10 , defwinproc =0x20 ,   beginpaint =0x40 , optional =0x80 , hook =0x100 , winevent_hook =0x200 ,   sent =0x1 , posted =0x2 , parent =0x4 , wparam =0x8 ,   lparam =0x10 , defwinproc =0x20 , beginpaint =0x40 , optional =0x80 ,   hook =0x100 , winevent_hook =0x200 , kbd_hook =0x400 }

Functions
static void	add_message (struct msg_sequence **seq, int sequence_index, const struct message *msg)
static void	flush_sequence (struct msg_sequence **seg, int sequence_index)
static void	flush_sequences (struct msg_sequence **seq, int n)
static void	dump_sequence (struct msg_sequence **seq, int sequence_index, const struct message *expected, const char *context, const char *file, int line)
static void	ok_sequence_ (struct msg_sequence **seq, int sequence_index, const struct message *expected_list, const char *context, BOOL todo, const char *file, int line)
static void	init_msg_sequences (struct msg_sequence **seq, int n)

Macro Definition Documentation

ok_sequence

#define ok_sequence	(		seq,
			index,
			exp,
			contx,
			todo
	)		ok_sequence_(seq, index, (exp), (contx), (todo), __FILE__, __LINE__)

Definition at line 387 of file msg.h.

SWP_NOCLIENTMOVE

#define SWP_NOCLIENTMOVE   0x1000

Definition at line 30 of file msg.h.

SWP_NOCLIENTSIZE

#define SWP_NOCLIENTSIZE   0x0800

Definition at line 29 of file msg.h.

Enumeration Type Documentation

msg_flags_t

enum msg_flags_t

Enumerator
sent
posted
parent
wparam
lparam
defwinproc
beginpaint
optional
hook
winevent_hook
kbd_hook
sent
posted
parent
wparam
lparam
defwinproc
beginpaint
optional
hook
winevent_hook
id
custdraw
sent
posted
parent
wparam
lparam
defwinproc
beginpaint
optional
hook
winevent_hook
id
sent
posted
parent
wparam
lparam
defwinproc
beginpaint
optional
hook
winevent_hook
sent
posted
parent
wparam
lparam
defwinproc
beginpaint
optional
hook
winevent_hook
kbd_hook

Definition at line 32 of file msg.h.

{
    sent = 0x1,
    posted = 0x2,
    parent = 0x4,
    wparam = 0x8,
    lparam = 0x10,
    defwinproc = 0x20,
    beginpaint = 0x40,
    optional = 0x80,
    hook = 0x100,
    winevent_hook =0x200,
    id = 0x400,
    custdraw = 0x800
} msg_flags_t;

Function Documentation

add_message()

static void add_message ( struct msg_sequence **  seq, int  sequence_index, const struct message *  msg  )

static

Definition at line 66 of file msg.h.

{
    struct msg_sequence *msg_seq = seq[sequence_index];
 
    if (!msg_seq->sequence)
    {
        msg_seq->size = 10;
        msg_seq->sequence = heap_alloc(msg_seq->size * sizeof (*msg_seq->sequence));
    }
 
    if (msg_seq->count == msg_seq->size)
    {
        msg_seq->size *= 2;
        msg_seq->sequence = heap_realloc(msg_seq->sequence, msg_seq->size * sizeof (*msg_seq->sequence));
    }
 
    assert(msg_seq->sequence);
 
    msg_seq->sequence[msg_seq->count] = *msg;
    msg_seq->count++;
}

dump_sequence()

static void dump_sequence ( struct msg_sequence **  seq, int  sequence_index, const struct message *  expected, const char *  context, const char *  file, int  line  )

static

Definition at line 105 of file msg.h.

{
    struct msg_sequence *msg_seq = seq[sequence_index];
    const struct message *actual, *sequence;
    unsigned int count = 0;
 
    sequence = msg_seq->sequence;
    actual = sequence;
 
    trace_(file, line)("Failed sequence %s:\n", context );
    while (expected->message && actual->message)
    {
        trace_(file, line)( "  %u: expected: %04x - actual: %04x wp %08lx lp %08lx\n",
                            count, expected->message, actual->message, actual->wParam, actual->lParam );
 
    if (expected->message == actual->message)
    {
        if ((expected->flags & defwinproc) != (actual->flags & defwinproc) &&
                (expected->flags & optional))
            {
                /* don't match messages if their defwinproc status differs */
                expected++;
            }
            else
            {
                expected++;
                actual++;
            }
    }
        else
        {
            expected++;
            actual++;
        }
        count++;
    }
 
    /* optional trailing messages */
    while (expected->message && expected->flags & optional)
    {
        trace_(file, line)( "  %u: expected: msg %04x - actual: nothing\n", count, expected->message );
    expected++;
        count++;
    }
 
    if (expected->message)
    {
        trace_(file, line)( "  %u: expected: msg %04x - actual: nothing\n", count, expected->message );
        return;
    }
 
    while (actual->message)
    {
        trace_(file, line)( "  %u: expected: nothing - actual: %04x wp %08lx lp %08lx\n",
                            count, actual->message, actual->wParam, actual->lParam );
        actual++;
        count++;
    }
}

Referenced by ok_sequence_().

flush_sequence()

static void flush_sequence ( struct msg_sequence **  seg, int  sequence_index  )

inlinestatic

Definition at line 89 of file msg.h.

{
    struct msg_sequence *msg_seq = seg[sequence_index];
    heap_free(msg_seq->sequence);
    msg_seq->sequence = NULL;
    msg_seq->count = msg_seq->size = 0;
}

flush_sequences()

static void flush_sequences ( struct msg_sequence **  seq, int  n  )

inlinestatic

Definition at line 97 of file msg.h.

{
    int i;
 
    for (i = 0; i < n; i++)
        flush_sequence(seq, i);
}

Referenced by create_custom_header_control(), create_parent_window(), run_test_(), START_TEST(), test_button_messages(), test_callback(), test_callback_mask(), test_canceleditlabel(), test_change_focus(), test_color(), test_columns(), test_comboex_get_set_item(), test_create(), test_create_syslink(), test_curfocus(), test_currdate(), test_cursel(), test_customdraw(), test_delete_focus(), test_delete_items(), test_destroy(), test_destroynotify(), test_dtm_get_monthcal(), test_dtm_set_and_get_mccolor(), test_dtm_set_and_get_mcfont(), test_dtm_set_and_get_range(), test_dtm_set_and_get_system_time(), test_dtm_set_and_get_systemtime_with_limits(), test_dtm_set_format(), test_dtm_set_range_swap_min_max(), test_editbox(), test_expandnotify(), test_extendedstyle(), test_fillroot(), test_firstDay(), test_focus(), test_get_set_bkcolor(), test_get_set_imagelist(), test_get_set_indent(), test_get_set_insertmark(), test_get_set_item(), test_get_set_itemheight(), test_get_set_scrolltime(), test_get_set_textcolor(), test_get_set_tooltips(), test_get_set_unicodeformat(), test_getitemposition(), test_getitemtext(), test_GetListBoxInfo(), test_getorigin(), test_getset_item(), test_getset_tooltips(), test_GetSetCurrentViewMode(), test_hdm_bitmapmarginMessages(), test_hdm_filterMessages(), test_hdm_getitemrect(), test_hdm_hittest(), test_hdm_imageMessages(), test_hdm_index_messages(), test_hdm_layout(), test_hdm_ordertoindex(), test_hdm_sethotdivider(), test_hdm_unicodeformatMessages(), test_header_notification(), test_header_notification2(), test_hittest(), test_hover(), test_icon_spacing(), test_IFolderView(), test_ignore_selection(), test_imagelists(), test_indentation(), test_insert_focus(), test_insertitem(), test_item_count(), test_item_position(), test_items(), test_line_size(), test_LVN_ENDLABELEDIT(), test_LVS_EX_TRANSPARENTBKGND(), test_maxselday(), test_monthrange(), test_multiselect(), test_norecompute(), test_ownerdata(), test_page_size(), test_pager(), test_position(), test_range(), test_redraw(), test_right_click(), test_save(), test_scroll(), test_scrollnotify(), test_select(), test_selection(), test_setredraw(), test_subitem_rect(), test_TCM_GETROWCOUNT(), test_TCN_SELCHANGING(), test_thumb_length(), test_tic_placement(), test_tic_settings(), test_today(), test_todaylink(), test_tool_tips(), test_tooltip(), test_trackbar_buddy(), test_TTN_SHOW(), test_TVS_SINGLEEXPAND(), test_unicode(), test_unicodeformat(), test_updown_base(), test_updown_buddy(), test_updown_create(), test_updown_pos(), test_updown_pos32(), test_updown_pos_notifications(), test_updown_unicode(), test_WM_CONTEXTMENU(), test_WM_KEYDOWN(), test_WM_MEASUREITEM(), and verify_msgs_in_().

init_msg_sequences()

static void init_msg_sequences ( struct msg_sequence **  seq, int  n  )

inlinestatic

Definition at line 391 of file msg.h.

{
    int i;
 
    for (i = 0; i < n; i++)
        seq[i] = heap_alloc_zero(sizeof(*seq[i]));
}

Referenced by START_TEST(), and test_messages().

ok_sequence_()

static void ok_sequence_ ( struct msg_sequence **  seq, int  sequence_index, const struct message *  expected_list, const char *  context, BOOL  todo, const char *  file, int  line  )

inlinestatic

Definition at line 167 of file msg.h.

{
    static const struct message end_of_sequence = {0, 0, 0, 0};
    struct msg_sequence *msg_seq = seq[sequence_index];
    const struct message *expected = expected_list;
    const struct message *actual, *sequence;
    int failcount = 0, dump = 0;
 
    add_message(seq, sequence_index, &end_of_sequence);
 
    sequence = msg_seq->sequence;
    actual = sequence;
 
    while (expected->message && actual->message)
    {
        if (expected->message == actual->message)
        {
            if (expected->flags & wparam)
            {
                if (expected->wParam != actual->wParam && todo)
                {
                    todo_wine
                    {
                        failcount++;
                        dump++;
                        ok_(file, line) (FALSE,
                            "%s: in msg 0x%04x expecting wParam 0x%lx got 0x%lx\n",
                            context, expected->message, expected->wParam, actual->wParam);
                    }
                }
                else
                {
                    ok_(file, line) (expected->wParam == actual->wParam,
                        "%s: in msg 0x%04x expecting wParam 0x%lx got 0x%lx\n",
                        context, expected->message, expected->wParam, actual->wParam);
                    if (expected->wParam != actual->wParam) dump++;
                }
            }
 
            if (expected->flags & lparam)
            {
                if (expected->lParam != actual->lParam && todo)
                {
                    todo_wine
                    {
                        failcount++;
                        dump++;
                        ok_(file, line) (FALSE,
                            "%s: in msg 0x%04x expecting lParam 0x%lx got 0x%lx\n",
                            context, expected->message, expected->lParam, actual->lParam);
                    }
                }
                else
                {
                    ok_(file, line) (expected->lParam == actual->lParam,
                        "%s: in msg 0x%04x expecting lParam 0x%lx got 0x%lx\n",
                        context, expected->message, expected->lParam, actual->lParam);
                    if (expected->lParam != actual->lParam) dump++;
                }
            }
 
            if (expected->flags & custdraw)
            {
                if (expected->stage != actual->stage && todo)
                {
                    todo_wine
                    {
                        failcount++;
                        dump++;
                        ok_(file, line) (FALSE,
                            "%s: in msg 0x%04x expecting cd stage 0x%08x got 0x%08x\n",
                            context, expected->message, expected->stage, actual->stage);
                    }
                }
                else
                {
                    ok_(file, line) (expected->stage == actual->stage,
                        "%s: in msg 0x%04x expecting cd stage 0x%08x got 0x%08x\n",
                        context, expected->message, expected->stage, actual->stage);
                    if (expected->stage != actual->stage) dump++;
                }
            }
 
            if (expected->flags & id)
            {
                if (expected->id != actual->id && expected->flags & optional)
                {
                    expected++;
                    continue;
                }
                if (expected->id != actual->id && todo)
                {
                    todo_wine
                    {
                        failcount++;
                        dump++;
                        ok_(file, line) (FALSE,
                            "%s: in msg 0x%04x expecting id 0x%x got 0x%x\n",
                            context, expected->message, expected->id, actual->id);
                    }
                }
                else
                {
                    ok_(file, line) (expected->id == actual->id,
                        "%s: in msg 0x%04x expecting id 0x%x got 0x%x\n",
                        context, expected->message, expected->id, actual->id);
                    if (expected->id != actual->id) dump++;
                }
            }
 
            if ((expected->flags & defwinproc) != (actual->flags & defwinproc) && todo)
            {
                todo_wine
                {
                    failcount++;
                    dump++;
                    ok_(file, line) (FALSE,
                        "%s: the msg 0x%04x should %shave been sent by DefWindowProc\n",
                        context, expected->message, (expected->flags & defwinproc) ? "" : "NOT ");
                }
            }
            else
            {
                ok_(file, line) ((expected->flags & defwinproc) == (actual->flags & defwinproc),
                    "%s: the msg 0x%04x should %shave been sent by DefWindowProc\n",
                    context, expected->message, (expected->flags & defwinproc) ? "" : "NOT ");
                if ((expected->flags & defwinproc) != (actual->flags & defwinproc)) dump++;
            }
 
            ok_(file, line) ((expected->flags & beginpaint) == (actual->flags & beginpaint),
                "%s: the msg 0x%04x should %shave been sent by BeginPaint\n",
                context, expected->message, (expected->flags & beginpaint) ? "" : "NOT ");
            if ((expected->flags & beginpaint) != (actual->flags & beginpaint)) dump++;
 
            ok_(file, line) ((expected->flags & (sent|posted)) == (actual->flags & (sent|posted)),
                "%s: the msg 0x%04x should have been %s\n",
                context, expected->message, (expected->flags & posted) ? "posted" : "sent");
            if ((expected->flags & (sent|posted)) != (actual->flags & (sent|posted))) dump++;
 
            ok_(file, line) ((expected->flags & parent) == (actual->flags & parent),
                "%s: the msg 0x%04x was expected in %s\n",
                context, expected->message, (expected->flags & parent) ? "parent" : "child");
            if ((expected->flags & parent) != (actual->flags & parent)) dump++;
 
            ok_(file, line) ((expected->flags & hook) == (actual->flags & hook),
                "%s: the msg 0x%04x should have been sent by a hook\n",
                context, expected->message);
            if ((expected->flags & hook) != (actual->flags & hook)) dump++;
 
            ok_(file, line) ((expected->flags & winevent_hook) == (actual->flags & winevent_hook),
                "%s: the msg 0x%04x should have been sent by a winevent hook\n",
                context, expected->message);
            if ((expected->flags & winevent_hook) != (actual->flags & winevent_hook)) dump++;
 
            expected++;
            actual++;
        }
        else if (expected->flags & optional)
            expected++;
        else if (todo)
        {
            failcount++;
            dump++;
            todo_wine
            {
                ok_(file, line) (FALSE, "%s: the msg 0x%04x was expected, but got msg 0x%04x instead\n",
                    context, expected->message, actual->message);
            }
            goto done;
        }
        else
        {
            ok_(file, line) (FALSE, "%s: the msg 0x%04x was expected, but got msg 0x%04x instead\n",
                context, expected->message, actual->message);
            dump++;
            expected++;
            actual++;
        }
    }
 
    /* skip all optional trailing messages */
    while (expected->message && ((expected->flags & optional)))
        expected++;
 
    if (todo)
    {
        todo_wine
        {
            if (expected->message || actual->message)
            {
                failcount++;
                dump++;
                ok_(file, line) (FALSE, "%s: the msg sequence is not complete: expected %04x - actual %04x\n",
                    context, expected->message, actual->message);
            }
        }
    }
    else if (expected->message || actual->message)
    {
        dump++;
        ok_(file, line) (FALSE, "%s: the msg sequence is not complete: expected %04x - actual %04x\n",
            context, expected->message, actual->message);
    }
 
    if(todo && !failcount) /* succeeded yet marked todo */
    {
        if (!strcmp(winetest_platform, "wine")) dump++;
        todo_wine
        {
            ok_(file, line)(TRUE, "%s: marked \"todo_wine\" but succeeds\n", context);
        }
    }
 
done:
    if (dump) dump_sequence( seq, sequence_index, expected_list, context, file, line );
    flush_sequence(seq, sequence_index);
}