X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2Finsetinclude.C;h=36d745ffaab50d50390a14dbced97131035e6018;hb=e28331ed63062dea10d0a21b9ec12034b4b17b9a;hp=7f015aeddf50d9ae29c7190d1a2aaf7c4de4f235;hpb=1f5c5a06ee85402345a2dfc62c2ba010137d9e27;p=lyx.git diff --git a/src/insets/insetinclude.C b/src/insets/insetinclude.C index 7f015aeddf..36d745ffaa 100644 --- a/src/insets/insetinclude.C +++ b/src/insets/insetinclude.C @@ -30,9 +30,9 @@ #include "lyxlex.h" #include "metricsinfo.h" #include "outputparams.h" +#include "TocBackend.h" #include "frontends/Alert.h" -#include "frontends/LyXView.h" #include "frontends/Painter.h" #include "graphics/PreviewImage.h" @@ -40,37 +40,37 @@ #include "insets/render_preview.h" -#include "support/filename.h" #include "support/filetools.h" #include "support/lstrings.h" // contains +#include "support/lyxalgo.h" #include "support/lyxlib.h" #include "support/convert.h" #include #include -#include "support/std_ostream.h" - -#include - -using lyx::support::AddName; -using lyx::support::AbsolutePath; -using lyx::support::bformat; -using lyx::support::ChangeExtension; -using lyx::support::contains; -using lyx::support::copy; -using lyx::support::FileName; -using lyx::support::GetFileContents; -using lyx::support::isFileReadable; -using lyx::support::isLyXFilename; -using lyx::support::latex_path; -using lyx::support::MakeAbsPath; -using lyx::support::MakeDisplayPath; -using lyx::support::MakeRelPath; -using lyx::support::OnlyFilename; -using lyx::support::OnlyPath; -using lyx::support::subst; -using lyx::support::sum; + +namespace lyx { + +using support::addName; +using support::absolutePath; +using support::bformat; +using support::changeExtension; +using support::contains; +using support::copy; +using support::DocFileName; +using support::FileName; +using support::getFileContents; +using support::isFileReadable; +using support::isLyXFilename; +using support::latex_path; +using support::makeAbsPath; +using support::makeDisplayPath; +using support::makeRelPath; +using support::onlyFilename; +using support::onlyPath; +using support::subst; +using support::sum; using std::endl; using std::string; @@ -79,17 +79,16 @@ using std::istringstream; using std::ostream; using std::ostringstream; +namespace Alert = frontend::Alert; namespace fs = boost::filesystem; -extern BufferList bufferlist; - namespace { -string const uniqueID() +docstring const uniqueID() { static unsigned int seed = 1000; - return "file" + convert(++seed); + return "file" + convert(++seed); } } // namespace anon @@ -126,11 +125,12 @@ void InsetInclude::doDispatch(LCursor & cur, FuncRequest & cmd) switch (cmd.action) { case LFUN_INSET_MODIFY: { - InsetCommandParams p; - InsetIncludeMailer::string2params(cmd.argument, p); - if (!p.getCmdName().empty()) + InsetCommandParams p("include"); + InsetIncludeMailer::string2params(to_utf8(cmd.argument()), p); + if (!p.getCmdName().empty()) { set(p, cur.buffer()); - else + cur.buffer().updateBibfilesCache(); + } else cur.noUpdate(); break; } @@ -140,7 +140,6 @@ void InsetInclude::doDispatch(LCursor & cur, FuncRequest & cmd) break; case LFUN_MOUSE_RELEASE: - case LFUN_INSET_DIALOG_SHOW: InsetIncludeMailer(*this).showDialog(&cur.bv()); break; @@ -158,7 +157,6 @@ bool InsetInclude::getStatus(LCursor & cur, FuncRequest const & cmd, case LFUN_INSET_MODIFY: case LFUN_INSET_DIALOG_UPDATE: - case LFUN_INSET_DIALOG_SHOW: flag.enabled(true); return true; @@ -219,11 +217,11 @@ string const parentFilename(Buffer const & buffer) } -string const includedFilename(Buffer const & buffer, +FileName const includedFilename(Buffer const & buffer, InsetCommandParams const & params) { - return MakeAbsPath(params.getContents(), - OnlyPath(parentFilename(buffer))); + return makeAbsPath(to_utf8(params["filename"]), + onlyPath(parentFilename(buffer))); } @@ -259,7 +257,7 @@ void InsetInclude::write(Buffer const &, ostream & os) const void InsetInclude::write(ostream & os) const { - os << "Include " << params_.getCommand() << '\n' + os << "Include " << to_utf8(params_.getCommand()) << '\n' << "preview " << convert(params_.preview()) << '\n'; } @@ -272,27 +270,55 @@ void InsetInclude::read(Buffer const &, LyXLex & lex) void InsetInclude::read(LyXLex & lex) { - params_.read(lex); + if (lex.isOK()) { + lex.next(); + string const command = lex.getString(); + params_.scanCommand(command); + } + string token; + while (lex.isOK()) { + lex.next(); + token = lex.getString(); + if (token == "\\end_inset") + break; + if (token == "preview") { + lex.next(); + params_.preview(lex.getBool()); + } else + lex.printError("Unknown parameter name `$$Token' for command " + params_.getCmdName()); + } + if (token != "\\end_inset") { + lex.printError("Missing \\end_inset at this point. " + "Read: `$$Token'"); + } } -string const InsetInclude::getScreenLabel(Buffer const &) const +docstring const InsetInclude::getScreenLabel(Buffer const &) const { - string temp; + docstring temp; switch (type(params_)) { - case INPUT: temp += _("Input"); break; - case VERB: temp += _("Verbatim Input"); break; - case VERBAST: temp += _("Verbatim Input*"); break; - case INCLUDE: temp += _("Include"); break; + case INPUT: + temp += _("Input"); + break; + case VERB: + temp += _("Verbatim Input"); + break; + case VERBAST: + temp += _("Verbatim Input*"); + break; + case INCLUDE: + temp += _("Include"); + break; } temp += ": "; - if (params_.getContents().empty()) + if (params_["filename"].empty()) temp += "???"; else - temp += OnlyFilename(params_.getContents()); + temp += from_utf8(onlyFilename(to_utf8(params_["filename"]))); return temp; } @@ -300,22 +326,36 @@ string const InsetInclude::getScreenLabel(Buffer const &) const namespace { +/// return the child buffer if the file is a LyX doc and is loaded +Buffer * getChildBuffer(Buffer const & buffer, InsetCommandParams const & params) +{ + if (isVerbatim(params)) + return 0; + + string const included_file = includedFilename(buffer, params).absFilename(); + if (!isLyXFilename(included_file)) + return 0; + + return theBufferList().getBuffer(included_file); +} + + /// return true if the file is or got loaded. bool loadIfNeeded(Buffer const & buffer, InsetCommandParams const & params) { if (isVerbatim(params)) return false; - string const included_file = includedFilename(buffer, params); - if (!isLyXFilename(included_file)) + FileName const included_file = includedFilename(buffer, params); + if (!isLyXFilename(included_file.absFilename())) return false; - Buffer * buf = bufferlist.getBuffer(included_file); + Buffer * buf = theBufferList().getBuffer(included_file.absFilename()); if (!buf) { // the readonly flag can/will be wrong, not anymore I think. - if (!fs::exists(included_file)) + if (!fs::exists(included_file.toFilesystemEncoding())) return false; - buf = bufferlist.newBuffer(included_file); + buf = theBufferList().newBuffer(included_file.absFilename()); if (!loadLyXFile(buf, included_file)) return false; } @@ -328,30 +368,30 @@ bool loadIfNeeded(Buffer const & buffer, InsetCommandParams const & params) } // namespace anon -int InsetInclude::latex(Buffer const & buffer, ostream & os, +int InsetInclude::latex(Buffer const & buffer, odocstream & os, OutputParams const & runparams) const { - string incfile(params_.getContents()); + string incfile(to_utf8(params_["filename"])); // Do nothing if no file name has been specified if (incfile.empty()) return 0; - string const included_file = includedFilename(buffer, params_); + FileName const included_file(includedFilename(buffer, params_)); Buffer const * const m_buffer = buffer.getMasterBuffer(); // if incfile is relative, make it relative to the master // buffer directory. - if (!AbsolutePath(incfile)) { - incfile = MakeRelPath(included_file, + if (!absolutePath(incfile)) { + incfile = makeRelPath(included_file.absFilename(), m_buffer->filePath()); } // write it to a file (so far the complete file) - string const exportfile = ChangeExtension(incfile, ".tex"); - string const mangled = FileName(ChangeExtension(included_file, + string const exportfile = changeExtension(incfile, ".tex"); + string const mangled = DocFileName(changeExtension(included_file.absFilename(), ".tex")).mangledFilename(); - string const writefile = MakeAbsPath(mangled, m_buffer->temppath()); + FileName const writefile(makeAbsPath(mangled, m_buffer->temppath())); if (!runparams.nice) incfile = mangled; @@ -359,19 +399,20 @@ int InsetInclude::latex(Buffer const & buffer, ostream & os, lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl; lyxerr[Debug::LATEX] << "writefile:" << writefile << endl; - if (runparams.inComment) + if (runparams.inComment || runparams.dryrun) // Don't try to load or copy the file ; else if (loadIfNeeded(buffer, params_)) { - Buffer * tmp = bufferlist.getBuffer(included_file); + Buffer * tmp = theBufferList().getBuffer(included_file.absFilename()); if (tmp->params().textclass != m_buffer->params().textclass) { - string text = bformat(_("Included file `%1$s'\n" + // FIXME UNICODE + docstring text = bformat(_("Included file `%1$s'\n" "has textclass `%2$s'\n" - "while parent file has textclass `%3$s'."), - MakeDisplayPath(included_file), - tmp->params().getLyXTextClass().name(), - m_buffer->params().getLyXTextClass().name()); + "while parent file has textclass `%3$s'."), + makeDisplayPath(included_file.absFilename()), + from_utf8(tmp->params().getLyXTextClass().name()), + from_utf8(m_buffer->params().getLyXTextClass().name())); Alert::warning(_("Different textclasses"), text); //return 0; } @@ -386,7 +427,7 @@ int InsetInclude::latex(Buffer const & buffer, ostream & os, // make use of it somehow? (JMarc 20031002) #endif tmp->makeLaTeXFile(writefile, - OnlyPath(masterFilename(buffer)), + onlyPath(masterFilename(buffer)), runparams, false); } else { // Copy the file to the temp dir, so that .aux files etc. @@ -397,10 +438,11 @@ int InsetInclude::latex(Buffer const & buffer, ostream & os, if (checksum_in != checksum_out) { if (!copy(included_file, writefile)) { + // FIXME UNICODE lyxerr[Debug::LATEX] - << bformat(_("Could not copy the file\n%1$s\n" - "into the temporary directory."), - included_file) + << to_utf8(bformat(_("Could not copy the file\n%1$s\n" + "into the temporary directory."), + from_utf8(included_file.absFilename()))) << endl; return 0; } @@ -411,21 +453,25 @@ int InsetInclude::latex(Buffer const & buffer, ostream & os, "latex" : "pdflatex"; if (isVerbatim(params_)) { incfile = latex_path(incfile); - os << '\\' << params_.getCmdName() << '{' << incfile << '}'; + // FIXME UNICODE + os << '\\' << from_ascii(params_.getCmdName()) << '{' + << from_utf8(incfile) << '}'; } else if (type(params_) == INPUT) { runparams.exportdata->addExternalFile(tex_format, writefile, exportfile); // \input wants file with extension (default is .tex) - if (!isLyXFilename(included_file)) { + if (!isLyXFilename(included_file.absFilename())) { incfile = latex_path(incfile); - os << '\\' << params_.getCmdName() << '{' << incfile << '}'; + // FIXME UNICODE + os << '\\' << from_ascii(params_.getCmdName()) + << '{' << from_utf8(incfile) << '}'; } else { - incfile = ChangeExtension(incfile, ".tex"); + incfile = changeExtension(incfile, ".tex"); incfile = latex_path(incfile); - os << '\\' << params_.getCmdName() << '{' - << incfile - << '}'; + // FIXME UNICODE + os << '\\' << from_ascii(params_.getCmdName()) + << '{' << from_utf8(incfile) << '}'; } } else { runparams.exportdata->addExternalFile(tex_format, writefile, @@ -433,90 +479,52 @@ int InsetInclude::latex(Buffer const & buffer, ostream & os, // \include don't want extension and demands that the // file really have .tex - incfile = ChangeExtension(incfile, string()); + incfile = changeExtension(incfile, string()); incfile = latex_path(incfile); - os << '\\' << params_.getCmdName() << '{' - << incfile - << '}'; + // FIXME UNICODE + os << '\\' << from_ascii(params_.getCmdName()) << '{' + << from_utf8(incfile) << '}'; } return 0; } -int InsetInclude::plaintext(Buffer const & buffer, ostream & os, +int InsetInclude::plaintext(Buffer const & buffer, odocstream & os, OutputParams const &) const { - if (isVerbatim(params_)) - os << GetFileContents(includedFilename(buffer, params_)); - return 0; -} - - -int InsetInclude::linuxdoc(Buffer const & buffer, ostream & os, - OutputParams const & runparams) const -{ - string incfile(params_.getContents()); - - // Do nothing if no file name has been specified - if (incfile.empty()) - return 0; - - string const included_file = includedFilename(buffer, params_); - - // write it to a file (so far the complete file) - string const exportfile = ChangeExtension(incfile, ".sgml"); - string writefile = ChangeExtension(included_file, ".sgml"); - - if (loadIfNeeded(buffer, params_)) { - Buffer * tmp = bufferlist.getBuffer(included_file); - - writefile = MakeAbsPath(FileName(writefile).mangledFilename(), - buffer.getMasterBuffer()->temppath()); - if (!runparams.nice) - incfile = writefile; - - lyxerr[Debug::LATEX] << "incfile:" << incfile << endl; - lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl; - lyxerr[Debug::LATEX] << "writefile:" << writefile << endl; - - tmp->makeLinuxDocFile(writefile, runparams, true); - } - if (isVerbatim(params_)) { - os << ""; - } else { - runparams.exportdata->addExternalFile("linuxdoc", writefile, - exportfile); - os << '&' << include_label << ';'; + // FIXME: We don't know the encoding of the file + docstring const str = from_utf8( + getFileContents(includedFilename(buffer, params_))); + os << str; + // Return how many newlines we issued. + return int(lyx::count(str.begin(), str.end(), '\n')); } - return 0; } -int InsetInclude::docbook(Buffer const & buffer, ostream & os, +int InsetInclude::docbook(Buffer const & buffer, odocstream & os, OutputParams const & runparams) const { - string incfile(params_.getContents()); + string incfile = to_utf8(params_["filename"]); // Do nothing if no file name has been specified if (incfile.empty()) return 0; - string const included_file = includedFilename(buffer, params_); + string const included_file = includedFilename(buffer, params_).absFilename(); // write it to a file (so far the complete file) - string const exportfile = ChangeExtension(incfile, ".sgml"); - string writefile = ChangeExtension(included_file, ".sgml"); + string const exportfile = changeExtension(incfile, ".sgml"); + DocFileName writefile(changeExtension(included_file, ".sgml")); if (loadIfNeeded(buffer, params_)) { - Buffer * tmp = bufferlist.getBuffer(included_file); + Buffer * tmp = theBufferList().getBuffer(included_file); - string const mangled = FileName(writefile).mangledFilename(); - writefile = MakeAbsPath(mangled, + string const mangled = writefile.mangledFilename(); + writefile = makeAbsPath(mangled, buffer.getMasterBuffer()->temppath()); if (!runparams.nice) incfile = mangled; @@ -538,7 +546,7 @@ int InsetInclude::docbook(Buffer const & buffer, ostream & os, << '&' << include_label << ';' << "\" format=\"linespecific\">"; } else - os << '&' << include_label << ';'; + os << '&' << include_label << ';'; return 0; } @@ -546,22 +554,22 @@ int InsetInclude::docbook(Buffer const & buffer, ostream & os, void InsetInclude::validate(LaTeXFeatures & features) const { - string incfile(params_.getContents()); + string incfile(to_utf8(params_["filename"])); string writefile; Buffer const & buffer = features.buffer(); - string const included_file = includedFilename(buffer, params_); + string const included_file = includedFilename(buffer, params_).absFilename(); if (isLyXFilename(included_file)) - writefile = ChangeExtension(included_file, ".sgml"); + writefile = changeExtension(included_file, ".sgml"); else writefile = included_file; if (!features.runparams().nice && !isVerbatim(params_)) { - incfile = FileName(writefile).mangledFilename(); - writefile = MakeAbsPath(incfile, - buffer.getMasterBuffer()->temppath()); + incfile = DocFileName(writefile).mangledFilename(); + writefile = makeAbsPath(incfile, + buffer.getMasterBuffer()->temppath()).absFilename(); } features.includeFile(include_label, writefile); @@ -574,7 +582,7 @@ void InsetInclude::validate(LaTeXFeatures & features) const // to be loaded: if (loadIfNeeded(buffer, params_)) { // a file got loaded - Buffer * const tmp = bufferlist.getBuffer(included_file); + Buffer * const tmp = theBufferList().getBuffer(included_file); if (tmp) { // We must temporarily change features.buffer, // otherwise it would always be the master buffer, @@ -588,11 +596,11 @@ void InsetInclude::validate(LaTeXFeatures & features) const void InsetInclude::getLabelList(Buffer const & buffer, - std::vector & list) const + std::vector & list) const { if (loadIfNeeded(buffer, params_)) { - string const included_file = includedFilename(buffer, params_); - Buffer * tmp = bufferlist.getBuffer(included_file); + string const included_file = includedFilename(buffer, params_).absFilename(); + Buffer * tmp = theBufferList().getBuffer(included_file); tmp->setParentName(""); tmp->getLabelList(list); tmp->setParentName(parentFilename(buffer)); @@ -601,11 +609,11 @@ void InsetInclude::getLabelList(Buffer const & buffer, void InsetInclude::fillWithBibKeys(Buffer const & buffer, - std::vector > & keys) const + std::vector > & keys) const { if (loadIfNeeded(buffer, params_)) { - string const included_file = includedFilename(buffer, params_); - Buffer * tmp = bufferlist.getBuffer(included_file); + string const included_file = includedFilename(buffer, params_).absFilename(); + Buffer * tmp = theBufferList().getBuffer(included_file); tmp->setParentName(""); tmp->fillWithBibKeys(keys); tmp->setParentName(parentFilename(buffer)); @@ -613,13 +621,39 @@ void InsetInclude::fillWithBibKeys(Buffer const & buffer, } -void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const +void InsetInclude::updateBibfilesCache(Buffer const & buffer) +{ + Buffer * const tmp = getChildBuffer(buffer, params_); + if (tmp) { + tmp->setParentName(""); + tmp->updateBibfilesCache(); + tmp->setParentName(parentFilename(buffer)); + } +} + + +std::vector const & +InsetInclude::getBibfilesCache(Buffer const & buffer) const +{ + Buffer * const tmp = getChildBuffer(buffer, params_); + if (tmp) { + tmp->setParentName(""); + std::vector const & cache = tmp->getBibfilesCache(); + tmp->setParentName(parentFilename(buffer)); + return cache; + } + static std::vector const empty; + return empty; +} + + +bool InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const { BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer()); bool use_preview = false; if (RenderPreview::status() != LyXRC::PREVIEW_OFF) { - lyx::graphics::PreviewImage const * pimage = + graphics::PreviewImage const * pimage = preview_->getPreviewImage(*mi.base.bv->buffer()); use_preview = pimage && pimage->image(); } @@ -638,7 +672,9 @@ void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const Box b(0, dim.wid, -dim.asc, dim.des); button_.setBox(b); + bool const changed = dim_ != dim; dim_ = dim; + return changed; } @@ -650,7 +686,7 @@ void InsetInclude::draw(PainterInfo & pi, int x, int y) const bool use_preview = false; if (RenderPreview::status() != LyXRC::PREVIEW_OFF) { - lyx::graphics::PreviewImage const * pimage = + graphics::PreviewImage const * pimage = preview_->getPreviewImage(*pi.base.bv->buffer()); use_preview = pimage && pimage->image(); } @@ -689,16 +725,16 @@ namespace { bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer) { - string const included_file = includedFilename(buffer, params); + FileName const included_file = includedFilename(buffer, params); return type(params) == INPUT && params.preview() && isFileReadable(included_file); } -string const latex_string(InsetInclude const & inset, Buffer const & buffer) +docstring const latex_string(InsetInclude const & inset, Buffer const & buffer) { - ostringstream os; + odocstringstream os; OutputParams runparams; runparams.flavor = OutputParams::LATEX; inset.latex(buffer, os, runparams); @@ -714,7 +750,7 @@ void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset, if (RenderPreview::status() != LyXRC::PREVIEW_OFF && preview_wanted(params, buffer)) { renderer.setAbsFile(includedFilename(buffer, params)); - string const snippet = latex_string(inset, buffer); + docstring const snippet = latex_string(inset, buffer); renderer.addPreview(snippet, buffer); } } @@ -722,17 +758,42 @@ void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset, } // namespace anon -void InsetInclude::addPreview(lyx::graphics::PreviewLoader & ploader) const +void InsetInclude::addPreview(graphics::PreviewLoader & ploader) const { Buffer const & buffer = ploader.buffer(); if (preview_wanted(params(), buffer)) { preview_->setAbsFile(includedFilename(buffer, params())); - string const snippet = latex_string(*this, buffer); + docstring const snippet = latex_string(*this, buffer); preview_->addPreview(snippet, ploader); } } +void InsetInclude::addToToc(TocList & toclist, Buffer const & buffer) const +{ + Buffer const * const childbuffer = getChildBuffer(buffer, params_); + if (!childbuffer) + return; + + TocList const & childtoclist = childbuffer->tocBackend().tocs(); + TocList::const_iterator it = childtoclist.begin(); + TocList::const_iterator const end = childtoclist.end(); + for(; it != end; ++it) + toclist[it->first].insert(toclist[it->first].end(), + it->second.begin(), it->second.end()); +} + + +void InsetInclude::updateLabels(Buffer const & buffer) const +{ + Buffer const * const childbuffer = getChildBuffer(buffer, params_); + if (!childbuffer) + return; + + lyx::updateLabels(*childbuffer, true); +} + + string const InsetIncludeMailer::name_("include"); InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset) @@ -749,7 +810,7 @@ string const InsetIncludeMailer::inset2string(Buffer const &) const void InsetIncludeMailer::string2params(string const & in, InsetCommandParams & params) { - params = InsetCommandParams(); + params.clear(); if (in.empty()) return; @@ -785,3 +846,6 @@ InsetIncludeMailer::params2string(InsetCommandParams const & params) data << "\\end_inset\n"; return data.str(); } + + +} // namespace lyx