/*******************************************************************************
 * Copyright (c) 2014 Bruno Medeiros and other Contributors.
 * 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:
 *     Bruno Medeiros - initial API and implementation
 *******************************************************************************/
package melnorme.lang.tooling.engine;


import static melnorme.utilbox.core.Assert.AssertNamespace.assertTrue;
import melnorme.lang.tooling.ast_actual.ElementDoc;
import melnorme.lang.tooling.engine.resolver.NamedElementSemantics;
import melnorme.lang.tooling.engine.resolver.NonValueConcreteElementSemantics;
import melnorme.lang.tooling.engine.scoping.CommonScopeLookup;
import melnorme.lang.tooling.symbols.AbstractNamedElement;
import melnorme.lang.tooling.symbols.IConcreteNamedElement;
import melnorme.lang.tooling.symbols.INamedElement;
import melnorme.utilbox.collections.ArrayList2;
import melnorme.utilbox.collections.Collection2;
import dtool.ast.definitions.EArcheType;
import dtool.engine.util.NamedElementUtil;

/**
 * An overloaded named element aggregates several elements with the same name in the same scope.
 * This can be a semantic error or not, depending on the composition of the elements.
 * For example it is usually valid for functions elements with the same name to exists.
 */
public class OverloadedNamedElement extends AbstractNamedElement implements IConcreteNamedElement {
	
	public static final String ERROR_NAME = ErrorElement.ERROR_PREFIX + "NameConflict";
	
	protected final ArrayList2<INamedElement> elements;
	protected final INamedElement firstElement;
	
	public OverloadedNamedElement(INamedElement firstElement) {
		super(firstElement.getName(), firstElement.getLexicalParent(), firstElement);
		this.firstElement = firstElement;
		this.elements = new ArrayList2<>();
		elements.add(firstElement);
	}
	
	@Override
	protected void doSetElementSemanticReady() {
		checkAreSemanticReady(elements, true);
	}
	
	/* -----------------  ----------------- */
	
	@Override
	public EArcheType getArcheType() {
		return EArcheType.Error;
	}
	
	@Override
	public String getNameInRegularNamespace() {
		return firstElement.getNameInRegularNamespace();
	}
	
	@Override
	public String getFullyQualifiedName() {
		return firstElement.getFullyQualifiedName();
	}
	
	@Override
	public String getModuleFullName() {
		return firstElement.getModuleFullName();
	}
	
	@Override
	public ElementDoc resolveDDoc() {
		return null;
	}
	
	public Collection2<INamedElement> getOverloadedElements() {
		return elements;
	}
	
	public void addElement(INamedElement newElement) {
		assertTrue(isSemanticReady() == false);
		assertTrue(newElement.getNameInRegularNamespace().equals(firstElement.getNameInRegularNamespace()));
		elements.add(newElement);
	}
	
	@Override
	public String toString() {
		StringBuilder sb = new StringBuilder();
		sb.append(ERROR_NAME);
		sb.append("[");
		
		boolean first = true;
		for (INamedElement namedElement : getOverloadedElements()) {
			if(first) {
				first = false;
			} else {
				sb.append("| ");
			}
			sb.append(NamedElementUtil.namedElementToString(namedElement));
		}
		sb.append("]");
		return sb.toString();
	}
	
	/* -----------------  ----------------- */
	
	@Override
	protected NamedElementSemantics doCreateSemantics(PickedElement<?> pickedElement) {
		return new NonValueConcreteElementSemantics(this, pickedElement) {
			
			@Override
			public void resolveSearchInMembersScope(CommonScopeLookup search) {
				// Do nothing.
			}
			
		};
	}
	
}