]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetInclude.cpp
Do not output deleted rows columns if show changes in output is false
[lyx.git] / src / insets / InsetInclude.cpp
index d7095cc80f2584ee46ee9a8341b1078d36e000a7..09d4be3cc76c55a2dc9bb382800fda72d4db5fab 100644 (file)
@@ -55,6 +55,7 @@
 #include "support/convert.h"
 #include "support/debug.h"
 #include "support/docstream.h"
+#include "support/FileName.h"
 #include "support/FileNameList.h"
 #include "support/filetools.h"
 #include "support/gettext.h"
@@ -151,7 +152,7 @@ string const parentFileName(Buffer const & buffer)
 FileName const includedFileName(Buffer const & buffer,
                              InsetCommandParams const & params)
 {
-       return makeAbsPath(to_utf8(params["filename"]),
+       return makeAbsPath(ltrim(to_utf8(params["filename"])),
                        onlyPath(parentFileName(buffer)));
 }
 
@@ -165,13 +166,30 @@ InsetLabel * createLabel(Buffer * buf, docstring const & label_str)
        return new InsetLabel(buf, icp);
 }
 
+
+char_type replaceCommaInBraces(docstring & params)
+{
+       // Code point from private use area
+       char_type private_char = 0xE000;
+       int count = 0;
+       for (char_type & c : params) {
+               if (c == '{')
+                       ++count;
+               else if (c == '}')
+                       --count;
+               else if (c == ',' && count)
+                       c = private_char;
+       }
+       return private_char;
+}
+
 } // namespace
 
 
 InsetInclude::InsetInclude(Buffer * buf, InsetCommandParams const & p)
        : InsetCommand(buf, p), include_label(uniqueID()),
          preview_(make_unique<RenderMonitoredPreview>(this)), failedtoload_(false),
-         set_label_(false), label_(0), child_buffer_(0)
+         set_label_(false), label_(0), child_buffer_(0), file_exist_(false)
 {
        preview_->connect([=](){ fileChanged(); });
 
@@ -186,7 +204,7 @@ InsetInclude::InsetInclude(Buffer * buf, InsetCommandParams const & p)
 InsetInclude::InsetInclude(InsetInclude const & other)
        : InsetCommand(other), include_label(other.include_label),
          preview_(make_unique<RenderMonitoredPreview>(this)), failedtoload_(false),
-         set_label_(false), label_(0), child_buffer_(0)
+         set_label_(false), label_(0), child_buffer_(0), file_exist_(other.file_exist_)
 {
        preview_->connect([=](){ fileChanged(); });
 
@@ -236,12 +254,19 @@ bool InsetInclude::isCompatibleCommand(string const & s)
 }
 
 
+bool InsetInclude::needsCProtection(bool const /*maintext*/, bool const fragile) const
+{
+       // We need to \cprotect all types in fragile context
+       return fragile;
+}
+
+
 void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
        switch (cmd.action()) {
 
        case LFUN_INSET_EDIT: {
-               editIncluded(to_utf8(params()["filename"]));
+               editIncluded(ltrim(to_utf8(params()["filename"])));
                break;
        }
 
@@ -293,6 +318,16 @@ void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
                break;
        }
 
+       case LFUN_MOUSE_RELEASE: {
+               if (cmd.modifier() == ControlModifier) {
+                       FileName const incfile = includedFileName(buffer(), params());
+                       string const & incname = incfile.absFileName();
+                       editIncluded(incname);
+                       break;
+               }
+       }
+       // fall through
+
        //pass everything else up the chain
        default:
                InsetCommand::doDispatch(cur, cmd);
@@ -301,16 +336,15 @@ void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
 }
 
 
-void InsetInclude::editIncluded(string const & file)
+void InsetInclude::editIncluded(string const & f)
 {
-       string const ext = support::getExtension(file);
-       if (ext == "lyx") {
-               FuncRequest fr(LFUN_BUFFER_CHILD_OPEN, file);
+       if (isLyXFileName(f)) {
+               FuncRequest fr(LFUN_BUFFER_CHILD_OPEN, f);
                lyx::dispatch(fr);
        } else
                // tex file or other text file in verbatim mode
                theFormats().edit(buffer(),
-                       support::makeAbsPath(file, support::onlyPath(buffer().absFileName())),
+                       support::makeAbsPath(f, support::onlyPath(buffer().absFileName())),
                        "text");
 }
 
@@ -361,12 +395,14 @@ bool InsetInclude::isChildIncluded() const
                return true;
        return (std::find(includeonlys.begin(),
                          includeonlys.end(),
-                         to_utf8(params()["filename"])) != includeonlys.end());
+                         ltrim(to_utf8(params()["filename"]))) != includeonlys.end());
 }
 
 
 docstring InsetInclude::screenLabel() const
 {
+       docstring pre = file_exist_ ? docstring() : _("FILE MISSING:");
+
        docstring temp;
 
        switch (type(params())) {
@@ -374,10 +410,10 @@ docstring InsetInclude::screenLabel() const
                        temp = buffer().B_("Input");
                        break;
                case VERB:
-                       temp = buffer().B_("Verbatim Input");
+            temp = buffer().B_("Verbatim");
                        break;
                case VERBAST:
-                       temp = buffer().B_("Verbatim Input*");
+            temp = buffer().B_("Verbatim*");
                        break;
                case INCLUDE:
                        if (isChildIncluded())
@@ -395,12 +431,12 @@ docstring InsetInclude::screenLabel() const
 
        temp += ": ";
 
-       if (params()["filename"].empty())
+       if (ltrim(params()["filename"]).empty())
                temp += "???";
        else
-               temp += from_utf8(onlyFileName(to_utf8(params()["filename"])));
+               temp += from_utf8(onlyFileName(ltrim(to_utf8(params()["filename"]))));
 
-       return temp;
+       return pre.empty() ? temp : pre + from_ascii(" ") + temp;
 }
 
 
@@ -444,8 +480,10 @@ Buffer * InsetInclude::loadIfNeeded() const
        Buffer * child = theBufferList().getBuffer(included_file);
        if (!child) {
                // the readonly flag can/will be wrong, not anymore I think.
-               if (!included_file.exists())
+               if (!included_file.exists()) {
+                       failedtoload_ = true;
                        return 0;
+               }
 
                child = theBufferList().newBuffer(included_file.absFileName());
                if (!child)
@@ -487,11 +525,26 @@ Buffer * InsetInclude::loadIfNeeded() const
 
 void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
 {
-       string incfile = to_utf8(params()["filename"]);
-
-       // Do nothing if no file name has been specified
-       if (incfile.empty())
+       string incfile = ltrim(to_utf8(params()["filename"]));
+
+       // Warn if no file name has been specified
+       if (incfile.empty()) {
+               frontend::Alert::warning(_("No file name specified"),
+                       _("An included file name is empty.\n"
+                          "Ignoring Inclusion"),
+                       true);
                return;
+       }
+       // Warn if file doesn't exist
+       if (!includedFileExist()) {
+               frontend::Alert::warning(_("Included file not found"),
+                       bformat(_("The included file\n"
+                                 "'%1$s'\n"
+                                 "has not been found. LyX will ignore the inclusion."),
+                               from_utf8(incfile)),
+                       true);
+                return;
+       }
 
        FileName const included_file = includedFileName(buffer(), params());
 
@@ -521,7 +574,6 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
        string exppath = incfile;
        if (!runparams.export_folder.empty()) {
                exppath = makeAbsPath(exppath, runparams.export_folder).realPath();
-               FileName(exppath).onlyPath().createPath();
        }
 
        // write it to a file (so far the complete file)
@@ -618,12 +670,18 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                docstring label;
                docstring placement;
                bool isfloat = lstparams.isFloat();
+               // We are going to split parameters at commas, so
+               // replace commas that are not parameter separators
+               // with a code point from the private use area
+               char_type comma = replaceCommaInBraces(parameters);
                // Get float placement, language, caption, and
                // label, then remove the relative options if minted.
                vector<docstring> opts =
                        getVectorFromString(parameters, from_ascii(","), false);
                vector<docstring> latexed_opts;
                for (size_t i = 0; i < opts.size(); ++i) {
+                       // Restore replaced commas
+                       opts[i] = subst(opts[i], comma, ',');
                        if (use_minted && prefixIs(opts[i], from_ascii("float"))) {
                                if (prefixIs(opts[i], from_ascii("float=")))
                                        placement = opts[i].substr(6);
@@ -636,7 +694,7 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                                                                  ParamInfo::HANDLING_LATEXIFY);
                                opts.erase(opts.begin() + i--);
                                if (!use_minted)
-                                       latexed_opts.push_back(from_ascii("caption=") + caption);
+                                       latexed_opts.push_back(from_ascii("caption={") + caption + "}");
                        } else if (prefixIs(opts[i], from_ascii("label="))) {
                                label = params().prepareCommand(runparams, trim(opts[i].substr(6), "{}"),
                                                                ParamInfo::HANDLING_ESCAPE);
@@ -744,6 +802,17 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                                        from_utf8(child_tf),
                                        from_utf8(master_tf));
                                Alert::warning(_("Different use-non-TeX-fonts settings"), text, true);
+                       } 
+                       else if (tmp->params().inputenc != masterBuffer->params().inputenc) {
+                               docstring text = bformat(_("Included file `%1$s'\n"
+                                       "uses input encoding \"%2$s\" [%3$s]\n"
+                                       "while parent file uses input encoding \"%4$s\" [%5$s]."),
+                                       included_file.displayName(),
+                                       _(tmp->params().inputenc),
+                                       from_utf8(tmp->params().encoding().guiName()),
+                                       _(masterBuffer->params().inputenc),
+                                       from_utf8(masterBuffer->params().encoding().guiName()));
+                               Alert::warning(_("Different LaTeX input encodings"), text, true);
                        }
 
                        // Make sure modules used in child are all included in master
@@ -762,7 +831,7 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                                                "uses module `%2$s'\n"
                                                "which is not used in parent file."),
                                                included_file.displayName(), from_utf8(module));
-                                       Alert::warning(_("Module not found"), text);
+                                       Alert::warning(_("Module not found"), text, true);
                                }
                        }
                }
@@ -781,15 +850,25 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                Language const * const oldLang = runparams.master_language;
                // If the master uses non-TeX fonts (XeTeX, LuaTeX),
                // the children must be encoded in plain utf8!
-               runparams.encoding = masterBuffer->params().useNonTeXFonts ?
-                       encodings.fromLyXName("utf8-plain")
-                       : &tmp->params().encoding();
+               if (masterBuffer->params().useNonTeXFonts)
+                       runparams.encoding = encodings.fromLyXName("utf8-plain");
+               else if (oldEnc)
+                       runparams.encoding = oldEnc;
+               else runparams.encoding = &tmp->params().encoding();
                runparams.master_language = buffer().params().language;
                runparams.par_begin = 0;
                runparams.par_end = tmp->paragraphs().size();
                runparams.is_child = true;
-               if (!tmp->makeLaTeXFile(tmpwritefile, masterFileName(buffer()).
-                               onlyPath().absFileName(), runparams, Buffer::OnlyBody)) {
+               Buffer::ExportStatus retval =
+                       tmp->makeLaTeXFile(tmpwritefile, masterFileName(buffer()).
+                               onlyPath().absFileName(), runparams, Buffer::OnlyBody);
+               if (retval == Buffer::ExportKilled && buffer().isClone() &&
+                     buffer().isExporting()) {
+                 // We really shouldn't get here, I don't think.
+                 LYXERR0("No conversion exception?");
+                       throw ConversionException();
+               }
+               else if (retval != Buffer::ExportSuccess) {
                        if (!runparams.silent) {
                                docstring msg = bformat(_("Included file `%1$s' "
                                        "was not exported correctly.\n "
@@ -798,10 +877,8 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                                ErrorList const & el = tmp->errorList("Export");
                                if (!el.empty())
                                        msg = bformat(from_ascii("%1$s\n\n%2$s\n\n%3$s"),
-                                               msg, el.begin()->error,
-                                               el.begin()->description);
-                               throw ExceptionMessage(ErrorException, _("Error: "),
-                                                      msg);
+                                               msg, el.begin()->error, el.begin()->description);
+                               throw ExceptionMessage(ErrorException, _("Error: "), msg);
                        }
                }
                runparams.encoding = oldEnc;
@@ -811,22 +888,23 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                // If needed, use converters to produce a latex file from the child
                if (tmpwritefile != writefile) {
                        ErrorList el;
-                       bool const success =
+                       Converters::RetVal const conv_retval =
                                theConverters().convert(tmp, tmpwritefile, writefile,
-                                                       included_file,
-                                                       inc_format, tex_format, el);
-
-                       if (!success && !runparams.silent) {
+                                   included_file, inc_format, tex_format, el);
+                       if (conv_retval == Converters::KILLED && buffer().isClone() &&
+                           buffer().isExporting()) {
+                               // We really shouldn't get here, I don't think.
+                               LYXERR0("No conversion exception?");
+                               throw ConversionException();
+                       } else if (conv_retval != Converters::SUCCESS && !runparams.silent) {
                                docstring msg = bformat(_("Included file `%1$s' "
                                                "was not exported correctly.\n "
                                                "LaTeX export is probably incomplete."),
                                                included_file.displayName());
                                if (!el.empty())
                                        msg = bformat(from_ascii("%1$s\n\n%2$s\n\n%3$s"),
-                                                       msg, el.begin()->error,
-                                                       el.begin()->description);
-                               throw ExceptionMessage(ErrorException, _("Error: "),
-                                                      msg);
+                                               msg, el.begin()->error, el.begin()->description);
+                               throw ExceptionMessage(ErrorException, _("Error: "), msg);
                        }
                }
        } else {
@@ -879,7 +957,7 @@ docstring InsetInclude::xhtml(XHTMLStream & xs, OutputParams const & rp) const
                        frontend::Alert::warning(_("Unsupported Inclusion"),
                                         bformat(_("LyX does not know how to include non-LyX files when "
                                                   "generating HTML output. Offending file:\n%1$s"),
-                                                   params()["filename"]));
+                                                   ltrim(params()["filename"])));
                return docstring();
        }
 
@@ -890,7 +968,7 @@ docstring InsetInclude::xhtml(XHTMLStream & xs, OutputParams const & rp) const
        if (buffer().absFileName() == included_file.absFileName()) {
                Alert::error(_("Recursive input"),
                               bformat(_("Attempted to include file %1$s in itself! "
-                              "Ignoring inclusion."), params()["filename"]));
+                              "Ignoring inclusion."), ltrim(params()["filename"])));
                return docstring();
        }
 
@@ -925,15 +1003,20 @@ int InsetInclude::plaintext(odocstringstream & os,
        // or are generating this for advanced search
        if (op.for_tooltip || op.for_toc || op.for_search) {
                os << '[' << screenLabel() << '\n'
-                  << getParam("filename") << "\n]";
+                  << ltrim(getParam("filename")) << "\n]";
                return PLAINTEXT_NEWLINE + 1; // one char on a separate line
        }
 
        if (isVerbatim(params()) || isListings(params())) {
-               os << '[' << screenLabel() << '\n'
-                  // FIXME: We don't know the encoding of the file, default to UTF-8.
-                  << includedFileName(buffer(), params()).fileContents("UTF-8")
-                  << "\n]";
+               if (op.for_search) {
+                       os << '[' << screenLabel() << ']';
+               }
+               else {
+                       os << '[' << screenLabel() << '\n'
+                          // FIXME: We don't know the encoding of the file, default to UTF-8.
+                          << includedFileName(buffer(), params()).fileContents("UTF-8")
+                          << "\n]";
+               }
                return PLAINTEXT_NEWLINE + 1; // one char on a separate line
        }
 
@@ -950,7 +1033,7 @@ int InsetInclude::plaintext(odocstringstream & os,
 
 int InsetInclude::docbook(odocstream & os, OutputParams const & runparams) const
 {
-       string incfile = to_utf8(params()["filename"]);
+       string incfile = ltrim(to_utf8(params()["filename"]));
 
        // Do nothing if no file name has been specified
        if (incfile.empty())
@@ -1014,7 +1097,7 @@ void InsetInclude::validate(LaTeXFeatures & features) const
 {
        LATTEST(&buffer() == &features.buffer());
 
-       string incfile = to_utf8(params()["filename"]);
+       string incfile = ltrim(to_utf8(params()["filename"]));
        string const included_file =
                includedFileName(buffer(), params()).absFileName();
 
@@ -1235,8 +1318,12 @@ void InsetInclude::addToToc(DocIterator const & cpit, bool output_active,
                b.pushItem(cpit, screenLabel(), output_active);
                InsetListingsParams p(to_utf8(params()["lstparams"]));
                b.argumentItem(from_utf8(p.getParamValue("caption")));
-               b.pop();
-       } else {
+        b.pop();
+    } else if (isVerbatim(params())) {
+        TocBuilder & b = backend.builder("child");
+        b.pushItem(cpit, screenLabel(), output_active);
+        b.pop();
+    } else {
                Buffer const * const childbuffer = getChildBuffer();
 
                TocBuilder & b = backend.builder("child");
@@ -1288,6 +1375,8 @@ void InsetInclude::updateCommand()
 
 void InsetInclude::updateBuffer(ParIterator const & it, UpdateType utype)
 {
+       file_exist_ = includedFileExist();
+
        button_.update(screenLabel(), true, false);
 
        Buffer const * const childbuffer = getChildBuffer();
@@ -1317,4 +1406,14 @@ void InsetInclude::updateBuffer(ParIterator const & it, UpdateType utype)
 }
 
 
+bool InsetInclude::includedFileExist() const
+{
+       // check whether the included file exist
+       string incFileName = ltrim(to_utf8(params()["filename"]));
+       FileName fn =
+               support::makeAbsPath(incFileName,
+                                    support::onlyPath(buffer().absFileName()));
+       return fn.exists();
+}
+
 } // namespace lyx