1b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato/* 2b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * ProGuard -- shrinking, optimization, obfuscation, and preverification 3b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * of Java bytecode. 4b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 52270795fbe0b277bfd49f40950ecaa78583175ccBrian Carlstrom * Copyright (c) 2002-2014 Eric Lafortune (eric@graphics.cornell.edu) 6b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 7b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * This program is free software; you can redistribute it and/or modify it 8b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * under the terms of the GNU General Public License as published by the Free 9b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Software Foundation; either version 2 of the License, or (at your option) 10b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * any later version. 11b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 12b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * This program is distributed in the hope that it will be useful, but WITHOUT 13b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 14b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 15b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * more details. 16b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 17b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * You should have received a copy of the GNU General Public License along 18b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * with this program; if not, write to the Free Software Foundation, Inc., 19b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 20b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 21b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratopackage proguard.shrink; 22b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 23b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoimport proguard.classfile.*; 24b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoimport proguard.classfile.visitor.*; 25b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 26b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 27b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato/** 28b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * This class can be used as a mark when keeping classes, class members, and 29b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * other elements. It can be certain or preliminary. It also contains additional 30b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * information about the reasons why an element is being kept. 31b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 32b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * @see ClassShrinker 33b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 34b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * @author Eric Lafortune 35b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 36b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratofinal class ShortestUsageMark 37b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato{ 38b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private final boolean certain; 39b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private final String reason; 40b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private final int depth; 41b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private Clazz clazz; 42b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private Member member; 43b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 44b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 45b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 46b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Creates a new certain ShortestUsageMark. 47b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * @param reason the reason for this mark. 48b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 49b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public ShortestUsageMark(String reason) 50b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 51b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.certain = true; 52b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.reason = reason; 53b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.depth = 0; 54b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 55b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 56b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 57b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 58b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Creates a new certain ShortestUsageMark. 59b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * @param previousUsageMark the previous mark to which this one is linked. 60b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * @param reason the reason for this mark. 61b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * @param clazz the class causing this mark. 62b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 63b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public ShortestUsageMark(ShortestUsageMark previousUsageMark, 64b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato String reason, 65b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato int cost, 66b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato Clazz clazz) 67b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 68b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this(previousUsageMark, reason, cost, clazz, null); 69b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 70b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 71b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 72b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 73b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Creates a new certain ShortestUsageMark. 74b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * @param previousUsageMark the previous mark to which this one is linked. 75b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * @param reason the reason for this mark. 76b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * @param clazz the class causing this mark. 77b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * @param member the member in the above class causing this mark. 78b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * @param cost the added cost of following this path. 79b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 80b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public ShortestUsageMark(ShortestUsageMark previousUsageMark, 81b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato String reason, 82b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato int cost, 83b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato Clazz clazz, 84b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato Member member) 85b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 86b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.certain = true; 87b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.reason = reason; 88b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.depth = previousUsageMark.depth + cost; 89b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.clazz = clazz; 90b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.member = member; 91b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 92b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 93b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 94b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 95b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Creates a new ShortestUsageMark, based on another mark. 96b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * @param otherUsageMark the other mark, whose properties will be copied. 97b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * @param certain specifies whether this is a certain mark. 98b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 99b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public ShortestUsageMark(ShortestUsageMark otherUsageMark, 100b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato boolean certain) 101b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 102b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.certain = certain; 103b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.reason = otherUsageMark.reason; 104b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.depth = otherUsageMark.depth; 105b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.clazz = otherUsageMark.clazz; 106b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.member = otherUsageMark.member; 107b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 108b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 109b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 110b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 111b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Returns whether this is a certain mark. 112b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 113b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public boolean isCertain() 114b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 115b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato return certain; 116b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 117b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 118b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 119b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 120b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Returns the reason for this mark. 121b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 122b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public String getReason() 123b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 124b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato return reason; 125b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 126b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 127b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 128b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 129b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Returns whether this mark has a shorter chain of reasons than the 130b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * given mark. 131b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 132b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public boolean isShorter(ShortestUsageMark otherUsageMark) 133b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 134b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato return this.depth < otherUsageMark.depth; 135b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 136b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 137b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 138b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 139b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Returns whether this is mark is caused by the given class. 140b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 141b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public boolean isCausedBy(Clazz clazz) 142b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 143b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato return clazz.equals(this.clazz); 144b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 145b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 146b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 147b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 148b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Applies the given class visitor to this mark's class, if any, 149b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * and if this mark doesn't have a member. 150b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 151b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public void acceptClassVisitor(ClassVisitor classVisitor) 152b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 153b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato if (clazz != null && 154b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato member == null) 155b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 156b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato clazz.accept(classVisitor); 157b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 158b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 159b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 160b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 161b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 162b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Applies the given class visitor to this mark's member, if any. 163b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 164b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public void acceptMemberVisitor(MemberVisitor memberVisitor) 165b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 166b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato if (clazz != null && 167b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato member != null) 168b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 169b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato member.accept(clazz, memberVisitor); 170b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 171b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 172b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 173b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 174b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato // Implementations for Object. 175b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 176b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public String toString() 177b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 178b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato return "certain=" + certain + ", depth="+depth+": " + 179b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato reason + 180b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato (clazz != null ? clazz.getName() : "(none)") + ": " + 181b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato (member != null ? member.getName(clazz) : "(none)"); 182b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 183b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato} 184