org.sonar.python.semantic.v2.ScopeVisitor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of python-frontend Show documentation
The newest version!
/*
 * SonarQube Python Plugin
 * Copyright (C) 2011-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * 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  02110-1301, USA.
 */
package org.sonar.python.semantic.v2;

import java.util.Deque;
import java.util.LinkedList;
import java.util.Map;
import javax.annotation.Nullable;
import org.sonar.plugins.python.api.tree.BaseTreeVisitor;
import org.sonar.plugins.python.api.tree.Tree;

public class ScopeVisitor extends BaseTreeVisitor {

  private final Map scopesByRootTree;
  private final Deque scopeRootTrees;

  public ScopeVisitor(Map scopesByRootTree) {
    this.scopesByRootTree = scopesByRootTree;
    this.scopeRootTrees = new LinkedList<>();
  }

  Tree currentScopeRootTree() {
    return scopeRootTrees.peek();
  }

  void enterScope(Tree tree) {
    scopeRootTrees.push(tree);
  }

  Tree leaveScope() {
    return scopeRootTrees.pop();
  }

  ScopeV2 currentScope() {
    return scopesByRootTree.get(currentScopeRootTree());
  }

  void createScope(Tree tree, @Nullable ScopeV2 parent) {
    scopesByRootTree.put(tree, new ScopeV2(parent, tree));
  }

  void createAndEnterScope(Tree tree, @Nullable ScopeV2 parent) {
    createScope(tree, parent);
    enterScope(tree);
  }

}