unity.c 48.8 KB
Newer Older
M
Mark VanderVoord 已提交
1 2 3 4 5 6
/* =========================================================================
    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]
============================================================================ */

J
John Lindgren 已提交
7
#define UNITY_INCLUDE_SETUP_STUBS
M
Mark VanderVoord 已提交
8 9 10
#include "unity.h"
#include <stddef.h>

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

16
/* Helpful macros for us to use here in Assert functions */
17 18
#define UNITY_FAIL_AND_BAIL   { Unity.CurrentTestFailed  = 1; TEST_ABORT(); }
#define UNITY_IGNORE_AND_BAIL { Unity.CurrentTestIgnored = 1; TEST_ABORT(); }
19
#define RETURN_IF_FAIL_OR_IGNORE if (Unity.CurrentTestFailed || Unity.CurrentTestIgnored) return
M
Mark VanderVoord 已提交
20

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

23 24 25 26 27 28
#ifdef UNITY_OUTPUT_COLOR
static const char UnityStrOk[]                     = "\033[42mOK\033[00m";
static const char UnityStrPass[]                   = "\033[42mPASS\033[00m";
static const char UnityStrFail[]                   = "\033[41mFAIL\033[00m";
static const char UnityStrIgnore[]                 = "\033[43mIGNORE\033[00m";
#else
29 30 31 32
static const char UnityStrOk[]                     = "OK";
static const char UnityStrPass[]                   = "PASS";
static const char UnityStrFail[]                   = "FAIL";
static const char UnityStrIgnore[]                 = "IGNORE";
33
#endif
34 35 36 37
static const char UnityStrNull[]                   = "NULL";
static const char UnityStrSpacer[]                 = ". ";
static const char UnityStrExpected[]               = " Expected ";
static const char UnityStrWas[]                    = " Was ";
38 39
static const char UnityStrGt[]                     = " to be greater than ";
static const char UnityStrLt[]                     = " to be less than ";
40
static const char UnityStrOrEqual[]                = "or equal to ";
41 42 43 44 45 46 47
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";
48
#ifndef UNITY_EXCLUDE_FLOAT
49 50 51 52 53 54
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";
55
#endif
56 57 58 59 60 61 62 63 64
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 已提交
65

66 67 68
/*-----------------------------------------------
 * Pretty Printers & Test Result Output Handlers
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
69 70 71 72 73 74 75 76 77

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

    if (pch != NULL)
    {
        while (*pch)
        {
78
            /* printable characters plus CR & LF are printed */
M
Mark VanderVoord 已提交
79 80 81 82
            if ((*pch <= 126) && (*pch >= 32))
            {
                UNITY_OUTPUT_CHAR(*pch);
            }
83
            /* write escaped carriage returns */
M
Mark VanderVoord 已提交
84 85 86 87 88
            else if (*pch == 13)
            {
                UNITY_OUTPUT_CHAR('\\');
                UNITY_OUTPUT_CHAR('r');
            }
89
            /* write escaped line feeds */
M
Mark VanderVoord 已提交
90 91 92 93 94
            else if (*pch == 10)
            {
                UNITY_OUTPUT_CHAR('\\');
                UNITY_OUTPUT_CHAR('n');
            }
95 96 97 98 99 100 101 102 103 104 105 106
#ifdef UNITY_OUTPUT_COLOR
            /* print ANSI escape code */
            else if (*pch == 27 && *(pch + 1) == '[')
            {
                while (*pch && *pch != 'm')
                {
                    UNITY_OUTPUT_CHAR(*pch);
                    pch++;
                }
                UNITY_OUTPUT_CHAR('m');
            }
#endif
107
            /* unprintable characters are shown as codes */
M
Mark VanderVoord 已提交
108 109 110
            else
            {
                UNITY_OUTPUT_CHAR('\\');
111
                UNITY_OUTPUT_CHAR('x');
112
                UnityPrintNumberHex((UNITY_UINT)*pch, 2);
M
Mark VanderVoord 已提交
113 114 115 116 117 118
            }
            pch++;
        }
    }
}

119
void UnityPrintLen(const char* string, const UNITY_UINT32 length)
M
Mark VanderVoord 已提交
120 121 122 123 124
{
    const char* pch = string;

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

156
/*-----------------------------------------------*/
157
void UnityPrintNumberByStyle(const UNITY_INT number, const UNITY_DISPLAY_STYLE_T style)
M
Mark VanderVoord 已提交
158 159 160 161 162 163 164
{
    if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT)
    {
        UnityPrintNumber(number);
    }
    else if ((style & UNITY_DISPLAY_RANGE_UINT) == UNITY_DISPLAY_RANGE_UINT)
    {
165
        UnityPrintNumberUnsigned((UNITY_UINT)number);
M
Mark VanderVoord 已提交
166 167 168
    }
    else
    {
169 170
        UNITY_OUTPUT_CHAR('0');
        UNITY_OUTPUT_CHAR('x');
171
        UnityPrintNumberHex((UNITY_UINT)number, (char)((style & 0xF) * 2));
M
Mark VanderVoord 已提交
172 173 174
    }
}

175
/*-----------------------------------------------*/
176
void UnityPrintNumber(const UNITY_INT number_to_print)
M
Mark VanderVoord 已提交
177
{
178
    UNITY_UINT number = (UNITY_UINT)number_to_print;
M
Mark VanderVoord 已提交
179 180 181

    if (number_to_print < 0)
    {
182
        /* A negative number, including MIN negative */
M
Mark VanderVoord 已提交
183
        UNITY_OUTPUT_CHAR('-');
184
        number = (UNITY_UINT)(-number_to_print);
M
Mark VanderVoord 已提交
185
    }
186
    UnityPrintNumberUnsigned(number);
M
Mark VanderVoord 已提交
187 188
}

189 190
/*-----------------------------------------------
 * basically do an itoa using as little ram as possible */
191
void UnityPrintNumberUnsigned(const UNITY_UINT number)
M
Mark VanderVoord 已提交
192
{
193
    UNITY_UINT divisor = 1;
M
Mark VanderVoord 已提交
194

195
    /* figure out initial divisor */
M
Mark VanderVoord 已提交
196 197
    while (number / divisor > 9)
    {
198
        divisor *= 10;
M
Mark VanderVoord 已提交
199 200
    }

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

209
/*-----------------------------------------------*/
210
void UnityPrintNumberHex(const UNITY_UINT number, const char nibbles_to_print)
M
Mark VanderVoord 已提交
211
{
212
    int nibble;
M
Mark VanderVoord 已提交
213
    char nibbles = nibbles_to_print;
214 215
    if ((unsigned)nibbles > (2 * sizeof(number)))
        nibbles = 2 * sizeof(number);
M
Mark VanderVoord 已提交
216 217 218

    while (nibbles > 0)
    {
219
        nibbles--;
220
        nibble = (int)(number >> (nibbles * 4)) & 0x0F;
M
Mark VanderVoord 已提交
221 222 223 224 225 226 227 228 229 230 231
        if (nibble <= 9)
        {
            UNITY_OUTPUT_CHAR((char)('0' + nibble));
        }
        else
        {
            UNITY_OUTPUT_CHAR((char)('A' - 10 + nibble));
        }
    }
}

232
/*-----------------------------------------------*/
233
void UnityPrintMask(const UNITY_UINT mask, const UNITY_UINT number)
M
Mark VanderVoord 已提交
234
{
235 236
    UNITY_UINT current_bit = (UNITY_UINT)1 << (UNITY_INT_WIDTH - 1);
    UNITY_INT32 i;
M
Mark VanderVoord 已提交
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258

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

259
/*-----------------------------------------------*/
J
jsalling 已提交
260
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
261 262 263 264 265 266 267 268
/*
 * This function prints a floating-point value in a format similar to
 * printf("%.7g").  It can work with either single- or double-precision,
 * but for simplicity, it prints only 7 significant digits in either case.
 * The 7th digit won't always be totally correct in single-precision
 * operation (for that level of accuracy, a more complicated algorithm
 * would be needed).
 */
269
void UnityPrintFloat(const UNITY_DOUBLE input_number)
M
Mark VanderVoord 已提交
270
{
271
    UNITY_DOUBLE number = input_number;
272

273 274
    /* print minus sign (including for negative zero) */
    if (number < 0.0f || (number == 0.0f && 1.0f / number < 0.0f))
J
jsalling 已提交
275 276
    {
        UNITY_OUTPUT_CHAR('-');
277
        number = -number;
J
jsalling 已提交
278
    }
279

280 281 282 283 284
    /* handle zero, NaN, and +/- infinity */
    if (number == 0.0f) UnityPrint("0");
    else if (isnan(number)) UnityPrint("nan");
    else if (isinf(number)) UnityPrint("inf");
    else
J
jsalling 已提交
285
    {
286
        int exponent = 0;
J
John Lindgren 已提交
287 288 289
        int decimals, digits;
        UNITY_INT32 n;
        char buf[16];
290

291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
        /*
         * Scale up or down by powers of 10.  To minimize rounding error,
         * start with a factor/divisor of 10^10, which is the largest
         * power of 10 that can be represented exactly.  Finally, compute
         * (exactly) the remaining power of 10 and perform one more
         * multiplication or division.
         */
        if(number < 1e6f)
        {
            UNITY_DOUBLE factor = 1.0f;

            while(number < 1e7f / 1e10f) { number *= 1e10f; exponent -= 10; }
            while(number * factor < 1e6f) { factor *= 10.0f; exponent--; }

            number *= factor;
        }
        else if(number > 1e7f)
        {
            UNITY_DOUBLE divisor = 1.0f;

            while(number > 1e6f * 1e10f) { number /= 1e10f; exponent += 10; }
            while(number / divisor > 1e7f) { divisor *= 10.0f; exponent++; }

            number /= divisor;
        }
316 317

        /* round to nearest integer */
J
John Lindgren 已提交
318
        n = ((UNITY_INT32)(number + number) + 1) / 2;
319
        if (n > 9999999)
320
        {
321
            n = 1000000;
322
            exponent++;
323 324
        }

325
        /* determine where to place decimal point */
326
        decimals = (exponent <= 0 && exponent >= -10) ? -exponent : 6;
327 328 329 330
        exponent += decimals;

        /* truncate trailing zeroes after decimal point */
        while (decimals > 0 && n % 10 == 0)
331
        {
332 333 334 335 336
            n /= 10;
            decimals--;
        }

        /* build up buffer in reverse order */
J
John Lindgren 已提交
337
        digits = 0;
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
        while (n != 0 || digits < decimals + 1)
        {
            buf[digits++] = (char)('0' + n % 10);
            n /= 10;
        }
        while (digits > 0)
        {
            if(digits == decimals) UNITY_OUTPUT_CHAR('.');
            UNITY_OUTPUT_CHAR(buf[--digits]);
        }

        /* print exponent if needed */
        if (exponent != 0)
        {
            UNITY_OUTPUT_CHAR('e');

            if(exponent < 0)
            {
                UNITY_OUTPUT_CHAR('-');
                exponent = -exponent;
            }
            else
            {
                UNITY_OUTPUT_CHAR('+');
            }

            digits = 0;
            while (exponent != 0 || digits < 2)
            {
                buf[digits++] = (char)('0' + exponent % 10);
                exponent /= 10;
            }
            while (digits > 0)
            {
                UNITY_OUTPUT_CHAR(buf[--digits]);
            }
374
        }
J
jsalling 已提交
375
    }
M
Mark VanderVoord 已提交
376
}
J
jsalling 已提交
377
#endif /* ! UNITY_EXCLUDE_FLOAT_PRINT */
M
Mark VanderVoord 已提交
378

379
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
380 381 382 383
static void UnityTestResultsBegin(const char* file, const UNITY_LINE_TYPE line)
{
    UnityPrint(file);
    UNITY_OUTPUT_CHAR(':');
384
    UnityPrintNumber((UNITY_INT)line);
M
Mark VanderVoord 已提交
385 386 387 388 389
    UNITY_OUTPUT_CHAR(':');
    UnityPrint(Unity.CurrentTestName);
    UNITY_OUTPUT_CHAR(':');
}

390
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
391 392 393 394 395 396 397
static void UnityTestResultsFailBegin(const UNITY_LINE_TYPE line)
{
    UnityTestResultsBegin(Unity.TestFile, line);
    UnityPrint(UnityStrFail);
    UNITY_OUTPUT_CHAR(':');
}

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

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

444
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
445 446 447 448 449 450 451 452 453 454 455
static void UnityPrintExpectedAndActualStrings(const char* expected, const char* actual)
{
    UnityPrint(UnityStrExpected);
    if (expected != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrint(expected);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
456
        UnityPrint(UnityStrNull);
M
Mark VanderVoord 已提交
457 458 459 460 461 462 463 464 465 466
    }
    UnityPrint(UnityStrWas);
    if (actual != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrint(actual);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
467
        UnityPrint(UnityStrNull);
M
Mark VanderVoord 已提交
468 469 470
    }
}

471
/*-----------------------------------------------*/
472 473 474
static void UnityPrintExpectedAndActualStringsLen(const char* expected,
                                                  const char* actual,
                                                  const UNITY_UINT32 length)
M
Mark VanderVoord 已提交
475 476 477 478 479 480 481 482 483 484
{
    UnityPrint(UnityStrExpected);
    if (expected != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrintLen(expected, length);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
485
        UnityPrint(UnityStrNull);
M
Mark VanderVoord 已提交
486 487 488 489 490 491 492 493 494 495
    }
    UnityPrint(UnityStrWas);
    if (actual != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrintLen(actual, length);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
496
        UnityPrint(UnityStrNull);
M
Mark VanderVoord 已提交
497 498 499
    }
}

500 501 502
/*-----------------------------------------------
 * Assertion & Control Helpers
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
503

504 505 506 507
static int UnityIsOneArrayNull(UNITY_INTERNAL_PTR expected,
                               UNITY_INTERNAL_PTR actual,
                               const UNITY_LINE_TYPE lineNumber,
                               const char* msg)
M
Mark VanderVoord 已提交
508
{
509
    if (expected == actual) return 0; /* Both are NULL or same pointer */
M
Mark VanderVoord 已提交
510

511
    /* print and return true if just expected is NULL */
M
Mark VanderVoord 已提交
512 513 514 515 516
    if (expected == NULL)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrNullPointerForExpected);
        UnityAddMsgIfSpecified(msg);
517
        return 1;
M
Mark VanderVoord 已提交
518 519
    }

520
    /* print and return true if just actual is NULL */
M
Mark VanderVoord 已提交
521 522 523 524 525
    if (actual == NULL)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrNullPointerForActual);
        UnityAddMsgIfSpecified(msg);
526
        return 1;
M
Mark VanderVoord 已提交
527 528
    }

529
    return 0; /* return false if neither is NULL */
M
Mark VanderVoord 已提交
530 531
}

532 533 534
/*-----------------------------------------------
 * Assertion Functions
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
535

536 537 538
void UnityAssertBits(const UNITY_INT mask,
                     const UNITY_INT expected,
                     const UNITY_INT actual,
M
Mark VanderVoord 已提交
539 540 541
                     const char* msg,
                     const UNITY_LINE_TYPE lineNumber)
{
542
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
543 544 545 546 547

    if ((mask & expected) != (mask & actual))
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrExpected);
548
        UnityPrintMask((UNITY_UINT)mask, (UNITY_UINT)expected);
M
Mark VanderVoord 已提交
549
        UnityPrint(UnityStrWas);
550
        UnityPrintMask((UNITY_UINT)mask, (UNITY_UINT)actual);
M
Mark VanderVoord 已提交
551 552 553 554 555
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

556
/*-----------------------------------------------*/
557 558
void UnityAssertEqualNumber(const UNITY_INT expected,
                            const UNITY_INT actual,
M
Mark VanderVoord 已提交
559 560 561 562
                            const char* msg,
                            const UNITY_LINE_TYPE lineNumber,
                            const UNITY_DISPLAY_STYLE_T style)
{
563
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
564 565 566 567 568 569 570 571 572 573 574 575 576

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

577
/*-----------------------------------------------*/
578 579 580 581 582 583
void UnityAssertGreaterOrLessOrEqualNumber(const UNITY_INT threshold,
                                           const UNITY_INT actual,
                                           const UNITY_COMPARISON_T compare,
                                           const char *msg,
                                           const UNITY_LINE_TYPE lineNumber,
                                           const UNITY_DISPLAY_STYLE_T style)
584
{
585
    int failed = 0;
586 587
    RETURN_IF_FAIL_OR_IGNORE;

588 589 590 591
    if (threshold == actual && compare & UNITY_EQUAL_TO) return;
    if (threshold == actual) failed = 1;

    if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT)
592
    {
593 594 595 596 597 598 599
        if (actual > threshold && compare & UNITY_SMALLER_THAN) failed = 1;
        if (actual < threshold && compare & UNITY_GREATER_THAN) failed = 1;
    }
    else /* UINT or HEX */
    {
        if ((UNITY_UINT)actual > (UNITY_UINT)threshold && compare & UNITY_SMALLER_THAN) failed = 1;
        if ((UNITY_UINT)actual < (UNITY_UINT)threshold && compare & UNITY_GREATER_THAN) failed = 1;
600 601
    }

602
    if (failed)
603 604 605 606
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrExpected);
        UnityPrintNumberByStyle(actual, style);
607 608 609
        if (compare & UNITY_GREATER_THAN) UnityPrint(UnityStrGt);
        if (compare & UNITY_SMALLER_THAN) UnityPrint(UnityStrLt);
        if (compare & UNITY_EQUAL_TO)     UnityPrint(UnityStrOrEqual);
610 611 612 613 614 615
        UnityPrintNumberByStyle(threshold, style);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

616 617 618 619 620 621 622
#define UnityPrintPointlessAndBail()       \
{                                          \
    UnityTestResultsFailBegin(lineNumber); \
    UnityPrint(UnityStrPointless);         \
    UnityAddMsgIfSpecified(msg);           \
    UNITY_FAIL_AND_BAIL; }

623
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
624 625
void UnityAssertEqualIntArray(UNITY_INTERNAL_PTR expected,
                              UNITY_INTERNAL_PTR actual,
626
                              const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
627 628
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
629 630
                              const UNITY_DISPLAY_STYLE_T style,
                              const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
631
{
632
    UNITY_UINT32 elements = num_elements;
633
    unsigned int length   = style & 0xF;
M
Mark VanderVoord 已提交
634

635
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
636

637 638 639 640
    if (num_elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
641

642 643 644
    if (expected == actual) return; /* Both are NULL or same pointer */
    if (UnityIsOneArrayNull(expected, actual, lineNumber, msg))
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
645

646
    while (elements--)
M
Mark VanderVoord 已提交
647
    {
648 649
        UNITY_INT expect_val;
        UNITY_INT actual_val;
650 651 652 653 654 655 656 657 658 659
        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;
M
Mark VanderVoord 已提交
660
#ifdef UNITY_SUPPORT_64
661 662 663 664
            case 8:
                expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)expected;
                actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)actual;
                break;
M
Mark VanderVoord 已提交
665
#endif
666 667 668 669 670
            default: /* length 4 bytes */
                expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT32*)expected;
                actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT32*)actual;
                length = 4;
                break;
671 672 673 674
        }

        if (expect_val != actual_val)
        {
675
            if (style & UNITY_DISPLAY_RANGE_UINT && length < sizeof(expect_val))
676 677 678 679 680 681
            {   /* 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;
            }
682 683 684 685 686 687 688 689 690 691
            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;
        }
692 693 694 695
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
            expected = (UNITY_INTERNAL_PTR)(length + (const char*)expected);
        }
696
        actual   = (UNITY_INTERNAL_PTR)(length + (const char*)actual);
M
Mark VanderVoord 已提交
697 698 699
    }
}

700
/*-----------------------------------------------*/
701
#ifndef UNITY_EXCLUDE_FLOAT
702
/* Wrap this define in a function with variable types as float or double */
703
#define UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff)                       \
704
    if (isinf(expected) && isinf(actual) && ((expected < 0) == (actual < 0))) return 1;   \
705
    if (UNITY_NAN_CHECK) return 1;                                                        \
706
    diff = actual - expected;                                                             \
707 708
    if (diff < 0) diff = -diff;                                                           \
    if (delta < 0) delta = -delta;                                                        \
709
    return !(isnan(diff) || isinf(diff) || (diff > delta))
710
    /* This first part of this condition will catch any NaN or Infinite values */
711 712 713 714 715
#ifndef UNITY_NAN_NOT_EQUAL_NAN
  #define UNITY_NAN_CHECK isnan(expected) && isnan(actual)
#else
  #define UNITY_NAN_CHECK 0
#endif
716

717 718
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
  #define UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual) \
719
  {                                                               \
720 721 722
    UnityPrint(UnityStrExpected);                                 \
    UnityPrintFloat(expected);                                    \
    UnityPrint(UnityStrWas);                                      \
723
    UnityPrintFloat(actual); }
724 725 726 727 728
#else
  #define UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual) \
    UnityPrint(UnityStrDelta)
#endif /* UNITY_EXCLUDE_FLOAT_PRINT */

729
static int UnityFloatsWithin(UNITY_FLOAT delta, UNITY_FLOAT expected, UNITY_FLOAT actual)
730
{
731
    UNITY_FLOAT diff;
732 733 734
    UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff);
}

735 736 737
void UnityAssertEqualFloatArray(UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* expected,
                                UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* actual,
                                const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
738
                                const char* msg,
739 740
                                const UNITY_LINE_TYPE lineNumber,
                                const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
741
{
742
    UNITY_UINT32 elements = num_elements;
743 744
    UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* ptr_expected = expected;
    UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* ptr_actual = actual;
M
Mark VanderVoord 已提交
745

746
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
747

748 749 750 751
    if (elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
752

753 754 755
    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 已提交
756 757 758

    while (elements--)
    {
759
        if (!UnityFloatsWithin(*ptr_expected * UNITY_FLOAT_PRECISION, *ptr_expected, *ptr_actual))
M
Mark VanderVoord 已提交
760 761 762
        {
            UnityTestResultsFailBegin(lineNumber);
            UnityPrint(UnityStrElement);
763
            UnityPrintNumberUnsigned(num_elements - elements - 1);
764
            UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT((UNITY_DOUBLE)*ptr_expected, (UNITY_DOUBLE)*ptr_actual);
M
Mark VanderVoord 已提交
765 766 767
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
768 769 770 771
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
            ptr_expected++;
        }
772
        ptr_actual++;
M
Mark VanderVoord 已提交
773 774 775
    }
}

776
/*-----------------------------------------------*/
777 778 779
void UnityAssertFloatsWithin(const UNITY_FLOAT delta,
                             const UNITY_FLOAT expected,
                             const UNITY_FLOAT actual,
M
Mark VanderVoord 已提交
780 781 782
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber)
{
783
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
784 785


786
    if (!UnityFloatsWithin(delta, expected, actual))
M
Mark VanderVoord 已提交
787 788
    {
        UnityTestResultsFailBegin(lineNumber);
789
        UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT((UNITY_DOUBLE)expected, (UNITY_DOUBLE)actual);
M
Mark VanderVoord 已提交
790 791 792 793 794
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

795
/*-----------------------------------------------*/
796
void UnityAssertFloatSpecial(const UNITY_FLOAT actual,
M
Mark VanderVoord 已提交
797 798 799 800
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber,
                             const UNITY_FLOAT_TRAIT_T style)
{
801 802 803 804
    const char* trait_names[] = {UnityStrInf, UnityStrNegInf, UnityStrNaN, UnityStrDet};
    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 已提交
805

806
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
807

808
    switch (style)
M
Mark VanderVoord 已提交
809 810 811
    {
        case UNITY_FLOAT_IS_INF:
        case UNITY_FLOAT_IS_NOT_INF:
812
            is_trait = isinf(actual) && (actual > 0);
M
Mark VanderVoord 已提交
813 814 815
            break;
        case UNITY_FLOAT_IS_NEG_INF:
        case UNITY_FLOAT_IS_NOT_NEG_INF:
816
            is_trait = isinf(actual) && (actual < 0);
M
Mark VanderVoord 已提交
817 818 819 820
            break;

        case UNITY_FLOAT_IS_NAN:
        case UNITY_FLOAT_IS_NOT_NAN:
821
            is_trait = isnan(actual) ? 1 : 0;
M
Mark VanderVoord 已提交
822 823
            break;

824
        case UNITY_FLOAT_IS_DET: /* A determinate number is non infinite and not NaN. */
M
Mark VanderVoord 已提交
825
        case UNITY_FLOAT_IS_NOT_DET:
826
            is_trait = !isinf(actual) && !isnan(actual);
M
Mark VanderVoord 已提交
827 828 829
            break;

        default:
830 831 832
            trait_index = 0;
            trait_names[0] = UnityStrInvalidFloatTrait;
            break;
M
Mark VanderVoord 已提交
833 834 835 836 837 838 839 840 841 842
    }

    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 已提交
843
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
844
        UnityPrintFloat((UNITY_DOUBLE)actual);
M
Mark VanderVoord 已提交
845 846 847 848 849 850 851 852 853 854
#else
        if (should_be_trait)
            UnityPrint(UnityStrNot);
        UnityPrint(trait_names[trait_index]);
#endif
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

855
#endif /* not UNITY_EXCLUDE_FLOAT */
M
Mark VanderVoord 已提交
856

857
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
858
#ifndef UNITY_EXCLUDE_DOUBLE
859
static int UnityDoublesWithin(UNITY_DOUBLE delta, UNITY_DOUBLE expected, UNITY_DOUBLE actual)
860
{
861
    UNITY_DOUBLE diff;
862 863 864
    UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff);
}

865 866 867
void UnityAssertEqualDoubleArray(UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* expected,
                                 UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* actual,
                                 const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
868
                                 const char* msg,
869 870
                                 const UNITY_LINE_TYPE lineNumber,
                                 const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
871
{
872
    UNITY_UINT32 elements = num_elements;
873 874
    UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* ptr_expected = expected;
    UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* ptr_actual = actual;
M
Mark VanderVoord 已提交
875

876
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
877

878 879 880 881
    if (elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
882

883 884 885
    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 已提交
886 887 888

    while (elements--)
    {
889
        if (!UnityDoublesWithin(*ptr_expected * UNITY_DOUBLE_PRECISION, *ptr_expected, *ptr_actual))
M
Mark VanderVoord 已提交
890 891 892
        {
            UnityTestResultsFailBegin(lineNumber);
            UnityPrint(UnityStrElement);
893
            UnityPrintNumberUnsigned(num_elements - elements - 1);
894
            UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(*ptr_expected, *ptr_actual);
M
Mark VanderVoord 已提交
895 896 897
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
898 899 900 901
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
            ptr_expected++;
        }
902
        ptr_actual++;
M
Mark VanderVoord 已提交
903 904 905
    }
}

906
/*-----------------------------------------------*/
907 908 909
void UnityAssertDoublesWithin(const UNITY_DOUBLE delta,
                              const UNITY_DOUBLE expected,
                              const UNITY_DOUBLE actual,
M
Mark VanderVoord 已提交
910 911 912
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber)
{
913
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
914

915
    if (!UnityDoublesWithin(delta, expected, actual))
M
Mark VanderVoord 已提交
916 917
    {
        UnityTestResultsFailBegin(lineNumber);
918
        UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual);
M
Mark VanderVoord 已提交
919 920 921 922 923
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

924
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
925

926
void UnityAssertDoubleSpecial(const UNITY_DOUBLE actual,
M
Mark VanderVoord 已提交
927 928 929 930
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
                              const UNITY_FLOAT_TRAIT_T style)
{
931 932 933 934
    const char* trait_names[] = {UnityStrInf, UnityStrNegInf, UnityStrNaN, UnityStrDet};
    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 已提交
935

936
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
937

938
    switch (style)
M
Mark VanderVoord 已提交
939 940 941
    {
        case UNITY_FLOAT_IS_INF:
        case UNITY_FLOAT_IS_NOT_INF:
942
            is_trait = isinf(actual) && (actual > 0);
M
Mark VanderVoord 已提交
943 944 945
            break;
        case UNITY_FLOAT_IS_NEG_INF:
        case UNITY_FLOAT_IS_NOT_NEG_INF:
946
            is_trait = isinf(actual) && (actual < 0);
M
Mark VanderVoord 已提交
947 948 949 950
            break;

        case UNITY_FLOAT_IS_NAN:
        case UNITY_FLOAT_IS_NOT_NAN:
951
            is_trait = isnan(actual) ? 1 : 0;
M
Mark VanderVoord 已提交
952 953
            break;

954
        case UNITY_FLOAT_IS_DET: /* A determinate number is non infinite and not NaN. */
M
Mark VanderVoord 已提交
955
        case UNITY_FLOAT_IS_NOT_DET:
956
            is_trait = !isinf(actual) && !isnan(actual);
M
Mark VanderVoord 已提交
957 958 959
            break;

        default:
960 961 962
            trait_index = 0;
            trait_names[0] = UnityStrInvalidFloatTrait;
            break;
M
Mark VanderVoord 已提交
963 964 965 966 967 968 969 970 971 972
    }

    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 已提交
973
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
M
Mark VanderVoord 已提交
974 975 976 977 978 979 980 981 982 983 984
        UnityPrintFloat(actual);
#else
        if (should_be_trait)
            UnityPrint(UnityStrNot);
        UnityPrint(trait_names[trait_index]);
#endif
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

985
#endif /* not UNITY_EXCLUDE_DOUBLE */
M
Mark VanderVoord 已提交
986

987
/*-----------------------------------------------*/
988 989 990 991 992 993
void UnityAssertNumbersWithin(const UNITY_UINT delta,
                              const UNITY_INT expected,
                              const UNITY_INT actual,
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
                              const UNITY_DISPLAY_STYLE_T style)
M
Mark VanderVoord 已提交
994
{
995
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
996 997 998 999

    if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT)
    {
        if (actual > expected)
M
Max Bruckner 已提交
1000
          Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(actual - expected) > delta);
M
Mark VanderVoord 已提交
1001
        else
M
Max Bruckner 已提交
1002
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(expected - actual) > delta);
M
Mark VanderVoord 已提交
1003 1004 1005
    }
    else
    {
1006
        if ((UNITY_UINT)actual > (UNITY_UINT)expected)
M
Max Bruckner 已提交
1007
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(actual - expected) > delta);
M
Mark VanderVoord 已提交
1008
        else
M
Max Bruckner 已提交
1009
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(expected - actual) > delta);
M
Mark VanderVoord 已提交
1010 1011 1012 1013 1014 1015
    }

    if (Unity.CurrentTestFailed)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrDelta);
1016
        UnityPrintNumberByStyle((UNITY_INT)delta, style);
M
Mark VanderVoord 已提交
1017 1018 1019 1020 1021 1022 1023 1024 1025
        UnityPrint(UnityStrExpected);
        UnityPrintNumberByStyle(expected, style);
        UnityPrint(UnityStrWas);
        UnityPrintNumberByStyle(actual, style);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

1026
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1027 1028 1029 1030 1031
void UnityAssertEqualString(const char* expected,
                            const char* actual,
                            const char* msg,
                            const UNITY_LINE_TYPE lineNumber)
{
1032
    UNITY_UINT32 i;
M
Mark VanderVoord 已提交
1033

1034
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1035

1036
    /* if both pointers not null compare the strings */
M
Mark VanderVoord 已提交
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
    if (expected && actual)
    {
        for (i = 0; expected[i] || actual[i]; i++)
        {
            if (expected[i] != actual[i])
            {
                Unity.CurrentTestFailed = 1;
                break;
            }
        }
    }
    else
1049
    { /* handle case of one pointers being null (if both null, test should pass) */
M
Mark VanderVoord 已提交
1050 1051 1052 1053 1054 1055 1056 1057
        if (expected != actual)
        {
            Unity.CurrentTestFailed = 1;
        }
    }

    if (Unity.CurrentTestFailed)
    {
1058 1059 1060 1061
        UnityTestResultsFailBegin(lineNumber);
        UnityPrintExpectedAndActualStrings(expected, actual);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
1062 1063 1064
    }
}

1065
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1066
void UnityAssertEqualStringLen(const char* expected,
1067 1068 1069 1070
                               const char* actual,
                               const UNITY_UINT32 length,
                               const char* msg,
                               const UNITY_LINE_TYPE lineNumber)
M
Mark VanderVoord 已提交
1071
{
1072
    UNITY_UINT32 i;
M
Mark VanderVoord 已提交
1073

1074
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1075

1076
    /* if both pointers not null compare the strings */
M
Mark VanderVoord 已提交
1077 1078
    if (expected && actual)
    {
1079
        for (i = 0; (i < length) && (expected[i] || actual[i]); i++)
M
Mark VanderVoord 已提交
1080 1081 1082 1083 1084 1085 1086 1087 1088
        {
            if (expected[i] != actual[i])
            {
                Unity.CurrentTestFailed = 1;
                break;
            }
        }
    }
    else
1089
    { /* handle case of one pointers being null (if both null, test should pass) */
M
Mark VanderVoord 已提交
1090 1091 1092 1093 1094 1095 1096 1097
        if (expected != actual)
        {
            Unity.CurrentTestFailed = 1;
        }
    }

    if (Unity.CurrentTestFailed)
    {
1098 1099 1100 1101
        UnityTestResultsFailBegin(lineNumber);
        UnityPrintExpectedAndActualStringsLen(expected, actual, length);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
1102 1103 1104
    }
}

1105
/*-----------------------------------------------*/
1106
void UnityAssertEqualStringArray(UNITY_INTERNAL_PTR expected,
1107 1108 1109
                                 const char** actual,
                                 const UNITY_UINT32 num_elements,
                                 const char* msg,
1110 1111
                                 const UNITY_LINE_TYPE lineNumber,
                                 const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
1112
{
1113 1114
    UNITY_UINT32 i = 0;
    UNITY_UINT32 j = 0;
1115
    const char* expd = NULL;
1116
    const char* act = NULL;
M
Mark VanderVoord 已提交
1117

1118
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1119

1120
    /* if no elements, it's an error */
1121 1122 1123 1124
    if (num_elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
1125

1126
    if ((const void*)expected == (const void*)actual)
1127 1128 1129 1130
    {
        return; /* Both are NULL or same pointer */
    }

1131
    if (UnityIsOneArrayNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg))
1132
    {
1133
        UNITY_FAIL_AND_BAIL;
1134 1135 1136 1137
    }

    if (flags != UNITY_ARRAY_TO_ARRAY)
    {
1138
        expd = (const char*)expected;
1139
    }
M
Mark VanderVoord 已提交
1140 1141 1142

    do
    {
1143 1144 1145
        act = actual[j];
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
1146
            expd = ((const char* const*)expected)[j];
1147 1148
        }

1149
        /* if both pointers not null compare the strings */
1150
        if (expd && act)
M
Mark VanderVoord 已提交
1151
        {
1152
            for (i = 0; expd[i] || act[i]; i++)
M
Mark VanderVoord 已提交
1153
            {
1154
                if (expd[i] != act[i])
M
Mark VanderVoord 已提交
1155 1156 1157 1158 1159 1160 1161
                {
                    Unity.CurrentTestFailed = 1;
                    break;
                }
            }
        }
        else
1162
        { /* handle case of one pointers being null (if both null, test should pass) */
1163
            if (expd != act)
M
Mark VanderVoord 已提交
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
            {
                Unity.CurrentTestFailed = 1;
            }
        }

        if (Unity.CurrentTestFailed)
        {
            UnityTestResultsFailBegin(lineNumber);
            if (num_elements > 1)
            {
                UnityPrint(UnityStrElement);
1175
                UnityPrintNumberUnsigned(j);
M
Mark VanderVoord 已提交
1176
            }
1177
            UnityPrintExpectedAndActualStrings(expd, act);
M
Mark VanderVoord 已提交
1178 1179 1180 1181 1182 1183
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
    } while (++j < num_elements);
}

1184
/*-----------------------------------------------*/
1185 1186 1187 1188 1189
void UnityAssertEqualMemory(UNITY_INTERNAL_PTR expected,
                            UNITY_INTERNAL_PTR actual,
                            const UNITY_UINT32 length,
                            const UNITY_UINT32 num_elements,
                            const char* msg,
1190 1191
                            const UNITY_LINE_TYPE lineNumber,
                            const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
1192 1193 1194
{
    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;
1195 1196
    UNITY_UINT32 elements = num_elements;
    UNITY_UINT32 bytes;
M
Mark VanderVoord 已提交
1197

1198
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1199

1200 1201 1202 1203
    if ((elements == 0) || (length == 0))
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
1204

1205 1206 1207
    if (expected == actual) return; /* Both are NULL or same pointer */
    if (UnityIsOneArrayNull(expected, actual, lineNumber, msg))
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220

    while (elements--)
    {
        bytes = length;
        while (bytes--)
        {
            if (*ptr_exp != *ptr_act)
            {
                UnityTestResultsFailBegin(lineNumber);
                UnityPrint(UnityStrMemory);
                if (num_elements > 1)
                {
                    UnityPrint(UnityStrElement);
1221
                    UnityPrintNumberUnsigned(num_elements - elements - 1);
M
Mark VanderVoord 已提交
1222 1223
                }
                UnityPrint(UnityStrByte);
1224
                UnityPrintNumberUnsigned(length - bytes - 1);
M
Mark VanderVoord 已提交
1225 1226 1227 1228 1229 1230 1231
                UnityPrint(UnityStrExpected);
                UnityPrintNumberByStyle(*ptr_exp, UNITY_DISPLAY_STYLE_HEX8);
                UnityPrint(UnityStrWas);
                UnityPrintNumberByStyle(*ptr_act, UNITY_DISPLAY_STYLE_HEX8);
                UnityAddMsgIfSpecified(msg);
                UNITY_FAIL_AND_BAIL;
            }
1232 1233
            ptr_exp++;
            ptr_act++;
M
Mark VanderVoord 已提交
1234
        }
1235 1236 1237 1238
        if (flags == UNITY_ARRAY_TO_VAL)
        {
            ptr_exp = (UNITY_PTR_ATTRIBUTE const unsigned char*)expected;
        }
M
Mark VanderVoord 已提交
1239 1240 1241
    }
}

1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
/*-----------------------------------------------*/

static union
{
    UNITY_INT8 i8;
    UNITY_INT16 i16;
    UNITY_INT32 i32;
#ifdef UNITY_SUPPORT_64
    UNITY_INT64 i64;
#endif
1252 1253 1254 1255 1256 1257
#ifndef UNITY_EXCLUDE_FLOAT
    float f;
#endif
#ifndef UNITY_EXCLUDE_DOUBLE
    double d;
#endif
1258 1259 1260 1261 1262 1263 1264
} UnityQuickCompare;

UNITY_INTERNAL_PTR UnityNumToPtr(const UNITY_INT num, const UNITY_UINT8 size)
{
    switch(size)
    {
        case 1:
1265
          UnityQuickCompare.i8 = (UNITY_INT8)num;
1266 1267 1268
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i8);

        case 2:
1269
          UnityQuickCompare.i16 = (UNITY_INT16)num;
1270 1271 1272 1273
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i16);

#ifdef UNITY_SUPPORT_64
        case 8:
1274
          UnityQuickCompare.i64 = (UNITY_INT64)num;
1275 1276
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i64);
#endif
1277
        default: /* 4 bytes */
1278
          UnityQuickCompare.i32 = (UNITY_INT32)num;
1279 1280 1281 1282
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i32);
    }
}

1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298
#ifndef UNITY_EXCLUDE_FLOAT
UNITY_INTERNAL_PTR UnityFloatToPtr(const float num)
{
    UnityQuickCompare.f = num;
    return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.f);
}
#endif

#ifndef UNITY_EXCLUDE_DOUBLE
UNITY_INTERNAL_PTR UnityDoubleToPtr(const double num)
{
    UnityQuickCompare.d = num;
    return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.d);
}
#endif

1299 1300 1301
/*-----------------------------------------------
 * Control Functions
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
1302 1303 1304

void UnityFail(const char* msg, const UNITY_LINE_TYPE line)
{
1305
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1306 1307

    UnityTestResultsBegin(Unity.TestFile, line);
1308
    UnityPrint(UnityStrFail);
M
Mark VanderVoord 已提交
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335
    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;
}

1336
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1337 1338
void UnityIgnore(const char* msg, const UNITY_LINE_TYPE line)
{
1339
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1340 1341 1342 1343 1344

    UnityTestResultsBegin(Unity.TestFile, line);
    UnityPrint(UnityStrIgnore);
    if (msg != NULL)
    {
1345 1346 1347
        UNITY_OUTPUT_CHAR(':');
        UNITY_OUTPUT_CHAR(' ');
        UnityPrint(msg);
M
Mark VanderVoord 已提交
1348 1349 1350 1351
    }
    UNITY_IGNORE_AND_BAIL;
}

1352
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
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();
    }
1364
    if (TEST_PROTECT())
M
Mark VanderVoord 已提交
1365 1366 1367 1368 1369 1370
    {
        tearDown();
    }
    UnityConcludeTest();
}

1371
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386
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();
}

1387
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1388 1389 1390 1391 1392
int UnityEnd(void)
{
    UNITY_PRINT_EOL();
    UnityPrint(UnityStrBreaker);
    UNITY_PRINT_EOL();
1393
    UnityPrintNumber((UNITY_INT)(Unity.NumberOfTests));
M
Mark VanderVoord 已提交
1394
    UnityPrint(UnityStrResultsTests);
1395
    UnityPrintNumber((UNITY_INT)(Unity.TestFailures));
M
Mark VanderVoord 已提交
1396
    UnityPrint(UnityStrResultsFailures);
1397
    UnityPrintNumber((UNITY_INT)(Unity.TestIgnores));
M
Mark VanderVoord 已提交
1398 1399 1400 1401
    UnityPrint(UnityStrResultsIgnored);
    UNITY_PRINT_EOL();
    if (Unity.TestFailures == 0U)
    {
1402
        UnityPrint(UnityStrOk);
M
Mark VanderVoord 已提交
1403 1404 1405
    }
    else
    {
1406
        UnityPrint(UnityStrFail);
1407 1408 1409
#ifdef UNITY_DIFFERENTIATE_FINAL_FAIL
        UNITY_OUTPUT_CHAR('E'); UNITY_OUTPUT_CHAR('D');
#endif
M
Mark VanderVoord 已提交
1410 1411
    }
    UNITY_PRINT_EOL();
1412
    UNITY_FLUSH_CALL();
M
Mark VanderVoord 已提交
1413 1414 1415 1416
    UNITY_OUTPUT_COMPLETE();
    return (int)(Unity.TestFailures);
}

1417 1418 1419
/*-----------------------------------------------
 * Command Line Argument Support
 *-----------------------------------------------*/
1420
#ifdef UNITY_USE_COMMAND_LINE_ARGS
1421 1422 1423

char* UnityOptionIncludeNamed = NULL;
char* UnityOptionExcludeNamed = NULL;
1424
int UnityVerbosity            = 1;
1425 1426 1427 1428 1429 1430 1431 1432 1433 1434

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

    for (int i = 1; i < argc; i++)
    {
        if (argv[i][0] == '-')
        {
1435
            switch (argv[i][1])
1436 1437
            {
                case 'l': /* list tests */
1438
                    return -1;
1439
                case 'n': /* include tests with name including this string */
1440 1441 1442 1443
                case 'f': /* an alias for -n */
                    if (argv[i][2] == '=')
                        UnityOptionIncludeNamed = &argv[i][3];
                    else if (++i < argc)
1444 1445 1446 1447 1448
                        UnityOptionIncludeNamed = argv[i];
                    else
                    {
                        UnityPrint("ERROR: No Test String to Include Matches For");
                        UNITY_PRINT_EOL();
1449
                        return 1;
1450 1451 1452 1453 1454 1455 1456 1457 1458
                    }
                    break;
                case 'q': /* quiet */
                    UnityVerbosity = 0;
                    break;
                case 'v': /* verbose */
                    UnityVerbosity = 2;
                    break;
                case 'x': /* exclude tests with name including this string */
1459 1460 1461
                    if (argv[i][2] == '=')
                        UnityOptionExcludeNamed = &argv[i][3];
                    else if (++i < argc)
1462 1463 1464 1465 1466
                        UnityOptionExcludeNamed = argv[i];
                    else
                    {
                        UnityPrint("ERROR: No Test String to Exclude Matches For");
                        UNITY_PRINT_EOL();
1467
                        return 1;
1468 1469 1470 1471
                    }
                    break;
                default:
                    UnityPrint("ERROR: Unknown Option ");
1472
                    UNITY_OUTPUT_CHAR(argv[i][1]);
1473 1474 1475 1476 1477 1478 1479 1480 1481
                    UNITY_PRINT_EOL();
                    return 1;
            }
        }
    }

    return 0;
}

1482
int IsStringInBiggerString(const char* longstring, const char* shortstring)
1483
{
1484 1485 1486
    const char* lptr = longstring;
    const char* sptr = shortstring;
    const char* lnext = lptr;
1487

1488 1489 1490
    if (*sptr == '*')
        return 1;

1491 1492 1493
    while (*lptr)
    {
        lnext = lptr + 1;
1494

1495 1496 1497 1498 1499
        /* If they current bytes match, go on to the next bytes */
        while (*lptr && *sptr && (*lptr == *sptr))
        {
            lptr++;
            sptr++;
1500

1501 1502 1503
            /* We're done if we match the entire string or up to a wildcard */
            if (*sptr == '*')
                return 1;
1504 1505 1506 1507 1508 1509 1510 1511
            if (*sptr == ',')
                return 1;
            if (*sptr == '"')
                return 1;
            if (*sptr == '\'')
                return 1;
            if (*sptr == ':')
                return 2;
1512 1513 1514 1515 1516 1517
            if (*sptr == 0)
                return 1;
        }

        /* Otherwise we start in the long pointer 1 character further and try again */
        lptr = lnext;
1518
        sptr = shortstring;
1519 1520
    }
    return 0;
1521 1522 1523 1524
}

int UnityStringArgumentMatches(const char* str)
{
1525 1526 1527
    int retval;
    const char* ptr1;
    const char* ptr2;
1528
    const char* ptrf;
1529

1530
    /* Go through the options and get the substrings for matching one at a time */
1531 1532 1533 1534 1535 1536
    ptr1 = str;
    while (ptr1[0] != 0)
    {
        if ((ptr1[0] == '"') || (ptr1[0] == '\''))
            ptr1++;

1537
        /* look for the start of the next partial */
1538
        ptr2 = ptr1;
1539
        ptrf = 0;
1540 1541
        do
        {
1542
            ptr2++;
1543 1544 1545 1546
            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] == ',')))
1547 1548
            ptr2++;

1549
        /* done if complete filename match */
1550 1551 1552 1553
        retval = IsStringInBiggerString(Unity.TestFile, ptr1);
        if (retval == 1)
            return retval;

1554
        /* done if testname match after filename partial match */
1555
        if ((retval == 2) && (ptrf != 0))
1556
        {
1557
            if (IsStringInBiggerString(Unity.CurrentTestName, ptrf))
1558 1559 1560
                return 1;
        }

1561
        /* done if complete testname match */
1562 1563 1564 1565 1566 1567
        if (IsStringInBiggerString(Unity.CurrentTestName, ptr1) == 1)
            return 1;

        ptr1 = ptr2;
    }

1568
    /* we couldn't find a match for any substrings */
1569
    return 0;
1570
}
1571

1572 1573 1574 1575 1576 1577 1578 1579 1580 1581
int UnityTestMatches(void)
{
    /* Check if this test name matches the included test pattern */
    int retval;
    if (UnityOptionIncludeNamed)
    {
        retval = UnityStringArgumentMatches(UnityOptionIncludeNamed);
    }
    else
        retval = 1;
1582

1583 1584 1585 1586 1587
    /* Check if this test name matches the excluded test pattern */
    if (UnityOptionExcludeNamed)
    {
        if (UnityStringArgumentMatches(UnityOptionExcludeNamed))
            retval = 0;
1588
    }
1589
    return retval;
1590 1591
}

1592
#endif /* UNITY_USE_COMMAND_LINE_ARGS */
1593
/*-----------------------------------------------*/