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::Systemcall;
108 using support::unzipFile;
109 using support::unzippedFileName;
114 using std::istringstream;
116 using std::ostringstream;
121 /// Find the most suitable image format for images in \p format
122 /// Note that \p format may be unknown (i. e. an empty string)
123 string findTargetFormat(string const & format, OutputParams const & runparams)
125 // Are we using latex or pdflatex?
126 if (runparams.flavor == OutputParams::PDFLATEX) {
127 LYXERR(Debug::GRAPHICS) << "findTargetFormat: PDF mode" << endl;
128 Format const * const f = formats.getFormat(format);
129 // Convert vector graphics to pdf
130 if (f && f->vectorFormat())
132 // pdflatex can use jpeg, png and pdf directly
135 // Convert everything else to png
138 // If it's postscript, we always do eps.
139 LYXERR(Debug::GRAPHICS) << "findTargetFormat: PostScript mode" << endl;
141 // any other than ps is changed to eps
150 InsetGraphics::InsetGraphics()
151 : graphic_label(sgml::uniqueID(from_ascii("graph"))),
152 graphic_(new RenderGraphic(this))
156 InsetGraphics::InsetGraphics(InsetGraphics const & ig)
158 boost::signals::trackable(),
159 graphic_label(sgml::uniqueID(from_ascii("graph"))),
160 graphic_(new RenderGraphic(*ig.graphic_, this))
162 setParams(ig.params());
166 auto_ptr<Inset> InsetGraphics::doClone() const
168 return auto_ptr<Inset>(new InsetGraphics(*this));
172 InsetGraphics::~InsetGraphics()
174 InsetGraphicsMailer(*this).hideDialog();
178 void InsetGraphics::doDispatch(Cursor & cur, FuncRequest & cmd)
180 switch (cmd.action) {
181 case LFUN_GRAPHICS_EDIT: {
182 Buffer const & buffer = *cur.bv().buffer();
183 InsetGraphicsParams p;
184 InsetGraphicsMailer::string2params(to_utf8(cmd.argument()), buffer, p);
185 editGraphics(p, buffer);
189 case LFUN_INSET_MODIFY: {
190 Buffer const & buffer = cur.buffer();
191 InsetGraphicsParams p;
192 InsetGraphicsMailer::string2params(to_utf8(cmd.argument()), buffer, p);
193 if (!p.filename.empty())
200 case LFUN_INSET_DIALOG_UPDATE:
201 InsetGraphicsMailer(*this).updateDialog(&cur.bv());
204 case LFUN_MOUSE_RELEASE:
205 if (!cur.selection())
206 InsetGraphicsMailer(*this).showDialog(&cur.bv());
210 Inset::doDispatch(cur, cmd);
216 bool InsetGraphics::getStatus(Cursor & cur, FuncRequest const & cmd,
217 FuncStatus & flag) const
219 switch (cmd.action) {
220 case LFUN_GRAPHICS_EDIT:
221 case LFUN_INSET_MODIFY:
222 case LFUN_INSET_DIALOG_UPDATE:
227 return Inset::getStatus(cur, cmd, flag);
232 void InsetGraphics::edit(Cursor & cur, bool)
234 InsetGraphicsMailer(*this).showDialog(&cur.bv());
238 bool InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
240 graphic_->metrics(mi, dim);
241 bool const changed = dim_ != dim;
247 void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
249 setPosCache(pi, x, y);
250 graphic_->draw(pi, x, y);
254 Inset::EDITABLE InsetGraphics::editable() const
260 void InsetGraphics::write(Buffer const & buf, ostream & os) const
263 params().Write(os, buf.filePath());
267 void InsetGraphics::read(Buffer const & buf, Lexer & lex)
269 string const token = lex.getString();
271 if (token == "Graphics")
272 readInsetGraphics(lex, buf.filePath());
274 LYXERR(Debug::GRAPHICS) << "Not a Graphics inset!" << endl;
276 graphic_->update(params().as_grfxParams());
280 void InsetGraphics::readInsetGraphics(Lexer & lex, string const & bufpath)
282 bool finished = false;
284 while (lex.isOK() && !finished) {
287 string const token = lex.getString();
288 LYXERR(Debug::GRAPHICS) << "Token: '" << token << '\''
293 } else if (token == "\\end_inset") {
296 if (!params_.Read(lex, token, bufpath))
297 lyxerr << "Unknown token, " << token << ", skipping."
304 string const InsetGraphics::createLatexOptions() const
306 // Calculate the options part of the command, we must do it to a string
307 // stream since we might have a trailing comma that we would like to remove
308 // before writing it to the output stream.
309 ostringstream options;
310 if (!params().bb.empty())
311 options << "bb=" << rtrim(params().bb) << ',';
316 double const scl = convert<double>(params().scale);
317 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
318 if (!float_equal(scl, 100.0, 0.05))
319 options << "scale=" << scl / 100.0 << ',';
321 if (!params().width.zero())
322 options << "width=" << params().width.asLatexString() << ',';
323 if (!params().height.zero())
324 options << "height=" << params().height.asLatexString() << ',';
325 if (params().keepAspectRatio)
326 options << "keepaspectratio,";
329 // Make sure rotation angle is not very close to zero;
330 // a float can be effectively zero but not exactly zero.
331 if (!params().rotateAngle.empty()
332 && !float_equal(convert<double>(params().rotateAngle), 0.0, 0.001)) {
333 options << "angle=" << params().rotateAngle << ',';
334 if (!params().rotateOrigin.empty()) {
335 options << "origin=" << params().rotateOrigin[0];
336 if (contains(params().rotateOrigin,"Top"))
338 else if (contains(params().rotateOrigin,"Bottom"))
340 else if (contains(params().rotateOrigin,"Baseline"))
346 if (!params().special.empty())
347 options << params().special << ',';
349 string opts = options.str();
351 return opts.substr(0, opts.size() - 1);
355 docstring const InsetGraphics::toDocbookLength(Length const & len) const
357 odocstringstream result;
358 switch (len.unit()) {
359 case Length::SP: // Scaled point (65536sp = 1pt) TeX's smallest unit.
360 result << len.value() * 65536.0 * 72 / 72.27 << "pt";
362 case Length::PT: // Point = 1/72.27in = 0.351mm
363 result << len.value() * 72 / 72.27 << "pt";
365 case Length::BP: // Big point (72bp = 1in), also PostScript point
366 result << len.value() << "pt";
368 case Length::DD: // Didot point = 1/72 of a French inch, = 0.376mm
369 result << len.value() * 0.376 << "mm";
371 case Length::MM: // Millimeter = 2.845pt
372 result << len.value() << "mm";
374 case Length::PC: // Pica = 12pt = 4.218mm
375 result << len.value() << "pc";
377 case Length::CC: // Cicero = 12dd = 4.531mm
378 result << len.value() * 4.531 << "mm";
380 case Length::CM: // Centimeter = 10mm = 2.371pc
381 result << len.value() << "cm";
383 case Length::IN: // Inch = 25.4mm = 72.27pt = 6.022pc
384 result << len.value() << "in";
386 case Length::EX: // Height of a small "x" for the current font.
387 // Obviously we have to compromise here. Any better ratio than 1.5 ?
388 result << len.value() / 1.5 << "em";
390 case Length::EM: // Width of capital "M" in current font.
391 result << len.value() << "em";
393 case Length::MU: // Math unit (18mu = 1em) for positioning in math mode
394 result << len.value() * 18 << "em";
396 case Length::PTW: // Percent of TextWidth
397 case Length::PCW: // Percent of ColumnWidth
398 case Length::PPW: // Percent of PageWidth
399 case Length::PLW: // Percent of LineWidth
400 case Length::PTH: // Percent of TextHeight
401 case Length::PPH: // Percent of Paper
402 // Sigh, this will go wrong.
403 result << len.value() << "%";
406 result << len.asDocstring();
412 docstring const InsetGraphics::createDocBookAttributes() const
414 // Calculate the options part of the command, we must do it to a string
415 // stream since we copied the code from createLatexParams() ;-)
417 // FIXME: av: need to translate spec -> Docbook XSL spec (http://www.sagehill.net/docbookxsl/ImageSizing.html)
418 // Right now it only works with my version of db2latex :-)
420 odocstringstream options;
421 double const scl = convert<double>(params().scale);
422 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
423 if (!float_equal(scl, 100.0, 0.05))
424 options << " scale=\""
425 << static_cast<int>( (scl) + 0.5 )
428 if (!params().width.zero()) {
429 options << " width=\"" << toDocbookLength(params().width) << "\" ";
431 if (!params().height.zero()) {
432 options << " depth=\"" << toDocbookLength(params().height) << "\" ";
434 if (params().keepAspectRatio) {
435 // This will be irrelevant unless both width and height are set
436 options << "scalefit=\"1\" ";
441 if (!params().special.empty())
442 options << from_ascii(params().special) << " ";
444 // trailing blanks are ok ...
445 return options.str();
459 std::pair<CopyStatus, FileName> const
460 copyFileIfNeeded(FileName const & file_in, FileName const & file_out)
462 unsigned long const checksum_in = support::sum(file_in);
463 unsigned long const checksum_out = support::sum(file_out);
465 if (checksum_in == checksum_out)
467 return std::make_pair(IDENTICAL_CONTENTS, file_out);
469 Mover const & mover = getMover(formats.getFormatFromFile(file_in));
470 bool const success = mover.copy(file_in, file_out);
473 LYXERR(Debug::GRAPHICS)
474 << to_utf8(support::bformat(_("Could not copy the file\n%1$s\n"
475 "into the temporary directory."),
476 from_utf8(file_in.absFilename())))
480 CopyStatus status = success ? SUCCESS : FAILURE;
481 return std::make_pair(status, file_out);
485 std::pair<CopyStatus, FileName> const
486 copyToDirIfNeeded(DocFileName const & file, string const & dir)
488 using support::rtrim;
490 string const file_in = file.absFilename();
491 string const only_path = support::onlyPath(file_in);
492 if (rtrim(support::onlyPath(file_in) , "/") == rtrim(dir, "/"))
493 return std::make_pair(IDENTICAL_PATHS, file_in);
495 string mangled = file.mangledFilename();
496 if (file.isZipped()) {
497 // We need to change _eps.gz to .eps.gz. The mangled name is
498 // still unique because of the counter in mangledFilename().
499 // We can't just call mangledFilename() with the zip
500 // extension removed, because base.eps and base.eps.gz may
501 // have different content but would get the same mangled
502 // name in this case.
503 string const base = removeExtension(file.unzippedFilename());
504 string::size_type const ext_len = file_in.length() - base.length();
505 mangled[mangled.length() - ext_len] = '.';
507 FileName const file_out(support::makeAbsPath(mangled, dir));
509 return copyFileIfNeeded(file, file_out);
513 string const stripExtensionIfPossible(string const & file, bool nice)
515 // Remove the extension so the LaTeX compiler will use whatever
516 // is appropriate (when there are several versions in different
518 // Do this only if we are not exporting for internal usage, because
519 // pdflatex prefers png over pdf and it would pick up the png images
520 // that we generate for preview.
521 // This works only if the filename contains no dots besides
522 // the just removed one. We can fool here by replacing all
523 // dots with a macro whose definition is just a dot ;-)
524 // The automatic format selection does not work if the file
526 string const latex_name = latex_path(file,
527 support::EXCLUDE_EXTENSION);
528 if (!nice || contains(latex_name, '"'))
530 return latex_path(removeExtension(file),
531 support::PROTECT_EXTENSION,
532 support::ESCAPE_DOTS);
536 string const stripExtensionIfPossible(string const & file, string const & to, bool nice)
538 // No conversion is needed. LaTeX can handle the graphic file as is.
539 // This is true even if the orig_file is compressed.
540 string const to_format = formats.getFormat(to)->extension();
541 string const file_format = getExtension(file);
542 // for latex .ps == .eps
543 if (to_format == file_format ||
544 (to_format == "eps" && file_format == "ps") ||
545 (to_format == "ps" && file_format == "eps"))
546 return stripExtensionIfPossible(file, nice);
547 return latex_path(file, support::EXCLUDE_EXTENSION);
553 string const InsetGraphics::prepareFile(Buffer const & buf,
554 OutputParams const & runparams) const
556 // The following code depends on non-empty filenames
557 if (params().filename.empty())
560 string const orig_file = params().filename.absFilename();
561 string const rel_file = params().filename.relFilename(buf.filePath());
563 // previewing source code, no file copying or file format conversion
564 if (runparams.dryrun)
565 return stripExtensionIfPossible(rel_file, runparams.nice);
567 // temp_file will contain the file for LaTeX to act on if, for example,
568 // we move it to a temp dir or uncompress it.
569 FileName temp_file = params().filename;
571 // The master buffer. This is useful when there are multiple levels
573 Buffer const * m_buffer = buf.getMasterBuffer();
575 // Return the output name if we are inside a comment or the file does
577 // We are not going to change the extension or using the name of the
578 // temporary file, the code is already complicated enough.
579 if (runparams.inComment || !isFileReadable(params().filename))
580 return params().filename.outputFilename(m_buffer->filePath());
582 // We place all temporary files in the master buffer's temp dir.
583 // This is possible because we use mangled file names.
584 // This is necessary for DVI export.
585 string const temp_path = m_buffer->temppath();
588 boost::tie(status, temp_file) =
589 copyToDirIfNeeded(params().filename, temp_path);
591 if (status == FAILURE)
594 // a relative filename should be relative to the master
596 // "nice" means that the buffer is exported to LaTeX format but not
597 // run through the LaTeX compiler.
598 string output_file = support::os::external_path(runparams.nice ?
599 params().filename.outputFilename(m_buffer->filePath()) :
600 onlyFilename(temp_file.absFilename()));
601 FileName source_file = runparams.nice ? FileName(params().filename) : temp_file;
602 string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
603 "latex" : "pdflatex";
605 // If the file is compressed and we have specified that it
606 // should not be uncompressed, then just return its name and
607 // let LaTeX do the rest!
608 if (params().filename.isZipped()) {
609 if (params().noUnzip) {
610 // We don't know whether latex can actually handle
611 // this file, but we can't check, because that would
612 // mean to unzip the file and thereby making the
613 // noUnzip parameter meaningless.
614 LYXERR(Debug::GRAPHICS)
615 << "\tpass zipped file to LaTeX.\n";
617 FileName const bb_orig_file = FileName(changeExtension(orig_file, "bb"));
618 if (runparams.nice) {
619 runparams.exportdata->addExternalFile(tex_format,
621 changeExtension(output_file, "bb"));
623 // LaTeX needs the bounding box file in the
625 FileName bb_file = FileName(changeExtension(temp_file.absFilename(), "bb"));
626 boost::tie(status, bb_file) =
627 copyFileIfNeeded(bb_orig_file, bb_file);
628 if (status == FAILURE)
630 runparams.exportdata->addExternalFile(tex_format,
633 runparams.exportdata->addExternalFile(tex_format,
634 source_file, output_file);
635 runparams.exportdata->addExternalFile("dvi",
636 source_file, output_file);
637 // We can't strip the extension, because we don't know
638 // the unzipped file format
639 return latex_path(output_file,
640 support::EXCLUDE_EXTENSION);
643 FileName const unzipped_temp_file =
644 FileName(unzippedFileName(temp_file.absFilename()));
645 output_file = unzippedFileName(output_file);
646 source_file = FileName(unzippedFileName(source_file.absFilename()));
647 if (compare_timestamps(unzipped_temp_file, temp_file) > 0) {
648 // temp_file has been unzipped already and
649 // orig_file has not changed in the meantime.
650 temp_file = unzipped_temp_file;
651 LYXERR(Debug::GRAPHICS)
652 << "\twas already unzipped to " << temp_file
655 // unzipped_temp_file does not exist or is too old
656 temp_file = unzipFile(temp_file);
657 LYXERR(Debug::GRAPHICS)
658 << "\tunzipped to " << temp_file << endl;
662 string const from = formats.getFormatFromFile(temp_file);
664 LYXERR(Debug::GRAPHICS)
665 << "\tCould not get file format." << endl;
667 string const to = findTargetFormat(from, runparams);
668 string const ext = formats.extension(to);
669 LYXERR(Debug::GRAPHICS)
670 << "\t we have: from " << from << " to " << to << '\n';
672 // We're going to be running the exported buffer through the LaTeX
673 // compiler, so must ensure that LaTeX can cope with the graphics
676 LYXERR(Debug::GRAPHICS)
677 << "\tthe orig file is: " << orig_file << endl;
680 if (!runparams.nice && getExtension(temp_file.absFilename()) != ext) {
681 // The LaTeX compiler will not be able to determine
682 // the file format from the extension, so we must
684 FileName const new_file = FileName(changeExtension(temp_file.absFilename(), ext));
685 if (support::rename(temp_file, new_file)) {
686 temp_file = new_file;
687 output_file = changeExtension(output_file, ext);
688 source_file = FileName(changeExtension(source_file.absFilename(), ext));
690 LYXERR(Debug::GRAPHICS)
691 << "Could not rename file `"
692 << temp_file << "' to `" << new_file
695 // The extension of temp_file might be != ext!
696 runparams.exportdata->addExternalFile(tex_format, source_file,
698 runparams.exportdata->addExternalFile("dvi", source_file,
700 return stripExtensionIfPossible(output_file, to, runparams.nice);
703 FileName const to_file = FileName(changeExtension(temp_file.absFilename(), ext));
704 string const output_to_file = changeExtension(output_file, ext);
706 // Do we need to perform the conversion?
707 // Yes if to_file does not exist or if temp_file is newer than to_file
708 if (compare_timestamps(temp_file, to_file) < 0) {
710 LYXERR(Debug::GRAPHICS)
711 << to_utf8(bformat(_("No conversion of %1$s is needed after all"),
712 from_utf8(rel_file)))
714 runparams.exportdata->addExternalFile(tex_format, to_file,
716 runparams.exportdata->addExternalFile("dvi", to_file,
718 return stripExtensionIfPossible(output_to_file, runparams.nice);
721 LYXERR(Debug::GRAPHICS)
722 << "\tThe original file is " << orig_file << "\n"
723 << "\tA copy has been made and convert is to be called with:\n"
724 << "\tfile to convert = " << temp_file << '\n'
725 << "\t from " << from << " to " << to << '\n';
727 // FIXME (Abdel 12/08/06): Is there a need to show these errors?
729 if (theConverters().convert(&buf, temp_file, to_file, params().filename,
731 Converters::try_default | Converters::try_cache)) {
732 runparams.exportdata->addExternalFile(tex_format,
733 to_file, output_to_file);
734 runparams.exportdata->addExternalFile("dvi",
735 to_file, output_to_file);
738 return stripExtensionIfPossible(output_to_file, runparams.nice);
742 int InsetGraphics::latex(Buffer const & buf, odocstream & os,
743 OutputParams const & runparams) const
745 // If there is no file specified or not existing,
746 // just output a message about it in the latex output.
747 LYXERR(Debug::GRAPHICS)
748 << "insetgraphics::latex: Filename = "
749 << params().filename.absFilename() << endl;
751 string const relative_file =
752 params().filename.relFilename(buf.filePath());
754 bool const file_exists = !params().filename.empty() &&
755 isFileReadable(params().filename);
756 string const message = file_exists ?
757 string() : string("bb = 0 0 200 100, draft, type=eps");
758 // if !message.empty() then there was no existing file
759 // "filename" found. In this case LaTeX
760 // draws only a rectangle with the above bb and the
761 // not found filename in it.
762 LYXERR(Debug::GRAPHICS)
763 << "\tMessage = \"" << message << '\"' << endl;
765 // These variables collect all the latex code that should be before and
766 // after the actual includegraphics command.
769 // Do we want subcaptions?
770 if (params().subcaption) {
771 if (runparams.moving_arg)
772 before += "\\protect";
773 before += "\\subfigure[" + params().subcaptionText + "]{";
777 if (runparams.moving_arg)
778 before += "\\protect";
780 // We never use the starred form, we use the "clip" option instead.
781 before += "\\includegraphics";
783 // Write the options if there are any.
784 string const opts = createLatexOptions();
785 LYXERR(Debug::GRAPHICS) << "\tOpts = " << opts << endl;
787 if (!opts.empty() && !message.empty())
788 before += ('[' + opts + ',' + message + ']');
789 else if (!opts.empty() || !message.empty())
790 before += ('[' + opts + message + ']');
792 LYXERR(Debug::GRAPHICS)
793 << "\tBefore = " << before
794 << "\n\tafter = " << after << endl;
796 string latex_str = before + '{';
797 // Convert the file if necessary.
798 // Remove the extension so LaTeX will use whatever is appropriate
799 // (when there are several versions in different formats)
800 latex_str += prepareFile(buf, runparams);
801 latex_str += '}' + after;
803 os << from_utf8(latex_str);
805 LYXERR(Debug::GRAPHICS) << "InsetGraphics::latex outputting:\n"
806 << latex_str << endl;
807 // Return how many newlines we issued.
808 return int(lyx::count(latex_str.begin(), latex_str.end(),'\n'));
812 int InsetGraphics::plaintext(Buffer const & buf, odocstream & os,
813 OutputParams const &) const
815 // No graphics in ascii output. Possible to use gifscii to convert
816 // images to ascii approximation.
817 // 1. Convert file to ascii using gifscii
818 // 2. Read ascii output file and add it to the output stream.
819 // at least we send the filename
821 // FIXME: We have no idea what the encoding of the filename is
823 docstring const str = bformat(buf.B_("Graphics file: %1$s"),
824 from_utf8(params().filename.absFilename()));
825 os << '<' << str << '>';
827 return 2 + str.size();
833 int writeImageObject(char * format, odocstream & os, OutputParams const & runparams,
834 docstring const graphic_label, docstring const attributes)
836 if (runparams.flavor != OutputParams::XML) {
837 os << "<![ %output.print."
842 os <<"<imageobject><imagedata fileref=\"&"
848 if (runparams.flavor == OutputParams::XML) {
849 os << " role=\"" << format << "\"/>" ;
852 os << " format=\"" << format << "\">" ;
854 os << "</imageobject>";
855 if (runparams.flavor != OutputParams::XML) {
856 os << std::endl << "]]>" ;
858 return runparams.flavor == OutputParams::XML ? 0 : 2;
860 // end anonymous namespace
864 // For explanation on inserting graphics into DocBook checkout:
865 // http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
866 // See also the docbook guide at http://www.docbook.org/
867 int InsetGraphics::docbook(Buffer const &, odocstream & os,
868 OutputParams const & runparams) const
870 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
871 // need to switch to MediaObject. However, for now this is sufficient and
873 if (runparams.flavor == OutputParams::XML) {
874 runparams.exportdata->addExternalFile("docbook-xml",
877 runparams.exportdata->addExternalFile("docbook",
880 os << "<inlinemediaobject>";
883 docstring attributes = createDocBookAttributes();
884 r += writeImageObject("png", os, runparams, graphic_label, attributes);
885 r += writeImageObject("pdf", os, runparams, graphic_label, attributes);
886 r += writeImageObject("eps", os, runparams, graphic_label, attributes);
887 r += writeImageObject("bmp", os, runparams, graphic_label, attributes);
889 os << "</inlinemediaobject>";
894 void InsetGraphics::validate(LaTeXFeatures & features) const
896 // If we have no image, we should not require anything.
897 if (params().filename.empty())
900 features.includeFile(graphic_label,
901 removeExtension(params().filename.absFilename()));
903 features.require("graphicx");
905 if (features.runparams().nice) {
906 Buffer const * m_buffer = features.buffer().getMasterBuffer();
907 string const rel_file = removeExtension(params().filename.relFilename(m_buffer->filePath()));
908 if (contains(rel_file, "."))
909 features.require("lyxdot");
912 if (params().subcaption)
913 features.require("subfigure");
917 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
919 // If nothing is changed, just return and say so.
920 if (params() == p && !p.filename.empty())
923 // Copy the new parameters.
926 // Update the display using the new parameters.
927 graphic_->update(params().as_grfxParams());
929 // We have changed data, report it.
934 InsetGraphicsParams const & InsetGraphics::params() const
940 void InsetGraphics::editGraphics(InsetGraphicsParams const & p,
941 Buffer const & buffer) const
943 formats.edit(buffer, p.filename,
944 formats.getFormatFromFile(p.filename));
948 string const InsetGraphicsMailer::name_("graphics");
950 InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset)
955 string const InsetGraphicsMailer::inset2string(Buffer const & buffer) const
957 return params2string(inset_.params(), buffer);
961 void InsetGraphicsMailer::string2params(string const & in,
962 Buffer const & buffer,
963 InsetGraphicsParams & params)
965 params = InsetGraphicsParams();
969 istringstream data(in);
975 if (!lex || name != name_)
976 return print_mailer_error("InsetGraphicsMailer", in, 1, name_);
979 inset.readInsetGraphics(lex, buffer.filePath());
980 params = inset.params();
985 InsetGraphicsMailer::params2string(InsetGraphicsParams const & params,
986 Buffer const & buffer)
989 data << name_ << ' ';
990 params.Write(data, buffer.filePath());
991 data << "\\end_inset\n";