Tools/WebKitTestRunner/StringFunctions.h

/*
 * Copyright (C) 2010-2020 Apple Inc. All rights reserved.
 * Copyright (C) 2010 University of Szeged. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include "JSBasics.h"
#include <WebKit/WKRetainPtr.h>
#include <WebKit/WKString.h>
#include <WebKit/WKStringPrivate.h>
#include <sstream>
#include <string>
#include <vector>
#include <wtf/Platform.h>
#include <wtf/StdLibExtras.h>
#include <wtf/UniqueArray.h>
#include <wtf/Vector.h>
#include <wtf/text/CString.h>
#include <wtf/text/WTFString.h>

namespace WTR {

WKRetainPtr<WKStringRef> toWKString(JSContextRef, JSValueRef);
WTF::String toWTFString(JSContextRef, JSValueRef);

inline WKRetainPtr<WKStringRef> toWK(JSStringRef string)
{
    return adoptWK(WKStringCreateWithJSString(string));
}

inline WKRetainPtr<WKStringRef> toWK(const JSRetainPtr<JSStringRef>& string)
{
    return toWK(string.get());
}

inline WKRetainPtr<WKStringRef> toWK(const char* string)
{
    return adoptWK(WKStringCreateWithUTF8CString(string));
}

inline WKRetainPtr<WKStringRef> toWK(const std::string& string)
{
    return toWK(string.c_str());
}

inline WKRetainPtr<WKStringRef> toWK(const WTF::String& string)
{
    return toWK(string.utf8().data());
}

inline JSRetainPtr<JSStringRef> toJS(WKStringRef string)
{
    return adopt(WKStringCopyJSString(string));
}

inline JSRetainPtr<JSStringRef> toJS(const WKRetainPtr<WKStringRef>& string)
{
    return toJS(string.get());
}

inline std::string toSTD(WKStringRef string)
{
    size_t bufferSize = WKStringGetMaximumUTF8CStringSize(string);
    auto buffer = makeUniqueWithoutFastMallocCheck<char[]>(bufferSize);
    size_t stringLength = WKStringGetUTF8CString(string, buffer.get(), bufferSize);
    return std::string(buffer.get(), stringLength - 1);
}

inline std::string toSTD(const WKRetainPtr<WKStringRef>& string)
{
    return toSTD(string.get());
}

inline WTF::String toWTFString(WKStringRef string)
{
    if (!string)
        return nullString();
    size_t bufferSize = WKStringGetMaximumUTF8CStringSize(string);
    auto buffer = makeUniqueWithoutFastMallocCheck<char[]>(bufferSize);
    size_t stringLength = WKStringGetUTF8CStringNonStrict(string, buffer.get(), bufferSize);
    if (!stringLength)
        return "(null)"_s;
    return WTF::String::fromUTF8WithLatin1Fallback(buffer.get(), stringLength - 1);
}
    
inline WTF::String toWTFString(const WKRetainPtr<WKStringRef>& string)
{
    return toWTFString(string.get());
}

inline WTF::String toWTFString(JSStringRef string)
{
    return toWTFString(toWK(string));
}

inline WTF::String toWTFString(const JSRetainPtr<JSStringRef>& string)
{
    return toWTFString(string.get());
}

inline WTF::String toWTFString(const std::string& string)
{
    return WTF::String::fromUTF8(string.c_str());
}

inline WKRetainPtr<WKStringRef> toWKString(JSContextRef context, JSValueRef value)
{
    return toWK(createJSString(context, value).get());
}

inline WTF::String toWTFString(JSContextRef context, JSValueRef value)
{
    // FIXME: Could make this efficient by using the WTFString inside OpaqueJSString if we wanted to.
    return toWTFString(createJSString(context, value));
}

template<typename StringType>
inline std::vector<StringType> split(const StringType& string, char delimiter)
{
    std::vector<StringType> result;

    size_t i = 0;
    while (i < string.size()) {
        auto foundIndex = string.find_first_of(delimiter, i);

        if (foundIndex != i)
            result.push_back(string.substr(i, foundIndex - i));

        if (foundIndex == StringType::npos)
            break;

        i = foundIndex + 1;
    }

    return result;
}

} // namespace WTR