X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetInclude.cpp;h=b0d2be4f0317db8804ecb67b726fad4da8f709b5;hb=aa794a8806ec309240bf8f4a64d84adb9b94dd64;hp=c889f1c94251bb8cad3113a15a56b32a57ef823a;hpb=26813996e2bdb4a71c9200729844e3cfe8feda78;p=lyx.git diff --git a/src/insets/InsetInclude.cpp b/src/insets/InsetInclude.cpp old mode 100755 new mode 100644 index c889f1c942..b0d2be4f03 --- a/src/insets/InsetInclude.cpp +++ b/src/insets/InsetInclude.cpp @@ -160,7 +160,7 @@ FileName const includedFileName(Buffer const & buffer, InsetLabel * createLabel(Buffer * buf, docstring const & label_str) { if (label_str.empty()) - return 0; + return nullptr; InsetCommandParams icp(LABEL_CODE); icp["name"] = label_str; return new InsetLabel(buf, icp); @@ -189,7 +189,7 @@ char_type replaceCommaInBraces(docstring & params) InsetInclude::InsetInclude(Buffer * buf, InsetCommandParams const & p) : InsetCommand(buf, p), include_label(uniqueID()), preview_(make_unique(this)), failedtoload_(false), - set_label_(false), label_(0), child_buffer_(0), file_exist_(false) + set_label_(false), label_(nullptr), child_buffer_(nullptr), file_exist_(false) { preview_->connect([=](){ fileChanged(); }); @@ -204,7 +204,8 @@ InsetInclude::InsetInclude(Buffer * buf, InsetCommandParams const & p) InsetInclude::InsetInclude(InsetInclude const & other) : InsetCommand(other), include_label(other.include_label), preview_(make_unique(this)), failedtoload_(false), - set_label_(false), label_(0), child_buffer_(0), file_exist_(other.file_exist_) + set_label_(false), label_(nullptr), child_buffer_(nullptr), + file_exist_(other.file_exist_) { preview_->connect([=](){ fileChanged(); }); @@ -289,7 +290,7 @@ void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd) if (new_label.empty()) { delete label_; - label_ = 0; + label_ = nullptr; } else { docstring old_label; if (label_) @@ -374,7 +375,10 @@ bool InsetInclude::getStatus(Cursor & cur, FuncRequest const & cmd, void InsetInclude::setParams(InsetCommandParams const & p) { // invalidate the cache - child_buffer_ = 0; + child_buffer_ = nullptr; + + // reset in order to allow loading new file + failedtoload_ = false; InsetCommand::setParams(p); set_label_ = false; @@ -410,10 +414,10 @@ docstring InsetInclude::screenLabel() const temp = buffer().B_("Input"); break; case VERB: - temp = buffer().B_("Verbatim"); + temp = buffer().B_("Verbatim"); break; case VERBAST: - temp = buffer().B_("Verbatim*"); + temp = buffer().B_("Verbatim*"); break; case INCLUDE: if (isChildIncluded()) @@ -447,7 +451,7 @@ Buffer * InsetInclude::getChildBuffer() const // FIXME RECURSIVE INCLUDE // This isn't sufficient, as the inclusion could be downstream. // But it'll have to do for now. - return (childBuffer == &buffer()) ? 0 : childBuffer; + return (childBuffer == &buffer()) ? nullptr : childBuffer; } @@ -460,43 +464,45 @@ Buffer * InsetInclude::loadIfNeeded() const // Don't try to load it again if we failed before. if (failedtoload_ || isVerbatim(params()) || isListings(params())) - return 0; + return nullptr; FileName const included_file = includedFileName(buffer(), params()); // Use cached Buffer if possible. - if (child_buffer_ != 0) { + if (child_buffer_ != nullptr) { if (theBufferList().isLoaded(child_buffer_) // additional sanity check: make sure the Buffer really is // associated with the file we want. && child_buffer_ == theBufferList().getBuffer(included_file)) return child_buffer_; // Buffer vanished, so invalidate cache and try to reload. - child_buffer_ = 0; + child_buffer_ = nullptr; } if (!isLyXFileName(included_file.absFileName())) - return 0; + return nullptr; Buffer * child = theBufferList().getBuffer(included_file); if (!child) { // the readonly flag can/will be wrong, not anymore I think. - if (!included_file.exists()) - return 0; + if (!included_file.exists()) { + failedtoload_ = true; + return nullptr; + } child = theBufferList().newBuffer(included_file.absFileName()); if (!child) // Buffer creation is not possible. - return 0; + return nullptr; // Set parent before loading, such that macros can be tracked child->setParent(&buffer()); if (child->loadLyXFile() != Buffer::ReadSuccess) { failedtoload_ = true; - child->setParent(0); + child->setParent(nullptr); //close the buffer we just opened theBufferList().release(child); - return 0; + return nullptr; } if (!child->errorList("Parse").empty()) { @@ -569,9 +575,10 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const from_utf8(masterBuffer->filePath()))); } - string const exppath = runparams.export_folder.empty() ? - incfile : - makeAbsPath(exppath, runparams.export_folder).realPath(); + string exppath = incfile; + if (!runparams.export_folder.empty()) { + exppath = makeAbsPath(exppath, runparams.export_folder).realPath(); + } // write it to a file (so far the complete file) string exportfile; @@ -759,149 +766,8 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const // in a comment or doing a dryrun return; - if (isInputOrInclude(params()) && - isLyXFileName(included_file.absFileName())) { - // if it's a LyX file and we're inputting or including, - // try to load it so we can write the associated latex - - Buffer * tmp = loadIfNeeded(); - if (!tmp) { - if (!runparams.silent) { - docstring text = bformat(_("Could not load included " - "file\n`%1$s'\n" - "Please, check whether it actually exists."), - included_file.displayName()); - throw ExceptionMessage(ErrorException, _("Error: "), - text); - } - return; - } - - if (!runparams.silent) { - if (tmp->params().baseClass() != masterBuffer->params().baseClass()) { - // FIXME UNICODE - docstring text = bformat(_("Included file `%1$s'\n" - "has textclass `%2$s'\n" - "while parent file has textclass `%3$s'."), - included_file.displayName(), - from_utf8(tmp->params().documentClass().name()), - from_utf8(masterBuffer->params().documentClass().name())); - Alert::warning(_("Different textclasses"), text, true); - } - - string const child_tf = tmp->params().useNonTeXFonts ? "true" : "false"; - string const master_tf = masterBuffer->params().useNonTeXFonts ? "true" : "false"; - if (tmp->params().useNonTeXFonts != masterBuffer->params().useNonTeXFonts) { - docstring text = bformat(_("Included file `%1$s'\n" - "has use-non-TeX-fonts set to `%2$s'\n" - "while parent file has use-non-TeX-fonts set to `%3$s'."), - included_file.displayName(), - 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 - // FIXME It might be worth loading the children's modules into the master - // over in BufferParams rather than doing this check. - LayoutModuleList const masterModules = masterBuffer->params().getModules(); - LayoutModuleList const childModules = tmp->params().getModules(); - LayoutModuleList::const_iterator it = childModules.begin(); - LayoutModuleList::const_iterator end = childModules.end(); - for (; it != end; ++it) { - string const module = *it; - LayoutModuleList::const_iterator found = - find(masterModules.begin(), masterModules.end(), module); - if (found == masterModules.end()) { - docstring text = bformat(_("Included file `%1$s'\n" - "uses module `%2$s'\n" - "which is not used in parent file."), - included_file.displayName(), from_utf8(module)); - Alert::warning(_("Module not found"), text, true); - } - } - } - - tmp->markDepClean(masterBuffer->temppath()); - - // Don't assume the child's format is latex - string const inc_format = tmp->params().bufferFormat(); - FileName const tmpwritefile(changeExtension(writefile.absFileName(), - theFormats().extension(inc_format))); - - // FIXME: handle non existing files - // The included file might be written in a different encoding - // and language. - Encoding const * const oldEnc = runparams.encoding; - 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") : oldEnc; - runparams.master_language = buffer().params().language; - runparams.par_begin = 0; - runparams.par_end = tmp->paragraphs().size(); - runparams.is_child = true; - 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 " - "LaTeX export is probably incomplete."), - included_file.displayName()); - 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); - } - } - runparams.encoding = oldEnc; - runparams.master_language = oldLang; - runparams.is_child = false; - - // If needed, use converters to produce a latex file from the child - if (tmpwritefile != writefile) { - ErrorList el; - Converters::RetVal const retval = - theConverters().convert(tmp, tmpwritefile, writefile, - included_file, inc_format, tex_format, el); - if (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 (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); - } - } - } else { + if (!isInputOrInclude(params()) || + !isLyXFileName(included_file.absFileName())) { // In this case, it's not a LyX file, so we copy the file // to the temp dir, so that .aux files etc. are not created // in the original dir. Files included by this file will be @@ -909,7 +775,6 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const // input@path, see ../Buffer.cpp. unsigned long const checksum_in = included_file.checksum(); unsigned long const checksum_out = writefile.checksum(); - if (checksum_in != checksum_out) { if (!included_file.copyTo(writefile)) { // FIXME UNICODE @@ -917,9 +782,153 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const to_utf8(bformat(_("Could not copy the file\n%1$s\n" "into the temporary directory."), from_utf8(included_file.absFileName())))); - return; } } + return; + } + + + // it's a LyX file and we're inputting or including, so + // try to load it so we can write the associated latex + Buffer * tmp = loadIfNeeded(); + if (!tmp) { + if (!runparams.silent) { + docstring text = bformat(_("Could not load included " + "file\n`%1$s'\n" + "Please, check whether it actually exists."), + included_file.displayName()); + throw ExceptionMessage(ErrorException, _("Error: "), + text); + } + return; + } + + if (!runparams.silent) { + if (tmp->params().baseClass() != masterBuffer->params().baseClass()) { + // FIXME UNICODE + docstring text = bformat(_("Included file `%1$s'\n" + "has textclass `%2$s'\n" + "while parent file has textclass `%3$s'."), + included_file.displayName(), + from_utf8(tmp->params().documentClass().name()), + from_utf8(masterBuffer->params().documentClass().name())); + Alert::warning(_("Different textclasses"), text, true); + } + + string const child_tf = tmp->params().useNonTeXFonts ? "true" : "false"; + string const master_tf = masterBuffer->params().useNonTeXFonts ? "true" : "false"; + if (tmp->params().useNonTeXFonts != masterBuffer->params().useNonTeXFonts) { + docstring text = bformat(_("Included file `%1$s'\n" + "has use-non-TeX-fonts set to `%2$s'\n" + "while parent file has use-non-TeX-fonts set to `%3$s'."), + included_file.displayName(), + 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 + // FIXME It might be worth loading the children's modules into the master + // over in BufferParams rather than doing this check. + LayoutModuleList const masterModules = masterBuffer->params().getModules(); + LayoutModuleList const childModules = tmp->params().getModules(); + LayoutModuleList::const_iterator it = childModules.begin(); + LayoutModuleList::const_iterator end = childModules.end(); + for (; it != end; ++it) { + string const module = *it; + LayoutModuleList::const_iterator found = + find(masterModules.begin(), masterModules.end(), module); + if (found == masterModules.end()) { + docstring text = bformat(_("Included file `%1$s'\n" + "uses module `%2$s'\n" + "which is not used in parent file."), + included_file.displayName(), from_utf8(module)); + Alert::warning(_("Module not found"), text, true); + } + } + } + + tmp->markDepClean(masterBuffer->temppath()); + + // Don't assume the child's format is latex + string const inc_format = tmp->params().bufferFormat(); + FileName const tmpwritefile(changeExtension(writefile.absFileName(), + theFormats().extension(inc_format))); + + // FIXME: handle non existing files + // The included file might be written in a different encoding + // and language. + Encoding const * const oldEnc = runparams.encoding; + Language const * const oldLang = runparams.master_language; + // If the master uses non-TeX fonts (XeTeX, LuaTeX), + // the children must be encoded in plain utf8! + 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; + 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 " + "LaTeX export is probably incomplete."), + included_file.displayName()); + 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); + } + } + runparams.encoding = oldEnc; + runparams.master_language = oldLang; + runparams.is_child = false; + + // If needed, use converters to produce a latex file from the child + if (tmpwritefile != writefile) { + ErrorList el; + Converters::RetVal const conv_retval = + theConverters().convert(tmp, tmpwritefile, writefile, + 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); + } } } @@ -1180,7 +1189,7 @@ void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const } else { if (!set_label_) { set_label_ = true; - button_.update(screenLabel(), true, false); + button_.update(screenLabel(), true, false, !file_exist_); } button_.metrics(mi, dim); } @@ -1267,7 +1276,7 @@ docstring latexString(InsetInclude const & inset) otexstream os(ods); // We don't need to set runparams.encoding since this will be done // by latex() anyway. - OutputParams runparams(0); + OutputParams runparams(nullptr); runparams.flavor = OutputParams::LATEX; runparams.for_preview = true; inset.latex(os, runparams); @@ -1312,12 +1321,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 if (isVerbatim(params())) { - TocBuilder & b = backend.builder("child"); - b.pushItem(cpit, screenLabel(), output_active); - 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"); @@ -1338,7 +1347,7 @@ void InsetInclude::addToToc(DocIterator const & cpit, bool output_active, //Copy missing outliner names (though the user has been warned against //having different document class and module selection between master //and child). - for (pair const & name + for (auto const & name : childbuffer->params().documentClass().outlinerNames()) backend.addName(name.first, translateIfPossible(name.second)); } @@ -1367,11 +1376,11 @@ void InsetInclude::updateCommand() } -void InsetInclude::updateBuffer(ParIterator const & it, UpdateType utype) +void InsetInclude::updateBuffer(ParIterator const & it, UpdateType utype, bool const deleted) { file_exist_ = includedFileExist(); - button_.update(screenLabel(), true, false); + button_.update(screenLabel(), true, false, !file_exist_); Buffer const * const childbuffer = getChildBuffer(); if (childbuffer) { @@ -1382,7 +1391,7 @@ void InsetInclude::updateBuffer(ParIterator const & it, UpdateType utype) return; if (label_) - label_->updateBuffer(it, utype); + label_->updateBuffer(it, utype, deleted); InsetListingsParams const par(to_utf8(params()["lstparams"])); if (par.getParamValue("caption").empty()) {