[APInt] Deprecate truncOrSelf, zextOrSelf and sextOrSelf

[lattner]

This is great in concept but I think we have macros to deprecate things in compiler.h, please also make sure all in tree uses are removed before landing this. Are there any APInt docs or comments that need to be updated? Are you keeping APSInt in sync as well?

[foad]

In D125558#3512236, @lattner wrote:

This is great in concept but I think we have macros to deprecate things in compiler.h,

The first version of this patch used LLVM_ATTRIBUTE_DEPRECATED but that was removed recently in favour of the standard [[deprecated]]: D94219, 903c30f4d1f3bc0d1aae9ca83af17c0062d02b40

please also make sure all in tree uses are removed before landing this.

Should be done in D125557.

Are there any APInt docs or comments that need to be updated?

I don't think so, at least I couldn't find any other mentions of the truncOrSelf etc names in the whole monorepo.

Are you keeping APSInt in sync as well?

APSInt never had these methods, so I don't think there's anything to do there.

[lattner]

Ok, awesome!

llvm/include/llvm/ADT/APInt.h

#endif
   /// Zero extend or truncate to width
   ///
   /// Make this APInt have the bit width given by \p width. The value is zero
   /// extended, truncated, or left alone to make it that width.
   APInt zextOrTrunc(unsigned width) const;
 
   /// Truncate this APInt if necessary to ensure that its bit width is <= \p
   /// width.
-  APInt truncOrSelf(unsigned width) const;
+  [[deprecated("Use trunc instead")]] APInt truncOrSelf(unsigned width) const;
 
   /// Sign-extend this APInt if necessary to ensure that its bit width is >= \p
   /// width.
-  APInt sextOrSelf(unsigned width) const;
+  [[deprecated("Use sext instead")]] APInt sextOrSelf(unsigned width) const;
 
   /// Zero-extend this APInt if necessary to ensure that its bit width is >= \p
   /// width.
-  APInt zextOrSelf(unsigned width) const;
+  [[deprecated("Use zext instead")]] APInt zextOrSelf(unsigned width) const;
 
   /// @}
   /// \name Bit Manipulation Operators
   /// @{
 
   /// Set every bit to 1.
   void setAllBits() {
     if (isSingleWord())

llvm/unittests/ADT/APIntTest.cpp

TEST(APIntTest, sext) {
   EXPECT_EQ(0U, i32_neg1.countTrailingZeros());
   EXPECT_EQ(63U, i32_neg1.countPopulation());
 }
 
 TEST(APIntTest, trunc) {
   APInt val(32, 0xFFFFFFFF);
   EXPECT_EQ(0xFFFF, val.trunc(16));
   EXPECT_EQ(0xFFFFFFFF, val.trunc(32));
-  EXPECT_EQ(0xFFFF, val.truncOrSelf(16));
-  EXPECT_EQ(0xFFFFFFFF, val.truncOrSelf(32));
-  EXPECT_EQ(0xFFFFFFFF, val.truncOrSelf(64));
 }
 
 TEST(APIntTest, concat) {
   APInt Int1(4, 0x1ULL);
   APInt Int3(4, 0x3ULL);
 
   EXPECT_EQ(0x31, Int3.concat(Int1));
   EXPECT_EQ(APInt(12, 0x313), Int3.concat(Int1).concat(Int3));