au.com.integradev.delphi.checks.InlineDeclarationCapturedByAnonymousMethodCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of delphi-checks Show documentation
There is a newer version: 1.12.1
/*
 * Sonar Delphi Plugin
 * Copyright (C) 2019 Integrated Application Development
 *
 * 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 au.com.integradev.delphi.checks;

import org.sonar.check.Rule;
import org.sonar.plugins.communitydelphi.api.ast.AnonymousMethodNode;
import org.sonar.plugins.communitydelphi.api.ast.NameReferenceNode;
import org.sonar.plugins.communitydelphi.api.check.DelphiCheck;
import org.sonar.plugins.communitydelphi.api.check.DelphiCheckContext;
import org.sonar.plugins.communitydelphi.api.symbol.declaration.NameDeclaration;
import org.sonar.plugins.communitydelphi.api.symbol.declaration.VariableNameDeclaration;
import org.sonar.plugins.communitydelphi.api.symbol.scope.DelphiScope;
import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;

@DeprecatedRuleKey(
    ruleKey = "InlineDeclarationCapturedByAnonymousMethodRule",
    repositoryKey = "delph")
@Rule(key = "InlineDeclarationCapturedByAnonymousMethod")
public class InlineDeclarationCapturedByAnonymousMethodCheck extends DelphiCheck {
  private static final String MESSAGE =
      "Do not capture this inline variable in an anonymous method.";

  @Override
  public DelphiCheckContext visit(NameReferenceNode node, DelphiCheckContext context) {
    if (isViolation(node)) {
      reportIssue(context, node, MESSAGE);
    }
    return super.visit(node, context);
  }

  private static boolean isViolation(NameReferenceNode node) {
    NameDeclaration declaration = node.getNameDeclaration();
    if (declaration instanceof VariableNameDeclaration) {
      VariableNameDeclaration varDeclaration = (VariableNameDeclaration) declaration;
      if (!varDeclaration.isInline()) {
        return false;
      }

      AnonymousMethodNode anonymousMethod = node.getFirstParentOfType(AnonymousMethodNode.class);
      if (anonymousMethod == null) {
        return false;
      }

      DelphiScope declarationScope = varDeclaration.getScope();
      DelphiScope scope = anonymousMethod.getScope();
      while ((scope = scope.getParent()) != null) {
        if (scope == declarationScope) {
          return true;
        }
      }
    }
    return false;
  }
}