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

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

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

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

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

22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
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 ";
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";
37
#ifndef UNITY_EXCLUDE_FLOAT
38 39 40 41 42 43
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";
44
#endif
45 46 47 48 49 50 51 52 53
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 已提交
54

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

236
/*-----------------------------------------------*/
J
jsalling 已提交
237
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
J
jsalling 已提交
238
static void UnityPrintDecimalAndNumberWithLeadingZeros(UNITY_INT32 fraction_part, UNITY_INT32 divisor)
239 240 241 242 243 244 245 246 247 248
{
    UNITY_OUTPUT_CHAR('.');
    while (divisor > 0)
    {
        UNITY_OUTPUT_CHAR('0' + fraction_part / divisor);
        fraction_part %= divisor;
        divisor /= 10;
        if (fraction_part == 0) break; /* Truncate trailing 0's */
    }
}
J
jsalling 已提交
249
#ifndef UNITY_ROUND_TIES_AWAY_FROM_ZERO
J
jsalling 已提交
250 251 252 253
/* If rounds up && remainder 0.5 && result odd && below cutoff for double precision issues */
  #define ROUND_TIES_TO_EVEN(orig, num_int, num)                                          \
  if (num_int > (num) && (num) - (num_int-1) <= 0.5 && (num_int & 1) == 1 && orig < 1e22) \
    num_int -= 1 /* => a tie to round down to even */
J
jsalling 已提交
254
#else
J
jsalling 已提交
255
  #define ROUND_TIES_TO_EVEN(orig, num_int, num) /* Remove macro */
256 257
#endif

J
jsalling 已提交
258 259 260 261 262 263
/* Printing floating point numbers is hard. Some goals of this implementation: works for embedded
 * systems, floats or doubles, and has a reasonable format. The key paper in this area,
 * 'How to Print Floating-Point Numbers Accurately' by Steele & White, shows an approximation by
 * scaling called Dragon 2. This code uses a similar idea. The other core algorithm uses casts and
 * floating subtraction to give exact remainders after the decimal, to be scaled into an integer.
 * Extra trailing 0's are excluded. The output defaults to rounding to nearest, ties to even. You
J
jsalling 已提交
264
 * can enable rounding ties away from zero. Note: UNITY_DOUBLE param can typedef to float or double
J
jsalling 已提交
265 266 267 268 269 270

 * The old version required compiling in snprintf. For reference, with a similar format as now:
 *  char buf[19];
 *  if (number > 4294967296.0 || -number > 4294967296.0) snprintf(buf, sizeof buf, "%.8e", number);
 *  else                                                 snprintf(buf, sizeof buf, "%.6f", number);
 *  UnityPrint(buf);
271
 */
272
void UnityPrintFloat(const UNITY_DOUBLE input_number)
M
Mark VanderVoord 已提交
273
{
274 275 276
    UNITY_DOUBLE number;

    if (input_number < 0)
J
jsalling 已提交
277 278
    {
        UNITY_OUTPUT_CHAR('-');
279 280 281 282
        number = -input_number;
    } else
    {
        number = input_number;
J
jsalling 已提交
283
    }
284 285 286

    if (isnan(number)) UnityPrint(UnityStrNaN);
    else if (isinf(number)) UnityPrintLen(UnityStrInf, 3);
287 288
    else if (number <= 0.0000005 && number > 0) UnityPrint("0.000000..."); /* Small number */
    else if (number < 4294967295.9999995) /* Rounded result fits in 32 bits, "%.6f" format */
J
jsalling 已提交
289
    {
J
jsalling 已提交
290 291 292
        const UNITY_INT32 divisor = 1000000/10;
        UNITY_UINT32 integer_part = (UNITY_UINT32)number;
        UNITY_INT32 fraction_part = (UNITY_INT32)((number - (UNITY_DOUBLE)integer_part)*1000000.0 + 0.5);
293
        /* Double precision calculation gives best performance for six rounded decimal places */
J
jsalling 已提交
294
        ROUND_TIES_TO_EVEN(number, fraction_part, (number - (UNITY_DOUBLE)integer_part)*1000000.0);
295

296
        if (fraction_part == 1000000) /* Carry across the decimal point */
297
        {
298
            fraction_part = 0;
299 300 301 302
            integer_part += 1;
        }

        UnityPrintNumberUnsigned(integer_part);
303
        UnityPrintDecimalAndNumberWithLeadingZeros(fraction_part, divisor);
304
    }
305
    else /* Number is larger, use exponential format of 9 digits, "%.8e" */
306
    {
J
jsalling 已提交
307 308 309
        const UNITY_INT32 divisor = 1000000000/10;
        UNITY_INT32 integer_part;
        UNITY_DOUBLE_TYPE divide = 10.0;
310
        int exponent = 9;
311

312
        while (number / divide >= 1000000000.0 - 0.5)
313
        {
314 315
            divide *= 10;
            exponent++;
316
        }
J
jsalling 已提交
317
        integer_part = (UNITY_INT32)(number / divide + 0.5);
318
        /* Double precision calculation required for float, to produce 9 rounded digits */
J
jsalling 已提交
319
        ROUND_TIES_TO_EVEN(number, integer_part, number / divide);
320

321
        UNITY_OUTPUT_CHAR('0' + integer_part / divisor);
322
        UnityPrintDecimalAndNumberWithLeadingZeros(integer_part % divisor, divisor / 10);
323 324
        UNITY_OUTPUT_CHAR('e');
        UNITY_OUTPUT_CHAR('+');
325
        if (exponent < 10) UNITY_OUTPUT_CHAR('0');
326
        UnityPrintNumber(exponent);
J
jsalling 已提交
327
    }
M
Mark VanderVoord 已提交
328
}
J
jsalling 已提交
329
#endif /* ! UNITY_EXCLUDE_FLOAT_PRINT */
M
Mark VanderVoord 已提交
330

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

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

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

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

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

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

452 453 454
/*-----------------------------------------------
 * Assertion & Control Helpers
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
455

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

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

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

481
    return 0; /* return false if neither is NULL */
M
Mark VanderVoord 已提交
482 483
}

484 485 486
/*-----------------------------------------------
 * Assertion Functions
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
487

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

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

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

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

529 530 531 532 533 534 535
#define UnityPrintPointlessAndBail()       \
{                                          \
    UnityTestResultsFailBegin(lineNumber); \
    UnityPrint(UnityStrPointless);         \
    UnityAddMsgIfSpecified(msg);           \
    UNITY_FAIL_AND_BAIL; }

536
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
537 538
void UnityAssertEqualIntArray(UNITY_INTERNAL_PTR expected,
                              UNITY_INTERNAL_PTR actual,
539
                              const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
540 541
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
542 543
                              const UNITY_DISPLAY_STYLE_T style,
                              const UNITY_FLAGS_T flags)
M
Mark VanderVoord 已提交
544
{
545
    UNITY_UINT32 elements = num_elements;
546
    unsigned int length   = style & 0xF;
M
Mark VanderVoord 已提交
547

548
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
549

550 551 552 553
    if (num_elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
554

555 556 557
    if (expected == actual) return; /* Both are NULL or same pointer */
    if (UnityIsOneArrayNull(expected, actual, lineNumber, msg))
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
558

559
    while (elements--)
M
Mark VanderVoord 已提交
560
    {
561 562
        UNITY_INT expect_val;
        UNITY_INT actual_val;
563 564 565 566 567 568 569 570 571 572
        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 已提交
573
#ifdef UNITY_SUPPORT_64
574 575 576 577
            case 8:
                expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)expected;
                actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)actual;
                break;
M
Mark VanderVoord 已提交
578
#endif
579 580 581 582 583
            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;
584 585 586 587
        }

        if (expect_val != actual_val)
        {
588
            if (style & UNITY_DISPLAY_RANGE_UINT && length < sizeof(expect_val))
589 590 591 592 593 594
            {   /* 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;
            }
595 596 597 598 599 600 601 602 603 604
            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;
        }
605 606 607 608
        if (flags == UNITY_ARRAY_TO_ARRAY)
        {
            expected = (UNITY_INTERNAL_PTR)(length + (const char*)expected);
        }
609
        actual   = (UNITY_INTERNAL_PTR)(length + (const char*)actual);
M
Mark VanderVoord 已提交
610 611 612
    }
}

613
/*-----------------------------------------------*/
614
#ifndef UNITY_EXCLUDE_FLOAT
615
/* Wrap this define in a function with variable types as float or double */
616
#define UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff)                       \
617
    if (isinf(expected) && isinf(actual) && ((expected < 0) == (actual < 0))) return 1;   \
618
    if (UNITY_NAN_CHECK) return 1;                                                        \
619
    diff = actual - expected;                                                             \
620 621
    if (diff < 0) diff = -diff;                                                           \
    if (delta < 0) delta = -delta;                                                        \
622
    return !(isnan(diff) || isinf(diff) || (diff > delta))
623
    /* This first part of this condition will catch any NaN or Infinite values */
624 625 626 627 628
#ifndef UNITY_NAN_NOT_EQUAL_NAN
  #define UNITY_NAN_CHECK isnan(expected) && isnan(actual)
#else
  #define UNITY_NAN_CHECK 0
#endif
629

630 631
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
  #define UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual) \
632
  {                                                               \
633 634 635
    UnityPrint(UnityStrExpected);                                 \
    UnityPrintFloat(expected);                                    \
    UnityPrint(UnityStrWas);                                      \
636
    UnityPrintFloat(actual); }
637 638 639 640 641
#else
  #define UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual) \
    UnityPrint(UnityStrDelta)
#endif /* UNITY_EXCLUDE_FLOAT_PRINT */

642
static int UnityFloatsWithin(UNITY_FLOAT delta, UNITY_FLOAT expected, UNITY_FLOAT actual)
643
{
644
    UNITY_FLOAT diff;
645 646 647
    UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff);
}

648 649 650
void UnityAssertEqualFloatArray(UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* expected,
                                UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* actual,
                                const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
651 652 653
                                const char* msg,
                                const UNITY_LINE_TYPE lineNumber)
{
654
    UNITY_UINT32 elements = num_elements;
655 656
    UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* ptr_expected = expected;
    UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* ptr_actual = actual;
M
Mark VanderVoord 已提交
657

658
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
659

660 661 662 663
    if (elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
664

665 666 667
    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 已提交
668 669 670

    while (elements--)
    {
671
        if (!UnityFloatsWithin(*ptr_expected * UNITY_FLOAT_PRECISION, *ptr_expected, *ptr_actual))
M
Mark VanderVoord 已提交
672 673 674
        {
            UnityTestResultsFailBegin(lineNumber);
            UnityPrint(UnityStrElement);
675
            UnityPrintNumberUnsigned(num_elements - elements - 1);
676
            UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT((UNITY_DOUBLE)*ptr_expected, (UNITY_DOUBLE)*ptr_actual);
M
Mark VanderVoord 已提交
677 678 679
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
680 681
        ptr_expected++;
        ptr_actual++;
M
Mark VanderVoord 已提交
682 683 684
    }
}

685
/*-----------------------------------------------*/
686 687 688
void UnityAssertFloatsWithin(const UNITY_FLOAT delta,
                             const UNITY_FLOAT expected,
                             const UNITY_FLOAT actual,
M
Mark VanderVoord 已提交
689 690 691
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber)
{
692
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
693 694


695
    if (!UnityFloatsWithin(delta, expected, actual))
M
Mark VanderVoord 已提交
696 697
    {
        UnityTestResultsFailBegin(lineNumber);
698
        UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT((UNITY_DOUBLE)expected, (UNITY_DOUBLE)actual);
M
Mark VanderVoord 已提交
699 700 701 702 703
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

704
/*-----------------------------------------------*/
705
void UnityAssertFloatSpecial(const UNITY_FLOAT actual,
M
Mark VanderVoord 已提交
706 707 708 709
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber,
                             const UNITY_FLOAT_TRAIT_T style)
{
710 711 712 713
    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 已提交
714

715
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
716

717
    switch (style)
M
Mark VanderVoord 已提交
718 719 720
    {
        case UNITY_FLOAT_IS_INF:
        case UNITY_FLOAT_IS_NOT_INF:
721
            is_trait = isinf(actual) && (actual > 0);
M
Mark VanderVoord 已提交
722 723 724
            break;
        case UNITY_FLOAT_IS_NEG_INF:
        case UNITY_FLOAT_IS_NOT_NEG_INF:
725
            is_trait = isinf(actual) && (actual < 0);
M
Mark VanderVoord 已提交
726 727 728 729
            break;

        case UNITY_FLOAT_IS_NAN:
        case UNITY_FLOAT_IS_NOT_NAN:
730
            is_trait = isnan(actual) ? 1 : 0;
M
Mark VanderVoord 已提交
731 732
            break;

733
        case UNITY_FLOAT_IS_DET: /* A determinate number is non infinite and not NaN. */
M
Mark VanderVoord 已提交
734
        case UNITY_FLOAT_IS_NOT_DET:
735
            is_trait = !isinf(actual) && !isnan(actual);
M
Mark VanderVoord 已提交
736 737 738
            break;

        default:
739 740 741
            trait_index = 0;
            trait_names[0] = UnityStrInvalidFloatTrait;
            break;
M
Mark VanderVoord 已提交
742 743 744 745 746 747 748 749 750 751
    }

    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 已提交
752
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
753
        UnityPrintFloat((UNITY_DOUBLE)actual);
M
Mark VanderVoord 已提交
754 755 756 757 758 759 760 761 762 763
#else
        if (should_be_trait)
            UnityPrint(UnityStrNot);
        UnityPrint(trait_names[trait_index]);
#endif
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

764
#endif /* not UNITY_EXCLUDE_FLOAT */
M
Mark VanderVoord 已提交
765

766
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
767
#ifndef UNITY_EXCLUDE_DOUBLE
768
static int UnityDoublesWithin(UNITY_DOUBLE delta, UNITY_DOUBLE expected, UNITY_DOUBLE actual)
769
{
770
    UNITY_DOUBLE diff;
771 772 773
    UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff);
}

774 775 776
void UnityAssertEqualDoubleArray(UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* expected,
                                 UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* actual,
                                 const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
777 778 779
                                 const char* msg,
                                 const UNITY_LINE_TYPE lineNumber)
{
780
    UNITY_UINT32 elements = num_elements;
781 782
    UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* ptr_expected = expected;
    UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* ptr_actual = actual;
M
Mark VanderVoord 已提交
783

784
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
785

786 787 788 789
    if (elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
790

791 792 793
    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 已提交
794 795 796

    while (elements--)
    {
797
        if (!UnityDoublesWithin(*ptr_expected * UNITY_DOUBLE_PRECISION, *ptr_expected, *ptr_actual))
M
Mark VanderVoord 已提交
798 799 800
        {
            UnityTestResultsFailBegin(lineNumber);
            UnityPrint(UnityStrElement);
801
            UnityPrintNumberUnsigned(num_elements - elements - 1);
802
            UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(*ptr_expected, *ptr_actual);
M
Mark VanderVoord 已提交
803 804 805
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
806 807
        ptr_expected++;
        ptr_actual++;
M
Mark VanderVoord 已提交
808 809 810
    }
}

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

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

829
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
830

831
void UnityAssertDoubleSpecial(const UNITY_DOUBLE actual,
M
Mark VanderVoord 已提交
832 833 834 835
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
                              const UNITY_FLOAT_TRAIT_T style)
{
836 837 838 839
    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 已提交
840

841
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
842

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

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

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

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

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

890
#endif /* not UNITY_EXCLUDE_DOUBLE */
M
Mark VanderVoord 已提交
891

892
/*-----------------------------------------------*/
893 894 895 896 897 898
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 已提交
899
{
900
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
901 902 903 904

    if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT)
    {
        if (actual > expected)
M
Max Bruckner 已提交
905
          Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(actual - expected) > delta);
M
Mark VanderVoord 已提交
906
        else
M
Max Bruckner 已提交
907
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(expected - actual) > delta);
M
Mark VanderVoord 已提交
908 909 910
    }
    else
    {
911
        if ((UNITY_UINT)actual > (UNITY_UINT)expected)
M
Max Bruckner 已提交
912
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(actual - expected) > delta);
M
Mark VanderVoord 已提交
913
        else
M
Max Bruckner 已提交
914
            Unity.CurrentTestFailed = (UNITY_UINT)((UNITY_UINT)(expected - actual) > delta);
M
Mark VanderVoord 已提交
915 916 917 918 919 920
    }

    if (Unity.CurrentTestFailed)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrDelta);
921
        UnityPrintNumberByStyle((UNITY_INT)delta, style);
M
Mark VanderVoord 已提交
922 923 924 925 926 927 928 929 930
        UnityPrint(UnityStrExpected);
        UnityPrintNumberByStyle(expected, style);
        UnityPrint(UnityStrWas);
        UnityPrintNumberByStyle(actual, style);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

931
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
932 933 934 935 936
void UnityAssertEqualString(const char* expected,
                            const char* actual,
                            const char* msg,
                            const UNITY_LINE_TYPE lineNumber)
{
937
    UNITY_UINT32 i;
M
Mark VanderVoord 已提交
938

939
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
940

941
    /* if both pointers not null compare the strings */
M
Mark VanderVoord 已提交
942 943 944 945 946 947 948 949 950 951 952 953
    if (expected && actual)
    {
        for (i = 0; expected[i] || actual[i]; i++)
        {
            if (expected[i] != actual[i])
            {
                Unity.CurrentTestFailed = 1;
                break;
            }
        }
    }
    else
954
    { /* handle case of one pointers being null (if both null, test should pass) */
M
Mark VanderVoord 已提交
955 956 957 958 959 960 961 962
        if (expected != actual)
        {
            Unity.CurrentTestFailed = 1;
        }
    }

    if (Unity.CurrentTestFailed)
    {
963 964 965 966
        UnityTestResultsFailBegin(lineNumber);
        UnityPrintExpectedAndActualStrings(expected, actual);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
967 968 969
    }
}

970
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
971
void UnityAssertEqualStringLen(const char* expected,
972 973 974 975
                               const char* actual,
                               const UNITY_UINT32 length,
                               const char* msg,
                               const UNITY_LINE_TYPE lineNumber)
M
Mark VanderVoord 已提交
976
{
977
    UNITY_UINT32 i;
M
Mark VanderVoord 已提交
978

979
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
980

981
    /* if both pointers not null compare the strings */
M
Mark VanderVoord 已提交
982 983
    if (expected && actual)
    {
984
        for (i = 0; (i < length) && (expected[i] || actual[i]); i++)
M
Mark VanderVoord 已提交
985 986 987 988 989 990 991 992 993
        {
            if (expected[i] != actual[i])
            {
                Unity.CurrentTestFailed = 1;
                break;
            }
        }
    }
    else
994
    { /* handle case of one pointers being null (if both null, test should pass) */
M
Mark VanderVoord 已提交
995 996 997 998 999 1000 1001 1002
        if (expected != actual)
        {
            Unity.CurrentTestFailed = 1;
        }
    }

    if (Unity.CurrentTestFailed)
    {
1003 1004 1005 1006
        UnityTestResultsFailBegin(lineNumber);
        UnityPrintExpectedAndActualStringsLen(expected, actual, length);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
1007 1008 1009
    }
}

1010
/*-----------------------------------------------*/
1011 1012 1013 1014 1015
void UnityAssertEqualStringArray(const char** expected,
                                 const char** actual,
                                 const UNITY_UINT32 num_elements,
                                 const char* msg,
                                 const UNITY_LINE_TYPE lineNumber)
M
Mark VanderVoord 已提交
1016
{
1017
    UNITY_UINT32 i, j = 0;
M
Mark VanderVoord 已提交
1018

1019
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1020

1021
    /* if no elements, it's an error */
1022 1023 1024 1025
    if (num_elements == 0)
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
1026

1027 1028 1029
    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 已提交
1030 1031 1032

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

        if (Unity.CurrentTestFailed)
        {
            UnityTestResultsFailBegin(lineNumber);
            if (num_elements > 1)
            {
                UnityPrint(UnityStrElement);
1059
                UnityPrintNumberUnsigned(j);
M
Mark VanderVoord 已提交
1060 1061 1062 1063 1064 1065 1066 1067
            }
            UnityPrintExpectedAndActualStrings((const char*)(expected[j]), (const char*)(actual[j]));
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
    } while (++j < num_elements);
}

1068
/*-----------------------------------------------*/
1069 1070 1071 1072 1073 1074
void UnityAssertEqualMemory(UNITY_INTERNAL_PTR expected,
                            UNITY_INTERNAL_PTR actual,
                            const UNITY_UINT32 length,
                            const UNITY_UINT32 num_elements,
                            const char* msg,
                            const UNITY_LINE_TYPE lineNumber)
M
Mark VanderVoord 已提交
1075 1076 1077
{
    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;
1078 1079
    UNITY_UINT32 elements = num_elements;
    UNITY_UINT32 bytes;
M
Mark VanderVoord 已提交
1080

1081
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1082

1083 1084 1085 1086
    if ((elements == 0) || (length == 0))
    {
        UnityPrintPointlessAndBail();
    }
M
Mark VanderVoord 已提交
1087

1088 1089 1090
    if (expected == actual) return; /* Both are NULL or same pointer */
    if (UnityIsOneArrayNull(expected, actual, lineNumber, msg))
        UNITY_FAIL_AND_BAIL;
M
Mark VanderVoord 已提交
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103

    while (elements--)
    {
        bytes = length;
        while (bytes--)
        {
            if (*ptr_exp != *ptr_act)
            {
                UnityTestResultsFailBegin(lineNumber);
                UnityPrint(UnityStrMemory);
                if (num_elements > 1)
                {
                    UnityPrint(UnityStrElement);
1104
                    UnityPrintNumberUnsigned(num_elements - elements - 1);
M
Mark VanderVoord 已提交
1105 1106
                }
                UnityPrint(UnityStrByte);
1107
                UnityPrintNumberUnsigned(length - bytes - 1);
M
Mark VanderVoord 已提交
1108 1109 1110 1111 1112 1113 1114
                UnityPrint(UnityStrExpected);
                UnityPrintNumberByStyle(*ptr_exp, UNITY_DISPLAY_STYLE_HEX8);
                UnityPrint(UnityStrWas);
                UnityPrintNumberByStyle(*ptr_act, UNITY_DISPLAY_STYLE_HEX8);
                UnityAddMsgIfSpecified(msg);
                UNITY_FAIL_AND_BAIL;
            }
1115 1116
            ptr_exp++;
            ptr_act++;
M
Mark VanderVoord 已提交
1117 1118 1119 1120
        }
    }
}

1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
/*-----------------------------------------------*/

static union
{
    UNITY_INT8 i8;
    UNITY_INT16 i16;
    UNITY_INT32 i32;
#ifdef UNITY_SUPPORT_64
    UNITY_INT64 i64;
#endif
} UnityQuickCompare;

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

        case 2:
          UnityQuickCompare.i16 = num;
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i16);

#ifdef UNITY_SUPPORT_64
        case 8:
          UnityQuickCompare.i64 = num;
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i64);
#endif
        default: //4 bytes
          UnityQuickCompare.i32 = num;
          return (UNITY_INTERNAL_PTR)(&UnityQuickCompare.i32);
    }
}

1156 1157 1158
/*-----------------------------------------------
 * Control Functions
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
1159 1160 1161

void UnityFail(const char* msg, const UNITY_LINE_TYPE line)
{
1162
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1163 1164

    UnityTestResultsBegin(Unity.TestFile, line);
1165
    UnityPrint(UnityStrFail);
M
Mark VanderVoord 已提交
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192
    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;
}

1193
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1194 1195
void UnityIgnore(const char* msg, const UNITY_LINE_TYPE line)
{
1196
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1197 1198 1199 1200 1201

    UnityTestResultsBegin(Unity.TestFile, line);
    UnityPrint(UnityStrIgnore);
    if (msg != NULL)
    {
1202 1203 1204
        UNITY_OUTPUT_CHAR(':');
        UNITY_OUTPUT_CHAR(' ');
        UnityPrint(msg);
M
Mark VanderVoord 已提交
1205 1206 1207 1208
    }
    UNITY_IGNORE_AND_BAIL;
}

1209
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1210
#if defined(UNITY_WEAK_ATTRIBUTE)
1211 1212
  UNITY_WEAK_ATTRIBUTE void setUp(void) { }
  UNITY_WEAK_ATTRIBUTE void tearDown(void) { }
M
Mark VanderVoord 已提交
1213
#elif defined(UNITY_WEAK_PRAGMA)
1214 1215 1216 1217
  #pragma weak setUp
  void setUp(void) { }
  #pragma weak tearDown
  void tearDown(void) { }
M
Mark VanderVoord 已提交
1218
#endif
1219

1220
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231
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();
    }
1232
    if (TEST_PROTECT())
M
Mark VanderVoord 已提交
1233 1234 1235 1236 1237 1238
    {
        tearDown();
    }
    UnityConcludeTest();
}

1239
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
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();
}

1255
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1256 1257 1258 1259 1260
int UnityEnd(void)
{
    UNITY_PRINT_EOL();
    UnityPrint(UnityStrBreaker);
    UNITY_PRINT_EOL();
1261
    UnityPrintNumber((UNITY_INT)(Unity.NumberOfTests));
M
Mark VanderVoord 已提交
1262
    UnityPrint(UnityStrResultsTests);
1263
    UnityPrintNumber((UNITY_INT)(Unity.TestFailures));
M
Mark VanderVoord 已提交
1264
    UnityPrint(UnityStrResultsFailures);
1265
    UnityPrintNumber((UNITY_INT)(Unity.TestIgnores));
M
Mark VanderVoord 已提交
1266 1267 1268 1269
    UnityPrint(UnityStrResultsIgnored);
    UNITY_PRINT_EOL();
    if (Unity.TestFailures == 0U)
    {
1270
        UnityPrint(UnityStrOk);
M
Mark VanderVoord 已提交
1271 1272 1273
    }
    else
    {
1274
        UnityPrint(UnityStrFail);
1275 1276 1277
#ifdef UNITY_DIFFERENTIATE_FINAL_FAIL
        UNITY_OUTPUT_CHAR('E'); UNITY_OUTPUT_CHAR('D');
#endif
M
Mark VanderVoord 已提交
1278 1279
    }
    UNITY_PRINT_EOL();
1280
    UNITY_FLUSH_CALL();
M
Mark VanderVoord 已提交
1281 1282 1283 1284
    UNITY_OUTPUT_COMPLETE();
    return (int)(Unity.TestFailures);
}

1285 1286 1287
/*-----------------------------------------------
 * Command Line Argument Support
 *-----------------------------------------------*/
1288
#ifdef UNITY_USE_COMMAND_LINE_ARGS
1289 1290 1291

char* UnityOptionIncludeNamed = NULL;
char* UnityOptionExcludeNamed = NULL;
1292
int UnityVerbosity            = 1;
1293 1294 1295 1296 1297 1298 1299 1300 1301 1302

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

    for (int i = 1; i < argc; i++)
    {
        if (argv[i][0] == '-')
        {
1303
            switch (argv[i][1])
1304 1305
            {
                case 'l': /* list tests */
1306
                    return -1;
1307
                case 'n': /* include tests with name including this string */
1308 1309 1310 1311
                case 'f': /* an alias for -n */
                    if (argv[i][2] == '=')
                        UnityOptionIncludeNamed = &argv[i][3];
                    else if (++i < argc)
1312 1313 1314 1315 1316
                        UnityOptionIncludeNamed = argv[i];
                    else
                    {
                        UnityPrint("ERROR: No Test String to Include Matches For");
                        UNITY_PRINT_EOL();
1317
                        return 1;
1318 1319 1320 1321 1322 1323 1324 1325 1326
                    }
                    break;
                case 'q': /* quiet */
                    UnityVerbosity = 0;
                    break;
                case 'v': /* verbose */
                    UnityVerbosity = 2;
                    break;
                case 'x': /* exclude tests with name including this string */
1327 1328 1329
                    if (argv[i][2] == '=')
                        UnityOptionExcludeNamed = &argv[i][3];
                    else if (++i < argc)
1330 1331 1332 1333 1334
                        UnityOptionExcludeNamed = argv[i];
                    else
                    {
                        UnityPrint("ERROR: No Test String to Exclude Matches For");
                        UNITY_PRINT_EOL();
1335
                        return 1;
1336 1337 1338 1339
                    }
                    break;
                default:
                    UnityPrint("ERROR: Unknown Option ");
1340
                    UNITY_OUTPUT_CHAR(argv[i][1]);
1341 1342 1343 1344 1345 1346 1347 1348 1349
                    UNITY_PRINT_EOL();
                    return 1;
            }
        }
    }

    return 0;
}

1350
int IsStringInBiggerString(const char* longstring, const char* shortstring)
1351
{
1352 1353 1354
    char* lptr = (char*)longstring;
    char* sptr = (char*)shortstring;
    char* lnext = lptr;
1355

1356 1357 1358
    if (*sptr == '*')
        return 1;

1359 1360 1361
    while (*lptr)
    {
        lnext = lptr + 1;
1362

1363 1364 1365 1366 1367
        /* If they current bytes match, go on to the next bytes */
        while (*lptr && *sptr && (*lptr == *sptr))
        {
            lptr++;
            sptr++;
1368

1369 1370 1371
            /* We're done if we match the entire string or up to a wildcard */
            if (*sptr == '*')
                return 1;
1372 1373 1374 1375 1376 1377 1378 1379
            if (*sptr == ',')
                return 1;
            if (*sptr == '"')
                return 1;
            if (*sptr == '\'')
                return 1;
            if (*sptr == ':')
                return 2;
1380 1381 1382 1383 1384 1385 1386 1387 1388
            if (*sptr == 0)
                return 1;
        }

        /* Otherwise we start in the long pointer 1 character further and try again */
        lptr = lnext;
        sptr = (char*)shortstring;
    }
    return 0;
1389 1390 1391 1392
}

int UnityStringArgumentMatches(const char* str)
{
1393 1394 1395
    int retval;
    const char* ptr1;
    const char* ptr2;
1396
    const char* ptrf;
1397

1398
    /* Go through the options and get the substrings for matching one at a time */
1399 1400 1401 1402 1403 1404
    ptr1 = str;
    while (ptr1[0] != 0)
    {
        if ((ptr1[0] == '"') || (ptr1[0] == '\''))
            ptr1++;

1405
        /* look for the start of the next partial */
1406
        ptr2 = ptr1;
1407
        ptrf = 0;
1408 1409
        do
        {
1410
            ptr2++;
1411 1412 1413 1414
            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] == ',')))
1415 1416
            ptr2++;

1417
        /* done if complete filename match */
1418 1419 1420 1421
        retval = IsStringInBiggerString(Unity.TestFile, ptr1);
        if (retval == 1)
            return retval;

1422
        /* done if testname match after filename partial match */
1423
        if ((retval == 2) && (ptrf != 0))
1424
        {
1425
            if (IsStringInBiggerString(Unity.CurrentTestName, ptrf))
1426 1427 1428
                return 1;
        }

1429
        /* done if complete testname match */
1430 1431 1432 1433 1434 1435
        if (IsStringInBiggerString(Unity.CurrentTestName, ptr1) == 1)
            return 1;

        ptr1 = ptr2;
    }

1436
    /* we couldn't find a match for any substrings */
1437
    return 0;
1438
}
1439

1440 1441 1442 1443 1444 1445 1446 1447 1448 1449
int UnityTestMatches(void)
{
    /* Check if this test name matches the included test pattern */
    int retval;
    if (UnityOptionIncludeNamed)
    {
        retval = UnityStringArgumentMatches(UnityOptionIncludeNamed);
    }
    else
        retval = 1;
1450

1451 1452 1453 1454 1455
    /* Check if this test name matches the excluded test pattern */
    if (UnityOptionExcludeNamed)
    {
        if (UnityStringArgumentMatches(UnityOptionExcludeNamed))
            retval = 0;
1456
    }
1457
    return retval;
1458 1459
}

1460
#endif /* UNITY_USE_COMMAND_LINE_ARGS */
1461
/*-----------------------------------------------*/