ios/web/web_state/web_frames_manager_impl.h

// Copyright 2018 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 IOS_WEB_WEB_STATE_WEB_FRAMES_MANAGER_IMPL_H_
#define IOS_WEB_WEB_STATE_WEB_FRAMES_MANAGER_IMPL_H_

#import "ios/web/public/web_state/web_frames_manager.h"

namespace web {

class WebFrame;

class WebFramesManagerImpl : public WebFramesManager {
 public:
  ~WebFramesManagerImpl() override;
  explicit WebFramesManagerImpl(web::WebState* web_state);

  static void CreateForWebState(WebState* web_state);
  static WebFramesManagerImpl* FromWebState(WebState* web_state);

  // Adds |frame| to the list of web frames associated with WebState.
  // The frame must not be already in the frame manager (the frame manager must
  // not have a frame with the same frame ID). If |frame| is a main frame, the
  // frame manager must not have a main frame already.
  void AddFrame(std::unique_ptr<WebFrame> frame);
  // Removes the web frame with |frame_id|, if one exists, from the list of
  // associated web frames.
  // If the frame manager does not contain a frame with this ID, operation is a
  // no-op.
  void RemoveFrameWithId(const std::string& frame_id);
  // Removes all web frames from the list of associated web frames.
  void RemoveAllWebFrames();

  // WebFramesManager overrides
  std::set<WebFrame*> GetAllWebFrames() override;
  WebFrame* GetMainWebFrame() override;
  WebFrame* GetFrameWithId(const std::string& frame_id) override;

 private:
  friend class web::WebStateUserData<WebFramesManagerImpl>;

  // List of pointers to all web frames associated with WebState.
  std::map<std::string, std::unique_ptr<WebFrame>> web_frames_;

  // Reference to the current main web frame.
  WebFrame* main_web_frame_ = nullptr;
  WebState* web_state_ = nullptr;
};

}  // namespace web

#endif  // IOS_WEB_WEB_STATE_WEB_FRAMES_MANAGER_H_