1b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato/* 2b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * ProGuard -- shrinking, optimization, obfuscation, and preverification 3b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * of Java bytecode. 4b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 5b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Copyright (c) 2002-2009 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; 22b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 23b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoimport proguard.classfile.*; 24b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoimport proguard.classfile.util.*; 25b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoimport proguard.classfile.visitor.*; 26b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoimport proguard.optimize.KeepMarker; 27b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 28b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoimport java.util.List; 29b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 30b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 31b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato/** 32b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * This class checks whether classes referenced by class members that are 33b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * marked to be kept are marked to be kept too. 34b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 35b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * @author Eric Lafortune 36b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 37b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratopublic class DescriptorKeepChecker 38b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoextends SimplifiedVisitor 39b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoimplements MemberVisitor, 40b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassVisitor 41b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato{ 42b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private final ClassPool programClassPool; 43b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private final ClassPool libraryClassPool; 44b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private final WarningPrinter notePrinter; 45b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 46b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato // Some fields acting as parameters for the class visitor. 47b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private Clazz referencingClass; 48b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private Member referencingMember; 49b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private boolean isField; 50b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 51b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 52b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 53b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Creates a new DescriptorKeepChecker. 54b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 55b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public DescriptorKeepChecker(ClassPool programClassPool, 56b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassPool libraryClassPool, 57b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato WarningPrinter notePrinter) 58b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 59b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.programClassPool = programClassPool; 60b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.libraryClassPool = libraryClassPool; 61b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.notePrinter = notePrinter; 62b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 63b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 64b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 65b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 66b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Checks the classes mentioned in the given keep specifications, printing 67b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * notes if necessary. Returns the number of notes printed. 68b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 69b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public void checkClassSpecifications(List keepSpecifications) 70b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 71b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato // Clean up any old visitor info. 72b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato programClassPool.classesAccept(new ClassCleaner()); 73b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato libraryClassPool.classesAccept(new ClassCleaner()); 74b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 75b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato // Create a visitor for marking the seeds. 76b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato KeepMarker keepMarker = new KeepMarker(); 77b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassPoolVisitor classPoolvisitor = 78b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassSpecificationVisitorFactory.createClassPoolVisitor(keepSpecifications, 79b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato keepMarker, 80b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato keepMarker, 81b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato false, 82b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato true, 83b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato true); 84b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato // Mark the seeds. 85b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato programClassPool.accept(classPoolvisitor); 86b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato libraryClassPool.accept(classPoolvisitor); 87b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 88b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato // Print out notes about argument types that are not being kept. 89b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato programClassPool.classesAccept(new AllMemberVisitor(this)); 90b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 91b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 92b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 93b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato // Implementations for MemberVisitor. 94b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 95b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public void visitProgramField(ProgramClass programClass, ProgramField programField) 96b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 97b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato if (KeepMarker.isKept(programField)) 98b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 99b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato referencingClass = programClass; 100b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato referencingMember = programField; 101b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato isField = true; 102b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 103b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato // Don't check the type, because it is not required for introspection. 104b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato //programField.referencedClassesAccept(this); 105b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 106b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 107b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 108b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 109b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public void visitProgramMethod(ProgramClass programClass, ProgramMethod programMethod) 110b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 111b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato if (KeepMarker.isKept(programMethod)) 112b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 113b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato referencingClass = programClass; 114b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato referencingMember = programMethod; 115b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato isField = false; 116b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 117b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato // Don't check the return type, because it is not required for 118b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato // introspection (e.g. the return type of the special Enum methods). 119b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato //programMethod.referencedClassesAccept(this); 120b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 121b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato Clazz[] referencedClasses = programMethod.referencedClasses; 122b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato if (referencedClasses != null) 123b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 124b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato for (int index = 0; index < referencedClasses.length-1; index++) 125b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 126b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato if (referencedClasses[index] != null) 127b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 128b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato referencedClasses[index].accept(this); 129b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 130b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 131b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 132b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 133b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 134b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 135b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 136b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato // Implementations for ClassVisitor. 137b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 138b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public void visitProgramClass(ProgramClass programClass) 139b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 140b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato if (!KeepMarker.isKept(programClass)) 141b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 142b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato notePrinter.print(referencingClass.getName(), 143b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato programClass.getName(), 144b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato "Note: the configuration keeps the entry point '" + 145b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassUtil.externalClassName(referencingClass.getName()) + 146b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato " { " + 147b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato (isField ? 148b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassUtil.externalFullFieldDescription(0, 149b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato referencingMember.getName(referencingClass), 150b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato referencingMember.getDescriptor(referencingClass)) : 151b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassUtil.externalFullMethodDescription(referencingClass.getName(), 152b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 0, 153b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato referencingMember.getName(referencingClass), 154b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato referencingMember.getDescriptor(referencingClass))) + 155b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato "; }', but not the descriptor class '" + 156b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassUtil.externalClassName(programClass.getName()) + 157b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato "'"); 158b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 159b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 160b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 161b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 162b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public void visitLibraryClass(LibraryClass libraryClass) {} 163b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato} 164