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"
57 #include "ErrorList.h"
60 #include "FuncRequest.h"
61 #include "FuncStatus.h"
62 #include "InsetIterator.h"
63 #include "LaTeXFeatures.h"
66 #include "MetricsInfo.h"
68 #include "OutputParams.h"
69 #include "output_xhtml.h"
71 #include "texstream.h"
72 #include "TocBackend.h"
74 #include "frontends/alert.h"
75 #include "frontends/Application.h"
77 #include "support/convert.h"
78 #include "support/debug.h"
79 #include "support/docstream.h"
80 #include "support/ExceptionMessage.h"
81 #include "support/filetools.h"
82 #include "support/gettext.h"
83 #include "support/lyxlib.h"
84 #include "support/lstrings.h"
85 #include "support/os.h"
86 #include "support/Systemcall.h"
93 using namespace lyx::support;
97 namespace Alert = frontend::Alert;
101 /// Find the most suitable image format for images in \p format
102 /// Note that \p format may be unknown (i. e. an empty string)
103 string findTargetFormat(string const & format, OutputParams const & runparams)
105 // Are we using latex or XeTeX/LuaTeX/pdflatex?
106 if (runparams.flavor == OutputParams::PDFLATEX
107 || runparams.flavor == OutputParams::XETEX
108 || runparams.flavor == OutputParams::LUATEX) {
109 LYXERR(Debug::GRAPHICS, "findTargetFormat: PDF mode");
110 Format const * const f = theFormats().getFormat(format);
111 // Convert vector graphics to pdf
112 if (f && f->vectorFormat())
114 // pdflatex can use jpeg, png and pdf directly
117 // Convert everything else to png
120 // for HTML, we leave the known formats and otherwise convert to png
121 if (runparams.flavor == OutputParams::HTML) {
122 Format const * const f = theFormats().getFormat(format);
123 // Convert vector graphics to svg
124 if (f && f->vectorFormat() && theConverters().isReachable(format, "svg"))
126 // Leave the known formats alone
127 if (format == "jpg" || format == "png" || format == "gif")
129 // Convert everything else to png
132 // If it's postscript, we always do eps.
133 LYXERR(Debug::GRAPHICS, "findTargetFormat: PostScript mode");
135 // any other than ps is changed to eps
142 void readInsetGraphics(Lexer & lex, Buffer const & buf, bool allowOrigin,
143 InsetGraphicsParams & params)
145 bool finished = false;
147 while (lex.isOK() && !finished) {
150 string const token = lex.getString();
151 LYXERR(Debug::GRAPHICS, "Token: '" << token << '\'');
156 if (token == "\\end_inset") {
159 if (!params.Read(lex, token, buf, allowOrigin))
160 lyxerr << "Unknown token, "
171 InsetGraphics::InsetGraphics(Buffer * buf)
172 : Inset(buf), graphic_label(sgml::uniqueID(from_ascii("graph"))),
173 graphic_(new RenderGraphic(this))
178 InsetGraphics::InsetGraphics(InsetGraphics const & ig)
180 graphic_label(sgml::uniqueID(from_ascii("graph"))),
181 graphic_(new RenderGraphic(*ig.graphic_, this))
183 setParams(ig.params());
187 Inset * InsetGraphics::clone() const
189 return new InsetGraphics(*this);
193 InsetGraphics::~InsetGraphics()
195 hideDialogs("graphics", this);
200 void InsetGraphics::doDispatch(Cursor & cur, FuncRequest & cmd)
202 switch (cmd.action()) {
203 case LFUN_INSET_EDIT: {
204 InsetGraphicsParams p = params();
205 if (!cmd.argument().empty())
206 string2params(to_utf8(cmd.argument()), buffer(), p);
211 case LFUN_INSET_MODIFY: {
212 if (cmd.getArg(0) != "graphics") {
213 Inset::doDispatch(cur, cmd);
217 InsetGraphicsParams p;
218 string2params(to_utf8(cmd.argument()), buffer(), p);
219 if (p.filename.empty()) {
220 cur.noScreenUpdate();
226 // if the inset is part of a graphics group, all the
227 // other members should be updated too.
228 if (!params_.groupId.empty())
229 graphics::unifyGraphicsGroups(buffer(),
230 to_utf8(cmd.argument()));
234 case LFUN_INSET_DIALOG_UPDATE:
235 cur.bv().updateDialog("graphics", params2string(params(), buffer()));
238 case LFUN_GRAPHICS_RELOAD:
239 params_.filename.refresh();
244 Inset::doDispatch(cur, cmd);
250 bool InsetGraphics::getStatus(Cursor & cur, FuncRequest const & cmd,
251 FuncStatus & flag) const
253 switch (cmd.action()) {
254 case LFUN_INSET_MODIFY:
255 if (cmd.getArg(0) != "graphics")
256 return Inset::getStatus(cur, cmd, flag);
258 case LFUN_INSET_EDIT:
259 case LFUN_INSET_DIALOG_UPDATE:
260 case LFUN_GRAPHICS_RELOAD:
261 flag.setEnabled(true);
265 return Inset::getStatus(cur, cmd, flag);
270 bool InsetGraphics::showInsetDialog(BufferView * bv) const
272 bv->showDialog("graphics", params2string(params(), bv->buffer()),
273 const_cast<InsetGraphics *>(this));
279 void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
281 graphic_->metrics(mi, dim);
285 void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
287 graphic_->draw(pi, x, y);
291 void InsetGraphics::write(ostream & os) const
294 params().Write(os, buffer());
298 void InsetGraphics::read(Lexer & lex)
300 lex.setContext("InsetGraphics::read");
302 readInsetGraphics(lex, buffer(), true, params_);
303 graphic_->update(params().as_grfxParams());
307 string InsetGraphics::createLatexOptions(bool const ps) const
309 // Calculate the options part of the command, we must do it to a string
310 // stream since we might have a trailing comma that we would like to remove
311 // before writing it to the output stream.
312 ostringstream options;
313 if (!params().bbox.empty()) {
314 string const key = ps ? "bb=" : "viewport=";
315 options << key << params().bbox.xl.asLatexString() << ' '
316 << params().bbox.yb.asLatexString() << ' '
317 << params().bbox.xr.asLatexString() << ' '
318 << params().bbox.yt.asLatexString() << ',';
325 double const scl = convert<double>(params().scale);
326 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
327 if (!float_equal(scl, 100.0, 0.05))
328 size << "scale=" << scl / 100.0 << ',';
330 if (!params().width.zero())
331 size << "width=" << params().width.asLatexString() << ',';
332 if (!params().height.zero())
333 size << "height=" << params().height.asLatexString() << ',';
334 if (params().keepAspectRatio)
335 size << "keepaspectratio,";
337 if (params().scaleBeforeRotation && !size.str().empty())
338 options << size.str();
340 // Make sure rotation angle is not very close to zero;
341 // a float can be effectively zero but not exactly zero.
342 if (!params().rotateAngle.empty()
343 && !float_equal(convert<double>(params().rotateAngle), 0.0, 0.001)) {
344 options << "angle=" << params().rotateAngle << ',';
345 if (!params().rotateOrigin.empty()) {
346 options << "origin=" << params().rotateOrigin[0];
347 if (contains(params().rotateOrigin,"Top"))
349 else if (contains(params().rotateOrigin,"Bottom"))
351 else if (contains(params().rotateOrigin,"Baseline"))
356 if (!params().scaleBeforeRotation && !size.str().empty())
357 options << size.str();
359 if (!params().special.empty())
360 options << params().special << ',';
362 string opts = options.str();
364 if (suffixIs(opts, ','))
365 opts = opts.substr(0, opts.size() - 1);
371 docstring InsetGraphics::toDocbookLength(Length const & len) const
373 odocstringstream result;
374 switch (len.unit()) {
375 case Length::SP: // Scaled point (65536sp = 1pt) TeX's smallest unit.
376 result << len.value() * 65536.0 * 72 / 72.27 << "pt";
378 case Length::PT: // Point = 1/72.27in = 0.351mm
379 result << len.value() * 72 / 72.27 << "pt";
381 case Length::BP: // Big point (72bp = 1in), also PostScript point
382 result << len.value() << "pt";
384 case Length::DD: // Didot point = 1/72 of a French inch, = 0.376mm
385 result << len.value() * 0.376 << "mm";
387 case Length::MM: // Millimeter = 2.845pt
388 result << len.value() << "mm";
390 case Length::PC: // Pica = 12pt = 4.218mm
391 result << len.value() << "pc";
393 case Length::CC: // Cicero = 12dd = 4.531mm
394 result << len.value() * 4.531 << "mm";
396 case Length::CM: // Centimeter = 10mm = 2.371pc
397 result << len.value() << "cm";
399 case Length::IN: // Inch = 25.4mm = 72.27pt = 6.022pc
400 result << len.value() << "in";
402 case Length::EX: // Height of a small "x" for the current font.
403 // Obviously we have to compromise here. Any better ratio than 1.5 ?
404 result << len.value() / 1.5 << "em";
406 case Length::EM: // Width of capital "M" in current font.
407 result << len.value() << "em";
409 case Length::MU: // Math unit (18mu = 1em) for positioning in math mode
410 result << len.value() * 18 << "em";
412 case Length::PTW: // Percent of TextWidth
413 case Length::PCW: // Percent of ColumnWidth
414 case Length::PPW: // Percent of PageWidth
415 case Length::PLW: // Percent of LineWidth
416 case Length::PTH: // Percent of TextHeight
417 case Length::PPH: // Percent of PaperHeight
418 case Length::BLS: // Percent of BaselineSkip
419 // Sigh, this will go wrong.
420 result << len.value() << "%";
423 result << len.asDocstring();
430 docstring InsetGraphics::createDocBookAttributes() const
432 // Calculate the options part of the command, we must do it to a string
433 // stream since we copied the code from createLatexParams() ;-)
435 // FIXME: av: need to translate spec -> Docbook XSL spec
436 // (http://www.sagehill.net/docbookxsl/ImageSizing.html)
437 // Right now it only works with my version of db2latex :-)
439 odocstringstream options;
440 double const scl = convert<double>(params().scale);
441 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
442 if (!float_equal(scl, 100.0, 0.05))
443 options << " scale=\""
444 << support::iround(scl)
447 if (!params().width.zero()) {
448 options << " width=\"" << toDocbookLength(params().width) << "\" ";
450 if (!params().height.zero()) {
451 options << " depth=\"" << toDocbookLength(params().height) << "\" ";
453 if (params().keepAspectRatio) {
454 // This will be irrelevant unless both width and height are set
455 options << "scalefit=\"1\" ";
460 if (!params().special.empty())
461 options << from_ascii(params().special) << " ";
463 // trailing blanks are ok ...
464 return options.str();
470 enum GraphicsCopyStatus {
478 pair<GraphicsCopyStatus, FileName> const
479 copyFileIfNeeded(FileName const & file_in, FileName const & file_out)
481 LYXERR(Debug::FILES, "Comparing " << file_in << " and " << file_out);
482 unsigned long const checksum_in = file_in.checksum();
483 unsigned long const checksum_out = file_out.checksum();
485 if (checksum_in == checksum_out)
487 return make_pair(IDENTICAL_CONTENTS, file_out);
489 Mover const & mover = getMover(theFormats().getFormatFromFile(file_in));
490 bool const success = mover.copy(file_in, file_out);
493 LYXERR(Debug::GRAPHICS,
494 to_utf8(bformat(_("Could not copy the file\n%1$s\n"
495 "into the temporary directory."),
496 from_utf8(file_in.absFileName()))));
499 GraphicsCopyStatus status = success ? SUCCESS : FAILURE;
500 return make_pair(status, file_out);
504 pair<GraphicsCopyStatus, FileName> const
505 copyToDirIfNeeded(DocFileName const & file, string const & dir)
507 string const file_in = file.absFileName();
508 string const only_path = onlyPath(file_in);
509 if (rtrim(only_path, "/") == rtrim(dir, "/"))
510 return make_pair(IDENTICAL_PATHS, FileName(file_in));
512 string mangled = file.mangledFileName();
513 if (theFormats().isZippedFile(file)) {
514 // We need to change _eps.gz to .eps.gz. The mangled name is
515 // still unique because of the counter in mangledFileName().
516 // We can't just call mangledFileName() with the zip
517 // extension removed, because base.eps and base.eps.gz may
518 // have different content but would get the same mangled
519 // name in this case.
520 string const base = removeExtension(file.unzippedFileName());
521 string::size_type const ext_len = file_in.length() - base.length();
522 mangled[mangled.length() - ext_len] = '.';
524 FileName const file_out(makeAbsPath(mangled, dir));
526 return copyFileIfNeeded(file, file_out);
530 string const stripExtensionIfPossible(string const & file, bool nice)
532 // Remove the extension so the LaTeX compiler will use whatever
533 // is appropriate (when there are several versions in different
535 // Do this only if we are not exporting for internal usage, because
536 // pdflatex prefers png over pdf and it would pick up the png images
537 // that we generate for preview.
538 // This works only if the filename contains no dots besides
539 // the just removed one. We can fool here by replacing all
540 // dots with a macro whose definition is just a dot ;-)
541 // The automatic format selection does not work if the file
543 string const latex_name = latex_path(file, EXCLUDE_EXTENSION);
544 if (!nice || contains(latex_name, '"'))
546 return latex_path(removeExtension(file), PROTECT_EXTENSION, ESCAPE_DOTS);
550 string const stripExtensionIfPossible(string const & file, string const & to, bool nice)
552 // No conversion is needed. LaTeX can handle the graphic file as is.
553 // This is true even if the orig_file is compressed.
554 string const to_format = theFormats().getFormat(to)->extension();
555 string const file_format = getExtension(file);
556 // for latex .ps == .eps
557 if (to_format == file_format ||
558 (to_format == "eps" && file_format == "ps") ||
559 (to_format == "ps" && file_format == "eps"))
560 return stripExtensionIfPossible(file, nice);
561 return latex_path(file, EXCLUDE_EXTENSION);
567 string InsetGraphics::prepareFile(OutputParams const & runparams) const
569 // The following code depends on non-empty filenames
570 if (params().filename.empty())
573 string const orig_file = params().filename.absFileName();
574 // this is for dryrun and display purposes, do not use latexFilename
575 string const rel_file = params().filename.relFileName(buffer().filePath());
577 // previewing source code, no file copying or file format conversion
578 if (runparams.dryrun)
579 return stripExtensionIfPossible(rel_file, runparams.nice);
581 // The master buffer. This is useful when there are multiple levels
583 Buffer const * masterBuffer = buffer().masterBuffer();
585 // Return the output name if we are inside a comment or the file does
587 // We are not going to change the extension or using the name of the
588 // temporary file, the code is already complicated enough.
589 if (runparams.inComment || !params().filename.isReadableFile())
590 return params().filename.outputFileName(masterBuffer->filePath());
592 // We place all temporary files in the master buffer's temp dir.
593 // This is possible because we use mangled file names.
594 // This is necessary for DVI export.
595 string const temp_path = masterBuffer->temppath();
597 // temp_file will contain the file for LaTeX to act on if, for example,
598 // we move it to a temp dir or uncompress it.
600 GraphicsCopyStatus status;
601 tie(status, temp_file) = copyToDirIfNeeded(params().filename, temp_path);
603 if (status == FAILURE)
606 // a relative filename should be relative to the master buffer.
607 // "nice" means that the buffer is exported to LaTeX format but not
608 // run through the LaTeX compiler.
609 string output_file = runparams.nice ?
610 params().filename.outputFileName(masterBuffer->filePath()) :
611 onlyFileName(temp_file.absFileName());
613 if (runparams.nice) {
614 if (!isValidLaTeXFileName(output_file)) {
615 frontend::Alert::warning(_("Invalid filename"),
616 _("The following filename will cause troubles "
617 "when running the exported file through LaTeX: ") +
618 from_utf8(output_file));
620 // only show DVI-specific warning when export format is plain latex
621 if (!isValidDVIFileName(output_file)
622 && runparams.flavor == OutputParams::LATEX) {
623 frontend::Alert::warning(_("Problematic filename for DVI"),
624 _("The following filename can cause troubles "
625 "when running the exported file through LaTeX "
626 "and opening the resulting DVI: ") +
627 from_utf8(output_file), true);
631 FileName source_file = runparams.nice ? FileName(params().filename) : temp_file;
632 // determine the export format
633 string const tex_format = flavor2format(runparams.flavor);
635 if (theFormats().isZippedFile(params().filename)) {
636 FileName const unzipped_temp_file =
637 FileName(unzippedFileName(temp_file.absFileName()));
638 output_file = unzippedFileName(output_file);
639 source_file = FileName(unzippedFileName(source_file.absFileName()));
640 if (compare_timestamps(unzipped_temp_file, temp_file) > 0) {
641 // temp_file has been unzipped already and
642 // orig_file has not changed in the meantime.
643 temp_file = unzipped_temp_file;
644 LYXERR(Debug::GRAPHICS, "\twas already unzipped to " << temp_file);
646 // unzipped_temp_file does not exist or is too old
647 temp_file = unzipFile(temp_file);
648 LYXERR(Debug::GRAPHICS, "\tunzipped to " << temp_file);
652 string const from = theFormats().getFormatFromFile(temp_file);
654 LYXERR(Debug::GRAPHICS, "\tCould not get file format.");
656 string const to = findTargetFormat(from, runparams);
657 string const ext = theFormats().extension(to);
658 LYXERR(Debug::GRAPHICS, "\t we have: from " << from << " to " << to);
660 // We're going to be running the exported buffer through the LaTeX
661 // compiler, so must ensure that LaTeX can cope with the graphics
664 LYXERR(Debug::GRAPHICS, "\tthe orig file is: " << orig_file);
667 // source and destination formats are the same
668 if (!runparams.nice && !FileName(temp_file).hasExtension(ext)) {
669 // The LaTeX compiler will not be able to determine
670 // the file format from the extension, so we must
672 FileName const new_file =
673 FileName(changeExtension(temp_file.absFileName(), ext));
674 if (temp_file.moveTo(new_file)) {
675 temp_file = new_file;
676 output_file = changeExtension(output_file, ext);
678 FileName(changeExtension(source_file.absFileName(), ext));
680 LYXERR(Debug::GRAPHICS, "Could not rename file `"
681 << temp_file << "' to `" << new_file << "'.");
684 // The extension of temp_file might be != ext!
685 runparams.exportdata->addExternalFile(tex_format, source_file,
687 runparams.exportdata->addExternalFile("dvi", source_file,
689 return stripExtensionIfPossible(output_file, to, runparams.nice);
692 // so the source and destination formats are different
693 FileName const to_file = FileName(changeExtension(temp_file.absFileName(), ext));
694 string const output_to_file = changeExtension(output_file, ext);
696 // Do we need to perform the conversion?
697 // Yes if to_file does not exist or if temp_file is newer than to_file
698 if (compare_timestamps(temp_file, to_file) < 0) {
700 LYXERR(Debug::GRAPHICS,
701 to_utf8(bformat(_("No conversion of %1$s is needed after all"),
702 from_utf8(rel_file))));
703 runparams.exportdata->addExternalFile(tex_format, to_file,
705 runparams.exportdata->addExternalFile("dvi", to_file,
707 return stripExtensionIfPossible(output_to_file, runparams.nice);
710 LYXERR(Debug::GRAPHICS,"\tThe original file is " << orig_file << "\n"
711 << "\tA copy has been made and convert is to be called with:\n"
712 << "\tfile to convert = " << temp_file << '\n'
713 << "\t from " << from << " to " << to);
715 // FIXME (Abdel 12/08/06): Is there a need to show these errors?
717 Converters::RetVal const rv =
718 theConverters().convert(&buffer(), temp_file, to_file, params().filename,
720 Converters::try_default | Converters::try_cache);
721 if (rv == Converters::KILLED) {
722 LYXERR0("Graphics preparation killed.");
723 if (buffer().isClone() && buffer().isExporting())
724 throw ConversionException();
725 } else if (rv == Converters::SUCCESS) {
726 runparams.exportdata->addExternalFile(tex_format,
727 to_file, output_to_file);
728 runparams.exportdata->addExternalFile("dvi",
729 to_file, output_to_file);
732 return stripExtensionIfPossible(output_to_file, runparams.nice);
736 void InsetGraphics::latex(otexstream & os,
737 OutputParams const & runparams) const
739 // If there is no file specified or not existing,
740 // just output a message about it in the latex output.
741 LYXERR(Debug::GRAPHICS, "insetgraphics::latex: Filename = "
742 << params().filename.absFileName());
744 bool const file_exists = !params().filename.empty()
745 && params().filename.isReadableFile();
748 if (params().bbox.empty())
749 message = "bb = 0 0 200 100";
750 if (!params().draft) {
751 if (!message.empty())
755 if (!message.empty())
757 message += "type=eps";
759 // If no existing file "filename" was found LaTeX
760 // draws only a rectangle with the above bb and the
761 // not found filename in it.
762 LYXERR(Debug::GRAPHICS, "\tMessage = \"" << message << '\"');
764 // These variables collect all the latex code that should be before and
765 // after the actual includegraphics command.
769 if (runparams.moving_arg)
770 before += "\\protect";
772 // We never use the starred form, we use the "clip" option instead.
773 before += "\\includegraphics";
775 // Write the options if there are any.
776 bool const ps = runparams.flavor == OutputParams::LATEX
777 || runparams.flavor == OutputParams::DVILUATEX;
778 string const opts = createLatexOptions(ps);
779 LYXERR(Debug::GRAPHICS, "\tOpts = " << opts);
781 if (!opts.empty() && !message.empty())
782 before += ('[' + opts + ',' + message + ']');
783 else if (!opts.empty() || !message.empty())
784 before += ('[' + opts + message + ']');
786 LYXERR(Debug::GRAPHICS, "\tBefore = " << before << "\n\tafter = " << after);
788 string latex_str = before + '{';
789 // Convert the file if necessary.
790 // Remove the extension so LaTeX will use whatever is appropriate
791 // (when there are several versions in different formats)
792 string file_path = prepareFile(runparams);
793 latex_str += file_path;
794 latex_str += '}' + after;
796 os << from_utf8(latex_str);
798 LYXERR(Debug::GRAPHICS, "InsetGraphics::latex outputting:\n" << latex_str);
802 int InsetGraphics::plaintext(odocstringstream & os,
803 OutputParams const &, size_t) const
805 // No graphics in ascii output. Possible to use gifscii to convert
806 // images to ascii approximation.
807 // 1. Convert file to ascii using gifscii
808 // 2. Read ascii output file and add it to the output stream.
809 // at least we send the filename
811 // FIXME: We have no idea what the encoding of the filename is
813 docstring const str = bformat(buffer().B_("Graphics file: %1$s"),
814 from_utf8(params().filename.absFileName()));
815 os << '<' << str << '>';
817 return 2 + str.size();
821 static int writeImageObject(char const * format, odocstream & os,
822 OutputParams const & runparams, docstring const & graphic_label,
823 docstring const & attributes)
825 if (runparams.flavor != OutputParams::XML)
826 os << "<![ %output.print." << format
829 os <<"<imageobject><imagedata fileref=\"&"
836 if (runparams.flavor == OutputParams::XML)
837 os << " role=\"" << format << "\"/>" ;
839 os << " format=\"" << format << "\">" ;
841 os << "</imageobject>";
843 if (runparams.flavor != OutputParams::XML)
844 os << endl << "]]>" ;
846 return runparams.flavor == OutputParams::XML ? 0 : 2;
850 // For explanation on inserting graphics into DocBook checkout:
851 // http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
852 // See also the docbook guide at http://www.docbook.org/
853 int InsetGraphics::docbook(odocstream & os,
854 OutputParams const & runparams) const
856 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
857 // need to switch to MediaObject. However, for now this is sufficient and
859 if (runparams.flavor == OutputParams::XML)
860 runparams.exportdata->addExternalFile("docbook-xml",
863 runparams.exportdata->addExternalFile("docbook",
866 os << "<inlinemediaobject>";
869 docstring attributes = createDocBookAttributes();
870 r += writeImageObject("png", os, runparams, graphic_label, attributes);
871 r += writeImageObject("pdf", os, runparams, graphic_label, attributes);
872 r += writeImageObject("eps", os, runparams, graphic_label, attributes);
873 r += writeImageObject("bmp", os, runparams, graphic_label, attributes);
875 os << "</inlinemediaobject>";
880 string InsetGraphics::prepareHTMLFile(OutputParams const & runparams) const
882 // The following code depends on non-empty filenames
883 if (params().filename.empty())
886 if (!params().filename.isReadableFile())
889 // The master buffer. This is useful when there are multiple levels
891 Buffer const * masterBuffer = buffer().masterBuffer();
893 // We place all temporary files in the master buffer's temp dir.
894 // This is possible because we use mangled file names.
895 // FIXME We may want to put these files in some special temporary
897 string const temp_path = masterBuffer->temppath();
899 // Copy to temporary directory.
901 GraphicsCopyStatus status;
902 tie(status, temp_file) = copyToDirIfNeeded(params().filename, temp_path);
904 if (status == FAILURE)
907 string const from = theFormats().getFormatFromFile(temp_file);
909 LYXERR(Debug::GRAPHICS, "\tCould not get file format.");
913 string const to = findTargetFormat(from, runparams);
914 string const ext = theFormats().extension(to);
915 string const orig_file = params().filename.absFileName();
916 string output_file = onlyFileName(temp_file.absFileName());
917 LYXERR(Debug::GRAPHICS, "\t we have: from " << from << " to " << to);
918 LYXERR(Debug::GRAPHICS, "\tthe orig file is: " << orig_file);
921 // source and destination formats are the same
922 runparams.exportdata->addExternalFile("xhtml", temp_file, output_file);
926 // so the source and destination formats are different
927 FileName const to_file = FileName(changeExtension(temp_file.absFileName(), ext));
928 string const output_to_file = changeExtension(output_file, ext);
930 // Do we need to perform the conversion?
931 // Yes if to_file does not exist or if temp_file is newer than to_file
932 if (compare_timestamps(temp_file, to_file) < 0) {
934 LYXERR(Debug::GRAPHICS,
935 to_utf8(bformat(_("No conversion of %1$s is needed after all"),
936 from_utf8(orig_file))));
937 runparams.exportdata->addExternalFile("xhtml", to_file, output_to_file);
938 return output_to_file;
941 LYXERR(Debug::GRAPHICS,"\tThe original file is " << orig_file << "\n"
942 << "\tA copy has been made and convert is to be called with:\n"
943 << "\tfile to convert = " << temp_file << '\n'
944 << "\t from " << from << " to " << to);
946 // FIXME (Abdel 12/08/06): Is there a need to show these errors?
948 Converters::RetVal const rv =
949 theConverters().convert(&buffer(), temp_file, to_file, params().filename,
950 from, to, el, Converters::try_default | Converters::try_cache);
951 if (rv == Converters::KILLED) {
952 if (buffer().isClone() && buffer().isExporting())
953 throw ConversionException();
956 if (rv != Converters::SUCCESS)
958 runparams.exportdata->addExternalFile("xhtml", to_file, output_to_file);
959 return output_to_file;
963 docstring InsetGraphics::xhtml(XHTMLStream & xs, OutputParams const & op) const
965 string const output_file = op.dryrun ? string() : prepareHTMLFile(op);
967 if (output_file.empty() && !op.dryrun) {
968 LYXERR0("InsetGraphics::xhtml: Unable to prepare file `"
969 << params().filename << "' for output. File missing?");
970 string const attr = "src='" + params().filename.absFileName()
971 + "' alt='image: " + output_file + "'";
972 xs << html::CompTag("img", attr);
977 // We aren't doing anything with the crop and rotate parameters, and it would
978 // really be better to do width and height conversion, rather than to output
979 // these parameters here.
981 bool const havewidth = !params().width.zero();
982 bool const haveheight = !params().height.zero();
983 if (havewidth || haveheight) {
985 imgstyle += "width:" + params().width.asHTMLString() + ";";
987 imgstyle += " height:" + params().height.asHTMLString() + ";";
988 } else if (params().scale != "100") {
989 // Note that this will not have the same effect as in LaTeX export:
990 // There, the image will be scaled from its original size. Here, the
991 // percentage will be interpreted by the browser, and the image will
992 // be scaled to a percentage of the window size.
993 imgstyle = "width:" + params().scale + "%;";
995 if (!imgstyle.empty())
996 imgstyle = "style='" + imgstyle + "' ";
998 string const attr = imgstyle + "src='" + output_file + "' alt='image: "
1000 xs << html::CompTag("img", attr);
1005 void InsetGraphics::validate(LaTeXFeatures & features) const
1007 // If we have no image, we should not require anything.
1008 if (params().filename.empty())
1011 features.includeFile(graphic_label,
1012 removeExtension(params().filename.absFileName()));
1014 features.require("graphicx");
1016 if (features.runparams().nice) {
1017 string const rel_file = params().filename.onlyFileNameWithoutExt();
1018 if (contains(rel_file, "."))
1019 features.require("lyxdot");
1024 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
1026 // If nothing is changed, just return and say so.
1027 if (params() == p && !p.filename.empty())
1030 // Copy the new parameters.
1033 // Update the display using the new parameters.
1034 graphic_->update(params().as_grfxParams());
1036 // We have changed data, report it.
1041 InsetGraphicsParams const & InsetGraphics::params() const
1047 void InsetGraphics::editGraphics(InsetGraphicsParams const & p) const
1049 theFormats().edit(buffer(), p.filename,
1050 theFormats().getFormatFromFile(p.filename));
1054 void InsetGraphics::addToToc(DocIterator const & cpit, bool output_active,
1055 UpdateType, TocBackend & backend) const
1058 docstring const str = from_utf8(params_.filename.onlyFileName());
1059 TocBuilder & b = backend.builder("graphics");
1060 b.pushItem(cpit, str, output_active);
1065 string InsetGraphics::contextMenuName() const
1067 return "context-graphics";
1071 void InsetGraphics::string2params(string const & in, Buffer const & buffer,
1072 InsetGraphicsParams & params)
1077 istringstream data(in);
1079 lex.setStream(data);
1080 lex.setContext("InsetGraphics::string2params");
1082 params = InsetGraphicsParams();
1083 readInsetGraphics(lex, buffer, false, params);
1087 string InsetGraphics::params2string(InsetGraphicsParams const & params,
1088 Buffer const & buffer)
1091 data << "graphics" << ' ';
1092 params.Write(data, buffer);
1093 data << "\\end_inset\n";
1098 docstring InsetGraphics::toolTip(BufferView const &, int, int) const
1100 return from_utf8(params().filename.onlyFileName());
1103 namespace graphics {
1105 void getGraphicsGroups(Buffer const & b, set<string> & ids)
1107 Inset & inset = b.inset();
1108 InsetIterator it = inset_iterator_begin(inset);
1109 InsetIterator const end = inset_iterator_end(inset);
1110 for (; it != end; ++it) {
1111 InsetGraphics const * ins = it->asInsetGraphics();
1114 InsetGraphicsParams const & inspar = ins->getParams();
1115 if (!inspar.groupId.empty())
1116 ids.insert(inspar.groupId);
1121 int countGroupMembers(Buffer const & b, string const & groupId)
1124 if (groupId.empty())
1126 Inset & inset = b.inset();
1127 InsetIterator it = inset_iterator_begin(inset);
1128 InsetIterator const end = inset_iterator_end(inset);
1129 for (; it != end; ++it) {
1130 InsetGraphics const * ins = it->asInsetGraphics();
1133 if (ins->getParams().groupId == groupId)
1140 string getGroupParams(Buffer const & b, string const & groupId)
1142 if (groupId.empty())
1144 Inset & inset = b.inset();
1145 InsetIterator it = inset_iterator_begin(inset);
1146 InsetIterator const end = inset_iterator_end(inset);
1147 for (; it != end; ++it) {
1148 InsetGraphics const * ins = it->asInsetGraphics();
1151 InsetGraphicsParams const & inspar = ins->getParams();
1152 if (inspar.groupId == groupId) {
1153 InsetGraphicsParams tmp = inspar;
1154 tmp.filename.erase();
1155 return InsetGraphics::params2string(tmp, b);
1162 void unifyGraphicsGroups(Buffer & b, string const & argument)
1164 InsetGraphicsParams params;
1165 InsetGraphics::string2params(argument, b, params);
1167 // This handles undo groups automagically
1168 UndoGroupHelper ugh(&b);
1169 Inset & inset = b.inset();
1170 InsetIterator it = inset_iterator_begin(inset);
1171 InsetIterator const end = inset_iterator_end(inset);
1172 for (; it != end; ++it) {
1173 InsetGraphics * ins = it->asInsetGraphics();
1176 InsetGraphicsParams const & inspar = ins->getParams();
1177 if (params.groupId == inspar.groupId) {
1178 CursorData(it).recordUndo();
1179 params.filename = inspar.filename;
1180 ins->setParams(params);
1186 InsetGraphics * getCurrentGraphicsInset(Cursor const & cur)
1188 Inset * instmp = &cur.inset();
1189 if (!instmp->asInsetGraphics())
1190 instmp = cur.nextInset();
1191 if (!instmp || !instmp->asInsetGraphics())
1194 return instmp->asInsetGraphics();
1197 } // namespace graphics