001 /*
002 $Id: VerifyClass.java,v 1.2 2005/05/27 10:13:07 russel Exp $
003
004 Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
005
006 Redistribution and use of this software and associated documentation
007 ("Software"), with or without modification, are permitted provided
008 that the following conditions are met:
009
010 1. Redistributions of source code must retain copyright
011 statements and notices. Redistributions must also contain a
012 copy of this document.
013
014 2. Redistributions in binary form must reproduce the
015 above copyright notice, this list of conditions and the
016 following disclaimer in the documentation and/or other
017 materials provided with the distribution.
018
019 3. The name "groovy" must not be used to endorse or promote
020 products derived from this Software without prior written
021 permission of The Codehaus. For written permission,
022 please contact info@codehaus.org.
023
024 4. Products derived from this Software may not be called "groovy"
025 nor may "groovy" appear in their names without prior written
026 permission of The Codehaus. "groovy" is a registered
027 trademark of The Codehaus.
028
029 5. Due credit should be given to The Codehaus -
030 http://groovy.codehaus.org/
031
032 THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
033 ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
034 NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
035 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
036 THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
037 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
038 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
039 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
040 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
041 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
042 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
043 OF THE POSSIBILITY OF SUCH DAMAGE.
044
045 */
046 package org.codehaus.groovy.ant;
047
048 import java.io.File;
049 import java.io.FileInputStream;
050 import java.io.IOException;
051 import java.util.List;
052
053 import org.apache.tools.ant.BuildException;
054 import org.apache.tools.ant.taskdefs.MatchingTask;
055 import org.objectweb.asm.ClassReader;
056 import org.objectweb.asm.Label;
057 import org.objectweb.asm.util.CheckClassAdapter;
058 import org.objectweb.asm.util.TraceMethodVisitor;
059 import org.objectweb.asm.tree.AbstractInsnNode ;
060 import org.objectweb.asm.tree.ClassNode ;
061 import org.objectweb.asm.tree.MethodNode ;
062 import org.objectweb.asm.tree.analysis.Analyzer ;
063 import org.objectweb.asm.tree.analysis.Frame ;
064 import org.objectweb.asm.tree.analysis.SimpleVerifier ;
065
066 /**
067 * Compiles Groovy source files. This task can take the following
068 * arguments:
069 * <ul>
070 * <li>sourcedir
071 * <li>destdir
072 * <li>classpath
073 * </ul>
074 * Of these arguments, the <b>sourcedir</b> and <b>destdir</b> are required.
075 * <p>
076 * When this task executes, it will recursively scan the sourcedir and
077 * destdir looking for Groovy source files to compile. This task makes its
078 * compile decision based on timestamp.
079 *
080 * Based heavily on the Javac implementation in Ant
081 *
082 * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
083 * @version $Revision: 1.2 $
084 */
085 public class VerifyClass extends MatchingTask {
086 private String topDir=null;
087 private boolean verbose = false;
088
089 public VerifyClass() {}
090
091 public void execute() throws BuildException {
092 if (topDir==null) throw new BuildException("no dir attribute is set");
093 File top = new File(topDir);
094 if (!top.exists()) throw new BuildException("the directory "+top+" does not exist");
095 log ("top dir is "+top);
096 int fails = execute(top);
097 if (fails==0) {
098 log ("no bytecode problems found");
099 } else {
100 log ("found "+fails+" failing classes");
101 }
102 }
103
104 public void setDir(String dir) throws BuildException {
105 topDir = dir;
106 }
107
108 public void setVerbose(boolean v) {
109 verbose = v;
110 }
111
112 private int execute(File dir) {
113 int fails = 0;
114 File[] files = dir.listFiles();
115 for (int i = 0; i < files.length; i++) {
116 File f =files[i];
117 if (f.isDirectory()) {
118 fails += execute(f);
119 } else if (f.getName().endsWith(".class")) {
120 try {
121 boolean ok = readClass(f.getCanonicalPath());
122 if (!ok) fails++;
123 } catch (IOException ioe) {
124 log(ioe.getMessage());
125 throw new BuildException(ioe);
126 }
127 }
128 }
129 return fails;
130 }
131
132 private boolean readClass(String clazz) throws IOException {
133 ClassReader cr = new ClassReader(new FileInputStream(clazz));
134 ClassNode ca = new ClassNode ( )
135 {
136 public void visitEnd () {
137 //accept(cv);
138 }
139 } ;
140 cr.accept(new CheckClassAdapter(ca), true);
141 boolean failed=false;
142
143 List methods = ca.methods;
144 for (int i = 0; i < methods.size(); ++i) {
145 MethodNode method = (MethodNode)methods.get(i);
146 if (method.instructions.size() > 0) {
147 Analyzer a = new Analyzer(new SimpleVerifier());
148 try {
149 a.analyze(ca.name, method);
150 continue;
151 } catch (Exception e) {
152 e.printStackTrace();
153 }
154 final Frame[] frames = a.getFrames();
155
156 if (!failed) {
157 failed=true;
158 log("verifying of class "+clazz+" failed");
159 }
160 if (verbose) log(method.name + method.desc);
161 TraceMethodVisitor cv = new TraceMethodVisitor(null) {
162 public void visitMaxs (int maxStack, int maxLocals) {
163 StringBuffer buffer = new StringBuffer();
164 for (int i = 0; i < text.size(); ++i) {
165 String s = frames[i] == null ? "null" : frames[i].toString();
166 while (s.length() < maxStack+maxLocals+1) {
167 s += " ";
168 }
169 buffer.append(Integer.toString(i + 100000).substring(1));
170 buffer.append(" ");
171 buffer.append(s);
172 buffer.append(" : ");
173 buffer.append(text.get(i));
174 }
175 if (verbose) log(buffer.toString());
176 }
177 };
178 for (int j = 0; j < method.instructions.size(); ++j) {
179 Object insn = method.instructions.get(j);
180 if (insn instanceof AbstractInsnNode) {
181 ((AbstractInsnNode)insn).accept(cv);
182 } else {
183 cv.visitLabel((Label)insn);
184 }
185 }
186 cv.visitMaxs(method.maxStack, method.maxLocals);
187 }
188 }
189 return !failed;
190 }
191
192 }