unity.c 47.3 KB
Newer Older
M
Mark VanderVoord 已提交
1 2 3 4 5 6 7
/* =========================================================================
    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"
J
John Lindgren 已提交
8
#include "unity_setup.h"
M
Mark VanderVoord 已提交
9 10
#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 29 30
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 ";
31 32
static const char UnityStrGt[]                     = " to be greater than ";
static const char UnityStrLt[]                     = " to be less than ";
33 34 35 36 37 38 39
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";
40
#ifndef UNITY_EXCLUDE_FLOAT
41 42 43 44 45 46
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";
47
#endif
48 49 50 51 52 53 54 55 56
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 已提交
57

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        /* build up buffer in reverse order */
J
John Lindgren 已提交
294
        digits = 0;
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 330
        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]);
            }
331
        }
J
jsalling 已提交
332
    }
M
Mark VanderVoord 已提交
333
}
J
jsalling 已提交
334
#endif /* ! UNITY_EXCLUDE_FLOAT_PRINT */
M
Mark VanderVoord 已提交
335

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 577
/*-----------------------------------------------*/
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;
    }
}



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

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

597
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
598

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

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

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

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

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

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

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

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

708
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
709

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

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

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

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


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

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

768
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
769

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

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

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

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

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

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

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

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

838
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
839

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

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

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

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

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

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

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

898
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
899

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

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

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

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

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

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

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

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

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

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

996
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
997

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

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

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

1036
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1037

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

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

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

1080
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1081

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

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

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

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

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

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

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

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

1160
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1161

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

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

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

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

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

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

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

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

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

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

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

    UnityTestResultsBegin(Unity.TestFile, line);
1270
    UnityPrint(UnityStrFail);
M
Mark VanderVoord 已提交
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 1297
    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;
}

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

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

1314
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325
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();
    }
1326
    if (TEST_PROTECT())
M
Mark VanderVoord 已提交
1327 1328 1329 1330 1331 1332
    {
        tearDown();
    }
    UnityConcludeTest();
}

1333
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348
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();
}

1349
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1350 1351 1352 1353 1354
int UnityEnd(void)
{
    UNITY_PRINT_EOL();
    UnityPrint(UnityStrBreaker);
    UNITY_PRINT_EOL();
1355
    UnityPrintNumber((UNITY_INT)(Unity.NumberOfTests));
M
Mark VanderVoord 已提交
1356
    UnityPrint(UnityStrResultsTests);
1357
    UnityPrintNumber((UNITY_INT)(Unity.TestFailures));
M
Mark VanderVoord 已提交
1358
    UnityPrint(UnityStrResultsFailures);
1359
    UnityPrintNumber((UNITY_INT)(Unity.TestIgnores));
M
Mark VanderVoord 已提交
1360 1361 1362 1363
    UnityPrint(UnityStrResultsIgnored);
    UNITY_PRINT_EOL();
    if (Unity.TestFailures == 0U)
    {
1364
        UnityPrint(UnityStrOk);
M
Mark VanderVoord 已提交
1365 1366 1367
    }
    else
    {
1368
        UnityPrint(UnityStrFail);
1369 1370 1371
#ifdef UNITY_DIFFERENTIATE_FINAL_FAIL
        UNITY_OUTPUT_CHAR('E'); UNITY_OUTPUT_CHAR('D');
#endif
M
Mark VanderVoord 已提交
1372 1373
    }
    UNITY_PRINT_EOL();
1374
    UNITY_FLUSH_CALL();
M
Mark VanderVoord 已提交
1375 1376 1377 1378
    UNITY_OUTPUT_COMPLETE();
    return (int)(Unity.TestFailures);
}

1379 1380 1381
/*-----------------------------------------------
 * Command Line Argument Support
 *-----------------------------------------------*/
1382
#ifdef UNITY_USE_COMMAND_LINE_ARGS
1383 1384 1385

char* UnityOptionIncludeNamed = NULL;
char* UnityOptionExcludeNamed = NULL;
1386
int UnityVerbosity            = 1;
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396

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

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

    return 0;
}

1444
int IsStringInBiggerString(const char* longstring, const char* shortstring)
1445
{
1446 1447 1448
    const char* lptr = longstring;
    const char* sptr = shortstring;
    const char* lnext = lptr;
1449

1450 1451 1452
    if (*sptr == '*')
        return 1;

1453 1454 1455
    while (*lptr)
    {
        lnext = lptr + 1;
1456

1457 1458 1459 1460 1461
        /* If they current bytes match, go on to the next bytes */
        while (*lptr && *sptr && (*lptr == *sptr))
        {
            lptr++;
            sptr++;
1462

1463 1464 1465
            /* We're done if we match the entire string or up to a wildcard */
            if (*sptr == '*')
                return 1;
1466 1467 1468 1469 1470 1471 1472 1473
            if (*sptr == ',')
                return 1;
            if (*sptr == '"')
                return 1;
            if (*sptr == '\'')
                return 1;
            if (*sptr == ':')
                return 2;
1474 1475 1476 1477 1478 1479
            if (*sptr == 0)
                return 1;
        }

        /* Otherwise we start in the long pointer 1 character further and try again */
        lptr = lnext;
1480
        sptr = shortstring;
1481 1482
    }
    return 0;
1483 1484 1485 1486
}

int UnityStringArgumentMatches(const char* str)
{
1487 1488 1489
    int retval;
    const char* ptr1;
    const char* ptr2;
1490
    const char* ptrf;
1491

1492
    /* Go through the options and get the substrings for matching one at a time */
1493 1494 1495 1496 1497 1498
    ptr1 = str;
    while (ptr1[0] != 0)
    {
        if ((ptr1[0] == '"') || (ptr1[0] == '\''))
            ptr1++;

1499
        /* look for the start of the next partial */
1500
        ptr2 = ptr1;
1501
        ptrf = 0;
1502 1503
        do
        {
1504
            ptr2++;
1505 1506 1507 1508
            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] == ',')))
1509 1510
            ptr2++;

1511
        /* done if complete filename match */
1512 1513 1514 1515
        retval = IsStringInBiggerString(Unity.TestFile, ptr1);
        if (retval == 1)
            return retval;

1516
        /* done if testname match after filename partial match */
1517
        if ((retval == 2) && (ptrf != 0))
1518
        {
1519
            if (IsStringInBiggerString(Unity.CurrentTestName, ptrf))
1520 1521 1522
                return 1;
        }

1523
        /* done if complete testname match */
1524 1525 1526 1527 1528 1529
        if (IsStringInBiggerString(Unity.CurrentTestName, ptr1) == 1)
            return 1;

        ptr1 = ptr2;
    }

1530
    /* we couldn't find a match for any substrings */
1531
    return 0;
1532
}
1533

1534 1535 1536 1537 1538 1539 1540 1541 1542 1543
int UnityTestMatches(void)
{
    /* Check if this test name matches the included test pattern */
    int retval;
    if (UnityOptionIncludeNamed)
    {
        retval = UnityStringArgumentMatches(UnityOptionIncludeNamed);
    }
    else
        retval = 1;
1544

1545 1546 1547 1548 1549
    /* Check if this test name matches the excluded test pattern */
    if (UnityOptionExcludeNamed)
    {
        if (UnityStringArgumentMatches(UnityOptionExcludeNamed))
            retval = 0;
1550
    }
1551
    return retval;
1552 1553
}

1554
#endif /* UNITY_USE_COMMAND_LINE_ARGS */
1555
/*-----------------------------------------------*/