ios/chrome/browser/overlays/model/public/overlay_request.h

// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef IOS_CHROME_BROWSER_OVERLAYS_MODEL_PUBLIC_OVERLAY_REQUEST_H_
#define IOS_CHROME_BROWSER_OVERLAYS_MODEL_PUBLIC_OVERLAY_REQUEST_H_

#include <memory>

#include "base/supports_user_data.h"

class OverlayCallbackManager;
namespace web {
class WebState;
}

// Model object used to track overlays requested for OverlayManager.
class OverlayRequest {
 public:
  virtual ~OverlayRequest() = default;

  // Creates an OverlayRequest configured with an OverlayUserData of type
  // ConfigType.  The ConfigType is constructed using the arguments passed to
  // this function.  For example, if a configuration of type StringConfig has
  // a constructor that takes a string, a request configured with a StringConfig
  // can be created using:
  //
  // OverlayRequest::CreateWithConfig<StringConfig>("configuration string");
  template <class ConfigType, typename... Args>
  static std::unique_ptr<OverlayRequest> CreateWithConfig(Args&&... args) {
    std::unique_ptr<OverlayRequest> request = OverlayRequest::Create();
    ConfigType::CreateForUserData(request->data(), std::forward<Args>(args)...);
    return request;
  }

  // Returns the OverlayUserData of type ConfigType stored in the request's
  // user data, or nullptr if it is not found. For example, a configuration of
  // type Config can be retrieved using:
  //
  // request->GetConfig<Config>();
  template <class ConfigType>
  ConfigType* GetConfig() {
    return ConfigType::FromUserData(data());
  }

  // Returns the request's callback controller, which can be used to communicate
  // user interaction information back to the reqeuster.
  virtual OverlayCallbackManager* GetCallbackManager() = 0;

  // Returns the WebState into whose OverlayRequestQueue this request was added.
  // Default value before being added to a queue is null.  After being added to
  // a queue, the WebState will be set for the remainder of the request's
  // lifetime.
  virtual web::WebState* GetQueueWebState() = 0;

 protected:
  OverlayRequest() = default;

  // Creates an unconfigured OverlayRequest.
  static std::unique_ptr<OverlayRequest> Create();

  // The container used to hold the user data.
  virtual base::SupportsUserData* data() = 0;
};

#endif  // IOS_CHROME_BROWSER_OVERLAYS_MODEL_PUBLIC_OVERLAY_REQUEST_H_