/* 

 * Copyright (c) 2003 Asim Jalis

 * 

 *  This software is provided 'as-is', without any express or implied

 *  warranty. In no event will the authors be held liable for any

 *  damages arising from the use of this software.

 * 

 *  Permission is granted to anyone to use this software for any

 *  purpose, including commercial applications, and to alter it and

 *  redistribute it freely, subject to the following restrictions:

 * 

 *  1. The origin of this software must not be misrepresented; you

 *  must not claim that you wrote the original software. If you use

 *  this software in a product, an acknowledgment in the product

 *  documentation would be appreciated but is not required.

 * 

 *  2. Altered source versions must be plainly marked as such, and

 *  must not be misrepresented as being the original software.

 * 

 *  3. This notice may not be removed or altered from any source

 *  distribution.

 *-------------------------------------------------------------------------*

 *

 * Originally obtained from "http://cutest.sourceforge.net/" version 1.4.

 *

 * Modified for serf as follows

 *    4) added CuSuiteSetSetupTeardownCallbacks to set a constructor and

 *       destructor per test suite, run for each test.

 *    3) added CuAssertStrnEquals(), CuAssertStrnEquals_Msg() and

 *       CuAssertStrnEquals_LineMsg()

 *    2) removed const from struct CuTest.name

 *    1) added CuStringFree(), CuTestFree(), CuSuiteFree(), and

 *       CuSuiteFreeDeep()

 *    0) reformatted the whitespace (doh!)

 */

#ifndef CU_TEST_H

#define CU_TEST_H

#include <setjmp.h>

#include <stdarg.h>

/* CuString */

char* CuStrAlloc(int size);

char* CuStrCopy(const char* old);

#define CU_ALLOC(TYPE)		((TYPE*) malloc(sizeof(TYPE)))

#define HUGE_STRING_LEN	8192

#define STRING_MAX		256

#define STRING_INC		256

typedef struct

{

    int length;

    int size;

    char* buffer;

} CuString;

void CuStringInit(CuString* str);

CuString* CuStringNew(void);

void CuStringFree(CuString *str);

void CuStringRead(CuString* str, const char* path);

void CuStringAppend(CuString* str, const char* text);

void CuStringAppendChar(CuString* str, char ch);

void CuStringAppendFormat(CuString* str, const char* format, ...);

void CuStringInsert(CuString* str, const char* text, int pos);

void CuStringResize(CuString* str, int newSize);

/* CuTest */

typedef struct CuTest CuTest;

typedef void (*TestFunction)(CuTest *);

typedef void *(*TestCallback)(void *baton);

struct CuTest

{

    char* name;

    TestFunction function;

    int failed;

    int ran;

    const char* message;

    jmp_buf *jumpBuf;

    TestCallback setup;

    TestCallback teardown;

    void *testBaton;

};

void CuTestInit(CuTest* t, const char* name, TestFunction function);

CuTest* CuTestNew(const char* name, TestFunction function);

void CuTestFree(CuTest* tc);

void CuTestRun(CuTest* tc);

/* Internal versions of assert functions -- use the public versions */

void CuFail_Line(CuTest* tc, const char* file, int line, const char* message2, const char* message);

void CuAssert_Line(CuTest* tc, const char* file, int line, const char* message, int condition);

void CuAssertStrEquals_LineMsg(CuTest* tc,

    const char* file, int line, const char* message,

    const char* expected, const char* actual);

void CuAssertStrnEquals_LineMsg(CuTest* tc,

    const char* file, int line, const char* message,

    const char* expected, size_t explen, const char* actual);

void CuAssertIntEquals_LineMsg(CuTest* tc,

    const char* file, int line, const char* message,

    int expected, int actual);

void CuAssertDblEquals_LineMsg(CuTest* tc,

    const char* file, int line, const char* message,

    double expected, double actual, double delta);

void CuAssertPtrEquals_LineMsg(CuTest* tc,

    const char* file, int line, const char* message,

    void* expected, void* actual);

/* public assert functions */

#define CuFail(tc, ms)                        CuFail_Line(  (tc), __FILE__, __LINE__, NULL, (ms))

#define CuAssert(tc, ms, cond)                CuAssert_Line((tc), __FILE__, __LINE__, (ms), (cond))

#define CuAssertTrue(tc, cond)                CuAssert_Line((tc), __FILE__, __LINE__, "assert failed", (cond))

#define CuAssertStrEquals(tc,ex,ac)           CuAssertStrEquals_LineMsg((tc),__FILE__,__LINE__,NULL,(ex),(ac))

#define CuAssertStrEquals_Msg(tc,ms,ex,ac)    CuAssertStrEquals_LineMsg((tc),__FILE__,__LINE__,(ms),(ex),(ac))

#define CuAssertStrnEquals(tc,ex,exlen,ac)        CuAssertStrnEquals_LineMsg((tc),__FILE__,__LINE__,NULL,(ex),(exlen),(ac))

#define CuAssertStrnEquals_Msg(tc,ms,ex,exlen,ac) CuAssertStrnEquals_LineMsg((tc),__FILE__,__LINE__,(ms),(ex),(exlen),(ac))

#define CuAssertIntEquals(tc,ex,ac)           CuAssertIntEquals_LineMsg((tc),__FILE__,__LINE__,NULL,(ex),(ac))

#define CuAssertIntEquals_Msg(tc,ms,ex,ac)    CuAssertIntEquals_LineMsg((tc),__FILE__,__LINE__,(ms),(ex),(ac))

#define CuAssertDblEquals(tc,ex,ac,dl)        CuAssertDblEquals_LineMsg((tc),__FILE__,__LINE__,NULL,(ex),(ac),(dl))

#define CuAssertDblEquals_Msg(tc,ms,ex,ac,dl) CuAssertDblEquals_LineMsg((tc),__FILE__,__LINE__,(ms),(ex),(ac),(dl))

#define CuAssertPtrEquals(tc,ex,ac)           CuAssertPtrEquals_LineMsg((tc),__FILE__,__LINE__,NULL,(ex),(ac))

#define CuAssertPtrEquals_Msg(tc,ms,ex,ac)    CuAssertPtrEquals_LineMsg((tc),__FILE__,__LINE__,(ms),(ex),(ac))

#define CuAssertPtrNotNull(tc,p)        CuAssert_Line((tc),__FILE__,__LINE__,"null pointer unexpected",(p != NULL))

#define CuAssertPtrNotNullMsg(tc,msg,p) CuAssert_Line((tc),__FILE__,__LINE__,(msg),(p != NULL))

/* CuSuite */

#define MAX_TEST_CASES	1024

#define SUITE_ADD_TEST(SUITE,TEST)	CuSuiteAdd(SUITE, CuTestNew(#TEST, TEST))

typedef struct

{

    int count;

    CuTest* list[MAX_TEST_CASES];

    int failCount;

    TestCallback setup;

    TestCallback teardown;

    void *testBaton;

} CuSuite;

void CuSuiteInit(CuSuite* testSuite);

CuSuite* CuSuiteNew(void);

void CuSuiteFree(CuSuite *testSuite);

void CuSuiteFreeDeep(CuSuite *testSuite);

void CuSuiteAdd(CuSuite* testSuite, CuTest *testCase);

void CuSuiteAddSuite(CuSuite* testSuite, CuSuite* testSuite2);

void CuSuiteRun(CuSuite* testSuite);

void CuSuiteSummary(CuSuite* testSuite, CuString* summary);

void CuSuiteDetails(CuSuite* testSuite, CuString* details);

void CuSuiteSetSetupTeardownCallbacks(CuSuite* testSuite, TestCallback setup,

                                      TestCallback teardown);

#endif /* CU_TEST_H */