// 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_HOST_DESKTOP_H_
#define CHROME_BROWSER_UI_HOST_DESKTOP_H_

#include "ui/gfx/native_widget_types.h"

class Browser;

namespace chrome {

// A value that specifies what desktop environment hosts a particular piece of
// UI.
// Note that HOST_DESKTOP_TYPE_ASH is always used on ChromeOS.
enum HostDesktopType {
  HOST_DESKTOP_TYPE_FIRST = 0,

  // The UI is hosted on the system native desktop.
  HOST_DESKTOP_TYPE_NATIVE = HOST_DESKTOP_TYPE_FIRST,

  // The UI is hosted in the synthetic Ash desktop.
#if defined(OS_CHROMEOS)
  HOST_DESKTOP_TYPE_ASH = HOST_DESKTOP_TYPE_NATIVE,
#else
  HOST_DESKTOP_TYPE_ASH,
#endif

  HOST_DESKTOP_TYPE_COUNT
};

// Used during initialization to override parenting.
class ScopedForceDesktopType {
 public:
  explicit ScopedForceDesktopType(HostDesktopType type);
  ~ScopedForceDesktopType();
 private:
  HostDesktopType previous_type_;
  bool previous_force_;

  DISALLOW_COPY_AND_ASSIGN(ScopedForceDesktopType);
};

HostDesktopType GetHostDesktopTypeForNativeView(gfx::NativeView native_view);
HostDesktopType GetHostDesktopTypeForNativeWindow(
    gfx::NativeWindow native_window);

// Returns the desktop type forced by an active ScopedForceDesktopType or
// |browser|'s desktop type. Most consumers shouldn't need to care about
// ScopedForceDesktopType and should use |browser|'s host_desktop_type()
// directly.
HostDesktopType GetHostDesktopTypeForBrowser(const Browser* browser);

// Returns the type of host desktop most likely to be in use.  This is the one
// most recently activated by the user.
HostDesktopType GetActiveDesktop();

}  // namespace chrome

#endif  // CHROME_BROWSER_UI_HOST_DESKTOP_H_