From 47ea25dbc2ec1975b1b39006a73324caa4992a6d Mon Sep 17 00:00:00 2001
From: Andrey Breslav <andrey.breslav@jetbrains.com>
Date: Fri, 29 Nov 2013 15:20:54 +0400
Subject: [PATCH] Rearranged declarations, added missing annotations in
 JetControlFlowBuilder

---
 .../jet/lang/cfg/JetControlFlowBuilder.java   | 62 ++++++++++---------
 .../cfg/JetControlFlowBuilderAdapter.java     |  7 ++-
 .../JetControlFlowInstructionsGenerator.java  | 10 ++-
 3 files changed, 44 insertions(+), 35 deletions(-)

diff --git a/compiler/frontend/src/org/jetbrains/jet/lang/cfg/JetControlFlowBuilder.java b/compiler/frontend/src/org/jetbrains/jet/lang/cfg/JetControlFlowBuilder.java
index 3441f29d747..de9860299ba 100644
--- a/compiler/frontend/src/org/jetbrains/jet/lang/cfg/JetControlFlowBuilder.java
+++ b/compiler/frontend/src/org/jetbrains/jet/lang/cfg/JetControlFlowBuilder.java
@@ -21,14 +21,31 @@ import org.jetbrains.annotations.Nullable;
 import org.jetbrains.jet.lang.cfg.pseudocode.Pseudocode;
 import org.jetbrains.jet.lang.psi.*;
 
-import java.util.Collection;
 import java.util.List;
 
 public interface JetControlFlowBuilder {
-    void read(@NotNull JetElement element);
-    void readUnit(@NotNull JetExpression expression);
+    // Subroutines
+    void enterSubroutine(@NotNull JetElement subroutine);
 
-    // General label management
+    @NotNull
+    Pseudocode exitSubroutine(@NotNull JetElement subroutine);
+
+    @NotNull
+    JetElement getCurrentSubroutine();
+    @Nullable
+    JetElement getReturnSubroutine();
+
+    // Entry/exit points
+    @NotNull
+    Label getEntryPoint(@NotNull JetElement labelElement);
+    @NotNull
+    Label getExitPoint(@NotNull JetElement labelElement);
+
+    // Declarations
+    void declare(@NotNull JetParameter parameter);
+    void declare(@NotNull JetVariableDeclaration property);
+
+    // Labels
     @NotNull
     Label createUnboundLabel();
     @NotNull
@@ -40,13 +57,14 @@ public interface JetControlFlowBuilder {
     void jump(@NotNull Label label);
     void jumpOnFalse(@NotNull Label label);
     void jumpOnTrue(@NotNull Label label);
-    void nondeterministicJump(Label label); // Maybe, jump to label
-    void nondeterministicJump(List<Label> label);
+    void nondeterministicJump(@NotNull Label label); // Maybe, jump to label
+    void nondeterministicJump(@NotNull List<Label> label);
     void jumpToError();
 
-    // Entry/exit points
-    Label getEntryPoint(@NotNull JetElement labelElement);
-    Label getExitPoint(@NotNull JetElement labelElement);
+    void returnValue(@NotNull JetExpression returnExpression, @NotNull JetElement subroutine);
+    void returnNoValue(@NotNull JetElement returnExpression, @NotNull JetElement subroutine);
+
+    void throwException(@NotNull JetThrowExpression throwExpression);
 
     // Loops
     LoopInfo enterLoop(@NotNull JetExpression expression, @Nullable Label loopExitPoint, @Nullable Label conditionEntryPoint);
@@ -55,33 +73,17 @@ public interface JetControlFlowBuilder {
     @Nullable
     JetElement getCurrentLoop();
 
-    // Finally
+    // Try-Finally
     void enterTryFinally(@NotNull GenerationTrigger trigger);
     void exitTryFinally();
 
-    // Subroutines
-    void enterSubroutine(@NotNull JetElement subroutine);
-
-    Pseudocode exitSubroutine(@NotNull JetElement subroutine);
-
-    @NotNull
-    JetElement getCurrentSubroutine();
-    @Nullable
-    JetElement getReturnSubroutine();
-    
-    void returnValue(@NotNull JetExpression returnExpression, @NotNull JetElement subroutine);
-
-    void returnNoValue(@NotNull JetElement returnExpression, @NotNull JetElement subroutine);
-    
-    void throwException(@NotNull JetThrowExpression throwExpression);
+    void repeatPseudocode(@NotNull Label startLabel, @NotNull Label finishLabel);
 
+    // Reading values
+    void readUnit(@NotNull JetExpression expression);
+    void read(@NotNull JetElement element);
     void write(@NotNull JetElement assignment, @NotNull JetElement lValue);
     
-    void declare(@NotNull JetParameter parameter);
-    void declare(@NotNull JetVariableDeclaration property);
-
     // Other
     void unsupported(JetElement element);
-
-    void repeatPseudocode(@NotNull Label startLabel, @NotNull Label finishLabel);
 }
diff --git a/compiler/frontend/src/org/jetbrains/jet/lang/cfg/JetControlFlowBuilderAdapter.java b/compiler/frontend/src/org/jetbrains/jet/lang/cfg/JetControlFlowBuilderAdapter.java
index a5ca2df280d..03fe58d95bb 100644
--- a/compiler/frontend/src/org/jetbrains/jet/lang/cfg/JetControlFlowBuilderAdapter.java
+++ b/compiler/frontend/src/org/jetbrains/jet/lang/cfg/JetControlFlowBuilderAdapter.java
@@ -78,13 +78,13 @@ public class JetControlFlowBuilderAdapter implements JetControlFlowBuilder {
     }
 
     @Override
-    public void nondeterministicJump(Label label) {
+    public void nondeterministicJump(@NotNull Label label) {
         assert builder != null;
         builder.nondeterministicJump(label);
     }
 
     @Override
-    public void nondeterministicJump(List<Label> labels) {
+    public void nondeterministicJump(@NotNull List<Label> labels) {
         assert builder != null;
         builder.nondeterministicJump(labels);
     }
@@ -101,11 +101,13 @@ public class JetControlFlowBuilderAdapter implements JetControlFlowBuilder {
         builder.throwException(throwExpression);
     }
     
+    @NotNull
     public Label getEntryPoint(@NotNull JetElement labelElement) {
         assert builder != null;
         return builder.getEntryPoint(labelElement);
     }
 
+    @NotNull
     @Override
     public Label getExitPoint(@NotNull JetElement labelElement) {
         assert builder != null;
@@ -149,6 +151,7 @@ public class JetControlFlowBuilderAdapter implements JetControlFlowBuilder {
         builder.enterSubroutine(subroutine);
     }
 
+    @NotNull
     @Override
     public Pseudocode exitSubroutine(@NotNull JetElement subroutine) {
         assert builder != null;
diff --git a/compiler/frontend/src/org/jetbrains/jet/lang/cfg/pseudocode/JetControlFlowInstructionsGenerator.java b/compiler/frontend/src/org/jetbrains/jet/lang/cfg/pseudocode/JetControlFlowInstructionsGenerator.java
index 8b52861c9f0..31a058a27da 100644
--- a/compiler/frontend/src/org/jetbrains/jet/lang/cfg/pseudocode/JetControlFlowInstructionsGenerator.java
+++ b/compiler/frontend/src/org/jetbrains/jet/lang/cfg/pseudocode/JetControlFlowInstructionsGenerator.java
@@ -67,6 +67,7 @@ public class JetControlFlowInstructionsGenerator extends JetControlFlowBuilderAd
         builder.enterSubroutine(subroutine);
     }
 
+    @NotNull
     @Override
     public Pseudocode exitSubroutine(@NotNull JetElement subroutine) {
         super.exitSubroutine(subroutine);
@@ -165,11 +166,13 @@ public class JetControlFlowInstructionsGenerator extends JetControlFlowBuilderAd
             return returnSubroutine;// subroutineInfo.empty() ? null : subroutineInfo.peek().getElement();
         }
 
+        @NotNull
         @Override
         public Label getEntryPoint(@NotNull JetElement labelElement) {
             return elementToBlockInfo.get(labelElement).getEntryPoint();
         }
 
+        @NotNull
         @Override
         public Label getExitPoint(@NotNull JetElement labelElement) {
             BreakableBlockInfo blockInfo = elementToBlockInfo.get(labelElement);
@@ -201,6 +204,7 @@ public class JetControlFlowInstructionsGenerator extends JetControlFlowBuilderAd
             }
         }
 
+        @NotNull
         @Override
         public Pseudocode exitSubroutine(@NotNull JetElement subroutine) {
             bindLabel(getExitPoint(subroutine));
@@ -211,7 +215,7 @@ public class JetControlFlowInstructionsGenerator extends JetControlFlowBuilderAd
             pseudocode.addSinkInstruction(new SubroutineSinkInstruction(subroutine, "<SINK>"));
             elementToBlockInfo.remove(subroutine);
             allBlocks.pop();
-            return null;
+            return pseudocode;
         }
 
         @Override
@@ -277,13 +281,13 @@ public class JetControlFlowInstructionsGenerator extends JetControlFlowBuilderAd
         }
 
         @Override
-        public void nondeterministicJump(Label label) {
+        public void nondeterministicJump(@NotNull Label label) {
             handleJumpInsideTryFinally(label);
             add(new NondeterministicJumpInstruction(label));
         }
 
         @Override
-        public void nondeterministicJump(List<Label> labels) {
+        public void nondeterministicJump(@NotNull List<Label> labels) {
             //todo
             //handleJumpInsideTryFinally(label);
             add(new NondeterministicJumpInstruction(labels));