/** FadePlugin.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_FADE_FADEPLUGIN_HH
#define FBCOMPOSITOR_PLUGIN_XRENDER_FADE_FADEPLUGIN_HH


#include "Enumerations.hh"
#include "Exceptions.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;


    /**
     * A simple plugin that provides window fades for XRender renderer.
     */
    class FadePlugin : public XRenderPlugin {
    public :
        //--- CONSTRUCTORS AND DESTRUCTORS -------------------------------------

        /** Constructor. */
        FadePlugin(const BaseScreen &screen, const std::vector<FbTk::FbString> &args);

        /** Destructor. */
        ~FadePlugin();


        //--- ACCESSORS --------------------------------------------------------

        /** \returns the name of the plugin. */
        const char *pluginName() const;


        //--- WINDOW EVENT CALLBACKS -------------------------------------------

        /** Called, whenever a window becomes ignored. */
        void windowBecameIgnored(const BaseCompWindow &window);

        /** Called, whenever a window is mapped. */
        void windowMapped(const BaseCompWindow &window);

        /** Called, whenever a window is unmapped. */
        void windowUnmapped(const BaseCompWindow &window);


        //--- RENDERING ACTIONS ------------------------------------------------

        /** Rectangles that the plugin wishes to damage. */
        const std::vector<XRectangle> &damagedAreas();


        /** Window rendering job initialization. */
        void windowRenderingJobInit(const XRenderWindow &window, XRenderRenderingJob &job);


        /** Extra rendering actions and jobs. */
        const std::vector<XRenderRenderingJob> &extraRenderingActions();

        /** Post extra rendering actions. */
        void postExtraRenderingActions();


    private :
        //--- INTERNAL FUNCTIONS -----------------------------------------------

        /** \returns the faded mask picture for the given window fade. */
        void createFadedMask(int alpha, XRenderPicturePtr mask, XRectangle dimensions,
                             XRenderPicturePtr fade_picture_return);


        //--- GENERAL RENDERING VARIABLES --------------------------------------

        /** PictFormat for fade pictures. */
        XRenderPictFormat *m_fade_pict_format;


        /** 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;


        //--- FADE SPECIFIC ----------------------------------------------------

        /** Holds the data about positive fades. */
        struct PosFadeData {
            XRectangle dimensions;          ///< Window's dimensions.
            int fade_alpha;                 ///< Window's relative fade alpha.
            XRenderPicturePtr fade_picture; ///< Picture of the faded window.
            TickTracker timer;              ///< Timer that tracks the current fade.
        };

        /** A list of appearing (positive) fades. */
        std::map<Window, PosFadeData> m_positive_fades;


        /** Holds the data about positive fades. */
        struct NegFadeData {
            Window window_id;                    ///< ID of the window that is being faded.
            XRenderRenderingJob job;            ///< Rendering job, associated with this fade.
            XRenderPicturePtr mask_picture;      ///< Window's shape mask.

            XRectangle dimensions;              ///< Window's dimensions.
            int fade_alpha;                      ///< Window's relative fade alpha.
            XRenderPicturePtr fade_picture;      ///< Picture of the faded window.
            TickTracker timer;                  ///< Timer that tracks the current fade.
        };

        /** A list of disappearing (negative) fades. */
        std::vector<NegFadeData> m_negative_fades;
    };


    //--- INLINE FUNCTIONS -----------------------------------------------------

    // Returns the name of the plugin.
    inline const char *FadePlugin::pluginName() const {
        return "fade";
    }
}


//--- 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_FADE_FADEPLUGIN_HH