[LayoutNG] Introduce block child iterator.

third_party/WebKit/Source/core/layout/ng/ng_block_child_iterator.cc

Index: third_party/WebKit/Source/core/layout/ng/ng_block_child_iterator.cc
diff --git a/third_party/WebKit/Source/core/layout/ng/ng_block_child_iterator.cc b/third_party/WebKit/Source/core/layout/ng/ng_block_child_iterator.cc
new file mode 100644
index 0000000000000000000000000000000000000000..63fb7007d8fb245668b4b20ddff1ff41c1e091bf
--- /dev/null
+++ b/third_party/WebKit/Source/core/layout/ng/ng_block_child_iterator.cc
@@ -0,0 +1,60 @@
+// Copyright 2017 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include "core/layout/ng/ng_block_child_iterator.h"
+
+#include "core/layout/ng/ng_block_break_token.h"
+#include "core/layout/ng/ng_layout_input_node.h"
+
+namespace blink {
+
+NGBlockChildIterator::NGBlockChildIterator(NGLayoutInputNode* first_child,
+                                           NGBlockBreakToken* break_token)
+    : child_(first_child), break_token_(break_token), child_token_idx_(0) {}
+
+std::pair<NGLayoutInputNode*, NGBreakToken*> NGBlockChildIterator::NextChild() {
+  NGLayoutInputNode* child = nullptr;
+  NGBreakToken* child_break_token = nullptr;
+
+  if (break_token_) {
+    // If we're resuming layout after a fragmentainer break, we need to skip
+    // siblings that we're done with. We may have been able to fully lay out
+    // some node(s) preceding a node that we had to break inside (and therefore
+    // were not able to fully lay out). This happens when we have parallel
+    // flows [1], which are caused by floats, overflow, etc.
+    //
+    // [1] https://drafts.csswg.org/css-break/#parallel-flows
+    do {
+      const auto& child_break_tokens = break_token_->ChildBreakTokens();

[mstensho (USE GERRIT), 2017/02/22 13:11:30]

Can be moved out of the do-while loop.

[ikilpatrick, 2017/02/22 18:47:19]

Done.

+      NGBreakToken* child_break_token_candidate = nullptr;
+
+      if (child_token_idx_ < child_break_tokens.size()) {

[mstensho (USE GERRIT), 2017/02/22 13:11:31]

Looks like you could get out early here if you do:

if (child_token_idx_ >= child_break_tokens.size())
    break;

[ikilpatrick, 2017/02/22 18:47:19]

Done.

+        child_break_token_candidate = child_break_tokens[child_token_idx_];
+      }
+
+      if (child_break_token_candidate &&
+          child_break_token_candidate->InputNode() == child_) {

[mstensho (USE GERRIT), 2017/02/22 13:11:31]

And how about breaking early here if child_break_token_candidate->InputNode() !=
child_?

[ikilpatrick, 2017/02/22 18:47:19]

Done.

+        ++child_token_idx_;
+
+        // We have only found a node if it's break token is unfinished.

[mstensho (USE GERRIT), 2017/02/22 13:11:30]

it's -> its

[ikilpatrick, 2017/02/22 18:47:19]

Done.

+        if (!child_break_token_candidate->IsFinished()) {
+          child_break_token = child_break_token_candidate;
+          break;

[mstensho (USE GERRIT), 2017/02/22 13:11:30]

Let me see if I've got this right:

Each child that we have previously started to lay out (and possibly also
finished) has an entry in child_break_tokens, while children that we haven't
visited at all yet don't? So, whether a child fragmented or not doesn't really
matter; they'll all get break tokens once we're finished with them (or when they
actually break)? Yes?

[ikilpatrick, 2017/02/22 18:47:19]

Yes thats exactly correct. I can try an encapsulate that in a comment if you
like.

[mstensho (USE GERRIT), 2017/02/22 20:09:23]

If it's a requirement that all finished nodes have break tokens, I'd like to
have that documented somewhere, if it isn't already.
Doing it in some follow-up CL would also be okay.

If this isn't the most appropriate place, maybe right before the definition of
NGBlockBreakToken::child_break_tokens_? Or before NGBlockBreakToken?

[ikilpatrick, 2017/02/22 22:25:21]

Clarified comment on NGBlockBreakToken.

[mstensho (USE GERRIT), 2017/02/23 08:31:40]

Excellent! Thanks.

+        }
+      } else {
+        // This child break token candidate doesn't match the current node,
+        // this node must be unfinished.
+        break;
+      }
+    } while ((child_ = child_->NextSibling()));
+  }
+
+  child = child_;
+  if (child_)
+    child_ = child_->NextSibling();
+
+  return std::make_pair(child, child_break_token);
+}
+
+}  // namespace blink