unity.c 49.7 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; UNITY_OUTPUT_FLUSH(); TEST_ABORT(); }
#define UNITY_IGNORE_AND_BAIL { Unity.CurrentTestIgnored = 1; UNITY_OUTPUT_FLUSH(); 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

K
Kochise 已提交
70
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
71 72 73 74 75 76 77 78
void UnityPrint(const char* string)
{
    const char* pch = string;

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

K
Kochise 已提交
120
/*-----------------------------------------------*/
121
void UnityPrintLen(const char* string, const UNITY_UINT32 length)
M
Mark VanderVoord 已提交
122 123 124 125 126
{
    const char* pch = string;

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

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

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

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

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

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

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

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

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

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

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

263
/*-----------------------------------------------*/
J
jsalling 已提交
264
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
265 266 267 268 269
/* This function prints a floating-point value in a format similar to
 * printf("%.6g").  It can work with either single- or double-precision,
 * but for simplicity, it prints only 6 significant digits in either case.
 * Printing more than 6 digits accurately is hard (at least in the single-
 * precision case) and isn't attempted here. */
270
void UnityPrintFloat(const UNITY_DOUBLE input_number)
M
Mark VanderVoord 已提交
271
{
272
    UNITY_DOUBLE number = input_number;
273

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

281
    /* handle zero, NaN, and +/- infinity */
K
Kochise 已提交
282 283 284 285 286 287 288 289 290 291 292 293
    if (number == 0.0f)
    {
        UnityPrint("0");
    }
    else if (isnan(number))
    {
        UnityPrint("nan");
    }
    else if (isinf(number))
    {
        UnityPrint("inf");
    }
294
    else
J
jsalling 已提交
295
    {
296
        int exponent = 0;
J
John Lindgren 已提交
297 298
        int decimals, digits;
        UNITY_INT32 n;
K
Kyle Krueger 已提交
299
        char buf[16] = {0};
300

301 302 303 304 305 306 307
        /* scale up or down by powers of 10 */
        while (number < 100000.0f / 1e6f)  { number *= 1e6f; exponent -= 6; }
        while (number < 100000.0f)         { number *= 10.0f; exponent--; }
        while (number > 1000000.0f * 1e6f) { number /= 1e6f; exponent += 6; }
        while (number > 1000000.0f)        { number /= 10.0f; exponent++; }

        /* round to nearest integer */
J
John Lindgren 已提交
308
        n = ((UNITY_INT32)(number + number) + 1) / 2;
309
        if (n > 999999)
310
        {
311 312
            n = 100000;
            exponent++;
313 314
        }

315
        /* determine where to place decimal point */
J
John Lindgren 已提交
316
        decimals = (exponent <= 0 && exponent >= -9) ? -exponent : 5;
317 318 319 320
        exponent += decimals;

        /* truncate trailing zeroes after decimal point */
        while (decimals > 0 && n % 10 == 0)
321
        {
322 323 324 325 326
            n /= 10;
            decimals--;
        }

        /* build up buffer in reverse order */
J
John Lindgren 已提交
327
        digits = 0;
328 329 330 331 332 333 334 335 336 337 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
        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]);
            }
364
        }
J
jsalling 已提交
365
    }
M
Mark VanderVoord 已提交
366
}
J
jsalling 已提交
367
#endif /* ! UNITY_EXCLUDE_FLOAT_PRINT */
M
Mark VanderVoord 已提交
368

369
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
370 371 372 373
static void UnityTestResultsBegin(const char* file, const UNITY_LINE_TYPE line)
{
    UnityPrint(file);
    UNITY_OUTPUT_CHAR(':');
374
    UnityPrintNumber((UNITY_INT)line);
M
Mark VanderVoord 已提交
375 376 377 378 379
    UNITY_OUTPUT_CHAR(':');
    UnityPrint(Unity.CurrentTestName);
    UNITY_OUTPUT_CHAR(':');
}

380
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
381 382 383 384 385 386 387
static void UnityTestResultsFailBegin(const UNITY_LINE_TYPE line)
{
    UnityTestResultsBegin(Unity.TestFile, line);
    UnityPrint(UnityStrFail);
    UNITY_OUTPUT_CHAR(':');
}

388
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
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;
407
    UNITY_EXEC_TIME_RESET();
M
Mark VanderVoord 已提交
408
    UNITY_PRINT_EOL();
409
    UNITY_FLUSH_CALL();
M
Mark VanderVoord 已提交
410 411
}

412
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
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);
    }
}

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

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

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

K
Kochise 已提交
495
/*-----------------------------------------------*/
496 497 498 499
static int UnityIsOneArrayNull(UNITY_INTERNAL_PTR expected,
                               UNITY_INTERNAL_PTR actual,
                               const UNITY_LINE_TYPE lineNumber,
                               const char* msg)
M
Mark VanderVoord 已提交
500
{
501
    if (expected == actual) return 0; /* Both are NULL or same pointer */
M
Mark VanderVoord 已提交
502

503
    /* print and return true if just expected is NULL */
M
Mark VanderVoord 已提交
504 505 506 507 508
    if (expected == NULL)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrNullPointerForExpected);
        UnityAddMsgIfSpecified(msg);
509
        return 1;
M
Mark VanderVoord 已提交
510 511
    }

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

521
    return 0; /* return false if neither is NULL */
M
Mark VanderVoord 已提交
522 523
}

524 525 526
/*-----------------------------------------------
 * Assertion Functions
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
527

K
Kochise 已提交
528
/*-----------------------------------------------*/
529 530 531
void UnityAssertBits(const UNITY_INT mask,
                     const UNITY_INT expected,
                     const UNITY_INT actual,
M
Mark VanderVoord 已提交
532 533 534
                     const char* msg,
                     const UNITY_LINE_TYPE lineNumber)
{
535
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
536 537 538 539 540

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

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

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

570
/*-----------------------------------------------*/
571 572 573 574 575 576
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)
577
{
578
    int failed = 0;
579 580
    RETURN_IF_FAIL_OR_IGNORE;

581 582 583 584
    if (threshold == actual && compare & UNITY_EQUAL_TO) return;
    if (threshold == actual) failed = 1;

    if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT)
585
    {
586 587 588 589 590 591 592
        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;
593 594
    }

595
    if (failed)
596 597 598 599
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrExpected);
        UnityPrintNumberByStyle(actual, style);
600 601 602
        if (compare & UNITY_GREATER_THAN) UnityPrint(UnityStrGt);
        if (compare & UNITY_SMALLER_THAN) UnityPrint(UnityStrLt);
        if (compare & UNITY_EQUAL_TO)     UnityPrint(UnityStrOrEqual);
603 604 605 606 607 608
        UnityPrintNumberByStyle(threshold, style);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

609 610 611 612 613 614 615
#define UnityPrintPointlessAndBail()       \
{                                          \
    UnityTestResultsFailBegin(lineNumber); \
    UnityPrint(UnityStrPointless);         \
    UnityAddMsgIfSpecified(msg);           \
    UNITY_FAIL_AND_BAIL; }

616
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
617 618
void UnityAssertEqualIntArray(UNITY_INTERNAL_PTR expected,
                              UNITY_INTERNAL_PTR actual,
619
                              const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
620 621
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
622 623
                              const UNITY_DISPLAY_STYLE_T style,
                              const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
624
{
625
    UNITY_UINT32 elements = num_elements;
626
    unsigned int length   = style & 0xF;
M
Mark VanderVoord 已提交
627

628
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
629

630 631 632 633
    if (num_elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
634

K
Kochise 已提交
635 636 637 638 639
    if (expected == actual)
    {
        return; /* Both are NULL or same pointer */
    }

640
    if (UnityIsOneArrayNull(expected, actual, lineNumber, msg))
K
Kochise 已提交
641
    {
642
        UNITY_FAIL_AND_BAIL;
K
Kochise 已提交
643
    }
M
Mark VanderVoord 已提交
644

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

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

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

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

K
Kochise 已提交
728
/*-----------------------------------------------*/
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);
}

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

747
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
748

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

K
Kochise 已提交
754 755 756 757 758
    if (expected == actual)
    {
        return; /* Both are NULL or same pointer */
    }

759
    if (UnityIsOneArrayNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg))
K
Kochise 已提交
760
    {
761
        UNITY_FAIL_AND_BAIL;
K
Kochise 已提交
762
    }
M
Mark VanderVoord 已提交
763 764 765

    while (elements--)
    {
766
        if (!UnityFloatsWithin(*ptr_expected * UNITY_FLOAT_PRECISION, *ptr_expected, *ptr_actual))
M
Mark VanderVoord 已提交
767 768 769
        {
            UnityTestResultsFailBegin(lineNumber);
            UnityPrint(UnityStrElement);
770
            UnityPrintNumberUnsigned(num_elements - elements - 1);
771
            UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT((UNITY_DOUBLE)*ptr_expected, (UNITY_DOUBLE)*ptr_actual);
M
Mark VanderVoord 已提交
772 773 774
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
775 776 777 778
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
            ptr_expected++;
        }
779
        ptr_actual++;
M
Mark VanderVoord 已提交
780 781 782
    }
}

783
/*-----------------------------------------------*/
784 785 786
void UnityAssertFloatsWithin(const UNITY_FLOAT delta,
                             const UNITY_FLOAT expected,
                             const UNITY_FLOAT actual,
M
Mark VanderVoord 已提交
787 788 789
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber)
{
790
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
791 792


793
    if (!UnityFloatsWithin(delta, expected, actual))
M
Mark VanderVoord 已提交
794 795
    {
        UnityTestResultsFailBegin(lineNumber);
796
        UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT((UNITY_DOUBLE)expected, (UNITY_DOUBLE)actual);
M
Mark VanderVoord 已提交
797 798 799 800 801
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

802
/*-----------------------------------------------*/
803
void UnityAssertFloatSpecial(const UNITY_FLOAT actual,
M
Mark VanderVoord 已提交
804 805 806 807
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber,
                             const UNITY_FLOAT_TRAIT_T style)
{
808 809 810 811
    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 已提交
812

813
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
814

815
    switch (style)
M
Mark VanderVoord 已提交
816 817 818
    {
        case UNITY_FLOAT_IS_INF:
        case UNITY_FLOAT_IS_NOT_INF:
819
            is_trait = isinf(actual) && (actual > 0);
M
Mark VanderVoord 已提交
820 821 822
            break;
        case UNITY_FLOAT_IS_NEG_INF:
        case UNITY_FLOAT_IS_NOT_NEG_INF:
823
            is_trait = isinf(actual) && (actual < 0);
M
Mark VanderVoord 已提交
824 825 826 827
            break;

        case UNITY_FLOAT_IS_NAN:
        case UNITY_FLOAT_IS_NOT_NAN:
828
            is_trait = isnan(actual) ? 1 : 0;
M
Mark VanderVoord 已提交
829 830
            break;

831
        case UNITY_FLOAT_IS_DET: /* A determinate number is non infinite and not NaN. */
M
Mark VanderVoord 已提交
832
        case UNITY_FLOAT_IS_NOT_DET:
833
            is_trait = !isinf(actual) && !isnan(actual);
M
Mark VanderVoord 已提交
834 835 836
            break;

        default:
837 838 839
            trait_index = 0;
            trait_names[0] = UnityStrInvalidFloatTrait;
            break;
M
Mark VanderVoord 已提交
840 841 842 843 844 845 846
    }

    if (is_trait != should_be_trait)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrExpected);
        if (!should_be_trait)
K
Kochise 已提交
847
        {
M
Mark VanderVoord 已提交
848
            UnityPrint(UnityStrNot);
K
Kochise 已提交
849
        }
M
Mark VanderVoord 已提交
850 851
        UnityPrint(trait_names[trait_index]);
        UnityPrint(UnityStrWas);
J
jsalling 已提交
852
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
853
        UnityPrintFloat((UNITY_DOUBLE)actual);
M
Mark VanderVoord 已提交
854 855
#else
        if (should_be_trait)
K
Kochise 已提交
856
        {
M
Mark VanderVoord 已提交
857
            UnityPrint(UnityStrNot);
K
Kochise 已提交
858
        }
M
Mark VanderVoord 已提交
859 860 861 862 863 864 865
        UnityPrint(trait_names[trait_index]);
#endif
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

866
#endif /* not UNITY_EXCLUDE_FLOAT */
M
Mark VanderVoord 已提交
867

868
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
869
#ifndef UNITY_EXCLUDE_DOUBLE
870
static int UnityDoublesWithin(UNITY_DOUBLE delta, UNITY_DOUBLE expected, UNITY_DOUBLE actual)
871
{
872
    UNITY_DOUBLE diff;
873 874 875
    UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff);
}

K
Kochise 已提交
876
/*-----------------------------------------------*/
877 878 879
void UnityAssertEqualDoubleArray(UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* expected,
                                 UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* actual,
                                 const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
880
                                 const char* msg,
881 882
                                 const UNITY_LINE_TYPE lineNumber,
                                 const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
883
{
884
    UNITY_UINT32 elements = num_elements;
885 886
    UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* ptr_expected = expected;
    UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* ptr_actual = actual;
M
Mark VanderVoord 已提交
887

888
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
889

890 891 892 893
    if (elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
894

K
Kochise 已提交
895 896 897 898 899
    if (expected == actual)
    {
        return; /* Both are NULL or same pointer */
    }

900
    if (UnityIsOneArrayNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg))
K
Kochise 已提交
901
    {
902
        UNITY_FAIL_AND_BAIL;
K
Kochise 已提交
903
    }
M
Mark VanderVoord 已提交
904 905 906

    while (elements--)
    {
907
        if (!UnityDoublesWithin(*ptr_expected * UNITY_DOUBLE_PRECISION, *ptr_expected, *ptr_actual))
M
Mark VanderVoord 已提交
908 909 910
        {
            UnityTestResultsFailBegin(lineNumber);
            UnityPrint(UnityStrElement);
911
            UnityPrintNumberUnsigned(num_elements - elements - 1);
912
            UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(*ptr_expected, *ptr_actual);
M
Mark VanderVoord 已提交
913 914 915
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
916 917 918 919
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
            ptr_expected++;
        }
920
        ptr_actual++;
M
Mark VanderVoord 已提交
921 922 923
    }
}

924
/*-----------------------------------------------*/
925 926 927
void UnityAssertDoublesWithin(const UNITY_DOUBLE delta,
                              const UNITY_DOUBLE expected,
                              const UNITY_DOUBLE actual,
M
Mark VanderVoord 已提交
928 929 930
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber)
{
931
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
932

933
    if (!UnityDoublesWithin(delta, expected, actual))
M
Mark VanderVoord 已提交
934 935
    {
        UnityTestResultsFailBegin(lineNumber);
936
        UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual);
M
Mark VanderVoord 已提交
937 938 939 940 941
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

942
/*-----------------------------------------------*/
943
void UnityAssertDoubleSpecial(const UNITY_DOUBLE actual,
M
Mark VanderVoord 已提交
944 945 946 947
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
                              const UNITY_FLOAT_TRAIT_T style)
{
948 949 950 951
    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 已提交
952

953
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
954

955
    switch (style)
M
Mark VanderVoord 已提交
956 957 958
    {
        case UNITY_FLOAT_IS_INF:
        case UNITY_FLOAT_IS_NOT_INF:
959
            is_trait = isinf(actual) && (actual > 0);
M
Mark VanderVoord 已提交
960 961 962
            break;
        case UNITY_FLOAT_IS_NEG_INF:
        case UNITY_FLOAT_IS_NOT_NEG_INF:
963
            is_trait = isinf(actual) && (actual < 0);
M
Mark VanderVoord 已提交
964 965 966 967
            break;

        case UNITY_FLOAT_IS_NAN:
        case UNITY_FLOAT_IS_NOT_NAN:
968
            is_trait = isnan(actual) ? 1 : 0;
M
Mark VanderVoord 已提交
969 970
            break;

971
        case UNITY_FLOAT_IS_DET: /* A determinate number is non infinite and not NaN. */
M
Mark VanderVoord 已提交
972
        case UNITY_FLOAT_IS_NOT_DET:
973
            is_trait = !isinf(actual) && !isnan(actual);
M
Mark VanderVoord 已提交
974 975 976
            break;

        default:
977 978 979
            trait_index = 0;
            trait_names[0] = UnityStrInvalidFloatTrait;
            break;
M
Mark VanderVoord 已提交
980 981 982 983 984 985 986
    }

    if (is_trait != should_be_trait)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrExpected);
        if (!should_be_trait)
K
Kochise 已提交
987
        {
M
Mark VanderVoord 已提交
988
            UnityPrint(UnityStrNot);
K
Kochise 已提交
989
        }
M
Mark VanderVoord 已提交
990 991
        UnityPrint(trait_names[trait_index]);
        UnityPrint(UnityStrWas);
J
jsalling 已提交
992
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
M
Mark VanderVoord 已提交
993 994 995
        UnityPrintFloat(actual);
#else
        if (should_be_trait)
K
Kochise 已提交
996
        {
M
Mark VanderVoord 已提交
997
            UnityPrint(UnityStrNot);
K
Kochise 已提交
998
        }
M
Mark VanderVoord 已提交
999 1000 1001 1002 1003 1004 1005
        UnityPrint(trait_names[trait_index]);
#endif
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

1006
#endif /* not UNITY_EXCLUDE_DOUBLE */
M
Mark VanderVoord 已提交
1007

1008
/*-----------------------------------------------*/
1009 1010 1011 1012 1013 1014
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 已提交
1015
{
1016
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1017 1018 1019 1020

    if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT)
    {
        if (actual > expected)
K
Kochise 已提交
1021
        {
1022
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(actual - expected) > delta);
K
Kochise 已提交
1023
        }
M
Mark VanderVoord 已提交
1024
        else
K
Kochise 已提交
1025
        {
M
Max Bruckner 已提交
1026
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(expected - actual) > delta);
K
Kochise 已提交
1027
        }
M
Mark VanderVoord 已提交
1028 1029 1030
    }
    else
    {
1031
        if ((UNITY_UINT)actual > (UNITY_UINT)expected)
K
Kochise 已提交
1032
        {
M
Max Bruckner 已提交
1033
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(actual - expected) > delta);
K
Kochise 已提交
1034
        }
M
Mark VanderVoord 已提交
1035
        else
K
Kochise 已提交
1036
        {
M
Max Bruckner 已提交
1037
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(expected - actual) > delta);
K
Kochise 已提交
1038
        }
M
Mark VanderVoord 已提交
1039 1040 1041 1042 1043 1044
    }

    if (Unity.CurrentTestFailed)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrDelta);
1045
        UnityPrintNumberByStyle((UNITY_INT)delta, style);
M
Mark VanderVoord 已提交
1046 1047 1048 1049 1050 1051 1052 1053 1054
        UnityPrint(UnityStrExpected);
        UnityPrintNumberByStyle(expected, style);
        UnityPrint(UnityStrWas);
        UnityPrintNumberByStyle(actual, style);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

1055
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1056 1057 1058 1059 1060
void UnityAssertEqualString(const char* expected,
                            const char* actual,
                            const char* msg,
                            const UNITY_LINE_TYPE lineNumber)
{
1061
    UNITY_UINT32 i;
M
Mark VanderVoord 已提交
1062

1063
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1064

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

    if (Unity.CurrentTestFailed)
    {
1087 1088 1089 1090
        UnityTestResultsFailBegin(lineNumber);
        UnityPrintExpectedAndActualStrings(expected, actual);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
1091 1092 1093
    }
}

1094
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1095
void UnityAssertEqualStringLen(const char* expected,
1096 1097 1098 1099
                               const char* actual,
                               const UNITY_UINT32 length,
                               const char* msg,
                               const UNITY_LINE_TYPE lineNumber)
M
Mark VanderVoord 已提交
1100
{
1101
    UNITY_UINT32 i;
M
Mark VanderVoord 已提交
1102

1103
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1104

1105
    /* if both pointers not null compare the strings */
M
Mark VanderVoord 已提交
1106 1107
    if (expected && actual)
    {
1108
        for (i = 0; (i < length) && (expected[i] || actual[i]); i++)
M
Mark VanderVoord 已提交
1109 1110 1111 1112 1113 1114 1115 1116 1117
        {
            if (expected[i] != actual[i])
            {
                Unity.CurrentTestFailed = 1;
                break;
            }
        }
    }
    else
1118
    { /* handle case of one pointers being null (if both null, test should pass) */
M
Mark VanderVoord 已提交
1119 1120 1121 1122 1123 1124 1125 1126
        if (expected != actual)
        {
            Unity.CurrentTestFailed = 1;
        }
    }

    if (Unity.CurrentTestFailed)
    {
1127 1128 1129 1130
        UnityTestResultsFailBegin(lineNumber);
        UnityPrintExpectedAndActualStringsLen(expected, actual, length);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
1131 1132 1133
    }
}

1134
/*-----------------------------------------------*/
1135
void UnityAssertEqualStringArray(UNITY_INTERNAL_PTR expected,
1136 1137 1138
                                 const char** actual,
                                 const UNITY_UINT32 num_elements,
                                 const char* msg,
1139 1140
                                 const UNITY_LINE_TYPE lineNumber,
                                 const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
1141
{
1142 1143
    UNITY_UINT32 i = 0;
    UNITY_UINT32 j = 0;
1144
    const char* expd = NULL;
1145
    const char* act = NULL;
M
Mark VanderVoord 已提交
1146

1147
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1148

1149
    /* if no elements, it's an error */
1150 1151 1152 1153
    if (num_elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
1154

1155
    if ((const void*)expected == (const void*)actual)
1156 1157 1158 1159
    {
        return; /* Both are NULL or same pointer */
    }

1160
    if (UnityIsOneArrayNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg))
1161
    {
1162
        UNITY_FAIL_AND_BAIL;
1163 1164 1165 1166
    }

    if (flags != UNITY_ARRAY_TO_ARRAY)
    {
1167
        expd = (const char*)expected;
1168
    }
M
Mark VanderVoord 已提交
1169 1170 1171

    do
    {
1172 1173 1174
        act = actual[j];
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
1175
            expd = ((const char* const*)expected)[j];
1176 1177
        }

1178
        /* if both pointers not null compare the strings */
1179
        if (expd && act)
M
Mark VanderVoord 已提交
1180
        {
1181
            for (i = 0; expd[i] || act[i]; i++)
M
Mark VanderVoord 已提交
1182
            {
1183
                if (expd[i] != act[i])
M
Mark VanderVoord 已提交
1184 1185 1186 1187 1188 1189 1190
                {
                    Unity.CurrentTestFailed = 1;
                    break;
                }
            }
        }
        else
1191
        { /* handle case of one pointers being null (if both null, test should pass) */
1192
            if (expd != act)
M
Mark VanderVoord 已提交
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203
            {
                Unity.CurrentTestFailed = 1;
            }
        }

        if (Unity.CurrentTestFailed)
        {
            UnityTestResultsFailBegin(lineNumber);
            if (num_elements > 1)
            {
                UnityPrint(UnityStrElement);
1204
                UnityPrintNumberUnsigned(j);
M
Mark VanderVoord 已提交
1205
            }
1206
            UnityPrintExpectedAndActualStrings(expd, act);
M
Mark VanderVoord 已提交
1207 1208 1209 1210 1211 1212
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
    } while (++j < num_elements);
}

1213
/*-----------------------------------------------*/
1214 1215 1216 1217 1218
void UnityAssertEqualMemory(UNITY_INTERNAL_PTR expected,
                            UNITY_INTERNAL_PTR actual,
                            const UNITY_UINT32 length,
                            const UNITY_UINT32 num_elements,
                            const char* msg,
1219 1220
                            const UNITY_LINE_TYPE lineNumber,
                            const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
1221 1222 1223
{
    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;
1224 1225
    UNITY_UINT32 elements = num_elements;
    UNITY_UINT32 bytes;
M
Mark VanderVoord 已提交
1226

1227
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1228

1229 1230 1231 1232
    if ((elements == 0) || (length == 0))
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
1233

K
Kochise 已提交
1234 1235 1236 1237 1238
    if (expected == actual)
    {
        return; /* Both are NULL or same pointer */
    }

1239
    if (UnityIsOneArrayNull(expected, actual, lineNumber, msg))
K
Kochise 已提交
1240
    {
1241
        UNITY_FAIL_AND_BAIL;
K
Kochise 已提交
1242
    }
M
Mark VanderVoord 已提交
1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255

    while (elements--)
    {
        bytes = length;
        while (bytes--)
        {
            if (*ptr_exp != *ptr_act)
            {
                UnityTestResultsFailBegin(lineNumber);
                UnityPrint(UnityStrMemory);
                if (num_elements > 1)
                {
                    UnityPrint(UnityStrElement);
1256
                    UnityPrintNumberUnsigned(num_elements - elements - 1);
M
Mark VanderVoord 已提交
1257 1258
                }
                UnityPrint(UnityStrByte);
1259
                UnityPrintNumberUnsigned(length - bytes - 1);
M
Mark VanderVoord 已提交
1260 1261 1262 1263 1264 1265 1266
                UnityPrint(UnityStrExpected);
                UnityPrintNumberByStyle(*ptr_exp, UNITY_DISPLAY_STYLE_HEX8);
                UnityPrint(UnityStrWas);
                UnityPrintNumberByStyle(*ptr_act, UNITY_DISPLAY_STYLE_HEX8);
                UnityAddMsgIfSpecified(msg);
                UNITY_FAIL_AND_BAIL;
            }
1267 1268
            ptr_exp++;
            ptr_act++;
M
Mark VanderVoord 已提交
1269
        }
1270 1271 1272 1273
        if (flags == UNITY_ARRAY_TO_VAL)
        {
            ptr_exp = (UNITY_PTR_ATTRIBUTE const unsigned char*)expected;
        }
M
Mark VanderVoord 已提交
1274 1275 1276
    }
}

1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
/*-----------------------------------------------*/

static union
{
    UNITY_INT8 i8;
    UNITY_INT16 i16;
    UNITY_INT32 i32;
#ifdef UNITY_SUPPORT_64
    UNITY_INT64 i64;
#endif
1287 1288 1289 1290 1291 1292
#ifndef UNITY_EXCLUDE_FLOAT
    float f;
#endif
#ifndef UNITY_EXCLUDE_DOUBLE
    double d;
#endif
1293 1294 1295 1296 1297 1298 1299
} UnityQuickCompare;

UNITY_INTERNAL_PTR UnityNumToPtr(const UNITY_INT num, const UNITY_UINT8 size)
{
    switch(size)
    {
        case 1:
1300
          UnityQuickCompare.i8 = (UNITY_INT8)num;
1301 1302 1303
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i8);

        case 2:
1304
          UnityQuickCompare.i16 = (UNITY_INT16)num;
1305 1306 1307 1308
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i16);

#ifdef UNITY_SUPPORT_64
        case 8:
1309
          UnityQuickCompare.i64 = (UNITY_INT64)num;
1310 1311
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i64);
#endif
1312
        default: /* 4 bytes */
1313
          UnityQuickCompare.i32 = (UNITY_INT32)num;
1314 1315 1316 1317
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i32);
    }
}

1318
#ifndef UNITY_EXCLUDE_FLOAT
K
Kochise 已提交
1319
/*-----------------------------------------------*/
1320 1321 1322 1323 1324 1325 1326 1327
UNITY_INTERNAL_PTR UnityFloatToPtr(const float num)
{
    UnityQuickCompare.f = num;
    return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.f);
}
#endif

#ifndef UNITY_EXCLUDE_DOUBLE
K
Kochise 已提交
1328
/*-----------------------------------------------*/
1329 1330 1331 1332 1333 1334 1335
UNITY_INTERNAL_PTR UnityDoubleToPtr(const double num)
{
    UnityQuickCompare.d = num;
    return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.d);
}
#endif

1336 1337 1338
/*-----------------------------------------------
 * Control Functions
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
1339

K
Kochise 已提交
1340
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1341 1342
void UnityFail(const char* msg, const UNITY_LINE_TYPE line)
{
1343
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1344 1345

    UnityTestResultsBegin(Unity.TestFile, line);
1346
    UnityPrint(UnityStrFail);
M
Mark VanderVoord 已提交
1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
    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;
}

1374
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1375 1376
void UnityIgnore(const char* msg, const UNITY_LINE_TYPE line)
{
1377
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1378 1379 1380 1381 1382

    UnityTestResultsBegin(Unity.TestFile, line);
    UnityPrint(UnityStrIgnore);
    if (msg != NULL)
    {
1383 1384 1385
        UNITY_OUTPUT_CHAR(':');
        UNITY_OUTPUT_CHAR(' ');
        UnityPrint(msg);
M
Mark VanderVoord 已提交
1386 1387 1388 1389
    }
    UNITY_IGNORE_AND_BAIL;
}

1390
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
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();
    }
1402
    if (TEST_PROTECT())
M
Mark VanderVoord 已提交
1403 1404 1405 1406 1407 1408
    {
        tearDown();
    }
    UnityConcludeTest();
}

1409
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1410 1411 1412 1413 1414 1415 1416 1417 1418 1419
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;
1420
    UNITY_EXEC_TIME_RESET();
M
Mark VanderVoord 已提交
1421 1422 1423 1424 1425

    UNITY_CLR_DETAILS();
    UNITY_OUTPUT_START();
}

1426
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1427 1428 1429 1430 1431
int UnityEnd(void)
{
    UNITY_PRINT_EOL();
    UnityPrint(UnityStrBreaker);
    UNITY_PRINT_EOL();
1432
    UnityPrintNumber((UNITY_INT)(Unity.NumberOfTests));
M
Mark VanderVoord 已提交
1433
    UnityPrint(UnityStrResultsTests);
1434
    UnityPrintNumber((UNITY_INT)(Unity.TestFailures));
M
Mark VanderVoord 已提交
1435
    UnityPrint(UnityStrResultsFailures);
1436
    UnityPrintNumber((UNITY_INT)(Unity.TestIgnores));
M
Mark VanderVoord 已提交
1437 1438 1439 1440
    UnityPrint(UnityStrResultsIgnored);
    UNITY_PRINT_EOL();
    if (Unity.TestFailures == 0U)
    {
1441
        UnityPrint(UnityStrOk);
M
Mark VanderVoord 已提交
1442 1443 1444
    }
    else
    {
1445
        UnityPrint(UnityStrFail);
1446 1447 1448
#ifdef UNITY_DIFFERENTIATE_FINAL_FAIL
        UNITY_OUTPUT_CHAR('E'); UNITY_OUTPUT_CHAR('D');
#endif
M
Mark VanderVoord 已提交
1449 1450
    }
    UNITY_PRINT_EOL();
1451
    UNITY_FLUSH_CALL();
M
Mark VanderVoord 已提交
1452 1453 1454 1455
    UNITY_OUTPUT_COMPLETE();
    return (int)(Unity.TestFailures);
}

1456 1457 1458
/*-----------------------------------------------
 * Command Line Argument Support
 *-----------------------------------------------*/
1459
#ifdef UNITY_USE_COMMAND_LINE_ARGS
1460 1461 1462

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

K
Kochise 已提交
1465
/*-----------------------------------------------*/
1466 1467 1468 1469 1470 1471 1472 1473 1474
int UnityParseOptions(int argc, char** argv)
{
    UnityOptionIncludeNamed = NULL;
    UnityOptionExcludeNamed = NULL;

    for (int i = 1; i < argc; i++)
    {
        if (argv[i][0] == '-')
        {
1475
            switch (argv[i][1])
1476 1477
            {
                case 'l': /* list tests */
1478
                    return -1;
1479
                case 'n': /* include tests with name including this string */
1480 1481
                case 'f': /* an alias for -n */
                    if (argv[i][2] == '=')
K
Kochise 已提交
1482
                    {
1483
                        UnityOptionIncludeNamed = &argv[i][3];
K
Kochise 已提交
1484
                    }
1485
                    else if (++i < argc)
K
Kochise 已提交
1486
                    {
1487
                        UnityOptionIncludeNamed = argv[i];
K
Kochise 已提交
1488
                    }
1489 1490 1491 1492
                    else
                    {
                        UnityPrint("ERROR: No Test String to Include Matches For");
                        UNITY_PRINT_EOL();
1493
                        return 1;
1494 1495 1496 1497 1498 1499 1500 1501 1502
                    }
                    break;
                case 'q': /* quiet */
                    UnityVerbosity = 0;
                    break;
                case 'v': /* verbose */
                    UnityVerbosity = 2;
                    break;
                case 'x': /* exclude tests with name including this string */
1503
                    if (argv[i][2] == '=')
K
Kochise 已提交
1504
                    {
1505
                        UnityOptionExcludeNamed = &argv[i][3];
K
Kochise 已提交
1506
                    }
1507
                    else if (++i < argc)
K
Kochise 已提交
1508
                    {
1509
                        UnityOptionExcludeNamed = argv[i];
K
Kochise 已提交
1510
                    }
1511 1512 1513 1514
                    else
                    {
                        UnityPrint("ERROR: No Test String to Exclude Matches For");
                        UNITY_PRINT_EOL();
1515
                        return 1;
1516 1517 1518 1519
                    }
                    break;
                default:
                    UnityPrint("ERROR: Unknown Option ");
1520
                    UNITY_OUTPUT_CHAR(argv[i][1]);
1521 1522 1523 1524 1525 1526 1527 1528 1529
                    UNITY_PRINT_EOL();
                    return 1;
            }
        }
    }

    return 0;
}

K
Kochise 已提交
1530
/*-----------------------------------------------*/
1531
int IsStringInBiggerString(const char* longstring, const char* shortstring)
1532
{
1533 1534 1535
    const char* lptr = longstring;
    const char* sptr = shortstring;
    const char* lnext = lptr;
1536

1537
    if (*sptr == '*')
K
Kochise 已提交
1538
    {
1539
        return 1;
K
Kochise 已提交
1540
    }
1541

1542 1543 1544
    while (*lptr)
    {
        lnext = lptr + 1;
1545

1546 1547 1548 1549 1550
        /* If they current bytes match, go on to the next bytes */
        while (*lptr && *sptr && (*lptr == *sptr))
        {
            lptr++;
            sptr++;
1551

1552 1553 1554
            /* We're done if we match the entire string or up to a wildcard */
            if (*sptr == '*')
                return 1;
1555 1556 1557 1558 1559 1560 1561 1562
            if (*sptr == ',')
                return 1;
            if (*sptr == '"')
                return 1;
            if (*sptr == '\'')
                return 1;
            if (*sptr == ':')
                return 2;
1563 1564 1565 1566 1567 1568
            if (*sptr == 0)
                return 1;
        }

        /* Otherwise we start in the long pointer 1 character further and try again */
        lptr = lnext;
1569
        sptr = shortstring;
1570
    }
K
Kochise 已提交
1571

1572
    return 0;
1573 1574
}

K
Kochise 已提交
1575
/*-----------------------------------------------*/
1576 1577
int UnityStringArgumentMatches(const char* str)
{
1578 1579 1580
    int retval;
    const char* ptr1;
    const char* ptr2;
1581
    const char* ptrf;
1582

1583
    /* Go through the options and get the substrings for matching one at a time */
1584 1585 1586 1587
    ptr1 = str;
    while (ptr1[0] != 0)
    {
        if ((ptr1[0] == '"') || (ptr1[0] == '\''))
K
Kochise 已提交
1588
        {
1589
            ptr1++;
K
Kochise 已提交
1590
        }
1591

1592
        /* look for the start of the next partial */
1593
        ptr2 = ptr1;
1594
        ptrf = 0;
1595 1596
        do
        {
1597
            ptr2++;
1598
            if ((ptr2[0] == ':') && (ptr2[1] != 0) && (ptr2[0] != '\'') && (ptr2[0] != '"') && (ptr2[0] != ','))
K
Kochise 已提交
1599
            {
1600
                ptrf = &ptr2[1];
K
Kochise 已提交
1601
            }
1602
        } while ((ptr2[0] != 0) && (ptr2[0] != '\'') && (ptr2[0] != '"') && (ptr2[0] != ','));
K
Kochise 已提交
1603

1604
        while ((ptr2[0] != 0) && ((ptr2[0] == ':') || (ptr2[0] == '\'') || (ptr2[0] == '"') || (ptr2[0] == ',')))
K
Kochise 已提交
1605
        {
1606
            ptr2++;
K
Kochise 已提交
1607
        }
1608

1609
        /* done if complete filename match */
1610 1611
        retval = IsStringInBiggerString(Unity.TestFile, ptr1);
        if (retval == 1)
K
Kochise 已提交
1612
        {
1613
            return retval;
K
Kochise 已提交
1614
        }
1615

1616
        /* done if testname match after filename partial match */
1617
        if ((retval == 2) && (ptrf != 0))
1618
        {
1619
            if (IsStringInBiggerString(Unity.CurrentTestName, ptrf))
K
Kochise 已提交
1620
            {
1621
                return 1;
K
Kochise 已提交
1622
            }
1623 1624
        }

1625
        /* done if complete testname match */
1626
        if (IsStringInBiggerString(Unity.CurrentTestName, ptr1) == 1)
K
Kochise 已提交
1627
        {
1628
            return 1;
K
Kochise 已提交
1629
        }
1630 1631 1632 1633

        ptr1 = ptr2;
    }

1634
    /* we couldn't find a match for any substrings */
1635
    return 0;
1636
}
1637

K
Kochise 已提交
1638
/*-----------------------------------------------*/
1639 1640 1641 1642 1643 1644 1645 1646 1647
int UnityTestMatches(void)
{
    /* Check if this test name matches the included test pattern */
    int retval;
    if (UnityOptionIncludeNamed)
    {
        retval = UnityStringArgumentMatches(UnityOptionIncludeNamed);
    }
    else
K
Kochise 已提交
1648
    {
1649
        retval = 1;
K
Kochise 已提交
1650
    }
1651

1652 1653 1654 1655
    /* Check if this test name matches the excluded test pattern */
    if (UnityOptionExcludeNamed)
    {
        if (UnityStringArgumentMatches(UnityOptionExcludeNamed))
K
Kochise 已提交
1656
        {
1657
            retval = 0;
K
Kochise 已提交
1658
        }
1659
    }
K
Kochise 已提交
1660

1661
    return retval;
1662 1663
}

1664
#endif /* UNITY_USE_COMMAND_LINE_ARGS */
1665
/*-----------------------------------------------*/