unity.c 45.2 KB
Newer Older
M
Mark VanderVoord 已提交
1 2 3 4 5 6 7 8 9
/* =========================================================================
    Unity Project - A Test Framework for C
    Copyright (c) 2007-14 Mike Karlesky, Mark VanderVoord, Greg Williams
    [Released under MIT License. Please refer to license.txt for details]
============================================================================ */

#include "unity.h"
#include <stddef.h>

10
/* If omitted from header, declare overrideable prototypes here so they're ready for use */
11
#ifdef UNITY_OMIT_OUTPUT_CHAR_HEADER_DECLARATION
12
void UNITY_OUTPUT_CHAR(int);
13 14
#endif

15
/* Helpful macros for us to use here */
M
Mark VanderVoord 已提交
16 17
#define UNITY_FAIL_AND_BAIL   { Unity.CurrentTestFailed  = 1; longjmp(Unity.AbortFrame, 1); }
#define UNITY_IGNORE_AND_BAIL { Unity.CurrentTestIgnored = 1; longjmp(Unity.AbortFrame, 1); }
18

19
/* return prematurely if we are already in failure or ignore state */
M
Mark VanderVoord 已提交
20 21
#define UNITY_SKIP_EXECUTION  { if ((Unity.CurrentTestFailed != 0) || (Unity.CurrentTestIgnored != 0)) {return;} }

22
struct UNITY_STORAGE_T Unity;
M
Mark VanderVoord 已提交
23

24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
static const char UnityStrOk[]                     = "OK";
static const char UnityStrPass[]                   = "PASS";
static const char UnityStrFail[]                   = "FAIL";
static const char UnityStrIgnore[]                 = "IGNORE";
static const char UnityStrNull[]                   = "NULL";
static const char UnityStrSpacer[]                 = ". ";
static const char UnityStrExpected[]               = " Expected ";
static const char UnityStrWas[]                    = " Was ";
static const char UnityStrElement[]                = " Element ";
static const char UnityStrByte[]                   = " Byte ";
static const char UnityStrMemory[]                 = " Memory Mismatch.";
static const char UnityStrDelta[]                  = " Values Not Within Delta ";
static const char UnityStrPointless[]              = " You Asked Me To Compare Nothing, Which Was Pointless.";
static const char UnityStrNullPointerForExpected[] = " Expected pointer to be NULL";
static const char UnityStrNullPointerForActual[]   = " Actual pointer was NULL";
39
#ifndef UNITY_EXCLUDE_FLOAT
40 41 42 43 44 45
static const char UnityStrNot[]                    = "Not ";
static const char UnityStrInf[]                    = "Infinity";
static const char UnityStrNegInf[]                 = "Negative Infinity";
static const char UnityStrNaN[]                    = "NaN";
static const char UnityStrDet[]                    = "Determinate";
static const char UnityStrInvalidFloatTrait[]      = "Invalid Float Trait";
46
#endif
47 48 49 50 51 52 53 54 55
const char UnityStrErrFloat[]                      = "Unity Floating Point Disabled";
const char UnityStrErrDouble[]                     = "Unity Double Precision Disabled";
const char UnityStrErr64[]                         = "Unity 64-bit Support Disabled";
static const char UnityStrBreaker[]                = "-----------------------";
static const char UnityStrResultsTests[]           = " Tests ";
static const char UnityStrResultsFailures[]        = " Failures ";
static const char UnityStrResultsIgnored[]         = " Ignored ";
static const char UnityStrDetail1Name[]            = UNITY_DETAIL1_NAME " ";
static const char UnityStrDetail2Name[]            = " " UNITY_DETAIL2_NAME " ";
M
Mark VanderVoord 已提交
56

57
/* compiler-generic print formatting masks */
58
static const UNITY_UINT UnitySizeMask[] =
M
Mark VanderVoord 已提交
59
{
60 61
    255u,         /* 0xFF */
    65535u,       /* 0xFFFF */
M
Mark VanderVoord 已提交
62
    65535u,
63
    4294967295u,  /* 0xFFFFFFFF */
M
Mark VanderVoord 已提交
64 65 66 67 68 69 70 71
    4294967295u,
    4294967295u,
    4294967295u
#ifdef UNITY_SUPPORT_64
    ,0xFFFFFFFFFFFFFFFF
#endif
};

72 73 74
/*-----------------------------------------------
 * Pretty Printers & Test Result Output Handlers
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
75 76 77 78 79 80 81 82 83

void UnityPrint(const char* string)
{
    const char* pch = string;

    if (pch != NULL)
    {
        while (*pch)
        {
84
            /* printable characters plus CR & LF are printed */
M
Mark VanderVoord 已提交
85 86 87 88
            if ((*pch <= 126) && (*pch >= 32))
            {
                UNITY_OUTPUT_CHAR(*pch);
            }
89
            /* write escaped carriage returns */
M
Mark VanderVoord 已提交
90 91 92 93 94
            else if (*pch == 13)
            {
                UNITY_OUTPUT_CHAR('\\');
                UNITY_OUTPUT_CHAR('r');
            }
95
            /* write escaped line feeds */
M
Mark VanderVoord 已提交
96 97 98 99 100
            else if (*pch == 10)
            {
                UNITY_OUTPUT_CHAR('\\');
                UNITY_OUTPUT_CHAR('n');
            }
101
            /* unprintable characters are shown as codes */
M
Mark VanderVoord 已提交
102 103 104
            else
            {
                UNITY_OUTPUT_CHAR('\\');
105
                UNITY_OUTPUT_CHAR('x');
106
                UnityPrintNumberHex((UNITY_UINT)*pch, 2);
M
Mark VanderVoord 已提交
107 108 109 110 111 112
            }
            pch++;
        }
    }
}

113 114
void UnityPrintLen(const char* string, const UNITY_UINT32 length);
void UnityPrintLen(const char* string, const UNITY_UINT32 length)
M
Mark VanderVoord 已提交
115 116 117 118 119
{
    const char* pch = string;

    if (pch != NULL)
    {
120
        while (*pch && (UNITY_UINT32)(pch - string) < length)
M
Mark VanderVoord 已提交
121
        {
122
            /* printable characters plus CR & LF are printed */
M
Mark VanderVoord 已提交
123 124 125 126
            if ((*pch <= 126) && (*pch >= 32))
            {
                UNITY_OUTPUT_CHAR(*pch);
            }
127
            /* write escaped carriage returns */
M
Mark VanderVoord 已提交
128 129 130 131 132
            else if (*pch == 13)
            {
                UNITY_OUTPUT_CHAR('\\');
                UNITY_OUTPUT_CHAR('r');
            }
133
            /* write escaped line feeds */
M
Mark VanderVoord 已提交
134 135 136 137 138
            else if (*pch == 10)
            {
                UNITY_OUTPUT_CHAR('\\');
                UNITY_OUTPUT_CHAR('n');
            }
139
            /* unprintable characters are shown as codes */
M
Mark VanderVoord 已提交
140 141 142
            else
            {
                UNITY_OUTPUT_CHAR('\\');
143
                UNITY_OUTPUT_CHAR('x');
144
                UnityPrintNumberHex((UNITY_UINT)*pch, 2);
M
Mark VanderVoord 已提交
145 146 147 148 149 150
            }
            pch++;
        }
    }
}

151
/*-----------------------------------------------*/
152
void UnityPrintNumberByStyle(const UNITY_INT number, const UNITY_DISPLAY_STYLE_T style)
M
Mark VanderVoord 已提交
153 154 155 156 157 158 159
{
    if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT)
    {
        UnityPrintNumber(number);
    }
    else if ((style & UNITY_DISPLAY_RANGE_UINT) == UNITY_DISPLAY_RANGE_UINT)
    {
160
        UnityPrintNumberUnsigned(  (UNITY_UINT)number  &  UnitySizeMask[((UNITY_UINT)style & (UNITY_UINT)0x0F) - 1]  );
M
Mark VanderVoord 已提交
161 162 163
    }
    else
    {
164 165
        UNITY_OUTPUT_CHAR('0');
        UNITY_OUTPUT_CHAR('x');
166
        UnityPrintNumberHex((UNITY_UINT)number, (char)((style & 0x000F) << 1));
M
Mark VanderVoord 已提交
167 168 169
    }
}

170
/*-----------------------------------------------*/
171
void UnityPrintNumber(const UNITY_INT number_to_print)
M
Mark VanderVoord 已提交
172
{
173
    UNITY_UINT number = (UNITY_UINT)number_to_print;
M
Mark VanderVoord 已提交
174 175 176

    if (number_to_print < 0)
    {
177
        /* A negative number, including MIN negative */
M
Mark VanderVoord 已提交
178
        UNITY_OUTPUT_CHAR('-');
179
        number = (UNITY_UINT)(-number_to_print);
M
Mark VanderVoord 已提交
180
    }
181
    UnityPrintNumberUnsigned(number);
M
Mark VanderVoord 已提交
182 183
}

184 185
/*-----------------------------------------------
 * basically do an itoa using as little ram as possible */
186
void UnityPrintNumberUnsigned(const UNITY_UINT number)
M
Mark VanderVoord 已提交
187
{
188
    UNITY_UINT divisor = 1;
M
Mark VanderVoord 已提交
189

190
    /* figure out initial divisor */
M
Mark VanderVoord 已提交
191 192
    while (number / divisor > 9)
    {
193
        divisor *= 10;
M
Mark VanderVoord 已提交
194 195
    }

196
    /* now mod and print, then divide divisor */
M
Mark VanderVoord 已提交
197 198 199 200 201 202 203 204
    do
    {
        UNITY_OUTPUT_CHAR((char)('0' + (number / divisor % 10)));
        divisor /= 10;
    }
    while (divisor > 0);
}

205
/*-----------------------------------------------*/
206
void UnityPrintNumberHex(const UNITY_UINT number, const char nibbles_to_print)
M
Mark VanderVoord 已提交
207
{
208
    UNITY_UINT nibble;
M
Mark VanderVoord 已提交
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
    char nibbles = nibbles_to_print;

    while (nibbles > 0)
    {
        nibble = (number >> (--nibbles << 2)) & 0x0000000F;
        if (nibble <= 9)
        {
            UNITY_OUTPUT_CHAR((char)('0' + nibble));
        }
        else
        {
            UNITY_OUTPUT_CHAR((char)('A' - 10 + nibble));
        }
    }
}

225
/*-----------------------------------------------*/
226
void UnityPrintMask(const UNITY_UINT mask, const UNITY_UINT number)
M
Mark VanderVoord 已提交
227
{
228 229
    UNITY_UINT current_bit = (UNITY_UINT)1 << (UNITY_INT_WIDTH - 1);
    UNITY_INT32 i;
M
Mark VanderVoord 已提交
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251

    for (i = 0; i < UNITY_INT_WIDTH; i++)
    {
        if (current_bit & mask)
        {
            if (current_bit & number)
            {
                UNITY_OUTPUT_CHAR('1');
            }
            else
            {
                UNITY_OUTPUT_CHAR('0');
            }
        }
        else
        {
            UNITY_OUTPUT_CHAR('X');
        }
        current_bit = current_bit >> 1;
    }
}

252
/*-----------------------------------------------*/
J
jsalling 已提交
253
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
J
jsalling 已提交
254
static void UnityPrintDecimalAndNumberWithLeadingZeros(UNITY_INT32 fraction_part, UNITY_INT32 divisor)
255 256 257 258 259 260 261 262 263 264
{
    UNITY_OUTPUT_CHAR('.');
    while (divisor > 0)
    {
        UNITY_OUTPUT_CHAR('0' + fraction_part / divisor);
        fraction_part %= divisor;
        divisor /= 10;
        if (fraction_part == 0) break; /* Truncate trailing 0's */
    }
}
J
jsalling 已提交
265
#ifndef UNITY_ROUND_TIES_AWAY_FROM_ZERO
J
jsalling 已提交
266 267 268 269
/* If rounds up && remainder 0.5 && result odd && below cutoff for double precision issues */
  #define ROUND_TIES_TO_EVEN(orig, num_int, num)                                          \
  if (num_int > (num) && (num) - (num_int-1) <= 0.5 && (num_int & 1) == 1 && orig < 1e22) \
    num_int -= 1 /* => a tie to round down to even */
J
jsalling 已提交
270
#else
J
jsalling 已提交
271
  #define ROUND_TIES_TO_EVEN(orig, num_int, num) /* Remove macro */
272 273
#endif

J
jsalling 已提交
274 275 276 277 278 279
/* Printing floating point numbers is hard. Some goals of this implementation: works for embedded
 * systems, floats or doubles, and has a reasonable format. The key paper in this area,
 * 'How to Print Floating-Point Numbers Accurately' by Steele & White, shows an approximation by
 * scaling called Dragon 2. This code uses a similar idea. The other core algorithm uses casts and
 * floating subtraction to give exact remainders after the decimal, to be scaled into an integer.
 * Extra trailing 0's are excluded. The output defaults to rounding to nearest, ties to even. You
J
jsalling 已提交
280
 * can enable rounding ties away from zero. Note: UNITY_DOUBLE param can typedef to float or double
J
jsalling 已提交
281 282 283 284 285 286

 * The old version required compiling in snprintf. For reference, with a similar format as now:
 *  char buf[19];
 *  if (number > 4294967296.0 || -number > 4294967296.0) snprintf(buf, sizeof buf, "%.8e", number);
 *  else                                                 snprintf(buf, sizeof buf, "%.6f", number);
 *  UnityPrint(buf);
287
 */
288
void UnityPrintFloat(UNITY_DOUBLE number)
M
Mark VanderVoord 已提交
289
{
J
jsalling 已提交
290 291 292 293 294
    if (number < 0)
    {
        UNITY_OUTPUT_CHAR('-');
        number = -number;
    }
295 296 297

    if (isnan(number)) UnityPrint(UnityStrNaN);
    else if (isinf(number)) UnityPrintLen(UnityStrInf, 3);
298 299
    else if (number <= 0.0000005 && number > 0) UnityPrint("0.000000..."); /* Small number */
    else if (number < 4294967295.9999995) /* Rounded result fits in 32 bits, "%.6f" format */
J
jsalling 已提交
300
    {
J
jsalling 已提交
301 302 303
        const UNITY_INT32 divisor = 1000000/10;
        UNITY_UINT32 integer_part = (UNITY_UINT32)number;
        UNITY_INT32 fraction_part = (UNITY_INT32)((number - (UNITY_DOUBLE)integer_part)*1000000.0 + 0.5);
304
        /* Double precision calculation gives best performance for six rounded decimal places */
J
jsalling 已提交
305
        ROUND_TIES_TO_EVEN(number, fraction_part, (number - (UNITY_DOUBLE)integer_part)*1000000.0);
306

307
        if (fraction_part == 1000000) /* Carry across the decimal point */
308
        {
309
            fraction_part = 0;
310 311 312 313
            integer_part += 1;
        }

        UnityPrintNumberUnsigned(integer_part);
314
        UnityPrintDecimalAndNumberWithLeadingZeros(fraction_part, divisor);
315
    }
316
    else /* Number is larger, use exponential format of 9 digits, "%.8e" */
317
    {
J
jsalling 已提交
318 319 320
        const UNITY_INT32 divisor = 1000000000/10;
        UNITY_INT32 integer_part;
        UNITY_DOUBLE_TYPE divide = 10.0;
321
        int exponent = 9;
322

323
        while (number / divide >= 1000000000.0 - 0.5)
324
        {
325 326
            divide *= 10;
            exponent++;
327
        }
J
jsalling 已提交
328
        integer_part = (UNITY_INT32)(number / divide + 0.5);
329
        /* Double precision calculation required for float, to produce 9 rounded digits */
J
jsalling 已提交
330
        ROUND_TIES_TO_EVEN(number, integer_part, number / divide);
331

332
        UNITY_OUTPUT_CHAR('0' + integer_part / divisor);
333
        UnityPrintDecimalAndNumberWithLeadingZeros(integer_part % divisor, divisor / 10);
334 335
        UNITY_OUTPUT_CHAR('e');
        UNITY_OUTPUT_CHAR('+');
336
        if (exponent < 10) UNITY_OUTPUT_CHAR('0');
337
        UnityPrintNumber(exponent);
J
jsalling 已提交
338
    }
M
Mark VanderVoord 已提交
339
}
J
jsalling 已提交
340
#endif /* ! UNITY_EXCLUDE_FLOAT_PRINT */
M
Mark VanderVoord 已提交
341

342
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
343 344 345 346 347 348 349 350 351 352 353 354 355

void UnityPrintFail(void);
void UnityPrintFail(void)
{
    UnityPrint(UnityStrFail);
}

void UnityPrintOk(void);
void UnityPrintOk(void)
{
    UnityPrint(UnityStrOk);
}

356
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
357 358 359 360 361 362
static void UnityTestResultsBegin(const char* file, const UNITY_LINE_TYPE line);
static void UnityTestResultsBegin(const char* file, const UNITY_LINE_TYPE line)
{
#ifndef UNITY_FIXTURES
    UnityPrint(file);
    UNITY_OUTPUT_CHAR(':');
363
    UnityPrintNumber((UNITY_INT)line);
M
Mark VanderVoord 已提交
364 365 366 367 368 369 370 371 372
    UNITY_OUTPUT_CHAR(':');
    UnityPrint(Unity.CurrentTestName);
    UNITY_OUTPUT_CHAR(':');
#else
    UNITY_UNUSED(file);
    UNITY_UNUSED(line);
#endif
}

373
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
374 375 376 377 378 379 380 381 382 383 384 385
static void UnityTestResultsFailBegin(const UNITY_LINE_TYPE line);
static void UnityTestResultsFailBegin(const UNITY_LINE_TYPE line)
{
#ifndef UNITY_FIXTURES
    UnityTestResultsBegin(Unity.TestFile, line);
#else
    UNITY_UNUSED(line);
#endif
    UnityPrint(UnityStrFail);
    UNITY_OUTPUT_CHAR(':');
}

386
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
void UnityConcludeTest(void)
{
    if (Unity.CurrentTestIgnored)
    {
        Unity.TestIgnores++;
    }
    else if (!Unity.CurrentTestFailed)
    {
        UnityTestResultsBegin(Unity.TestFile, Unity.CurrentTestLineNumber);
        UnityPrint(UnityStrPass);
    }
    else
    {
        Unity.TestFailures++;
    }

    Unity.CurrentTestFailed = 0;
    Unity.CurrentTestIgnored = 0;
    UNITY_PRINT_EOL();
406
    UNITY_FLUSH_CALL();
M
Mark VanderVoord 已提交
407 408
}

409
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
static void UnityAddMsgIfSpecified(const char* msg);
static void UnityAddMsgIfSpecified(const char* msg)
{
    if (msg)
    {
        UnityPrint(UnityStrSpacer);
#ifndef UNITY_EXCLUDE_DETAILS
        if (Unity.CurrentDetail1)
        {
            UnityPrint(UnityStrDetail1Name);
            UnityPrint(Unity.CurrentDetail1);
            if (Unity.CurrentDetail2)
            {
                UnityPrint(UnityStrDetail2Name);
                UnityPrint(Unity.CurrentDetail2);
            }
            UnityPrint(UnityStrSpacer);
        }
#endif
        UnityPrint(msg);
    }
}

433
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
static void UnityPrintExpectedAndActualStrings(const char* expected, const char* actual);
static void UnityPrintExpectedAndActualStrings(const char* expected, const char* actual)
{
    UnityPrint(UnityStrExpected);
    if (expected != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrint(expected);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
      UnityPrint(UnityStrNull);
    }
    UnityPrint(UnityStrWas);
    if (actual != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrint(actual);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
      UnityPrint(UnityStrNull);
    }
}

461
/*-----------------------------------------------*/
462
static void UnityPrintExpectedAndActualStringsLen(const char* expected, const char* actual, const UNITY_UINT32 length)
M
Mark VanderVoord 已提交
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
{
    UnityPrint(UnityStrExpected);
    if (expected != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrintLen(expected, length);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
      UnityPrint(UnityStrNull);
    }
    UnityPrint(UnityStrWas);
    if (actual != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrintLen(actual, length);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
      UnityPrint(UnityStrNull);
    }
}



490 491 492
/*-----------------------------------------------
 * Assertion & Control Helpers
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
493 494 495

static int UnityCheckArraysForNull(UNITY_INTERNAL_PTR expected, UNITY_INTERNAL_PTR actual, const UNITY_LINE_TYPE lineNumber, const char* msg)
{
496
    /* return true if they are both NULL */
M
Mark VanderVoord 已提交
497 498 499
    if ((expected == NULL) && (actual == NULL))
        return 1;

500
    /* throw error if just expected is NULL */
M
Mark VanderVoord 已提交
501 502 503 504 505 506 507 508
    if (expected == NULL)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrNullPointerForExpected);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }

509
    /* throw error if just actual is NULL */
M
Mark VanderVoord 已提交
510 511 512 513 514 515 516 517
    if (actual == NULL)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrNullPointerForActual);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }

518
    /* return false if neither is NULL */
M
Mark VanderVoord 已提交
519 520 521
    return 0;
}

522 523 524
/*-----------------------------------------------
 * Assertion Functions
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
525

526 527 528
void UnityAssertBits(const UNITY_INT mask,
                     const UNITY_INT expected,
                     const UNITY_INT actual,
M
Mark VanderVoord 已提交
529 530 531 532 533 534 535 536 537
                     const char* msg,
                     const UNITY_LINE_TYPE lineNumber)
{
    UNITY_SKIP_EXECUTION;

    if ((mask & expected) != (mask & actual))
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrExpected);
538
        UnityPrintMask((UNITY_UINT)mask, (UNITY_UINT)expected);
M
Mark VanderVoord 已提交
539
        UnityPrint(UnityStrWas);
540
        UnityPrintMask((UNITY_UINT)mask, (UNITY_UINT)actual);
M
Mark VanderVoord 已提交
541 542 543 544 545
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

546
/*-----------------------------------------------*/
547 548
void UnityAssertEqualNumber(const UNITY_INT expected,
                            const UNITY_INT actual,
M
Mark VanderVoord 已提交
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
                            const char* msg,
                            const UNITY_LINE_TYPE lineNumber,
                            const UNITY_DISPLAY_STYLE_T style)
{
    UNITY_SKIP_EXECUTION;

    if (expected != actual)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrExpected);
        UnityPrintNumberByStyle(expected, style);
        UnityPrint(UnityStrWas);
        UnityPrintNumberByStyle(actual, style);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

567 568 569 570 571 572 573
#define UnityPrintPointlessAndBail()       \
{                                          \
    UnityTestResultsFailBegin(lineNumber); \
    UnityPrint(UnityStrPointless);         \
    UnityAddMsgIfSpecified(msg);           \
    UNITY_FAIL_AND_BAIL; }

574
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
575 576
void UnityAssertEqualIntArray(UNITY_INTERNAL_PTR expected,
                              UNITY_INTERNAL_PTR actual,
577
                              const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
578 579 580 581
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
                              const UNITY_DISPLAY_STYLE_T style)
{
582
    UNITY_UINT32 elements = num_elements;
583 584 585
    const unsigned int length = style & 0xF;
    UNITY_INT expect_val = 0;
    UNITY_INT actual_val = 0;
M
Mark VanderVoord 已提交
586 587 588

    UNITY_SKIP_EXECUTION;

589
    if (num_elements == 0)
M
Mark VanderVoord 已提交
590
    {
591
        UnityPrintPointlessAndBail();
M
Mark VanderVoord 已提交
592 593 594 595 596
    }

    if (UnityCheckArraysForNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg) == 1)
        return;

597
    while (elements--)
M
Mark VanderVoord 已提交
598
    {
599 600 601 602 603 604 605 606 607 608 609 610 611 612
        switch (length)
        {
            case 1:
                expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT8*)expected;
                actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT8*)actual;
                break;
            case 2:
                expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT16*)expected;
                actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT16*)actual;
                break;
            default: /* length 4 bytes */
                expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT32*)expected;
                actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT32*)actual;
                break;
M
Mark VanderVoord 已提交
613
#ifdef UNITY_SUPPORT_64
614 615 616 617
            case 8:
                expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)expected;
                actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)actual;
                break;
M
Mark VanderVoord 已提交
618
#endif
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
        }

        if (expect_val != actual_val)
        {
            UnityTestResultsFailBegin(lineNumber);
            UnityPrint(UnityStrElement);
            UnityPrintNumberUnsigned(num_elements - elements - 1);
            UnityPrint(UnityStrExpected);
            UnityPrintNumberByStyle(expect_val, style);
            UnityPrint(UnityStrWas);
            UnityPrintNumberByStyle(actual_val, style);
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
        expected = length + (const char*)expected;
        actual   = length + (const char*)actual;
M
Mark VanderVoord 已提交
635 636 637
    }
}

638
/*-----------------------------------------------*/
639
/* Wrap this define in a function with variable types as float or double */
640 641
#define UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff)                       \
    if (isinf(expected) && isinf(actual) && (isneg(expected) == isneg(actual))) return 1; \
642
    if (UNITY_NAN_CHECK) return 1;                                                        \
643 644 645
    diff = actual - expected;                                                             \
    if (diff < 0.0f) diff = 0.0f - diff;                                                  \
    if (delta < 0.0f) delta = 0.0f - delta;                                               \
646
    return !(isnan(diff) || isinf(diff) || (diff > delta))
647
    /* This first part of this condition will catch any NaN or Infinite values */
648 649 650 651 652
#ifndef UNITY_NAN_NOT_EQUAL_NAN
  #define UNITY_NAN_CHECK isnan(expected) && isnan(actual)
#else
  #define UNITY_NAN_CHECK 0
#endif
653

654 655 656 657 658 659 660 661 662 663 664 665 666
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
  #define UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual) \
    do {                                                          \
    UnityPrint(UnityStrExpected);                                 \
    UnityPrintFloat(expected);                                    \
    UnityPrint(UnityStrWas);                                      \
    UnityPrintFloat(actual);                                      \
    } while(0)
#else
  #define UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual) \
    UnityPrint(UnityStrDelta)
#endif /* UNITY_EXCLUDE_FLOAT_PRINT */

M
Mark VanderVoord 已提交
667
#ifndef UNITY_EXCLUDE_FLOAT
668
static int UnityFloatsWithin(UNITY_FLOAT delta, UNITY_FLOAT expected, UNITY_FLOAT actual)
669
{
670
    UNITY_FLOAT diff;
671 672 673
    UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff);
}

674 675 676
void UnityAssertEqualFloatArray(UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* expected,
                                UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* actual,
                                const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
677 678 679
                                const char* msg,
                                const UNITY_LINE_TYPE lineNumber)
{
680 681 682
    UNITY_UINT32 elements = num_elements;
    UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* ptr_expected = expected;
    UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* ptr_actual = actual;
M
Mark VanderVoord 已提交
683 684 685 686 687

    UNITY_SKIP_EXECUTION;

    if (elements == 0)
    {
688
        UnityPrintPointlessAndBail();
M
Mark VanderVoord 已提交
689 690 691 692 693 694 695
    }

    if (UnityCheckArraysForNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg) == 1)
        return;

    while (elements--)
    {
696
        if (!UnityFloatsWithin(*ptr_expected * UNITY_FLOAT_PRECISION, *ptr_expected, *ptr_actual))
M
Mark VanderVoord 已提交
697 698 699
        {
            UnityTestResultsFailBegin(lineNumber);
            UnityPrint(UnityStrElement);
700
            UnityPrintNumberUnsigned(num_elements - elements - 1);
701
            UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(*ptr_expected, *ptr_actual);
M
Mark VanderVoord 已提交
702 703 704 705 706 707 708 709
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
        ptr_expected++;
        ptr_actual++;
    }
}

710
/*-----------------------------------------------*/
711 712 713
void UnityAssertFloatsWithin(const UNITY_FLOAT delta,
                             const UNITY_FLOAT expected,
                             const UNITY_FLOAT actual,
M
Mark VanderVoord 已提交
714 715 716 717 718 719
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber)
{
    UNITY_SKIP_EXECUTION;


720
    if (!UnityFloatsWithin(delta, expected, actual))
M
Mark VanderVoord 已提交
721 722
    {
        UnityTestResultsFailBegin(lineNumber);
723
        UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual);
M
Mark VanderVoord 已提交
724 725 726 727 728
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

729
/*-----------------------------------------------*/
730
void UnityAssertFloatSpecial(const UNITY_FLOAT actual,
M
Mark VanderVoord 已提交
731 732 733 734 735
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber,
                             const UNITY_FLOAT_TRAIT_T style)
{
    const char* trait_names[] = { UnityStrInf, UnityStrNegInf, UnityStrNaN, UnityStrDet };
736 737 738
    UNITY_INT should_be_trait   = ((UNITY_INT)style & 1);
    UNITY_INT is_trait          = !should_be_trait;
    UNITY_INT trait_index       = (UNITY_INT)(style >> 1);
M
Mark VanderVoord 已提交
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754

    UNITY_SKIP_EXECUTION;

    switch(style)
    {
        case UNITY_FLOAT_IS_INF:
        case UNITY_FLOAT_IS_NOT_INF:
            is_trait = isinf(actual) & ispos(actual);
            break;
        case UNITY_FLOAT_IS_NEG_INF:
        case UNITY_FLOAT_IS_NOT_NEG_INF:
            is_trait = isinf(actual) & isneg(actual);
            break;

        case UNITY_FLOAT_IS_NAN:
        case UNITY_FLOAT_IS_NOT_NAN:
755
            is_trait = isnan(actual) ? 1 : 0;
M
Mark VanderVoord 已提交
756 757
            break;

758
        /* A determinate number is non infinite and not NaN. (therefore the opposite of the two above) */
M
Mark VanderVoord 已提交
759 760
        case UNITY_FLOAT_IS_DET:
        case UNITY_FLOAT_IS_NOT_DET:
761
            if (isinf(actual) || isnan(actual))
M
Mark VanderVoord 已提交
762 763 764 765 766 767
                is_trait = 0;
            else
                is_trait = 1;
            break;

        default:
768 769 770
            trait_index = 0;
            trait_names[0] = UnityStrInvalidFloatTrait;
            break;
M
Mark VanderVoord 已提交
771 772 773 774 775 776 777 778 779 780
    }

    if (is_trait != should_be_trait)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrExpected);
        if (!should_be_trait)
            UnityPrint(UnityStrNot);
        UnityPrint(trait_names[trait_index]);
        UnityPrint(UnityStrWas);
J
jsalling 已提交
781
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
M
Mark VanderVoord 已提交
782 783 784 785 786 787 788 789 790 791 792
        UnityPrintFloat(actual);
#else
        if (should_be_trait)
            UnityPrint(UnityStrNot);
        UnityPrint(trait_names[trait_index]);
#endif
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

793
#endif /* not UNITY_EXCLUDE_FLOAT */
M
Mark VanderVoord 已提交
794

795
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
796
#ifndef UNITY_EXCLUDE_DOUBLE
797
static int UnityDoublesWithin(UNITY_DOUBLE delta, UNITY_DOUBLE expected, UNITY_DOUBLE actual)
798
{
799
    UNITY_DOUBLE diff;
800 801 802
    UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff);
}

803 804 805
void UnityAssertEqualDoubleArray(UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* expected,
                                 UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* actual,
                                 const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
806 807 808
                                 const char* msg,
                                 const UNITY_LINE_TYPE lineNumber)
{
809 810 811
    UNITY_UINT32 elements = num_elements;
    UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* ptr_expected = expected;
    UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* ptr_actual = actual;
M
Mark VanderVoord 已提交
812 813 814 815 816

    UNITY_SKIP_EXECUTION;

    if (elements == 0)
    {
817
        UnityPrintPointlessAndBail();
M
Mark VanderVoord 已提交
818 819 820 821 822 823 824
    }

    if (UnityCheckArraysForNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg) == 1)
        return;

    while (elements--)
    {
825
        if (!UnityDoublesWithin(*ptr_expected * UNITY_DOUBLE_PRECISION, *ptr_expected, *ptr_actual))
M
Mark VanderVoord 已提交
826 827 828
        {
            UnityTestResultsFailBegin(lineNumber);
            UnityPrint(UnityStrElement);
829
            UnityPrintNumberUnsigned(num_elements - elements - 1);
830
            UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(*ptr_expected, *ptr_actual);
M
Mark VanderVoord 已提交
831 832 833 834 835 836 837 838
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
        ptr_expected++;
        ptr_actual++;
    }
}

839
/*-----------------------------------------------*/
840 841 842
void UnityAssertDoublesWithin(const UNITY_DOUBLE delta,
                              const UNITY_DOUBLE expected,
                              const UNITY_DOUBLE actual,
M
Mark VanderVoord 已提交
843 844 845 846 847
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber)
{
    UNITY_SKIP_EXECUTION;

848
    if (!UnityDoublesWithin(delta, expected, actual))
M
Mark VanderVoord 已提交
849 850
    {
        UnityTestResultsFailBegin(lineNumber);
851
        UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual);
M
Mark VanderVoord 已提交
852 853 854 855 856
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

857
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
858

859
void UnityAssertDoubleSpecial(const UNITY_DOUBLE actual,
M
Mark VanderVoord 已提交
860 861 862 863 864
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
                              const UNITY_FLOAT_TRAIT_T style)
{
    const char* trait_names[] = { UnityStrInf, UnityStrNegInf, UnityStrNaN, UnityStrDet };
865 866 867
    UNITY_INT should_be_trait   = ((UNITY_INT)style & 1);
    UNITY_INT is_trait          = !should_be_trait;
    UNITY_INT trait_index       = (UNITY_INT)(style >> 1);
M
Mark VanderVoord 已提交
868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883

    UNITY_SKIP_EXECUTION;

     switch(style)
    {
        case UNITY_FLOAT_IS_INF:
        case UNITY_FLOAT_IS_NOT_INF:
            is_trait = isinf(actual) & ispos(actual);
            break;
        case UNITY_FLOAT_IS_NEG_INF:
        case UNITY_FLOAT_IS_NOT_NEG_INF:
            is_trait = isinf(actual) & isneg(actual);
            break;

        case UNITY_FLOAT_IS_NAN:
        case UNITY_FLOAT_IS_NOT_NAN:
884
            is_trait = isnan(actual) ? 1 : 0;
M
Mark VanderVoord 已提交
885 886
            break;

887
        /* A determinate number is non infinite and not NaN. (therefore the opposite of the two above) */
M
Mark VanderVoord 已提交
888 889
        case UNITY_FLOAT_IS_DET:
        case UNITY_FLOAT_IS_NOT_DET:
890
            if (isinf(actual) || isnan(actual))
M
Mark VanderVoord 已提交
891 892 893 894 895 896
                is_trait = 0;
            else
                is_trait = 1;
            break;

        default:
897 898 899
            trait_index = 0;
            trait_names[0] = UnityStrInvalidFloatTrait;
            break;
M
Mark VanderVoord 已提交
900 901 902 903 904 905 906 907 908 909
    }

    if (is_trait != should_be_trait)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrExpected);
        if (!should_be_trait)
            UnityPrint(UnityStrNot);
        UnityPrint(trait_names[trait_index]);
        UnityPrint(UnityStrWas);
J
jsalling 已提交
910
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
M
Mark VanderVoord 已提交
911 912 913 914 915 916 917 918 919 920 921 922
        UnityPrintFloat(actual);
#else
        if (should_be_trait)
            UnityPrint(UnityStrNot);
        UnityPrint(trait_names[trait_index]);
#endif
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}


923
#endif /* not UNITY_EXCLUDE_DOUBLE */
M
Mark VanderVoord 已提交
924

925
/*-----------------------------------------------*/
926 927 928
void UnityAssertNumbersWithin( const UNITY_UINT delta,
                               const UNITY_INT expected,
                               const UNITY_INT actual,
M
Mark VanderVoord 已提交
929 930 931 932 933 934 935 936 937
                               const char* msg,
                               const UNITY_LINE_TYPE lineNumber,
                               const UNITY_DISPLAY_STYLE_T style)
{
    UNITY_SKIP_EXECUTION;

    if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT)
    {
        if (actual > expected)
938
            Unity.CurrentTestFailed = ((UNITY_UINT)(actual - expected) > delta);
M
Mark VanderVoord 已提交
939
        else
940
            Unity.CurrentTestFailed = ((UNITY_UINT)(expected - actual) > delta);
M
Mark VanderVoord 已提交
941 942 943
    }
    else
    {
944 945
        if ((UNITY_UINT)actual > (UNITY_UINT)expected)
            Unity.CurrentTestFailed = ((UNITY_UINT)(actual - expected) > delta);
M
Mark VanderVoord 已提交
946
        else
947
            Unity.CurrentTestFailed = ((UNITY_UINT)(expected - actual) > delta);
M
Mark VanderVoord 已提交
948 949 950 951 952 953
    }

    if (Unity.CurrentTestFailed)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrDelta);
954
        UnityPrintNumberByStyle((UNITY_INT)delta, style);
M
Mark VanderVoord 已提交
955 956 957 958 959 960 961 962 963
        UnityPrint(UnityStrExpected);
        UnityPrintNumberByStyle(expected, style);
        UnityPrint(UnityStrWas);
        UnityPrintNumberByStyle(actual, style);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

964
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
965 966 967 968 969
void UnityAssertEqualString(const char* expected,
                            const char* actual,
                            const char* msg,
                            const UNITY_LINE_TYPE lineNumber)
{
970
    UNITY_UINT32 i;
M
Mark VanderVoord 已提交
971 972 973

    UNITY_SKIP_EXECUTION;

974
    /* if both pointers not null compare the strings */
M
Mark VanderVoord 已提交
975 976 977 978 979 980 981 982 983 984 985 986
    if (expected && actual)
    {
        for (i = 0; expected[i] || actual[i]; i++)
        {
            if (expected[i] != actual[i])
            {
                Unity.CurrentTestFailed = 1;
                break;
            }
        }
    }
    else
987
    { /* handle case of one pointers being null (if both null, test should pass) */
M
Mark VanderVoord 已提交
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
        if (expected != actual)
        {
            Unity.CurrentTestFailed = 1;
        }
    }

    if (Unity.CurrentTestFailed)
    {
      UnityTestResultsFailBegin(lineNumber);
      UnityPrintExpectedAndActualStrings(expected, actual);
      UnityAddMsgIfSpecified(msg);
      UNITY_FAIL_AND_BAIL;
    }
}

1003
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1004 1005
void UnityAssertEqualStringLen(const char* expected,
                            const char* actual,
1006
                            const UNITY_UINT32 length,
M
Mark VanderVoord 已提交
1007 1008 1009
                            const char* msg,
                            const UNITY_LINE_TYPE lineNumber)
{
1010
    UNITY_UINT32 i;
M
Mark VanderVoord 已提交
1011 1012 1013

    UNITY_SKIP_EXECUTION;

1014
    /* if both pointers not null compare the strings */
M
Mark VanderVoord 已提交
1015 1016
    if (expected && actual)
    {
1017
        for (i = 0; (i < length) && (expected[i] || actual[i]); i++)
M
Mark VanderVoord 已提交
1018 1019 1020 1021 1022 1023 1024 1025 1026
        {
            if (expected[i] != actual[i])
            {
                Unity.CurrentTestFailed = 1;
                break;
            }
        }
    }
    else
1027
    { /* handle case of one pointers being null (if both null, test should pass) */
M
Mark VanderVoord 已提交
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
        if (expected != actual)
        {
            Unity.CurrentTestFailed = 1;
        }
    }

    if (Unity.CurrentTestFailed)
    {
      UnityTestResultsFailBegin(lineNumber);
      UnityPrintExpectedAndActualStringsLen(expected, actual, length);
      UnityAddMsgIfSpecified(msg);
      UNITY_FAIL_AND_BAIL;
    }
}


1044
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1045 1046
void UnityAssertEqualStringArray( const char** expected,
                                  const char** actual,
1047
                                  const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
1048 1049 1050
                                  const char* msg,
                                  const UNITY_LINE_TYPE lineNumber)
{
1051
    UNITY_UINT32 i, j = 0;
M
Mark VanderVoord 已提交
1052 1053 1054

    UNITY_SKIP_EXECUTION;

1055
    /* if no elements, it's an error */
M
Mark VanderVoord 已提交
1056 1057
    if (num_elements == 0)
    {
1058
        UnityPrintPointlessAndBail();
M
Mark VanderVoord 已提交
1059 1060 1061 1062 1063 1064 1065
    }

    if (UnityCheckArraysForNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg) == 1)
        return;

    do
    {
1066
        /* if both pointers not null compare the strings */
M
Mark VanderVoord 已提交
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
        if (expected[j] && actual[j])
        {
            for (i = 0; expected[j][i] || actual[j][i]; i++)
            {
                if (expected[j][i] != actual[j][i])
                {
                    Unity.CurrentTestFailed = 1;
                    break;
                }
            }
        }
        else
1079
        { /* handle case of one pointers being null (if both null, test should pass) */
M
Mark VanderVoord 已提交
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
            if (expected[j] != actual[j])
            {
                Unity.CurrentTestFailed = 1;
            }
        }

        if (Unity.CurrentTestFailed)
        {
            UnityTestResultsFailBegin(lineNumber);
            if (num_elements > 1)
            {
                UnityPrint(UnityStrElement);
1092
                UnityPrintNumberUnsigned(j);
M
Mark VanderVoord 已提交
1093 1094 1095 1096 1097 1098 1099 1100
            }
            UnityPrintExpectedAndActualStrings((const char*)(expected[j]), (const char*)(actual[j]));
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
    } while (++j < num_elements);
}

1101
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1102 1103
void UnityAssertEqualMemory( UNITY_INTERNAL_PTR expected,
                             UNITY_INTERNAL_PTR actual,
1104 1105
                             const UNITY_UINT32 length,
                             const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
1106 1107 1108 1109 1110
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber)
{
    UNITY_PTR_ATTRIBUTE const unsigned char* ptr_exp = (UNITY_PTR_ATTRIBUTE const unsigned char*)expected;
    UNITY_PTR_ATTRIBUTE const unsigned char* ptr_act = (UNITY_PTR_ATTRIBUTE const unsigned char*)actual;
1111 1112
    UNITY_UINT32 elements = num_elements;
    UNITY_UINT32 bytes;
M
Mark VanderVoord 已提交
1113 1114 1115 1116 1117

    UNITY_SKIP_EXECUTION;

    if ((elements == 0) || (length == 0))
    {
1118
        UnityPrintPointlessAndBail();
M
Mark VanderVoord 已提交
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
    }

    if (UnityCheckArraysForNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg) == 1)
        return;

    while (elements--)
    {
        bytes = length;
        while (bytes--)
        {
            if (*ptr_exp != *ptr_act)
            {
                UnityTestResultsFailBegin(lineNumber);
                UnityPrint(UnityStrMemory);
                if (num_elements > 1)
                {
                    UnityPrint(UnityStrElement);
1136
                    UnityPrintNumberUnsigned(num_elements - elements - 1);
M
Mark VanderVoord 已提交
1137 1138
                }
                UnityPrint(UnityStrByte);
1139
                UnityPrintNumberUnsigned(length - bytes - 1);
M
Mark VanderVoord 已提交
1140 1141 1142 1143 1144 1145 1146
                UnityPrint(UnityStrExpected);
                UnityPrintNumberByStyle(*ptr_exp, UNITY_DISPLAY_STYLE_HEX8);
                UnityPrint(UnityStrWas);
                UnityPrintNumberByStyle(*ptr_act, UNITY_DISPLAY_STYLE_HEX8);
                UnityAddMsgIfSpecified(msg);
                UNITY_FAIL_AND_BAIL;
            }
1147 1148
            ptr_exp++;
            ptr_act++;
M
Mark VanderVoord 已提交
1149 1150 1151 1152
        }
    }
}

1153 1154 1155
/*-----------------------------------------------
 * Control Functions
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189

void UnityFail(const char* msg, const UNITY_LINE_TYPE line)
{
    UNITY_SKIP_EXECUTION;

    UnityTestResultsBegin(Unity.TestFile, line);
    UnityPrintFail();
    if (msg != NULL)
    {
        UNITY_OUTPUT_CHAR(':');

#ifndef UNITY_EXCLUDE_DETAILS
        if (Unity.CurrentDetail1)
        {
            UnityPrint(UnityStrDetail1Name);
            UnityPrint(Unity.CurrentDetail1);
            if (Unity.CurrentDetail2)
            {
                UnityPrint(UnityStrDetail2Name);
                UnityPrint(Unity.CurrentDetail2);
            }
            UnityPrint(UnityStrSpacer);
        }
#endif
        if (msg[0] != ' ')
        {
            UNITY_OUTPUT_CHAR(' ');
        }
        UnityPrint(msg);
    }

    UNITY_FAIL_AND_BAIL;
}

1190
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
void UnityIgnore(const char* msg, const UNITY_LINE_TYPE line)
{
    UNITY_SKIP_EXECUTION;

    UnityTestResultsBegin(Unity.TestFile, line);
    UnityPrint(UnityStrIgnore);
    if (msg != NULL)
    {
      UNITY_OUTPUT_CHAR(':');
      UNITY_OUTPUT_CHAR(' ');
      UnityPrint(msg);
    }
    UNITY_IGNORE_AND_BAIL;
}

1206
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1207 1208 1209 1210 1211 1212 1213 1214 1215
#if defined(UNITY_WEAK_ATTRIBUTE)
    UNITY_WEAK_ATTRIBUTE void setUp(void) { }
    UNITY_WEAK_ATTRIBUTE void tearDown(void) { }
#elif defined(UNITY_WEAK_PRAGMA)
#   pragma weak setUp
    void setUp(void) { }
#   pragma weak tearDown
    void tearDown(void) { }
#endif
1216
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
void UnityDefaultTestRun(UnityTestFunction Func, const char* FuncName, const int FuncLineNum)
{
    Unity.CurrentTestName = FuncName;
    Unity.CurrentTestLineNumber = (UNITY_LINE_TYPE)FuncLineNum;
    Unity.NumberOfTests++;
    UNITY_CLR_DETAILS();
    if (TEST_PROTECT())
    {
        setUp();
        Func();
    }
    if (TEST_PROTECT() && !(Unity.CurrentTestIgnored))
    {
        tearDown();
    }
    UnityConcludeTest();
}

1235
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250
void UnityBegin(const char* filename)
{
    Unity.TestFile = filename;
    Unity.CurrentTestName = NULL;
    Unity.CurrentTestLineNumber = 0;
    Unity.NumberOfTests = 0;
    Unity.TestFailures = 0;
    Unity.TestIgnores = 0;
    Unity.CurrentTestFailed = 0;
    Unity.CurrentTestIgnored = 0;

    UNITY_CLR_DETAILS();
    UNITY_OUTPUT_START();
}

1251
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1252 1253 1254 1255 1256
int UnityEnd(void)
{
    UNITY_PRINT_EOL();
    UnityPrint(UnityStrBreaker);
    UNITY_PRINT_EOL();
1257
    UnityPrintNumber((UNITY_INT)(Unity.NumberOfTests));
M
Mark VanderVoord 已提交
1258
    UnityPrint(UnityStrResultsTests);
1259
    UnityPrintNumber((UNITY_INT)(Unity.TestFailures));
M
Mark VanderVoord 已提交
1260
    UnityPrint(UnityStrResultsFailures);
1261
    UnityPrintNumber((UNITY_INT)(Unity.TestIgnores));
M
Mark VanderVoord 已提交
1262 1263 1264 1265 1266 1267 1268 1269 1270
    UnityPrint(UnityStrResultsIgnored);
    UNITY_PRINT_EOL();
    if (Unity.TestFailures == 0U)
    {
        UnityPrintOk();
    }
    else
    {
        UnityPrintFail();
1271 1272 1273
#ifdef UNITY_DIFFERENTIATE_FINAL_FAIL
        UNITY_OUTPUT_CHAR('E'); UNITY_OUTPUT_CHAR('D');
#endif
M
Mark VanderVoord 已提交
1274 1275
    }
    UNITY_PRINT_EOL();
1276
    UNITY_FLUSH_CALL();
M
Mark VanderVoord 已提交
1277 1278 1279 1280
    UNITY_OUTPUT_COMPLETE();
    return (int)(Unity.TestFailures);
}

1281 1282 1283
/*-----------------------------------------------
 * Command Line Argument Support
 *-----------------------------------------------*/
1284
#ifdef UNITY_USE_COMMAND_LINE_ARGS
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301

char* UnityOptionIncludeNamed = NULL;
char* UnityOptionExcludeNamed = NULL;
int   UnityVerbosity          = 1;

int UnityParseOptions(int argc, char** argv)
{
    UnityOptionIncludeNamed = NULL;
    UnityOptionExcludeNamed = NULL;

    for (int i = 1; i < argc; i++)
    {
        if (argv[i][0] == '-')
        {
            switch(argv[i][1])
            {
                case 'l': /* list tests */
1302
                    return -1;
1303
                case 'n': /* include tests with name including this string */
1304 1305 1306 1307
                case 'f': /* an alias for -n */
                    if (argv[i][2] == '=')
                        UnityOptionIncludeNamed = &argv[i][3];
                    else if (++i < argc)
1308 1309 1310 1311 1312
                        UnityOptionIncludeNamed = argv[i];
                    else
                    {
                        UnityPrint("ERROR: No Test String to Include Matches For");
                        UNITY_PRINT_EOL();
1313
                        return 1;
1314 1315 1316 1317 1318 1319 1320 1321 1322
                    }
                    break;
                case 'q': /* quiet */
                    UnityVerbosity = 0;
                    break;
                case 'v': /* verbose */
                    UnityVerbosity = 2;
                    break;
                case 'x': /* exclude tests with name including this string */
1323 1324 1325
                    if (argv[i][2] == '=')
                        UnityOptionExcludeNamed = &argv[i][3];
                    else if (++i < argc)
1326 1327 1328 1329 1330
                        UnityOptionExcludeNamed = argv[i];
                    else
                    {
                        UnityPrint("ERROR: No Test String to Exclude Matches For");
                        UNITY_PRINT_EOL();
1331
                        return 1;
1332 1333 1334 1335
                    }
                    break;
                default:
                    UnityPrint("ERROR: Unknown Option ");
1336
                    UNITY_OUTPUT_CHAR(argv[i][1]);
1337 1338 1339 1340 1341 1342 1343 1344 1345
                    UNITY_PRINT_EOL();
                    return 1;
            }
        }
    }

    return 0;
}

1346
int IsStringInBiggerString(const char* longstring, const char* shortstring)
1347
{
1348 1349 1350
    char* lptr = (char*)longstring;
    char* sptr = (char*)shortstring;
    char* lnext = lptr;
1351

1352 1353 1354
    if (*sptr == '*')
        return 1;

1355 1356 1357
    while (*lptr)
    {
        lnext = lptr + 1;
1358

1359 1360 1361 1362 1363
        /* If they current bytes match, go on to the next bytes */
        while (*lptr && *sptr && (*lptr == *sptr))
        {
            lptr++;
            sptr++;
1364

1365 1366 1367
            /* We're done if we match the entire string or up to a wildcard */
            if (*sptr == '*')
                return 1;
1368 1369 1370 1371 1372 1373 1374 1375
            if (*sptr == ',')
                return 1;
            if (*sptr == '"')
                return 1;
            if (*sptr == '\'')
                return 1;
            if (*sptr == ':')
                return 2;
1376 1377 1378 1379 1380 1381 1382 1383 1384
            if (*sptr == 0)
                return 1;
        }

        /* Otherwise we start in the long pointer 1 character further and try again */
        lptr = lnext;
        sptr = (char*)shortstring;
    }
    return 0;
1385 1386 1387 1388
}

int UnityStringArgumentMatches(const char* str)
{
1389 1390 1391
    int retval;
    const char* ptr1;
    const char* ptr2;
1392
    const char* ptrf;
1393

1394
    /* Go through the options and get the substrings for matching one at a time */
1395 1396 1397 1398 1399 1400
    ptr1 = str;
    while (ptr1[0] != 0)
    {
        if ((ptr1[0] == '"') || (ptr1[0] == '\''))
            ptr1++;

1401
        /* look for the start of the next partial */
1402
        ptr2 = ptr1;
1403
        ptrf = 0;
1404 1405
        do {
            ptr2++;
1406 1407 1408 1409
            if ((ptr2[0] == ':') && (ptr2[1] != 0) && (ptr2[0] != '\'') && (ptr2[0] != '"') && (ptr2[0] != ','))
                ptrf = &ptr2[1];
        } while ((ptr2[0] != 0) && (ptr2[0] != '\'') && (ptr2[0] != '"') && (ptr2[0] != ','));
        while ((ptr2[0] != 0) && ((ptr2[0] == ':') || (ptr2[0] == '\'') || (ptr2[0] == '"') || (ptr2[0] == ',')))
1410 1411
            ptr2++;

1412
        /* done if complete filename match */
1413 1414 1415 1416
        retval = IsStringInBiggerString(Unity.TestFile, ptr1);
        if (retval == 1)
            return retval;

1417
        /* done if testname match after filename partial match */
1418
        if ((retval == 2) && (ptrf != 0))
1419
        {
1420
            if (IsStringInBiggerString(Unity.CurrentTestName, ptrf))
1421 1422 1423
                return 1;
        }

1424
        /* done if complete testname match */
1425 1426 1427 1428 1429 1430
        if (IsStringInBiggerString(Unity.CurrentTestName, ptr1) == 1)
            return 1;

        ptr1 = ptr2;
    }

1431
    /* we couldn't find a match for any substrings */
1432
    return 0;
1433
}
1434

1435 1436 1437 1438 1439 1440 1441 1442 1443 1444
int UnityTestMatches(void)
{
    /* Check if this test name matches the included test pattern */
    int retval;
    if (UnityOptionIncludeNamed)
    {
        retval = UnityStringArgumentMatches(UnityOptionIncludeNamed);
    }
    else
        retval = 1;
1445

1446 1447 1448 1449 1450
    /* Check if this test name matches the excluded test pattern */
    if (UnityOptionExcludeNamed)
    {
        if (UnityStringArgumentMatches(UnityOptionExcludeNamed))
            retval = 0;
1451
    }
1452
    return retval;
1453 1454
}

1455
#endif /* UNITY_USE_COMMAND_LINE_ARGS */
1456
/*-----------------------------------------------*/