1 /*
2  *  Copyright (c) 2013 The WebRTC project authors. All Rights Reserved.
3  *
4  *  Use of this source code is governed by a BSD-style license
5  *  that can be found in the LICENSE file in the root of the source
6  *  tree. An additional intellectual property rights grant can be found
7  *  in the file PATENTS.  All contributing project authors may
8  *  be found in the AUTHORS file in the root of the source tree.
9  */
10 
11 #ifndef WEBRTC_MODULES_DESKTOP_CAPTURE_X11_SHARED_X_DISPLAY_H_
12 #define WEBRTC_MODULES_DESKTOP_CAPTURE_X11_SHARED_X_DISPLAY_H_
13 
14 #include <map>
15 #include <vector>
16 
17 #include <assert.h>
18 #include <X11/Xlib.h>
19 
20 #include <string>
21 
22 #include "webrtc/base/scoped_ref_ptr.h"
23 #include "webrtc/system_wrappers/include/atomic32.h"
24 
25 namespace webrtc {
26 
27 // A ref-counted object to store XDisplay connection.
28 class SharedXDisplay {
29  public:
30   class XEventHandler {
31    public:
~XEventHandler()32     virtual ~XEventHandler() {}
33 
34     // Processes XEvent. Returns true if the event has been handled.
35     virtual bool HandleXEvent(const XEvent& event) = 0;
36   };
37 
38   // Takes ownership of |display|.
39   explicit SharedXDisplay(Display* display);
40 
41   // Creates a new X11 Display for the |display_name|. NULL is returned if X11
42   // connection failed. Equivalent to CreateDefault() when |display_name| is
43   // empty.
44   static rtc::scoped_refptr<SharedXDisplay> Create(
45       const std::string& display_name);
46 
47   // Creates X11 Display connection for the default display (e.g. specified in
48   // DISPLAY). NULL is returned if X11 connection failed.
49   static rtc::scoped_refptr<SharedXDisplay> CreateDefault();
50 
AddRef()51   void AddRef() { ++ref_count_; }
Release()52   void Release() {
53     if (--ref_count_ == 0)
54       delete this;
55   }
56 
display()57   Display* display() { return display_; }
58 
59   // Adds a new event |handler| for XEvent's of |type|.
60   void AddEventHandler(int type, XEventHandler* handler);
61 
62   // Removes event |handler| added using |AddEventHandler|. Doesn't do anything
63   // if |handler| is not registered.
64   void RemoveEventHandler(int type, XEventHandler* handler);
65 
66   // Processes pending XEvents, calling corresponding event handlers.
67   void ProcessPendingXEvents();
68 
69  private:
70   typedef std::map<int, std::vector<XEventHandler*> > EventHandlersMap;
71 
72   ~SharedXDisplay();
73 
74   Atomic32 ref_count_;
75   Display* display_;
76 
77   EventHandlersMap event_handlers_;
78 
79   RTC_DISALLOW_COPY_AND_ASSIGN(SharedXDisplay);
80 };
81 
82 }  // namespace webrtc
83 
84 #endif  // WEBRTC_MODULES_DESKTOP_CAPTURE_X11_SHARED_X_DISPLAY_H_
85