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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    for (i = 0; i < UNITY_INT_WIDTH; i++)
    {
        if (current_bit & mask)
        {
            if (current_bit & number)
            {
                UNITY_OUTPUT_CHAR('1');
            }
            else
            {
                UNITY_OUTPUT_CHAR('0');
            }
        }
        else
        {
            UNITY_OUTPUT_CHAR('X');
        }
        current_bit = current_bit >> 1;
    }
}

259
/*-----------------------------------------------*/
J
jsalling 已提交
260
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
261 262
/*
 * This function prints a floating-point value in a format similar to
263 264 265 266
 * printf("%.7g") on a single-precision machine or printf("%.9g") on a
 * double-precision machine.  The 7th digit won't always be totally correct
 * in single-precision operation (for that level of accuracy, a more
 * complicated algorithm would be needed).
267
 */
268
void UnityPrintFloat(const UNITY_DOUBLE input_number)
M
Mark VanderVoord 已提交
269
{
270 271 272 273 274 275 276 277 278 279
#ifdef UNITY_INCLUDE_DOUBLE
    static const int sig_digits = 9;
    static const UNITY_INT32 min_scaled = 100000000;
    static const UNITY_INT32 max_scaled = 1000000000;
#else
    static const int sig_digits = 7;
    static const UNITY_INT32 min_scaled = 1000000;
    static const UNITY_INT32 max_scaled = 10000000;
#endif

280
    UNITY_DOUBLE number = input_number;
281

282 283
    /* print minus sign (including for negative zero) */
    if (number < 0.0f || (number == 0.0f && 1.0f / number < 0.0f))
J
jsalling 已提交
284 285
    {
        UNITY_OUTPUT_CHAR('-');
286
        number = -number;
J
jsalling 已提交
287
    }
288

289 290 291 292 293
    /* 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 已提交
294
    {
J
John Lindgren 已提交
295
        UNITY_INT32 n_int = 0, n;
296
        int exponent = 0;
J
John Lindgren 已提交
297 298
        int decimals, digits;
        char buf[16];
299

300 301 302 303 304 305 306
        /*
         * Scale up or down by powers of 10.  To minimize rounding error,
         * start with a factor/divisor of 10^10, which is the largest
         * power of 10 that can be represented exactly.  Finally, compute
         * (exactly) the remaining power of 10 and perform one more
         * multiplication or division.
         */
307
        if (number < 1.0f)
308 309 310
        {
            UNITY_DOUBLE factor = 1.0f;

311 312
            while (number < (UNITY_DOUBLE)max_scaled / 1e10f) { number *= 1e10f; exponent -= 10; }
            while (number * factor < (UNITY_DOUBLE)min_scaled) { factor *= 10.0f; exponent--; }
313 314 315

            number *= factor;
        }
316
        else if (number > (UNITY_DOUBLE)max_scaled)
317 318 319
        {
            UNITY_DOUBLE divisor = 1.0f;

320 321
            while (number > (UNITY_DOUBLE)min_scaled * 1e10f) { number /= 1e10f; exponent += 10; }
            while (number / divisor > (UNITY_DOUBLE)max_scaled) { divisor *= 10.0f; exponent++; }
322 323 324

            number /= divisor;
        }
325 326 327 328 329 330 331 332
        else
        {
            /*
             * In this range, we can split off the integer part before
             * doing any multiplications.  This reduces rounding error by
             * freeing up significant bits in the fractional part.
             */
            UNITY_DOUBLE factor = 1.0f;
J
John Lindgren 已提交
333 334
            n_int = (UNITY_INT32)number;
            number -= (UNITY_DOUBLE)n_int;
335

J
John Lindgren 已提交
336
            while (n_int < min_scaled) { n_int *= 10; factor *= 10.0f; exponent--; }
337 338 339

            number *= factor;
        }
340 341

        /* round to nearest integer */
J
John Lindgren 已提交
342 343 344 345 346 347 348 349 350 351
        n = ((UNITY_INT32)(number + number) + 1) / 2;

#ifndef UNITY_ROUND_TIES_AWAY_FROM_ZERO
        /* round to even if exactly between two integers */
        if ((n & 1) && ((UNITY_DOUBLE)n - number == 0.5f))
            n--;
#endif

        n += n_int;

352
        if (n >= max_scaled)
353
        {
354
            n = min_scaled;
355
            exponent++;
356 357
        }

358
        /* determine where to place decimal point */
359
        decimals = (exponent <= 0 && exponent >= -(sig_digits + 3)) ? -exponent : (sig_digits - 1);
360 361 362 363
        exponent += decimals;

        /* truncate trailing zeroes after decimal point */
        while (decimals > 0 && n % 10 == 0)
364
        {
365 366 367 368 369
            n /= 10;
            decimals--;
        }

        /* build up buffer in reverse order */
J
John Lindgren 已提交
370
        digits = 0;
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
        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]);
            }
407
        }
J
jsalling 已提交
408
    }
M
Mark VanderVoord 已提交
409
}
J
jsalling 已提交
410
#endif /* ! UNITY_EXCLUDE_FLOAT_PRINT */
M
Mark VanderVoord 已提交
411

412
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
413 414 415 416
static void UnityTestResultsBegin(const char* file, const UNITY_LINE_TYPE line)
{
    UnityPrint(file);
    UNITY_OUTPUT_CHAR(':');
417
    UnityPrintNumber((UNITY_INT)line);
M
Mark VanderVoord 已提交
418 419 420 421 422
    UNITY_OUTPUT_CHAR(':');
    UnityPrint(Unity.CurrentTestName);
    UNITY_OUTPUT_CHAR(':');
}

423
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
424 425 426 427 428 429 430
static void UnityTestResultsFailBegin(const UNITY_LINE_TYPE line)
{
    UnityTestResultsBegin(Unity.TestFile, line);
    UnityPrint(UnityStrFail);
    UNITY_OUTPUT_CHAR(':');
}

431
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
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();
451
    UNITY_FLUSH_CALL();
M
Mark VanderVoord 已提交
452 453
}

454
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
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);
    }
}

477
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
478 479 480 481 482 483 484 485 486 487 488
static void UnityPrintExpectedAndActualStrings(const char* expected, const char* actual)
{
    UnityPrint(UnityStrExpected);
    if (expected != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrint(expected);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
489
        UnityPrint(UnityStrNull);
M
Mark VanderVoord 已提交
490 491 492 493 494 495 496 497 498 499
    }
    UnityPrint(UnityStrWas);
    if (actual != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrint(actual);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
500
        UnityPrint(UnityStrNull);
M
Mark VanderVoord 已提交
501 502 503
    }
}

504
/*-----------------------------------------------*/
505 506 507
static void UnityPrintExpectedAndActualStringsLen(const char* expected,
                                                  const char* actual,
                                                  const UNITY_UINT32 length)
M
Mark VanderVoord 已提交
508 509 510 511 512 513 514 515 516 517
{
    UnityPrint(UnityStrExpected);
    if (expected != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrintLen(expected, length);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
518
        UnityPrint(UnityStrNull);
M
Mark VanderVoord 已提交
519 520 521 522 523 524 525 526 527 528
    }
    UnityPrint(UnityStrWas);
    if (actual != NULL)
    {
        UNITY_OUTPUT_CHAR('\'');
        UnityPrintLen(actual, length);
        UNITY_OUTPUT_CHAR('\'');
    }
    else
    {
529
        UnityPrint(UnityStrNull);
M
Mark VanderVoord 已提交
530 531 532
    }
}

533 534 535
/*-----------------------------------------------
 * Assertion & Control Helpers
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
536

537 538 539 540
static int UnityIsOneArrayNull(UNITY_INTERNAL_PTR expected,
                               UNITY_INTERNAL_PTR actual,
                               const UNITY_LINE_TYPE lineNumber,
                               const char* msg)
M
Mark VanderVoord 已提交
541
{
542
    if (expected == actual) return 0; /* Both are NULL or same pointer */
M
Mark VanderVoord 已提交
543

544
    /* print and return true if just expected is NULL */
M
Mark VanderVoord 已提交
545 546 547 548 549
    if (expected == NULL)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrNullPointerForExpected);
        UnityAddMsgIfSpecified(msg);
550
        return 1;
M
Mark VanderVoord 已提交
551 552
    }

553
    /* print and return true if just actual is NULL */
M
Mark VanderVoord 已提交
554 555 556 557 558
    if (actual == NULL)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrNullPointerForActual);
        UnityAddMsgIfSpecified(msg);
559
        return 1;
M
Mark VanderVoord 已提交
560 561
    }

562
    return 0; /* return false if neither is NULL */
M
Mark VanderVoord 已提交
563 564
}

565 566 567
/*-----------------------------------------------
 * Assertion Functions
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
568

569 570 571
void UnityAssertBits(const UNITY_INT mask,
                     const UNITY_INT expected,
                     const UNITY_INT actual,
M
Mark VanderVoord 已提交
572 573 574
                     const char* msg,
                     const UNITY_LINE_TYPE lineNumber)
{
575
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
576 577 578 579 580

    if ((mask & expected) != (mask & actual))
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrExpected);
581
        UnityPrintMask((UNITY_UINT)mask, (UNITY_UINT)expected);
M
Mark VanderVoord 已提交
582
        UnityPrint(UnityStrWas);
583
        UnityPrintMask((UNITY_UINT)mask, (UNITY_UINT)actual);
M
Mark VanderVoord 已提交
584 585 586 587 588
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

589
/*-----------------------------------------------*/
590 591
void UnityAssertEqualNumber(const UNITY_INT expected,
                            const UNITY_INT actual,
M
Mark VanderVoord 已提交
592 593 594 595
                            const char* msg,
                            const UNITY_LINE_TYPE lineNumber,
                            const UNITY_DISPLAY_STYLE_T style)
{
596
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
597 598 599 600 601 602 603 604 605 606 607 608 609

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

610
/*-----------------------------------------------*/
611 612 613 614 615 616
void UnityAssertGreaterOrLessOrEqualNumber(const UNITY_INT threshold,
                                           const UNITY_INT actual,
                                           const UNITY_COMPARISON_T compare,
                                           const char *msg,
                                           const UNITY_LINE_TYPE lineNumber,
                                           const UNITY_DISPLAY_STYLE_T style)
617
{
618
    int failed = 0;
619 620
    RETURN_IF_FAIL_OR_IGNORE;

621 622 623 624
    if (threshold == actual && compare & UNITY_EQUAL_TO) return;
    if (threshold == actual) failed = 1;

    if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT)
625
    {
626 627 628 629 630 631 632
        if (actual > threshold && compare & UNITY_SMALLER_THAN) failed = 1;
        if (actual < threshold && compare & UNITY_GREATER_THAN) failed = 1;
    }
    else /* UINT or HEX */
    {
        if ((UNITY_UINT)actual > (UNITY_UINT)threshold && compare & UNITY_SMALLER_THAN) failed = 1;
        if ((UNITY_UINT)actual < (UNITY_UINT)threshold && compare & UNITY_GREATER_THAN) failed = 1;
633 634
    }

635
    if (failed)
636 637 638 639
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrExpected);
        UnityPrintNumberByStyle(actual, style);
640 641 642
        if (compare & UNITY_GREATER_THAN) UnityPrint(UnityStrGt);
        if (compare & UNITY_SMALLER_THAN) UnityPrint(UnityStrLt);
        if (compare & UNITY_EQUAL_TO)     UnityPrint(UnityStrOrEqual);
643 644 645 646 647 648
        UnityPrintNumberByStyle(threshold, style);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

649 650 651 652 653 654 655
#define UnityPrintPointlessAndBail()       \
{                                          \
    UnityTestResultsFailBegin(lineNumber); \
    UnityPrint(UnityStrPointless);         \
    UnityAddMsgIfSpecified(msg);           \
    UNITY_FAIL_AND_BAIL; }

656
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
657 658
void UnityAssertEqualIntArray(UNITY_INTERNAL_PTR expected,
                              UNITY_INTERNAL_PTR actual,
659
                              const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
660 661
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
662 663
                              const UNITY_DISPLAY_STYLE_T style,
                              const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
664
{
665
    UNITY_UINT32 elements = num_elements;
666
    unsigned int length   = style & 0xF;
M
Mark VanderVoord 已提交
667

668
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
669

670 671 672 673
    if (num_elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
674

675 676 677
    if (expected == actual) return; /* Both are NULL or same pointer */
    if (UnityIsOneArrayNull(expected, actual, lineNumber, msg))
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
678

679
    while (elements--)
M
Mark VanderVoord 已提交
680
    {
681 682
        UNITY_INT expect_val;
        UNITY_INT actual_val;
683 684 685 686 687 688 689 690 691 692
        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 已提交
693
#ifdef UNITY_SUPPORT_64
694 695 696 697
            case 8:
                expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)expected;
                actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)actual;
                break;
M
Mark VanderVoord 已提交
698
#endif
699 700 701 702 703
            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;
704 705 706 707
        }

        if (expect_val != actual_val)
        {
708
            if (style & UNITY_DISPLAY_RANGE_UINT && length < sizeof(expect_val))
709 710 711 712 713 714
            {   /* 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;
            }
715 716 717 718 719 720 721 722 723 724
            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;
        }
725 726 727 728
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
            expected = (UNITY_INTERNAL_PTR)(length + (const char*)expected);
        }
729
        actual   = (UNITY_INTERNAL_PTR)(length + (const char*)actual);
M
Mark VanderVoord 已提交
730 731 732
    }
}

733
/*-----------------------------------------------*/
734
#ifndef UNITY_EXCLUDE_FLOAT
735
/* Wrap this define in a function with variable types as float or double */
736
#define UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff)                       \
737
    if (isinf(expected) && isinf(actual) && ((expected < 0) == (actual < 0))) return 1;   \
738
    if (UNITY_NAN_CHECK) return 1;                                                        \
739
    diff = actual - expected;                                                             \
740 741
    if (diff < 0) diff = -diff;                                                           \
    if (delta < 0) delta = -delta;                                                        \
742
    return !(isnan(diff) || isinf(diff) || (diff > delta))
743
    /* This first part of this condition will catch any NaN or Infinite values */
744 745 746 747 748
#ifndef UNITY_NAN_NOT_EQUAL_NAN
  #define UNITY_NAN_CHECK isnan(expected) && isnan(actual)
#else
  #define UNITY_NAN_CHECK 0
#endif
749

750 751
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
  #define UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual) \
752
  {                                                               \
753 754 755
    UnityPrint(UnityStrExpected);                                 \
    UnityPrintFloat(expected);                                    \
    UnityPrint(UnityStrWas);                                      \
756
    UnityPrintFloat(actual); }
757 758 759 760 761
#else
  #define UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual) \
    UnityPrint(UnityStrDelta)
#endif /* UNITY_EXCLUDE_FLOAT_PRINT */

762
static int UnityFloatsWithin(UNITY_FLOAT delta, UNITY_FLOAT expected, UNITY_FLOAT actual)
763
{
764
    UNITY_FLOAT diff;
765 766 767
    UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff);
}

768 769 770
void UnityAssertEqualFloatArray(UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* expected,
                                UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* actual,
                                const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
771
                                const char* msg,
772 773
                                const UNITY_LINE_TYPE lineNumber,
                                const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
774
{
775
    UNITY_UINT32 elements = num_elements;
776 777
    UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* ptr_expected = expected;
    UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* ptr_actual = actual;
M
Mark VanderVoord 已提交
778

779
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
780

781 782 783 784
    if (elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
785

786 787 788
    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 已提交
789 790 791

    while (elements--)
    {
792
        if (!UnityFloatsWithin(*ptr_expected * UNITY_FLOAT_PRECISION, *ptr_expected, *ptr_actual))
M
Mark VanderVoord 已提交
793 794 795
        {
            UnityTestResultsFailBegin(lineNumber);
            UnityPrint(UnityStrElement);
796
            UnityPrintNumberUnsigned(num_elements - elements - 1);
797
            UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT((UNITY_DOUBLE)*ptr_expected, (UNITY_DOUBLE)*ptr_actual);
M
Mark VanderVoord 已提交
798 799 800
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
801 802 803 804
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
            ptr_expected++;
        }
805
        ptr_actual++;
M
Mark VanderVoord 已提交
806 807 808
    }
}

809
/*-----------------------------------------------*/
810 811 812
void UnityAssertFloatsWithin(const UNITY_FLOAT delta,
                             const UNITY_FLOAT expected,
                             const UNITY_FLOAT actual,
M
Mark VanderVoord 已提交
813 814 815
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber)
{
816
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
817 818


819
    if (!UnityFloatsWithin(delta, expected, actual))
M
Mark VanderVoord 已提交
820 821
    {
        UnityTestResultsFailBegin(lineNumber);
822
        UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT((UNITY_DOUBLE)expected, (UNITY_DOUBLE)actual);
M
Mark VanderVoord 已提交
823 824 825 826 827
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

828
/*-----------------------------------------------*/
829
void UnityAssertFloatSpecial(const UNITY_FLOAT actual,
M
Mark VanderVoord 已提交
830 831 832 833
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber,
                             const UNITY_FLOAT_TRAIT_T style)
{
834 835 836 837
    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 已提交
838

839
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
840

841
    switch (style)
M
Mark VanderVoord 已提交
842 843 844
    {
        case UNITY_FLOAT_IS_INF:
        case UNITY_FLOAT_IS_NOT_INF:
845
            is_trait = isinf(actual) && (actual > 0);
M
Mark VanderVoord 已提交
846 847 848
            break;
        case UNITY_FLOAT_IS_NEG_INF:
        case UNITY_FLOAT_IS_NOT_NEG_INF:
849
            is_trait = isinf(actual) && (actual < 0);
M
Mark VanderVoord 已提交
850 851 852 853
            break;

        case UNITY_FLOAT_IS_NAN:
        case UNITY_FLOAT_IS_NOT_NAN:
854
            is_trait = isnan(actual) ? 1 : 0;
M
Mark VanderVoord 已提交
855 856
            break;

857
        case UNITY_FLOAT_IS_DET: /* A determinate number is non infinite and not NaN. */
M
Mark VanderVoord 已提交
858
        case UNITY_FLOAT_IS_NOT_DET:
859
            is_trait = !isinf(actual) && !isnan(actual);
M
Mark VanderVoord 已提交
860 861 862
            break;

        default:
863 864 865
            trait_index = 0;
            trait_names[0] = UnityStrInvalidFloatTrait;
            break;
M
Mark VanderVoord 已提交
866 867 868 869 870 871 872 873 874 875
    }

    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 已提交
876
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
877
        UnityPrintFloat((UNITY_DOUBLE)actual);
M
Mark VanderVoord 已提交
878 879 880 881 882 883 884 885 886 887
#else
        if (should_be_trait)
            UnityPrint(UnityStrNot);
        UnityPrint(trait_names[trait_index]);
#endif
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

888
#endif /* not UNITY_EXCLUDE_FLOAT */
M
Mark VanderVoord 已提交
889

890
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
891
#ifndef UNITY_EXCLUDE_DOUBLE
892
static int UnityDoublesWithin(UNITY_DOUBLE delta, UNITY_DOUBLE expected, UNITY_DOUBLE actual)
893
{
894
    UNITY_DOUBLE diff;
895 896 897
    UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff);
}

898 899 900
void UnityAssertEqualDoubleArray(UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* expected,
                                 UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* actual,
                                 const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
901
                                 const char* msg,
902 903
                                 const UNITY_LINE_TYPE lineNumber,
                                 const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
904
{
905
    UNITY_UINT32 elements = num_elements;
906 907
    UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* ptr_expected = expected;
    UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* ptr_actual = actual;
M
Mark VanderVoord 已提交
908

909
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
910

911 912 913 914
    if (elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
915

916 917 918
    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 已提交
919 920 921

    while (elements--)
    {
922
        if (!UnityDoublesWithin(*ptr_expected * UNITY_DOUBLE_PRECISION, *ptr_expected, *ptr_actual))
M
Mark VanderVoord 已提交
923 924 925
        {
            UnityTestResultsFailBegin(lineNumber);
            UnityPrint(UnityStrElement);
926
            UnityPrintNumberUnsigned(num_elements - elements - 1);
927
            UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(*ptr_expected, *ptr_actual);
M
Mark VanderVoord 已提交
928 929 930
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
931 932 933 934
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
            ptr_expected++;
        }
935
        ptr_actual++;
M
Mark VanderVoord 已提交
936 937 938
    }
}

939
/*-----------------------------------------------*/
940 941 942
void UnityAssertDoublesWithin(const UNITY_DOUBLE delta,
                              const UNITY_DOUBLE expected,
                              const UNITY_DOUBLE actual,
M
Mark VanderVoord 已提交
943 944 945
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber)
{
946
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
947

948
    if (!UnityDoublesWithin(delta, expected, actual))
M
Mark VanderVoord 已提交
949 950
    {
        UnityTestResultsFailBegin(lineNumber);
951
        UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual);
M
Mark VanderVoord 已提交
952 953 954 955 956
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

957
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
958

959
void UnityAssertDoubleSpecial(const UNITY_DOUBLE actual,
M
Mark VanderVoord 已提交
960 961 962 963
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
                              const UNITY_FLOAT_TRAIT_T style)
{
964 965 966 967
    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 已提交
968

969
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
970

971
    switch (style)
M
Mark VanderVoord 已提交
972 973 974
    {
        case UNITY_FLOAT_IS_INF:
        case UNITY_FLOAT_IS_NOT_INF:
975
            is_trait = isinf(actual) && (actual > 0);
M
Mark VanderVoord 已提交
976 977 978
            break;
        case UNITY_FLOAT_IS_NEG_INF:
        case UNITY_FLOAT_IS_NOT_NEG_INF:
979
            is_trait = isinf(actual) && (actual < 0);
M
Mark VanderVoord 已提交
980 981 982 983
            break;

        case UNITY_FLOAT_IS_NAN:
        case UNITY_FLOAT_IS_NOT_NAN:
984
            is_trait = isnan(actual) ? 1 : 0;
M
Mark VanderVoord 已提交
985 986
            break;

987
        case UNITY_FLOAT_IS_DET: /* A determinate number is non infinite and not NaN. */
M
Mark VanderVoord 已提交
988
        case UNITY_FLOAT_IS_NOT_DET:
989
            is_trait = !isinf(actual) && !isnan(actual);
M
Mark VanderVoord 已提交
990 991 992
            break;

        default:
993 994 995
            trait_index = 0;
            trait_names[0] = UnityStrInvalidFloatTrait;
            break;
M
Mark VanderVoord 已提交
996 997 998 999 1000 1001 1002 1003 1004 1005
    }

    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 已提交
1006
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
M
Mark VanderVoord 已提交
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
        UnityPrintFloat(actual);
#else
        if (should_be_trait)
            UnityPrint(UnityStrNot);
        UnityPrint(trait_names[trait_index]);
#endif
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

1018
#endif /* not UNITY_EXCLUDE_DOUBLE */
M
Mark VanderVoord 已提交
1019

1020
/*-----------------------------------------------*/
1021 1022 1023 1024 1025 1026
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 已提交
1027
{
1028
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1029 1030 1031 1032

    if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT)
    {
        if (actual > expected)
M
Max Bruckner 已提交
1033
          Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(actual - expected) > delta);
M
Mark VanderVoord 已提交
1034
        else
M
Max Bruckner 已提交
1035
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(expected - actual) > delta);
M
Mark VanderVoord 已提交
1036 1037 1038
    }
    else
    {
1039
        if ((UNITY_UINT)actual > (UNITY_UINT)expected)
M
Max Bruckner 已提交
1040
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(actual - expected) > delta);
M
Mark VanderVoord 已提交
1041
        else
M
Max Bruckner 已提交
1042
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(expected - actual) > delta);
M
Mark VanderVoord 已提交
1043 1044 1045 1046 1047 1048
    }

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

1059
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1060 1061 1062 1063 1064
void UnityAssertEqualString(const char* expected,
                            const char* actual,
                            const char* msg,
                            const UNITY_LINE_TYPE lineNumber)
{
1065
    UNITY_UINT32 i;
M
Mark VanderVoord 已提交
1066

1067
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1068

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

    if (Unity.CurrentTestFailed)
    {
1091 1092 1093 1094
        UnityTestResultsFailBegin(lineNumber);
        UnityPrintExpectedAndActualStrings(expected, actual);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
1095 1096 1097
    }
}

1098
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1099
void UnityAssertEqualStringLen(const char* expected,
1100 1101 1102 1103
                               const char* actual,
                               const UNITY_UINT32 length,
                               const char* msg,
                               const UNITY_LINE_TYPE lineNumber)
M
Mark VanderVoord 已提交
1104
{
1105
    UNITY_UINT32 i;
M
Mark VanderVoord 已提交
1106

1107
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1108

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

    if (Unity.CurrentTestFailed)
    {
1131 1132 1133 1134
        UnityTestResultsFailBegin(lineNumber);
        UnityPrintExpectedAndActualStringsLen(expected, actual, length);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
1135 1136 1137
    }
}

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

1151
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1152

1153
    /* if no elements, it's an error */
1154 1155 1156 1157
    if (num_elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
1158

1159
    if ((const void*)expected == (const void*)actual)
1160 1161 1162 1163
    {
        return; /* Both are NULL or same pointer */
    }

1164
    if (UnityIsOneArrayNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg))
1165
    {
1166
        UNITY_FAIL_AND_BAIL;
1167 1168 1169 1170
    }

    if (flags != UNITY_ARRAY_TO_ARRAY)
    {
1171
        expd = (const char*)expected;
1172
    }
M
Mark VanderVoord 已提交
1173 1174 1175

    do
    {
1176 1177 1178
        act = actual[j];
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
1179
            expd = ((const char* const*)expected)[j];
1180 1181
        }

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

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

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

1231
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1232

1233 1234 1235 1236
    if ((elements == 0) || (length == 0))
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
1237

1238 1239 1240
    if (expected == actual) return; /* Both are NULL or same pointer */
    if (UnityIsOneArrayNull(expected, actual, lineNumber, msg))
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253

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

1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
/*-----------------------------------------------*/

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

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

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

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

1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
#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

1332 1333 1334
/*-----------------------------------------------
 * Control Functions
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
1335 1336 1337

void UnityFail(const char* msg, const UNITY_LINE_TYPE line)
{
1338
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1339 1340

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

1369
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1370 1371
void UnityIgnore(const char* msg, const UNITY_LINE_TYPE line)
{
1372
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1373 1374 1375 1376 1377

    UnityTestResultsBegin(Unity.TestFile, line);
    UnityPrint(UnityStrIgnore);
    if (msg != NULL)
    {
1378 1379 1380
        UNITY_OUTPUT_CHAR(':');
        UNITY_OUTPUT_CHAR(' ');
        UnityPrint(msg);
M
Mark VanderVoord 已提交
1381 1382 1383 1384
    }
    UNITY_IGNORE_AND_BAIL;
}

1385
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396
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();
    }
1397
    if (TEST_PROTECT())
M
Mark VanderVoord 已提交
1398 1399 1400 1401 1402 1403
    {
        tearDown();
    }
    UnityConcludeTest();
}

1404
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419
void UnityBegin(const char* filename)
{
    Unity.TestFile = filename;
    Unity.CurrentTestName = NULL;
    Unity.CurrentTestLineNumber = 0;
    Unity.NumberOfTests = 0;
    Unity.TestFailures = 0;
    Unity.TestIgnores = 0;
    Unity.CurrentTestFailed = 0;
    Unity.CurrentTestIgnored = 0;

    UNITY_CLR_DETAILS();
    UNITY_OUTPUT_START();
}

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

1450 1451 1452
/*-----------------------------------------------
 * Command Line Argument Support
 *-----------------------------------------------*/
1453
#ifdef UNITY_USE_COMMAND_LINE_ARGS
1454 1455 1456

char* UnityOptionIncludeNamed = NULL;
char* UnityOptionExcludeNamed = NULL;
1457
int UnityVerbosity            = 1;
1458 1459 1460 1461 1462 1463 1464 1465 1466 1467

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

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

    return 0;
}

1515
int IsStringInBiggerString(const char* longstring, const char* shortstring)
1516
{
1517 1518 1519
    const char* lptr = longstring;
    const char* sptr = shortstring;
    const char* lnext = lptr;
1520

1521 1522 1523
    if (*sptr == '*')
        return 1;

1524 1525 1526
    while (*lptr)
    {
        lnext = lptr + 1;
1527

1528 1529 1530 1531 1532
        /* If they current bytes match, go on to the next bytes */
        while (*lptr && *sptr && (*lptr == *sptr))
        {
            lptr++;
            sptr++;
1533

1534 1535 1536
            /* We're done if we match the entire string or up to a wildcard */
            if (*sptr == '*')
                return 1;
1537 1538 1539 1540 1541 1542 1543 1544
            if (*sptr == ',')
                return 1;
            if (*sptr == '"')
                return 1;
            if (*sptr == '\'')
                return 1;
            if (*sptr == ':')
                return 2;
1545 1546 1547 1548 1549 1550
            if (*sptr == 0)
                return 1;
        }

        /* Otherwise we start in the long pointer 1 character further and try again */
        lptr = lnext;
1551
        sptr = shortstring;
1552 1553
    }
    return 0;
1554 1555 1556 1557
}

int UnityStringArgumentMatches(const char* str)
{
1558 1559 1560
    int retval;
    const char* ptr1;
    const char* ptr2;
1561
    const char* ptrf;
1562

1563
    /* Go through the options and get the substrings for matching one at a time */
1564 1565 1566 1567 1568 1569
    ptr1 = str;
    while (ptr1[0] != 0)
    {
        if ((ptr1[0] == '"') || (ptr1[0] == '\''))
            ptr1++;

1570
        /* look for the start of the next partial */
1571
        ptr2 = ptr1;
1572
        ptrf = 0;
1573 1574
        do
        {
1575
            ptr2++;
1576 1577 1578 1579
            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] == ',')))
1580 1581
            ptr2++;

1582
        /* done if complete filename match */
1583 1584 1585 1586
        retval = IsStringInBiggerString(Unity.TestFile, ptr1);
        if (retval == 1)
            return retval;

1587
        /* done if testname match after filename partial match */
1588
        if ((retval == 2) && (ptrf != 0))
1589
        {
1590
            if (IsStringInBiggerString(Unity.CurrentTestName, ptrf))
1591 1592 1593
                return 1;
        }

1594
        /* done if complete testname match */
1595 1596 1597 1598 1599 1600
        if (IsStringInBiggerString(Unity.CurrentTestName, ptr1) == 1)
            return 1;

        ptr1 = ptr2;
    }

1601
    /* we couldn't find a match for any substrings */
1602
    return 0;
1603
}
1604

1605 1606 1607 1608 1609 1610 1611 1612 1613 1614
int UnityTestMatches(void)
{
    /* Check if this test name matches the included test pattern */
    int retval;
    if (UnityOptionIncludeNamed)
    {
        retval = UnityStringArgumentMatches(UnityOptionIncludeNamed);
    }
    else
        retval = 1;
1615

1616 1617 1618 1619 1620
    /* Check if this test name matches the excluded test pattern */
    if (UnityOptionExcludeNamed)
    {
        if (UnityStringArgumentMatches(UnityOptionExcludeNamed))
            retval = 0;
1621
    }
1622
    return retval;
1623 1624
}

1625
#endif /* UNITY_USE_COMMAND_LINE_ARGS */
1626
/*-----------------------------------------------*/