001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.nbbuild;
043:
044: import java.io.File;
045: import java.io.FileInputStream;
046: import java.io.FileOutputStream;
047: import java.io.IOException;
048: import java.lang.reflect.Method;
049: import java.util.ArrayList;
050: import java.util.HashMap;
051: import java.util.List;
052: import java.util.Map;
053: import org.apache.tools.ant.*;
054: import org.apache.tools.ant.types.*;
055:
056: /**
057: * @author Jaroslav Tulach
058: */
059: public class NbEnhanceClass extends Task {
060:
061: /* Path to library containing the patch method */
062: private Path patchPath;
063:
064: public Path createClasspath() {
065: if (patchPath == null) {
066: patchPath = new Path(getProject());
067: }
068: return patchPath.createPath();
069: }
070:
071: /* Name of class with patch method */
072: private String patchClass = "org.netbeans.PatchByteCode";
073:
074: public void setPatchClass(String f) {
075: patchClass = f;
076: }
077:
078: /** Name of the method to call. Must have signature byte[] x(byte[], Map)
079: */
080: private String enhanceMethod = "enhanceClass";
081:
082: public void setEnhanceMethod(String f) {
083: enhanceMethod = f;
084: }
085:
086: /* Base dir to find classes relative to */
087: private File basedir;
088:
089: public void setBasedir(File f) {
090: basedir = f;
091: }
092:
093: /* The class to change its super class and the value of the super class.
094: */
095: public static class Patch {
096: String clazz;
097: String nbSuperClass;
098: String nbImplements;
099: List<Member> members;
100:
101: /** Class in form of java/lang/Object */
102: public void setClass(String s) {
103: clazz = s;
104: }
105:
106: /** Class in form of java/lang/Object */
107: public void setSuper(String s) {
108: nbSuperClass = s;
109: }
110:
111: public void setImplements(String s) {
112: nbImplements = s;
113: }
114:
115: public Object createMember() {
116: Member m = new Member();
117: if (members == null) {
118: members = new ArrayList<Member>();
119: }
120: members.add(m);
121: return m;
122: }
123:
124: public static final class Member extends Object {
125: String name;
126: String rename;
127:
128: public void setName(String s) {
129: name = s;
130: }
131:
132: public void setRename(String s) {
133: rename = s;
134: }
135: }
136: }
137:
138: private List<Patch> patches = new ArrayList<Patch>();
139:
140: public Patch createPatch() {
141: Patch n = new Patch();
142: patches.add(n);
143: return n;
144: }
145:
146: public void execute() throws BuildException {
147: if (basedir == null) {
148: throw new BuildException(
149: "Attribute basedir must be specified");
150: }
151:
152: if (patches.isEmpty()) {
153: // no work
154: return;
155: }
156:
157: //
158: // Initialize the method
159: //
160:
161: ClassLoader cl = new AntClassLoader(getProject(), patchPath,
162: false);
163:
164: Method m;
165: try {
166: Class<?> c = cl.loadClass(patchClass);
167: m = c.getMethod(enhanceMethod, byte[].class, Map.class);
168: if (m.getReturnType() != byte[].class) {
169: throw new BuildException(
170: "Method does not return byte[]: " + m);
171: }
172: } catch (Exception ex) {
173: throw new BuildException("Cannot initialize class "
174: + patchClass + " and method " + enhanceMethod, ex);
175: }
176:
177: /*
178: try {
179: log ("Testing method " + m);
180: byte[] res = (byte[])m.invoke (null, new Object[] { new byte[0], "someString" });
181: } catch (Exception ex) {
182: throw new BuildException ("Exception during test invocation of the method", ex);
183: }
184: */
185:
186: //
187: // Ok we have the method and we can do the patching
188: //
189: for (Patch p : patches) {
190: if (p.clazz == null) {
191: throw new BuildException(
192: "Attribute class must be specified");
193: }
194:
195: File f = new File(basedir, p.clazz + ".class");
196: if (!f.exists()) {
197: throw new BuildException("File " + f + " for class "
198: + p.clazz + " does not exists");
199: }
200:
201: byte[] arr = new byte[(int) f.length()];
202: try {
203: FileInputStream is = new FileInputStream(f);
204: if (arr.length != is.read(arr)) {
205: throw new BuildException("Not all bytes read");
206: }
207: is.close();
208: } catch (IOException ex) {
209: throw new BuildException("Cannot read file " + f, ex);
210: }
211:
212: List<String> members = null;
213: List<String> rename = null;
214: if (p.members != null) {
215: members = new ArrayList<String>();
216: for (Patch.Member mem : p.members) {
217: members.add(mem.name);
218:
219: if (mem.rename != null) {
220: if (rename == null) {
221: rename = new ArrayList<String>();
222: }
223: rename.add(mem.name);
224: rename.add(mem.rename);
225: }
226: }
227: }
228:
229: byte[] out;
230: try {
231: Map<String, Object> args = new HashMap<String, Object>();
232: if (p.nbSuperClass != null) {
233: args.put("netbeans.superclass", p.nbSuperClass);
234: }
235: if (p.nbImplements != null) {
236: args.put("netbeans.interfaces", p.nbImplements);
237: }
238: if (members != null) {
239: args.put("netbeans.public", members);
240: }
241: if (rename != null) {
242: args.put("netbeans.rename", rename);
243: }
244:
245: log("Patching " + p.clazz + " with arguments " + args,
246: Project.MSG_VERBOSE);
247:
248: out = (byte[]) m.invoke(null, arr, args);
249: if (out == null) {
250: // no patching needed
251: continue;
252: }
253: } catch (Exception ex) {
254: throw new BuildException(ex);
255: }
256:
257: if (p.nbSuperClass != null) {
258: log("Enhanced " + f + " to have alternate superclass "
259: + p.nbSuperClass + " and be public");
260: } else {
261: log("Enhanced " + f + " to be public");
262: }
263:
264: try {
265: FileOutputStream os = new FileOutputStream(f);
266: os.write(out);
267: os.close();
268: } catch (IOException ex) {
269: throw new BuildException("Cannot overwrite file " + f,
270: ex);
271: }
272: }
273: }
274:
275: }
|