[Demangle] Add prepend functionality to OutputString

[ljmf00]

Summary

Implement the functionallity of prepend, required by D demangler.
Please read discussion https://reviews.llvm.org/D111414 for context.
See also https://reviews.llvm.org/D111947 .

[dblaikie]

Looks alright - guess some other boundary testing could be done (testing without anything in the buffer, testing when prepend causes the buffer to grow V when it's already big enough) but it's probably fine as-is.

libcxxabi/src/demangle/Utility.h

102

Could probably skip this. Falls out naturally from the implementation.

104–106

Could use memmove for this?

[ljmf00]

I added more tests to cover the requested situations. I also forgot to add a free after a malloc on the testsuite. I also changed the manual for loop to memmove to benefit from optimized implementations.

[ljmf00]

Just ran clang-format

[ljmf00]

Renamed OutputString test to OutputBuffer test

[Geod24]

LGTM

[ljmf00]

@dblaikie I changed what you requested, which includes the use of memmove and adding some tests to cover empty buffers and reinsertion after resetting the position. Can you re-review please?

[dblaikie]

Looks good, thanks!

[ljmf00]

In D111948#3085316, @dblaikie wrote:

Looks good, thanks!

Can you or someone with permission, land it? Thanks :)

[dblaikie]

I'm having trouble applying this patch locally - I get:

$ arc patch D111948
Created and checked out branch arcpatch-D111948.
Created and checked out branch arcpatch-D111947.
Checking patch llvm/unittests/Demangle/OutputStreamTest.cpp => llvm/unittests/Demangle/OutputBufferTest.cpp...
Checking patch llvm/unittests/Demangle/ItaniumDemangleTest.cpp...
Checking patch llvm/unittests/Demangle/CMakeLists.txt...
Checking patch llvm/lib/Demangle/RustDemangle.cpp...
Checking patch llvm/lib/Demangle/MicrosoftDemangleNodes.cpp...
Checking patch llvm/lib/Demangle/MicrosoftDemangle.cpp...
Checking patch llvm/lib/Demangle/ItaniumDemangle.cpp...
Checking patch llvm/include/llvm/Demangle/Utility.h...
Checking patch llvm/include/llvm/Demangle/MicrosoftDemangleNodes.h...
Checking patch llvm/include/llvm/Demangle/ItaniumDemangle.h...
Checking patch libcxxabi/src/demangle/Utility.h...
Checking patch libcxxabi/src/demangle/ItaniumDemangle.h...
Applied patch llvm/unittests/Demangle/OutputStreamTest.cpp => llvm/unittests/Demangle/OutputBufferTest.cpp cleanly.
Applied patch llvm/unittests/Demangle/ItaniumDemangleTest.cpp cleanly.
Applied patch llvm/unittests/Demangle/CMakeLists.txt cleanly.
Applied patch llvm/lib/Demangle/RustDemangle.cpp cleanly.
Applied patch llvm/lib/Demangle/MicrosoftDemangleNodes.cpp cleanly.
Applied patch llvm/lib/Demangle/MicrosoftDemangle.cpp cleanly.
Applied patch llvm/lib/Demangle/ItaniumDemangle.cpp cleanly.
Applied patch llvm/include/llvm/Demangle/Utility.h cleanly.
Applied patch llvm/include/llvm/Demangle/MicrosoftDemangleNodes.h cleanly.
Applied patch llvm/include/llvm/Demangle/ItaniumDemangle.h cleanly.
Applied patch libcxxabi/src/demangle/Utility.h cleanly.
Applied patch libcxxabi/src/demangle/ItaniumDemangle.h cleanly.

 Cherry Pick Failed!
Exception
Command failed with error #1!
COMMAND
git cherry-pick 'arcpatch-D111947'

STDOUT
On branch arcpatch-D111948
You are currently cherry-picking commit f03e9f1cbed8.
  (all conflicts fixed: run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

nothing to commit, working tree clean


STDERR
The previous cherry-pick is now empty, possibly due to conflict resolution.
If you wish to commit it anyway, use:

    git commit --allow-empty

Otherwise, please use 'git cherry-pick --skip'

(Run with `--trace` for a full exception trace.)

Perhaps it needs to be rebased or something?

[ljmf00]

In D111948#3088563, @dblaikie wrote:

Perhaps it needs to be rebased or something?

Should be good now. For some reason, adding the rename patch to the parent patch stack did that. I reproduced the arc patch D111948 and it works now. I rebased anyway.

libcxxabi/src/demangle/Utility.h

 //===--- Utility.h ----------------------------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 //
 // Provide some utility classes for use in the demangler(s).
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef DEMANGLE_UTILITY_H
 #define DEMANGLE_UTILITY_H
 
 #include "StringView.h"
+#include "llvm/Demangle/MicrosoftDemangleNodes.h"
 #include <cstdint>
 #include <cstdlib>
 #include <cstring>
 #include <iterator>
 #include <limits>
 
 DEMANGLE_NAMESPACE_BEGIN
 
public:
   }
 
   OutputString &operator+=(char C) {
     grow(1);
     Buffer[CurrentPosition++] = C;
     return *this;
   }
 
+  OutputString prepend(StringView R)
+  {
+      char *TempBuffer;
+      size_t Size = R.size();
+
+    if (Size != 0) {
+      grow(Size);
+      for (TempBuffer = (Buffer + CurrentPosition) - 1; TempBuffer >= Buffer; --TempBuffer) {
+        TempBuffer[Size] = TempBuffer[0];
+      }
+      std::memcpy(Buffer, R.begin(), Size);
+      CurrentPosition += Size;
+    }
+
+    return *this;
+  }
+
   OutputString &operator<<(StringView R) { return (*this += R); }
 
   OutputString &operator<<(char C) { return (*this += C); }
 
   OutputString &operator<<(long long N) {
     if (N < 0)
       writeUnsigned(static_cast<unsigned long long>(-N), true);
     else

llvm/include/llvm/Demangle/Utility.h

 //===--- Utility.h ----------------------------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 //
 // Provide some utility classes for use in the demangler(s).
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef DEMANGLE_UTILITY_H
 #define DEMANGLE_UTILITY_H
 
 #include "StringView.h"
+#include "llvm/Demangle/MicrosoftDemangleNodes.h"
 #include <cstdint>
 #include <cstdlib>
 #include <cstring>
 #include <iterator>
 #include <limits>
 
 DEMANGLE_NAMESPACE_BEGIN
 
public:
   }
 
   OutputString &operator+=(char C) {
     grow(1);
     Buffer[CurrentPosition++] = C;
     return *this;
   }
 
+  OutputString prepend(StringView R)
+  {
+      char *TempBuffer;
+      size_t Size = R.size();
+
+    if (Size != 0) {
+      grow(Size);
+      for (TempBuffer = (Buffer + CurrentPosition) - 1; TempBuffer >= Buffer; --TempBuffer) {
+        TempBuffer[Size] = TempBuffer[0];
+      }
+      std::memcpy(Buffer, R.begin(), Size);
+      CurrentPosition += Size;
+    }
+
+    return *this;
+  }
+
   OutputString &operator<<(StringView R) { return (*this += R); }
 
   OutputString &operator<<(char C) { return (*this += C); }
 
   OutputString &operator<<(long long N) {
     if (N < 0)
       writeUnsigned(static_cast<unsigned long long>(-N), true);
     else

llvm/unittests/Demangle/OutputStringTest.cpp

 //===- llvm/unittest/OutputStreamTest.cpp - OutputStream unit tests -------===//
 //
 // 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/Demangle/MicrosoftDemangleNodes.h"
 #include "llvm/Demangle/Utility.h"
 #include "gtest/gtest.h"
 #include <string>
 
 using namespace llvm;
 using llvm::itanium_demangle::OutputString;
 
 static std::string toString(OutputString &OS) {
TEST(OutputStringTest, Insert) {
   OS.insert(5, "y", 1);
   EXPECT_EQ("xabcdy", toString(OS));
 
   OS.insert(3, "defghi", 6);
   EXPECT_EQ("xabdefghicdy", toString(OS));
 
   std::free(OS.getBuffer());
 }
+
+TEST(OutputStringTest, Prepend)
+{
+  OutputString OS;
+
+  OS << "abc";
+  OS.prepend("def");
+  EXPECT_EQ("defabc", toString(OS));
+}