strncmp.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: BSL-1.0
// SPDX-FileCopyrightText: Copyright (C) 2020 Tobias Hienzsch
 
#ifndef TETL_CSTRING_STRNCMP_HPP
#define TETL_CSTRING_STRNCMP_HPP
 
#include <etl/_config/all.hpp>
 
#include <etl/_cstddef/size_t.hpp>
#include <etl/_strings/cstr.hpp>
 
namespace etl {
 
/// Compares at most count characters of two possibly null-terminated
/// arrays. The comparison is done lexicographically. Characters following the
/// null character are not compared.
///
/// The behavior is undefined when access occurs past the end of either
/// array lhs or rhs. The behavior is undefined when either lhs or rhs is the
/// null pointer.
///
/// \ingroup cstring
[[nodiscard]] constexpr auto strncmp(char const* lhs, char const* rhs, etl::size_t count) -> int
{
#if __has_builtin(__builtin_strncmp)
    return __builtin_strncmp(lhs, rhs, count);
#else
    return etl::detail::strncmp<char, etl::size_t>(lhs, rhs, count);
#endif
}
 
} // namespace etl
 
#endif // TETL_CSTRING_STRNCMP_HPP