001    /*
002     * Copyright 2010-2015 JetBrains s.r.o.
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    
017    package org.jetbrains.kotlin.psi;
018    
019    import com.intellij.lang.ASTNode;
020    import com.intellij.psi.PsiElement;
021    import org.jetbrains.annotations.NotNull;
022    import org.jetbrains.annotations.Nullable;
023    import org.jetbrains.kotlin.KtNodeTypes;
024    import org.jetbrains.kotlin.lexer.KtTokens;
025    
026    public class KtForExpression extends KtLoopExpression {
027        public KtForExpression(@NotNull ASTNode node) {
028            super(node);
029        }
030    
031        @Override
032        public <R, D> R accept(@NotNull KtVisitor<R, D> visitor, D data) {
033            return visitor.visitForExpression(this, data);
034        }
035    
036        @Nullable @IfNotParsed
037        public KtParameter getLoopParameter() {
038            return (KtParameter) findChildByType(KtNodeTypes.VALUE_PARAMETER);
039        }
040    
041        @Nullable
042        public KtDestructuringDeclaration getDestructuringDeclaration() {
043            KtParameter loopParameter = getLoopParameter();
044            if (loopParameter == null) return null;
045            return loopParameter.getDestructuringDeclaration();
046        }
047    
048        @Nullable @IfNotParsed
049        public KtExpression getLoopRange() {
050            return findExpressionUnder(KtNodeTypes.LOOP_RANGE);
051        }
052    
053        @Nullable @IfNotParsed
054        public PsiElement getInKeyword() {
055            return findChildByType(KtTokens.IN_KEYWORD);
056        }
057    
058        @NotNull
059        public PsiElement getForKeyword() {
060            return findChildByType(KtTokens.FOR_KEYWORD);
061        }
062    }