verilog/analysis/checkers/no_tabs_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/no_tabs_rule.h"

#include <cstddef>
#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/text/token_info.h"
#include "verilog/analysis/descriptions.h"
#include "verilog/analysis/lint_rule_registry.h"
#include "verilog/parser/verilog_token_enum.h"

namespace verilog {
namespace analysis {

using verible::GetStyleGuideCitation;
using verible::LintRuleStatus;
using verible::LintViolation;
using verible::TokenInfo;

// Register the lint rule
VERILOG_REGISTER_LINT_RULE(NoTabsRule);

absl::string_view NoTabsRule::Name() { return "no-tabs"; }
const char NoTabsRule::kTopic[] = "tabs";
const char NoTabsRule::kMessage[] = "Use spaces, not tabs.";

std::string NoTabsRule::GetDescription(DescriptionType description_type) {
  return absl::StrCat(
      "Checks that no tabs are used. Spaces should be used instead of tabs. "
      "See ",
      GetStyleGuideCitation(kTopic), ".");
}

void NoTabsRule::HandleLine(absl::string_view line) {
  // Finds first tab in each line, if there is one.
  // This reports only the first violation on each line.
  const auto tab_pos = line.find('\t');
  if (tab_pos != absl::string_view::npos) {
    TokenInfo token(TK_SPACE, line.substr(tab_pos, 1));
    violations_.insert(LintViolation(token, kMessage));
  }
}

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

}  // namespace analysis
}  // namespace verilog