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/test.h"
  24
  25 /* undocumented SWP flags - from SDK 3.1 */
  26 #define SWP_NOCLIENTSIZE        0x0800
  27 #define SWP_NOCLIENTMOVE        0x1000
  28
  29 typedef enum
  30 {
  31     sent = 0x1,
  32     posted = 0x2,
  33     parent = 0x4,
  34     wparam = 0x8,
  35     lparam = 0x10,
  36     defwinproc = 0x20,
  37     beginpaint = 0x40,
  38     optional = 0x80,
  39     hook = 0x100,
  40     winevent_hook =0x200,
  41     id = 0x400,
  42     custdraw = 0x800
  43 } msg_flags_t;
  44
  45 struct message
  46 {
  47     UINT message;       /* the WM_* code */
  48     msg_flags_t flags;  /* message props */
  49     WPARAM wParam;      /* expected value of wParam */
  50     LPARAM lParam;      /* expected value of lParam */
  51     UINT id;            /* extra message data: id of the window,
  52                            notify code etc. */
  53     DWORD stage;        /* custom draw stage */
  54 };
  55
  56 struct msg_sequence
  57 {
  58     int count;
  59     int size;
  60     struct message *sequence;
  61 };
  62
  63 static void add_message(struct msg_sequence **seq, int sequence_index,
  64     const struct message *msg)
  65 {
  66     struct msg_sequence *msg_seq = seq[sequence_index];
  67
  68     if (!msg_seq->sequence)
  69     {
  70         msg_seq->size = 10;
  71         msg_seq->sequence = HeapAlloc(GetProcessHeap(), 0,
  72                                       msg_seq->size * sizeof (struct message));
  73     }
  74
  75     if (msg_seq->count == msg_seq->size)
  76     {
  77         msg_seq->size *= 2;
  78         msg_seq->sequence = HeapReAlloc(GetProcessHeap(), 0,
  79                                         msg_seq->sequence,
  80                                         msg_seq->size * sizeof (struct message));
  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     HeapFree(GetProcessHeap(), 0, 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 %08lx lp %08lx\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))
 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     {
 147         trace_(file, line)( "  %u: expected: msg %04x - actual: nothing\n", count, expected->message );
 148         expected++;
 149         count++;
 150     }
 151
 152     if (expected->message)
 153     {
 154         trace_(file, line)( "  %u: expected: msg %04x - actual: nothing\n", count, expected->message );
 155         return;
 156     }
 157
 158     while (actual->message)
 159     {
 160         trace_(file, line)( "  %u: expected: nothing - actual: %04x wp %08lx lp %08lx\n",
 161                             count, actual->message, actual->wParam, actual->lParam );
 162         actual++;
 163         count++;
 164     }
 165 }
 166
 167 static void ok_sequence_(struct msg_sequence **seq, int sequence_index,
 168     const struct message *expected, const char *context, BOOL todo,
 169     const char *file, int line)
 170 {
 171     struct msg_sequence *msg_seq = seq[sequence_index];
 172     static const struct message end_of_sequence = {0, 0, 0, 0};
 173     const struct message *actual, *sequence;
 174     int failcount = 0, dump = 0;
 175
 176     add_message(seq, sequence_index, &end_of_sequence);
 177
 178     sequence = msg_seq->sequence;
 179     actual = sequence;
 180
 181     while (expected->message && actual->message)
 182     {
 183         if (expected->message == actual->message)
 184         {
 185             if (expected->flags & wparam)
 186             {
 187                 if (expected->wParam != actual->wParam && todo)
 188                 {
 189                     todo_wine
 190                     {
 191                         failcount++;
 192                         dump++;
 193                         ok_(file, line) (FALSE,
 194                             "%s: in msg 0x%04x expecting wParam 0x%lx got 0x%lx\n",
 195                             context, expected->message, expected->wParam, actual->wParam);
 196                     }
 197                 }
 198                 else
 199                 {
 200                     ok_(file, line) (expected->wParam == actual->wParam,
 201                         "%s: in msg 0x%04x expecting wParam 0x%lx got 0x%lx\n",
 202                         context, expected->message, expected->wParam, actual->wParam);
 203                     if (expected->wParam != actual->wParam) dump++;
 204                 }
 205             }
 206
 207             if (expected->flags & lparam)
 208             {
 209                 if (expected->lParam != actual->lParam && todo)
 210                 {
 211                     todo_wine
 212                     {
 213                         failcount++;
 214                         dump++;
 215                         ok_(file, line) (FALSE,
 216                             "%s: in msg 0x%04x expecting lParam 0x%lx got 0x%lx\n",
 217                             context, expected->message, expected->lParam, actual->lParam);
 218                     }
 219                 }
 220                 else
 221                 {
 222                     ok_(file, line) (expected->lParam == actual->lParam,
 223                         "%s: in msg 0x%04x expecting lParam 0x%lx got 0x%lx\n",
 224                         context, expected->message, expected->lParam, actual->lParam);
 225                     if (expected->lParam != actual->lParam) dump++;
 226                 }
 227             }
 228
 229             if (expected->flags & custdraw)
 230             {
 231                 if (expected->stage != actual->stage && todo)
 232                 {
 233                     todo_wine
 234                     {
 235                         failcount++;
 236                         dump++;
 237                         ok_(file, line) (FALSE,
 238                             "%s: in msg 0x%04x expecting cd stage 0x%08x got 0x%08x\n",
 239                             context, expected->message, expected->stage, actual->stage);
 240                     }
 241                 }
 242                 else
 243                 {
 244                     ok_(file, line) (expected->stage == actual->stage,
 245                         "%s: in msg 0x%04x expecting cd stage 0x%08x got 0x%08x\n",
 246                         context, expected->message, expected->stage, actual->stage);
 247                     if (expected->stage != actual->stage) dump++;
 248                 }
 249             }
 250
 251             if (expected->flags & id)
 252             {
 253                 if (expected->id != actual->id && expected->flags & optional)
 254                 {
 255                     expected++;
 256                     continue;
 257                 }
 258                 if (expected->id != actual->id && todo)
 259                 {
 260                     todo_wine
 261                     {
 262                         failcount++;
 263                         dump++;
 264                         ok_(file, line) (FALSE,
 265                             "%s: in msg 0x%04x expecting id 0x%x got 0x%x\n",
 266                             context, expected->message, expected->id, actual->id);
 267                     }
 268                 }
 269                 else
 270                 {
 271                     ok_(file, line) (expected->id == actual->id,
 272                         "%s: in msg 0x%04x expecting id 0x%x got 0x%x\n",
 273                         context, expected->message, expected->id, actual->id);
 274                     if (expected->id != actual->id) dump++;
 275                 }
 276             }
 277
 278             if ((expected->flags & defwinproc) != (actual->flags & defwinproc) && todo)
 279             {
 280                 todo_wine
 281                 {
 282                     failcount++;
 283                     dump++;
 284                     ok_(file, line) (FALSE,
 285                         "%s: the msg 0x%04x should %shave been sent by DefWindowProc\n",
 286                         context, expected->message, (expected->flags & defwinproc) ? "" : "NOT ");
 287                 }
 288             }
 289             else
 290             {
 291                 ok_(file, line) ((expected->flags & defwinproc) == (actual->flags & defwinproc),
 292                     "%s: the msg 0x%04x should %shave been sent by DefWindowProc\n",
 293                     context, expected->message, (expected->flags & defwinproc) ? "" : "NOT ");
 294                 if ((expected->flags & defwinproc) != (actual->flags & defwinproc)) dump++;
 295             }
 296
 297             ok_(file, line) ((expected->flags & beginpaint) == (actual->flags & beginpaint),
 298                 "%s: the msg 0x%04x should %shave been sent by BeginPaint\n",
 299                 context, expected->message, (expected->flags & beginpaint) ? "" : "NOT ");
 300             if ((expected->flags & beginpaint) != (actual->flags & beginpaint)) dump++;
 301
 302             ok_(file, line) ((expected->flags & (sent|posted)) == (actual->flags & (sent|posted)),
 303                 "%s: the msg 0x%04x should have been %s\n",
 304                 context, expected->message, (expected->flags & posted) ? "posted" : "sent");
 305             if ((expected->flags & (sent|posted)) != (actual->flags & (sent|posted))) dump++;
 306
 307             ok_(file, line) ((expected->flags & parent) == (actual->flags & parent),
 308                 "%s: the msg 0x%04x was expected in %s\n",
 309                 context, expected->message, (expected->flags & parent) ? "parent" : "child");
 310             if ((expected->flags & parent) != (actual->flags & parent)) dump++;
 311
 312             ok_(file, line) ((expected->flags & hook) == (actual->flags & hook),
 313                 "%s: the msg 0x%04x should have been sent by a hook\n",
 314                 context, expected->message);
 315             if ((expected->flags & hook) != (actual->flags & hook)) dump++;
 316
 317             ok_(file, line) ((expected->flags & winevent_hook) == (actual->flags & winevent_hook),
 318                 "%s: the msg 0x%04x should have been sent by a winevent hook\n",
 319                 context, expected->message);
 320             if ((expected->flags & winevent_hook) != (actual->flags & winevent_hook)) dump++;
 321
 322             expected++;
 323             actual++;
 324         }
 325         else if (expected->flags & optional)
 326             expected++;
 327         else if (todo)
 328         {
 329             failcount++;
 330             dump++;
 331             todo_wine
 332             {
 333                 ok_(file, line) (FALSE, "%s: the msg 0x%04x was expected, but got msg 0x%04x instead\n",
 334                     context, expected->message, actual->message);
 335             }
 336             goto done;
 337         }
 338         else
 339         {
 340             ok_(file, line) (FALSE, "%s: the msg 0x%04x was expected, but got msg 0x%04x instead\n",
 341                 context, expected->message, actual->message);
 342             dump++;
 343             expected++;
 344             actual++;
 345         }
 346     }
 347
 348     /* skip all optional trailing messages */
 349     while (expected->message && ((expected->flags & optional)))
 350         expected++;
 351
 352     if (todo)
 353     {
 354         todo_wine
 355         {
 356             if (expected->message || actual->message)
 357             {
 358                 failcount++;
 359                 dump++;
 360                 ok_(file, line) (FALSE, "%s: the msg sequence is not complete: expected %04x - actual %04x\n",
 361                     context, expected->message, actual->message);
 362             }
 363         }
 364     }
 365     else if (expected->message || actual->message)
 366     {
 367         dump++;
 368         ok_(file, line) (FALSE, "%s: the msg sequence is not complete: expected %04x - actual %04x\n",
 369             context, expected->message, actual->message);
 370     }
 371
 372     if(todo && !failcount) /* succeeded yet marked todo */
 373     {
 374         dump++;
 375         todo_wine
 376         {
 377             ok_(file, line)(TRUE, "%s: marked \"todo_wine\" but succeeds\n", context);
 378         }
 379     }
 380
 381 done:
 382     if (dump) dump_sequence( seq, sequence_index, expected, context, file, line );
 383     flush_sequence(seq, sequence_index);
 384 }
 385
 386 #define ok_sequence(seq, index, exp, contx, todo) \
 387         ok_sequence_(seq, index, (exp), (contx), (todo), __FILE__, __LINE__)
 388
 389
 390 static void init_msg_sequences(struct msg_sequence **seq, int n)
 391 {
 392     int i;
 393
 394     for (i = 0; i < n; i++)
 395         seq[i] = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(struct msg_sequence));
 396 }