src/graphics/GraphicsCacheItem.C

   1 /* This file is part of
   2  * =================================================
   3  *
   4  *          LyX, The Document Processor
   5  *          Copyright 1995 Matthias Ettrich.
   6  *          Copyright 1995-2001 The LyX Team.
   7  *
   8  *          This file Copyright 2000 Baruch Even
   9  * ================================================= */
  10
  11 #include <config.h>
  12
  13 #ifdef __GNUG__
  14 #pragma implementation
  15 #endif
  16
  17 #include "graphics/GraphicsCache.h"
  18 #include "graphics/GraphicsCacheItem.h"
  19 #include "frontends/support/LyXImage.h"
  20 #include "graphics/ImageLoaderXPM.h"
  21 #include "converter.h"
  22 #include "support/filetools.h"
  23 #include "support/lyxlib.h"
  24 #include "lyx_gui_misc.h"
  25 #include "debug.h"
  26 #include "support/LAssert.h"
  27 #include "gettext.h"
  28
  29 using std::endl;
  30
  31 /*
  32  * The order of conversion:
  33  *
  34  * The c-tor calls convertImage()
  35  *
  36  * convertImage() verifies that we need to do conversion, if not it will just
  37  * call the loadImage()
  38  * if conversion is needed, it will initiate the conversion.
  39  *
  40  * When the conversion is completed imageConverted() is called, which in turn
  41  * calls loadImage().
  42  *
  43  * Since we currently do everything synchronously, convertImage() calls
  44  * imageConverted() right after it does the call to the conversion process.
  45 */
  46
  47 GraphicsCacheItem::GraphicsCacheItem(string const & filename)
  48         : imageStatus_(GraphicsCacheItem::Loading)
  49 {
  50         filename_ = filename;
  51
  52         bool success = convertImage(filename);
  53         if (! success) // Conversion failed miserably (couldn't even start).
  54                 setStatus(ErrorConverting);
  55 }
  56
  57
  58 GraphicsCacheItem::~GraphicsCacheItem()
  59 {}
  60
  61
  62 GraphicsCacheItem::ImageStatus
  63 GraphicsCacheItem::getImageStatus() const { return imageStatus_; }
  64
  65
  66 void GraphicsCacheItem::setStatus(ImageStatus new_status)
  67 {
  68         imageStatus_ = new_status;
  69 }
  70
  71
  72 LyXImage *
  73 GraphicsCacheItem::getImage() const { return image_.get(); }
  74
  75
  76 void
  77 GraphicsCacheItem::imageConverted(bool success)
  78 {
  79         lyxerr << "imageConverted, status=" << success << endl;
  80
  81         if (! success) {
  82                 lyxerr << "(GraphicsCacheItem::imageConverter) "
  83                         "Error converting image." << endl;
  84                 setStatus(GraphicsCacheItem::ErrorConverting);
  85                 return;
  86         }
  87
  88         // Do the actual image loading from file to memory.
  89         loadImage();
  90 }
  91
  92
  93 namespace {
  94
  95 string const findTargetFormat(string const & from)
  96 {
  97         typedef ImageLoader::FormatList FormatList;
  98         FormatList formats = ImageLoaderXPM().loadableFormats();
  99         lyx::Assert(formats.size() > 0); // There must be a format to load from.
 100
 101         FormatList::const_iterator iter = formats.begin();
 102         FormatList::const_iterator end  = formats.end();
 103
 104         for (; iter != end; ++iter) {
 105                 if (converters.IsReachable(from, *iter))
 106                         break;
 107         }
 108         if (iter == end) {
 109                 // We do not know how to convert the image to something loadable.
 110                 lyxerr << "ERROR: Do not know how to convert image." << std::endl;
 111
 112                 string const first(_("Cannot convert image to display format"));
 113                 string const second1(_("Need converter from "));
 114                 string const second2(_(" to "));
 115                 string const second(second1 + from + second2 + formats[0]);
 116
 117                 WriteAlert(first, second);
 118
 119                 return string();
 120         }
 121
 122         return (*iter);
 123 }
 124
 125 } // anon namespace
 126
 127
 128 bool
 129 GraphicsCacheItem::convertImage(string const & filename)
 130 {
 131         string const from = GetExtension(filename);
 132         string const to = findTargetFormat(from);
 133         if (to.empty())
 134                 return false;
 135
 136         // Take only the filename part of the file, without path or extension.
 137         string temp = OnlyFilename(filename);
 138         temp = ChangeExtension(filename, string());
 139
 140         // Add some stuff to have it a unique temp file.
 141         // This tempfile is deleted in loadImage after it is loaded to memory.
 142         tempfile = lyx::tempName(string(), temp);
 143         // Remove the temp file, we only want the name...
 144         lyx::unlink(tempfile);
 145
 146         converters.Convert(0, filename, tempfile, from, to);
 147
 148         // For now we are synchronous
 149         imageConverted(true);
 150
 151         // Cleanup after the conversion.
 152         lyx::unlink(tempfile);
 153         tempfile = string();
 154
 155         return true;
 156 }
 157
 158
 159 // This function gets called from the callback after the image has been
 160 // converted successfully.
 161 void
 162 GraphicsCacheItem::loadImage()
 163 {
 164         lyxerr << "Loading XPM Image... ";
 165
 166         ImageLoaderXPM imageLoader;
 167         if (imageLoader.loadImage(tempfile) == ImageLoader::OK) {
 168                 lyxerr << "Success." << endl;
 169                 image_.reset(imageLoader.getImage());
 170                 setStatus(GraphicsCacheItem::Loaded);
 171         } else {
 172                 lyxerr << "Loading " << tempfile << "Failed" << endl;
 173                 setStatus(GraphicsCacheItem::ErrorReading);
 174         }
 175 }