/*
 * Copyright 2002-2019 Intel Corporation.
 * 
 * This software is provided to you as Sample Source Code as defined in the accompanying
 * End User License Agreement for the Intel(R) Software Development Products ("Agreement")
 * section 1.L.
 * 
 * This software and the related documents are provided as is, with no express or implied
 * warranties, other than those that are expressly stated in the License.
 */

/*! @file
 *  General tests for pin util functions.
 */

#include <fstream>
#include "pin_tests_util.H"

VOID CharsUtilTest()
{
   CHAR c = 'a';
   TEST('A' == CharToUpper(c), "CharToUpper failed");

   TEST(10 == CharToHexDigit(c), "CharToHexDigit failed");

   TEST(false == CharIsSpace(c), "CharIsSpace failed");
   TEST(true == CharIsSpace(' '), "CharIsSpace failed");

   //printf("Chars util tests completed\n");
}

VOID StringsUtilTest()
{
    string str = "hello/world";
    TEST(str == Joinpath("hello", "world"), "Joinpath failed");
    TEST(str == Joinpath("hello/", "world"), "Joinpath failed");

    TEST(("DD1,234,567,890" == StringBignum(1234567890, 15,'D')), "StringBignum failed");
    // if digits < len(number), digits and padding are irrelevant
    TEST("-1,234,567,890" == StringBignum(-1234567890, 7,'B'), "StringBignum failed");

    TEST(("T" == StringBool(true)) && ("F" == StringBool(false)), "StringBool failed");

    TEST(("Y" == StringTri(TRI_YES)) && ("N" == StringTri(TRI_NO)) &&
            ("M" == StringTri(TRI_MAYBE)), "StringTri failed");

    TEST(float(100) == FLT64FromString("1.0E2"), "FLT64FromString failed");
    
    //printf("Strings util tests completed\n");
}

VOID TempFileTest()
{
   CHAR tmpl[18] = "/tmp/test.XXXXXX";
   CHAR* filename = CreateTmpFileName(tmpl, sizeof tmpl);

   fstream tmpStream(filename);
   TEST(tmpStream.is_open(), "Fail to open "+string(filename)+"\n");
   //printf("%s is now opened\n", filename);

   tmpStream.close();

   INT32 removed = remove(filename);
   TEST(removed == 0, "Can't remove tmp file "+string(filename)+"\n");
   //printf("%s is now removed\n", filename);
}

VOID TimeTest()
{
    MilliSecondsElapsed();
    TEST(MilliSecondsElapsed() == 0, "MilliSecondsElapsed failed");
}

VOID PageTest()
{
    ADDRINT addr = 0x123456;
    string pageAddr1 = hexstr(GetPageOfAddr(addr));
    string pageAddr2 = ptrstr(MemPageRange((void*)addr).Base());
    TEST(pageAddr1 == pageAddr2, "GetPageOfAddr or MemPageRange failed");
}

int main(INT32 argc, CHAR **argv)
{
    PIN_Init(argc, argv);

    CharsUtilTest();
    StringsUtilTest();
    TempFileTest();
    TimeTest();
    PageTest();

    TEST(PIN_VmFullPath() != string(), "PIN_VmFullPath failed"); 
    BreakMe(); // Empty function

    // Never returns
    PIN_StartProgram();
    
    return 0;
}