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();
259 string const msg = statusMessage();
263 font_width = lyxfont::width(msg, font);
265 return std::max(50, font_width + 15);
270 void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
271 int baseline, float & x, bool) const
273 Painter & paint = bv->painter();
275 int ldescent = descent(bv, font);
276 int lascent = ascent(bv, font);
277 int lwidth = width(bv, font);
279 // Make sure x is updated upon exit from this routine
283 // This will draw the graphics. If the graphics has not been loaded yet,
284 // we draw just a rectangle.
287 paint.image(old_x + 2, baseline - lascent,
288 lwidth - 4, lascent + ldescent,
289 cacheHandle->getImage());
292 // Get the image status, default to unknown error.
293 GraphicsCacheItem::ImageStatus status = GraphicsCacheItem::UnknownError;
294 if (params.display != InsetGraphicsParams::NONE &&
296 status = cacheHandle->getImageStatus();
298 // Check if the image is now ready.
299 if (status == GraphicsCacheItem::Loaded) {
302 // Tell BufferView we need to be updated!
303 bv->text->status(bv, LyXText::CHANGED_IN_DRAW);
308 paint.rectangle(old_x + 2, baseline - lascent,
312 string const msg = statusMessage();
314 // Print the message.
315 LyXFont msgFont(font);
316 msgFont.setFamily(LyXFont::SANS_FAMILY);
317 msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
318 string const justname = OnlyFilename (params.filename);
319 paint.text(old_x + 8,
320 baseline - lyxfont::maxAscent(msgFont) - 4,
323 msgFont.setSize(LyXFont::SIZE_TINY);
324 paint.text(old_x + 8, baseline - 4, msg, msgFont);
330 void InsetGraphics::edit(BufferView *bv, int, int, unsigned int)
332 bv->owner()->getDialogs()->showGraphics(this);
336 void InsetGraphics::edit(BufferView * bv, bool)
342 Inset::EDITABLE InsetGraphics::editable() const
348 void InsetGraphics::write(Buffer const * buf, ostream & os) const
350 os << "Graphics FormatVersion 1\n";
352 params.Write(buf, os);
356 void InsetGraphics::read(Buffer const * buf, LyXLex & lex)
358 string const token = lex.getString();
360 if (token == "Graphics")
361 readInsetGraphics(buf, lex);
362 else if (token == "Figure") // Compatibility reading of FigInset figures.
363 readFigInset(buf, lex);
365 lyxerr[Debug::INFO] << "Not a Graphics or Figure inset!\n";
370 void InsetGraphics::readInsetGraphics(Buffer const * buf, LyXLex & lex)
372 bool finished = false;
374 while (lex.isOK() && !finished) {
377 string const token = lex.getString();
378 lyxerr[Debug::INFO] << "Token: '" << token << '\''
383 } else if (token == "\\end_inset") {
385 } else if (token == "FormatVersion") {
387 int version = lex.getInteger();
390 << "This document was created with a newer Graphics widget"
391 ", You should use a newer version of LyX to read this"
394 // TODO: Possibly open up a dialog?
397 if (! params.Read(buf, lex, token))
398 lyxerr << "Unknown token, " << token << ", skipping."
405 void InsetGraphics::readFigInset(Buffer const * buf, LyXLex & lex)
407 bool finished = false;
409 while (lex.isOK() && !finished) {
412 string const token = lex.getString();
413 lyxerr[Debug::INFO] << "Token: " << token << endl;
417 else if (token == "\\end_inset") {
419 } else if (token == "file") {
421 string const name = lex.getString();
422 string const path = OnlyPath(buf->fileName());
423 params.filename = MakeAbsPath(name, path);
425 } else if (token == "extra") {
427 // kept for backwards compability. Delete in 0.13.x
428 } else if (token == "subcaption") {
430 params.subcaptionText = lex.getString();
431 } else if (token == "label") {
433 // kept for backwards compability. Delete in 0.13.x
434 } else if (token == "angle") {
436 params.rotateAngle = lex.getFloat();
437 } else if (token == "size") {
438 // Size of image on screen is ignored in InsetGraphics, just eat
446 } else if (token == "flags") {
447 InsetGraphicsParams::DisplayType tmp = InsetGraphicsParams::COLOR;
449 switch (lex.getInteger()) {
450 case 1: tmp = InsetGraphicsParams::MONOCHROME; break;
451 case 2: tmp = InsetGraphicsParams::GRAYSCALE; break;
453 params.display = tmp;
454 } else if (token == "subfigure") {
455 params.subcaption = true;
456 } else if (token == "width") {
458 params.widthResize = static_cast<InsetGraphicsParams::Resize>(lex.getInteger());
461 params.widthSize = lex.getFloat();
463 } else if (token == "height") {
465 params.heightResize = static_cast<InsetGraphicsParams::Resize>(lex.getInteger());
468 params.heightSize = lex.getFloat();
477 void formatResize(ostream & os, string const & key,
478 InsetGraphicsParams::Resize resizeType, double size)
480 switch (resizeType) {
481 case InsetGraphicsParams::DEFAULT_SIZE:
484 case InsetGraphicsParams::CM:
485 os << key << '=' << size << "cm,";
488 case InsetGraphicsParams::INCH:
489 os << key << '=' << size << "in,";
492 case InsetGraphicsParams::PERCENT_PAGE:
493 os << key << '=' << size / 100 << "\\text" << key << ',';
496 case InsetGraphicsParams::PERCENT_COLUMN:
497 os << key << '=' << size / 100 << "\\column" << key << ',';
500 case InsetGraphicsParams::SCALE:
501 os << "scale" << '=' << size << ',';
509 InsetGraphics::createLatexOptions() const
511 // Calculate the options part of the command, we must do it to a string
512 // stream since we might have a trailing comma that we would like to remove
513 // before writing it to the output stream.
514 ostringstream options;
516 formatResize(options, "width", params.widthResize, params.widthSize);
517 formatResize(options, "height", params.heightResize, params.heightSize);
519 // Make sure it's not very close to zero, a float can be effectively
520 // zero but not exactly zero.
521 if (lyx::float_equal(params.rotateAngle, 0, 0.001)) {
523 << params.rotateAngle << ',';
526 string opts = options.str().c_str();
527 opts = strip(opts, ',');
543 bool isEPS(string const & filename)
545 if (filename.empty() || !IsFileReadable(filename)) return false;
547 ifstream ifs(filename.c_str());
549 if (!ifs) return false; // Couldn't open file...
551 bool is_eps = false; // Have we recognized the file as EPS?
552 string to_find = "%!PS-Adobe-"; // The string we use to recognize
553 int const max_attempts = 500; // Maximum strings to read to attempt recognition
554 int count = 0; // Counter of attempts.
556 for (; count < max_attempts; ++count) {
558 lyxerr[Debug::INFO] << "InsetGraphics (isEPS)"
559 " End of file reached and it wasn't found to be EPS!" << endl;
564 if (str.find(to_find)) {
573 enum FileType classifyFileType(string const & filename, string const & suffix)
577 else if (suffix == "jpg" || suffix == "jpeg")
579 else if (suffix == "gif")
581 else if (suffix == "pdf")
583 else if (isEPS(filename))
589 string decideOutputImageFormat(string const & suffix, enum FileType type)
591 // lyxrc.pdf_mode means:
592 // Are we creating a PDF or a PS file?
593 // (Should actually mean, are we using latex or pdflatex).
595 if (lyxrc.pdf_mode) {
596 if (type == EPS || type == EPS || type == PDF)
598 else if (type == JPEG)
604 // If it's postscript, we always do eps.
605 // There are many suffixes that are actually EPS (ask Garst for example)
606 // so we detect if it's an EPS by looking in the file, if it is, we return
607 // the same suffix of the file so it won't be converted.
617 InsetGraphics::prepareFile(Buffer const *buf) const
620 // do_convert = Do we need to convert the file?
621 // nice = Do we create a nice version?
622 // This is used when exporting the latex file only.
626 // return original filename
629 // convert_place = temp directory
630 // return new filename in temp directory
632 // convert_place = original file directory
633 // return original filename without the extension
636 // Get the extension (format) of the original file.
637 string const extension = GetExtension(params.filename);
638 FileType type = classifyFileType(params.filename, extension);
640 // Are we creating a PDF or a PS file?
641 // (Should actually mean, are we usind latex or pdflatex).
642 string const image_target = decideOutputImageFormat(extension, type);
644 if (extension == image_target)
645 return params.filename;
648 if (!buf->niceFile) {
649 string const temp = AddName(buf->tmppath, params.filename);
650 outfile = RemoveExtension(temp);
652 //lyxerr << "buf::tmppath = " << buf->tmppath << "\n";
653 //lyxerr << "filename = " << params.filename << "\n";
654 //lyxerr << "temp = " << temp << "\n";
655 //lyxerr << "outfile = " << outfile << endl;
657 string const path = OnlyPath(buf->fileName());
658 string const relname = MakeRelPath(params.filename, path);
659 outfile = RemoveExtension(relname);
662 converters.convert(buf, params.filename, outfile, extension, image_target);
668 int InsetGraphics::latex(Buffer const *buf, ostream & os,
669 bool /*fragile*/, bool/*fs*/) const
671 // MISSING: We have to decide how to do the order of the options
672 // that is dependent of order, like width, height, angle. Should
673 // we rotate before scale? Should we let the user decide?
674 // bool rot_before_scale; ?
676 // (BE) As a first step we should do a scale before rotate since this is
677 // more like the natural thought of how to do it.
678 // (BE) I believe that a priority list presented to the user with
679 // a default order would be the best, though it would be better to
680 // hide such a thing in an "Advanced options" dialog.
681 // (BE) This should go an advanced LaTeX options dialog.
683 // If there is no file specified, just output a message about it in
685 if (params.filename.empty()) {
686 os << "\\fbox{\\rule[-0.5in]{0pt}{1in}"
687 << _("empty figure path")
690 return 1; // One end of line marker added to the stream.
693 // Keep count of newlines that we issued.
696 // This variables collect all the latex code that should be before and
697 // after the actual includegraphics command.
701 // Do we want subcaptions?
702 if (params.subcaption) {
703 before += "\\subfigure[" + params.subcaptionText + "]{";
707 // We never use the starred form, we use the "clip" option instead.
708 os << before << "\\includegraphics";
710 // Write the options if there are any.
711 string const opts = createLatexOptions();
713 os << '[' << opts << ']';
716 // Make the filename relative to the lyx file
717 // and remove the extension so the LaTeX will use whatever is
718 // appropriate (when there are several versions in different formats)
719 string const filename = prepareFile(buf);
721 os << '{' << filename << '}' << after;
723 // Return how many newlines we issued.
728 int InsetGraphics::ascii(Buffer const *, ostream &, int) const
730 // No graphics in ascii output. Possible to use gifscii to convert
731 // images to ascii approximation.
733 // 1. Convert file to ascii using gifscii
734 // 2. Read ascii output file and add it to the output stream.
740 int InsetGraphics::linuxdoc(Buffer const *, ostream &) const
742 // No graphics in LinuxDoc output. Should check how/what to add.
747 // For explanation on inserting graphics into DocBook checkout:
748 // http://linuxdoc.org/LDP/LDP-Author-Guide/inserting-pictures.html
749 // See also the docbook guide at http://www.docbook.org/
750 int InsetGraphics::docbook(Buffer const * buf, ostream & os) const
752 // Change the path to be relative to the main file.
753 string const buffer_dir = OnlyPath(buf->fileName());
754 string const filename = RemoveExtension(
755 MakeRelPath(params.filename, buffer_dir));
757 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
758 // need to switch to MediaObject. However, for now this is sufficient and
760 os << "<graphic fileref=\"" << filename << "\"></graphic>";
765 void InsetGraphics::validate(LaTeXFeatures & features) const
767 // If we have no image, we should not require anything.
768 if (params.filename.empty())
771 features.graphicx = true;
773 if (params.subcaption)
774 features.subfigure = true;
778 // Update the inset after parameters changed (read from file or changed in
780 void InsetGraphics::updateInset() const
782 GraphicsCache & gc = GraphicsCache::getInstance();
783 boost::shared_ptr<GraphicsCacheItem> temp(0);
785 // We do it this way so that in the face of some error, we will still
786 // be in a valid state.
787 if (!params.filename.empty()) {
788 temp = gc.addFile(params.filename);
791 // Mark the image as unloaded so that it gets updated.
798 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
800 // If nothing is changed, just return and say so.
804 // Copy the new parameters.
807 // Update the inset with the new parameters.
810 // We have changed data, report it.
815 InsetGraphicsParams InsetGraphics::getParams() const
821 Inset * InsetGraphics::clone(Buffer const &, bool same_id) const
823 return new InsetGraphics(*this, same_id);