001/////////////////////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code and other text files for adherence to a set of rules. 003// Copyright (C) 2001-2026 the original author or authors. 004// 005// This library is free software; you can redistribute it and/or 006// modify it under the terms of the GNU Lesser General Public 007// License as published by the Free Software Foundation; either 008// version 2.1 of the License, or (at your option) any later version. 009// 010// This library is distributed in the hope that it will be useful, 011// but WITHOUT ANY WARRANTY; without even the implied warranty of 012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 013// Lesser General Public License for more details. 014// 015// You should have received a copy of the GNU Lesser General Public 016// License along with this library; if not, write to the Free Software 017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 018/////////////////////////////////////////////////////////////////////////////////////////////// 019 020package com.puppycrawl.tools.checkstyle.checks.coding; 021 022import com.puppycrawl.tools.checkstyle.FileStatefulCheck; 023import com.puppycrawl.tools.checkstyle.api.AbstractCheck; 024import com.puppycrawl.tools.checkstyle.api.DetailAST; 025import com.puppycrawl.tools.checkstyle.api.TokenTypes; 026 027/** 028 * <div> 029 * Restricts nested if-else blocks to a specified depth. 030 * </div> 031 * 032 * @since 3.2 033 */ 034@FileStatefulCheck 035public final class NestedIfDepthCheck extends AbstractCheck { 036 037 /** 038 * A key is pointing to the warning message text in "messages.properties" file. 039 */ 040 public static final String MSG_KEY = "nested.if.depth"; 041 042 /** Specify maximum allowed nesting depth. */ 043 private int max = 1; 044 /** Current nesting depth. */ 045 private int depth; 046 047 /** 048 * Creates a new {@code NestedIfDepthCheck} instance. 049 */ 050 public NestedIfDepthCheck() { 051 // no code by default 052 } 053 054 /** 055 * Setter to specify maximum allowed nesting depth. 056 * 057 * @param max maximum allowed nesting depth. 058 * @since 3.2 059 */ 060 public void setMax(int max) { 061 this.max = max; 062 } 063 064 @Override 065 public int[] getDefaultTokens() { 066 return getRequiredTokens(); 067 } 068 069 @Override 070 public int[] getAcceptableTokens() { 071 return getRequiredTokens(); 072 } 073 074 @Override 075 public int[] getRequiredTokens() { 076 return new int[] {TokenTypes.LITERAL_IF}; 077 } 078 079 @Override 080 public void visitToken(DetailAST literalIf) { 081 if (!isElseIf(literalIf)) { 082 if (depth > max) { 083 log(literalIf, MSG_KEY, depth, max); 084 } 085 ++depth; 086 } 087 } 088 089 @Override 090 public void leaveToken(DetailAST literalIf) { 091 if (!isElseIf(literalIf)) { 092 --depth; 093 } 094 } 095 096 /** 097 * Returns whether a token represents an ELSE as part of an ELSE / IF set. 098 * 099 * @param ast the token to check 100 * @return whether it is 101 */ 102 private static boolean isElseIf(DetailAST ast) { 103 final DetailAST parentAST = ast.getParent(); 104 105 return isElse(parentAST) || isElseWithCurlyBraces(parentAST); 106 } 107 108 /** 109 * Returns whether a token represents an ELSE. 110 * 111 * @param ast the token to check 112 * @return whether the token represents an ELSE 113 */ 114 private static boolean isElse(DetailAST ast) { 115 return ast.getType() == TokenTypes.LITERAL_ELSE; 116 } 117 118 /** 119 * Returns whether a token represents an SLIST as part of an ELSE statement. 120 * 121 * @param ast the token to check 122 * @return whether the toke does represent an SLIST as part of an ELSE 123 */ 124 private static boolean isElseWithCurlyBraces(DetailAST ast) { 125 return ast.getChildCount() == 2 && isElse(ast.getParent()); 126 } 127 128}