YiUtilities.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_UTILITIES_H_
#define _YI_UTILITIES_H_

#include "framework/YiPredef.h"
#include "utility/YiMemoryUtilities.h"
#include "utility/YiString.h"
#include "utility/YiStringUtilities.h"


bool YiGetFileName(char &pFileName, char *pFilter);

CYIString YiGetLocalDirectory();

bool YiMakeDirectory(const CYIString &sPath);

bool YiDeleteFile(const char *pPath);

bool YiCopyFile(const char *pSourcePath, const char *pDestinationPath);

bool YiFilesAreIdentical(const char *pReferencePath, const char *pTestPath);

/* YI_SWAP
 * Swaps a and b using temp storage t *
 */
template <typename YI_SWAP_TYPE>
inline void YI_SWAP(YI_SWAP_TYPE &a, YI_SWAP_TYPE &b)
{
    YI_SWAP_TYPE t = a; a = b; b = t;
}

YI_EXTERNINLINE uint16_t RandomWORD(void);
YI_EXTERNINLINE int32_t YI_MIN4(int32_t a, int32_t b, int32_t c, int32_t d);
YI_EXTERNINLINE int32_t YI_MAX4(int32_t a, int32_t b, int32_t c, int32_t d);

bool CompareNames(wchar_t *Name, wchar_t *Compare);

YI_FILE *YI_FOPEN(const char *pPath, const char *pMode);
YI_FILE *YI_WFOPEN(const wchar_t *pPath, const wchar_t *pMode);
void     YI_FCLOSE(YI_FILE *pFile);
void YI_FSEEK(YI_FILE *pFile, int32_t nPos, int32_t nMode);
int32_t YI_FTELL(YI_FILE *pFile);
int32_t YI_TRUNCATE(YI_FILE *pFile, int32_t length);

uint64_t YiGetTimeuS(void);

void YILockFrameRate(int32_t nFPS);

#if defined (YI_WIN32)
int32_t GetLine(char *buff, int32_t n, YI_FILE *in);
#endif

/* YiReadFile
 * Returns the contents of a file into an allocated buffer
 * Returned buffer must be freed (YI_FREE)
 */
uint8_t *YiReadFile(YI_FILE *pFile, uint32_t *pBufferSize, uint32_t uAdditionalPadding);

std::vector<char> YiBase64Encode(const char *pData, uint32_t unInputLength);

inline std::vector<char> YiBase64Encode(const std::vector<char> &byteArray)
{
    return YiBase64Encode(&byteArray.front(), (uint32_t)byteArray.size());
}

inline std::vector<char> YiBase64Encode(const std::string &str)
{
    return YiBase64Encode(str.c_str(), (uint32_t)str.size());
}

inline std::vector<char> YiBase64Encode(const CYIString &str)
{
    return YiBase64Encode(str.GetData(), str.GetSizeInBytes());
}

std::vector<char> YiBase64Decode(const char *pData, uint32_t unInputLength);

inline std::vector<char> YiBase64Decode(const std::vector<char> &byteArray)
{
    return YiBase64Decode(&byteArray.front(), (uint32_t)byteArray.size());
}

inline std::vector<char> YiBase64Decode(const std::string &str)
{
    return YiBase64Decode(str.c_str(), (uint32_t)str.size());
}

inline std::vector<char> YiBase64Decode(const CYIString &str)
{
    return YiBase64Decode(str.GetData(), str.GetSizeInBytes());
}


bool YiIsLittleEndian();


bool YiIsBigEndian();

template<typename T, size_t N>
inline size_t YI_SIZE_OF_ARRAY(const T (&a)[N])
{
    YI_UNUSED(a);
    YI_UNUSED(sizeof (0[a])); // This line should cause an error if you pass an object with a user-defined subscript operator
    return N;
}

#endif // _YI_UTILITIES_H_