corrected/removed forward declarations

[wxWidgets.git] / include / wx / rawbmp.h

diff --git a/include/wx/rawbmp.h b/include/wx/rawbmp.h
index b0037d896626422bfd7d22645852b666fd9c3b46..3e599a602b287855d457b70de368a9f31d7cb957 100644 (file)
--- a/include/wx/rawbmp.h
+++ b/include/wx/rawbmp.h
@@ -5,12 +5,14 @@
 // Modified by:
 // Created:     10.03.03
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     10.03.03
 // RCS-ID:      $Id$

-// Copyright:   (c) 2002 Vadim Zeitlin <vadim@wxwindows.org>
+// Copyright:   (c) 2002 Vadim Zeitlin <vadim@wxwidgets.org>

 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 

-#ifndef _WX_RAWBMP_H_BASE_
-#define _WX_RAWBMP_H_BASE_
+#ifndef _WX_RAWBMP_H_
+#define _WX_RAWBMP_H_
+
+#include "wx/image.h"

 
 // ----------------------------------------------------------------------------
 // Abstract Pixel API
 
 // ----------------------------------------------------------------------------
 // Abstract Pixel API


@@ -69,10 +71,12 @@
     }
  */
 
     }
  */
 

-#ifdef __VISUALC__
-    // VC++ gives an absolutely harmless warning for wxPixelData<wxBitmap> ctor
-    #pragma warning(disable: 4355) // 'this' used in initializer list
-#endif
+/*
+    Note: we do not use WXDLLEXPORT with classes in this file because VC++ has
+    problems with exporting inner class defined inside a specialization of a
+    template class from a DLL. Besides, as all the methods are inline it's not
+    really necessary to put them in DLL at all.
+ */

 
 // ----------------------------------------------------------------------------
 // wxPixelFormat
 
 // ----------------------------------------------------------------------------
 // wxPixelFormat


@@ -100,10 +104,12 @@
         - index of the alpha component or -1 if none
         - type which can contain the full pixel value (all channels)
  */
         - index of the alpha component or -1 if none
         - type which can contain the full pixel value (all channels)
  */

-template <typename Channel,
+
+template <class Channel,

           size_t Bpp, int R, int G, int B, int A = -1,
           size_t Bpp, int R, int G, int B, int A = -1,

-          typename Pixel = wxUint32>
-struct WXDLLEXPORT wxPixelFormat
+          class Pixel = wxUint32>
+
+struct wxPixelFormat

 {
     // iterator over pixels is usually of type "ChannelType *"
     typedef Channel ChannelType;
 {
     // iterator over pixels is usually of type "ChannelType *"
     typedef Channel ChannelType;


@@ -118,7 +124,7 @@ struct WXDLLEXPORT wxPixelFormat
     enum { BitsPerPixel = Bpp };
 
     // size of one pixel in ChannelType units (usually bytes)
     enum { BitsPerPixel = Bpp };
 
     // size of one pixel in ChannelType units (usually bytes)

-    enum { SizePixel = BitsPerPixel / (8 * sizeof(ChannelType)) };
+    enum { SizePixel = Bpp / (8 * sizeof(Channel)) };

 
     // the channels indices inside the pixel
     enum
 
     // the channels indices inside the pixel
     enum


@@ -141,33 +147,57 @@ struct WXDLLEXPORT wxPixelFormat
 typedef wxPixelFormat<unsigned char, 24, 0, 1, 2> wxImagePixelFormat;
 
 // the (most common) native bitmap format without alpha support
 typedef wxPixelFormat<unsigned char, 24, 0, 1, 2> wxImagePixelFormat;
 
 // the (most common) native bitmap format without alpha support

-typedef wxPixelFormat<unsigned char, 24,
-                      #ifdef __WXMSW__
-                                2, 1, 0
-                      #else // !__WXMSW__
-                                0, 1, 2
-                      #endif // __WXMSW__/!__WXMSW__
-                     > wxNativePixelFormat;
+#if defined(__WXMSW__)
+    // under MSW the RGB components are reversed, they're in BGR order
+    typedef wxPixelFormat<unsigned char, 24, 2, 1, 0> wxNativePixelFormat;
+
+    #define wxPIXEL_FORMAT_ALPHA 3
+#elif defined(__WXMAC__)
+    // under Mac, first component is unused but still present, hence we use
+    // 32bpp, not 24
+    typedef wxPixelFormat<unsigned char, 32, 1, 2, 3> wxNativePixelFormat;
+
+    #define wxPIXEL_FORMAT_ALPHA 0
+#elif defined(__WXCOCOA__)
+    // Cocoa is standard RGB or RGBA (normally it is RGBA)
+    typedef wxPixelFormat<unsigned char, 24, 0, 1, 2> wxNativePixelFormat;
+
+    #define wxPIXEL_FORMAT_ALPHA 3
+#elif defined(__WXGTK__)
+    // Under GTK+ 2.X we use GdkPixbuf, which is standard RGB or RGBA
+    typedef wxPixelFormat<unsigned char, 24, 0, 1, 2> wxNativePixelFormat;
+
+    #define wxPIXEL_FORMAT_ALPHA 3
+#elif defined(__WXDFB__)
+    // Under DirectFB, RGB components are reversed, they're in BGR order
+    typedef wxPixelFormat<unsigned char, 24, 2, 1, 0> wxNativePixelFormat;
+
+    #define wxPIXEL_FORMAT_ALPHA 3
+#endif

 
 // the (most common) native format for bitmaps with alpha channel
 
 // the (most common) native format for bitmaps with alpha channel

-typedef wxPixelFormat<unsigned char, 32,
-                      wxNativePixelFormat::RED,
-                      wxNativePixelFormat::GREEN,
-                      wxNativePixelFormat::BLUE,
-                      3> wxAlphaPixelFormat;
+#ifdef wxPIXEL_FORMAT_ALPHA
+    typedef wxPixelFormat<unsigned char, 32,
+                          wxNativePixelFormat::RED,
+                          wxNativePixelFormat::GREEN,
+                          wxNativePixelFormat::BLUE,
+                          wxPIXEL_FORMAT_ALPHA> wxAlphaPixelFormat;
+#endif // wxPIXEL_FORMAT_ALPHA

 
 // we also define the (default/best) pixel format for the given class: this is
 // used as default value for the pixel format in wxPixelIterator template
 template <class T> struct wxPixelFormatFor;
 
 
 // we also define the (default/best) pixel format for the given class: this is
 // used as default value for the pixel format in wxPixelIterator template
 template <class T> struct wxPixelFormatFor;
 

+#if wxUSE_IMAGE

 // wxPixelFormatFor is only defined for wxImage, attempt to use it with other
 // classes (wxBitmap...) will result in compile errors which is exactly what we
 // want
 template <>
 // wxPixelFormatFor is only defined for wxImage, attempt to use it with other
 // classes (wxBitmap...) will result in compile errors which is exactly what we
 // want
 template <>

-struct WXDLLEXPORT wxPixelFormatFor<wxImage>
+struct wxPixelFormatFor<wxImage>

 {
     typedef wxImagePixelFormat Format;
 };
 {
     typedef wxImagePixelFormat Format;
 };

+#endif //wxUSE_IMAGE

 
 // ----------------------------------------------------------------------------
 // wxPixelData
 
 // ----------------------------------------------------------------------------
 // wxPixelData


@@ -177,15 +207,26 @@ struct WXDLLEXPORT wxPixelFormatFor<wxImage>
     wxPixelDataBase is just a helper for wxPixelData: it contains things common
     to both wxImage and wxBitmap specializations.
  */
     wxPixelDataBase is just a helper for wxPixelData: it contains things common
     to both wxImage and wxBitmap specializations.
  */

-class WXDLLEXPORT wxPixelDataBase
+class wxPixelDataBase

 {
 public:
 {
 public:

+    // origin of the rectangular region we represent
+    wxPoint GetOrigin() const { return m_ptOrigin; }
+
+    // width and height of the region we represent

     int GetWidth() const { return m_width; }
     int GetHeight() const { return m_height; }
     int GetWidth() const { return m_width; }
     int GetHeight() const { return m_height; }

+
+    wxSize GetSize() const { return wxSize(m_width, m_height); }
+
+    // the distance between two rows

     int GetRowStride() const { return m_stride; }
 
 // private: -- see comment in the beginning of the file
 
     int GetRowStride() const { return m_stride; }
 
 // private: -- see comment in the beginning of the file
 

+    // the origin of this image inside the bigger bitmap (usually (0, 0))
+    wxPoint m_ptOrigin;
+

     // the size of the image we address, in pixels
     int m_width,
         m_height;
     // the size of the image we address, in pixels
     int m_width,
         m_height;


@@ -234,26 +275,28 @@ protected:
 
 // we need to define this skeleton template to mollify VC++
 template <class Image>
 
 // we need to define this skeleton template to mollify VC++
 template <class Image>

-struct WXDLLEXPORT wxPixelDataOut
+struct wxPixelDataOut

 {
     template <class PixelFormat>
 {
     template <class PixelFormat>

-    class WXDLLEXPORT wxPixelDataIn
+    class wxPixelDataIn

     {
     public:
         class Iterator { };
     };
 };
 
     {
     public:
         class Iterator { };
     };
 };
 

+#if wxUSE_IMAGE

 // wxPixelData specialization for wxImage: this is the simplest case as we
 // don't have to care about different pixel formats here
 template <>
 // wxPixelData specialization for wxImage: this is the simplest case as we
 // don't have to care about different pixel formats here
 template <>

-struct WXDLLEXPORT wxPixelDataOut<wxImage>
+struct wxPixelDataOut<wxImage>

 {
     // NB: this is a template class even though it doesn't use its template
     //     parameter because otherwise wxPixelData couldn't compile
     template <class dummyPixelFormat>
 {
     // NB: this is a template class even though it doesn't use its template
     //     parameter because otherwise wxPixelData couldn't compile
     template <class dummyPixelFormat>

-    class WXDLLEXPORT wxPixelDataIn : public wxPixelDataBase
+    class wxPixelDataIn : public wxPixelDataBase

     {
     {

+    public:

         // the type of the class we're working with
         typedef wxImage ImageType;
 
         // the type of the class we're working with
         typedef wxImage ImageType;
 


@@ -266,7 +309,7 @@ struct WXDLLEXPORT wxPixelDataOut<wxImage>
             typedef wxImagePixelFormat PixelFormat;
 
             // the type of the pixel components
             typedef wxImagePixelFormat PixelFormat;
 
             // the type of the pixel components

-            typedef typename PixelFormat::ChannelType ChannelType;
+            typedef typename dummyPixelFormat::ChannelType ChannelType;

 
             // the pixel data we're working with
             typedef
 
             // the pixel data we're working with
             typedef


@@ -311,12 +354,13 @@ struct WXDLLEXPORT wxPixelDataOut<wxImage>
             {
                 m_pRGB += PixelFormat::SizePixel;
                 if ( m_pAlpha )
             {
                 m_pRGB += PixelFormat::SizePixel;
                 if ( m_pAlpha )

-                    m_pAlpha += PixelFormat::SizePixel;
+                    ++m_pAlpha;

 
                 return *this;
             }
 
 
                 return *this;
             }
 

-            // postfix (hence less efficient -- don't use unless you must) version
+            // postfix (hence less efficient -- don't use it unless you
+            // absolutely must) version

             Iterator operator++(int)
             {
                 Iterator p(*this);
             Iterator operator++(int)
             {
                 Iterator p(*this);


@@ -362,9 +406,9 @@ struct WXDLLEXPORT wxPixelDataOut<wxImage>
             // -----------
 
             // access to invidividual colour components
             // -----------
 
             // access to invidividual colour components

-            ChannelType& Red() { return m_ptr[PixelFormat::RED]; }
-            ChannelType& Green() { return m_ptr[PixelFormat::GREEN]; }
-            ChannelType& Blue() { return m_ptr[PixelFormat::BLUE]; }
+            ChannelType& Red() { return m_pRGB[PixelFormat::RED]; }
+            ChannelType& Green() { return m_pRGB[PixelFormat::GREEN]; }
+            ChannelType& Blue() { return m_pRGB[PixelFormat::BLUE]; }

             ChannelType& Alpha() { return *m_pAlpha; }
 
         // private: -- see comment in the beginning of the file
             ChannelType& Alpha() { return *m_pAlpha; }
 
         // private: -- see comment in the beginning of the file


@@ -384,6 +428,25 @@ struct WXDLLEXPORT wxPixelDataOut<wxImage>
             m_stride = Iterator::SizePixel * m_width;
         }
 
             m_stride = Iterator::SizePixel * m_width;
         }
 

+        // initializes us with the given region of the specified image
+        wxPixelDataIn(ImageType& image,
+                      const wxPoint& pt,
+                      const wxSize& sz) : m_image(image), m_pixels(image)
+        {
+            m_stride = Iterator::SizePixel * m_width;
+
+            InitRect(pt, sz);
+        }
+
+        // initializes us with the given region of the specified image
+        wxPixelDataIn(ImageType& image,
+                      const wxRect& rect) : m_image(image), m_pixels(image)
+        {
+            m_stride = Iterator::SizePixel * m_width;
+
+            InitRect(rect.GetPosition(), rect.GetSize());
+        }
+

         // we evaluate to true only if we could get access to bitmap data
         // successfully
         operator bool() const { return m_pixels.IsOk(); }
         // we evaluate to true only if we could get access to bitmap data
         // successfully
         operator bool() const { return m_pixels.IsOk(); }


@@ -392,6 +455,15 @@ struct WXDLLEXPORT wxPixelDataOut<wxImage>
         Iterator GetPixels() const { return m_pixels; }
 
     private:
         Iterator GetPixels() const { return m_pixels; }
 
     private:

+        void InitRect(const wxPoint& pt, const wxSize& sz)
+        {
+            m_width = sz.x;
+            m_height = sz.y;
+
+            m_ptOrigin = pt;
+            m_pixels.Offset(*this, pt.x, pt.y);
+        }
+

         // the image we're working with
         ImageType& m_image;
 
         // the image we're working with
         ImageType& m_image;
 


@@ -399,14 +471,16 @@ struct WXDLLEXPORT wxPixelDataOut<wxImage>
         Iterator m_pixels;
     };
 };
         Iterator m_pixels;
     };
 };

+#endif //wxUSE_IMAGE

 
 

+#if wxUSE_GUI

 // wxPixelData specialization for wxBitmap: here things are more interesting as
 // we also have to support different pixel formats
 template <>
 // wxPixelData specialization for wxBitmap: here things are more interesting as
 // we also have to support different pixel formats
 template <>

-struct WXDLLEXPORT wxPixelDataOut<wxBitmap>
+struct wxPixelDataOut<wxBitmap>

 {
     template <class Format>
 {
     template <class Format>

-    class WXDLLEXPORT wxPixelDataIn : public wxPixelDataBase
+    class wxPixelDataIn : public wxPixelDataBase

     {
     public:
         // the type of the class we're working with
     {
     public:
         // the type of the class we're working with


@@ -431,25 +505,32 @@ struct WXDLLEXPORT wxPixelDataOut<wxBitmap>
                 *this = data.GetPixels();
             }
 
                 *this = data.GetPixels();
             }
 

-            // initializes the iterator to point to the origin of the given pixel
-            // data
+            // initializes the iterator to point to the origin of the given
+            // pixel data

             Iterator(PixelData& data)
             {
                 Reset(data);
             }
 
             Iterator(PixelData& data)
             {
                 Reset(data);
             }
 

-            // initializes the iterator to point to the origin of the given bitmap
+            // initializes the iterator to point to the origin of the given
+            // bitmap

             Iterator(wxBitmap& bmp, PixelData& data)
             {
             Iterator(wxBitmap& bmp, PixelData& data)
             {

-                // using cast here is ugly but it should be safe as GetRawData()
-                // real return type should be consistent with BitsPerPixel (which
-                // is in turn defined by ChannelType) and this is the only thing we
-                // can do without making GetRawData() a template function which is
-                // undesirable
+                // using cast here is ugly but it should be safe as
+                // GetRawData() real return type should be consistent with
+                // BitsPerPixel (which is in turn defined by ChannelType) and
+                // this is the only thing we can do without making GetRawData()
+                // a template function which is undesirable

                 m_ptr = (ChannelType *)
                             bmp.GetRawData(data, PixelFormat::BitsPerPixel);
             }
 
                 m_ptr = (ChannelType *)
                             bmp.GetRawData(data, PixelFormat::BitsPerPixel);
             }
 

+            // default constructor
+            Iterator()
+            {
+                m_ptr = NULL;
+            }
+

             // return true if this iterator is valid
             bool IsOk() const { return m_ptr != NULL; }
 
             // return true if this iterator is valid
             bool IsOk() const { return m_ptr != NULL; }
 


@@ -465,7 +546,8 @@ struct WXDLLEXPORT wxPixelDataOut<wxBitmap>
                 return *this;
             }
 
                 return *this;
             }
 

-            // postfix (hence less efficient -- don't use unless you must) version
+            // postfix (hence less efficient -- don't use it unless you
+            // absolutely must) version

             Iterator operator++(int)
             {
                 Iterator p(*this);
             Iterator operator++(int)
             {
                 Iterator p(*this);


@@ -518,17 +600,30 @@ struct WXDLLEXPORT wxPixelDataOut<wxBitmap>
 
         // private: -- see comment in the beginning of the file
 
 
         // private: -- see comment in the beginning of the file
 

-            // NB: for efficiency reasons this class must *not* have any other
-            //     fields, otherwise it won't be put into a CPU register (as it
-            //     should inside the inner loops) by some compilers, notably gcc
+            // for efficiency reasons this class should not have any other
+            // fields, otherwise it won't be put into a CPU register (as it
+            // should inside the inner loops) by some compilers, notably gcc

             ChannelType *m_ptr;
         };
 
             ChannelType *m_ptr;
         };
 

-        // ctor associates this pointer with a bitmap and locks the bitmap for raw
-        // access, it will be unlocked only by our dtor and so these objects should
-        // normally be only created on the stack, i.e. have limited life-time
-        wxPixelDataIn(wxBitmap bmp) : m_bmp(bmp), m_pixels(bmp, *this)
+        // ctor associates this pointer with a bitmap and locks the bitmap for
+        // raw access, it will be unlocked only by our dtor and so these
+        // objects should normally be only created on the stack, i.e. have
+        // limited life-time
+        wxPixelDataIn(wxBitmap& bmp) : m_bmp(bmp), m_pixels(bmp, *this)
+        {
+        }
+
+        wxPixelDataIn(wxBitmap& bmp, const wxRect& rect)
+            : m_bmp(bmp), m_pixels(bmp, *this)

         {
         {

+            InitRect(rect.GetPosition(), rect.GetSize());
+        }
+
+        wxPixelDataIn(wxBitmap& bmp, const wxPoint& pt, const wxSize& sz)
+            : m_bmp(bmp), m_pixels(bmp, *this)
+        {
+            InitRect(pt, sz);

         }
 
         // we evaluate to true only if we could get access to bitmap data
         }
 
         // we evaluate to true only if we could get access to bitmap data


@@ -541,11 +636,22 @@ struct WXDLLEXPORT wxPixelDataOut<wxBitmap>
         // dtor unlocks the bitmap
         ~wxPixelDataIn()
         {
         // dtor unlocks the bitmap
         ~wxPixelDataIn()
         {

-            m_bmp.UngetRawData(*this);
+            if ( m_pixels.IsOk() )
+            {
+#if defined(__WXMSW__) || defined(__WXMAC__)
+                // this is a hack to mark wxBitmap as using alpha channel
+                if ( Format::HasAlpha )
+                    m_bmp.UseAlpha();
+#endif
+                m_bmp.UngetRawData(*this);
+            }
+            // else: don't call UngetRawData() if GetRawData() failed

         }
 
         }
 

-        // call this to indicate that we should use the alpha channel
-        void UseAlpha() { m_bmp.UseAlpha(); }
+#if WXWIN_COMPATIBILITY_2_8
+        // not needed anymore, calls to it should be simply removed
+        wxDEPRECATED_INLINE( void UseAlpha(), wxEMPTY_PARAMETER_VALUE )
+#endif

 
     // private: -- see comment in the beginning of the file
 
 
     // private: -- see comment in the beginning of the file
 


@@ -554,25 +660,50 @@ struct WXDLLEXPORT wxPixelDataOut<wxBitmap>
 
         // the iterator pointing to the image origin
         Iterator m_pixels;
 
         // the iterator pointing to the image origin
         Iterator m_pixels;

+
+    private:
+        void InitRect(const wxPoint& pt, const wxSize& sz)
+        {
+            m_pixels.Offset(*this, pt.x, pt.y);
+
+            m_ptOrigin = pt;
+            m_width = sz.x;
+            m_height = sz.y;
+        }

     };
 };
 
     };
 };
 

+#endif //wxUSE_GUI
+

 template <class Image, class PixelFormat = wxPixelFormatFor<Image> >
 class wxPixelData :
     public wxPixelDataOut<Image>::template wxPixelDataIn<PixelFormat>
 {
 public:
 template <class Image, class PixelFormat = wxPixelFormatFor<Image> >
 class wxPixelData :
     public wxPixelDataOut<Image>::template wxPixelDataIn<PixelFormat>
 {
 public:

-    wxPixelData(const Image& image)
-        : wxPixelDataOut<Image>::template wxPixelDataIn<PixelFormat>(image)
-        {
-        }
+    typedef
+        typename wxPixelDataOut<Image>::template wxPixelDataIn<PixelFormat>
+        Base;
+
+    wxPixelData(Image& image) : Base(image) { }
+
+    wxPixelData(Image& i, const wxRect& rect) : Base(i, rect) { }
+
+    wxPixelData(Image& i, const wxPoint& pt, const wxSize& sz)
+        : Base(i, pt, sz)
+    {
+    }

 };
 
 // some "predefined" pixel data classes
 };
 
 // some "predefined" pixel data classes

+#if wxUSE_IMAGE

 typedef wxPixelData<wxImage> wxImagePixelData;
 typedef wxPixelData<wxImage> wxImagePixelData;

+#endif //wxUSE_IMAGE
+#if wxUSE_GUI

 typedef wxPixelData<wxBitmap, wxNativePixelFormat> wxNativePixelData;
 typedef wxPixelData<wxBitmap, wxAlphaPixelFormat> wxAlphaPixelData;
 
 typedef wxPixelData<wxBitmap, wxNativePixelFormat> wxNativePixelData;
 typedef wxPixelData<wxBitmap, wxAlphaPixelFormat> wxAlphaPixelData;
 

+#endif //wxUSE_GUI
+

 // ----------------------------------------------------------------------------
 // wxPixelIterator
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxPixelIterator
 // ----------------------------------------------------------------------------


@@ -590,13 +721,8 @@ typedef wxPixelData<wxBitmap, wxAlphaPixelFormat> wxAlphaPixelData;
     partial template specialization then and neither VC6 nor VC7 provide it.
  */
 template < class Image, class PixelFormat = wxPixelFormatFor<Image> >
     partial template specialization then and neither VC6 nor VC7 provide it.
  */
 template < class Image, class PixelFormat = wxPixelFormatFor<Image> >

-struct WXDLLEXPORT wxPixelIterator : wxPixelData<Image, PixelFormat>::Iterator
+struct wxPixelIterator : public wxPixelData<Image, PixelFormat>::Iterator

 {
 };
 
 {
 };
 

-#ifdef __VISUALC__
-    #pragma warning(default: 4355)
-#endif
-
-#endif // _WX_RAWBMP_H_BASE_
-
+#endif // _WX_RAWBMP_H_