org.sonar.python.tree.IPythonTreeMaker 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 Sonar Source-Available License Version 1, as published by SonarSource SA.
 *
 * 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 Sonar Source-Available License for more details.
 *
 * You should have received a copy of the Sonar Source-Available License
 * along with this program; if not, see https://sonarsource.com/license/ssal/
 */
package org.sonar.python.tree;

import com.sonar.sslr.api.AstNode;
import com.sonar.sslr.api.GenericTokenType;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.annotation.Nullable;
import org.sonar.plugins.python.api.tree.CellMagicStatement;
import org.sonar.plugins.python.api.tree.DynamicObjectInfoStatement;
import org.sonar.plugins.python.api.tree.Expression;
import org.sonar.plugins.python.api.tree.ExpressionStatement;
import org.sonar.plugins.python.api.tree.FileInput;
import org.sonar.plugins.python.api.tree.LineMagic;
import org.sonar.plugins.python.api.tree.Statement;
import org.sonar.plugins.python.api.tree.StatementList;
import org.sonar.plugins.python.api.tree.Token;
import org.sonar.plugins.python.api.tree.Tree;
import org.sonar.python.DocstringExtractor;
import org.sonar.python.IPythonLocation;
import org.sonar.python.api.IPythonGrammar;

public class IPythonTreeMaker extends PythonTreeMaker {

  private Map offsetMap;

  public IPythonTreeMaker() {
    this(Map.of());
  }
  public IPythonTreeMaker(Map offsetMap) {
    this.offsetMap = offsetMap;
  }

  @Override
  protected Token toPyToken(@Nullable com.sonar.sslr.api.Token token) {
    if (token == null) {
      return null;
    }
    if (this.offsetMap != null && !this.offsetMap.isEmpty()) {
      return TokenEnricher.enrichToken(token, offsetMap);
    }
    return new TokenImpl(token);
  }

  @Override
  public FileInput fileInput(AstNode astNode) {
    StatementList statementList = astNode.getChildren(IPythonGrammar.CELL, IPythonGrammar.MAGIC_CELL)
      .stream()
      .flatMap(this::getStatementsFromCell)
      .collect(Collectors.collectingAndThen(Collectors.toList(), l -> l.isEmpty() ? null : new StatementListImpl(l)));
    Token endOfFile = toPyToken(astNode.getFirstChild(GenericTokenType.EOF).getToken());
    FileInputImpl pyFileInputTree = new FileInputImpl(statementList, endOfFile, DocstringExtractor.extractDocstring(statementList));
    setParents(pyFileInputTree);
    pyFileInputTree.accept(new ExceptGroupJumpInstructionsCheck());
    return pyFileInputTree;
  }

  private Stream getStatementsFromCell(AstNode cell) {
    if (cell.is(IPythonGrammar.CELL)) {
      return getStatements(cell).stream().map(this::statement);
    } else {
      return Stream.of(cell.getFirstChild(IPythonGrammar.CELL_MAGIC_STATEMENT)).map(this::cellMagicStatement);
    }
  }

  @Override
  protected Statement statement(StatementWithSeparator statementWithSeparator) {
    var astNode = statementWithSeparator.statement();

    if (astNode.is(IPythonGrammar.LINE_MAGIC_STATEMENT)) {
      return lineMagicStatement(astNode);
    }
    if (astNode.is(IPythonGrammar.DYNAMIC_OBJECT_INFO_STATEMENT)) {
      return dynamicObjectInfoStatement(astNode);
    }
    return super.statement(statementWithSeparator);
  }

  @Override
  protected Expression annotatedRhs(AstNode annotatedRhs) {
    var child = annotatedRhs.getFirstChild();
    if (child.is(IPythonGrammar.LINE_MAGIC)) {
      return lineMagic(child);
    }
    return super.annotatedRhs(annotatedRhs);
  }

  private  CellMagicStatement cellMagicStatement(AstNode astNode) {
    var tokens = astNode.getChildren()
      .stream()
      .map(AstNode::getTokens)
      .flatMap(Collection::stream)
      .map(this::toPyToken)
      .toList();
    return new CellMagicStatementImpl(tokens);
  }

  protected ExpressionStatement lineMagicStatement(AstNode astNode) {
    var lineMagic = lineMagic(astNode.getFirstChild(IPythonGrammar.LINE_MAGIC));
    return new ExpressionStatementImpl(List.of(lineMagic), Separators.EMPTY);
  }

  protected DynamicObjectInfoStatement dynamicObjectInfoStatement(AstNode astNode) {
    var questionMarksBefore = new ArrayList();
    var children = new ArrayList();
    var questionMarksAfter = new ArrayList();

    var nodeChildren = astNode.getChildren();

    var isQuestionMarksBefore = true;
    for (int i = 0; i < nodeChildren.size(); i++) {
      var child = nodeChildren.get(i);
      var childToken = child.getToken();
      if ("?".equals(childToken.getValue())) {
        if (isQuestionMarksBefore) {
          questionMarksBefore.add(toPyToken(childToken));
        } else {
          questionMarksAfter.add(toPyToken(childToken));
        }
      } else {
        isQuestionMarksBefore = false;
        child.getTokens()
          .stream()
          .map(this::toPyToken)
          .forEach(children::add);
      }
    }
    return new DynamicObjectInfoStatementImpl(questionMarksBefore, children, questionMarksAfter);
  }

  protected LineMagic lineMagic(AstNode astNode) {
    var percent = toPyToken(astNode.getFirstChild().getToken());

    var tokens = astNode.getChildren()
      .stream()
      .skip(1)
      .map(AstNode::getTokens)
      .flatMap(Collection::stream)
      .map(this::toPyToken)
      .toList();
    return new LineMagicImpl(percent, tokens);
  }
}