strcmp.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: BSL-1.0
// SPDX-FileCopyrightText: Copyright (C) 2019 Tobias Hienzsch
 
#ifndef TETL_CSTRING_STRCMP_HPP
#define TETL_CSTRING_STRCMP_HPP
 
#include <etl/_config/all.hpp>
 
#include <etl/_cstddef/size_t.hpp>
#include <etl/_strings/cstr.hpp>
 
namespace etl {
 
/// Compares the C string lhs to the C string rhs.
///
/// This function starts comparing the first character of each string.
/// If they are equal to each other, it continues with the following pairs until
/// the characters differ or until a terminating null-character is reached.
///
/// \ingroup cstring
[[nodiscard]] constexpr auto strcmp(char const* lhs, char const* rhs) -> int
{
#if __has_builtin(__builtin_strcmp)
    return __builtin_strcmp(lhs, rhs);
#else
    return etl::detail::strcmp<char>(lhs, rhs);
#endif
}
 
} // namespace etl
 
#endif // TETL_CSTRING_STRCMP_HPP