1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995-2001 the LyX Team.
8 * This file Copyright 2000 Baruch Even.
9 * ====================================================== */
13 * Switch to convert the images in the background, this requires work on
14 the converter, the systemcontroller and the graphics cache.
17 * Pop up a dialog if the widget version is higher than what we accept.
18 * Provide sed/awk/C code to downgrade from InsetGraphics to FigInset(?)
25 * If the image is from the clipart, and the document is moved to another
26 directory, the user is screwed. Need a way to handle it.
27 This amounts to a problem of when to use relative or absolute file paths
28 We should probably use what the user asks to use... but when he chooses
29 by the file dialog we normally get an absolute path and this may not be
31 * Bug in FileDlg class (src/filedlg.[hC]) when selecting a file and then
32 pressing ok, it counts as if no real selection done. Apparently
33 when choosing a file it doesn't update the select file input line.
35 * If we are trying to create a file in a read-only directory and there
36 are graphics that need converting, the converting will fail because
37 it is done in-place, into the same directory as the original image.
38 This needs to be fixed in the src/converter.C file
39 [ This is presumed to be fixed, needs testing.]
41 * We do not dither or resize the image in a WYSIWYM way, we load it at
42 its original size and color, resizing is done in the final output,
43 but not in the LyX window.
45 * The scale option is only handled for the horizontal part, the vertical
46 part will not work. For now it is also shown only for horizontal
49 * EPS figures are not fully detected, they may have a lot of possible
50 suffixes so we need to read the file and detect if it's EPS or not.
51 [Implemented, need testing]
53 TODO Before initial production release:
54 * Replace insetfig everywhere
55 * Search for comments of the form
56 // INSET_GRAPHICS: remove this when InsetFig is thrown.
57 And act upon them. Make sure not to remove InsetFig code for the
58 1.2.0 release, only afterwards, after deployment shows InsetGraphics
61 TODO Extended features:
63 * Advanced Latex tab folder.
64 * Add support for more features so that it will be better than insetfig.
65 * Keep aspect ratio radio button
66 * Support for complete control over the latex parameters for TeXperts
67 * What advanced features the users want to do?
68 Implement them in a non latex dependent way, but a logical way.
69 LyX should translate it to latex or any other fitting format.
70 * Add a way to roll the image file into the file format.
71 * When loading, if the image is not found in the expected place, try
72 to find it in the clipart, or in the same directory with the image.
73 * Keep a tab on the image file, if it changes, update the lyx view.
74 * The image choosing dialog could show thumbnails of the image formats
75 it knows of, thus selection based on the image instead of based on
77 * Add support for the 'picins' package.
78 * Add support for the 'picinpar' package.
79 * Improve support for 'subfigure' - Allow to set the various options
81 * Add resizing by percentage of image size (50%, 150%) - usefull for two
82 images of different size to be resized where they both should have
83 the same scale compared to each other.
89 * This is currently a moving target, I'm trying stuff and learning what
90 * is needed and how to accomplish it, since there is no predefined goal or
91 * way to go I invent it as I go.
93 * My current intention is for seperation from LaTeX, the basic needs are
94 * resizing and rotating, displaying on screen in various depths and printing
95 * conversion of depths (independent of the display depth). For this I'll
96 * provide a simple interface.
98 * The medium level includes clipping of the image, but in a limited way.
100 * For the LaTeX gurus I'll provide a complete control over the output, but
101 * this is latex dependent and guru dependent so I'd rather avoid doing this
102 * for the normal user. This stuff includes clipping, special image size
103 * specifications (\textwidth\minus 2in) which I see no way to generalize
104 * to non-latex specific way.
107 * 'graphicx' for the graphics inclusion.
108 * 'subfigure' for the subfigures.
112 * Current version is 1 (inset file format version), when changing it
113 * it should be changed in the Write() function when writing in one place
114 * and when reading one should change the version check and the error message.
116 * The filename is kept in the lyx file in a relative way, so as to allow
117 * moving the document file and its images with no problem.
120 * Postscript output means EPS figures.
122 * PDF output is best done with PDF figures if it's a direct conversion
123 * or PNG figures otherwise.
135 #pragma implementation
138 #include "insets/insetgraphics.h"
139 #include "insets/insetgraphicsParams.h"
140 #include "graphics/GraphicsCache.h"
141 #include "graphics/GraphicsCacheItem.h"
143 #include "frontends/Dialogs.h"
146 #include "BufferView.h"
147 #include "converter.h"
148 #include "frontends/support/LyXImage.h"
150 #include "lyx_gui_misc.h"
151 #include "support/FileInfo.h"
152 #include "support/filetools.h"
153 #include "support/lyxlib.h"
156 #include "font.h" // For the lyxfont class.
157 #include "fstream" // for ifstream in isEPS
158 #include <algorithm> // For the std::max
159 #include "support/lyxmanip.h"
163 extern string system_tempdir;
170 // This function is a utility function
172 string const RemoveExtension(string const & filename)
174 return ChangeExtension(filename, string());
178 // Initialize only those variables that do not have a constructor.
179 InsetGraphics::InsetGraphics()
180 : cacheHandle(0), imageLoaded(false)
184 InsetGraphics::InsetGraphics(InsetGraphics const & ig, bool same_id)
185 : Inset(), SigC::Object()
186 , cacheHandle(ig.cacheHandle)
187 , imageLoaded(ig.imageLoaded)
189 setParams(ig.getParams());
195 InsetGraphics::~InsetGraphics()
197 // Emits the hide signal to the dialog connected (if any)
203 InsetGraphics::statusMessage() const
207 if (cacheHandle.get()) {
208 switch (cacheHandle->getImageStatus()) {
209 case GraphicsCacheItem::UnknownError:
210 msg = _("Unknown Error");
213 case GraphicsCacheItem::Loading:
214 msg = _("Loading...");
217 case GraphicsCacheItem::ErrorReading:
218 msg = _("Error reading");
221 case GraphicsCacheItem::ErrorConverting:
222 msg = _("Error converting");
225 case GraphicsCacheItem::Loaded:
226 // No message to write.
235 int InsetGraphics::ascent(BufferView *, LyXFont const &) const
237 LyXImage * pixmap = 0;
238 if (cacheHandle.get() && (pixmap = cacheHandle->getImage()))
239 return pixmap->getHeight();
245 int InsetGraphics::descent(BufferView *, LyXFont const &) const
247 // this is not true if viewport is used and clip is not.
252 int InsetGraphics::width(BufferView *, LyXFont const & font) const
254 LyXImage * pixmap = 0;
256 if (cacheHandle.get() && (pixmap = cacheHandle->getImage()))
257 return pixmap->getWidth();
261 LyXFont msgFont(font);
262 msgFont.setFamily(LyXFont::SANS_FAMILY);
264 string const justname = OnlyFilename (params.filename);
265 if (!justname.empty()) {
266 msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
267 font_width = lyxfont::width(justname, msgFont);
270 string const msg = statusMessage();
272 msgFont.setSize(LyXFont::SIZE_TINY);
273 int const msg_width = lyxfont::width(msg, msgFont);
274 font_width = std::max(font_width, msg_width);
277 return std::max(50, font_width + 15);
282 void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
283 int baseline, float & x, bool) const
285 Painter & paint = bv->painter();
287 int ldescent = descent(bv, font);
288 int lascent = ascent(bv, font);
289 int lwidth = width(bv, font);
291 // Make sure x is updated upon exit from this routine
295 // This will draw the graphics. If the graphics has not been loaded yet,
296 // we draw just a rectangle.
299 paint.image(old_x + 2, baseline - lascent,
300 lwidth - 4, lascent + ldescent,
301 cacheHandle->getImage());
304 // Get the image status, default to unknown error.
305 GraphicsCacheItem::ImageStatus status = GraphicsCacheItem::UnknownError;
306 if (lyxrc.display_graphics != "no" &&
307 params.display != InsetGraphicsParams::NONE &&
309 status = cacheHandle->getImageStatus();
311 // Check if the image is now ready.
312 if (status == GraphicsCacheItem::Loaded) {
315 // Tell BufferView we need to be updated!
316 bv->text->status(bv, LyXText::CHANGED_IN_DRAW);
320 paint.rectangle(old_x + 2, baseline - lascent,
324 // Print the file name.
325 LyXFont msgFont(font);
326 msgFont.setFamily(LyXFont::SANS_FAMILY);
328 string const justname = OnlyFilename (params.filename);
329 if (!justname.empty()) {
330 msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
331 paint.text(old_x + 8,
332 baseline - lyxfont::maxAscent(msgFont) - 4,
336 // Print the message.
337 string const msg = statusMessage();
339 msgFont.setSize(LyXFont::SIZE_TINY);
340 paint.text(old_x + 8, baseline - 4, msg, msgFont);
346 void InsetGraphics::edit(BufferView *bv, int, int, unsigned int)
348 bv->owner()->getDialogs()->showGraphics(this);
352 void InsetGraphics::edit(BufferView * bv, bool)
358 Inset::EDITABLE InsetGraphics::editable() const
364 void InsetGraphics::write(Buffer const * buf, ostream & os) const
366 os << "Graphics FormatVersion 1\n";
368 params.Write(buf, os);
372 void InsetGraphics::read(Buffer const * buf, LyXLex & lex)
374 string const token = lex.getString();
376 if (token == "Graphics")
377 readInsetGraphics(buf, lex);
378 else if (token == "Figure") // Compatibility reading of FigInset figures.
379 readFigInset(buf, lex);
381 lyxerr[Debug::INFO] << "Not a Graphics or Figure inset!\n";
386 void InsetGraphics::readInsetGraphics(Buffer const * buf, LyXLex & lex)
388 bool finished = false;
390 while (lex.isOK() && !finished) {
393 string const token = lex.getString();
394 lyxerr[Debug::INFO] << "Token: '" << token << '\''
399 } else if (token == "\\end_inset") {
401 } else if (token == "FormatVersion") {
403 int version = lex.getInteger();
406 << "This document was created with a newer Graphics widget"
407 ", You should use a newer version of LyX to read this"
410 // TODO: Possibly open up a dialog?
413 if (! params.Read(buf, lex, token))
414 lyxerr << "Unknown token, " << token << ", skipping."
421 void InsetGraphics::readFigInset(Buffer const * buf, LyXLex & lex)
423 bool finished = false;
425 while (lex.isOK() && !finished) {
428 string const token = lex.getString();
429 lyxerr[Debug::INFO] << "Token: " << token << endl;
433 else if (token == "\\end_inset") {
435 } else if (token == "file") {
437 string const name = lex.getString();
438 string const path = OnlyPath(buf->fileName());
439 params.filename = MakeAbsPath(name, path);
441 } else if (token == "extra") {
443 // kept for backwards compability. Delete in 0.13.x
444 } else if (token == "subcaption") {
446 params.subcaptionText = lex.getString();
447 } else if (token == "label") {
449 // kept for backwards compability. Delete in 0.13.x
450 } else if (token == "angle") {
452 params.rotateAngle = lex.getFloat();
453 } else if (token == "size") {
454 // Size of image on screen is ignored in InsetGraphics, just eat
462 } else if (token == "flags") {
463 InsetGraphicsParams::DisplayType tmp = InsetGraphicsParams::COLOR;
465 switch (lex.getInteger()) {
466 case 1: tmp = InsetGraphicsParams::MONOCHROME; break;
467 case 2: tmp = InsetGraphicsParams::GRAYSCALE; break;
469 params.display = tmp;
470 } else if (token == "subfigure") {
471 params.subcaption = true;
472 } else if (token == "width") {
474 params.widthResize = static_cast<InsetGraphicsParams::Resize>(lex.getInteger());
477 params.widthSize = lex.getFloat();
479 } else if (token == "height") {
481 params.heightResize = static_cast<InsetGraphicsParams::Resize>(lex.getInteger());
484 params.heightSize = lex.getFloat();
493 void formatResize(ostream & os, string const & key,
494 InsetGraphicsParams::Resize resizeType, double size)
496 switch (resizeType) {
497 case InsetGraphicsParams::DEFAULT_SIZE:
500 case InsetGraphicsParams::CM:
501 os << key << '=' << size << "cm,";
504 case InsetGraphicsParams::INCH:
505 os << key << '=' << size << "in,";
508 case InsetGraphicsParams::PERCENT_PAGE:
509 os << key << '=' << size / 100 << "\\text" << key << ',';
512 case InsetGraphicsParams::PERCENT_COLUMN:
513 os << key << '=' << size / 100 << "\\column" << key << ',';
516 case InsetGraphicsParams::SCALE:
517 os << "scale" << '=' << size/100 << ',';
525 InsetGraphics::createLatexOptions() const
527 // Calculate the options part of the command, we must do it to a string
528 // stream since we might have a trailing comma that we would like to remove
529 // before writing it to the output stream.
530 ostringstream options;
532 formatResize(options, "width", params.widthResize, params.widthSize);
533 formatResize(options, "height", params.heightResize, params.heightSize);
535 // Make sure it's not very close to zero, a float can be effectively
536 // zero but not exactly zero.
537 if (lyx::float_equal(params.rotateAngle, 0, 0.001)) {
539 << params.rotateAngle << ',';
542 string opts = options.str().c_str();
543 opts = strip(opts, ',');
559 bool isEPS(string const & filename)
561 if (filename.empty() || !IsFileReadable(filename)) return false;
563 ifstream ifs(filename.c_str());
565 if (!ifs) return false; // Couldn't open file...
567 bool is_eps = false; // Have we recognized the file as EPS?
568 string to_find = "%!PS-Adobe-"; // The string we use to recognize
569 int const max_attempts = 500; // Maximum strings to read to attempt recognition
570 int count = 0; // Counter of attempts.
572 for (; count < max_attempts; ++count) {
574 lyxerr[Debug::INFO] << "InsetGraphics (isEPS)"
575 " End of file reached and it wasn't found to be EPS!" << endl;
580 if (str.find(to_find)) {
589 enum FileType classifyFileType(string const & filename, string const & suffix)
593 else if (suffix == "jpg" || suffix == "jpeg")
595 else if (suffix == "gif")
597 else if (suffix == "pdf")
599 else if (isEPS(filename))
605 string decideOutputImageFormat(string const & suffix, enum FileType type)
607 // lyxrc.pdf_mode means:
608 // Are we creating a PDF or a PS file?
609 // (Should actually mean, are we using latex or pdflatex).
611 if (lyxrc.pdf_mode) {
612 if (type == EPS || type == EPS || type == PDF)
614 else if (type == JPEG)
620 // If it's postscript, we always do eps.
621 // There are many suffixes that are actually EPS (ask Garst for example)
622 // so we detect if it's an EPS by looking in the file, if it is, we return
623 // the same suffix of the file so it won't be converted.
633 InsetGraphics::prepareFile(Buffer const *buf) const
636 // do_convert = Do we need to convert the file?
637 // nice = Do we create a nice version?
638 // This is used when exporting the latex file only.
642 // return original filename
645 // convert_place = temp directory
646 // return new filename in temp directory
648 // convert_place = original file directory
649 // return original filename without the extension
652 // Get the extension (format) of the original file.
653 string const extension = GetExtension(params.filename);
654 FileType type = classifyFileType(params.filename, extension);
656 // Are we creating a PDF or a PS file?
657 // (Should actually mean, are we usind latex or pdflatex).
658 string const image_target = decideOutputImageFormat(extension, type);
660 if (extension == image_target)
661 return params.filename;
664 if (!buf->niceFile) {
665 string const temp = AddName(buf->tmppath, params.filename);
666 outfile = RemoveExtension(temp);
668 //lyxerr << "buf::tmppath = " << buf->tmppath << "\n";
669 //lyxerr << "filename = " << params.filename << "\n";
670 //lyxerr << "temp = " << temp << "\n";
671 //lyxerr << "outfile = " << outfile << endl;
673 string const path = OnlyPath(buf->fileName());
674 string const relname = MakeRelPath(params.filename, path);
675 outfile = RemoveExtension(relname);
678 converters.convert(buf, params.filename, outfile, extension, image_target);
684 int InsetGraphics::latex(Buffer const *buf, ostream & os,
685 bool /*fragile*/, bool/*fs*/) const
687 // MISSING: We have to decide how to do the order of the options
688 // that is dependent of order, like width, height, angle. Should
689 // we rotate before scale? Should we let the user decide?
690 // bool rot_before_scale; ?
692 // (BE) As a first step we should do a scale before rotate since this is
693 // more like the natural thought of how to do it.
694 // (BE) I believe that a priority list presented to the user with
695 // a default order would be the best, though it would be better to
696 // hide such a thing in an "Advanced options" dialog.
697 // (BE) This should go an advanced LaTeX options dialog.
699 // If there is no file specified, just output a message about it in
701 if (params.filename.empty()) {
702 os << "\\fbox{\\rule[-0.5in]{0pt}{1in}"
703 << _("empty figure path")
706 return 1; // One end of line marker added to the stream.
709 // Keep count of newlines that we issued.
712 // This variables collect all the latex code that should be before and
713 // after the actual includegraphics command.
717 // Do we want subcaptions?
718 if (params.subcaption) {
719 before += "\\subfigure[" + params.subcaptionText + "]{";
723 // We never use the starred form, we use the "clip" option instead.
724 os << before << "\\includegraphics";
726 // Write the options if there are any.
727 string const opts = createLatexOptions();
729 os << '[' << opts << ']';
732 // Make the filename relative to the lyx file
733 // and remove the extension so the LaTeX will use whatever is
734 // appropriate (when there are several versions in different formats)
735 string const filename = prepareFile(buf);
737 os << '{' << filename << '}' << after;
739 // Return how many newlines we issued.
744 int InsetGraphics::ascii(Buffer const *, ostream &, int) const
746 // No graphics in ascii output. Possible to use gifscii to convert
747 // images to ascii approximation.
749 // 1. Convert file to ascii using gifscii
750 // 2. Read ascii output file and add it to the output stream.
756 int InsetGraphics::linuxdoc(Buffer const *, ostream &) const
758 // No graphics in LinuxDoc output. Should check how/what to add.
763 // For explanation on inserting graphics into DocBook checkout:
764 // http://linuxdoc.org/LDP/LDP-Author-Guide/inserting-pictures.html
765 // See also the docbook guide at http://www.docbook.org/
766 int InsetGraphics::docbook(Buffer const * buf, ostream & os) const
768 // Change the path to be relative to the main file.
769 string const buffer_dir = OnlyPath(buf->fileName());
770 string const filename = RemoveExtension(
771 MakeRelPath(params.filename, buffer_dir));
773 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
774 // need to switch to MediaObject. However, for now this is sufficient and
776 os << "<graphic fileref=\"" << filename << "\"></graphic>";
781 void InsetGraphics::validate(LaTeXFeatures & features) const
783 // If we have no image, we should not require anything.
784 if (params.filename.empty())
787 features.require("graphicx");
789 if (params.subcaption)
790 features.require("subfigure");
794 // Update the inset after parameters changed (read from file or changed in
796 void InsetGraphics::updateInset() const
798 GraphicsCache & gc = GraphicsCache::getInstance();
799 boost::shared_ptr<GraphicsCacheItem> temp(0);
801 // We do it this way so that in the face of some error, we will still
802 // be in a valid state.
803 if (!params.filename.empty() &&
804 lyxrc.display_graphics != "no" &&
805 params.display != InsetGraphicsParams::NONE) {
806 temp = gc.addFile(params.filename);
809 // Mark the image as unloaded so that it gets updated.
816 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
818 // If nothing is changed, just return and say so.
822 // Copy the new parameters.
825 // Update the inset with the new parameters.
828 // We have changed data, report it.
833 InsetGraphicsParams InsetGraphics::getParams() const
839 Inset * InsetGraphics::clone(Buffer const &, bool same_id) const
841 return new InsetGraphics(*this, same_id);