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
32 * If we are trying to create a file in a read-only directory and there
33 are graphics that need converting, the converting will fail because
34 it is done in-place, into the same directory as the original image.
35 This needs to be fixed in the src/converter.C file
36 [ This is presumed to be fixed, needs testing.]
38 * We do not dither or resize the image in a WYSIWYM way, we load it at
39 its original size and color, resizing is done in the final output,
40 but not in the LyX window.
42 * The scale option is only handled for the horizontal part, the vertical
43 part will not work. For now it is also shown only for horizontal
46 * EPS figures are not fully detected, they may have a lot of possible
47 suffixes so we need to read the file and detect if it's EPS or not.
48 [Implemented, need testing]
50 TODO Before initial production release:
51 * Replace insetfig everywhere
52 * Search for comments of the form
53 // INSET_GRAPHICS: remove this when InsetFig is thrown.
54 And act upon them. Make sure not to remove InsetFig code for the
55 1.2.0 release, only afterwards, after deployment shows InsetGraphics
58 TODO Extended features:
60 * Advanced Latex tab folder.
61 * Add support for more features so that it will be better than insetfig.
62 * Keep aspect ratio radio button
63 * Support for complete control over the latex parameters for TeXperts
64 * What advanced features the users want to do?
65 Implement them in a non latex dependent way, but a logical way.
66 LyX should translate it to latex or any other fitting format.
67 * Add a way to roll the image file into the file format.
68 * When loading, if the image is not found in the expected place, try
69 to find it in the clipart, or in the same directory with the image.
70 * Keep a tab on the image file, if it changes, update the lyx view.
71 * The image choosing dialog could show thumbnails of the image formats
72 it knows of, thus selection based on the image instead of based on
74 * Add support for the 'picins' package.
75 * Add support for the 'picinpar' package.
76 * Improve support for 'subfigure' - Allow to set the various options
78 * Add resizing by percentage of image size (50%, 150%) - usefull for two
79 images of different size to be resized where they both should have
80 the same scale compared to each other.
86 * This is currently a moving target, I'm trying stuff and learning what
87 * is needed and how to accomplish it, since there is no predefined goal or
88 * way to go I invent it as I go.
90 * My current intention is for seperation from LaTeX, the basic needs are
91 * resizing and rotating, displaying on screen in various depths and printing
92 * conversion of depths (independent of the display depth). For this I'll
93 * provide a simple interface.
95 * The medium level includes clipping of the image, but in a limited way.
97 * For the LaTeX gurus I'll provide a complete control over the output, but
98 * this is latex dependent and guru dependent so I'd rather avoid doing this
99 * for the normal user. This stuff includes clipping, special image size
100 * specifications (\textwidth\minus 2in) which I see no way to generalize
101 * to non-latex specific way.
104 * 'graphicx' for the graphics inclusion.
105 * 'subfigure' for the subfigures.
109 * Current version is 1 (inset file format version), when changing it
110 * it should be changed in the Write() function when writing in one place
111 * and when reading one should change the version check and the error message.
113 * The filename is kept in the lyx file in a relative way, so as to allow
114 * moving the document file and its images with no problem.
117 * Postscript output means EPS figures.
119 * PDF output is best done with PDF figures if it's a direct conversion
120 * or PNG figures otherwise.
132 #pragma implementation
135 #include "insets/insetgraphics.h"
136 #include "insets/insetgraphicsParams.h"
137 #include "graphics/GraphicsCache.h"
138 #include "graphics/GraphicsCacheItem.h"
140 #include "frontends/Dialogs.h"
143 #include "BufferView.h"
144 #include "converter.h"
145 #include "frontends/support/LyXImage.h"
147 #include "lyx_gui_misc.h"
148 #include "support/FileInfo.h"
149 #include "support/filetools.h"
150 #include "support/lyxlib.h"
153 #include "font.h" // For the lyxfont class.
154 #include "fstream" // for ifstream in isEPS
155 #include <algorithm> // For the std::max
156 #include "support/lyxmanip.h"
160 extern string system_tempdir;
167 // This function is a utility function
168 // ... that should be with ChangeExtension ...
170 string const RemoveExtension(string const & filename)
172 return ChangeExtension(filename, string());
176 // Initialize only those variables that do not have a constructor.
177 InsetGraphics::InsetGraphics()
178 : cacheHandle(0), imageLoaded(false)
182 InsetGraphics::InsetGraphics(InsetGraphics const & ig, bool same_id)
183 : Inset(), SigC::Object()
184 , cacheHandle(ig.cacheHandle)
185 , imageLoaded(ig.imageLoaded)
187 setParams(ig.getParams());
193 InsetGraphics::~InsetGraphics()
195 // Emits the hide signal to the dialog connected (if any)
201 InsetGraphics::statusMessage() const
205 if (cacheHandle.get()) {
206 switch (cacheHandle->getImageStatus()) {
207 case GraphicsCacheItem::UnknownError:
208 msg = _("Unknown Error");
211 case GraphicsCacheItem::Loading:
212 msg = _("Loading...");
215 case GraphicsCacheItem::ErrorReading:
216 msg = _("Error reading");
219 case GraphicsCacheItem::ErrorConverting:
220 msg = _("Error converting");
223 case GraphicsCacheItem::Loaded:
224 // No message to write.
233 int InsetGraphics::ascent(BufferView *, LyXFont const &) const
235 LyXImage * pixmap = 0;
236 if (cacheHandle.get() && (pixmap = cacheHandle->getImage()))
237 return pixmap->getHeight();
243 int InsetGraphics::descent(BufferView *, LyXFont const &) const
245 // this is not true if viewport is used and clip is not.
250 int InsetGraphics::width(BufferView *, LyXFont const & font) const
252 LyXImage * pixmap = 0;
254 if (cacheHandle.get() && (pixmap = cacheHandle->getImage()))
255 return pixmap->getWidth();
259 LyXFont msgFont(font);
260 msgFont.setFamily(LyXFont::SANS_FAMILY);
262 string const justname = OnlyFilename (params.filename);
263 if (!justname.empty()) {
264 msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
265 font_width = lyxfont::width(justname, msgFont);
268 string const msg = statusMessage();
270 msgFont.setSize(LyXFont::SIZE_TINY);
271 int const msg_width = lyxfont::width(msg, msgFont);
272 font_width = std::max(font_width, msg_width);
275 return std::max(50, font_width + 15);
280 void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
281 int baseline, float & x, bool) const
283 Painter & paint = bv->painter();
285 int ldescent = descent(bv, font);
286 int lascent = ascent(bv, font);
287 int lwidth = width(bv, font);
289 // Make sure x is updated upon exit from this routine
293 // This will draw the graphics. If the graphics has not been loaded yet,
294 // we draw just a rectangle.
297 paint.image(old_x + 2, baseline - lascent,
298 lwidth - 4, lascent + ldescent,
299 cacheHandle->getImage());
302 // Get the image status, default to unknown error.
303 GraphicsCacheItem::ImageStatus status = GraphicsCacheItem::UnknownError;
304 if (lyxrc.display_graphics != "no" &&
305 params.display != InsetGraphicsParams::NONE &&
307 status = cacheHandle->getImageStatus();
309 // Check if the image is now ready.
310 if (status == GraphicsCacheItem::Loaded) {
313 // Tell BufferView we need to be updated!
314 bv->text->status(bv, LyXText::CHANGED_IN_DRAW);
318 paint.rectangle(old_x + 2, baseline - lascent,
322 // Print the file name.
323 LyXFont msgFont(font);
324 msgFont.setFamily(LyXFont::SANS_FAMILY);
326 string const justname = OnlyFilename (params.filename);
327 if (!justname.empty()) {
328 msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
329 paint.text(old_x + 8,
330 baseline - lyxfont::maxAscent(msgFont) - 4,
334 // Print the message.
335 string const msg = statusMessage();
337 msgFont.setSize(LyXFont::SIZE_TINY);
338 paint.text(old_x + 8, baseline - 4, msg, msgFont);
344 void InsetGraphics::edit(BufferView *bv, int, int, unsigned int)
346 bv->owner()->getDialogs()->showGraphics(this);
350 void InsetGraphics::edit(BufferView * bv, bool)
356 Inset::EDITABLE InsetGraphics::editable() const
362 void InsetGraphics::write(Buffer const * buf, ostream & os) const
364 os << "Graphics FormatVersion 1\n";
366 params.Write(buf, os);
370 void InsetGraphics::read(Buffer const * buf, LyXLex & lex)
372 string const token = lex.getString();
374 if (token == "Graphics")
375 readInsetGraphics(buf, lex);
376 else if (token == "Figure") // Compatibility reading of FigInset figures.
377 readFigInset(buf, lex);
379 lyxerr[Debug::INFO] << "Not a Graphics or Figure inset!\n";
384 void InsetGraphics::readInsetGraphics(Buffer const * buf, LyXLex & lex)
386 bool finished = false;
388 while (lex.isOK() && !finished) {
391 string const token = lex.getString();
392 lyxerr[Debug::INFO] << "Token: '" << token << '\''
397 } else if (token == "\\end_inset") {
399 } else if (token == "FormatVersion") {
401 int version = lex.getInteger();
404 << "This document was created with a newer Graphics widget"
405 ", You should use a newer version of LyX to read this"
408 // TODO: Possibly open up a dialog?
411 if (! params.Read(buf, lex, token))
412 lyxerr << "Unknown token, " << token << ", skipping."
419 void InsetGraphics::readFigInset(Buffer const * buf, LyXLex & lex)
421 bool finished = false;
423 while (lex.isOK() && !finished) {
426 string const token = lex.getString();
427 lyxerr[Debug::INFO] << "Token: " << token << endl;
431 else if (token == "\\end_inset") {
433 } else if (token == "file") {
435 string const name = lex.getString();
436 string const path = OnlyPath(buf->fileName());
437 params.filename = MakeAbsPath(name, path);
439 } else if (token == "extra") {
441 // kept for backwards compability. Delete in 0.13.x
442 } else if (token == "subcaption") {
444 params.subcaptionText = lex.getString();
445 } else if (token == "label") {
447 // kept for backwards compability. Delete in 0.13.x
448 } else if (token == "angle") {
450 params.rotateAngle = lex.getFloat();
451 } else if (token == "size") {
452 // Size of image on screen is ignored in InsetGraphics, just eat
460 } else if (token == "flags") {
461 InsetGraphicsParams::DisplayType tmp = InsetGraphicsParams::COLOR;
463 switch (lex.getInteger()) {
464 case 1: tmp = InsetGraphicsParams::MONOCHROME; break;
465 case 2: tmp = InsetGraphicsParams::GRAYSCALE; break;
467 params.display = tmp;
468 } else if (token == "subfigure") {
469 params.subcaption = true;
470 } else if (token == "width") {
472 params.widthResize = static_cast<InsetGraphicsParams::Resize>(lex.getInteger());
475 params.widthSize = lex.getFloat();
477 } else if (token == "height") {
479 params.heightResize = static_cast<InsetGraphicsParams::Resize>(lex.getInteger());
482 params.heightSize = lex.getFloat();
491 void formatResize(ostream & os, string const & key,
492 InsetGraphicsParams::Resize resizeType, double size)
494 switch (resizeType) {
495 case InsetGraphicsParams::DEFAULT_SIZE:
498 case InsetGraphicsParams::CM:
499 os << key << '=' << size << "cm,";
502 case InsetGraphicsParams::INCH:
503 os << key << '=' << size << "in,";
506 case InsetGraphicsParams::PERCENT_PAGE:
507 os << key << '=' << size / 100 << "\\text" << key << ',';
510 case InsetGraphicsParams::PERCENT_COLUMN:
511 os << key << '=' << size / 100 << "\\column" << key << ',';
514 case InsetGraphicsParams::SCALE:
515 os << "scale" << '=' << size/100 << ',';
523 InsetGraphics::createLatexOptions() const
525 // Calculate the options part of the command, we must do it to a string
526 // stream since we might have a trailing comma that we would like to remove
527 // before writing it to the output stream.
528 ostringstream options;
530 formatResize(options, "width", params.widthResize, params.widthSize);
531 formatResize(options, "height", params.heightResize, params.heightSize);
533 // Make sure it's not very close to zero, a float can be effectively
534 // zero but not exactly zero.
535 if (!lyx::float_equal(params.rotateAngle, 0, 0.001)) {
537 << params.rotateAngle << ',';
540 string opts = options.str().c_str();
541 opts = strip(opts, ',');
557 bool isEPS(string const & filename)
559 if (filename.empty() || !IsFileReadable(filename)) return false;
561 ifstream ifs(filename.c_str());
563 if (!ifs) return false; // Couldn't open file...
565 bool is_eps = false; // Have we recognized the file as EPS?
566 string to_find = "%!PS-Adobe-"; // The string we use to recognize
567 int const max_attempts = 500; // Maximum strings to read to attempt recognition
568 int count = 0; // Counter of attempts.
570 for (; count < max_attempts; ++count) {
572 lyxerr[Debug::INFO] << "InsetGraphics (isEPS)"
573 " End of file reached and it wasn't found to be EPS!" << endl;
578 if (str.find(to_find)) {
587 enum FileType classifyFileType(string const & filename, string const & suffix)
591 else if (suffix == "jpg" || suffix == "jpeg")
593 else if (suffix == "gif")
595 else if (suffix == "pdf")
597 else if (isEPS(filename))
603 string decideOutputImageFormat(string const & suffix, enum FileType type)
605 // lyxrc.pdf_mode means:
606 // Are we creating a PDF or a PS file?
607 // (Should actually mean, are we using latex or pdflatex).
609 if (lyxrc.pdf_mode) {
610 if (type == EPS || type == EPS || type == PDF)
612 else if (type == JPEG)
618 // If it's postscript, we always do eps.
619 // There are many suffixes that are actually EPS (ask Garst for example)
620 // so we detect if it's an EPS by looking in the file, if it is, we return
621 // the same suffix of the file so it won't be converted.
631 InsetGraphics::prepareFile(Buffer const *buf) const
634 // do_convert = Do we need to convert the file?
635 // nice = Do we create a nice version?
636 // This is used when exporting the latex file only.
640 // return original filename
643 // convert_place = temp directory
644 // return new filename in temp directory
646 // convert_place = original file directory
647 // return original filename without the extension
650 // Get the extension (format) of the original file.
651 string const extension = GetExtension(params.filename);
652 FileType type = classifyFileType(params.filename, extension);
654 // Are we creating a PDF or a PS file?
655 // (Should actually mean, are we usind latex or pdflatex).
656 string const image_target = decideOutputImageFormat(extension, type);
658 if (extension == image_target)
659 return params.filename;
662 if (!buf->niceFile) {
663 string const temp = AddName(buf->tmppath, params.filename);
664 outfile = RemoveExtension(temp);
666 //lyxerr << "buf::tmppath = " << buf->tmppath << "\n";
667 //lyxerr << "filename = " << params.filename << "\n";
668 //lyxerr << "temp = " << temp << "\n";
669 //lyxerr << "outfile = " << outfile << endl;
671 string const path = OnlyPath(buf->fileName());
672 string const relname = MakeRelPath(params.filename, path);
673 outfile = RemoveExtension(relname);
676 converters.convert(buf, params.filename, outfile, extension, image_target);
682 int InsetGraphics::latex(Buffer const *buf, ostream & os,
683 bool /*fragile*/, bool/*fs*/) const
685 // MISSING: We have to decide how to do the order of the options
686 // that is dependent of order, like width, height, angle. Should
687 // we rotate before scale? Should we let the user decide?
688 // bool rot_before_scale; ?
690 // (BE) As a first step we should do a scale before rotate since this is
691 // more like the natural thought of how to do it.
692 // (BE) I believe that a priority list presented to the user with
693 // a default order would be the best, though it would be better to
694 // hide such a thing in an "Advanced options" dialog.
695 // (BE) This should go an advanced LaTeX options dialog.
697 // If there is no file specified, just output a message about it in
699 if (params.filename.empty()) {
700 os << "\\fbox{\\rule[-0.5in]{0pt}{1in}"
701 << _("empty figure path")
704 return 1; // One end of line marker added to the stream.
707 // Keep count of newlines that we issued.
710 // This variables collect all the latex code that should be before and
711 // after the actual includegraphics command.
715 // Do we want subcaptions?
716 if (params.subcaption) {
717 before += "\\subfigure[" + params.subcaptionText + "]{";
721 // We never use the starred form, we use the "clip" option instead.
722 os << before << "\\includegraphics";
724 // Write the options if there are any.
725 string const opts = createLatexOptions();
727 os << '[' << opts << ']';
730 // Make the filename relative to the lyx file
731 // and remove the extension so the LaTeX will use whatever is
732 // appropriate (when there are several versions in different formats)
733 string const filename = prepareFile(buf);
735 os << '{' << filename << '}' << after;
737 // Return how many newlines we issued.
742 int InsetGraphics::ascii(Buffer const *, ostream &, int) const
744 // No graphics in ascii output. Possible to use gifscii to convert
745 // images to ascii approximation.
747 // 1. Convert file to ascii using gifscii
748 // 2. Read ascii output file and add it to the output stream.
754 int InsetGraphics::linuxdoc(Buffer const *, ostream &) const
756 // No graphics in LinuxDoc output. Should check how/what to add.
761 // For explanation on inserting graphics into DocBook checkout:
762 // http://linuxdoc.org/LDP/LDP-Author-Guide/inserting-pictures.html
763 // See also the docbook guide at http://www.docbook.org/
764 int InsetGraphics::docbook(Buffer const * buf, ostream & os) const
766 // Change the path to be relative to the main file.
767 string const buffer_dir = OnlyPath(buf->fileName());
768 string const filename = RemoveExtension(
769 MakeRelPath(params.filename, buffer_dir));
771 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
772 // need to switch to MediaObject. However, for now this is sufficient and
774 os << "<graphic fileref=\"" << filename << "\"></graphic>";
779 void InsetGraphics::validate(LaTeXFeatures & features) const
781 // If we have no image, we should not require anything.
782 if (params.filename.empty())
785 features.require("graphicx");
787 if (params.subcaption)
788 features.require("subfigure");
792 // Update the inset after parameters changed (read from file or changed in
794 void InsetGraphics::updateInset() const
796 GraphicsCache & gc = GraphicsCache::getInstance();
797 boost::shared_ptr<GraphicsCacheItem> temp(0);
799 // We do it this way so that in the face of some error, we will still
800 // be in a valid state.
801 if (!params.filename.empty() &&
802 lyxrc.display_graphics != "no" &&
803 params.display != InsetGraphicsParams::NONE) {
804 temp = gc.addFile(params.filename);
807 // Mark the image as unloaded so that it gets updated.
814 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
816 // If nothing is changed, just return and say so.
820 // Copy the new parameters.
823 // Update the inset with the new parameters.
826 // We have changed data, report it.
831 InsetGraphicsParams InsetGraphics::getParams() const
837 Inset * InsetGraphics::clone(Buffer const &, bool same_id) const
839 return new InsetGraphics(*this, same_id);