/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* 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. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun 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.scala.project;
import java.io.File;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Map.Entry;
import org.netbeans.api.java.classpath.ClassPath;
import org.netbeans.api.java.platform.JavaPlatform;
import org.netbeans.api.java.platform.JavaPlatformManager;
import org.netbeans.api.java.source.ClasspathInfo;
import org.netbeans.api.scala.platform.ScalaPlatform;
import org.netbeans.api.scala.platform.ScalaPlatformManager;
import org.netbeans.api.scala.platform.Specification;
import org.netbeans.api.project.Project;
import org.netbeans.modules.scala.project.ui.customizer.J2SEProjectProperties;
import org.netbeans.modules.scala.project.ui.customizer.MainClassChooser;
import org.netbeans.spi.project.support.ant.GeneratedFilesHelper;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;
import org.netbeans.api.language.util.ast.AstDfn;
import org.netbeans.modules.scala.core.ScalaSourceUtil;
/**
* Miscellaneous utilities for the j2seproject module.
* @author Jiri Rechtacek
*/
public class J2SEProjectUtil {
private J2SEProjectUtil () {}
/**
* Returns the property value evaluated by J2SEProject'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 AntProjectHelper
*/
public static Object getEvaluatedProperty(Project p, String value) {
if (value == null) {
return null;
}
J2SEProject j2seprj = (J2SEProject) p.getLookup().lookup(J2SEProject.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;
}
return true;//!SourceUtils.getMainClasses(fo).isEmpty();
}
/** @Todo should rename to getMainClasses */
public static Collection<AstDfn> getMainMethods (final FileObject fo) {
// support for unit testing
if (fo == null || MainClassChooser.unitTestingSupport_hasMainMethodResult != null) {
return Collections.<AstDfn>emptySet();
}
return ScalaSourceUtil.getMainClassesAsJavaCollection(fo);
}
public static boolean isMainClass (final String className, ClassPath bootPath, ClassPath compilePath, ClassPath sourcePath) {
ClasspathInfo cpInfo = ClasspathInfo.create(bootPath, compilePath, sourcePath);
/** @Todo */
return true;
//return SourceUtils.isMainClass(className, cpInfo);
}
/**
* 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;
}
/**
* Returns the active platform used by the project or null if the active
* project platform is broken.
* @param activePlatformId the name of platform used by Ant script or null
* for default platform.
* @return active {@link ScalaPlatform} or null if the project's platform
* is broken
*/
public static ScalaPlatform getActivePlatform (final String activePlatformId) {
final ScalaPlatformManager pm = ScalaPlatformManager.getDefault();
if (activePlatformId == null) {
return pm.getDefaultPlatform();
}
else {
ScalaPlatform[] installedPlatforms = pm.getPlatforms(null, new Specification ("std",null)); //NOI18N
for (int i=0; i<installedPlatforms.length; i++) {
String antName = (String) installedPlatforms[i].getProperties().get("scala.platform.ant.name"); //NOI18N
if (antName != null && antName.equals(activePlatformId)) {
return installedPlatforms[i];
}
}
return null;
}
}
/**
* Returns the active platform used by the project or null if the active
* project platform is broken.
* @param activePlatformId the name of platform used by Ant script or null
* for default platform.
* @return active {@link JavaPlatform} or null if the project's platform
* is broken
*/
public static JavaPlatform getJavaActivePlatform (final String activePlatformId) {
final JavaPlatformManager pm = JavaPlatformManager.getDefault();
if (activePlatformId == null) {
return pm.getDefaultPlatform();
}
else {
JavaPlatform[] installedPlatforms = pm.getPlatforms(null, new org.netbeans.api.java.platform.Specification ("j2se",null)); //NOI18N
for (JavaPlatform p : installedPlatforms) {
String antName = p.getProperties().get("platform.ant.name"); // NOI18N
if (antName != null && antName.equals(activePlatformId)) {
return p;
}
}
return null;
}
}
public static String getBuildXmlName (final J2SEProject project) {
assert project != null;
String buildScriptPath = project.evaluator().getProperty(J2SEProjectProperties.BUILD_SCRIPT);
if (buildScriptPath == null) {
buildScriptPath = GeneratedFilesHelper.BUILD_XML_PATH;
}
return buildScriptPath;
}
public static FileObject getBuildXml (final J2SEProject project) {
return project.getProjectDirectory().getFileObject (getBuildXmlName(project));
}
public static boolean isCompileOnSaveSupported(final J2SEProject project) {
for (Entry<String, String> e :project.evaluator().getProperties().entrySet()) {
if (e.getKey().startsWith(J2SEProjectProperties.COMPILE_ON_SAVE_UNSUPPORTED_PREFIX)) {
if (e.getValue() != null && Boolean.valueOf(e.getValue())) {
return false;
}
}
}
return true;
}
public static boolean isCompileOnSaveEnabled(final J2SEProject project) {
String compileOnSaveProperty = project.evaluator().getProperty(J2SEProjectProperties.COMPILE_ON_SAVE);
return (compileOnSaveProperty != null && Boolean.valueOf(compileOnSaveProperty)) && J2SEProjectUtil.isCompileOnSaveSupported(project);
}
}