3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Stefan Schimanski
9 * Full author contact details are available in file CREDITS.
17 #include "BiblioInfo.h"
18 #include "BranchList.h"
19 #include "buffer_funcs.h"
20 #include "BufferList.h"
21 #include "BufferParams.h"
25 #include "Converter.h"
28 #include "CutAndPaste.h"
29 #include "DispatchResult.h"
30 #include "DocIterator.h"
31 #include "BufferEncodings.h"
32 #include "ErrorList.h"
35 #include "FuncRequest.h"
36 #include "FuncStatus.h"
37 #include "IndicesList.h"
38 #include "InsetIterator.h"
39 #include "InsetList.h"
41 #include "LaTeXFeatures.h"
45 #include "LyXAction.h"
50 #include "output_latex.h"
51 #include "output_docbook.h"
52 #include "output_plaintext.h"
53 #include "output_xhtml.h"
54 #include "Paragraph.h"
55 #include "ParagraphParameters.h"
56 #include "ParIterator.h"
57 #include "PDFOptions.h"
59 #include "SpellChecker.h"
61 #include "texstream.h"
64 #include "TextClass.h"
65 #include "TocBackend.h"
67 #include "VCBackend.h"
69 #include "WordLangTuple.h"
71 #include "insets/InsetBranch.h"
72 #include "insets/InsetInclude.h"
73 #include "insets/InsetText.h"
75 #include "mathed/InsetMathHull.h"
76 #include "mathed/MacroTable.h"
77 #include "mathed/InsetMathMacroTemplate.h"
78 #include "mathed/MathSupport.h"
80 #include "graphics/PreviewLoader.h"
82 #include "frontends/Application.h"
83 #include "frontends/alert.h"
84 #include "frontends/Delegates.h"
85 #include "frontends/WorkAreaManager.h"
87 #include "support/lassert.h"
88 #include "support/convert.h"
89 #include "support/debug.h"
90 #include "support/docstring_list.h"
91 #include "support/ExceptionMessage.h"
92 #include "support/FileMonitor.h"
93 #include "support/FileName.h"
94 #include "support/FileNameList.h"
95 #include "support/filetools.h"
96 #include "support/gettext.h"
97 #include "support/gzstream.h"
98 #include "support/lstrings.h"
99 #include "support/mutex.h"
100 #include "support/os.h"
101 #include "support/Package.h"
102 #include "support/PathChanger.h"
103 #include "support/Systemcall.h"
104 #include "support/TempFile.h"
105 #include "support/textutils.h"
106 #include "support/types.h"
118 using namespace lyx::support;
119 using namespace lyx::graphics;
123 namespace Alert = frontend::Alert;
124 namespace os = support::os;
128 int const LYX_FORMAT = LYX_FORMAT_LYX;
130 typedef map<string, bool> DepClean;
132 // Information about labels and their associated refs
137 InsetLabel const * inset;
138 /// associated references cache
139 Buffer::References references;
140 /// whether this label is active (i.e., not deleted)
144 typedef vector<LabelInfo> LabelCache;
146 typedef map<docstring, Buffer::References> RefCache;
148 // A storehouse for the cloned buffers.
149 typedef list<CloneList_ptr> CloneStore;
150 CloneStore cloned_buffers;
159 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
163 delete preview_loader_;
171 /// search for macro in local (buffer) table or in children
172 MacroData const * getBufferMacro(docstring const & name,
173 DocIterator const & pos) const;
175 /// Update macro table starting with position of it \param it in some
177 void updateMacros(DocIterator & it, DocIterator & scope);
179 void setLabel(ParIterator & it, UpdateType utype) const;
181 /** If we have branches that use the file suffix
182 feature, return the file name with suffix appended.
184 FileName exportFileName() const;
191 mutable TexRow texrow;
193 /// need to regenerate .tex?
196 /// name of the file the buffer is associated with.
200 mutable TocBackend toc_backend;
205 ScopeMacro(DocIterator const & s, MacroData const & m)
206 : scope(s), macro(m) {}
210 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
211 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
212 /// map from the macro name to the position map,
213 /// which maps the macro definition position to the scope and the MacroData.
214 NamePositionScopeMacroMap macros;
216 /// positions of child buffers in the buffer
217 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
219 ScopeBuffer() : buffer(nullptr) {}
220 ScopeBuffer(DocIterator const & s, Buffer const * b)
221 : scope(s), buffer(b) {}
223 Buffer const * buffer;
225 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
226 /// position of children buffers in this buffer
227 BufferPositionMap children_positions;
228 /// map from children inclusion positions to their scope and their buffer
229 PositionScopeBufferMap position_to_children;
231 /// Contains the old buffer filePath() while saving-as, or the
232 /// directory where the document was last saved while loading.
235 /** Keeps track of the path of local layout files.
236 * If possible, it is always relative to the buffer path.
237 * Empty for layouts in system or user directory.
239 string layout_position;
241 /// Container for all sort of Buffer dependant errors.
242 map<string, ErrorList> errorLists;
244 /// checksum used to test if the file has been externally modified. Used to
245 /// double check whether the file had been externally modified when saving.
246 unsigned long checksum_;
249 frontend::WorkAreaManager * wa_;
251 frontend::GuiBufferDelegate * gui_;
256 /// A cache for the bibfiles (including bibfiles of loaded child
257 /// documents), needed for appropriate update of natbib labels.
258 mutable docstring_list bibfiles_cache_;
260 // FIXME The caching mechanism could be improved. At present, we have a
261 // cache for each Buffer, that caches all the bibliography info for that
262 // Buffer. A more efficient solution would be to have a global cache per
263 // file, and then to construct the Buffer's bibinfo from that.
264 /// A cache for bibliography info
265 mutable BiblioInfo bibinfo_;
266 /// Cache of timestamps of .bib files
267 map<FileName, time_t> bibfile_status_;
269 /// These two hold the file name and format, written to by
270 /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
271 FileName preview_file_;
272 string preview_format_;
274 /// Cache the references associated to a label and their positions
276 mutable RefCache ref_cache_;
277 /// Cache the label insets and their activity status.
278 mutable LabelCache label_cache_;
280 /// our Text that should be wrapped in an InsetText
284 PreviewLoader * preview_loader_;
286 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
287 /// This one is useful for preview detached in a thread.
288 Buffer const * cloned_buffer_;
290 CloneList_ptr clone_list_;
293 std::list<Buffer const *> include_list_;
295 /// So we can force access via the accessors.
296 mutable Buffer const * parent_buffer;
298 FileMonitorPtr file_monitor_;
300 /// ints and bools are all listed last so as to avoid alignment issues
302 /// original format of loaded file
305 /// are we in the process of exporting this buffer?
306 mutable bool doing_export;
308 /// If there was an error when previewing, on the next preview we do
309 /// a fresh compile (e.g. in case the user installed a package that
311 bool require_fresh_start_;
313 /// Indicates whether the bibinfo has changed since the last time
314 /// we ran updateBuffer(), i.e., whether citation labels may need
316 mutable bool cite_labels_valid_;
317 /// Do we have a bibliography environment?
318 mutable bool have_bibitems_;
321 mutable bool lyx_clean;
323 /// is autosave needed?
324 mutable bool bak_clean;
326 /// is this an unnamed file (New...)?
329 /// is this an internal bufffer?
330 bool internal_buffer;
335 /** Set to true only when the file is fully loaded.
336 * Used to prevent the premature generation of previews
337 * and by the citation inset.
339 bool file_fully_loaded;
341 /// if the file was originally loaded from an older format, do
342 /// we need to back it up still?
343 bool need_format_backup;
345 /// Ignore the parent (e.g. when exporting a child standalone)?
348 /// This seem to change the way Buffer::getMacro() works
349 mutable bool macro_lock;
351 /// has been externally modified? Can be reset by the user.
352 mutable bool externally_modified_;
354 /// whether the bibinfo cache is valid
355 mutable bool bibinfo_cache_valid_;
358 mutable bool need_update;
366 /// This is here to force the test to be done whenever parent_buffer
368 Buffer const * parent() const
370 // ignore_parent temporarily "orphans" a buffer
371 // (e.g. if a child is compiled standalone)
374 // if parent_buffer is not loaded, then it has been unloaded,
375 // which means that parent_buffer is an invalid pointer. So we
376 // set it to null in that case.
377 // however, the BufferList doesn't know about cloned buffers, so
378 // they will always be regarded as unloaded. in that case, we hope
380 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
381 parent_buffer = nullptr;
382 return parent_buffer;
386 void setParent(Buffer const * pb)
388 if (parent_buffer == pb)
391 if (!cloned_buffer_ && parent_buffer && pb)
392 LYXERR0("Warning: a buffer should not have two parents!");
394 if (!cloned_buffer_ && parent_buffer)
395 parent_buffer->invalidateBibinfoCache();
398 /// compute statistics
399 /// \p from initial position
400 /// \p to points to the end position
401 void updateStatistics(DocIterator & from, DocIterator & to,
402 bool skipNoOutput = true);
403 /// statistics accessor functions
404 int wordCount() const
408 int charCount(bool with_blanks) const
411 + (with_blanks ? blank_count_ : 0);
414 // Make sure the file monitor monitors the good file.
415 void refreshFileMonitor();
417 /// Notify or clear of external modification
418 void fileExternallyModified(bool exists);
420 ///Binding LaTeX lines with buffer positions.
421 //Common routine for LaTeX and Reference errors listing.
422 void traverseErrors(TeXErrors::Errors::const_iterator err,
423 TeXErrors::Errors::const_iterator end,
424 ErrorList & errorList) const;
428 /// Creates the per buffer temporary directory
429 static FileName createBufferTmpDir()
431 // FIXME This would be the ideal application for a TempDir class (like
432 // TempFile but for directories)
437 Mutex::Locker locker(&mutex);
438 counter = convert<string>(count++);
440 // We are in our own directory. Why bother to mangle name?
441 // In fact I wrote this code to circumvent a problematic behaviour
442 // (bug?) of EMX mkstemp().
443 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
446 if (!tmpfl.createDirectory(0777)) {
447 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
448 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
449 from_utf8(tmpfl.absFileName())));
455 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
456 Buffer const * cloned_buffer)
457 : owner_(owner), filename(file), toc_backend(owner), checksum_(0),
458 wa_(nullptr), gui_(nullptr), undo_(*owner), inset(nullptr),
459 preview_loader_(nullptr), cloned_buffer_(cloned_buffer),
460 clone_list_(nullptr), parent_buffer(nullptr), file_format(LYX_FORMAT),
461 doing_export(false), require_fresh_start_(false), cite_labels_valid_(false),
462 have_bibitems_(false), lyx_clean(true), bak_clean(true), unnamed(false),
463 internal_buffer(false), read_only(readonly_), file_fully_loaded(false),
464 need_format_backup(false), ignore_parent(false), macro_lock(false),
465 externally_modified_(false), bibinfo_cache_valid_(false),
466 need_update(false), word_count_(0), char_count_(0), blank_count_(0)
468 refreshFileMonitor();
469 if (!cloned_buffer_) {
470 temppath = createBufferTmpDir();
471 lyxvc.setBuffer(owner_);
472 Language const * inplang = theApp() ?
473 languages.getFromCode(theApp()->inputLanguageCode())
476 params.language = inplang;
478 wa_ = new frontend::WorkAreaManager;
481 temppath = cloned_buffer_->d->temppath;
482 file_fully_loaded = true;
483 params = cloned_buffer_->d->params;
484 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
485 bibinfo_ = cloned_buffer_->d->bibinfo_;
486 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
487 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
488 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
489 have_bibitems_ = cloned_buffer_->d->have_bibitems_;
490 unnamed = cloned_buffer_->d->unnamed;
491 internal_buffer = cloned_buffer_->d->internal_buffer;
492 layout_position = cloned_buffer_->d->layout_position;
493 preview_file_ = cloned_buffer_->d->preview_file_;
494 preview_format_ = cloned_buffer_->d->preview_format_;
495 require_fresh_start_ = cloned_buffer_->d->require_fresh_start_;
499 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
500 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
502 LYXERR(Debug::INFO, "Buffer::Buffer()");
504 d->inset = new InsetText(*cloned_buffer->d->inset);
505 d->inset->setBuffer(*this);
506 // FIXME: optimize this loop somewhat, maybe by creating a new
507 // general recursive Inset::setId().
508 DocIterator it = doc_iterator_begin(this);
509 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
510 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
511 it.paragraph().setId(cloned_it.paragraph().id());
513 d->inset = new InsetText(this);
514 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
520 LYXERR(Debug::INFO, "Buffer::~Buffer()");
521 // here the buffer should take care that it is
522 // saved properly, before it goes into the void.
524 // GuiView already destroyed
528 // No need to do additional cleanups for internal buffer.
534 // this is in case of recursive includes: we won't try to delete
535 // ourselves as a child.
536 d->clone_list_->erase(this);
537 // loop over children
538 for (auto const & p : d->children_positions) {
539 Buffer * child = const_cast<Buffer *>(p.first);
540 if (d->clone_list_->erase(child))
543 // if we're the master buffer, then we should get rid of the list
546 // If this is not empty, we have leaked something. Worse, one of the
547 // children still has a reference to this list. But we will try to
548 // continue, rather than shut down.
549 LATTEST(d->clone_list_->empty());
550 // The clone list itself is empty, but it's still referenced in our list
551 // of clones. So let's find it and remove it.
552 CloneStore::iterator it =
553 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
554 if (it == cloned_buffers.end()) {
555 // We will leak in this case, but it is safe to continue.
558 cloned_buffers.erase(it);
560 // FIXME Do we really need to do this right before we delete d?
561 // clear references to children in macro tables
562 d->children_positions.clear();
563 d->position_to_children.clear();
565 // loop over children
566 for (auto const & p : d->children_positions) {
567 Buffer * child = const_cast<Buffer *>(p.first);
568 if (theBufferList().isLoaded(child)) {
569 if (theBufferList().isOthersChild(this, child))
570 child->setParent(nullptr);
572 theBufferList().release(child);
577 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
579 msg += emergencyWrite();
581 msg += " " + _("Save failed! Document is lost.");
583 Alert::warning(_("Attempting to close changed document!"), msg);
586 // FIXME Do we really need to do this right before we delete d?
587 // clear references to children in macro tables
588 d->children_positions.clear();
589 d->position_to_children.clear();
591 if (!d->temppath.destroyDirectory()) {
592 LYXERR0(bformat(_("Could not remove the temporary directory %1$s"),
593 from_utf8(d->temppath.absFileName())));
602 Buffer * Buffer::cloneWithChildren() const
605 cloned_buffers.emplace_back(new CloneList);
606 CloneList_ptr clones = cloned_buffers.back();
608 cloneWithChildren(bufmap, clones);
610 // make sure we got cloned
611 BufferMap::const_iterator bit = bufmap.find(this);
612 LASSERT(bit != bufmap.end(), return nullptr);
613 Buffer * cloned_buffer = bit->second;
615 return cloned_buffer;
619 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList_ptr clones) const
621 // have we already been cloned?
622 if (bufmap.find(this) != bufmap.end())
625 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
627 // The clone needs its own DocumentClass, since running updateBuffer() will
628 // modify it, and we would otherwise be sharing it with the original Buffer.
629 buffer_clone->params().makeDocumentClass(true);
630 cap::switchBetweenClasses(
631 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
632 static_cast<InsetText &>(buffer_clone->inset()));
634 bufmap[this] = buffer_clone;
635 clones->insert(buffer_clone);
636 buffer_clone->d->clone_list_ = clones;
637 buffer_clone->d->macro_lock = true;
638 buffer_clone->d->children_positions.clear();
640 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
641 // math macro caches need to be rethought and simplified.
642 // I am not sure wether we should handle Buffer cloning here or in BufferList.
643 // Right now BufferList knows nothing about buffer clones.
644 for (auto const & p : d->position_to_children) {
645 DocIterator dit = p.first.clone(buffer_clone);
646 dit.setBuffer(buffer_clone);
647 Buffer * child = const_cast<Buffer *>(p.second.buffer);
649 child->cloneWithChildren(bufmap, clones);
650 BufferMap::iterator const bit = bufmap.find(child);
651 LASSERT(bit != bufmap.end(), continue);
652 Buffer * child_clone = bit->second;
654 Inset * inset = dit.nextInset();
655 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
656 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
657 inset_inc->setChildBuffer(child_clone);
658 child_clone->d->setParent(buffer_clone);
659 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
660 buffer_clone->setChild(dit, child_clone);
662 buffer_clone->d->macro_lock = false;
666 Buffer * Buffer::cloneBufferOnly() const {
667 cloned_buffers.emplace_back(new CloneList);
668 CloneList_ptr clones = cloned_buffers.back();
669 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
671 // The clone needs its own DocumentClass, since running updateBuffer() will
672 // modify it, and we would otherwise be sharing it with the original Buffer.
673 buffer_clone->params().makeDocumentClass(true);
674 cap::switchBetweenClasses(
675 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
676 static_cast<InsetText &>(buffer_clone->inset()));
678 clones->insert(buffer_clone);
679 buffer_clone->d->clone_list_ = clones;
681 // we won't be cloning the children
682 buffer_clone->d->children_positions.clear();
687 bool Buffer::isClone() const
689 return d->cloned_buffer_;
693 void Buffer::changed(bool update_metrics) const
696 d->wa_->redrawAll(update_metrics);
700 frontend::WorkAreaManager & Buffer::workAreaManager() const
707 Text & Buffer::text() const
709 return d->inset->text();
713 Inset & Buffer::inset() const
719 BufferParams & Buffer::params()
725 BufferParams const & Buffer::params() const
731 BufferParams const & Buffer::masterParams() const
733 if (masterBuffer() == this)
736 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
737 // Copy child authors to the params. We need those pointers.
738 for (Author const & a : params().authors())
739 mparams.authors().record(a);
744 double Buffer::fontScalingFactor() const
746 return isExporting() ? 75.0 * params().html_math_img_scale
747 : 0.01 * lyxrc.dpi * lyxrc.currentZoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
751 ParagraphList & Buffer::paragraphs()
753 return text().paragraphs();
757 ParagraphList const & Buffer::paragraphs() const
759 return text().paragraphs();
763 LyXVC & Buffer::lyxvc()
769 LyXVC const & Buffer::lyxvc() const
775 string const Buffer::temppath() const
777 return d->temppath.absFileName();
781 TexRow & Buffer::texrow()
787 TexRow const & Buffer::texrow() const
793 TocBackend & Buffer::tocBackend() const
795 return d->toc_backend;
799 Undo & Buffer::undo()
805 void Buffer::setChild(DocIterator const & dit, Buffer * child)
807 d->children_positions[child] = dit;
811 string Buffer::latexName(bool const no_path) const
813 FileName latex_name =
814 makeLatexName(d->exportFileName());
815 return no_path ? latex_name.onlyFileName()
816 : latex_name.absFileName();
820 FileName Buffer::Impl::exportFileName() const
822 docstring const branch_suffix =
823 params.branchlist().getFileNameSuffix();
824 if (branch_suffix.empty())
827 string const name = addExtension(filename.onlyFileNameWithoutExt()
828 + to_utf8(branch_suffix), filename.extension());
829 FileName res(filename.onlyPath().absFileName() + "/" + name);
835 string Buffer::logName(LogType * type) const
837 string const filename = latexName(false);
839 if (filename.empty()) {
845 string const path = temppath();
847 FileName const fname(addName(temppath(),
848 onlyFileName(changeExtension(filename,
851 // FIXME: how do we know this is the name of the build log?
852 FileName const bname(
853 addName(path, onlyFileName(
854 changeExtension(filename,
855 theFormats().extension(params().bufferFormat()) + ".out"))));
857 // Also consider the master buffer log file
858 FileName masterfname = fname;
859 LogType mtype = latexlog;
860 if (masterBuffer() != this) {
861 string const mlogfile = masterBuffer()->logName(&mtype);
862 masterfname = FileName(mlogfile);
865 // If no Latex log or Build log is newer, show Build log
866 if (bname.exists() &&
867 ((!fname.exists() && !masterfname.exists())
868 || (fname.lastModified() < bname.lastModified()
869 && masterfname.lastModified() < bname.lastModified()))) {
870 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
873 return bname.absFileName();
874 // If we have a newer master file log or only a master log, show this
875 } else if (fname != masterfname
876 && (!fname.exists() && (masterfname.exists()
877 || fname.lastModified() < masterfname.lastModified()))) {
878 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
881 return masterfname.absFileName();
883 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
886 return fname.absFileName();
890 void Buffer::setReadonly(bool const flag)
892 if (d->read_only != flag) {
899 void Buffer::setFileName(FileName const & fname)
901 bool const changed = fname != d->filename;
903 d->refreshFileMonitor();
905 lyxvc().file_found_hook(fname);
906 setReadonly(d->filename.isReadOnly());
912 int Buffer::readHeader(Lexer & lex)
914 int unknown_tokens = 0;
916 int begin_header_line = -1;
918 // Initialize parameters that may be/go lacking in header:
919 params().branchlist().clear();
920 params().preamble.erase();
921 params().options.erase();
922 params().master.erase();
923 params().float_placement.erase();
924 params().float_alignment.erase();
925 params().paperwidth.erase();
926 params().paperheight.erase();
927 params().leftmargin.erase();
928 params().rightmargin.erase();
929 params().topmargin.erase();
930 params().bottommargin.erase();
931 params().headheight.erase();
932 params().headsep.erase();
933 params().footskip.erase();
934 params().columnsep.erase();
935 params().font_roman_opts.erase();
936 params().font_sans_opts.erase();
937 params().font_typewriter_opts.erase();
938 params().fonts_cjk.erase();
939 params().listings_params.clear();
940 params().clearLayoutModules();
941 params().clearRemovedModules();
942 params().clearIncludedChildren();
943 params().pdfoptions().clear();
944 params().indiceslist().clear();
945 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
946 params().isbackgroundcolor = false;
947 params().fontcolor = RGBColor(0, 0, 0);
948 params().isfontcolor = false;
949 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
950 params().isnotefontcolor = false;
951 params().boxbgcolor = RGBColor(0xFF, 0, 0);
952 params().isboxbgcolor = false;
953 params().html_latex_start.clear();
954 params().html_latex_end.clear();
955 params().html_math_img_scale = 1.0;
956 params().output_sync_macro.erase();
957 params().setLocalLayout(docstring(), false);
958 params().setLocalLayout(docstring(), true);
959 params().biblio_opts.erase();
960 params().biblatex_bibstyle.erase();
961 params().biblatex_citestyle.erase();
962 params().multibib.erase();
963 params().lineno_opts.clear();
964 params().spellignore().clear();
966 for (int i = 0; i < 4; ++i) {
967 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
968 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
971 ErrorList & errorList = d->errorLists["Parse"];
980 if (token == "\\end_header")
984 if (token == "\\begin_header") {
985 begin_header_line = line;
989 LYXERR(Debug::PARSER, "Handling document header token: `"
992 string const result =
993 params().readToken(lex, token, d->filename);
994 if (!result.empty()) {
995 if (token == "\\textclass") {
996 d->layout_position = result;
999 docstring const s = bformat(_("Unknown token: "
1002 lex.getDocString());
1003 errorList.push_back(ErrorItem(_("Document header error"), s));
1007 if (begin_header_line) {
1008 docstring const s = _("\\begin_header is missing");
1009 errorList.push_back(ErrorItem(_("Document header error"), s));
1012 params().shell_escape = theSession().shellescapeFiles().find(absFileName());
1014 params().makeDocumentClass(isClone(), isInternal());
1016 return unknown_tokens;
1021 // changed to be public and have one parameter
1022 // Returns true if "\end_document" is not read (Asger)
1023 bool Buffer::readDocument(Lexer & lex)
1025 ErrorList & errorList = d->errorLists["Parse"];
1028 // remove dummy empty par
1029 paragraphs().clear();
1031 if (!lex.checkFor("\\begin_document")) {
1032 docstring const s = _("\\begin_document is missing");
1033 errorList.push_back(ErrorItem(_("Document header error"), s));
1038 if (params().output_changes) {
1039 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1040 LaTeXFeatures::isAvailable("xcolor");
1043 Alert::warning(_("Changes not shown in LaTeX output"),
1044 _("Changes will not be highlighted in LaTeX output, "
1045 "because xcolor and ulem are not installed.\n"
1046 "Please install both packages or redefine "
1047 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1051 if (!parent() && !params().master.empty()) {
1052 FileName const master_file = makeAbsPath(params().master,
1053 onlyPath(absFileName()));
1054 if (isLyXFileName(master_file.absFileName())) {
1056 checkAndLoadLyXFile(master_file, true);
1058 // necessary e.g. after a reload
1059 // to re-register the child (bug 5873)
1060 // FIXME: clean up updateMacros (here, only
1061 // child registering is needed).
1062 master->updateMacros();
1063 // set master as master buffer, but only
1064 // if we are a real child
1065 if (master->isChild(this))
1067 // if the master is not fully loaded
1068 // it is probably just loading this
1069 // child. No warning needed then.
1070 else if (master->isFullyLoaded())
1071 LYXERR0("The master '"
1073 << "' assigned to this document ("
1075 << ") does not include "
1076 "this document. Ignoring the master assignment.");
1077 // If the master has just been created, un-hide it (#11162)
1078 if (!master->fileName().exists())
1079 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
1080 master->absFileName()));
1085 // assure we have a default index
1086 params().indiceslist().addDefault(B_("Index"));
1089 if (FileName::isAbsolute(params().origin))
1090 d->old_position = params().origin;
1092 d->old_position = filePath();
1097 bool const res = text().read(lex, errorList, d->inset);
1098 d->old_position.clear();
1100 // inform parent buffer about local macros
1102 Buffer const * pbuf = parent();
1103 for (auto const & m : usermacros)
1104 pbuf->usermacros.insert(m);
1108 updateMacroInstances(InternalUpdate);
1113 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1115 Format const * fmt = theFormats().getFormat(format);
1118 // It is important to use the correct extension here, since some
1119 // converters create a wrong output file otherwise (e.g. html2latex)
1120 FileName const name = tempFileName("Buffer_importStringXXXXXX." + fmt->extension());
1121 ofdocstream os(name.toFilesystemEncoding().c_str());
1122 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1123 bool const success = !(os << contents).fail();
1126 bool converted = false;
1128 params().compressed = false;
1130 // remove dummy empty par
1131 paragraphs().clear();
1133 converted = importFile(format, name, errorList);
1136 removeTempFile(name);
1141 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1143 if (!theConverters().isReachable(format, "lyx"))
1146 FileName const lyx = tempFileName("Buffer_importFileXXXXXX.lyx");
1147 Converters::RetVal const retval =
1148 theConverters().convert(nullptr, name, lyx, name, format, "lyx", errorList);
1149 if (retval == Converters::SUCCESS) {
1150 bool const success = readFile(lyx) == ReadSuccess;
1151 removeTempFile(lyx);
1159 bool Buffer::readString(string const & s)
1161 params().compressed = false;
1164 istringstream is(s);
1166 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1167 FileName const fn = tempfile.name();
1170 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1172 if (success && file_format != LYX_FORMAT) {
1173 // We need to call lyx2lyx, so write the input to a file
1174 ofstream os(fn.toFilesystemEncoding().c_str());
1177 // lyxvc in readFile
1178 if (readFile(fn) != ReadSuccess)
1182 if (readDocument(lex))
1188 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1191 if (!lex.setFile(fn)) {
1192 Alert::error(_("File Not Found"),
1193 bformat(_("Unable to open file `%1$s'."),
1194 from_utf8(fn.absFileName())));
1195 return ReadFileNotFound;
1199 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1200 if (ret_plf != ReadSuccess)
1203 if (file_format != LYX_FORMAT) {
1205 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1206 if (ret_clf != ReadSuccess)
1208 ret_clf = readFile(tmpFile);
1209 if (ret_clf == ReadSuccess) {
1210 d->file_format = file_format;
1211 d->need_format_backup = true;
1216 // FIXME: InsetInfo needs to know whether the file is under VCS
1217 // during the parse process, so this has to be done before.
1218 lyxvc().file_found_hook(d->filename);
1220 if (readDocument(lex)) {
1221 Alert::error(_("Document format failure"),
1222 bformat(_("%1$s ended unexpectedly, which means"
1223 " that it is probably corrupted."),
1224 from_utf8(fn.absFileName())));
1225 return ReadDocumentFailure;
1228 d->file_fully_loaded = true;
1229 d->read_only = !d->filename.isWritable();
1230 params().compressed = theFormats().isZippedFile(d->filename);
1236 bool Buffer::isFullyLoaded() const
1238 return d->file_fully_loaded;
1242 void Buffer::setFullyLoaded(bool value)
1244 d->file_fully_loaded = value;
1248 bool Buffer::freshStartRequired() const
1250 return d->require_fresh_start_;
1253 void Buffer::requireFreshStart(bool const b) const
1255 d->require_fresh_start_ = b;
1259 PreviewLoader * Buffer::loader() const
1261 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1263 if (!d->preview_loader_)
1264 d->preview_loader_ = new PreviewLoader(*this);
1265 return d->preview_loader_;
1269 void Buffer::removePreviews() const
1271 delete d->preview_loader_;
1272 d->preview_loader_ = nullptr;
1276 void Buffer::updatePreviews() const
1278 PreviewLoader * ploader = loader();
1282 InsetIterator it = begin(*d->inset);
1283 InsetIterator const itend = end(*d->inset);
1284 for (; it != itend; ++it)
1285 it->addPreview(it, *ploader);
1287 ploader->startLoading();
1291 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1292 FileName const & fn, int & file_format) const
1294 if(!lex.checkFor("\\lyxformat")) {
1295 Alert::error(_("Document format failure"),
1296 bformat(_("%1$s is not a readable LyX document."),
1297 from_utf8(fn.absFileName())));
1298 return ReadNoLyXFormat;
1304 // LyX formats 217 and earlier were written as 2.17. This corresponds
1305 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1306 // these cases. See also: www.lyx.org/trac/changeset/1313.
1307 size_t dot = tmp_format.find_first_of(".,");
1308 if (dot != string::npos)
1309 tmp_format.erase(dot, 1);
1311 file_format = convert<int>(tmp_format);
1316 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1317 FileName & tmpfile, int from_format)
1319 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1320 tempfile.setAutoRemove(false);
1321 tmpfile = tempfile.name();
1322 if(tmpfile.empty()) {
1323 Alert::error(_("Conversion failed"),
1324 bformat(_("%1$s is from a different"
1325 " version of LyX, but a temporary"
1326 " file for converting it could"
1327 " not be created."),
1328 from_utf8(fn.absFileName())));
1329 return LyX2LyXNoTempFile;
1332 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1333 if (lyx2lyx.empty()) {
1334 Alert::error(_("Conversion script not found"),
1335 bformat(_("%1$s is from a different"
1336 " version of LyX, but the"
1337 " conversion script lyx2lyx"
1338 " could not be found."),
1339 from_utf8(fn.absFileName())));
1340 return LyX2LyXNotFound;
1344 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1345 ostringstream command;
1346 command << os::python()
1347 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1348 << " -t " << convert<string>(LYX_FORMAT)
1349 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1350 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1351 string const command_str = command.str();
1353 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1355 cmd_ret const ret = runCommand(command_str);
1357 if (from_format < LYX_FORMAT) {
1358 Alert::error(_("Conversion script failed"),
1359 bformat(_("%1$s is from an older version"
1360 " of LyX and the lyx2lyx script"
1361 " failed to convert it."),
1362 from_utf8(fn.absFileName())));
1363 return LyX2LyXOlderFormat;
1365 Alert::error(_("Conversion script failed"),
1366 bformat(_("%1$s is from a newer version"
1367 " of LyX and the lyx2lyx script"
1368 " failed to convert it."),
1369 from_utf8(fn.absFileName())));
1370 return LyX2LyXNewerFormat;
1377 FileName Buffer::getBackupName() const {
1378 map<int, string> const file_formats = {
1395 FileName const & fn = fileName();
1396 string const fname = fn.onlyFileNameWithoutExt();
1397 string const fext = fn.extension() + "~";
1398 string const fpath = lyxrc.backupdir_path.empty() ?
1399 fn.onlyPath().absFileName() :
1400 lyxrc.backupdir_path;
1401 string backup_suffix;
1402 // If file format is from a stable series use version instead of file format
1403 auto const it = file_formats.find(d->file_format);
1404 if (it != file_formats.end())
1405 backup_suffix = "-lyx" + it->second;
1407 backup_suffix = "-lyxformat-" + convert<string>(d->file_format);
1408 string const backname = fname + backup_suffix;
1409 FileName backup(addName(fpath, addExtension(backname, fext)));
1411 // limit recursion, just in case
1413 unsigned long orig_checksum = 0;
1414 while (backup.exists() && v < 100) {
1415 if (orig_checksum == 0)
1416 orig_checksum = fn.checksum();
1417 unsigned long new_checksum = backup.checksum();
1418 if (orig_checksum == new_checksum) {
1419 LYXERR(Debug::FILES, "Not backing up " << fn <<
1420 "since " << backup << "has the same checksum.");
1421 // a bit of a hack, but we have to check this anyway
1422 // below, and setting this is simpler than introducing
1423 // a special boolean for this purpose.
1427 string const newbackname = backname + "-" + convert<string>(v);
1428 backup.set(addName(fpath, addExtension(newbackname, fext)));
1431 return v < 100 ? backup : FileName();
1435 // Should probably be moved to somewhere else: BufferView? GuiView?
1436 bool Buffer::save() const
1438 docstring const file = makeDisplayPath(absFileName(), 20);
1439 d->filename.refresh();
1441 // check the read-only status before moving the file as a backup
1442 if (d->filename.exists()) {
1443 bool const read_only = !d->filename.isWritable();
1445 Alert::warning(_("File is read-only"),
1446 bformat(_("The file %1$s cannot be written because it "
1447 "is marked as read-only."), file));
1452 // ask if the disk file has been externally modified (use checksum method)
1453 if (fileName().exists() && isChecksumModified()) {
1455 bformat(_("Document %1$s has been externally modified. "
1456 "Are you sure you want to overwrite this file?"), file);
1457 int const ret = Alert::prompt(_("Overwrite modified file?"),
1458 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1463 // We don't need autosaves in the immediate future. (Asger)
1464 resetAutosaveTimers();
1466 // if the file does not yet exist, none of the backup activity
1467 // that follows is necessary
1468 if (!fileName().exists()) {
1469 if (!writeFile(fileName()))
1475 // we first write the file to a new name, then move it to its
1476 // proper location once that has been done successfully. that
1477 // way we preserve the original file if something goes wrong.
1478 string const justname = fileName().onlyFileNameWithoutExt();
1479 auto tempfile = lyx::make_unique<TempFile>(fileName().onlyPath(),
1480 justname + "-XXXXXX.lyx");
1481 bool const symlink = fileName().isSymLink();
1483 tempfile->setAutoRemove(false);
1485 FileName savefile(tempfile->name());
1486 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1487 if (!savefile.clonePermissions(fileName()))
1488 LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
1490 if (!writeFile(savefile))
1493 // we will set this to false if we fail
1494 bool made_backup = true;
1496 FileName backupName;
1497 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1499 if (d->need_format_backup)
1500 backupName = getBackupName();
1502 // If we for some reason failed to find a backup name in case of
1503 // a format change, this will still set one. It's the best we can
1505 if (backupName.empty()) {
1506 backupName.set(fileName().absFileName() + "~");
1507 if (!lyxrc.backupdir_path.empty()) {
1508 string const mangledName =
1509 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1510 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1514 LYXERR(Debug::FILES, "Backing up original file to " <<
1515 backupName.absFileName());
1516 // Except file is symlink do not copy because of #6587.
1517 // Hard links have bad luck.
1518 made_backup = symlink ?
1519 fileName().copyTo(backupName):
1520 fileName().moveTo(backupName);
1523 Alert::error(_("Backup failure"),
1524 bformat(_("Cannot create backup file %1$s.\n"
1525 "Please check whether the directory exists and is writable."),
1526 from_utf8(backupName.absFileName())));
1527 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1528 } else if (d->need_format_backup) {
1529 // the original file has been backed up successfully, so we
1530 // will not need to do that again
1531 d->need_format_backup = false;
1535 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1536 // Only do this if tempfile is not in autoremove mode
1539 // If we have no symlink, we can simply rename the temp file.
1540 // Otherwise, we need to copy it so the symlink stays intact.
1541 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1542 savefile.moveTo(fileName()))
1544 // saveCheckSum() was already called by writeFile(), but the
1545 // time stamp is invalidated by copying/moving
1548 // the file associated with this buffer is now in the current format
1549 d->file_format = LYX_FORMAT;
1552 // else we saved the file, but failed to move it to the right location.
1554 if (needBackup && made_backup && !symlink) {
1555 // the original file was moved to some new location, so it will look
1556 // to the user as if it was deleted. (see bug #9234.) we could try
1557 // to restore it, but that would basically mean trying to do again
1558 // what we just failed to do. better to leave things as they are.
1559 Alert::error(_("Write failure"),
1560 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1561 "But LyX could not move it to:\n %2$s.\n"
1562 "Your original file has been backed up to:\n %3$s"),
1563 from_utf8(savefile.absFileName()),
1564 from_utf8(fileName().absFileName()),
1565 from_utf8(backupName.absFileName())));
1567 // either we did not try to make a backup, or else we tried and failed,
1568 // or else the original file was a symlink, in which case it was copied,
1569 // not moved. so the original file is intact.
1570 Alert::error(_("Write failure"),
1571 bformat(_("Cannot move saved file to:\n %1$s.\n"
1572 "But the file has successfully been saved as:\n %2$s."),
1573 from_utf8(fileName().absFileName()),
1574 from_utf8(savefile.absFileName())));
1580 bool Buffer::writeFile(FileName const & fname) const
1582 if (d->read_only && fname == d->filename)
1585 bool retval = false;
1587 docstring const str = bformat(_("Saving document %1$s..."),
1588 makeDisplayPath(fname.absFileName()));
1591 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1593 if (params().compressed) {
1594 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1595 retval = ofs && write(ofs);
1597 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1598 retval = ofs && write(ofs);
1602 message(str + _(" could not write file!"));
1607 // removeAutosaveFile();
1610 message(str + _(" done."));
1616 docstring Buffer::emergencyWrite() const
1618 // No need to save if the buffer has not changed.
1622 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1624 docstring user_message = bformat(
1625 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1627 // We try to save three places:
1628 // 1) Same place as document. Unless it is an unnamed doc.
1630 string s = absFileName();
1633 if (writeFile(FileName(s))) {
1635 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1636 return user_message;
1638 user_message += " " + _("Save failed! Trying again...\n");
1642 // 2) In HOME directory.
1643 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1645 lyxerr << ' ' << s << endl;
1646 if (writeFile(FileName(s))) {
1648 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1649 return user_message;
1652 user_message += " " + _("Save failed! Trying yet again...\n");
1654 // 3) In "/tmp" directory.
1655 // MakeAbsPath to prepend the current
1656 // drive letter on OS/2
1657 s = addName(package().temp_dir().absFileName(), absFileName());
1659 lyxerr << ' ' << s << endl;
1660 if (writeFile(FileName(s))) {
1662 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1663 return user_message;
1666 user_message += " " + _("Save failed! Document is lost.");
1669 return user_message;
1673 bool Buffer::write(ostream & ofs) const
1676 // Use the standard "C" locale for file output.
1677 ofs.imbue(locale::classic());
1680 // The top of the file should not be written by params().
1682 // write out a comment in the top of the file
1683 // Important: Keep the version formatting in sync with lyx2lyx and
1684 // tex2lyx (bug 7951)
1685 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1686 << " created this file. For more info see https://www.lyx.org/\n"
1687 << "\\lyxformat " << LYX_FORMAT << "\n"
1688 << "\\begin_document\n";
1690 /// For each author, set 'used' to true if there is a change
1691 /// by this author in the document; otherwise set it to 'false'.
1692 for (Author const & a : params().authors())
1695 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1696 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1697 for ( ; it != end; ++it)
1698 it->checkAuthors(params().authors());
1700 // now write out the buffer parameters.
1701 ofs << "\\begin_header\n";
1702 params().writeFile(ofs, this);
1703 ofs << "\\end_header\n";
1706 ofs << "\n\\begin_body\n";
1708 ofs << "\n\\end_body\n";
1710 // Write marker that shows file is complete
1711 ofs << "\\end_document" << endl;
1713 // Shouldn't really be needed....
1716 // how to check if close went ok?
1717 // Following is an attempt... (BE 20001011)
1719 // good() returns false if any error occurred, including some
1720 // formatting error.
1721 // bad() returns true if something bad happened in the buffer,
1722 // which should include file system full errors.
1727 lyxerr << "File was not closed properly." << endl;
1734 Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
1735 string const & original_path,
1736 OutputParams const & runparams_in,
1737 OutputWhat output) const
1739 OutputParams runparams = runparams_in;
1741 string const encoding = runparams.encoding->iconvName();
1742 LYXERR(Debug::OUTFILE, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1745 try { ofs.reset(encoding); }
1746 catch (iconv_codecvt_facet_exception const & e) {
1747 lyxerr << "Caught iconv exception: " << e.what() << endl;
1748 Alert::error(_("Iconv software exception Detected"),
1749 bformat(_("Please verify that the `iconv' support software is"
1750 " properly installed and supports the selected encoding"
1751 " (%1$s), or change the encoding in"
1752 " Document>Settings>Language."), from_ascii(encoding)));
1755 if (!openFileWrite(ofs, fname))
1758 ErrorList & errorList = d->errorLists["Export"];
1760 ExportStatus status = ExportSuccess;
1763 // make sure we are ready to export
1764 // this needs to be done before we validate
1765 // FIXME Do we need to do this all the time? I.e., in children
1766 // of a master we are exporting?
1768 updateMacroInstances(OutputUpdate);
1770 ExportStatus retval;
1772 retval = writeLaTeXSource(os, original_path, runparams, output);
1773 if (retval == ExportKilled)
1774 return ExportKilled;
1776 catch (EncodingException const & e) {
1777 docstring const failed(1, e.failed_char);
1779 oss << "0x" << hex << static_cast<uint32_t>(e.failed_char) << dec;
1780 if (getParFromID(e.par_id).paragraph().layout().pass_thru) {
1781 docstring msg = bformat(_("Uncodable character '%1$s'"
1782 " (code point %2$s)"),
1783 failed, from_utf8(oss.str()));
1784 errorList.push_back(ErrorItem(msg, _("Some characters of your document are not "
1785 "representable in specific verbatim contexts.\n"
1786 "Changing the document encoding to utf8 could help."),
1787 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1789 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1790 " (code point %2$s)"),
1791 failed, from_utf8(oss.str()));
1792 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1793 "representable in the chosen encoding.\n"
1794 "Changing the document encoding to utf8 could help."),
1795 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1797 status = ExportError;
1799 catch (iconv_codecvt_facet_exception const & e) {
1800 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1802 status = ExportError;
1804 catch (exception const & e) {
1805 errorList.push_back(ErrorItem(_("conversion failed"),
1807 lyxerr << e.what() << endl;
1808 status = ExportError;
1811 lyxerr << "Caught some really weird exception..." << endl;
1815 d->texrow = move(os.texrow());
1819 status = ExportError;
1820 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1823 if (runparams_in.silent)
1831 Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
1832 string const & original_path,
1833 OutputParams const & runparams_in,
1834 OutputWhat output) const
1836 // The child documents, if any, shall be already loaded at this point.
1838 OutputParams runparams = runparams_in;
1840 // Some macros rely on font encoding
1841 runparams.main_fontenc = params().main_font_encoding();
1843 // If we are compiling a file standalone, even if this is the
1844 // child of some other buffer, let's cut the link here, so the
1845 // file is really independent and no concurring settings from
1846 // the master (e.g. branch state) interfere (see #8100).
1847 if (!runparams.is_child)
1848 d->ignore_parent = true;
1850 // Classify the unicode characters appearing in math insets
1851 BufferEncodings::initUnicodeMath(*this);
1853 // validate the buffer.
1854 LYXERR(Debug::OUTFILE, " Validating buffer...");
1855 LaTeXFeatures features(*this, params(), runparams);
1857 // This is only set once per document (in master)
1858 if (!runparams.is_child) {
1859 runparams.use_polyglossia = features.usePolyglossia();
1860 runparams.use_hyperref = features.isRequired("hyperref");
1861 runparams.use_CJK = features.mustProvide("CJK");
1863 LYXERR(Debug::OUTFILE, " Buffer validation done.");
1865 bool const output_preamble =
1866 output == FullSource || output == OnlyPreamble;
1867 bool const output_body =
1868 output == FullSource || output == OnlyBody;
1870 // The starting paragraph of the coming rows is the
1871 // first paragraph of the document. (Asger)
1872 if (output_preamble && runparams.nice) {
1873 os << "%% LyX " << lyx_version << " created this file. "
1874 "For more info, see https://www.lyx.org/.\n"
1875 "%% Do not edit unless you really know what "
1878 LYXERR(Debug::INFO, "lyx document header finished");
1880 // There are a few differences between nice LaTeX and usual files:
1881 // usual files have \batchmode and special input@path to allow
1882 // inclusion of figures specified by an explicitly relative path
1883 // (i.e., a path starting with './' or '../') with either \input or
1884 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1885 // input@path is set when the actual parameter original_path is set.
1886 // This is done for usual tex-file, but not for nice-latex-file.
1887 // (Matthias 250696)
1888 // Note that input@path is only needed for something the user does
1889 // in the preamble, included .tex files or ERT, files included by
1890 // LyX work without it.
1891 if (output_preamble) {
1892 if (!runparams.nice) {
1893 // code for usual, NOT nice-latex-file
1894 os << "\\batchmode\n"; // changed from \nonstopmode
1896 if (!original_path.empty()) {
1898 // We don't know the encoding of inputpath
1899 docstring const inputpath = from_utf8(original_path);
1900 docstring uncodable_glyphs;
1901 Encoding const * const enc = runparams.encoding;
1903 for (char_type n : inputpath) {
1904 if (!enc->encodable(n)) {
1905 docstring const glyph(1, n);
1906 LYXERR0("Uncodable character '"
1908 << "' in input path!");
1909 uncodable_glyphs += glyph;
1914 // warn user if we found uncodable glyphs.
1915 if (!uncodable_glyphs.empty()) {
1916 frontend::Alert::warning(
1917 _("Uncodable character in file path"),
1919 _("The path of your document\n"
1921 "contains glyphs that are unknown "
1922 "in the current document encoding "
1923 "(namely %2$s). This may result in "
1924 "incomplete output, unless "
1925 "TEXINPUTS contains the document "
1926 "directory and you don't use "
1927 "explicitly relative paths (i.e., "
1928 "paths starting with './' or "
1929 "'../') in the preamble or in ERT."
1930 "\n\nIn case of problems, choose "
1931 "an appropriate document encoding\n"
1932 "(such as utf8) or change the "
1934 inputpath, uncodable_glyphs));
1936 string docdir = os::latex_path(original_path);
1937 if (contains(docdir, '#')) {
1938 docdir = subst(docdir, "#", "\\#");
1939 os << "\\catcode`\\#=11"
1940 "\\def\\#{#}\\catcode`\\#=6\n";
1942 if (contains(docdir, '%')) {
1943 docdir = subst(docdir, "%", "\\%");
1944 os << "\\catcode`\\%=11"
1945 "\\def\\%{%}\\catcode`\\%=14\n";
1947 if (contains(docdir, '~'))
1948 docdir = subst(docdir, "~", "\\string~");
1949 bool const nonascii = !isAscii(from_utf8(docdir));
1950 // LaTeX 2019/10/01 handles non-ascii path without detokenize
1951 bool const utfpathlatex = features.isAvailable("LaTeX-2019/10/01");
1952 bool const detokenize = !utfpathlatex && nonascii;
1953 bool const quote = contains(docdir, ' ');
1954 if (utfpathlatex && nonascii)
1955 os << "\\UseRawInputEncoding\n";
1956 os << "\\makeatletter\n"
1957 << "\\def\\input@path{{";
1959 os << "\\detokenize{";
1968 << "\\makeatother\n";
1972 // get parent macros (if this buffer has a parent) which will be
1973 // written at the document begin further down.
1974 MacroSet parentMacros;
1975 listParentMacros(parentMacros, features);
1977 // Write the preamble
1978 runparams.use_babel = params().writeLaTeX(os, features,
1979 d->filename.onlyPath());
1981 // Active characters
1982 runparams.active_chars = features.getActiveChars();
1984 // Biblatex bibliographies are loaded here
1985 if (params().useBiblatex()) {
1986 vector<pair<docstring, string>> const bibfiles =
1987 prepareBibFilePaths(runparams, getBibfiles(), true);
1988 for (pair<docstring, string> const & file: bibfiles) {
1989 os << "\\addbibresource";
1990 if (!file.second.empty())
1991 os << "[bibencoding=" << file.second << "]";
1992 os << "{" << file.first << "}\n";
1996 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1997 && !features.hasOnlyPolyglossiaLanguages()) {
2000 vector<string> bll = features.getBabelExclusiveLanguages();
2001 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
2004 for (string const & sit : bll) {
2009 blangs = bll.size() > 1 ?
2010 bformat(_("The languages %1$s are only supported by Babel."), langs)
2011 : bformat(_("The language %1$s is only supported by Babel."), langs);
2015 for (string const & pit : pll) {
2020 plangs = pll.size() > 1 ?
2021 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
2022 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
2023 if (!blangs.empty())
2027 frontend::Alert::warning(
2028 _("Incompatible Languages!"),
2030 _("You cannot use the following languages "
2031 "together in one LaTeX document because "
2032 "they require conflicting language packages:\n"
2037 // Japanese might be required only in some children of a document,
2038 // but once required, we must keep use_japanese true.
2039 runparams.use_japanese |= features.isRequired("japanese");
2042 // Restore the parenthood if needed
2043 if (!runparams.is_child)
2044 d->ignore_parent = false;
2045 return ExportSuccess;
2049 // mark the beginning of the body to separate it from InPreamble insets
2050 os.texrow().start(TexRow::beginDocument());
2051 os << "\\begin{document}\n";
2053 // mark the start of a new paragraph by simulating a newline,
2054 // so that os.afterParbreak() returns true at document start
2057 // output the parent macros
2058 for (auto const & mac : parentMacros) {
2059 int num_lines = mac->write(os.os(), true);
2060 os.texrow().newlines(num_lines);
2063 } // output_preamble
2065 LYXERR(Debug::INFO, "preamble finished, now the body.");
2069 latexParagraphs(*this, text(), os, runparams);
2071 catch (ConversionException const &) { return ExportKilled; }
2073 // Restore the parenthood if needed
2074 if (!runparams.is_child)
2075 d->ignore_parent = false;
2077 // add this just in case after all the paragraphs
2080 if (output_preamble) {
2081 os << "\\end{document}\n";
2082 LYXERR(Debug::OUTFILE, "makeLaTeXFile...done");
2084 LYXERR(Debug::OUTFILE, "LaTeXFile for inclusion made.");
2086 runparams_in.encoding = runparams.encoding;
2088 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2089 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2090 return ExportSuccess;
2094 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2095 OutputParams const & runparams,
2096 OutputWhat output) const
2098 LYXERR(Debug::OUTFILE, "makeDocBookFile...");
2101 if (!openFileWrite(ofs, fname))
2104 // make sure we are ready to export
2105 // this needs to be done before we validate
2107 updateMacroInstances(OutputUpdate);
2109 ExportStatus const retval = writeDocBookSource(ofs, runparams, output);
2110 if (retval == ExportKilled)
2111 return ExportKilled;
2115 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2116 return ExportSuccess;
2120 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os,
2121 OutputParams const & runparams,
2122 OutputWhat output) const
2124 LaTeXFeatures features(*this, params(), runparams);
2126 d->bibinfo_.makeCitationLabels(*this);
2130 DocumentClass const & tclass = params().documentClass();
2132 bool const output_preamble =
2133 output == FullSource || output == OnlyPreamble;
2134 bool const output_body =
2135 output == FullSource || output == OnlyBody || output == IncludedFile;
2137 if (output_preamble) {
2138 // XML preamble, no doctype needed.
2139 // Not using XMLStream for this, as the root tag would be in the tag stack and make troubles with the error
2140 // detection mechanisms (these are called before the end tag is output, and thus interact with the canary
2141 // parsep in output_docbook.cpp).
2142 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2143 << "<!-- This DocBook file was created by LyX " << lyx_version
2144 << "\n See https://www.lyx.org/ for more information -->\n";
2146 // Prepare the name space declaration for MathML depending on document preferences.
2147 string mathmlNamespace;
2148 if (params().docbook_mathml_prefix != BufferParams::NoPrefix) {
2149 string mathmlPrefix;
2150 if (params().docbook_mathml_prefix == BufferParams::MPrefix)
2152 else if (params().docbook_mathml_prefix == BufferParams::MMLPrefix)
2153 mathmlPrefix = "mml";
2154 mathmlNamespace = + " xmlns:" + mathmlPrefix + "=\"http://www.w3.org/1998/Math/MathML\"";
2157 // Directly output the root tag, based on the current type of document.
2158 string languageCode = params().language->code();
2159 string params = "xml:lang=\"" + languageCode + '"'
2160 + " xmlns=\"http://docbook.org/ns/docbook\""
2161 + " xmlns:xlink=\"http://www.w3.org/1999/xlink\""
2163 + " xmlns:xi=\"http://www.w3.org/2001/XInclude\""
2164 + " version=\"5.2\"";
2166 os << "<" << from_ascii(tclass.docbookroot()) << " " << from_ascii(params) << ">\n";
2170 // Start to output the document.
2172 docbookParagraphs(text(), *this, xs, runparams);
2175 if (output_preamble) {
2176 // Close the root element. No need for a line break, as free text is never allowed
2177 // in a root element, it must always be wrapped in some container.
2178 os << "</" << from_ascii(tclass.docbookroot()) << ">";
2181 return ExportSuccess;
2185 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2186 OutputParams const & runparams) const
2188 LYXERR(Debug::OUTFILE, "makeLyXHTMLFile...");
2191 if (!openFileWrite(ofs, fname))
2194 // make sure we are ready to export
2195 // this has to be done before we validate
2196 updateBuffer(UpdateMaster, OutputUpdate);
2197 updateMacroInstances(OutputUpdate);
2199 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2200 if (retval == ExportKilled)
2205 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2210 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2211 OutputParams const & runparams,
2212 OutputWhat output) const
2214 LaTeXFeatures features(*this, params(), runparams);
2216 d->bibinfo_.makeCitationLabels(*this);
2218 bool const output_preamble =
2219 output == FullSource || output == OnlyPreamble;
2220 bool const output_body =
2221 output == FullSource || output == OnlyBody || output == IncludedFile;
2223 if (output_preamble) {
2224 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2225 << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN\" \"http://www.w3.org/Math/DTD/mathml2/xhtml-math11-f.dtd\">\n"
2226 // FIXME Language should be set properly.
2227 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2229 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2230 // FIXME Presumably need to set this right
2231 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2233 docstring const & doctitle = features.htmlTitle();
2235 << (doctitle.empty() ?
2236 from_ascii("LyX Document") :
2237 xml::escapeString(doctitle, XMLStream::ESCAPE_ALL))
2240 docstring styles = features.getTClassHTMLPreamble();
2241 if (!styles.empty())
2242 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2244 // we will collect CSS information in a stream, and then output it
2245 // either here, as part of the header, or else in a separate file.
2246 odocstringstream css;
2247 styles = features.getCSSSnippets();
2248 if (!styles.empty())
2249 css << "/* LyX Provided Styles */\n" << styles << '\n';
2251 styles = features.getTClassHTMLStyles();
2252 if (!styles.empty())
2253 css << "/* Layout-provided Styles */\n" << styles << '\n';
2255 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2256 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2257 if (needfg || needbg) {
2258 css << "\nbody {\n";
2261 << from_ascii(X11hexname(params().fontcolor))
2264 css << " background-color: "
2265 << from_ascii(X11hexname(params().backgroundcolor))
2270 docstring const dstyles = css.str();
2271 if (!dstyles.empty()) {
2272 bool written = false;
2273 if (params().html_css_as_file) {
2274 // open a file for CSS info
2276 string const fcssname = addName(temppath(), "docstyle.css");
2277 FileName const fcssfile = FileName(fcssname);
2278 if (openFileWrite(ocss, fcssfile)) {
2282 // write link to header
2283 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2285 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2288 // we are here if the CSS is supposed to be written to the header
2289 // or if we failed to write it to an external file.
2291 os << "<style type='text/css'>\n"
2300 bool const output_body_tag = (output != IncludedFile);
2301 if (output_body_tag)
2302 os << "<body dir=\"auto\">\n";
2304 if (output != IncludedFile)
2305 // if we're an included file, the counters are in the master.
2306 params().documentClass().counters().reset();
2308 xhtmlParagraphs(text(), *this, xs, runparams);
2310 catch (ConversionException const &) { return ExportKilled; }
2311 if (output_body_tag)
2315 if (output_preamble)
2318 return ExportSuccess;
2322 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2323 // Other flags: -wall -v0 -x
2324 int Buffer::runChktex()
2328 // get LaTeX-Filename
2329 FileName const path(temppath());
2330 string const name = addName(path.absFileName(), latexName());
2331 string const org_path = filePath();
2333 PathChanger p(path); // path to LaTeX file
2334 message(_("Running chktex..."));
2336 // Generate the LaTeX file if neccessary
2337 OutputParams runparams(¶ms().encoding());
2338 runparams.flavor = Flavor::LaTeX;
2339 runparams.nice = false;
2340 runparams.linelen = lyxrc.plaintext_linelen;
2341 ExportStatus const retval =
2342 makeLaTeXFile(FileName(name), org_path, runparams);
2343 if (retval != ExportSuccess) {
2344 // error code on failure
2349 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2350 int const res = chktex.run(terr); // run chktex
2353 Alert::error(_("chktex failure"),
2354 _("Could not run chktex successfully."));
2356 ErrorList & errlist = d->errorLists["ChkTeX"];
2358 bufferErrors(terr, errlist);
2363 if (runparams.silent)
2364 d->errorLists["ChkTeX"].clear();
2372 void Buffer::validate(LaTeXFeatures & features) const
2374 // Validate the buffer params, but not for included
2375 // files, since they also use the parent buffer's
2377 if (!features.runparams().is_child)
2378 params().validate(features);
2383 for (Paragraph const & p : paragraphs())
2384 p.validate(features);
2386 if (lyxerr.debugging(Debug::OUTFILE)) {
2387 features.showStruct();
2392 void Buffer::getLabelList(vector<std::pair<docstring, docstring>> & list) const
2394 // If this is a child document, use the master's list instead.
2396 masterBuffer()->getLabelList(list);
2401 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2402 for (auto const & tocit : *toc) {
2403 if (tocit.depth() == 0)
2404 list.push_back(make_pair(tocit.str(), tocit.asString()));
2409 void Buffer::invalidateBibinfoCache() const
2411 d->bibinfo_cache_valid_ = false;
2412 d->cite_labels_valid_ = false;
2413 removeBiblioTempFiles();
2414 // also invalidate the cache for the parent buffer
2415 Buffer const * const pbuf = d->parent();
2417 pbuf->invalidateBibinfoCache();
2421 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2423 // FIXME This is probably unnecessary, given where we call this.
2424 // If this is a child document, use the master instead.
2425 Buffer const * const pbuf = masterBuffer();
2426 if (pbuf != this && scope != UpdateChildOnly)
2427 return pbuf->getBibfiles();
2429 // In 2.3.x, we have:
2430 //if (!d->bibfile_cache_valid_)
2431 // this->updateBibfilesCache(scope);
2432 // I think that is a leftover, but there have been so many back-
2433 // and-forths with this, due to Windows issues, that I am not sure.
2435 return d->bibfiles_cache_;
2439 BiblioInfo const & Buffer::masterBibInfo() const
2441 Buffer const * const tmp = masterBuffer();
2443 return tmp->masterBibInfo();
2448 BiblioInfo const & Buffer::bibInfo() const
2454 void Buffer::registerBibfiles(const docstring_list & bf) const
2456 // We register the bib files in the master buffer,
2457 // if there is one, but also in every single buffer,
2458 // in case a child is compiled alone.
2459 Buffer const * const tmp = masterBuffer();
2461 tmp->registerBibfiles(bf);
2463 for (auto const & p : bf) {
2464 docstring_list::const_iterator temp =
2465 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2466 if (temp == d->bibfiles_cache_.end())
2467 d->bibfiles_cache_.push_back(p);
2472 static map<docstring, FileName> bibfileCache;
2474 FileName Buffer::getBibfilePath(docstring const & bibid) const
2476 map<docstring, FileName>::const_iterator it =
2477 bibfileCache.find(bibid);
2478 if (it != bibfileCache.end()) {
2479 // i.e., return bibfileCache[bibid];
2483 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2484 string const texfile = changeExtension(to_utf8(bibid), "bib");
2485 // we need to check first if this file exists where it's said to be.
2486 // there's a weird bug that occurs otherwise: if the file is in the
2487 // Buffer's directory but has the same name as some file that would be
2488 // found by kpsewhich, then we find the latter, not the former.
2489 FileName const local_file = makeAbsPath(texfile, filePath());
2490 FileName file = local_file;
2491 if (!file.exists()) {
2492 // there's no need now to check whether the file can be found
2494 file = findtexfile(texfile, "bib", true);
2498 LYXERR(Debug::FILES, "Found at: " << file);
2500 bibfileCache[bibid] = file;
2501 return bibfileCache[bibid];
2505 void Buffer::checkIfBibInfoCacheIsValid() const
2507 // use the master's cache
2508 Buffer const * const tmp = masterBuffer();
2510 tmp->checkIfBibInfoCacheIsValid();
2514 // If we already know the cache is invalid, stop here.
2515 // This is important in the case when the bibliography
2516 // environment (rather than Bib[la]TeX) is used.
2517 // In that case, the timestamp check below gives no
2518 // sensible result. Rather than that, the cache will
2519 // be invalidated explicitly via invalidateBibInfoCache()
2520 // by the Bibitem inset.
2521 // Same applies for bib encoding changes, which trigger
2522 // invalidateBibInfoCache() by InsetBibtex.
2523 if (!d->bibinfo_cache_valid_)
2526 if (d->have_bibitems_) {
2527 // We have a bibliography environment.
2528 // Invalidate the bibinfo cache unconditionally.
2529 // Cite labels will get invalidated by the inset if needed.
2530 d->bibinfo_cache_valid_ = false;
2534 // OK. This is with Bib(la)tex. We'll assume the cache
2535 // is valid and change this if we find changes in the bibs.
2536 d->bibinfo_cache_valid_ = true;
2537 d->cite_labels_valid_ = true;
2539 // compare the cached timestamps with the actual ones.
2540 docstring_list const & bibfiles_cache = getBibfiles();
2541 for (auto const & bf : bibfiles_cache) {
2542 FileName const fn = getBibfilePath(bf);
2543 time_t lastw = fn.lastModified();
2544 time_t prevw = d->bibfile_status_[fn];
2545 if (lastw != prevw) {
2546 d->bibinfo_cache_valid_ = false;
2547 d->cite_labels_valid_ = false;
2548 d->bibfile_status_[fn] = lastw;
2554 void Buffer::clearBibFileCache() const
2556 bibfileCache.clear();
2560 void Buffer::reloadBibInfoCache(bool const force) const
2562 // we should not need to do this for internal buffers
2566 // use the master's cache
2567 Buffer const * const tmp = masterBuffer();
2569 tmp->reloadBibInfoCache(force);
2574 checkIfBibInfoCacheIsValid();
2575 if (d->bibinfo_cache_valid_)
2579 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2580 // re-read file locations when this info changes
2581 // FIXME Is this sufficient? Or should we also force that
2582 // in some other cases? If so, then it is easy enough to
2583 // add the following line in some other places.
2584 clearBibFileCache();
2585 d->bibinfo_.clear();
2586 FileNameList checkedFiles;
2587 d->have_bibitems_ = false;
2588 collectBibKeys(checkedFiles);
2589 d->bibinfo_cache_valid_ = true;
2593 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2598 for (InsetIterator it = begin(inset()); it; ++it) {
2599 it->collectBibKeys(it, checkedFiles);
2600 if (it->lyxCode() == BIBITEM_CODE) {
2601 if (parent() != nullptr)
2602 parent()->d->have_bibitems_ = true;
2604 d->have_bibitems_ = true;
2610 void Buffer::addBiblioInfo(BiblioInfo const & bi_in) const
2612 // We add the biblio info to the parent buffer,
2613 // if there is one, but also to this buffer, in case
2614 // it is compiled alone.
2615 BiblioInfo & our_bi = d->bibinfo_;
2616 our_bi.mergeBiblioInfo(bi_in);
2619 parent()->addBiblioInfo(bi_in);
2623 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2625 // We add the bibtex info to the master buffer,
2626 // if there is one, but also to every single buffer,
2627 // in case a child is compiled alone.
2628 BiblioInfo & bi = d->bibinfo_;
2631 if (parent() != nullptr) {
2632 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2633 masterbi[key] = bin;
2638 void Buffer::makeCitationLabels() const
2640 Buffer const * const master = masterBuffer();
2641 return d->bibinfo_.makeCitationLabels(*master);
2645 void Buffer::invalidateCiteLabels() const
2647 masterBuffer()->d->cite_labels_valid_ = false;
2650 bool Buffer::citeLabelsValid() const
2652 return masterBuffer()->d->cite_labels_valid_;
2656 void Buffer::removeBiblioTempFiles() const
2658 // We remove files that contain LaTeX commands specific to the
2659 // particular bibliographic style being used, in order to avoid
2660 // LaTeX errors when we switch style.
2661 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2662 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2663 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2664 aux_file.removeFile();
2665 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2666 bbl_file.removeFile();
2667 // Also for the parent buffer
2668 Buffer const * const pbuf = parent();
2670 pbuf->removeBiblioTempFiles();
2674 bool Buffer::isDepClean(string const & name) const
2676 DepClean::const_iterator const it = d->dep_clean.find(name);
2677 if (it == d->dep_clean.end())
2683 void Buffer::markDepClean(string const & name)
2685 d->dep_clean[name] = true;
2689 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2692 // FIXME? if there is an Buffer LFUN that can be dispatched even
2693 // if internal, put a switch '(cmd.action)' here.
2699 switch (cmd.action()) {
2701 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2702 flag.setOnOff(hasReadonlyFlag());
2705 // FIXME: There is need for a command-line import.
2706 //case LFUN_BUFFER_IMPORT:
2708 case LFUN_BUFFER_AUTO_SAVE:
2711 case LFUN_BUFFER_EXPORT_CUSTOM:
2712 // FIXME: Nothing to check here?
2715 case LFUN_BUFFER_EXPORT: {
2716 docstring const & arg = cmd.argument();
2717 if (arg == "custom") {
2721 string format = (arg.empty() || arg == "default") ?
2722 params().getDefaultOutputFormat() : to_utf8(arg);
2723 size_t pos = format.find(' ');
2724 if (pos != string::npos)
2725 format = format.substr(0, pos);
2726 enable = params().isExportable(format, false);
2728 flag.message(bformat(
2729 _("Don't know how to export to format: %1$s"), arg));
2733 case LFUN_BUILD_PROGRAM:
2734 enable = params().isExportable("program", false);
2737 case LFUN_BRANCH_ACTIVATE:
2738 case LFUN_BRANCH_DEACTIVATE:
2739 case LFUN_BRANCH_MASTER_ACTIVATE:
2740 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2741 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2742 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2743 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2744 : params().branchlist();
2745 docstring const & branchName = cmd.argument();
2746 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2750 case LFUN_BRANCH_ADD:
2751 case LFUN_BRANCHES_RENAME:
2752 // if no Buffer is present, then of course we won't be called!
2755 case LFUN_BUFFER_LANGUAGE:
2756 enable = !isReadonly();
2759 case LFUN_BUFFER_VIEW_CACHE:
2760 (d->preview_file_).refresh();
2761 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2764 case LFUN_CHANGES_TRACK:
2765 flag.setEnabled(true);
2766 flag.setOnOff(params().track_changes);
2769 case LFUN_CHANGES_OUTPUT:
2770 flag.setEnabled(true);
2771 flag.setOnOff(params().output_changes);
2774 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2775 flag.setOnOff(params().compressed);
2778 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2779 flag.setOnOff(params().output_sync);
2782 case LFUN_BUFFER_ANONYMIZE:
2788 flag.setEnabled(enable);
2793 void Buffer::dispatch(string const & command, DispatchResult & result)
2795 return dispatch(lyxaction.lookupFunc(command), result);
2799 // NOTE We can end up here even if we have no GUI, because we are called
2800 // by LyX::exec to handled command-line requests. So we may need to check
2801 // whether we have a GUI or not. The boolean use_gui holds this information.
2802 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2805 // FIXME? if there is an Buffer LFUN that can be dispatched even
2806 // if internal, put a switch '(cmd.action())' here.
2807 dr.dispatched(false);
2810 string const argument = to_utf8(func.argument());
2811 // We'll set this back to false if need be.
2812 bool dispatched = true;
2813 // This handles undo groups automagically
2814 UndoGroupHelper ugh(this);
2816 switch (func.action()) {
2817 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2818 if (lyxvc().inUse()) {
2819 string log = lyxvc().toggleReadOnly();
2824 setReadonly(!hasReadonlyFlag());
2827 case LFUN_BUFFER_EXPORT: {
2828 string const format = (argument.empty() || argument == "default") ?
2829 params().getDefaultOutputFormat() : argument;
2830 ExportStatus const status = doExport(format, false);
2831 dr.setError(status != ExportSuccess);
2832 if (status != ExportSuccess)
2833 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2834 from_utf8(format)));
2838 case LFUN_BUILD_PROGRAM: {
2839 ExportStatus const status = doExport("program", true);
2840 dr.setError(status != ExportSuccess);
2841 if (status != ExportSuccess)
2842 dr.setMessage(_("Error generating literate programming code."));
2846 case LFUN_BUFFER_EXPORT_CUSTOM: {
2848 string command = split(argument, format_name, ' ');
2849 Format const * format = theFormats().getFormat(format_name);
2851 lyxerr << "Format \"" << format_name
2852 << "\" not recognized!"
2857 // The name of the file created by the conversion process
2860 // Output to filename
2861 if (format->name() == "lyx") {
2862 string const latexname = latexName(false);
2863 filename = changeExtension(latexname,
2864 format->extension());
2865 filename = addName(temppath(), filename);
2867 if (!writeFile(FileName(filename)))
2871 doExport(format_name, true, filename);
2874 // Substitute $$FName for filename
2875 if (!contains(command, "$$FName"))
2876 command = "( " + command + " ) < $$FName";
2877 command = subst(command, "$$FName", filename);
2879 // Execute the command in the background
2881 call.startscript(Systemcall::DontWait, command,
2882 filePath(), layoutPos());
2886 // FIXME: There is need for a command-line import.
2888 case LFUN_BUFFER_IMPORT:
2893 case LFUN_BUFFER_AUTO_SAVE:
2895 resetAutosaveTimers();
2898 case LFUN_BRANCH_ACTIVATE:
2899 case LFUN_BRANCH_DEACTIVATE:
2900 case LFUN_BRANCH_MASTER_ACTIVATE:
2901 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2902 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2903 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2904 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2907 docstring const & branch_name = func.argument();
2908 // the case without a branch name is handled elsewhere
2909 if (branch_name.empty()) {
2913 Branch * branch = buf->params().branchlist().find(branch_name);
2915 LYXERR0("Branch " << branch_name << " does not exist.");
2917 docstring const msg =
2918 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2922 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2923 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2924 if (branch->isSelected() != activate) {
2925 buf->undo().recordUndoBufferParams(CursorData());
2926 branch->setSelected(activate);
2928 dr.screenUpdate(Update::Force);
2929 dr.forceBufferUpdate();
2934 case LFUN_BRANCH_ADD: {
2935 docstring const & branchnames = func.argument();
2936 if (branchnames.empty()) {
2940 BranchList & branch_list = params().branchlist();
2941 vector<docstring> const branches =
2942 getVectorFromString(branchnames, branch_list.separator());
2944 for (docstring const & branch_name : branches) {
2945 Branch * branch = branch_list.find(branch_name);
2947 LYXERR0("Branch " << branch_name << " already exists.");
2951 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2953 undo().recordUndoBufferParams(CursorData());
2954 branch_list.add(branch_name);
2955 branch = branch_list.find(branch_name);
2957 // needed to update the color table for dark mode
2958 branch->setColors("background", "background");
2960 dr.screenUpdate(Update::Force);
2968 case LFUN_BRANCHES_RENAME: {
2969 if (func.argument().empty())
2972 docstring const oldname = from_utf8(func.getArg(0));
2973 docstring const newname = from_utf8(func.getArg(1));
2974 InsetIterator it = begin(inset());
2975 InsetIterator const itend = end(inset());
2976 bool success = false;
2977 for (; it != itend; ++it) {
2978 if (it->lyxCode() == BRANCH_CODE) {
2979 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2980 if (ins.branch() == oldname) {
2981 undo().recordUndo(CursorData(it));
2982 ins.rename(newname);
2987 if (it->lyxCode() == INCLUDE_CODE) {
2988 // get buffer of external file
2989 InsetInclude const & ins =
2990 static_cast<InsetInclude const &>(*it);
2991 Buffer * child = ins.loadIfNeeded();
2994 child->dispatch(func, dr);
2999 dr.screenUpdate(Update::Force);
3000 dr.forceBufferUpdate();
3005 case LFUN_BUFFER_VIEW_CACHE:
3006 if (!theFormats().view(*this, d->preview_file_,
3007 d->preview_format_))
3008 dr.setMessage(_("Error viewing the output file."));
3011 case LFUN_CHANGES_TRACK:
3012 if (params().save_transient_properties)
3013 undo().recordUndoBufferParams(CursorData());
3014 params().track_changes = !params().track_changes;
3017 case LFUN_CHANGES_OUTPUT:
3018 if (params().save_transient_properties)
3019 undo().recordUndoBufferParams(CursorData());
3020 params().output_changes = !params().output_changes;
3021 if (params().output_changes) {
3022 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3023 LaTeXFeatures::isAvailable("xcolor");
3026 Alert::warning(_("Changes not shown in LaTeX output"),
3027 _("Changes will not be highlighted in LaTeX output, "
3028 "because xcolor and ulem are not installed.\n"
3029 "Please install both packages or redefine "
3030 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3035 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3036 // turn compression on/off
3037 undo().recordUndoBufferParams(CursorData());
3038 params().compressed = !params().compressed;
3041 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3042 undo().recordUndoBufferParams(CursorData());
3043 params().output_sync = !params().output_sync;
3046 case LFUN_BUFFER_ANONYMIZE: {
3047 undo().recordUndoFullBuffer(CursorData());
3048 CursorData cur(doc_iterator_begin(this));
3049 for ( ; cur ; cur.forwardPar())
3050 cur.paragraph().anonymize();
3051 dr.forceBufferUpdate();
3052 dr.screenUpdate(Update::Force);
3060 dr.dispatched(dispatched);
3064 void Buffer::changeLanguage(Language const * from, Language const * to)
3066 LASSERT(from, return);
3067 LASSERT(to, return);
3069 ParIterator it = par_iterator_begin();
3070 ParIterator eit = par_iterator_end();
3071 for (; it != eit; ++it)
3072 it->changeLanguage(params(), from, to);
3076 bool Buffer::isMultiLingual() const
3078 ParConstIterator end = par_iterator_end();
3079 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3080 if (it->isMultiLingual(params()))
3087 std::set<Language const *> Buffer::getLanguages() const
3089 std::set<Language const *> langs;
3090 getLanguages(langs);
3095 void Buffer::getLanguages(std::set<Language const *> & langs) const
3097 ParConstIterator end = par_iterator_end();
3098 // add the buffer language, even if it's not actively used
3099 langs.insert(language());
3100 // iterate over the paragraphs
3101 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3102 it->getLanguages(langs);
3104 ListOfBuffers clist = getDescendants();
3105 for (auto const & cit : clist)
3106 cit->getLanguages(langs);
3110 DocIterator Buffer::getParFromID(int const id) const
3112 Buffer * buf = const_cast<Buffer *>(this);
3114 // This means non-existent
3115 return doc_iterator_end(buf);
3117 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3118 if (it.paragraph().id() == id)
3121 return doc_iterator_end(buf);
3125 bool Buffer::hasParWithID(int const id) const
3127 return !getParFromID(id).atEnd();
3131 ParIterator Buffer::par_iterator_begin()
3133 return ParIterator(doc_iterator_begin(this));
3137 ParIterator Buffer::par_iterator_end()
3139 return ParIterator(doc_iterator_end(this));
3143 ParConstIterator Buffer::par_iterator_begin() const
3145 return ParConstIterator(doc_iterator_begin(this));
3149 ParConstIterator Buffer::par_iterator_end() const
3151 return ParConstIterator(doc_iterator_end(this));
3154 bool Buffer::empty() const
3156 return paragraphs().size() == 1 && paragraphs().front().empty();
3160 Language const * Buffer::language() const
3162 return params().language;
3166 docstring Buffer::B_(string const & l10n) const
3168 return params().B_(l10n);
3172 bool Buffer::isClean() const
3174 return d->lyx_clean;
3178 bool Buffer::isChecksumModified() const
3180 LASSERT(d->filename.exists(), return false);
3181 return d->checksum_ != d->filename.checksum();
3185 void Buffer::saveCheckSum() const
3187 FileName const & file = d->filename;
3189 d->checksum_ = file.exists() ? file.checksum()
3190 : 0; // in the case of save to a new file.
3194 void Buffer::markClean() const
3196 if (!d->lyx_clean) {
3197 d->lyx_clean = true;
3200 // if the .lyx file has been saved, we don't need an
3202 d->bak_clean = true;
3203 d->undo_.markDirty();
3204 clearExternalModification();
3208 void Buffer::setUnnamed(bool flag)
3214 bool Buffer::isUnnamed() const
3221 /// Don't check unnamed, here: isInternal() is used in
3222 /// newBuffer(), where the unnamed flag has not been set by anyone
3223 /// yet. Also, for an internal buffer, there should be no need for
3224 /// retrieving fileName() nor for checking if it is unnamed or not.
3225 bool Buffer::isInternal() const
3227 return d->internal_buffer;
3231 void Buffer::setInternal(bool flag)
3233 d->internal_buffer = flag;
3237 void Buffer::markDirty()
3240 d->lyx_clean = false;
3243 d->bak_clean = false;
3245 for (auto & depit : d->dep_clean)
3246 depit.second = false;
3250 FileName Buffer::fileName() const
3256 string Buffer::absFileName() const
3258 return d->filename.absFileName();
3262 string Buffer::filePath() const
3264 string const abs = d->filename.onlyPath().absFileName();
3267 int last = abs.length() - 1;
3269 return abs[last] == '/' ? abs : abs + '/';
3273 DocFileName Buffer::getReferencedFileName(string const & fn) const
3276 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3277 result.set(fn, filePath());
3279 // filePath() ends with a path separator
3280 FileName const test(filePath() + fn);
3282 result.set(fn, filePath());
3284 result.set(fn, params().origin);
3291 string const Buffer::prepareFileNameForLaTeX(string const & name,
3292 string const & ext, bool nice) const
3294 string const fname = makeAbsPath(name, filePath()).absFileName();
3295 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3301 return to_utf8(makeRelPath(from_utf8(fname),
3302 from_utf8(masterBuffer()->filePath())));
3306 vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3307 docstring_list const & bibfilelist,
3308 bool const add_extension) const
3310 // If we are processing the LaTeX file in a temp directory then
3311 // copy the .bib databases to this temp directory, mangling their
3312 // names in the process. Store this mangled name in the list of
3314 // (We need to do all this because BibTeX *really*, *really*
3315 // can't handle "files with spaces" and Windows users tend to
3316 // use such filenames.)
3317 // Otherwise, store the (maybe absolute) path to the original,
3318 // unmangled database name.
3320 vector<pair<docstring, string>> res;
3322 // determine the export format
3323 string const tex_format = flavor2format(runparams.flavor);
3325 // check for spaces in paths
3326 bool found_space = false;
3328 for (auto const & bit : bibfilelist) {
3329 string utf8input = to_utf8(bit);
3331 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3332 FileName try_in_file =
3333 makeAbsPath(database + ".bib", filePath());
3334 bool not_from_texmf = try_in_file.isReadableFile();
3335 // If the file has not been found, try with the real file name
3336 // (it might come from a child in a sub-directory)
3337 if (!not_from_texmf) {
3338 try_in_file = getBibfilePath(bit);
3339 if (try_in_file.isReadableFile()) {
3340 // Check if the file is in texmf
3341 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3342 not_from_texmf = kpsefile.empty()
3343 || kpsefile.absFileName() != try_in_file.absFileName();
3345 // If this exists, make path relative to the master
3348 removeExtension(prepareFileNameForLaTeX(
3349 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3350 from_utf8(filePath()))),
3351 ".bib", runparams.nice));
3355 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3357 // mangledFileName() needs the extension
3358 DocFileName const in_file = DocFileName(try_in_file);
3359 database = removeExtension(in_file.mangledFileName());
3360 FileName const out_file = makeAbsPath(database + ".bib",
3361 masterBuffer()->temppath());
3362 bool const success = in_file.copyTo(out_file);
3364 LYXERR0("Failed to copy '" << in_file
3365 << "' to '" << out_file << "'");
3367 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3368 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3369 if (!isValidLaTeXFileName(database)) {
3370 frontend::Alert::warning(_("Invalid filename"),
3371 _("The following filename will cause troubles "
3372 "when running the exported file through LaTeX: ") +
3373 from_utf8(database));
3375 if (!isValidDVIFileName(database)) {
3376 frontend::Alert::warning(_("Problematic filename for DVI"),
3377 _("The following filename can cause troubles "
3378 "when running the exported file through LaTeX "
3379 "and opening the resulting DVI: ") +
3380 from_utf8(database), true);
3388 docstring const path = from_utf8(latex_path(database));
3390 if (contains(path, ' '))
3393 if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
3394 enc = params().bibFileEncoding(utf8input);
3396 bool recorded = false;
3397 for (auto const & pe : res) {
3398 if (pe.first == path) {
3405 res.push_back(make_pair(path, enc));
3408 // Check if there are spaces in the path and warn BibTeX users, if so.
3409 // (biber can cope with such paths)
3410 if (!prefixIs(runparams.bibtex_command, "biber")) {
3411 // Post this warning only once.
3412 static bool warned_about_spaces = false;
3413 if (!warned_about_spaces &&
3414 runparams.nice && found_space) {
3415 warned_about_spaces = true;
3416 Alert::warning(_("Export Warning!"),
3417 _("There are spaces in the paths to your BibTeX databases.\n"
3418 "BibTeX will be unable to find them."));
3427 string Buffer::layoutPos() const
3429 return d->layout_position;
3433 void Buffer::setLayoutPos(string const & path)
3436 d->layout_position.clear();
3440 LATTEST(FileName::isAbsolute(path));
3442 d->layout_position =
3443 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3445 if (d->layout_position.empty())
3446 d->layout_position = ".";
3450 bool Buffer::hasReadonlyFlag() const
3452 return d->read_only;
3456 bool Buffer::isReadonly() const
3458 return hasReadonlyFlag() || notifiesExternalModification();
3462 void Buffer::setParent(Buffer const * buffer)
3464 // We need to do some work here to avoid recursive parent structures.
3465 // This is the easy case.
3466 if (buffer == this) {
3467 LYXERR0("Ignoring attempt to set self as parent in\n" << fileName());
3470 // Now we check parents going upward, to make sure that IF we set the
3471 // parent as requested, we would not generate a recursive include.
3472 set<Buffer const *> sb;
3473 Buffer const * b = buffer;
3474 bool found_recursion = false;
3476 if (sb.find(b) != sb.end()) {
3477 found_recursion = true;
3484 if (found_recursion) {
3485 LYXERR0("Ignoring attempt to set parent of\n" <<
3488 buffer->fileName() <<
3489 "\nbecause that would create a recursive inclusion.");
3493 // We should be safe now.
3494 d->setParent(buffer);
3499 Buffer const * Buffer::parent() const
3505 ListOfBuffers Buffer::allRelatives() const
3507 ListOfBuffers lb = masterBuffer()->getDescendants();
3508 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3513 Buffer const * Buffer::masterBuffer() const
3515 Buffer const * const pbuf = d->parent();
3519 return pbuf->masterBuffer();
3523 bool Buffer::isChild(Buffer * child) const
3525 return d->children_positions.find(child) != d->children_positions.end();
3529 DocIterator Buffer::firstChildPosition(Buffer const * child)
3531 Impl::BufferPositionMap::iterator it;
3532 it = d->children_positions.find(child);
3533 if (it == d->children_positions.end())
3534 return DocIterator(this);
3539 bool Buffer::hasChildren() const
3541 return !d->children_positions.empty();
3545 void Buffer::collectChildren(ListOfBuffers & children, bool grand_children) const
3547 // loop over children
3548 for (auto const & p : d->children_positions) {
3549 Buffer * child = const_cast<Buffer *>(p.first);
3551 ListOfBuffers::const_iterator bit = find(children.begin(), children.end(), child);
3552 if (bit != children.end())
3554 children.push_back(child);
3556 // there might be grandchildren
3557 child->collectChildren(children, true);
3562 ListOfBuffers Buffer::getChildren() const
3565 collectChildren(v, false);
3566 // Make sure we have not included ourselves.
3567 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3568 if (bit != v.end()) {
3569 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3576 ListOfBuffers Buffer::getDescendants() const
3579 collectChildren(v, true);
3580 // Make sure we have not included ourselves.
3581 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3582 if (bit != v.end()) {
3583 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3590 template<typename M>
3591 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3596 typename M::const_iterator it = m.lower_bound(x);
3597 if (it == m.begin())
3605 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3606 DocIterator const & pos) const
3608 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3610 // if paragraphs have no macro context set, pos will be empty
3614 // we haven't found anything yet
3615 DocIterator bestPos = owner_->par_iterator_begin();
3616 MacroData const * bestData = nullptr;
3618 // find macro definitions for name
3619 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3620 if (nameIt != macros.end()) {
3621 // find last definition in front of pos or at pos itself
3622 PositionScopeMacroMap::const_iterator it
3623 = greatest_below(nameIt->second, pos);
3624 if (it != nameIt->second.end()) {
3626 // scope ends behind pos?
3627 if (pos < it->second.scope) {
3628 // Looks good, remember this. If there
3629 // is no external macro behind this,
3630 // we found the right one already.
3631 bestPos = it->first;
3632 bestData = &it->second.macro;
3636 // try previous macro if there is one
3637 if (it == nameIt->second.begin())
3644 // find macros in included files
3645 PositionScopeBufferMap::const_iterator it
3646 = greatest_below(position_to_children, pos);
3647 if (it == position_to_children.end())
3648 // no children before
3652 // do we know something better (i.e. later) already?
3653 if (it->first < bestPos )
3656 // scope ends behind pos?
3657 if (pos < it->second.scope
3658 && (cloned_buffer_ ||
3659 theBufferList().isLoaded(it->second.buffer))) {
3660 // look for macro in external file
3662 MacroData const * data
3663 = it->second.buffer->getMacro(name, false);
3666 bestPos = it->first;
3672 // try previous file if there is one
3673 if (it == position_to_children.begin())
3678 // return the best macro we have found
3683 MacroData const * Buffer::getMacro(docstring const & name,
3684 DocIterator const & pos, bool global) const
3689 // query buffer macros
3690 MacroData const * data = d->getBufferMacro(name, pos);
3691 if (data != nullptr)
3694 // If there is a master buffer, query that
3695 Buffer const * const pbuf = d->parent();
3697 d->macro_lock = true;
3698 MacroData const * macro = pbuf->getMacro(
3699 name, *this, false);
3700 d->macro_lock = false;
3706 data = MacroTable::globalMacros().get(name);
3707 if (data != nullptr)
3715 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3717 // set scope end behind the last paragraph
3718 DocIterator scope = par_iterator_begin();
3719 scope.pit() = scope.lastpit() + 1;
3721 return getMacro(name, scope, global);
3725 MacroData const * Buffer::getMacro(docstring const & name,
3726 Buffer const & child, bool global) const
3728 // look where the child buffer is included first
3729 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3730 if (it == d->children_positions.end())
3733 // check for macros at the inclusion position
3734 return getMacro(name, it->second, global);
3738 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3740 pit_type const lastpit = it.lastpit();
3742 // look for macros in each paragraph
3743 while (it.pit() <= lastpit) {
3744 Paragraph & par = it.paragraph();
3746 // iterate over the insets of the current paragraph
3747 for (auto const & insit : par.insetList()) {
3748 it.pos() = insit.pos;
3750 // is it a nested text inset?
3751 if (insit.inset->asInsetText()) {
3752 // Inset needs its own scope?
3753 InsetText const * itext = insit.inset->asInsetText();
3754 bool newScope = itext->isMacroScope();
3756 // scope which ends just behind the inset
3757 DocIterator insetScope = it;
3760 // collect macros in inset
3761 it.push_back(CursorSlice(*insit.inset));
3762 updateMacros(it, newScope ? insetScope : scope);
3767 if (insit.inset->asInsetTabular()) {
3768 CursorSlice slice(*insit.inset);
3769 size_t const numcells = slice.nargs();
3770 for (; slice.idx() < numcells; slice.forwardIdx()) {
3771 it.push_back(slice);
3772 updateMacros(it, scope);
3778 // is it an external file?
3779 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3780 // get buffer of external file
3781 InsetInclude const & incinset =
3782 static_cast<InsetInclude const &>(*insit.inset);
3784 Buffer * child = incinset.loadIfNeeded();
3789 // register its position, but only when it is
3790 // included first in the buffer
3791 children_positions.insert({child, it});
3793 // register child with its scope
3794 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3798 InsetMath * im = insit.inset->asInsetMath();
3799 if (doing_export && im) {
3800 InsetMathHull * hull = im->asHullInset();
3802 hull->recordLocation(it);
3805 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3809 InsetMathMacroTemplate & macroTemplate =
3810 *insit.inset->asInsetMath()->asMacroTemplate();
3811 MacroContext mc(owner_, it);
3812 macroTemplate.updateToContext(mc);
3815 bool valid = macroTemplate.validMacro();
3816 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3817 // then the BufferView's cursor will be invalid in
3818 // some cases which leads to crashes.
3823 // FIXME (Abdel), I don't understand why we pass 'it' here
3824 // instead of 'macroTemplate' defined above... is this correct?
3825 macros[macroTemplate.name()][it] =
3826 Impl::ScopeMacro(scope, MacroData(owner_, it));
3836 void Buffer::updateMacros() const
3841 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3843 // start with empty table
3845 d->children_positions.clear();
3846 d->position_to_children.clear();
3848 // Iterate over buffer, starting with first paragraph
3849 // The scope must be bigger than any lookup DocIterator
3850 // later. For the global lookup, lastpit+1 is used, hence
3851 // we use lastpit+2 here.
3852 DocIterator it = par_iterator_begin();
3853 DocIterator outerScope = it;
3854 outerScope.pit() = outerScope.lastpit() + 2;
3855 d->updateMacros(it, outerScope);
3859 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3861 for (Inset const & it : inset()) {
3862 if (it.lyxCode() == BRANCH_CODE) {
3863 InsetBranch const & br = static_cast<InsetBranch const &>(it);
3864 docstring const name = br.branch();
3865 if (!from_master && !params().branchlist().find(name))
3866 result.push_back(name);
3867 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3868 result.push_back(name);
3871 if (it.lyxCode() == INCLUDE_CODE) {
3872 // get buffer of external file
3873 InsetInclude const & ins =
3874 static_cast<InsetInclude const &>(it);
3875 Buffer * child = ins.loadIfNeeded();
3878 child->getUsedBranches(result, true);
3881 // remove duplicates
3886 void Buffer::updateMacroInstances(UpdateType utype) const
3888 LYXERR(Debug::MACROS, "updateMacroInstances for "
3889 << d->filename.onlyFileName());
3890 DocIterator it = doc_iterator_begin(this);
3892 DocIterator const end = doc_iterator_end(this);
3893 for (; it != end; it.forwardInset()) {
3894 // look for MathData cells in InsetMathNest insets
3895 InsetMath * minset = it.nextInset()->asInsetMath();
3899 // update macro in all cells of the InsetMathNest
3900 idx_type n = minset->nargs();
3901 MacroContext mc = MacroContext(this, it);
3902 for (idx_type i = 0; i < n; ++i) {
3903 MathData & data = minset->cell(i);
3904 data.updateMacros(nullptr, mc, utype, 0);
3910 void Buffer::listMacroNames(MacroNameSet & macros) const
3915 d->macro_lock = true;
3917 // loop over macro names
3918 for (auto const & nameit : d->macros)
3919 macros.insert(nameit.first);
3921 // loop over children
3922 for (auto const & p : d->children_positions) {
3923 Buffer * child = const_cast<Buffer *>(p.first);
3924 // The buffer might have been closed (see #10766).
3925 if (theBufferList().isLoaded(child))
3926 child->listMacroNames(macros);
3930 Buffer const * const pbuf = d->parent();
3932 pbuf->listMacroNames(macros);
3934 d->macro_lock = false;
3938 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3940 Buffer const * const pbuf = d->parent();
3945 pbuf->listMacroNames(names);
3948 for (auto const & mit : names) {
3950 MacroData const * data = pbuf->getMacro(mit, *this, false);
3952 macros.insert(data);
3954 // we cannot access the original InsetMathMacroTemplate anymore
3955 // here to calls validate method. So we do its work here manually.
3956 // FIXME: somehow make the template accessible here.
3957 if (data->optionals() > 0)
3958 features.require("xargs");
3964 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3967 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3969 RefCache::iterator it = d->ref_cache_.find(label);
3970 if (it != d->ref_cache_.end())
3973 static References const dummy_refs = References();
3974 it = d->ref_cache_.insert(
3975 make_pair(label, dummy_refs)).first;
3980 Buffer::References const & Buffer::references(docstring const & label) const
3982 return const_cast<Buffer *>(this)->getReferenceCache(label);
3986 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3988 References & refs = getReferenceCache(label);
3989 refs.push_back(make_pair(inset, it));
3993 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
3997 linfo.label = label;
3999 linfo.active = active;
4000 masterBuffer()->d->label_cache_.push_back(linfo);
4004 InsetLabel const * Buffer::insetLabel(docstring const & label,
4005 bool const active) const
4007 for (auto const & rc : masterBuffer()->d->label_cache_) {
4008 if (rc.label == label && (rc.active || !active))
4015 bool Buffer::activeLabel(docstring const & label) const
4017 return insetLabel(label, true) != nullptr;
4021 void Buffer::clearReferenceCache() const
4024 d->ref_cache_.clear();
4025 d->label_cache_.clear();
4030 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
4032 //FIXME: This does not work for child documents yet.
4033 reloadBibInfoCache();
4035 // Check if the label 'from' appears more than once
4036 vector<docstring> labels;
4037 for (auto const & bibit : masterBibInfo())
4038 labels.push_back(bibit.first);
4040 if (count(labels.begin(), labels.end(), from) > 1)
4043 string const paramName = "key";
4044 UndoGroupHelper ugh(this);
4045 InsetIterator it = begin(inset());
4047 if (it->lyxCode() != CITE_CODE)
4049 InsetCommand * inset = it->asInsetCommand();
4050 docstring const oldValue = inset->getParam(paramName);
4051 if (oldValue == from) {
4052 undo().recordUndo(CursorData(it));
4053 inset->setParam(paramName, to);
4058 // returns NULL if id-to-row conversion is unsupported
4059 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4060 pit_type par_begin, pit_type par_end,
4061 OutputWhat output, bool master) const
4063 unique_ptr<TexRow> texrow;
4064 OutputParams runparams(¶ms().encoding());
4065 runparams.nice = true;
4066 runparams.flavor = params().getOutputFlavor(format);
4067 runparams.linelen = lyxrc.plaintext_linelen;
4068 // No side effect of file copying and image conversion
4069 runparams.dryrun = true;
4071 // Some macros rely on font encoding
4072 runparams.main_fontenc = params().main_font_encoding();
4074 // Use the right wrapping for the comment at the beginning of the generated
4075 // snippet, so that it is either valid LaTeX or valid XML (including HTML and DocBook).
4076 docstring comment_start = from_ascii("% ");
4077 docstring comment_end = from_ascii("");
4078 if (runparams.flavor == Flavor::Html || runparams.flavor == Flavor::DocBook5) {
4079 comment_start = from_ascii("<!-- ");
4080 comment_end = from_ascii(" -->");
4083 if (output == CurrentParagraph) {
4084 runparams.par_begin = par_begin;
4085 runparams.par_end = par_end;
4086 if (par_begin + 1 == par_end) {
4088 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4093 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4094 convert<docstring>(par_begin),
4095 convert<docstring>(par_end - 1))
4099 // output paragraphs
4100 if (runparams.flavor == Flavor::LyX) {
4101 Paragraph const & par = text().paragraphs()[par_begin];
4103 depth_type dt = par.getDepth();
4104 par.write(ods, params(), dt);
4105 os << from_utf8(ods.str());
4106 } else if (runparams.flavor == Flavor::Html) {
4108 setMathFlavor(runparams);
4109 xhtmlParagraphs(text(), *this, xs, runparams);
4110 } else if (runparams.flavor == Flavor::Text) {
4112 // FIXME Handles only one paragraph, unlike the others.
4113 // Probably should have some routine with a signature like them.
4114 writePlaintextParagraph(*this,
4115 text().paragraphs()[par_begin], os, runparams, dummy);
4116 } else if (runparams.flavor == Flavor::DocBook5) {
4118 docbookParagraphs(text(), *this, xs, runparams);
4120 // If we are previewing a paragraph, even if this is the
4121 // child of some other buffer, let's cut the link here,
4122 // so that no concurring settings from the master
4123 // (e.g. branch state) interfere (see #8101).
4125 d->ignore_parent = true;
4126 // We need to validate the Buffer params' features here
4127 // in order to know if we should output polyglossia
4128 // macros (instead of babel macros)
4129 LaTeXFeatures features(*this, params(), runparams);
4131 runparams.use_polyglossia = features.usePolyglossia();
4132 runparams.use_hyperref = features.isRequired("hyperref");
4133 // latex or literate
4136 ots.texrow().newlines(2);
4138 latexParagraphs(*this, text(), ots, runparams);
4139 texrow = ots.releaseTexRow();
4141 // Restore the parenthood
4143 d->ignore_parent = false;
4146 os << comment_start;
4147 if (output == FullSource)
4148 os << _("Preview source code");
4149 else if (output == OnlyPreamble)
4150 os << _("Preview preamble");
4151 else if (output == OnlyBody)
4152 os << _("Preview body");
4155 if (runparams.flavor == Flavor::LyX) {
4157 if (output == FullSource)
4159 else if (output == OnlyPreamble)
4160 params().writeFile(ods, this);
4161 else if (output == OnlyBody)
4163 os << from_utf8(ods.str());
4164 } else if (runparams.flavor == Flavor::Html) {
4165 writeLyXHTMLSource(os, runparams, output);
4166 } else if (runparams.flavor == Flavor::Text) {
4167 if (output == OnlyPreamble)
4168 os << "% "<< _("Plain text does not have a preamble.");
4170 writePlaintextFile(*this, os, runparams);
4171 } else if (runparams.flavor == Flavor::DocBook5) {
4172 writeDocBookSource(os, runparams, output);
4174 // latex or literate
4177 ots.texrow().newlines(2);
4179 runparams.is_child = true;
4181 writeLaTeXSource(ots, string(), runparams, output);
4182 texrow = ots.releaseTexRow();
4189 ErrorList & Buffer::errorList(string const & type) const
4191 return d->errorLists[type];
4195 void Buffer::updateTocItem(std::string const & type,
4196 DocIterator const & dit) const
4199 d->gui_->updateTocItem(type, dit);
4203 void Buffer::structureChanged() const
4206 d->gui_->structureChanged();
4210 void Buffer::errors(string const & err, bool from_master) const
4213 d->gui_->errors(err, from_master);
4217 void Buffer::message(docstring const & msg) const
4220 d->gui_->message(msg);
4224 void Buffer::setBusy(bool on) const
4227 d->gui_->setBusy(on);
4231 void Buffer::updateTitles() const
4234 d->wa_->updateTitles();
4238 void Buffer::resetAutosaveTimers() const
4241 d->gui_->resetAutosaveTimers();
4245 bool Buffer::hasGuiDelegate() const
4251 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4257 FileName Buffer::getEmergencyFileName() const
4259 return FileName(d->filename.absFileName() + ".emergency");
4263 FileName Buffer::getAutosaveFileName() const
4265 // if the document is unnamed try to save in the backup dir, else
4266 // in the default document path, and as a last try in the filePath,
4267 // which will most often be the temporary directory
4270 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4271 : lyxrc.backupdir_path;
4272 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4275 string const fname = "#" + d->filename.onlyFileName() + "#";
4277 return makeAbsPath(fname, fpath);
4281 void Buffer::removeAutosaveFile() const
4283 FileName const f = getAutosaveFileName();
4289 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4291 FileName const newauto = getAutosaveFileName();
4293 if (newauto != oldauto && oldauto.exists())
4294 if (!oldauto.moveTo(newauto))
4295 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4299 bool Buffer::autoSave() const
4301 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4302 if (buf->d->bak_clean || hasReadonlyFlag())
4305 message(_("Autosaving current document..."));
4306 buf->d->bak_clean = true;
4308 FileName const fname = getAutosaveFileName();
4309 LASSERT(d->cloned_buffer_, return false);
4311 // If this buffer is cloned, we assume that
4312 // we are running in a separate thread already.
4313 TempFile tempfile("lyxautoXXXXXX.lyx");
4314 tempfile.setAutoRemove(false);
4315 FileName const tmp_ret = tempfile.name();
4316 if (!tmp_ret.empty()) {
4318 // assume successful write of tmp_ret
4319 if (tmp_ret.moveTo(fname))
4322 // failed to write/rename tmp_ret so try writing direct
4323 return writeFile(fname);
4327 void Buffer::setExportStatus(bool e) const
4329 d->doing_export = e;
4330 ListOfBuffers clist = getDescendants();
4331 for (auto const & bit : clist)
4332 bit->d->doing_export = e;
4336 bool Buffer::isExporting() const
4338 return d->doing_export;
4342 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4346 return doExport(target, put_in_tempdir, result_file);
4349 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4350 string & result_file) const
4352 bool const update_unincluded =
4353 params().maintain_unincluded_children != BufferParams::CM_None
4354 && !params().getIncludedChildren().empty();
4356 // (1) export with all included children (omit \includeonly)
4357 if (update_unincluded) {
4358 ExportStatus const status =
4359 doExport(target, put_in_tempdir, true, result_file);
4360 if (status != ExportSuccess)
4363 // (2) export with included children only
4364 return doExport(target, put_in_tempdir, false, result_file);
4368 void Buffer::setMathFlavor(OutputParams & op) const
4370 // Passes the way to generate formulae to the XHTML output code.
4371 // In particular, this function has no impact on the DocBook code, as it
4372 // uses another mechanism to handle math flavours.
4373 switch (params().html_math_output) {
4374 case BufferParams::MathML:
4375 op.math_flavor = OutputParams::MathAsMathML;
4377 case BufferParams::HTML:
4378 op.math_flavor = OutputParams::MathAsHTML;
4380 case BufferParams::Images:
4381 op.math_flavor = OutputParams::MathAsImages;
4383 case BufferParams::LaTeX:
4384 op.math_flavor = OutputParams::MathAsLaTeX;
4390 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4391 bool includeall, string & result_file) const
4393 LYXERR(Debug::FILES, "target=" << target);
4394 OutputParams runparams(¶ms().encoding());
4395 string format = target;
4396 string dest_filename;
4397 size_t pos = target.find(' ');
4398 if (pos != string::npos) {
4399 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4400 format = target.substr(0, pos);
4401 if (format == "default")
4402 format = params().getDefaultOutputFormat();
4403 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4404 FileName(dest_filename).onlyPath().createPath();
4405 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4407 MarkAsExporting exporting(this);
4408 string backend_format;
4409 runparams.flavor = Flavor::LaTeX;
4410 runparams.linelen = lyxrc.plaintext_linelen;
4411 runparams.includeall = includeall;
4412 vector<string> backs = params().backends();
4413 Converters converters = theConverters();
4414 bool need_nice_file = false;
4415 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4416 // Get the shortest path to format
4417 converters.buildGraph();
4418 Graph::EdgePath path;
4419 for (string const & sit : backs) {
4420 Graph::EdgePath p = converters.getPath(sit, format);
4421 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4422 backend_format = sit;
4427 if (!put_in_tempdir) {
4428 // Only show this alert if this is an export to a non-temporary
4429 // file (not for previewing).
4430 docstring s = bformat(_("No information for exporting the format %1$s."),
4431 translateIfPossible(theFormats().prettyName(format)));
4432 if (format == "pdf4")
4434 + bformat(_("Hint: use non-TeX fonts or set input encoding "
4435 " to '%1$s'"), from_utf8(encodings.fromLyXName("ascii")->guiName()));
4436 Alert::error(_("Couldn't export file"), s);
4438 return ExportNoPathToFormat;
4440 runparams.flavor = converters.getFlavor(path, this);
4441 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4442 for (auto const & edge : path)
4443 if (theConverters().get(edge).nice()) {
4444 need_nice_file = true;
4449 backend_format = format;
4450 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4451 // FIXME: Don't hardcode format names here, but use a flag
4452 if (backend_format == "pdflatex")
4453 runparams.flavor = Flavor::PdfLaTeX;
4454 else if (backend_format == "luatex")
4455 runparams.flavor = Flavor::LuaTeX;
4456 else if (backend_format == "dviluatex")
4457 runparams.flavor = Flavor::DviLuaTeX;
4458 else if (backend_format == "xetex")
4459 runparams.flavor = Flavor::XeTeX;
4462 string filename = latexName(false);
4463 filename = addName(temppath(), filename);
4464 filename = changeExtension(filename,
4465 theFormats().extension(backend_format));
4466 LYXERR(Debug::FILES, "filename=" << filename);
4468 // Plain text backend
4469 if (backend_format == "text") {
4470 runparams.flavor = Flavor::Text;
4472 writePlaintextFile(*this, FileName(filename), runparams);
4474 catch (ConversionException const &) { return ExportCancel; }
4477 else if (backend_format == "xhtml") {
4478 runparams.flavor = Flavor::Html;
4479 setMathFlavor(runparams);
4480 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4481 return ExportKilled;
4482 } else if (backend_format == "lyx")
4483 writeFile(FileName(filename));
4485 else if (backend_format == "docbook5") {
4486 runparams.flavor = Flavor::DocBook5;
4487 runparams.nice = false;
4488 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4489 return ExportKilled;
4492 else if (backend_format == format || need_nice_file) {
4493 runparams.nice = true;
4494 ExportStatus const retval =
4495 makeLaTeXFile(FileName(filename), string(), runparams);
4496 if (retval == ExportKilled)
4497 return ExportKilled;
4498 if (d->cloned_buffer_)
4499 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4500 if (retval != ExportSuccess)
4502 } else if (!lyxrc.tex_allows_spaces
4503 && contains(filePath(), ' ')) {
4504 Alert::error(_("File name error"),
4505 bformat(_("The directory path to the document\n%1$s\n"
4506 "contains spaces, but your TeX installation does "
4507 "not allow them. You should save the file to a directory "
4508 "whose name does not contain spaces."), from_utf8(filePath())));
4509 return ExportTexPathHasSpaces;
4511 runparams.nice = false;
4512 ExportStatus const retval =
4513 makeLaTeXFile(FileName(filename), filePath(), runparams);
4514 if (retval == ExportKilled)
4515 return ExportKilled;
4516 if (d->cloned_buffer_)
4517 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4518 if (retval != ExportSuccess)
4522 string const error_type = (format == "program")
4523 ? "Build" : params().bufferFormat();
4524 ErrorList & error_list = d->errorLists[error_type];
4525 string const ext = theFormats().extension(format);
4526 FileName const tmp_result_file(changeExtension(filename, ext));
4527 Converters::RetVal const retval =
4528 converters.convert(this, FileName(filename), tmp_result_file,
4529 FileName(absFileName()), backend_format, format,
4530 error_list, Converters::none, includeall);
4531 if (retval == Converters::KILLED)
4532 return ExportCancel;
4533 bool success = (retval == Converters::SUCCESS);
4535 // Emit the signal to show the error list or copy it back to the
4536 // cloned Buffer so that it can be emitted afterwards.
4537 if (format != backend_format) {
4538 if (runparams.silent)
4540 else if (d->cloned_buffer_)
4541 d->cloned_buffer_->d->errorLists[error_type] =
4542 d->errorLists[error_type];
4545 // also to the children, in case of master-buffer-view
4546 ListOfBuffers clist = getDescendants();
4547 for (auto const & bit : clist) {
4548 if (runparams.silent)
4549 bit->d->errorLists[error_type].clear();
4550 else if (d->cloned_buffer_) {
4551 // Enable reverse search by copying back the
4552 // texrow object to the cloned buffer.
4553 // FIXME: this is not thread safe.
4554 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4555 bit->d->cloned_buffer_->d->errorLists[error_type] =
4556 bit->d->errorLists[error_type];
4558 bit->errors(error_type, true);
4562 if (d->cloned_buffer_) {
4563 // Enable reverse dvi or pdf to work by copying back the texrow
4564 // object to the cloned buffer.
4565 // FIXME: There is a possibility of concurrent access to texrow
4566 // here from the main GUI thread that should be securized.
4567 d->cloned_buffer_->d->texrow = d->texrow;
4568 string const err_type = params().bufferFormat();
4569 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4573 if (put_in_tempdir) {
4574 result_file = tmp_result_file.absFileName();
4575 return success ? ExportSuccess : ExportConverterError;
4578 if (dest_filename.empty())
4579 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4581 result_file = dest_filename;
4582 // We need to copy referenced files (e.g. included graphics
4583 // if format == "dvi") to the result dir.
4584 vector<ExportedFile> const extfiles =
4585 runparams.exportdata->externalFiles(format);
4586 string const dest = runparams.export_folder.empty() ?
4587 onlyPath(result_file) : runparams.export_folder;
4588 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4589 : force_overwrite == ALL_FILES;
4590 CopyStatus status = use_force ? FORCE : SUCCESS;
4592 for (ExportedFile const & exp : extfiles) {
4593 if (status == CANCEL) {
4594 message(_("Document export cancelled."));
4595 return ExportCancel;
4597 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4598 string fixedName = exp.exportName;
4599 if (!runparams.export_folder.empty()) {
4600 // Relative pathnames starting with ../ will be sanitized
4601 // if exporting to a different folder
4602 while (fixedName.substr(0, 3) == "../")
4603 fixedName = fixedName.substr(3, fixedName.length() - 3);
4605 FileName fixedFileName = makeAbsPath(fixedName, dest);
4606 fixedFileName.onlyPath().createPath();
4607 status = copyFile(fmt, exp.sourceName,
4609 exp.exportName, status == FORCE,
4610 runparams.export_folder.empty());
4614 if (tmp_result_file.exists()) {
4615 // Finally copy the main file
4616 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4617 : force_overwrite != NO_FILES;
4618 if (status == SUCCESS && use_force)
4620 status = copyFile(format, tmp_result_file,
4621 FileName(result_file), result_file,
4623 if (status == CANCEL) {
4624 message(_("Document export cancelled."));
4625 return ExportCancel;
4627 message(bformat(_("Document exported as %1$s "
4629 translateIfPossible(theFormats().prettyName(format)),
4630 makeDisplayPath(result_file)));
4633 // This must be a dummy converter like fax (bug 1888)
4634 message(bformat(_("Document exported as %1$s"),
4635 translateIfPossible(theFormats().prettyName(format))));
4638 return success ? ExportSuccess : ExportConverterError;
4642 Buffer::ExportStatus Buffer::preview(string const & format) const
4644 bool const update_unincluded =
4645 params().maintain_unincluded_children != BufferParams::CM_None
4646 && !params().getIncludedChildren().empty();
4647 return preview(format, update_unincluded);
4651 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4653 MarkAsExporting exporting(this);
4655 // (1) export with all included children (omit \includeonly)
4657 ExportStatus const status = doExport(format, true, true, result_file);
4658 if (status != ExportSuccess)
4661 // (2) export with included children only
4662 ExportStatus const status = doExport(format, true, false, result_file);
4663 FileName const previewFile(result_file);
4665 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4666 theimpl->preview_file_ = previewFile;
4667 theimpl->preview_format_ = format;
4668 theimpl->require_fresh_start_ = (status != ExportSuccess);
4670 if (status != ExportSuccess)
4673 if (previewFile.exists())
4674 return theFormats().view(*this, previewFile, format) ?
4675 PreviewSuccess : PreviewError;
4677 // Successful export but no output file?
4678 // Probably a bug in error detection.
4679 LATTEST(status != ExportSuccess);
4684 Buffer::ReadStatus Buffer::extractFromVC()
4686 bool const found = LyXVC::file_not_found_hook(d->filename);
4688 return ReadFileNotFound;
4689 if (!d->filename.isReadableFile())
4695 Buffer::ReadStatus Buffer::loadEmergency()
4697 FileName const emergencyFile = getEmergencyFileName();
4698 if (!emergencyFile.exists()
4699 || emergencyFile.lastModified() <= d->filename.lastModified())
4700 return ReadFileNotFound;
4702 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4703 docstring const text = bformat(_("An emergency save of the document "
4704 "%1$s exists.\n\nRecover emergency save?"), file);
4706 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4707 0, 3, _("&Recover"), _("&Load Original"), _("&Only show difference"), _("&Cancel"));
4713 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4714 bool const success = (ret_llf == ReadSuccess);
4716 if (hasReadonlyFlag()) {
4717 Alert::warning(_("File is read-only"),
4718 bformat(_("An emergency file is successfully loaded, "
4719 "but the original file %1$s is marked read-only. "
4720 "Please make sure to save the document as a different "
4721 "file."), from_utf8(d->filename.absFileName())));
4724 lyxvc().file_found_hook(d->filename);
4725 str = _("Document was successfully recovered.");
4727 str = _("Document was NOT successfully recovered.");
4728 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4729 makeDisplayPath(emergencyFile.absFileName()));
4731 int const del_emerg =
4732 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4733 _("&Remove"), _("&Keep"));
4734 if (del_emerg == 0) {
4735 emergencyFile.removeFile();
4737 Alert::warning(_("Emergency file deleted"),
4738 _("Do not forget to save your file now!"), true);
4740 return success ? ReadSuccess : ReadEmergencyFailure;
4743 int const del_emerg =
4744 Alert::prompt(_("Delete emergency file?"),
4745 _("Remove emergency file now?"), 1, 1,
4746 _("&Remove"), _("&Keep"));
4748 emergencyFile.removeFile();
4752 string const ename = emergencyFile.absFileName();
4754 // Surely we can find one in 100 tries?
4755 for (int i = 1; i < 100; ++i) {
4756 newname.set(ename + to_string(i) + ".lyx");
4757 if (!newname.exists()) {
4763 // renameTo returns true on success. So inverting that
4764 // will give us true if we fail.
4765 noname = !emergencyFile.renameTo(newname);
4768 Alert::warning(_("Can't rename emergency file!"),
4769 _("LyX was unable to rename the emergency file. "
4770 "You should do so manually. Otherwise, you will be "
4771 "asked about it again the next time you try to load "
4772 "this file, and may over-write your own work."));
4774 Alert::warning(_("Emergency File Renames"),
4775 bformat(_("Emergency file renamed as:\n %1$s"),
4776 from_utf8(newname.onlyFileName())));
4779 return ReadOriginal;
4783 string const f1 = d->filename.absFileName();
4784 string const f2 = emergencyFile.absFileName();
4785 if (loadThisLyXFile(d->filename) != ReadSuccess)
4787 string const par = "compare run-blocking " + quoteName(f1) + " " + quoteName(f2);
4788 LYXERR(Debug::FILES, par << "\n");
4789 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, par));
4791 //release the emergency buffer loaded by compare
4792 Buffer * emerBuffer = theBufferList().getBuffer(emergencyFile);
4794 theBufferList().release(emerBuffer);
4796 return ReadCancel; //Release the buffer of Original immediatelly
4805 Buffer::ReadStatus Buffer::loadAutosave()
4807 // Now check if autosave file is newer.
4808 FileName const autosaveFile = getAutosaveFileName();
4809 if (!autosaveFile.exists()
4810 || autosaveFile.lastModified() <= d->filename.lastModified())
4811 return ReadFileNotFound;
4813 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4814 docstring const text = bformat(_("The backup of the document %1$s "
4815 "is newer.\n\nLoad the backup instead?"), file);
4816 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4817 _("&Load backup"), _("Load &original"), _("&Cancel"));
4822 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4823 // the file is not saved if we load the autosave file.
4824 if (ret_llf == ReadSuccess) {
4825 if (hasReadonlyFlag()) {
4826 Alert::warning(_("File is read-only"),
4827 bformat(_("A backup file is successfully loaded, "
4828 "but the original file %1$s is marked read-only. "
4829 "Please make sure to save the document as a "
4831 from_utf8(d->filename.absFileName())));
4834 lyxvc().file_found_hook(d->filename);
4837 return ReadAutosaveFailure;
4840 // Here we delete the autosave
4841 autosaveFile.removeFile();
4842 return ReadOriginal;
4850 Buffer::ReadStatus Buffer::loadLyXFile()
4852 if (!d->filename.isReadableFile()) {
4853 ReadStatus const ret_rvc = extractFromVC();
4854 if (ret_rvc != ReadSuccess)
4858 ReadStatus const ret_re = loadEmergency();
4859 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4862 ReadStatus const ret_ra = loadAutosave();
4863 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4866 return loadThisLyXFile(d->filename);
4870 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4872 return readFile(fn);
4876 void Buffer::Impl::traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const
4878 for (; err != end; ++err) {
4879 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4880 int errorRow = err->error_in_line;
4881 Buffer const * buf = nullptr;
4882 Impl const * p = this;
4883 if (err->child_name.empty())
4884 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4886 // The error occurred in a child
4887 for (Buffer const * child : owner_->getDescendants()) {
4888 string const child_name =
4889 DocFileName(changeExtension(child->absFileName(), "tex")).
4891 if (err->child_name != child_name)
4893 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4894 if (!TexRow::isNone(start)) {
4895 buf = this->cloned_buffer_
4896 ? child->d->cloned_buffer_->d->owner_
4903 errorList.push_back(ErrorItem(err->error_desc, err->error_text,
4909 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4911 TeXErrors::Errors::const_iterator err = terr.begin();
4912 TeXErrors::Errors::const_iterator end = terr.end();
4914 d->traverseErrors(err, end, errorList);
4918 void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const
4920 TeXErrors::Errors::const_iterator err = terr.begin_ref();
4921 TeXErrors::Errors::const_iterator end = terr.end_ref();
4923 d->traverseErrors(err, end, errorList);
4927 void Buffer::updateBuffer() const
4929 updateBuffer(UpdateMaster, InternalUpdate);
4930 d->need_update = false;
4934 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4936 LBUFERR(!text().paragraphs().empty());
4938 // This can be called when loading a file, so that there be no
4940 UndoGroupHelper ugh(const_cast<Buffer *>(this));
4942 // Use the master text class also for child documents
4943 Buffer const * const master = masterBuffer();
4944 DocumentClass const & textclass = master->params().documentClass();
4946 docstring_list old_bibfiles;
4947 // Do this only if we are the top-level Buffer. We also need to account
4948 // for the case of a previewed child with ignored parent here.
4949 if (master == this && !d->ignore_parent) {
4950 textclass.counters().reset(from_ascii("bibitem"));
4951 reloadBibInfoCache();
4952 // we will re-read this cache as we go through, but we need
4953 // to know whether it's changed to know whether we need to
4954 // update the bibinfo cache.
4955 old_bibfiles = d->bibfiles_cache_;
4956 d->bibfiles_cache_.clear();
4959 // keep the buffers to be children in this set. If the call from the
4960 // master comes back we can see which of them were actually seen (i.e.
4961 // via an InsetInclude). The remaining ones in the set need still be updated.
4962 static std::set<Buffer const *> bufToUpdate;
4963 if (scope == UpdateMaster) {
4964 // If this is a child document start with the master
4965 if (master != this) {
4966 bufToUpdate.insert(this);
4967 master->updateBuffer(UpdateMaster, utype);
4968 // If the master buffer has no gui associated with it, then the TocModel is
4969 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4970 // (bug 5699). The same happens if the master buffer is open in a different
4971 // window. This test catches both possibilities.
4972 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
4973 // There remains a problem here: If there is another child open in yet a third
4974 // window, that TOC is not updated. So some more general solution is needed at
4976 if (master->d->gui_ != d->gui_)
4979 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4980 if (bufToUpdate.find(this) == bufToUpdate.end())
4984 // start over the counters in the master
4985 textclass.counters().reset();
4988 // update will be done below for this buffer
4989 bufToUpdate.erase(this);
4991 // update all caches
4992 clearReferenceCache();
4995 Buffer & cbuf = const_cast<Buffer &>(*this);
4996 // if we are reloading, then we could have a dangling TOC,
4997 // in effect. so we need to go ahead and reset, even though
4998 // we will do so again when we rebuild the TOC later.
4999 cbuf.tocBackend().reset();
5002 ParIterator parit = cbuf.par_iterator_begin();
5003 if (scope == UpdateMaster)
5005 updateBuffer(parit, utype);
5007 // If this document has siblings, then update the TocBackend later. The
5008 // reason is to ensure that later siblings are up to date when e.g. the
5009 // broken or not status of references is computed. The update is called
5010 // in InsetInclude::addToToc.
5014 // if the bibfiles changed, the cache of bibinfo is invalid
5015 docstring_list new_bibfiles = d->bibfiles_cache_;
5016 // this is a trick to determine whether the two vectors have
5017 // the same elements.
5018 sort(new_bibfiles.begin(), new_bibfiles.end());
5019 sort(old_bibfiles.begin(), old_bibfiles.end());
5020 if (old_bibfiles != new_bibfiles) {
5021 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
5022 invalidateBibinfoCache();
5023 reloadBibInfoCache();
5024 // We relied upon the bibinfo cache when recalculating labels. But that
5025 // cache was invalid, although we didn't find that out until now. So we
5026 // have to do it all again.
5027 // That said, the only thing we really need to do is update the citation
5028 // labels. Nothing else will have changed. So we could create a new
5029 // UpdateType that would signal that fact, if we needed to do so.
5030 parit = cbuf.par_iterator_begin();
5031 // we will be re-doing the counters and references and such.
5032 textclass.counters().reset();
5033 clearReferenceCache();
5034 // we should not need to do this again?
5036 updateBuffer(parit, utype);
5037 // this will already have been done by reloadBibInfoCache();
5038 // d->bibinfo_cache_valid_ = true;
5041 LYXERR(Debug::FILES, "Bibfiles unchanged.");
5042 // this is also set to true on the other path, by reloadBibInfoCache.
5043 d->bibinfo_cache_valid_ = true;
5045 d->cite_labels_valid_ = true;
5048 cbuf.tocBackend().update(true, utype);
5049 if (scope == UpdateMaster)
5050 cbuf.structureChanged();
5052 d->need_update = false;
5056 static depth_type getDepth(DocIterator const & it)
5058 depth_type depth = 0;
5059 for (size_t i = 0 ; i < it.depth() ; ++i)
5060 if (!it[i].inset().inMathed())
5061 depth += it[i].paragraph().getDepth() + 1;
5062 // remove 1 since the outer inset does not count
5063 // we should have at least one non-math inset, so
5064 // depth should nevery be 0. but maybe it is worth
5065 // marking this, just in case.
5067 // coverity[INTEGER_OVERFLOW]
5071 static depth_type getItemDepth(ParIterator const & it)
5073 Paragraph const & par = *it;
5074 LabelType const labeltype = par.layout().labeltype;
5076 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5079 // this will hold the lowest depth encountered up to now.
5080 depth_type min_depth = getDepth(it);
5081 ParIterator prev_it = it;
5084 --prev_it.top().pit();
5086 // start of nested inset: go to outer par
5088 if (prev_it.empty()) {
5089 // start of document: nothing to do
5094 // We search for the first paragraph with same label
5095 // that is not more deeply nested.
5096 Paragraph & prev_par = *prev_it;
5097 depth_type const prev_depth = getDepth(prev_it);
5098 if (labeltype == prev_par.layout().labeltype) {
5099 if (prev_depth < min_depth)
5100 return prev_par.itemdepth + 1;
5101 if (prev_depth == min_depth)
5102 return prev_par.itemdepth;
5104 min_depth = min(min_depth, prev_depth);
5105 // small optimization: if we are at depth 0, we won't
5106 // find anything else
5107 if (prev_depth == 0)
5113 static bool needEnumCounterReset(ParIterator const & it)
5115 Paragraph const & par = *it;
5116 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5117 depth_type const cur_depth = par.getDepth();
5118 ParIterator prev_it = it;
5119 while (prev_it.pit()) {
5120 --prev_it.top().pit();
5121 Paragraph const & prev_par = *prev_it;
5122 if (prev_par.getDepth() <= cur_depth)
5123 return prev_par.layout().name() != par.layout().name();
5125 // start of nested inset: reset
5130 // set the label of a paragraph. This includes the counters.
5131 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5133 BufferParams const & bp = owner_->masterBuffer()->params();
5134 DocumentClass const & textclass = bp.documentClass();
5135 Paragraph & par = it.paragraph();
5136 Layout const & layout = par.layout();
5137 Counters & counters = textclass.counters();
5139 if (par.params().startOfAppendix()) {
5140 // We want to reset the counter corresponding to toplevel sectioning
5141 Layout const & lay = textclass.getTOCLayout();
5142 docstring const cnt = lay.counter;
5144 counters.reset(cnt);
5145 counters.appendix(true);
5147 par.params().appendix(counters.appendix());
5149 // Compute the item depth of the paragraph
5150 par.itemdepth = getItemDepth(it);
5152 if (layout.margintype == MARGIN_MANUAL) {
5153 if (par.params().labelWidthString().empty())
5154 par.params().labelWidthString(par.expandLabel(layout, bp));
5155 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5156 // we do not need to do anything here, since the empty case is
5157 // handled during export.
5159 par.params().labelWidthString(docstring());
5162 switch(layout.labeltype) {
5163 case LABEL_ITEMIZE: {
5164 par.params().labelString(
5166 ? bp.user_defined_bullet(par.itemdepth).getLabel()
5167 // Display fallback for too deeply nested items
5168 : bformat(from_ascii("[?%1$d]"), int(par.itemdepth + 1)));
5172 case LABEL_ENUMERATE: {
5173 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5175 switch (par.itemdepth) {
5186 enumcounter += "iv";
5189 // not a valid enumdepth...
5193 if (needEnumCounterReset(it)) {
5194 // Increase the parent counter?
5195 if (layout.stepparentcounter)
5196 counters.stepParent(enumcounter, utype);
5197 // Maybe we have to reset the enumeration counter.
5198 if (!layout.resumecounter)
5199 counters.reset(enumcounter);
5201 counters.step(enumcounter, utype);
5203 string const & lang = par.getParLanguage(bp)->code();
5204 par.params().labelString(counters.theCounter(enumcounter, lang));
5209 case LABEL_SENSITIVE: {
5210 string const & type = counters.current_float();
5211 docstring full_label;
5213 full_label = owner_->B_("Senseless!!! ");
5215 docstring name = owner_->B_(textclass.floats().getType(type).name());
5216 if (counters.hasCounter(from_utf8(type))) {
5217 string const & lang = par.getParLanguage(bp)->code();
5218 counters.step(from_utf8(type), utype);
5219 full_label = bformat(from_ascii("%1$s %2$s:"),
5221 counters.theCounter(from_utf8(type), lang));
5223 full_label = bformat(from_ascii("%1$s #:"), name);
5225 par.params().labelString(full_label);
5229 case LABEL_NO_LABEL:
5230 par.params().labelString(docstring());
5234 case LABEL_CENTERED:
5235 case LABEL_STATIC: {
5236 docstring const & lcounter = layout.counter;
5237 if (!lcounter.empty()) {
5238 if (layout.toclevel <= bp.secnumdepth
5239 && (layout.latextype != LATEX_ENVIRONMENT
5240 || it.text()->isFirstInSequence(it.pit()))) {
5241 if (counters.hasCounter(lcounter))
5242 counters.step(lcounter, utype);
5243 par.params().labelString(par.expandLabel(layout, bp));
5245 par.params().labelString(docstring());
5247 par.params().labelString(par.expandLabel(layout, bp));
5253 par.params().labelString(par.expandLabel(layout, bp));
5258 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype, bool const deleted) const
5260 pushIncludedBuffer(this);
5261 // LASSERT: Is it safe to continue here, or should we just return?
5262 LASSERT(parit.pit() == 0, /**/);
5264 // Set the position of the text in the buffer to be able
5265 // to resolve macros in it.
5266 parit.text()->setMacrocontextPosition(parit);
5268 depth_type maxdepth = 0;
5269 pit_type const lastpit = parit.lastpit();
5270 bool changed = false;
5271 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5272 // reduce depth if necessary
5273 if (parit->params().depth() > maxdepth) {
5274 /** FIXME: this function is const, but
5275 * nevertheless it modifies the buffer. To be
5276 * cleaner, one should modify the buffer in
5277 * another function, which is actually
5278 * non-const. This would however be costly in
5279 * terms of code duplication.
5281 CursorData(parit).recordUndo();
5282 parit->params().depth(maxdepth);
5284 maxdepth = parit->getMaxDepthAfter();
5286 if (utype == OutputUpdate) {
5287 // track the active counters
5288 // we have to do this for the master buffer, since the local
5289 // buffer isn't tracking anything.
5290 masterBuffer()->params().documentClass().counters().
5291 setActiveLayout(parit->layout());
5294 // set the counter for this paragraph
5295 d->setLabel(parit, utype);
5298 for (auto const & insit : parit->insetList()) {
5299 parit.pos() = insit.pos;
5300 insit.inset->updateBuffer(parit, utype, deleted || parit->isDeleted(insit.pos));
5301 changed |= insit.inset->isChanged();
5304 // are there changes in this paragraph?
5305 changed |= parit->isChanged();
5308 // set change indicator for the inset (or the cell that the iterator
5309 // points to, if applicable).
5310 parit.text()->inset().isChanged(changed);
5311 popIncludedBuffer();
5315 void Buffer::forceUpdate() const
5317 d->need_update = true;
5321 bool Buffer::needUpdate() const
5323 return d->need_update;
5327 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5328 WordLangTuple & word_lang, docstring_list & suggestions) const
5332 suggestions.clear();
5333 word_lang = WordLangTuple();
5334 bool const to_end = to.empty();
5335 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5336 // OK, we start from here.
5337 for (; from != end; from.forwardPos()) {
5338 // This skips all insets with spell check disabled.
5339 while (!from.allowSpellCheck()) {
5343 // If from is at the end of the document (which is possible
5344 // when "from" was changed above) LyX will crash later otherwise.
5345 if (from.atEnd() || (!to_end && from >= end))
5348 from.paragraph().spellCheck();
5349 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5350 if (SpellChecker::misspelled(res)) {
5354 // Do not increase progress when from == to, otherwise the word
5355 // count will be wrong.
5365 void Buffer::requestSpellcheck()
5367 ParagraphList::iterator pit = paragraphs().begin();
5368 ParagraphList::iterator pend = paragraphs().end();
5369 for (; pit != pend; ++pit)
5370 pit->requestSpellCheck();
5374 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5376 bool inword = false;
5381 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5382 if (!dit.inTexted()) {
5387 Paragraph const & par = dit.paragraph();
5388 pos_type const pos = dit.pos();
5390 // Copied and adapted from isWordSeparator() in Paragraph
5391 if (pos == dit.lastpos()) {
5394 Inset const * ins = par.getInset(pos);
5395 if (ins && skipNoOutput && !ins->producesOutput()) {
5398 // stop if end of range was skipped
5399 if (!to.atEnd() && dit >= to)
5402 } else if (!par.isDeleted(pos)) {
5403 if (par.isWordSeparator(pos))
5409 if (ins && ins->isLetter()) {
5410 odocstringstream os;
5412 char_count_ += os.str().length();
5414 else if (ins && ins->isSpace())
5417 pair<int, int> words = ins->isWords();
5418 char_count_ += words.first;
5419 word_count_ += words.second;
5423 char_type const c = par.getChar(pos);
5424 if (isPrintableNonspace(c))
5426 else if (isSpace(c))
5436 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5438 d->updateStatistics(from, to, skipNoOutput);
5442 int Buffer::wordCount() const
5444 return d->wordCount();
5448 int Buffer::charCount(bool with_blanks) const
5450 return d->charCount(with_blanks);
5454 bool Buffer::areChangesPresent() const
5456 return inset().isChanged();
5460 Buffer::ReadStatus Buffer::reload()
5463 // c.f. bug https://www.lyx.org/trac/ticket/6587
5464 removeAutosaveFile();
5465 // e.g., read-only status could have changed due to version control
5466 d->filename.refresh();
5467 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5469 // clear parent. this will get reset if need be.
5470 d->setParent(nullptr);
5471 ReadStatus const status = loadLyXFile();
5472 if (status == ReadSuccess) {
5477 message(bformat(_("Document %1$s reloaded."), disp_fn));
5480 message(bformat(_("Could not reload document %1$s."), disp_fn));
5490 bool Buffer::saveAs(FileName const & fn)
5492 FileName const old_name = fileName();
5493 FileName const old_auto = getAutosaveFileName();
5494 bool const old_unnamed = isUnnamed();
5495 bool success = true;
5496 d->old_position = filePath();
5503 // bring the autosave file with us, just in case.
5504 moveAutosaveFile(old_auto);
5505 // validate version control data and
5506 // correct buffer title
5507 lyxvc().file_found_hook(fileName());
5509 // the file has now been saved to the new location.
5510 // we need to check that the locations of child buffers
5512 checkChildBuffers();
5513 checkMasterBuffer();
5516 // reset the old filename and unnamed state
5517 setFileName(old_name);
5518 setUnnamed(old_unnamed);
5522 d->old_position.clear();
5527 void Buffer::checkChildBuffers()
5529 for (auto const & bit : d->children_positions) {
5530 DocIterator dit = bit.second;
5531 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5532 if (!cbuf || !theBufferList().isLoaded(cbuf))
5534 Inset * inset = dit.nextInset();
5535 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5536 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5537 docstring const & incfile = inset_inc->getParam("filename");
5538 string oldloc = cbuf->absFileName();
5539 string newloc = makeAbsPath(to_utf8(incfile),
5540 onlyPath(absFileName())).absFileName();
5541 if (oldloc == newloc)
5543 // the location of the child file is incorrect.
5544 cbuf->setParent(nullptr);
5545 inset_inc->setChildBuffer(nullptr);
5547 // invalidate cache of children
5548 d->children_positions.clear();
5549 d->position_to_children.clear();
5553 // If a child has been saved under a different name/path, it might have been
5554 // orphaned. Therefore the master needs to be reset (bug 8161).
5555 void Buffer::checkMasterBuffer()
5557 Buffer const * const master = masterBuffer();
5561 // necessary to re-register the child (bug 5873)
5562 // FIXME: clean up updateMacros (here, only
5563 // child registering is needed).
5564 master->updateMacros();
5565 // (re)set master as master buffer, but only
5566 // if we are a real child
5567 if (master->isChild(this))
5574 string Buffer::includedFilePath(string const & name, string const & ext) const
5576 if (d->old_position.empty() ||
5577 equivalent(FileName(d->old_position), FileName(filePath())))
5580 bool isabsolute = FileName::isAbsolute(name);
5581 // both old_position and filePath() end with a path separator
5582 string absname = isabsolute ? name : d->old_position + name;
5584 // if old_position is set to origin, we need to do the equivalent of
5585 // getReferencedFileName() (see readDocument())
5586 if (!isabsolute && d->old_position == params().origin) {
5587 FileName const test(addExtension(filePath() + name, ext));
5589 absname = filePath() + name;
5592 if (!FileName(addExtension(absname, ext)).exists())
5596 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5598 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5599 from_utf8(filePath())));
5603 void Buffer::Impl::refreshFileMonitor()
5605 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5606 file_monitor_->refresh();
5610 // The previous file monitor is invalid
5611 // This also destroys the previous file monitor and all its connections
5612 file_monitor_ = FileSystemWatcher::monitor(filename);
5613 // file_monitor_ will be destroyed with *this, so it is not going to call a
5614 // destroyed object method.
5615 file_monitor_->connect([this](bool exists) {
5616 fileExternallyModified(exists);
5621 void Buffer::Impl::fileExternallyModified(bool const exists)
5623 // ignore notifications after our own saving operations
5624 if (checksum_ == filename.checksum()) {
5625 LYXERR(Debug::FILES, "External modification but "
5626 "checksum unchanged: " << filename);
5629 // If the file has been deleted, only mark the file as dirty since it is
5630 // pointless to prompt for reloading. If later a file is moved into this
5631 // location, then the externally modified warning will appear then.
5633 externally_modified_ = true;
5634 // Update external modification notification.
5635 // Dirty buffers must be visible at all times.
5636 if (wa_ && wa_->unhide(owner_))
5637 wa_->updateTitles();
5639 // Unable to unhide the buffer (e.g. no GUI or not current View)
5644 bool Buffer::notifiesExternalModification() const
5646 return d->externally_modified_;
5650 void Buffer::clearExternalModification() const
5652 d->externally_modified_ = false;
5654 d->wa_->updateTitles();
5658 void Buffer::pushIncludedBuffer(Buffer const * buf) const
5660 masterBuffer()->d->include_list_.push_back(buf);
5661 if (lyxerr.debugging(Debug::FILES)) {
5662 LYXERR0("Pushed. Stack now:");
5663 if (masterBuffer()->d->include_list_.empty())
5666 for (auto const & b : masterBuffer()->d->include_list_)
5667 LYXERR0(b->fileName());
5672 void Buffer::popIncludedBuffer() const
5674 masterBuffer()->d->include_list_.pop_back();
5675 if (lyxerr.debugging(Debug::FILES)) {
5676 LYXERR0("Popped. Stack now:");
5677 if (masterBuffer()->d->include_list_.empty())
5680 for (auto const & b : masterBuffer()->d->include_list_)
5681 LYXERR0(b->fileName());
5686 bool Buffer::isBufferIncluded(Buffer const * buf) const
5690 if (lyxerr.debugging(Debug::FILES)) {
5691 LYXERR0("Checking for " << buf->fileName() << ". Stack now:");
5692 if (masterBuffer()->d->include_list_.empty())
5695 for (auto const & b : masterBuffer()->d->include_list_)
5696 LYXERR0(b->fileName());
5698 list<Buffer const *> const & blist = masterBuffer()->d->include_list_;
5699 return find(blist.begin(), blist.end(), buf) != blist.end();
5703 void Buffer::clearIncludeList() const
5705 LYXERR(Debug::FILES, "Clearing include list for " << fileName());
5706 d->include_list_.clear();