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.cfg.pseudocode;
018    
019    import org.jetbrains.annotations.NotNull;
020    import org.jetbrains.annotations.Nullable;
021    import org.jetbrains.kotlin.cfg.pseudocode.instructions.Instruction;
022    import org.jetbrains.kotlin.cfg.pseudocode.instructions.special.LocalFunctionDeclarationInstruction;
023    import org.jetbrains.kotlin.cfg.pseudocode.instructions.special.SubroutineEnterInstruction;
024    import org.jetbrains.kotlin.cfg.pseudocode.instructions.special.SubroutineExitInstruction;
025    import org.jetbrains.kotlin.cfg.pseudocode.instructions.special.SubroutineSinkInstruction;
026    import org.jetbrains.kotlin.psi.JetElement;
027    
028    import java.util.List;
029    import java.util.Set;
030    
031    public interface Pseudocode {
032        @NotNull
033        JetElement getCorrespondingElement();
034    
035        @Nullable
036        Pseudocode getParent();
037    
038        @NotNull
039        Set<LocalFunctionDeclarationInstruction> getLocalDeclarations();
040    
041        @NotNull
042        List<Instruction> getInstructions();
043    
044        @NotNull
045        List<Instruction> getReversedInstructions();
046    
047        @NotNull
048        List<Instruction> getInstructionsIncludingDeadCode();
049    
050        @NotNull
051        SubroutineExitInstruction getExitInstruction();
052    
053        @NotNull
054        SubroutineSinkInstruction getSinkInstruction();
055    
056        @NotNull
057        SubroutineEnterInstruction getEnterInstruction();
058    
059        @Nullable
060        PseudoValue getElementValue(@Nullable JetElement element);
061    
062        @NotNull
063        List<? extends JetElement> getValueElements(@Nullable PseudoValue value);
064    
065        @NotNull
066        List<? extends Instruction> getUsages(@Nullable PseudoValue value);
067    
068        boolean isSideEffectFree(@NotNull Instruction instruction);
069    }