/* 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.fr;

import java.util.ArrayList;
import java.util.List;
import java.util.ResourceBundle;

import org.languagetool.AnalyzedSentence;
import org.languagetool.AnalyzedTokenReadings;
import org.languagetool.rules.Category;
import org.languagetool.rules.RuleMatch;
import org.languagetool.tools.StringTools;

/**
 * A rule that matches spaces before ?,:,; and ! (required for correct French
 * punctuation).
 *
 * @see http://unicode.org/udhr/n/notes_fra.html
 * 
 * @author Marcin Miłkowski
 */
public class QuestionWhitespaceRule extends FrenchRule {

  public QuestionWhitespaceRule(final ResourceBundle messages) {
    // super(messages);
    super.setCategory(new Category(messages.getString("category_misc")));
  }

  @Override
  public String getId() {
    return "FRENCH_WHITESPACE";
  }

  @Override
  public String getDescription() {
    return "Insertion des espaces fines insécables";
  }

  @Override
  public RuleMatch[] match(final AnalyzedSentence text) {
    final List<RuleMatch> ruleMatches = new ArrayList<RuleMatch>();
    final AnalyzedTokenReadings[] tokens = text.getTokens();
    String prevToken = "";
    int pos = 0;
    for (int i = 1; i < tokens.length; i++) {
      final String token = tokens[i].getToken();
      final boolean isWhiteBefore = tokens[i].isWhitespaceBefore();
      pos += token.length();
      String msg = null;
      final int fixPos = 0;
      int fixLen = 0;
      String suggestionText = null;
      if (isWhiteBefore) {
        if (token.equals("?")) {
          msg = "Point d'interrogation est précédé d'une espace fine insécable.";
          // non-breaking space
          suggestionText = " ?";
          fixLen = 1;
        } else if (token.equals("!")) {
          msg = "Point d'exclamation est précédé d'une espace fine insécable.";
          // non-breaking space
          suggestionText = " !";
          fixLen = 1; 
        } else if (token.equals("»")) {
          msg = "Le guillemet fermant est précédé d'une espace fine insécable.";
          // non-breaking space
          suggestionText = " »";
          fixLen = 1;
        } else if (token.equals(";")) {
          msg = "Point-virgule est précédé d'une espace fine insécable.";
          // non-breaking space
          suggestionText = " ;";
          fixLen = 1;
        } else if (token.equals(":")) {
          msg = "Deux-points sont précédé d'une espace fine insécable.";
          // non-breaking space
          suggestionText = " :";
          fixLen = 1;
        }        
      } else {
        // Stricly speaking, the character before ?!;: should be an
        // "espace fine insécable" (U+202f).  In practise, an
        // "espace insécable" (U+00a0) is also often used. Let's accept both.
        if (token.equals("?") && !prevToken.equals("!")
            && !prevToken.equals("\u00a0") && !prevToken.equals("\u202f")) {
          msg = "Point d'interrogation est précédé d'une espace fine insécable.";
          // non-breaking space
          suggestionText = prevToken + " ?";
          fixLen = 1;
        } else if (token.equals("!") && !prevToken.equals("?")
            && !prevToken.equals("\u00a0") && !prevToken.equals("\u202f")) {
          msg = "Point d'exclamation est précédé d'une espace fine insécable.";
          // non-breaking space
          suggestionText = prevToken + " !";
          fixLen = 1;
        } else if (token.equals(";")
            && !prevToken.equals("\u00a0") && !prevToken.equals("\u202f")) {
          msg = "Point-virgule est précédé d'une espace fine insécable.";
          // non-breaking space
          suggestionText = prevToken + " ;";
          fixLen = 1;
        } else if (token.equals(":") 
            && !prevToken.equals("\u00a0") && !prevToken.equals("\u202f")) {
          msg = "Deux-points précédés d'une espace fine insécable.";
          // non-breaking space
          suggestionText = prevToken + " :";
          fixLen = 1;
        } else if (token.equals("»")
            && !prevToken.equals("\u00a0") && !prevToken.equals("\u202f")) {
          msg = "Le guillemet fermant est précédé d'une espace fine insécable.";
          // non-breaking space
          suggestionText = prevToken + " »";
          fixLen = 1;
        }             
      } 
      
      if (StringTools.isEmpty(token) && prevToken.equals("«")) {
        msg = "Le guillemet ouvrant est suivi d'une espace fine insécable.";
        // non-breaking space
        suggestionText = "« ";
        fixLen = 1;
      }  else if (!StringTools.isEmpty(token) && !token.equals("\u00a0")
          && prevToken.equals("«")) {
        msg = "Le guillemet ouvrant est suivi d'une espace fine insécable.";
        // non-breaking space
        suggestionText = "« ";
        fixLen = 0;
      } 

      if (msg != null) {
        final int fromPos = tokens[i - 1].getStartPos() + fixPos;
        final int toPos = tokens[i - 1].getStartPos() + fixPos + fixLen
            + tokens[i - 1].getToken().length();
        final RuleMatch ruleMatch = new RuleMatch(this, fromPos, toPos, msg,
            "Insérer un espace insécable");
        if (suggestionText != null) {
          ruleMatch.setSuggestedReplacement(suggestionText);
        }
        ruleMatches.add(ruleMatch);
      }
      prevToken = token;
    }

    return toRuleMatchArray(ruleMatches);
  }

  @Override
  public void reset() {
    // nothing
  }

}

@@ -2011,25 +2011,12 @@
  %22%22;
-%0A
     
-int pos = 0;
 %0A   
@@ -2178,37 +2178,14 @@
 e();
-%0A
       
-pos += token.length();
 %0A   

remove unused variable