src/third_party/libjingle/source/talk/base/window.h

   1 /*
   2  * libjingle
   3  * Copyright 2004--2005, Google Inc.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  *  1. Redistributions of source code must retain the above copyright notice,
   9  *     this list of conditions and the following disclaimer.
  10  *  2. Redistributions in binary form must reproduce the above copyright notice,
  11  *     this list of conditions and the following disclaimer in the documentation
  12  *     and/or other materials provided with the distribution.
  13  *  3. The name of the author may not be used to endorse or promote products
  14  *     derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
  19  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef TALK_BASE_WINDOW_H_
  29 #define TALK_BASE_WINDOW_H_
  30
  31 #include "talk/base/stringencode.h"
  32
  33 // Define platform specific window types.
  34 #if defined(LINUX)
  35 typedef unsigned long Window;  // Avoid include <X11/Xlib.h>.
  36 #elif defined(WIN32)
  37 // We commonly include win32.h in talk/base so just include it here.
  38 #include "talk/base/win32.h"  // Include HWND, HMONITOR.
  39 #elif defined(OSX)
  40 typedef unsigned int CGWindowID;
  41 typedef unsigned int CGDirectDisplayID;
  42 #endif
  43
  44 namespace talk_base {
  45
  46 class WindowId {
  47  public:
  48   // Define WindowT for each platform.
  49 #if defined(LINUX)
  50   typedef Window WindowT;
  51 #elif defined(WIN32)
  52   typedef HWND WindowT;
  53 #elif defined(OSX)
  54   typedef CGWindowID WindowT;
  55 #else
  56   typedef unsigned int WindowT;
  57 #endif
  58
  59   static WindowId Cast(uint64 id) {
  60 #if defined(WIN32)
  61     return WindowId(reinterpret_cast<WindowId::WindowT>(id));
  62 #else
  63     return WindowId(static_cast<WindowId::WindowT>(id));
  64 #endif
  65   }
  66
  67   static uint64 Format(const WindowT& id) {
  68 #if defined(WIN32)
  69     return static_cast<uint64>(reinterpret_cast<uintptr_t>(id));
  70 #else
  71     return static_cast<uint64>(id);
  72 #endif
  73   }
  74
  75   WindowId() : id_(0) {}
  76   WindowId(const WindowT& id) : id_(id) {}  // NOLINT
  77   const WindowT& id() const { return id_; }
  78   bool IsValid() const { return id_ != 0; }
  79   bool Equals(const WindowId& other) const {
  80     return id_ == other.id();
  81   }
  82
  83  private:
  84   WindowT id_;
  85 };
  86
  87 class DesktopId {
  88  public:
  89   // Define DesktopT for each platform.
  90 #if defined(LINUX)
  91   typedef Window DesktopT;
  92 #elif defined(WIN32)
  93   typedef HMONITOR DesktopT;
  94 #elif defined(OSX)
  95   typedef CGDirectDisplayID DesktopT;
  96 #else
  97   typedef unsigned int DesktopT;
  98 #endif
  99
 100   static DesktopId Cast(int id, int index) {
 101 #if defined(WIN32)
 102     return DesktopId(reinterpret_cast<DesktopId::DesktopT>(id), index);
 103 #else
 104     return DesktopId(static_cast<DesktopId::DesktopT>(id), index);
 105 #endif
 106   }
 107
 108   DesktopId() : id_(0), index_(-1) {}
 109   DesktopId(const DesktopT& id, int index)  // NOLINT
 110       : id_(id), index_(index) {
 111   }
 112   const DesktopT& id() const { return id_; }
 113   int index() const { return index_; }
 114   bool IsValid() const { return index_ != -1; }
 115   bool Equals(const DesktopId& other) const {
 116     return id_ == other.id() && index_ == other.index();
 117   }
 118
 119  private:
 120   // Id is the platform specific desktop identifier.
 121   DesktopT id_;
 122   // Index is the desktop index as enumerated by each platform.
 123   // Desktop capturer typically takes the index instead of id.
 124   int index_;
 125 };
 126
 127 // Window event types.
 128 enum WindowEvent {
 129   WE_RESIZE = 0,
 130   WE_CLOSE = 1,
 131   WE_MINIMIZE = 2,
 132   WE_RESTORE = 3,
 133 };
 134
 135 inline std::string ToString(const WindowId& window) {
 136   return ToString(window.id());
 137 }
 138
 139 }  // namespace talk_base
 140
 141 #endif  // TALK_BASE_WINDOW_H_