plugins/org.eclipse.ldt/src/org/eclipse/ldt/core/buildpath/LuaExecutionEnvironment.java

/*******************************************************************************
 * Copyright (c) 2012 Sierra Wireless and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Sierra Wireless - initial API and implementation
 *******************************************************************************/
package org.eclipse.ldt.core.buildpath;

import java.util.Map;

import org.eclipse.core.runtime.IPath;
import org.eclipse.ldt.core.internal.buildpath.LuaExecutionEnvironmentConstants;

public class LuaExecutionEnvironment implements Comparable<LuaExecutionEnvironment> {

	public static final String DEFAULT_TEMPLATE = "default"; //$NON-NLS-1$
	public static final String TEMPLATE_BUILDPATH = "buildpath"; //$NON-NLS-1$
	public static final Object OPEN_FILE = "openfile"; //$NON-NLS-1$

	private final String id;
	private final String version;
	private final IPath path;
	private final IPath oldTemplate;
	private final IPath templates;
	private final String luaGrammar;
	private boolean embedded;
	private Map<?, ?> templatesInfo;

	public LuaExecutionEnvironment(final String identifier, final String eeversion, final Map<?, ?> templatesInfo, final IPath pathToEE,
			final String grammar) {
		id = identifier;
		version = eeversion;
		path = pathToEE;
		embedded = false;
		luaGrammar = grammar;
		this.templatesInfo = templatesInfo;

		// Old template folder (supported for legacy only)
		IPath oldTemplatePath = null;
		if (pathToEE != null)
			oldTemplatePath = pathToEE.append(LuaExecutionEnvironmentConstants.EE_OLDTEMPLATE_FOLDER);
		if (oldTemplatePath != null && oldTemplatePath.toFile().exists())
			oldTemplate = oldTemplatePath;
		else
			oldTemplate = null;

		// New templates folder (allow multiple templates)
		IPath templatesPath = null;
		if (pathToEE != null)
			templatesPath = pathToEE.append(LuaExecutionEnvironmentConstants.EE_TEMPLATE_FOLDER);
		if (templatesPath != null && templatesPath.toFile().exists())
			templates = templatesPath;
		else
			templates = null;
	}

	public void setEmbedded(final boolean embeddedEE) {
		this.embedded = embeddedEE;
	}

	public boolean isEmbedded() {
		return embedded;
	}

	public String getID() {
		return id;
	}

	public String getVersion() {
		return version;
	}

	public IPath getPath() {
		return path;
	}

	public IPath[] getSourcepath() {
		if (path != null && path.toFile().exists()) {
			final IPath sourcePath = path.append(LuaExecutionEnvironmentConstants.EE_FILE_API_ARCHIVE);
			if (sourcePath.toFile().exists()) {
				return new IPath[] { sourcePath };
			}
		}
		return new IPath[0];
	}

	public IPath[] getDocumentationPath() {
		if (path != null && path.toFile().exists()) {
			final IPath sourcePath = path.append(LuaExecutionEnvironmentConstants.EE_FILE_DOCS_FOLDER);
			if (sourcePath.toFile().exists()) {
				return new IPath[] { sourcePath };
			}
		}
		return new IPath[0];
	}

	public String getEEIdentifier() {
		return getID() + '-' + getVersion();
	}

	@Override
	public String toString() {
		return getEEIdentifier();
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((id == null) ? 0 : id.hashCode());
		result = prime * result + ((version == null) ? 0 : version.hashCode());
		return result;
	}

	@Override
	public boolean equals(final Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
		final LuaExecutionEnvironment other = (LuaExecutionEnvironment) obj;
		if (id == null) {
			if (other.id != null)
				return false;
		} else if (!id.equals(other.id))
			return false;
		if (version == null) {
			if (other.version != null)
				return false;
		} else if (!version.equals(other.version))
			return false;
		return true;
	}

	@Override
	public int compareTo(final LuaExecutionEnvironment ee) {
		return getEEIdentifier().compareTo(ee.getEEIdentifier());
	}

	public IPath getOldTemplatePath() {
		return oldTemplate;
	}

	public IPath getTemplatesPath() {
		return templates;
	}

	public Map<?, ?> getDefaultTemplateInfo() {
		if (templatesInfo != null) {
			Object defaultTemplate = templatesInfo.get(DEFAULT_TEMPLATE);
			if (defaultTemplate instanceof Map && !((Map<?, ?>) defaultTemplate).isEmpty()) {
				return (Map<?, ?>) defaultTemplate;
			}
		}
		return null;
	}

	public IPath getDefaultTemplatePath() {
		final IPath templatesPath = this.getTemplatesPath();
		if (templatesPath == null)
			return null;
		return templatesPath.append(LuaExecutionEnvironment.DEFAULT_TEMPLATE);
	}

	public String getLuaGrammar() {
		return luaGrammar;
	}
}