]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/rawbmp.h
Split wxTextCompleter into a base class and wxTextCompleterSimple.
[wxWidgets.git] / include / wx / rawbmp.h
index 3fca5566a7156054b5439eb36142d33ef173c6a9..ff353e39883470bebcd4178360d7e86b0a28895a 100644 (file)
@@ -9,10 +9,15 @@
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
-#ifndef _WX_RAWBMP_H_BASE_
-#define _WX_RAWBMP_H_BASE_
+#ifndef _WX_RAWBMP_H_
+#define _WX_RAWBMP_H_
+
+#include "wx/defs.h"
+
+#ifdef wxHAS_RAW_BITMAP
 
 #include "wx/image.h"
+#include "wx/bitmap.h"
 
 // ----------------------------------------------------------------------------
 // Abstract Pixel API
     }
  */
 
-#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 WXDLLIMPEXP_CORE 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
@@ -107,7 +114,7 @@ template <class Channel,
           size_t Bpp, int R, int G, int B, int A = -1,
           class Pixel = wxUint32>
 
-struct WXDLLEXPORT wxPixelFormat
+struct wxPixelFormat
 {
     // iterator over pixels is usually of type "ChannelType *"
     typedef Channel ChannelType;
@@ -146,7 +153,7 @@ typedef wxPixelFormat<unsigned char, 24, 0, 1, 2> wxImagePixelFormat;
 
 // the (most common) native bitmap format without alpha support
 #if defined(__WXMSW__)
-    // under MSW the RGB components are inversed, they're in BGR order
+    // 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
@@ -162,9 +169,14 @@ typedef wxPixelFormat<unsigned char, 24, 0, 1, 2> wxImagePixelFormat;
 
     #define wxPIXEL_FORMAT_ALPHA 3
 #elif defined(__WXGTK__)
-    // Under GTK+ 2.X we use GdkPixbuf, which should be RGBA
+    // 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
 
@@ -186,7 +198,7 @@ template <class T> struct wxPixelFormatFor;
 // classes (wxBitmap...) will result in compile errors which is exactly what we
 // want
 template <>
-struct WXDLLEXPORT wxPixelFormatFor<wxImage>
+struct wxPixelFormatFor<wxImage>
 {
     typedef wxImagePixelFormat Format;
 };
@@ -200,7 +212,7 @@ struct WXDLLEXPORT wxPixelFormatFor<wxImage>
     wxPixelDataBase is just a helper for wxPixelData: it contains things common
     to both wxImage and wxBitmap specializations.
  */
-class WXDLLEXPORT wxPixelDataBase
+class wxPixelDataBase
 {
 public:
     // origin of the rectangular region we represent
@@ -268,10 +280,10 @@ protected:
 
 // we need to define this skeleton template to mollify VC++
 template <class Image>
-struct WXDLLEXPORT wxPixelDataOut
+struct wxPixelDataOut
 {
     template <class PixelFormat>
-    class WXDLLEXPORT wxPixelDataIn
+    class wxPixelDataIn
     {
     public:
         class Iterator { };
@@ -282,12 +294,12 @@ struct WXDLLEXPORT wxPixelDataOut
 // 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>
-    class WXDLLEXPORT wxPixelDataIn : public wxPixelDataBase
+    class wxPixelDataIn : public wxPixelDataBase
     {
     public:
         // the type of the class we're working with
@@ -301,9 +313,6 @@ struct WXDLLEXPORT wxPixelDataOut<wxImage>
             // the pixel format we use
             typedef wxImagePixelFormat PixelFormat;
 
-            // the type of the pixel components
-            typedef typename dummyPixelFormat::ChannelType ChannelType;
-
             // the pixel data we're working with
             typedef
                 wxPixelDataOut<wxImage>::wxPixelDataIn<PixelFormat> PixelData;
@@ -398,11 +407,19 @@ struct WXDLLEXPORT wxPixelDataOut<wxImage>
             // data access
             // -----------
 
-            // access to invidividual colour components
-            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; }
+            // access to individual colour components
+            PixelFormat::ChannelType& Red() { return m_pRGB[PixelFormat::RED]; }
+            PixelFormat::ChannelType& Green() { return m_pRGB[PixelFormat::GREEN]; }
+            PixelFormat::ChannelType& Blue() { return m_pRGB[PixelFormat::BLUE]; }
+            PixelFormat::ChannelType& Alpha() { return *m_pAlpha; }
+
+            // address the pixel contents directly (always RGB, without alpha)
+            //
+            // this can't be used to modify the image as assigning a 32bpp
+            // value to 24bpp pixel would overwrite an extra byte in the next
+            // pixel or beyond the end of image
+            const typename PixelFormat::PixelType& Data()
+                { return *(typename PixelFormat::PixelType *)m_pRGB; }
 
         // private: -- see comment in the beginning of the file
 
@@ -418,7 +435,7 @@ struct WXDLLEXPORT wxPixelDataOut<wxImage>
         {
             m_width = image.GetWidth();
             m_height = image.GetHeight();
-            m_stride = Iterator::SizePixel * m_width;
+            m_stride = Iterator::PixelFormat::SizePixel * m_width;
         }
 
         // initializes us with the given region of the specified image
@@ -426,7 +443,7 @@ struct WXDLLEXPORT wxPixelDataOut<wxImage>
                       const wxPoint& pt,
                       const wxSize& sz) : m_image(image), m_pixels(image)
         {
-            m_stride = Iterator::SizePixel * m_width;
+            m_stride = Iterator::PixelFormat::SizePixel * m_width;
 
             InitRect(pt, sz);
         }
@@ -435,7 +452,7 @@ struct WXDLLEXPORT wxPixelDataOut<wxImage>
         wxPixelDataIn(ImageType& image,
                       const wxRect& rect) : m_image(image), m_pixels(image)
         {
-            m_stride = Iterator::SizePixel * m_width;
+            m_stride = Iterator::PixelFormat::SizePixel * m_width;
 
             InitRect(rect.GetPosition(), rect.GetSize());
         }
@@ -470,16 +487,16 @@ struct WXDLLEXPORT wxPixelDataOut<wxImage>
 // 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>
-    class WXDLLEXPORT wxPixelDataIn : public wxPixelDataBase
+    class wxPixelDataIn : public wxPixelDataBase
     {
     public:
         // the type of the class we're working with
         typedef wxBitmap ImageType;
 
-        class WXDLLEXPORT Iterator
+        class Iterator
         {
         public:
             // the pixel format we use
@@ -518,6 +535,12 @@ struct WXDLLEXPORT wxPixelDataOut<wxBitmap>
                             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; }
 
@@ -573,7 +596,7 @@ struct WXDLLEXPORT wxPixelDataOut<wxBitmap>
             // data access
             // -----------
 
-            // access to invidividual colour components
+            // access to individual colour components
             ChannelType& Red() { return m_ptr[PixelFormat::RED]; }
             ChannelType& Green() { return m_ptr[PixelFormat::GREEN]; }
             ChannelType& Blue() { return m_ptr[PixelFormat::BLUE]; }
@@ -582,6 +605,10 @@ struct WXDLLEXPORT wxPixelDataOut<wxBitmap>
             // address the pixel contents directly
             //
             // warning: the format is platform dependent
+            //
+            // warning 2: assigning to Data() only works correctly for 16bpp or
+            //            32bpp formats but using it for 24bpp ones overwrites
+            //            one extra byte and so can't be done
             typename PixelFormat::PixelType& Data()
                 { return *(typename PixelFormat::PixelType *)m_ptr; }
 
@@ -623,11 +650,22 @@ struct WXDLLEXPORT wxPixelDataOut<wxBitmap>
         // 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
 
@@ -648,17 +686,21 @@ struct WXDLLEXPORT wxPixelDataOut<wxBitmap>
         }
     };
 };
+
 #endif //wxUSE_GUI
 
-#ifdef __VISUALC__
-    // typedef-name 'foo' used as synonym for class-name 'bar'
-    // (VC++ gives this warning each time wxPixelData::Base is used but it
-    //  doesn't make any sense here -- what's wrong with using typedef instead
-    //  of class, this is what it is here for!)
-    #pragma warning(disable: 4097)
-#endif // __VISUALC__
+// FIXME-VC6: VC6 doesn't like typename in default template parameters while
+//            it is necessary with standard-conforming compilers, remove this
+//            #define and just use typename when we drop VC6 support
+#if defined(__VISUALC__) && !wxCHECK_VISUALC_VERSION(7)
+    #define wxTYPENAME_IN_TEMPLATE_DEFAULT_PARAM
+#else
+    #define wxTYPENAME_IN_TEMPLATE_DEFAULT_PARAM typename
+#endif
 
-template <class Image, class PixelFormat = wxPixelFormatFor<Image> >
+template <class Image,
+          class PixelFormat = wxTYPENAME_IN_TEMPLATE_DEFAULT_PARAM
+                                wxPixelFormatFor<Image>::Format >
 class wxPixelData :
     public wxPixelDataOut<Image>::template wxPixelDataIn<PixelFormat>
 {
@@ -677,7 +719,6 @@ public:
     }
 };
 
-
 // some "predefined" pixel data classes
 #if wxUSE_IMAGE
 typedef wxPixelData<wxImage> wxImagePixelData;
@@ -685,6 +726,7 @@ typedef wxPixelData<wxImage> wxImagePixelData;
 #if wxUSE_GUI
 typedef wxPixelData<wxBitmap, wxNativePixelFormat> wxNativePixelData;
 typedef wxPixelData<wxBitmap, wxAlphaPixelFormat> wxAlphaPixelData;
+
 #endif //wxUSE_GUI
 
 // ----------------------------------------------------------------------------
@@ -704,14 +746,9 @@ typedef wxPixelData<wxBitmap, wxAlphaPixelFormat> wxAlphaPixelData;
     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)
-    #pragma warning(default: 4097)
-#endif
-
-#endif // _WX_RAWBMP_H_BASE_
-
+#endif // wxHAS_RAW_BITMAP
+#endif // _WX_RAWBMP_H_