Utils Namespace Reference

Utils provides utilities for string & file handling, logging and math functions. More...

Classes
class	Averaged
	Averaged template class provides an average value from a fixed size array. More...
struct	AverageTimingBlock
	concatenation of average value and timer More...
class	AverageTiming
	Singleton timing class for average measurement of different timing blocks in loops. More...
class	CustomLog
	Logger interface. More...
class	FileLog
	File logging class. More...
class	ComputerInfos
	Class for holding computer information. More...

Typedefs
typedef Utils::Averaged< float >	AvgFloat

Functions
string	toString (float f, int roundedDecimals=1)
	Returns a string from a float with max. one trailing zero. More...
string	toString (double d, int roundedDecimals=1)
	Returns a string from a double with max. one trailing zero. More...
string	toLowerString (string s)
	Returns a string in lower case. More...
string	toUpperString (string s)
	Returns a string in upper case. More...
string	trimString (const string &s, const string &drop=" ")
	Trims a string at both end. More...
string	trimRightString (const string &s, const string &drop)
	trims a string at the right end More...
string	trimLeftString (const string &s, const string &drop)
	trims a string at the left end More...
void	splitString (const string &s, char delimiter, vector< string > &splits)
	Splits an input string at a delimiter character into a string vector. More...
void	replaceString (string &source, const string &from, const string &to)
	Replaces in the source string the from string by the to string. More...
vector< string >	getStringLines (const string &multiLineString)
	Returns a vector of string one per line of a multiline string. More...
string	readTextFileIntoString (const char *logTag, const string &pathAndFilename)
	Reads a text file into a string and returns it. More...
void	writeStringIntoTextFile (const char *logTag, const string &stringToWrite, const string &pathAndFilename)
	Writes a string into a text file. More...
string	replaceNonFilenameChars (string source, char replaceChar='-')
	replaces non-filename characters: /|?%*:"<>' More...
string	getLocalTimeString ()
	Returns local time as string like "Wed Feb 13 15:46:11 2019". More...
string	getDateTime1String ()
	Returns local time as string like "13.02.19-15:46". More...
string	getDateTime2String ()
	Returns local time as string like "20190213-154611". More...
string	getHostName ()
	Returns the computer name. More...
string	formatString (string fmt_str,...)
	Returns a formatted string as sprintf. More...
bool	containsString (const string &container, const string &search)
	Returns true if container contains the search string. More...
bool	startsWithString (const string &container, const string &startStr)
	Return true if the container string starts with the startStr. More...
bool	endsWithString (const string &container, const string &endStr)
	Return true if the container string ends with the endStr. More...
string	unifySlashes (const string &inputDir, bool withTrailingSlash=true)
	Returns the inputDir string with unified forward slashes, e.g.: "dirA/dirB/". More...
string	getPath (const string &pathFilename)
	Returns the path w. '\' of path-filename string. More...
bool	getFileContent (const string &fileName, vector< string > &vecOfStrings)
	Returns true if content of file could be put in a vector of strings. More...
bool	compareNatural (const string &a, const string &b)
	Naturally compares two strings (used for filename sorting) More...
string	getFileName (const string &pathFilename)
	Returns the filename of path-filename string. More...
string	getDirName (const string &pathFilename)
	Strip last component from file name. More...
string	getFileNameWOExt (const string &pathFilename)
	Returns the filename without extension. More...
string	getFileExt (const string &filename)
	Returns the file extension without dot in lower case. More...
vector< string >	getDirNamesInDir (const string &dirName, bool fullPath=true)
	Returns a vector directory names with path in dir. More...
vector< string >	getAllNamesInDir (const string &dirName, bool fullPath=true)
	Returns a vector of sorted names (files and directories) with path in dir. More...
vector< string >	getFileNamesInDir (const string &dirName, bool fullPath=true)
	Returns a vector of sorted filesnames in dirName. More...
bool	dirExists (const string &path)
	Returns true if a directory exists. More...
bool	makeDir (const string &path)
	Creates a directory with given path. More...
bool	makeDirRecurse (std::string path)
void	removeDir (const string &path)
	RemoveDir deletes a directory with given path. More...
void	removeFile (const string &path)
	RemoveFile deletes a file with given path. More...
bool	fileExists (const string &pathfilename)
	Returns true if a file exists. More...
unsigned int	getFileSize (const string &filename)
	Returns the file size in bytes. More...
unsigned int	getFileSize (std::ifstream &fs)
string	getAppsWritableDir (string appName="SLProject")
	Returns the writable configuration directory. More...
string	getCurrentWorkingDir ()
	Returns the working directory. More...
bool	deleteFile (string &pathfilename)
	Deletes a file on the filesystem. More...
void	loopFileSystemRec (const string &path, function< void(string path, string baseName, int depth)> processFile, function< void(string path, string baseName, int depth)> processDir, const int depth=0)
	process all files and folders recursively naturally sorted More...
void	dumpFileSystemRec (const char *logtag, const string &folderpath)
	Dumps all folders and files recursovely. More...
string	findFile (const string &filename, const vector< string > &pathsToCheck)
	Tries to find a filename on various paths to check. More...
void	initFileLog (const string &logDir, bool forceFlush)
void	log (const char *tag, const char *format,...)
	logs a formatted string platform independently More...
void	exitMsg (const char *tag, const char *msg, int line, const char *file)
	Terminates the application with a message. No leak checking. More...
void	warnMsg (const char *tag, const char *msg, int line, const char *file)
	Platform independent warn message output. More...
void	errorMsg (const char *tag, const char *msg, int line, const char *file)
	Platform independent error message output. More...
unsigned int	maxThreads ()
	Returns in release config the max. NO. of threads otherwise 1. More...
int	gcd (int a, int b)
	Greatest common divisor of two integer numbers (ggT = grösster gemeinsame Teiler) More...
int	lcm (int a, int b)
unsigned	closestPowerOf2 (unsigned num)
	Returns the closest power of 2 to a passed number. More...
unsigned	nextPowerOf2 (unsigned num)
	Returns the next power of 2 to a passed number. More...
bool	makeDirRecurse (string path)
	Creates a directory with given path recursively. More...
void	initFileLog (const std::string &logDir, bool forceFlush)
	Instantiates FileLog instance. More...
template<class T >
T	sign (T a)
template<class T >
T	floor (T a)
template<class T >
T	ceil (T a)
template<class T >
T	fract (T a)
template<class T >
T	abs (T a)
template<class T >
T	mod (T a, T b)
template<class T >
T	step (T edge, T x)
template<class T >
T	pulse (T a, T b, T x)
template<class T >
T	clamp (T a, T min, T max)
template<class T >
T	mix (T mix, T a, T b)
template<class T >
T	lerp (T x, T a, T b)
bool	isPowerOf2 (unsigned int a)
	Returns true if a number is of power of 2. More...
float	random (float min, float max)
	Returns a uniform distributed random float number between min and max. More...
int	random (int min, int max)
	Returns a uniform distributed random int number between min and max. More...

Variables
std::unique_ptr< CustomLog >	customLog
	custom log instance, e.g. log to a ui log window More...
bool	onlyErrorLogs = false
	if this flag is set to true all calls to log get ignored More...
static std::unique_ptr< FileLog >	fileLog
static const float	PI = 3.14159265358979f
static const float	RAD2DEG = 180.0f / PI
static const float	DEG2RAD = PI / 180.0f
static const float	TWOPI = 2.0f * PI
static const float	ONEOVERPI = 1.0f / PI
static const float	HALFPI = PI * 0.5f

Detailed Description

Utils provides utilities for string & file handling, logging and math functions.

Function are grouped into sections:

• String Handling Functions
• File Handling Functions
• Logging Functions
• Math Constants and Functions

Typedef Documentation

AvgFloat

typedef Utils::Averaged<float> Utils::AvgFloat

Definition at line 85 of file Averaged.h.

Function Documentation

abs()

template<class T >

T Utils::abs ( T  a )

inline

Definition at line 249 of file Utils.h.

{return (a >= 0) ? a : -a;}

ceil()

template<class T >

T Utils::ceil ( T  a )

inline

Definition at line 247 of file Utils.h.

{return (T)((int)a + ((a > 0 && a != (int)(a))));}

clamp()

template<class T >

T Utils::clamp ( T  a, T  min, T  max  )

inline

Definition at line 253 of file Utils.h.

{return (a < min) ? min : (a > max) ? max : a;}

closestPowerOf2()

unsigned Utils::closestPowerOf2

(

unsigned

num

)

Returns the closest power of 2 to a passed number.

Definition at line 1218 of file Utils.cpp.

{
    unsigned nextPow2 = 1;
    if (num <= 0) return 1;
 
    while (nextPow2 <= num)
        nextPow2 <<= 1;
    unsigned prevPow2 = nextPow2 >> 1;
 
    if (num - prevPow2 < nextPow2 - num)
        return prevPow2;
    else
        return nextPow2;
}

compareNatural()

bool Utils::compareNatural	(	const string &	a,
		const string &	b
	)

Naturally compares two strings (used for filename sorting)

String comparison as most filesystem do it. Source: https://www.o-rho.com/naturalsort

std::sort compareNatural

---

1.txt 1.txt 10.txt 1_t.txt 1_t.txt 10.txt 20 20 20.txt 20.txt ABc ABc aBCd aBCd aBCd(01) aBCd(1) aBCd(1) aBCd(01) aBCd(12) aBCd(2) aBCd(2) aBCd(12) aBc aBc aBcd aBcd aaA aaA aaa aaa z10.txt z2.txt z100.txt z10.txt z2.txt z100.txt

Definition at line 463 of file Utils.cpp.

{
    const char*          p1         = a.c_str();
    const char*          p2         = b.c_str();
    const unsigned short st_scan    = 0;
    const unsigned short st_alpha   = 1;
    const unsigned short st_numeric = 2;
    unsigned short       state      = st_scan;
    const char*          numstart1  = nullptr;
    const char*          numstart2  = nullptr;
    const char*          numend1    = nullptr;
    const char*          numend2    = nullptr;
    unsigned long        sz1        = 0;
    unsigned long        sz2        = 0;
 
    while (*p1 && *p2)
    {
        switch (state)
        {
            case st_scan:
                if (!isdigit(*p1) && !isdigit(*p2))
                {
                    state = st_alpha;
                    if (*p1 == *p2)
                    {
                        p1++;
                        p2++;
                    }
                    else
                        return *p1 < *p2;
                }
                else if (isdigit(*p1) && !isdigit(*p2))
                    return true;
                else if (!isdigit(*p1) && isdigit(*p2))
                    return false;
                else
                {
                    state = st_numeric;
                    if (sz1 == 0)
                        while (*p1 == '0')
                        {
                            p1++;
                            sz1++;
                        }
                    else
                        while (*p1 == '0') p1++;
                    if (sz2 == 0)
                        while (*p2 == '0')
                        {
                            p2++;
                            sz2++;
                        }
                    else
                        while (*p2 == '0') p2++;
                    if (sz1 == sz2)
                    {
                        sz1 = 0;
                        sz2 = 0;
                    }
                    if (!isdigit(*p1)) p1--;
                    if (!isdigit(*p2)) p2--;
                    numstart1 = p1;
                    numstart2 = p2;
                    numend1   = numstart1;
                    numend2   = numstart2;
                }
                break;
            case st_alpha:
                if (!isdigit(*p1) && !isdigit(*p2))
                {
                    if (*p1 == *p2)
                    {
                        p1++;
                        p2++;
                    }
                    else
                        return *p1 < *p2;
                }
                else
                    state = st_scan;
                break;
            case st_numeric:
                while (isdigit(*p1)) numend1 = p1++;
                while (isdigit(*p2)) numend2 = p2++;
                if (numend1 - numstart1 == numend2 - numstart2 &&
                    !strncmp(numstart1, numstart2, numend2 - numstart2 + 1))
                    state = st_scan;
                else
                {
                    if (numend1 - numstart1 != numend2 - numstart2)
                        return numend1 - numstart1 < numend2 - numstart2;
                    while (*numstart1 && *numstart2)
                    {
                        if (*numstart1 != *numstart2) return *numstart1 < *numstart2;
                        numstart1++;
                        numstart2++;
                    }
                }
                break;
            default: break;
        }
    }
    if (sz1 < sz2) return true;
    if (sz1 > sz2) return false;
    if (*p1 == 0 && *p2 != 0) return true;
    if (*p1 != 0 && *p2 == 0) return false;
    return false;
}

containsString()

bool Utils::containsString	(	const string &	container,
		const string &	search
	)

Returns true if container contains the search string.

Definition at line 344 of file Utils.cpp.

{
    return (container.find(search) != string::npos);
}

deleteFile()

bool Utils::deleteFile

(

string &

pathfilename

)

Deletes a file on the filesystem.

Definition at line 1005 of file Utils.cpp.

{
    if (fileExists(pathfilename))
        return remove(pathfilename.c_str()) != 0;
    return false;
}

dirExists()

bool Utils::dirExists

(

const string &

path

)

Returns true if a directory exists.

Definition at line 789 of file Utils.cpp.

{
#if defined(__EMSCRIPTEN__)
    return true;
#elif defined(USE_STD_FILESYSTEM)
    return fs::exists(path) && fs::is_directory(path);
#else
    struct stat info
    {
    };
    if (stat(path.c_str(), &info) != 0)
        return false;
    else if (info.st_mode & S_IFDIR)
        return true;
    else
        return false;
#endif
}

dumpFileSystemRec()

void Utils::dumpFileSystemRec	(	const char *	logtag,
		const string &	folderPath
	)

Dumps all folders and files recursovely.

Definition at line 1048 of file Utils.cpp.

{
    const char* tab = "    ";
 
    loopFileSystemRec(
      folderPath,
      [logtag, tab](string path, string baseName, int depth) -> void {
          string indent;
          for (int d = 0; d < depth; ++d)
              indent += tab;
          string indentFolderName = indent + baseName;
          Utils::log(logtag, "%s", indentFolderName.c_str());
      },
      [logtag, tab](string path, string baseName, int depth) -> void {
          string indent;
          for (int d = 0; d < depth; ++d)
              indent += tab;
          string indentFolderName = indent + "[" + baseName + "]";
          Utils::log(logtag, "%s", indentFolderName.c_str());
      });
}

endsWithString()

bool Utils::endsWithString	(	const string &	container,
		const string &	endStr
	)

Return true if the container string ends with the endStr.

Definition at line 356 of file Utils.cpp.

{
    if (container.length() >= endStr.length())
        return (0 == container.compare(container.length() - endStr.length(),
                                       endStr.length(),
                                       endStr));
    else
        return false;
}

errorMsg()

void Utils::errorMsg	(	const char *	tag,
		const char *	msg,
		const int	line,
		const char *	file
	)

Platform independent error message output.

Definition at line 1165 of file Utils.cpp.

{
#if defined(ANDROID) || defined(ANDROID_NDK)
    __android_log_print(ANDROID_LOG_ERROR,
                        tag,
                        "Error: %s at line %d in %s\n",
                        msg,
                        line,
                        file);
#else
    std::cout << "--------------------------------\n"
              << "Error:\n"
              << "Tag: " << tag << '\n'
              << "Location: " << file << ":" << line << '\n'
              << "Message: " << msg << '\n'
              << "--------------------------------" << std::endl;
#endif
}

exitMsg()

void Utils::exitMsg	(	const char *	tag,
		const char *	msg,
		const int	line,
		const char *	file
	)

Terminates the application with a message. No leak checking.

Definition at line 1132 of file Utils.cpp.

{
    errorMsg(tag, msg, line, file);
    exit(-1);
}

fileExists()

bool Utils::fileExists

(

const string &

pathfilename

)

Returns true if a file exists.

Definition at line 894 of file Utils.cpp.

{
#if defined(__EMSCRIPTEN__)
    return false;
#elif defined(USE_STD_FILESYSTEM)
    return fs::exists(pathfilename);
#else
    struct stat info
    {
    };
    return (stat(pathfilename.c_str(), &info) == 0) && ((info.st_mode & S_IFDIR) == 0);
#endif
}

findFile()

string Utils::findFile	(	const string &	filename,
		const vector< string > &	pathsToCheck
	)

Tries to find a filename on various paths to check.

Definition at line 1074 of file Utils.cpp.

{
    if (Utils::fileExists(filename))
        return filename;
 
    // Check file existence
    for (const auto& path : pathsToCheck)
    {
        string pathPlusFilename = Utils::unifySlashes(path) + filename;
        if (Utils::fileExists(pathPlusFilename))
            return pathPlusFilename;
    }
    return "";
}

floor()

template<class T >

T Utils::floor ( T  a )

inline

Definition at line 246 of file Utils.h.

{return (T)((int)a - ((a < 0 && a != (int)(a))));}

formatString()

string Utils::formatString	(	string	fmt_str,
			...
	)

Returns a formatted string as sprintf.

Definition at line 320 of file Utils.cpp.

{
    // Reserve two times as much as the length of the fmt_str
    int final_n = 0;
    int n       = ((int)fmt_str.size()) * 2;
 
    std::unique_ptr<char[]> formatted;
    va_list                 ap;
    while (true)
    {
        formatted.reset(new char[n]);
        strcpy(&formatted[0], fmt_str.c_str());
        va_start(ap, fmt_str);
        final_n = vsnprintf(&formatted[0], (unsigned long)n, fmt_str.c_str(), ap);
        va_end(ap);
        if (final_n < 0 || final_n >= n)
            n += abs(final_n - n + 1);
        else
            break;
    }
    return string(formatted.get());
}

fract()

template<class T >

T Utils::fract ( T  a )

inline

Definition at line 248 of file Utils.h.

{return a - floor(a);}

gcd()

int Utils::gcd	(	int	a,
		int	b
	)

Greatest common divisor of two integer numbers (ggT = grösster gemeinsame Teiler)

Definition at line 1204 of file Utils.cpp.

{
    if (b == 0)
        return a;
    return gcd(b, a % b);
}

getAllNamesInDir()

vector< string > Utils::getAllNamesInDir	(	const string &	dirName,
		bool	fullPath
	)

Returns a vector of sorted names (files and directories) with path in dir.

Definition at line 690 of file Utils.cpp.

{
    vector<string> filePathNames;
 
#if defined(USE_STD_FILESYSTEM)
    if (fs::exists(dirName) && fs::is_directory(dirName))
    {
        for (const auto& entry : fs::directory_iterator(dirName))
        {
            auto filename = entry.path().filename();
            if (fullPath)
                filePathNames.push_back(dirName + "/" + filename.u8string());
            else
                filePathNames.push_back(filename.u8string());
        }
    }
#else
#    if defined(TARGET_OS_IOS) && (TARGET_OS_IOS == 1)
    return Utils_iOS::getAllNamesInDir(dirName, fullPath);
#    else
    DIR* dir = opendir(dirName.c_str());
 
    if (dir)
    {
        struct dirent* dirContent = nullptr;
 
        while ((dirContent = readdir(dir)) != nullptr)
        {
            string name(dirContent->d_name);
            if (name != "." && name != "..")
            {
                if (fullPath)
                    filePathNames.push_back(dirName + "/" + name);
                else
                    filePathNames.push_back(name);
            }
        }
        closedir(dir);
    }
#    endif
#endif
 
    return filePathNames;
}

getAppsWritableDir()

string Utils::getAppsWritableDir

(

string

appName

)

Returns the writable configuration directory.

Definition at line 939 of file Utils.cpp.

{
#if defined(_WIN32)
    string appData   = getenv("APPDATA");
    string configDir = appData + "/" + appName;
    replaceString(configDir, "\\", "/");
    if (!dirExists(configDir))
        makeDir(configDir.c_str());
    return configDir + "/";
#elif defined(__APPLE__)
    string home      = getenv("HOME");
    string appData   = home + "/Library/Application Support";
    string configDir = appData + "/" + appName;
    if (!dirExists(configDir))
        mkdir(configDir.c_str(), S_IRWXU);
    return configDir + "/";
#elif defined(ANDROID) || defined(ANDROID_NDK)
    // @todo Where is the app data path on Andoroid?
#elif defined(linux) || defined(__linux) || defined(__linux__)
    // @todo Where is the app data path on Linux?
    string home      = getenv("HOME");
    string configDir = home + "/." + appName;
    if (!dirExists(configDir))
        mkdir(configDir.c_str(), S_IRWXU | S_IRWXG | S_IRWXO);
    return configDir + "/";
#elif defined(__EMSCRIPTEN__)
    return "?";
#else
#    error "No port to this OS"
#endif
    return "";
}

getCurrentWorkingDir()

string Utils::getCurrentWorkingDir

(

)

Returns the working directory.

Definition at line 973 of file Utils.cpp.

{
#if defined(_WIN32)
#    if defined(USE_STD_FILESYSTEM)
    return fs::current_path().u8string();
#    else
    int   size   = 256;
    char* buffer = (char*)malloc(size);
    if (_getcwd(buffer, size) == buffer)
    {
        string dir = buffer;
        replaceString(dir, "\\", "/");
        return dir + "/";
    }
 
    free(buffer);
    return "";
#    endif
#elif !defined(__EMSCRIPTEN__)
    size_t size   = 256;
    char*  buffer = (char*)malloc(size);
    if (getcwd(buffer, size) == buffer)
        return string(buffer) + "/";
 
    free(buffer);
    return "";
#else
    return "/";
#endif
}

getDateTime1String()

string Utils::getDateTime1String

(

)

Returns local time as string like "13.02.19-15:46".

Definition at line 269 of file Utils.cpp.

{
    time_t tm = 0;
    time(&tm);
    struct tm* t = localtime(&tm);
 
    static char shortTime[50];
    snprintf(shortTime,
             sizeof(shortTime),
             "%.2d.%.2d.%.2d-%.2d:%.2d",
             t->tm_mday,
             t->tm_mon + 1,
             t->tm_year - 100,
             t->tm_hour,
             t->tm_min);
 
    return string(shortTime);
}

getDateTime2String()

string Utils::getDateTime2String

(

)

Returns local time as string like "20190213-154611".

Definition at line 289 of file Utils.cpp.

{
    time_t tm = 0;
    time(&tm);
    struct tm* t = localtime(&tm);
 
    static char shortTime[50];
    snprintf(shortTime,
             sizeof(shortTime),
             "%.4d%.2d%.2d-%.2d%.2d%.2d",
             1900 + t->tm_year,
             t->tm_mon + 1,
             t->tm_mday,
             t->tm_hour,
             t->tm_min,
             t->tm_sec);
 
    return string(shortTime);
}

getDirName()

string Utils::getDirName

(

const string &

pathFilename

)

Strip last component from file name.

Definition at line 597 of file Utils.cpp.

{
    size_t i1 = pathFilename.rfind('\\', pathFilename.length());
    size_t i2 = pathFilename.rfind('/', pathFilename.length());
    int    i  = -1;
 
    if (i1 != string::npos && i2 != string::npos)
        i = (int)std::max(i1, i2);
    else if (i1 != string::npos)
        i = (int)i1;
    else if (i2 != string::npos)
        i = (int)i2;
 
    return pathFilename.substr(0, i + 1);
}

getDirNamesInDir()

vector< string > Utils::getDirNamesInDir	(	const string &	dirName,
		bool	fullPath
	)

Returns a vector directory names with path in dir.

Definition at line 637 of file Utils.cpp.

{
    vector<string> filePathNames;
 
#if defined(USE_STD_FILESYSTEM)
    if (fs::exists(dirName) && fs::is_directory(dirName))
    {
        for (const auto& entry : fs::directory_iterator(dirName))
        {
            auto filename = entry.path().filename();
            if (fs::is_directory(entry.status()))
            {
                if (fullPath)
                    filePathNames.push_back(dirName + "/" + filename.u8string());
                else
                    filePathNames.push_back(filename.u8string());
            }
        }
    }
#else
    DIR* dir = opendir(dirName.c_str());
 
    if (dir)
    {
        struct dirent* dirContent = nullptr;
 
        while ((dirContent = readdir(dir)) != nullptr)
        {
            string name(dirContent->d_name);
 
            if (name != "." && name != "..")
            {
                struct stat path_stat
                {
                };
                stat((dirName + name).c_str(), &path_stat);
                if (!S_ISREG(path_stat.st_mode))
                {
                    if (fullPath)
                        filePathNames.push_back(dirName + "/" + name);
                    else
                        filePathNames.push_back(name);
                }
            }
        }
        closedir(dir);
    }
#endif
 
    return filePathNames;
}

getFileContent()

bool Utils::getFileContent	(	const string &	fileName,
		vector< string > &	vecOfStrings
	)

Returns true if content of file could be put in a vector of strings.

Definition at line 410 of file Utils.cpp.

{
 
    // Open the File
    std::ifstream in(fileName.c_str());
 
    // Check if object is valid
    if (!in)
    {
        std::cerr << "Cannot open the File : " << fileName << std::endl;
        return false;
    }
 
    // Read the next line from File untill it reaches the end.
    std::string str;
    while (std::getline(in, str))
    {
        // Line contains string of length > 0 then save it in vector
        if (!str.empty())
            vecOfStrings.push_back(str);
    }
 
    // Close The File
    in.close();
    return true;
}

getFileExt()

string Utils::getFileExt

(

const string &

filename

)

Returns the file extension without dot in lower case.

Definition at line 628 of file Utils.cpp.

{
    size_t i = filename.rfind('.', filename.length());
    if (i != string::npos)
        return toLowerString(filename.substr(i + 1, filename.length() - i));
    return ("");
}

getFileName()

string Utils::getFileName

(

const string &

pathFilename

)

Returns the filename of path-filename string.

Definition at line 579 of file Utils.cpp.

{
    size_t i1 = pathFilename.rfind('\\', pathFilename.length());
    size_t i2 = pathFilename.rfind('/', pathFilename.length());
    int    i  = -1;
 
    if (i1 != string::npos && i2 != string::npos)
        i = (int)std::max(i1, i2);
    else if (i1 != string::npos)
        i = (int)i1;
    else if (i2 != string::npos)
        i = (int)i2;
 
    return pathFilename.substr(i + 1, pathFilename.length() - i);
}

getFileNamesInDir()

vector< string > Utils::getFileNamesInDir	(	const string &	dirName,
		bool	fullPath
	)

Returns a vector of sorted filesnames in dirName.

Definition at line 736 of file Utils.cpp.

{
    vector<string> filePathNames;
 
#if defined(USE_STD_FILESYSTEM)
    if (fs::exists(dirName) && fs::is_directory(dirName))
    {
        for (const auto& entry : fs::directory_iterator(dirName))
        {
            auto filename = entry.path().filename();
            if (fs::is_regular_file(entry.status()))
            {
                if (fullPath)
                    filePathNames.push_back(dirName + "/" + filename.u8string());
                else
                    filePathNames.push_back(filename.u8string());
            }
        }
    }
#else
    // todo: does this part also return directories? It should only return file names..
    DIR* dir = opendir(dirName.c_str());
 
    if (dir)
    {
        struct dirent* dirContent = nullptr;
 
        while ((dirContent = readdir(dir)) != nullptr)
        {
            string name(dirContent->d_name);
            if (name != "." && name != "..")
            {
                struct stat path_stat
                {
                };
                stat((dirName + name).c_str(), &path_stat);
                if (S_ISREG(path_stat.st_mode))
                {
                    if (fullPath)
                        filePathNames.push_back(dirName + name);
                    else
                        filePathNames.push_back(name);
                }
            }
        }
        closedir(dir);
    }
#endif
 
    return filePathNames;
}

getFileNameWOExt()

string Utils::getFileNameWOExt

(

const string &

pathFilename

)

Returns the filename without extension.

Definition at line 615 of file Utils.cpp.

{
    string filename = getFileName(pathFilename);
    size_t i        = filename.rfind('.', filename.length());
    if (i != string::npos)
    {
        return (filename.substr(0, i));
    }
 
    return (filename);
}

getFileSize() [1/2]

unsigned int Utils::getFileSize

(

const string &

pathfilename

)

Returns the file size in bytes.

Definition at line 909 of file Utils.cpp.

{
#if defined(USE_STD_FILESYSTEM)
    if (fs::exists(pathfilename))
        return (unsigned int)fs::file_size(pathfilename);
    else
        return 0;
#else
    struct stat st
    {
    };
    if (stat(pathfilename.c_str(), &st) != 0)
        return 0;
    return (unsigned int)st.st_size;
#endif
}

getFileSize() [2/2]

unsigned int Utils::getFileSize

(

std::ifstream &

fs

)

Definition at line 927 of file Utils.cpp.

{
    fs.seekg(0, std::ios::beg);
    std::streampos begin = fs.tellg();
    fs.seekg(0, std::ios::end);
    std::streampos end = fs.tellg();
    fs.seekg(0, std::ios::beg);
    return (unsigned int)(end - begin);
}

getHostName()

string Utils::getHostName

(

)

Returns the computer name.

Definition at line 310 of file Utils.cpp.

{
#ifndef __EMSCRIPTEN__
    return asio::ip::host_name();
#else
    return "0.0.0.0";
#endif
}

getLocalTimeString()

string Utils::getLocalTimeString

(

)

Returns local time as string like "Wed Feb 13 15:46:11 2019".

Definition at line 258 of file Utils.cpp.

{
    time_t tm = 0;
    time(&tm);
    struct tm* t2 = localtime(&tm);
    char       buf[1024];
    strftime(buf, sizeof(buf), "%c", t2);
    return string(buf);
}

getPath()

string Utils::getPath

(

const string &

pathFilename

)

Returns the path w. '\' of path-filename string.

Definition at line 391 of file Utils.cpp.

{
    size_t i1 = pathFilename.rfind('\\', pathFilename.length());
    size_t i2 = pathFilename.rfind('/', pathFilename.length());
    if ((i1 != string::npos && i2 == string::npos) ||
        (i1 != string::npos && i1 > i2))
    {
        return (pathFilename.substr(0, i1 + 1));
    }
 
    if ((i2 != string::npos && i1 == string::npos) ||
        (i2 != string::npos && i2 > i1))
    {
        return (pathFilename.substr(0, i2 + 1));
    }
    return pathFilename;
}

getStringLines()

vector< string > Utils::getStringLines

(

const string &

multiLineString

)

Returns a vector of string one per line of a multiline string.

Definition at line 195 of file Utils.cpp.

{
    std::stringstream        stream(multiLineString);
    std::vector<std::string> res;
    while (1)
    {
        std::string line;
        std::getline(stream, line);
        line = Utils::trimString(line, "\r");
        res.push_back(line);
        if (!stream.good())
            break;
    }
    return res;
}

initFileLog() [1/2]

void Utils::initFileLog	(	const std::string &	logDir,
		bool	forceFlush
	)

Instantiates FileLog instance.

initFileLog() [2/2]

void Utils::initFileLog	(	const string &	logDir,
		bool	forceFlush
	)

Definition at line 1094 of file Utils.cpp.

{
    fileLog = std::make_unique<FileLog>(logDir, forceFlush);
}

isPowerOf2()

bool Utils::isPowerOf2 ( unsigned int  a )

inline

Returns true if a number is of power of 2.

Definition at line 259 of file Utils.h.

{
    return a == 1 || (a & (a - 1)) == 0;
}

lcm()

int Utils::lcm	(	int	a,
		int	b
	)

Definition at line 1212 of file Utils.cpp.

{
    return (a * b) / Utils::gcd(a, b);
}

lerp()

template<class T >

T Utils::lerp ( T  x, T  a, T  b  )

inline

Definition at line 255 of file Utils.h.

{return (a + x * (b - a));}

log()

void Utils::log	(	const char *	tag,
		const char *	format,
			...
	)

logs a formatted string platform independently

Definition at line 1100 of file Utils.cpp.

{
    char log[4096];
 
    va_list argptr;
    va_start(argptr, format);
    vsnprintf(log, sizeof(log), format, argptr);
    va_end(argptr);
 
    char msg[4096];
    strcpy(msg, tag);
    strcat(msg, ": ");
    strcat(msg, log);
    strcat(msg, "\n");
 
    if (fileLog)
        fileLog->post(msg);
 
    if (customLog)
        customLog->post(msg);
 
    if (Utils::onlyErrorLogs)
        return;
 
#if defined(ANDROID) || defined(ANDROID_NDK)
    __android_log_print(ANDROID_LOG_INFO, tag, msg);
#else
    std::cout << msg << std::flush;
#endif
}

loopFileSystemRec()

void Utils::loopFileSystemRec	(	const string &	path,
		function< void(string path, string baseName, int depth)>	processFile,
		function< void(string path, string baseName, int depth)>	processDir,
		const int	depth
	)

process all files and folders recursively naturally sorted

Definition at line 1013 of file Utils.cpp.

{
    // be sure that the folder slashes are correct
    string folder = unifySlashes(path);
 
    if (dirExists(folder))
    {
        vector<string> unsortedNames = getAllNamesInDir(folder);
 
        processDir(getDirName(trimRightString(folder, "/")),
                   getFileName(trimRightString(folder, "/")),
                   depth);
        sort(unsortedNames.begin(), unsortedNames.end(), Utils::compareNatural);
 
        for (const auto& fileOrFolder : unsortedNames)
        {
            if (dirExists(fileOrFolder))
                loopFileSystemRec(fileOrFolder, processFile, processDir, depth + 1);
            else
                processFile(folder, getFileName(fileOrFolder), depth);
        }
    }
    else
    {
        processFile(getDirName(trimRightString(path, "/")),
                    getFileName(trimRightString(path, "/")),
                    depth);
    }
}

makeDir()

bool Utils::makeDir

(

const string &

path

)

Creates a directory with given path.

Definition at line 809 of file Utils.cpp.

{
#if defined(USE_STD_FILESYSTEM)
    return fs::create_directories(path);
#else
#    if defined(_WIN32)
    return _mkdir(path.c_str());
#    else
    int  failed = mkdir(path.c_str(), S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
    bool result = !failed;
    return result;
#    endif
#endif
}

makeDirRecurse() [1/2]

bool Utils::makeDirRecurse

(

std::string

path

)

Definition at line 825 of file Utils.cpp.

{
    std::string delimiter = "/";
 
    size_t      pos = 0;
    std::string createdPath;
 
    while ((pos = path.find(delimiter)) != std::string::npos)
    {
        createdPath += path.substr(0, pos) + "/";
 
        if (!dirExists(createdPath))
        {
            if (!makeDir(createdPath))
            {
                return false;
            }
        }
 
        path.erase(0, pos + delimiter.length());
    }
 
    return true;
}

makeDirRecurse() [2/2]

bool Utils::makeDirRecurse

(

string

path

)

Creates a directory with given path recursively.

maxThreads()

unsigned int Utils::maxThreads

(

)

Returns in release config the max. NO. of threads otherwise 1.

Definition at line 1188 of file Utils.cpp.

{
#if defined(DEBUG) || defined(_DEBUG)
    return 1;
#else
    return std::max(std::thread::hardware_concurrency(), 1U);
#endif
}

mix()

template<class T >

T Utils::mix ( T  mix, T  a, T  b  )

inline

Definition at line 254 of file Utils.h.

{return (1 - mix) * a + mix * b;}

mod()

template<class T >

T Utils::mod ( T  a, T  b  )

inline

Definition at line 250 of file Utils.h.

{return a - b * floor(a / b);}

nextPowerOf2()

unsigned Utils::nextPowerOf2

(

unsigned

num

)

Returns the next power of 2 to a passed number.

Definition at line 1234 of file Utils.cpp.

{
    unsigned nextPow2 = 1;
    if (num == 0) return 1;
 
    while (nextPow2 <= num)
        nextPow2 <<= 1;
    return nextPow2;
}

pulse()

template<class T >

T Utils::pulse ( T  a, T  b, T  x  )

inline

Definition at line 252 of file Utils.h.

{return (SL_step(a, x) - step(b, x));}

random() [1/2]

float Utils::random ( float  min, float  max  )

inline

Returns a uniform distributed random float number between min and max.

Definition at line 265 of file Utils.h.

{
    return ((float)rand() / (float)RAND_MAX) * (max - min) + min;
}

random() [2/2]

int Utils::random ( int  min, int  max  )

inline

Returns a uniform distributed random int number between min and max.

Definition at line 271 of file Utils.h.

{
    return min + (rand() % (int)(max - min + 1));
}

readTextFileIntoString()

string Utils::readTextFileIntoString	(	const char *	logTag,
		const string &	pathAndFilename
	)

Reads a text file into a string and returns it.

Definition at line 212 of file Utils.cpp.

{
    fstream shaderFile(pathAndFilename.c_str(), std::ios::in);
 
    if (!shaderFile.is_open())
    {
        log(logTag,
            "File open failed in readTextFileIntoString: %s",
            pathAndFilename.c_str());
        exit(1);
    }
 
    std::stringstream buffer;
    buffer << shaderFile.rdbuf();
    return buffer.str();
}

removeDir()

void Utils::removeDir

(

const string &

path

)

RemoveDir deletes a directory with given path.

Definition at line 851 of file Utils.cpp.

{
 
#if defined(USE_STD_FILESYSTEM)
    fs::remove_all(path);
#else
#    if defined(_WIN32)
    int ret = _rmdir(path.c_str());
    if (ret != 0)
    {
        errno_t err;
        _get_errno(&err);
        log("Could not remove directory: %s\nErrno: %s\n", path.c_str(), strerror(errno));
    }
#    else
    rmdir(path.c_str());
#    endif
#endif
}

removeFile()

void Utils::removeFile

(

const string &

path

)

RemoveFile deletes a file with given path.

Definition at line 872 of file Utils.cpp.

{
    if (fileExists(path))
    {
#if defined(USE_STD_FILESYSTEM)
        fs::remove(path);
#else
#    if defined(_WIN32)
        DeleteFileA(path.c_str());
#    else
        unlink(path.c_str());
#    endif
 
#endif
    }
    else
        log("Could not remove file : %s\nErrno: %s\n",
            path.c_str(),
            "file does not exist");
}

replaceNonFilenameChars()

string Utils::replaceNonFilenameChars	(	string	src,
		const char	replaceChar
	)

replaces non-filename characters: /|?%*:"<>'

Definition at line 244 of file Utils.cpp.

{
    std::replace(src.begin(), src.end(), '/', replaceChar);
    std::replace(src.begin(), src.end(), '\\', replaceChar);
    std::replace(src.begin(), src.end(), '|', replaceChar);
    std::replace(src.begin(), src.end(), '?', replaceChar);
    std::replace(src.begin(), src.end(), '%', replaceChar);
    std::replace(src.begin(), src.end(), '*', replaceChar);
    std::replace(src.begin(), src.end(), ':', replaceChar);
    std::replace(src.begin(), src.end(), '"', replaceChar);
    return src;
}

replaceString()

void Utils::replaceString	(	string &	source,
		const string &	from,
		const string &	to
	)

Replaces in the source string the from string by the to string.

Definition at line 170 of file Utils.cpp.

{
    // Code from: http://stackoverflow.com/questions/2896600/
    // how-to-replace-all-occurrences-of-a-character-in-string
    string newString;
    newString.reserve(source.length()); // avoids a few memory allocations
 
    string::size_type lastPos = 0;
    string::size_type findPos = 0;
 
    while (string::npos != (findPos = source.find(from, lastPos)))
    {
        newString.append(source, lastPos, findPos - lastPos);
        newString += to;
        lastPos = findPos + from.length();
    }
 
    // Care for the rest after last occurrence
    newString += source.substr(lastPos);
    source.swap(newString);
}

sign()

template<class T >

T Utils::sign ( T  a )

inline

Definition at line 245 of file Utils.h.

{return (T)((a > 0) ? 1 : (a < 0) ? -1 : 0);}

splitString()

void Utils::splitString	(	const string &	s,
		char	delimiter,
		vector< string > &	splits
	)

Splits an input string at a delimiter character into a string vector.

Definition at line 152 of file Utils.cpp.

{
    string::size_type i = 0;
    string::size_type j = s.find(delimiter);
 
    while (j != string::npos)
    {
        splits.push_back(s.substr(i, j - i));
        i = ++j;
        j = s.find(delimiter, j);
        if (j == string::npos)
            splits.push_back(s.substr(i, s.length()));
    }
}

startsWithString()

bool Utils::startsWithString	(	const string &	container,
		const string &	startStr
	)

Return true if the container string starts with the startStr.

Definition at line 350 of file Utils.cpp.

{
    return container.find(startStr) == 0;
}

step()

template<class T >

T Utils::step ( T  edge, T  x  )

inline

Definition at line 251 of file Utils.h.

{return (T)(x >= edge);}

toLowerString()

string Utils::toLowerString

(

string

s

)

Returns a string in lower case.

Definition at line 112 of file Utils.cpp.

{
    string cpy(std::move(s));
    transform(cpy.begin(), cpy.end(), cpy.begin(), ::tolower);
    return cpy;
}

toString() [1/2]

string Utils::toString	(	double	d,
		int	roundedDecimals
	)

Returns a string from a double with max. one trailing zero.

Definition at line 102 of file Utils.cpp.

{
    stringstream ss;
    ss << std::fixed << std::setprecision(roundedDecimals) << d;
    string num = ss.str();
    if (num == "-0.0") num = "0.0";
    return num;
}

toString() [2/2]

string Utils::toString	(	float	f,
		int	roundedDecimals
	)

Returns a string from a float with max. one trailing zero.

Definition at line 92 of file Utils.cpp.

{
    stringstream ss;
    ss << std::fixed << std::setprecision(roundedDecimals) << f;
    string num = ss.str();
    if (num == "-0.0") num = "0.0";
    return num;
}

toUpperString()

string Utils::toUpperString

(

string

s

)

Returns a string in upper case.

Definition at line 120 of file Utils.cpp.

{
    string cpy(std::move(s));
    transform(cpy.begin(), cpy.end(), cpy.begin(), ::toupper);
    return cpy;
}

trimLeftString()

string Utils::trimLeftString	(	const string &	s,
		const string &	drop
	)

trims a string at the left end

Definition at line 144 of file Utils.cpp.

{
    string r = s;
    r        = r.erase(r.find_first_not_of(drop) + 1);
    return r;
}

trimRightString()

string Utils::trimRightString	(	const string &	s,
		const string &	drop
	)

trims a string at the right end

Definition at line 136 of file Utils.cpp.

{
    string r = s;
    r        = r.erase(r.find_last_not_of(drop) + 1);
    return r;
}

trimString()

string Utils::trimString	(	const string &	s,
		const string &	drop
	)

Trims a string at both end.

Definition at line 128 of file Utils.cpp.

{
    string r = s;
    r        = r.erase(r.find_last_not_of(drop) + 1);
    return r.erase(0, r.find_first_not_of(drop));
}

unifySlashes()

string Utils::unifySlashes	(	const string &	inputDir,
		bool	withTrailingSlash
	)

Returns the inputDir string with unified forward slashes, e.g.: "dirA/dirB/".

Definition at line 367 of file Utils.cpp.

{
    string copy = inputDir;
    string curr;
    string delimiter = "\\";
    size_t pos       = 0;
    string token;
    while ((pos = copy.find(delimiter)) != string::npos)
    {
        token = copy.substr(0, pos);
        copy.erase(0, pos + delimiter.length());
        curr.append(token);
        curr.append("/");
    }
 
    curr.append(copy);
 
    if (withTrailingSlash && !curr.empty() && curr.back() != '/')
        curr.append("/");
 
    return curr;
}

warnMsg()

void Utils::warnMsg	(	const char *	tag,
		const char *	msg,
		const int	line,
		const char *	file
	)

Platform independent warn message output.

Definition at line 1142 of file Utils.cpp.

{
#if defined(ANDROID) || defined(ANDROID_NDK)
    __android_log_print(ANDROID_LOG_WARN,
                        tag,
                        "Warning: %s at line %d in %s\n",
                        msg,
                        line,
                        file);
#else
    std::cout << "--------------------------------\n"
              << "Warning:\n"
              << "Tag: " << tag << '\n'
              << "Location: " << file << ":" << line << '\n'
              << "Message: " << msg << '\n'
              << "--------------------------------" << std::endl;
#endif
}

writeStringIntoTextFile()

void Utils::writeStringIntoTextFile	(	const char *	logTag,
		const string &	stringToWrite,
		const string &	pathAndFilename
	)

Writes a string into a text file.

Definition at line 230 of file Utils.cpp.

{
    std::ofstream file(pathAndFilename);
    file << stringToWrite;
    if (file.bad())
        log(logTag,
            "Writing file failed in writeStringIntoTextFile: %s",
            pathAndFilename.c_str());
    file.close();
}

Variable Documentation

customLog

std::unique_ptr< CustomLog > Utils::customLog

custom log instance, e.g. log to a ui log window

Definition at line 82 of file Utils.cpp.

DEG2RAD

const float Utils::DEG2RAD = PI / 180.0f

static

Definition at line 239 of file Utils.h.

fileLog

std::unique_ptr<FileLog> Utils::fileLog

static

FileLog Instance for logging to logfile. If it is instantiated the logging methods will also output into this file. Instantiate it with initFileLog function.

Definition at line 198 of file Utils.h.

HALFPI

const float Utils::HALFPI = PI * 0.5f

static

Definition at line 242 of file Utils.h.

ONEOVERPI

const float Utils::ONEOVERPI = 1.0f / PI

static

Definition at line 241 of file Utils.h.

onlyErrorLogs

bool Utils::onlyErrorLogs = false

if this flag is set to true all calls to log get ignored

Definition at line 84 of file Utils.cpp.

PI

const float Utils::PI = 3.14159265358979f

static

Definition at line 237 of file Utils.h.

RAD2DEG

const float Utils::RAD2DEG = 180.0f / PI

static

Definition at line 238 of file Utils.h.

TWOPI

const float Utils::TWOPI = 2.0f * PI

static

Definition at line 240 of file Utils.h.