0ct0pu5/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-12-02 12:30:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

AK+Kernel+Userland: Enable some more compiletime format string checks

Browse source 
This enables format string checks for three more functions:
- String::formatted()
- Builder::appendff()
- KBufferBuilder::appendff()
This commit is contained in:
AnotherTest 2021-02-23 09:58:15 +03:30 committed by Andreas Kling
parent c989e55195
commit 7c2754c3a6
Notes: sideshowbarker 2024-07-18 21:59:47 +09:00 
Author: https://github.com/alimpfard
Commit: https://github.com/SerenityOS/serenity/commit/7c2754c3a66
Pull-request: https://github.com/SerenityOS/serenity/pull/5468
6 changed files with 24 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
AK/String.h
View file

@ -270,9 +270,9 @@ public:
static String vformatted(StringView fmtstr, TypeErasedFormatParams);
template<typename... Parameters>
static String formatted(StringView fmtstr, const Parameters&... parameters)
static String formatted(CheckedFormatString<Parameters...>&& fmtstr, const Parameters&... parameters)
{
return vformatted(fmtstr, VariadicFormatParams { parameters... });
return vformatted(fmtstr.view(), VariadicFormatParams { parameters... });
}
template<typename T>

4
AK/StringBuilder.h
View file

@ -52,9 +52,9 @@ public:
void append_escaped_for_json(const StringView&);
template<typename... Parameters>
void appendff(StringView fmtstr, const Parameters&... parameters)
void appendff(CheckedFormatString<Parameters...>&& fmtstr, const Parameters&... parameters)
{
vformat(*this, fmtstr, VariadicFormatParams { parameters... });
vformat(*this, fmtstr.view(), VariadicFormatParams { parameters... });
}
String build() const;

20
AK/Tests/TestFormat.cpp
View file

@ -58,8 +58,10 @@ TEST_CASE(reorder_format_arguments)
{
EXPECT_EQ(String::formatted("{1}{0}", "a", "b"), "ba");
EXPECT_EQ(String::formatted("{0}{1}", "a", "b"), "ab");
EXPECT_EQ(String::formatted("{0}{0}{0}", "a", "b"), "aaa");
EXPECT_EQ(String::formatted("{1}{}{0}", "a", "b", "c"), "baa");
// Compiletime check bypass: ignoring a passed argument.
EXPECT_EQ(String::formatted(StringView { "{0}{0}{0}" }, "a", "b"), "aaa");
// Compiletime check bypass: ignoring a passed argument.
EXPECT_EQ(String::formatted(StringView { "{1}{}{0}" }, "a", "b", "c"), "baa");
}
TEST_CASE(escape_braces)
@ -123,16 +125,18 @@ TEST_CASE(zero_pad)
TEST_CASE(replacement_field)
{
EXPECT_EQ(String::formatted("{:*>{1}}", 13, static_cast<size_t>(10)), "********13");
EXPECT_EQ(String::formatted("{:*<{1}}", 7, 4), "7***");
EXPECT_EQ(String::formatted("{:{2}}", -5, 8, 16), " -5");
EXPECT_EQ(String::formatted("{{{:*^{1}}}}", 1, 3), "{*1*}");
EXPECT_EQ(String::formatted("{:0{}}", 1, 3), "001");
// FIXME: Compiletime check bypass: cannot parse '}}' correctly.
EXPECT_EQ(String::formatted(StringView { "{:*>{1}}" }, 13, static_cast<size_t>(10)), "********13");
EXPECT_EQ(String::formatted(StringView { "{:*<{1}}" }, 7, 4), "7***");
EXPECT_EQ(String::formatted(StringView { "{:{2}}" }, -5, 8, 16), " -5");
EXPECT_EQ(String::formatted(StringView { "{{{:*^{1}}}}" }, 1, 3), "{*1*}");
EXPECT_EQ(String::formatted(StringView { "{:0{}}" }, 1, 3), "001");
}
TEST_CASE(replacement_field_regression)
{
EXPECT_EQ(String::formatted("{:{}}", "", static_cast<unsigned long>(6)), " ");
// FIXME: Compiletime check bypass: cannot parse '}}' correctly.
EXPECT_EQ(String::formatted(StringView { "{:{}}" }, "", static_cast<unsigned long>(6)), " ");
}
TEST_CASE(complex_string_specifiers)

4
Kernel/KBufferBuilder.h
View file

@ -49,11 +49,11 @@ public:
void append_bytes(ReadonlyBytes);
template<typename... Parameters>
void appendff(StringView fmtstr, const Parameters&... parameters)
void appendff(CheckedFormatString<Parameters...>&& fmtstr, const Parameters&... parameters)
{
// FIXME: This is really not the way to go about it, but vformat expects a
// StringBuilder. Why does this class exist anyways?
append(String::formatted(fmtstr, parameters...));
append(String::formatted(fmtstr.view(), parameters...));
}
bool flush();

7
Userland/Applications/Calculator/Keypad.cpp
View file

@ -164,8 +164,11 @@ String Keypad::to_string() const
builder.append("-");
builder.appendff("{}", m_int_value);
if (m_frac_length > 0)
builder.appendff(".{:0{}}", m_frac_value, m_frac_length);
if (m_frac_length > 0) {
// FIXME: This disables the compiletime format string check since we can't parse '}}' here correctly.
// remove the 'StringView { }' when that's fixed.
builder.appendff(StringView { ".{:0{}}" }, m_frac_value, m_frac_length);
}
return builder.to_string();
}

2
Userland/Applications/CrashReporter/main.cpp
View file

@ -60,7 +60,7 @@ static TitleAndText build_backtrace(const CoreDump::Reader& coredump, const ELF:
StringBuilder builder;
auto prepend_metadata = [&](auto& key, auto& fmt) {
auto prepend_metadata = [&](auto& key, StringView fmt) {
auto maybe_value = coredump.metadata().get(key);
if (!maybe_value.has_value() || maybe_value.value().is_empty())
return;