GLSLReferenceElement.java

/*
 *     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
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     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;

import com.intellij.psi.PsiReference;
import org.jetbrains.annotations.NotNull;

/**
 * GLSLReferenceElement acts as a proxy for getReference and getReferences of PsiElement.
 * <p/>
 * This interface is implemented for those classes which references some kind definitions
 * but also needs IntelliJ IDEA to be unaware of that fact.
 * <p/>
 * <strong>Example:</strong> <br/>
 * The GLSLIdentifier element is the element we want IDEA to query for references, but it is the
 * GLSLCallExpression, GLSLIdentifierExpression, etc... which implements the functionality.
 *
 * @author Yngve Devik Hammersland
 *         Date: Mar 1, 2009
 *         Time: 10:52:06 PM
 */
public interface GLSLReferenceElement extends GLSLElement {
    @NotNull
    PsiReference getReferenceProxy();
}