org.sonarsource.analyzer.commons.regex.finders.GraphemeInClassFinder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-regex-parsing Show documentation

Logic useful to read and analyze regular expressions

The newest version!

/*
 * SonarSource Analyzers Regex Parsing Commons
 * Copyright (C) 2009-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * 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  02110-1301, USA.
 */
package org.sonarsource.analyzer.commons.regex.finders;

import java.util.ArrayList;
import java.util.List;
import org.sonarsource.analyzer.commons.regex.RegexIssueLocation;
import org.sonarsource.analyzer.commons.regex.RegexIssueReporter;
import org.sonarsource.analyzer.commons.regex.ast.CharacterClassTree;
import org.sonarsource.analyzer.commons.regex.ast.CharacterClassUnionTree;
import org.sonarsource.analyzer.commons.regex.ast.RegexBaseVisitor;
import org.sonarsource.analyzer.commons.regex.helpers.GraphemeHelper;

public class GraphemeInClassFinder extends RegexBaseVisitor {

  private static final String MESSAGE = "Extract %d Grapheme Cluster(s) from this character class.";

  private final RegexIssueReporter.ElementIssue regexElementIssueReporter;
  private final List graphemeClusters = new ArrayList<>();

  public GraphemeInClassFinder(RegexIssueReporter.ElementIssue regexElementIssueReporter) {
    this.regexElementIssueReporter = regexElementIssueReporter;
  }

  @Override
  public void visitCharacterClass(CharacterClassTree tree) {
    super.visitCharacterClass(tree);
    if (!graphemeClusters.isEmpty()) {
      regexElementIssueReporter.report(tree, String.format(MESSAGE, graphemeClusters.size()), null, graphemeClusters);
    }
    graphemeClusters.clear();
  }

  @Override
  public void visitCharacterClassUnion(CharacterClassUnionTree tree) {
    graphemeClusters.addAll(GraphemeHelper.getGraphemeInList(tree.getCharacterClasses()));
    super.visitCharacterClassUnion(tree);
  }

}