// Copyright (c) 2009 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_EXTENSIONS_EXTENSION_TABS_MODULE_H__
#define CHROME_BROWSER_EXTENSIONS_EXTENSION_TABS_MODULE_H__

#include <string>

#include "chrome/browser/extensions/extension_function.h"
#include "chrome/common/notification_service.h"
#include "chrome/common/notification_registrar.h"

class Browser;
class DictionaryValue;
class TabContents;
class TabStripModel;

class ExtensionTabUtil {
 public:
  // Possible tab states.  These states are used to calculate the "status"
  // property of the Tab object that is used in the extension tab API.
  enum TabStatus {
    TAB_LOADING,  // Waiting for the DOM to load.
    TAB_COMPLETE  // Tab loading and rendering is complete.
  };

  static int GetWindowId(const Browser* browser);
  static int GetTabId(const TabContents* tab_contents);
  static TabStatus GetTabStatus(const TabContents* tab_contents);
  static std::string GetTabStatusText(TabStatus status);
  static int GetWindowIdOfTab(const TabContents* tab_contents);
  static DictionaryValue* CreateTabValue(const TabContents* tab_contents);
  static DictionaryValue* CreateTabValue(const TabContents* tab_contents,
                                         TabStripModel* tab_strip,
                                         int tab_index);

  // Any out parameter (|browser|, |tab_strip|, |contents|, & |tab_index|) may
  // be NULL and will not be set within the function.
  static bool GetTabById(int tab_id, Profile* profile, Browser** browser,
                         TabStripModel** tab_strip,
                         TabContents** contents,
                         int* tab_index);
};

// Windows
class GetWindowFunction : public SyncExtensionFunction {
  virtual bool RunImpl();
};
class GetCurrentWindowFunction : public SyncExtensionFunction {
  virtual bool RunImpl();
};
class GetLastFocusedWindowFunction : public SyncExtensionFunction {
  virtual bool RunImpl();
};
class GetAllWindowsFunction : public SyncExtensionFunction {
  virtual bool RunImpl();
};
class CreateWindowFunction : public SyncExtensionFunction {
  virtual bool RunImpl();
};
class UpdateWindowFunction : public SyncExtensionFunction {
  virtual bool RunImpl();
};
class RemoveWindowFunction : public SyncExtensionFunction {
  virtual bool RunImpl();
};

// Tabs
class GetTabFunction : public SyncExtensionFunction {
  virtual bool RunImpl();
};
class GetSelectedTabFunction : public SyncExtensionFunction {
  virtual bool RunImpl();
};
class GetAllTabsInWindowFunction : public SyncExtensionFunction {
  virtual bool RunImpl();
};
class CreateTabFunction : public SyncExtensionFunction {
  virtual bool RunImpl();
};
class UpdateTabFunction : public SyncExtensionFunction {
  virtual bool RunImpl();
};
class MoveTabFunction : public SyncExtensionFunction {
  virtual bool RunImpl();
};
class RemoveTabFunction : public SyncExtensionFunction {
  virtual bool RunImpl();
};
class DetectTabLanguageFunction : public AsyncExtensionFunction,
                                  public NotificationObserver {
  virtual bool RunImpl();

 private:
  virtual void Observe(NotificationType type,
                       const NotificationSource& source,
                       const NotificationDetails& details);
  NotificationRegistrar registrar_;
};

#endif  // CHROME_BROWSER_EXTENSIONS_EXTENSION_TABS_MODULE_H__