mandoline/tab/frame_tree.h

// Copyright 2015 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.

#ifndef MANDOLINE_TAB_FRAME_TREE_H_
#define MANDOLINE_TAB_FRAME_TREE_H_

#include "mandoline/tab/frame.h"
#include "third_party/mojo/src/mojo/public/cpp/bindings/array.h"

namespace mojo {
class String;
}

namespace mandoline {

class FrameTreeClient;
class FrameTreeDelegate;
class FrameUserData;

// FrameTree manages the set of Frames that comprise a single url. FrameTree
// owns the root Frame and each Frame owns its children. Frames are
// automatically deleted and removed from the tree if the corresponding view is
// deleted. This happens if the creator of the view deletes it (say an iframe is
// destroyed).
class FrameTree {
 public:
  // |view| is the view to do the initial embedding in. It is assumed |view|
  // outlives FrameTree.
  FrameTree(mojo::View* view,
            FrameTreeDelegate* delegate,
            FrameTreeClient* root_client,
            scoped_ptr<FrameUserData> user_data);
  ~FrameTree();

  Frame* root() { return &root_; }

  uint32_t change_id() const { return change_id_; }

  Frame* CreateAndAddFrame(mojo::View* view,
                           Frame* parent,
                           FrameTreeClient* client,
                           scoped_ptr<FrameUserData> user_data);

  // Creates a new Frame parented to |parent|. The Frame is considered shared in
  // that it is sharing the FrameTreeClient/FrameTreeServer of |parent|. There
  // may or may not be a View identified by |frame_id| yet. See Frame for
  // details.
  void CreateSharedFrame(Frame* parent,
                         uint32_t frame_id,
                         const Frame::ClientPropertyMap& client_properties);

 private:
  friend class Frame;

  // Increments the change id, returning the new value.
  uint32_t AdvanceChangeID();

  Frame* CreateAndAddFrameImpl(
      mojo::View* view,
      uint32_t frame_id,
      Frame* parent,
      FrameTreeClient* client,
      scoped_ptr<FrameUserData> user_data,
      const Frame::ClientPropertyMap& client_properties);

  void LoadingStateChanged();
  void ProgressChanged();
  void ClientPropertyChanged(const Frame* source,
                             const mojo::String& name,
                             const mojo::Array<uint8_t>& value);

  mojo::View* view_;

  FrameTreeDelegate* delegate_;

  Frame root_;

  double progress_;

  uint32_t change_id_;

  DISALLOW_COPY_AND_ASSIGN(FrameTree);
};

}  // namespace mandoline

#endif  // MANDOLINE_TAB_FRAME_TREE_H_