/*

% Copyright (C) 2003-2025 GraphicsMagick Group

% Copyright (C) 2002 ImageMagick Studio

% Copyright 1991-1999 E. I. du Pont de Nemours and Company

%

% This program is covered by multiple licenses, which are described in

% Copyright.txt. You should have received a copy of Copyright.txt with this

% package; otherwise see http://www.graphicsmagick.org/www/Copyright.html.

%

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%                                                                             %

%                                                                             %

%                                                                             %

%                            U   U  IIIII  L                                  %

%                            U   U    I    L                                  %

%                            U   U    I    L                                  %

%                            U   U    I    L                                  %

%                             UUU   IIIII  LLLLL                              %

%                                                                             %

%                                                                             %

%                         Write X-Motif UIL Table                             %

%                                                                             %

%                                                                             %

%                              Software Design                                %

%                                John Cristy                                  %

%                                 July 1992                                   %

%                                                                             %

%                                                                             %

%                                                                             %

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%

%

*/

/*

  Include declarations.

*/

#include "magick/studio.h"

#include "magick/blob.h"

#include "magick/pixel_cache.h"

#include "magick/color.h"

#include "magick/color_lookup.h"

#include "magick/magick.h"

#include "magick/monitor.h"

#include "magick/utility.h"

#include "magick/static.h"

/*

  Forward declarations.

*/

static unsigned int

  WriteUILImage(const ImageInfo *,Image *);

/*

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%                                                                             %

%                                                                             %

%                                                                             %

%   R e g i s t e r U I L I m a g e                                           %

%                                                                             %

%                                                                             %

%                                                                             %

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%

%  Method RegisterUILImage adds attributes for the UIL image format to

%  the list of supported formats.  The attributes include the image format

%  tag, a method to read and/or write the format, whether the format

%  supports the saving of more than one frame to the same file or blob,

%  whether the format supports native in-memory I/O, and a brief

%  description of the format.

%

%  The format of the RegisterUILImage method is:

%

%      RegisterUILImage(void)

%

*/

ModuleExport void RegisterUILImage(void)

{

  MagickInfo

    *entry;

  entry=SetMagickInfo("UIL");

  entry->encoder=(EncoderHandler) WriteUILImage;

  entry->adjoin=False;

  entry->description="X-Motif UIL table";

  entry->module="UIL";

  entry->coder_class=UnstableCoderClass;

  (void) RegisterMagickInfo(entry);

}

/*

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%                                                                             %

%                                                                             %

%                                                                             %

%   U n r e g i s t e r U I L I m a g e                                       %

%                                                                             %

%                                                                             %

%                                                                             %

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%

%  Method UnregisterUILImage removes format registrations made by the

%  UIL module from the list of supported formats.

%

%  The format of the UnregisterUILImage method is:

%

%      UnregisterUILImage(void)

%

*/

ModuleExport void UnregisterUILImage(void)

{

  (void) UnregisterMagickInfo("UIL");

}

/*

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%                                                                             %

%                                                                             %

%                                                                             %

%   W r i t e U I L I m a g e                                                 %

%                                                                             %

%                                                                             %

%                                                                             %

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%

%  Procedure WriteUILImage writes an image to a file in the X-Motif UIL table

%  format.

%

%  The format of the WriteUILImage method is:

%

%      unsigned int WriteUILImage(const ImageInfo *image_info,Image *image)

%

%  A description of each parameter follows.

%

%    o status: Method WriteUILImage return True if the image is written.

%      False is returned is there is a memory shortage or if the image file

%      fails to write.

%

%    o image_info: Specifies a pointer to a ImageInfo structure.

%

%    o image:  A pointer to an Image structure.

%

%

*/

static unsigned int WriteUILImage(const ImageInfo *image_info,Image *image)

{

#define MaxCixels  92

  static const char

    Cixel[MaxCixels+1] = " .XoO+@#$%&*=-;:>,<1234567890qwertyuipasdfghjk"

                         "lzxcvbnmMNBVCZASDFGHJKLPIUYTREWQ!~^/()_`'][{}|";

  char

    basename[MaxTextExtent],

    buffer[MaxTextExtent],

    name[MaxTextExtent],

    symbol[MaxTextExtent];

  int

    j;

  long

    k,

    y;

  register const PixelPacket

    *p;

  register long

    i,

    x;

  unsigned int

    status,

    transparent;

  unsigned long

    characters_per_pixel,

    colors,

    number_pixels;

  /*

    Open output image file.

  */

  assert(image_info != (const ImageInfo *) NULL);

  assert(image_info->signature == MagickSignature);

  assert(image != (Image *) NULL);

  assert(image->signature == MagickSignature);

  status=OpenBlob(image_info,image,WriteBinaryBlobMode,&image->exception);

  if (status == False)

    ThrowWriterException(FileOpenError,UnableToOpenFile,image);

  (void) TransformColorspace(image,RGBColorspace);

  transparent=False;

  i=0;

  p=(const PixelPacket *) NULL;

  if (image->storage_class == PseudoClass)

    colors=image->colors;

  else

    {

      unsigned char

        *matte_image;

      /*

        Convert DirectClass to PseudoClass image.

      */

      matte_image=(unsigned char *) NULL;

      if (image->matte)

        {

          /*

            Map all the transparent pixels.

          */

          number_pixels=image->columns*image->rows;

          matte_image=MagickAllocateResourceLimitedMemory(unsigned char *,number_pixels);

          if (matte_image == (unsigned char *) NULL)

            ThrowWriterException(ResourceLimitError,MemoryAllocationFailed,

              image);

          for (y=0; y < (long) image->rows; y++)

          {

            p=AcquireImagePixels(image,0,y,image->columns,1,&image->exception);

            if (p == (const PixelPacket *) NULL)

              break;

            for (x=0; x < (long) image->columns; x++)

            {

              matte_image[i]=(unsigned char) (p->opacity == TransparentOpacity);

              if (matte_image[i])

                transparent=True;

              i++;

              p++;

            }

          }

        }

      (void) SetImageType(image,PaletteType);

      colors=image->colors;

      if (transparent)

        {

          i=0;

          colors++;

          for (y=0; y < (long) image->rows; y++)

          {

            register IndexPacket

              *indexes;

            p=GetImagePixelsEx(image,0,y,image->columns,1,&image->exception);

            if (p == (const PixelPacket *) NULL)

              break;

            indexes=AccessMutableIndexes(image);

            for (x=0; x < (long) image->columns; x++)

            {

              if (matte_image[i])

                indexes[x]=(IndexPacket) image->colors;

              p++;

            }

          }

        }

      if (matte_image != (unsigned char *) NULL)

        MagickFreeResourceLimitedMemory(unsigned char *,matte_image);

    }

  /*

    Compute the character per pixel.

  */

  characters_per_pixel=1;

  for (k=MaxCixels; (long) colors > k; k*=MaxCixels)

    characters_per_pixel++;

  /*

    UIL header.

  */

  (void) WriteBlobString(image,"/* UIL */\n");

  GetPathComponent(image->filename,BasePath,basename);

  FormatString(buffer,"value\n  %.1024s_ct : color_table(\n",basename);

  (void) WriteBlobString(image,buffer);

  for (i=0; i < (long) image->colors; i++)

  {

    /*

      Define UIL color.

    */

    (void) QueryColorname(image,image->colormap+i,X11Compliance,name,

      &image->exception);

    if (transparent)

      if (i == (long) (colors-1))

        (void) strlcpy(name,"None",sizeof(name));

    /*

      Write UIL color.

    */

    k=i % MaxCixels;

    symbol[0]=Cixel[k];

    for (j=1; j < (int) characters_per_pixel; j++)

    {

      k=((i-k)/MaxCixels) % MaxCixels;

      symbol[j]=Cixel[k];

    }

    symbol[j]='\0';

    if (LocaleCompare(name,"None") == 0)

      FormatString(buffer,"    background color = '%.1024s'",symbol);

    else

      FormatString(buffer,"    color('%.1024s',%.1024s) = '%.1024s'",name,

        PixelIntensityToQuantum(image->colormap+i) < (((double) MaxRGB+1.0)/2.0) ?

        "background" : "foreground",symbol);

    (void) WriteBlobString(image,buffer);

    FormatString(buffer,"%.1024s",(i == (long) (colors-1) ? ");\n" : ",\n"));

    (void) WriteBlobString(image,buffer);

  }

  /*

    Define UIL pixels.

  */

  GetPathComponent(image->filename,BasePath,basename);

  FormatString(buffer,

    "  %.1024s_icon : icon(color_table = %.1024s_ct,\n",basename,basename);

  (void) WriteBlobString(image,buffer);

  for (y=0; y < (long) image->rows; y++)

  {

    register const IndexPacket

      *indexes;

    p=AcquireImagePixels(image,0,y,image->columns,1,&image->exception);

    if (p == (const PixelPacket *) NULL)

      break;

    indexes=AccessImmutableIndexes(image);

    (void) WriteBlobString(image,"    \"");

    for (x=0; x < (long) image->columns; x++)

    {

      k=(long) (indexes[x] % MaxCixels);

      symbol[0]=Cixel[k];

      for (j=1; j < (int) characters_per_pixel; j++)

      {

        k=(((int) indexes[x]-k)/MaxCixels) % MaxCixels;

        symbol[j]=Cixel[k];

      }

      symbol[j]='\0';

      (void) strlcpy(buffer,symbol,MaxTextExtent);

      (void) WriteBlobString(image,buffer);

      p++;

    }

    FormatString(buffer,"\"%.1024s\n",

      (y == (long) (image->rows-1) ? ");" : ","));

    (void) WriteBlobString(image,buffer);

    if (QuantumTick(y,image->rows))

      if (!MagickMonitorFormatted(y,image->rows,&image->exception,

                                  SaveImageText,image->filename,

                                  image->columns,image->rows))

        break;

  }

  status &= CloseBlob(image);

  return(status);

}