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"
74 #include "EmbeddedFiles.h"
76 #include "frontends/alert.h"
78 #include "support/convert.h"
79 #include "support/filetools.h"
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>
94 using support::bformat;
95 using support::changeExtension;
96 using support::compare_timestamps;
97 using support::contains;
98 using support::DocFileName;
99 using support::FileName;
100 using support::float_equal;
101 using support::getExtension;
102 using support::isValidLaTeXFilename;
103 using support::latex_path;
104 using support::onlyFilename;
105 using support::removeExtension;
106 using support::rtrim;
107 using support::subst;
108 using support::suffixIs;
109 using support::Systemcall;
110 using support::unzipFile;
111 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 Inset * InsetGraphics::clone() const
169 return 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::registerEmbeddedFiles(Buffer const &,
234 EmbeddedFiles & files) const
236 files.registerFile(params().filename.absFilename(),
241 void InsetGraphics::updateEmbeddedFile(Buffer const & buf,
242 EmbeddedFile const & file)
244 BOOST_ASSERT(buf.embeddedFiles().enabled());
245 params_.filename = file;
246 LYXERR(Debug::FILES) << "Update InsetGraphic with File "
247 << params_.filename.toFilesystemEncoding()
248 << ", embedding status: "
249 << params_.filename.embedded() << std::endl;
253 void InsetGraphics::edit(Cursor & cur, bool)
255 InsetGraphicsMailer(*this).showDialog(&cur.bv());
259 void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
261 graphic_->metrics(mi, dim);
265 void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
267 graphic_->draw(pi, x, y);
271 Inset::EDITABLE InsetGraphics::editable() const
277 void InsetGraphics::write(Buffer const & buf, ostream & os) const
280 params().Write(os, buf);
284 void InsetGraphics::read(Buffer const & buf, Lexer & lex)
286 string const token = lex.getString();
288 if (token == "Graphics")
289 readInsetGraphics(lex, buf.filePath());
291 LYXERR(Debug::GRAPHICS) << "Not a Graphics inset!" << endl;
293 // InsetGraphics is read, with filename in params_. We do not know if this file actually
294 // exists or is embedded so we need to get the 'availableFile' from buf.embeddedFiles()
295 if (buf.embeddedFiles().enabled()) {
296 EmbeddedFiles::EmbeddedFileList::const_iterator it =
297 buf.embeddedFiles().find(params_.filename.toFilesystemEncoding());
298 if (it != buf.embeddedFiles().end())
299 // using available file, embedded or external, depending on file availability and
301 params_.filename = *it;
303 graphic_->update(params().as_grfxParams());
307 void InsetGraphics::readInsetGraphics(Lexer & lex, string const & bufpath)
309 bool finished = false;
311 while (lex.isOK() && !finished) {
314 string const token = lex.getString();
315 LYXERR(Debug::GRAPHICS) << "Token: '" << token << '\''
320 } else if (token == "\\end_inset") {
323 if (!params_.Read(lex, token, bufpath))
324 lyxerr << "Unknown token, " << token << ", skipping."
331 string const InsetGraphics::createLatexOptions() const
333 // Calculate the options part of the command, we must do it to a string
334 // stream since we might have a trailing comma that we would like to remove
335 // before writing it to the output stream.
336 ostringstream options;
337 if (!params().bb.empty())
338 options << "bb=" << rtrim(params().bb) << ',';
344 double const scl = convert<double>(params().scale);
345 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
346 if (!float_equal(scl, 100.0, 0.05))
347 size << "scale=" << scl / 100.0 << ',';
349 if (!params().width.zero())
350 size << "width=" << params().width.asLatexString() << ',';
351 if (!params().height.zero())
352 size << "height=" << params().height.asLatexString() << ',';
353 if (params().keepAspectRatio)
354 size << "keepaspectratio,";
356 if (params().scaleBeforeRotation && !size.str().empty())
357 options << size.str();
359 // Make sure rotation angle is not very close to zero;
360 // a float can be effectively zero but not exactly zero.
361 if (!params().rotateAngle.empty()
362 && !float_equal(convert<double>(params().rotateAngle), 0.0, 0.001)) {
363 options << "angle=" << params().rotateAngle << ',';
364 if (!params().rotateOrigin.empty()) {
365 options << "origin=" << params().rotateOrigin[0];
366 if (contains(params().rotateOrigin,"Top"))
368 else if (contains(params().rotateOrigin,"Bottom"))
370 else if (contains(params().rotateOrigin,"Baseline"))
375 if (!params().scaleBeforeRotation && !size.str().empty())
376 options << size.str();
378 if (!params().special.empty())
379 options << params().special << ',';
381 string opts = options.str();
383 if (suffixIs(opts, ','))
384 opts = opts.substr(0, opts.size() - 1);
390 docstring const InsetGraphics::toDocbookLength(Length const & len) const
392 odocstringstream result;
393 switch (len.unit()) {
394 case Length::SP: // Scaled point (65536sp = 1pt) TeX's smallest unit.
395 result << len.value() * 65536.0 * 72 / 72.27 << "pt";
397 case Length::PT: // Point = 1/72.27in = 0.351mm
398 result << len.value() * 72 / 72.27 << "pt";
400 case Length::BP: // Big point (72bp = 1in), also PostScript point
401 result << len.value() << "pt";
403 case Length::DD: // Didot point = 1/72 of a French inch, = 0.376mm
404 result << len.value() * 0.376 << "mm";
406 case Length::MM: // Millimeter = 2.845pt
407 result << len.value() << "mm";
409 case Length::PC: // Pica = 12pt = 4.218mm
410 result << len.value() << "pc";
412 case Length::CC: // Cicero = 12dd = 4.531mm
413 result << len.value() * 4.531 << "mm";
415 case Length::CM: // Centimeter = 10mm = 2.371pc
416 result << len.value() << "cm";
418 case Length::IN: // Inch = 25.4mm = 72.27pt = 6.022pc
419 result << len.value() << "in";
421 case Length::EX: // Height of a small "x" for the current font.
422 // Obviously we have to compromise here. Any better ratio than 1.5 ?
423 result << len.value() / 1.5 << "em";
425 case Length::EM: // Width of capital "M" in current font.
426 result << len.value() << "em";
428 case Length::MU: // Math unit (18mu = 1em) for positioning in math mode
429 result << len.value() * 18 << "em";
431 case Length::PTW: // Percent of TextWidth
432 case Length::PCW: // Percent of ColumnWidth
433 case Length::PPW: // Percent of PageWidth
434 case Length::PLW: // Percent of LineWidth
435 case Length::PTH: // Percent of TextHeight
436 case Length::PPH: // Percent of Paper
437 // Sigh, this will go wrong.
438 result << len.value() << "%";
441 result << len.asDocstring();
447 docstring const InsetGraphics::createDocBookAttributes() const
449 // Calculate the options part of the command, we must do it to a string
450 // stream since we copied the code from createLatexParams() ;-)
452 // FIXME: av: need to translate spec -> Docbook XSL spec (http://www.sagehill.net/docbookxsl/ImageSizing.html)
453 // Right now it only works with my version of db2latex :-)
455 odocstringstream options;
456 double const scl = convert<double>(params().scale);
457 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
458 if (!float_equal(scl, 100.0, 0.05))
459 options << " scale=\""
460 << static_cast<int>( (scl) + 0.5 )
463 if (!params().width.zero()) {
464 options << " width=\"" << toDocbookLength(params().width) << "\" ";
466 if (!params().height.zero()) {
467 options << " depth=\"" << toDocbookLength(params().height) << "\" ";
469 if (params().keepAspectRatio) {
470 // This will be irrelevant unless both width and height are set
471 options << "scalefit=\"1\" ";
476 if (!params().special.empty())
477 options << from_ascii(params().special) << " ";
479 // trailing blanks are ok ...
480 return options.str();
486 enum GraphicsCopyStatus {
494 std::pair<GraphicsCopyStatus, FileName> const
495 copyFileIfNeeded(FileName const & file_in, FileName const & file_out)
497 unsigned long const checksum_in = support::sum(file_in);
498 unsigned long const checksum_out = support::sum(file_out);
500 if (checksum_in == checksum_out)
502 return std::make_pair(IDENTICAL_CONTENTS, file_out);
504 Mover const & mover = getMover(formats.getFormatFromFile(file_in));
505 bool const success = mover.copy(file_in, file_out);
508 LYXERR(Debug::GRAPHICS)
509 << to_utf8(support::bformat(_("Could not copy the file\n%1$s\n"
510 "into the temporary directory."),
511 from_utf8(file_in.absFilename())))
515 GraphicsCopyStatus status = success ? SUCCESS : FAILURE;
516 return std::make_pair(status, file_out);
520 std::pair<GraphicsCopyStatus, FileName> const
521 copyToDirIfNeeded(DocFileName const & file, string const & dir)
523 using support::rtrim;
525 string const file_in = file.absFilename();
526 string const only_path = support::onlyPath(file_in);
527 if (rtrim(support::onlyPath(file_in) , "/") == rtrim(dir, "/"))
528 return std::make_pair(IDENTICAL_PATHS, file_in);
530 string mangled = file.mangledFilename();
531 if (file.isZipped()) {
532 // We need to change _eps.gz to .eps.gz. The mangled name is
533 // still unique because of the counter in mangledFilename().
534 // We can't just call mangledFilename() with the zip
535 // extension removed, because base.eps and base.eps.gz may
536 // have different content but would get the same mangled
537 // name in this case.
538 string const base = removeExtension(file.unzippedFilename());
539 string::size_type const ext_len = file_in.length() - base.length();
540 mangled[mangled.length() - ext_len] = '.';
542 FileName const file_out(support::makeAbsPath(mangled, dir));
544 return copyFileIfNeeded(file, file_out);
548 string const stripExtensionIfPossible(string const & file, bool nice)
550 // Remove the extension so the LaTeX compiler will use whatever
551 // is appropriate (when there are several versions in different
553 // Do this only if we are not exporting for internal usage, because
554 // pdflatex prefers png over pdf and it would pick up the png images
555 // that we generate for preview.
556 // This works only if the filename contains no dots besides
557 // the just removed one. We can fool here by replacing all
558 // dots with a macro whose definition is just a dot ;-)
559 // The automatic format selection does not work if the file
561 string const latex_name = latex_path(file,
562 support::EXCLUDE_EXTENSION);
563 if (!nice || contains(latex_name, '"'))
565 return latex_path(removeExtension(file),
566 support::PROTECT_EXTENSION,
567 support::ESCAPE_DOTS);
571 string const stripExtensionIfPossible(string const & file, string const & to, bool nice)
573 // No conversion is needed. LaTeX can handle the graphic file as is.
574 // This is true even if the orig_file is compressed.
575 string const to_format = formats.getFormat(to)->extension();
576 string const file_format = getExtension(file);
577 // for latex .ps == .eps
578 if (to_format == file_format ||
579 (to_format == "eps" && file_format == "ps") ||
580 (to_format == "ps" && file_format == "eps"))
581 return stripExtensionIfPossible(file, nice);
582 return latex_path(file, support::EXCLUDE_EXTENSION);
588 string const InsetGraphics::prepareFile(Buffer const & buf,
589 OutputParams const & runparams) const
591 // The following code depends on non-empty filenames
592 if (params().filename.empty())
595 string const orig_file = params().filename.absFilename();
596 string const rel_file = params().filename.relFilename(buf.filePath());
598 // previewing source code, no file copying or file format conversion
599 if (runparams.dryrun)
600 return stripExtensionIfPossible(rel_file, runparams.nice);
602 // temp_file will contain the file for LaTeX to act on if, for example,
603 // we move it to a temp dir or uncompress it.
604 FileName temp_file = params().filename;
606 // The master buffer. This is useful when there are multiple levels
608 Buffer const * masterBuffer = buf.masterBuffer();
610 // Return the output name if we are inside a comment or the file does
612 // We are not going to change the extension or using the name of the
613 // temporary file, the code is already complicated enough.
614 if (runparams.inComment || !params().filename.isFileReadable())
615 return params().filename.outputFilename(masterBuffer->filePath());
617 // We place all temporary files in the master buffer's temp dir.
618 // This is possible because we use mangled file names.
619 // This is necessary for DVI export.
620 string const temp_path = masterBuffer->temppath();
622 GraphicsCopyStatus status;
623 boost::tie(status, temp_file) =
624 copyToDirIfNeeded(params().filename, temp_path);
626 if (status == FAILURE)
629 // a relative filename should be relative to the master buffer.
630 // "nice" means that the buffer is exported to LaTeX format but not
631 // run through the LaTeX compiler.
632 string output_file = runparams.nice ?
633 params().filename.outputFilename(masterBuffer->filePath()) :
634 onlyFilename(temp_file.absFilename());
636 if (runparams.nice && !isValidLaTeXFilename(output_file)) {
637 frontend::Alert::warning(_("Invalid filename"),
638 _("The following filename is likely to cause trouble "
639 "when running the exported file through LaTeX: ") +
640 from_utf8(output_file));
643 FileName source_file = runparams.nice ? FileName(params().filename) : temp_file;
644 string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
645 "latex" : "pdflatex";
647 // If the file is compressed and we have specified that it
648 // should not be uncompressed, then just return its name and
649 // let LaTeX do the rest!
650 if (params().filename.isZipped()) {
651 if (params().noUnzip) {
652 // We don't know whether latex can actually handle
653 // this file, but we can't check, because that would
654 // mean to unzip the file and thereby making the
655 // noUnzip parameter meaningless.
656 LYXERR(Debug::GRAPHICS)
657 << "\tpass zipped file to LaTeX.\n";
659 FileName const bb_orig_file = FileName(changeExtension(orig_file, "bb"));
660 if (runparams.nice) {
661 runparams.exportdata->addExternalFile(tex_format,
663 changeExtension(output_file, "bb"));
665 // LaTeX needs the bounding box file in the
667 FileName bb_file = FileName(changeExtension(temp_file.absFilename(), "bb"));
668 boost::tie(status, bb_file) =
669 copyFileIfNeeded(bb_orig_file, bb_file);
670 if (status == FAILURE)
672 runparams.exportdata->addExternalFile(tex_format,
675 runparams.exportdata->addExternalFile(tex_format,
676 source_file, output_file);
677 runparams.exportdata->addExternalFile("dvi",
678 source_file, output_file);
679 // We can't strip the extension, because we don't know
680 // the unzipped file format
681 return latex_path(output_file,
682 support::EXCLUDE_EXTENSION);
685 FileName const unzipped_temp_file =
686 FileName(unzippedFileName(temp_file.absFilename()));
687 output_file = unzippedFileName(output_file);
688 source_file = FileName(unzippedFileName(source_file.absFilename()));
689 if (compare_timestamps(unzipped_temp_file, temp_file) > 0) {
690 // temp_file has been unzipped already and
691 // orig_file has not changed in the meantime.
692 temp_file = unzipped_temp_file;
693 LYXERR(Debug::GRAPHICS)
694 << "\twas already unzipped to " << temp_file
697 // unzipped_temp_file does not exist or is too old
698 temp_file = unzipFile(temp_file);
699 LYXERR(Debug::GRAPHICS)
700 << "\tunzipped to " << temp_file << endl;
704 string const from = formats.getFormatFromFile(temp_file);
706 LYXERR(Debug::GRAPHICS)
707 << "\tCould not get file format." << endl;
709 string const to = findTargetFormat(from, runparams);
710 string const ext = formats.extension(to);
711 LYXERR(Debug::GRAPHICS)
712 << "\t we have: from " << from << " to " << to << '\n';
714 // We're going to be running the exported buffer through the LaTeX
715 // compiler, so must ensure that LaTeX can cope with the graphics
718 LYXERR(Debug::GRAPHICS)
719 << "\tthe orig file is: " << orig_file << endl;
722 if (!runparams.nice && getExtension(temp_file.absFilename()) != ext) {
723 // The LaTeX compiler will not be able to determine
724 // the file format from the extension, so we must
726 FileName const new_file = FileName(changeExtension(temp_file.absFilename(), ext));
727 if (support::rename(temp_file, new_file)) {
728 temp_file = new_file;
729 output_file = changeExtension(output_file, ext);
730 source_file = FileName(changeExtension(source_file.absFilename(), ext));
732 LYXERR(Debug::GRAPHICS)
733 << "Could not rename file `"
734 << temp_file << "' to `" << new_file
737 // The extension of temp_file might be != ext!
738 runparams.exportdata->addExternalFile(tex_format, source_file,
740 runparams.exportdata->addExternalFile("dvi", source_file,
742 return stripExtensionIfPossible(output_file, to, runparams.nice);
745 FileName const to_file = FileName(changeExtension(temp_file.absFilename(), ext));
746 string const output_to_file = changeExtension(output_file, ext);
748 // Do we need to perform the conversion?
749 // Yes if to_file does not exist or if temp_file is newer than to_file
750 if (compare_timestamps(temp_file, to_file) < 0) {
752 LYXERR(Debug::GRAPHICS)
753 << to_utf8(bformat(_("No conversion of %1$s is needed after all"),
754 from_utf8(rel_file)))
756 runparams.exportdata->addExternalFile(tex_format, to_file,
758 runparams.exportdata->addExternalFile("dvi", to_file,
760 return stripExtensionIfPossible(output_to_file, runparams.nice);
763 LYXERR(Debug::GRAPHICS)
764 << "\tThe original file is " << orig_file << "\n"
765 << "\tA copy has been made and convert is to be called with:\n"
766 << "\tfile to convert = " << temp_file << '\n'
767 << "\t from " << from << " to " << to << '\n';
769 // FIXME (Abdel 12/08/06): Is there a need to show these errors?
771 if (theConverters().convert(&buf, temp_file, to_file, params().filename,
773 Converters::try_default | Converters::try_cache)) {
774 runparams.exportdata->addExternalFile(tex_format,
775 to_file, output_to_file);
776 runparams.exportdata->addExternalFile("dvi",
777 to_file, output_to_file);
780 return stripExtensionIfPossible(output_to_file, runparams.nice);
784 int InsetGraphics::latex(Buffer const & buf, odocstream & os,
785 OutputParams const & runparams) const
787 // If there is no file specified or not existing,
788 // just output a message about it in the latex output.
789 LYXERR(Debug::GRAPHICS)
790 << "insetgraphics::latex: Filename = "
791 << params().filename.absFilename() << endl;
793 string const relative_file =
794 params().filename.relFilename(buf.filePath());
796 bool const file_exists = !params().filename.empty()
797 && params().filename.isFileReadable();
798 string const message = file_exists ?
799 string() : string("bb = 0 0 200 100, draft, type=eps");
800 // if !message.empty() then there was no existing file
801 // "filename" found. In this case LaTeX
802 // draws only a rectangle with the above bb and the
803 // not found filename in it.
804 LYXERR(Debug::GRAPHICS)
805 << "\tMessage = \"" << message << '\"' << endl;
807 // These variables collect all the latex code that should be before and
808 // after the actual includegraphics command.
811 // Do we want subcaptions?
812 if (params().subcaption) {
813 if (runparams.moving_arg)
814 before += "\\protect";
815 before += "\\subfigure[" + params().subcaptionText + "]{";
819 if (runparams.moving_arg)
820 before += "\\protect";
822 // We never use the starred form, we use the "clip" option instead.
823 before += "\\includegraphics";
825 // Write the options if there are any.
826 string const opts = createLatexOptions();
827 LYXERR(Debug::GRAPHICS) << "\tOpts = " << opts << endl;
829 if (!opts.empty() && !message.empty())
830 before += ('[' + opts + ',' + message + ']');
831 else if (!opts.empty() || !message.empty())
832 before += ('[' + opts + message + ']');
834 LYXERR(Debug::GRAPHICS)
835 << "\tBefore = " << before
836 << "\n\tafter = " << after << endl;
838 string latex_str = before + '{';
839 // Convert the file if necessary.
840 // Remove the extension so LaTeX will use whatever is appropriate
841 // (when there are several versions in different formats)
842 latex_str += prepareFile(buf, runparams);
843 latex_str += '}' + after;
845 os << from_utf8(latex_str);
847 LYXERR(Debug::GRAPHICS) << "InsetGraphics::latex outputting:\n"
848 << latex_str << endl;
849 // Return how many newlines we issued.
850 return int(std::count(latex_str.begin(), latex_str.end(),'\n'));
854 int InsetGraphics::plaintext(Buffer const & buf, odocstream & os,
855 OutputParams const &) const
857 // No graphics in ascii output. Possible to use gifscii to convert
858 // images to ascii approximation.
859 // 1. Convert file to ascii using gifscii
860 // 2. Read ascii output file and add it to the output stream.
861 // at least we send the filename
863 // FIXME: We have no idea what the encoding of the filename is
865 docstring const str = bformat(buf.B_("Graphics file: %1$s"),
866 from_utf8(params().filename.absFilename()));
867 os << '<' << str << '>';
869 return 2 + str.size();
875 int writeImageObject(char const * format,
877 OutputParams const & runparams,
878 docstring const & graphic_label,
879 docstring const & attributes)
881 if (runparams.flavor != OutputParams::XML) {
882 os << "<![ %output.print."
887 os <<"<imageobject><imagedata fileref=\"&"
893 if (runparams.flavor == OutputParams::XML) {
894 os << " role=\"" << format << "\"/>" ;
897 os << " format=\"" << format << "\">" ;
899 os << "</imageobject>";
900 if (runparams.flavor != OutputParams::XML) {
901 os << std::endl << "]]>" ;
903 return runparams.flavor == OutputParams::XML ? 0 : 2;
905 // end anonymous namespace
909 // For explanation on inserting graphics into DocBook checkout:
910 // http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
911 // See also the docbook guide at http://www.docbook.org/
912 int InsetGraphics::docbook(Buffer const &, odocstream & os,
913 OutputParams const & runparams) const
915 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
916 // need to switch to MediaObject. However, for now this is sufficient and
918 if (runparams.flavor == OutputParams::XML) {
919 runparams.exportdata->addExternalFile("docbook-xml",
922 runparams.exportdata->addExternalFile("docbook",
925 os << "<inlinemediaobject>";
928 docstring attributes = createDocBookAttributes();
929 r += writeImageObject("png", os, runparams, graphic_label, attributes);
930 r += writeImageObject("pdf", os, runparams, graphic_label, attributes);
931 r += writeImageObject("eps", os, runparams, graphic_label, attributes);
932 r += writeImageObject("bmp", os, runparams, graphic_label, attributes);
934 os << "</inlinemediaobject>";
939 void InsetGraphics::validate(LaTeXFeatures & features) const
941 // If we have no image, we should not require anything.
942 if (params().filename.empty())
945 features.includeFile(graphic_label,
946 removeExtension(params().filename.absFilename()));
948 features.require("graphicx");
950 if (features.runparams().nice) {
951 Buffer const * masterBuffer = features.buffer().masterBuffer();
952 string const rel_file = removeExtension(params().filename.relFilename(masterBuffer->filePath()));
953 if (contains(rel_file, "."))
954 features.require("lyxdot");
957 if (params().subcaption)
958 features.require("subfigure");
962 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
964 // If nothing is changed, just return and say so.
965 if (params() == p && !p.filename.empty())
968 // Copy the new parameters.
971 // Update the display using the new parameters.
972 graphic_->update(params().as_grfxParams());
974 // We have changed data, report it.
979 InsetGraphicsParams const & InsetGraphics::params() const
985 void InsetGraphics::editGraphics(InsetGraphicsParams const & p,
986 Buffer const & buffer) const
988 formats.edit(buffer, p.filename,
989 formats.getFormatFromFile(p.filename));
993 string const InsetGraphicsMailer::name_("graphics");
995 InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset)
1000 string const InsetGraphicsMailer::inset2string(Buffer const & buffer) const
1002 return params2string(inset_.params(), buffer);
1006 void InsetGraphicsMailer::string2params(string const & in,
1007 Buffer const & buffer,
1008 InsetGraphicsParams & params)
1010 params = InsetGraphicsParams();
1014 istringstream data(in);
1016 lex.setStream(data);
1020 if (!lex || name != name_)
1021 return print_mailer_error("InsetGraphicsMailer", in, 1, name_);
1023 InsetGraphics inset;
1024 inset.readInsetGraphics(lex, buffer.filePath());
1025 params = inset.params();
1030 InsetGraphicsMailer::params2string(InsetGraphicsParams const & params,
1031 Buffer const & buffer)
1034 data << name_ << ' ';
1035 params.Write(data, buffer);
1036 data << "\\end_inset\n";