verilog/analysis/checkers/always_comb_rule.cc

// Copyright 2017-2020 The Verible Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#include "verilog/analysis/checkers/always_comb_rule.h"

#include <set>
#include <string>

#include "absl/strings/str_cat.h"
#include "absl/strings/string_view.h"
#include "common/analysis/citation.h"
#include "common/analysis/lint_rule_status.h"
#include "common/analysis/matcher/bound_symbol_manager.h"
#include "common/text/symbol.h"
#include "common/text/syntax_tree_context.h"
#include "verilog/analysis/descriptions.h"
#include "verilog/analysis/lint_rule_registry.h"

namespace verilog {
namespace analysis {

using verible::GetStyleGuideCitation;
using verible::LintRuleStatus;
using verible::LintViolation;
using verible::SyntaxTreeContext;

// Register AlwaysCombRule
VERILOG_REGISTER_LINT_RULE(AlwaysCombRule);

absl::string_view AlwaysCombRule::Name() { return "always-comb"; }
const char AlwaysCombRule::kTopic[] = "combinational-logic";
const char AlwaysCombRule::kMessage[] =
    "Use \'always_comb\' instead of \'always @*\'.";

std::string AlwaysCombRule::GetDescription(DescriptionType description_type) {
  return absl::StrCat("Checks that there are no occurrences of ",
                      Codify("always @*", description_type), ". Use ",
                      Codify("always_comb", description_type), " instead. See ",
                      GetStyleGuideCitation(kTopic), ".");
}

void AlwaysCombRule::HandleSymbol(const verible::Symbol& symbol,
                                  const SyntaxTreeContext& context) {
  // Check for offending use of always @*
  verible::matcher::BoundSymbolManager manager;
  if (always_star_matcher_.Matches(symbol, &manager)) {
    violations_.insert(LintViolation(symbol, kMessage, context));
  }
}

LintRuleStatus AlwaysCombRule::Report() const {
  return LintRuleStatus(violations_, Name(), GetStyleGuideCitation(kTopic));
}

}  // namespace analysis
}  // namespace verilog