*     Copyright 2010 Jean-Paul Balabanian and Yngve Devik Hammersland
 *     This file is part of glsl4idea.
 *     Glsl4idea is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU Lesser General Public License as
 *     published by the Free Software Foundation, either version 3 of
 *     the License, or (at your option) any later version.
 *     Glsl4idea is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     GNU Lesser General Public License for more details.
 *     You should have received a copy of the GNU General Public License
 *     along with glsl4idea.  If not, see <http://www.gnu.org/licenses/>.

package glslplugin.lang.elements.reference;

import com.intellij.openapi.util.TextRange;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiNamedElement;
import com.intellij.psi.PsiReference;
import com.intellij.psi.ResolveState;
import com.intellij.psi.util.PsiTreeUtil;
import com.intellij.util.IncorrectOperationException;
import glslplugin.lang.elements.GLSLElement;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

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

 * Base for inter-element references.
 * @author Yngve Devik Hammersland
 *         Date: Feb 4, 2009
 *         Time: 1:29:50 AM
public abstract class GLSLReferenceBase<SOURCE_TYPE extends GLSLElement, TARGET_TYPE extends GLSLElement> implements PsiReference {
    protected SOURCE_TYPE source;

    public GLSLReferenceBase(SOURCE_TYPE source) {
        this.source = source;

    public SOURCE_TYPE getElement() {
        return source;

    public TextRange getRangeInElement() {
        return new TextRange(0, source == null ? 0 : source.getTextLength());

    public abstract TARGET_TYPE resolve();

    public String getCanonicalText() {
        final TARGET_TYPE resolve = resolve();
        if (resolve == null) {
            return source.getText();
        } else {
            return resolve.getText();

    public PsiElement handleElementRename(@NotNull String newElementName) throws IncorrectOperationException {
        if (source == null) throw new IncorrectOperationException("Reference is invalid");
        if (source instanceof PsiNamedElement) {
            return ((PsiNamedElement) source).setName(newElementName);
        return resolve();

    public PsiElement bindToElement(@NotNull PsiElement element) throws IncorrectOperationException {
        throw new IncorrectOperationException("Not supported");

    public boolean isReferenceTo(@Nullable PsiElement element) {
        return element != null && element == resolve();

    public Object[] getVariants() {
        List<PsiNamedElement> elements = new ArrayList<>();
        NamedElementCollector collector = new NamedElementCollector(elements);
        PsiTreeUtil.treeWalkUp(collector, source, null, ResolveState.initial());
        return elements.toArray();

    public boolean isSoft() {
        // TODO: Not quite sure about this one. Investigate!
        return false;