package daikon;

import java.io.LineNumberReader;
import java.io.ObjectStreamException;
import java.io.Serializable;
import java.io.StreamTokenizer;
import java.io.StringReader;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import org.checkerframework.checker.interning.qual.Interned;
import org.checkerframework.checker.lock.qual.GuardSatisfied;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.dataflow.qual.Pure;
import org.checkerframework.dataflow.qual.SideEffectFree;
import org.plumelib.util.Intern;
import org.plumelib.util.StringsPlume;

/**
 * Represents the type of a variable, for its declared type, dtrace file representation, and
 * internal representations. ProgLangTypes are interned, so they can be == compared.
 */

// I could also consider using Class; however:
//  * that ties this to a Java front end, as Class can't represent types of
//    (say) C variables.  (not a compelling problem)
//  * that loads the class, which requies that all classes available at
//    run time be available at inference time.  (not a compelling problem)
//  * Class does not represent inheritance (but I can do that myself);
//    and see isAssignableFrom, which might do all I need.
//  * Class has no "dimensions" field.  isArray() exists, however, as does
//    getComponentType().  I can always determine the number of dimensions
//    from the number of leading "[" in the name, and dimensions is only
//    really needed for parse_value.  parse_value can do literal checks and
//    elementType() can use the name, I suppose.  Or maybe try to
//    instantiate something, though that seems dicier.

// Problem:  this doesn't currently represent inheritance, coercability, or
// other relationships over the base types.

// integral_types = ("int", "char", "float", "double", "integral", "boolean")
// known_types = integral_types + ("pointer", "address")

public final @Interned class ProglangType implements Serializable {
  static final long serialVersionUID = 20020122L;

  /** Maps from a base type name to its ProglangTypes and arrays with that base. */
  private static HashMap<@Interned String, List<ProglangType>> all_known_types = new HashMap<>();

  /**
   * The set of (interned) names of classes that implement java.util.List. For a Java class, this is
   * a {@code @BinaryName}, but when Daikon is processing programs written in other languages, it
   * can be arbitrary.
   */
  public static HashSet<String> list_implementors = new LinkedHashSet<>();

  /**
   * If true, treat 32 bit values whose high bit is on, as a negative number (rather than as a 32
   * bit unsigned).
   */
  public static boolean dkconfig_convert_to_signed = false;

  static {
    // XXX for now, hard-code these list-implementing types. We should
    // make the front-end dump the language-specific ones into .decls.
    list_implementors.add("java.util.List");
    list_implementors.add("java.util.AbstractList");
    list_implementors.add("java.util.Vector");
    list_implementors.add("java.util.ArrayList");
    list_implementors.add("java.util.AbstractSequentialList");
    list_implementors.add("java.util.LinkedList");
    list_implementors.add("java.util.Stack");
  }

  // For a Java class, this is a binary name.  When Daikon is processing
  // other languages, the format is arbitrary.
  private @Interned String base; // interned name of base type

  public @Interned String base() {
    return base;
  }

  /** Number of dimensions. Zero for a non-array. */
  private int dimensions;

  /**
   * Return the number of dimensions (zero for a non-array).
   *
   * @return the number of dimensions
   */
  public int dimensions() {
    return dimensions;
  }

  @Pure
  public boolean isArray() {
    return dimensions > 0;
  }

  /**
   * No public constructor: use parse() instead to get a canonical representation. basetype should
   * be interned.
   *
   * @param basetype the base type
   * @param dimensions the number of dimensions
   */
  @SuppressWarnings("super.invocation") // never called twice with the same arguments
  private ProglangType(@Interned String basetype, int dimensions) {
    assert basetype == basetype.intern();
    this.base = basetype;
    this.dimensions = dimensions;
  }

  /**
   * This can't be a constructor because it returns a canonical representation (that can be compared
   * with ==), not necessarily a new object.
   *
   * @param rep the name of the type, optionally suffixed by (possibly multiple) "[]"
   */
  public static ProglangType parse(String rep) {
    String new_base = rep;
    int dims = 0;
    while (new_base.endsWith("[]")) {
      dims++;
      new_base = new_base.substring(0, new_base.length() - 2);
    }
    return intern(new_base.intern(), dims);
  }

  /**
   * Like parse, but normalizes representation types (such as converting "float" to "double"), in
   * order to return real file representation types even if the file contains something slightly
   * different than the prescribed format.
   */
  public static ProglangType rep_parse(String rep) {
    ProglangType candidate = parse(rep);
    if ((candidate.base == "address") || (candidate.base == "pointer")) { // interned
      return intern("hashcode", candidate.dimensions);
    } else if (candidate.base == "float") { // interned
      return intern("double", candidate.dimensions);
    } else if (candidate.base == "string") { // interned
      return intern("java.lang.String", candidate.dimensions);
    } else {
      return candidate;
    }
  }

  /** Convert a file representation type to an internal representation type. */
  public ProglangType fileTypeToRepType() {
    if ((base == BASE_HASHCODE)
        || (base == BASE_BOOLEAN)
        || (base == BASE_LONG)
        || (base == BASE_LONG_LONG)
        || (base == BASE_SHORT)) {
      return intern(BASE_INT, dimensions);
    }
    return this;
  }

  /**
   * For serialization; indicates which object to return instead of the one that was just read from
   * the file. This obviates the need to write a readObject method that interns the interned fields
   * (just "base").
   */
  public Object readResolve() throws ObjectStreamException {
    return intern(base.intern(), dimensions);
  }

  // Is this necessary?  It will be inherited from Object.
  // @EnsuresNonNullIf(result=true, expression="#1")
  // public boolean equals(@Nullable Object o) {
  //   return this == o;
  // }

  // THIS CODE IS A HOT SPOT (~33% of run time) [as of January 2002].
  /**
   * Searches for an array type with the given base and number of dimensions.
   *
   * @param t_base the base type; must be interned
   * @param t_dims the number of dimensions
   * @return an array type with the given base and number of dimensions, or null
   */
  private static @Nullable ProglangType find(@Interned String t_base, int t_dims) {
    // Disabled for performance reasons! this assertion is sound though:
    //    assert t_base == t_base.intern();

    // the string maps us to a vec of all ProglangTypes with that base
    List<ProglangType> v = all_known_types.get(t_base);
    if (v == null) {
      return null;
    }

    // now search for the right dimension
    for (ProglangType candidate : v) {
      if (candidate.dimensions() == t_dims) {
        return candidate;
      }
    }

    return null;
  }

  // private ProglangType intern() {
  //   return ProglangType.intern(this);
  // }

  // We shouldn't even get to the point of interning; we should not
  // have created the ProglangType if it isn't canonical.
  // private static ProglangType intern(ProglangType t) {
  //   ProglangType candidate = find(t.base, t.dimensions);
  //   if (candidate != null)
  //     return candidate;
  //   all_known_types.add(t);
  //   return t;
  // }

  private static ProglangType intern(@Interned String t_base, int t_dims) {
    // Disabled for performance reasons! this assertion is sound though:
    //    assert t_base == t_base.intern();
    ProglangType existing = find(t_base, t_dims);
    if (existing != null) {
      return existing;
    }
    @SuppressWarnings("interning") // test above did not find one, so the new one is interned
    @Interned ProglangType result = new ProglangType(t_base, t_dims);

    List<ProglangType> v =
        all_known_types.computeIfAbsent(t_base, __ -> new ArrayList<ProglangType>());

    v.add(result);

    return result;
  }

  /**
   * Returns the type of elements of this. They may themselves be arrays if this is
   * multidimensional.
   */
  public ProglangType elementType(@GuardSatisfied ProglangType this) {
    // Presume that if there are no dimensions, this must be a list of
    // objects.  Callers should really find this out from other information
    // in the variable, but this will old code that relied on the pseudo
    // dimensions of lists to work
    if (dimensions == 0) {
      return OBJECT;
    }
    assert base == base.intern() : "Uninterned base " + base;
    return ProglangType.intern(base, dimensions - 1);
  }

  // All these variables are public because the way to check the base of an
  // array is type.base() == ProglangType.BASE_CHAR.

  // Primitive types
  static final @Interned String BASE_BOOLEAN = "boolean";
  static final @Interned String BASE_BYTE = "byte";
  static final @Interned String BASE_CHAR = "char";
  static final @Interned String BASE_DOUBLE = "double";
  static final @Interned String BASE_FLOAT = "float";
  static final @Interned String BASE_INT = "int";
  static final @Interned String BASE_LONG = "long";
  static final @Interned String BASE_LONG_LONG = "long long int";
  static final @Interned String BASE_SHORT = "short";

  // Nonprimitive types
  static final @Interned String BASE_OBJECT = "java.lang.Object";
  static final @Interned String BASE_STRING = "java.lang.String";
  static final @Interned String BASE_INTEGER = "java.lang.Integer";
  // "hashcode", "address", and "pointer" are identical;
  // "hashcode" is preferred.
  static final @Interned String BASE_HASHCODE = "hashcode";
  // static final @Interned String BASE_ADDRESS = "address";
  // static final @Interned String BASE_POINTER = "pointer";

  // avoid duplicate allocations
  // No need for the Integer versions; use Long instead.
  // static final @Interned Integer IntegerZero = Intern.internedInteger(0);
  // static final @Interned Integer IntegerOne = Intern.internedInteger(1);
  static final @Interned Long LongZero = Intern.internedLong(0);
  static final @Interned Long LongOne = Intern.internedLong(1);
  static final @Interned Double DoubleZero = Intern.internedDouble(0);
  static final @Interned Double DoubleNaN = Intern.internedDouble(Double.NaN);
  static final @Interned Double DoublePositiveInfinity =
      Intern.internedDouble(Double.POSITIVE_INFINITY);
  static final @Interned Double DoubleNegativeInfinity =
      Intern.internedDouble(Double.NEGATIVE_INFINITY);

  /*
   *  Now that all other static initialisers are done, it is safe to
   *  construct some instances, also statically.  Note that these are
   *  down here to delay their instantiation until after we have
   *  created (e.g.) the list_implementors object, etc.  */

  // Use == to compare, because ProglangType objects are interned.
  public static final ProglangType INT = ProglangType.intern("int", 0);
  public static final ProglangType LONG_PRIMITIVE = ProglangType.intern("long", 0);
  public static final ProglangType DOUBLE = ProglangType.intern("double", 0);
  public static final ProglangType CHAR = ProglangType.intern("char", 0);
  public static final ProglangType STRING = ProglangType.intern("java.lang.String", 0);
  public static final ProglangType INT_ARRAY = ProglangType.intern("int", 1);
  public static final ProglangType LONG_PRIMITIVE_ARRAY = ProglangType.intern("long", 1);
  public static final ProglangType DOUBLE_ARRAY = ProglangType.intern("double", 1);
  public static final ProglangType CHAR_ARRAY = ProglangType.intern("char", 1);
  public static final ProglangType STRING_ARRAY = ProglangType.intern("java.lang.String", 1);
  public static final ProglangType CHAR_ARRAY_ARRAY = ProglangType.intern("char", 2);

  public static final ProglangType INTEGER = ProglangType.intern("java.lang.Integer", 0);
  public static final ProglangType LONG_OBJECT = ProglangType.intern("java.lang.Long", 0);

  public static final ProglangType OBJECT = ProglangType.intern("java.lang.Object", 0);

  public static final ProglangType BOOLEAN = ProglangType.intern("boolean", 0);
  public static final ProglangType HASHCODE = ProglangType.intern("hashcode", 0);
  public static final ProglangType BOOLEAN_ARRAY = ProglangType.intern("boolean", 1);
  public static final ProglangType HASHCODE_ARRAY = ProglangType.intern("hashcode", 1);

  /**
   * Like Long.parseLong(), but transform large unsigned longs (as from C's unsigned long long) into
   * the corresponding negative Java longs. Also handles hex values that begin with 0x.
   */
  @SuppressWarnings("ConstantOverflow")
  private static long myParseLong(String value) {
    if ((value.length() == 20 && value.charAt(0) == '1')
        || (value.length() == 19
            && value.charAt(0) == '9'
            && value.compareTo("9223372036854775808") >= 0)) {
      // Oops, we got a large unsigned long, which Java, having
      // only signed longs, will refuse to parse. We'll have to
      // turn it into the corresponding negative long value.
      String rest; // A substring that will be a valid positive long
      long subtracted; // The amount we effectively subtracted to make it
      if (value.length() == 20) {
        rest = value.substring(1);
        subtracted = 100000L * 100000 * 100000 * 10000; // 10^19; overflows
      } else {
        rest = value.substring(1);
        subtracted = 9L * 100000 * 100000 * 100000 * 1000; // 9*10^18
      }
      return Long.parseLong(rest) + subtracted;
    } else {
      long val;
      if ((value.length() > 2) && (value.charAt(0) == '0') && (value.charAt(1) == 'x')) {
        val = Long.parseLong(value.substring(2), 16);
      } else {
        val = Long.parseLong(value);
      }
      // presume that 32 bit values are signed
      if (dkconfig_convert_to_signed
          && (((val & 0x80000000L) == 0x80000000L) && ((val & 0xFFFFFFFF00000000L) == 0))) {
        // long orig = val;
        val |= 0xFFFFFFFF00000000L;
        // System.out.printf("Warning: converted %d to %d%n", orig, val);
      }
      return val;
    }
  }

  /**
   * Given a string representation of a value (of the type represented by this ProglangType), return
   * the (canonicalized) interpretation of that value.
   *
   * <p>This ProglangType (the method receiver) is assumed to be a representation type, not an
   * arbitrary type in the underlying programming language.
   *
   * <p>If the type is an array and there are any nonsensical elements in the array, the entire
   * array is considered to be nonsensical (indicated by returning null). This is not really
   * correct, but it is a reasonable path to take for now. (jhp, Feb 12, 2005)
   */
  public final @Nullable @Interned Object parse_value(
      String value, LineNumberReader reader, String filename) {
    // System.out.println(format() + ".parse(\"" + value + "\")");

    switch (dimensions) {
      case 0:
        return parse_value_scalar(value, reader, filename);
      case 1:
        return parse_value_array_1d(value, reader, filename);
      case 2:
        return parse_value_array_2d(value, reader, filename);
      default:
        throw new Error("Can't parse a value of type " + format());
    }
  }

  public final @Nullable @Interned Object parse_value_scalar(
      String value, LineNumberReader reader, String filename) {
    // System.out.println(format() + ".parse(\"" + value + "\")");

    assert dimensions == 0;

    if (base == BASE_STRING) {
      if (value.equals("null")) {
        return null;
      }
      // assert value.startsWith("\"") && value.endsWith("\"");
      if (value.startsWith("\"") && value.endsWith("\"")) {
        value = value.substring(1, value.length() - 1);
      } else {
        // Unfortunately, there is not a convenient way to communicate what
        // the variable name is, which would make the error message even
        // more specific.
        if (!value.startsWith("\"")) {
          System.out.printf(
              "Warning: unquoted string value at %s line %d: %s%n",
              filename, reader.getLineNumber(), value);
        } else {
          assert !value.endsWith("\"");
          System.out.printf(
              "Warning: unterminated string value at %s line %d: %s%n",
              filename, reader.getLineNumber(), value);
        }
        System.out.printf(
            "Proceeding anyway.  Please report a bug in the tool that made the data trace file.");
      }
      value = StringsPlume.unescapeJava(value);
      return value.intern();
    } else if (base == BASE_CHAR) {
      // This will fail if the character is output as an integer
      // (as I believe the C front end does).
      char c;
      if (value.length() == 1) {
        c = value.charAt(0);
      } else if ((value.length() == 2) && (value.charAt(0) == '\\')) {
        c = StringsPlume.unescapeJava(value).charAt(0);
      } else if ((value.length() == 4) && (value.charAt(0) == '\\')) {
        Byte b = Byte.decode("0" + value.substring(1));
        return Intern.internedLong(b.longValue());
      } else {
        throw new IllegalArgumentException("Bad character: " + value);
      }
      return Intern.internedLong((int) c);
    }
    // When parse_value is called from FileIO.read_ppt_decl, we have
    // not set file_rep_type. Hence, rep_type is still file_rep_type
    // and BASE_BOOLEAN is legal.
    else if ((base == BASE_INT) || (base == BASE_BOOLEAN)) {
      // File rep type might be int, boolean, or hashcode.
      // If we had the declared type, we could do error-checking here.
      // (Example:  no hashcode should be negative, nor any boolean > 1.)
      if (value.equals("nonsensical")) {
        return null;
      }
      if (value.equals("false") || value.equals("0")) {
        return LongZero;
      }
      if (value.equals("true") || value.equals("1")) {
        return LongOne;
      }
      if (value.equals("null")) {
        return LongZero;
      }
      return Intern.internedLong(myParseLong(value));
    } else if (base == BASE_DOUBLE) {
      // Must ignore case, because dfej outputs "NaN", while dfec
      // outputs "nan".  dfec outputs "nan", because this string
      // comes from the C++ library.
      if (value.equalsIgnoreCase("NaN")) {
        return DoubleNaN;
      }
      if (value.equalsIgnoreCase("Infinity") || value.equals("inf")) {
        return DoublePositiveInfinity;
      }
      if (value.equalsIgnoreCase("-Infinity") || value.equals("-inf")) {
        return DoubleNegativeInfinity;
      }
      return Intern.internedDouble(value);
    } else if ((base == BASE_HASHCODE)
        || (base == BASE_LONG)
        || (base == BASE_LONG_LONG)
        || (base == BASE_SHORT)) {
      throw new Error("not a rep type: illegal base type " + base);
    } else {
      throw new Error("unrecognized base type " + base);
    }
  }

  public final @Nullable @Interned Object parse_value_array_1d(
      String value, LineNumberReader reader, String filename) {
    // System.out.println(format() + ".parse(\"" + value + "\")");

    String value_orig = value; // we will side-effect the parameter

    // variable is an array
    assert dimensions == 1;

    value = value.trim();

    // Deal with [] surrounding array output (permits
    // distinguishing between null and an array containing just null).
    if (value.startsWith("[") && value.endsWith("]")) {
      value = value.substring(1, value.length() - 1).trim();
    } else {
      throw new IllegalArgumentException("Array values must be enlosed in square brackets");
    }

    // Elements of value_strings can be null only if base == BASE_STRING.
    // [I think they can never be null.  -MDE]
    String[] value_strings;
    if (value.length() == 0) {
      value_strings = new String[0];
    } else if (base == BASE_STRING) {
      // This properly handles strings containing embedded spaces.
      List<@Nullable String> v = new ArrayList<>();
      StreamTokenizer parser = new StreamTokenizer(new StringReader(value));
      parser.quoteChar('\"');
      try {
        while (parser.nextToken() != StreamTokenizer.TT_EOF) {
          if (parser.ttype == '\"') {
            v.add(parser.sval);
          } else if (parser.ttype == StreamTokenizer.TT_WORD) {
            assert parser.sval != null
                : "@AssumeAssertion(nullness): dependent: representation invariant of"
                    + " StreamTokenizer";
            if (parser.sval.equals("nonsensical")) {
              return null;
            }
            assert parser.sval.equals("null");
            v.add(null);
          } else if (parser.ttype == StreamTokenizer.TT_NUMBER) {
            v.add(Integer.toString((int) parser.nval));
          } else {
            System.out.printf(
                "Warning: at %s line %d%n"
                    + "  bad ttype %c [int=%d] while parsing %s%n"
                    + "  Proceeding with value 'null'%n",
                filename, reader.getLineNumber(), (char) parser.ttype, parser.ttype, value_orig);
            v.add(null);
          }
        }
      } catch (Exception e) {
        throw new Error(e);
      }
      // Avoid nullness warnings about elements of value_strings
      @SuppressWarnings("nullness")
      String[] value_strings_result = v.toArray(new @Nullable String[0]);
      value_strings = value_strings_result;
    } else {
      value_strings = Global.ws_regexp.split(value);
    }
    int len = value_strings.length;

    // This big if ... else should deal with all the primitive types --
    // or at least all the ones that can be rep_types.
    // ("long" and "short" cannot be rep_types; for simplicity, variables
    // declared as long or short have the "int" rep_type.)
    if (base == BASE_INT) {
      long[] result = new long[len];
      for (int i = 0; i < len; i++) {
        if (value_strings[i].equals("nonsensical")) {
          return null;
        } else if (value_strings[i].equals("null")) result[i] = 0;
        else if (value_strings[i].equals("false")) result[i] = 0;
        else if (value_strings[i].equals("true")) result[i] = 1;
        else {
          result[i] = myParseLong(value_strings[i]);
        }
      }
      return Intern.intern(result);
    } else if (base == BASE_DOUBLE) {
      double[] result = new double[len];
      for (int i = 0; i < len; i++) {
        if (value_strings[i].equals("nonsensical")) {
          return null;
        } else if (value_strings[i].equals("null")) {
          result[i] = 0;
        } else if (value_strings[i].equalsIgnoreCase("NaN")) {
          result[i] = Double.NaN;
        } else if (value_strings[i].equalsIgnoreCase("Infinity")
            || value_strings[i].equals("inf")) {
          result[i] = Double.POSITIVE_INFINITY;
        } else if (value_strings[i].equalsIgnoreCase("-Infinity")
            || value_strings[i].equals("-inf")) {
          result[i] = Double.NEGATIVE_INFINITY;
        } else {
          result[i] = Double.parseDouble(value_strings[i]);
        }
      }
      return Intern.intern(result);
    } else if (base == BASE_STRING) {
      // First, intern each String in the array ...
      @Interned String[] value_strings_elts_interned = Intern.internStrings(value_strings);
      // ... then, intern the entire array, and return it
      return Intern.intern(value_strings_elts_interned);
    } else {
      throw new Error("Can't yet parse array of base type " + base);
    }

    // This is a more general technique; but when will we need
    // such generality?
    // // not elementType() because that interns; here, there is no
    // // need to do the work of interning (I think)
    // ProglangType elt_type = elementType();
    // Object[] result = new Object[len];
    // for (int i = 0; i<len; i++)
    //   result[i] = ***;

  }

  public final @Nullable @Interned Object parse_value_array_2d(
      String value, LineNumberReader reader, String filename) {
    // System.out.println(format() + ".parse(\"" + value + "\")");

    assert dimensions == 2;
    if (base == BASE_CHAR) {
      // Array of strings
      throw new Error("To implement");
      // value = tuple(eval(value));
    } else {
      throw new Error("Can't parse a value of type " + format());
    }
  }

  public boolean baseIsPrimitive() {
    return ((base == BASE_BOOLEAN)
        || (base == BASE_BYTE)
        || (base == BASE_CHAR)
        || (base == BASE_DOUBLE)
        || (base == BASE_FLOAT)
        || (base == BASE_INT)
        || (base == BASE_LONG)
        || (base == BASE_LONG_LONG)
        || (base == BASE_SHORT));
  }

  @Pure
  public boolean isPrimitive() {
    return (dimensions == 0) && baseIsPrimitive();
  }

  // Does not include boolean.  Is that intentional?  (If it were added,
  // we would need to change isIndex().)
  public boolean baseIsIntegral() {
    return ((base == BASE_BYTE)
        || (base == BASE_CHAR)
        || (base == BASE_INT)
        || (base == BASE_LONG)
        || (base == BASE_LONG_LONG)
        || (base == BASE_SHORT)
        || (base == BASE_INTEGER));
  }

  @Pure
  public boolean isIntegral() {
    return (dimensions == 0) && baseIsIntegral();
  }

  // More efficient than elementType().isIntegral()
  public boolean elementIsIntegral() {
    return (dimensions == 1) && baseIsIntegral();
  }

  public boolean elementIsFloat() {
    return (dimensions == 1) && baseIsFloat();
  }

  public boolean elementIsString() {
    return (dimensions == 1) && baseIsString();
  }

  // Return true if this variable is sensible as an array index.
  @Pure
  public boolean isIndex() {
    return isIntegral();
  }

  @Pure
  public boolean isScalar() {
    // For reptypes, checking against INT is sufficient, rather than
    // calling isIntegral().
    return isIntegral() || (this == HASHCODE) || (this == BOOLEAN);
  }

  public boolean baseIsScalar() {
    return baseIsIntegral() || (base == BASE_BOOLEAN) || (base == BASE_HASHCODE);
  }

  public boolean baseIsBoolean() {
    return base == BASE_BOOLEAN;
  }

  public boolean baseIsFloat() {
    return (base == BASE_DOUBLE) || (base == BASE_FLOAT);
  }

  @Pure
  public boolean isFloat() {
    return (dimensions == 0) && baseIsFloat();
  }

  /**
   * Return true if this is java.lang.Object.
   *
   * @return true if this is java.lang.Object
   */
  @Pure
  public boolean isObject() {
    return (dimensions == 0) && baseIsObject();
  }

  /**
   * Return true if the base (the final element type) is a reference type rather than integer,
   * float, or boolean.
   *
   * @return true if the base is Object
   */
  public boolean baseIsObject() {
    return !baseIsIntegral() && !baseIsFloat() && !(base == BASE_BOOLEAN);
  }

  public boolean baseIsString() {
    return base == BASE_STRING;
  }

  @Pure
  public boolean isString() {
    return (dimensions == 0) && baseIsString();
  }

  public boolean baseIsHashcode() {
    return (base == BASE_HASHCODE);
  }

  @Pure
  public boolean isHashcode() {
    return (dimensions == 0) && baseIsHashcode();
  }

  /** Does this type represent a pointer? Should only be applied to file_rep types. */
  @Pure
  public boolean isPointerFileRep() {
    return base == BASE_HASHCODE;
  }

  /**
   * Return true if these two types can be sensibly compared to one another, or if one can be cast
   * to the other. For instance, int is castable to long, but boolean is not castable to float, and
   * int is not castable to int[]. This is a reflexive relationship, but not a transitive one
   * because it might not be true for two children of a superclass, even though it's true for the
   * superclass.
   */
  public boolean comparableOrSuperclassEitherWay(ProglangType other) {
    if (this == other) { // ProglangType objects are interned
      return true;
    }
    if (this.dimensions != other.dimensions) {
      return false;
    }
    boolean thisIntegral = this.baseIsIntegral();
    boolean otherIntegral = other.baseIsIntegral();
    if (thisIntegral && otherIntegral) {
      return true;
    }
    // Make Object castable to everything, except booleans
    if (((this.base == BASE_OBJECT) && other.baseIsObject()) // interned strings
        || ((other.base == BASE_OBJECT) && baseIsObject())) { // interned strings
      return true;
    }

    return false;
  }

  /**
   * Return true if these two types can be sensibly compared to one another, and if non-integral,
   * whether this could be a superclass of other. A List is comparableOrSuperclassOf to a ArrayList,
   * but not the other way around. This is a transitive method, but not reflexive.
   */
  public boolean comparableOrSuperclassOf(ProglangType other) {
    if (this == other) { // ProglangType objects are interned
      return true;
    }
    if (this.dimensions != other.dimensions) {
      return false;
    }
    boolean thisIntegral = this.baseIsIntegral();
    boolean otherIntegral = other.baseIsIntegral();
    if (thisIntegral && otherIntegral) {
      return true;
    }
    // Make Object castable to everything, except booleans
    if ((this.base == BASE_OBJECT) && other.baseIsObject()) { // interned strings
      return true;
    }

    return false;
  }

  // For Java programs, a @BinaryName.
  @SideEffectFree
  public String format(@GuardSatisfied ProglangType this) {
    if (dimensions == 0) {
      return base;
    }

    StringBuilder sb = new StringBuilder();
    sb.append(base);
    for (int i = 0; i < dimensions; i++) {
      sb.append("[]");
    }
    return sb.toString();
  }

  // For Java programs, a @BinaryName.
  @SideEffectFree
  @Override
  public String toString(@GuardSatisfied ProglangType this) {
    return format();
  }

  /**
   * Returns whether or not this declared type is a function pointer Only valid if the front end
   * marks the function pointer with the name '*func'.
   */
  @Pure
  public boolean is_function_pointer() {
    assert base == base.intern();
    return base == "*func"; // interned
  }
}