Introduce assorted unsigned int/long Refaster rules (#1291)

error-prone-contrib/src/main/java/tech/picnic/errorprone/refasterrules/PrimitiveRules.java

@@ -8,6 +8,8 @@ import com.google.common.primitives.Floats;
 import com.google.common.primitives.Ints;
 import com.google.common.primitives.Longs;
 import com.google.common.primitives.Shorts;
+import com.google.common.primitives.UnsignedInts;
+import com.google.common.primitives.UnsignedLongs;
 import com.google.errorprone.refaster.Refaster;
 import com.google.errorprone.refaster.annotation.AfterTemplate;
 import com.google.errorprone.refaster.annotation.AlsoNegation;
@@ -76,6 +78,8 @@ final class PrimitiveRules {
   }
 
   /** Prefer {@link Math#toIntExact(long)} over the Guava alternative. */
+  // XXX: This rule changes the exception possibly thrown from `IllegalArgumentException` to
+  // `ArithmeticException`.
   static final class LongToIntExact {
     @BeforeTemplate
     int before(long l) {
@@ -379,4 +383,205 @@ final class PrimitiveRules {
       return Long.signum(l) == -1;
     }
   }
+
+  /** Prefer JDK's {@link Integer#compareUnsigned(int, int)} over third-party alternatives. */
+  static final class IntegerCompareUnsigned {
+    @BeforeTemplate
+    int before(int x, int y) {
+      return UnsignedInts.compare(x, y);
+    }
+
+    @AfterTemplate
+    int after(int x, int y) {
+      return Integer.compareUnsigned(x, y);
+    }
+  }
+
+  /** Prefer JDK's {@link Long#compareUnsigned(long, long)} over third-party alternatives. */
+  static final class LongCompareUnsigned {
+    @BeforeTemplate
+    long before(long x, long y) {
+      return UnsignedLongs.compare(x, y);
+    }
+
+    @AfterTemplate
+    long after(long x, long y) {
+      return Long.compareUnsigned(x, y);
+    }
+  }
+
+  /** Prefer JDK's {@link Integer#divideUnsigned(int, int)} over third-party alternatives. */
+  static final class IntegerDivideUnsigned {
+    @BeforeTemplate
+    int before(int x, int y) {
+      return UnsignedInts.divide(x, y);
+    }
+
+    @AfterTemplate
+    int after(int x, int y) {
+      return Integer.divideUnsigned(x, y);
+    }
+  }
+
+  /** Prefer JDK's {@link Long#divideUnsigned(long, long)} over third-party alternatives. */
+  static final class LongDivideUnsigned {
+    @BeforeTemplate
+    long before(long x, long y) {
+      return UnsignedLongs.divide(x, y);
+    }
+
+    @AfterTemplate
+    long after(long x, long y) {
+      return Long.divideUnsigned(x, y);
+    }
+  }
+
+  /** Prefer JDK's {@link Integer#remainderUnsigned(int, int)} over third-party alternatives. */
+  static final class IntegerRemainderUnsigned {
+    @BeforeTemplate
+    int before(int x, int y) {
+      return UnsignedInts.remainder(x, y);
+    }
+
+    @AfterTemplate
+    int after(int x, int y) {
+      return Integer.remainderUnsigned(x, y);
+    }
+  }
+
+  /** Prefer JDK's {@link Long#remainderUnsigned(long, long)} over third-party alternatives. */
+  static final class LongRemainderUnsigned {
+    @BeforeTemplate
+    long before(long x, long y) {
+      return UnsignedLongs.remainder(x, y);
+    }
+
+    @AfterTemplate
+    long after(long x, long y) {
+      return Long.remainderUnsigned(x, y);
+    }
+  }
+
+  /**
+   * Prefer JDK's {@link Integer#parseUnsignedInt(String)} over third-party or more verbose
+   * alternatives.
+   */
+  static final class IntegerParseUnsignedInt {
+    @BeforeTemplate
+    int before(String string) {
+      return Refaster.anyOf(
+          UnsignedInts.parseUnsignedInt(string), Integer.parseUnsignedInt(string, 10));
+    }
+
+    @AfterTemplate
+    int after(String string) {
+      return Integer.parseUnsignedInt(string);
+    }
+  }
+
+  /**
+   * Prefer JDK's {@link Long#parseUnsignedLong(String)} over third-party or more verbose
+   * alternatives.
+   */
+  static final class LongParseUnsignedLong {
+    @BeforeTemplate
+    long before(String string) {
+      return Refaster.anyOf(
+          UnsignedLongs.parseUnsignedLong(string), Long.parseUnsignedLong(string, 10));
+    }
+
+    @AfterTemplate
+    long after(String string) {
+      return Long.parseUnsignedLong(string);
+    }
+  }
+
+  /** Prefer JDK's {@link Integer#parseUnsignedInt(String, int)} over third-party alternatives. */
+  static final class IntegerParseUnsignedIntWithRadix {
+    @BeforeTemplate
+    int before(String string, int radix) {
+      return UnsignedInts.parseUnsignedInt(string, radix);
+    }
+
+    @AfterTemplate
+    int after(String string, int radix) {
+      return Integer.parseUnsignedInt(string, radix);
+    }
+  }
+
+  /** Prefer JDK's {@link Long#parseUnsignedLong(String, int)} over third-party alternatives. */
+  static final class LongParseUnsignedLongWithRadix {
+    @BeforeTemplate
+    long before(String string, int radix) {
+      return UnsignedLongs.parseUnsignedLong(string, radix);
+    }
+
+    @AfterTemplate
+    long after(String string, int radix) {
+      return Long.parseUnsignedLong(string, radix);
+    }
+  }
+
+  /**
+   * Prefer JDK's {@link Integer#toUnsignedString(int)} over third-party or more verbose
+   * alternatives.
+   */
+  static final class IntegerToUnsignedString {
+    @BeforeTemplate
+    String before(int i) {
+      return Refaster.anyOf(UnsignedInts.toString(i), Integer.toUnsignedString(i, 10));
+    }
+
+    @AfterTemplate
+    String after(int i) {
+      return Integer.toUnsignedString(i);
+    }
+  }
+
+  /**
+   * Prefer JDK's {@link Long#toUnsignedString(long)} over third-party or more verbose alternatives.
+   */
+  static final class LongToUnsignedString {
+    @BeforeTemplate
+    String before(long i) {
+      return Refaster.anyOf(UnsignedLongs.toString(i), Long.toUnsignedString(i, 10));
+    }
+
+    @AfterTemplate
+    String after(long i) {
+      return Long.toUnsignedString(i);
+    }
+  }
+
+  /**
+   * Prefer JDK's {@link Integer#toUnsignedString(int,int)} over third-party or more verbose
+   * alternatives.
+   */
+  static final class IntegerToUnsignedStringWithRadix {
+    @BeforeTemplate
+    String before(int i, int radix) {
+      return UnsignedInts.toString(i, radix);
+    }
+
+    @AfterTemplate
+    String after(int i, int radix) {
+      return Integer.toUnsignedString(i, radix);
+    }
+  }
+
+  /**
+   * Prefer JDK's {@link Long#toUnsignedString(long,int)} over third-party or more verbose
+   * alternatives.
+   */
+  static final class LongToUnsignedStringWithRadix {
+    @BeforeTemplate
+    String before(long i, int radix) {
+      return UnsignedLongs.toString(i, radix);
+    }
+
+    @AfterTemplate
+    String after(long i, int radix) {
+      return Long.toUnsignedString(i, radix);
+    }
+  }
 }

error-prone-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/PrimitiveRulesTestInput.java

@@ -9,6 +9,8 @@ import com.google.common.primitives.Floats;
 import com.google.common.primitives.Ints;
 import com.google.common.primitives.Longs;
 import com.google.common.primitives.Shorts;
+import com.google.common.primitives.UnsignedInts;
+import com.google.common.primitives.UnsignedLongs;
 import tech.picnic.errorprone.refaster.test.RefasterRuleCollectionTestCase;
 
 final class PrimitiveRulesTest implements RefasterRuleCollectionTestCase {
@@ -22,7 +24,9 @@ final class PrimitiveRulesTest implements RefasterRuleCollectionTestCase {
         Floats.class,
         Ints.class,
         Longs.class,
-        Shorts.class);
+        Shorts.class,
+        UnsignedInts.class,
+        UnsignedLongs.class);
   }
 
   ImmutableSet<Boolean> testLessThan() {
@@ -170,4 +174,60 @@ final class PrimitiveRulesTest implements RefasterRuleCollectionTestCase {
     return ImmutableSet.of(
         Long.signum(1L) < 0, Long.signum(2L) <= -1, Long.signum(3L) >= 0, Long.signum(4L) > -1);
   }
+
+  int testIntegerCompareUnsigned() {
+    return UnsignedInts.compare(1, 2);
+  }
+
+  long testLongCompareUnsigned() {
+    return UnsignedLongs.compare(1, 2);
+  }
+
+  int testIntegerDivideUnsigned() {
+    return UnsignedInts.divide(1, 2);
+  }
+
+  long testLongDivideUnsigned() {
+    return UnsignedLongs.divide(1, 2);
+  }
+
+  int testIntegerRemainderUnsigned() {
+    return UnsignedInts.remainder(1, 2);
+  }
+
+  long testLongRemainderUnsigned() {
+    return UnsignedLongs.remainder(1, 2);
+  }
+
+  ImmutableSet<Integer> testIntegerParseUnsignedInt() {
+    return ImmutableSet.of(UnsignedInts.parseUnsignedInt("1"), Integer.parseUnsignedInt("2", 10));
+  }
+
+  ImmutableSet<Long> testLongParseUnsignedLong() {
+    return ImmutableSet.of(UnsignedLongs.parseUnsignedLong("1"), Long.parseUnsignedLong("2", 10));
+  }
+
+  int testIntegerParseUnsignedIntWithRadix() {
+    return UnsignedInts.parseUnsignedInt("1", 2);
+  }
+
+  long testLongParseUnsignedLongWithRadix() {
+    return UnsignedLongs.parseUnsignedLong("1", 2);
+  }
+
+  ImmutableSet<String> testIntegerToUnsignedString() {
+    return ImmutableSet.of(UnsignedInts.toString(1), Integer.toUnsignedString(2, 10));
+  }
+
+  ImmutableSet<String> testLongToUnsignedString() {
+    return ImmutableSet.of(UnsignedLongs.toString(1), Long.toUnsignedString(2, 10));
+  }
+
+  String testIntegerToUnsignedStringWithRadix() {
+    return UnsignedInts.toString(1, 2);
+  }
+
+  String testLongToUnsignedStringWithRadix() {
+    return UnsignedLongs.toString(1, 2);
+  }
 }

error-prone-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/PrimitiveRulesTestOutput.java

@@ -9,6 +9,8 @@ import com.google.common.primitives.Floats;
 import com.google.common.primitives.Ints;
 import com.google.common.primitives.Longs;
 import com.google.common.primitives.Shorts;
+import com.google.common.primitives.UnsignedInts;
+import com.google.common.primitives.UnsignedLongs;
 import tech.picnic.errorprone.refaster.test.RefasterRuleCollectionTestCase;
 
 final class PrimitiveRulesTest implements RefasterRuleCollectionTestCase {
@@ -22,7 +24,9 @@ final class PrimitiveRulesTest implements RefasterRuleCollectionTestCase {
         Floats.class,
         Ints.class,
         Longs.class,
-        Shorts.class);
+        Shorts.class,
+        UnsignedInts.class,
+        UnsignedLongs.class);
   }
 
   ImmutableSet<Boolean> testLessThan() {
@@ -170,4 +174,60 @@ final class PrimitiveRulesTest implements RefasterRuleCollectionTestCase {
     return ImmutableSet.of(
         Long.signum(1L) == -1, Long.signum(2L) == -1, Long.signum(3L) != -1, Long.signum(4L) != -1);
   }
+
+  int testIntegerCompareUnsigned() {
+    return Integer.compareUnsigned(1, 2);
+  }
+
+  long testLongCompareUnsigned() {
+    return Long.compareUnsigned(1, 2);
+  }
+
+  int testIntegerDivideUnsigned() {
+    return Integer.divideUnsigned(1, 2);
+  }
+
+  long testLongDivideUnsigned() {
+    return Long.divideUnsigned(1, 2);
+  }
+
+  int testIntegerRemainderUnsigned() {
+    return Integer.remainderUnsigned(1, 2);
+  }
+
+  long testLongRemainderUnsigned() {
+    return Long.remainderUnsigned(1, 2);
+  }
+
+  ImmutableSet<Integer> testIntegerParseUnsignedInt() {
+    return ImmutableSet.of(Integer.parseUnsignedInt("1"), Integer.parseUnsignedInt("2"));
+  }
+
+  ImmutableSet<Long> testLongParseUnsignedLong() {
+    return ImmutableSet.of(Long.parseUnsignedLong("1"), Long.parseUnsignedLong("2"));
+  }
+
+  int testIntegerParseUnsignedIntWithRadix() {
+    return Integer.parseUnsignedInt("1", 2);
+  }
+
+  long testLongParseUnsignedLongWithRadix() {
+    return Long.parseUnsignedLong("1", 2);
+  }
+
+  ImmutableSet<String> testIntegerToUnsignedString() {
+    return ImmutableSet.of(Integer.toUnsignedString(1), Integer.toUnsignedString(2));
+  }
+
+  ImmutableSet<String> testLongToUnsignedString() {
+    return ImmutableSet.of(Long.toUnsignedString(1), Long.toUnsignedString(2));
+  }
+
+  String testIntegerToUnsignedStringWithRadix() {
+    return Integer.toUnsignedString(1, 2);
+  }
+
+  String testLongToUnsignedStringWithRadix() {
+    return Long.toUnsignedString(1, 2);
+  }
 }