unity.c 45.5 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 in Assert functions */
16 17
#define UNITY_FAIL_AND_BAIL   { Unity.CurrentTestFailed  = 1; TEST_ABORT(); }
#define UNITY_IGNORE_AND_BAIL { Unity.CurrentTestIgnored = 1; TEST_ABORT(); }
18
#define RETURN_IF_FAIL_OR_IGNORE if (Unity.CurrentTestFailed || Unity.CurrentTestIgnored) return
M
Mark VanderVoord 已提交
19

20
struct UNITY_STORAGE_T Unity;
M
Mark VanderVoord 已提交
21

22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
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";
37
#ifndef UNITY_EXCLUDE_FLOAT
38 39 40 41 42 43
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";
44
#endif
45 46 47 48 49 50 51 52 53
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 已提交
54

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

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

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

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

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

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

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

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

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

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

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

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

203
/*-----------------------------------------------*/
204
void UnityPrintNumberHex(const UNITY_UINT number, const char nibbles_to_print)
M
Mark VanderVoord 已提交
205
{
206
    UNITY_UINT nibble;
M
Mark VanderVoord 已提交
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
    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));
        }
    }
}

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

    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;
    }
}

250
/*-----------------------------------------------*/
J
jsalling 已提交
251
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
J
jsalling 已提交
252
static void UnityPrintDecimalAndNumberWithLeadingZeros(UNITY_INT32 fraction_part, UNITY_INT32 divisor)
253 254 255 256 257 258 259 260 261 262
{
    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 已提交
263
#ifndef UNITY_ROUND_TIES_AWAY_FROM_ZERO
J
jsalling 已提交
264 265 266 267
/* 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 已提交
268
#else
J
jsalling 已提交
269
  #define ROUND_TIES_TO_EVEN(orig, num_int, num) /* Remove macro */
270 271
#endif

J
jsalling 已提交
272 273 274 275 276 277
/* 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 已提交
278
 * can enable rounding ties away from zero. Note: UNITY_DOUBLE param can typedef to float or double
J
jsalling 已提交
279 280 281 282 283 284

 * 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);
285
 */
286
void UnityPrintFloat(UNITY_DOUBLE number)
M
Mark VanderVoord 已提交
287
{
J
jsalling 已提交
288 289 290 291 292
    if (number < 0)
    {
        UNITY_OUTPUT_CHAR('-');
        number = -number;
    }
293 294 295

    if (isnan(number)) UnityPrint(UnityStrNaN);
    else if (isinf(number)) UnityPrintLen(UnityStrInf, 3);
296 297
    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 已提交
298
    {
J
jsalling 已提交
299 300 301
        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);
302
        /* Double precision calculation gives best performance for six rounded decimal places */
J
jsalling 已提交
303
        ROUND_TIES_TO_EVEN(number, fraction_part, (number - (UNITY_DOUBLE)integer_part)*1000000.0);
304

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

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

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

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

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

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

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

354
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
355 356 357 358 359
static void UnityTestResultsBegin(const char* file, const UNITY_LINE_TYPE line);
static void UnityTestResultsBegin(const char* file, const UNITY_LINE_TYPE line)
{
    UnityPrint(file);
    UNITY_OUTPUT_CHAR(':');
360
    UnityPrintNumber((UNITY_INT)line);
M
Mark VanderVoord 已提交
361 362 363 364 365
    UNITY_OUTPUT_CHAR(':');
    UnityPrint(Unity.CurrentTestName);
    UNITY_OUTPUT_CHAR(':');
}

366
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
367 368 369 370 371 372 373 374
static void UnityTestResultsFailBegin(const UNITY_LINE_TYPE line);
static void UnityTestResultsFailBegin(const UNITY_LINE_TYPE line)
{
    UnityTestResultsBegin(Unity.TestFile, line);
    UnityPrint(UnityStrFail);
    UNITY_OUTPUT_CHAR(':');
}

375
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
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();
395
    UNITY_FLUSH_CALL();
M
Mark VanderVoord 已提交
396 397
}

398
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
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);
    }
}

422
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
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);
    }
}

450
/*-----------------------------------------------*/
451
static void UnityPrintExpectedAndActualStringsLen(const char* expected, const char* actual, const UNITY_UINT32 length)
M
Mark VanderVoord 已提交
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
{
    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);
    }
}



479 480 481
/*-----------------------------------------------
 * Assertion & Control Helpers
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
482

483 484 485 486
static int UnityIsOneArrayNull(UNITY_INTERNAL_PTR expected,
                               UNITY_INTERNAL_PTR actual,
                               const UNITY_LINE_TYPE lineNumber,
                               const char* msg)
M
Mark VanderVoord 已提交
487
{
488
    if (expected == actual) return 0; /* Both are NULL or same pointer */
M
Mark VanderVoord 已提交
489

490
    /* print and return true if just expected is NULL */
M
Mark VanderVoord 已提交
491 492 493 494 495
    if (expected == NULL)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrNullPointerForExpected);
        UnityAddMsgIfSpecified(msg);
496
        return 1;
M
Mark VanderVoord 已提交
497 498
    }

499
    /* print and return true if just actual is NULL */
M
Mark VanderVoord 已提交
500 501 502 503 504
    if (actual == NULL)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrNullPointerForActual);
        UnityAddMsgIfSpecified(msg);
505
        return 1;
M
Mark VanderVoord 已提交
506 507
    }

508
    return 0; /* return false if neither is NULL */
M
Mark VanderVoord 已提交
509 510
}

511 512 513
/*-----------------------------------------------
 * Assertion Functions
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
514

515 516 517
void UnityAssertBits(const UNITY_INT mask,
                     const UNITY_INT expected,
                     const UNITY_INT actual,
M
Mark VanderVoord 已提交
518 519 520
                     const char* msg,
                     const UNITY_LINE_TYPE lineNumber)
{
521
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
522 523 524 525 526

    if ((mask & expected) != (mask & actual))
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrExpected);
527
        UnityPrintMask((UNITY_UINT)mask, (UNITY_UINT)expected);
M
Mark VanderVoord 已提交
528
        UnityPrint(UnityStrWas);
529
        UnityPrintMask((UNITY_UINT)mask, (UNITY_UINT)actual);
M
Mark VanderVoord 已提交
530 531 532 533 534
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

535
/*-----------------------------------------------*/
536 537
void UnityAssertEqualNumber(const UNITY_INT expected,
                            const UNITY_INT actual,
M
Mark VanderVoord 已提交
538 539 540 541
                            const char* msg,
                            const UNITY_LINE_TYPE lineNumber,
                            const UNITY_DISPLAY_STYLE_T style)
{
542
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
543 544 545 546 547 548 549 550 551 552 553 554 555

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

556 557 558 559 560 561 562
#define UnityPrintPointlessAndBail()       \
{                                          \
    UnityTestResultsFailBegin(lineNumber); \
    UnityPrint(UnityStrPointless);         \
    UnityAddMsgIfSpecified(msg);           \
    UNITY_FAIL_AND_BAIL; }

563
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
564 565
void UnityAssertEqualIntArray(UNITY_INTERNAL_PTR expected,
                              UNITY_INTERNAL_PTR actual,
566
                              const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
567 568 569 570
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
                              const UNITY_DISPLAY_STYLE_T style)
{
571
    UNITY_UINT32 elements = num_elements;
572
    unsigned int length   = style & 0xF;
M
Mark VanderVoord 已提交
573

574
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
575

576
    if (num_elements == 0)
M
Mark VanderVoord 已提交
577
    {
578
        UnityPrintPointlessAndBail();
M
Mark VanderVoord 已提交
579 580
    }

581 582 583
    if (expected == actual) return; /* Both are NULL or same pointer */
    if (UnityIsOneArrayNull(expected, actual, lineNumber, msg))
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
584

585
    while (elements--)
M
Mark VanderVoord 已提交
586
    {
587 588
        UNITY_INT expect_val;
        UNITY_INT actual_val;
589 590 591 592 593 594 595 596 597 598 599 600 601
        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;
602
                length = 4;
603
                break;
M
Mark VanderVoord 已提交
604
#ifdef UNITY_SUPPORT_64
605 606 607 608
            case 8:
                expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)expected;
                actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)actual;
                break;
M
Mark VanderVoord 已提交
609
#endif
610 611 612 613
        }

        if (expect_val != actual_val)
        {
614 615 616 617 618 619 620
            if (style & UNITY_DISPLAY_RANGE_UINT && length < sizeof expect_val)
            {   /* For UINT, remove sign extension (padding 1's) from signed type casts above */
                UNITY_INT mask = 1;
                mask = (mask << 8 * length) - 1;
                expect_val &= mask;
                actual_val &= mask;
            }
621 622 623 624 625 626 627 628 629 630
            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;
        }
631 632
        expected = (UNITY_INTERNAL_PTR)(length + (const char*)expected);
        actual   = (UNITY_INTERNAL_PTR)(length + (const char*)actual);
M
Mark VanderVoord 已提交
633 634 635
    }
}

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

653 654 655 656 657 658 659 660 661 662 663 664 665
#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 */

666
static int UnityFloatsWithin(UNITY_FLOAT delta, UNITY_FLOAT expected, UNITY_FLOAT actual)
667
{
668
    UNITY_FLOAT diff;
669 670 671
    UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff);
}

672 673 674
void UnityAssertEqualFloatArray(UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* expected,
                                UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* actual,
                                const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
675 676 677
                                const char* msg,
                                const UNITY_LINE_TYPE lineNumber)
{
678 679 680
    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 已提交
681

682
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
683 684 685

    if (elements == 0)
    {
686
        UnityPrintPointlessAndBail();
M
Mark VanderVoord 已提交
687 688
    }

689 690 691
    if (expected == actual) return; /* Both are NULL or same pointer */
    if (UnityIsOneArrayNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg))
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
692 693 694

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

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


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

728
/*-----------------------------------------------*/
729
void UnityAssertFloatSpecial(const UNITY_FLOAT actual,
M
Mark VanderVoord 已提交
730 731 732 733 734
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber,
                             const UNITY_FLOAT_TRAIT_T style)
{
    const char* trait_names[] = { UnityStrInf, UnityStrNegInf, UnityStrNaN, UnityStrDet };
735 736 737
    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 已提交
738

739
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
740 741 742 743 744

    switch(style)
    {
        case UNITY_FLOAT_IS_INF:
        case UNITY_FLOAT_IS_NOT_INF:
745
            is_trait = isinf(actual) && (actual > 0);
M
Mark VanderVoord 已提交
746 747 748
            break;
        case UNITY_FLOAT_IS_NEG_INF:
        case UNITY_FLOAT_IS_NOT_NEG_INF:
749
            is_trait = isinf(actual) && (actual < 0);
M
Mark VanderVoord 已提交
750 751 752 753
            break;

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

757
        case UNITY_FLOAT_IS_DET: /* A determinate number is non infinite and not NaN. */
M
Mark VanderVoord 已提交
758
        case UNITY_FLOAT_IS_NOT_DET:
759
            is_trait = !isinf(actual) && !isnan(actual);
M
Mark VanderVoord 已提交
760 761 762
            break;

        default:
763 764 765
            trait_index = 0;
            trait_names[0] = UnityStrInvalidFloatTrait;
            break;
M
Mark VanderVoord 已提交
766 767 768 769 770 771 772 773 774 775
    }

    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 已提交
776
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
M
Mark VanderVoord 已提交
777 778 779 780 781 782 783 784 785 786 787
        UnityPrintFloat(actual);
#else
        if (should_be_trait)
            UnityPrint(UnityStrNot);
        UnityPrint(trait_names[trait_index]);
#endif
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

788
#endif /* not UNITY_EXCLUDE_FLOAT */
M
Mark VanderVoord 已提交
789

790
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
791
#ifndef UNITY_EXCLUDE_DOUBLE
792
static int UnityDoublesWithin(UNITY_DOUBLE delta, UNITY_DOUBLE expected, UNITY_DOUBLE actual)
793
{
794
    UNITY_DOUBLE diff;
795 796 797
    UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff);
}

798 799 800
void UnityAssertEqualDoubleArray(UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* expected,
                                 UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* actual,
                                 const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
801 802 803
                                 const char* msg,
                                 const UNITY_LINE_TYPE lineNumber)
{
804 805 806
    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 已提交
807

808
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
809 810 811

    if (elements == 0)
    {
812
        UnityPrintPointlessAndBail();
M
Mark VanderVoord 已提交
813 814
    }

815 816 817
    if (expected == actual) return; /* Both are NULL or same pointer */
    if (UnityIsOneArrayNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg))
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
818 819 820

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

835
/*-----------------------------------------------*/
836 837 838
void UnityAssertDoublesWithin(const UNITY_DOUBLE delta,
                              const UNITY_DOUBLE expected,
                              const UNITY_DOUBLE actual,
M
Mark VanderVoord 已提交
839 840 841
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber)
{
842
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
843

844
    if (!UnityDoublesWithin(delta, expected, actual))
M
Mark VanderVoord 已提交
845 846
    {
        UnityTestResultsFailBegin(lineNumber);
847
        UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual);
M
Mark VanderVoord 已提交
848 849 850 851 852
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

853
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
854

855
void UnityAssertDoubleSpecial(const UNITY_DOUBLE actual,
M
Mark VanderVoord 已提交
856 857 858 859 860
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
                              const UNITY_FLOAT_TRAIT_T style)
{
    const char* trait_names[] = { UnityStrInf, UnityStrNegInf, UnityStrNaN, UnityStrDet };
861 862 863
    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 已提交
864

865
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
866 867 868 869 870

     switch(style)
    {
        case UNITY_FLOAT_IS_INF:
        case UNITY_FLOAT_IS_NOT_INF:
871
            is_trait = isinf(actual) && (actual > 0);
M
Mark VanderVoord 已提交
872 873 874
            break;
        case UNITY_FLOAT_IS_NEG_INF:
        case UNITY_FLOAT_IS_NOT_NEG_INF:
875
            is_trait = isinf(actual) && (actual < 0);
M
Mark VanderVoord 已提交
876 877 878 879
            break;

        case UNITY_FLOAT_IS_NAN:
        case UNITY_FLOAT_IS_NOT_NAN:
880
            is_trait = isnan(actual) ? 1 : 0;
M
Mark VanderVoord 已提交
881 882
            break;

883
        case UNITY_FLOAT_IS_DET: /* A determinate number is non infinite and not NaN. */
M
Mark VanderVoord 已提交
884
        case UNITY_FLOAT_IS_NOT_DET:
885
            is_trait = !isinf(actual) && !isnan(actual);
M
Mark VanderVoord 已提交
886 887 888
            break;

        default:
889 890 891
            trait_index = 0;
            trait_names[0] = UnityStrInvalidFloatTrait;
            break;
M
Mark VanderVoord 已提交
892 893 894 895 896 897 898 899 900 901
    }

    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 已提交
902
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
M
Mark VanderVoord 已提交
903 904 905 906 907 908 909 910 911 912 913 914
        UnityPrintFloat(actual);
#else
        if (should_be_trait)
            UnityPrint(UnityStrNot);
        UnityPrint(trait_names[trait_index]);
#endif
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}


915
#endif /* not UNITY_EXCLUDE_DOUBLE */
M
Mark VanderVoord 已提交
916

917
/*-----------------------------------------------*/
918 919 920
void UnityAssertNumbersWithin( const UNITY_UINT delta,
                               const UNITY_INT expected,
                               const UNITY_INT actual,
M
Mark VanderVoord 已提交
921 922 923 924
                               const char* msg,
                               const UNITY_LINE_TYPE lineNumber,
                               const UNITY_DISPLAY_STYLE_T style)
{
925
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
926 927 928 929

    if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT)
    {
        if (actual > expected)
930
            Unity.CurrentTestFailed = ((UNITY_UINT)(actual - expected) > delta);
M
Mark VanderVoord 已提交
931
        else
932
            Unity.CurrentTestFailed = ((UNITY_UINT)(expected - actual) > delta);
M
Mark VanderVoord 已提交
933 934 935
    }
    else
    {
936 937
        if ((UNITY_UINT)actual > (UNITY_UINT)expected)
            Unity.CurrentTestFailed = ((UNITY_UINT)(actual - expected) > delta);
M
Mark VanderVoord 已提交
938
        else
939
            Unity.CurrentTestFailed = ((UNITY_UINT)(expected - actual) > delta);
M
Mark VanderVoord 已提交
940 941 942 943 944 945
    }

    if (Unity.CurrentTestFailed)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrDelta);
946
        UnityPrintNumberByStyle((UNITY_INT)delta, style);
M
Mark VanderVoord 已提交
947 948 949 950 951 952 953 954 955
        UnityPrint(UnityStrExpected);
        UnityPrintNumberByStyle(expected, style);
        UnityPrint(UnityStrWas);
        UnityPrintNumberByStyle(actual, style);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

956
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
957 958 959 960 961
void UnityAssertEqualString(const char* expected,
                            const char* actual,
                            const char* msg,
                            const UNITY_LINE_TYPE lineNumber)
{
962
    UNITY_UINT32 i;
M
Mark VanderVoord 已提交
963

964
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
965

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

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

995
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
996 997
void UnityAssertEqualStringLen(const char* expected,
                            const char* actual,
998
                            const UNITY_UINT32 length,
M
Mark VanderVoord 已提交
999 1000 1001
                            const char* msg,
                            const UNITY_LINE_TYPE lineNumber)
{
1002
    UNITY_UINT32 i;
M
Mark VanderVoord 已提交
1003

1004
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1005

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

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


1036
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1037 1038
void UnityAssertEqualStringArray( const char** expected,
                                  const char** actual,
1039
                                  const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
1040 1041 1042
                                  const char* msg,
                                  const UNITY_LINE_TYPE lineNumber)
{
1043
    UNITY_UINT32 i, j = 0;
M
Mark VanderVoord 已提交
1044

1045
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1046

1047
    /* if no elements, it's an error */
M
Mark VanderVoord 已提交
1048 1049
    if (num_elements == 0)
    {
1050
        UnityPrintPointlessAndBail();
M
Mark VanderVoord 已提交
1051 1052
    }

1053 1054 1055
    if (expected == actual) return; /* Both are NULL or same pointer */
    if (UnityIsOneArrayNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg))
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
1056 1057 1058

    do
    {
1059
        /* if both pointers not null compare the strings */
M
Mark VanderVoord 已提交
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
        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
1072
        { /* handle case of one pointers being null (if both null, test should pass) */
M
Mark VanderVoord 已提交
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
            if (expected[j] != actual[j])
            {
                Unity.CurrentTestFailed = 1;
            }
        }

        if (Unity.CurrentTestFailed)
        {
            UnityTestResultsFailBegin(lineNumber);
            if (num_elements > 1)
            {
                UnityPrint(UnityStrElement);
1085
                UnityPrintNumberUnsigned(j);
M
Mark VanderVoord 已提交
1086 1087 1088 1089 1090 1091 1092 1093
            }
            UnityPrintExpectedAndActualStrings((const char*)(expected[j]), (const char*)(actual[j]));
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
    } while (++j < num_elements);
}

1094
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1095 1096
void UnityAssertEqualMemory( UNITY_INTERNAL_PTR expected,
                             UNITY_INTERNAL_PTR actual,
1097 1098
                             const UNITY_UINT32 length,
                             const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
1099 1100 1101 1102 1103
                             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;
1104 1105
    UNITY_UINT32 elements = num_elements;
    UNITY_UINT32 bytes;
M
Mark VanderVoord 已提交
1106

1107
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1108 1109 1110

    if ((elements == 0) || (length == 0))
    {
1111
        UnityPrintPointlessAndBail();
M
Mark VanderVoord 已提交
1112 1113
    }

1114 1115 1116
    if (expected == actual) return; /* Both are NULL or same pointer */
    if (UnityIsOneArrayNull(expected, actual, lineNumber, msg))
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129

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

1147 1148 1149
/*-----------------------------------------------
 * Control Functions
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
1150 1151 1152

void UnityFail(const char* msg, const UNITY_LINE_TYPE line)
{
1153
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1154 1155 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

    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;
}

1184
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1185 1186
void UnityIgnore(const char* msg, const UNITY_LINE_TYPE line)
{
1187
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199

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

1200
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1201 1202 1203 1204 1205 1206 1207 1208 1209
#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
1210
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
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();
    }
1222
    if (TEST_PROTECT())
M
Mark VanderVoord 已提交
1223 1224 1225 1226 1227 1228
    {
        tearDown();
    }
    UnityConcludeTest();
}

1229
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244
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();
}

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

1275 1276 1277
/*-----------------------------------------------
 * Command Line Argument Support
 *-----------------------------------------------*/
1278
#ifdef UNITY_USE_COMMAND_LINE_ARGS
1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295

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

    return 0;
}

1340
int IsStringInBiggerString(const char* longstring, const char* shortstring)
1341
{
1342 1343 1344
    char* lptr = (char*)longstring;
    char* sptr = (char*)shortstring;
    char* lnext = lptr;
1345

1346 1347 1348
    if (*sptr == '*')
        return 1;

1349 1350 1351
    while (*lptr)
    {
        lnext = lptr + 1;
1352

1353 1354 1355 1356 1357
        /* If they current bytes match, go on to the next bytes */
        while (*lptr && *sptr && (*lptr == *sptr))
        {
            lptr++;
            sptr++;
1358

1359 1360 1361
            /* We're done if we match the entire string or up to a wildcard */
            if (*sptr == '*')
                return 1;
1362 1363 1364 1365 1366 1367 1368 1369
            if (*sptr == ',')
                return 1;
            if (*sptr == '"')
                return 1;
            if (*sptr == '\'')
                return 1;
            if (*sptr == ':')
                return 2;
1370 1371 1372 1373 1374 1375 1376 1377 1378
            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;
1379 1380 1381 1382
}

int UnityStringArgumentMatches(const char* str)
{
1383 1384 1385
    int retval;
    const char* ptr1;
    const char* ptr2;
1386
    const char* ptrf;
1387

1388
    /* Go through the options and get the substrings for matching one at a time */
1389 1390 1391 1392 1393 1394
    ptr1 = str;
    while (ptr1[0] != 0)
    {
        if ((ptr1[0] == '"') || (ptr1[0] == '\''))
            ptr1++;

1395
        /* look for the start of the next partial */
1396
        ptr2 = ptr1;
1397
        ptrf = 0;
1398 1399
        do {
            ptr2++;
1400 1401 1402 1403
            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] == ',')))
1404 1405
            ptr2++;

1406
        /* done if complete filename match */
1407 1408 1409 1410
        retval = IsStringInBiggerString(Unity.TestFile, ptr1);
        if (retval == 1)
            return retval;

1411
        /* done if testname match after filename partial match */
1412
        if ((retval == 2) && (ptrf != 0))
1413
        {
1414
            if (IsStringInBiggerString(Unity.CurrentTestName, ptrf))
1415 1416 1417
                return 1;
        }

1418
        /* done if complete testname match */
1419 1420 1421 1422 1423 1424
        if (IsStringInBiggerString(Unity.CurrentTestName, ptr1) == 1)
            return 1;

        ptr1 = ptr2;
    }

1425
    /* we couldn't find a match for any substrings */
1426
    return 0;
1427
}
1428

1429 1430 1431 1432 1433 1434 1435 1436 1437 1438
int UnityTestMatches(void)
{
    /* Check if this test name matches the included test pattern */
    int retval;
    if (UnityOptionIncludeNamed)
    {
        retval = UnityStringArgumentMatches(UnityOptionIncludeNamed);
    }
    else
        retval = 1;
1439

1440 1441 1442 1443 1444
    /* Check if this test name matches the excluded test pattern */
    if (UnityOptionExcludeNamed)
    {
        if (UnityStringArgumentMatches(UnityOptionExcludeNamed))
            retval = 0;
1445
    }
1446
    return retval;
1447 1448
}

1449
#endif /* UNITY_USE_COMMAND_LINE_ARGS */
1450
/*-----------------------------------------------*/