2 * \file InsetGraphics.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
15 * What advanced features the users want to do?
16 Implement them in a non latex dependent way, but a logical way.
17 LyX should translate it to latex or any other fitting format.
18 * When loading, if the image is not found in the expected place, try
19 to find it in the clipart, or in the same directory with the image.
20 * The image choosing dialog could show thumbnails of the image formats
21 it knows of, thus selection based on the image instead of based on
23 * Add support for the 'picins' package.
24 * Add support for the 'picinpar' package.
29 * The filename is kept in the lyx file in a relative way, so as to allow
30 * moving the document file and its images with no problem.
34 * Postscript output means EPS figures.
36 * PDF output is best done with PDF figures if it's a direct conversion
37 * or PNG figures otherwise.
49 #include "insets/InsetGraphics.h"
50 #include "insets/RenderGraphic.h"
53 #include "BufferView.h"
54 #include "Converter.h"
56 #include "DispatchResult.h"
58 #include "ErrorList.h"
61 #include "FuncRequest.h"
62 #include "FuncStatus.h"
63 #include "InsetIterator.h"
64 #include "LaTeXFeatures.h"
66 #include "MetricsInfo.h"
68 #include "OutputParams.h"
69 #include "output_docbook.h"
70 #include "output_xhtml.h"
72 #include "texstream.h"
73 #include "TocBackend.h"
75 #include "frontends/alert.h"
76 #include "frontends/Application.h"
78 #include "graphics/GraphicsCache.h"
79 #include "graphics/GraphicsCacheItem.h"
80 #include "graphics/GraphicsImage.h"
82 #include "support/convert.h"
83 #include "support/debug.h"
84 #include "support/docstream.h"
85 #include "support/ExceptionMessage.h"
86 #include "support/filetools.h"
87 #include "support/gettext.h"
88 #include "support/Length.h"
89 #include "support/lyxlib.h"
90 #include "support/lstrings.h"
91 #include "support/os.h"
92 #include "support/qstring_helpers.h"
93 #include "support/Systemcall.h"
96 #include <QtGui/QImage>
102 using namespace lyx::support;
106 namespace Alert = frontend::Alert;
110 /// Find the most suitable image format for images in \p format
111 /// Note that \p format may be unknown (i.e. an empty string)
112 string findTargetFormat(string const & format, OutputParams const & runparams)
114 // Are we latexing to DVI or PDF?
115 if (runparams.flavor == OutputParams::PDFLATEX
116 || runparams.flavor == OutputParams::XETEX
117 || runparams.flavor == OutputParams::LUATEX) {
118 LYXERR(Debug::GRAPHICS, "findTargetFormat: PDF mode");
119 Format const * const f = theFormats().getFormat(format);
120 // Convert vector graphics to pdf
121 if (f && f->vectorFormat())
123 // pdflatex can use jpeg, png and pdf directly
126 // Convert everything else to png
130 // for HTML and DocBook, we leave the known formats and otherwise convert to png
131 if (runparams.flavor == OutputParams::HTML || runparams.flavor == OutputParams::DOCBOOK5) {
132 Format const * const f = theFormats().getFormat(format);
133 // Convert vector graphics to svg
134 if (f && f->vectorFormat() && theConverters().isReachable(format, "svg"))
136 // Leave the known formats alone
137 if (format == "jpg" || format == "png" || format == "gif")
139 // Convert everything else to png
142 // If it's postscript, we always do eps.
143 LYXERR(Debug::GRAPHICS, "findTargetFormat: PostScript mode");
145 // any other than ps is changed to eps
152 void readInsetGraphics(Lexer & lex, Buffer const & buf, bool allowOrigin,
153 InsetGraphicsParams & params)
155 bool finished = false;
157 while (lex.isOK() && !finished) {
160 string const token = lex.getString();
161 LYXERR(Debug::GRAPHICS, "Token: '" << token << '\'');
166 if (token == "\\end_inset") {
169 if (!params.Read(lex, token, buf, allowOrigin))
170 lyxerr << "Unknown token, "
181 InsetGraphics::InsetGraphics(Buffer * buf)
182 : Inset(buf), graphic_label(xml::uniqueID(from_ascii("graph"))),
183 graphic_(new RenderGraphic(this))
188 InsetGraphics::InsetGraphics(InsetGraphics const & ig)
190 graphic_label(xml::uniqueID(from_ascii("graph"))),
191 graphic_(new RenderGraphic(*ig.graphic_, this))
193 setParams(ig.params());
197 Inset * InsetGraphics::clone() const
199 return new InsetGraphics(*this);
203 InsetGraphics::~InsetGraphics()
205 hideDialogs("graphics", this);
210 void InsetGraphics::doDispatch(Cursor & cur, FuncRequest & cmd)
212 switch (cmd.action()) {
213 case LFUN_INSET_EDIT: {
214 InsetGraphicsParams p = params();
215 if (!cmd.argument().empty())
216 string2params(to_utf8(cmd.argument()), buffer(), p);
221 case LFUN_INSET_MODIFY: {
222 if (cmd.getArg(0) != "graphics") {
223 Inset::doDispatch(cur, cmd);
227 InsetGraphicsParams p;
228 string2params(to_utf8(cmd.argument()), buffer(), p);
229 if (p.filename.empty()) {
230 cur.noScreenUpdate();
236 // if the inset is part of a graphics group, all the
237 // other members should be updated too.
238 if (!params_.groupId.empty())
239 graphics::unifyGraphicsGroups(buffer(),
240 to_utf8(cmd.argument()));
244 case LFUN_INSET_DIALOG_UPDATE:
245 cur.bv().updateDialog("graphics", params2string(params(), buffer()));
248 case LFUN_GRAPHICS_RELOAD:
249 params_.filename.refresh();
254 Inset::doDispatch(cur, cmd);
260 bool InsetGraphics::getStatus(Cursor & cur, FuncRequest const & cmd,
261 FuncStatus & flag) const
263 switch (cmd.action()) {
264 case LFUN_INSET_MODIFY:
265 if (cmd.getArg(0) != "graphics")
266 return Inset::getStatus(cur, cmd, flag);
268 case LFUN_INSET_EDIT:
269 case LFUN_INSET_DIALOG_UPDATE:
270 case LFUN_GRAPHICS_RELOAD:
271 flag.setEnabled(true);
275 return Inset::getStatus(cur, cmd, flag);
280 bool InsetGraphics::showInsetDialog(BufferView * bv) const
282 bv->showDialog("graphics", params2string(params(), bv->buffer()),
283 const_cast<InsetGraphics *>(this));
289 void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
291 graphic_->metrics(mi, dim);
295 void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
297 graphic_->draw(pi, x, y);
301 void InsetGraphics::write(ostream & os) const
304 params().Write(os, buffer());
308 void InsetGraphics::read(Lexer & lex)
310 lex.setContext("InsetGraphics::read");
312 readInsetGraphics(lex, buffer(), true, params_);
313 graphic_->update(params().as_grfxParams());
317 void InsetGraphics::outBoundingBox(graphics::BoundingBox & bbox) const
322 FileName const file(params().filename.absFileName());
324 // No correction is necessary for a vector image
325 bool const zipped = theFormats().isZippedFile(file);
326 FileName const unzipped_file = zipped ? unzipFile(file) : file;
327 string const format = theFormats().getFormatFromFile(unzipped_file);
329 unzipped_file.removeFile();
330 if (theFormats().getFormat(format)->vectorFormat())
333 // Get the actual image dimensions in pixels
336 graphics::Cache & gc = graphics::Cache::get();
337 if (gc.inCache(file)) {
338 graphics::Image const * image = gc.item(file)->image();
340 width = image->width();
341 height = image->height();
344 // Even if cached, the image is not loaded without GUI
345 if (width == 0 && height == 0) {
346 QImage image(toqstr(file.absFileName()));
347 width = image.width();
348 height = image.height();
350 if (width == 0 || height == 0)
353 // Use extractbb to find the dimensions in the typeset output
355 extractbb.start("extractbb", QStringList() << "-O" << toqstr(file.absFileName()));
356 if (!extractbb.waitForStarted() || !extractbb.waitForFinished()) {
357 LYXERR0("Cannot read output bounding box of " << file);
361 string const result = extractbb.readAll().constData();
362 size_t i = result.find("%%BoundingBox:");
363 if (i == string::npos) {
364 LYXERR0("Cannot find output bounding box of " << file);
368 string const bb = result.substr(i);
369 int out_width = convert<int>(token(bb, ' ', 3));
370 int out_height = convert<int>(token(bb, ' ', 4));
372 // Compute the scaling ratio and correct the bounding box
373 double scalex = out_width / double(width);
374 double scaley = out_height / double(height);
376 bbox.xl.value(scalex * bbox.xl.value());
377 bbox.xr.value(scalex * bbox.xr.value());
378 bbox.yb.value(scaley * bbox.yb.value());
379 bbox.yt.value(scaley * bbox.yt.value());
383 string InsetGraphics::createLatexOptions(bool const ps) const
385 // Calculate the options part of the command, we must do it to a string
386 // stream since we might have a trailing comma that we would like to remove
387 // before writing it to the output stream.
388 ostringstream options;
389 if (!params().bbox.empty()) {
390 graphics::BoundingBox out_bbox = params().bbox;
391 outBoundingBox(out_bbox);
392 string const key = ps ? "bb=" : "viewport=";
393 options << key << out_bbox.xl.asLatexString() << ' '
394 << out_bbox.yb.asLatexString() << ' '
395 << out_bbox.xr.asLatexString() << ' '
396 << out_bbox.yt.asLatexString() << ',';
403 double const scl = convert<double>(params().scale);
404 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
405 if (!float_equal(scl, 100.0, 0.05))
406 size << "scale=" << scl / 100.0 << ',';
408 if (!params().width.zero())
409 size << "width=" << params().width.asLatexString() << ',';
410 if (!params().height.zero())
411 size << "totalheight=" << params().height.asLatexString() << ',';
412 if (params().keepAspectRatio)
413 size << "keepaspectratio,";
415 if (params().scaleBeforeRotation && !size.str().empty())
416 options << size.str();
418 // Make sure rotation angle is not very close to zero;
419 // a float can be effectively zero but not exactly zero.
420 if (!params().rotateAngle.empty()
421 && !float_equal(convert<double>(params().rotateAngle), 0.0, 0.001)) {
422 options << "angle=" << params().rotateAngle << ',';
423 if (!params().rotateOrigin.empty()) {
424 options << "origin=" << params().rotateOrigin[0];
425 if (contains(params().rotateOrigin,"Top"))
427 else if (contains(params().rotateOrigin,"Bottom"))
429 else if (contains(params().rotateOrigin,"Baseline"))
434 if (!params().scaleBeforeRotation && !size.str().empty())
435 options << size.str();
437 if (!params().special.empty())
438 options << params().special << ',';
440 string opts = options.str();
442 if (suffixIs(opts, ','))
443 opts = opts.substr(0, opts.size() - 1);
449 docstring InsetGraphics::toDocbookLength(Length const & len) const
451 odocstringstream result;
452 switch (len.unit()) {
453 case Length::SP: // Scaled point (65536sp = 1pt) TeX's smallest unit.
454 result << len.value() * 65536.0 * 72 / 72.27 << "pt";
456 case Length::PT: // Point = 1/72.27in = 0.351mm
457 result << len.value() * 72 / 72.27 << "pt";
459 case Length::BP: // Big point (72bp = 1in), also PostScript point
460 result << len.value() << "pt";
462 case Length::DD: // Didot point = 1/72 of a French inch, = 0.376mm
463 result << len.value() * 0.376 << "mm";
465 case Length::MM: // Millimeter = 2.845pt
466 result << len.value() << "mm";
468 case Length::PC: // Pica = 12pt = 4.218mm
469 result << len.value() << "pc";
471 case Length::CC: // Cicero = 12dd = 4.531mm
472 result << len.value() * 4.531 << "mm";
474 case Length::CM: // Centimeter = 10mm = 2.371pc
475 result << len.value() << "cm";
477 case Length::IN: // Inch = 25.4mm = 72.27pt = 6.022pc
478 result << len.value() << "in";
480 case Length::EX: // Height of a small "x" for the current font.
481 // Obviously we have to compromise here. Any better ratio than 1.5 ?
482 result << len.value() / 1.5 << "em";
484 case Length::EM: // Width of capital "M" in current font.
485 result << len.value() << "em";
487 case Length::MU: // Math unit (18mu = 1em) for positioning in math mode
488 result << len.value() * 18 << "em";
490 case Length::PTW: // Percent of TextWidth
491 case Length::PCW: // Percent of ColumnWidth
492 case Length::PPW: // Percent of PageWidth
493 case Length::PLW: // Percent of LineWidth
494 case Length::PTH: // Percent of TextHeight
495 case Length::PPH: // Percent of PaperHeight
496 case Length::BLS: // Percent of BaselineSkip
497 // Sigh, this will go wrong.
498 result << len.value() << "%";
501 result << len.asDocstring();
508 docstring InsetGraphics::createDocBookAttributes() const
510 // Calculate the options part of the command, we must do it to a string
511 // stream since we copied the code from createLatexParams() ;-)
513 odocstringstream options;
514 auto const scl = convert<double>(params().scale);
515 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
516 if (!float_equal(scl, 100.0, 0.05))
517 options << " scale=\""
518 << support::iround(scl)
521 if (!params().width.zero())
522 options << " width=\"" << toDocbookLength(params().width) << "\" ";
523 if (!params().height.zero())
524 options << " depth=\"" << toDocbookLength(params().height) << "\" ";
525 if (params().keepAspectRatio)
526 // This will be irrelevant unless both width and height are set
527 options << "scalefit=\"1\" ";
530 // TODO: parse params().special?
532 // trailing blanks are ok ...
533 return options.str();
539 enum GraphicsCopyStatus {
547 pair<GraphicsCopyStatus, FileName> const
548 copyFileIfNeeded(FileName const & file_in, FileName const & file_out)
550 LYXERR(Debug::FILES, "Comparing " << file_in << " and " << file_out);
551 unsigned long const checksum_in = file_in.checksum();
552 unsigned long const checksum_out = file_out.checksum();
554 if (checksum_in == checksum_out)
556 return make_pair(IDENTICAL_CONTENTS, file_out);
558 Mover const & mover = getMover(theFormats().getFormatFromFile(file_in));
559 bool const success = mover.copy(file_in, file_out);
562 LYXERR(Debug::GRAPHICS,
563 to_utf8(bformat(_("Could not copy the file\n%1$s\n"
564 "into the temporary directory."),
565 from_utf8(file_in.absFileName()))));
568 GraphicsCopyStatus status = success ? SUCCESS : FAILURE;
569 return make_pair(status, file_out);
573 pair<GraphicsCopyStatus, FileName> const
574 copyToDirIfNeeded(DocFileName const & file, string const & dir)
576 string const file_in = file.absFileName();
577 string const only_path = onlyPath(file_in);
578 if (rtrim(only_path, "/") == rtrim(dir, "/"))
579 return make_pair(IDENTICAL_PATHS, FileName(file_in));
581 string mangled = file.mangledFileName(empty_string(), false, true);
582 if (theFormats().isZippedFile(file)) {
583 // We need to change _eps.gz to .eps.gz. The mangled name is
584 // still unique because of the counter in mangledFileName().
585 // We can't just call mangledFileName() with the zip
586 // extension removed, because base.eps and base.eps.gz may
587 // have different content but would get the same mangled
588 // name in this case.
589 // Also take into account that if the name of the zipped file
590 // has no zip extension then the name of the unzipped one is
591 // prefixed by "unzipped_".
592 string const base = removeExtension(file.unzippedFileName());
593 string::size_type const prefix_len =
594 prefixIs(onlyFileName(base), "unzipped_") ? 9 : 0;
595 string::size_type const ext_len =
596 file_in.length() + prefix_len - base.length();
597 mangled[mangled.length() - ext_len] = '.';
599 FileName const file_out(makeAbsPath(mangled, dir));
601 return copyFileIfNeeded(file, file_out);
605 string const stripExtensionIfPossible(string const & file, bool nice)
607 // Remove the extension so the LaTeX compiler will use whatever
608 // is appropriate (when there are several versions in different
610 // Do this only if we are not exporting for internal usage, because
611 // pdflatex prefers png over pdf and it would pick up the png images
612 // that we generate for preview.
613 // This works only if the filename contains no dots besides
614 // the just removed one. We can fool here by replacing all
615 // dots with a macro whose definition is just a dot ;-)
616 // The automatic format selection does not work if the file
618 string const latex_name = latex_path(file, EXCLUDE_EXTENSION);
619 if (!nice || contains(latex_name, '"'))
621 return latex_path(removeExtension(file), PROTECT_EXTENSION, ESCAPE_DOTS);
625 string const stripExtensionIfPossible(string const & file, string const & to, bool nice)
627 // No conversion is needed. LaTeX can handle the graphic file as is.
628 // This is true even if the orig_file is compressed.
629 Format const * f = theFormats().getFormat(to);
631 return latex_path(file, EXCLUDE_EXTENSION);
632 string const to_format = f->extension();
633 string const file_format = getExtension(file);
634 // for latex .ps == .eps
635 if (to_format == file_format ||
636 (to_format == "eps" && file_format == "ps") ||
637 (to_format == "ps" && file_format == "eps"))
638 return stripExtensionIfPossible(file, nice);
639 return latex_path(file, EXCLUDE_EXTENSION);
645 string InsetGraphics::prepareFile(OutputParams const & runparams) const
647 // The following code depends on non-empty filenames
648 if (params().filename.empty())
651 string const orig_file = params().filename.absFileName();
652 // this is for dryrun and display purposes, do not use latexFilename
653 string const rel_file = params().filename.relFileName(buffer().filePath());
655 // previewing source code, no file copying or file format conversion
656 if (runparams.dryrun)
657 return stripExtensionIfPossible(rel_file, runparams.nice);
659 // The master buffer. This is useful when there are multiple levels
661 Buffer const * masterBuffer = buffer().masterBuffer();
663 // Return the output name if we are inside a comment or the file does
665 // We are not going to change the extension or using the name of the
666 // temporary file, the code is already complicated enough.
667 if (runparams.inComment || !params().filename.isReadableFile())
668 return params().filename.outputFileName(masterBuffer->filePath());
670 // We place all temporary files in the master buffer's temp dir.
671 // This is possible because we use mangled file names.
672 // This is necessary for DVI export.
673 string const temp_path = masterBuffer->temppath();
675 // temp_file will contain the file for LaTeX to act on if, for example,
676 // we move it to a temp dir or uncompress it.
678 GraphicsCopyStatus status;
679 tie(status, temp_file) = copyToDirIfNeeded(params().filename, temp_path);
681 if (status == FAILURE)
684 // a relative filename should be relative to the master buffer.
685 // "nice" means that the buffer is exported to LaTeX format but not
686 // run through the LaTeX compiler.
687 string output_file = runparams.nice ?
688 params().filename.outputFileName(masterBuffer->filePath()) :
689 onlyFileName(temp_file.absFileName());
691 if (runparams.nice) {
692 if (!isValidLaTeXFileName(output_file)) {
693 frontend::Alert::warning(_("Invalid filename"),
694 _("The following filename will cause troubles "
695 "when running the exported file through LaTeX: ") +
696 from_utf8(output_file));
698 // only show DVI-specific warning when export format is plain latex
699 if (!isValidDVIFileName(output_file)
700 && runparams.flavor == OutputParams::LATEX) {
701 frontend::Alert::warning(_("Problematic filename for DVI"),
702 _("The following filename can cause troubles "
703 "when running the exported file through LaTeX "
704 "and opening the resulting DVI: ") +
705 from_utf8(output_file), true);
709 FileName source_file = runparams.nice ? FileName(params().filename) : temp_file;
710 // determine the export format
711 string const tex_format = flavor2format(runparams.flavor);
713 if (theFormats().isZippedFile(params().filename)) {
714 FileName const unzipped_temp_file =
715 FileName(unzippedFileName(temp_file.absFileName()));
716 output_file = unzippedFileName(output_file);
717 source_file = FileName(unzippedFileName(source_file.absFileName()));
718 if (compare_timestamps(unzipped_temp_file, temp_file) > 0) {
719 // temp_file has been unzipped already and
720 // orig_file has not changed in the meantime.
721 temp_file = unzipped_temp_file;
722 LYXERR(Debug::GRAPHICS, "\twas already unzipped to " << temp_file);
724 // unzipped_temp_file does not exist or is too old
725 temp_file = unzipFile(temp_file);
726 LYXERR(Debug::GRAPHICS, "\tunzipped to " << temp_file);
730 string const from = theFormats().getFormatFromFile(temp_file);
732 LYXERR(Debug::GRAPHICS, "\tCould not get file format.");
734 string const to = findTargetFormat(from, runparams);
735 string const ext = theFormats().extension(to);
736 LYXERR(Debug::GRAPHICS, "\t we have: from " << from << " to " << to);
738 // We're going to be running the exported buffer through the LaTeX
739 // compiler, so must ensure that LaTeX can cope with the graphics
742 LYXERR(Debug::GRAPHICS, "\tthe orig file is: " << orig_file);
745 // source and destination formats are the same
746 if (!runparams.nice && !FileName(temp_file).hasExtension(ext)) {
747 // The LaTeX compiler will not be able to determine
748 // the file format from the extension, so we must
750 FileName const new_file =
751 FileName(changeExtension(temp_file.absFileName(), ext));
752 if (temp_file.moveTo(new_file)) {
753 temp_file = new_file;
754 output_file = changeExtension(output_file, ext);
756 FileName(changeExtension(source_file.absFileName(), ext));
758 LYXERR(Debug::GRAPHICS, "Could not rename file `"
759 << temp_file << "' to `" << new_file << "'.");
762 // The extension of temp_file might be != ext!
763 runparams.exportdata->addExternalFile(tex_format, source_file,
765 runparams.exportdata->addExternalFile("dvi", source_file,
767 return stripExtensionIfPossible(output_file, to, runparams.nice);
770 // so the source and destination formats are different
771 FileName const to_file = FileName(changeExtension(temp_file.absFileName(), ext));
772 string const output_to_file = changeExtension(output_file, ext);
774 // Do we need to perform the conversion?
775 // Yes if to_file does not exist or if temp_file is newer than to_file
776 if (compare_timestamps(temp_file, to_file) < 0) {
778 LYXERR(Debug::GRAPHICS,
779 to_utf8(bformat(_("No conversion of %1$s is needed after all"),
780 from_utf8(rel_file))));
781 runparams.exportdata->addExternalFile(tex_format, to_file,
783 runparams.exportdata->addExternalFile("dvi", to_file,
785 return stripExtensionIfPossible(output_to_file, runparams.nice);
788 LYXERR(Debug::GRAPHICS,"\tThe original file is " << orig_file << "\n"
789 << "\tA copy has been made and convert is to be called with:\n"
790 << "\tfile to convert = " << temp_file << '\n'
791 << "\t from " << from << " to " << to);
793 // FIXME (Abdel 12/08/06): Is there a need to show these errors?
795 Converters::RetVal const rv =
796 theConverters().convert(&buffer(), temp_file, to_file, params().filename,
798 Converters::try_default | Converters::try_cache);
799 if (rv == Converters::KILLED) {
800 LYXERR0("Graphics preparation killed.");
801 if (buffer().isClone() && buffer().isExporting())
802 throw ConversionException();
803 } else if (rv == Converters::SUCCESS) {
804 runparams.exportdata->addExternalFile(tex_format,
805 to_file, output_to_file);
806 runparams.exportdata->addExternalFile("dvi",
807 to_file, output_to_file);
810 return stripExtensionIfPossible(output_to_file, runparams.nice);
814 void InsetGraphics::latex(otexstream & os,
815 OutputParams const & runparams) const
817 // If there is no file specified or not existing,
818 // just output a message about it in the latex output.
819 LYXERR(Debug::GRAPHICS, "insetgraphics::latex: Filename = "
820 << params().filename.absFileName());
822 bool const file_exists = !params().filename.empty()
823 && params().filename.isReadableFile();
826 if (params().bbox.empty())
827 message = "bb = 0 0 200 100";
828 if (!params().draft) {
829 if (!message.empty())
833 if (!message.empty())
835 message += "type=eps";
837 // If no existing file "filename" was found LaTeX
838 // draws only a rectangle with the above bb and the
839 // not found filename in it.
840 LYXERR(Debug::GRAPHICS, "\tMessage = \"" << message << '\"');
842 // These variables collect all the latex code that should be before and
843 // after the actual includegraphics command.
847 // Write the options if there are any.
848 bool const ps = runparams.flavor == OutputParams::LATEX
849 || runparams.flavor == OutputParams::DVILUATEX;
850 string const opts = createLatexOptions(ps);
851 LYXERR(Debug::GRAPHICS, "\tOpts = " << opts);
853 if (contains(opts, '=') && contains(runparams.active_chars, '=')) {
854 // We have a language that makes = active. Deactivate locally
855 // for keyval option parsing (#2005).
856 before = "\\begingroup\\catcode`\\=12";
857 after = "\\endgroup ";
860 if (runparams.moving_arg)
861 before += "\\protect";
863 // We never use the starred form, we use the "clip" option instead.
864 before += "\\includegraphics";
866 if (!opts.empty() && !message.empty())
867 before += ('[' + opts + ',' + message + ']');
868 else if (!opts.empty() || !message.empty())
869 before += ('[' + opts + message + ']');
871 LYXERR(Debug::GRAPHICS, "\tBefore = " << before << "\n\tafter = " << after);
873 string latex_str = before + '{';
874 // Convert the file if necessary.
875 // Remove the extension so LaTeX will use whatever is appropriate
876 // (when there are several versions in different formats)
877 docstring file_path = from_utf8(prepareFile(runparams));
878 // we can only output characters covered by the current
881 docstring encodable_file_path;
882 for (char_type c : file_path) {
884 if (runparams.encoding->encodable(c))
885 encodable_file_path += c;
886 else if (runparams.dryrun) {
887 encodable_file_path += "<" + _("LyX Warning: ")
888 + _("uncodable character") + " '";
889 encodable_file_path += docstring(1, c);
890 encodable_file_path += "'>";
893 } catch (EncodingException & /* e */) {
894 if (runparams.dryrun) {
895 encodable_file_path += "<" + _("LyX Warning: ")
896 + _("uncodable character") + " '";
897 encodable_file_path += docstring(1, c);
898 encodable_file_path += "'>";
903 if (!uncodable.empty() && !runparams.silent) {
904 // issue a warning about omitted characters
905 // FIXME: should be passed to the error dialog
906 frontend::Alert::warning(_("Uncodable character in file path"),
907 bformat(_("The following characters in one of the graphic paths are\n"
908 "not representable in the current encoding and have been omitted: %1$s.\n"
909 "You need to adapt either the encoding or the path."),
912 latex_str += to_utf8(encodable_file_path);
913 latex_str += '}' + after;
915 os << from_utf8(latex_str);
917 LYXERR(Debug::GRAPHICS, "InsetGraphics::latex outputting:\n" << latex_str);
921 int InsetGraphics::plaintext(odocstringstream & os,
922 OutputParams const &, size_t) const
924 // No graphics in ascii output. Possible to use gifscii to convert
925 // images to ascii approximation.
926 // 1. Convert file to ascii using gifscii
927 // 2. Read ascii output file and add it to the output stream.
928 // at least we send the filename
930 // FIXME: We have no idea what the encoding of the filename is
932 docstring const str = bformat(buffer().B_("Graphics file: %1$s"),
933 from_utf8(params().filename.absFileName()));
934 os << '<' << str << '>';
936 return 2 + str.size();
940 // For explanation on inserting graphics into DocBook checkout:
941 // http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
942 // See also the docbook guide at http://www.docbook.org/
943 void InsetGraphics::docbook(XMLStream & xs, OutputParams const & runparams) const
945 string fn = params().filename.relFileName(runparams.export_folder);
946 string tag = runparams.docbook_in_float ? "mediaobject" : "inlinemediaobject";
948 xs << xml::StartTag(tag);
950 xs << xml::StartTag("imageobject");
952 xs << xml::CompTag("imagedata", "fileref=\"" + fn + "\" " + to_utf8(createDocBookAttributes()));
954 xs << xml::EndTag("imageobject");
956 xs << xml::EndTag(tag);
961 string InsetGraphics::prepareHTMLFile(OutputParams const & runparams) const
963 // The following code depends on non-empty filenames
964 if (params().filename.empty())
967 if (!params().filename.isReadableFile())
970 // The master buffer. This is useful when there are multiple levels
972 Buffer const * masterBuffer = buffer().masterBuffer();
974 // We place all temporary files in the master buffer's temp dir.
975 // This is possible because we use mangled file names.
976 // FIXME We may want to put these files in some special temporary
978 string const temp_path = masterBuffer->temppath();
980 // Copy to temporary directory.
982 GraphicsCopyStatus status;
983 tie(status, temp_file) = copyToDirIfNeeded(params().filename, temp_path);
985 if (status == FAILURE)
988 string const from = theFormats().getFormatFromFile(temp_file);
990 LYXERR(Debug::GRAPHICS, "\tCould not get file format.");
994 string const to = findTargetFormat(from, runparams);
995 string const ext = theFormats().extension(to);
996 string const orig_file = params().filename.absFileName();
997 string output_file = onlyFileName(temp_file.absFileName());
998 LYXERR(Debug::GRAPHICS, "\t we have: from " << from << " to " << to);
999 LYXERR(Debug::GRAPHICS, "\tthe orig file is: " << orig_file);
1002 // source and destination formats are the same
1003 runparams.exportdata->addExternalFile("xhtml", temp_file, output_file);
1007 // so the source and destination formats are different
1008 FileName const to_file = FileName(changeExtension(temp_file.absFileName(), ext));
1009 string const output_to_file = changeExtension(output_file, ext);
1011 // Do we need to perform the conversion?
1012 // Yes if to_file does not exist or if temp_file is newer than to_file
1013 if (compare_timestamps(temp_file, to_file) < 0) {
1015 LYXERR(Debug::GRAPHICS,
1016 to_utf8(bformat(_("No conversion of %1$s is needed after all"),
1017 from_utf8(orig_file))));
1018 runparams.exportdata->addExternalFile("xhtml", to_file, output_to_file);
1019 return output_to_file;
1022 LYXERR(Debug::GRAPHICS,"\tThe original file is " << orig_file << "\n"
1023 << "\tA copy has been made and convert is to be called with:\n"
1024 << "\tfile to convert = " << temp_file << '\n'
1025 << "\t from " << from << " to " << to);
1027 // FIXME (Abdel 12/08/06): Is there a need to show these errors?
1029 Converters::RetVal const rv =
1030 theConverters().convert(&buffer(), temp_file, to_file, params().filename,
1031 from, to, el, Converters::try_default | Converters::try_cache);
1032 if (rv == Converters::KILLED) {
1033 if (buffer().isClone() && buffer().isExporting())
1034 throw ConversionException();
1037 if (rv != Converters::SUCCESS)
1039 runparams.exportdata->addExternalFile("xhtml", to_file, output_to_file);
1040 return output_to_file;
1044 docstring InsetGraphics::xhtml(XMLStream & xs, OutputParams const & op) const
1046 string const output_file = op.dryrun ? string() : prepareHTMLFile(op);
1048 if (output_file.empty() && !op.dryrun) {
1049 LYXERR0("InsetGraphics::xhtml: Unable to prepare file `"
1050 << params().filename << "' for output. File missing?");
1051 string const attr = "src='" + params().filename.absFileName()
1052 + "' alt='image: " + output_file + "'";
1053 xs << xml::CompTag("img", attr);
1058 // We aren't doing anything with the crop and rotate parameters, and it would
1059 // really be better to do width and height conversion, rather than to output
1060 // these parameters here.
1062 bool const havewidth = !params().width.zero();
1063 bool const haveheight = !params().height.zero();
1064 if (havewidth || haveheight) {
1066 imgstyle += "width:" + params().width.asHTMLString() + ";";
1068 imgstyle += " height:" + params().height.asHTMLString() + ";";
1069 } else if (params().scale != "100") {
1070 // Note that this will not have the same effect as in LaTeX export:
1071 // There, the image will be scaled from its original size. Here, the
1072 // percentage will be interpreted by the browser, and the image will
1073 // be scaled to a percentage of the window size.
1074 imgstyle = "width:" + params().scale + "%;";
1076 if (!imgstyle.empty())
1077 imgstyle = "style='" + imgstyle + "' ";
1079 string const attr = imgstyle + "src='" + output_file + "' alt='image: "
1080 + output_file + "'";
1081 xs << xml::CompTag("img", attr);
1086 void InsetGraphics::validate(LaTeXFeatures & features) const
1088 // If we have no image, we should not require anything.
1089 if (params().filename.empty())
1092 features.includeFile(graphic_label,
1093 removeExtension(params().filename.absFileName()));
1095 features.require("graphicx");
1097 if (features.runparams().nice) {
1098 string const rel_file = params().filename.onlyFileNameWithoutExt();
1099 if (contains(rel_file, "."))
1100 features.require("lyxdot");
1102 if (features.inDeletedInset()) {
1103 features.require("tikz");
1104 features.require("ct-tikz-object-sout");
1109 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
1111 // If nothing is changed, just return and say so.
1112 if (params() == p && !p.filename.empty())
1115 // Copy the new parameters.
1118 // Update the display using the new parameters.
1119 graphic_->update(params().as_grfxParams());
1121 // We have changed data, report it.
1126 InsetGraphicsParams const & InsetGraphics::params() const
1132 void InsetGraphics::editGraphics(InsetGraphicsParams const & p) const
1134 theFormats().edit(buffer(), p.filename,
1135 theFormats().getFormatFromFile(p.filename));
1139 void InsetGraphics::addToToc(DocIterator const & cpit, bool output_active,
1140 UpdateType, TocBackend & backend) const
1143 docstring const str = from_utf8(params_.filename.onlyFileName());
1144 TocBuilder & b = backend.builder("graphics");
1145 b.pushItem(cpit, str, output_active);
1150 string InsetGraphics::contextMenuName() const
1152 return "context-graphics";
1156 void InsetGraphics::string2params(string const & in, Buffer const & buffer,
1157 InsetGraphicsParams & params)
1162 istringstream data(in);
1164 lex.setStream(data);
1165 lex.setContext("InsetGraphics::string2params");
1167 params = InsetGraphicsParams();
1168 readInsetGraphics(lex, buffer, false, params);
1172 string InsetGraphics::params2string(InsetGraphicsParams const & params,
1173 Buffer const & buffer)
1176 data << "graphics" << ' ';
1177 params.Write(data, buffer);
1178 data << "\\end_inset\n";
1183 docstring InsetGraphics::toolTip(BufferView const &, int, int) const
1185 return from_utf8(params().filename.onlyFileName());
1188 namespace graphics {
1190 void getGraphicsGroups(Buffer const & b, set<string> & ids)
1192 for (Inset const & it : b.inset()) {
1193 InsetGraphics const * ins = it.asInsetGraphics();
1196 InsetGraphicsParams const & inspar = ins->getParams();
1197 if (!inspar.groupId.empty())
1198 ids.insert(inspar.groupId);
1203 int countGroupMembers(Buffer const & b, string const & groupId)
1206 if (groupId.empty())
1208 for (Inset const & it : b.inset()) {
1209 InsetGraphics const * ins = it.asInsetGraphics();
1212 if (ins->getParams().groupId == groupId)
1219 string getGroupParams(Buffer const & b, string const & groupId)
1221 if (groupId.empty())
1223 for (Inset const & it : b.inset()) {
1224 InsetGraphics const * ins = it.asInsetGraphics();
1227 InsetGraphicsParams const & inspar = ins->getParams();
1228 if (inspar.groupId == groupId) {
1229 InsetGraphicsParams tmp = inspar;
1230 tmp.filename.erase();
1231 return InsetGraphics::params2string(tmp, b);
1238 void unifyGraphicsGroups(Buffer & b, string const & argument)
1240 InsetGraphicsParams params;
1241 InsetGraphics::string2params(argument, b, params);
1243 // This handles undo groups automagically
1244 UndoGroupHelper ugh(&b);
1245 Inset & inset = b.inset();
1246 InsetIterator it = begin(inset);
1247 InsetIterator const itend = end(inset);
1248 for (; it != itend; ++it) {
1249 InsetGraphics * ins = it->asInsetGraphics();
1252 InsetGraphicsParams const & inspar = ins->getParams();
1253 if (params.groupId == inspar.groupId) {
1254 CursorData(it).recordUndo();
1255 params.filename = inspar.filename;
1256 ins->setParams(params);
1262 InsetGraphics * getCurrentGraphicsInset(Cursor const & cur)
1264 Inset * instmp = &cur.inset();
1265 if (!instmp->asInsetGraphics())
1266 instmp = cur.nextInset();
1267 if (!instmp || !instmp->asInsetGraphics())
1270 return instmp->asInsetGraphics();
1273 } // namespace graphics