Forgot to commit these last time; no longer need the basic image loader.

Hurrah!


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@5818 a592a061-630c-0410-9148-cb99ea01b6c8
This commit is contained in:
Angus Leeming 2002-12-16 12:46:45 +00:00
parent 3e8298b9a4
commit 61b80e2821
4 changed files with 7 additions and 930 deletions

View File

@ -1,3 +1,9 @@
2002-12-13 Angus Leeming <leeming@lyx.org>
* GraphicsImageXPM.[Ch]: removed.
* Makefile.am: associated change.
2002-12-01 Lars Gullik Bjønnes <larsbj@gullik.net>
* several files: ws changes

View File

@ -1,764 +0,0 @@
/**
* \file GraphicsImageXPM.C
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Baruch Even
* \author Angus Leeming
*
* Full author contact details are available in file CREDITS
*/
#include <config.h>
#ifdef __GNUG__
#pragma implementation
#endif
#include "GraphicsImageXPM.h"
#include "GraphicsParams.h"
#include "frontends/xforms/ColorHandler.h"
#include "debug.h"
#include "support/filetools.h" // IsFileReadable
#include "support/lstrings.h"
#include "Lsstream.h"
#include <boost/tuple/tuple.hpp>
#include <boost/bind.hpp>
#include FORMS_H_LOCATION
#include <iomanip> // std::setfill, etc
#include <cmath> // cos, sin
#include <cstdlib> // malloc, free
#ifndef CXX_GLOBAL_CSTD
using std::cos;
using std::sin;
using std::malloc;
using std::strcpy;
using std::strlen;
#endif
namespace grfx {
/// Access to this class is through this static method.
Image::ImagePtr ImageXPM::newImage()
{
ImagePtr ptr;
ptr.reset(new ImageXPM);
return ptr;
}
/// Return the list of loadable formats.
Image::FormatList ImageXPM::loadableFormats()
{
FormatList formats(1);
formats[0] = "xpm";
return formats;
}
ImageXPM::ImageXPM()
: pixmap_(0),
pixmap_status_(PIXMAP_UNINITIALISED)
{}
ImageXPM::ImageXPM(ImageXPM const & other)
: Image(other),
image_(other.image_),
pixmap_(0),
pixmap_status_(PIXMAP_UNINITIALISED)
{}
ImageXPM::~ImageXPM()
{
if (pixmap_)
XFreePixmap(fl_get_display(), pixmap_);
}
Image * ImageXPM::clone() const
{
return new ImageXPM(*this);
}
unsigned int ImageXPM::getWidth() const
{
return image_.width();
}
unsigned int ImageXPM::getHeight() const
{
return image_.height();
}
bool ImageXPM::isDrawable() const
{
return pixmap_;
}
Pixmap ImageXPM::getPixmap() const
{
if (!pixmap_status_ == PIXMAP_SUCCESS)
return 0;
return pixmap_;
}
void ImageXPM::load(string const & filename)
{
if (filename.empty()) {
finishedLoading(false);
return;
}
if (!image_.empty()) {
lyxerr[Debug::GRAPHICS]
<< "Image is loaded already!" << std::endl;
finishedLoading(false);
return;
}
XpmImage * xpm_image = new XpmImage;
int const success =
XpmReadFileToXpmImage(const_cast<char *>(filename.c_str()),
xpm_image, 0);
switch (success) {
case XpmOpenFailed:
lyxerr[Debug::GRAPHICS]
<< "No XPM image file found." << std::endl;
break;
case XpmFileInvalid:
lyxerr[Debug::GRAPHICS]
<< "File format is invalid" << std::endl;
break;
case XpmNoMemory:
lyxerr[Debug::GRAPHICS]
<< "Insufficient memory to read in XPM file"
<< std::endl;
break;
}
if (success != XpmSuccess) {
XpmFreeXpmImage(xpm_image);
delete xpm_image;
lyxerr[Debug::GRAPHICS]
<< "Error reading XPM file '"
<< XpmGetErrorString(success) << '\''
<< std::endl;
} else {
image_.reset(*xpm_image);
}
finishedLoading(success == XpmSuccess);
}
bool ImageXPM::setPixmap(Params const & params)
{
if (image_.empty() || params.display == NoDisplay) {
return false;
}
Display * display = fl_get_display();
if (pixmap_ && pixmap_status_ == PIXMAP_SUCCESS)
XFreePixmap(display, pixmap_);
//(BE 2000-08-05)
// This might be a dirty thing, but I dont know any other solution.
Screen * screen = ScreenOfDisplay(display, fl_screen);
Pixmap pixmap;
Pixmap mask;
XpmAttributes attrib;
// Allow libXPM lots of leeway when trying to allocate colors.
attrib.closeness = 10000;
attrib.valuemask = XpmCloseness;
// The XPM file format allows multiple pixel colours to be defined
// as c_color, g_color or m_color.
switch (params.display) {
case MonochromeDisplay:
attrib.color_key = XPM_MONO;
break;
case GrayscaleDisplay:
attrib.color_key = XPM_GRAY;
break;
case ColorDisplay:
default: // NoDisplay cannot happen!
attrib.color_key = XPM_COLOR;
break;
}
attrib.valuemask |= XpmColorKey;
// Set the color "none" entry to the color of the background.
XpmColorSymbol xpm_col[2];
xpm_col[0].name = 0;
xpm_col[0].value = "none";
xpm_col[0].pixel = lyxColorHandler->colorPixel(LColor::graphicsbg);
// some image magick versions use this
xpm_col[1].name = 0;
xpm_col[1].value = "opaque";
xpm_col[1].pixel = lyxColorHandler->colorPixel(LColor::black);
attrib.numsymbols = 2;
attrib.colorsymbols = xpm_col;
attrib.valuemask |= XpmColorSymbols;
// Load up the pixmap
XpmImage xpm_image = image_.get();
int const status =
XpmCreatePixmapFromXpmImage(display,
XRootWindowOfScreen(screen),
&xpm_image,
&pixmap, &mask, &attrib);
XpmFreeAttributes(&attrib);
if (status != XpmSuccess) {
lyxerr << "Error creating pixmap from xpm_image '"
<< XpmGetErrorString(status) << '\''
<< std::endl;
pixmap_status_ = PIXMAP_FAILED;
return false;
}
pixmap_ = pixmap;
pixmap_status_ = PIXMAP_SUCCESS;
return true;
}
void ImageXPM::clip(Params const & params)
{
if (image_.empty())
return;
if (params.bb.empty())
// No clipping is necessary.
return;
typedef unsigned int dimension;
dimension const new_width = params.bb.xr - params.bb.xl;
dimension const new_height = params.bb.yt - params.bb.yb;
if (new_width > image_.width() || new_height > image_.height())
// Bounds are invalid.
return;
if (new_width == image_.width() && new_height == image_.height())
// Bounds are unchanged.
return;
dimension * new_data = image_.initialisedData(new_width, new_height);
dimension * it = new_data;
// The image is stored in memory from upper-left to lower-right,
// so we loop from yt to yb.
dimension const * old_data = image_.data();
dimension const * start_row = old_data +
image_.width() * (image_.height() - params.bb.yt);
// the Bounding Box dimensions are never less than zero, so we can use
// "unsigned int row" here
for (dimension row = params.bb.yb; row < params.bb.yt; ++row) {
dimension const * begin = start_row + params.bb.xl;
dimension const * end = start_row + params.bb.xr;
it = std::copy(begin, end, it);
start_row += image_.width();
}
image_.resetData(new_width, new_height, new_data);
}
void ImageXPM::rotate(Params const & params)
{
if (image_.empty())
return ;
if (!params.angle)
// No rotation is necessary.
return;
// Ascertain the bounding box of the rotated image
// Rotate about the bottom-left corner
static double const pi = 3.14159265358979323846;
// The minus sign is needed to rotate in the same sense as xdvi et al.
double const angle = -double(params.angle) * pi / 180.0;
double const cos_a = cos(angle);
double const sin_a = sin(angle);
// (0, 0)
double max_x = 0; double min_x = 0;
double max_y = 0; double min_y = 0;
// (old_xpm->width, 0)
double x_rot = cos_a * image_.width();
double y_rot = sin_a * image_.width();
max_x = std::max(max_x, x_rot); min_x = std::min(min_x, x_rot);
max_y = std::max(max_y, y_rot); min_y = std::min(min_y, y_rot);
// (image_.width, image_.height)
x_rot = cos_a * image_.width() - sin_a * image_.height();
y_rot = sin_a * image_.width() + cos_a * image_.height();
max_x = std::max(max_x, x_rot); min_x = std::min(min_x, x_rot);
max_y = std::max(max_y, y_rot); min_y = std::min(min_y, y_rot);
// (0, image_.height)
x_rot = - sin_a * image_.height();
y_rot = cos_a * image_.height();
max_x = std::max(max_x, x_rot); min_x = std::min(min_x, x_rot);
max_y = std::max(max_y, y_rot); min_y = std::min(min_y, y_rot);
typedef unsigned int dimension;
dimension const new_width = 1 + int(max_x - min_x); // round up!
dimension const new_height = 1 + int(max_y - min_y);
dimension * new_data = image_.initialisedData(new_width, new_height);
dimension const * old_data = image_.data();
// rotate the data
for (dimension y_old = 0; y_old < image_.height(); ++y_old) {
for (dimension x_old = 0; x_old < image_.width(); ++x_old) {
double const x_pos = cos_a*x_old - sin_a*y_old - min_x;
double const y_pos = sin_a*x_old + cos_a*y_old - min_y;
// ensure that there are no rounding errors
dimension x_new = (x_pos > 0) ? dimension(x_pos) : 0;
dimension y_new = (y_pos > 0) ? dimension(y_pos) : 0;
x_new = std::min(new_width - 1, x_new);
y_new = std::min(new_height - 1, y_new);
size_t const id_old = x_old + image_.width() * y_old;
size_t const id_new = x_new + new_width * y_new;
new_data[id_new] = old_data[id_old];
}
}
image_.resetData(new_width, new_height, new_data);
}
void ImageXPM::scale(Params const & params)
{
if (image_.empty())
return;
typedef unsigned int dimension;
dimension new_width;
dimension new_height;
boost::tie(new_width, new_height) = getScaledDimensions(params);
if (new_width == getWidth() && new_height == getHeight())
// No scaling needed
return;
dimension * new_data = image_.initialisedData(new_width, new_height);
dimension const * old_data = image_.data();
double const x_scale = double(image_.width()) / double(new_width);
double const y_scale = double(image_.height()) / double(new_height);
// A very simple scaling routine.
// Ascertain the old pixel corresponding to the new one.
// There is no dithering at all here.
for (dimension x_new = 0; x_new < new_width; ++x_new) {
dimension x_old = dimension(x_new * x_scale);
for (dimension y_new = 0; y_new < new_height; ++y_new) {
dimension y_old = dimension(y_new * y_scale);
size_t const id_old = x_old + image_.width() * y_old;
size_t const id_new = x_new + new_width * y_new;
new_data[id_new] = old_data[id_old];
}
}
image_.resetData(new_width, new_height, new_data);
}
} // namespace grfx
namespace {
void free_color_table(XpmColor * colorTable, size_t size);
void copy_color_table(XpmColor const * in, size_t size, XpmColor * out);
bool contains_color_none(XpmImage const & image);
string const unique_color_string(XpmImage const & image);
// libXpm cannot cope with strings of the form #rrrrggggbbbb,
// #rrrgggbbb or #rgb, so convert them to #rrggbb.
string const convertTo7chars(string const &);
// create a copy (using malloc and strcpy). If (!in) return 0;
char * clone_c_string(char const * in);
// Given a string of the form #ff0571 create appropriate grayscale and
// monochrome colors.
void mapcolor(char const * c_color, char ** g_color_ptr, char ** m_color_ptr);
} // namespace anon
namespace grfx {
ImageXPM::Data::Data()
: width_(0), height_(0), cpp_(0), ncolors_(0)
{}
ImageXPM::Data::~Data()
{
}
void ImageXPM::Data::reset(XpmImage & image)
{
width_ = image.width;
height_ = image.height;
cpp_ = image.cpp;
// Move the data ptr into this store and free up image.data
data_.reset(image.data, free);
image.data = 0;
// Don't just store the color table, but check first that it contains
// all that we require of it.
// The idea is to store the color table in a shared_ptr and for all
// modified images to use the same table.
// It must, therefore, have a c_color "none" entry and g_color and
// m_color entries corresponding to each and every c_color entry
// (except "none"!)
// 1. Create a copy of the color table.
// Add a c_color "none" entry to the table if it isn't already there.
bool const add_color = !contains_color_none(image);
if (add_color) {
ncolors_ = 1 + image.ncolors;
size_t const mem_size = sizeof(XpmColor) * ncolors_;
XpmColor * table = static_cast<XpmColor *>(malloc(mem_size));
copy_color_table(image.colorTable, image.ncolors, table);
XpmColor & color = table[ncolors_ - 1];
color.symbolic = 0;
color.m_color = 0;
color.g_color = 0;
color.g4_color = 0;
color.string =
clone_c_string(unique_color_string(image).c_str());
color.c_color = clone_c_string("none");
free_color_table(image.colorTable, image.ncolors);
colorTable_.reset(table, boost::bind(free_color_table, _1, ncolors_));
} else {
// Just move the pointer across
ncolors_ = image.ncolors;
colorTable_.reset(image.colorTable,
boost::bind(free_color_table, _1, ncolors_));
image.colorTable = 0;
}
// Clean-up the remaining entries of image.
image.width = 0;
image.height = 0;
image.cpp = 0;
image.ncolors = 0;
// 2. Ensure that the color table has g_color and m_color entries
XpmColor * table = colorTable_.get();
for (size_t i = 0; i < ncolors_; ++i) {
XpmColor & entry = table[i];
if (!entry.c_color)
continue;
// libXpm cannot cope with strings of the form #rrrrggggbbbb,
// #rrrgggbbb or #rgb, so convert them to #rrggbb.
string c_color = entry.c_color;
if (c_color[0] == '#' && c_color.size() != 7) {
c_color = convertTo7chars(c_color);
free(entry.c_color);
entry.c_color = clone_c_string(c_color.c_str());
}
// If the c_color is defined and the equivalent
// grayscale or monochrome ones are not, then define them.
mapcolor(entry.c_color, &entry.g_color, &entry.m_color);
}
}
XpmImage ImageXPM::Data::get() const
{
XpmImage image;
image.width = width_;
image.height = height_;
image.cpp = cpp_;
image.ncolors = ncolors_;
image.data = data_.get();
image.colorTable = colorTable_.get();
return image;
}
void ImageXPM::Data::resetData(int w, int h, unsigned int * d)
{
width_ = w;
height_ = h;
data_.reset(d, free);
}
unsigned int * ImageXPM::Data::initialisedData(int w, int h) const
{
size_t const data_size = w * h;
size_t const mem_size = sizeof(unsigned int) * data_size;
unsigned int * ptr = static_cast<unsigned int *>(malloc(mem_size));
unsigned int none_id = color_none_id();
std::fill(ptr, ptr + data_size, none_id);
return ptr;
}
unsigned int ImageXPM::Data::color_none_id() const
{
XpmColor * table = colorTable_.get();
for (size_t i = 0; i < ncolors_; ++i) {
char const * const color = table[i].c_color;
if (color && ascii_lowercase(color) == "none")
return static_cast<unsigned int>(i);
}
return 0;
}
} // namespace grfx
namespace {
// libXpm cannot cope with strings of the form #rrrrggggbbbb,
// #rrrgggbbb or #rgb, so convert them to #rrggbb.
string const convertTo7chars(string const & input)
{
string::size_type size = input.size();
if (size != 13 && size != 10 && size != 9 && size != 4)
// Can't deal with it.
return input;
if (input[0] != '#')
// Can't deal with it.
return input;
string format(input);
switch (size) {
case 13: // #rrrrggggbbbb
format.erase(3, 2);
format.erase(5, 2);
format.erase(7, 2);
break;
case 10: // #rrrgggbbb
format.erase(3, 1);
format.erase(5, 1);
format.erase(7, 1);
break;
case 9: //
format.erase(7);
break;
case 4: // #rgb
format.insert(2, 1, '0');
format.insert(4, 1, '0');
format.append(1, '0');
break;
}
return format;
}
// Given a string of the form #ff0571 create appropriate grayscale and
// monochrome colors.
void mapcolor(char const * c_color, char ** g_color_ptr, char ** m_color_ptr)
{
if (!c_color)
return;
char * g_color = *g_color_ptr;
char * m_color = *m_color_ptr;
if (g_color && m_color)
// Already filled.
return;
Display * display = fl_get_display();
Colormap cmap = fl_state[fl_get_vclass()].colormap;
XColor xcol;
XColor ccol;
if (XLookupColor(display, cmap, c_color, &xcol, &ccol) == 0)
// Unable to parse c_color.
return;
// Note that X stores the RGB values in the range 0 - 65535
// whilst we require them in the range 0 - 255.
int const r = xcol.red / 256;
int const g = xcol.green / 256;
int const b = xcol.blue / 256;
// This gives a good match to a human's RGB to luminance conversion.
// (From xv's Postscript code --- Mike Ressler.)
int const gray = int((0.32 * r) + (0.5 * g) + (0.18 * b));
ostringstream gray_stream;
gray_stream << '#' << std::setbase(16) << std::setfill('0')
<< std::setw(2) << gray
<< std::setw(2) << gray
<< std::setw(2) << gray;
int const mono = (gray < 128) ? 0 : 255;
ostringstream mono_stream;
mono_stream << '#' << std::setbase(16) << std::setfill('0')
<< std::setw(2) << mono
<< std::setw(2) << mono
<< std::setw(2) << mono;
// This string is going into an XpmImage struct, so create copies that
// libXPM can free successfully.
if (!g_color)
*g_color_ptr = clone_c_string(gray_stream.str().c_str());
if (!m_color)
*m_color_ptr = clone_c_string(mono_stream.str().c_str());
}
void copy_color_table(XpmColor const * in, size_t size, XpmColor * out)
{
for (size_t i = 0; i < size; ++i) {
out[i].string = clone_c_string(in[i].string);
out[i].symbolic = clone_c_string(in[i].symbolic);
out[i].m_color = clone_c_string(in[i].m_color);
out[i].g_color = clone_c_string(in[i].g_color);
out[i].g4_color = clone_c_string(in[i].g4_color);
out[i].c_color = clone_c_string(in[i].c_color);
}
}
void free_color_table(XpmColor * table, size_t size)
{
for (size_t i = 0; i < size; ++i) {
free(table[i].string);
free(table[i].symbolic);
free(table[i].m_color);
free(table[i].g_color);
free(table[i].g4_color);
free(table[i].c_color);
}
free(table);
}
char * clone_c_string(char const * in)
{
if (!in)
return 0;
// Don't forget the '\0'
char * out = static_cast<char *>(malloc(strlen(in) + 1));
return strcpy(out, in);
}
bool contains_color_none(XpmImage const & image)
{
for (size_t i = 0; i < image.ncolors; ++i) {
char const * const color = image.colorTable[i].c_color;
if (color && ascii_lowercase(color) == "none")
return true;
}
return false;
}
string const unique_color_string(XpmImage const & image)
{
string id(image.cpp, ' ');
for(;;) {
bool found_it = false;
for (size_t i = 0; i < image.ncolors; ++i) {
string const c_id = image.colorTable[i].string;
if (c_id == id) {
found_it = true;
break;
}
}
if (!found_it)
return id;
// Loop over the printable characters in the ASCII table.
// Ie, count from char 32 (' ') to char 126 ('~')
// A base 94 counter!
string::size_type current_index = id.size() - 1;
bool continue_loop = true;
while(continue_loop) {
continue_loop = false;
if (id[current_index] == 126) {
continue_loop = true;
if (current_index == 0)
// Unable to find a unique string
return image.colorTable[0].string;
id[current_index] = 32;
current_index -= 1;
} else {
id[current_index] += 1;
// Note that '"' is an illegal char in this
// context
if (id[current_index] == '"')
id[current_index] += 1;
}
}
if (continue_loop)
// Unable to find a unique string
return string();
}
}
} // namespace anon

View File

@ -1,161 +0,0 @@
// -*- C++ -*-
/**
* \file GraphicsImageXPM.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Baruch Even
* \author Angus Leeming
*
* Full author contact details are available in file CREDITS
*
* An instantiation of Image that makes use of libXPM to load and store
* the image in memory.
*/
#ifndef GRAPHICSIMAGEXPM_H
#define GRAPHICSIMAGEXPM_H
#include "GraphicsImage.h"
#include XPM_H_LOCATION
#include <boost/shared_ptr.hpp>
#ifdef __GNUG__
#pragma interface
#endif
namespace grfx {
class ImageXPM : public Image
{
public:
/// Access to this class is through this static method.
static ImagePtr newImage();
/// Return the list of loadable formats.
static FormatList loadableFormats();
///
~ImageXPM();
/// Create a copy
Image * clone() const;
///
Pixmap getPixmap() const;
/// Get the image width
unsigned int getWidth() const;
/// Get the image height
unsigned int getHeight() const;
bool isDrawable() const;
/** Load the image file into memory.
* In this case (ImageXPM), the process is blocking.
*/
void load(string const & filename);
/** Generate the pixmap, based on the current state of the
* xpm_image_ (clipped, rotated, scaled etc).
* Uses the params to decide on color, grayscale etc.
* Returns true if the pixmap is created.
*/
bool setPixmap(Params const & params);
/// Clip the image using params.
void clip(Params const & params);
/// Rotate the image using params.
void rotate(Params const & params);
/// Scale the image using params.
void scale(Params const & params);
private:
/// Access to the class is through newImage() and clone.
ImageXPM();
///
ImageXPM(ImageXPM const &);
/** Contains the data read from file.
* This class is a wrapper for a XpmImage struct, but all views
* of a single file's data will share the same color table.
* This is done by ensuring that the color table contains a "none"
* c_color together with g_color and m_color entries for each c_color
* entry when it is first stored.
*/
class Data
{
public:
/// Default c-tor. Initialise everything to zero.
Data();
~Data();
bool empty() const { return width_ == 0; }
/** Wrap an XpmImage in a nice, clean C++ interface.
* Empty the original XpmImage.
* Does some analysis of the color table to ensure that
* it is suitable for all future eventualities. (See above
* description.)
*/
void reset(XpmImage & image);
/// Reset the data struct with this data.
void resetData(int width, int height, unsigned int * data);
/** Returns a ptr to an initialised block of memory.
* the data is initialised to the color "none" entry.
*/
unsigned int * initialisedData(int width, int height) const;
/** Construct an XpmImage from the stored contents.
* To pass to XpmCreatePixmapFromXpmImage.
* Efficient, because we only copy the ptrs to the structs.
*/
XpmImage get() const;
unsigned int width() const { return width_; }
unsigned int height() const { return height_; }
unsigned int cpp() const { return cpp_; }
unsigned int ncolors() const { return ncolors_; }
unsigned int const * data() const
{ return data_.get(); }
XpmColor const * colorTable() const
{ return colorTable_.get(); }
private:
unsigned int width_;
unsigned int height_;
unsigned int cpp_;
unsigned int ncolors_;
boost::shared_ptr<unsigned int> data_;
boost::shared_ptr<XpmColor> colorTable_;
unsigned int color_none_id() const;
};
Data image_;
/// The pixmap itself.
Pixmap pixmap_;
/// Is the pixmap initialized?
enum PixmapStatus {
///
PIXMAP_UNINITIALISED,
///
PIXMAP_FAILED,
///
PIXMAP_SUCCESS
};
PixmapStatus pixmap_status_;
};
} // namespace grfx
#endif // GRAPHICSIMAGEXPM_H

View File

@ -6,10 +6,6 @@ INCLUDES = -I$(srcdir)/.. $(BOOST_INCLUDES)
EXTRA_DIST = GraphicsImageXPM.C GraphicsImageXPM.h
if USE_BASIC_IMAGE_LOADER
GRAPHICSIMAGEXPM = GraphicsImageXPM.C GraphicsImageXPM.h
endif
libgraphics_la_SOURCES = \
GraphicsCache.h \
GraphicsCache.C \
@ -21,7 +17,7 @@ libgraphics_la_SOURCES = \
GraphicsImage.C \
GraphicsLoader.h \
GraphicsLoader.C \
$(GRAPHICSIMAGEXPM) GraphicsParams.C \
GraphicsParams.C \
GraphicsParams.h \
GraphicsSupport.h \
GraphicsSupport.C \