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

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

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

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

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

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

57 58 59
/*-----------------------------------------------
 * Pretty Printers & Test Result Output Handlers
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
60 61 62 63 64 65 66 67 68

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

    if (pch != NULL)
    {
        while (*pch)
        {
69
            /* printable characters plus CR & LF are printed */
M
Mark VanderVoord 已提交
70 71 72 73
            if ((*pch <= 126) && (*pch >= 32))
            {
                UNITY_OUTPUT_CHAR(*pch);
            }
74
            /* write escaped carriage returns */
M
Mark VanderVoord 已提交
75 76 77 78 79
            else if (*pch == 13)
            {
                UNITY_OUTPUT_CHAR('\\');
                UNITY_OUTPUT_CHAR('r');
            }
80
            /* write escaped line feeds */
M
Mark VanderVoord 已提交
81 82 83 84 85
            else if (*pch == 10)
            {
                UNITY_OUTPUT_CHAR('\\');
                UNITY_OUTPUT_CHAR('n');
            }
86
            /* unprintable characters are shown as codes */
M
Mark VanderVoord 已提交
87 88 89
            else
            {
                UNITY_OUTPUT_CHAR('\\');
90
                UNITY_OUTPUT_CHAR('x');
91
                UnityPrintNumberHex((UNITY_UINT)*pch, 2);
M
Mark VanderVoord 已提交
92 93 94 95 96 97
            }
            pch++;
        }
    }
}

98
void UnityPrintLen(const char* string, const UNITY_UINT32 length)
M
Mark VanderVoord 已提交
99 100 101 102 103
{
    const char* pch = string;

    if (pch != NULL)
    {
104
        while (*pch && (UNITY_UINT32)(pch - string) < length)
M
Mark VanderVoord 已提交
105
        {
106
            /* printable characters plus CR & LF are printed */
M
Mark VanderVoord 已提交
107 108 109 110
            if ((*pch <= 126) && (*pch >= 32))
            {
                UNITY_OUTPUT_CHAR(*pch);
            }
111
            /* write escaped carriage returns */
M
Mark VanderVoord 已提交
112 113 114 115 116
            else if (*pch == 13)
            {
                UNITY_OUTPUT_CHAR('\\');
                UNITY_OUTPUT_CHAR('r');
            }
117
            /* write escaped line feeds */
M
Mark VanderVoord 已提交
118 119 120 121 122
            else if (*pch == 10)
            {
                UNITY_OUTPUT_CHAR('\\');
                UNITY_OUTPUT_CHAR('n');
            }
123
            /* unprintable characters are shown as codes */
M
Mark VanderVoord 已提交
124 125 126
            else
            {
                UNITY_OUTPUT_CHAR('\\');
127
                UNITY_OUTPUT_CHAR('x');
128
                UnityPrintNumberHex((UNITY_UINT)*pch, 2);
M
Mark VanderVoord 已提交
129 130 131 132 133 134
            }
            pch++;
        }
    }
}

135
/*-----------------------------------------------*/
136
void UnityPrintNumberByStyle(const UNITY_INT number, const UNITY_DISPLAY_STYLE_T style)
M
Mark VanderVoord 已提交
137 138 139 140 141 142 143
{
    if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT)
    {
        UnityPrintNumber(number);
    }
    else if ((style & UNITY_DISPLAY_RANGE_UINT) == UNITY_DISPLAY_RANGE_UINT)
    {
144
        UnityPrintNumberUnsigned((UNITY_UINT)number);
M
Mark VanderVoord 已提交
145 146 147
    }
    else
    {
148 149
        UNITY_OUTPUT_CHAR('0');
        UNITY_OUTPUT_CHAR('x');
150
        UnityPrintNumberHex((UNITY_UINT)number, (char)((style & 0xF) * 2));
M
Mark VanderVoord 已提交
151 152 153
    }
}

154
/*-----------------------------------------------*/
155
void UnityPrintNumber(const UNITY_INT number_to_print)
M
Mark VanderVoord 已提交
156
{
157
    UNITY_UINT number = (UNITY_UINT)number_to_print;
M
Mark VanderVoord 已提交
158 159 160

    if (number_to_print < 0)
    {
161
        /* A negative number, including MIN negative */
M
Mark VanderVoord 已提交
162
        UNITY_OUTPUT_CHAR('-');
163
        number = (UNITY_UINT)(-number_to_print);
M
Mark VanderVoord 已提交
164
    }
165
    UnityPrintNumberUnsigned(number);
M
Mark VanderVoord 已提交
166 167
}

168 169
/*-----------------------------------------------
 * basically do an itoa using as little ram as possible */
170
void UnityPrintNumberUnsigned(const UNITY_UINT number)
M
Mark VanderVoord 已提交
171
{
172
    UNITY_UINT divisor = 1;
M
Mark VanderVoord 已提交
173

174
    /* figure out initial divisor */
M
Mark VanderVoord 已提交
175 176
    while (number / divisor > 9)
    {
177
        divisor *= 10;
M
Mark VanderVoord 已提交
178 179
    }

180
    /* now mod and print, then divide divisor */
M
Mark VanderVoord 已提交
181 182 183 184
    do
    {
        UNITY_OUTPUT_CHAR((char)('0' + (number / divisor % 10)));
        divisor /= 10;
185
    } while (divisor > 0);
M
Mark VanderVoord 已提交
186 187
}

188
/*-----------------------------------------------*/
189
void UnityPrintNumberHex(const UNITY_UINT number, const char nibbles_to_print)
M
Mark VanderVoord 已提交
190
{
191
    int nibble;
M
Mark VanderVoord 已提交
192
    char nibbles = nibbles_to_print;
193 194
    if ((unsigned)nibbles > (2 * sizeof(number)))
        nibbles = 2 * sizeof(number);
M
Mark VanderVoord 已提交
195 196 197

    while (nibbles > 0)
    {
198
        nibbles--;
199
        nibble = (int)(number >> (nibbles * 4)) & 0x0F;
M
Mark VanderVoord 已提交
200 201 202 203 204 205 206 207 208 209 210
        if (nibble <= 9)
        {
            UNITY_OUTPUT_CHAR((char)('0' + nibble));
        }
        else
        {
            UNITY_OUTPUT_CHAR((char)('A' - 10 + nibble));
        }
    }
}

211
/*-----------------------------------------------*/
212
void UnityPrintMask(const UNITY_UINT mask, const UNITY_UINT number)
M
Mark VanderVoord 已提交
213
{
214 215
    UNITY_UINT current_bit = (UNITY_UINT)1 << (UNITY_INT_WIDTH - 1);
    UNITY_INT32 i;
M
Mark VanderVoord 已提交
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237

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

238
/*-----------------------------------------------*/
J
jsalling 已提交
239
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
240 241 242 243 244
/* 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. */
245
void UnityPrintFloat(const UNITY_DOUBLE input_number)
M
Mark VanderVoord 已提交
246
{
247
    UNITY_DOUBLE number = input_number;
248

249 250
    /* print minus sign (including for negative zero) */
    if (number < 0.0f || (number == 0.0f && 1.0f / number < 0.0f))
J
jsalling 已提交
251 252
    {
        UNITY_OUTPUT_CHAR('-');
253
        number = -number;
J
jsalling 已提交
254
    }
255

256 257 258 259 260
    /* 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 已提交
261
    {
262
        int exponent = 0;
J
John Lindgren 已提交
263 264 265
        int decimals, digits;
        UNITY_INT32 n;
        char buf[16];
266

267 268 269 270 271 272 273
        /* 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 已提交
274
        n = ((UNITY_INT32)(number + number) + 1) / 2;
275
        if (n > 999999)
276
        {
277 278
            n = 100000;
            exponent++;
279 280
        }

281
        /* determine where to place decimal point */
J
John Lindgren 已提交
282
        decimals = (exponent <= 0 && exponent >= -9) ? -exponent : 5;
283 284 285 286
        exponent += decimals;

        /* truncate trailing zeroes after decimal point */
        while (decimals > 0 && n % 10 == 0)
287
        {
288 289 290 291 292
            n /= 10;
            decimals--;
        }

        /* build up buffer in reverse order */
J
John Lindgren 已提交
293
        digits = 0;
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
        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]);
            }
330
        }
J
jsalling 已提交
331
    }
M
Mark VanderVoord 已提交
332
}
J
jsalling 已提交
333
#endif /* ! UNITY_EXCLUDE_FLOAT_PRINT */
M
Mark VanderVoord 已提交
334

335
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
336 337 338 339
static void UnityTestResultsBegin(const char* file, const UNITY_LINE_TYPE line)
{
    UnityPrint(file);
    UNITY_OUTPUT_CHAR(':');
340
    UnityPrintNumber((UNITY_INT)line);
M
Mark VanderVoord 已提交
341 342 343 344 345
    UNITY_OUTPUT_CHAR(':');
    UnityPrint(Unity.CurrentTestName);
    UNITY_OUTPUT_CHAR(':');
}

346
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
347 348 349 350 351 352 353
static void UnityTestResultsFailBegin(const UNITY_LINE_TYPE line)
{
    UnityTestResultsBegin(Unity.TestFile, line);
    UnityPrint(UnityStrFail);
    UNITY_OUTPUT_CHAR(':');
}

354
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
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();
374
    UNITY_FLUSH_CALL();
M
Mark VanderVoord 已提交
375 376
}

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

400
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
401 402 403 404 405 406 407 408 409 410 411
static void UnityPrintExpectedAndActualStrings(const char* expected, const char* actual)
{
    UnityPrint(UnityStrExpected);
    if (expected != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrint(expected);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
412
        UnityPrint(UnityStrNull);
M
Mark VanderVoord 已提交
413 414 415 416 417 418 419 420 421 422
    }
    UnityPrint(UnityStrWas);
    if (actual != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrint(actual);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
423
        UnityPrint(UnityStrNull);
M
Mark VanderVoord 已提交
424 425 426
    }
}

427
/*-----------------------------------------------*/
428 429 430
static void UnityPrintExpectedAndActualStringsLen(const char* expected,
                                                  const char* actual,
                                                  const UNITY_UINT32 length)
M
Mark VanderVoord 已提交
431 432 433 434 435 436 437 438 439 440
{
    UnityPrint(UnityStrExpected);
    if (expected != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrintLen(expected, length);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
441
        UnityPrint(UnityStrNull);
M
Mark VanderVoord 已提交
442 443 444 445 446 447 448 449 450 451
    }
    UnityPrint(UnityStrWas);
    if (actual != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrintLen(actual, length);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
452
        UnityPrint(UnityStrNull);
M
Mark VanderVoord 已提交
453 454 455
    }
}

456 457 458
/*-----------------------------------------------
 * Assertion & Control Helpers
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
459

460 461 462 463
static int UnityIsOneArrayNull(UNITY_INTERNAL_PTR expected,
                               UNITY_INTERNAL_PTR actual,
                               const UNITY_LINE_TYPE lineNumber,
                               const char* msg)
M
Mark VanderVoord 已提交
464
{
465
    if (expected == actual) return 0; /* Both are NULL or same pointer */
M
Mark VanderVoord 已提交
466

467
    /* print and return true if just expected is NULL */
M
Mark VanderVoord 已提交
468 469 470 471 472
    if (expected == NULL)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrNullPointerForExpected);
        UnityAddMsgIfSpecified(msg);
473
        return 1;
M
Mark VanderVoord 已提交
474 475
    }

476
    /* print and return true if just actual is NULL */
M
Mark VanderVoord 已提交
477 478 479 480 481
    if (actual == NULL)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrNullPointerForActual);
        UnityAddMsgIfSpecified(msg);
482
        return 1;
M
Mark VanderVoord 已提交
483 484
    }

485
    return 0; /* return false if neither is NULL */
M
Mark VanderVoord 已提交
486 487
}

488 489 490
/*-----------------------------------------------
 * Assertion Functions
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
491

492 493 494
void UnityAssertBits(const UNITY_INT mask,
                     const UNITY_INT expected,
                     const UNITY_INT actual,
M
Mark VanderVoord 已提交
495 496 497
                     const char* msg,
                     const UNITY_LINE_TYPE lineNumber)
{
498
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
499 500 501 502 503

    if ((mask & expected) != (mask & actual))
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrExpected);
504
        UnityPrintMask((UNITY_UINT)mask, (UNITY_UINT)expected);
M
Mark VanderVoord 已提交
505
        UnityPrint(UnityStrWas);
506
        UnityPrintMask((UNITY_UINT)mask, (UNITY_UINT)actual);
M
Mark VanderVoord 已提交
507 508 509 510 511
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

512
/*-----------------------------------------------*/
513 514
void UnityAssertEqualNumber(const UNITY_INT expected,
                            const UNITY_INT actual,
M
Mark VanderVoord 已提交
515 516 517 518
                            const char* msg,
                            const UNITY_LINE_TYPE lineNumber,
                            const UNITY_DISPLAY_STYLE_T style)
{
519
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
520 521 522 523 524 525 526 527 528 529 530 531 532

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

533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
/*-----------------------------------------------*/
void UnityAssertGreaterNumber(const UNITY_INT threshold,
                              const UNITY_INT actual,
                              const char *msg,
                              const UNITY_LINE_TYPE lineNumber,
                              const UNITY_DISPLAY_STYLE_T style)
{
    RETURN_IF_FAIL_OR_IGNORE;

    if (!(actual > threshold))
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrExpected);
        UnityPrintNumberByStyle(actual, style);
        UnityPrint(UnityStrGt);
        UnityPrintNumberByStyle(threshold, style);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

/*-----------------------------------------------*/
void UnityAssertSmallerNumber(const UNITY_INT threshold,
                              const UNITY_INT actual,
                              const char *msg,
                              const UNITY_LINE_TYPE lineNumber,
                              const UNITY_DISPLAY_STYLE_T style)
{
    RETURN_IF_FAIL_OR_IGNORE;

    if (!(actual < threshold))
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrExpected);
        UnityPrintNumberByStyle(actual, style);
        UnityPrint(UnityStrLt);
        UnityPrintNumberByStyle(threshold, style);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}



577 578 579 580 581 582 583
#define UnityPrintPointlessAndBail()       \
{                                          \
    UnityTestResultsFailBegin(lineNumber); \
    UnityPrint(UnityStrPointless);         \
    UnityAddMsgIfSpecified(msg);           \
    UNITY_FAIL_AND_BAIL; }

584
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
585 586
void UnityAssertEqualIntArray(UNITY_INTERNAL_PTR expected,
                              UNITY_INTERNAL_PTR actual,
587
                              const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
588 589
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
590 591
                              const UNITY_DISPLAY_STYLE_T style,
                              const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
592
{
593
    UNITY_UINT32 elements = num_elements;
594
    unsigned int length   = style & 0xF;
M
Mark VanderVoord 已提交
595

596
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
597

598 599 600 601
    if (num_elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
602

603 604 605
    if (expected == actual) return; /* Both are NULL or same pointer */
    if (UnityIsOneArrayNull(expected, actual, lineNumber, msg))
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
606

607
    while (elements--)
M
Mark VanderVoord 已提交
608
    {
609 610
        UNITY_INT expect_val;
        UNITY_INT actual_val;
611 612 613 614 615 616 617 618 619 620
        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 已提交
621
#ifdef UNITY_SUPPORT_64
622 623 624 625
            case 8:
                expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)expected;
                actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)actual;
                break;
M
Mark VanderVoord 已提交
626
#endif
627 628 629 630 631
            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;
632 633 634 635
        }

        if (expect_val != actual_val)
        {
636
            if (style & UNITY_DISPLAY_RANGE_UINT && length < sizeof(expect_val))
637 638 639 640 641 642
            {   /* 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;
            }
643 644 645 646 647 648 649 650 651 652
            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;
        }
653 654 655 656
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
            expected = (UNITY_INTERNAL_PTR)(length + (const char*)expected);
        }
657
        actual   = (UNITY_INTERNAL_PTR)(length + (const char*)actual);
M
Mark VanderVoord 已提交
658 659 660
    }
}

661
/*-----------------------------------------------*/
662
#ifndef UNITY_EXCLUDE_FLOAT
663
/* Wrap this define in a function with variable types as float or double */
664
#define UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff)                       \
665
    if (isinf(expected) && isinf(actual) && ((expected < 0) == (actual < 0))) return 1;   \
666
    if (UNITY_NAN_CHECK) return 1;                                                        \
667
    diff = actual - expected;                                                             \
668 669
    if (diff < 0) diff = -diff;                                                           \
    if (delta < 0) delta = -delta;                                                        \
670
    return !(isnan(diff) || isinf(diff) || (diff > delta))
671
    /* This first part of this condition will catch any NaN or Infinite values */
672 673 674 675 676
#ifndef UNITY_NAN_NOT_EQUAL_NAN
  #define UNITY_NAN_CHECK isnan(expected) && isnan(actual)
#else
  #define UNITY_NAN_CHECK 0
#endif
677

678 679
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
  #define UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual) \
680
  {                                                               \
681 682 683
    UnityPrint(UnityStrExpected);                                 \
    UnityPrintFloat(expected);                                    \
    UnityPrint(UnityStrWas);                                      \
684
    UnityPrintFloat(actual); }
685 686 687 688 689
#else
  #define UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual) \
    UnityPrint(UnityStrDelta)
#endif /* UNITY_EXCLUDE_FLOAT_PRINT */

690
static int UnityFloatsWithin(UNITY_FLOAT delta, UNITY_FLOAT expected, UNITY_FLOAT actual)
691
{
692
    UNITY_FLOAT diff;
693 694 695
    UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff);
}

696 697 698
void UnityAssertEqualFloatArray(UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* expected,
                                UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* actual,
                                const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
699
                                const char* msg,
700 701
                                const UNITY_LINE_TYPE lineNumber,
                                const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
702
{
703
    UNITY_UINT32 elements = num_elements;
704 705
    UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* ptr_expected = expected;
    UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* ptr_actual = actual;
M
Mark VanderVoord 已提交
706

707
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
708

709 710 711 712
    if (elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
713

714 715 716
    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 已提交
717 718 719

    while (elements--)
    {
720
        if (!UnityFloatsWithin(*ptr_expected * UNITY_FLOAT_PRECISION, *ptr_expected, *ptr_actual))
M
Mark VanderVoord 已提交
721 722 723
        {
            UnityTestResultsFailBegin(lineNumber);
            UnityPrint(UnityStrElement);
724
            UnityPrintNumberUnsigned(num_elements - elements - 1);
725
            UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT((UNITY_DOUBLE)*ptr_expected, (UNITY_DOUBLE)*ptr_actual);
M
Mark VanderVoord 已提交
726 727 728
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
729 730 731 732
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
            ptr_expected++;
        }
733
        ptr_actual++;
M
Mark VanderVoord 已提交
734 735 736
    }
}

737
/*-----------------------------------------------*/
738 739 740
void UnityAssertFloatsWithin(const UNITY_FLOAT delta,
                             const UNITY_FLOAT expected,
                             const UNITY_FLOAT actual,
M
Mark VanderVoord 已提交
741 742 743
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber)
{
744
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
745 746


747
    if (!UnityFloatsWithin(delta, expected, actual))
M
Mark VanderVoord 已提交
748 749
    {
        UnityTestResultsFailBegin(lineNumber);
750
        UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT((UNITY_DOUBLE)expected, (UNITY_DOUBLE)actual);
M
Mark VanderVoord 已提交
751 752 753 754 755
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

756
/*-----------------------------------------------*/
757
void UnityAssertFloatSpecial(const UNITY_FLOAT actual,
M
Mark VanderVoord 已提交
758 759 760 761
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber,
                             const UNITY_FLOAT_TRAIT_T style)
{
762 763 764 765
    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 已提交
766

767
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
768

769
    switch (style)
M
Mark VanderVoord 已提交
770 771 772
    {
        case UNITY_FLOAT_IS_INF:
        case UNITY_FLOAT_IS_NOT_INF:
773
            is_trait = isinf(actual) && (actual > 0);
M
Mark VanderVoord 已提交
774 775 776
            break;
        case UNITY_FLOAT_IS_NEG_INF:
        case UNITY_FLOAT_IS_NOT_NEG_INF:
777
            is_trait = isinf(actual) && (actual < 0);
M
Mark VanderVoord 已提交
778 779 780 781
            break;

        case UNITY_FLOAT_IS_NAN:
        case UNITY_FLOAT_IS_NOT_NAN:
782
            is_trait = isnan(actual) ? 1 : 0;
M
Mark VanderVoord 已提交
783 784
            break;

785
        case UNITY_FLOAT_IS_DET: /* A determinate number is non infinite and not NaN. */
M
Mark VanderVoord 已提交
786
        case UNITY_FLOAT_IS_NOT_DET:
787
            is_trait = !isinf(actual) && !isnan(actual);
M
Mark VanderVoord 已提交
788 789 790
            break;

        default:
791 792 793
            trait_index = 0;
            trait_names[0] = UnityStrInvalidFloatTrait;
            break;
M
Mark VanderVoord 已提交
794 795 796 797 798 799 800 801 802 803
    }

    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 已提交
804
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
805
        UnityPrintFloat((UNITY_DOUBLE)actual);
M
Mark VanderVoord 已提交
806 807 808 809 810 811 812 813 814 815
#else
        if (should_be_trait)
            UnityPrint(UnityStrNot);
        UnityPrint(trait_names[trait_index]);
#endif
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

816
#endif /* not UNITY_EXCLUDE_FLOAT */
M
Mark VanderVoord 已提交
817

818
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
819
#ifndef UNITY_EXCLUDE_DOUBLE
820
static int UnityDoublesWithin(UNITY_DOUBLE delta, UNITY_DOUBLE expected, UNITY_DOUBLE actual)
821
{
822
    UNITY_DOUBLE diff;
823 824 825
    UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff);
}

826 827 828
void UnityAssertEqualDoubleArray(UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* expected,
                                 UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* actual,
                                 const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
829
                                 const char* msg,
830 831
                                 const UNITY_LINE_TYPE lineNumber,
                                 const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
832
{
833
    UNITY_UINT32 elements = num_elements;
834 835
    UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* ptr_expected = expected;
    UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* ptr_actual = actual;
M
Mark VanderVoord 已提交
836

837
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
838

839 840 841 842
    if (elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
843

844 845 846
    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 已提交
847 848 849

    while (elements--)
    {
850
        if (!UnityDoublesWithin(*ptr_expected * UNITY_DOUBLE_PRECISION, *ptr_expected, *ptr_actual))
M
Mark VanderVoord 已提交
851 852 853
        {
            UnityTestResultsFailBegin(lineNumber);
            UnityPrint(UnityStrElement);
854
            UnityPrintNumberUnsigned(num_elements - elements - 1);
855
            UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(*ptr_expected, *ptr_actual);
M
Mark VanderVoord 已提交
856 857 858
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
859 860 861 862
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
            ptr_expected++;
        }
863
        ptr_actual++;
M
Mark VanderVoord 已提交
864 865 866
    }
}

867
/*-----------------------------------------------*/
868 869 870
void UnityAssertDoublesWithin(const UNITY_DOUBLE delta,
                              const UNITY_DOUBLE expected,
                              const UNITY_DOUBLE actual,
M
Mark VanderVoord 已提交
871 872 873
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber)
{
874
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
875

876
    if (!UnityDoublesWithin(delta, expected, actual))
M
Mark VanderVoord 已提交
877 878
    {
        UnityTestResultsFailBegin(lineNumber);
879
        UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual);
M
Mark VanderVoord 已提交
880 881 882 883 884
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

885
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
886

887
void UnityAssertDoubleSpecial(const UNITY_DOUBLE actual,
M
Mark VanderVoord 已提交
888 889 890 891
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
                              const UNITY_FLOAT_TRAIT_T style)
{
892 893 894 895
    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 已提交
896

897
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
898

899
    switch (style)
M
Mark VanderVoord 已提交
900 901 902
    {
        case UNITY_FLOAT_IS_INF:
        case UNITY_FLOAT_IS_NOT_INF:
903
            is_trait = isinf(actual) && (actual > 0);
M
Mark VanderVoord 已提交
904 905 906
            break;
        case UNITY_FLOAT_IS_NEG_INF:
        case UNITY_FLOAT_IS_NOT_NEG_INF:
907
            is_trait = isinf(actual) && (actual < 0);
M
Mark VanderVoord 已提交
908 909 910 911
            break;

        case UNITY_FLOAT_IS_NAN:
        case UNITY_FLOAT_IS_NOT_NAN:
912
            is_trait = isnan(actual) ? 1 : 0;
M
Mark VanderVoord 已提交
913 914
            break;

915
        case UNITY_FLOAT_IS_DET: /* A determinate number is non infinite and not NaN. */
M
Mark VanderVoord 已提交
916
        case UNITY_FLOAT_IS_NOT_DET:
917
            is_trait = !isinf(actual) && !isnan(actual);
M
Mark VanderVoord 已提交
918 919 920
            break;

        default:
921 922 923
            trait_index = 0;
            trait_names[0] = UnityStrInvalidFloatTrait;
            break;
M
Mark VanderVoord 已提交
924 925 926 927 928 929 930 931 932 933
    }

    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 已提交
934
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
M
Mark VanderVoord 已提交
935 936 937 938 939 940 941 942 943 944 945
        UnityPrintFloat(actual);
#else
        if (should_be_trait)
            UnityPrint(UnityStrNot);
        UnityPrint(trait_names[trait_index]);
#endif
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

946
#endif /* not UNITY_EXCLUDE_DOUBLE */
M
Mark VanderVoord 已提交
947

948
/*-----------------------------------------------*/
949 950 951 952 953 954
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 已提交
955
{
956
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
957 958 959 960

    if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT)
    {
        if (actual > expected)
M
Max Bruckner 已提交
961
          Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(actual - expected) > delta);
M
Mark VanderVoord 已提交
962
        else
M
Max Bruckner 已提交
963
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(expected - actual) > delta);
M
Mark VanderVoord 已提交
964 965 966
    }
    else
    {
967
        if ((UNITY_UINT)actual > (UNITY_UINT)expected)
M
Max Bruckner 已提交
968
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(actual - expected) > delta);
M
Mark VanderVoord 已提交
969
        else
M
Max Bruckner 已提交
970
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(expected - actual) > delta);
M
Mark VanderVoord 已提交
971 972 973 974 975 976
    }

    if (Unity.CurrentTestFailed)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrDelta);
977
        UnityPrintNumberByStyle((UNITY_INT)delta, style);
M
Mark VanderVoord 已提交
978 979 980 981 982 983 984 985 986
        UnityPrint(UnityStrExpected);
        UnityPrintNumberByStyle(expected, style);
        UnityPrint(UnityStrWas);
        UnityPrintNumberByStyle(actual, style);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

987
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
988 989 990 991 992
void UnityAssertEqualString(const char* expected,
                            const char* actual,
                            const char* msg,
                            const UNITY_LINE_TYPE lineNumber)
{
993
    UNITY_UINT32 i;
M
Mark VanderVoord 已提交
994

995
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
996

997
    /* if both pointers not null compare the strings */
M
Mark VanderVoord 已提交
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
    if (expected && actual)
    {
        for (i = 0; expected[i] || actual[i]; i++)
        {
            if (expected[i] != actual[i])
            {
                Unity.CurrentTestFailed = 1;
                break;
            }
        }
    }
    else
1010
    { /* handle case of one pointers being null (if both null, test should pass) */
M
Mark VanderVoord 已提交
1011 1012 1013 1014 1015 1016 1017 1018
        if (expected != actual)
        {
            Unity.CurrentTestFailed = 1;
        }
    }

    if (Unity.CurrentTestFailed)
    {
1019 1020 1021 1022
        UnityTestResultsFailBegin(lineNumber);
        UnityPrintExpectedAndActualStrings(expected, actual);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
1023 1024 1025
    }
}

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

1035
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1036

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

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

1066
/*-----------------------------------------------*/
1067
void UnityAssertEqualStringArray(UNITY_INTERNAL_PTR expected,
1068 1069 1070
                                 const char** actual,
                                 const UNITY_UINT32 num_elements,
                                 const char* msg,
1071 1072
                                 const UNITY_LINE_TYPE lineNumber,
                                 const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
1073
{
1074 1075
    UNITY_UINT32 i = 0;
    UNITY_UINT32 j = 0;
1076 1077
    const char* exp = NULL;
    const char* act = NULL;
M
Mark VanderVoord 已提交
1078

1079
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1080

1081
    /* if no elements, it's an error */
1082 1083 1084 1085
    if (num_elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
1086

1087
    if ((const void*)expected == (const void*)actual)
1088 1089 1090 1091
    {
        return; /* Both are NULL or same pointer */
    }

1092
    if (UnityIsOneArrayNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg))
1093
    {
1094
        UNITY_FAIL_AND_BAIL;
1095 1096 1097 1098 1099 1100
    }

    if (flags != UNITY_ARRAY_TO_ARRAY)
    {
        exp = (const char*)expected;
    }
M
Mark VanderVoord 已提交
1101 1102 1103

    do
    {
1104 1105 1106
        act = actual[j];
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
1107
            exp = ((const char* const*)expected)[j];
1108 1109
        }

1110
        /* if both pointers not null compare the strings */
1111
        if (exp && act)
M
Mark VanderVoord 已提交
1112
        {
1113
            for (i = 0; exp[i] || act[i]; i++)
M
Mark VanderVoord 已提交
1114
            {
1115
                if (exp[i] != act[i])
M
Mark VanderVoord 已提交
1116 1117 1118 1119 1120 1121 1122
                {
                    Unity.CurrentTestFailed = 1;
                    break;
                }
            }
        }
        else
1123
        { /* handle case of one pointers being null (if both null, test should pass) */
1124
            if (exp != act)
M
Mark VanderVoord 已提交
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
            {
                Unity.CurrentTestFailed = 1;
            }
        }

        if (Unity.CurrentTestFailed)
        {
            UnityTestResultsFailBegin(lineNumber);
            if (num_elements > 1)
            {
                UnityPrint(UnityStrElement);
1136
                UnityPrintNumberUnsigned(j);
M
Mark VanderVoord 已提交
1137
            }
1138
            UnityPrintExpectedAndActualStrings(exp, act);
M
Mark VanderVoord 已提交
1139 1140 1141 1142 1143 1144
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
    } while (++j < num_elements);
}

1145
/*-----------------------------------------------*/
1146 1147 1148 1149 1150
void UnityAssertEqualMemory(UNITY_INTERNAL_PTR expected,
                            UNITY_INTERNAL_PTR actual,
                            const UNITY_UINT32 length,
                            const UNITY_UINT32 num_elements,
                            const char* msg,
1151 1152
                            const UNITY_LINE_TYPE lineNumber,
                            const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
1153 1154 1155
{
    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;
1156 1157
    UNITY_UINT32 elements = num_elements;
    UNITY_UINT32 bytes;
M
Mark VanderVoord 已提交
1158

1159
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1160

1161 1162 1163 1164
    if ((elements == 0) || (length == 0))
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
1165

1166 1167 1168
    if (expected == actual) return; /* Both are NULL or same pointer */
    if (UnityIsOneArrayNull(expected, actual, lineNumber, msg))
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181

    while (elements--)
    {
        bytes = length;
        while (bytes--)
        {
            if (*ptr_exp != *ptr_act)
            {
                UnityTestResultsFailBegin(lineNumber);
                UnityPrint(UnityStrMemory);
                if (num_elements > 1)
                {
                    UnityPrint(UnityStrElement);
1182
                    UnityPrintNumberUnsigned(num_elements - elements - 1);
M
Mark VanderVoord 已提交
1183 1184
                }
                UnityPrint(UnityStrByte);
1185
                UnityPrintNumberUnsigned(length - bytes - 1);
M
Mark VanderVoord 已提交
1186 1187 1188 1189 1190 1191 1192
                UnityPrint(UnityStrExpected);
                UnityPrintNumberByStyle(*ptr_exp, UNITY_DISPLAY_STYLE_HEX8);
                UnityPrint(UnityStrWas);
                UnityPrintNumberByStyle(*ptr_act, UNITY_DISPLAY_STYLE_HEX8);
                UnityAddMsgIfSpecified(msg);
                UNITY_FAIL_AND_BAIL;
            }
1193 1194
            ptr_exp++;
            ptr_act++;
M
Mark VanderVoord 已提交
1195
        }
1196 1197 1198 1199
        if (flags == UNITY_ARRAY_TO_VAL)
        {
            ptr_exp = (UNITY_PTR_ATTRIBUTE const unsigned char*)expected;
        }
M
Mark VanderVoord 已提交
1200 1201 1202
    }
}

1203 1204 1205 1206 1207 1208 1209 1210 1211 1212
/*-----------------------------------------------*/

static union
{
    UNITY_INT8 i8;
    UNITY_INT16 i16;
    UNITY_INT32 i32;
#ifdef UNITY_SUPPORT_64
    UNITY_INT64 i64;
#endif
1213 1214 1215 1216 1217 1218
#ifndef UNITY_EXCLUDE_FLOAT
    float f;
#endif
#ifndef UNITY_EXCLUDE_DOUBLE
    double d;
#endif
1219 1220 1221 1222 1223 1224 1225
} UnityQuickCompare;

UNITY_INTERNAL_PTR UnityNumToPtr(const UNITY_INT num, const UNITY_UINT8 size)
{
    switch(size)
    {
        case 1:
1226
          UnityQuickCompare.i8 = (UNITY_INT8)num;
1227 1228 1229
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i8);

        case 2:
1230
          UnityQuickCompare.i16 = (UNITY_INT16)num;
1231 1232 1233 1234
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i16);

#ifdef UNITY_SUPPORT_64
        case 8:
1235
          UnityQuickCompare.i64 = (UNITY_INT64)num;
1236 1237
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i64);
#endif
1238
        default: /* 4 bytes */
1239
          UnityQuickCompare.i32 = (UNITY_INT32)num;
1240 1241 1242 1243
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i32);
    }
}

1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259
#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

1260 1261 1262
/*-----------------------------------------------
 * Control Functions
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
1263 1264 1265

void UnityFail(const char* msg, const UNITY_LINE_TYPE line)
{
1266
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1267 1268

    UnityTestResultsBegin(Unity.TestFile, line);
1269
    UnityPrint(UnityStrFail);
M
Mark VanderVoord 已提交
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296
    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;
}

1297
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1298 1299
void UnityIgnore(const char* msg, const UNITY_LINE_TYPE line)
{
1300
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1301 1302 1303 1304 1305

    UnityTestResultsBegin(Unity.TestFile, line);
    UnityPrint(UnityStrIgnore);
    if (msg != NULL)
    {
1306 1307 1308
        UNITY_OUTPUT_CHAR(':');
        UNITY_OUTPUT_CHAR(' ');
        UnityPrint(msg);
M
Mark VanderVoord 已提交
1309 1310 1311 1312
    }
    UNITY_IGNORE_AND_BAIL;
}

1313
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1314
#if defined(UNITY_WEAK_ATTRIBUTE)
1315 1316
  UNITY_WEAK_ATTRIBUTE void setUp(void) { }
  UNITY_WEAK_ATTRIBUTE void tearDown(void) { }
M
Mark VanderVoord 已提交
1317
#elif defined(UNITY_WEAK_PRAGMA)
1318 1319 1320 1321
  #pragma weak setUp
  void setUp(void) { }
  #pragma weak tearDown
  void tearDown(void) { }
M
Mark VanderVoord 已提交
1322
#endif
1323

1324
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335
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();
    }
1336
    if (TEST_PROTECT())
M
Mark VanderVoord 已提交
1337 1338 1339 1340 1341 1342
    {
        tearDown();
    }
    UnityConcludeTest();
}

1343
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
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();
}

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

1389 1390 1391
/*-----------------------------------------------
 * Command Line Argument Support
 *-----------------------------------------------*/
1392
#ifdef UNITY_USE_COMMAND_LINE_ARGS
1393 1394 1395

char* UnityOptionIncludeNamed = NULL;
char* UnityOptionExcludeNamed = NULL;
1396
int UnityVerbosity            = 1;
1397 1398 1399 1400 1401 1402 1403 1404 1405 1406

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

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

    return 0;
}

1454
int IsStringInBiggerString(const char* longstring, const char* shortstring)
1455
{
1456 1457 1458
    const char* lptr = longstring;
    const char* sptr = shortstring;
    const char* lnext = lptr;
1459

1460 1461 1462
    if (*sptr == '*')
        return 1;

1463 1464 1465
    while (*lptr)
    {
        lnext = lptr + 1;
1466

1467 1468 1469 1470 1471
        /* If they current bytes match, go on to the next bytes */
        while (*lptr && *sptr && (*lptr == *sptr))
        {
            lptr++;
            sptr++;
1472

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

        /* Otherwise we start in the long pointer 1 character further and try again */
        lptr = lnext;
1490
        sptr = shortstring;
1491 1492
    }
    return 0;
1493 1494 1495 1496
}

int UnityStringArgumentMatches(const char* str)
{
1497 1498 1499
    int retval;
    const char* ptr1;
    const char* ptr2;
1500
    const char* ptrf;
1501

1502
    /* Go through the options and get the substrings for matching one at a time */
1503 1504 1505 1506 1507 1508
    ptr1 = str;
    while (ptr1[0] != 0)
    {
        if ((ptr1[0] == '"') || (ptr1[0] == '\''))
            ptr1++;

1509
        /* look for the start of the next partial */
1510
        ptr2 = ptr1;
1511
        ptrf = 0;
1512 1513
        do
        {
1514
            ptr2++;
1515 1516 1517 1518
            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] == ',')))
1519 1520
            ptr2++;

1521
        /* done if complete filename match */
1522 1523 1524 1525
        retval = IsStringInBiggerString(Unity.TestFile, ptr1);
        if (retval == 1)
            return retval;

1526
        /* done if testname match after filename partial match */
1527
        if ((retval == 2) && (ptrf != 0))
1528
        {
1529
            if (IsStringInBiggerString(Unity.CurrentTestName, ptrf))
1530 1531 1532
                return 1;
        }

1533
        /* done if complete testname match */
1534 1535 1536 1537 1538 1539
        if (IsStringInBiggerString(Unity.CurrentTestName, ptr1) == 1)
            return 1;

        ptr1 = ptr2;
    }

1540
    /* we couldn't find a match for any substrings */
1541
    return 0;
1542
}
1543

1544 1545 1546 1547 1548 1549 1550 1551 1552 1553
int UnityTestMatches(void)
{
    /* Check if this test name matches the included test pattern */
    int retval;
    if (UnityOptionIncludeNamed)
    {
        retval = UnityStringArgumentMatches(UnityOptionIncludeNamed);
    }
    else
        retval = 1;
1554

1555 1556 1557 1558 1559
    /* Check if this test name matches the excluded test pattern */
    if (UnityOptionExcludeNamed)
    {
        if (UnityStringArgumentMatches(UnityOptionExcludeNamed))
            retval = 0;
1560
    }
1561
    return retval;
1562 1563
}

1564
#endif /* UNITY_USE_COMMAND_LINE_ARGS */
1565
/*-----------------------------------------------*/