/*
 * Copyright (c) 2010, IETR/INSA of Rennes
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 *   * Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *   * Neither the name of the IETR/INSA of Rennes nor the names of its
 *     contributors may be used to endorse or promote products derived from this
 *     software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */
package net.sf.orcc.cal.util;

import static net.sf.orcc.cal.cal.CalPackage.eINSTANCE;

import java.util.List;

import net.sf.orcc.cal.cal.AnnotationArgument;
import net.sf.orcc.cal.cal.AstActor;
import net.sf.orcc.cal.cal.AstAnnotation;
import net.sf.orcc.cal.cal.AstEntity;
import net.sf.orcc.cal.cal.AstUnit;
import net.sf.orcc.cal.cal.Variable;
import net.sf.orcc.util.Attributable;
import net.sf.orcc.util.Attribute;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.Path;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.xtext.nodemodel.ICompositeNode;
import org.eclipse.xtext.nodemodel.util.NodeModelUtils;

/**
 * This class defines utility functions for the net.sf.orcc.cal plug-in.
 * 
 * @author Matthieu Wipliez
 * 
 */
public class Util {

	/**
	 * Returns the line on which the given object is defined.
	 * 
	 * @param object
	 *            an AST object
	 * @return the line on which the given object is defined
	 */
	public static int getLocation(EObject object) {
		ICompositeNode node = NodeModelUtils.getNode(object);
		if (node == null) {
			return 0;
		} else {
			return node.getStartLine();
		}
	}

	/**
	 * Returns the qualified name of the given entity as
	 * <code>package + "." + name</code>. If <code>package</code> is
	 * <code>null</code>, only the name is returned.
	 * 
	 * @param entity
	 *            an entity
	 * @return the qualified name of the given entity
	 */
	public static String getQualifiedName(AstEntity entity) {
		String packageName = entity.getPackage();
		String simpleName = entity.getName();

		String name = simpleName;
		if (packageName != null) {
			name = packageName + "." + name;
		}

		return name;
	}

	/**
	 * Returns <code>true</code> if the given annotation list contains an
	 * annotation whose name equals the given name.
	 * 
	 * @param name
	 *            a name
	 * @param annotations
	 *            a list of annotations
	 * @return <code>true</code> if the given annotation list contains an
	 *         annotation whose name equals the given name
	 */
	public static boolean hasAnnotation(String name,
			List<AstAnnotation> annotations) {
		for (AstAnnotation annotation : annotations) {
			if (name.equals(annotation.getName())) {
				return true;
			}
		}
		return false;
	}

	/**
	 * Returns <code>true</code> if the variable can be assigned a value.
	 * 
	 * @param variable
	 *            a variable
	 * @return <code>true</code> if the variable can be assigned a value
	 */
	public static boolean isAssignable(Variable variable) {
		EStructuralFeature feature = variable.eContainingFeature();
		if (variable.isConstant()) {
			return false;
		} else {
			return feature != eINSTANCE.getAstActor_Parameters()
					&& feature != eINSTANCE.getAstUnit_Variables();
		}
	}

	/**
	 * Returns <code>true</code> if the variable is global.
	 * 
	 * @param variable
	 *            a variable
	 * @return <code>true</code> if the variable is global
	 */
	public static boolean isGlobal(Variable variable) {
		EObject cter = variable.eContainer();
		return cter instanceof AstActor || cter instanceof AstUnit;
	}

	/**
	 * Transforms the AST annotations to IR.
	 * 
	 * @param eobject
	 *            an attributable object
	 * @param annotations
	 *            a list of annotations
	 */
	public static void transformAnnotations(Attributable eobject,
			List<AstAnnotation> annotations) {

		for (AstAnnotation astAnnotation : annotations) {

			String annotationName = astAnnotation.getName();

			eobject.addAttribute(annotationName);
			Attribute annotationAttribute = eobject
					.getAttribute(annotationName);

			for (AnnotationArgument arg : astAnnotation.getArguments()) {
				annotationAttribute.setAttribute(arg.getName(), arg.getValue());
			}
		}
	}

	public static IProject getProject(final EObject object) {
		final String objectPath = object.eResource().getURI()
				.toPlatformString(true);
		final IFile file = ResourcesPlugin.getWorkspace().getRoot()
				.getFile(new Path(objectPath));
		return file.getProject();
	}

	public static String getProjectName(final EObject object) {
		return getProject(object).getName();
	}
}