///////////////////////////////////////////////////////////////////////////////////////////////
   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
   // Copyright (C) 2001-2025 the original author or authors.
   //
   // 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  ///////////////////////////////////////////////////////////////////////////////////////////////
  
  package com.puppycrawl.tools.checkstyle.checks.whitespace;
  
  import java.util.Arrays;
  import java.util.Locale;
  
  import com.puppycrawl.tools.checkstyle.StatelessCheck;
  import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
  import com.puppycrawl.tools.checkstyle.api.DetailAST;
  import com.puppycrawl.tools.checkstyle.api.TokenTypes;
  import com.puppycrawl.tools.checkstyle.utils.CodePointUtil;
  import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
  
  /**
   * <div>
   * Checks line wrapping with separators.
   * </div>
   *
   * @since 5.8
   */
  @StatelessCheck
  public class SeparatorWrapCheck
      extends AbstractCheck {
  
      /**
       * A key is pointing to the warning message text in "messages.properties"
       * file.
       */
      public static final String MSG_LINE_PREVIOUS = "line.previous";
  
      /**
       * A key is pointing to the warning message text in "messages.properties"
       * file.
       */
      public static final String MSG_LINE_NEW = "line.new";
  
      /** Specify policy on how to wrap lines. */
      private WrapOption option = WrapOption.EOL;
  
      /**
       * Setter to specify policy on how to wrap lines.
       *
       * @param optionStr string to decode option from
       * @throws IllegalArgumentException if unable to decode
       * @since 5.8
       */
      public void setOption(String optionStr) {
          option = WrapOption.valueOf(optionStr.trim().toUpperCase(Locale.ENGLISH));
      }
  
      @Override
      public int[] getDefaultTokens() {
          return new int[] {
              TokenTypes.DOT,
              TokenTypes.COMMA,
          };
      }
  
      @Override
      public int[] getAcceptableTokens() {
          return new int[] {
              TokenTypes.DOT,
              TokenTypes.COMMA,
              TokenTypes.SEMI,
              TokenTypes.ELLIPSIS,
              TokenTypes.AT,
              TokenTypes.LPAREN,
              TokenTypes.RPAREN,
              TokenTypes.ARRAY_DECLARATOR,
              TokenTypes.RBRACK,
              TokenTypes.METHOD_REF,
          };
      }
  
      @Override
      public int[] getRequiredTokens() {
          return CommonUtil.EMPTY_INT_ARRAY;
      }
  
      @Override
      public void visitToken(DetailAST ast) {
         final String text = ast.getText();
         final int colNo = ast.getColumnNo();
         final int lineNo = ast.getLineNo();
         final int[] currentLine = getLineCodePoints(lineNo - 1);
         final boolean isLineEmptyAfterToken = CodePointUtil.isBlank(
                 Arrays.copyOfRange(currentLine, colNo + text.length(), currentLine.length)
         );
         final boolean isLineEmptyBeforeToken = CodePointUtil.isBlank(
                 Arrays.copyOfRange(currentLine, 0, colNo)
         );
 
         if (option == WrapOption.NL
                  && isLineEmptyAfterToken) {
             log(ast, MSG_LINE_NEW, text);
         }
         else if (option == WrapOption.EOL
                 && isLineEmptyBeforeToken) {
             log(ast, MSG_LINE_PREVIOUS, text);
         }
     }
 
 }