DISTRHO
/
JUCE
mirror of https://github.com/DISTRHO/JUCE
1
0
Fork 0
Code Releases 1 Activity
The JUCE cross-platform C++ framework, with DISTRHO/KXStudio specific changes
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
12499 Commits
9 Branches
440MB
Tree: fe4515adb6
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'fe4515adb6'
${ noResults }
JUCE/modules/juce_gui_basics/native/x11/juce_linux_XWindowSystem.h

349 lines
13KB
Raw Blame History 

  1. /*

  2.   ==============================================================================

  3. 

  4.    This file is part of the JUCE library.

  5.    Copyright (c) 2020 - Raw Material Software Limited

  6. 

  7.    JUCE is an open source library subject to commercial or open-source

  8.    licensing.

  9. 

  10.    By using JUCE, you agree to the terms of both the JUCE 6 End-User License

  11.    Agreement and JUCE Privacy Policy (both effective as of the 16th June 2020).

  12. 

  13.    End User License Agreement: www.juce.com/juce-6-licence

  14.    Privacy Policy: www.juce.com/juce-privacy-policy

  15. 

  16.    Or: You may also use this code under the terms of the GPL v3 (see

  17.    www.gnu.org/licenses).

  18. 

  19.    JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER

  20.    EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE

  21.    DISCLAIMED.

  22. 

  23.   ==============================================================================

  24. */

  25. 

  26. namespace juce

  27. {

  28. 

  29. //==============================================================================

  30. namespace XWindowSystemUtilities

  31. {

  32.     //==============================================================================

  33.     /** A handy struct that uses XLockDisplay and XUnlockDisplay to lock the X server

  34.         using RAII.

  35. 

  36.         @tags{GUI}

  37.     */

  38.     struct ScopedXLock

  39.     {

  40.         ScopedXLock();

  41.         ~ScopedXLock();

  42.     };

  43. 

  44.     //==============================================================================

  45.     /** Gets a specified window property and stores its associated data, freeing it

  46.         on deletion.

  47. 

  48.         @tags{GUI}

  49.     */

  50.     struct GetXProperty

  51.     {

  52.         GetXProperty (::Display* display, ::Window windowH, Atom property,

  53.                       long offset, long length, bool shouldDelete, Atom requestedType);

  54.         ~GetXProperty();

  55. 

  56.         bool success = false;

  57.         unsigned char* data = nullptr;

  58.         unsigned long numItems = 0, bytesLeft = 0;

  59.         Atom actualType;

  60.         int actualFormat = -1;

  61.     };

  62. 

  63.     //==============================================================================

  64.     /** Initialises and stores some atoms for the display.

  65. 

  66.         @tags{GUI}

  67.     */

  68.     struct Atoms

  69.     {

  70.         enum ProtocolItems

  71.         {

  72.             TAKE_FOCUS = 0,

  73.             DELETE_WINDOW = 1,

  74.             PING = 2

  75.         };

  76. 

  77.         Atoms() = default;

  78.         explicit Atoms (::Display*);

  79. 

  80.         static Atom getIfExists (::Display*, const char* name);

  81.         static Atom getCreating (::Display*, const char* name);

  82. 

  83.         static String getName (::Display*, Atom);

  84.         static bool isMimeTypeFile (::Display*, Atom);

  85. 

  86.         static constexpr unsigned long DndVersion = 3;

  87. 

  88.         Atom protocols, protocolList[3], changeState, state, userTime, activeWin, pid, windowType, windowState, windowStateHidden,

  89.              XdndAware, XdndEnter, XdndLeave, XdndPosition, XdndStatus, XdndDrop, XdndFinished, XdndSelection,

  90.              XdndTypeList, XdndActionList, XdndActionDescription, XdndActionCopy, XdndActionPrivate,

  91.              XembedMsgType, XembedInfo, allowedActions[5], allowedMimeTypes[4], utf8String, clipboard, targets;

  92.     };

  93. 

  94.     //==============================================================================

  95.     /** Represents a setting according to the XSETTINGS specification.

  96. 

  97.         @tags{GUI}

  98.     */

  99.     struct XSetting

  100.     {

  101.         enum class Type

  102.         {

  103.             integer,

  104.             string,

  105.             colour,

  106.             invalid

  107.         };

  108. 

  109.         XSetting() = default;

  110. 

  111.         XSetting (const String& n, int v)            : name (n), type (Type::integer), integerValue (v)  {}

  112.         XSetting (const String& n, const String& v)  : name (n), type (Type::string),  stringValue (v)   {}

  113.         XSetting (const String& n, const Colour& v)  : name (n), type (Type::colour),  colourValue (v)   {}

  114. 

  115.         bool isValid() const noexcept  { return type != Type::invalid; }

  116. 

  117.         String name;

  118.         Type type = Type::invalid;

  119. 

  120.         int integerValue = -1;

  121.         String stringValue;

  122.         Colour colourValue;

  123.     };

  124. 

  125.     /** Parses and stores the X11 settings for a display according to the XSETTINGS

  126.         specification.

  127. 

  128.         @tags{GUI}

  129.     */

  130.     class XSettings

  131.     {

  132.     public:

  133.         explicit XSettings (::Display*);

  134. 

  135.         //==============================================================================

  136.         void update();

  137.         ::Window getSettingsWindow() const noexcept  { return settingsWindow; }

  138. 

  139.         XSetting getSetting (const String& settingName) const;

  140. 

  141.         //==============================================================================

  142.         struct Listener

  143.         {

  144.             virtual ~Listener() = default;

  145.             virtual void settingChanged (const XSetting& settingThatHasChanged) = 0;

  146.         };

  147. 

  148.         void addListener (Listener* listenerToAdd)        { listeners.add (listenerToAdd); }

  149.         void removeListener (Listener* listenerToRemove)  { listeners.remove (listenerToRemove); }

  150. 

  151.     private:

  152.         ::Display* display = nullptr;

  153.         ::Window settingsWindow = None;

  154.         Atom settingsAtom;

  155. 

  156.         int lastUpdateSerial = -1;

  157. 

  158.         std::unordered_map<String, XSetting> settings;

  159.         ListenerList<Listener> listeners;

  160. 

  161.         //==============================================================================

  162.         JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (XSettings)

  163.     };

  164. }

  165. 

  166. //==============================================================================

  167. class LinuxComponentPeer;

  168. 

  169. class XWindowSystem  : public DeletedAtShutdown

  170. {

  171. public:

  172.     //==============================================================================

  173.     ::Window createWindow (::Window parentWindow, LinuxComponentPeer*) const;

  174.     void destroyWindow    (::Window);

  175. 

  176.     void setTitle (::Window, const String&) const;

  177.     void setIcon (::Window , const Image&) const;

  178.     void setVisible (::Window, bool shouldBeVisible) const;

  179.     void setBounds (::Window, Rectangle<int>, bool fullScreen) const;

  180.     void updateConstraints (::Window) const;

  181. 

  182.     BorderSize<int> getBorderSize   (::Window) const;

  183.     Rectangle<int>  getWindowBounds (::Window, ::Window parentWindow);

  184.     Point<int> getPhysicalParentScreenPosition() const;

  185. 

  186.     bool contains (::Window, Point<int> localPos) const;

  187. 

  188.     void setMinimised (::Window, bool shouldBeMinimised) const;

  189.     bool isMinimised  (::Window) const;

  190. 

  191.     void setMaximised (::Window, bool shouldBeMinimised) const;

  192. 

  193.     void toFront  (::Window, bool makeActive) const;

  194.     void toBehind (::Window, ::Window otherWindow) const;

  195. 

  196.     bool isFocused (::Window) const;

  197.     bool grabFocus (::Window) const;

  198. 

  199.     bool canUseSemiTransparentWindows() const;

  200.     bool canUseARGBImages() const;

  201.     bool isDarkModeActive() const;

  202. 

  203.     int getNumPaintsPendingForWindow (::Window);

  204.     void processPendingPaintsForWindow (::Window);

  205.     void addPendingPaintForWindow (::Window);

  206.     void removePendingPaintForWindow (::Window);

  207. 

  208.     Image createImage (bool isSemiTransparentWindow, int width, int height, bool argb) const;

  209.     void blitToWindow (::Window, Image, Rectangle<int> destinationRect, Rectangle<int> totalRect) const;

  210. 

  211.     void setScreenSaverEnabled (bool enabled) const;

  212. 

  213.     Point<float> getCurrentMousePosition() const;

  214.     void setMousePosition (Point<float> pos) const;

  215. 

  216.     Cursor createCustomMouseCursorInfo (const Image&, Point<int> hotspot) const;

  217.     void deleteMouseCursor (Cursor cursorHandle) const;

  218.     Cursor createStandardMouseCursor (MouseCursor::StandardCursorType) const;

  219.     void showCursor (::Window, Cursor cursorHandle) const;

  220. 

  221.     bool isKeyCurrentlyDown (int keyCode) const;

  222.     ModifierKeys getNativeRealtimeModifiers() const;

  223. 

  224.     Array<Displays::Display> findDisplays (float masterScale) const;

  225. 

  226.     ::Window createKeyProxy (::Window) const;

  227.     void deleteKeyProxy (::Window) const;

  228. 

  229.     bool externalDragFileInit (LinuxComponentPeer*, const StringArray& files, bool canMove, std::function<void()>&& callback) const;

  230.     bool externalDragTextInit (LinuxComponentPeer*, const String& text, std::function<void()>&& callback) const;

  231. 

  232.     void copyTextToClipboard (const String&);

  233.     String getTextFromClipboard() const;

  234.     String getLocalClipboardContent() const noexcept  { return localClipboardContent; }

  235. 

  236.     ::Display* getDisplay() const noexcept                            { return display; }

  237.     const XWindowSystemUtilities::Atoms& getAtoms() const noexcept    { return atoms; }

  238.     XWindowSystemUtilities::XSettings* getXSettings() const noexcept  { return xSettings.get(); }

  239. 

  240.     bool isX11Available() const noexcept  { return xIsAvailable; }

  241. 

  242.     static String getWindowScalingFactorSettingName()  { return "Gdk/WindowScalingFactor"; }

  243.     static String getThemeNameSettingName()            { return "Net/ThemeName"; }

  244. 

  245.     //==============================================================================

  246.     void handleWindowMessage (LinuxComponentPeer*, XEvent&) const;

  247.     bool isParentWindowOf (::Window, ::Window possibleChild) const;

  248. 

  249.     //==============================================================================

  250.     JUCE_DECLARE_SINGLETON (XWindowSystem, false)

  251. 

  252. private:

  253.     XWindowSystem();

  254.     ~XWindowSystem();

  255. 

  256.     //==============================================================================

  257.     struct VisualAndDepth

  258.     {

  259.         Visual* visual;

  260.         int depth;

  261.     };

  262. 

  263.     struct DisplayVisuals

  264.     {

  265.         explicit DisplayVisuals (::Display*);

  266. 

  267.         VisualAndDepth getBestVisualForWindow (bool) const;

  268.         bool isValid() const noexcept;

  269. 

  270.         Visual* visual16Bit = nullptr;

  271.         Visual* visual24Bit = nullptr;

  272.         Visual* visual32Bit = nullptr;

  273.     };

  274. 

  275.     bool initialiseXDisplay();

  276.     void destroyXDisplay();

  277. 

  278.     //==============================================================================

  279.     ::Window getFocusWindow (::Window) const;

  280. 

  281.     bool isFrontWindow (::Window) const;

  282. 

  283.     //==============================================================================

  284.     void xchangeProperty (::Window, Atom, Atom, int, const void*, int) const;

  285. 

  286.     void removeWindowDecorations (::Window) const;

  287.     void addWindowButtons        (::Window, int) const;

  288.     void setWindowType           (::Window, int) const;

  289. 

  290.     void initialisePointerMap();

  291.     void deleteIconPixmaps (::Window) const;

  292.     void updateModifierMappings() const;

  293. 

  294.     long getUserTime (::Window) const;

  295. 

  296.     void initialiseXSettings();

  297. 

  298.     //==============================================================================

  299.     void handleKeyPressEvent        (LinuxComponentPeer*, XKeyEvent&) const;

  300.     void handleKeyReleaseEvent      (LinuxComponentPeer*, const XKeyEvent&) const;

  301.     void handleWheelEvent           (LinuxComponentPeer*, const XButtonPressedEvent&, float) const;

  302.     void handleButtonPressEvent     (LinuxComponentPeer*, const XButtonPressedEvent&, int) const;

  303.     void handleButtonPressEvent     (LinuxComponentPeer*, const XButtonPressedEvent&) const;

  304.     void handleButtonReleaseEvent   (LinuxComponentPeer*, const XButtonReleasedEvent&) const;

  305.     void handleMotionNotifyEvent    (LinuxComponentPeer*, const XPointerMovedEvent&) const;

  306.     void handleEnterNotifyEvent     (LinuxComponentPeer*, const XEnterWindowEvent&) const;

  307.     void handleLeaveNotifyEvent     (LinuxComponentPeer*, const XLeaveWindowEvent&) const;

  308.     void handleFocusInEvent         (LinuxComponentPeer*) const;

  309.     void handleFocusOutEvent        (LinuxComponentPeer*) const;

  310.     void handleExposeEvent          (LinuxComponentPeer*, XExposeEvent&) const;

  311.     void handleConfigureNotifyEvent (LinuxComponentPeer*, XConfigureEvent&) const;

  312.     void handleGravityNotify        (LinuxComponentPeer*) const;

  313.     void propertyNotifyEvent        (LinuxComponentPeer*, const XPropertyEvent&) const;

  314.     void handleMappingNotify        (XMappingEvent&) const;

  315.     void handleClientMessageEvent   (LinuxComponentPeer*, XClientMessageEvent&, XEvent&) const;

  316.     void handleXEmbedMessage        (LinuxComponentPeer*, XClientMessageEvent&) const;

  317. 

  318.     void dismissBlockingModals      (LinuxComponentPeer*) const;

  319.     void dismissBlockingModals      (LinuxComponentPeer*, const XConfigureEvent&) const;

  320.     void updateConstraints          (::Window, ComponentPeer&) const;

  321. 

  322.     ::Window findTopLevelWindowOf (::Window) const;

  323. 

  324.     static void windowMessageReceive (XEvent&);

  325. 

  326.     //==============================================================================

  327.     bool xIsAvailable = false;

  328. 

  329.     XWindowSystemUtilities::Atoms atoms;

  330.     ::Display* display = nullptr;

  331.     std::unique_ptr<DisplayVisuals> displayVisuals;

  332.     std::unique_ptr<XWindowSystemUtilities::XSettings> xSettings;

  333. 

  334.    #if JUCE_USE_XSHM

  335.     std::map<::Window, int> shmPaintsPendingMap;

  336.    #endif

  337. 

  338.     int shmCompletionEvent = 0;

  339.     int pointerMap[5] = {};

  340.     String localClipboardContent;

  341. 

  342.     Point<int> parentScreenPosition;

  343. 

  344.     //==============================================================================

  345.     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (XWindowSystem)

  346. };

  347. 

  348. } // namespace juce