org.sonar.javascript.ast.resolve.Symbol Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javascript-squid Show documentation
The newest version!
/*
 * SonarQube JavaScript Plugin
 * Copyright (C) 2011 SonarSource and Eriks Nukis
 * [email protected]
 *
 * This program 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.
 *
 * This program 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 Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonar.javascript.ast.resolve;

import com.google.common.collect.Lists;
import org.sonar.javascript.model.implementations.lexical.InternalSyntaxToken;
import org.sonar.javascript.model.interfaces.expression.IdentifierTree;

import javax.annotation.Nullable;
import java.util.List;

public class Symbol {

  public enum Kind {
    VARIABLE("variable"),
    FUNCTION("function"),
    PARAMETER("parameter"),
    CLASS("class");

    private Kind(String value) {
      this.value = value;
    }
    private final String value;
    public String getValue() {
      return value;
    }
  }

  private final String name;
  private List declarations = Lists.newArrayList();
  private Kind kind;
  private boolean buildIn;

  public Symbol(String name, SymbolDeclaration declaration, Kind kind) {
    this.name = name;
    this.kind = kind;
    this.declarations.add(declaration);
    this.buildIn = false;
  }

  public Symbol(String name, SymbolDeclaration declaration, Kind kind, boolean buildIn) {
    this.name = name;
    this.kind = kind;
    this.declarations.add(declaration);
    this.buildIn = buildIn;
  }

  public String name() {
    return name;
  }

  @Nullable
  public InternalSyntaxToken getSymbolNameToken() {
    SymbolDeclaration firstDeclaration = getFirstDeclaration();
    if (firstDeclaration.is(SymbolDeclaration.Kind.BUILD_IN)){
      return null;
    } else {
      return (InternalSyntaxToken) ((IdentifierTree) firstDeclaration.tree()).identifierToken();
    }
  }

  public Kind kind() {
    return kind;
  }

  public boolean buildIn() {
    return buildIn;
  }

  public boolean is(Symbol.Kind kind) {
    return kind.equals(this.kind);
  }

  public List declarations() {
    return declarations;
  }

  public SymbolDeclaration getFirstDeclaration() {
    return declarations.get(0);
  }

}