/*
 *  The ManaPlus Client
 *  Copyright (C) 2011-2015  The ManaPlus Developers
 *
 *  This file is part of The ManaPlus Client.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/*      _______   __   __   __   ______   __   __   _______   __   __
 *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
 *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
 *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
 *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
 * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
 * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
 *
 * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
 *
 *
 * Per Larsson a.k.a finalman
 * Olof Naessén a.k.a jansem/yakslem
 *
 * Visit: http://guichan.sourceforge.net
 *
 * License: (BSD)
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of Guichan nor the names of its contributors may
 *    be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef GUI_COLOR_H
#define GUI_COLOR_H

#include "localconsts.h"

/**
  * Represents a color with red, green, blue and alpha components.
  */
class Color final
{
    public:
        /**
          * Constructor. Initializes the color to black.
          */
        Color();

        /**
          * Constructor. Constructs a color from the bytes in an integer. 
          * Call it with a hexadecimal constant for HTML-style color
          * representation.
          * The alpha component is 255 by default.
          *
          * EXAMPLE: Color(0xff50a0) constructs a very nice pinkish color.
          *
          * NOTE: Because of this constructor, integers will be automatically
          *       casted to a color by your compiler.
          *
          * @param color The color to initialise the object with.
          */
        explicit Color(const unsigned int color);

        /**
          * Constructor. The default alpha value is 255.
          *
          * @param r Red color component (range 0-255).
          * @param g Green color component  (range 0-255).
          * @param b Blue color component (range 0-255).
          * @param a Alpha, used for transparency. A value of 0 means
          *          totaly transparent, 255 is totaly opaque.
          */
        Color(const unsigned int r,
              const unsigned int g,
              const unsigned int b,
              const unsigned int a = 255);

        /**
          * Adds the RGB values of two colors together. The values will be
          * clamped if they go out of range. 
          *
          * WARNING: This function will reset the alpha value of the
          *          returned color to 255.
          *
          * @param color A color to add to this color.
          * @return The added colors with an alpha value set to 255.
          */
        Color operator+(const Color& color) const;

        /**
          * Subtracts the RGB values of one color from another.
          * The values will be clamped if they go out of range.
          *
          * WARNING: This function will reset the alpha value of the
          *          returned color to 255.
          *
          * @param color A color to subtract from this color.
          * @return The subtracted colors with an alpha value set to 255.
          */
        Color operator-(const Color& color) const;

        /**
          * Multiplies the RGB values of a color with a float value.
          * The values will be clamped if they go out of range.
          *
          * @param value The value to multiply the color with.
          * @return The multiplied colors. The alpha value will, unlike
          *         the add and subtract operations, be multiplied as
          *         well.
          */
        Color operator*(const float value) const;

        /**
          * Compares two colors.
          *
          * @return True if the two colors have the same RGBA components
          *         false otherwise.
          */
        bool operator==(const Color& color) const;

        /**
          * Compares two colors.
          *
          * @return True if the two colors have different RGBA components,
          *         false otherwise.
          */
        bool operator!=(const Color& color) const;

        /**
          * Holds the red color component (range 0-255).
          */
        unsigned int r;

        /**
          *  Holds the green color component (range 0-255).
          */
        unsigned int g;

        /**
          *  Holds the blue color component (range 0-255).
          */
        unsigned int b;

        /**
          * Holds the alpha color component. A value of 0 means totally
          * transparent while a value of 255 is considered opaque.
          */
        unsigned int a;
};

#endif  // GUI_COLOR_H