Mirror of the JODE repository
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
jode/jode/jode/decompiler/LocalInfo.java

415 lines
11 KiB

/* LocalInfo Copyright (C) 1998-1999 Jochen Hoenicke.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, 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 Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; see the file COPYING. If not, write to
* the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
*
* $Id$
*/
package jode.decompiler;
import java.util.Enumeration;
import java.util.Vector;
import jode.GlobalOptions;
import jode.type.Type;
import jode.expr.Expression;
import jode.expr.LocalVarOperator;
/**
* The LocalInfo represents a local variable of a method.
* The problem is that two different local variables may use the same
* slot. The current strategie is to make the range of a local variable
* as small as possible.<p>
*
* There may be more than one LocalInfo for a single local variable,
* because the algorithm begins with totally disjunct variables and
* then unifies locals. One of the local is then a shadow object which
* calls the member functions of the other local.<p>
*/
public class LocalInfo implements Declarable {
private static int serialnr = 0;
private static int nextAnonymousSlot = -1;
private int slot;
private MethodAnalyzer methodAnalyzer;
private boolean nameIsGenerated = false;
private boolean isUnique;
private String name;
private Type type;
private LocalInfo shadow;
private Vector operators = new Vector();
private Vector hints = new Vector();
private boolean removed = false;
private boolean isFinal = false;
private Expression constExpr = null;
static class Hint {
String name;
Type type;
public Hint(String name, Type type) {
this.name = name;
this.type = type;
}
public final Type getType() {
return type;
}
public final String getName() {
return name;
}
public boolean equals(Object o) {
if (o instanceof Hint) {
Hint h = (Hint) o;
return name.equals(h.name) && type.equals(h.type);
}
return false;
}
public int hashCode() {
return name.hashCode() ^ type.hashCode();
}
}
/**
* Create a new local info with an anonymous slot.
*/
public LocalInfo() {
name = null;
type = Type.tUnknown;
this.slot = nextAnonymousSlot--;
}
/**
* Create a new local info.
* @param slot The slot of this variable.
*/
public LocalInfo(MethodAnalyzer method, int slot) {
name = null;
type = Type.tUnknown;
this.methodAnalyzer = method;
this.slot = slot;
}
public static void init() {
serialnr = 0;
}
public void setOperator(LocalVarOperator operator) {
getLocalInfo().operators.addElement(operator);
}
public void addHint(String name, Type type) {
getLocalInfo().hints.addElement(new Hint(name, type));
}
public int getUseCount() {
return getLocalInfo().operators.size();
}
/**
* Combines the LocalInfo with another. This will make this
* a shadow object to the other local info. That is all member
* functions will use the new local info instead of data in this
* object. <p>
* If this is called with ourself nothing will happen.
* @param li the local info that we want to shadow.
*/
public void combineWith(LocalInfo shadow) {
if (this.shadow != null) {
getLocalInfo().combineWith(shadow);
return;
}
shadow = shadow.getLocalInfo();
if (this == shadow)
return;
this.shadow = shadow;
if (!nameIsGenerated)
shadow.name = name;
if (constExpr != null) {
if (shadow.constExpr != null)
throw new jode.AssertError
("local has multiple constExpr");
shadow.constExpr = constExpr;
}
// GlobalOptions.err.println("combining "+name+"("+type+") and "
// +shadow.name+"("+shadow.type+")");
shadow.setType(type);
boolean needTypeUpdate = !shadow.type.equals(type);
java.util.Enumeration enum = operators.elements();
while (enum.hasMoreElements()) {
LocalVarOperator lvo =
(LocalVarOperator) enum.nextElement();
if (needTypeUpdate) {
if ((GlobalOptions.debuggingFlags
& GlobalOptions.DEBUG_TYPES) != 0)
GlobalOptions.err.println("updating " + lvo);
lvo.updateType();
}
shadow.operators.addElement(lvo);
}
enum = hints.elements();
while (enum.hasMoreElements()) {
Object hint = enum.nextElement();
if (!shadow.hints.contains(hint))
shadow.hints.addElement(hint);
}
/* Clear unused fields, to allow garbage collection.
*/
type = null;
name = null;
operators = null;
}
/**
* Get the real LocalInfo. This may be different from the
* current object if this is a shadow local info.
*/
public LocalInfo getLocalInfo() {
if (shadow != null) {
while (shadow.shadow != null) {
shadow = shadow.shadow;
}
return shadow;
}
return this;
}
/**
* Returns true if the local already has a name.
*/
public boolean hasName() {
return getLocalInfo().name != null;
}
public String guessName() {
if (shadow != null) {
while (shadow.shadow != null) {
shadow = shadow.shadow;
}
return shadow.guessName();
}
if (name == null) {
Enumeration enum = hints.elements();
while (enum.hasMoreElements()) {
Hint hint = (Hint) enum.nextElement();
if (type.isOfType(hint.getType())) {
name = hint.getName();
setType(hint.getType());
return name;
}
}
nameIsGenerated = true;
if ((GlobalOptions.debuggingFlags & GlobalOptions.DEBUG_TYPES) != 0)
GlobalOptions.err.println(getName()+" set type to getHint()");
setType(type.getHint());
if ((Options.options & Options.OPTION_PRETTY) != 0) {
name = type.getDefaultName();
} else {
name = type.getDefaultName()
+ (slot >= 0 ? "_" + slot : "") + "_" + serialnr++ + "_";
isUnique = true;
}
if ((GlobalOptions.debuggingFlags
& GlobalOptions.DEBUG_LOCALS) != 0) {
GlobalOptions.err.println("Guessed name: " + name
+ " from type: " + type);
Thread.dumpStack();
}
}
return name;
}
/**
* Get the name of this local.
*/
public String getName() {
if (shadow != null) {
while (shadow.shadow != null) {
shadow = shadow.shadow;
}
return shadow.getName();
}
if (name == null) {
return "local_" + (slot >= 0 ? slot + "_" : "")
+ Integer.toHexString(hashCode());
}
return name;
}
public boolean isNameGenerated() {
return getLocalInfo().nameIsGenerated;
}
/**
* Get the slot of this local.
*/
public int getSlot() {
/* The slot may change when shadowing for anonymous locals */
return getLocalInfo().slot;
}
/**
* Set the name of this local.
*/
public void setName(String name) {
LocalInfo li = getLocalInfo();
li.name = name;
}
/**
* Set the name of this local.
*/
public void makeNameUnique() {
LocalInfo li = getLocalInfo();
String name = li.getName();
if (!li.isUnique) {
li.name = name + "_" + serialnr++ + "_";
li.isUnique = true;
}
}
/**
* Get the type of this local.
*/
public Type getType() {
return getLocalInfo().type;
}
private int loopCount = 0;
/**
* Sets a new information about the type of this local.
* The type of the local is may be made more specific by this call.
* @param The new type information to be set.
* @return The new type of the local.
*/
public Type setType(Type otherType) {
LocalInfo li = getLocalInfo();
if (li.loopCount++ > 5) {
GlobalOptions.err.println("Type error in local " + getName()+": "
+ li.type + " seems to be recursive.");
Thread.dumpStack();
otherType = Type.tError;
}
Type newType = li.type.intersection(otherType);
if (newType == Type.tError
&& otherType != Type.tError && li.type != Type.tError) {
GlobalOptions.err.println("Type error in local " + getName()+": "
+ li.type + " and " + otherType);
if ((GlobalOptions.debuggingFlags
& GlobalOptions.DEBUG_TYPES) != 0)
Thread.dumpStack();
}
else if ((GlobalOptions.debuggingFlags & GlobalOptions.DEBUG_TYPES) != 0)
GlobalOptions.err.println(getName()+" setType, new: "+newType
+ " old: "+li.type);
if (!li.type.equals(newType)) {
li.type = newType;
java.util.Enumeration enum = li.operators.elements();
while (enum.hasMoreElements()) {
LocalVarOperator lvo = (LocalVarOperator) enum.nextElement();
if ((GlobalOptions.debuggingFlags & GlobalOptions.DEBUG_TYPES) != 0)
GlobalOptions.err.println("updating "+lvo);
lvo.updateType();
}
}
li.loopCount--;
return li.type;
}
public void setExpression(Expression expr) {
setType(expr.getType());
getLocalInfo().constExpr = expr;
}
public Expression getExpression() {
return getLocalInfo().constExpr;
}
public boolean isShadow() {
return (shadow != null);
}
public boolean equals(Object obj) {
return (obj instanceof LocalInfo
&& ((LocalInfo)obj).getLocalInfo() == getLocalInfo());
}
public void remove() {
removed = true;
}
public boolean isRemoved() {
return removed;
}
public boolean isConstant() {
LocalInfo li = getLocalInfo();
Enumeration enum = li.operators.elements();
int writes = 0;
while (enum.hasMoreElements()) {
if (((LocalVarOperator) enum.nextElement()).isWrite())
writes++;
}
if (writes > 1)
return false;
return true;
}
public MethodAnalyzer getMethodAnalyzer() {
return methodAnalyzer;
}
public boolean markFinal() {
LocalInfo li = getLocalInfo();
Enumeration enum = li.operators.elements();
int writes = 0;
while (enum.hasMoreElements()) {
if (((LocalVarOperator) enum.nextElement()).isWrite())
writes++;
}
if (writes > 1)
return false;
li.isFinal = true;
return true;
}
public boolean isFinal() {
return getLocalInfo().isFinal;
}
public String toString() {
return getName();
}
public void dumpDeclaration(TabbedPrintWriter writer)
throws java.io.IOException
{
LocalInfo li = getLocalInfo();
if (li.isFinal)
writer.print("final ");
writer.printType(li.getType().getHint());
writer.print(" " + li.getName().toString());
}
}