unity.c 45.2 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 */
M
Mark VanderVoord 已提交
16 17
#define UNITY_FAIL_AND_BAIL   { Unity.CurrentTestFailed  = 1; longjmp(Unity.AbortFrame, 1); }
#define UNITY_IGNORE_AND_BAIL { Unity.CurrentTestIgnored = 1; longjmp(Unity.AbortFrame, 1); }
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
/* compiler-generic print formatting masks */
56
static const UNITY_UINT UnitySizeMask[] =
M
Mark VanderVoord 已提交
57
{
58 59
    255u,         /* 0xFF */
    65535u,       /* 0xFFFF */
M
Mark VanderVoord 已提交
60
    65535u,
61
    4294967295u,  /* 0xFFFFFFFF */
M
Mark VanderVoord 已提交
62 63 64 65 66 67 68 69
    4294967295u,
    4294967295u,
    4294967295u
#ifdef UNITY_SUPPORT_64
    ,0xFFFFFFFFFFFFFFFF
#endif
};

70 71 72
/*-----------------------------------------------
 * Pretty Printers & Test Result Output Handlers
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
73 74 75 76 77 78 79 80 81

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

    if (pch != NULL)
    {
        while (*pch)
        {
82
            /* printable characters plus CR & LF are printed */
M
Mark VanderVoord 已提交
83 84 85 86
            if ((*pch <= 126) && (*pch >= 32))
            {
                UNITY_OUTPUT_CHAR(*pch);
            }
87
            /* write escaped carriage returns */
M
Mark VanderVoord 已提交
88 89 90 91 92
            else if (*pch == 13)
            {
                UNITY_OUTPUT_CHAR('\\');
                UNITY_OUTPUT_CHAR('r');
            }
93
            /* write escaped line feeds */
M
Mark VanderVoord 已提交
94 95 96 97 98
            else if (*pch == 10)
            {
                UNITY_OUTPUT_CHAR('\\');
                UNITY_OUTPUT_CHAR('n');
            }
99
            /* unprintable characters are shown as codes */
M
Mark VanderVoord 已提交
100 101 102
            else
            {
                UNITY_OUTPUT_CHAR('\\');
103
                UNITY_OUTPUT_CHAR('x');
104
                UnityPrintNumberHex((UNITY_UINT)*pch, 2);
M
Mark VanderVoord 已提交
105 106 107 108 109 110
            }
            pch++;
        }
    }
}

111 112
void UnityPrintLen(const char* string, const UNITY_UINT32 length);
void UnityPrintLen(const char* string, const UNITY_UINT32 length)
M
Mark VanderVoord 已提交
113 114 115 116 117
{
    const char* pch = string;

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

149
/*-----------------------------------------------*/
150
void UnityPrintNumberByStyle(const UNITY_INT number, const UNITY_DISPLAY_STYLE_T style)
M
Mark VanderVoord 已提交
151 152 153 154 155 156 157
{
    if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT)
    {
        UnityPrintNumber(number);
    }
    else if ((style & UNITY_DISPLAY_RANGE_UINT) == UNITY_DISPLAY_RANGE_UINT)
    {
158
        UnityPrintNumberUnsigned(  (UNITY_UINT)number  &  UnitySizeMask[((UNITY_UINT)style & (UNITY_UINT)0x0F) - 1]  );
M
Mark VanderVoord 已提交
159 160 161
    }
    else
    {
162 163
        UNITY_OUTPUT_CHAR('0');
        UNITY_OUTPUT_CHAR('x');
164
        UnityPrintNumberHex((UNITY_UINT)number, (char)((style & 0x000F) << 1));
M
Mark VanderVoord 已提交
165 166 167
    }
}

168
/*-----------------------------------------------*/
169
void UnityPrintNumber(const UNITY_INT number_to_print)
M
Mark VanderVoord 已提交
170
{
171
    UNITY_UINT number = (UNITY_UINT)number_to_print;
M
Mark VanderVoord 已提交
172 173 174

    if (number_to_print < 0)
    {
175
        /* A negative number, including MIN negative */
M
Mark VanderVoord 已提交
176
        UNITY_OUTPUT_CHAR('-');
177
        number = (UNITY_UINT)(-number_to_print);
M
Mark VanderVoord 已提交
178
    }
179
    UnityPrintNumberUnsigned(number);
M
Mark VanderVoord 已提交
180 181
}

182 183
/*-----------------------------------------------
 * basically do an itoa using as little ram as possible */
184
void UnityPrintNumberUnsigned(const UNITY_UINT number)
M
Mark VanderVoord 已提交
185
{
186
    UNITY_UINT divisor = 1;
M
Mark VanderVoord 已提交
187

188
    /* figure out initial divisor */
M
Mark VanderVoord 已提交
189 190
    while (number / divisor > 9)
    {
191
        divisor *= 10;
M
Mark VanderVoord 已提交
192 193
    }

194
    /* now mod and print, then divide divisor */
M
Mark VanderVoord 已提交
195 196 197 198 199 200 201 202
    do
    {
        UNITY_OUTPUT_CHAR((char)('0' + (number / divisor % 10)));
        divisor /= 10;
    }
    while (divisor > 0);
}

203
/*-----------------------------------------------*/
204
void UnityPrintNumberHex(const UNITY_UINT number, const char nibbles_to_print)
M
Mark VanderVoord 已提交
205
{
206
    UNITY_UINT nibble;
M
Mark VanderVoord 已提交
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
    char nibbles = nibbles_to_print;

    while (nibbles > 0)
    {
        nibble = (number >> (--nibbles << 2)) & 0x0000000F;
        if (nibble <= 9)
        {
            UNITY_OUTPUT_CHAR((char)('0' + nibble));
        }
        else
        {
            UNITY_OUTPUT_CHAR((char)('A' - 10 + nibble));
        }
    }
}

223
/*-----------------------------------------------*/
224
void UnityPrintMask(const UNITY_UINT mask, const UNITY_UINT number)
M
Mark VanderVoord 已提交
225
{
226 227
    UNITY_UINT current_bit = (UNITY_UINT)1 << (UNITY_INT_WIDTH - 1);
    UNITY_INT32 i;
M
Mark VanderVoord 已提交
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249

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

250
/*-----------------------------------------------*/
J
jsalling 已提交
251
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
J
jsalling 已提交
252
static void UnityPrintDecimalAndNumberWithLeadingZeros(UNITY_INT32 fraction_part, UNITY_INT32 divisor)
253 254 255 256 257 258 259 260 261 262
{
    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 已提交
263
#ifndef UNITY_ROUND_TIES_AWAY_FROM_ZERO
J
jsalling 已提交
264 265 266 267
/* 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 已提交
268
#else
J
jsalling 已提交
269
  #define ROUND_TIES_TO_EVEN(orig, num_int, num) /* Remove macro */
270 271
#endif

J
jsalling 已提交
272 273 274 275 276 277
/* 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 已提交
278
 * can enable rounding ties away from zero. Note: UNITY_DOUBLE param can typedef to float or double
J
jsalling 已提交
279 280 281 282 283 284

 * 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);
285
 */
286
void UnityPrintFloat(UNITY_DOUBLE number)
M
Mark VanderVoord 已提交
287
{
J
jsalling 已提交
288 289 290 291 292
    if (number < 0)
    {
        UNITY_OUTPUT_CHAR('-');
        number = -number;
    }
293 294 295

    if (isnan(number)) UnityPrint(UnityStrNaN);
    else if (isinf(number)) UnityPrintLen(UnityStrInf, 3);
296 297
    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 已提交
298
    {
J
jsalling 已提交
299 300 301
        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);
302
        /* Double precision calculation gives best performance for six rounded decimal places */
J
jsalling 已提交
303
        ROUND_TIES_TO_EVEN(number, fraction_part, (number - (UNITY_DOUBLE)integer_part)*1000000.0);
304

305
        if (fraction_part == 1000000) /* Carry across the decimal point */
306
        {
307
            fraction_part = 0;
308 309 310 311
            integer_part += 1;
        }

        UnityPrintNumberUnsigned(integer_part);
312
        UnityPrintDecimalAndNumberWithLeadingZeros(fraction_part, divisor);
313
    }
314
    else /* Number is larger, use exponential format of 9 digits, "%.8e" */
315
    {
J
jsalling 已提交
316 317 318
        const UNITY_INT32 divisor = 1000000000/10;
        UNITY_INT32 integer_part;
        UNITY_DOUBLE_TYPE divide = 10.0;
319
        int exponent = 9;
320

321
        while (number / divide >= 1000000000.0 - 0.5)
322
        {
323 324
            divide *= 10;
            exponent++;
325
        }
J
jsalling 已提交
326
        integer_part = (UNITY_INT32)(number / divide + 0.5);
327
        /* Double precision calculation required for float, to produce 9 rounded digits */
J
jsalling 已提交
328
        ROUND_TIES_TO_EVEN(number, integer_part, number / divide);
329

330
        UNITY_OUTPUT_CHAR('0' + integer_part / divisor);
331
        UnityPrintDecimalAndNumberWithLeadingZeros(integer_part % divisor, divisor / 10);
332 333
        UNITY_OUTPUT_CHAR('e');
        UNITY_OUTPUT_CHAR('+');
334
        if (exponent < 10) UNITY_OUTPUT_CHAR('0');
335
        UnityPrintNumber(exponent);
J
jsalling 已提交
336
    }
M
Mark VanderVoord 已提交
337
}
J
jsalling 已提交
338
#endif /* ! UNITY_EXCLUDE_FLOAT_PRINT */
M
Mark VanderVoord 已提交
339

340
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
341 342 343 344 345 346 347 348 349 350 351 352 353

void UnityPrintFail(void);
void UnityPrintFail(void)
{
    UnityPrint(UnityStrFail);
}

void UnityPrintOk(void);
void UnityPrintOk(void)
{
    UnityPrint(UnityStrOk);
}

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

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

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

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

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

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

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



479 480 481
/*-----------------------------------------------
 * Assertion & Control Helpers
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
482 483 484

static int UnityCheckArraysForNull(UNITY_INTERNAL_PTR expected, UNITY_INTERNAL_PTR actual, const UNITY_LINE_TYPE lineNumber, const char* msg)
{
485
    /* return true if they are both NULL */
M
Mark VanderVoord 已提交
486 487 488
    if ((expected == NULL) && (actual == NULL))
        return 1;

489
    /* throw error if just expected is NULL */
M
Mark VanderVoord 已提交
490 491 492 493 494 495 496 497
    if (expected == NULL)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrNullPointerForExpected);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }

498
    /* throw error if just actual is NULL */
M
Mark VanderVoord 已提交
499 500 501 502 503 504 505 506
    if (actual == NULL)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrNullPointerForActual);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }

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

511 512 513
/*-----------------------------------------------
 * Assertion Functions
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
514

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

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

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

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

556 557 558 559 560 561 562
#define UnityPrintPointlessAndBail()       \
{                                          \
    UnityTestResultsFailBegin(lineNumber); \
    UnityPrint(UnityStrPointless);         \
    UnityAddMsgIfSpecified(msg);           \
    UNITY_FAIL_AND_BAIL; }

563
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
564 565
void UnityAssertEqualIntArray(UNITY_INTERNAL_PTR expected,
                              UNITY_INTERNAL_PTR actual,
566
                              const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
567 568 569 570
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
                              const UNITY_DISPLAY_STYLE_T style)
{
571
    UNITY_UINT32 elements = num_elements;
572
    unsigned int length   = style & 0xF;
M
Mark VanderVoord 已提交
573

574
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
575

576
    if (num_elements == 0)
M
Mark VanderVoord 已提交
577
    {
578
        UnityPrintPointlessAndBail();
M
Mark VanderVoord 已提交
579 580 581 582 583
    }

    if (UnityCheckArraysForNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg) == 1)
        return;

584
    while (elements--)
M
Mark VanderVoord 已提交
585
    {
586 587
        UNITY_INT expect_val;
        UNITY_INT actual_val;
588 589 590 591 592 593 594 595 596 597 598 599 600
        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;
            default: /* length 4 bytes */
                expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT32*)expected;
                actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT32*)actual;
601
                length = 4;
602
                break;
M
Mark VanderVoord 已提交
603
#ifdef UNITY_SUPPORT_64
604 605 606 607
            case 8:
                expect_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)expected;
                actual_val = *(UNITY_PTR_ATTRIBUTE const UNITY_INT64*)actual;
                break;
M
Mark VanderVoord 已提交
608
#endif
609 610 611 612
        }

        if (expect_val != actual_val)
        {
613 614 615 616 617 618 619
            if (style & UNITY_DISPLAY_RANGE_UINT && length < sizeof expect_val)
            {   /* 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;
            }
620 621 622 623 624 625 626 627 628 629
            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;
        }
630 631
        expected = (UNITY_INTERNAL_PTR)(length + (const char*)expected);
        actual   = (UNITY_INTERNAL_PTR)(length + (const char*)actual);
M
Mark VanderVoord 已提交
632 633 634
    }
}

635
/*-----------------------------------------------*/
636
#ifndef UNITY_EXCLUDE_FLOAT
637
/* Wrap this define in a function with variable types as float or double */
638
#define UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff)                       \
639
    if (isinf(expected) && isinf(actual) && ((expected < 0) == (actual < 0))) return 1;   \
640
    if (UNITY_NAN_CHECK) return 1;                                                        \
641
    diff = actual - expected;                                                             \
642 643
    if (diff < 0) diff = -diff;                                                           \
    if (delta < 0) delta = -delta;                                                        \
644
    return !(isnan(diff) || isinf(diff) || (diff > delta))
645
    /* This first part of this condition will catch any NaN or Infinite values */
646 647 648 649 650
#ifndef UNITY_NAN_NOT_EQUAL_NAN
  #define UNITY_NAN_CHECK isnan(expected) && isnan(actual)
#else
  #define UNITY_NAN_CHECK 0
#endif
651

652 653 654 655 656 657 658 659 660 661 662 663 664
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
  #define UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual) \
    do {                                                          \
    UnityPrint(UnityStrExpected);                                 \
    UnityPrintFloat(expected);                                    \
    UnityPrint(UnityStrWas);                                      \
    UnityPrintFloat(actual);                                      \
    } while(0)
#else
  #define UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual) \
    UnityPrint(UnityStrDelta)
#endif /* UNITY_EXCLUDE_FLOAT_PRINT */

665
static int UnityFloatsWithin(UNITY_FLOAT delta, UNITY_FLOAT expected, UNITY_FLOAT actual)
666
{
667
    UNITY_FLOAT diff;
668 669 670
    UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff);
}

671 672 673
void UnityAssertEqualFloatArray(UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* expected,
                                UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* actual,
                                const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
674 675 676
                                const char* msg,
                                const UNITY_LINE_TYPE lineNumber)
{
677 678 679
    UNITY_UINT32 elements = num_elements;
    UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* ptr_expected = expected;
    UNITY_PTR_ATTRIBUTE const UNITY_FLOAT* ptr_actual = actual;
M
Mark VanderVoord 已提交
680

681
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
682 683 684

    if (elements == 0)
    {
685
        UnityPrintPointlessAndBail();
M
Mark VanderVoord 已提交
686 687 688 689 690 691 692
    }

    if (UnityCheckArraysForNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg) == 1)
        return;

    while (elements--)
    {
693
        if (!UnityFloatsWithin(*ptr_expected * UNITY_FLOAT_PRECISION, *ptr_expected, *ptr_actual))
M
Mark VanderVoord 已提交
694 695 696
        {
            UnityTestResultsFailBegin(lineNumber);
            UnityPrint(UnityStrElement);
697
            UnityPrintNumberUnsigned(num_elements - elements - 1);
698
            UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(*ptr_expected, *ptr_actual);
M
Mark VanderVoord 已提交
699 700 701 702 703 704 705 706
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
        ptr_expected++;
        ptr_actual++;
    }
}

707
/*-----------------------------------------------*/
708 709 710
void UnityAssertFloatsWithin(const UNITY_FLOAT delta,
                             const UNITY_FLOAT expected,
                             const UNITY_FLOAT actual,
M
Mark VanderVoord 已提交
711 712 713
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber)
{
714
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
715 716


717
    if (!UnityFloatsWithin(delta, expected, actual))
M
Mark VanderVoord 已提交
718 719
    {
        UnityTestResultsFailBegin(lineNumber);
720
        UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual);
M
Mark VanderVoord 已提交
721 722 723 724 725
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

726
/*-----------------------------------------------*/
727
void UnityAssertFloatSpecial(const UNITY_FLOAT actual,
M
Mark VanderVoord 已提交
728 729 730 731 732
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber,
                             const UNITY_FLOAT_TRAIT_T style)
{
    const char* trait_names[] = { UnityStrInf, UnityStrNegInf, UnityStrNaN, UnityStrDet };
733 734 735
    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 已提交
736

737
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
738 739 740 741 742

    switch(style)
    {
        case UNITY_FLOAT_IS_INF:
        case UNITY_FLOAT_IS_NOT_INF:
743
            is_trait = isinf(actual) && (actual > 0);
M
Mark VanderVoord 已提交
744 745 746
            break;
        case UNITY_FLOAT_IS_NEG_INF:
        case UNITY_FLOAT_IS_NOT_NEG_INF:
747
            is_trait = isinf(actual) && (actual < 0);
M
Mark VanderVoord 已提交
748 749 750 751
            break;

        case UNITY_FLOAT_IS_NAN:
        case UNITY_FLOAT_IS_NOT_NAN:
752
            is_trait = isnan(actual) ? 1 : 0;
M
Mark VanderVoord 已提交
753 754
            break;

755
        case UNITY_FLOAT_IS_DET: /* A determinate number is non infinite and not NaN. */
M
Mark VanderVoord 已提交
756
        case UNITY_FLOAT_IS_NOT_DET:
757
            is_trait = !isinf(actual) && !isnan(actual);
M
Mark VanderVoord 已提交
758 759 760
            break;

        default:
761 762 763
            trait_index = 0;
            trait_names[0] = UnityStrInvalidFloatTrait;
            break;
M
Mark VanderVoord 已提交
764 765 766 767 768 769 770 771 772 773
    }

    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 已提交
774
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
M
Mark VanderVoord 已提交
775 776 777 778 779 780 781 782 783 784 785
        UnityPrintFloat(actual);
#else
        if (should_be_trait)
            UnityPrint(UnityStrNot);
        UnityPrint(trait_names[trait_index]);
#endif
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

786
#endif /* not UNITY_EXCLUDE_FLOAT */
M
Mark VanderVoord 已提交
787

788
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
789
#ifndef UNITY_EXCLUDE_DOUBLE
790
static int UnityDoublesWithin(UNITY_DOUBLE delta, UNITY_DOUBLE expected, UNITY_DOUBLE actual)
791
{
792
    UNITY_DOUBLE diff;
793 794 795
    UNITY_FLOAT_OR_DOUBLE_WITHIN(delta, expected, actual, diff);
}

796 797 798
void UnityAssertEqualDoubleArray(UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* expected,
                                 UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* actual,
                                 const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
799 800 801
                                 const char* msg,
                                 const UNITY_LINE_TYPE lineNumber)
{
802 803 804
    UNITY_UINT32 elements = num_elements;
    UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* ptr_expected = expected;
    UNITY_PTR_ATTRIBUTE const UNITY_DOUBLE* ptr_actual = actual;
M
Mark VanderVoord 已提交
805

806
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
807 808 809

    if (elements == 0)
    {
810
        UnityPrintPointlessAndBail();
M
Mark VanderVoord 已提交
811 812 813 814 815 816 817
    }

    if (UnityCheckArraysForNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg) == 1)
        return;

    while (elements--)
    {
818
        if (!UnityDoublesWithin(*ptr_expected * UNITY_DOUBLE_PRECISION, *ptr_expected, *ptr_actual))
M
Mark VanderVoord 已提交
819 820 821
        {
            UnityTestResultsFailBegin(lineNumber);
            UnityPrint(UnityStrElement);
822
            UnityPrintNumberUnsigned(num_elements - elements - 1);
823
            UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(*ptr_expected, *ptr_actual);
M
Mark VanderVoord 已提交
824 825 826 827 828 829 830 831
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
        ptr_expected++;
        ptr_actual++;
    }
}

832
/*-----------------------------------------------*/
833 834 835
void UnityAssertDoublesWithin(const UNITY_DOUBLE delta,
                              const UNITY_DOUBLE expected,
                              const UNITY_DOUBLE actual,
M
Mark VanderVoord 已提交
836 837 838
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber)
{
839
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
840

841
    if (!UnityDoublesWithin(delta, expected, actual))
M
Mark VanderVoord 已提交
842 843
    {
        UnityTestResultsFailBegin(lineNumber);
844
        UNITY_PRINT_EXPECTED_AND_ACTUAL_FLOAT(expected, actual);
M
Mark VanderVoord 已提交
845 846 847 848 849
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

850
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
851

852
void UnityAssertDoubleSpecial(const UNITY_DOUBLE actual,
M
Mark VanderVoord 已提交
853 854 855 856 857
                              const char* msg,
                              const UNITY_LINE_TYPE lineNumber,
                              const UNITY_FLOAT_TRAIT_T style)
{
    const char* trait_names[] = { UnityStrInf, UnityStrNegInf, UnityStrNaN, UnityStrDet };
858 859 860
    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 已提交
861

862
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
863 864 865 866 867

     switch(style)
    {
        case UNITY_FLOAT_IS_INF:
        case UNITY_FLOAT_IS_NOT_INF:
868
            is_trait = isinf(actual) && (actual > 0);
M
Mark VanderVoord 已提交
869 870 871
            break;
        case UNITY_FLOAT_IS_NEG_INF:
        case UNITY_FLOAT_IS_NOT_NEG_INF:
872
            is_trait = isinf(actual) && (actual < 0);
M
Mark VanderVoord 已提交
873 874 875 876
            break;

        case UNITY_FLOAT_IS_NAN:
        case UNITY_FLOAT_IS_NOT_NAN:
877
            is_trait = isnan(actual) ? 1 : 0;
M
Mark VanderVoord 已提交
878 879
            break;

880
        case UNITY_FLOAT_IS_DET: /* A determinate number is non infinite and not NaN. */
M
Mark VanderVoord 已提交
881
        case UNITY_FLOAT_IS_NOT_DET:
882
            is_trait = !isinf(actual) && !isnan(actual);
M
Mark VanderVoord 已提交
883 884 885
            break;

        default:
886 887 888
            trait_index = 0;
            trait_names[0] = UnityStrInvalidFloatTrait;
            break;
M
Mark VanderVoord 已提交
889 890 891 892 893 894 895 896 897 898
    }

    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 已提交
899
#ifndef UNITY_EXCLUDE_FLOAT_PRINT
M
Mark VanderVoord 已提交
900 901 902 903 904 905 906 907 908 909 910 911
        UnityPrintFloat(actual);
#else
        if (should_be_trait)
            UnityPrint(UnityStrNot);
        UnityPrint(trait_names[trait_index]);
#endif
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}


912
#endif /* not UNITY_EXCLUDE_DOUBLE */
M
Mark VanderVoord 已提交
913

914
/*-----------------------------------------------*/
915 916 917
void UnityAssertNumbersWithin( const UNITY_UINT delta,
                               const UNITY_INT expected,
                               const UNITY_INT actual,
M
Mark VanderVoord 已提交
918 919 920 921
                               const char* msg,
                               const UNITY_LINE_TYPE lineNumber,
                               const UNITY_DISPLAY_STYLE_T style)
{
922
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
923 924 925 926

    if ((style & UNITY_DISPLAY_RANGE_INT) == UNITY_DISPLAY_RANGE_INT)
    {
        if (actual > expected)
927
            Unity.CurrentTestFailed = ((UNITY_UINT)(actual - expected) > delta);
M
Mark VanderVoord 已提交
928
        else
929
            Unity.CurrentTestFailed = ((UNITY_UINT)(expected - actual) > delta);
M
Mark VanderVoord 已提交
930 931 932
    }
    else
    {
933 934
        if ((UNITY_UINT)actual > (UNITY_UINT)expected)
            Unity.CurrentTestFailed = ((UNITY_UINT)(actual - expected) > delta);
M
Mark VanderVoord 已提交
935
        else
936
            Unity.CurrentTestFailed = ((UNITY_UINT)(expected - actual) > delta);
M
Mark VanderVoord 已提交
937 938 939 940 941 942
    }

    if (Unity.CurrentTestFailed)
    {
        UnityTestResultsFailBegin(lineNumber);
        UnityPrint(UnityStrDelta);
943
        UnityPrintNumberByStyle((UNITY_INT)delta, style);
M
Mark VanderVoord 已提交
944 945 946 947 948 949 950 951 952
        UnityPrint(UnityStrExpected);
        UnityPrintNumberByStyle(expected, style);
        UnityPrint(UnityStrWas);
        UnityPrintNumberByStyle(actual, style);
        UnityAddMsgIfSpecified(msg);
        UNITY_FAIL_AND_BAIL;
    }
}

953
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
954 955 956 957 958
void UnityAssertEqualString(const char* expected,
                            const char* actual,
                            const char* msg,
                            const UNITY_LINE_TYPE lineNumber)
{
959
    UNITY_UINT32 i;
M
Mark VanderVoord 已提交
960

961
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
962

963
    /* if both pointers not null compare the strings */
M
Mark VanderVoord 已提交
964 965 966 967 968 969 970 971 972 973 974 975
    if (expected && actual)
    {
        for (i = 0; expected[i] || actual[i]; i++)
        {
            if (expected[i] != actual[i])
            {
                Unity.CurrentTestFailed = 1;
                break;
            }
        }
    }
    else
976
    { /* handle case of one pointers being null (if both null, test should pass) */
M
Mark VanderVoord 已提交
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
        if (expected != actual)
        {
            Unity.CurrentTestFailed = 1;
        }
    }

    if (Unity.CurrentTestFailed)
    {
      UnityTestResultsFailBegin(lineNumber);
      UnityPrintExpectedAndActualStrings(expected, actual);
      UnityAddMsgIfSpecified(msg);
      UNITY_FAIL_AND_BAIL;
    }
}

992
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
993 994
void UnityAssertEqualStringLen(const char* expected,
                            const char* actual,
995
                            const UNITY_UINT32 length,
M
Mark VanderVoord 已提交
996 997 998
                            const char* msg,
                            const UNITY_LINE_TYPE lineNumber)
{
999
    UNITY_UINT32 i;
M
Mark VanderVoord 已提交
1000

1001
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1002

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

    if (Unity.CurrentTestFailed)
    {
      UnityTestResultsFailBegin(lineNumber);
      UnityPrintExpectedAndActualStringsLen(expected, actual, length);
      UnityAddMsgIfSpecified(msg);
      UNITY_FAIL_AND_BAIL;
    }
}


1033
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1034 1035
void UnityAssertEqualStringArray( const char** expected,
                                  const char** actual,
1036
                                  const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
1037 1038 1039
                                  const char* msg,
                                  const UNITY_LINE_TYPE lineNumber)
{
1040
    UNITY_UINT32 i, j = 0;
M
Mark VanderVoord 已提交
1041

1042
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1043

1044
    /* if no elements, it's an error */
M
Mark VanderVoord 已提交
1045 1046
    if (num_elements == 0)
    {
1047
        UnityPrintPointlessAndBail();
M
Mark VanderVoord 已提交
1048 1049 1050 1051 1052 1053 1054
    }

    if (UnityCheckArraysForNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg) == 1)
        return;

    do
    {
1055
        /* if both pointers not null compare the strings */
M
Mark VanderVoord 已提交
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
        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
1068
        { /* handle case of one pointers being null (if both null, test should pass) */
M
Mark VanderVoord 已提交
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
            if (expected[j] != actual[j])
            {
                Unity.CurrentTestFailed = 1;
            }
        }

        if (Unity.CurrentTestFailed)
        {
            UnityTestResultsFailBegin(lineNumber);
            if (num_elements > 1)
            {
                UnityPrint(UnityStrElement);
1081
                UnityPrintNumberUnsigned(j);
M
Mark VanderVoord 已提交
1082 1083 1084 1085 1086 1087 1088 1089
            }
            UnityPrintExpectedAndActualStrings((const char*)(expected[j]), (const char*)(actual[j]));
            UnityAddMsgIfSpecified(msg);
            UNITY_FAIL_AND_BAIL;
        }
    } while (++j < num_elements);
}

1090
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1091 1092
void UnityAssertEqualMemory( UNITY_INTERNAL_PTR expected,
                             UNITY_INTERNAL_PTR actual,
1093 1094
                             const UNITY_UINT32 length,
                             const UNITY_UINT32 num_elements,
M
Mark VanderVoord 已提交
1095 1096 1097 1098 1099
                             const char* msg,
                             const UNITY_LINE_TYPE lineNumber)
{
    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;
1100 1101
    UNITY_UINT32 elements = num_elements;
    UNITY_UINT32 bytes;
M
Mark VanderVoord 已提交
1102

1103
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1104 1105 1106

    if ((elements == 0) || (length == 0))
    {
1107
        UnityPrintPointlessAndBail();
M
Mark VanderVoord 已提交
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
    }

    if (UnityCheckArraysForNull((UNITY_INTERNAL_PTR)expected, (UNITY_INTERNAL_PTR)actual, lineNumber, msg) == 1)
        return;

    while (elements--)
    {
        bytes = length;
        while (bytes--)
        {
            if (*ptr_exp != *ptr_act)
            {
                UnityTestResultsFailBegin(lineNumber);
                UnityPrint(UnityStrMemory);
                if (num_elements > 1)
                {
                    UnityPrint(UnityStrElement);
1125
                    UnityPrintNumberUnsigned(num_elements - elements - 1);
M
Mark VanderVoord 已提交
1126 1127
                }
                UnityPrint(UnityStrByte);
1128
                UnityPrintNumberUnsigned(length - bytes - 1);
M
Mark VanderVoord 已提交
1129 1130 1131 1132 1133 1134 1135
                UnityPrint(UnityStrExpected);
                UnityPrintNumberByStyle(*ptr_exp, UNITY_DISPLAY_STYLE_HEX8);
                UnityPrint(UnityStrWas);
                UnityPrintNumberByStyle(*ptr_act, UNITY_DISPLAY_STYLE_HEX8);
                UnityAddMsgIfSpecified(msg);
                UNITY_FAIL_AND_BAIL;
            }
1136 1137
            ptr_exp++;
            ptr_act++;
M
Mark VanderVoord 已提交
1138 1139 1140 1141
        }
    }
}

1142 1143 1144
/*-----------------------------------------------
 * Control Functions
 *-----------------------------------------------*/
M
Mark VanderVoord 已提交
1145 1146 1147

void UnityFail(const char* msg, const UNITY_LINE_TYPE line)
{
1148
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178

    UnityTestResultsBegin(Unity.TestFile, line);
    UnityPrintFail();
    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;
}

1179
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1180 1181
void UnityIgnore(const char* msg, const UNITY_LINE_TYPE line)
{
1182
    RETURN_IF_FAIL_OR_IGNORE;
M
Mark VanderVoord 已提交
1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194

    UnityTestResultsBegin(Unity.TestFile, line);
    UnityPrint(UnityStrIgnore);
    if (msg != NULL)
    {
      UNITY_OUTPUT_CHAR(':');
      UNITY_OUTPUT_CHAR(' ');
      UnityPrint(msg);
    }
    UNITY_IGNORE_AND_BAIL;
}

1195
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1196 1197 1198 1199 1200 1201 1202 1203 1204
#if defined(UNITY_WEAK_ATTRIBUTE)
    UNITY_WEAK_ATTRIBUTE void setUp(void) { }
    UNITY_WEAK_ATTRIBUTE void tearDown(void) { }
#elif defined(UNITY_WEAK_PRAGMA)
#   pragma weak setUp
    void setUp(void) { }
#   pragma weak tearDown
    void tearDown(void) { }
#endif
1205
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
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();
    }
1217
    if (TEST_PROTECT())
M
Mark VanderVoord 已提交
1218 1219 1220 1221 1222 1223
    {
        tearDown();
    }
    UnityConcludeTest();
}

1224
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
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();
}

1240
/*-----------------------------------------------*/
M
Mark VanderVoord 已提交
1241 1242 1243 1244 1245
int UnityEnd(void)
{
    UNITY_PRINT_EOL();
    UnityPrint(UnityStrBreaker);
    UNITY_PRINT_EOL();
1246
    UnityPrintNumber((UNITY_INT)(Unity.NumberOfTests));
M
Mark VanderVoord 已提交
1247
    UnityPrint(UnityStrResultsTests);
1248
    UnityPrintNumber((UNITY_INT)(Unity.TestFailures));
M
Mark VanderVoord 已提交
1249
    UnityPrint(UnityStrResultsFailures);
1250
    UnityPrintNumber((UNITY_INT)(Unity.TestIgnores));
M
Mark VanderVoord 已提交
1251 1252 1253 1254 1255 1256 1257 1258 1259
    UnityPrint(UnityStrResultsIgnored);
    UNITY_PRINT_EOL();
    if (Unity.TestFailures == 0U)
    {
        UnityPrintOk();
    }
    else
    {
        UnityPrintFail();
1260 1261 1262
#ifdef UNITY_DIFFERENTIATE_FINAL_FAIL
        UNITY_OUTPUT_CHAR('E'); UNITY_OUTPUT_CHAR('D');
#endif
M
Mark VanderVoord 已提交
1263 1264
    }
    UNITY_PRINT_EOL();
1265
    UNITY_FLUSH_CALL();
M
Mark VanderVoord 已提交
1266 1267 1268 1269
    UNITY_OUTPUT_COMPLETE();
    return (int)(Unity.TestFailures);
}

1270 1271 1272
/*-----------------------------------------------
 * Command Line Argument Support
 *-----------------------------------------------*/
1273
#ifdef UNITY_USE_COMMAND_LINE_ARGS
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290

char* UnityOptionIncludeNamed = NULL;
char* UnityOptionExcludeNamed = NULL;
int   UnityVerbosity          = 1;

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

    for (int i = 1; i < argc; i++)
    {
        if (argv[i][0] == '-')
        {
            switch(argv[i][1])
            {
                case 'l': /* list tests */
1291
                    return -1;
1292
                case 'n': /* include tests with name including this string */
1293 1294 1295 1296
                case 'f': /* an alias for -n */
                    if (argv[i][2] == '=')
                        UnityOptionIncludeNamed = &argv[i][3];
                    else if (++i < argc)
1297 1298 1299 1300 1301
                        UnityOptionIncludeNamed = argv[i];
                    else
                    {
                        UnityPrint("ERROR: No Test String to Include Matches For");
                        UNITY_PRINT_EOL();
1302
                        return 1;
1303 1304 1305 1306 1307 1308 1309 1310 1311
                    }
                    break;
                case 'q': /* quiet */
                    UnityVerbosity = 0;
                    break;
                case 'v': /* verbose */
                    UnityVerbosity = 2;
                    break;
                case 'x': /* exclude tests with name including this string */
1312 1313 1314
                    if (argv[i][2] == '=')
                        UnityOptionExcludeNamed = &argv[i][3];
                    else if (++i < argc)
1315 1316 1317 1318 1319
                        UnityOptionExcludeNamed = argv[i];
                    else
                    {
                        UnityPrint("ERROR: No Test String to Exclude Matches For");
                        UNITY_PRINT_EOL();
1320
                        return 1;
1321 1322 1323 1324
                    }
                    break;
                default:
                    UnityPrint("ERROR: Unknown Option ");
1325
                    UNITY_OUTPUT_CHAR(argv[i][1]);
1326 1327 1328 1329 1330 1331 1332 1333 1334
                    UNITY_PRINT_EOL();
                    return 1;
            }
        }
    }

    return 0;
}

1335
int IsStringInBiggerString(const char* longstring, const char* shortstring)
1336
{
1337 1338 1339
    char* lptr = (char*)longstring;
    char* sptr = (char*)shortstring;
    char* lnext = lptr;
1340

1341 1342 1343
    if (*sptr == '*')
        return 1;

1344 1345 1346
    while (*lptr)
    {
        lnext = lptr + 1;
1347

1348 1349 1350 1351 1352
        /* If they current bytes match, go on to the next bytes */
        while (*lptr && *sptr && (*lptr == *sptr))
        {
            lptr++;
            sptr++;
1353

1354 1355 1356
            /* We're done if we match the entire string or up to a wildcard */
            if (*sptr == '*')
                return 1;
1357 1358 1359 1360 1361 1362 1363 1364
            if (*sptr == ',')
                return 1;
            if (*sptr == '"')
                return 1;
            if (*sptr == '\'')
                return 1;
            if (*sptr == ':')
                return 2;
1365 1366 1367 1368 1369 1370 1371 1372 1373
            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;
1374 1375 1376 1377
}

int UnityStringArgumentMatches(const char* str)
{
1378 1379 1380
    int retval;
    const char* ptr1;
    const char* ptr2;
1381
    const char* ptrf;
1382

1383
    /* Go through the options and get the substrings for matching one at a time */
1384 1385 1386 1387 1388 1389
    ptr1 = str;
    while (ptr1[0] != 0)
    {
        if ((ptr1[0] == '"') || (ptr1[0] == '\''))
            ptr1++;

1390
        /* look for the start of the next partial */
1391
        ptr2 = ptr1;
1392
        ptrf = 0;
1393 1394
        do {
            ptr2++;
1395 1396 1397 1398
            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] == ',')))
1399 1400
            ptr2++;

1401
        /* done if complete filename match */
1402 1403 1404 1405
        retval = IsStringInBiggerString(Unity.TestFile, ptr1);
        if (retval == 1)
            return retval;

1406
        /* done if testname match after filename partial match */
1407
        if ((retval == 2) && (ptrf != 0))
1408
        {
1409
            if (IsStringInBiggerString(Unity.CurrentTestName, ptrf))
1410 1411 1412
                return 1;
        }

1413
        /* done if complete testname match */
1414 1415 1416 1417 1418 1419
        if (IsStringInBiggerString(Unity.CurrentTestName, ptr1) == 1)
            return 1;

        ptr1 = ptr2;
    }

1420
    /* we couldn't find a match for any substrings */
1421
    return 0;
1422
}
1423

1424 1425 1426 1427 1428 1429 1430 1431 1432 1433
int UnityTestMatches(void)
{
    /* Check if this test name matches the included test pattern */
    int retval;
    if (UnityOptionIncludeNamed)
    {
        retval = UnityStringArgumentMatches(UnityOptionIncludeNamed);
    }
    else
        retval = 1;
1434

1435 1436 1437 1438 1439
    /* Check if this test name matches the excluded test pattern */
    if (UnityOptionExcludeNamed)
    {
        if (UnityStringArgumentMatches(UnityOptionExcludeNamed))
            retval = 0;
1440
    }
1441
    return retval;
1442 1443
}

1444
#endif /* UNITY_USE_COMMAND_LINE_ARGS */
1445
/*-----------------------------------------------*/