Await it!

runtime/vm/ast.h

 // Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 #ifndef VM_AST_H_
 #define VM_AST_H_
 
 #include "platform/assert.h"
 #include "vm/allocation.h"
 #include "vm/growable_array.h"
 #include "vm/scopes.h"
 #include "vm/object.h"
 #include "vm/native_entry.h"
 #include "vm/token.h"
 
 namespace dart {
 
 #define FOR_EACH_NODE(V)                                                       \
   V(Await)                                                                     \
+  V(AwaitMarker)                                                               \
   V(Return)                                                                    \
   V(Literal)                                                                   \
   V(Type)                                                                      \
   V(Assignable)                                                                \
   V(BinaryOp)                                                                  \
   V(BinaryOpWithMask32)                                                        \
   V(Comparison)                                                                \
   V(UnaryOp)                                                                   \
   V(ConditionalExpr)                                                           \
   V(If)                                                                        \
@@ skipping 131 matching lines @@
 
   DECLARE_COMMON_NODE_FUNCTIONS(AwaitNode);
 
  private:
   AstNode* expr_;
 
   DISALLOW_COPY_AND_ASSIGN(AwaitNode);
 };
 
 
+// AwaitMarker nodes are used to generate markers that the FlowGraphBuilder
+// relies on. They can occur in two kinds:
+// 1) kNewContinuationState: A marker indicating that a new await state needs to
+//    be added to a function preamble. This type also triggers storing of the
+//    current context.
+// 2) kTargetForContinuation: A marker indicating an entry point for the last

[hausner, 2014/08/20 21:42:52]

Last as in "most recent" or "previous".

[Michael Lippautz (Google), 2014/08/21 16:39:14]

done: most recent

+//    generated state.
+//
+// In general it is expected (ASSERT) that the different kinds of markers reach
+// the FlowGraphBuilder in alternating order. That is:
+//   <new state> -> <other nodes> -> <target> -> <other nodes> ->
+//   <new state> -> ...
+class AwaitMarkerNode : public AstNode {
+ public:
+  enum Type {
+    kNewContinuationState,
+    kTargetForContinuation,
+  };
+
+  explicit AwaitMarkerNode(Type type)
+    : AstNode(Scanner::kNoSourcePos), type_(type) { }
+
+  void VisitChildren(AstNodeVisitor* visitor) const { }
+
+  Type type() const { return type_; }
+
+  LocalScope* scope() const { return scope_; }
+  void set_scope(LocalScope* scope) { scope_ = scope; }
+
+  DECLARE_COMMON_NODE_FUNCTIONS(AwaitMarkerNode);
+
+ private:
+  Type type_;
+  LocalScope* scope_;
+
+  DISALLOW_COPY_AND_ASSIGN(AwaitMarkerNode);
+};
+
+
 class SequenceNode : public AstNode {
  public:
   SequenceNode(intptr_t token_pos, LocalScope* scope)
     : AstNode(token_pos),
       scope_(scope),
       nodes_(4),
       label_(NULL) {
   }
 
   LocalScope* scope() const { return scope_; }
@@ skipping 348 matching lines @@
 
   DECLARE_COMMON_NODE_FUNCTIONS(PrimaryNode);
 
  private:
   const Object& primary_;
   bool is_deferred_reference_;
 
   DISALLOW_IMPLICIT_CONSTRUCTORS(PrimaryNode);
 };
 
-
-// TODO(mlippautz): Implement return nodes that are used to return from a
-// continuation.
+// Return nodes can be of different types:
+// * A regular return node that in the case of async functions gets replaced
+//   with appropriate completer calls. This kind is generated by dart code.
+// * A continuation return that just returns from a function. This kind is
+//   generated by AST transformers.
 class ReturnNode : public AstNode {
  public:
+  enum Type {

[srdjan, 2014/08/20 23:08:42]

I would rename the enum since we have a class Type already (see object.h). Maybe
ReturnType?

[Michael Lippautz (Google), 2014/08/21 16:39:14]

Done.

+    kRegular,
+    kContinuation,
+  };
+
   // Return from a void function returns the null object.
   explicit ReturnNode(intptr_t token_pos)
       : AstNode(token_pos),
         value_(new LiteralNode(token_pos, Instance::ZoneHandle())),
         inlined_finally_list_(),
-        is_regular_return_(true) { }
+        type_(kRegular) { }
   // Return from a non-void function.
   ReturnNode(intptr_t token_pos,
              AstNode* value)
       : AstNode(token_pos),
         value_(value),
         inlined_finally_list_(),
-        is_regular_return_(true) {
+        type_(kRegular) {
     ASSERT(value_ != NULL);
   }
 
   AstNode* value() const { return value_; }
 
   intptr_t inlined_finally_list_length() const {
     return inlined_finally_list_.length();
   }
   InlinedFinallyNode* InlinedFinallyNodeAt(intptr_t index) const {
     return inlined_finally_list_[index];
   }
   void AddInlinedFinallyNode(InlinedFinallyNode* finally_node) {
     inlined_finally_list_.Add(finally_node);
   }
 
   virtual void VisitChildren(AstNodeVisitor* visitor) const {
     if (value() != NULL) {
       value()->Visit(visitor);
     }
   }
 
   void set_scope(LocalScope* scope) { scope_ = scope; }
   LocalScope* scope() const { return scope_; }
 
-  // Returns false if the return node is used to return from a continuation.
-  bool is_regular_return() const { return is_regular_return_; }
+  Type type() const { return type_; }
+  void set_type(Type type) { type_ = type; }
 
   DECLARE_COMMON_NODE_FUNCTIONS(ReturnNode);
 
  private:
   AstNode* value_;
   GrowableArray<InlinedFinallyNode*> inlined_finally_list_;
   LocalScope* scope_;
-  bool is_regular_return_;
+  Type type_;

[srdjan, 2014/08/20 23:08:42]

Add printing of type to ReturnNode printing.

[Michael Lippautz (Google), 2014/08/21 16:39:14]

Done.

 
   DISALLOW_COPY_AND_ASSIGN(ReturnNode);
 };
 
 
 class ComparisonNode : public AstNode {
  public:
   ComparisonNode(intptr_t token_pos,
                  Token::Kind kind,
                  AstNode* left,
@@ skipping 1247 matching lines @@
   const intptr_t try_index_;
 
   DISALLOW_IMPLICIT_CONSTRUCTORS(InlinedFinallyNode);
 };
 
 }  // namespace dart
 
 #undef DECLARE_COMMON_NODE_FUNCTIONS
 
 #endif  // VM_AST_H_