2 * \file insetgraphics.C
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/render_graphic.h"
56 #include "BufferView.h"
57 #include "converter.h"
60 #include "dispatchresult.h"
63 #include "funcrequest.h"
64 #include "FuncStatus.h"
66 #include "LaTeXFeatures.h"
68 #include "lyxlength.h"
70 #include "metricsinfo.h"
72 #include "outputparams.h"
75 #include "frontends/Alert.h"
76 #include "frontends/LyXView.h"
78 #include "support/convert.h"
79 #include "support/filetools.h"
80 #include "support/lyxalgo.h" // lyx::count
81 #include "support/lyxlib.h" // lyx::sum
82 #include "support/lstrings.h"
83 #include "support/os.h"
84 #include "support/systemcall.h"
86 #include <boost/bind.hpp>
87 #include <boost/tuple/tuple.hpp>
91 namespace support = lyx::support;
93 using lyx::support::absolutePath;
94 using lyx::support::bformat;
95 using lyx::support::changeExtension;
96 using lyx::support::compare_timestamps;
97 using lyx::support::contains;
98 using lyx::support::FileName;
99 using lyx::support::float_equal;
100 using lyx::support::getExtension;
101 using lyx::support::isFileReadable;
102 using lyx::support::latex_path;
103 using lyx::support::onlyFilename;
104 using lyx::support::removeExtension;
105 using lyx::support::rtrim;
106 using lyx::support::subst;
107 using lyx::support::Systemcall;
108 using lyx::support::unzipFile;
109 using lyx::support::unzippedFileName;
111 namespace os = lyx::support::os;
116 using std::istringstream;
118 using std::ostringstream;
123 /// Find the most suitable image format for images in \p format
124 /// Note that \p format may be unknown (i. e. an empty string)
125 string findTargetFormat(string const & format, OutputParams const & runparams)
127 // Are we using latex or pdflatex?
128 if (runparams.flavor == OutputParams::PDFLATEX) {
129 lyxerr[Debug::GRAPHICS] << "findTargetFormat: PDF mode" << endl;
130 // Convert postscript to pdf
131 if (format == "eps" || format == "ps")
133 // pdflatex can use jpeg, png and pdf directly
134 if (format == "jpg" || format == "pdf")
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("graph")),
153 graphic_(new RenderGraphic(this))
157 InsetGraphics::InsetGraphics(InsetGraphics const & ig)
159 boost::signals::trackable(),
160 graphic_label(sgml::uniqueID("graph")),
161 graphic_(new RenderGraphic(*ig.graphic_, this))
163 setParams(ig.params());
167 auto_ptr<InsetBase> InsetGraphics::doClone() const
169 return auto_ptr<InsetBase>(new InsetGraphics(*this));
173 InsetGraphics::~InsetGraphics()
175 InsetGraphicsMailer(*this).hideDialog();
179 void InsetGraphics::doDispatch(LCursor & 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(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(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 InsetGraphicsMailer(*this).showDialog(&cur.bv());
210 InsetBase::doDispatch(cur, cmd);
216 bool InsetGraphics::getStatus(LCursor & 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 InsetBase::getStatus(cur, cmd, flag);
232 void InsetGraphics::edit(LCursor & cur, bool)
234 InsetGraphicsMailer(*this).showDialog(&cur.bv());
238 void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
240 graphic_->metrics(mi, dim);
245 void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
247 setPosCache(pi, x, y);
248 graphic_->draw(pi, x, y);
252 InsetBase::EDITABLE InsetGraphics::editable() const
258 void InsetGraphics::write(Buffer const & buf, ostream & os) const
261 params().Write(os, buf.filePath());
265 void InsetGraphics::read(Buffer const & buf, LyXLex & lex)
267 string const token = lex.getString();
269 if (token == "Graphics")
270 readInsetGraphics(lex, buf.filePath());
272 lyxerr[Debug::GRAPHICS] << "Not a Graphics inset!" << endl;
274 graphic_->update(params().as_grfxParams());
278 void InsetGraphics::readInsetGraphics(LyXLex & lex, string const & bufpath)
280 bool finished = false;
282 while (lex.isOK() && !finished) {
285 string const token = lex.getString();
286 lyxerr[Debug::GRAPHICS] << "Token: '" << token << '\''
291 } else if (token == "\\end_inset") {
294 if (!params_.Read(lex, token, bufpath))
295 lyxerr << "Unknown token, " << token << ", skipping."
302 string const InsetGraphics::createLatexOptions() const
304 // Calculate the options part of the command, we must do it to a string
305 // stream since we might have a trailing comma that we would like to remove
306 // before writing it to the output stream.
307 ostringstream options;
308 if (!params().bb.empty())
309 options << "bb=" << rtrim(params().bb) << ',';
314 double const scl = convert<double>(params().scale);
315 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
316 if (!float_equal(scl, 100.0, 0.05))
317 options << "scale=" << scl / 100.0 << ',';
319 if (!params().width.zero())
320 options << "width=" << params().width.asLatexString() << ',';
321 if (!params().height.zero())
322 options << "height=" << params().height.asLatexString() << ',';
323 if (params().keepAspectRatio)
324 options << "keepaspectratio,";
327 // Make sure rotation angle is not very close to zero;
328 // a float can be effectively zero but not exactly zero.
329 if (!params().rotateAngle.empty()
330 && !float_equal(convert<double>(params().rotateAngle), 0.0, 0.001)) {
331 options << "angle=" << params().rotateAngle << ',';
332 if (!params().rotateOrigin.empty()) {
333 options << "origin=" << params().rotateOrigin[0];
334 if (contains(params().rotateOrigin,"Top"))
336 else if (contains(params().rotateOrigin,"Bottom"))
338 else if (contains(params().rotateOrigin,"Baseline"))
344 if (!params().special.empty())
345 options << params().special << ',';
347 string opts = options.str();
349 return opts.substr(0, opts.size() - 1);
353 string const InsetGraphics::toDocbookLength(LyXLength const & len) const
355 ostringstream result;
356 switch (len.unit()) {
357 case LyXLength::SP: // Scaled point (65536sp = 1pt) TeX's smallest unit.
358 result << len.value() * 65536.0 * 72 / 72.27 << "pt";
360 case LyXLength::PT: // Point = 1/72.27in = 0.351mm
361 result << len.value() * 72 / 72.27 << "pt";
363 case LyXLength::BP: // Big point (72bp = 1in), also PostScript point
364 result << len.value() << "pt";
366 case LyXLength::DD: // Didot point = 1/72 of a French inch, = 0.376mm
367 result << len.value() * 0.376 << "mm";
369 case LyXLength::MM: // Millimeter = 2.845pt
370 result << len.value() << "mm";
372 case LyXLength::PC: // Pica = 12pt = 4.218mm
373 result << len.value() << "pc";
375 case LyXLength::CC: // Cicero = 12dd = 4.531mm
376 result << len.value() * 4.531 << "mm";
378 case LyXLength::CM: // Centimeter = 10mm = 2.371pc
379 result << len.value() << "cm";
381 case LyXLength::IN: // Inch = 25.4mm = 72.27pt = 6.022pc
382 result << len.value() << "in";
384 case LyXLength::EX: // Height of a small "x" for the current font.
385 // Obviously we have to compromise here. Any better ratio than 1.5 ?
386 result << len.value() / 1.5 << "em";
388 case LyXLength::EM: // Width of capital "M" in current font.
389 result << len.value() << "em";
391 case LyXLength::MU: // Math unit (18mu = 1em) for positioning in math mode
392 result << len.value() * 18 << "em";
394 case LyXLength::PTW: // Percent of TextWidth
395 case LyXLength::PCW: // Percent of ColumnWidth
396 case LyXLength::PPW: // Percent of PageWidth
397 case LyXLength::PLW: // Percent of LineWidth
398 case LyXLength::PTH: // Percent of TextHeight
399 case LyXLength::PPH: // Percent of Paper
400 // Sigh, this will go wrong.
401 result << len.value() << "%";
404 result << len.asString();
410 string const InsetGraphics::createDocBookAttributes() const
412 // Calculate the options part of the command, we must do it to a string
413 // stream since we copied the code from createLatexParams() ;-)
415 // FIXME: av: need to translate spec -> Docbook XSL spec (http://www.sagehill.net/docbookxsl/ImageSizing.html)
416 // Right now it only works with my version of db2latex :-)
418 ostringstream options;
419 double const scl = convert<double>(params().scale);
420 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
421 if (!float_equal(scl, 100.0, 0.05))
422 options << " scale=\""
423 << static_cast<int>( (scl) + 0.5 )
426 if (!params().width.zero()) {
427 options << " width=\"" << toDocbookLength(params().width) << "\" ";
429 if (!params().height.zero()) {
430 options << " depth=\"" << toDocbookLength(params().height) << "\" ";
432 if (params().keepAspectRatio) {
433 // This will be irrelevant unless both width and height are set
434 options << "scalefit=\"1\" ";
439 if (!params().special.empty())
440 options << params().special << " ";
442 string opts = options.str();
443 // trailing blanks are ok ...
458 std::pair<CopyStatus, string> const
459 copyFileIfNeeded(string const & file_in, string const & file_out)
461 BOOST_ASSERT(absolutePath(file_in));
462 BOOST_ASSERT(absolutePath(file_out));
464 unsigned long const checksum_in = support::sum(file_in);
465 unsigned long const checksum_out = support::sum(file_out);
467 if (checksum_in == checksum_out)
469 return std::make_pair(IDENTICAL_CONTENTS, file_out);
471 Mover const & mover = movers(formats.getFormatFromFile(file_in));
472 bool const success = mover.copy(file_in, file_out);
474 lyxerr[Debug::GRAPHICS]
475 << support::bformat(_("Could not copy the file\n%1$s\n"
476 "into the temporary directory."),
481 CopyStatus status = success ? SUCCESS : FAILURE;
482 return std::make_pair(status, file_out);
486 std::pair<CopyStatus, string> const
487 copyToDirIfNeeded(string const & file_in, string const & dir, bool zipped)
489 using support::rtrim;
491 BOOST_ASSERT(absolutePath(file_in));
493 string const only_path = support::onlyPath(file_in);
494 if (rtrim(support::onlyPath(file_in) , "/") == rtrim(dir, "/"))
495 return std::make_pair(IDENTICAL_PATHS, file_in);
497 string mangled = FileName(file_in).mangledFilename();
499 // We need to change _eps.gz to .eps.gz. The mangled name is
500 // still unique because of the counter in mangledFilename().
501 // We can't just call mangledFilename() with the zip
502 // extension removed, because base.eps and base.eps.gz may
503 // have different content but would get the same mangled
504 // name in this case.
505 string const base = removeExtension(unzippedFileName(file_in));
506 string::size_type const ext_len = file_in.length() - base.length();
507 mangled[mangled.length() - ext_len] = '.';
509 string const file_out = support::makeAbsPath(mangled, dir);
511 return copyFileIfNeeded(file_in, file_out);
515 string const stripExtensionIfPossible(string const & file)
517 // Remove the extension so the LaTeX will use whatever
518 // is appropriate (when there are several versions in
519 // different formats)
520 // This works only if the filename contains no dots besides
521 // the just removed one. We can fool here by replacing all
522 // dots with a macro whose definition is just a dot ;-)
523 // The automatic format selection does not work if the file
525 string const latex_name = latex_path(file,
526 lyx::support::EXCLUDE_EXTENSION);
527 if (contains(latex_name, '"'))
529 return latex_path(removeExtension(file),
530 lyx::support::PROTECT_EXTENSION,
531 lyx::support::ESCAPE_DOTS);
535 string const stripExtensionIfPossible(string const & file, string const & to)
537 // No conversion is needed. LaTeX can handle the graphic file as is.
538 // This is true even if the orig_file is compressed.
539 string const to_format = formats.getFormat(to)->extension();
540 string const file_format = getExtension(file);
541 // for latex .ps == .eps
542 if (to_format == file_format ||
543 (to_format == "eps" && file_format == "ps") ||
544 (to_format == "ps" && file_format == "eps"))
545 return stripExtensionIfPossible(file);
546 return latex_path(file, lyx::support::EXCLUDE_EXTENSION);
552 string const InsetGraphics::prepareFile(Buffer const & buf,
553 OutputParams const & runparams) const
555 // The following code depends on non-empty filenames
556 if (params().filename.empty())
559 string const orig_file = params().filename.absFilename();
560 string const rel_file = params().filename.relFilename(buf.filePath());
562 // previewing source code, no file copying or file format conversion
563 if (runparams.dryrun)
564 return stripExtensionIfPossible(rel_file);
566 // If the file is compressed and we have specified that it
567 // should not be uncompressed, then just return its name and
568 // let LaTeX do the rest!
569 bool const zipped = params().filename.isZipped();
571 // temp_file will contain the file for LaTeX to act on if, for example,
572 // we move it to a temp dir or uncompress it.
573 string temp_file = orig_file;
575 // The master buffer. This is useful when there are multiple levels
577 Buffer const * m_buffer = buf.getMasterBuffer();
579 // Return the output name if we are inside a comment or the file does
581 // We are not going to change the extension or using the name of the
582 // temporary file, the code is already complicated enough.
583 if (runparams.inComment || !isFileReadable(orig_file))
584 return params().filename.outputFilename(m_buffer->filePath());
586 // We place all temporary files in the master buffer's temp dir.
587 // This is possible because we use mangled file names.
588 // This is necessary for DVI export.
589 string const temp_path = m_buffer->temppath();
592 boost::tie(status, temp_file) =
593 copyToDirIfNeeded(orig_file, temp_path, zipped);
595 if (status == FAILURE)
598 // a relative filename should be relative to the master
600 // "nice" means that the buffer is exported to LaTeX format but not
601 // run through the LaTeX compiler.
602 string output_file = os::external_path(runparams.nice ?
603 params().filename.outputFilename(m_buffer->filePath()) :
604 onlyFilename(temp_file));
605 string source_file = runparams.nice ? orig_file : temp_file;
606 string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
607 "latex" : "pdflatex";
610 if (params().noUnzip) {
611 // We don't know whether latex can actually handle
612 // this file, but we can't check, because that would
613 // mean to unzip the file and thereby making the
614 // noUnzip parameter meaningless.
615 lyxerr[Debug::GRAPHICS]
616 << "\tpass zipped file to LaTeX.\n";
618 string const bb_orig_file = changeExtension(orig_file, "bb");
619 if (runparams.nice) {
620 runparams.exportdata->addExternalFile(tex_format,
622 changeExtension(output_file, "bb"));
624 // LaTeX needs the bounding box file in the
626 string bb_file = changeExtension(temp_file, "bb");
627 boost::tie(status, bb_file) =
628 copyFileIfNeeded(bb_orig_file, bb_file);
629 if (status == FAILURE)
631 runparams.exportdata->addExternalFile(tex_format,
634 runparams.exportdata->addExternalFile(tex_format,
635 source_file, output_file);
636 runparams.exportdata->addExternalFile("dvi",
637 source_file, output_file);
638 // We can't strip the extension, because we don't know
639 // the unzipped file format
640 return latex_path(output_file,
641 lyx::support::EXCLUDE_EXTENSION);
644 string const unzipped_temp_file = unzippedFileName(temp_file);
645 output_file = unzippedFileName(output_file);
646 source_file = unzippedFileName(source_file);
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) != ext) {
681 // The LaTeX compiler will not be able to determine
682 // the file format from the extension, so we must
684 string const new_file = changeExtension(temp_file, ext);
685 if (lyx::support::rename(temp_file, new_file)) {
686 temp_file = new_file;
687 output_file = changeExtension(output_file, ext);
689 lyxerr[Debug::GRAPHICS]
690 << "Could not rename file `"
691 << temp_file << "' to `" << new_file
694 // The extension of temp_file might be != ext!
695 runparams.exportdata->addExternalFile(tex_format, source_file,
697 runparams.exportdata->addExternalFile("dvi", source_file,
699 return stripExtensionIfPossible(output_file, to);
702 string const to_file = changeExtension(temp_file, ext);
703 string const output_to_file = changeExtension(output_file, ext);
705 // Do we need to perform the conversion?
706 // Yes if to_file does not exist or if temp_file is newer than to_file
707 if (compare_timestamps(temp_file, to_file) < 0) {
708 lyxerr[Debug::GRAPHICS]
709 << bformat(_("No conversion of %1$s is needed after all"),
712 runparams.exportdata->addExternalFile(tex_format, to_file,
714 runparams.exportdata->addExternalFile("dvi", to_file,
716 return stripExtensionIfPossible(output_file);
719 lyxerr[Debug::GRAPHICS]
720 << "\tThe original file is " << orig_file << "\n"
721 << "\tA copy has been made and convert is to be called with:\n"
722 << "\tfile to convert = " << temp_file << '\n'
723 << "\t from " << from << " to " << to << '\n';
725 if (converters.convert(&buf, temp_file, temp_file, from, to, true)) {
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_file);
736 int InsetGraphics::latex(Buffer const & buf, ostream & 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]
742 << "insetgraphics::latex: Filename = "
743 << params().filename.absFilename() << endl;
745 string const relative_file =
746 params().filename.relFilename(buf.filePath());
748 string const file_ = params().filename.absFilename();
749 bool const file_exists = !file_.empty() && isFileReadable(file_);
750 string const message = file_exists ?
751 string() : string("bb = 0 0 200 100, draft, type=eps");
752 // if !message.empty() then there was no existing file
753 // "filename" found. In this case LaTeX
754 // draws only a rectangle with the above bb and the
755 // not found filename in it.
756 lyxerr[Debug::GRAPHICS]
757 << "\tMessage = \"" << message << '\"' << endl;
759 // These variables collect all the latex code that should be before and
760 // after the actual includegraphics command.
763 // Do we want subcaptions?
764 if (params().subcaption) {
765 if (runparams.moving_arg)
766 before += "\\protect";
767 before += "\\subfigure[" + params().subcaptionText + "]{";
771 if (runparams.moving_arg)
772 before += "\\protect";
774 // We never use the starred form, we use the "clip" option instead.
775 before += "\\includegraphics";
777 // Write the options if there are any.
778 string const opts = createLatexOptions();
779 lyxerr[Debug::GRAPHICS] << "\tOpts = " << opts << endl;
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]
787 << "\tBefore = " << before
788 << "\n\tafter = " << after << endl;
790 string latex_str = before + '{';
791 // Convert the file if necessary.
792 // Remove the extension so LaTeX will use whatever is appropriate
793 // (when there are several versions in different formats)
794 latex_str += prepareFile(buf, runparams);
795 latex_str += '}' + after;
798 lyxerr[Debug::GRAPHICS] << "InsetGraphics::latex outputting:\n"
799 << latex_str << endl;
800 // Return how many newlines we issued.
801 return int(lyx::count(latex_str.begin(), latex_str.end(),'\n'));
805 int InsetGraphics::plaintext(Buffer const &, ostream & os,
806 OutputParams const &) const
808 // No graphics in ascii output. Possible to use gifscii to convert
809 // images to ascii approximation.
810 // 1. Convert file to ascii using gifscii
811 // 2. Read ascii output file and add it to the output stream.
812 // at least we send the filename
813 os << '<' << bformat(_("Graphics file: %1$s"),
814 params().filename.absFilename()) << ">\n";
819 int InsetGraphics::linuxdoc(Buffer const & buf, ostream & os,
820 OutputParams const & runparams) const
822 string const file_name = runparams.nice ?
823 params().filename.relFilename(buf.filePath()):
824 params().filename.absFilename();
826 runparams.exportdata->addExternalFile("linuxdoc",
827 params().filename.absFilename());
828 os << "<eps file=\"" << file_name << "\">\n";
829 os << "<img src=\"" << file_name << "\">";
836 int writeImageObject(char * format, ostream& os, OutputParams const & runparams,
837 string const graphic_label, string const attributes)
839 if (runparams.flavor != OutputParams::XML) {
840 os << "<![ %output.print." << format << "; [" << std::endl;
842 os <<"<imageobject><imagedata fileref=\"&"
843 << graphic_label << ";." << format << "\" " << attributes ;
844 if (runparams.flavor == OutputParams::XML) {
845 os << " role=\"" << format << "\"/>" ;
848 os << " format=\"" << format << "\">" ;
850 os << "</imageobject>";
851 if (runparams.flavor != OutputParams::XML) {
852 os << std::endl << "]]>" ;
854 return runparams.flavor == OutputParams::XML ? 0 : 2;
856 // end anonymous namespace
860 // For explanation on inserting graphics into DocBook checkout:
861 // http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
862 // See also the docbook guide at http://www.docbook.org/
863 int InsetGraphics::docbook(Buffer const &, ostream & os,
864 OutputParams const & runparams) const
866 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
867 // need to switch to MediaObject. However, for now this is sufficient and
869 if (runparams.flavor == OutputParams::XML) {
870 runparams.exportdata->addExternalFile("docbook-xml",
871 params().filename.absFilename());
873 runparams.exportdata->addExternalFile("docbook",
874 params().filename.absFilename());
876 os << "<inlinemediaobject>";
879 string attributes = createDocBookAttributes();
880 r += writeImageObject("png", os, runparams, graphic_label, attributes);
881 r += writeImageObject("pdf", os, runparams, graphic_label, attributes);
882 r += writeImageObject("eps", os, runparams, graphic_label, attributes);
883 r += writeImageObject("bmp", os, runparams, graphic_label, attributes);
885 os << "</inlinemediaobject>";
890 void InsetGraphics::validate(LaTeXFeatures & features) const
892 // If we have no image, we should not require anything.
893 if (params().filename.empty())
896 features.includeFile(graphic_label,
897 removeExtension(params().filename.absFilename()));
899 features.require("graphicx");
901 if (features.runparams().nice) {
902 Buffer const * m_buffer = features.buffer().getMasterBuffer();
904 params().filename.outputFilename(m_buffer->filePath());
905 basename = removeExtension(basename);
906 if(params().filename.isZipped())
907 basename = removeExtension(basename);
908 if (contains(basename, "."))
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 string const file_with_path = p.filename.absFilename();
944 formats.edit(buffer, file_with_path,
945 formats.getFormatFromFile(file_with_path));
949 string const InsetGraphicsMailer::name_("graphics");
951 InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset)
956 string const InsetGraphicsMailer::inset2string(Buffer const & buffer) const
958 return params2string(inset_.params(), buffer);
962 void InsetGraphicsMailer::string2params(string const & in,
963 Buffer const & buffer,
964 InsetGraphicsParams & params)
966 params = InsetGraphicsParams();
970 istringstream data(in);
976 if (!lex || name != name_)
977 return print_mailer_error("InsetGraphicsMailer", in, 1, name_);
980 inset.readInsetGraphics(lex, buffer.filePath());
981 params = inset.params();
986 InsetGraphicsMailer::params2string(InsetGraphicsParams const & params,
987 Buffer const & buffer)
990 data << name_ << ' ';
991 params.Write(data, buffer.filePath());
992 data << "\\end_inset\n";