[Lldb-commits] [lldb] [lldb] Use AppendMessageWithFormatv instead of AppendMessageWithFormat (PR #185012)
via lldb-commits
lldb-commits at lists.llvm.org
Fri Mar 6 06:47:01 PST 2026
llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT-->
@llvm/pr-subscribers-lldb
Author: David Spickett (DavidSpickett)
<details>
<summary>Changes</summary>
When the message ends with a newline. ...WithFormatv adds a newline automatically.
Note that the ":x" style is lower case hex with 0x prefix. (see llvm/include/llvm/Support/FormatProviders.h)
This change does not change uses where multiple chunks are emitted to one line, or the message has embedded newlines. I want to deal with these more complex cases later.
This is round 3 of N doing this, converting a few files at a time.
---
Full diff: https://github.com/llvm/llvm-project/pull/185012.diff
4 Files Affected:
- (modified) lldb/source/Commands/CommandObjectBreakpoint.cpp (+15-17)
- (modified) lldb/source/Commands/CommandObjectMemory.cpp (+5-5)
- (modified) lldb/source/Commands/CommandObjectProcess.cpp (+16-16)
- (modified) lldb/source/Commands/CommandObjectTarget.cpp (+16-16)
``````````diff
diff --git a/lldb/source/Commands/CommandObjectBreakpoint.cpp b/lldb/source/Commands/CommandObjectBreakpoint.cpp
index 75dc890cc40ed..d78374ddd6edf 100644
--- a/lldb/source/Commands/CommandObjectBreakpoint.cpp
+++ b/lldb/source/Commands/CommandObjectBreakpoint.cpp
@@ -2146,9 +2146,8 @@ class CommandObjectBreakpointEnable : public CommandObjectParsed {
if (command.empty()) {
// No breakpoint selected; enable all currently set breakpoints.
target.EnableAllowedBreakpoints();
- result.AppendMessageWithFormat("All breakpoints enabled. (%" PRIu64
- " breakpoints)\n",
- (uint64_t)num_breakpoints);
+ result.AppendMessageWithFormatv(
+ "All breakpoints enabled. ({0} breakpoints)", num_breakpoints);
result.SetStatus(eReturnStatusSuccessFinishNoResult);
} else {
// Particular breakpoint selected; enable that breakpoint.
@@ -2183,8 +2182,8 @@ class CommandObjectBreakpointEnable : public CommandObjectParsed {
}
}
}
- result.AppendMessageWithFormat("%d breakpoints enabled.\n",
- enable_count + loc_count);
+ result.AppendMessageWithFormatv("{0} breakpoints enabled.",
+ enable_count + loc_count);
result.SetStatus(eReturnStatusSuccessFinishNoResult);
}
}
@@ -2254,9 +2253,8 @@ the second re-enables the first location.");
if (command.empty()) {
// No breakpoint selected; disable all currently set breakpoints.
target.DisableAllowedBreakpoints();
- result.AppendMessageWithFormat("All breakpoints disabled. (%" PRIu64
- " breakpoints)\n",
- (uint64_t)num_breakpoints);
+ result.AppendMessageWithFormatv(
+ "All breakpoints disabled. ({0} breakpoints)\n", num_breakpoints);
result.SetStatus(eReturnStatusSuccessFinishNoResult);
} else {
// Particular breakpoint selected; disable that breakpoint.
@@ -2292,8 +2290,8 @@ the second re-enables the first location.");
}
}
}
- result.AppendMessageWithFormat("%d breakpoints disabled.\n",
- disable_count + loc_count);
+ result.AppendMessageWithFormatv("{0} breakpoints disabled.",
+ disable_count + loc_count);
result.SetStatus(eReturnStatusSuccessFinishNoResult);
}
}
@@ -2669,9 +2667,9 @@ class CommandObjectBreakpointDelete : public CommandObjectParsed {
result.AppendMessage("Operation cancelled...");
} else {
target.RemoveAllowedBreakpoints();
- result.AppendMessageWithFormat(
- "All breakpoints removed. (%" PRIu64 " breakpoint%s)\n",
- (uint64_t)num_breakpoints, num_breakpoints > 1 ? "s" : "");
+ result.AppendMessageWithFormatv(
+ "All breakpoints removed. ({0} breakpoint{1})", num_breakpoints,
+ num_breakpoints > 1 ? "s" : "");
}
result.SetStatus(eReturnStatusSuccessFinishNoResult);
return;
@@ -2739,8 +2737,8 @@ class CommandObjectBreakpointDelete : public CommandObjectParsed {
}
}
}
- result.AppendMessageWithFormat(
- "%d breakpoints deleted; %d breakpoint locations disabled.\n",
+ result.AppendMessageWithFormatv(
+ "{0} breakpoints deleted; {1} breakpoint locations disabled.",
delete_count, disable_count);
result.SetStatus(eReturnStatusSuccessFinishNoResult);
}
@@ -3156,7 +3154,7 @@ class CommandObjectBreakpointNameList : public CommandObjectParsed {
target.FindBreakpointName(ConstString(name), false, error);
if (bp_name) {
StreamString s;
- result.AppendMessageWithFormat("Name: %s\n", name);
+ result.AppendMessageWithFormatv("Name: {0}", name);
if (bp_name->GetDescription(&s, eDescriptionLevelFull)) {
result.AppendMessage(s.GetString());
}
@@ -3178,7 +3176,7 @@ class CommandObjectBreakpointNameList : public CommandObjectParsed {
if (!any_set)
result.AppendMessage("No breakpoints using this name.");
} else {
- result.AppendMessageWithFormat("Name: %s not found.\n", name);
+ result.AppendMessageWithFormatv("Name: {0} not found.", name);
}
}
}
diff --git a/lldb/source/Commands/CommandObjectMemory.cpp b/lldb/source/Commands/CommandObjectMemory.cpp
index 93b6c1751b121..1ca98ac1a4bde 100644
--- a/lldb/source/Commands/CommandObjectMemory.cpp
+++ b/lldb/source/Commands/CommandObjectMemory.cpp
@@ -1110,8 +1110,8 @@ class CommandObjectMemoryFind : public CommandObjectParsed {
result.AppendMessage("no more matches within the range.\n");
break;
}
- result.AppendMessageWithFormat("data found at location: 0x%" PRIx64 "\n",
- found_location);
+ result.AppendMessageWithFormatv("data found at location: {0:x}",
+ found_location);
DataBufferHeap dumpbuffer(32, 0);
process->ReadMemory(
@@ -1699,8 +1699,8 @@ class CommandObjectMemoryRegion : public CommandObjectParsed {
range_info.GetDirtyPageList();
if (dirty_page_list) {
const size_t page_count = dirty_page_list->size();
- result.AppendMessageWithFormat(
- "Modified memory (dirty) page list provided, %zu entries.\n",
+ result.AppendMessageWithFormatv(
+ "Modified memory (dirty) page list provided, {0} entries.",
page_count);
if (page_count > 0) {
bool print_comma = false;
@@ -1712,7 +1712,7 @@ class CommandObjectMemoryRegion : public CommandObjectParsed {
print_comma = true;
result.AppendMessageWithFormat("0x%" PRIx64, (*dirty_page_list)[i]);
}
- result.AppendMessageWithFormat(".\n");
+ result.AppendMessage(".");
}
}
}
diff --git a/lldb/source/Commands/CommandObjectProcess.cpp b/lldb/source/Commands/CommandObjectProcess.cpp
index ca210e145d07e..b6963effbcf05 100644
--- a/lldb/source/Commands/CommandObjectProcess.cpp
+++ b/lldb/source/Commands/CommandObjectProcess.cpp
@@ -264,8 +264,8 @@ class CommandObjectProcessLaunch : public CommandObjectProcessLaunchOrAttach {
const char *archname =
exe_module_sp->GetArchitecture().GetArchitectureName();
- result.AppendMessageWithFormat(
- "Process %" PRIu64 " launched: '%s' (%s)\n", process_sp->GetID(),
+ result.AppendMessageWithFormatv(
+ "Process {0} launched: '{1}' ({2})", process_sp->GetID(),
exe_module_sp->GetFileSpec().GetPath().c_str(), archname);
}
result.SetStatus(eReturnStatusSuccessFinishResult);
@@ -383,8 +383,8 @@ class CommandObjectProcessAttach : public CommandObjectProcessLaunchOrAttach {
if (!old_exec_module_sp) {
// We might not have a module if we attached to a raw pid...
if (new_exec_module_sp) {
- result.AppendMessageWithFormat(
- "Executable binary set to \"%s\".\n",
+ result.AppendMessageWithFormatv(
+ "Executable binary set to \"{0}\".",
new_exec_module_sp->GetFileSpec().GetPath().c_str());
}
} else if (!new_exec_module_sp) {
@@ -399,8 +399,8 @@ class CommandObjectProcessAttach : public CommandObjectProcessLaunchOrAttach {
}
if (!old_arch_spec.IsValid()) {
- result.AppendMessageWithFormat(
- "Architecture set to: %s.\n",
+ result.AppendMessageWithFormatv(
+ "Architecture set to: {0}.",
target->GetArchitecture().GetTriple().getTriple().c_str());
} else if (!old_arch_spec.IsExactMatch(target->GetArchitecture())) {
result.AppendWarningWithFormat(
@@ -719,8 +719,8 @@ class CommandObjectProcessContinue : public CommandObjectParsed {
// PushProcessIOHandler().
process->SyncIOHandler(iohandler_id, std::chrono::seconds(2));
- result.AppendMessageWithFormat("Process %" PRIu64 " resuming\n",
- process->GetID());
+ result.AppendMessageWithFormatv("Process {0} resuming",
+ process->GetID());
if (synchronous_execution) {
// If any state changed events had anything to say, add that to the
// result
@@ -1122,8 +1122,8 @@ class CommandObjectProcessUnload : public CommandObjectParsed {
Status error(process->GetTarget().GetPlatform()->UnloadImage(
process, image_token));
if (error.Success()) {
- result.AppendMessageWithFormat(
- "Unloading shared library with index %u...ok\n", image_token);
+ result.AppendMessageWithFormatv(
+ "Unloading shared library with index {0}...ok", image_token);
result.SetStatus(eReturnStatusSuccessFinishResult);
} else {
result.AppendErrorWithFormat("failed to unload image: %s",
@@ -1468,12 +1468,12 @@ class CommandObjectProcessStatus : public CommandObjectParsed {
addr_t data_mask = process->GetDataAddressMask();
if (code_mask != LLDB_INVALID_ADDRESS_MASK) {
int bits = std::bitset<64>(~code_mask).count();
- result.AppendMessageWithFormat(
- "Addressable code address mask: 0x%" PRIx64 "\n", code_mask);
- result.AppendMessageWithFormat(
- "Addressable data address mask: 0x%" PRIx64 "\n", data_mask);
- result.AppendMessageWithFormat(
- "Number of bits used in addressing (code): %d\n", bits);
+ result.AppendMessageWithFormatv("Addressable code address mask: {0:x}",
+ code_mask);
+ result.AppendMessageWithFormatv("Addressable data address mask: {0:x}",
+ data_mask);
+ result.AppendMessageWithFormatv(
+ "Number of bits used in addressing (code): {0}", bits);
}
PlatformSP platform_sp = process->GetTarget().GetPlatform();
diff --git a/lldb/source/Commands/CommandObjectTarget.cpp b/lldb/source/Commands/CommandObjectTarget.cpp
index 59ccf390dea31..d4b0b29390f92 100644
--- a/lldb/source/Commands/CommandObjectTarget.cpp
+++ b/lldb/source/Commands/CommandObjectTarget.cpp
@@ -441,8 +441,8 @@ class CommandObjectTargetCreate : public CommandObjectParsed {
core_file.GetPath());
}
} else {
- result.AppendMessageWithFormat(
- "Current executable set to '%s' (%s).\n",
+ result.AppendMessageWithFormatv(
+ "Current executable set to '{0}' ({1}).",
file_spec.GetPath().c_str(),
target_sp->GetArchitecture().GetArchitectureName());
result.SetStatus(eReturnStatusSuccessFinishNoResult);
@@ -3016,9 +3016,9 @@ class CommandObjectTargetModulesLoad
if (target.SetSectionLoadAddress(section_sp,
load_addr))
changed = true;
- result.AppendMessageWithFormat(
- "section '%s' loaded at 0x%" PRIx64 "\n",
- sect_name, load_addr);
+ result.AppendMessageWithFormatv(
+ "section '{0}' loaded at {1:x}", sect_name,
+ load_addr);
}
} else {
result.AppendErrorWithFormat("no section found that "
@@ -3120,7 +3120,7 @@ class CommandObjectTargetModulesLoad
if (matching_modules.GetModulePointerAtIndex(i)
->GetFileSpec()
.GetPath(path, sizeof(path)))
- result.AppendMessageWithFormat("%s\n", path);
+ result.AppendMessageWithFormatv("{0}", path);
}
} else {
result.AppendErrorWithFormat(
@@ -4389,8 +4389,8 @@ class CommandObjectTargetSymbolsAdd : public CommandObjectParsed {
if (object_file && object_file->GetFileSpec() == symbol_fspec) {
// Provide feedback that the symfile has been successfully added.
const FileSpec &module_fs = module_sp->GetFileSpec();
- result.AppendMessageWithFormat(
- "symbol file '%s' has been added to '%s'\n", symfile_path,
+ result.AppendMessageWithFormatv(
+ "symbol file '{0}' has been added to '{1}'", symfile_path,
module_fs.GetPath().c_str());
// Let clients know something changed in the module if it is
@@ -5078,8 +5078,8 @@ Filter Options:
Target::StopHookCommandLine *hook_ptr =
static_cast<Target::StopHookCommandLine *>(new_hook_sp.get());
hook_ptr->SetActionFromStrings(m_options.m_one_liner);
- result.AppendMessageWithFormat("Stop hook #%" PRIu64 " added.\n",
- new_hook_sp->GetID());
+ result.AppendMessageWithFormatv("Stop hook #{0} added.",
+ new_hook_sp->GetID());
} else if (!m_python_class_options.GetName().empty()) {
// This is a scripted stop hook:
Target::StopHookScripted *hook_ptr =
@@ -5088,8 +5088,8 @@ Filter Options:
m_python_class_options.GetName(),
m_python_class_options.GetStructuredData());
if (error.Success())
- result.AppendMessageWithFormat("Stop hook #%" PRIu64 " added.\n",
- new_hook_sp->GetID());
+ result.AppendMessageWithFormatv("Stop hook #{0} added.",
+ new_hook_sp->GetID());
else {
// FIXME: Set the stop hook ID counter back.
result.AppendErrorWithFormat("Couldn't add stop hook: %s",
@@ -5457,8 +5457,8 @@ class CommandObjectTargetFrameProviderRegister : public CommandObjectParsed {
return;
}
- result.AppendMessageWithFormat(
- "successfully registered scripted frame provider '%s' for target\n",
+ result.AppendMessageWithFormatv(
+ "successfully registered scripted frame provider '{0}' for target",
m_class_options.GetName().c_str());
}
@@ -5563,8 +5563,8 @@ class CommandObjectTargetFrameProviderRemove : public CommandObjectParsed {
}
if (size_t num_removed_providers = removed_provider_ids.size()) {
- result.AppendMessageWithFormat(
- "Successfully removed %zu frame-providers.\n", num_removed_providers);
+ result.AppendMessageWithFormatv(
+ "Successfully removed {0} frame-providers.", num_removed_providers);
result.SetStatus(eReturnStatusSuccessFinishNoResult);
} else {
result.AppendError("0 frame providers removed.\n");
``````````
</details>
https://github.com/llvm/llvm-project/pull/185012
More information about the lldb-commits
mailing list