001: /* ====================================================================
002: * The JRefactory License, Version 1.0
003: *
004: * Copyright (c) 2001 JRefactory. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by the
021: * JRefactory (http://www.sourceforge.org/projects/jrefactory)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. The names "JRefactory" must not be used to endorse or promote
026: * products derived from this software without prior written
027: * permission. For written permission, please contact seguin@acm.org.
028: *
029: * 5. Products derived from this software may not be called "JRefactory",
030: * nor may "JRefactory" appear in their name, without prior written
031: * permission of Chris Seguin.
032: *
033: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
034: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
035: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
036: * DISCLAIMED. IN NO EVENT SHALL THE CHRIS SEGUIN OR
037: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
038: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
039: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
040: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
041: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
042: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
043: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
044: * SUCH DAMAGE.
045: * ====================================================================
046: *
047: * This software consists of voluntary contributions made by many
048: * individuals on behalf of JRefactory. For more information on
049: * JRefactory, please see
050: * <http://www.sourceforge.org/projects/jrefactory>.
051: */
052: package org.acm.seguin.summary;
053:
054: import java.io.File;
055: import java.io.IOException;
056: import java.util.Iterator;
057: import java.util.StringTokenizer;
058: import org.acm.seguin.io.DirectoryTreeTraversal;
059: import org.acm.seguin.summary.load.LoadStatus;
060: import org.acm.seguin.summary.load.SwingLoadStatus;
061: import org.acm.seguin.util.FileSettings;
062: import org.acm.seguin.util.MissingSettingsException;
063:
064: /**
065: * Summarizes a directory structure
066: *
067: *@author Chris Seguin
068: *@author Mike Atkinson
069: *@created June 6, 1999
070: */
071: public class SummaryTraversal extends DirectoryTreeTraversal {
072: private String root;
073: private String blockDirectories;
074: private LoadStatus status;
075: private static FrameworkLoader framework = null;
076: private boolean useFramework;
077:
078: /**
079: * Traverses a directory tree structure and generates a summary of the
080: * classes.
081: *
082: *@param init the initial directory
083: */
084: public SummaryTraversal(String init) {
085: this (init, null, true);
086: }
087:
088: /**
089: * Traverses a directory tree structure and generates a summary of the
090: * classes.
091: *
092: *@param init the initial directory
093: *@param initStatus Description of Parameter
094: */
095:
096: public SummaryTraversal(String init, LoadStatus initStatus) {
097: this (init, initStatus, true);
098: }
099:
100: /**
101: * Traverses a directory tree structure and generates a summary of the
102: * classes.
103: *
104: *@param init the initial directory
105: *@param initStatus Description of Parameter
106: *@param useFramework use the framework (i.e. load JDK stubs)
107: */
108: public SummaryTraversal(String init, LoadStatus initStatus,
109: boolean useFramework) {
110: super (init);
111: root = init;
112: status = initStatus;
113: if (status == null) {
114: status = new SwingLoadStatus();
115: }
116: this .useFramework = useFramework;
117: if (useFramework) {
118: if (framework == null) {
119: framework = new FrameworkFileSummaryLoader(status);
120: }
121: }
122:
123: try {
124: FileSettings umlBundle = FileSettings
125: .getRefactorySettings("uml");
126: umlBundle.setContinuallyReload(true);
127: blockDirectories = umlBundle.getString("skip.dir");
128: if (blockDirectories == null) {
129: blockDirectories = "";
130: } else {
131: blockDirectories = blockDirectories.trim();
132: if (blockDirectories == null) {
133: blockDirectories = "";
134: }
135: }
136: } catch (MissingSettingsException mse) {
137: blockDirectories = "";
138: }
139: }
140:
141: /**
142: * Method that starts the traversal to generate the summaries.
143: */
144: public void run() {
145: //System.out.println("SummaryTraversal.run() thread="+Thread.currentThread());
146: if (useFramework) {
147: framework.run();
148: }
149:
150: File temp = new File(root);
151: String dir = null;
152: try {
153: dir = temp.getCanonicalPath();
154: } catch (IOException ioe) {
155: dir = temp.getPath();
156: }
157:
158: status.setRoot(dir);
159: FileSummary.removeDeletedSummaries();
160: super .run();
161: status.done();
162: }
163:
164: /**
165: * Determines if this file should be handled by this traversal
166: *
167: *@param currentFile the current file
168: *@return true if the file should be handled
169: */
170: protected boolean isTarget(File currentFile) {
171: String name = currentFile.getName();
172: int dot = name.indexOf(".");
173: int java = name.indexOf(".java");
174:
175: return (dot == java) && name.endsWith(".java");
176: }
177:
178: /**
179: * Are we allowed to traverse this directory?
180: *
181: *@param currentDirectory the directory that we are about to enter
182: *@return true if we are allowed to enter it
183: */
184: protected boolean isAllowed(File currentDirectory) {
185: if ((blockDirectories == null)
186: || (blockDirectories.length() == 0)) {
187: return true;
188: }
189:
190: StringTokenizer tok = new StringTokenizer(blockDirectories,
191: File.pathSeparator);
192: while (tok.hasMoreTokens()) {
193: String next = tok.nextToken();
194: if (currentDirectory.getName().indexOf(next) >= 0) {
195: return false;
196: }
197: }
198:
199: return true;
200: }
201:
202: /**
203: * Visits the current file
204: *
205: *@param currentFile the current file
206: */
207: protected void visit(File currentFile) {
208: try {
209: status.setCurrentFile(currentFile.getPath());
210: FileSummary.getFileSummary(currentFile);
211:
212: Thread.currentThread().yield();
213: } catch (Throwable oops) {
214: try {
215: System.out.println("\nError loading: "
216: + currentFile.getCanonicalPath());
217: } catch (Exception e) {
218: System.out.println("\nError loading: "
219: + currentFile.getName());
220: }
221: oops.printStackTrace(System.out);
222: }
223: }
224:
225: /**
226: * Sets the framework loader
227: *
228: *@param value The new FrameworkLoader value
229: */
230: public static void setFrameworkLoader(FrameworkLoader value) {
231: framework = value;
232: }
233:
234: /**
235: * Main program
236: *
237: *@param args the command line arguments
238: */
239: public static void main(String[] args) {
240: if (args.length == 0) {
241: (new SummaryTraversal(System.getProperty("user.dir")))
242: .run();
243: } else {
244: (new SummaryTraversal(args[0])).run();
245: }
246:
247: debug();
248: System.exit(0);
249: }
250:
251: /**
252: * Print everything for debugging purposes
253: */
254: public static void debug() {
255: // Now print everything
256: PrintVisitor printer = new PrintVisitor();
257: Iterator iter = PackageSummary.getAllPackages();
258: while (iter.hasNext()) {
259: PackageSummary next = (PackageSummary) iter.next();
260: next.accept(printer, "");
261: }
262: }
263: }
|