Tests for UTF-8 and PUA characters and octal escapes

[wxWidgets.git] / wxPython / src / _image.i

diff --git a/wxPython/src/_image.i b/wxPython/src/_image.i
index b475672670759385cc927955788931cfdbfbf600..27f48e9319fa20d09d2169675dc0f7f2337a5c5e 100644 (file)
--- a/wxPython/src/_image.i
+++ b/wxPython/src/_image.i
@@ -68,6 +68,37 @@ public:
         "Find first colour that is not used in the image and has higher RGB
 values than startR, startG, startB.  Returns a tuple consisting of a
 success flag and rgb values.", "");
         "Find first colour that is not used in the image and has higher RGB
 values than startR, startG, startB.  Returns a tuple consisting of a
 success flag and rgb values.", "");

+
+    %extend {
+        DocStr(GetCount,
+               "Returns the pixel count for the given key.  Use `MakeKey` to create a
+key value from a RGB tripple.", "");
+        unsigned long GetCount(unsigned long key) {
+            wxImageHistogramEntry e = (*self)[key];
+            return e.value;
+        }
+
+        DocStr(GetCountRGB,
+               "Returns the pixel count for the given RGB values.", "");
+        unsigned long GetCountRGB(unsigned char r,
+                                  unsigned char g,
+                                  unsigned char b) {
+            unsigned long key = wxImageHistogram::MakeKey(r, g, b);
+            wxImageHistogramEntry e = (*self)[key];
+            return e.value;
+        }
+        
+        DocStr(GetCountColour,
+               "Returns the pixel count for the given `wx.Colour` value.", "");
+        unsigned long GetCountColour(const wxColour& colour) {
+            unsigned long key = wxImageHistogram::MakeKey(colour.Red(),
+                                                          colour.Green(),
+                                                          colour.Blue());
+            wxImageHistogramEntry e = (*self)[key];
+            return e.value;
+        }
+    }
+    

 };
 
 
 };
 
 


@@ -76,15 +107,32 @@ success flag and rgb values.", "");
 
 class wxImage : public wxObject {
 public:
 
 class wxImage : public wxObject {
 public:

-    wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );
+    DocCtorStr(
+        wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 ),
+        "", "");
+    

     ~wxImage();
 
     // Alternate constructors
     ~wxImage();
 
     // Alternate constructors

-    %name(ImageFromMime) wxImage(const wxString& name, const wxString& mimetype, int index = -1);
-    %name(ImageFromStream) wxImage(wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1);
-    %name(ImageFromStreamMime) wxImage(wxInputStream& stream, const wxString& mimetype, int index = -1 );
+    DocCtorStrName(
+        wxImage(const wxString& name, const wxString& mimetype, int index = -1),
+        "", "",
+        ImageFromMime);
+    
+    DocCtorStrName(
+        wxImage(wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1),
+        "", "",
+        ImageFromStream);
+    
+    DocCtorStrName(
+        wxImage(wxInputStream& stream, const wxString& mimetype, int index = -1 ),
+        "", "",
+        ImageFromStreamMime);
+    

     %extend {
     %extend {

-        %name(EmptyImage) wxImage(int width=0, int height=0, bool clear = True) {
+        %rename(EmptyImage) wxImage(int width=0, int height=0, bool clear = true);
+        wxImage(int width=0, int height=0, bool clear = true)
+        {

             if (width > 0 && height > 0)
                 return new wxImage(width, height, clear);
             else
             if (width > 0 && height > 0)
                 return new wxImage(width, height, clear);
             else


@@ -92,11 +140,15 @@ public:
         }
 
         MustHaveApp(wxImage(const wxBitmap &bitmap));
         }
 
         MustHaveApp(wxImage(const wxBitmap &bitmap));

-        %name(ImageFromBitmap) wxImage(const wxBitmap &bitmap) {
+        %rename(ImageFromBitmap) wxImage(const wxBitmap &bitmap);
+        wxImage(const wxBitmap &bitmap)
+        {

             return new wxImage(bitmap.ConvertToImage());
         }
 
             return new wxImage(bitmap.ConvertToImage());
         }
 

-        %name(ImageFromData) wxImage(int width, int height, unsigned char* data) {
+        %rename(ImageFromData) wxImage(int width, int height, unsigned char* data);
+        wxImage(int width, int height, unsigned char* data)
+        {

             // Copy the source data so the wxImage can clean it up later
             unsigned char* copy = (unsigned char*)malloc(width*height*3);
             if (copy == NULL) {
             // Copy the source data so the wxImage can clean it up later
             unsigned char* copy = (unsigned char*)malloc(width*height*3);
             if (copy == NULL) {


@@ -104,10 +156,34 @@ public:
                 return NULL;
             }
             memcpy(copy, data, width*height*3);
                 return NULL;
             }
             memcpy(copy, data, width*height*3);

-            return new wxImage(width, height, copy, False);
+            return new wxImage(width, height, copy, false);
+        }
+
+        
+        %rename(ImageFromDataWithAlpha) wxImage(int width, int height, unsigned char* data, unsigned char* alpha);
+        wxImage(int width, int height, unsigned char* data, unsigned char* alpha)
+        {
+            // Copy the source data so the wxImage can clean it up later
+            unsigned char* dcopy = (unsigned char*)malloc(width*height*3);
+            if (dcopy == NULL) {
+                PyErr_NoMemory();
+                return NULL;
+            }
+            memcpy(dcopy, data, width*height*3);
+            unsigned char* acopy = (unsigned char*)malloc(width*height);
+            if (acopy == NULL) {
+                PyErr_NoMemory();
+                return NULL;
+            }
+            memcpy(acopy, alpha, width*height);
+            
+            return new wxImage(width, height, dcopy, acopy, false);

         }
     }
 
         }
     }
 

+    // TODO: wxImage( char** xpmData );
+
+

     void Create( int width, int height );
     void Destroy();
 
     void Create( int width, int height );
     void Destroy();
 


@@ -115,7 +191,16 @@ public:
     wxImage ShrinkBy( int xFactor , int yFactor ) const ;
     wxImage& Rescale(int width, int height);
 
     wxImage ShrinkBy( int xFactor , int yFactor ) const ;
     wxImage& Rescale(int width, int height);
 

+    // resizes the image in place
+    wxImage& Resize( const wxSize& size, const wxPoint& pos, 
+                     int r = -1, int g = -1, int b = -1 );
+    

     void SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b );
     void SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b );

+
+    %Rename(SetRGBRect,
+            void, SetRGB( const wxRect& rect,
+                          unsigned char r, unsigned char g, unsigned char b ));
+

     unsigned char GetRed( int x, int y );
     unsigned char GetGreen( int x, int y );
     unsigned char GetBlue( int x, int y );
     unsigned char GetRed( int x, int y );
     unsigned char GetGreen( int x, int y );
     unsigned char GetBlue( int x, int y );


@@ -124,6 +209,14 @@ public:
     unsigned char GetAlpha(int x, int y);
     bool HasAlpha();
 
     unsigned char GetAlpha(int x, int y);
     bool HasAlpha();
 

+    DocDeclStr(
+        void , InitAlpha(),
+        "Initializes the image alpha channel data. It is an error to call it if
+the image already has alpha data. If it doesn't, alpha data will be by
+default initialized to all pixels being fully opaque. But if the image
+has a a mask colour, all mask pixels will be completely transparent.", "");
+    
+    

     // find first colour that is not used in the image and has higher
     // RGB values than <startR,startG,startB>
     DocDeclAStr(
     // find first colour that is not used in the image and has higher
     // RGB values than <startR,startG,startB>
     DocDeclAStr(


@@ -134,7 +227,30 @@ public:
 values than startR, startG, startB.  Returns a tuple consisting of a
 success flag and rgb values.", "");
 
 values than startR, startG, startB.  Returns a tuple consisting of a
 success flag and rgb values.", "");
 

+    
+    DocDeclStr(
+        bool , ConvertAlphaToMask(byte threshold = 128),
+        "If the image has alpha channel, this method converts it to mask. All pixels
+with alpha value less than ``threshold`` are replaced with mask colour and the
+alpha channel is removed. Mask colour is chosen automatically using
+`FindFirstUnusedColour`.
+
+If the image image doesn't have alpha channel, ConvertAlphaToMask does
+nothing.", "");
+    
+
+    DocDeclStr(
+        bool , ConvertColourToAlpha( unsigned char r, unsigned char g, unsigned char b ),
+        "This method converts an image where the original alpha information is
+only available as a shades of a colour (actually shades of grey)
+typically when you draw anti-aliased text into a bitmap. The DC
+drawing routines draw grey values on the black background although
+they actually mean to draw white with differnt alpha values.  This
+method reverses it, assuming a black (!) background and white text.
+The method will then fill up the whole image with the colour given.", "");
+    

 
 

+    

     // Set image's mask to the area of 'mask' that has <mr,mg,mb> colour
     bool SetMaskFromImage(const wxImage & mask,
                           byte mr, byte mg, byte mb);
     // Set image's mask to the area of 'mask' that has <mr,mg,mb> colour
     bool SetMaskFromImage(const wxImage & mask,
                           byte mr, byte mg, byte mb);


@@ -149,14 +265,14 @@ success flag and rgb values.", "");
     static int GetImageCount( const wxString& name, long type = wxBITMAP_TYPE_ANY );
 
     bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );
     static int GetImageCount( const wxString& name, long type = wxBITMAP_TYPE_ANY );
 
     bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );

-    %name(LoadMimeFile)bool LoadFile( const wxString& name, const wxString& mimetype, int index = -1 );
+    %Rename(LoadMimeFile, bool,  LoadFile( const wxString& name, const wxString& mimetype, int index = -1 ));

 
     bool SaveFile( const wxString& name, int type );
 
     bool SaveFile( const wxString& name, int type );

-    %name(SaveMimeFile)bool SaveFile( const wxString& name, const wxString& mimetype );
+    %Rename(SaveMimeFile, bool,  SaveFile( const wxString& name, const wxString& mimetype ));

 
 

-    %name(CanReadStream) static bool CanRead( wxInputStream& stream );
-    %name(LoadStream) bool LoadFile( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 );
-    %name(LoadMimeStream) bool LoadFile( wxInputStream& stream, const wxString& mimetype, int index = -1 );
+    %Rename(CanReadStream, static bool,  CanRead( wxInputStream& stream ));
+    %Rename(LoadStream, bool,  LoadFile( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 ));
+    %Rename(LoadMimeStream, bool,  LoadFile( wxInputStream& stream, const wxString& mimetype, int index = -1 ));

 
     bool Ok();
     int GetWidth();
 
     bool Ok();
     int GetWidth();


@@ -170,6 +286,14 @@ success flag and rgb values.", "");
     }
 
     wxImage GetSubImage(const wxRect& rect);
     }
 
     wxImage GetSubImage(const wxRect& rect);

+
+    // Paste the image or part of this image into an image of the given size at the pos
+    //  any newly exposed areas will be filled with the rgb colour
+    //  by default if r = g = b = -1 then fill with this image's mask colour or find and 
+    //  set a suitable mask colour
+    wxImage Size( const wxSize& size, const wxPoint& pos, 
+                  int r = -1, int g = -1, int b = -1 ) const;
+    

     wxImage Copy();
     void Paste( const wxImage &image, int x, int y );
 
     wxImage Copy();
     void Paste( const wxImage &image, int x, int y );
 


@@ -188,7 +312,8 @@ success flag and rgb values.", "");
             unsigned char* dataPtr;
 
             if (! PyString_Check(data)) {
             unsigned char* dataPtr;
 
             if (! PyString_Check(data)) {

-                PyErr_SetString(PyExc_TypeError, "Expected string object");
+                wxPyBLOCK_THREADS(PyErr_SetString(PyExc_TypeError,
+                                                  "Expected string object"));

                 return /* NULL */ ;
             }
 
                 return /* NULL */ ;
             }
 


@@ -212,7 +337,7 @@ success flag and rgb values.", "");
             unsigned char* buffer;
             int size;
 
             unsigned char* buffer;
             int size;
 

-            bool blocked = wxPyBeginBlockThreads();
+            wxPyBlock_t blocked = wxPyBeginBlockThreads();

             if (!PyArg_Parse(data, "t#", &buffer, &size))
                 goto done;
 
             if (!PyArg_Parse(data, "t#", &buffer, &size))
                 goto done;
 


@@ -266,7 +391,7 @@ success flag and rgb values.", "");
             unsigned char* buffer;
             int size;
 
             unsigned char* buffer;
             int size;
 

-            bool blocked = wxPyBeginBlockThreads();
+            wxPyBlock_t blocked = wxPyBeginBlockThreads();

             if (!PyArg_Parse(data, "t#", &buffer, &size))
                 goto done;
 
             if (!PyArg_Parse(data, "t#", &buffer, &size))
                 goto done;
 


@@ -281,16 +406,25 @@ success flag and rgb values.", "");
     }
 
     void SetMaskColour( unsigned char r, unsigned char g, unsigned char b );
     }
 
     void SetMaskColour( unsigned char r, unsigned char g, unsigned char b );

+
+    DocDeclAStr(
+        /*bool*/ void , GetOrFindMaskColour( unsigned char *OUTPUT,
+                                             unsigned char *OUTPUT,
+                                             unsigned char *OUTPUT ) const,
+        "GetOrFindMaskColour() -> (r,g,b)",
+        "Get the current mask colour or find a suitable colour.", "");
+    
+

     unsigned char GetMaskRed();
     unsigned char GetMaskGreen();
     unsigned char GetMaskBlue();
     unsigned char GetMaskRed();
     unsigned char GetMaskGreen();
     unsigned char GetMaskBlue();

-    void SetMask( bool mask = True );
+    void SetMask( bool mask = true );

     bool HasMask();
 
     wxImage Rotate(double angle, const wxPoint & centre_of_rotation,
     bool HasMask();
 
     wxImage Rotate(double angle, const wxPoint & centre_of_rotation,

-                   bool interpolating = True, wxPoint * offset_after_rotation = NULL) const ;
-    wxImage Rotate90( bool clockwise = True ) ;
-    wxImage Mirror( bool horizontally = True ) ;
+                   bool interpolating = true, wxPoint * offset_after_rotation = NULL) const ;
+    wxImage Rotate90( bool clockwise = true ) ;
+    wxImage Mirror( bool horizontally = true ) ;

 
     void Replace( unsigned char r1, unsigned char g1, unsigned char b1,
                   unsigned char r2, unsigned char g2, unsigned char b2 );
 
     void Replace( unsigned char r1, unsigned char g1, unsigned char b1,
                   unsigned char r2, unsigned char g2, unsigned char b2 );


@@ -299,7 +433,7 @@ success flag and rgb values.", "");
     wxImage ConvertToMono( unsigned char r, unsigned char g, unsigned char b ) const;
 
     void SetOption(const wxString& name, const wxString& value);
     wxImage ConvertToMono( unsigned char r, unsigned char g, unsigned char b ) const;
 
     void SetOption(const wxString& name, const wxString& value);

-    %name(SetOptionInt)void SetOption(const wxString& name, int value);
+    %Rename(SetOptionInt, void,  SetOption(const wxString& name, int value));

     wxString GetOption(const wxString& name) const;
     int GetOptionInt(const wxString& name) const;
     bool HasOption(const wxString& name) const;
     wxString GetOption(const wxString& name) const;
     int GetOptionInt(const wxString& name) const;
     bool HasOption(const wxString& name) const;


@@ -317,8 +451,8 @@ MustHaveApp(ConvertToBitmap);
 MustHaveApp(ConvertToMonoBitmap);
 
     %extend {
 MustHaveApp(ConvertToMonoBitmap);
 
     %extend {

-        wxBitmap ConvertToBitmap() {
-            wxBitmap bitmap(*self);
+        wxBitmap ConvertToBitmap(int depth=-1) {
+            wxBitmap bitmap(*self, depth);

             return bitmap;
         }
 
             return bitmap;
         }
 


@@ -356,12 +490,15 @@ const wxImage    wxNullImage;
 
 //---------------------------------------------------------------------------
 
 
 //---------------------------------------------------------------------------
 

-
+MAKE_CONST_WXSTRING(IMAGE_OPTION_FILENAME);

 MAKE_CONST_WXSTRING(IMAGE_OPTION_BMP_FORMAT);
 MAKE_CONST_WXSTRING(IMAGE_OPTION_CUR_HOTSPOT_X);
 MAKE_CONST_WXSTRING(IMAGE_OPTION_CUR_HOTSPOT_Y);
 MAKE_CONST_WXSTRING(IMAGE_OPTION_RESOLUTION);
 MAKE_CONST_WXSTRING(IMAGE_OPTION_BMP_FORMAT);
 MAKE_CONST_WXSTRING(IMAGE_OPTION_CUR_HOTSPOT_X);
 MAKE_CONST_WXSTRING(IMAGE_OPTION_CUR_HOTSPOT_Y);
 MAKE_CONST_WXSTRING(IMAGE_OPTION_RESOLUTION);

+MAKE_CONST_WXSTRING(IMAGE_OPTION_RESOLUTIONX);
+MAKE_CONST_WXSTRING(IMAGE_OPTION_RESOLUTIONY);

 MAKE_CONST_WXSTRING(IMAGE_OPTION_RESOLUTIONUNIT);
 MAKE_CONST_WXSTRING(IMAGE_OPTION_RESOLUTIONUNIT);

+MAKE_CONST_WXSTRING(IMAGE_OPTION_QUALITY);

 
 enum
 {
 
 enum
 {


@@ -370,6 +507,21 @@ enum
 };
 
 
 };
 
 

+MAKE_CONST_WXSTRING(IMAGE_OPTION_BITSPERSAMPLE);
+MAKE_CONST_WXSTRING(IMAGE_OPTION_SAMPLESPERPIXEL); 
+MAKE_CONST_WXSTRING(IMAGE_OPTION_COMPRESSION);
+MAKE_CONST_WXSTRING(IMAGE_OPTION_IMAGEDESCRIPTOR);
+
+MAKE_CONST_WXSTRING(IMAGE_OPTION_PNG_FORMAT);
+MAKE_CONST_WXSTRING(IMAGE_OPTION_PNG_BITDEPTH);
+
+enum
+{
+    wxPNG_TYPE_COLOUR = 0,
+    wxPNG_TYPE_GREY = 2,
+    wxPNG_TYPE_GREY_RED = 3
+};
+

 enum
 {
     wxBMP_24BPP        = 24, // default, do not need to set
 enum
 {
     wxBMP_24BPP        = 24, // default, do not need to set