VuoStringUtilities.cc

Go to the documentation of this file.

 
#include <iomanip>
#include <sstream>
#include <CommonCrypto/CommonDigest.h>
#include <CoreFoundation/CoreFoundation.h>
#include "VuoException.hh"
#include "VuoStringUtilities.hh"
 
extern "C" {
#include "mkdio.h"
}
 
bool VuoStringUtilities::beginsWith(const string &wholeString, const string &beginning)
{
    return wholeString.rfind(beginning, 0) == 0;
}
 
bool VuoStringUtilities::beginsWith(const char *wholeString, const char *beginning)
{
    return strlen(wholeString) >= strlen(beginning) && strstr(wholeString, beginning) == wholeString;
}
 
bool VuoStringUtilities::endsWith(const string &wholeString, const string &ending)
{
    if (wholeString.length() < ending.length())
        return false;
 
    return wholeString.compare(wholeString.length()-ending.length(), ending.length(), ending) == 0;
}
 
string VuoStringUtilities::substrAfter(const string &wholeString, const string &beginning)
{
    if (! beginsWith(wholeString, beginning))
        return "";
 
    return wholeString.substr(beginning.length());
}
 
string VuoStringUtilities::substrBefore(const string &wholeString, const string &ending)
{
    if (! endsWith(wholeString, ending))
        return "";
 
    return wholeString.substr(0, wholeString.length()-ending.length());
}
 
string VuoStringUtilities::replaceAll(const string &wholeString, char originalChar, char replacementChar)
{
    string outString = wholeString;
    size_t pos = 0;
    while ((pos = wholeString.find_first_of(originalChar, pos)) != string::npos)
    {
        outString[pos] = replacementChar;
        pos = pos + 1;
    }
    return outString;
}
 
size_t VuoStringUtilities::replaceAll(string &wholeString, const string &originalSubstring, const string &replacementSubstring)
{
    size_t replacementCount = 0;
    size_t startPos = 0;
    while ((startPos = wholeString.find(originalSubstring, startPos)) != string::npos)
    {
        wholeString.replace(startPos, originalSubstring.length(), replacementSubstring);
        startPos += replacementSubstring.length();
        ++replacementCount;
    }
    return replacementCount;
}
 
vector<string> VuoStringUtilities::split(const string &wholeString, char delimiter)
{
    vector<string> tokens;
    istringstream iss(wholeString);
    string token;
    while( getline(iss, token, delimiter) )
        tokens.push_back(token);
    return tokens;
}
 
string VuoStringUtilities::join(const vector<string> &partialStrings, char delimiter)
{
    string delimiterStr(1, delimiter);
    return join(partialStrings, delimiterStr);
}
 
string VuoStringUtilities::join(const vector<string> &partialStrings, const string &delimiter)
{
    string wholeString;
    for (auto i = partialStrings.cbegin(); i != partialStrings.cend(); )
    {
        wholeString += *i;
        if (++i != partialStrings.cend())
            wholeString += delimiter;
    }
    return wholeString;
}
 
string VuoStringUtilities::join(const set<string> &partialStrings, const string &delimiter)
{
    string wholeString;
    for (auto i = partialStrings.cbegin(); i != partialStrings.cend(); )
    {
        wholeString += *i;
        if (++i != partialStrings.cend())
            wholeString += delimiter;
    }
    return wholeString;
}
 
string VuoStringUtilities::trim(const string &originalString)
{
    string whitespace = " \t\v\n\r\f";
 
    string::size_type begin = originalString.find_first_not_of(whitespace);
    if (begin == std::string::npos)
        return "";
 
    string::size_type end = originalString.find_last_not_of(whitespace);
 
    return originalString.substr(begin, end - begin + 1);
}
 
void VuoStringUtilities::doForEachLine(const string &multiLineString, std::function<void(const char *)> doForLine)
{
    // https://stackoverflow.com/questions/17983005/c-how-to-read-a-string-line-by-line
 
    const char linebreak = '\n';
 
    int bufferLength = 1024;
    char *line = (char *)malloc(bufferLength + 1);
 
    const char *lineStart = multiLineString.c_str();
    while (lineStart)
    {
        const char *lineEnd = strchr(lineStart, linebreak);
        int lineLength = lineEnd ? (lineEnd - lineStart) : strlen(lineStart);
 
        if (lineLength > bufferLength)
        {
            free(line);
            line = (char *)malloc(lineLength + 1);
            bufferLength = lineLength;
        }
 
        memcpy(line, lineStart, lineLength);
        line[lineLength] = 0;
 
        doForLine(line);
 
        lineStart = lineEnd ? (lineEnd + 1) : nullptr;
    }
 
    free(line);
}
 
string VuoStringUtilities::buildCompositionIdentifier(const string &parentCompositionIdentifier, const string &nodeIdentifier)
{
    return parentCompositionIdentifier + "/" + nodeIdentifier;
}
 
string VuoStringUtilities::buildPortIdentifier(const string &nodeIdentifier, const string &portName)
{
    return nodeIdentifier + ":" + portName;
}
 
string VuoStringUtilities::prefixSymbolName(const string &symbolName, const string &moduleKey)
{
    return transcodeToIdentifier(moduleKey) + "__" + symbolName;
}
 
string VuoStringUtilities::transcodeToIdentifier(const string &str)
{
    CFMutableStringRef strCF = CFStringCreateMutable(NULL, 0);
    CFStringAppendCString(strCF, str.c_str(), kCFStringEncodingUTF8);
 
    CFStringNormalize(strCF, kCFStringNormalizationFormD);  // decomposes combining characters, so accents/diacritics are separated from their letters
 
    CFIndex strLength = CFStringGetLength(strCF);
    UniChar *strBuf = (UniChar *)malloc(strLength * sizeof(UniChar));
    if (!strBuf)
    {
        CFRelease(strCF);
        return string();
    }
    CFStringGetCharacters(strCF, CFRangeMake(0, strLength), strBuf);
 
    CFStringRef empty = CFStringCreateWithCString(NULL, "", kCFStringEncodingUTF8);
    CFStringRef underscore = CFStringCreateWithCString(NULL, "_", kCFStringEncodingUTF8);
    CFStringRef doubleUnderscore = CFStringCreateWithCString(NULL, "__", kCFStringEncodingUTF8);
    if (!empty || !underscore || !doubleUnderscore)
    {
        CFRelease(strCF);
        if (empty)
            CFRelease(empty);
        if (underscore)
            CFRelease(underscore);
        if (doubleUnderscore)
            CFRelease(doubleUnderscore);
        return string();
    }
 
    for (CFIndex i = strLength-1; i >= 0; --i)
    {
        UniChar c = strBuf[i];
 
        CFStringRef replacement = NULL;
        if (c > 127)  // non-ASCII
            replacement = empty;
        else if (c == '.' || isspace(c))
            replacement = underscore;
        else if (c == '/' || c == ':')
            replacement = doubleUnderscore;
        else if (! isValidCharInIdentifier(c))
            replacement = empty;
 
        if (replacement)
            CFStringReplace(strCF, CFRangeMake(i, 1), replacement);
    }
 
    string ret = makeFromCFString(strCF);
 
    CFRelease(strCF);
    CFRelease(empty);
    CFRelease(underscore);
    CFRelease(doubleUnderscore);
    free(strBuf);
 
    return ret;
}
 
bool VuoStringUtilities::isValidCharInIdentifier(char ch)
{
    return isalnum(ch) || ch == '_';
}
 
string VuoStringUtilities::transcodeToGraphvizIdentifier(const string &originalString)
{
    string escapedString = originalString;
    for (string::size_type i = 0; (i = escapedString.find("\\", i)) != std::string::npos; i += 2)
        escapedString.replace(i, 1, "\\\\");
    for (string::size_type i = 0; (i = escapedString.find("\"", i)) != std::string::npos; i += 2)
        escapedString.replace(i, 1, "\\\"");
    for (string::size_type i = 0; (i = escapedString.find("{", i)) != std::string::npos; i += 2)
        escapedString.replace(i, 1, "\\{");
    for (string::size_type i = 0; (i = escapedString.find("}", i)) != std::string::npos; i += 2)
        escapedString.replace(i, 1, "\\}");
    for (string::size_type i = 0; (i = escapedString.find("<", i)) != std::string::npos; i += 2)
        escapedString.replace(i, 1, "\\<");
    for (string::size_type i = 0; (i = escapedString.find(">", i)) != std::string::npos; i += 2)
        escapedString.replace(i, 1, "\\>");
    for (string::size_type i = 0; (i = escapedString.find("|", i)) != std::string::npos; i += 2)
        escapedString.replace(i, 1, "\\|");
    for (string::size_type i = 0; (i = escapedString.find("  ", i)) != std::string::npos; i += 3)
        escapedString.replace(i, 2, " \\ ");
    return escapedString;
}
 
string VuoStringUtilities::transcodeFromGraphvizIdentifier(const string &graphvizIdentifier)
{
    string unescapedString;
    bool inEscape = false;
    for (string::const_iterator i = graphvizIdentifier.begin(); i != graphvizIdentifier.end(); ++i)
    {
        if (inEscape)
        {
            inEscape = false;
            unescapedString += *i;
            continue;
        }
 
        if (*i == '\\')
        {
            inEscape = true;
            continue;
        }
 
        unescapedString  += *i;
    }
    return unescapedString;
}
 
string VuoStringUtilities::formUniqueIdentifier(set<string> &takenIdentifiers,
                                                const string &preferredIdentifier, const string &identifierPrefix)
{
    auto isIdentifierAvailable = [&takenIdentifiers] (const string &identifier)
    {
        return takenIdentifiers.find(identifier) == takenIdentifiers.end();
    };
 
    string uniqueIdentifier = formUniqueIdentifier(isIdentifierAvailable, preferredIdentifier, identifierPrefix);
    takenIdentifiers.insert(uniqueIdentifier);
    return uniqueIdentifier;
}
 
string VuoStringUtilities::formUniqueIdentifier(std::function<bool(const string &)> isIdentifierAvailable,
                                                const string &preferredIdentifier, const string &identifierPrefix)
{
    string unique = preferredIdentifier;
    string prefix = (! identifierPrefix.empty() ? identifierPrefix : preferredIdentifier);
    int suffix = 2;
 
    while (! isIdentifierAvailable(unique))
    {
        ostringstream oss;
        oss << prefix << suffix++;
        unique = oss.str();
    }
 
    return unique;
}
 
string VuoStringUtilities::generateHtmlFromMarkdown(const string &markdownString)
{
    MMIOT *doc = mkd_string(markdownString.c_str(), markdownString.length(), MKD_NOPANTS);
    mkd_compile(doc, 0);
    char *html;
    mkd_document(doc, &html);
    string htmlString(html);
    mkd_cleanup(doc);
 
    // Remove the final linebreak from code blocks,
    // since Qt (unlike typical browser rendering engines) considers that whitespace significant.
    replaceAll(htmlString, "\n</code></pre>", "</code></pre>");
 
    return htmlString;
}
 
string VuoStringUtilities::generateHtmlFromMarkdownLine(const string &markdownString)
{
    size_t length = markdownString.length();
    if (!length)
        return "";
 
    char *html;
    mkd_line((char *)markdownString.c_str(), length, &html, MKD_NOPANTS);
    string htmlString(html);
    free(html);
    return htmlString;
}
 
string VuoStringUtilities::convertToCamelCase(const string &originalString,
                                              bool forceFirstLetterToUpper, bool forceFirstLetterToLower, bool forceInterveningLettersToLower,
                                              bool allowSeparatorDots)
{
    string camelCaseString;
    bool first = true;
    bool uppercaseNext = forceFirstLetterToUpper;
    bool lowercaseNext = forceFirstLetterToLower;
    bool previousWasDot = false;
    for (string::const_iterator i = originalString.begin(); i != originalString.end(); ++i)
    {
        if (first && !isalpha(*i))
            continue;
        first = false;
 
        bool isDot = *i == '.';
        if (allowSeparatorDots && isDot)
        {
            if (previousWasDot)
                continue;
            uppercaseNext = false;
        }
        else if (!isalnum(*i))
        {
            uppercaseNext = true;
            continue;
        }
 
        if (uppercaseNext)
            camelCaseString += toupper(*i);
        else if (lowercaseNext)
            camelCaseString += tolower(*i);
        else
            camelCaseString += *i;
 
        uppercaseNext = false;
        lowercaseNext = forceInterveningLettersToLower;
        previousWasDot = isDot;
    }
 
    // Trim trailing dots.
    if (allowSeparatorDots)
        while (endsWith(camelCaseString, "."))
            camelCaseString = substrBefore(camelCaseString, ".");
 
    return camelCaseString;
}
 
string VuoStringUtilities::expandCamelCase(const string &camelCaseString)
{
    // Only apply these transformations if the whole string matches,
    // since they may appear as substrings in contexts where they shouldn't be all-caps.
    if (camelCaseString == "x")
        return "X";
    else if (camelCaseString == "y")
        return "Y";
    else if (camelCaseString == "z")
        return "Z";
    else if (camelCaseString == "w")
        return "W";
    else if (camelCaseString == "xy")
        return "XY";
    else if (camelCaseString == "osc")
        return "OSC";
 
    string out;
    out += toupper(camelCaseString[0]);
 
    size_t length = camelCaseString.length();
    for (int i = 1; i < length; ++i)
    {
        char c = camelCaseString[i];
        if (isupper(c) || (isdigit(c) && !isdigit(camelCaseString[i-1])))
            out += " ";
        out += c;
    }
 
    string allCaps[]{
        "2d",
        "3d",
        "4d",
        "Xyzw",
        "Xyz",
        "Rgbaw",
        "Rgba",
        "Rgbw",
        "Rgb",
        "Wwcw",
        "Cmy",
        "Hsl",
        "Hdmi",
        "Sdi",
        "Ntsc",
//      "Pal",  // Appears in Leap Motion "Palm Velocity".
        "Url",
        "Midi",
        "Rss",
        "Csv",
        "Tsv",
        "Ascii",
        "Json",
        "Xml",
        "Dmx",
    };
    for (auto lower : allCaps)
    {
        string upper = lower;
        std::transform(upper.begin(), upper.end(), upper.begin(), ::toupper);
        VuoStringUtilities::replaceAll(out, lower, upper);
    }
 
    return out;
}
 
string VuoStringUtilities::makeFromCFString(const void *cfs)
{
    if (!cfs)
        return "";
 
    CFStringRef cfString = (CFStringRef)cfs;
 
    // https://stackoverflow.com/questions/1609565/whats-the-cfstring-equiv-of-nsstrings-utf8string
    const char *utf8StringPtr = CFStringGetCStringPtr(cfString, kCFStringEncodingUTF8);
    if (utf8StringPtr)
        return utf8StringPtr;
    else
    {
        CFIndex maxBytes = CFStringGetMaximumSizeForEncoding(CFStringGetLength(cfString), kCFStringEncodingUTF8) + 1;
        char *t = (char *)calloc(1, maxBytes);
        CFStringGetCString(cfString, t, maxBytes, kCFStringEncodingUTF8);
        string s(t);
        free(t);
        return s;
    }
}
 
string VuoStringUtilities::makeRandomHash(int length)
{
    static const char alphanum[] =
        "0123456789"
        "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
        "abcdefghijklmnopqrstuvwxyz";
 
    string hash(length, 0);
    for (int i = 0; i < length; ++i)
        hash[i] = alphanum[arc4random_uniform(sizeof(alphanum)-1)];
 
    return hash;
}
 
const std::locale VuoStringUtilities::locale;
const std::collate<char> &VuoStringUtilities::collate = std::use_facet<std::collate<char> >(VuoStringUtilities::locale);
 
string VuoStringUtilities::calculateSHA256(const string &s)
{
    unsigned char hash[CC_SHA256_DIGEST_LENGTH];
    if (!CC_SHA256(s.c_str(), s.length(), hash))
        throw VuoException("Error: CC_SHA256 failed.");
 
    ostringstream oss;
    oss << setfill('0') << hex;
    for (int i = 0; i < CC_SHA256_DIGEST_LENGTH; ++i)
        oss << setw(2) << (int)hash[i];
    return oss.str();
}