org.sonar.python.tree.NumericLiteralImpl 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 java.util.Collections;
import java.util.List;
import java.util.Locale;
import org.sonar.plugins.python.api.tree.NumericLiteral;
import org.sonar.plugins.python.api.tree.Token;
import org.sonar.plugins.python.api.tree.Tree;
import org.sonar.plugins.python.api.tree.TreeVisitor;
import org.sonar.plugins.python.api.types.InferredType;
import org.sonar.python.types.InferredTypes;
import org.sonar.python.types.v2.PythonType;

public class NumericLiteralImpl extends PyTree implements NumericLiteral {

  private final String valueAsString;
  private final Token token;
  private final InferredType type;

  private PythonType typeV2 = PythonType.UNKNOWN;

  NumericLiteralImpl(Token token) {
    this.token = token;
    valueAsString = token.value();
    type = computeType();
  }

  @Override
  public Kind getKind() {
    return Kind.NUMERIC_LITERAL;
  }

  @Override
  public void accept(TreeVisitor visitor) {
    visitor.visitNumericLiteral(this);
  }

  @Override
  public long valueAsLong() {
    String literalValue = valueAsString.replace("_", "");
    if (literalValue.startsWith("0b") || literalValue.startsWith("0B")) {
      return Integer.valueOf(literalValue.substring(2), 2);
    }
    if (literalValue.startsWith("0o") || literalValue.startsWith("0O")) {
      return Integer.valueOf(literalValue.substring(2), 8);
    } else if (literalValue.startsWith("0x") || literalValue.startsWith("0X")) {
      return Integer.valueOf(literalValue.substring(2), 16);
    } else if (literalValue.startsWith("0") && literalValue.length() > 1) {
      // Python 2 syntax (https://www.python.org/dev/peps/pep-3127/#removal-of-old-octal-syntax)
      return Integer.valueOf(literalValue.substring(1), 8);
    }
    if (valueAsString.endsWith("L") || valueAsString.endsWith("l")) {
      literalValue = literalValue.substring(0, literalValue.length() - 1);
    }
    return Long.parseLong(literalValue);
  }

  @Override
  public String valueAsString() {
    return valueAsString;
  }

  @Override
  public List computeChildren() {
    return Collections.singletonList(token);
  }

  @Override
  public InferredType type() {
    return type;
  }

  // https://docs.python.org/3/reference/lexical_analysis.html#numeric-literals
  private InferredType computeType() {
    return switch (numericKind()) {
      case FLOAT -> InferredTypes.FLOAT;
      case COMPLEX -> InferredTypes.COMPLEX;
      default -> InferredTypes.INT;
    };
  }

  public NumericKind numericKind() {
    String valueAsStringLowerCase = valueAsString.toLowerCase(Locale.ROOT);
    if (valueAsStringLowerCase.contains("j")) {
      return NumericKind.COMPLEX;
    }
    if (valueAsStringLowerCase.startsWith("0x")) {
      return NumericKind.INT;
    }
    if (valueAsString.contains(".") || valueAsStringLowerCase.contains("e")) {
      return NumericKind.FLOAT;
    }
    return NumericKind.INT;
  }

  @Override
  public PythonType typeV2() {
    return this.typeV2;
  }

  public void typeV2(PythonType type) {
    this.typeV2 = type;
  }

  public enum NumericKind {
    INT("int"), FLOAT("float"), COMPLEX("complex");

    private final String value;

    NumericKind(String value) {
      this.value = value;
    }

    public String value() {
      return value;
    }
  }
}