org.sonar.python.checks.PreIncrementDecrementCheck Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of python-checks Show documentation

There is a newer version: 4.23.0.17664

/*
 * 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.checks;

import org.sonar.check.Rule;
import org.sonar.plugins.python.api.PythonSubscriptionCheck;
import org.sonar.plugins.python.api.SubscriptionContext;
import org.sonar.plugins.python.api.tree.UnaryExpression;
import org.sonar.plugins.python.api.tree.Tree.Kind;

@Rule(key = PreIncrementDecrementCheck.CHECK_KEY)
public class PreIncrementDecrementCheck extends PythonSubscriptionCheck {
  public static final String CHECK_KEY = "PreIncrementDecrement";
  private static final String MESSAGE = "This statement doesn't produce the expected result, replace use of non-existent pre-%srement operator";

  @Override
  public void initialize(Context context) {
    context.registerSyntaxNodeConsumer(Kind.UNARY_PLUS, PreIncrementDecrementCheck::checkIncrementDecrement);
    context.registerSyntaxNodeConsumer(Kind.UNARY_MINUS, PreIncrementDecrementCheck::checkIncrementDecrement);
  }

  private static void checkIncrementDecrement(SubscriptionContext ctx) {
    UnaryExpression unaryExpressionTree = (UnaryExpression) ctx.syntaxNode();
    Kind kind = unaryExpressionTree.getKind();
    if (unaryExpressionTree.expression().is(kind)) {
      ctx.addIssue(unaryExpressionTree, String.format(MESSAGE, kind == Kind.UNARY_PLUS ? "inc" : "dec"));
    }
  }
}