#include "Converter.h"
#include "Cursor.h"
#include "DispatchResult.h"
+#include "Encoding.h"
#include "ErrorList.h"
#include "Exporter.h"
#include "Format.h"
#include "FuncRequest.h"
#include "FuncStatus.h"
#include "InsetIterator.h"
+#include "LaTeX.h"
#include "LaTeXFeatures.h"
-#include "Length.h"
#include "Lexer.h"
#include "MetricsInfo.h"
#include "Mover.h"
-#include "OutputParams.h"
+#include "output_docbook.h"
#include "output_xhtml.h"
-#include "sgml.h"
+#include "xml.h"
#include "texstream.h"
#include "TocBackend.h"
#include "frontends/alert.h"
#include "frontends/Application.h"
+#include "graphics/GraphicsCache.h"
+#include "graphics/GraphicsCacheItem.h"
+#include "graphics/GraphicsImage.h"
+
#include "support/convert.h"
#include "support/debug.h"
#include "support/docstream.h"
#include "support/ExceptionMessage.h"
#include "support/filetools.h"
#include "support/gettext.h"
+#include "support/Length.h"
#include "support/lyxlib.h"
#include "support/lstrings.h"
#include "support/os.h"
+#include "support/qstring_helpers.h"
#include "support/Systemcall.h"
+#include <QProcess>
+#include <QtGui/QImage>
+
#include <algorithm>
#include <sstream>
-#include <tuple>
using namespace std;
using namespace lyx::support;
namespace {
/// Find the most suitable image format for images in \p format
-/// Note that \p format may be unknown (i. e. an empty string)
+/// Note that \p format may be unknown (i.e. an empty string)
string findTargetFormat(string const & format, OutputParams const & runparams)
{
- // Are we using latex or XeTeX/LuaTeX/pdflatex?
- if (runparams.flavor == OutputParams::PDFLATEX
- || runparams.flavor == OutputParams::XETEX
- || runparams.flavor == OutputParams::LUATEX) {
+ // Are we latexing to DVI or PDF?
+ if (runparams.flavor == Flavor::PdfLaTeX
+ || runparams.flavor == Flavor::XeTeX
+ || runparams.flavor == Flavor::LuaTeX) {
LYXERR(Debug::GRAPHICS, "findTargetFormat: PDF mode");
Format const * const f = theFormats().getFormat(format);
// Convert vector graphics to pdf
// Convert everything else to png
return "png";
}
- // for HTML, we leave the known formats and otherwise convert to png
- if (runparams.flavor == OutputParams::HTML) {
+
+ // for HTML and DocBook, we leave the known formats and otherwise convert to png
+ if (runparams.flavor == Flavor::Html || runparams.flavor == Flavor::DocBook5) {
Format const * const f = theFormats().getFormat(format);
// Convert vector graphics to svg
if (f && f->vectorFormat() && theConverters().isReachable(format, "svg"))
InsetGraphics::InsetGraphics(Buffer * buf)
- : Inset(buf), graphic_label(sgml::uniqueID(from_ascii("graph"))),
+ : Inset(buf), graphic_label(xml::uniqueID(from_ascii("graph"))),
graphic_(new RenderGraphic(this))
{
}
InsetGraphics::InsetGraphics(InsetGraphics const & ig)
: Inset(ig),
- graphic_label(sgml::uniqueID(from_ascii("graph"))),
+ graphic_label(xml::uniqueID(from_ascii("graph"))),
graphic_(new RenderGraphic(*ig.graphic_, this))
{
setParams(ig.params());
void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
{
- graphic_->draw(pi, x, y);
+ graphic_->draw(pi, x, y, params_.darkModeSensitive);
}
}
+void InsetGraphics::outBoundingBox(graphics::BoundingBox & bbox) const
+{
+ if (bbox.empty())
+ return;
+
+ FileName const file(params().filename.absFileName());
+
+ // No correction is necessary for a vector image
+ bool const zipped = theFormats().isZippedFile(file);
+ FileName const unzipped_file = zipped ? unzipFile(file) : file;
+ string const format = theFormats().getFormatFromFile(unzipped_file);
+ if (zipped)
+ unzipped_file.removeFile();
+ if (theFormats().getFormat(format)->vectorFormat())
+ return;
+
+ // Get the actual image dimensions in pixels
+ int width = 0;
+ int height = 0;
+ graphics::Cache & gc = graphics::Cache::get();
+ if (gc.inCache(file)) {
+ graphics::Image const * image = gc.item(file)->image();
+ if (image) {
+ width = image->width();
+ height = image->height();
+ }
+ }
+ // Even if cached, the image is not loaded without GUI
+ if (width == 0 && height == 0) {
+ QImage image(toqstr(file.absFileName()));
+ width = image.width();
+ height = image.height();
+ }
+ if (width == 0 || height == 0)
+ return;
+
+ // Use extractbb to find the dimensions in the typeset output
+ QProcess extractbb;
+ extractbb.start("extractbb", QStringList() << "-O" << toqstr(file.absFileName()));
+ if (!extractbb.waitForStarted() || !extractbb.waitForFinished()) {
+ LYXERR0("Cannot read output bounding box of " << file);
+ return;
+ }
+
+ string const result = extractbb.readAll().constData();
+ size_t i = result.find("%%BoundingBox:");
+ if (i == string::npos) {
+ LYXERR0("Cannot find output bounding box of " << file);
+ return;
+ }
+
+ string const bb = result.substr(i);
+ int out_width = convert<int>(token(bb, ' ', 3));
+ int out_height = convert<int>(token(bb, ' ', 4));
+
+ // Compute the scaling ratio and correct the bounding box
+ double scalex = out_width / double(width);
+ double scaley = out_height / double(height);
+
+ bbox.xl.value(scalex * bbox.xl.value());
+ bbox.xr.value(scalex * bbox.xr.value());
+ bbox.yb.value(scaley * bbox.yb.value());
+ bbox.yt.value(scaley * bbox.yt.value());
+}
+
+
string InsetGraphics::createLatexOptions(bool const ps) const
{
// Calculate the options part of the command, we must do it to a string
// before writing it to the output stream.
ostringstream options;
if (!params().bbox.empty()) {
+ graphics::BoundingBox out_bbox = params().bbox;
+ outBoundingBox(out_bbox);
string const key = ps ? "bb=" : "viewport=";
- options << key << params().bbox.xl.asLatexString() << ' '
- << params().bbox.yb.asLatexString() << ' '
- << params().bbox.xr.asLatexString() << ' '
- << params().bbox.yt.asLatexString() << ',';
+ options << key << out_bbox.xl.asLatexString() << ' '
+ << out_bbox.yb.asLatexString() << ' '
+ << out_bbox.xr.asLatexString() << ' '
+ << out_bbox.yt.asLatexString() << ',';
}
if (params().draft)
options << "draft,";
if (!params().width.zero())
size << "width=" << params().width.asLatexString() << ',';
if (!params().height.zero())
- size << "height=" << params().height.asLatexString() << ',';
+ size << "totalheight=" << params().height.asLatexString() << ',';
if (params().keepAspectRatio)
size << "keepaspectratio,";
}
{
odocstringstream result;
switch (len.unit()) {
- case Length::SP: // Scaled point (65536sp = 1pt) TeX's smallest unit.
- result << len.value() * 65536.0 * 72 / 72.27 << "pt";
- break;
- case Length::PT: // Point = 1/72.27in = 0.351mm
- result << len.value() * 72 / 72.27 << "pt";
- break;
- case Length::BP: // Big point (72bp = 1in), also PostScript point
- result << len.value() << "pt";
- break;
- case Length::DD: // Didot point = 1/72 of a French inch, = 0.376mm
- result << len.value() * 0.376 << "mm";
- break;
- case Length::MM: // Millimeter = 2.845pt
- result << len.value() << "mm";
- break;
- case Length::PC: // Pica = 12pt = 4.218mm
- result << len.value() << "pc";
- break;
- case Length::CC: // Cicero = 12dd = 4.531mm
- result << len.value() * 4.531 << "mm";
- break;
- case Length::CM: // Centimeter = 10mm = 2.371pc
- result << len.value() << "cm";
- break;
- case Length::IN: // Inch = 25.4mm = 72.27pt = 6.022pc
- result << len.value() << "in";
- break;
- case Length::EX: // Height of a small "x" for the current font.
- // Obviously we have to compromise here. Any better ratio than 1.5 ?
- result << len.value() / 1.5 << "em";
- break;
- case Length::EM: // Width of capital "M" in current font.
- result << len.value() << "em";
- break;
- case Length::MU: // Math unit (18mu = 1em) for positioning in math mode
- result << len.value() * 18 << "em";
- break;
- case Length::PTW: // Percent of TextWidth
- case Length::PCW: // Percent of ColumnWidth
- case Length::PPW: // Percent of PageWidth
- case Length::PLW: // Percent of LineWidth
- case Length::PTH: // Percent of TextHeight
- case Length::PPH: // Percent of PaperHeight
- case Length::BLS: // Percent of BaselineSkip
- // Sigh, this will go wrong.
- result << len.value() << "%";
- break;
- default:
- result << len.asDocstring();
- break;
+ case Length::SP: // Scaled point (65536sp = 1pt) TeX's smallest unit.
+ result << len.value() * 65536.0 * 72 / 72.27 << "pt";
+ break;
+ case Length::PT: // Point = 1/72.27in = 0.351mm
+ result << len.value() * 72 / 72.27 << "pt";
+ break;
+ case Length::BP: // Big point (72bp = 1in), also PostScript point
+ result << len.value() << "pt";
+ break;
+ case Length::DD: // Didot point = 1/72 of a French inch, = 0.376mm
+ result << len.value() * 0.376 << "mm";
+ break;
+ case Length::MM: // Millimeter = 2.845pt
+ result << len.value() << "mm";
+ break;
+ case Length::PC: // Pica = 12pt = 4.218mm
+ result << len.value() << "pc";
+ break;
+ case Length::CC: // Cicero = 12dd = 4.531mm
+ result << len.value() * 4.531 << "mm";
+ break;
+ case Length::CM: // Centimeter = 10mm = 2.371pc
+ result << len.value() << "cm";
+ break;
+ case Length::IN: // Inch = 25.4mm = 72.27pt = 6.022pc
+ result << len.value() << "in";
+ break;
+ case Length::EX: // Height of a small "x" for the current font.
+ // Obviously we have to compromise here. Any better ratio than 1.5 ?
+ result << len.value() / 1.5 << "em";
+ break;
+ case Length::EM: // Width of capital "M" in current font.
+ result << len.value() << "em";
+ break;
+ case Length::MU: // Math unit (18mu = 1em) for positioning in math mode
+ result << len.value() * 18 << "em";
+ break;
+ case Length::PTW: // Percent of TextWidth
+ case Length::PCW: // Percent of ColumnWidth
+ case Length::PPW: // Percent of PageWidth
+ case Length::PLW: // Percent of LineWidth
+ case Length::PTH: // Percent of TextHeight
+ case Length::PPH: // Percent of PaperHeight
+ case Length::BLS: // Percent of BaselineSkip
+ // Sigh, this will go wrong.
+ result << len.value() << "%";
+ break;
+ default:
+ result << len.asDocstring();
+ break;
}
return result.str();
}
// Calculate the options part of the command, we must do it to a string
// stream since we copied the code from createLatexParams() ;-)
- // FIXME: av: need to translate spec -> Docbook XSL spec
- // (http://www.sagehill.net/docbookxsl/ImageSizing.html)
- // Right now it only works with my version of db2latex :-)
-
odocstringstream options;
- double const scl = convert<double>(params().scale);
+ auto const scl = convert<double>(params().scale);
if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
if (!float_equal(scl, 100.0, 0.05))
options << " scale=\""
- << support::iround(scl)
- << "\" ";
+ << support::iround(scl)
+ << "\" ";
} else {
- if (!params().width.zero()) {
+ if (!params().width.zero())
options << " width=\"" << toDocbookLength(params().width) << "\" ";
- }
- if (!params().height.zero()) {
+ if (!params().height.zero())
options << " depth=\"" << toDocbookLength(params().height) << "\" ";
- }
- if (params().keepAspectRatio) {
+ if (params().keepAspectRatio)
// This will be irrelevant unless both width and height are set
options << "scalefit=\"1\" ";
- }
}
-
- if (!params().special.empty())
- options << from_ascii(params().special) << " ";
+ // TODO: parse params().special?
// trailing blanks are ok ...
return options.str();
if (rtrim(only_path, "/") == rtrim(dir, "/"))
return make_pair(IDENTICAL_PATHS, FileName(file_in));
- string mangled = file.mangledFileName();
+ string mangled = file.mangledFileName(empty_string(), false, true);
if (theFormats().isZippedFile(file)) {
// We need to change _eps.gz to .eps.gz. The mangled name is
// still unique because of the counter in mangledFileName().
// extension removed, because base.eps and base.eps.gz may
// have different content but would get the same mangled
// name in this case.
+ // Also take into account that if the name of the zipped file
+ // has no zip extension then the name of the unzipped one is
+ // prefixed by "unzipped_".
string const base = removeExtension(file.unzippedFileName());
- string::size_type const ext_len = file_in.length() - base.length();
+ string::size_type const prefix_len =
+ prefixIs(onlyFileName(base), "unzipped_") ? 9 : 0;
+ string::size_type const ext_len =
+ file_in.length() + prefix_len - base.length();
mangled[mangled.length() - ext_len] = '.';
}
FileName const file_out(makeAbsPath(mangled, dir));
{
// No conversion is needed. LaTeX can handle the graphic file as is.
// This is true even if the orig_file is compressed.
- string const to_format = theFormats().getFormat(to)->extension();
+ Format const * f = theFormats().getFormat(to);
+ if (!f)
+ return latex_path(file, EXCLUDE_EXTENSION);
+ string const to_format = f->extension();
string const file_format = getExtension(file);
// for latex .ps == .eps
if (to_format == file_format ||
}
// only show DVI-specific warning when export format is plain latex
if (!isValidDVIFileName(output_file)
- && runparams.flavor == OutputParams::LATEX) {
+ && runparams.flavor == Flavor::LaTeX) {
frontend::Alert::warning(_("Problematic filename for DVI"),
_("The following filename can cause troubles "
"when running the exported file through LaTeX "
if (from == to) {
// source and destination formats are the same
- if (!runparams.nice && !FileName(temp_file).hasExtension(ext)) {
+ if (!runparams.nice && !temp_file.hasExtension(ext)) {
// The LaTeX compiler will not be able to determine
// the file format from the extension, so we must
// change it.
bool const file_exists = !params().filename.empty()
&& params().filename.isReadableFile();
string message;
- if (!file_exists) {
+ // PDFLaTeX and Xe/LuaTeX fall back to draft themselves
+ // and error about it. For DVI/PS, we do something similar here.
+ // We also don't do such tricks when simply exporting a LaTeX file.
+ if (!file_exists && !runparams.nice && runparams.flavor == Flavor::LaTeX) {
+ TeXErrors terr;
+ ErrorList & errorList = buffer().errorList("Export");
+ docstring const s = params().filename.empty() ?
+ _("Graphic not specified. Falling back to `draft' mode.")
+ : bformat(_("Graphic `%1$s' was not found. Falling back to `draft' mode."),
+ params().filename.absoluteFilePath());
+ Paragraph const & par = buffer().paragraphs().front();
+ errorList.push_back(ErrorItem(_("Graphic not found!"), s,
+ {par.id(), 0}, {par.id(), -1}));
+ buffer().bufferErrors(terr, errorList);
if (params().bbox.empty())
message = "bb = 0 0 200 100";
if (!params().draft) {
if (!message.empty())
message += ", ";
message += "type=eps";
+ // If no existing file "filename" was found LaTeX
+ // draws only a rectangle with the above bb and the
+ // not found filename in it.
+ LYXERR(Debug::GRAPHICS, "\tMessage = \"" << message << '\"');
}
- // If no existing file "filename" was found LaTeX
- // draws only a rectangle with the above bb and the
- // not found filename in it.
- LYXERR(Debug::GRAPHICS, "\tMessage = \"" << message << '\"');
// These variables collect all the latex code that should be before and
// after the actual includegraphics command.
string before;
string after;
+ // Write the options if there are any.
+ bool const ps = runparams.flavor == Flavor::LaTeX
+ || runparams.flavor == Flavor::DviLuaTeX;
+ string const opts = createLatexOptions(ps);
+ LYXERR(Debug::GRAPHICS, "\tOpts = " << opts);
+
+ if (contains(opts, '=') && contains(runparams.active_chars, '=')) {
+ // We have a language that makes = active. Deactivate locally
+ // for keyval option parsing (#2005).
+ before = "\\begingroup\\catcode`\\=12";
+ after = "\\endgroup ";
+ }
+
if (runparams.moving_arg)
before += "\\protect";
// We never use the starred form, we use the "clip" option instead.
before += "\\includegraphics";
- // Write the options if there are any.
- bool const ps = runparams.flavor == OutputParams::LATEX
- || runparams.flavor == OutputParams::DVILUATEX;
- string const opts = createLatexOptions(ps);
- LYXERR(Debug::GRAPHICS, "\tOpts = " << opts);
-
if (!opts.empty() && !message.empty())
before += ('[' + opts + ',' + message + ']');
else if (!opts.empty() || !message.empty())
// Convert the file if necessary.
// Remove the extension so LaTeX will use whatever is appropriate
// (when there are several versions in different formats)
- string file_path = prepareFile(runparams);
- latex_str += file_path;
+ docstring file_path = from_utf8(prepareFile(runparams));
+ // we can only output characters covered by the current
+ // encoding!
+ docstring uncodable;
+ docstring encodable_file_path;
+ for (char_type c : file_path) {
+ try {
+ if (runparams.encoding->encodable(c))
+ encodable_file_path += c;
+ else if (runparams.dryrun) {
+ encodable_file_path += "<" + _("LyX Warning: ")
+ + _("uncodable character") + " '";
+ encodable_file_path += docstring(1, c);
+ encodable_file_path += "'>";
+ } else
+ uncodable += c;
+ } catch (EncodingException & /* e */) {
+ if (runparams.dryrun) {
+ encodable_file_path += "<" + _("LyX Warning: ")
+ + _("uncodable character") + " '";
+ encodable_file_path += docstring(1, c);
+ encodable_file_path += "'>";
+ } else
+ uncodable += c;
+ }
+ }
+ if (!uncodable.empty() && !runparams.silent) {
+ // issue a warning about omitted characters
+ // FIXME: should be passed to the error dialog
+ frontend::Alert::warning(_("Uncodable character in file path"),
+ bformat(_("The following characters in one of the graphic paths are\n"
+ "not representable in the current encoding and have been omitted: %1$s.\n"
+ "You need to adapt either the encoding or the path."),
+ uncodable));
+ }
+ latex_str += to_utf8(encodable_file_path);
latex_str += '}' + after;
// FIXME UNICODE
os << from_utf8(latex_str);
}
-static int writeImageObject(char const * format, odocstream & os,
- OutputParams const & runparams, docstring const & graphic_label,
- docstring const & attributes)
-{
- if (runparams.flavor != OutputParams::XML)
- os << "<![ %output.print." << format
- << "; [" << endl;
-
- os <<"<imageobject><imagedata fileref=\"&"
- << graphic_label
- << ";."
- << format
- << "\" "
- << attributes;
-
- if (runparams.flavor == OutputParams::XML)
- os << " role=\"" << format << "\"/>" ;
- else
- os << " format=\"" << format << "\">" ;
-
- os << "</imageobject>";
-
- if (runparams.flavor != OutputParams::XML)
- os << endl << "]]>" ;
-
- return runparams.flavor == OutputParams::XML ? 0 : 2;
-}
-
-
// For explanation on inserting graphics into DocBook checkout:
// http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
// See also the docbook guide at http://www.docbook.org/
-int InsetGraphics::docbook(odocstream & os,
- OutputParams const & runparams) const
+void InsetGraphics::docbook(XMLStream & xs, OutputParams const & runparams) const
{
- // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
- // need to switch to MediaObject. However, for now this is sufficient and
- // easier to use.
- if (runparams.flavor == OutputParams::XML)
- runparams.exportdata->addExternalFile("docbook-xml",
- params().filename);
- else
- runparams.exportdata->addExternalFile("docbook",
- params().filename);
-
- os << "<inlinemediaobject>";
-
- int r = 0;
- docstring attributes = createDocBookAttributes();
- r += writeImageObject("png", os, runparams, graphic_label, attributes);
- r += writeImageObject("pdf", os, runparams, graphic_label, attributes);
- r += writeImageObject("eps", os, runparams, graphic_label, attributes);
- r += writeImageObject("bmp", os, runparams, graphic_label, attributes);
-
- os << "</inlinemediaobject>";
- return r;
+ string fn = params().filename.relFileName(runparams.export_folder);
+ string tag = runparams.docbook_in_float ? "mediaobject" : "inlinemediaobject";
+
+ xs << xml::StartTag(tag);
+ xs << xml::CR();
+ xs << xml::StartTag("imageobject");
+ xs << xml::CR();
+ xs << xml::CompTag("imagedata", "fileref=\"" + fn + "\" " + to_utf8(createDocBookAttributes()));
+ xs << xml::CR();
+ xs << xml::EndTag("imageobject");
+ xs << xml::CR();
+ xs << xml::EndTag(tag);
+ xs << xml::CR();
}
}
-docstring InsetGraphics::xhtml(XHTMLStream & xs, OutputParams const & op) const
+CtObject InsetGraphics::getCtObject(OutputParams const &) const
+{
+ return CtObject::Object;
+}
+
+
+docstring InsetGraphics::xhtml(XMLStream & xs, OutputParams const & op) const
{
string const output_file = op.dryrun ? string() : prepareHTMLFile(op);
<< params().filename << "' for output. File missing?");
string const attr = "src='" + params().filename.absFileName()
+ "' alt='image: " + output_file + "'";
- xs << html::CompTag("img", attr);
+ xs << xml::CompTag("img", attr);
return docstring();
}
string const attr = imgstyle + "src='" + output_file + "' alt='image: "
+ output_file + "'";
- xs << html::CompTag("img", attr);
+ xs << xml::CompTag("img", attr);
return docstring();
}
if (contains(rel_file, "."))
features.require("lyxdot");
}
+ if (features.inDeletedInset()) {
+ features.require("tikz");
+ features.require("ct-tikz-object-sout");
+ }
}
void getGraphicsGroups(Buffer const & b, set<string> & ids)
{
- Inset & inset = b.inset();
- InsetIterator it = inset_iterator_begin(inset);
- InsetIterator const end = inset_iterator_end(inset);
- for (; it != end; ++it) {
- InsetGraphics const * ins = it->asInsetGraphics();
+ for (Inset const & it : b.inset()) {
+ InsetGraphics const * ins = it.asInsetGraphics();
if (!ins)
continue;
InsetGraphicsParams const & inspar = ins->getParams();
int n = 0;
if (groupId.empty())
return n;
- Inset & inset = b.inset();
- InsetIterator it = inset_iterator_begin(inset);
- InsetIterator const end = inset_iterator_end(inset);
- for (; it != end; ++it) {
- InsetGraphics const * ins = it->asInsetGraphics();
+ for (Inset const & it : b.inset()) {
+ InsetGraphics const * ins = it.asInsetGraphics();
if (!ins)
continue;
if (ins->getParams().groupId == groupId)
{
if (groupId.empty())
return string();
- Inset & inset = b.inset();
- InsetIterator it = inset_iterator_begin(inset);
- InsetIterator const end = inset_iterator_end(inset);
- for (; it != end; ++it) {
- InsetGraphics const * ins = it->asInsetGraphics();
+ for (Inset const & it : b.inset()) {
+ InsetGraphics const * ins = it.asInsetGraphics();
if (!ins)
continue;
InsetGraphicsParams const & inspar = ins->getParams();
// This handles undo groups automagically
UndoGroupHelper ugh(&b);
Inset & inset = b.inset();
- InsetIterator it = inset_iterator_begin(inset);
- InsetIterator const end = inset_iterator_end(inset);
- for (; it != end; ++it) {
+ InsetIterator it = begin(inset);
+ InsetIterator const itend = end(inset);
+ for (; it != itend; ++it) {
InsetGraphics * ins = it->asInsetGraphics();
if (!ins)
continue;
projects / features.git / blobdiff