spoon.reflect.visitor.NameScopeImpl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spoon-core Show documentation

Spoon is a tool for meta-programming, analysis and transformation of Java programs.

There is a newer version: 11.1.1-beta-14

/*
 * SPDX-License-Identifier: (MIT OR CECILL-C)
 *
 * Copyright (C) 2006-2023 INRIA and contributors
 *
 * Spoon is available either under the terms of the MIT License (see LICENSE-MIT.txt) or the Cecill-C License (see LICENSE-CECILL-C.txt). You as the user are entitled to choose the terms under which to adopt Spoon.
 */
package spoon.reflect.visitor;

import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.function.Function;

import spoon.reflect.declaration.CtElement;
import spoon.reflect.declaration.CtNamedElement;
import spoon.reflect.declaration.CtParameter;

/**
 * Maps names to CtElements, which are visible at current scanning place
 */
class NameScopeImpl implements LexicalScope {

	private final LexicalScope parent;
	private final CtElement scopeElement;

	public Map getElementsByName() {
		return elementsByName;
	}

	private final Map elementsByName = new HashMap<>();

	NameScopeImpl(LexicalScope parent, CtElement scopeElement, List> parameters) {
		this(parent, scopeElement);
		for (CtParameter parameter : parameters) {
			addNamedElement(parameter);
		}
	}

	protected NameScopeImpl(LexicalScope parent, CtElement scopeElement) {
		this.parent = parent;
		this.scopeElement = scopeElement;
	}

	@Override
	public NameScopeImpl addNamedElement(CtNamedElement element) {
		elementsByName.put(element.getSimpleName(), element);
		return this;
	}

	/**
	 * @return the {@link CtElement} which represents the current scope
	 */
	@Override
	public final CtElement getScopeElement() {
		return scopeElement;
	}

	public final Optional getParent() {
		return Optional.ofNullable(parent);
	}

	/**
	 * @param name to be searched simple name
	 * @param consumer is called for each named element with same name which are accessible from this {@link NameScopeImpl}
	 * 	as long as there are some elements and consumer returns null. If `consumer` return not null value then it is returned
	 * @return the value returned by `consumer` or null
	 */
	@Override
	public  T forEachElementByName(String name, Function consumer) {
		T r = forEachByName(elementsByName, name, consumer);
		if (r != null) {
			return r;
		}
		if (scopeElement instanceof CtNamedElement) {
			CtNamedElement named = (CtNamedElement) scopeElement;
			if (name.equals(named.getSimpleName())) {
				r = consumer.apply(named);
				if (r != null) {
					return r;
				}
			}
		}
		if (parent != null) {
			return parent.forEachElementByName(name, consumer);
		}
		return null;
	}

	protected static  T forEachByName(Map map, String name, Function consumer) {
		CtNamedElement named = map.get(name);
		if (named != null) {
			return consumer.apply(named);
		}
		return null;
	}
}