soot.coffi.CONSTANT_String_info Maven / Gradle / Ivy

package soot.coffi;

/*-
 * #%L
 * Soot - a J*va Optimization Framework
 * %%
 * Copyright (C) 1997 Clark Verbrugge
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 2.1 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import soot.Value;
import soot.jimple.StringConstant;

/**
 * A constant pool entry of type CONSTANT_String.
 * 
 * @see cp_info
 * @author Clark Verbrugge
 */
class CONSTANT_String_info extends cp_info {
  /**
   * Constant pool index of the CONSTANT_Utf8 object for the actual string.
   * 
   * @see CONSTANT_Utf8_info
   */
  public int string_index;

  /**
   * Returns the size of this cp_info object.
   * 
   * @return number of bytes occupied by this object.
   * @see cp_info#size
   */
  public int size() {
    return 3;
  }

  /**
   * Returns a String representation of this entry.
   * 
   * @param constant_pool
   *          constant pool of ClassFile.
   * @return String representation of this entry.
   * @see cp_info#toString
   */
  public String toString(cp_info constant_pool[]) {
    CONSTANT_Utf8_info ci = (CONSTANT_Utf8_info) (constant_pool[string_index]);
    return "\"" + ci.convert() + "\"";
  }

  /**
   * Returns a String description of what kind of entry this is.
   * 
   * @return the String "string".
   * @see cp_info#typeName
   */
  public String typeName() {
    return "string";
  }

  /**
   * Compares this entry with another cp_info object (which may reside in a different constant pool).
   * 
   * @param constant_pool
   *          constant pool of ClassFile for this.
   * @param cp
   *          constant pool entry to compare against.
   * @param cp_constant_pool
   *          constant pool of ClassFile for cp.
   * @return a value <0, 0, or >0 indicating whether this is smaller, the same or larger than cp.
   * @see cp_info#compareTo
   */
  public int compareTo(cp_info constant_pool[], cp_info cp, cp_info cp_constant_pool[]) {
    if (tag != cp.tag) {
      return tag - cp.tag;
    }
    CONSTANT_String_info cu = (CONSTANT_String_info) cp;
    return ((CONSTANT_Utf8_info) (constant_pool[string_index])).compareTo(cp_constant_pool[cu.string_index]);
  }

  public Value createJimpleConstantValue(cp_info[] constant_pool) {
    CONSTANT_Utf8_info ci = (CONSTANT_Utf8_info) (constant_pool[string_index]);
    return StringConstant.v(ci.convert());
  }
}