dlls/comctl32/tests/msg.h

   1 /* Message Sequence Testing Code
   2  *
   3  * Copyright (C) 2007 James Hawkins
   4  * Copyright (C) 2007 Lei Zhang
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #include <assert.h>
  22 #include <windows.h>
  23 #include "wine/heap.h"
  24 #include "wine/test.h"
  25
  26 /* undocumented SWP flags - from SDK 3.1 */
  27 #define SWP_NOCLIENTSIZE        0x0800
  28 #define SWP_NOCLIENTMOVE        0x1000
  29
  30 typedef enum
  31 {
  32     sent = 0x1,
  33     posted = 0x2,
  34     parent = 0x4,
  35     wparam = 0x8,
  36     lparam = 0x10,
  37     defwinproc = 0x20,
  38     beginpaint = 0x40,
  39     optional = 0x80,
  40     hook = 0x100,
  41     winevent_hook =0x200,
  42     id = 0x400,
  43     custdraw = 0x800
  44 } msg_flags_t;
  45
  46 struct message
  47 {
  48     UINT message;       /* the WM_* code */
  49     msg_flags_t flags;  /* message props */
  50     WPARAM wParam;      /* expected value of wParam */
  51     LPARAM lParam;      /* expected value of lParam */
  52     UINT id;            /* extra message data: id of the window,
  53                            notify code etc. */
  54     DWORD stage;        /* custom draw stage */
  55 };
  56
  57 struct msg_sequence
  58 {
  59     int count;
  60     int size;
  61     struct message *sequence;
  62 };
  63
  64 static HWINEVENTHOOK hwineventhook;
  65
  66 static void add_message(struct msg_sequence **seq, int sequence_index,
  67     const struct message *msg)
  68 {
  69     struct msg_sequence *msg_seq = seq[sequence_index];
  70
  71     if (!msg_seq->sequence)
  72     {
  73         msg_seq->size = 10;
  74         msg_seq->sequence = malloc(msg_seq->size * sizeof (*msg_seq->sequence));
  75     }
  76
  77     if (msg_seq->count == msg_seq->size)
  78     {
  79         msg_seq->size *= 2;
  80         msg_seq->sequence = realloc(msg_seq->sequence, msg_seq->size * sizeof (*msg_seq->sequence));
  81     }
  82
  83     assert(msg_seq->sequence);
  84
  85     msg_seq->sequence[msg_seq->count] = *msg;
  86     msg_seq->count++;
  87 }
  88
  89 static inline void flush_sequence(struct msg_sequence **seg, int sequence_index)
  90 {
  91     struct msg_sequence *msg_seq = seg[sequence_index];
  92     free(msg_seq->sequence);
  93     msg_seq->sequence = NULL;
  94     msg_seq->count = msg_seq->size = 0;
  95 }
  96
  97 static inline void flush_sequences(struct msg_sequence **seq, int n)
  98 {
  99     int i;
 100
 101     for (i = 0; i < n; i++)
 102         flush_sequence(seq, i);
 103 }
 104
 105 static void dump_sequence( struct msg_sequence **seq, int sequence_index,
 106                            const struct message *expected, const char *context,
 107                            const char *file, int line )
 108 {
 109     struct msg_sequence *msg_seq = seq[sequence_index];
 110     const struct message *actual, *sequence;
 111     unsigned int count = 0;
 112
 113     sequence = msg_seq->sequence;
 114     actual = sequence;
 115
 116     trace_(file, line)("Failed sequence %s:\n", context );
 117     while (expected->message && actual->message)
 118     {
 119         trace_(file, line)( "  %u: expected: %04x - actual: %04x wp %08Ix lp %08Ix\n",
 120                             count, expected->message, actual->message, actual->wParam, actual->lParam );
 121
 122         if (expected->message == actual->message)
 123         {
 124             if ((expected->flags & defwinproc) != (actual->flags & defwinproc) &&
 125                 ((expected->flags & optional) || ((expected->flags & winevent_hook) && !hwineventhook)))
 126             {
 127                 /* don't match messages if their defwinproc status differs */
 128                 expected++;
 129             }
 130             else
 131             {
 132                 expected++;
 133                 actual++;
 134             }
 135         }
 136         else
 137         {
 138             expected++;
 139             actual++;
 140         }
 141         count++;
 142     }
 143
 144     /* optional trailing messages */
 145     while (expected->message && (expected->flags & optional ||
 146                                  ((expected->flags & winevent_hook) && !hwineventhook)))
 147     {
 148         trace_(file, line)( "  %u: expected: msg %04x - actual: nothing\n", count, expected->message );
 149         expected++;
 150         count++;
 151     }
 152
 153     if (expected->message)
 154     {
 155         trace_(file, line)( "  %u: expected: msg %04x - actual: nothing\n", count, expected->message );
 156         return;
 157     }
 158
 159     while (actual->message)
 160     {
 161         trace_(file, line)( "  %u: expected: nothing - actual: %04x wp %08Ix lp %08Ix\n",
 162                             count, actual->message, actual->wParam, actual->lParam );
 163         actual++;
 164         count++;
 165     }
 166 }
 167
 168 static void ok_sequence_(struct msg_sequence **seq, int sequence_index,
 169     const struct message *expected_list, const char *context, BOOL todo,
 170     const char *file, int line)
 171 {
 172     static const struct message end_of_sequence = {0, 0, 0, 0};
 173     struct msg_sequence *msg_seq = seq[sequence_index];
 174     const struct message *expected = expected_list;
 175     const struct message *actual, *sequence;
 176     int failcount = 0, dump = 0;
 177
 178     add_message(seq, sequence_index, &end_of_sequence);
 179
 180     sequence = msg_seq->sequence;
 181     actual = sequence;
 182
 183     while (expected->message && actual->message)
 184     {
 185         if (expected->message == actual->message)
 186         {
 187             if (expected->flags & wparam)
 188             {
 189                 if (expected->wParam != actual->wParam && todo)
 190                 {
 191                     todo_wine
 192                     {
 193                         failcount++;
 194                         dump++;
 195                         ok_(file, line) (FALSE,
 196                             "%s: in msg 0x%04x expecting wParam 0x%Ix got 0x%Ix\n",
 197                             context, expected->message, expected->wParam, actual->wParam);
 198                     }
 199                 }
 200                 else
 201                 {
 202                     ok_(file, line) (expected->wParam == actual->wParam,
 203                         "%s: in msg 0x%04x expecting wParam 0x%Ix got 0x%Ix\n",
 204                         context, expected->message, expected->wParam, actual->wParam);
 205                     if (expected->wParam != actual->wParam) dump++;
 206                 }
 207             }
 208
 209             if (expected->flags & lparam)
 210             {
 211                 if (expected->lParam != actual->lParam && todo)
 212                 {
 213                     todo_wine
 214                     {
 215                         failcount++;
 216                         dump++;
 217                         ok_(file, line) (FALSE,
 218                             "%s: in msg 0x%04x expecting lParam 0x%Ix got 0x%Ix\n",
 219                             context, expected->message, expected->lParam, actual->lParam);
 220                     }
 221                 }
 222                 else
 223                 {
 224                     ok_(file, line) (expected->lParam == actual->lParam,
 225                         "%s: in msg 0x%04x expecting lParam 0x%Ix got 0x%Ix\n",
 226                         context, expected->message, expected->lParam, actual->lParam);
 227                     if (expected->lParam != actual->lParam) dump++;
 228                 }
 229             }
 230
 231             if (expected->flags & custdraw)
 232             {
 233                 if (expected->stage != actual->stage && todo)
 234                 {
 235                     todo_wine
 236                     {
 237                         failcount++;
 238                         dump++;
 239                         ok_(file, line) (FALSE,
 240                             "%s: in msg 0x%04x expecting cd stage 0x%08lx got 0x%08lx\n",
 241                             context, expected->message, expected->stage, actual->stage);
 242                     }
 243                 }
 244                 else
 245                 {
 246                     ok_(file, line) (expected->stage == actual->stage,
 247                         "%s: in msg 0x%04x expecting cd stage 0x%08lx got 0x%08lx\n",
 248                         context, expected->message, expected->stage, actual->stage);
 249                     if (expected->stage != actual->stage) dump++;
 250                 }
 251             }
 252
 253             if (expected->flags & id)
 254             {
 255                 if (expected->id != actual->id && ((expected->flags & optional) || ((expected->flags & winevent_hook) && !hwineventhook)))
 256                 {
 257                     expected++;
 258                     continue;
 259                 }
 260                 if (expected->id != actual->id && todo)
 261                 {
 262                     todo_wine
 263                     {
 264                         failcount++;
 265                         dump++;
 266                         ok_(file, line) (FALSE,
 267                             "%s: in msg 0x%04x expecting id %d got %d\n",
 268                             context, expected->message, expected->id, actual->id);
 269                     }
 270                 }
 271                 else
 272                 {
 273                     ok_(file, line) (expected->id == actual->id,
 274                         "%s: in msg 0x%04x expecting id %d got %d\n",
 275                         context, expected->message, expected->id, actual->id);
 276                     if (expected->id != actual->id) dump++;
 277                 }
 278             }
 279
 280             if ((expected->flags & defwinproc) != (actual->flags & defwinproc) && todo)
 281             {
 282                 todo_wine
 283                 {
 284                     failcount++;
 285                     dump++;
 286                     ok_(file, line) (FALSE,
 287                         "%s: the msg 0x%04x should %shave been sent by DefWindowProc\n",
 288                         context, expected->message, (expected->flags & defwinproc) ? "" : "NOT ");
 289                 }
 290             }
 291             else
 292             {
 293                 ok_(file, line) ((expected->flags & defwinproc) == (actual->flags & defwinproc),
 294                     "%s: the msg 0x%04x should %shave been sent by DefWindowProc\n",
 295                     context, expected->message, (expected->flags & defwinproc) ? "" : "NOT ");
 296                 if ((expected->flags & defwinproc) != (actual->flags & defwinproc)) dump++;
 297             }
 298
 299             ok_(file, line) ((expected->flags & beginpaint) == (actual->flags & beginpaint),
 300                 "%s: the msg 0x%04x should %shave been sent by BeginPaint\n",
 301                 context, expected->message, (expected->flags & beginpaint) ? "" : "NOT ");
 302             if ((expected->flags & beginpaint) != (actual->flags & beginpaint)) dump++;
 303
 304             ok_(file, line) ((expected->flags & (sent|posted)) == (actual->flags & (sent|posted)),
 305                 "%s: the msg 0x%04x should have been %s\n",
 306                 context, expected->message, (expected->flags & posted) ? "posted" : "sent");
 307             if ((expected->flags & (sent|posted)) != (actual->flags & (sent|posted))) dump++;
 308
 309             ok_(file, line) ((expected->flags & parent) == (actual->flags & parent),
 310                 "%s: the msg 0x%04x was expected in %s\n",
 311                 context, expected->message, (expected->flags & parent) ? "parent" : "child");
 312             if ((expected->flags & parent) != (actual->flags & parent)) dump++;
 313
 314             ok_(file, line) ((expected->flags & hook) == (actual->flags & hook),
 315                 "%s: the msg 0x%04x should have been sent by a hook\n",
 316                 context, expected->message);
 317             if ((expected->flags & hook) != (actual->flags & hook)) dump++;
 318
 319             ok_(file, line) ((expected->flags & winevent_hook) == (actual->flags & winevent_hook),
 320                 "%s: the msg 0x%04x should have been sent by a winevent hook\n",
 321                 context, expected->message);
 322             if ((expected->flags & winevent_hook) != (actual->flags & winevent_hook)) dump++;
 323
 324             expected++;
 325             actual++;
 326         }
 327         else if ((expected->flags & optional) || ((expected->flags & winevent_hook) && !hwineventhook))
 328             expected++;
 329         else if (todo)
 330         {
 331             failcount++;
 332             dump++;
 333             todo_wine
 334             {
 335                 ok_(file, line) (FALSE, "%s: the msg 0x%04x was expected, but got msg 0x%04x instead\n",
 336                     context, expected->message, actual->message);
 337             }
 338             goto done;
 339         }
 340         else
 341         {
 342             ok_(file, line) (FALSE, "%s: the msg 0x%04x was expected, but got msg 0x%04x instead\n",
 343                 context, expected->message, actual->message);
 344             dump++;
 345             expected++;
 346             actual++;
 347         }
 348     }
 349
 350     /* skip all optional trailing messages */
 351     while (expected->message && ((expected->flags & optional) || ((expected->flags & winevent_hook) && !hwineventhook)))
 352         expected++;
 353
 354     if (todo)
 355     {
 356         todo_wine
 357         {
 358             if (expected->message || actual->message)
 359             {
 360                 failcount++;
 361                 dump++;
 362                 ok_(file, line) (FALSE, "%s: the msg sequence is not complete: expected %04x - actual %04x\n",
 363                     context, expected->message, actual->message);
 364             }
 365         }
 366     }
 367     else if (expected->message || actual->message)
 368     {
 369         dump++;
 370         ok_(file, line) (FALSE, "%s: the msg sequence is not complete: expected %04x - actual %04x\n",
 371             context, expected->message, actual->message);
 372     }
 373
 374     if(todo && !failcount) /* succeeded yet marked todo */
 375     {
 376         if (!strcmp(winetest_platform, "wine")) dump++;
 377         todo_wine
 378         {
 379             ok_(file, line)(TRUE, "%s: marked \"todo_wine\" but succeeds\n", context);
 380         }
 381     }
 382
 383 done:
 384     if (dump) dump_sequence( seq, sequence_index, expected_list, context, file, line );
 385     flush_sequence(seq, sequence_index);
 386 }
 387
 388 #define ok_sequence(seq, index, exp, contx, todo) \
 389         ok_sequence_(seq, index, (exp), (contx), (todo), __FILE__, __LINE__)
 390
 391
 392 static void init_msg_sequences(struct msg_sequence **seq, int n)
 393 {
 394     int i;
 395
 396     for (i = 0; i < n; i++)
 397         seq[i] = calloc(1, sizeof(*seq[i]));
 398 }