verilog/analysis/checkers/interface_name_style_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/interface_name_style_rule.h"

#include <set>
#include <string>

#include "absl/strings/match.h"
#include "absl/strings/str_cat.h"
#include "common/analysis/citation.h"
#include "common/analysis/lint_rule_status.h"
#include "common/analysis/matcher/bound_symbol_manager.h"
#include "common/strings/naming_utils.h"
#include "common/text/symbol.h"
#include "common/text/syntax_tree_context.h"
#include "verilog/CST/module.h"
#include "verilog/CST/type.h"
#include "verilog/analysis/lint_rule_registry.h"

namespace verilog {
namespace analysis {

VERILOG_REGISTER_LINT_RULE(InterfaceNameStyleRule);

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

absl::string_view InterfaceNameStyleRule::Name() {
  return "interface-name-style";
}
const char InterfaceNameStyleRule::kTopic[] = "interface-conventions";
const char InterfaceNameStyleRule::kMessage[] =
    "Interface names must use lower_snake_case naming convention "
    "and end with _if.";

std::string InterfaceNameStyleRule::GetDescription(
    DescriptionType description_type) {
  return absl::StrCat(
      "Checks that ", Codify("interface", description_type),
      " names use lower_snake_case naming convention and end with '_if'. See ",
      GetStyleGuideCitation(kTopic), ".");
}

void InterfaceNameStyleRule::HandleSymbol(const verible::Symbol& symbol,
                                          const SyntaxTreeContext& context) {
  verible::matcher::BoundSymbolManager manager;
  absl::string_view name;
  const verible::TokenInfo* identifier_token;
  if (matcher_interface_.Matches(symbol, &manager)) {
    identifier_token = &GetInterfaceNameToken(symbol);
    name = identifier_token->text();

    if (!verible::IsLowerSnakeCaseWithDigits(name) ||
        !absl::EndsWith(name, "_if")) {
      violations_.insert(LintViolation(*identifier_token, kMessage, context));
    }
  }
}

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

}  // namespace analysis
}  // namespace verilog