2 * \file GraphicsImageXPM.C
3 * Copyright 2002 the LyX Team
4 * Read the file COPYING
6 * \author Baruch Even <baruch.even@writeme.com>
7 * \author Angus Leeming <a.leeming@ic.ac.uk>
13 #pragma implementation
16 #include "GraphicsImageXPM.h"
17 #include "GraphicsParams.h"
18 #include "ColorHandler.h"
20 #include "frontends/GUIRunTime.h" // x11Display, x11Screen
21 #include "support/filetools.h" // IsFileReadable
22 #include "support/lstrings.h"
24 #include <iomanip> // std::setfill, etc
25 #include <cmath> // cos, sin
26 #include <cstdlib> // malloc, free
30 /// Access to this class is through this static method.
31 ImagePtr GImageXPM::newImage()
34 ptr.reset(new GImageXPM());
39 /// Return the list of loadable formats.
40 GImage::FormatList GImageXPM::loadableFormats()
42 FormatList formats(1);
48 GImageXPM::GImageXPM()
50 pixmap_status_(PIXMAP_UNINITIALISED)
54 GImageXPM::GImageXPM(GImageXPM const & other)
58 pixmap_status_(PIXMAP_UNINITIALISED)
62 GImageXPM::~GImageXPM()
65 XFreePixmap(GUIRunTime::x11Display(), pixmap_);
69 GImage * GImageXPM::clone() const
71 return new GImageXPM(*this);
75 unsigned int GImageXPM::getWidth() const
77 return image_.width();
81 unsigned int GImageXPM::getHeight() const
83 return image_.height();
87 Pixmap GImageXPM::getPixmap() const
89 if (!pixmap_status_ == PIXMAP_SUCCESS)
95 void GImageXPM::load(string const & filename, GImage::SignalTypePtr on_finish)
97 if (filename.empty()) {
98 on_finish->emit(false);
102 if (!image_.empty()) {
103 lyxerr[Debug::GRAPHICS]
104 << "Image is loaded already!" << std::endl;
105 on_finish->emit(false);
109 XpmImage * xpm_image = new XpmImage;
112 XpmReadFileToXpmImage(const_cast<char *>(filename.c_str()),
117 lyxerr[Debug::GRAPHICS]
118 << "No XPM image file found." << std::endl;
122 lyxerr[Debug::GRAPHICS]
123 << "File format is invalid" << std::endl;
127 lyxerr[Debug::GRAPHICS]
128 << "Insufficient memory to read in XPM file"
133 if (success != XpmSuccess) {
134 XpmFreeXpmImage(xpm_image);
137 lyxerr[Debug::GRAPHICS]
138 << "Error reading XPM file '"
139 << XpmGetErrorString(success) << "'"
142 image_.reset(*xpm_image);
145 on_finish->emit(success == XpmSuccess);
149 bool GImageXPM::setPixmap(GParams const & params)
151 if (image_.empty() || params.display == GParams::NONE) {
155 Display * display = GUIRunTime::x11Display();
157 if (pixmap_ && pixmap_status_ == PIXMAP_SUCCESS)
158 XFreePixmap(display, pixmap_);
161 // This might be a dirty thing, but I dont know any other solution.
162 Screen * screen = ScreenOfDisplay(display, GUIRunTime::x11Screen());
167 XpmAttributes attrib;
169 // Allow libXPM lots of leeway when trying to allocate colors.
170 attrib.closeness = 10000;
171 attrib.valuemask = XpmCloseness;
173 // The XPM file format allows multiple pixel colours to be defined
174 // as c_color, g_color or m_color.
175 switch (params.display) {
176 case GParams::MONOCHROME:
177 attrib.color_key = XPM_MONO;
179 case GParams::GRAYSCALE:
180 attrib.color_key = XPM_GRAY;
183 default: // NONE cannot happen!
184 attrib.color_key = XPM_COLOR;
188 attrib.valuemask |= XpmColorKey;
190 // Set the color "none" entry to the color of the background.
191 XpmColorSymbol xpm_col;
193 xpm_col.value = "none";
194 xpm_col.pixel = lyxColorHandler->colorPixel(LColor::graphicsbg);
196 attrib.numsymbols = 1;
197 attrib.colorsymbols = &xpm_col;
198 attrib.valuemask |= XpmColorSymbols;
200 // Load up the pixmap
201 XpmImage xpm_image = image_.get();
203 XpmCreatePixmapFromXpmImage(display,
204 XRootWindowOfScreen(screen),
206 &pixmap, &mask, &attrib);
208 XpmFreeAttributes(&attrib);
210 if (status != XpmSuccess) {
211 lyxerr << "Error creating pixmap from xpm_image '"
212 << XpmGetErrorString(status) << "'"
214 pixmap_status_ = PIXMAP_FAILED;
219 pixmap_status_ = PIXMAP_SUCCESS;
224 void GImageXPM::clip(GParams const & params)
229 if (params.bb.empty())
230 // No clipping is necessary.
233 typedef unsigned int dimension;
235 dimension const new_width = params.bb.xr - params.bb.xl;
236 dimension const new_height = params.bb.yt - params.bb.yb;
238 if (new_width > image_.width() || new_height > image_.height())
239 // Bounds are invalid.
242 if (new_width == image_.width() && new_height == image_.height())
243 // Bounds are unchanged.
246 dimension * new_data = image_.initialisedData(new_width, new_height);
247 dimension * it = new_data;
249 // The image is stored in memory from upper-left to lower-right,
250 // so we loop from yt to yb.
251 dimension const * old_data = image_.data();
252 dimension const * start_row = old_data +
253 image_.width() * (image_.height() - params.bb.yt);
255 // the Bounding Box dimensions are never less than zero, so we can use
256 // "unsigned int row" here
257 for (dimension row = params.bb.yb; row < params.bb.yt; ++row) {
258 dimension const * begin = start_row + params.bb.xl;
259 dimension const * end = start_row + params.bb.xr;
260 it = std::copy(begin, end, it);
261 start_row += image_.width();
264 image_.resetData(new_width, new_height, new_data);
268 void GImageXPM::rotate(GParams const & params)
274 // No rotation is necessary.
277 // Ascertain the bounding box of the rotated image
278 // Rotate about the bottom-left corner
279 static double const pi = 3.14159265358979323846;
280 double const angle = double(params.angle) * pi / 180.0;
281 double const cos_a = cos(angle);
282 double const sin_a = sin(angle);
285 double max_x = 0; double min_x = 0;
286 double max_y = 0; double min_y = 0;
288 // (old_xpm->width, 0)
289 double x_rot = cos_a * image_.width();
290 double y_rot = sin_a * image_.width();
291 max_x = std::max(max_x, x_rot); min_x = std::min(min_x, x_rot);
292 max_y = std::max(max_y, y_rot); min_y = std::min(min_y, y_rot);
294 // (image_.width, image_.height)
295 x_rot = cos_a * image_.width() - sin_a * image_.height();
296 y_rot = sin_a * image_.width() + cos_a * image_.height();
297 max_x = std::max(max_x, x_rot); min_x = std::min(min_x, x_rot);
298 max_y = std::max(max_y, y_rot); min_y = std::min(min_y, y_rot);
300 // (0, image_.height)
301 x_rot = - sin_a * image_.height();
302 y_rot = cos_a * image_.height();
303 max_x = std::max(max_x, x_rot); min_x = std::min(min_x, x_rot);
304 max_y = std::max(max_y, y_rot); min_y = std::min(min_y, y_rot);
306 typedef unsigned int dimension;
308 dimension const new_width = 1 + int(max_x - min_x); // round up!
309 dimension const new_height = 1 + int(max_y - min_y);
311 dimension * new_data = image_.initialisedData(new_width, new_height);
312 dimension const * old_data = image_.data();
315 for (dimension y_old = 0; y_old < image_.height(); ++y_old) {
316 for (dimension x_old = 0; x_old < image_.width(); ++x_old) {
317 double const x_pos = cos_a*x_old - sin_a*y_old - min_x;
318 double const y_pos = sin_a*x_old + cos_a*y_old - min_y;
320 // ensure that there are no rounding errors
321 dimension x_new = (x_pos > 0) ? dimension(x_pos) : 0;
322 dimension y_new = (y_pos > 0) ? dimension(y_pos) : 0;
323 x_new = std::min(new_width - 1, x_new);
324 y_new = std::min(new_height - 1, y_new);
326 size_t const id_old = x_old + image_.width() * y_old;
327 size_t const id_new = x_new + new_width * y_new;
329 new_data[id_new] = old_data[id_old];
333 image_.resetData(new_width, new_height, new_data);
337 void GImageXPM::scale(GParams const & params)
342 typedef unsigned int dimension;
344 // boost::tie produces horrible compilation errors on my machine
346 std::pair<dimension, dimension> d = getScaledDimensions(params);
347 dimension const new_width = d.first;
348 dimension const new_height = d.second;
349 if (new_width == getWidth() && new_height == getHeight())
353 dimension * new_data = image_.initialisedData(new_width, new_height);
354 dimension const * old_data = image_.data();
356 double const x_scale = double(image_.width()) / double(new_width);
357 double const y_scale = double(image_.height()) / double(new_height);
359 // A very simple scaling routine.
360 // Ascertain the old pixel corresponding to the new one.
361 // There is no dithering at all here.
362 for (dimension x_new = 0; x_new < new_width; ++x_new) {
363 dimension x_old = dimension(x_new * x_scale);
365 for (dimension y_new = 0; y_new < new_height; ++y_new) {
366 dimension y_old = dimension(y_new * y_scale);
368 size_t const id_old = x_old + image_.width() * y_old;
369 size_t const id_new = x_new + new_width * y_new;
371 new_data[id_new] = old_data[id_old];
375 image_.resetData(new_width, new_height, new_data);
383 void free_color_table(XpmColor * colorTable, size_t size);
385 void copy_color_table(XpmColor const * in, size_t size, XpmColor * out);
387 bool contains_color_none(XpmImage const & image);
389 string const unique_color_string(XpmImage const & image);
391 // create a copy (using malloc and strcpy). If (!in) return 0;
392 char * clone_c_string(char const * in);
394 // Given a string of the form #ff0571 create appropriate grayscale and
395 // monochrome colors.
396 void mapcolor(char const * c_color, char ** g_color_ptr, char ** m_color_ptr);
403 GImageXPM::Data::Data()
404 : width_(0), height_(0), cpp_(0), ncolors_(0)
408 GImageXPM::Data::~Data()
410 if (colorTable_.unique())
411 free_color_table(colorTable_.get(), ncolors_);
415 void GImageXPM::Data::reset(XpmImage & image)
417 width_ = image.width;
418 height_ = image.height;
421 // Move the data ptr into this store and free up image.data
422 data_.reset(image.data);
425 // Don't just store the color table, but check first that it contains
426 // all that we require of it.
427 // The idea is to store the color table in a shared_ptr and for all
428 // modified images to use the same table.
429 // It must, therefore, have a c_color "none" entry and g_color and
430 // m_color entries corresponding to each and every c_color entry
433 // 1. Create a copy of the color table.
434 // Add a c_color "none" entry to the table if it isn't already there.
435 bool const add_color = !contains_color_none(image);
439 ncolors_ = 1 + image.ncolors;
440 size_t const mem_size = sizeof(XpmColor) * ncolors_;
441 XpmColor * table = static_cast<XpmColor *>(malloc(mem_size));
443 copy_color_table(image.colorTable, image.ncolors, table);
445 XpmColor & color = table[ncolors_ - 1];
451 clone_c_string(unique_color_string(image).c_str());
452 color.c_color = clone_c_string("none");
454 free_color_table(image.colorTable, image.ncolors);
455 colorTable_.reset(table);
459 // Just move the pointer across
460 ncolors_ = image.ncolors;
461 colorTable_.reset(image.colorTable);
462 image.colorTable = 0;
465 // Clean-up the remaining entries of image.
471 // 2. Ensure that the color table has g_color and m_color entries
472 XpmColor * table = colorTable_.get();
475 for (size_t i = 0; i < ncolors_; ++i) {
476 XpmColor & entry = table[i];
480 // A work-around for buggy XPM files that may be created by
481 // ImageMagick's convert.
482 string c_color = entry.c_color;
483 if (c_color[0] == '#' && c_color.size() > 7) {
484 if (buggy_color.empty())
485 buggy_color = c_color;
487 c_color = c_color.substr(0, 7);
489 entry.c_color = clone_c_string(c_color.c_str());
492 // If the c_color is defined and the equivalent
493 // grayscale or monochrome ones are not, then define them.
494 mapcolor(entry.c_color, &entry.g_color, &entry.m_color);
497 if (!buggy_color.empty()) {
498 lyxerr << "The XPM file contains silly colors, "
499 << "an example being \""
500 << buggy_color << "\".\n"
501 << "This was cropped to \""
502 << buggy_color.substr(0, 7)
503 << "\" so you can see something!\n"
504 << "If this file was created by ImageMagick's convert,\n"
505 << "then upgrading may cure the problem."
511 XpmImage GImageXPM::Data::get() const
514 image.width = width_;
515 image.height = height_;
517 image.ncolors = ncolors_;
518 image.data = data_.get();
519 image.colorTable = colorTable_.get();
524 void GImageXPM::Data::resetData(int w, int h, unsigned int * d)
531 unsigned int * GImageXPM::Data::initialisedData(int w, int h) const
533 size_t const data_size = w * h;
535 size_t const mem_size = sizeof(unsigned int) * data_size;
536 unsigned int * ptr = static_cast<unsigned int *>(malloc(mem_size));
538 unsigned int none_id = color_none_id();
539 std::fill(ptr, ptr + data_size, none_id);
545 unsigned int GImageXPM::Data::color_none_id() const
547 XpmColor * table = colorTable_.get();
548 for (size_t i = 0; i < ncolors_; ++i) {
549 char const * const color = table[i].c_color;
550 if (color && lowercase(color) == "none")
560 // Given a string of the form #ff0571 create appropriate grayscale and
561 // monochrome colors.
562 void mapcolor(char const * c_color, char ** g_color_ptr, char ** m_color_ptr)
567 char * g_color = *g_color_ptr;
568 char * m_color = *m_color_ptr;
570 if (g_color && m_color)
574 Display * display = GUIRunTime::x11Display();
575 Colormap cmap = GUIRunTime::x11Colormap();
578 if (XLookupColor(display, cmap, c_color, &xcol, &ccol) == 0)
579 // Unable to parse c_color.
582 // Note that X stores the RGB values in the range 0 - 65535
583 // whilst we require them in the range 0 - 255.
584 int const r = xcol.red / 256;
585 int const g = xcol.green / 256;
586 int const b = xcol.blue / 256;
588 // This gives a good match to a human's RGB to luminance conversion.
589 // (From xv's Postscript code --- Mike Ressler.)
590 int const gray = int((0.32 * r) + (0.5 * g) + (0.18 * b));
592 ostringstream gray_stream;
593 gray_stream << "#" << std::setbase(16) << std::setfill('0')
594 << std::setw(2) << gray
595 << std::setw(2) << gray
596 << std::setw(2) << gray;
598 int const mono = (gray < 128) ? 0 : 255;
599 ostringstream mono_stream;
600 mono_stream << "#" << std::setbase(16) << std::setfill('0')
601 << std::setw(2) << mono
602 << std::setw(2) << mono
603 << std::setw(2) << mono;
605 // This string is going into an XpmImage struct, so create copies that
606 // libXPM can free successfully.
608 *g_color_ptr = clone_c_string(gray_stream.str().c_str());
610 *m_color_ptr = clone_c_string(mono_stream.str().c_str());
614 void copy_color_table(XpmColor const * in, size_t size, XpmColor * out)
616 for (size_t i = 0; i < size; ++i) {
617 out[i].string = clone_c_string(in[i].string);
618 out[i].symbolic = clone_c_string(in[i].symbolic);
619 out[i].m_color = clone_c_string(in[i].m_color);
620 out[i].g_color = clone_c_string(in[i].g_color);
621 out[i].g4_color = clone_c_string(in[i].g4_color);
622 out[i].c_color = clone_c_string(in[i].c_color);
627 void free_color_table(XpmColor * table, size_t size)
629 for (size_t i = 0; i < size; ++i) {
630 free(table[i].string);
631 free(table[i].symbolic);
632 free(table[i].m_color);
633 free(table[i].g_color);
634 free(table[i].g4_color);
635 free(table[i].c_color);
637 // Don't free the table itself. Let the shared_c_ptr do that.
642 char * clone_c_string(char const * in)
647 // Don't forget the '\0'
648 char * out = static_cast<char *>(malloc(strlen(in) + 1));
649 return strcpy(out, in);
653 bool contains_color_none(XpmImage const & image)
655 for (size_t i = 0; i < image.ncolors; ++i) {
656 char const * const color = image.colorTable[i].c_color;
657 if (color && lowercase(color) == "none")
664 string const unique_color_string(XpmImage const & image)
666 string id(image.cpp, ' ');
669 bool found_it = false;
670 for (size_t i = 0; i < image.ncolors; ++i) {
671 string const c_id = image.colorTable[i].string;
681 // Loop over the printable characters in the ASCII table.
682 // Ie, count from char 32 (' ') to char 126 ('~')
683 // A base 94 counter!
684 string::size_type current_index = id.size() - 1;
685 bool continue_loop = true;
686 while(continue_loop) {
687 continue_loop = false;
689 if (id[current_index] == 126) {
690 continue_loop = true;
691 if (current_index == 0)
692 // Unable to find a unique string
693 return image.colorTable[0].string;
695 id[current_index] = 32;
698 id[current_index] += 1;
699 // Note that '"' is an illegal char in this
701 if (id[current_index] == '"')
702 id[current_index] += 1;
706 // Unable to find a unique string