code: /* LanguageTool, a natural language style checker 
   * Copyright (C) 2005 Daniel Naber (http://www.danielnaber.de)
   * 
   * This library 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 2.1 of the License, or (at your option) any later version.
   *
   * This library 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 library; if not, write to the Free Software
   * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
   * USA
   */
  package org.languagetool.rules;
  
  import java.util.ArrayList;
  import java.util.List;
  import java.util.ResourceBundle;
  
  import org.languagetool.AnalyzedSentence;
  import org.languagetool.AnalyzedTokenReadings;
  
  /**
   * A rule that matches "..", "::", "-," but not "...", "!..", "?!!", ",-" etc.
   * Languages will have to subclass it and override <code>isPunctsJoinOk()</code>
   * and <code>isPunctuation()</code> to provide language-specific checking
   * 
   * @author Andriy Rysin
   */
  public abstract class AbstractPunctuationCheckRule extends Rule {
  
    public AbstractPunctuationCheckRule(ResourceBundle messages) {
      super(messages);
      super.setCategory(Categories.PUNCTUATION.getCategory(messages));
    }
  
    @Override
    public String getId() {
      return "PUNCTUATION_GENERIC_CHECK";
    }
  
    @Override
    public String getDescription() {
      return "Use of unusual combination of punctuation characters";
    }
  
    protected abstract boolean isPunctsJoinOk(String tokens);
  
    protected abstract boolean isPunctuation(String token);
  
    @Override
    public RuleMatch[] match(AnalyzedSentence sentence) {
      List<RuleMatch> ruleMatches = new ArrayList<>();
      AnalyzedTokenReadings[] tokens = sentence.getTokens();
  
      int startTokenIdx = -1;
      String tkns = "";
      for (int i = 0; i < tokens.length; i++) {
        String tokenStr = tokens[i].getToken();
  
        if (isPunctuation(tokenStr)) {
          tkns += tokenStr;
          if (startTokenIdx == -1) {
            startTokenIdx = i;
          }
          if (i < tokens.length - 1) {
            continue;
          }
        }
  
        if (tkns.length() >= 2 && !isPunctsJoinOk(tkns)) {
          String msg = "bad duplication or combination of punctuation signs";
          RuleMatch ruleMatch = new RuleMatch(this, sentence, tokens[startTokenIdx].getStartPos(),
              tokens[startTokenIdx].getStartPos() + tkns.length(), msg,
              "Punctuation problem");
          ruleMatch.setSuggestedReplacement(tkns.substring(0, 1));
          ruleMatches.add(ruleMatch);
        }
        tkns = "";
        startTokenIdx = -1;
      }
  
      return toRuleMatchArray(ruleMatches);
    }
  
  }