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 * Add a way to roll the image file into the file format.
19 * When loading, if the image is not found in the expected place, try
20 to find it in the clipart, or in the same directory with the image.
21 * The image choosing dialog could show thumbnails of the image formats
22 it knows of, thus selection based on the image instead of based on
24 * Add support for the 'picins' package.
25 * Add support for the 'picinpar' package.
26 * Improve support for 'subfigure' - Allow to set the various options
32 * The filename is kept in the lyx file in a relative way, so as to allow
33 * moving the document file and its images with no problem.
37 * Postscript output means EPS figures.
39 * PDF output is best done with PDF figures if it's a direct conversion
40 * or PNG figures otherwise.
52 #include "insets/InsetGraphics.h"
53 #include "insets/RenderGraphic.h"
56 #include "BufferView.h"
57 #include "Converter.h"
60 #include "DispatchResult.h"
61 #include "ErrorList.h"
64 #include "FuncRequest.h"
65 #include "FuncStatus.h"
67 #include "LaTeXFeatures.h"
70 #include "MetricsInfo.h"
72 #include "OutputParams.h"
75 #include "frontends/alert.h"
77 #include "support/convert.h"
78 #include "support/filetools.h"
79 #include "support/lyxalgo.h" // count
80 #include "support/lyxlib.h" // sum
81 #include "support/lstrings.h"
82 #include "support/os.h"
83 #include "support/Systemcall.h"
85 #include <boost/bind.hpp>
86 #include <boost/tuple/tuple.hpp>
93 using support::bformat;
94 using support::changeExtension;
95 using support::compare_timestamps;
96 using support::contains;
97 using support::DocFileName;
98 using support::FileName;
99 using support::float_equal;
100 using support::getExtension;
101 using support::isFileReadable;
102 using support::latex_path;
103 using support::onlyFilename;
104 using support::removeExtension;
105 using support::rtrim;
106 using support::subst;
107 using support::suffixIs;
108 using support::Systemcall;
109 using support::unzipFile;
110 using support::unzippedFileName;
115 using std::istringstream;
117 using std::ostringstream;
122 /// Find the most suitable image format for images in \p format
123 /// Note that \p format may be unknown (i. e. an empty string)
124 string findTargetFormat(string const & format, OutputParams const & runparams)
126 // Are we using latex or pdflatex?
127 if (runparams.flavor == OutputParams::PDFLATEX) {
128 LYXERR(Debug::GRAPHICS) << "findTargetFormat: PDF mode" << endl;
129 Format const * const f = formats.getFormat(format);
130 // Convert vector graphics to pdf
131 if (f && f->vectorFormat())
133 // pdflatex can use jpeg, png and pdf directly
136 // Convert everything else to png
139 // If it's postscript, we always do eps.
140 LYXERR(Debug::GRAPHICS) << "findTargetFormat: PostScript mode" << endl;
142 // any other than ps is changed to eps
151 InsetGraphics::InsetGraphics()
152 : graphic_label(sgml::uniqueID(from_ascii("graph"))),
153 graphic_(new RenderGraphic(this))
157 InsetGraphics::InsetGraphics(InsetGraphics const & ig)
159 boost::signals::trackable(),
160 graphic_label(sgml::uniqueID(from_ascii("graph"))),
161 graphic_(new RenderGraphic(*ig.graphic_, this))
163 setParams(ig.params());
167 auto_ptr<Inset> InsetGraphics::doClone() const
169 return auto_ptr<Inset>(new InsetGraphics(*this));
173 InsetGraphics::~InsetGraphics()
175 InsetGraphicsMailer(*this).hideDialog();
179 void InsetGraphics::doDispatch(Cursor & cur, FuncRequest & cmd)
181 switch (cmd.action) {
182 case LFUN_GRAPHICS_EDIT: {
183 Buffer const & buffer = *cur.bv().buffer();
184 InsetGraphicsParams p;
185 InsetGraphicsMailer::string2params(to_utf8(cmd.argument()), buffer, p);
186 editGraphics(p, buffer);
190 case LFUN_INSET_MODIFY: {
191 Buffer const & buffer = cur.buffer();
192 InsetGraphicsParams p;
193 InsetGraphicsMailer::string2params(to_utf8(cmd.argument()), buffer, p);
194 if (!p.filename.empty())
201 case LFUN_INSET_DIALOG_UPDATE:
202 InsetGraphicsMailer(*this).updateDialog(&cur.bv());
205 case LFUN_MOUSE_RELEASE:
206 if (!cur.selection())
207 InsetGraphicsMailer(*this).showDialog(&cur.bv());
211 Inset::doDispatch(cur, cmd);
217 bool InsetGraphics::getStatus(Cursor & cur, FuncRequest const & cmd,
218 FuncStatus & flag) const
220 switch (cmd.action) {
221 case LFUN_GRAPHICS_EDIT:
222 case LFUN_INSET_MODIFY:
223 case LFUN_INSET_DIALOG_UPDATE:
228 return Inset::getStatus(cur, cmd, flag);
233 void InsetGraphics::edit(Cursor & cur, bool)
235 InsetGraphicsMailer(*this).showDialog(&cur.bv());
239 bool InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
241 graphic_->metrics(mi, dim);
242 bool const changed = dim_ != dim;
248 void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
250 setPosCache(pi, x, y);
251 graphic_->draw(pi, x, y);
255 Inset::EDITABLE InsetGraphics::editable() const
261 void InsetGraphics::write(Buffer const & buf, ostream & os) const
264 params().Write(os, buf.filePath());
268 void InsetGraphics::read(Buffer const & buf, Lexer & lex)
270 string const token = lex.getString();
272 if (token == "Graphics")
273 readInsetGraphics(lex, buf.filePath());
275 LYXERR(Debug::GRAPHICS) << "Not a Graphics inset!" << endl;
277 graphic_->update(params().as_grfxParams());
281 void InsetGraphics::readInsetGraphics(Lexer & lex, string const & bufpath)
283 bool finished = false;
285 while (lex.isOK() && !finished) {
288 string const token = lex.getString();
289 LYXERR(Debug::GRAPHICS) << "Token: '" << token << '\''
294 } else if (token == "\\end_inset") {
297 if (!params_.Read(lex, token, bufpath))
298 lyxerr << "Unknown token, " << token << ", skipping."
305 string const InsetGraphics::createLatexOptions() const
307 // Calculate the options part of the command, we must do it to a string
308 // stream since we might have a trailing comma that we would like to remove
309 // before writing it to the output stream.
310 ostringstream options;
311 if (!params().bb.empty())
312 options << "bb=" << rtrim(params().bb) << ',';
318 double const scl = convert<double>(params().scale);
319 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
320 if (!float_equal(scl, 100.0, 0.05))
321 size << "scale=" << scl / 100.0 << ',';
323 if (!params().width.zero())
324 size << "width=" << params().width.asLatexString() << ',';
325 if (!params().height.zero())
326 size << "height=" << params().height.asLatexString() << ',';
327 if (params().keepAspectRatio)
328 size << "keepaspectratio,";
330 if (params().scaleBeforeRotation && !size.str().empty())
331 options << size.str();
333 // Make sure rotation angle is not very close to zero;
334 // a float can be effectively zero but not exactly zero.
335 if (!params().rotateAngle.empty()
336 && !float_equal(convert<double>(params().rotateAngle), 0.0, 0.001)) {
337 options << "angle=" << params().rotateAngle << ',';
338 if (!params().rotateOrigin.empty()) {
339 options << "origin=" << params().rotateOrigin[0];
340 if (contains(params().rotateOrigin,"Top"))
342 else if (contains(params().rotateOrigin,"Bottom"))
344 else if (contains(params().rotateOrigin,"Baseline"))
349 if (!params().scaleBeforeRotation && !size.str().empty())
350 options << size.str();
352 if (!params().special.empty())
353 options << params().special << ',';
355 string opts = options.str();
357 if (suffixIs(opts, ','))
358 opts = opts.substr(0, opts.size() - 1);
364 docstring const InsetGraphics::toDocbookLength(Length const & len) const
366 odocstringstream result;
367 switch (len.unit()) {
368 case Length::SP: // Scaled point (65536sp = 1pt) TeX's smallest unit.
369 result << len.value() * 65536.0 * 72 / 72.27 << "pt";
371 case Length::PT: // Point = 1/72.27in = 0.351mm
372 result << len.value() * 72 / 72.27 << "pt";
374 case Length::BP: // Big point (72bp = 1in), also PostScript point
375 result << len.value() << "pt";
377 case Length::DD: // Didot point = 1/72 of a French inch, = 0.376mm
378 result << len.value() * 0.376 << "mm";
380 case Length::MM: // Millimeter = 2.845pt
381 result << len.value() << "mm";
383 case Length::PC: // Pica = 12pt = 4.218mm
384 result << len.value() << "pc";
386 case Length::CC: // Cicero = 12dd = 4.531mm
387 result << len.value() * 4.531 << "mm";
389 case Length::CM: // Centimeter = 10mm = 2.371pc
390 result << len.value() << "cm";
392 case Length::IN: // Inch = 25.4mm = 72.27pt = 6.022pc
393 result << len.value() << "in";
395 case Length::EX: // Height of a small "x" for the current font.
396 // Obviously we have to compromise here. Any better ratio than 1.5 ?
397 result << len.value() / 1.5 << "em";
399 case Length::EM: // Width of capital "M" in current font.
400 result << len.value() << "em";
402 case Length::MU: // Math unit (18mu = 1em) for positioning in math mode
403 result << len.value() * 18 << "em";
405 case Length::PTW: // Percent of TextWidth
406 case Length::PCW: // Percent of ColumnWidth
407 case Length::PPW: // Percent of PageWidth
408 case Length::PLW: // Percent of LineWidth
409 case Length::PTH: // Percent of TextHeight
410 case Length::PPH: // Percent of Paper
411 // Sigh, this will go wrong.
412 result << len.value() << "%";
415 result << len.asDocstring();
421 docstring const InsetGraphics::createDocBookAttributes() const
423 // Calculate the options part of the command, we must do it to a string
424 // stream since we copied the code from createLatexParams() ;-)
426 // FIXME: av: need to translate spec -> Docbook XSL spec (http://www.sagehill.net/docbookxsl/ImageSizing.html)
427 // Right now it only works with my version of db2latex :-)
429 odocstringstream options;
430 double const scl = convert<double>(params().scale);
431 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
432 if (!float_equal(scl, 100.0, 0.05))
433 options << " scale=\""
434 << static_cast<int>( (scl) + 0.5 )
437 if (!params().width.zero()) {
438 options << " width=\"" << toDocbookLength(params().width) << "\" ";
440 if (!params().height.zero()) {
441 options << " depth=\"" << toDocbookLength(params().height) << "\" ";
443 if (params().keepAspectRatio) {
444 // This will be irrelevant unless both width and height are set
445 options << "scalefit=\"1\" ";
450 if (!params().special.empty())
451 options << from_ascii(params().special) << " ";
453 // trailing blanks are ok ...
454 return options.str();
468 std::pair<CopyStatus, FileName> const
469 copyFileIfNeeded(FileName const & file_in, FileName const & file_out)
471 unsigned long const checksum_in = support::sum(file_in);
472 unsigned long const checksum_out = support::sum(file_out);
474 if (checksum_in == checksum_out)
476 return std::make_pair(IDENTICAL_CONTENTS, file_out);
478 Mover const & mover = getMover(formats.getFormatFromFile(file_in));
479 bool const success = mover.copy(file_in, file_out);
482 LYXERR(Debug::GRAPHICS)
483 << to_utf8(support::bformat(_("Could not copy the file\n%1$s\n"
484 "into the temporary directory."),
485 from_utf8(file_in.absFilename())))
489 CopyStatus status = success ? SUCCESS : FAILURE;
490 return std::make_pair(status, file_out);
494 std::pair<CopyStatus, FileName> const
495 copyToDirIfNeeded(DocFileName const & file, string const & dir)
497 using support::rtrim;
499 string const file_in = file.absFilename();
500 string const only_path = support::onlyPath(file_in);
501 if (rtrim(support::onlyPath(file_in) , "/") == rtrim(dir, "/"))
502 return std::make_pair(IDENTICAL_PATHS, file_in);
504 string mangled = file.mangledFilename();
505 if (file.isZipped()) {
506 // We need to change _eps.gz to .eps.gz. The mangled name is
507 // still unique because of the counter in mangledFilename().
508 // We can't just call mangledFilename() with the zip
509 // extension removed, because base.eps and base.eps.gz may
510 // have different content but would get the same mangled
511 // name in this case.
512 string const base = removeExtension(file.unzippedFilename());
513 string::size_type const ext_len = file_in.length() - base.length();
514 mangled[mangled.length() - ext_len] = '.';
516 FileName const file_out(support::makeAbsPath(mangled, dir));
518 return copyFileIfNeeded(file, file_out);
522 string const stripExtensionIfPossible(string const & file, bool nice)
524 // Remove the extension so the LaTeX compiler will use whatever
525 // is appropriate (when there are several versions in different
527 // Do this only if we are not exporting for internal usage, because
528 // pdflatex prefers png over pdf and it would pick up the png images
529 // that we generate for preview.
530 // This works only if the filename contains no dots besides
531 // the just removed one. We can fool here by replacing all
532 // dots with a macro whose definition is just a dot ;-)
533 // The automatic format selection does not work if the file
535 string const latex_name = latex_path(file,
536 support::EXCLUDE_EXTENSION);
537 if (!nice || contains(latex_name, '"'))
539 return latex_path(removeExtension(file),
540 support::PROTECT_EXTENSION,
541 support::ESCAPE_DOTS);
545 string const stripExtensionIfPossible(string const & file, string const & to, bool nice)
547 // No conversion is needed. LaTeX can handle the graphic file as is.
548 // This is true even if the orig_file is compressed.
549 string const to_format = formats.getFormat(to)->extension();
550 string const file_format = getExtension(file);
551 // for latex .ps == .eps
552 if (to_format == file_format ||
553 (to_format == "eps" && file_format == "ps") ||
554 (to_format == "ps" && file_format == "eps"))
555 return stripExtensionIfPossible(file, nice);
556 return latex_path(file, support::EXCLUDE_EXTENSION);
562 string const InsetGraphics::prepareFile(Buffer const & buf,
563 OutputParams const & runparams) const
565 // The following code depends on non-empty filenames
566 if (params().filename.empty())
569 string const orig_file = params().filename.absFilename();
570 string const rel_file = params().filename.relFilename(buf.filePath());
572 // previewing source code, no file copying or file format conversion
573 if (runparams.dryrun)
574 return stripExtensionIfPossible(rel_file, runparams.nice);
576 // temp_file will contain the file for LaTeX to act on if, for example,
577 // we move it to a temp dir or uncompress it.
578 FileName temp_file = params().filename;
580 // The master buffer. This is useful when there are multiple levels
582 Buffer const * m_buffer = buf.getMasterBuffer();
584 // Return the output name if we are inside a comment or the file does
586 // We are not going to change the extension or using the name of the
587 // temporary file, the code is already complicated enough.
588 if (runparams.inComment || !isFileReadable(params().filename))
589 return params().filename.outputFilename(m_buffer->filePath());
591 // We place all temporary files in the master buffer's temp dir.
592 // This is possible because we use mangled file names.
593 // This is necessary for DVI export.
594 string const temp_path = m_buffer->temppath();
597 boost::tie(status, temp_file) =
598 copyToDirIfNeeded(params().filename, temp_path);
600 if (status == FAILURE)
603 // a relative filename should be relative to the master
605 // "nice" means that the buffer is exported to LaTeX format but not
606 // run through the LaTeX compiler.
607 string output_file = support::os::external_path(runparams.nice ?
608 params().filename.outputFilename(m_buffer->filePath()) :
609 onlyFilename(temp_file.absFilename()));
610 FileName source_file = runparams.nice ? FileName(params().filename) : temp_file;
611 string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
612 "latex" : "pdflatex";
614 // If the file is compressed and we have specified that it
615 // should not be uncompressed, then just return its name and
616 // let LaTeX do the rest!
617 if (params().filename.isZipped()) {
618 if (params().noUnzip) {
619 // We don't know whether latex can actually handle
620 // this file, but we can't check, because that would
621 // mean to unzip the file and thereby making the
622 // noUnzip parameter meaningless.
623 LYXERR(Debug::GRAPHICS)
624 << "\tpass zipped file to LaTeX.\n";
626 FileName const bb_orig_file = FileName(changeExtension(orig_file, "bb"));
627 if (runparams.nice) {
628 runparams.exportdata->addExternalFile(tex_format,
630 changeExtension(output_file, "bb"));
632 // LaTeX needs the bounding box file in the
634 FileName bb_file = FileName(changeExtension(temp_file.absFilename(), "bb"));
635 boost::tie(status, bb_file) =
636 copyFileIfNeeded(bb_orig_file, bb_file);
637 if (status == FAILURE)
639 runparams.exportdata->addExternalFile(tex_format,
642 runparams.exportdata->addExternalFile(tex_format,
643 source_file, output_file);
644 runparams.exportdata->addExternalFile("dvi",
645 source_file, output_file);
646 // We can't strip the extension, because we don't know
647 // the unzipped file format
648 return latex_path(output_file,
649 support::EXCLUDE_EXTENSION);
652 FileName const unzipped_temp_file =
653 FileName(unzippedFileName(temp_file.absFilename()));
654 output_file = unzippedFileName(output_file);
655 source_file = FileName(unzippedFileName(source_file.absFilename()));
656 if (compare_timestamps(unzipped_temp_file, temp_file) > 0) {
657 // temp_file has been unzipped already and
658 // orig_file has not changed in the meantime.
659 temp_file = unzipped_temp_file;
660 LYXERR(Debug::GRAPHICS)
661 << "\twas already unzipped to " << temp_file
664 // unzipped_temp_file does not exist or is too old
665 temp_file = unzipFile(temp_file);
666 LYXERR(Debug::GRAPHICS)
667 << "\tunzipped to " << temp_file << endl;
671 string const from = formats.getFormatFromFile(temp_file);
673 LYXERR(Debug::GRAPHICS)
674 << "\tCould not get file format." << endl;
676 string const to = findTargetFormat(from, runparams);
677 string const ext = formats.extension(to);
678 LYXERR(Debug::GRAPHICS)
679 << "\t we have: from " << from << " to " << to << '\n';
681 // We're going to be running the exported buffer through the LaTeX
682 // compiler, so must ensure that LaTeX can cope with the graphics
685 LYXERR(Debug::GRAPHICS)
686 << "\tthe orig file is: " << orig_file << endl;
689 if (!runparams.nice && getExtension(temp_file.absFilename()) != ext) {
690 // The LaTeX compiler will not be able to determine
691 // the file format from the extension, so we must
693 FileName const new_file = FileName(changeExtension(temp_file.absFilename(), ext));
694 if (support::rename(temp_file, new_file)) {
695 temp_file = new_file;
696 output_file = changeExtension(output_file, ext);
697 source_file = FileName(changeExtension(source_file.absFilename(), ext));
699 LYXERR(Debug::GRAPHICS)
700 << "Could not rename file `"
701 << temp_file << "' to `" << new_file
704 // The extension of temp_file might be != ext!
705 runparams.exportdata->addExternalFile(tex_format, source_file,
707 runparams.exportdata->addExternalFile("dvi", source_file,
709 return stripExtensionIfPossible(output_file, to, runparams.nice);
712 FileName const to_file = FileName(changeExtension(temp_file.absFilename(), ext));
713 string const output_to_file = changeExtension(output_file, ext);
715 // Do we need to perform the conversion?
716 // Yes if to_file does not exist or if temp_file is newer than to_file
717 if (compare_timestamps(temp_file, to_file) < 0) {
719 LYXERR(Debug::GRAPHICS)
720 << to_utf8(bformat(_("No conversion of %1$s is needed after all"),
721 from_utf8(rel_file)))
723 runparams.exportdata->addExternalFile(tex_format, to_file,
725 runparams.exportdata->addExternalFile("dvi", to_file,
727 return stripExtensionIfPossible(output_to_file, runparams.nice);
730 LYXERR(Debug::GRAPHICS)
731 << "\tThe original file is " << orig_file << "\n"
732 << "\tA copy has been made and convert is to be called with:\n"
733 << "\tfile to convert = " << temp_file << '\n'
734 << "\t from " << from << " to " << to << '\n';
736 // FIXME (Abdel 12/08/06): Is there a need to show these errors?
738 if (theConverters().convert(&buf, temp_file, to_file, params().filename,
740 Converters::try_default | Converters::try_cache)) {
741 runparams.exportdata->addExternalFile(tex_format,
742 to_file, output_to_file);
743 runparams.exportdata->addExternalFile("dvi",
744 to_file, output_to_file);
747 return stripExtensionIfPossible(output_to_file, runparams.nice);
751 int InsetGraphics::latex(Buffer const & buf, odocstream & os,
752 OutputParams const & runparams) const
754 // If there is no file specified or not existing,
755 // just output a message about it in the latex output.
756 LYXERR(Debug::GRAPHICS)
757 << "insetgraphics::latex: Filename = "
758 << params().filename.absFilename() << endl;
760 string const relative_file =
761 params().filename.relFilename(buf.filePath());
763 bool const file_exists = !params().filename.empty() &&
764 isFileReadable(params().filename);
765 string const message = file_exists ?
766 string() : string("bb = 0 0 200 100, draft, type=eps");
767 // if !message.empty() then there was no existing file
768 // "filename" found. In this case LaTeX
769 // draws only a rectangle with the above bb and the
770 // not found filename in it.
771 LYXERR(Debug::GRAPHICS)
772 << "\tMessage = \"" << message << '\"' << endl;
774 // These variables collect all the latex code that should be before and
775 // after the actual includegraphics command.
778 // Do we want subcaptions?
779 if (params().subcaption) {
780 if (runparams.moving_arg)
781 before += "\\protect";
782 before += "\\subfigure[" + params().subcaptionText + "]{";
786 if (runparams.moving_arg)
787 before += "\\protect";
789 // We never use the starred form, we use the "clip" option instead.
790 before += "\\includegraphics";
792 // Write the options if there are any.
793 string const opts = createLatexOptions();
794 LYXERR(Debug::GRAPHICS) << "\tOpts = " << opts << endl;
796 if (!opts.empty() && !message.empty())
797 before += ('[' + opts + ',' + message + ']');
798 else if (!opts.empty() || !message.empty())
799 before += ('[' + opts + message + ']');
801 LYXERR(Debug::GRAPHICS)
802 << "\tBefore = " << before
803 << "\n\tafter = " << after << endl;
805 string latex_str = before + '{';
806 // Convert the file if necessary.
807 // Remove the extension so LaTeX will use whatever is appropriate
808 // (when there are several versions in different formats)
809 latex_str += prepareFile(buf, runparams);
810 latex_str += '}' + after;
812 os << from_utf8(latex_str);
814 LYXERR(Debug::GRAPHICS) << "InsetGraphics::latex outputting:\n"
815 << latex_str << endl;
816 // Return how many newlines we issued.
817 return int(lyx::count(latex_str.begin(), latex_str.end(),'\n'));
821 int InsetGraphics::plaintext(Buffer const & buf, odocstream & os,
822 OutputParams const &) const
824 // No graphics in ascii output. Possible to use gifscii to convert
825 // images to ascii approximation.
826 // 1. Convert file to ascii using gifscii
827 // 2. Read ascii output file and add it to the output stream.
828 // at least we send the filename
830 // FIXME: We have no idea what the encoding of the filename is
832 docstring const str = bformat(buf.B_("Graphics file: %1$s"),
833 from_utf8(params().filename.absFilename()));
834 os << '<' << str << '>';
836 return 2 + str.size();
842 int writeImageObject(char * format, odocstream & os, OutputParams const & runparams,
843 docstring const graphic_label, docstring const attributes)
845 if (runparams.flavor != OutputParams::XML) {
846 os << "<![ %output.print."
851 os <<"<imageobject><imagedata fileref=\"&"
857 if (runparams.flavor == OutputParams::XML) {
858 os << " role=\"" << format << "\"/>" ;
861 os << " format=\"" << format << "\">" ;
863 os << "</imageobject>";
864 if (runparams.flavor != OutputParams::XML) {
865 os << std::endl << "]]>" ;
867 return runparams.flavor == OutputParams::XML ? 0 : 2;
869 // end anonymous namespace
873 // For explanation on inserting graphics into DocBook checkout:
874 // http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
875 // See also the docbook guide at http://www.docbook.org/
876 int InsetGraphics::docbook(Buffer const &, odocstream & os,
877 OutputParams const & runparams) const
879 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
880 // need to switch to MediaObject. However, for now this is sufficient and
882 if (runparams.flavor == OutputParams::XML) {
883 runparams.exportdata->addExternalFile("docbook-xml",
886 runparams.exportdata->addExternalFile("docbook",
889 os << "<inlinemediaobject>";
892 docstring attributes = createDocBookAttributes();
893 r += writeImageObject("png", os, runparams, graphic_label, attributes);
894 r += writeImageObject("pdf", os, runparams, graphic_label, attributes);
895 r += writeImageObject("eps", os, runparams, graphic_label, attributes);
896 r += writeImageObject("bmp", os, runparams, graphic_label, attributes);
898 os << "</inlinemediaobject>";
903 void InsetGraphics::validate(LaTeXFeatures & features) const
905 // If we have no image, we should not require anything.
906 if (params().filename.empty())
909 features.includeFile(graphic_label,
910 removeExtension(params().filename.absFilename()));
912 features.require("graphicx");
914 if (features.runparams().nice) {
915 Buffer const * m_buffer = features.buffer().getMasterBuffer();
916 string const rel_file = removeExtension(params().filename.relFilename(m_buffer->filePath()));
917 if (contains(rel_file, "."))
918 features.require("lyxdot");
921 if (params().subcaption)
922 features.require("subfigure");
926 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
928 // If nothing is changed, just return and say so.
929 if (params() == p && !p.filename.empty())
932 // Copy the new parameters.
935 // Update the display using the new parameters.
936 graphic_->update(params().as_grfxParams());
938 // We have changed data, report it.
943 InsetGraphicsParams const & InsetGraphics::params() const
949 void InsetGraphics::editGraphics(InsetGraphicsParams const & p,
950 Buffer const & buffer) const
952 formats.edit(buffer, p.filename,
953 formats.getFormatFromFile(p.filename));
957 string const InsetGraphicsMailer::name_("graphics");
959 InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset)
964 string const InsetGraphicsMailer::inset2string(Buffer const & buffer) const
966 return params2string(inset_.params(), buffer);
970 void InsetGraphicsMailer::string2params(string const & in,
971 Buffer const & buffer,
972 InsetGraphicsParams & params)
974 params = InsetGraphicsParams();
978 istringstream data(in);
984 if (!lex || name != name_)
985 return print_mailer_error("InsetGraphicsMailer", in, 1, name_);
988 inset.readInsetGraphics(lex, buffer.filePath());
989 params = inset.params();
994 InsetGraphicsMailer::params2string(InsetGraphicsParams const & params,
995 Buffer const & buffer)
998 data << name_ << ' ';
999 params.Write(data, buffer.filePath());
1000 data << "\\end_inset\n";