src/dawn/common/StringViewUtils.h

// Copyright 2024 The Dawn & Tint Authors
//
// 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.
//
// 3. Neither the name of the copyright holder nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT HOLDER OR 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.

#ifndef SRC_DAWN_COMMON_STRINGVIEWUTILS_H_
#define SRC_DAWN_COMMON_STRINGVIEWUTILS_H_

#include <webgpu/webgpu_cpp.h>

#include <string>
#include <string_view>

// A comparison operators for use in tests that assumes that the nil string is the same as "".
bool operator==(WGPUStringView a, WGPUStringView b);
namespace wgpu {
bool operator==(StringView a, StringView b);
}  // namespace wgpu

namespace dawn {

// Helper functions to work with the C WGPUStringView in tests, since it doesn't have all the
// niceties of wgpu::StringView.
WGPUStringView ToOutputStringView(const std::string& s);
WGPUStringView ToOutputStringView(const std::string_view& s);
template <size_t N>
constexpr WGPUStringView ToOutputStringView(const char (&s)[N]) {
    return {s, N - 1};
}

constexpr WGPUStringView kEmptyOutputStringView = {nullptr, 0};

std::string ToString(WGPUStringView s);

}  // namespace dawn

#endif  // SRC_DAWN_COMMON_STRINGVIEWUTILS_H_