com.sonar.csharp.checks.AsyncAwaitIdentifierCheck Maven / Gradle / Ivy

Go to download
/*
 * Sonar C# Plugin :: C# Squid :: Checks
 * Copyright (C) 2010 Jose Chillan, Alexandre Victoor and SonarSource
 * [email protected]
 *
 * 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 com.sonar.csharp.checks;

import com.sonar.csharp.squid.parser.CSharpGrammar;
import com.sonar.sslr.api.AstNode;
import com.sonar.sslr.api.GenericTokenType;
import com.sonar.sslr.api.Grammar;
import org.sonar.squidbridge.checks.SquidCheck;
import org.sonar.check.BelongsToProfile;
import org.sonar.check.Priority;
import org.sonar.check.Rule;

@Rule(
  key = "AsyncAwaitIdentifier",
  priority = Priority.MAJOR)
@BelongsToProfile(title = CheckList.SONAR_WAY_PROFILE, priority = Priority.MAJOR)
public class AsyncAwaitIdentifierCheck extends SquidCheck {

  @Override
  public void init() {
    subscribeTo(GenericTokenType.IDENTIFIER);
  }

  @Override
  public void visitNode(AstNode node) {
    if (isAsyncOrAwaitIdentifier(node)) {
      getContext().createLineViolation(this, "Rename this identifier.", node);
    }
  }

  private boolean isAsyncOrAwaitIdentifier(AstNode node) {
    return isAsyncOrAwait(node) && !isContextualAsyncOrAwaitKeyword(node);
  }

  private boolean isAsyncOrAwait(AstNode node) {
    String value = node.getTokenOriginalValue();
    return "async".equals(value) || "await".equals(value);
  }

  private boolean isContextualAsyncOrAwaitKeyword(AstNode node) {
    return node.getParent().is(CSharpGrammar.ASYNC, CSharpGrammar.AWAIT_EXPRESSION);
  }

}