utils.h

Go to the documentation of this file.

// Copyright 2018-present Network Optix, Inc. Licensed under MPL 2.0: www.mozilla.org/MPL/2.0/

#pragma once

#include <cstddef>
#include <cstring>
#include <cstdio>
#include <cstdlib>
#include <stdint.h>
#include <string>
#include <sstream>
#include <vector>
#include <map>

#if defined(QT_CORE_LIB)
    // To be supported in toString().
    #include <QtCore/QByteArray>
    #include <QtCore/QString>
    #include <QtCore/QUrl>
#endif

#if !defined(NX_KIT_API)
    #define NX_KIT_API /*empty*/
#endif

namespace nx {
namespace kit {
namespace utils {

//-------------------------------------------------------------------------------------------------
// Strings.

inline bool isAsciiPrintable(int c)
{
    return c >= 32 && c <= 126;
}

inline bool isSpaceOrControlChar(char c)
{
    // NOTE: Chars 128..255 should be treated as non-whitespace, thus, isprint() will not do.
    return (((unsigned char) c) <= 32) || (c == 127);
}

NX_KIT_API std::string decodeEscapedString(
    const std::string& s, std::string* outErrorMessage = nullptr);

template<typename T>
std::string toString(T value);

template<typename... Args>
std::string format(const std::string& formatStr, Args... args)
{
    const int size = snprintf(nullptr, 0, formatStr.c_str(), args...) + /*space for \0*/ 1;
    if (size <= 0)
        return formatStr; //< No better way to handle out-of-memory-like errors.
    std::string result(size, '\0');
    snprintf(&result[0], size, formatStr.c_str(), args...);
    result.resize(size - /*terminating \0*/ 1);
    return result;
}

NX_KIT_API bool fromString(const std::string& s, int* value);
NX_KIT_API bool fromString(const std::string& s, double* value);
NX_KIT_API bool fromString(const std::string& s, float* value);
NX_KIT_API bool fromString(const std::string& s, bool* value);

NX_KIT_API void stringReplaceAllChars(std::string* s, char sample, char replacement);
NX_KIT_API void stringInsertAfterEach(std::string* s, char sample, const char* insertion);
NX_KIT_API void stringReplaceAll(
    std::string* s, const std::string& sample, const std::string& replacement);

// TODO: Remove when migrating to C++20 - it has std::string::starts_with()/ends_with().
NX_KIT_API bool stringStartsWith(const std::string& s, const std::string& prefix);
NX_KIT_API bool stringEndsWith(const std::string& s, const std::string& suffix);

// TODO: Remove when migrating to C++23 - it has std::string::contains().
NX_KIT_API bool stringContains(const std::string& s, const std::string& substring);

NX_KIT_API std::string trimString(const std::string& s);

//-------------------------------------------------------------------------------------------------
// OS support.

constexpr char kPathSeparator =
    #if defined(_WIN32)
        '\\';
    #else
        '/';
    #endif

NX_KIT_API std::string baseName(std::string path);

NX_KIT_API std::string absolutePath(
    const std::string& originDir, const std::string& path);

NX_KIT_API std::string getProcessName();

NX_KIT_API const std::vector<std::string>& getProcessCmdLineArgs();

NX_KIT_API std::string getPathToExecutable();

NX_KIT_API bool fileExists(const char* filename);

//-------------------------------------------------------------------------------------------------
// Aligned allocation.

inline size_t alignUp(size_t value, size_t alignment)
{
    if (alignment == 0)
        return value;
    const size_t remainder = value % alignment;
    if (remainder == 0)
        return value;
    return value + alignment - remainder;
}

constexpr size_t kMinAlignment = 16;

template<class MallocFunc>
void* mallocAligned(size_t size, size_t alignment, MallocFunc mallocFunc)
{
    if (alignment < kMinAlignment)
        alignment = kMinAlignment;

    // Reject sizes that overflow the arithmetic below. Without this check an overflowing request
    // would succeed with a buffer far smaller than asked for, turning a bogus size into a heap
    // overflow at the first write.
    if (alignment > SIZE_MAX - sizeof(alignment))
        return nullptr;
    const size_t overhead = alignment + sizeof(alignment);
    if (size > SIZE_MAX - overhead)
        return nullptr;

    const auto ptr = (char*) mallocFunc(size + overhead);
    if (!ptr) //< allocation error
        return ptr;

    char* const alignedPtr = ptr + sizeof(alignment); //< Leaving place to save misalignment.
    const size_t misalignment = alignment - (uintptr_t) alignedPtr % alignment;
    memcpy(ptr + misalignment, &misalignment, sizeof(misalignment)); //< Save misalignment.
    return alignedPtr + misalignment;
}

inline void* mallocAligned(size_t size, size_t alignment)
{
    // NOTE: Lambda is used to suppress a warning that some ::malloc() implementations are using
    // deprecated exception specification.
    return mallocAligned<>(size, alignment, [](size_t size) { return ::malloc(size); });
}

template<class FreeFunc>
void freeAligned(void* ptr, FreeFunc freeFunc)
{
    if (!ptr)
        return freeFunc(ptr);

    ptr = (char*) ptr - sizeof(size_t);
    size_t misalignment = 0;
    memcpy(&misalignment, ptr, sizeof(misalignment)); //< Retrieve saved misalignment.
    ptr = (char*) ptr - misalignment;

    freeFunc(ptr);
}

inline void freeAligned(void* ptr)
{
    // NOTE: Lambda is used to suppress a warning that some ::free() implementations are using
    // deprecated exception specification.
    return freeAligned<>(ptr, [](void* ptr) { return ::free(ptr); });
}

//-------------------------------------------------------------------------------------------------
// Implementation.

// The order of overloads below is important - it defines which will be chosen by inline functions.
NX_KIT_API std::string toString(bool b);
NX_KIT_API std::string toString(const void* ptr);
inline std::string toString(void* ptr) { return toString(const_cast<const void*>(ptr)); }
inline std::string toString(std::nullptr_t ptr) { return toString((const void*) ptr); }
inline std::string toString(uint8_t i) { return toString((int) i); } //< Avoid matching as char.
inline std::string toString(int8_t i) { return toString((int) i); } //< Avoid matching as char.
NX_KIT_API std::string toString(char c);
NX_KIT_API std::string toString(const char* s);
inline std::string toString(char* s) { return toString(const_cast<const char*>(s)); }
NX_KIT_API std::string toString(wchar_t c);
NX_KIT_API std::string toString(const wchar_t* w);
inline std::string toString(wchar_t* w) { return toString(const_cast<const wchar_t*>(w)); }

// std::string can contain '\0' inside, hence a dedicated implementation.
NX_KIT_API std::string toString(const std::string& s);
NX_KIT_API std::string toString(const std::wstring& w);


template<typename T>
std::string toString(T value)
{
    std::ostringstream outputString;
    outputString << value;
    return outputString.str();
}

#if defined(QT_CORE_LIB)

static inline std::string toString(QByteArray b) //< By value to avoid calling the template impl.
{
    return toString(b.toStdString());
}

static inline std::string toString(QString s) //< By value to avoid calling the template impl.
{
    return toString(s.toUtf8().constData());
}

static inline std::string toString(QUrl u) //< By value to avoid calling the template impl.
{
    return toString(u.toEncoded().toStdString());
}

#endif // defined(QT_CORE_LIB)

template<typename P>
std::string toString(P* ptr)
{
    return toString((const void*) ptr);
}

//-------------------------------------------------------------------------------------------------
// Configuration file parsing.

NX_KIT_API bool parseNameValueFile(
    const std::string& nameValueFilePath,
    std::map<std::string, std::string>* nameValueMap,
    const std::string& errorPrefix,
    std::ostream* out,
    bool* isFileEmpty);

//-------------------------------------------------------------------------------------------------
// String conversions.

NX_KIT_API std::string toUpper(const std::string& str);

#if defined(_WIN32)

NX_KIT_API std::string wideCharToStdString(const wchar_t* str);

#endif // defined(_WIN32)

} // namespace utils
} // namespace kit
} // namespace nx