unity.c 48.2 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
/* 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. */
266
void UnityPrintFloat(const UNITY_DOUBLE input_number)
M
Mark VanderVoord 已提交
267
{
268
    UNITY_DOUBLE number = input_number;
269

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

277 278 279 280 281
    /* 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 已提交
282
    {
283
        int exponent = 0;
J
John Lindgren 已提交
284 285 286
        int decimals, digits;
        UNITY_INT32 n;
        char buf[16];
287

288 289 290 291 292 293 294
        /* 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 已提交
295
        n = ((UNITY_INT32)(number + number) + 1) / 2;
296
        if (n > 999999)
297
        {
298 299
            n = 100000;
            exponent++;
300 301
        }

302
        /* determine where to place decimal point */
J
John Lindgren 已提交
303
        decimals = (exponent <= 0 && exponent >= -9) ? -exponent : 5;
304 305 306 307
        exponent += decimals;

        /* truncate trailing zeroes after decimal point */
        while (decimals > 0 && n % 10 == 0)
308
        {
309 310 311 312 313
            n /= 10;
            decimals--;
        }

        /* build up buffer in reverse order */
J
John Lindgren 已提交
314
        digits = 0;
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
        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]);
            }
351
        }
J
jsalling 已提交
352
    }
M
Mark VanderVoord 已提交
353
}
J
jsalling 已提交
354
#endif /* ! UNITY_EXCLUDE_FLOAT_PRINT */
M
Mark VanderVoord 已提交
355

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

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

375
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
void UnityConcludeTest(void)
{
    if (Unity.CurrentTestIgnored)
    {
        Unity.TestIgnores++;
    }
    else if (!Unity.CurrentTestFailed)
    {
        UnityTestResultsBegin(Unity.TestFile, Unity.CurrentTestLineNumber);
        UnityPrint(UnityStrPass);
    }
    else
    {
        Unity.TestFailures++;
    }

    Unity.CurrentTestFailed = 0;
    Unity.CurrentTestIgnored = 0;
    UNITY_PRINT_EOL();
395
    UNITY_FLUSH_CALL();
M
Mark VanderVoord 已提交
396 397
}

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

421
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
422 423 424 425 426 427 428 429 430 431 432
static void UnityPrintExpectedAndActualStrings(const char* expected, const char* actual)
{
    UnityPrint(UnityStrExpected);
    if (expected != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrint(expected);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
433
        UnityPrint(UnityStrNull);
M
Mark VanderVoord 已提交
434 435 436 437 438 439 440 441 442 443
    }
    UnityPrint(UnityStrWas);
    if (actual != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrint(actual);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
444
        UnityPrint(UnityStrNull);
M
Mark VanderVoord 已提交
445 446 447
    }
}

448
/*-----------------------------------------------*/
449 450 451
static void UnityPrintExpectedAndActualStringsLen(const char* expected,
                                                  const char* actual,
                                                  const UNITY_UINT32 length)
M
Mark VanderVoord 已提交
452 453 454 455 456 457 458 459 460 461
{
    UnityPrint(UnityStrExpected);
    if (expected != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrintLen(expected, length);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
462
        UnityPrint(UnityStrNull);
M
Mark VanderVoord 已提交
463 464 465 466 467 468 469 470 471 472
    }
    UnityPrint(UnityStrWas);
    if (actual != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrintLen(actual, length);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
473
        UnityPrint(UnityStrNull);
M
Mark VanderVoord 已提交
474 475 476
    }
}

477 478 479
/*-----------------------------------------------
 * Assertion & Control Helpers
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
480

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

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

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

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

509 510 511
/*-----------------------------------------------
 * Assertion Functions
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
512

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

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

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

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

554
/*-----------------------------------------------*/
555 556 557 558 559 560
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)
561
{
562
    int failed = 0;
563 564
    RETURN_IF_FAIL_OR_IGNORE;

565 566 567 568
    if (threshold == actual && compare & UNITY_EQUAL_TO) return;
    if (threshold == actual) failed = 1;

    if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT)
569
    {
570 571 572 573 574 575 576
        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;
577 578
    }

579
    if (failed)
580 581 582 583
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrExpected);
        UnityPrintNumberByStyle(actual, style);
584 585 586
        if (compare & UNITY_GREATER_THAN) UnityPrint(UnityStrGt);
        if (compare & UNITY_SMALLER_THAN) UnityPrint(UnityStrLt);
        if (compare & UNITY_EQUAL_TO)     UnityPrint(UnityStrOrEqual);
587 588 589 590 591 592
        UnityPrintNumberByStyle(threshold, style);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

593 594 595 596 597 598 599
#define UnityPrintPointlessAndBail()       \
{                                          \
    UnityTestResultsFailBegin(lineNumber); \
    UnityPrint(UnityStrPointless);         \
    UnityAddMsgIfSpecified(msg);           \
    UNITY_FAIL_AND_BAIL; }

600
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
601 602
void UnityAssertEqualIntArray(UNITY_INTERNAL_PTR expected,
                              UNITY_INTERNAL_PTR actual,
603
                              const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
604 605
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
606 607
                              const UNITY_DISPLAY_STYLE_T style,
                              const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
608
{
609
    UNITY_UINT32 elements = num_elements;
610
    unsigned int length   = style & 0xF;
M
Mark VanderVoord 已提交
611

612
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
613

614 615 616 617
    if (num_elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
618

619 620 621
    if (expected == actual) return; /* Both are NULL or same pointer */
    if (UnityIsOneArrayNull(expected, actual, lineNumber, msg))
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
622

623
    while ((elements > 0) && elements--)
M
Mark VanderVoord 已提交
624
    {
625 626
        UNITY_INT expect_val;
        UNITY_INT actual_val;
627 628 629 630 631 632 633 634 635 636
        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 已提交
637
#ifdef UNITY_SUPPORT_64
638 639 640 641
            case 8:
                expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)expected;
                actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)actual;
                break;
M
Mark VanderVoord 已提交
642
#endif
643 644 645 646 647
            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;
648 649 650 651
        }

        if (expect_val != actual_val)
        {
652
            if (style & UNITY_DISPLAY_RANGE_UINT && length < sizeof(expect_val))
653 654 655 656 657 658
            {   /* 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;
            }
659 660 661 662 663 664 665 666 667 668
            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;
        }
669 670 671 672
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
            expected = (UNITY_INTERNAL_PTR)(length + (const char*)expected);
        }
673
        actual   = (UNITY_INTERNAL_PTR)(length + (const char*)actual);
M
Mark VanderVoord 已提交
674 675 676
    }
}

677
/*-----------------------------------------------*/
678
#ifndef UNITY_EXCLUDE_FLOAT
679
/* Wrap this define in a function with variable types as float or double */
680 681 682 683 684 685 686
#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)))
687
    /* This first part of this condition will catch any NaN or Infinite values */
688 689 690 691 692
#ifndef UNITY_NAN_NOT_EQUAL_NAN
  #define UNITY_NAN_CHECK isnan(expected) && isnan(actual)
#else
  #define UNITY_NAN_CHECK 0
#endif
693

694 695
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
  #define UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual) \
696
  {                                                               \
697 698 699
    UnityPrint(UnityStrExpected);                                 \
    UnityPrintFloat(expected);                                    \
    UnityPrint(UnityStrWas);                                      \
700
    UnityPrintFloat(actual); }
701 702 703 704 705
#else
  #define UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual) \
    UnityPrint(UnityStrDelta)
#endif /* UNITY_EXCLUDE_FLOAT_PRINT */

706
static int UnityFloatsWithin(UNITY_FLOAT delta, UNITY_FLOAT expected, UNITY_FLOAT actual)
707
{
708
    UNITY_FLOAT diff;
709 710 711
    UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff);
}

712 713 714
void UnityAssertEqualFloatArray(UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* expected,
                                UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* actual,
                                const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
715
                                const char* msg,
716 717
                                const UNITY_LINE_TYPE lineNumber,
                                const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
718
{
719
    UNITY_UINT32 elements = num_elements;
720 721
    UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* ptr_expected = expected;
    UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* ptr_actual = actual;
M
Mark VanderVoord 已提交
722

723
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
724

725 726 727 728
    if (elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
729

730 731 732
    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 已提交
733 734 735

    while (elements--)
    {
736
        if (!UnityFloatsWithin(*ptr_expected * UNITY_FLOAT_PRECISION, *ptr_expected, *ptr_actual))
M
Mark VanderVoord 已提交
737 738 739
        {
            UnityTestResultsFailBegin(lineNumber);
            UnityPrint(UnityStrElement);
740
            UnityPrintNumberUnsigned(num_elements - elements - 1);
741
            UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT((UNITY_DOUBLE)*ptr_expected, (UNITY_DOUBLE)*ptr_actual);
M
Mark VanderVoord 已提交
742 743 744
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
745 746 747 748
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
            ptr_expected++;
        }
749
        ptr_actual++;
M
Mark VanderVoord 已提交
750 751 752
    }
}

753
/*-----------------------------------------------*/
754 755 756
void UnityAssertFloatsWithin(const UNITY_FLOAT delta,
                             const UNITY_FLOAT expected,
                             const UNITY_FLOAT actual,
M
Mark VanderVoord 已提交
757 758 759
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber)
{
760
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
761 762


763
    if (!UnityFloatsWithin(delta, expected, actual))
M
Mark VanderVoord 已提交
764 765
    {
        UnityTestResultsFailBegin(lineNumber);
766
        UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT((UNITY_DOUBLE)expected, (UNITY_DOUBLE)actual);
M
Mark VanderVoord 已提交
767 768 769 770 771
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

772
/*-----------------------------------------------*/
773
void UnityAssertFloatSpecial(const UNITY_FLOAT actual,
M
Mark VanderVoord 已提交
774 775 776 777
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber,
                             const UNITY_FLOAT_TRAIT_T style)
{
778 779 780 781
    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 已提交
782

783
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
784

785
    switch (style)
M
Mark VanderVoord 已提交
786 787 788
    {
        case UNITY_FLOAT_IS_INF:
        case UNITY_FLOAT_IS_NOT_INF:
789
            is_trait = isinf(actual) && (actual > 0);
M
Mark VanderVoord 已提交
790 791 792
            break;
        case UNITY_FLOAT_IS_NEG_INF:
        case UNITY_FLOAT_IS_NOT_NEG_INF:
793
            is_trait = isinf(actual) && (actual < 0);
M
Mark VanderVoord 已提交
794 795 796 797
            break;

        case UNITY_FLOAT_IS_NAN:
        case UNITY_FLOAT_IS_NOT_NAN:
798
            is_trait = isnan(actual) ? 1 : 0;
M
Mark VanderVoord 已提交
799 800
            break;

801
        case UNITY_FLOAT_IS_DET: /* A determinate number is non infinite and not NaN. */
M
Mark VanderVoord 已提交
802
        case UNITY_FLOAT_IS_NOT_DET:
803
            is_trait = !isinf(actual) && !isnan(actual);
M
Mark VanderVoord 已提交
804 805 806
            break;

        default:
807 808 809
            trait_index = 0;
            trait_names[0] = UnityStrInvalidFloatTrait;
            break;
M
Mark VanderVoord 已提交
810 811 812 813 814 815 816 817 818 819
    }

    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 已提交
820
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
821
        UnityPrintFloat((UNITY_DOUBLE)actual);
M
Mark VanderVoord 已提交
822 823 824 825 826 827 828 829 830 831
#else
        if (should_be_trait)
            UnityPrint(UnityStrNot);
        UnityPrint(trait_names[trait_index]);
#endif
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

832
#endif /* not UNITY_EXCLUDE_FLOAT */
M
Mark VanderVoord 已提交
833

834
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
835
#ifndef UNITY_EXCLUDE_DOUBLE
836
static int UnityDoublesWithin(UNITY_DOUBLE delta, UNITY_DOUBLE expected, UNITY_DOUBLE actual)
837
{
838
    UNITY_DOUBLE diff;
839 840 841
    UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff);
}

842 843 844
void UnityAssertEqualDoubleArray(UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* expected,
                                 UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* actual,
                                 const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
845
                                 const char* msg,
846 847
                                 const UNITY_LINE_TYPE lineNumber,
                                 const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
848
{
849
    UNITY_UINT32 elements = num_elements;
850 851
    UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* ptr_expected = expected;
    UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* ptr_actual = actual;
M
Mark VanderVoord 已提交
852

853
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
854

855 856 857 858
    if (elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
859

860 861 862
    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 已提交
863 864 865

    while (elements--)
    {
866
        if (!UnityDoublesWithin(*ptr_expected * UNITY_DOUBLE_PRECISION, *ptr_expected, *ptr_actual))
M
Mark VanderVoord 已提交
867 868 869
        {
            UnityTestResultsFailBegin(lineNumber);
            UnityPrint(UnityStrElement);
870
            UnityPrintNumberUnsigned(num_elements - elements - 1);
871
            UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(*ptr_expected, *ptr_actual);
M
Mark VanderVoord 已提交
872 873 874
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
875 876 877 878
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
            ptr_expected++;
        }
879
        ptr_actual++;
M
Mark VanderVoord 已提交
880 881 882
    }
}

883
/*-----------------------------------------------*/
884 885 886
void UnityAssertDoublesWithin(const UNITY_DOUBLE delta,
                              const UNITY_DOUBLE expected,
                              const UNITY_DOUBLE actual,
M
Mark VanderVoord 已提交
887 888 889
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber)
{
890
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
891

892
    if (!UnityDoublesWithin(delta, expected, actual))
M
Mark VanderVoord 已提交
893 894
    {
        UnityTestResultsFailBegin(lineNumber);
895
        UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual);
M
Mark VanderVoord 已提交
896 897 898 899 900
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

901
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
902

903
void UnityAssertDoubleSpecial(const UNITY_DOUBLE actual,
M
Mark VanderVoord 已提交
904 905 906 907
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
                              const UNITY_FLOAT_TRAIT_T style)
{
908 909 910 911
    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 已提交
912

913
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
914

915
    switch (style)
M
Mark VanderVoord 已提交
916 917 918
    {
        case UNITY_FLOAT_IS_INF:
        case UNITY_FLOAT_IS_NOT_INF:
919
            is_trait = isinf(actual) && (actual > 0);
M
Mark VanderVoord 已提交
920 921 922
            break;
        case UNITY_FLOAT_IS_NEG_INF:
        case UNITY_FLOAT_IS_NOT_NEG_INF:
923
            is_trait = isinf(actual) && (actual < 0);
M
Mark VanderVoord 已提交
924 925 926 927
            break;

        case UNITY_FLOAT_IS_NAN:
        case UNITY_FLOAT_IS_NOT_NAN:
928
            is_trait = isnan(actual) ? 1 : 0;
M
Mark VanderVoord 已提交
929 930
            break;

931
        case UNITY_FLOAT_IS_DET: /* A determinate number is non infinite and not NaN. */
M
Mark VanderVoord 已提交
932
        case UNITY_FLOAT_IS_NOT_DET:
933
            is_trait = !isinf(actual) && !isnan(actual);
M
Mark VanderVoord 已提交
934 935 936
            break;

        default:
937 938 939
            trait_index = 0;
            trait_names[0] = UnityStrInvalidFloatTrait;
            break;
M
Mark VanderVoord 已提交
940 941 942 943 944 945 946 947 948 949
    }

    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 已提交
950
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
M
Mark VanderVoord 已提交
951 952 953 954 955 956 957 958 959 960 961
        UnityPrintFloat(actual);
#else
        if (should_be_trait)
            UnityPrint(UnityStrNot);
        UnityPrint(trait_names[trait_index]);
#endif
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

962
#endif /* not UNITY_EXCLUDE_DOUBLE */
M
Mark VanderVoord 已提交
963

964
/*-----------------------------------------------*/
965 966 967 968 969 970
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 已提交
971
{
972
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
973 974 975 976

    if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT)
    {
        if (actual > expected)
M
Max Bruckner 已提交
977
          Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(actual - expected) > delta);
M
Mark VanderVoord 已提交
978
        else
M
Max Bruckner 已提交
979
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(expected - actual) > delta);
M
Mark VanderVoord 已提交
980 981 982
    }
    else
    {
983
        if ((UNITY_UINT)actual > (UNITY_UINT)expected)
M
Max Bruckner 已提交
984
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(actual - expected) > delta);
M
Mark VanderVoord 已提交
985
        else
M
Max Bruckner 已提交
986
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(expected - actual) > delta);
M
Mark VanderVoord 已提交
987 988 989 990 991 992
    }

    if (Unity.CurrentTestFailed)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrDelta);
993
        UnityPrintNumberByStyle((UNITY_INT)delta, style);
M
Mark VanderVoord 已提交
994 995 996 997 998 999 1000 1001 1002
        UnityPrint(UnityStrExpected);
        UnityPrintNumberByStyle(expected, style);
        UnityPrint(UnityStrWas);
        UnityPrintNumberByStyle(actual, style);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

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

1011
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1012

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

    if (Unity.CurrentTestFailed)
    {
1035 1036 1037 1038
        UnityTestResultsFailBegin(lineNumber);
        UnityPrintExpectedAndActualStrings(expected, actual);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
1039 1040 1041
    }
}

1042
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1043
void UnityAssertEqualStringLen(const char* expected,
1044 1045 1046 1047
                               const char* actual,
                               const UNITY_UINT32 length,
                               const char* msg,
                               const UNITY_LINE_TYPE lineNumber)
M
Mark VanderVoord 已提交
1048
{
1049
    UNITY_UINT32 i;
M
Mark VanderVoord 已提交
1050

1051
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1052

1053
    /* if both pointers not null compare the strings */
M
Mark VanderVoord 已提交
1054 1055
    if (expected && actual)
    {
1056
        for (i = 0; (i < length) && (expected[i] || actual[i]); i++)
M
Mark VanderVoord 已提交
1057 1058 1059 1060 1061 1062 1063 1064 1065
        {
            if (expected[i] != actual[i])
            {
                Unity.CurrentTestFailed = 1;
                break;
            }
        }
    }
    else
1066
    { /* handle case of one pointers being null (if both null, test should pass) */
M
Mark VanderVoord 已提交
1067 1068 1069 1070 1071 1072 1073 1074
        if (expected != actual)
        {
            Unity.CurrentTestFailed = 1;
        }
    }

    if (Unity.CurrentTestFailed)
    {
1075 1076 1077 1078
        UnityTestResultsFailBegin(lineNumber);
        UnityPrintExpectedAndActualStringsLen(expected, actual, length);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
1079 1080 1081
    }
}

1082
/*-----------------------------------------------*/
1083
void UnityAssertEqualStringArray(UNITY_INTERNAL_PTR expected,
1084 1085 1086
                                 const char** actual,
                                 const UNITY_UINT32 num_elements,
                                 const char* msg,
1087 1088
                                 const UNITY_LINE_TYPE lineNumber,
                                 const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
1089
{
1090 1091
    UNITY_UINT32 i = 0;
    UNITY_UINT32 j = 0;
1092
    const char* expd = NULL;
1093
    const char* act = NULL;
M
Mark VanderVoord 已提交
1094

1095
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1096

1097
    /* if no elements, it's an error */
1098 1099 1100 1101
    if (num_elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
1102

1103
    if ((const void*)expected == (const void*)actual)
1104 1105 1106 1107
    {
        return; /* Both are NULL or same pointer */
    }

1108
    if (UnityIsOneArrayNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg))
1109
    {
1110
        UNITY_FAIL_AND_BAIL;
1111 1112 1113 1114
    }

    if (flags != UNITY_ARRAY_TO_ARRAY)
    {
1115
        expd = (const char*)expected;
1116
    }
M
Mark VanderVoord 已提交
1117 1118 1119

    do
    {
1120 1121 1122
        act = actual[j];
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
1123
            expd = ((const char* const*)expected)[j];
1124 1125
        }

1126
        /* if both pointers not null compare the strings */
1127
        if (expd && act)
M
Mark VanderVoord 已提交
1128
        {
1129
            for (i = 0; expd[i] || act[i]; i++)
M
Mark VanderVoord 已提交
1130
            {
1131
                if (expd[i] != act[i])
M
Mark VanderVoord 已提交
1132 1133 1134 1135 1136 1137 1138
                {
                    Unity.CurrentTestFailed = 1;
                    break;
                }
            }
        }
        else
1139
        { /* handle case of one pointers being null (if both null, test should pass) */
1140
            if (expd != act)
M
Mark VanderVoord 已提交
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
            {
                Unity.CurrentTestFailed = 1;
            }
        }

        if (Unity.CurrentTestFailed)
        {
            UnityTestResultsFailBegin(lineNumber);
            if (num_elements > 1)
            {
                UnityPrint(UnityStrElement);
1152
                UnityPrintNumberUnsigned(j);
M
Mark VanderVoord 已提交
1153
            }
1154
            UnityPrintExpectedAndActualStrings(expd, act);
M
Mark VanderVoord 已提交
1155 1156 1157 1158 1159 1160
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
    } while (++j < num_elements);
}

1161
/*-----------------------------------------------*/
1162 1163 1164 1165 1166
void UnityAssertEqualMemory(UNITY_INTERNAL_PTR expected,
                            UNITY_INTERNAL_PTR actual,
                            const UNITY_UINT32 length,
                            const UNITY_UINT32 num_elements,
                            const char* msg,
1167 1168
                            const UNITY_LINE_TYPE lineNumber,
                            const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
1169 1170 1171
{
    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;
1172 1173
    UNITY_UINT32 elements = num_elements;
    UNITY_UINT32 bytes;
M
Mark VanderVoord 已提交
1174

1175
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1176

1177 1178 1179 1180
    if ((elements == 0) || (length == 0))
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
1181

1182 1183 1184
    if (expected == actual) return; /* Both are NULL or same pointer */
    if (UnityIsOneArrayNull(expected, actual, lineNumber, msg))
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197

    while (elements--)
    {
        bytes = length;
        while (bytes--)
        {
            if (*ptr_exp != *ptr_act)
            {
                UnityTestResultsFailBegin(lineNumber);
                UnityPrint(UnityStrMemory);
                if (num_elements > 1)
                {
                    UnityPrint(UnityStrElement);
1198
                    UnityPrintNumberUnsigned(num_elements - elements - 1);
M
Mark VanderVoord 已提交
1199 1200
                }
                UnityPrint(UnityStrByte);
1201
                UnityPrintNumberUnsigned(length - bytes - 1);
M
Mark VanderVoord 已提交
1202 1203 1204 1205 1206 1207 1208
                UnityPrint(UnityStrExpected);
                UnityPrintNumberByStyle(*ptr_exp, UNITY_DISPLAY_STYLE_HEX8);
                UnityPrint(UnityStrWas);
                UnityPrintNumberByStyle(*ptr_act, UNITY_DISPLAY_STYLE_HEX8);
                UnityAddMsgIfSpecified(msg);
                UNITY_FAIL_AND_BAIL;
            }
1209 1210
            ptr_exp++;
            ptr_act++;
M
Mark VanderVoord 已提交
1211
        }
1212 1213 1214 1215
        if (flags == UNITY_ARRAY_TO_VAL)
        {
            ptr_exp = (UNITY_PTR_ATTRIBUTE const unsigned char*)expected;
        }
M
Mark VanderVoord 已提交
1216 1217 1218
    }
}

1219 1220 1221 1222 1223 1224 1225 1226 1227 1228
/*-----------------------------------------------*/

static union
{
    UNITY_INT8 i8;
    UNITY_INT16 i16;
    UNITY_INT32 i32;
#ifdef UNITY_SUPPORT_64
    UNITY_INT64 i64;
#endif
1229 1230 1231 1232 1233 1234
#ifndef UNITY_EXCLUDE_FLOAT
    float f;
#endif
#ifndef UNITY_EXCLUDE_DOUBLE
    double d;
#endif
1235 1236 1237 1238 1239 1240 1241
} UnityQuickCompare;

UNITY_INTERNAL_PTR UnityNumToPtr(const UNITY_INT num, const UNITY_UINT8 size)
{
    switch(size)
    {
        case 1:
1242
          UnityQuickCompare.i8 = (UNITY_INT8)num;
1243 1244 1245
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i8);

        case 2:
1246
          UnityQuickCompare.i16 = (UNITY_INT16)num;
1247 1248 1249 1250
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i16);

#ifdef UNITY_SUPPORT_64
        case 8:
1251
          UnityQuickCompare.i64 = (UNITY_INT64)num;
1252 1253
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i64);
#endif
1254
        default: /* 4 bytes */
1255
          UnityQuickCompare.i32 = (UNITY_INT32)num;
1256 1257 1258 1259
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i32);
    }
}

1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275
#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

1276 1277 1278
/*-----------------------------------------------
 * Control Functions
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
1279 1280 1281

void UnityFail(const char* msg, const UNITY_LINE_TYPE line)
{
1282
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1283 1284

    UnityTestResultsBegin(Unity.TestFile, line);
1285
    UnityPrint(UnityStrFail);
M
Mark VanderVoord 已提交
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
    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;
}

1313
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1314 1315
void UnityIgnore(const char* msg, const UNITY_LINE_TYPE line)
{
1316
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1317 1318 1319 1320 1321

    UnityTestResultsBegin(Unity.TestFile, line);
    UnityPrint(UnityStrIgnore);
    if (msg != NULL)
    {
1322 1323 1324
        UNITY_OUTPUT_CHAR(':');
        UNITY_OUTPUT_CHAR(' ');
        UnityPrint(msg);
M
Mark VanderVoord 已提交
1325 1326 1327 1328
    }
    UNITY_IGNORE_AND_BAIL;
}

1329
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340
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();
    }
1341
    if (TEST_PROTECT())
M
Mark VanderVoord 已提交
1342 1343 1344 1345 1346 1347
    {
        tearDown();
    }
    UnityConcludeTest();
}

1348
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
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();
}

1364
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1365 1366 1367 1368 1369
int UnityEnd(void)
{
    UNITY_PRINT_EOL();
    UnityPrint(UnityStrBreaker);
    UNITY_PRINT_EOL();
1370
    UnityPrintNumber((UNITY_INT)(Unity.NumberOfTests));
M
Mark VanderVoord 已提交
1371
    UnityPrint(UnityStrResultsTests);
1372
    UnityPrintNumber((UNITY_INT)(Unity.TestFailures));
M
Mark VanderVoord 已提交
1373
    UnityPrint(UnityStrResultsFailures);
1374
    UnityPrintNumber((UNITY_INT)(Unity.TestIgnores));
M
Mark VanderVoord 已提交
1375 1376 1377 1378
    UnityPrint(UnityStrResultsIgnored);
    UNITY_PRINT_EOL();
    if (Unity.TestFailures == 0U)
    {
1379
        UnityPrint(UnityStrOk);
M
Mark VanderVoord 已提交
1380 1381 1382
    }
    else
    {
1383
        UnityPrint(UnityStrFail);
1384 1385 1386
#ifdef UNITY_DIFFERENTIATE_FINAL_FAIL
        UNITY_OUTPUT_CHAR('E'); UNITY_OUTPUT_CHAR('D');
#endif
M
Mark VanderVoord 已提交
1387 1388
    }
    UNITY_PRINT_EOL();
1389
    UNITY_FLUSH_CALL();
M
Mark VanderVoord 已提交
1390 1391 1392 1393
    UNITY_OUTPUT_COMPLETE();
    return (int)(Unity.TestFailures);
}

1394 1395 1396
/*-----------------------------------------------
 * Command Line Argument Support
 *-----------------------------------------------*/
1397
#ifdef UNITY_USE_COMMAND_LINE_ARGS
1398 1399 1400

char* UnityOptionIncludeNamed = NULL;
char* UnityOptionExcludeNamed = NULL;
1401
int UnityVerbosity            = 1;
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411

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

    for (int i = 1; i < argc; i++)
    {
        if (argv[i][0] == '-')
        {
1412
            switch (argv[i][1])
1413 1414
            {
                case 'l': /* list tests */
1415
                    return -1;
1416
                case 'n': /* include tests with name including this string */
1417 1418 1419 1420
                case 'f': /* an alias for -n */
                    if (argv[i][2] == '=')
                        UnityOptionIncludeNamed = &argv[i][3];
                    else if (++i < argc)
1421 1422 1423 1424 1425
                        UnityOptionIncludeNamed = argv[i];
                    else
                    {
                        UnityPrint("ERROR: No Test String to Include Matches For");
                        UNITY_PRINT_EOL();
1426
                        return 1;
1427 1428 1429 1430 1431 1432 1433 1434 1435
                    }
                    break;
                case 'q': /* quiet */
                    UnityVerbosity = 0;
                    break;
                case 'v': /* verbose */
                    UnityVerbosity = 2;
                    break;
                case 'x': /* exclude tests with name including this string */
1436 1437 1438
                    if (argv[i][2] == '=')
                        UnityOptionExcludeNamed = &argv[i][3];
                    else if (++i < argc)
1439 1440 1441 1442 1443
                        UnityOptionExcludeNamed = argv[i];
                    else
                    {
                        UnityPrint("ERROR: No Test String to Exclude Matches For");
                        UNITY_PRINT_EOL();
1444
                        return 1;
1445 1446 1447 1448
                    }
                    break;
                default:
                    UnityPrint("ERROR: Unknown Option ");
1449
                    UNITY_OUTPUT_CHAR(argv[i][1]);
1450 1451 1452 1453 1454 1455 1456 1457 1458
                    UNITY_PRINT_EOL();
                    return 1;
            }
        }
    }

    return 0;
}

1459
int IsStringInBiggerString(const char* longstring, const char* shortstring)
1460
{
1461 1462 1463
    const char* lptr = longstring;
    const char* sptr = shortstring;
    const char* lnext = lptr;
1464

1465 1466 1467
    if (*sptr == '*')
        return 1;

1468 1469 1470
    while (*lptr)
    {
        lnext = lptr + 1;
1471

1472 1473 1474 1475 1476
        /* If they current bytes match, go on to the next bytes */
        while (*lptr && *sptr && (*lptr == *sptr))
        {
            lptr++;
            sptr++;
1477

1478 1479 1480
            /* We're done if we match the entire string or up to a wildcard */
            if (*sptr == '*')
                return 1;
1481 1482 1483 1484 1485 1486 1487 1488
            if (*sptr == ',')
                return 1;
            if (*sptr == '"')
                return 1;
            if (*sptr == '\'')
                return 1;
            if (*sptr == ':')
                return 2;
1489 1490 1491 1492 1493 1494
            if (*sptr == 0)
                return 1;
        }

        /* Otherwise we start in the long pointer 1 character further and try again */
        lptr = lnext;
1495
        sptr = shortstring;
1496 1497
    }
    return 0;
1498 1499 1500 1501
}

int UnityStringArgumentMatches(const char* str)
{
1502 1503 1504
    int retval;
    const char* ptr1;
    const char* ptr2;
1505
    const char* ptrf;
1506

1507
    /* Go through the options and get the substrings for matching one at a time */
1508 1509 1510 1511 1512 1513
    ptr1 = str;
    while (ptr1[0] != 0)
    {
        if ((ptr1[0] == '"') || (ptr1[0] == '\''))
            ptr1++;

1514
        /* look for the start of the next partial */
1515
        ptr2 = ptr1;
1516
        ptrf = 0;
1517 1518
        do
        {
1519
            ptr2++;
1520 1521 1522 1523
            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] == ',')))
1524 1525
            ptr2++;

1526
        /* done if complete filename match */
1527 1528 1529 1530
        retval = IsStringInBiggerString(Unity.TestFile, ptr1);
        if (retval == 1)
            return retval;

1531
        /* done if testname match after filename partial match */
1532
        if ((retval == 2) && (ptrf != 0))
1533
        {
1534
            if (IsStringInBiggerString(Unity.CurrentTestName, ptrf))
1535 1536 1537
                return 1;
        }

1538
        /* done if complete testname match */
1539 1540 1541 1542 1543 1544
        if (IsStringInBiggerString(Unity.CurrentTestName, ptr1) == 1)
            return 1;

        ptr1 = ptr2;
    }

1545
    /* we couldn't find a match for any substrings */
1546
    return 0;
1547
}
1548

1549 1550 1551 1552 1553 1554 1555 1556 1557 1558
int UnityTestMatches(void)
{
    /* Check if this test name matches the included test pattern */
    int retval;
    if (UnityOptionIncludeNamed)
    {
        retval = UnityStringArgumentMatches(UnityOptionIncludeNamed);
    }
    else
        retval = 1;
1559

1560 1561 1562 1563 1564
    /* Check if this test name matches the excluded test pattern */
    if (UnityOptionExcludeNamed)
    {
        if (UnityStringArgumentMatches(UnityOptionExcludeNamed))
            retval = 0;
1565
    }
1566
    return retval;
1567 1568
}

1569
#endif /* UNITY_USE_COMMAND_LINE_ARGS */
1570
/*-----------------------------------------------*/