2cfba3d4221805b32f0a3b733b8e6bc7fbb0812c
[occt.git] / src / Aspect / Aspect_DisplayConnection.hxx
1 // Copyright (c) 2013-2014 OPEN CASCADE SAS
2 //
3 // This file is part of Open CASCADE Technology software library.
4 //
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
10 //
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
13
14 #ifndef _Aspect_DisplayConnection_H__
15 #define _Aspect_DisplayConnection_H__
16
17 #include <Standard_Transient.hxx>
18 #include <Aspect_XAtom.hxx>
19
20 #include <TCollection_AsciiString.hxx>
21 #include <NCollection_DataMap.hxx>
22
23 #if !defined(_WIN32) && (!defined(__APPLE__) || defined(MACOSX_USE_GLX)) && !defined(__ANDROID__) && !defined(__QNX__) && !defined(__EMSCRIPTEN__)
24   #include <InterfaceGraphic.hxx>
25   #include <Aspect_FBConfig.hxx>
26 #endif
27
28 //! This class creates and provides connection with X server.
29 //! Raises exception if can not connect to X server.
30 //! On Windows and Mac OS X (in case when Cocoa used) platforms this class do nothing.
31 //! WARRNING: Do not close display connection manualy!
32
33 class Aspect_DisplayConnection : public Standard_Transient
34 {
35 public:
36
37   //! Default constructor. Creates connection with display name taken from "DISPLAY" environment variable
38   Standard_EXPORT Aspect_DisplayConnection();
39
40   //! Destructor. Close opened connection.
41   Standard_EXPORT ~Aspect_DisplayConnection();
42
43 #if !defined(_WIN32) && (!defined(__APPLE__) || defined(MACOSX_USE_GLX)) && !defined(__ANDROID__) && !defined(__QNX__) && !defined(__EMSCRIPTEN__)
44   //! Constructor. Creates connection with display specified in theDisplayName.
45   //! Display name should be in format "hostname:number" or "hostname:number.screen_number", where:
46   //! hostname      - Specifies the name of the host machine on which the display is physically attached.
47   //! number        - Specifies the number of the display server on that host machine.
48   //! screen_number - Specifies the screen to be used on that server. Optional variable.
49   Aspect_DisplayConnection (const TCollection_AsciiString& theDisplayName);
50
51   //! Constructor wrapping existing Display instance.
52   //! WARNING! it is a responsibility of application to keep this pointer
53   //! valid while Aspect_DisplayConnection is alive and to close Display when it is no more needed.
54   Aspect_DisplayConnection (Display* theDisplay);
55
56   //! @return pointer to Display structure that serves as the connection to the X server.
57   Display* GetDisplay() { return myDisplay; }
58
59   //! @return TRUE if X Display has been allocated by this class
60   Standard_Boolean IsOwnDisplay() const { return myIsOwnDisplay; }
61
62   //! @return identifier(atom) for custom named property associated with windows that use current connection to X server.
63   Atom GetAtom (const Aspect_XAtom theAtom) const;
64
65   //! @return display name for this connection.
66   const TCollection_AsciiString& GetDisplayName() { return myDisplayName; }
67
68   //! Open connection with display specified in myDisplayName class field
69   //! or takes theDisplay parameter when it is not NULL.
70   //! WARNING! When external Display is specified, it is a responsibility of application
71   //! to keep this pointer valid while Aspect_DisplayConnection is alive
72   //! and to close Display when it is no more needed.
73   //! @param theDisplay external pointer to allocated Display, or NULL if new connection should be created
74   void Init (Display* theDisplay);
75
76   //! Return default window visual or NULL when undefined.
77   XVisualInfo* GetDefaultVisualInfo() const { return myDefVisualInfo; }
78
79   //! @return native Window FB config (GLXFBConfig on Xlib)
80   Aspect_FBConfig GetDefaultFBConfig() const { return myDefFBConfig; }
81
82   //! Set default window visual; the visual will be deallocated using XFree().
83   Standard_EXPORT void SetDefaultVisualInfo (XVisualInfo* theVisual,
84                                              Aspect_FBConfig theFBConfig);
85
86 private:
87
88   Display*                 myDisplay;
89   XVisualInfo*             myDefVisualInfo;
90   Aspect_FBConfig          myDefFBConfig;
91   NCollection_DataMap<Aspect_XAtom, Atom> myAtoms;
92   TCollection_AsciiString  myDisplayName;
93   Standard_Boolean         myIsOwnDisplay;
94 #endif
95
96 private:
97
98   //! To protect the connection from closing copying allowed only through the handles.
99   Aspect_DisplayConnection            (const Aspect_DisplayConnection& );
100   Aspect_DisplayConnection& operator= (const Aspect_DisplayConnection& );
101
102 public:
103
104   DEFINE_STANDARD_RTTIEXT(Aspect_DisplayConnection,Standard_Transient) // Type definition
105
106 };
107
108 DEFINE_STANDARD_HANDLE (Aspect_DisplayConnection, Standard_Transient)
109
110 #endif // _Aspect_DisplayConnection_H__