[LLVM][Support] Allow char[N] parameters in llvm::format (#159541)

Cygwin builds are currently broken after #157312, which effectively
reverted #138117. The root cause is that Cygwin defines
`DL_info::dli_fname` as `char[N]`, which is not a valid parameter type
for `llvm::format`.

This patch allows `llvm::format` to accept `char[N]` by decaying it to
`const char *`. As a result, string literals are also accepted without
an explicit cast.

Other array types remain rejected:
- Wide/unicode character arrays (e.g., `wchar_t[N]`) are not supported,
as LLVM does not use them and they are less compatible with platform's
`printf` implementations.
- Non-character arrays (e.g., `int[N]`) are also rejected, since passing
such arrays to `printf` is meaningless.
This commit is contained in:
Tomohiro Kashiwada 2025-10-13 18:09:42 +09:00 committed by GitHub
parent cdc8e8d092
commit ea251536d5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 70 additions and 2 deletions

View File

@ -78,9 +78,20 @@ public:
/// printed, this synthesizes the string into a temporary buffer provided and
/// returns whether or not it is big enough.
namespace detail {
template <typename T> struct decay_if_c_char_array {
using type = T;
};
template <std::size_t N> struct decay_if_c_char_array<char[N]> {
using type = const char *;
};
template <typename T>
using decay_if_c_char_array_t = typename decay_if_c_char_array<T>::type;
} // namespace detail
template <typename... Ts>
class format_object final : public format_object_base {
std::tuple<Ts...> Vals;
std::tuple<detail::decay_if_c_char_array_t<Ts>...> Vals;
template <std::size_t... Is>
int snprint_tuple(char *Buffer, unsigned BufferSize,
@ -96,7 +107,7 @@ public:
format_object(const char *fmt, const Ts &... vals)
: format_object_base(fmt), Vals(vals...) {
static_assert(
(std::is_scalar_v<Ts> && ...),
(std::is_scalar_v<detail::decay_if_c_char_array_t<Ts>> && ...),
"format can't be used with non fundamental / non pointer type");
}

View File

@ -44,6 +44,7 @@ add_llvm_unittest(SupportTests
ExtensibleRTTITest.cpp
FileCollectorTest.cpp
FileOutputBufferTest.cpp
Format.cpp
FormatVariadicTest.cpp
FSUniqueIDTest.cpp
GenericDomTreeTest.cpp

View File

@ -0,0 +1,56 @@
//===----------------------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "llvm/Support/Format.h"
#include "gtest/gtest.h"
using namespace llvm;
namespace {
template <typename FormatTy>
std::string printToString(unsigned MaxN, FormatTy &&Fmt) {
std::vector<char> Dst(MaxN + 2);
int N = Fmt.snprint(Dst.data(), Dst.size());
Dst.back() = 0;
return N < 0 ? "" : Dst.data();
}
template <typename Expected, typename Arg>
constexpr bool checkDecayTypeEq(const Arg &arg) {
return std::is_same_v<detail::decay_if_c_char_array_t<Arg>, Expected>;
}
TEST(Format, DecayIfCCharArray) {
char Array[] = "Array";
const char ConstArray[] = "ConstArray";
char PtrBuf[] = "Ptr";
char *Ptr = PtrBuf;
const char *PtrToConst = "PtrToConst";
EXPECT_EQ(" Literal", printToString(20, format("%15s", "Literal")));
EXPECT_EQ(" Array", printToString(20, format("%15s", Array)));
EXPECT_EQ(" ConstArray", printToString(20, format("%15s", ConstArray)));
EXPECT_EQ(" Ptr", printToString(20, format("%15s", Ptr)));
EXPECT_EQ(" PtrToConst", printToString(20, format("%15s", PtrToConst)));
EXPECT_TRUE(checkDecayTypeEq<const char *>("Literal"));
EXPECT_TRUE(checkDecayTypeEq<const char *>(Array));
EXPECT_TRUE(checkDecayTypeEq<const char *>(ConstArray));
EXPECT_TRUE(checkDecayTypeEq<char *>(Ptr));
EXPECT_TRUE(checkDecayTypeEq<const char *>(PtrToConst));
EXPECT_TRUE(checkDecayTypeEq<char>(PtrToConst[0]));
EXPECT_TRUE(
checkDecayTypeEq<const char *>(static_cast<const char *>("Literal")));
wchar_t WCharArray[] = L"WCharArray";
EXPECT_TRUE(checkDecayTypeEq<wchar_t[11]>(WCharArray));
EXPECT_TRUE(checkDecayTypeEq<wchar_t>(WCharArray[0]));
}
} // namespace