Add missing WXK constants for the control keys

[wxWidgets.git] / src / common / imagtga.cpp

diff --git a/src/common/imagtga.cpp b/src/common/imagtga.cpp
index bf99b1af4cff216455598bc86f3a7e7a10fd99c3..9a5c4ccd87c1299450192ac4274e1f94c6847d37 100644 (file)
--- a/src/common/imagtga.cpp
+++ b/src/common/imagtga.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        imagtga.cpp
+// Name:        src/common/imagtga.cpp

 // Purpose:     wxImage TGA handler
 // Author:      Seth Jackson
 // CVS-ID:      $Id$
 // Purpose:     wxImage TGA handler
 // Author:      Seth Jackson
 // CVS-ID:      $Id$


@@ -30,6 +30,7 @@
 
 #include "wx/imagtga.h"
 #include "wx/log.h"
 
 #include "wx/imagtga.h"
 #include "wx/log.h"

+#include "wx/scopeguard.h"

 
 // ----------------------------------------------------------------------------
 // constants
 
 // ----------------------------------------------------------------------------
 // constants


@@ -38,9 +39,10 @@
 // TGA error codes.
 enum
 {
 // TGA error codes.
 enum
 {

-    wxTGA_OK = 0,
-    wxTGA_INVFORMAT = 1,
-    wxTGA_MEMERR = 2
+    wxTGA_OK,
+    wxTGA_INVFORMAT,
+    wxTGA_MEMERR,
+    wxTGA_IOERR

 };
 
 // TGA header bytes.
 };
 
 // TGA header bytes.


@@ -99,8 +101,9 @@ void FlipTGA(unsigned char* imageData, int width, int height, short pixelSize)
     }
 }
 
     }
 }
 

+// return wxTGA_OK or wxTGA_IOERR

 static
 static

-void DecodeRLE(unsigned char* imageData, unsigned long imageSize,
+int DecodeRLE(unsigned char* imageData, unsigned long imageSize,

                short pixelSize, wxInputStream& stream)
 {
     unsigned long index = 0;
                short pixelSize, wxInputStream& stream)
 {
     unsigned long index = 0;


@@ -110,7 +113,11 @@ void DecodeRLE(unsigned char* imageData, unsigned long imageSize,
 
     while (index < imageSize)
     {
 
     while (index < imageSize)
     {

-        current = stream.GetC();
+        int ch = stream.GetC();
+        if ( ch == wxEOF )
+            return wxTGA_IOERR;
+
+        current = ch;

 
         // RLE packet.
         if ( current & 0x80 )
 
         // RLE packet.
         if ( current & 0x80 )


@@ -124,8 +131,14 @@ void DecodeRLE(unsigned char* imageData, unsigned long imageSize,
 
             index += current * pixelSize;
 
 
             index += current * pixelSize;
 

+            if (index >= imageSize)
+            {
+                return wxTGA_IOERR;
+            }
+

             // Repeat the pixel length times.
             // Repeat the pixel length times.

-            stream.Read(buf, pixelSize);
+            if ( !stream.Read(buf, pixelSize) )
+                return wxTGA_IOERR;

 
             for (unsigned int i = 0; i < length; i++)
             {
 
             for (unsigned int i = 0; i < length; i++)
             {


@@ -143,12 +156,54 @@ void DecodeRLE(unsigned char* imageData, unsigned long imageSize,
 
             index += length;
 
 
             index += length;
 

+            if (index >= imageSize)
+            {
+                return wxTGA_IOERR;
+            }
+

             // Write the next length pixels directly to the image data.
             // Write the next length pixels directly to the image data.

-            stream.Read(imageData, length);
+            if ( !stream.Read(imageData, length) )
+                return wxTGA_IOERR;

 
             imageData += length;
         }
     }
 
             imageData += length;
         }
     }

+
+    return wxTGA_OK;
+}
+
+/*
+Mimic the behaviour of wxPalette.GetRGB and the way the TGA image handler
+used it. That is: don't check the return value of GetRGB and continue decoding
+using previous RGB values.
+
+It might be better to check for palette index bounds and stop decoding if
+it's out of range (and add something like wxTGA_DATAERR to indicate unexpected
+pixel data).
+*/
+static
+void Palette_GetRGB(const unsigned char *palette, unsigned int paletteCount,
+    unsigned int index,
+    unsigned char *red, unsigned char *green, unsigned char *blue)
+{
+    if (index >= paletteCount)
+    {
+        return;
+    }
+
+    *red   = palette[index];
+    *green = palette[(paletteCount * 1) + index];
+    *blue  = palette[(paletteCount * 2) + index];
+}
+
+static
+void Palette_SetRGB(unsigned char *palette, unsigned int paletteCount,
+    unsigned int index,
+    unsigned char red, unsigned char green, unsigned char blue)
+{
+    palette[index] = red;
+    palette[(paletteCount * 1) + index] = green;
+    palette[(paletteCount * 2) + index] = blue;

 }
 
 static
 }
 
 static


@@ -161,7 +216,8 @@ int ReadTGA(wxImage* image, wxInputStream& stream)
     short offset = hdr[HDR_OFFSET] + HDR_SIZE;
     short colorType = hdr[HDR_COLORTYPE];
     short imageType = hdr[HDR_IMAGETYPE];
     short offset = hdr[HDR_OFFSET] + HDR_SIZE;
     short colorType = hdr[HDR_COLORTYPE];
     short imageType = hdr[HDR_IMAGETYPE];

-    int paletteLength = hdr[HDR_PALETTELENGTH] + 256 * hdr[HDR_PALETTELENGTH + 1];
+    unsigned int paletteLength = hdr[HDR_PALETTELENGTH]
+        + 256 * hdr[HDR_PALETTELENGTH + 1];

     int width = (hdr[HDR_WIDTH] + 256 * hdr[HDR_WIDTH + 1]) -
                 (hdr[HDR_XORIGIN] + 256 * hdr[HDR_XORIGIN + 1]);
     int height = (hdr[HDR_HEIGHT] + 256 * hdr[HDR_HEIGHT + 1]) -
     int width = (hdr[HDR_WIDTH] + 256 * hdr[HDR_WIDTH + 1]) -
                 (hdr[HDR_XORIGIN] + 256 * hdr[HDR_XORIGIN + 1]);
     int height = (hdr[HDR_HEIGHT] + 256 * hdr[HDR_HEIGHT + 1]) -


@@ -171,7 +227,7 @@ int ReadTGA(wxImage* image, wxInputStream& stream)
 
     image->Create(width, height);
 
 
     image->Create(width, height);
 

-    if (!image->Ok())
+    if (!image->IsOk())

     {
         return wxTGA_MEMERR;
     }
     {
         return wxTGA_MEMERR;
     }


@@ -187,6 +243,8 @@ int ReadTGA(wxImage* image, wxInputStream& stream)
         return wxTGA_MEMERR;
     }
 
         return wxTGA_MEMERR;
     }
 

+    wxON_BLOCK_EXIT1(free, imageData);
+

     unsigned char *dst = image->GetData();
 
     unsigned char* alpha = NULL;
     unsigned char *dst = image->GetData();
 
     unsigned char* alpha = NULL;


@@ -198,39 +256,34 @@ int ReadTGA(wxImage* image, wxInputStream& stream)
     }
 
     // Seek from the offset we got from the TGA header.
     }
 
     // Seek from the offset we got from the TGA header.

-    stream.SeekI(offset, wxFromStart);
+    if (stream.SeekI(offset, wxFromStart) == wxInvalidOffset)
+        return wxTGA_INVFORMAT;

 
 

+    unsigned char *palette = NULL;

     // Load a palette if we have one.
     if (colorType == wxTGA_MAPPED)
     {
         unsigned char buf[3];
 
     // Load a palette if we have one.
     if (colorType == wxTGA_MAPPED)
     {
         unsigned char buf[3];
 

-        unsigned char* r = new unsigned char[paletteLength];
-        unsigned char* g = new unsigned char[paletteLength];
-        unsigned char* b = new unsigned char[paletteLength];
+        palette = (unsigned char *) malloc(paletteLength * 3);

 
 

-        for (int i = 0; i < paletteLength; i++)
+        for (unsigned int i = 0; i < paletteLength; i++)

         {
             stream.Read(buf, 3);
 
         {
             stream.Read(buf, 3);
 

-            r[i] = buf[2];
-            g[i] = buf[1];
-            b[i] = buf[0];
+            Palette_SetRGB(palette, paletteLength, i, buf[2], buf[1], buf[0]);

         }
 
         }
 

-        #if wxUSE_PALETTE
-
+#if wxUSE_PALETTE

         // Set the palette of the image.
         // Set the palette of the image.

+        image->SetPalette(wxPalette((int) paletteLength, &palette[0],
+            &palette[paletteLength * 1], &palette[paletteLength * 2]));
+#endif // wxUSE_PALETTE

 
 

-        image->SetPalette(wxPalette(paletteLength, r, g, b));
-
-        #endif // wxUSE_PALETTE
-
-        delete[] r;
-        delete[] g;
-        delete[] b;

     }
 
     }
 

+    wxON_BLOCK_EXIT1(free, palette);
+

     // Handle the various TGA formats we support.
 
     switch (imageType)
     // Handle the various TGA formats we support.
 
     switch (imageType)


@@ -239,10 +292,9 @@ int ReadTGA(wxImage* image, wxInputStream& stream)
 
         case 1:
         {
 
         case 1:
         {

-            const wxPalette& palette = image->GetPalette();
-            unsigned char r;
-            unsigned char g;
-            unsigned char b;
+            unsigned char r = 0;
+            unsigned char g = 0;
+            unsigned char b = 0;

 
             // No compression read the data directly to imageData.
 
 
             // No compression read the data directly to imageData.
 


@@ -266,7 +318,8 @@ int ReadTGA(wxImage* image, wxInputStream& stream)
                 {
                     for (unsigned long index = 0; index < imageSize; index += pixelSize)
                     {
                 {
                     for (unsigned long index = 0; index < imageSize; index += pixelSize)
                     {

-                        palette.GetRGB(imageData[index], &r, &g, &b);
+                        Palette_GetRGB(palette, paletteLength,
+                            imageData[index], &r, &g, &b);

 
                         *(dst++) = r;
                         *(dst++) = g;
 
                         *(dst++) = r;
                         *(dst++) = g;


@@ -281,7 +334,8 @@ int ReadTGA(wxImage* image, wxInputStream& stream)
                 {
                     for (unsigned long index = 0; index < imageSize; index += pixelSize)
                     {
                 {
                     for (unsigned long index = 0; index < imageSize; index += pixelSize)
                     {

-                        palette.GetRGB(imageData[index], &r, &g, &b);
+                        Palette_GetRGB(palette, paletteLength,
+                            imageData[index], &r, &g, &b);

 
                         *(dst++) = r;
                         *(dst++) = g;
 
                         *(dst++) = r;
                         *(dst++) = g;


@@ -432,14 +486,15 @@ int ReadTGA(wxImage* image, wxInputStream& stream)
 
         case 9:
         {
 
         case 9:
         {

-            const wxPalette& palette = image->GetPalette();
-            unsigned char r;
-            unsigned char g;
-            unsigned char b;
+            unsigned char r = 0;
+            unsigned char g = 0;
+            unsigned char b = 0;

 
             // Decode the RLE data.
 
 
             // Decode the RLE data.
 

-            DecodeRLE(imageData, imageSize, pixelSize, stream);
+            int rc =  DecodeRLE(imageData, imageSize, pixelSize, stream);
+            if ( rc != wxTGA_OK )
+                return rc;

 
             // If orientation == 0, then the image is stored upside down.
             // We need to store it right side up.
 
             // If orientation == 0, then the image is stored upside down.
             // We need to store it right side up.


@@ -459,7 +514,8 @@ int ReadTGA(wxImage* image, wxInputStream& stream)
                 {
                     for (unsigned long index = 0; index < imageSize; index += pixelSize)
                     {
                 {
                     for (unsigned long index = 0; index < imageSize; index += pixelSize)
                     {

-                        palette.GetRGB(imageData[index], &r, &g, &b);
+                        Palette_GetRGB(palette, paletteLength,
+                            imageData[index], &r, &g, &b);

 
                         *(dst++) = r;
                         *(dst++) = g;
 
                         *(dst++) = r;
                         *(dst++) = g;


@@ -474,7 +530,8 @@ int ReadTGA(wxImage* image, wxInputStream& stream)
                 {
                     for (unsigned long index = 0; index < imageSize; index += pixelSize)
                     {
                 {
                     for (unsigned long index = 0; index < imageSize; index += pixelSize)
                     {

-                        palette.GetRGB(imageData[index], &r, &g, &b);
+                        Palette_GetRGB(palette, paletteLength,
+                            imageData[index], &r, &g, &b);

 
                         *(dst++) = r;
                         *(dst++) = g;
 
                         *(dst++) = r;
                         *(dst++) = g;


@@ -496,7 +553,9 @@ int ReadTGA(wxImage* image, wxInputStream& stream)
         {
             // Decode the RLE data.
 
         {
             // Decode the RLE data.
 

-            DecodeRLE(imageData, imageSize, pixelSize, stream);
+            int rc = DecodeRLE(imageData, imageSize, pixelSize, stream);
+            if ( rc != wxTGA_OK )
+                return rc;

 
             // If orientation == 0, then the image is stored upside down.
             // We need to store it right side up.
 
             // If orientation == 0, then the image is stored upside down.
             // We need to store it right side up.


@@ -574,7 +633,9 @@ int ReadTGA(wxImage* image, wxInputStream& stream)
         {
             // Decode the RLE data.
 
         {
             // Decode the RLE data.
 

-            DecodeRLE(imageData, imageSize, pixelSize, stream);
+            int rc = DecodeRLE(imageData, imageSize, pixelSize, stream);
+            if ( rc != wxTGA_OK )
+                return rc;

 
             // If orientation == 0, then the image is stored upside down.
             // We need to store it right side up.
 
             // If orientation == 0, then the image is stored upside down.
             // We need to store it right side up.


@@ -625,15 +686,74 @@ int ReadTGA(wxImage* image, wxInputStream& stream)
             return wxTGA_INVFORMAT;
     }
 
             return wxTGA_INVFORMAT;
     }
 

-    free(imageData);
-

     return wxTGA_OK;
 }
 
 static
     return wxTGA_OK;
 }
 
 static

-int SaveTGA(wxImage* WXUNUSED(image), wxOutputStream& WXUNUSED(stream))
+int SaveTGA(const wxImage& image, wxOutputStream *stream)

 {
 {

-    wxLogError(wxT("Saving in TGA format is not implemented."));
+    bool hasAlpha = image.HasAlpha();
+    unsigned bytesPerPixel = 3 + (hasAlpha ? 1 : 0);
+    wxSize size = image.GetSize();
+    size_t scanlineSize = size.x * bytesPerPixel;
+    unsigned char *scanlineData = (unsigned char *) malloc(scanlineSize);
+    if (!scanlineData)
+    {
+        return wxTGA_MEMERR;
+    }
+
+    wxON_BLOCK_EXIT1(free, scanlineData);
+
+    // Compose and write the TGA header
+    unsigned char hdr[HDR_SIZE];
+    (void) memset(&hdr, 0, HDR_SIZE);
+
+    hdr[HDR_COLORTYPE] = wxTGA_UNMAPPED;
+    hdr[HDR_IMAGETYPE] = 2 /* Uncompressed truecolour */;
+
+    hdr[HDR_WIDTH] =  size.x & 0xFF;
+    hdr[HDR_WIDTH + 1] =  (size.x >> 8) & 0xFF;
+
+    hdr[HDR_HEIGHT] =  size.y & 0xFF;
+    hdr[HDR_HEIGHT + 1] =  (size.y >> 8) & 0xFF;
+
+    hdr[HDR_BPP] = hasAlpha ? 32 : 24;
+    hdr[HDR_ORIENTATION] = 1 << 5; // set bit to indicate top-down order
+    if (hasAlpha)
+    {
+        hdr[HDR_ORIENTATION] |= 8; // number of alpha bits
+    }
+
+    if ( !stream->Write(hdr, HDR_SIZE) )
+    {
+        return wxTGA_IOERR;
+    }
+
+
+    // Write image data, converting RGB to BGR and adding alpha if applicable
+
+    unsigned char *src = image.GetData();
+    unsigned char *alpha = image.GetAlpha();
+    for (int y = 0; y < size.y; ++y)
+    {
+        unsigned char *dst = scanlineData;
+        for (int x = 0; x < size.x; ++x)
+        {
+            dst[0] = src[2];
+            dst[1] = src[1];
+            dst[2] = src[0];
+            if (alpha)
+            {
+                dst[3] = *(alpha++);
+            }
+            src += 3;
+            dst += bytesPerPixel;
+        }
+        if ( !stream->Write(scanlineData, scanlineSize) )
+        {
+            return wxTGA_IOERR;
+        }
+    }

 
     return wxTGA_OK;
 }
 
     return wxTGA_OK;
 }


@@ -650,7 +770,9 @@ bool wxTGAHandler::LoadFile(wxImage* image,
     if ( !CanRead(stream) )
     {
         if ( verbose )
     if ( !CanRead(stream) )
     {
         if ( verbose )

+        {

             wxLogError(wxT("TGA: this is not a TGA file."));
             wxLogError(wxT("TGA: this is not a TGA file."));

+        }

 
         return false;
     }
 
         return false;
     }


@@ -672,6 +794,10 @@ bool wxTGAHandler::LoadFile(wxImage* image,
                     wxLogError(wxT("TGA: couldn't allocate memory."));
                     break;
 
                     wxLogError(wxT("TGA: couldn't allocate memory."));
                     break;
 

+                case wxTGA_IOERR:
+                    wxLogError(wxT("TGA: couldn't read image data."));
+                    break;
+

                 default:
                     wxLogError(wxT("TGA: unknown error!"));
             }
                 default:
                     wxLogError(wxT("TGA: unknown error!"));
             }


@@ -687,7 +813,7 @@ bool wxTGAHandler::LoadFile(wxImage* image,
 
 bool wxTGAHandler::SaveFile(wxImage* image, wxOutputStream& stream, bool verbose)
 {
 
 bool wxTGAHandler::SaveFile(wxImage* image, wxOutputStream& stream, bool verbose)
 {

-    int error = SaveTGA(image, stream);
+    int error = SaveTGA(*image, &stream);

 
     if ( error != wxTGA_OK )
     {
 
     if ( error != wxTGA_OK )
     {


@@ -695,14 +821,14 @@ bool wxTGAHandler::SaveFile(wxImage* image, wxOutputStream& stream, bool verbose
         {
             switch ( error )
             {
         {
             switch ( error )
             {

-                case wxTGA_INVFORMAT:
-                    wxLogError(wxT("TGA: invalid image."));
-                    break;
-

                 case wxTGA_MEMERR:
                     wxLogError(wxT("TGA: couldn't allocate memory."));
                     break;
 
                 case wxTGA_MEMERR:
                     wxLogError(wxT("TGA: couldn't allocate memory."));
                     break;
 

+                case wxTGA_IOERR:
+                    wxLogError(wxT("TGA: couldn't write image data."));
+                    break;
+

                 default:
                     wxLogError(wxT("TGA: unknown error!"));
             }
                 default:
                     wxLogError(wxT("TGA: unknown error!"));
             }


@@ -718,9 +844,9 @@ bool wxTGAHandler::DoCanRead(wxInputStream& stream)
 {
     // read the fixed-size TGA headers
     unsigned char hdr[HDR_SIZE];
 {
     // read the fixed-size TGA headers
     unsigned char hdr[HDR_SIZE];

-    stream.Read(hdr, HDR_SIZE);
+    stream.Read(hdr, HDR_SIZE);     // it's ok to modify the stream position here

 
 

-    // Check wether we can read the file or not.
+    // Check whether we can read the file or not.

 
     short colorType = hdr[HDR_COLORTYPE];
     if ( colorType != wxTGA_UNMAPPED && colorType != wxTGA_MAPPED )
 
     short colorType = hdr[HDR_COLORTYPE];
     if ( colorType != wxTGA_UNMAPPED && colorType != wxTGA_MAPPED )