/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common
* Development and Distribution License("CDDL") (collectively, the
* "License"). You may not use this file except in compliance with the
* License. You can obtain a copy of the License at
* http://www.netbeans.org/cddl-gplv2.html
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
* specific language governing permissions and limitations under the
* License. When distributing the software, include this License Header
* Notice in each file and include the License file at
* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the
* License Header, with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Contributor(s):
*
* The Original Software is NetBeans. The Initial Developer of the Original
* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
* Microsystems, Inc. All Rights Reserved.
*
* If you wish your version of this file to be governed by only the CDDL
* or only the GPL Version 2, indicate your decision by adding
* "[Contributor] elects to include this software in this distribution
* under the [CDDL or GPL Version 2] license." If you do not indicate a
* single choice of license, a recipient has the option to distribute
* your version of this file under either the CDDL, the GPL Version 2 or
* to extend the choice of license to its licensees as provided above.
* However, if you add GPL Version 2 code and therefore, elected the GPL
* Version 2 license, then the option applies only if the new code is
* made subject to such option by the copyright holder.
*/
package org.netbeans.modules.ruby.rubyproject;
import java.io.File;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import org.netbeans.api.ruby.platform.RubyInstallation;
import org.netbeans.api.project.Project;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;
/**
* Miscellaneous utilities for the j2seproject module.
* @author Jiri Rechtacek
*/
public class RubyProjectUtil {
private RubyProjectUtil () {}
/**
* Returns the property value evaluated by RubyProject's PropertyEvaluator.
*
* @param p project
* @param value of property
* @return evaluated value of given property or null if the property not set or
* if the project doesn't provide RakeProjectHelper
*/
public static Object getEvaluatedProperty(Project p, String value) {
if (value == null) {
return null;
}
RubyProject j2seprj = p.getLookup().lookup(RubyProject.class);
if (j2seprj != null) {
return j2seprj.evaluator().evaluate(value);
} else {
return null;
}
}
/** Check if the given file object represents a source with the main method.
*
* @param fo source
* @return true if the source contains the main method
*/
public static boolean hasMainMethod(FileObject fo) {
// support for unit testing
// if (MainClassChooser.unitTestingSupport_hasMainMethodResult != null) {
// return MainClassChooser.unitTestingSupport_hasMainMethodResult.booleanValue ();
// }
// if (fo == null) {
// // ??? maybe better should be thrown IAE
// return false;
// }
//
// boolean has = false;
// JavaModel.getJavaRepository ().beginTrans (false);
//
// try {
// JavaModel.setClassPath(fo);
// Resource res = JavaModel.getResource (fo);
// assert res != null : "Resource found for FileObject " + fo;
// has = !res.getMain().isEmpty();
// } finally {
// JavaModel.getJavaRepository ().endTrans ();
// }
// return has;
return true;
}
/** Returns list of FQN of classes contains the main method.
*
* @param roots the classpath roots of source to start find
* @return list of names of classes, e.g, [sample.project1.Hello, sample.project.app.MainApp]
*/
public static List<String> getMainClasses (FileObject[] roots) {
List<String> result = new ArrayList<String>();
for (int i=0; i<roots.length; i++) {
getMainClasses(roots[i], result);
}
return result;
}
public static void getAllScripts(String prefix, FileObject sourcesRoot, List<String> result) {
FileObject children[] = sourcesRoot.getChildren();
if (!"".equals(prefix)) {
prefix += "/";
//prefix += ".";
}
for (int i = 0; i < children.length; i++) {
if (children[i].isData()) {
if (children[i].getMIMEType().equals(RubyInstallation.RUBY_MIME_TYPE)) {
result.add(prefix + children[i].getNameExt());
}
}
if (children[i].isFolder()) {
getAllScripts(prefix + children[i].getNameExt(), children[i], result);
}
}
}
/** Returns list of FQN of classes contains the main method.
*
* @param root the root of source to start find
* @param addInto list of names of classes, e.g, [sample.project1.Hello, sample.project.app.MainApp]
*/
private static void getMainClasses (FileObject root, List<String> addInto) {
getAllScripts("", root, addInto);
// JMManager.getManager().waitScanFinished();
// JavaModel.getJavaRepository ().beginTrans (false);
// try {
// JavaModelPackage mofPackage = JavaModel.getJavaExtent(root);
// ClassIndex index = ClassIndex.getIndex (mofPackage);
// //Resource[] res = index.findResourcesForIdentifier ("main"); // NOI18N
// Collection col = index.findResourcesForIdent ("main"); // NOI18N
// Object[] arr = col.toArray ();
//
// if (arr == null) {
// // no main classes
// return;
// }
//
// for (int i = 0; i < arr.length; i++) {
// Resource res = (Resource)arr[i];
// Iterator mainIt=res.getMain().iterator();
//
// while (mainIt.hasNext()) {
// JavaClass jcls=(JavaClass)mainIt.next();
//
// addInto.add(jcls.getName());
// }
// }
// } finally {
// JavaModel.getJavaRepository ().endTrans (false);
// }
}
/** Returns if the given class name exists under the sources root and
* it's a main class.
*
* @param className FQN of class
* @param roots roots of sources
* @return true if the class name exists and it's a main class
*/
public static boolean isMainClass(String className, FileObject[] roots) {
// All classes are considered main classes in Ruby (the intent of this
// method is to return "executable classes", and all Ruby files are executable
// However, we should check that the file at least exists.
if (roots == null) {
return false;
}
for (FileObject root : roots) {
if (root.getFileObject(className) != null) {
return true;
}
}
return false;
}
/**
* Creates an URL of a classpath or sourcepath root
* For the existing directory it returns the URL obtained from {@link File#toUri()}
* For archive file it returns an URL of the root of the archive file
* For non existing directory it fixes the ending '/'
* @param root the file of a root
* @param offset a path relative to the root file or null (eg. src/ for jar:file:///lib.jar!/src/)"
* @return an URL of the root
* @throws MalformedURLException if the URL cannot be created
*/
public static URL getRootURL (File root, String offset) throws MalformedURLException {
URL url = root.toURI().toURL();
if (FileUtil.isArchiveFile(url)) {
url = FileUtil.getArchiveRoot(url);
} else if (!root.exists()) {
url = new URL(url.toExternalForm() + "/"); // NOI18N
}
if (offset != null) {
assert offset.endsWith("/"); //NOI18N
url = new URL(url.toExternalForm() + offset); // NOI18N
}
return url;
}
/**
* Gets the load path including the source and test source roots of the
* given <code>project</code>.
* @param project
* @return String represententing the load path, complete with the <code>-I</code>
* switch (i.e. can be passed as initial args to an <code>ExecutionDescriptor</code>
* as it is).
*/
public static String getLoadPath(Project project) {
RubyBaseProject baseProject = project.getLookup().lookup(RubyBaseProject.class);
assert baseProject != null : "No RubyBaseProject found in the project lookup. Project: " + project; //NOI18N
// Set the load path from the source and test folders.
// Load paths are additive so users can add their own in the
// options field as well.
FileObject[] srcPath = baseProject.getSourceRootFiles();
FileObject[] testPath = baseProject.getTestSourceRootFiles();
return asLoadPath(srcPath) + asLoadPath(testPath);
}
private static String asLoadPath(FileObject[] paths) {
StringBuilder result = new StringBuilder();
for (FileObject root : paths) {
// there might be dirs configured as source roots that
// have since been deleted
if (root == null || !root.isValid()) {
continue;
}
if (result.length() > 0) {
result.append(' ');
}
result.append("-I\""); // NOI18N
// using FO#getPath as the load path must use forward slashes even on Win
result.append(root.getPath());
result.append("\""); // NOI18N
}
return result.toString();
}
}