content: /*******************************************************************************
   * Copyright (C) 2022, 1C-Soft LLC and others.
   *
   * This program and the accompanying materials are made
   * available under the terms of the Eclipse Public License 2.0
   * which is available at https://www.eclipse.org/legal/epl-2.0/
   *
   * SPDX-License-Identifier: EPL-2.0
   *
   * Contributors:
   *     1C-Soft LLC - initial API and implementation
   *******************************************************************************/
  package com.e1c.v8codestyle.bsl.check;
  
  import static com._1c.g5.v8.dt.bsl.model.BslPackage.Literals.MODULE;
  
  import java.text.MessageFormat;
  import java.util.Iterator;
  
  import org.eclipse.core.runtime.IProgressMonitor;
  import org.eclipse.emf.ecore.EObject;
  import org.eclipse.xtext.TerminalRule;
  import org.eclipse.xtext.nodemodel.ILeafNode;
  import org.eclipse.xtext.nodemodel.INode;
  import org.eclipse.xtext.nodemodel.util.NodeModelUtils;
  
  import com._1c.g5.v8.dt.bsl.model.Module;
  import com._1c.g5.v8.dt.bsl.services.BslGrammarAccess;
  import com.e1c.g5.v8.dt.check.BslDirectLocationIssue;
  import com.e1c.g5.v8.dt.check.DirectLocation;
  import com.e1c.g5.v8.dt.check.ICheckParameters;
  import com.e1c.g5.v8.dt.check.Issue;
  import com.e1c.g5.v8.dt.check.components.BasicCheck;
  import com.e1c.g5.v8.dt.check.settings.IssueSeverity;
  import com.e1c.g5.v8.dt.check.settings.IssueType;
  import com.google.inject.Inject;
  
  /**
   * Checks consecutive empty lines
   *
   * @author Artem Iliukhin
   */
  public class ConsecutiveEmptyLinesCheck
      extends BasicCheck
  {
  
      private static final String PATTERN = "(?<=\\n)"; //$NON-NLS-1$
      private static final String DEFAULT_NUMBER_OF_EMPTY_LINES = "1"; //$NON-NLS-1$
      private static final String NUMBER_OF_EMPTY_LINES = "numberOfEmptyLines"; //$NON-NLS-1$
      private static final String CHECK_ID = "module-consecutive-blank-lines"; //$NON-NLS-1$
  
      private final BslGrammarAccess grammarAccess;
  
      /**
       * Instantiates a new consecutive empty lines check.
       *
       * @param grammarAccess the grammar access
       */
      @Inject
      public ConsecutiveEmptyLinesCheck(BslGrammarAccess grammarAccess)
      {
          super();
          this.grammarAccess = grammarAccess;
      }
  
      @Override
      public String getCheckId()
      {
          return CHECK_ID;
      }
  
      @Override
      protected void configureCheck(CheckConfigurer builder)
      {
          builder.title(Messages.ConsecutiveEmptyLines_Title)
              .description(Messages.ConsecutiveEmptyLines_Description)
              .issueType(IssueType.CODE_STYLE)
              .severity(IssueSeverity.TRIVIAL)
              .disable()
              .module()
              .checkedObjectType(MODULE)
              .parameter(NUMBER_OF_EMPTY_LINES, Integer.class, DEFAULT_NUMBER_OF_EMPTY_LINES,
                  Messages.ConsecutiveEmptyLines_Parameter_title);
      }
  
      @Override
      protected void check(Object object, ResultAcceptor resultAceptor, ICheckParameters parameters,
          IProgressMonitor progressMonitor)
      {
          Module module = (Module)object;
          INode node = NodeModelUtils.findActualNodeFor(module);
          Iterator<ILeafNode> iterator = node.getLeafNodes().iterator();
  
          int numberAllowedLines = parameters.getInt(NUMBER_OF_EMPTY_LINES);
  
          while (iterator.hasNext())
          {
              ILeafNode leafNode = iterator.next();
              if (leafNode.isHidden())
              {
                  EObject grammarElement = leafNode.getGrammarElement();
                  int startLine = leafNode.getStartLine();
                  int endLine = leafNode.getEndLine();
                  if (grammarElement instanceof TerminalRule && grammarAccess.getWSRule().equals(grammarElement)
                      && (endLine - startLine - 1) > numberAllowedLines)
                  {
                      String message = MessageFormat.format(
                          Messages.ConsecutiveEmptyLines_Sequence_of_empty_lines_between__0__and__1__is_greator_than__2,
                          startLine, endLine, numberAllowedLines);
  
                      String[] lines = leafNode.getText().split(PATTERN);
                      int headLength = getAllowedHeadLength(numberAllowedLines, lines);
  
                      DirectLocation directLocation =
                          new DirectLocation(
                              leafNode.getOffset() + headLength,
                              leafNode.getLength() - (headLength + getAllowedTailLength(lines)),
                              startLine + numberAllowedLines + 1, module);
  
                      Issue issue = new BslDirectLocationIssue(message, directLocation);
  
                      resultAceptor.addIssue(issue);
                  }
              }
          }
      }
  
      private int getAllowedHeadLength(int number, String[] lines)
      {
          int sum = 0;
          for (int i = 0; i <= number; i++)
          {
              sum += lines[i].length();
          }
          return sum;
      }
  
      private int getAllowedTailLength(String[] lines)
      {
          return lines[lines.length - 1].length();
      }
  }
  