X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBuffer.cpp;h=38d236964af0393b0b4b922d8257fb3e03bf23b2;hb=1511516ef769cb3a11546a78cea6abd41cb91ffe;hp=56e19b81be56189141cc7e2ca60f68f3b4bf4ffd;hpb=11397a2e82ba19b69818f9891132ff7074bc1759;p=lyx.git diff --git a/src/Buffer.cpp b/src/Buffer.cpp index 56e19b81be..38d236964a 100644 --- a/src/Buffer.cpp +++ b/src/Buffer.cpp @@ -14,7 +14,6 @@ #include "Buffer.h" #include "Author.h" -#include "LayoutFile.h" #include "BiblioInfo.h" #include "BranchList.h" #include "buffer_funcs.h" @@ -22,6 +21,7 @@ #include "BufferParams.h" #include "Bullet.h" #include "Chktex.h" +#include "ColorSet.h" #include "Converter.h" #include "Counters.h" #include "Cursor.h" @@ -46,18 +46,18 @@ #include "LyX.h" #include "LyXRC.h" #include "LyXVC.h" -#include "output_docbook.h" #include "output.h" #include "output_latex.h" -#include "output_xhtml.h" +#include "output_docbook.h" #include "output_plaintext.h" +#include "output_xhtml.h" #include "Paragraph.h" #include "ParagraphParameters.h" #include "ParIterator.h" #include "PDFOptions.h" #include "Session.h" #include "SpellChecker.h" -#include "sgml.h" +#include "xml.h" #include "texstream.h" #include "TexRow.h" #include "Text.h" @@ -67,12 +67,9 @@ #include "VCBackend.h" #include "version.h" #include "WordLangTuple.h" -#include "WordList.h" -#include "insets/InsetBibtex.h" #include "insets/InsetBranch.h" #include "insets/InsetInclude.h" -#include "insets/InsetTabular.h" #include "insets/InsetText.h" #include "mathed/InsetMathHull.h" @@ -80,7 +77,6 @@ #include "mathed/InsetMathMacroTemplate.h" #include "mathed/MathSupport.h" -#include "graphics/GraphicsCache.h" #include "graphics/PreviewLoader.h" #include "frontends/Application.h" @@ -97,11 +93,9 @@ #include "support/FileName.h" #include "support/FileNameList.h" #include "support/filetools.h" -#include "support/ForkedCalls.h" #include "support/gettext.h" #include "support/gzstream.h" #include "support/lstrings.h" -#include "support/lyxalgo.h" #include "support/mutex.h" #include "support/os.h" #include "support/Package.h" @@ -111,8 +105,6 @@ #include "support/textutils.h" #include "support/types.h" -#include "support/bind.h" - #include #include #include @@ -154,7 +146,8 @@ typedef vector LabelCache; typedef map RefCache; // A storehouse for the cloned buffers. -std::list cloned_buffers; +typedef list CloneStore; +CloneStore cloned_buffers; } // namespace @@ -200,40 +193,9 @@ public: /// need to regenerate .tex? DepClean dep_clean; - /// is save needed? - mutable bool lyx_clean; - - /// is autosave needed? - mutable bool bak_clean; - - /// is this an unnamed file (New...)? - bool unnamed; - - /// is this an internal bufffer? - bool internal_buffer; - - /// buffer is r/o - bool read_only; - /// name of the file the buffer is associated with. FileName filename; - /** Set to true only when the file is fully loaded. - * Used to prevent the premature generation of previews - * and by the citation inset. - */ - bool file_fully_loaded; - - /// original format of loaded file - int file_format; - - /// if the file was originally loaded from an older format, do - /// we need to back it up still? - bool need_format_backup; - - /// Ignore the parent (e.g. when exporting a child standalone)? - bool ignore_parent; - /// mutable TocBackend toc_backend; @@ -250,8 +212,6 @@ public: /// map from the macro name to the position map, /// which maps the macro definition position to the scope and the MacroData. NamePositionScopeMacroMap macros; - /// This seem to change the way Buffer::getMacro() works - mutable bool macro_lock; /// positions of child buffers in the buffer typedef map BufferPositionMap; @@ -303,25 +263,13 @@ public: // file, and then to construct the Buffer's bibinfo from that. /// A cache for bibliography info mutable BiblioInfo bibinfo_; - /// whether the bibinfo cache is valid - mutable bool bibinfo_cache_valid_; /// Cache of timestamps of .bib files map bibfile_status_; - /// Indicates whether the bibinfo has changed since the last time - /// we ran updateBuffer(), i.e., whether citation labels may need - /// to be updated. - mutable bool cite_labels_valid_; - /// Do we have a bibliography environment? - mutable bool have_bibitems_; /// These two hold the file name and format, written to by /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE. FileName preview_file_; string preview_format_; - /// If there was an error when previewing, on the next preview we do - /// a fresh compile (e.g. in case the user installed a package that - /// was missing). - bool require_fresh_start_; /// Cache the references associated to a label and their positions /// in the buffer. @@ -335,6 +283,86 @@ public: /// PreviewLoader * preview_loader_; + /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_ + /// This one is useful for preview detached in a thread. + Buffer const * cloned_buffer_; + /// + CloneList_ptr clone_list_; + + /// + std::list include_list_; +private: + /// So we can force access via the accessors. + mutable Buffer const * parent_buffer; + + FileMonitorPtr file_monitor_; + +/// ints and bools are all listed last so as to avoid alignment issues +public: + /// original format of loaded file + int file_format; + + /// are we in the process of exporting this buffer? + mutable bool doing_export; + + /// If there was an error when previewing, on the next preview we do + /// a fresh compile (e.g. in case the user installed a package that + /// was missing). + bool require_fresh_start_; + + /// Indicates whether the bibinfo has changed since the last time + /// we ran updateBuffer(), i.e., whether citation labels may need + /// to be updated. + mutable bool cite_labels_valid_; + /// Do we have a bibliography environment? + mutable bool have_bibitems_; + + /// is save needed? + mutable bool lyx_clean; + + /// is autosave needed? + mutable bool bak_clean; + + /// is this an unnamed file (New...)? + bool unnamed; + + /// is this an internal bufffer? + bool internal_buffer; + + /// buffer is r/o + bool read_only; + + /** Set to true only when the file is fully loaded. + * Used to prevent the premature generation of previews + * and by the citation inset. + */ + bool file_fully_loaded; + + /// if the file was originally loaded from an older format, do + /// we need to back it up still? + bool need_format_backup; + + /// Ignore the parent (e.g. when exporting a child standalone)? + bool ignore_parent; + + /// This seem to change the way Buffer::getMacro() works + mutable bool macro_lock; + + /// has been externally modified? Can be reset by the user. + mutable bool externally_modified_; + + /// whether the bibinfo cache is valid + mutable bool bibinfo_cache_valid_; + + /// + mutable bool need_update; + +private: + int word_count_; + int char_count_; + int blank_count_; + +public: /// This is here to force the test to be done whenever parent_buffer /// is accessed. Buffer const * parent() const @@ -367,14 +395,6 @@ public: parent_buffer->invalidateBibinfoCache(); } - /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_ - /// This one is useful for preview detached in a thread. - Buffer const * cloned_buffer_; - /// - CloneList * clone_list_; - /// are we in the process of exporting this buffer? - mutable bool doing_export; - /// compute statistics /// \p from initial position /// \p to points to the end position @@ -397,24 +417,11 @@ public: /// Notify or clear of external modification void fileExternallyModified(bool exists); - /// has been externally modified? Can be reset by the user. - mutable bool externally_modified_; - ///Binding LaTeX lines with buffer positions. //Common routine for LaTeX and Reference errors listing. void traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const; - -private: - /// So we can force access via the accessors. - mutable Buffer const * parent_buffer; - - int word_count_; - int char_count_; - int blank_count_; - - FileMonitorPtr file_monitor_; }; @@ -447,16 +454,16 @@ static FileName createBufferTmpDir() Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_, Buffer const * cloned_buffer) - : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false), - internal_buffer(false), read_only(readonly_), filename(file), - file_fully_loaded(false), file_format(LYX_FORMAT), need_format_backup(false), - ignore_parent(false), toc_backend(owner), macro_lock(false), - checksum_(0), wa_(nullptr), gui_(nullptr), undo_(*owner), bibinfo_cache_valid_(false), - cite_labels_valid_(false), have_bibitems_(false), require_fresh_start_(false), - inset(nullptr), preview_loader_(nullptr), cloned_buffer_(cloned_buffer), - clone_list_(nullptr), doing_export(false), - externally_modified_(false), parent_buffer(nullptr), - word_count_(0), char_count_(0), blank_count_(0) + : owner_(owner), filename(file), toc_backend(owner), checksum_(0), + wa_(nullptr), gui_(nullptr), undo_(*owner), inset(nullptr), + preview_loader_(nullptr), cloned_buffer_(cloned_buffer), + clone_list_(nullptr), parent_buffer(nullptr), file_format(LYX_FORMAT), + doing_export(false), require_fresh_start_(false), cite_labels_valid_(false), + have_bibitems_(false), lyx_clean(true), bak_clean(true), unnamed(false), + internal_buffer(false), read_only(readonly_), file_fully_loaded(false), + need_format_backup(false), ignore_parent(false), macro_lock(false), + externally_modified_(false), bibinfo_cache_valid_(false), + need_update(false), word_count_(0), char_count_(0), blank_count_(0) { refreshFileMonitor(); if (!cloned_buffer_) { @@ -530,8 +537,8 @@ Buffer::~Buffer() // loop over children for (auto const & p : d->children_positions) { Buffer * child = const_cast(p.first); - if (d->clone_list_->erase(child)) - delete child; + if (d->clone_list_->erase(child)) + delete child; } // if we're the master buffer, then we should get rid of the list // of clones @@ -540,16 +547,15 @@ Buffer::~Buffer() // children still has a reference to this list. But we will try to // continue, rather than shut down. LATTEST(d->clone_list_->empty()); - list::iterator it = + // The clone list itself is empty, but it's still referenced in our list + // of clones. So let's find it and remove it. + CloneStore::iterator it = find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_); if (it == cloned_buffers.end()) { // We will leak in this case, but it is safe to continue. LATTEST(false); - } else { - delete(*it); + } else cloned_buffers.erase(it); - } - delete d->clone_list_; } // FIXME Do we really need to do this right before we delete d? // clear references to children in macro tables @@ -596,8 +602,8 @@ Buffer::~Buffer() Buffer * Buffer::cloneWithChildren() const { BufferMap bufmap; - cloned_buffers.push_back(new CloneList); - CloneList * clones = cloned_buffers.back(); + cloned_buffers.emplace_back(new CloneList); + CloneList_ptr clones = cloned_buffers.back(); cloneWithChildren(bufmap, clones); @@ -610,7 +616,7 @@ Buffer * Buffer::cloneWithChildren() const } -void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const +void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList_ptr clones) const { // have we already been cloned? if (bufmap.find(this) != bufmap.end()) @@ -621,10 +627,9 @@ void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const // The clone needs its own DocumentClass, since running updateBuffer() will // modify it, and we would otherwise be sharing it with the original Buffer. buffer_clone->params().makeDocumentClass(true); - ErrorList el; cap::switchBetweenClasses( params().documentClassPtr(), buffer_clone->params().documentClassPtr(), - static_cast(buffer_clone->inset()), el); + static_cast(buffer_clone->inset())); bufmap[this] = buffer_clone; clones->insert(buffer_clone); @@ -655,22 +660,20 @@ void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const buffer_clone->setChild(dit, child_clone); } buffer_clone->d->macro_lock = false; - return; } Buffer * Buffer::cloneBufferOnly() const { - cloned_buffers.push_back(new CloneList); - CloneList * clones = cloned_buffers.back(); + cloned_buffers.emplace_back(new CloneList); + CloneList_ptr clones = cloned_buffers.back(); Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this); // The clone needs its own DocumentClass, since running updateBuffer() will // modify it, and we would otherwise be sharing it with the original Buffer. buffer_clone->params().makeDocumentClass(true); - ErrorList el; cap::switchBetweenClasses( params().documentClassPtr(), buffer_clone->params().documentClassPtr(), - static_cast(buffer_clone->inset()), el); + static_cast(buffer_clone->inset())); clones->insert(buffer_clone); buffer_clone->d->clone_list_ = clones; @@ -799,6 +802,12 @@ Undo & Buffer::undo() } +Undo const & Buffer::undo() const +{ + return d->undo_; +} + + void Buffer::setChild(DocIterator const & dit, Buffer * child) { d->children_positions[child] = dit; @@ -938,13 +947,16 @@ int Buffer::readHeader(Lexer & lex) params().clearRemovedModules(); params().clearIncludedChildren(); params().pdfoptions().clear(); + params().document_metadata.clear(); params().indiceslist().clear(); params().backgroundcolor = lyx::rgbFromHexName("#ffffff"); params().isbackgroundcolor = false; params().fontcolor = RGBColor(0, 0, 0); params().isfontcolor = false; params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC); + params().isnotefontcolor = false; params().boxbgcolor = RGBColor(0xFF, 0, 0); + params().isboxbgcolor = false; params().html_latex_start.clear(); params().html_latex_end.clear(); params().html_math_img_scale = 1.0; @@ -956,6 +968,7 @@ int Buffer::readHeader(Lexer & lex) params().biblatex_citestyle.erase(); params().multibib.erase(); params().lineno_opts.clear(); + params().spellignore().clear(); for (int i = 0; i < 4; ++i) { params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i]; @@ -984,7 +997,7 @@ int Buffer::readHeader(Lexer & lex) << token << '\''); string const result = - params().readToken(lex, token, d->filename.onlyPath()); + params().readToken(lex, token, d->filename); if (!result.empty()) { if (token == "\\textclass") { d->layout_position = result; @@ -1005,7 +1018,7 @@ int Buffer::readHeader(Lexer & lex) params().shell_escape = theSession().shellescapeFiles().find(absFileName()); - params().makeDocumentClass(); + params().makeDocumentClass(isClone(), isInternal()); return unknown_tokens; } @@ -1084,6 +1097,10 @@ bool Buffer::readDocument(Lexer & lex) d->old_position = params().origin; else d->old_position = filePath(); + + if (!parent()) + clearIncludeList(); + bool const res = text().read(lex, errorList, d->inset); d->old_position.clear(); @@ -1100,6 +1117,24 @@ bool Buffer::readDocument(Lexer & lex) } +bool Buffer::isSyncTeXenabled() const +{ + bool enabled = params().output_sync; + + if (!enabled) + for (auto const & c : theConverters()) { + const string dest = c.to().substr(0,3); + if (dest == "dvi" || dest == "pdf") { + const string cmd = c.command(); + enabled |= cmd.find("-synctex=") != string::npos + && cmd.find("-synctex=0") == string::npos; + if (enabled) + break; + } + } + return enabled; +} + bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList) { Format const * fmt = theFormats().getFormat(format); @@ -1135,7 +1170,7 @@ bool Buffer::importFile(string const & format, FileName const & name, ErrorList FileName const lyx = tempFileName("Buffer_importFileXXXXXX.lyx"); Converters::RetVal const retval = - theConverters().convert(nullptr, name, lyx, name, format, "lyx", errorList); + theConverters().convert(this, name, lyx, name, format, "lyx", errorList); if (retval == Converters::SUCCESS) { bool const success = readFile(lyx) == ReadSuccess; removeTempFile(lyx); @@ -1177,9 +1212,8 @@ bool Buffer::readString(string const & s) Buffer::ReadStatus Buffer::readFile(FileName const & fn) { - FileName fname(fn); Lexer lex; - if (!lex.setFile(fname)) { + if (!lex.setFile(fn)) { Alert::error(_("File Not Found"), bformat(_("Unable to open file `%1$s'."), from_utf8(fn.absFileName()))); @@ -1270,9 +1304,9 @@ void Buffer::updatePreviews() const if (!ploader) return; - InsetIterator it = inset_iterator_begin(*d->inset); - InsetIterator const end = inset_iterator_end(*d->inset); - for (; it != end; ++it) + InsetIterator it = begin(*d->inset); + InsetIterator const itend = end(*d->inset); + for (; it != itend; ++it) it->addPreview(it, *ploader); ploader->startLoading(); @@ -1344,7 +1378,7 @@ Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn, LYXERR(Debug::INFO, "Running '" << command_str << '\''); cmd_ret const ret = runCommand(command_str); - if (ret.first != 0) { + if (!ret.valid) { if (from_format < LYX_FORMAT) { Alert::error(_("Conversion script failed"), bformat(_("%1$s is from an older version" @@ -1467,7 +1501,7 @@ bool Buffer::save() const // proper location once that has been done successfully. that // way we preserve the original file if something goes wrong. string const justname = fileName().onlyFileNameWithoutExt(); - auto tempfile = make_unique(fileName().onlyPath(), + auto tempfile = lyx::make_unique(fileName().onlyPath(), justname + "-XXXXXX.lyx"); bool const symlink = fileName().isSymLink(); if (!symlink) @@ -1536,9 +1570,8 @@ bool Buffer::save() const // time stamp is invalidated by copying/moving saveCheckSum(); markClean(); - if (d->file_format != LYX_FORMAT) - // the file associated with this buffer is now in the current format - d->file_format = LYX_FORMAT; + // the file associated with this buffer is now in the current format + d->file_format = LYX_FORMAT; return true; } // else we saved the file, but failed to move it to the right location. @@ -1605,7 +1638,7 @@ bool Buffer::writeFile(FileName const & fname) const } -docstring Buffer::emergencyWrite() +docstring Buffer::emergencyWrite() const { // No need to save if the buffer has not changed. if (isClean()) @@ -1731,7 +1764,7 @@ Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname, OutputParams runparams = runparams_in; string const encoding = runparams.encoding->iconvName(); - LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath()); + LYXERR(Debug::OUTFILE, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath()); ofdocstream ofs; try { ofs.reset(encoding); } @@ -1768,7 +1801,7 @@ Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname, catch (EncodingException const & e) { docstring const failed(1, e.failed_char); ostringstream oss; - oss << "0x" << hex << e.failed_char << dec; + oss << "0x" << hex << static_cast(e.failed_char) << dec; if (getParFromID(e.par_id).paragraph().layout().pass_thru) { docstring msg = bformat(_("Uncodable character '%1$s'" " (code point %2$s)"), @@ -1804,7 +1837,7 @@ Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname, lyx_exit(1); } - d->texrow = move(os.texrow()); + d->texrow = std::move(os.texrow()); ofs.close(); if (ofs.fail()) { @@ -1843,15 +1876,16 @@ Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os, BufferEncodings::initUnicodeMath(*this); // validate the buffer. - LYXERR(Debug::LATEX, " Validating buffer..."); + LYXERR(Debug::OUTFILE, " Validating buffer..."); LaTeXFeatures features(*this, params(), runparams); validate(features); // This is only set once per document (in master) if (!runparams.is_child) { runparams.use_polyglossia = features.usePolyglossia(); + runparams.use_hyperref = features.isRequired("hyperref"); runparams.use_CJK = features.mustProvide("CJK"); } - LYXERR(Debug::LATEX, " Buffer validation done."); + LYXERR(Debug::OUTFILE, " Buffer validation done."); bool const output_preamble = output == FullSource || output == OnlyPreamble; @@ -1891,9 +1925,9 @@ Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os, docstring uncodable_glyphs; Encoding const * const enc = runparams.encoding; if (enc) { - for (size_t n = 0; n < inputpath.size(); ++n) { - if (!enc->encodable(inputpath[n])) { - docstring const glyph(1, inputpath[n]); + for (char_type n : inputpath) { + if (!enc->encodable(n)) { + docstring const glyph(1, n); LYXERR0("Uncodable character '" << glyph << "' in input path!"); @@ -1939,7 +1973,7 @@ Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os, docdir = subst(docdir, "~", "\\string~"); bool const nonascii = !isAscii(from_utf8(docdir)); // LaTeX 2019/10/01 handles non-ascii path without detokenize - bool const utfpathlatex = features.isAvailable("LaTeX-2019/10/01"); + bool const utfpathlatex = features.isAvailableAtLeastFrom("LaTeX", 2019, 10); bool const detokenize = !utfpathlatex && nonascii; bool const quote = contains(docdir, ' '); if (utfpathlatex && nonascii) @@ -2070,9 +2104,9 @@ Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os, if (output_preamble) { os << "\\end{document}\n"; - LYXERR(Debug::LATEX, "makeLaTeXFile...done"); + LYXERR(Debug::OUTFILE, "makeLaTeXFile...done"); } else { - LYXERR(Debug::LATEX, "LaTeXFile for inclusion made."); + LYXERR(Debug::OUTFILE, "LaTeXFile for inclusion made."); } runparams_in.encoding = runparams.encoding; @@ -2086,7 +2120,7 @@ Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname, OutputParams const & runparams, OutputWhat output) const { - LYXERR(Debug::LATEX, "makeDocBookFile..."); + LYXERR(Debug::OUTFILE, "makeDocBookFile..."); ofdocstream ofs; if (!openFileWrite(ofs, fname)) @@ -2097,8 +2131,7 @@ Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname, updateBuffer(); updateMacroInstances(OutputUpdate); - ExportStatus const retval = - writeDocBookSource(ofs, fname.absFileName(), runparams, output); + ExportStatus const retval = writeDocBookSource(ofs, runparams, output); if (retval == ExportKilled) return ExportKilled; @@ -2109,86 +2142,73 @@ Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname, } -Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os, string const & fname, +Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os, OutputParams const & runparams, OutputWhat output) const { LaTeXFeatures features(*this, params(), runparams); validate(features); + d->bibinfo_.makeCitationLabels(*this); d->texrow.reset(); DocumentClass const & tclass = params().documentClass(); - string const & top_element = tclass.latexname(); bool const output_preamble = output == FullSource || output == OnlyPreamble; bool const output_body = - output == FullSource || output == OnlyBody; + output == FullSource || output == OnlyBody || output == IncludedFile; if (output_preamble) { - if (runparams.flavor == OutputParams::XML) - os << "\n"; - - // FIXME UNICODE - os << "\n"; - preamble += "\n"; - preamble += "\n"; - preamble += "\n"; + // XML preamble, no doctype needed. + // Not using XMLStream for this, as the root tag would be in the tag stack and make troubles with the error + // detection mechanisms (these are called before the end tag is output, and thus interact with the canary + // parsep in output_docbook.cpp). + os << "\n" + << "\n"; + + // Prepare the name space declaration for MathML depending on document preferences. + string mathmlNamespace; + if (params().docbook_mathml_prefix != BufferParams::NoPrefix) { + string mathmlPrefix; + if (params().docbook_mathml_prefix == BufferParams::MPrefix) + mathmlPrefix = "m"; + else if (params().docbook_mathml_prefix == BufferParams::MMLPrefix) + mathmlPrefix = "mml"; + mathmlNamespace = + " xmlns:" + mathmlPrefix + "=\"http://www.w3.org/1998/Math/MathML\""; } - string const name = runparams.nice - ? changeExtension(absFileName(), ".sgml") : fname; - preamble += features.getIncludedFiles(name); - preamble += features.getLyXSGMLEntities(); + // XML-compatible language code: in lib/languages, language codes are + // given as dictionary file names; HTML5 expects to follow BCP47. This + // function implements a simple heuristic that does the conversion. + std::string htmlCode = params().language->code(); + std::replace(htmlCode.begin(), htmlCode.end(), '_', '-'); - if (!preamble.empty()) { - os << "\n [ " << preamble << " ]"; - } - os << ">\n\n"; + // Directly output the root tag, based on the current type of document. + string attributes = "xml:lang=\"" + htmlCode + '"' + + " xmlns=\"http://docbook.org/ns/docbook\"" + + " xmlns:xlink=\"http://www.w3.org/1999/xlink\"" + + mathmlNamespace + + " xmlns:xi=\"http://www.w3.org/2001/XInclude\"" + + " version=\"5.2\""; + // Version 5.2 is required for formalgroup. + + os << "<" << from_ascii(tclass.docbookroot()) << " " << from_ascii(attributes) << ">\n"; } if (output_body) { - string top = top_element; - top += " lang=\""; - if (runparams.flavor == OutputParams::XML) - top += params().language->code(); - else - top += params().language->code().substr(0, 2); - top += '"'; - - if (!params().options.empty()) { - top += ' '; - top += params().options; - } - - os << "\n"; - - params().documentClass().counters().reset(); + // Start to output the document. + XMLStream xs(os); + docbookParagraphs(text(), *this, xs, runparams); + } - sgml::openTag(os, top); - os << '\n'; - try { - docbookParagraphs(text(), *this, os, runparams); - } - catch (ConversionException const &) { return ExportKilled; } - sgml::closeTag(os, top_element); + if (output_preamble) { + // Close the root element. No need for a line break, as free text is never allowed + // in a root element, it must always be wrapped in some container. + os << ""; } + return ExportSuccess; } @@ -2196,7 +2216,7 @@ Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os, string const & Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname, OutputParams const & runparams) const { - LYXERR(Debug::LATEX, "makeLyXHTMLFile..."); + LYXERR(Debug::OUTFILE, "makeLyXHTMLFile..."); ofdocstream ofs; if (!openFileWrite(ofs, fname)) @@ -2232,30 +2252,28 @@ Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os, output == FullSource || output == OnlyBody || output == IncludedFile; if (output_preamble) { - os << "\n" - << "\n" - // FIXME Language should be set properly. - << "\n" + // HTML5-compatible language code: in lib/languages, language codes are + // given as dictionary file names; HTML5 expects to follow BCP47. This + // function implements a simple heuristic that does the conversion. + std::string htmlCode = params().language->code(); + std::replace(htmlCode.begin(), htmlCode.end(), '_', '-'); + + os << "\n" + << "\n" << "\n" - << "\n" - // FIXME Presumably need to set this right - << "\n"; + << "\n"; docstring const & doctitle = features.htmlTitle(); os << "" << (doctitle.empty() ? from_ascii("LyX Document") : - html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL)) + xml::escapeString(doctitle, XMLStream::ESCAPE_ALL)) << "\n"; docstring styles = features.getTClassHTMLPreamble(); if (!styles.empty()) os << "\n\n" << styles << '\n'; - styles = features.getPreambleSnippets().str; - if (!styles.empty()) - os << "\n\n" << styles << '\n'; - // we will collect CSS information in a stream, and then output it // either here, as part of the header, or else in a separate file. odocstringstream css; @@ -2303,7 +2321,7 @@ Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os, // we are here if the CSS is supposed to be written to the header // or if we failed to write it to an external file. if (!written) { - os << "\n"; } @@ -2315,7 +2333,7 @@ Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os, bool const output_body_tag = (output != IncludedFile); if (output_body_tag) os << "\n"; - XHTMLStream xs(os); + XMLStream xs(os); if (output != IncludedFile) // if we're an included file, the counters are in the master. params().documentClass().counters().reset(); @@ -2350,7 +2368,7 @@ int Buffer::runChktex() // Generate the LaTeX file if neccessary OutputParams runparams(¶ms().encoding()); - runparams.flavor = OutputParams::LATEX; + runparams.flavor = Flavor::LaTeX; runparams.nice = false; runparams.linelen = lyxrc.plaintext_linelen; ExportStatus const retval = @@ -2392,16 +2410,19 @@ void Buffer::validate(LaTeXFeatures & features) const if (!features.runparams().is_child) params().validate(features); + if (!parent()) + clearIncludeList(); + for (Paragraph const & p : paragraphs()) p.validate(features); - if (lyxerr.debugging(Debug::LATEX)) { + if (lyxerr.debugging(Debug::OUTFILE)) { features.showStruct(); } } -void Buffer::getLabelList(vector & list) const +void Buffer::getLabelList(vector> & list) const { // If this is a child document, use the master's list instead. if (parent()) { @@ -2412,8 +2433,9 @@ void Buffer::getLabelList(vector & list) const list.clear(); shared_ptr toc = d->toc_backend.toc("label"); for (auto const & tocit : *toc) { - if (tocit.depth() == 0) - list.push_back(tocit.str()); + if (tocit.depth() == 0) { + list.push_back(make_tuple(tocit.str(), tocit.asString(), tocit.prettyStr())); + } } } @@ -2422,7 +2444,7 @@ void Buffer::invalidateBibinfoCache() const { d->bibinfo_cache_valid_ = false; d->cite_labels_valid_ = false; - removeBiblioTempFiles(); + scheduleBiblioTempRemoval(); // also invalidate the cache for the parent buffer Buffer const * const pbuf = d->parent(); if (pbuf) @@ -2604,7 +2626,10 @@ void Buffer::reloadBibInfoCache(bool const force) const void Buffer::collectBibKeys(FileNameList & checkedFiles) const { - for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) { + if (!parent()) + clearIncludeList(); + + for (InsetIterator it = begin(inset()); it; ++it) { it->collectBibKeys(it, checkedFiles); if (it->lyxCode() == BIBITEM_CODE) { if (parent() != nullptr) @@ -2616,18 +2641,16 @@ void Buffer::collectBibKeys(FileNameList & checkedFiles) const } -void Buffer::addBiblioInfo(BiblioInfo const & bin) const +void Buffer::addBiblioInfo(BiblioInfo const & bi_in) const { - // We add the biblio info to the master buffer, - // if there is one, but also to every single buffer, - // in case a child is compiled alone. - BiblioInfo & bi = d->bibinfo_; - bi.mergeBiblioInfo(bin); + // We add the biblio info to the parent buffer, + // if there is one, but also to this buffer, in case + // it is compiled alone. + BiblioInfo & our_bi = d->bibinfo_; + our_bi.mergeBiblioInfo(bi_in); - if (parent() != nullptr) { - BiblioInfo & masterbi = parent()->d->bibinfo_; - masterbi.mergeBiblioInfo(bin); - } + if (parent()) + parent()->addBiblioInfo(bi_in); } @@ -2679,6 +2702,7 @@ void Buffer::removeBiblioTempFiles() const Buffer const * const pbuf = parent(); if (pbuf) pbuf->removeBiblioTempFiles(); + removeBiblioTemps = false; } @@ -2697,7 +2721,25 @@ void Buffer::markDepClean(string const & name) } -bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag) +bool Buffer::branchActivationEnabled(FuncCode act, docstring const & branch) const +{ + bool const master = act == LFUN_BRANCH_MASTER_ACTIVATE + || act == LFUN_BRANCH_MASTER_DEACTIVATE; + bool const activate = act == LFUN_BRANCH_ACTIVATE + || act == LFUN_BRANCH_MASTER_ACTIVATE; + Buffer const * buf = master ? masterBuffer() : this; + Branch const * our_branch = buf->params().branchlist().find(branch); + // Can be disabled if + // - this is a _MASTER_ command and there is no master + // - the relevant buffer does not know the branch + // - the branch is already in the desired state + return ((!master || parent() != nullptr) + && !branch.empty() && our_branch + && our_branch->isSelected() != activate); +} + + +bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag) const { if (isInternal()) { // FIXME? if there is an Buffer LFUN that can be dispatched even @@ -2724,7 +2766,7 @@ bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag) break; case LFUN_BUFFER_EXPORT: { - docstring const arg = cmd.argument(); + docstring const & arg = cmd.argument(); if (arg == "custom") { enable = true; break; @@ -2748,15 +2790,12 @@ bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag) case LFUN_BRANCH_ACTIVATE: case LFUN_BRANCH_DEACTIVATE: case LFUN_BRANCH_MASTER_ACTIVATE: - case LFUN_BRANCH_MASTER_DEACTIVATE: { - bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE - || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE); - BranchList const & branchList = master ? masterBuffer()->params().branchlist() - : params().branchlist(); - docstring const branchName = cmd.argument(); - flag.setEnabled(!branchName.empty() && branchList.find(branchName)); + case LFUN_BRANCH_MASTER_DEACTIVATE: + // Let a branch inset handle that + if (cmd.argument().empty()) + return false; + flag.setEnabled(branchActivationEnabled(cmd.action(), cmd.argument())); break; - } case LFUN_BRANCH_ADD: case LFUN_BRANCHES_RENAME: @@ -2801,6 +2840,53 @@ bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag) } +bool Buffer::branchActivationDispatch(FuncCode act, docstring const & branch) +{ + bool const master = (act == LFUN_BRANCH_MASTER_ACTIVATE + || act == LFUN_BRANCH_MASTER_DEACTIVATE); + bool const activate = (act == LFUN_BRANCH_ACTIVATE + || act == LFUN_BRANCH_MASTER_ACTIVATE); + Buffer * buf = master ? const_cast(masterBuffer()) : this; + Branch * our_branch = buf->params().branchlist().find(branch); + + // See comment in branchActivationStatus + if ((master && parent() == nullptr) + || !our_branch + || our_branch->isSelected() == activate) + return false; + + if (master && !buf->hasGuiDelegate() + && (!theApp() || !theApp()->unhide(buf))) + // at least issue a warning for now (ugly, but better than dataloss). + frontend::Alert::warning(_("Branch state changes in master document"), + lyx::support::bformat(_("The state of the branch '%1$s' " + "was changed in the master file. " + "Please make sure to save the master."), branch), true); + + UndoGroupHelper ugh(buf); + buf->undo().recordUndoBufferParams(CursorData()); + our_branch->setSelected(activate); + // cur.forceBufferUpdate() is not enough) + buf->updateBuffer(); + + // if branch exists in a descendant, update previews. + // TODO: only needed if "Show preview" is enabled in the included inset. + bool exists_in_desc = false; + for (auto const & it : buf->getDescendants()) { + if (it->params().branchlist().find(branch)) + exists_in_desc = true; + } + if (exists_in_desc) { + // TODO: ideally we would only update the previews of the + // specific children that have this branch directly or + // in one of their descendants + buf->removePreviews(); + buf->updatePreviews(); + } + return true; +} + + void Buffer::dispatch(string const & command, DispatchResult & result) { return dispatch(lyxaction.lookupFunc(command), result); @@ -2812,6 +2898,7 @@ void Buffer::dispatch(string const & command, DispatchResult & result) // whether we have a GUI or not. The boolean use_gui holds this information. void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr) { + LYXERR(Debug::ACTION, "Buffer::dispatch: cmd: " << func); if (isInternal()) { // FIXME? if there is an Buffer LFUN that can be dispatched even // if internal, put a switch '(cmd.action())' here. @@ -2910,40 +2997,20 @@ void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr) case LFUN_BRANCH_DEACTIVATE: case LFUN_BRANCH_MASTER_ACTIVATE: case LFUN_BRANCH_MASTER_DEACTIVATE: { - bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE - || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE); - Buffer * buf = master ? const_cast(masterBuffer()) - : this; - - docstring const branch_name = func.argument(); - // the case without a branch name is handled elsewhere - if (branch_name.empty()) { - dispatched = false; - break; - } - Branch * branch = buf->params().branchlist().find(branch_name); - if (!branch) { - LYXERR0("Branch " << branch_name << " does not exist."); - dr.setError(true); - docstring const msg = - bformat(_("Branch \"%1$s\" does not exist."), branch_name); - dr.setMessage(msg); - break; + // Let a branch inset handle that + if (func.argument().empty()) { + dr.dispatched(false); + return; } - bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE - || func.action() == LFUN_BRANCH_MASTER_ACTIVATE); - if (branch->isSelected() != activate) { - buf->undo().recordUndoBufferParams(CursorData()); - branch->setSelected(activate); - dr.setError(false); + bool const res = branchActivationDispatch(func.action(), func.argument()); + dr.setError(!res); + if (res) dr.screenUpdate(Update::Force); - dr.forceBufferUpdate(); - } break; } case LFUN_BRANCH_ADD: { - docstring branchnames = func.argument(); + docstring const & branchnames = func.argument(); if (branchnames.empty()) { dispatched = false; break; @@ -2964,9 +3031,9 @@ void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr) undo().recordUndoBufferParams(CursorData()); branch_list.add(branch_name); branch = branch_list.find(branch_name); - string const x11hexname = X11hexname(branch->color()); - docstring const str = branch_name + ' ' + from_ascii(x11hexname); - lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str)); + if (branch) + // needed to update the color table for dark mode + branch->setColors("background", "background"); dr.setError(false); dr.screenUpdate(Update::Force); } @@ -2982,10 +3049,10 @@ void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr) docstring const oldname = from_utf8(func.getArg(0)); docstring const newname = from_utf8(func.getArg(1)); - InsetIterator it = inset_iterator_begin(inset()); - InsetIterator const end = inset_iterator_end(inset()); + InsetIterator it = begin(inset()); + InsetIterator const itend = end(inset()); bool success = false; - for (; it != end; ++it) { + for (; it != itend; ++it) { if (it->lyxCode() == BRANCH_CODE) { InsetBranch & ins = static_cast(*it); if (ins.branch() == oldname) { @@ -2999,7 +3066,7 @@ void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr) // get buffer of external file InsetInclude const & ins = static_cast(*it); - Buffer * child = ins.getChildBuffer(); + Buffer * child = ins.loadIfNeeded(); if (!child) continue; child->dispatch(func, dr); @@ -3077,9 +3144,10 @@ void Buffer::changeLanguage(Language const * from, Language const * to) LASSERT(from, return); LASSERT(to, return); - for_each(par_iterator_begin(), - par_iterator_end(), - bind(&Paragraph::changeLanguage, _1, params(), from, to)); + ParIterator it = par_iterator_begin(); + ParIterator eit = par_iterator_end(); + for (; it != eit; ++it) + it->changeLanguage(params(), from, to); } @@ -3161,6 +3229,11 @@ ParConstIterator Buffer::par_iterator_end() const return ParConstIterator(doc_iterator_end(this)); } +bool Buffer::empty() const +{ + return paragraphs().size() == 1 && paragraphs().front().empty(); +} + Language const * Buffer::language() const { @@ -3168,7 +3241,7 @@ Language const * Buffer::language() const } -docstring const Buffer::B_(string const & l10n) const +docstring Buffer::B_(string const & l10n) const { return params().B_(l10n); } @@ -3399,7 +3472,7 @@ vector> const Buffer::prepareBibFilePaths(OutputParams c enc = params().bibFileEncoding(utf8input); bool recorded = false; - for (pair pe : res) { + for (auto const & pe : res) { if (pe.first == path) { recorded = true; break; @@ -3466,8 +3539,37 @@ bool Buffer::isReadonly() const void Buffer::setParent(Buffer const * buffer) { - // Avoids recursive include. - d->setParent(buffer == this ? nullptr : buffer); + // We need to do some work here to avoid recursive parent structures. + // This is the easy case. + if (buffer == this) { + LYXERR0("Ignoring attempt to set self as parent in\n" << fileName()); + return; + } + // Now we check parents going upward, to make sure that IF we set the + // parent as requested, we would not generate a recursive include. + set sb; + Buffer const * b = buffer; + bool found_recursion = false; + while (b) { + if (sb.find(b) != sb.end()) { + found_recursion = true; + break; + } + sb.insert(b); + b = b->parent(); + } + + if (found_recursion) { + LYXERR0("Ignoring attempt to set parent of\n" << + fileName() << + "\nto " << + buffer->fileName() << + "\nbecause that would create a recursive inclusion."); + return; + } + + // We should be safe now. + d->setParent(buffer); updateMacros(); } @@ -3488,8 +3590,6 @@ ListOfBuffers Buffer::allRelatives() const Buffer const * Buffer::masterBuffer() const { - // FIXME Should be make sure we are not in some kind - // of recursive include? A -> B -> A will crash this. Buffer const * const pbuf = d->parent(); if (!pbuf) return this; @@ -3520,19 +3620,19 @@ bool Buffer::hasChildren() const } -void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const +void Buffer::collectChildren(ListOfBuffers & children, bool grand_children) const { // loop over children for (auto const & p : d->children_positions) { Buffer * child = const_cast(p.first); // No duplicates - ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child); - if (bit != clist.end()) + ListOfBuffers::const_iterator bit = find(children.begin(), children.end(), child); + if (bit != children.end()) continue; - clist.push_back(child); + children.push_back(child); if (grand_children) // there might be grandchildren - child->collectChildren(clist, true); + child->collectChildren(children, true); } } @@ -3721,7 +3821,6 @@ void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope) while (it.pit() <= lastpit) { Paragraph & par = it.paragraph(); - // FIXME Can this be done with the new-style iterators? // iterate over the insets of the current paragraph for (auto const & insit : par.insetList()) { it.pos() = insit.pos; @@ -3760,16 +3859,14 @@ void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope) InsetInclude const & incinset = static_cast(*insit.inset); macro_lock = true; - Buffer * child = incinset.getChildBuffer(); + Buffer * child = incinset.loadIfNeeded(); macro_lock = false; if (!child) continue; // register its position, but only when it is // included first in the buffer - if (children_positions.find(child) == - children_positions.end()) - children_positions[child] = it; + children_positions.insert({child, it}); // register child with its scope position_to_children[it] = Impl::ScopeBuffer(scope, child); @@ -3804,7 +3901,7 @@ void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope) // FIXME (Abdel), I don't understand why we pass 'it' here // instead of 'macroTemplate' defined above... is this correct? macros[macroTemplate.name()][it] = - Impl::ScopeMacro(scope, MacroData(const_cast(owner_), it)); + Impl::ScopeMacro(scope, MacroData(owner_, it)); } // next paragraph @@ -3839,11 +3936,9 @@ void Buffer::updateMacros() const void Buffer::getUsedBranches(std::list & result, bool const from_master) const { - InsetIterator it = inset_iterator_begin(inset()); - InsetIterator const end = inset_iterator_end(inset()); - for (; it != end; ++it) { - if (it->lyxCode() == BRANCH_CODE) { - InsetBranch & br = static_cast(*it); + for (Inset const & it : inset()) { + if (it.lyxCode() == BRANCH_CODE) { + InsetBranch const & br = static_cast(it); docstring const name = br.branch(); if (!from_master && !params().branchlist().find(name)) result.push_back(name); @@ -3851,11 +3946,11 @@ void Buffer::getUsedBranches(std::list & result, bool const from_mast result.push_back(name); continue; } - if (it->lyxCode() == INCLUDE_CODE) { + if (it.lyxCode() == INCLUDE_CODE) { // get buffer of external file InsetInclude const & ins = - static_cast(*it); - Buffer * child = ins.getChildBuffer(); + static_cast(it); + Buffer * child = ins.loadIfNeeded(); if (!child) continue; child->getUsedBranches(result, true); @@ -3880,9 +3975,9 @@ void Buffer::updateMacroInstances(UpdateType utype) const continue; // update macro in all cells of the InsetMathNest - DocIterator::idx_type n = minset->nargs(); + idx_type n = minset->nargs(); MacroContext mc = MacroContext(this, it); - for (DocIterator::idx_type i = 0; i < n; ++i) { + for (idx_type i = 0; i < n; ++i) { MathData & data = minset->cell(i); data.updateMacros(nullptr, mc, utype, 0); } @@ -3987,7 +4082,7 @@ void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il, InsetLabel const * Buffer::insetLabel(docstring const & label, bool const active) const { - for (auto & rc : masterBuffer()->d->label_cache_) { + for (auto const & rc : masterBuffer()->d->label_cache_) { if (rc.label == label && (rc.active || !active)) return rc.inset; } @@ -3997,10 +4092,7 @@ InsetLabel const * Buffer::insetLabel(docstring const & label, bool Buffer::activeLabel(docstring const & label) const { - if (!insetLabel(label, true)) - return false; - - return true; + return insetLabel(label, true) != nullptr; } @@ -4028,7 +4120,7 @@ void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to) string const paramName = "key"; UndoGroupHelper ugh(this); - InsetIterator it = inset_iterator_begin(inset()); + InsetIterator it = begin(inset()); for (; it; ++it) { if (it->lyxCode() != CITE_CODE) continue; @@ -4057,39 +4149,51 @@ unique_ptr Buffer::getSourceCode(odocstream & os, string const & format, // Some macros rely on font encoding runparams.main_fontenc = params().main_font_encoding(); + // Use the right wrapping for the comment at the beginning of the generated + // snippet, so that it is either valid LaTeX or valid XML (including HTML and DocBook). + docstring comment_start = from_ascii("% "); + docstring comment_end = from_ascii(""); + if (runparams.flavor == Flavor::Html || runparams.flavor == Flavor::DocBook5) { + comment_start = from_ascii(""); + } + if (output == CurrentParagraph) { runparams.par_begin = par_begin; runparams.par_end = par_end; if (par_begin + 1 == par_end) { - os << "% " + os << comment_start << bformat(_("Preview source code for paragraph %1$d"), par_begin) + << comment_end << "\n\n"; } else { - os << "% " + os << comment_start << bformat(_("Preview source code from paragraph %1$s to %2$s"), convert(par_begin), convert(par_end - 1)) + << comment_end << "\n\n"; } // output paragraphs - if (runparams.flavor == OutputParams::LYX) { + if (runparams.flavor == Flavor::LyX) { Paragraph const & par = text().paragraphs()[par_begin]; ostringstream ods; depth_type dt = par.getDepth(); par.write(ods, params(), dt); os << from_utf8(ods.str()); - } else if (runparams.flavor == OutputParams::HTML) { - XHTMLStream xs(os); + } else if (runparams.flavor == Flavor::Html) { + XMLStream xs(os); setMathFlavor(runparams); xhtmlParagraphs(text(), *this, xs, runparams); - } else if (runparams.flavor == OutputParams::TEXT) { + } else if (runparams.flavor == Flavor::Text) { bool dummy = false; // FIXME Handles only one paragraph, unlike the others. // Probably should have some routine with a signature like them. writePlaintextParagraph(*this, text().paragraphs()[par_begin], os, runparams, dummy); - } else if (params().isDocBook()) { - docbookParagraphs(text(), *this, os, runparams); + } else if (runparams.flavor == Flavor::DocBook5) { + XMLStream xs{os}; + docbookParagraphs(text(), *this, xs, runparams); } else { // If we are previewing a paragraph, even if this is the // child of some other buffer, let's cut the link here, @@ -4103,6 +4207,8 @@ unique_ptr Buffer::getSourceCode(odocstream & os, string const & format, LaTeXFeatures features(*this, params(), runparams); validate(features); runparams.use_polyglossia = features.usePolyglossia(); + runparams.use_babel = features.useBabel(); + runparams.use_hyperref = features.isRequired("hyperref"); // latex or literate otexstream ots(os); // output above @@ -4116,15 +4222,16 @@ unique_ptr Buffer::getSourceCode(odocstream & os, string const & format, d->ignore_parent = false; } } else { - os << "% "; + os << comment_start; if (output == FullSource) os << _("Preview source code"); else if (output == OnlyPreamble) os << _("Preview preamble"); else if (output == OnlyBody) os << _("Preview body"); + os << comment_end; os << "\n\n"; - if (runparams.flavor == OutputParams::LYX) { + if (runparams.flavor == Flavor::LyX) { ostringstream ods; if (output == FullSource) write(ods); @@ -4133,15 +4240,15 @@ unique_ptr Buffer::getSourceCode(odocstream & os, string const & format, else if (output == OnlyBody) text().write(ods); os << from_utf8(ods.str()); - } else if (runparams.flavor == OutputParams::HTML) { + } else if (runparams.flavor == Flavor::Html) { writeLyXHTMLSource(os, runparams, output); - } else if (runparams.flavor == OutputParams::TEXT) { - if (output == OnlyPreamble) { + } else if (runparams.flavor == Flavor::Text) { + if (output == OnlyPreamble) os << "% "<< _("Plain text does not have a preamble."); - } else + else writePlaintextFile(*this, os, runparams); - } else if (params().isDocBook()) { - writeDocBookSource(os, absFileName(), runparams, output); + } else if (runparams.flavor == Flavor::DocBook5) { + writeDocBookSource(os, runparams, output); } else { // latex or literate otexstream ots(os); @@ -4207,6 +4314,13 @@ void Buffer::updateTitles() const } +void Buffer::scheduleRedrawWorkAreas() const +{ + if (d->wa_) + d->wa_->scheduleRedraw(); +} + + void Buffer::resetAutosaveTimers() const { if (d->gui_) @@ -4226,91 +4340,6 @@ void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui) } - -namespace { - -class AutoSaveBuffer : public ForkedProcess { -public: - /// - AutoSaveBuffer(Buffer const & buffer, FileName const & fname) - : buffer_(buffer), fname_(fname) {} - /// - virtual shared_ptr clone() const - { - return make_shared(*this); - } - /// - int start() - { - command_ = to_utf8(bformat(_("Auto-saving %1$s"), - from_utf8(fname_.absFileName()))); - return run(DontWait); - } -private: - /// - virtual int generateChild(); - /// - Buffer const & buffer_; - FileName fname_; -}; - - -int AutoSaveBuffer::generateChild() -{ -#if defined(__APPLE__) - /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard) - * We should use something else like threads. - * - * Since I do not know how to determine at run time what is the OS X - * version, I just disable forking altogether for now (JMarc) - */ - pid_t const pid = -1; -#else - // tmp_ret will be located (usually) in /tmp - // will that be a problem? - // Note that this calls ForkedCalls::fork(), so it's - // ok cross-platform. - pid_t const pid = fork(); - // If you want to debug the autosave - // you should set pid to -1, and comment out the fork. - if (pid != 0 && pid != -1) - return pid; -#endif - - // pid = -1 signifies that lyx was unable - // to fork. But we will do the save - // anyway. - bool failed = false; - TempFile tempfile("lyxautoXXXXXX.lyx"); - tempfile.setAutoRemove(false); - FileName const tmp_ret = tempfile.name(); - if (!tmp_ret.empty()) { - if (!buffer_.writeFile(tmp_ret)) - failed = true; - else if (!tmp_ret.moveTo(fname_)) - failed = true; - } else - failed = true; - - if (failed) { - // failed to write/rename tmp_ret so try writing direct - if (!buffer_.writeFile(fname_)) { - // It is dangerous to do this in the child, - // but safe in the parent, so... - if (pid == -1) // emit message signal. - buffer_.message(_("Autosave failed!")); - } - } - - if (pid == 0) // we are the child so... - _exit(0); - - return pid; -} - -} // namespace - - FileName Buffer::getEmergencyFileName() const { return FileName(d->filename.absFileName() + ".emergency"); @@ -4407,7 +4436,7 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir string & result_file) const { bool const update_unincluded = - params().maintain_unincluded_children + params().maintain_unincluded_children != BufferParams::CM_None && !params().getIncludedChildren().empty(); // (1) export with all included children (omit \includeonly) @@ -4424,6 +4453,9 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir void Buffer::setMathFlavor(OutputParams & op) const { + // Passes the way to generate formulae to the XHTML output code. + // In particular, this function has no impact on the DocBook code, as it + // uses another mechanism to handle math flavours. switch (params().html_math_output) { case BufferParams::MathML: op.math_flavor = OutputParams::MathAsMathML; @@ -4444,6 +4476,8 @@ void Buffer::setMathFlavor(OutputParams & op) const Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir, bool includeall, string & result_file) const { + if (removeBiblioTemps) + removeBiblioTempFiles(); LYXERR(Debug::FILES, "target=" << target); OutputParams runparams(¶ms().encoding()); string format = target; @@ -4460,14 +4494,14 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir } MarkAsExporting exporting(this); string backend_format; - runparams.flavor = OutputParams::LATEX; + runparams.flavor = Flavor::LaTeX; runparams.linelen = lyxrc.plaintext_linelen; runparams.includeall = includeall; vector backs = params().backends(); Converters converters = theConverters(); bool need_nice_file = false; if (find(backs.begin(), backs.end(), format) == backs.end()) { - // Get shortest path to format + // Get the shortest path to format converters.buildGraph(); Graph::EdgePath path; for (string const & sit : backs) { @@ -4482,10 +4516,10 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir // Only show this alert if this is an export to a non-temporary // file (not for previewing). docstring s = bformat(_("No information for exporting the format %1$s."), - theFormats().prettyName(format)); + translateIfPossible(theFormats().prettyName(format))); if (format == "pdf4") s += "\n" - + bformat(_("Hint: use non-TeX fonts or set input encoding " + + bformat(_("Hint: use non-TeX fonts or set input encoding" " to '%1$s'"), from_utf8(encodings.fromLyXName("ascii")->guiName())); Alert::error(_("Couldn't export file"), s); } @@ -4504,13 +4538,13 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir LYXERR(Debug::FILES, "backend_format=" << backend_format); // FIXME: Don't hardcode format names here, but use a flag if (backend_format == "pdflatex") - runparams.flavor = OutputParams::PDFLATEX; + runparams.flavor = Flavor::PdfLaTeX; else if (backend_format == "luatex") - runparams.flavor = OutputParams::LUATEX; + runparams.flavor = Flavor::LuaTeX; else if (backend_format == "dviluatex") - runparams.flavor = OutputParams::DVILUATEX; + runparams.flavor = Flavor::DviLuaTeX; else if (backend_format == "xetex") - runparams.flavor = OutputParams::XETEX; + runparams.flavor = Flavor::XeTeX; } string filename = latexName(false); @@ -4521,7 +4555,7 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir // Plain text backend if (backend_format == "text") { - runparams.flavor = OutputParams::TEXT; + runparams.flavor = Flavor::Text; try { writePlaintextFile(*this, FileName(filename), runparams); } @@ -4529,15 +4563,16 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir } // HTML backend else if (backend_format == "xhtml") { - runparams.flavor = OutputParams::HTML; + runparams.flavor = Flavor::Html; setMathFlavor(runparams); if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled) return ExportKilled; } else if (backend_format == "lyx") writeFile(FileName(filename)); - // Docbook backend - else if (params().isDocBook()) { - runparams.nice = !put_in_tempdir; + // DocBook backend + else if (backend_format == "docbook5") { + runparams.flavor = Flavor::DocBook5; + runparams.nice = false; if (makeDocBookFile(FileName(filename), runparams) == ExportKilled) return ExportKilled; } @@ -4578,8 +4613,9 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir string const ext = theFormats().extension(format); FileName const tmp_result_file(changeExtension(filename, ext)); Converters::RetVal const retval = - converters.convert(this, FileName(filename), tmp_result_file, - FileName(absFileName()), backend_format, format, error_list); + converters.convert(this, FileName(filename), tmp_result_file, + FileName(absFileName()), backend_format, format, + error_list, Converters::none, includeall); if (retval == Converters::KILLED) return ExportCancel; bool success = (retval == Converters::SUCCESS); @@ -4631,7 +4667,7 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir result_file = changeExtension(d->exportFileName().absFileName(), ext); else result_file = dest_filename; - // We need to copy referenced files (e. g. included graphics + // We need to copy referenced files (e.g. included graphics // if format == "dvi") to the result dir. vector const extfiles = runparams.exportdata->externalFiles(format); @@ -4678,13 +4714,13 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir } else { message(bformat(_("Document exported as %1$s " "to file `%2$s'"), - theFormats().prettyName(format), + translateIfPossible(theFormats().prettyName(format)), makeDisplayPath(result_file))); } } else { // This must be a dummy converter like fax (bug 1888) message(bformat(_("Document exported as %1$s"), - theFormats().prettyName(format))); + translateIfPossible(theFormats().prettyName(format)))); } return success ? ExportSuccess : ExportConverterError; @@ -4694,7 +4730,7 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir Buffer::ExportStatus Buffer::preview(string const & format) const { bool const update_unincluded = - params().maintain_unincluded_children + params().maintain_unincluded_children != BufferParams::CM_None && !params().getIncludedChildren().empty(); return preview(format, update_unincluded); } @@ -4756,7 +4792,7 @@ Buffer::ReadStatus Buffer::loadEmergency() "%1$s exists.\n\nRecover emergency save?"), file); int const load_emerg = Alert::prompt(_("Load emergency save?"), text, - 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel")); + 0, 3, _("&Recover"), _("&Load Original"), _("&Only show difference"), _("&Cancel")); switch (load_emerg) { @@ -4823,7 +4859,7 @@ Buffer::ReadStatus Buffer::loadEmergency() "asked about it again the next time you try to load " "this file, and may over-write your own work.")); } else { - Alert::warning(_("Emergency File Renames"), + Alert::warning(_("Emergency File Renamed"), bformat(_("Emergency file renamed as:\n %1$s"), from_utf8(newname.onlyFileName()))); } @@ -4831,6 +4867,22 @@ Buffer::ReadStatus Buffer::loadEmergency() return ReadOriginal; } + case 2: { + string const f1 = d->filename.absFileName(); + string const f2 = emergencyFile.absFileName(); + if (loadThisLyXFile(d->filename) != ReadSuccess) + return ReadCancel; + string const par = "compare run-blocking " + quoteName(f1) + " " + quoteName(f2); + LYXERR(Debug::FILES, par << "\n"); + lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, par)); + + //release the emergency buffer loaded by compare + Buffer * emerBuffer = theBufferList().getBuffer(emergencyFile); + if (emerBuffer) + theBufferList().release(emerBuffer); + + return ReadCancel; //Release the buffer of Original immediatelly + } default: break; } @@ -4960,10 +5012,21 @@ void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const } +void Buffer::updateBuffer() const +{ + updateBuffer(UpdateMaster, InternalUpdate); + d->need_update = false; +} + + void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const { LBUFERR(!text().paragraphs().empty()); + // This can be called when loading a file, so that there be no + // open undo group. + UndoGroupHelper ugh(const_cast(this)); + // Use the master text class also for child documents Buffer const * const master = masterBuffer(); DocumentClass const & textclass = master->params().documentClass(); @@ -5025,6 +5088,8 @@ void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const // do the real work ParIterator parit = cbuf.par_iterator_begin(); + if (scope == UpdateMaster) + clearIncludeList(); updateBuffer(parit, utype); // If this document has siblings, then update the TocBackend later. The @@ -5067,9 +5132,12 @@ void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const } d->cite_labels_valid_ = true; /// FIXME: Perf + clearIncludeList(); cbuf.tocBackend().update(true, utype); if (scope == UpdateMaster) cbuf.structureChanged(); + + d->need_update = false; } @@ -5181,31 +5249,11 @@ void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const switch(layout.labeltype) { case LABEL_ITEMIZE: { - // At some point of time we should do something more - // clever here, like: - // par.params().labelString( - // bp.user_defined_bullet(par.itemdepth).getText()); - // for now, use a simple hardcoded label - docstring itemlabel; - switch (par.itemdepth) { - case 0: - // • U+2022 BULLET - itemlabel = char_type(0x2022); - break; - case 1: - // – U+2013 EN DASH - itemlabel = char_type(0x2013); - break; - case 2: - // ∗ U+2217 ASTERISK OPERATOR - itemlabel = char_type(0x2217); - break; - case 3: - // · U+00B7 MIDDLE DOT - itemlabel = char_type(0x00b7); - break; - } - par.params().labelString(itemlabel); + par.params().labelString( + (par.itemdepth < 4) + ? bp.user_defined_bullet(par.itemdepth).getLabel() + // Display fallback for too deeply nested items + : bformat(from_ascii("[?%1$d]"), int(par.itemdepth + 1))); break; } @@ -5231,9 +5279,9 @@ void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const } if (needEnumCounterReset(it)) { - // Increase the master counter? - if (layout.stepmastercounter) - counters.stepMaster(enumcounter, utype); + // Increase the parent counter? + if (layout.stepparentcounter) + counters.stepParent(enumcounter, utype); // Maybe we have to reset the enumeration counter. if (!layout.resumecounter) counters.reset(enumcounter); @@ -5295,8 +5343,13 @@ void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const } -void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const +void Buffer::updateBuffer(ParIterator & parit, UpdateType utype, bool const deleted) const { + // if fomatted references are shown in workarea update buffer accordingly + if (params().use_formatted_ref) + utype = OutputUpdate; + + pushIncludedBuffer(this); // LASSERT: Is it safe to continue here, or should we just return? LASSERT(parit.pit() == 0, /**/); @@ -5304,11 +5357,6 @@ void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const // to resolve macros in it. parit.text()->setMacrocontextPosition(parit); - // Reset bibitem counter in master (#8499) - Buffer const * const master = masterBuffer(); - if (master == this && !d->ignore_parent) - master->params().documentClass().counters().reset(from_ascii("bibitem")); - depth_type maxdepth = 0; pit_type const lastpit = parit.lastpit(); bool changed = false; @@ -5341,7 +5389,7 @@ void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const // now the insets for (auto const & insit : parit->insetList()) { parit.pos() = insit.pos; - insit.inset->updateBuffer(parit, utype); + insit.inset->updateBuffer(parit, utype, deleted || parit->isDeleted(insit.pos)); changed |= insit.inset->isChanged(); } @@ -5352,6 +5400,19 @@ void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const // set change indicator for the inset (or the cell that the iterator // points to, if applicable). parit.text()->inset().isChanged(changed); + popIncludedBuffer(); +} + + +void Buffer::forceUpdate() const +{ + d->need_update = true; +} + + +bool Buffer::needUpdate() const +{ + return d->need_update; } @@ -5393,6 +5454,15 @@ int Buffer::spellCheck(DocIterator & from, DocIterator & to, } +void Buffer::requestSpellcheck() +{ + ParagraphList::iterator pit = paragraphs().begin(); + ParagraphList::iterator pend = paragraphs().end(); + for (; pit != pend; ++pit) + pit->requestSpellCheck(); +} + + void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) { bool inword = false; @@ -5428,10 +5498,19 @@ void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool s ++word_count_; inword = true; } - if (ins && ins->isLetter()) - ++char_count_; + if (ins && ins->isLetter()) { + odocstringstream os; + ins->toString(os); + char_count_ += os.str().length(); + } else if (ins && ins->isSpace()) ++blank_count_; + else if (ins) { + pair words = ins->isWords(); + char_count_ += words.first; + word_count_ += words.second; + inword = false; + } else { char_type const c = par.getChar(pos); if (isPrintableNonspace(c)) @@ -5480,12 +5559,22 @@ Buffer::ReadStatus Buffer::reload() docstring const disp_fn = makeDisplayPath(d->filename.absFileName()); // clear parent. this will get reset if need be. + Buffer const * oldparent = d->parent(); d->setParent(nullptr); ReadStatus const status = loadLyXFile(); + // The inset members in cursors held by buffer views are now wrong. + workAreaManager().sanitizeCursors(); + setBusy(false); if (status == ReadSuccess) { updateBuffer(); changed(true); updateTitles(); + // reset parent if this hasn't been done yet + // but only if this is still its child (e.g., + // not after the former child has been saved as...) + if (!d->parent() && oldparent && oldparent->isFullyLoaded() + && oldparent->isChild(this)) + d->setParent(oldparent); markClean(); message(bformat(_("Document %1$s reloaded."), disp_fn)); d->undo_.clear(); @@ -5639,15 +5728,24 @@ void Buffer::Impl::fileExternallyModified(bool const exists) "checksum unchanged: " << filename); return; } + lyx_clean = false; // If the file has been deleted, only mark the file as dirty since it is // pointless to prompt for reloading. If later a file is moved into this // location, then the externally modified warning will appear then. if (exists) - externally_modified_ = true; + externally_modified_ = true; // Update external modification notification. // Dirty buffers must be visible at all times. - if (wa_ && wa_->unhide(owner_)) + if (wa_ && wa_->unhide(owner_)) { wa_->updateTitles(); + if (!exists) { + frontend::Alert::warning( + _("File deleted from disk"), + bformat(_("The file\n %1$s\n" + "has been deleted from disk!"), + from_utf8(filename.absFileName()))); + } + } else // Unable to unhide the buffer (e.g. no GUI or not current View) lyx_clean = true; @@ -5668,4 +5766,55 @@ void Buffer::clearExternalModification() const } +void Buffer::pushIncludedBuffer(Buffer const * buf) const +{ + masterBuffer()->d->include_list_.push_back(buf); + if (lyxerr.debugging(Debug::FILES)) { + LYXERR0("Pushed. Stack now:"); + if (masterBuffer()->d->include_list_.empty()) + LYXERR0("EMPTY!"); + else + for (auto const & b : masterBuffer()->d->include_list_) + LYXERR0(b->fileName()); + } +} + + +void Buffer::popIncludedBuffer() const +{ + masterBuffer()->d->include_list_.pop_back(); + if (lyxerr.debugging(Debug::FILES)) { + LYXERR0("Popped. Stack now:"); + if (masterBuffer()->d->include_list_.empty()) + LYXERR0("EMPTY!"); + else + for (auto const & b : masterBuffer()->d->include_list_) + LYXERR0(b->fileName()); + } +} + + +bool Buffer::isBufferIncluded(Buffer const * buf) const +{ + if (!buf) + return false; + if (lyxerr.debugging(Debug::FILES)) { + LYXERR0("Checking for " << buf->fileName() << ". Stack now:"); + if (masterBuffer()->d->include_list_.empty()) + LYXERR0("EMPTY!"); + else + for (auto const & b : masterBuffer()->d->include_list_) + LYXERR0(b->fileName()); + } + list const & blist = masterBuffer()->d->include_list_; + return find(blist.begin(), blist.end(), buf) != blist.end(); +} + + +void Buffer::clearIncludeList() const +{ + LYXERR(Debug::FILES, "Clearing include list for " << fileName()); + d->include_list_.clear(); +} + } // namespace lyx