org.eclipse.osbp.ecview.dsl/src/org/eclipse/osbp/ecview/dsl/scope/RawBindablePathRawBindableScope.java

/**
 * Copyright (c) 2011, 2015 - Lunifera GmbH (Gross Enzersdorf, Austria), Loetz GmbH&Co.KG (69115 Heidelberg, Germany)
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0 
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *         Florian Pirchner - Initial implementation
 */

package org.eclipse.osbp.ecview.dsl.scope;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import org.eclipse.emf.ecore.EObject;
import org.eclipse.xtext.naming.IQualifiedNameProvider;
import org.eclipse.xtext.resource.EObjectDescription;
import org.eclipse.xtext.resource.IEObjectDescription;
import org.eclipse.xtext.scoping.IScope;
import org.eclipse.xtext.scoping.impl.AbstractScope;
import org.eclipse.osbp.ecview.semantic.uimodel.UiRawBindable;
import org.eclipse.osbp.ecview.semantic.uimodel.UiRawBindablePathSegment;
import org.eclipse.osbp.ecview.semantic.uimodel.UiRawBindableProvider;
import org.eclipse.osbp.ecview.semantic.uimodel.UiTypedBindableDef;
import org.eclipse.osbp.ecview.semantic.uimodel.UiTypedBindableRawType;
import org.eclipse.osbp.ecview.semantic.uimodel.UiView;

// TODO: Auto-generated Javadoc
/**
 * The Class RawBindablePathRawBindableScope.
 */
public class RawBindablePathRawBindableScope extends AbstractScope {

	/** The context. */
	private EObject context;
	
	/** The name provider. */
	@SuppressWarnings("unused")
	private IQualifiedNameProvider nameProvider;

	/**
	 * Instantiates a new raw bindable path raw bindable scope.
	 *
	 * @param context
	 *            the context
	 * @param nameProvider
	 *            the name provider
	 */
	protected RawBindablePathRawBindableScope(EObject context,
			IQualifiedNameProvider nameProvider) {
		super(IScope.NULLSCOPE, true);
		this.context = context;
		this.nameProvider = nameProvider;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.xtext.scoping.impl.AbstractScope#getAllLocalElements()
	 */
	@Override
	protected Iterable<IEObjectDescription> getAllLocalElements() {
		if (context instanceof UiRawBindablePathSegment) {
			UiRawBindablePathSegment pathSegment = (UiRawBindablePathSegment) context;

			EObject expected = null;
			EObject parent = context.eContainer();
			if (parent instanceof UiTypedBindableDef) {
				expected = ((UiTypedBindableDef) parent).getRawBindable();
			} else if (parent instanceof UiRawBindablePathSegment) {
				expected = ((UiRawBindablePathSegment) parent).getRawBindable();
			} else if (parent instanceof UiTypedBindableRawType) {
				expected = ((UiTypedBindableRawType) parent).getRawBindable();
			}

			List<IEObjectDescription> result = null;
			if (!pathSegment.isToParent()) {
				result = collectRawBindables(expected);
			} else if (expected != null) {
				result = new ArrayList<IEObjectDescription>(1);
				IEObjectDescription bindableResult = findValidRawBindableInParent(expected.eContainer());
				if (bindableResult != null) {
					result.add(bindableResult);
				}
			}
			return result;
		}

		return Collections.emptyList();
	}

	/**
	 * Iterate the eContainers() up to root to find a raw bindable.
	 *
	 * @param expected
	 *            the expected
	 * @return the IE object description
	 */
	private IEObjectDescription findValidRawBindableInParent(EObject expected) {

		UiRawBindable result = findInParent(expected);
		if (result != null) {
			return EObjectDescription.create(
					((UiRawBindable) result).getName(), result);
		} else {
			return null;
		}

	}

	/**
	 * Find in parent.
	 *
	 * @param expected
	 *            the expected
	 * @return the ui raw bindable
	 */
	private UiRawBindable findInParent(EObject expected) {
		if (expected == null) {
			return null;
		}

		if (expected instanceof UiRawBindable
				&& isValid(((UiRawBindable) expected).getName())) {
			return (UiRawBindable) expected;
		}

		return findInParent(expected.eContainer());
	}

	/**
	 * Iterate the structure down to find raw bindables.
	 *
	 * @param container
	 *            the container
	 * @return the list
	 */
	protected List<IEObjectDescription> collectRawBindables(EObject container) {
		List<IEObjectDescription> result = new ArrayList<IEObjectDescription>();
		for (EObject object : container.eContents()) {
			if (object instanceof UiRawBindable) {
				if (isValid(((UiRawBindable) object).getName())) {
					result.add(EObjectDescription.create(
							((UiRawBindable) object).getName(), object));
				} else {
					// direct children may be of type UiRawBindable
					result.addAll(collectRawBindables(object));
				}
			} else if (object instanceof UiRawBindableProvider) {
				// direct children may be of type UiRawBindable
				result.addAll(collectRawBindables(object));
			}
		}
		return result;
	}

	/**
	 * Collect raw bindables.
	 *
	 * @param def
	 *            the def
	 * @return the list
	 */
	protected List<IEObjectDescription> collectRawBindables(
			UiTypedBindableDef def) {
		EObject rawBindableParent = findRawBindableParent(def);
		if (rawBindableParent == null) {
			rawBindableParent = findView(def);
		}
		List<IEObjectDescription> result = collectRawBindables(rawBindableParent);
		return result;
	}

	/**
	 * Checks if is valid.
	 *
	 * @param value
	 *            the value
	 * @return true, if is valid
	 */
	private boolean isValid(String value) {
		return value != null && !value.equals("");
	}

	/**
	 * Find raw bindable parent.
	 *
	 * @param eObject
	 *            the e object
	 * @return the ui raw bindable
	 */
	private UiRawBindable findRawBindableParent(EObject eObject) {
		UiRawBindable result = null;
		while (eObject != null && eObject.eContainer() != null) {
			if (eObject instanceof UiRawBindable) {
				result = (UiRawBindable) eObject;
				break;
			}
			eObject = eObject.eContainer();
		}
		return result;
	}

	/**
	 * Find view.
	 *
	 * @param def
	 *            the def
	 * @return the ui view
	 */
	private UiView findView(EObject def) {
		UiView result = null;
		while (def.eContainer() != null) {
			def = def.eContainer();
			if (def instanceof UiView) {
				result = (UiView) def;
				break;
			}
		}
		return result;
	}
}