fbcompose - A compositing addon for fluxbox window manager.

 fbcompose(1) is an optional compositing addon for fluxbox window manager. It
 augments fluxbox with a number of graphical features. Most notably, fbcompose
 allows fluxbox to properly display applications that require compositing
 (docky, for example), adds support for true window transparency (as opposed to
 fluxbox's pseudo transparency) and provides a plugin framework to extend the
 compositor's functionality.

 As this is still a beta version of the compositor, the bugs are likely.

1 files changed, 188 insertions, 0 deletions

diff --git a/util/fbcompose/Compositor.hh b/util/fbcompose/Compositor.hh
new file mode 100644
index 0000000..459bfb0
--- /dev/null
+++ b/util/fbcompose/Compositor.hh
@@ -0,0 +1,188 @@
+/** Compositor.hh file for the fluxbox compositor. */
+
+// Copyright (c) 2011 Gediminas Liktaras (gliktaras at gmail dot com)
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+
+#ifndef FBCOMPOSITOR_COMPOSITOR_HH
+#define FBCOMPOSITOR_COMPOSITOR_HH
+
+
+#include "Enumerations.hh"
+#include "Exceptions.hh"
+#include "TickTracker.hh"
+
+#include "FbTk/App.hh"
+
+#include <X11/Xlib.h>
+
+#include <vector>
+
+
+namespace FbCompositor {
+
+    class BaseScreen;
+    class CompositorConfig;
+
+
+    //--- TYPEDEFS -------------------------------------------------------------
+
+    /** A pointer to an X query extension function. */
+    typedef Bool (*QueryExtensionFunction)(Display*, int*, int*);
+
+    /** A pointer to an X query version function. */
+    typedef Status (*QueryVersionFunction)(Display*, int*, int*);
+
+
+    //--- MAIN COMPOSITOR CLASS ------------------------------------------------
+
+    /**
+     * Main class for the compositor.
+     *
+     * Note that if the serverauto rendering mode is selected, ServerAutoApp is
+     * used instead. This was done to take out the ad-hoc code out of this
+     * class, since this class is too complex for serverauto rendering.
+     */
+    class Compositor : public FbTk::App {
+    public:
+        //--- CONSTRUCTORS AND DESTRUCTORS -------------------------------------
+
+        /** Constructor. */
+        Compositor(const CompositorConfig &configuration);
+
+        /** Destructor. */
+        ~Compositor();
+
+
+        //--- EVENT LOOP -------------------------------------------------------
+
+        /** Enters the event loop. */
+        void eventLoop();
+
+
+    private:
+        //--- CONSTRUCTORS -----------------------------------------------------
+
+        /** Copy constructor. */
+        Compositor(const Compositor&);
+
+        /** Assignment operator. */
+        Compositor &operator=(const Compositor&);
+
+
+        //--- INITIALIZATION FUNCTIONS -----------------------------------------
+
+        /** Acquire the ownership of compositing manager selections. */
+        Window getCMSelectionOwnership(int screen_number);
+
+        /** Initializes all relevant X's extensions. */
+        void initAllExtensions();
+
+        /** Initializes a particular X server extension. */
+        void initExtension(const char *extension_name, QueryExtensionFunction extension_func,
+                           QueryVersionFunction version_func, const int min_major_ver, const int min_minor_ver,
+                           int &event_base, int &error_base);
+
+        /** Initializes monitor heads on every screen. */
+        void initHeads();
+
+
+        //--- INTERNAL FUNCTIONS -----------------------------------------------
+
+        /** \returns the exposed area in a XExposeEvent as an XRectangle. */
+        XRectangle getExposedRect(const XExposeEvent &event);
+
+        /** Locates the screen an event affects. Returns -1 on failure. */
+        int screenOfEvent(const XEvent &event);
+
+
+        //--- COMPOSITOR VARIABLES ---------------------------------------------
+
+        /** A tick tracker that controls when the screen is redrawn. */
+        TickTracker m_timer;
+
+        /** Rendering mode in use. */
+        RenderingMode m_rendering_mode;
+
+        /** The array of available screens. */
+        std::vector<BaseScreen*> m_screens;
+
+
+        //--- EXTENSION BASE VARIABLES -----------------------------------------
+
+        /** Event base of the X Composite extension. */
+        int m_composite_event_base;
+
+        /** Error base of the X Composite extension. */
+        int m_composite_error_base;
+
+        /** Event base of the X Damage extension. */
+        int m_damage_event_base;
+
+        /** Error base of the X Damage extension. */
+        int m_damage_error_base;
+
+        /** Event base of the GLX extension. */
+        int m_glx_event_base;
+
+        /** Error base of the GLX extension. */
+        int m_glx_error_base;
+
+        /** Event base of the X Fixes extension. */
+        int m_fixes_event_base;
+
+        /** Error base of the X Fixes extension. */
+        int m_fixes_error_base;
+
+        /** Event base of the X Render extension. */
+        int m_render_event_base;
+
+        /** Error base of the X Render extension. */
+        int m_render_error_base;
+
+        /** Event base of the X Shape extension. */
+        int m_shape_event_base;
+
+        /** Error base of the X Shape extension. */
+        int m_shape_error_base;
+
+        /** Event base of the Xinerama extension. */
+        int m_xinerama_event_base;
+
+        /** Error base of the Xinerama extension. */
+        int m_xinerama_error_base;
+    };
+
+
+    //--- VARIOUS HANDLERS -----------------------------------------------------
+
+    /** Custom signal handler. */
+    void handleSignal(int signal);
+
+
+    /** Custom X error handler (ignore). */
+    int ignoreXError(Display *display, XErrorEvent *error);
+
+    /** Custom X error handler (print, continue). */
+    int printXError(Display *display, XErrorEvent *error);
+}
+
+
+#endif  // FBCOMPOSITOR_COMPOSITOR_HH