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.indentation;
021
022import com.puppycrawl.tools.checkstyle.api.DetailAST;
023import com.puppycrawl.tools.checkstyle.utils.TokenUtil;
024
025/**
026 * Handler for yield expression.
027 */
028public class YieldHandler extends AbstractExpressionHandler {
029
030    /**
031     * Construct an instance of this handler with the given indentation check,
032     * abstract syntax tree, and parent handler.
033     *
034     * @param indentCheck the indentation check
035     * @param ast         the abstract syntax tree
036     * @param parent      the parent handler
037     */
038    public YieldHandler(IndentationCheck indentCheck,
039                      DetailAST ast,
040                      AbstractExpressionHandler parent) {
041        super(indentCheck, "yield", ast, parent);
042    }
043
044    @Override
045    public IndentLevel getSuggestedChildIndent(AbstractExpressionHandler child) {
046        final IndentLevel result;
047        if (TokenUtil.areOnSameLine(getMainAst(), child.getMainAst())) {
048            result = getIndent();
049        }
050        else {
051            result = super.getSuggestedChildIndent(child);
052        }
053        return result;
054    }
055
056    @Override
057    public void checkIndentation() {
058        checkYield();
059        final DetailAST expression = getMainAst().getFirstChild();
060        if (!TokenUtil.areOnSameLine(getMainAst(), expression)) {
061            checkExpressionSubtree(expression, getIndent(), false, false);
062        }
063    }
064
065    /**
066     * Check the indentation of the yield keyword.
067     */
068    private void checkYield() {
069        final DetailAST yieldKey = getMainAst();
070        final int columnNo = expandedTabsColumnNo(yieldKey);
071        if (isOnStartOfLine(yieldKey) && !getIndent().isAcceptable(columnNo)) {
072            logError(yieldKey, "", columnNo);
073        }
074    }
075}