Color.h

/*
 * #%L
 * OME-XML C++ library for working with OME-XML metadata structures.
 * %%
 * Copyright © 2006 - 2015 Open Microscopy Environment:
 *   - Massachusetts Institute of Technology
 *   - National Institutes of Health
 *   - University of Dundee
 *   - Board of Regents of the University of Wisconsin-Madison
 *   - Glencoe Software, Inc.
 * %%
 * 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.
 *
 * 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 HOLDERS 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.
 *
 * The views and conclusions contained in the software and documentation are
 * those of the authors and should not be interpreted as representing official
 * policies, either expressed or implied, of any organization.
 * #L%
 */

#ifndef OME_XML_MODEL_PRIMITIVES_COLOR_H
#define OME_XML_MODEL_PRIMITIVES_COLOR_H

#include <limits>
#include <string>

#include <ome/compat/cstdint.h>

namespace ome
{
  namespace xml
  {
    namespace model
    {
      namespace primitives
      {

        class Color
        {
        public:
          typedef uint8_t  component_type;
          typedef uint32_t composed_type;
          typedef int32_t  signed_type;

          inline
          Color ():
            value(0x000000FFU)
          {
          }

          inline
          Color (composed_type value):
            value(value)
          {
          }

          inline
          Color (signed_type value):
            value(static_cast<composed_type>(value))
          {
          }

          inline
          Color (component_type r,
                 component_type g,
                 component_type b,
                 component_type a = std::numeric_limits<component_type>::max()):
            value(static_cast<composed_type>(r) << 24U |
                  static_cast<composed_type>(g) << 16U |
                  static_cast<composed_type>(b) <<  8U |
                  static_cast<composed_type>(a) <<  0U)
          {
          }

          Color (const std::string& str,
                 bool               sign = true);

          inline
          ~Color ()
          {
          }

          inline component_type
          getRed () const
          {
            return static_cast<component_type>((this->value >> 24U) & 0xffU);
          }

          inline void
          setRed (component_type red)
          {
            this->value &= ~(0xFFU << 24U);
            this->value |= static_cast<composed_type>(red) << 24U;
          }

          inline component_type
          getGreen () const
          {
            return static_cast<component_type>((this->value >> 16U) & 0xffU);
          }

          inline void
          setGreen (component_type green)
          {
            this->value &= ~(0xffU << 16U);
            this->value |= static_cast<composed_type>(green) << 16U;
          }

          inline component_type
          getBlue () const
          {
            return static_cast<component_type>((this->value >> 8U) & 0xffU);
          }

          inline void
          setBlue (component_type blue)
          {
            this->value &= ~(0xffU << 8U);
            this->value |= static_cast<composed_type>(blue) << 8U;
          }

          inline component_type
          getAlpha () const
          {
            return static_cast<component_type>((this->value >> 0) & 0xffU);
          }

          inline void
          setAlpha (component_type alpha)
          {
            this->value &= ~(0xffU << 0);
            this->value |= static_cast<composed_type>(alpha) << 0;
          }

          inline signed_type
          getValue () const
          {
            return static_cast<signed_type>(this->value);
          }

          inline void
          setValue (composed_type value)
          {
            this->value = value;
          }

          inline void
          setValue (signed_type value)
          {
            this->value = static_cast<composed_type>(value);
          }

          inline
          operator composed_type () const
          {
            return this->value;
          }

          inline
          operator signed_type () const
          {
            return static_cast<signed_type>(this->value);
          }

        private:
          composed_type value;
        };

        inline bool
        operator== (const Color& lhs,
                    const Color& rhs)
        {
          return static_cast<Color::composed_type>(lhs) == static_cast<Color::composed_type>(rhs);
        }

        inline bool
        operator== (const Color&         lhs,
                    Color::composed_type rhs)
        {
          return static_cast<Color::composed_type>(lhs) == rhs;
        }

        inline bool
        operator== (Color::composed_type lhs,
                    const Color&         rhs)
        {
          return lhs == static_cast<Color::composed_type>(rhs);
        }

        inline bool
        operator== (const Color&       lhs,
                    Color::signed_type rhs)
        {
          return static_cast<Color::signed_type>(lhs) == rhs;
        }

        inline bool
        operator== (Color::signed_type lhs,
                    const Color&       rhs)
        {
          return lhs == static_cast<Color::signed_type>(rhs);
        }

        inline bool
        operator!= (const Color& lhs,
                    const Color& rhs)
        {
          return static_cast<Color::composed_type>(lhs) != static_cast<Color::composed_type>(rhs);
        }

        inline bool
        operator!= (const Color&         lhs,
                    Color::composed_type rhs)
        {
          return static_cast<Color::composed_type>(lhs) != rhs;
        }

        inline bool
        operator!= (Color::composed_type lhs,
                    const Color&         rhs)
        {
          return lhs != static_cast<Color::composed_type>(rhs);
        }

        inline bool
        operator!= (const Color&       lhs,
                    Color::signed_type rhs)
        {
          return static_cast<Color::signed_type>(lhs) != rhs;
        }

        inline bool
        operator!= (Color::signed_type lhs,
                    const Color&       rhs)
        {
          return lhs != static_cast<Color::signed_type>(rhs);
        }

        template<class charT, class traits>
        inline std::basic_ostream<charT,traits>&
        operator<< (std::basic_ostream<charT,traits>& os,
                    const Color& color)
        {
          return os << static_cast<Color::signed_type>(color);
        }

        template<class charT, class traits>
        inline std::basic_istream<charT,traits>&
        operator>> (std::basic_istream<charT,traits>& is,
                    Color& color)
        {
          Color::signed_type c;
          if (is >> c)
            color.setValue(c);
          return is;
        }

      }
    }
  }
}

#endif // OME_XML_MODEL_PRIMITIVES_COLOR_H

/*
 * Local Variables:
 * mode:C++
 * End:
 */