components/web_view/frame_tree.h

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef COMPONENTS_WEB_VIEW_FRAME_TREE_H_
   6 #define COMPONENTS_WEB_VIEW_FRAME_TREE_H_
   7
   8 #include "components/view_manager/public/interfaces/view_tree.mojom.h"
   9 #include "components/web_view/frame.h"
  10 #include "third_party/mojo/src/mojo/public/cpp/bindings/array.h"
  11
  12 namespace mojo {
  13 class String;
  14 }
  15
  16 namespace web_view {
  17
  18 class FrameTreeClient;
  19 class FrameTreeDelegate;
  20 class FrameUserData;
  21
  22 // FrameTree manages the set of Frames that comprise a single url. FrameTree
  23 // owns the root Frame and each Frame owns its children. Frames are
  24 // automatically deleted and removed from the tree if the corresponding view is
  25 // deleted. This happens if the creator of the view deletes it (say an iframe is
  26 // destroyed).
  27 class FrameTree {
  28  public:
  29   // |view| is the view to do the initial embedding in. It is assumed |view|
  30   // outlives FrameTree.
  31   // |client_properties| is the client properties for the root frame.
  32   // |root_app_id| is a unique identifier of the app providing |root_client|.
  33   // See Frame for details on app id's.
  34   FrameTree(uint32_t root_app_id,
  35             mojo::View* view,
  36             mojo::ViewTreeClientPtr view_tree_client,
  37             FrameTreeDelegate* delegate,
  38             FrameTreeClient* root_client,
  39             scoped_ptr<FrameUserData> user_data,
  40             const Frame::ClientPropertyMap& client_properties);
  41   ~FrameTree();
  42
  43   // Returns true if there should be a distinct renderer per frame. This is
  44   // useful for testing.
  45   static bool AlwaysCreateNewFrameTree();
  46
  47   const Frame* root() const { return root_; }
  48   Frame* root() { return root_; }
  49   uint32_t change_id() const { return change_id_; }
  50
  51  private:
  52   friend class Frame;
  53
  54   // Creates a new Frame parented to |parent|. The Frame is considered shared in
  55   // that it is sharing the FrameTreeClient/FrameTreeServer of |parent|. There
  56   // may or may not be a View identified by |frame_id| yet. See Frame for
  57   // details.
  58   Frame* CreateSharedFrame(Frame* parent,
  59                            uint32_t frame_id,
  60                            uint32_t app_id,
  61                            const Frame::ClientPropertyMap& client_properties);
  62
  63   // Increments the change id, returning the new value.
  64   uint32_t AdvanceChangeID();
  65
  66   void LoadingStateChanged();
  67   void ProgressChanged();
  68   void TitleChanged(const mojo::String& title);
  69   void ClientPropertyChanged(const Frame* source,
  70                              const mojo::String& name,
  71                              const mojo::Array<uint8_t>& value);
  72
  73   mojo::View* view_;
  74
  75   FrameTreeDelegate* delegate_;
  76
  77   // |root_| is owned by this, but a raw pointer as during destruction we still
  78   // want access to it.
  79   Frame* root_;
  80
  81   double progress_;
  82
  83   uint32_t change_id_;
  84
  85   DISALLOW_COPY_AND_ASSIGN(FrameTree);
  86 };
  87
  88 }  // namespace web_view
  89
  90 #endif  // COMPONENTS_WEB_VIEW_FRAME_TREE_H_