// Copyright 2008, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef CHROME_BROWSER_VIEWS_SHELF_ITEM_DIALOG_H__
#define CHROME_BROWSER_VIEWS_SHELF_ITEM_DIALOG_H__

#include "chrome/browser/cancelable_request.h"
#include "chrome/browser/history/history.h"
#include "chrome/views/dialog_delegate.h"
#include "chrome/views/native_button.h"
#include "chrome/views/table_view.h"
#include "chrome/views/text_field.h"
#include "chrome/views/view.h"
#include "chrome/views/window.h"

namespace ChromeViews {
class Button;
class Label;
}

class PossibleURLModel;
class Profile;
class ShelfItemDialog;

// TODO(sky): rename this, perhaps to URLPicker.

// ShelfItemDialog delegate. Notified when the user accepts the entry.
class ShelfItemDialogDelegate {
 public:
  virtual void AddBookmark(ShelfItemDialog* dialog,
                           const std::wstring& title,
                           const GURL& url) = 0;
};

////////////////////////////////////////////////////////////////////////////////
//
// This class implements the dialog that let the user add a bookmark or page
// to the list of urls to open on startup.
// ShelfItemDialog deletes itself when the dialog is closed.
//
////////////////////////////////////////////////////////////////////////////////
class ShelfItemDialog : public ChromeViews::View,
                        public ChromeViews::DialogDelegate,
                        public ChromeViews::TextField::Controller,
                        public ChromeViews::TableViewObserver {
 public:
  ShelfItemDialog(ShelfItemDialogDelegate* delegate,
                  Profile* profile,
                  bool show_title);
  virtual ~ShelfItemDialog();

  // Show the dialog on the provided contents.
  virtual void Show(HWND parent);

  // Closes the dialog.
  void Close();

  // DialogDelegate.
  virtual std::wstring GetWindowTitle() const;
  virtual bool IsModal() const;
  virtual void WindowClosing();
  virtual std::wstring GetDialogButtonLabel(DialogButton button) const;
  virtual bool Accept();
  virtual bool IsDialogButtonEnabled(DialogButton button) const;
  virtual ChromeViews::View* GetContentsView();

  // TextField::Controller.
  virtual void ContentsChanged(ChromeViews::TextField* sender,
                               const std::wstring& new_contents);
  virtual void HandleKeystroke(ChromeViews::TextField* sender,
                               UINT message, TCHAR key, UINT repeat_count,
                               UINT flags) {}

  // Overridden from View.
  virtual void DidChangeBounds(const CRect& previous, const CRect& current);
  virtual void GetPreferredSize(CSize *out);
  virtual bool AcceleratorPressed(const ChromeViews::Accelerator& accelerator);

  // TableViewObserver.
  virtual void OnSelectionChanged();
  virtual void OnDoubleClick();

 private:
  // Modify the model from the user interface.
  void PerformModelChange();

  // Fetch the title for the entered URL. If we get the title in time before
  // the user starts to modify the title field, the title field is changed.
  void InitiateTitleAutoFill(const GURL& url);

  // Invoked by the history system when a title becomes available.
  void OnURLInfoAvailable(HistoryService::Handle handle,
                          bool success,
                          const history::URLRow* info,
                          history::VisitVector* unused);

  // Returns the URL the user has typed.
  GURL GetInputURL() const;

  // Profile.
  Profile* profile_;

  // URL Field.
  ChromeViews::TextField* url_field_;

  // Title field. This is NULL if we're not showing the title.
  ChromeViews::TextField* title_field_;

  // The table model.
  scoped_ptr<PossibleURLModel> url_table_model_;

  // The table of visited urls.
  ChromeViews::TableView* url_table_;

  // Handle of the title request we are expecting.
  CancelableRequestProvider::Handle expected_title_handle_;

  // The consumer object for the history database.
  CancelableRequestConsumer history_consumer_;

  // The delegate.
  ShelfItemDialogDelegate* delegate_;

  DISALLOW_EVIL_CONSTRUCTORS(ShelfItemDialog);
};

#endif  // CHROME_BROWSER_VIEWS_SHELF_ITEM_DIALOG_H__