[Lldb-commits] [PATCH] D49307: Fix some crashes and deadlocks in FormatAnsiTerminalCodes

[Raphael Isemann via Phabricator via lldb-commits]

teemperor created this revision.
teemperor added a reviewer: davide.
Herald added a subscriber: mgorny.

This patch fixes a few problems with the FormatAnsiTerminalCodes function:

- It does an infinite loop on an unknown color value.
- It crashes when the color value is at the end of the string.
- It deletes the first character behind the color token.

Also added a few tests that reproduce those problems (and test some other 
corner cases).


https://reviews.llvm.org/D49307

Files:
  include/lldb/Utility/AnsiTerminal.h
  unittests/Utility/AnsiTerminalTest.cpp
  unittests/Utility/CMakeLists.txt


Index: unittests/Utility/CMakeLists.txt
===================================================================
--- unittests/Utility/CMakeLists.txt
+++ unittests/Utility/CMakeLists.txt
@@ -1,4 +1,5 @@
 add_lldb_unittest(UtilityTests
+  AnsiTerminalTest.cpp
   ArgsTest.cpp
   OptionsWithRawTest.cpp
   ArchSpecTest.cpp
Index: unittests/Utility/AnsiTerminalTest.cpp
===================================================================
--- /dev/null
+++ unittests/Utility/AnsiTerminalTest.cpp
@@ -0,0 +1,61 @@
+//===-- AnsiTerminalTest.cpp ------------------------------------*- C++ -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "gtest/gtest.h"
+
+#include "lldb/Utility/AnsiTerminal.h"
+
+using namespace lldb_utility;
+
+TEST(AnsiTerminal, Empty) {
+  std::string format = ansi::FormatAnsiTerminalCodes("");
+  EXPECT_STREQ("", format.c_str());
+}
+
+TEST(AnsiTerminal, WhiteSpace) {
+  std::string format = ansi::FormatAnsiTerminalCodes(" ");
+  EXPECT_STREQ(" ", format.c_str());
+}
+
+TEST(AnsiTerminal, AtEnd) {
+  std::string format = ansi::FormatAnsiTerminalCodes("abc${ansi.fg.black}");
+  EXPECT_STREQ("abc\x1B[30m", format.c_str());
+}
+
+TEST(AnsiTerminal, AtStart) {
+  std::string format = ansi::FormatAnsiTerminalCodes("${ansi.fg.black}abc");
+  EXPECT_STREQ("\x1B[30mabc", format.c_str());
+}
+
+TEST(AnsiTerminal, KnownPrefix) {
+  std::string format = ansi::FormatAnsiTerminalCodes("${ansi.fg.redish}abc");
+  EXPECT_STREQ("${ansi.fg.redish}abc", format.c_str());
+}
+
+TEST(AnsiTerminal, Unknown) {
+  std::string format = ansi::FormatAnsiTerminalCodes("${ansi.fg.foo}abc");
+  EXPECT_STREQ("${ansi.fg.foo}abc", format.c_str());
+}
+
+TEST(AnsiTerminal, Incomplete) {
+  std::string format = ansi::FormatAnsiTerminalCodes("abc${ansi.");
+  EXPECT_STREQ("abc${ansi.", format.c_str());
+}
+
+TEST(AnsiTerminal, Twice) {
+  std::string format =
+      ansi::FormatAnsiTerminalCodes("${ansi.fg.black}${ansi.fg.red}abc");
+  EXPECT_STREQ("\x1B[30m\x1B[31mabc", format.c_str());
+}
+
+TEST(AnsiTerminal, Basic) {
+  std::string format =
+      ansi::FormatAnsiTerminalCodes("abc${ansi.fg.red}abc${ansi.normal}abc");
+  EXPECT_STREQ("abc\x1B[31mabc\x1B[0mabc", format.c_str());
+}
Index: include/lldb/Utility/AnsiTerminal.h
===================================================================
--- include/lldb/Utility/AnsiTerminal.h
+++ include/lldb/Utility/AnsiTerminal.h
@@ -119,17 +119,21 @@
       break;
     }
 
+    bool found_code = false;
     for (const auto &code : codes) {
       if (!right.consume_front(code.name))
         continue;
 
       if (do_color)
         fmt.append(code.value);
-      format = right;
+      found_code = true;
       break;
     }
-
-    format = format.drop_front();
+    format = right;
+    // If we haven't found a valid replacement value, we just copy the string
+    // to the result without any modifications.
+    if (!found_code)
+      fmt.append(tok_hdr);
   }
   return fmt;
 }

_______________________________________________
lldb-commits mailing list
lldb-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits