// Copyright (c) 2012 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 CHROME_BROWSER_UI_WEBUI_CONSTRAINED_HTML_UI_H_
#define CHROME_BROWSER_UI_WEBUI_CONSTRAINED_HTML_UI_H_
#pragma once

#include "base/compiler_specific.h"
#include "content/public/browser/web_ui_controller.h"

class ConstrainedWindow;
class HtmlDialogTabContentsDelegate;
class HtmlDialogUIDelegate;
class Profile;
class TabContentsWrapper;

namespace base {
template<class T> class PropertyAccessor;
}

namespace content {
class RenderViewHost;
}

class ConstrainedHtmlUIDelegate {
 public:
  virtual const HtmlDialogUIDelegate* GetHtmlDialogUIDelegate() const = 0;
  virtual HtmlDialogUIDelegate* GetHtmlDialogUIDelegate() = 0;

  // Called when the dialog is being closed in response to a "DialogClose"
  // message from WebUI.
  virtual void OnDialogCloseFromWebUI() = 0;

  // If called, on dialog closure, the dialog will release its WebContents
  // instead of destroying it. After which point, the caller will own the
  // released WebContents.
  virtual void ReleaseTabContentsOnDialogClose() = 0;

  // Returns the ConstrainedWindow.
  virtual ConstrainedWindow* window() = 0;

  // Returns the TabContentsWrapper owned by the constrained window.
  virtual TabContentsWrapper* tab() = 0;

 protected:
  virtual ~ConstrainedHtmlUIDelegate() {}
};

// ConstrainedHtmlUI is a facility to show HTML WebUI content
// in a tab-modal constrained dialog.  It is implemented as an adapter
// between an HtmlDialogUI object and a ConstrainedWindow object.
//
// Since ConstrainedWindow requires platform-specific delegate
// implementations, this class is just a factory stub.
// TODO(thestig) Refactor the platform-independent code out of the
// platform-specific implementations.
class ConstrainedHtmlUI : public content::WebUIController {
 public:
  explicit ConstrainedHtmlUI(content::WebUI* web_ui);
  virtual ~ConstrainedHtmlUI();

  // WebUIController implementation:
  virtual void RenderViewCreated(
      content::RenderViewHost* render_view_host) OVERRIDE;

  // Create a constrained HTML dialog. The actual object that gets created
  // is a ConstrainedHtmlUIDelegate, which later triggers construction of a
  // ConstrainedHtmlUI object.
  // |profile| is used to construct the constrained HTML dialog's WebContents.
  // |delegate| controls the behavior of the dialog.
  // |tab_delegate| is optional, pass one in to use a custom
  //                HtmlDialogTabContentsDelegate with the dialog, or NULL to
  //                use the default one. The dialog takes ownership of
  //                |tab_delegate|.
  // |overshadowed| is the tab being overshadowed by the dialog.
  static ConstrainedHtmlUIDelegate* CreateConstrainedHtmlDialog(
      Profile* profile,
      HtmlDialogUIDelegate* delegate,
      HtmlDialogTabContentsDelegate* tab_delegate,
      TabContentsWrapper* overshadowed);

  // Returns a property accessor that can be used to set the
  // ConstrainedHtmlUIDelegate property on a WebContents.
  static base::PropertyAccessor<ConstrainedHtmlUIDelegate*>&
      GetPropertyAccessor();

 protected:
  // Returns the WebContents' PropertyBag's ConstrainedHtmlUIDelegate.
  // Returns NULL if that property is not set.
  ConstrainedHtmlUIDelegate* GetConstrainedDelegate();

 private:
  // JS Message Handler
  void OnDialogCloseMessage(const base::ListValue* args);

  DISALLOW_COPY_AND_ASSIGN(ConstrainedHtmlUI);
};

#endif  // CHROME_BROWSER_UI_WEBUI_CONSTRAINED_HTML_UI_H_