///////////////////////////////////////////////////////////////////////////////////////////////
   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
   // Copyright (C) 2001-2026 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.indentation;
  
  import com.puppycrawl.tools.checkstyle.api.DetailAST;
  import com.puppycrawl.tools.checkstyle.api.TokenTypes;
  
  /**
   * Handler for class definitions.
   *
   */
  public class ClassDefHandler extends BlockParentHandler {
  
      /** Token for modifier. */
      private static final String MODIFIER = "modifier";
  
      /**
       * Construct an instance of this handler with the given indentation check,
       * abstract syntax tree, and parent handler.
       *
       * @param indentCheck   the indentation check
       * @param ast           the abstract syntax tree
       * @param parent        the parent handler
       */
      public ClassDefHandler(IndentationCheck indentCheck,
                             DetailAST ast,
                             AbstractExpressionHandler parent) {
          super(indentCheck, getHandlerName(ast), ast, parent);
      }
  
      @Override
      protected DetailAST getLeftCurly() {
          return getMainAst().findFirstToken(TokenTypes.OBJBLOCK)
              .findFirstToken(TokenTypes.LCURLY);
      }
  
      @Override
      protected DetailAST getRightCurly() {
          return getMainAst().findFirstToken(TokenTypes.OBJBLOCK)
              .findFirstToken(TokenTypes.RCURLY);
      }
  
      @Override
      protected DetailAST getTopLevelAst() {
          return null;
          // note: ident checked by hand in check indentation;
      }
  
      @Override
      protected DetailAST getListChild() {
          return getMainAst().findFirstToken(TokenTypes.OBJBLOCK);
      }
  
      @Override
      public void checkIndentation() {
          final DetailAST modifiers = getMainAst().findFirstToken(TokenTypes.MODIFIERS);
          if (modifiers.hasChildren()) {
              checkModifiers();
          }
          else {
              if (getMainAst().getType() != TokenTypes.ANNOTATION_DEF) {
                  final DetailAST ident = getMainAst().findFirstToken(TokenTypes.IDENT);
                  DetailAST tokenToCheck = getMainAst();
                  if (ident.getLineNo() == getMainAst().getLineNo()) {
                      tokenToCheck = ident;
                  }
                  final int lineStart = getLineStart(tokenToCheck);
                  if (!getIndent().isAcceptable(lineStart)) {
                      logError(tokenToCheck, "ident", lineStart);
                  }
              }
          }
          if (getMainAst().getType() == TokenTypes.ANNOTATION_DEF) {
              final DetailAST atAst = getMainAst().findFirstToken(TokenTypes.AT);
              if (isOnStartOfLine(atAst)) {
                  checkWrappingIndentation(getMainAst(), getListChild(), 0,
                          getIndent().getFirstIndentLevel(),
                          LineWrappingHandler.LineWrappingOptions.NONE);
              }
          }
          else {
              checkWrappingIndentation(getMainAst(), getListChild());
         }
         super.checkIndentation();
     }
 
     @Override
     protected int[] getCheckedChildren() {
         return new int[] {
             TokenTypes.EXPR,
             TokenTypes.OBJBLOCK,
             TokenTypes.LITERAL_BREAK,
             TokenTypes.LITERAL_RETURN,
             TokenTypes.LITERAL_THROW,
             TokenTypes.LITERAL_CONTINUE,
         };
     }
 
     /**
      * Checks modifiers for class/annotation definitions.
      */
     private void checkModifiers() {
         if (getMainAst().getType() == TokenTypes.ANNOTATION_DEF) {
             checkAnnotationDefModifiers();
         }
         else {
             checkClassDefModifiers();
         }
     }
 
     /**
      * Checks modifiers for annotation definitions, skipping modifiers that are
      * not at the start of the line.
      */
     private void checkAnnotationDefModifiers() {
         final DetailAST modifiers = getMainAst().findFirstToken(TokenTypes.MODIFIERS);
         for (DetailAST modifier = modifiers.getFirstChild();
              modifier != null;
              modifier = modifier.getNextSibling()) {
             if (isOnStartOfLine(modifier)
                     && !getIndent().isAcceptable(expandedTabsColumnNo(modifier))) {
                 logError(modifier, MODIFIER, expandedTabsColumnNo(modifier));
             }
         }
     }
 
     /**
      * Checks modifiers for class definitions, skipping wrapped modifiers
      * that appear on lines after the first modifier line.
      * Annotations that wrap before the class keyword are skipped only when
      * they are correctly indented, since a correctly indented annotation
      * before a wrongly indented class keyword is not itself a violation.
      */
     private void checkClassDefModifiers() {
         final DetailAST modifiers = getMainAst().findFirstToken(TokenTypes.MODIFIERS);
         final DetailAST firstModifier = modifiers.getFirstChild();
         final DetailAST firstNonAnnotationMod = getFirstNonAnnotationModifier(firstModifier);
         final int firstModifierLine = firstModifier.getLineNo();
         final int firstNonAnnotationLine = firstNonAnnotationMod.getLineNo();
 
         checkLineModifiers(firstModifier, firstModifierLine);
 
         if (firstModifierLine != firstNonAnnotationLine) {
             checkNonFirstLineModifiers(firstNonAnnotationMod);
         }
     }
 
     /**
      * Checks modifiers on the first modifier line.
      *
      * @param firstModifier the first modifier
      * @param firstModifierLine line number of the first modifier
      */
     private void checkLineModifiers(DetailAST firstModifier,
             int firstModifierLine) {
         for (DetailAST modifier = firstModifier;
              modifier != null
                      && modifier.getLineNo() == firstModifierLine;
              modifier = modifier.getNextSibling()) {
             if (isOnStartOfLine(modifier)
                     && !getIndent().isAcceptable(expandedTabsColumnNo(modifier))) {
                 logError(modifier, MODIFIER, expandedTabsColumnNo(modifier));
             }
         }
     }
 
     /**
      * Checks modifiers on the line of the first non-annotation modifier,
      * skipping correctly-indented annotations to avoid false positives
      * when annotations wrap before the class keyword.
      *
      * @param firstNonAnnotationMod the first non-annotation modifier
      */
     private void checkNonFirstLineModifiers(DetailAST firstNonAnnotationMod) {
         for (DetailAST modifier = firstNonAnnotationMod;
              modifier != null;
              modifier = modifier.getNextSibling()) {
             if (isOnStartOfLine(modifier)
                     && !getIndent().isAcceptable(
                             expandedTabsColumnNo(modifier))) {
                 logError(modifier, MODIFIER, expandedTabsColumnNo(modifier));
             }
         }
     }
 
     /**
      * Finds the first non-annotation modifier node.
      *
      * @param firstModifier the first modifier in the modifiers list
      * @return the first non-annotation modifier node
      */
     private static DetailAST getFirstNonAnnotationModifier(DetailAST firstModifier) {
         DetailAST result = firstModifier;
         for (DetailAST modifier = firstModifier;
              modifier != null;
              modifier = modifier.getNextSibling()) {
             if (modifier.getType() != TokenTypes.ANNOTATION) {
                 result = modifier;
                 break;
             }
         }
         return result;
     }
 
     /**
      * Creates a handler name for this class according to ast type.
      *
      * @param ast the abstract syntax tree.
      * @return handler name for this class.
      */
     private static String getHandlerName(DetailAST ast) {
         final int tokenType = ast.getType();
 
         return switch (tokenType) {
             case TokenTypes.CLASS_DEF -> "class def";
             case TokenTypes.ENUM_DEF -> "enum def";
             case TokenTypes.ANNOTATION_DEF -> "annotation def";
             case TokenTypes.RECORD_DEF -> "record def";
             default -> "interface def";
         };
     }
 
 }