]> git.lyx.org Git - features.git/blobdiff - src/insets/InsetGraphics.cpp
Completion: handle undo in insets' insertCompletion methods
[features.git] / src / insets / InsetGraphics.cpp
index 2a291aafebb517db4a76eb8b5f49944912870bb4..2d93f157fbb975d9a5d1aaa16f44b63c4a930a6c 100644 (file)
@@ -61,14 +61,14 @@ TODO
 #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"
 
@@ -85,6 +85,7 @@ TODO
 #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"
@@ -92,10 +93,10 @@ TODO
 #include "support/Systemcall.h"
 
 #include <QProcess>
+#include <QtGui/QImage>
 
 #include <algorithm>
 #include <sstream>
-#include <tuple>
 
 using namespace std;
 using namespace lyx::support;
@@ -107,13 +108,13 @@ namespace Alert = frontend::Alert;
 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 latexing to DVI or PDF?
-       if (runparams.flavor == OutputParams::PDFLATEX
-           || runparams.flavor == OutputParams::XETEX
-           || runparams.flavor == OutputParams::LUATEX) {
+       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
@@ -125,8 +126,9 @@ string findTargetFormat(string const & format, OutputParams const & runparams)
                // 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"))
@@ -177,7 +179,7 @@ void readInsetGraphics(Lexer & lex, Buffer const & buf, bool allowOrigin,
 
 
 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))
 {
 }
@@ -185,7 +187,7 @@ InsetGraphics::InsetGraphics(Buffer * buf)
 
 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());
@@ -292,7 +294,7 @@ void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
 
 void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
 {
-       graphic_->draw(pi, x, y);
+       graphic_->draw(pi, x, y, params_.darkModeSensitive);
 }
 
 
@@ -319,13 +321,13 @@ void InsetGraphics::outBoundingBox(graphics::BoundingBox & bbox) const
 
        FileName const file(params().filename.absFileName());
 
-       // No correction is necessary for a postscript image
+       // 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 (Formats::isPostScriptFileFormat(format))
+       if (theFormats().getFormat(format)->vectorFormat())
                return;
 
        // Get the actual image dimensions in pixels
@@ -339,6 +341,12 @@ void InsetGraphics::outBoundingBox(graphics::BoundingBox & bbox) const
                        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;
 
@@ -442,56 +450,56 @@ docstring InsetGraphics::toDocbookLength(Length const & len) const
 {
        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();
 }
@@ -502,33 +510,24 @@ docstring InsetGraphics::createDocBookAttributes() const
        // 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();
@@ -579,7 +578,7 @@ copyToDirIfNeeded(DocFileName const & file, string const & dir)
        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().
@@ -627,7 +626,10 @@ string const stripExtensionIfPossible(string const & file, string const & to, bo
 {
        // 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 ||
@@ -695,7 +697,7 @@ string InsetGraphics::prepareFile(OutputParams const & runparams) const
                }
                // 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 "
@@ -741,7 +743,7 @@ string InsetGraphics::prepareFile(OutputParams const & runparams) const
 
        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.
@@ -820,7 +822,20 @@ void InsetGraphics::latex(otexstream & os,
        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) {
@@ -831,11 +846,11 @@ void InsetGraphics::latex(otexstream & os,
                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.
@@ -843,8 +858,8 @@ void InsetGraphics::latex(otexstream & os,
        string after;
 
        // Write the options if there are any.
-       bool const ps = runparams.flavor == OutputParams::LATEX
-               || runparams.flavor == OutputParams::DVILUATEX;
+       bool const ps = runparams.flavor == Flavor::LaTeX
+               || runparams.flavor == Flavor::DviLuaTeX;
        string const opts = createLatexOptions(ps);
        LYXERR(Debug::GRAPHICS, "\tOpts = " << opts);
 
@@ -877,8 +892,7 @@ void InsetGraphics::latex(otexstream & os,
        // encoding!
        docstring uncodable;
        docstring encodable_file_path;
-       for (size_type i = 0 ; i < file_path.size() ; ++i) {
-               char_type c = file_path[i];
+       for (char_type c : file_path) {
                try {
                        if (runparams.encoding->encodable(c))
                                encodable_file_path += c;
@@ -936,62 +950,24 @@ int InsetGraphics::plaintext(odocstringstream & os,
 }
 
 
-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();
 }
 
 
@@ -1078,7 +1054,13 @@ string InsetGraphics::prepareHTMLFile(OutputParams const & runparams) const
 }
 
 
-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);
 
@@ -1087,7 +1069,7 @@ docstring InsetGraphics::xhtml(XHTMLStream & xs, OutputParams const & op) const
                        << 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();
        }
 
@@ -1115,7 +1097,7 @@ docstring InsetGraphics::xhtml(XHTMLStream & xs, OutputParams const & op) const
 
        string const attr = imgstyle + "src='" + output_file + "' alt='image: "
                            + output_file + "'";
-       xs << html::CompTag("img", attr);
+       xs << xml::CompTag("img", attr);
        return docstring();
 }
 
@@ -1136,6 +1118,10 @@ void InsetGraphics::validate(LaTeXFeatures & features) const
                if (contains(rel_file, "."))
                        features.require("lyxdot");
        }
+       if (features.inDeletedInset()) {
+               features.require("tikz");
+               features.require("ct-tikz-object-sout");
+       }
 }
 
 
@@ -1222,11 +1208,8 @@ namespace graphics {
 
 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();
@@ -1241,11 +1224,8 @@ int countGroupMembers(Buffer const & b, string const & groupId)
        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)
@@ -1259,11 +1239,8 @@ string getGroupParams(Buffer const & b, string const & 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();
@@ -1285,9 +1262,9 @@ void unifyGraphicsGroups(Buffer & b, string const & argument)
        // 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;