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, 153 insertions, 0 deletions

diff --git a/util/fbcompose/plugins/xrender/preview/PreviewPlugin.hh b/util/fbcompose/plugins/xrender/preview/PreviewPlugin.hh
new file mode 100644
index 0000000..5f1c0d1
--- /dev/null
+++ b/util/fbcompose/plugins/xrender/preview/PreviewPlugin.hh
@@ -0,0 +1,153 @@
+/** PreviewPlugin.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_PLUGIN_XRENDER_PREVIEW_PREVIEWPLUGIN_HH
+#define FBCOMPOSITOR_PLUGIN_XRENDER_PREVIEW_PREVIEWPLUGIN_HH
+
+
+#include "Enumerations.hh"
+#include "TickTracker.hh"
+#include "XRenderPlugin.hh"
+#include "XRenderResources.hh"
+
+#include "FbTk/FbString.hh"
+
+#include <X11/Xlib.h>
+#include <X11/extensions/Xrender.h>
+
+#include <map>
+#include <vector>
+
+
+namespace FbCompositor {
+
+    class BaseScreen;
+    class XRenderScreen;
+    class XRenderWindow;
+
+
+    /**
+     * Provides window preview feature for the iconbar.
+     */
+    class PreviewPlugin : public XRenderPlugin {
+        struct PreviewWindowData;
+
+    public :
+        //--- CONSTRUCTORS AND DESTRUCTORS -------------------------------------
+
+        /** Constructor. */
+        PreviewPlugin(const BaseScreen &screen, const std::vector<FbTk::FbString> &args);
+
+        /** Destructor. */
+        ~PreviewPlugin();
+
+
+        //--- ACCESSORS --------------------------------------------------------
+
+        /** \returns the name of the plugin. */
+        const char *pluginName() const;
+
+
+        //--- WINDOW EVENT CALLBACKS -------------------------------------------
+
+        /** Called, whenever a new window is created. */
+        void windowCreated(const BaseCompWindow &window);
+
+        /** Called, whenever a window is destroyed. */
+        void windowDestroyed(const BaseCompWindow &window);
+
+
+        //--- RENDERING ACTIONS ------------------------------------------------
+
+        /** Rectangles that the plugin wishes to damage. */
+        const std::vector<XRectangle> &damagedAreas();
+
+        /** Extra rendering actions and jobs. */
+        const std::vector<XRenderRenderingJob> &extraRenderingActions();
+
+
+    private :
+        //--- INTERNAL FUNCTIONS -----------------------------------------------
+
+        /** Update the preview window data. */
+        void updatePreviewWindowData(PreviewWindowData &win_preview);
+
+        /** Update the preview window position. */
+        void updatePreviewWindowPos(PreviewWindowData &win_preview);
+
+
+        //--- GENERAL RENDERING VARIABLES --------------------------------------
+
+        /** Vector, containing the areas that the plugin wishes to paint. */
+        std::vector<XRectangle> m_damaged_areas;
+
+        /** Vector, containing the plugin's extra rendering jobs. */
+        std::vector<XRenderRenderingJob> m_extra_jobs;
+
+
+        /** Preview window's mask. */
+        XRenderPicturePtr m_mask_picture;
+
+        /** Timer that signals when the preview window should appear. */
+        TickTracker m_tick_tracker;
+
+
+        /** Previously modified rectangle. */
+        XRectangle m_previous_damage;
+
+        /** Previously drawn preview window. */
+        Window m_previous_window;
+
+
+        //--- PREVIEW WINDOW DATA ----------------------------------------------
+
+        /** Holds data about the preview window. */
+        struct PreviewWindowData {
+            const XRenderWindow &window;    ///< The corresponding window object.
+            XRenderRenderingJob job;        ///< Rendering job of this preview object.
+        };
+
+        /** A list of potential preview windows. */
+        std::map<Window, PreviewWindowData> m_preview_data;
+    };
+
+
+    //--- INLINE FUNCTIONS -----------------------------------------------------
+
+    // Returns the name of the plugin.
+    inline const char *PreviewPlugin::pluginName() const {
+        return "preview";
+    }
+}
+
+
+//--- PLUGIN MANAGER FUNCTIONS -------------------------------------------------
+
+/** Creates a plugin object. */
+extern "C" FbCompositor::BasePlugin *createPlugin(const FbCompositor::BaseScreen &screen, const std::vector<FbTk::FbString> &args);
+
+/** \returns the type of the plugin. */
+extern "C" FbCompositor::PluginType pluginType();
+
+
+#endif  // FBCOMPOSITOR_PLUGIN_XRENDER_PREVIEW_PREVIEWPLUGIN_HH