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::LATEX, "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::LATEX, " 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::LATEX, " 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::LATEX, "makeLaTeXFile...done");
2084 LYXERR(Debug::LATEX, "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::LATEX, "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 =
2110 writeDocBookSource(ofs, runparams, output);
2111 if (retval == ExportKilled)
2112 return ExportKilled;
2116 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2117 return ExportSuccess;
2121 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os,
2122 OutputParams const & runparams,
2123 OutputWhat output) const
2125 LaTeXFeatures features(*this, params(), runparams);
2127 d->bibinfo_.makeCitationLabels(*this);
2131 DocumentClass const & tclass = params().documentClass();
2133 bool const output_preamble =
2134 output == FullSource || output == OnlyPreamble;
2135 bool const output_body =
2136 output == FullSource || output == OnlyBody || output == IncludedFile;
2138 if (output_preamble) {
2139 // XML preamble, no doctype needed.
2140 // Not using XMLStream for this, as the root tag would be in the tag stack and make troubles with the error
2141 // detection mechanisms (these are called before the end tag is output, and thus interact with the canary
2142 // parsep in output_docbook.cpp).
2143 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2144 << "<!-- This DocBook file was created by LyX " << lyx_version
2145 << "\n See https://www.lyx.org/ for more information -->\n";
2147 // Prepare the name space declaration for MathML depending on document preferences.
2148 string mathmlNamespace;
2149 if (params().docbook_mathml_prefix != BufferParams::NoPrefix) {
2150 string mathmlPrefix;
2151 if (params().docbook_mathml_prefix == BufferParams::MPrefix)
2153 else if (params().docbook_mathml_prefix == BufferParams::MMLPrefix)
2154 mathmlPrefix = "mml";
2155 mathmlNamespace = + " xmlns:" + mathmlPrefix + "=\"http://www.w3.org/1998/Math/MathML\"";
2158 // Directly output the root tag, based on the current type of document.
2159 string languageCode = params().language->code();
2160 string params = "xml:lang=\"" + languageCode + '"'
2161 + " xmlns=\"http://docbook.org/ns/docbook\""
2162 + " xmlns:xlink=\"http://www.w3.org/1999/xlink\""
2164 + " xmlns:xi=\"http://www.w3.org/2001/XInclude\""
2165 + " version=\"5.2\"";
2167 os << "<" << from_ascii(tclass.docbookroot()) << " " << from_ascii(params) << ">\n";
2171 // Start to output the document.
2173 docbookParagraphs(text(), *this, xs, runparams);
2176 if (output_preamble) {
2177 // Close the root element. No need for a line break, as free text is never allowed
2178 // in a root element, it must always be wrapped in some container.
2179 os << "</" << from_ascii(tclass.docbookroot()) << ">";
2182 return ExportSuccess;
2186 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2187 OutputParams const & runparams) const
2189 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2192 if (!openFileWrite(ofs, fname))
2195 // make sure we are ready to export
2196 // this has to be done before we validate
2197 updateBuffer(UpdateMaster, OutputUpdate);
2198 updateMacroInstances(OutputUpdate);
2200 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2201 if (retval == ExportKilled)
2206 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2211 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2212 OutputParams const & runparams,
2213 OutputWhat output) const
2215 LaTeXFeatures features(*this, params(), runparams);
2217 d->bibinfo_.makeCitationLabels(*this);
2219 bool const output_preamble =
2220 output == FullSource || output == OnlyPreamble;
2221 bool const output_body =
2222 output == FullSource || output == OnlyBody || output == IncludedFile;
2224 if (output_preamble) {
2225 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2226 << "<!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"
2227 // FIXME Language should be set properly.
2228 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2230 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2231 // FIXME Presumably need to set this right
2232 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2234 docstring const & doctitle = features.htmlTitle();
2236 << (doctitle.empty() ?
2237 from_ascii("LyX Document") :
2238 xml::escapeString(doctitle, XMLStream::ESCAPE_ALL))
2241 docstring styles = features.getTClassHTMLPreamble();
2242 if (!styles.empty())
2243 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2245 // we will collect CSS information in a stream, and then output it
2246 // either here, as part of the header, or else in a separate file.
2247 odocstringstream css;
2248 styles = features.getCSSSnippets();
2249 if (!styles.empty())
2250 css << "/* LyX Provided Styles */\n" << styles << '\n';
2252 styles = features.getTClassHTMLStyles();
2253 if (!styles.empty())
2254 css << "/* Layout-provided Styles */\n" << styles << '\n';
2256 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2257 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2258 if (needfg || needbg) {
2259 css << "\nbody {\n";
2262 << from_ascii(X11hexname(params().fontcolor))
2265 css << " background-color: "
2266 << from_ascii(X11hexname(params().backgroundcolor))
2271 docstring const dstyles = css.str();
2272 if (!dstyles.empty()) {
2273 bool written = false;
2274 if (params().html_css_as_file) {
2275 // open a file for CSS info
2277 string const fcssname = addName(temppath(), "docstyle.css");
2278 FileName const fcssfile = FileName(fcssname);
2279 if (openFileWrite(ocss, fcssfile)) {
2283 // write link to header
2284 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2286 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2289 // we are here if the CSS is supposed to be written to the header
2290 // or if we failed to write it to an external file.
2292 os << "<style type='text/css'>\n"
2301 bool const output_body_tag = (output != IncludedFile);
2302 if (output_body_tag)
2303 os << "<body dir=\"auto\">\n";
2305 if (output != IncludedFile)
2306 // if we're an included file, the counters are in the master.
2307 params().documentClass().counters().reset();
2309 xhtmlParagraphs(text(), *this, xs, runparams);
2311 catch (ConversionException const &) { return ExportKilled; }
2312 if (output_body_tag)
2316 if (output_preamble)
2319 return ExportSuccess;
2323 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2324 // Other flags: -wall -v0 -x
2325 int Buffer::runChktex()
2329 // get LaTeX-Filename
2330 FileName const path(temppath());
2331 string const name = addName(path.absFileName(), latexName());
2332 string const org_path = filePath();
2334 PathChanger p(path); // path to LaTeX file
2335 message(_("Running chktex..."));
2337 // Generate the LaTeX file if neccessary
2338 OutputParams runparams(¶ms().encoding());
2339 runparams.flavor = Flavor::LaTeX;
2340 runparams.nice = false;
2341 runparams.linelen = lyxrc.plaintext_linelen;
2342 ExportStatus const retval =
2343 makeLaTeXFile(FileName(name), org_path, runparams);
2344 if (retval != ExportSuccess) {
2345 // error code on failure
2350 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2351 int const res = chktex.run(terr); // run chktex
2354 Alert::error(_("chktex failure"),
2355 _("Could not run chktex successfully."));
2357 ErrorList & errlist = d->errorLists["ChkTeX"];
2359 bufferErrors(terr, errlist);
2364 if (runparams.silent)
2365 d->errorLists["ChkTeX"].clear();
2373 void Buffer::validate(LaTeXFeatures & features) const
2375 // Validate the buffer params, but not for included
2376 // files, since they also use the parent buffer's
2378 if (!features.runparams().is_child)
2379 params().validate(features);
2384 for (Paragraph const & p : paragraphs())
2385 p.validate(features);
2387 if (lyxerr.debugging(Debug::LATEX)) {
2388 features.showStruct();
2393 void Buffer::getLabelList(vector<docstring> & list) const
2395 // If this is a child document, use the master's list instead.
2397 masterBuffer()->getLabelList(list);
2402 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2403 for (auto const & tocit : *toc) {
2404 if (tocit.depth() == 0)
2405 list.push_back(tocit.str());
2410 void Buffer::invalidateBibinfoCache() const
2412 d->bibinfo_cache_valid_ = false;
2413 d->cite_labels_valid_ = false;
2414 removeBiblioTempFiles();
2415 // also invalidate the cache for the parent buffer
2416 Buffer const * const pbuf = d->parent();
2418 pbuf->invalidateBibinfoCache();
2422 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2424 // FIXME This is probably unnecessary, given where we call this.
2425 // If this is a child document, use the master instead.
2426 Buffer const * const pbuf = masterBuffer();
2427 if (pbuf != this && scope != UpdateChildOnly)
2428 return pbuf->getBibfiles();
2430 // In 2.3.x, we have:
2431 //if (!d->bibfile_cache_valid_)
2432 // this->updateBibfilesCache(scope);
2433 // I think that is a leftover, but there have been so many back-
2434 // and-forths with this, due to Windows issues, that I am not sure.
2436 return d->bibfiles_cache_;
2440 BiblioInfo const & Buffer::masterBibInfo() const
2442 Buffer const * const tmp = masterBuffer();
2444 return tmp->masterBibInfo();
2449 BiblioInfo const & Buffer::bibInfo() const
2455 void Buffer::registerBibfiles(const docstring_list & bf) const
2457 // We register the bib files in the master buffer,
2458 // if there is one, but also in every single buffer,
2459 // in case a child is compiled alone.
2460 Buffer const * const tmp = masterBuffer();
2462 tmp->registerBibfiles(bf);
2464 for (auto const & p : bf) {
2465 docstring_list::const_iterator temp =
2466 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2467 if (temp == d->bibfiles_cache_.end())
2468 d->bibfiles_cache_.push_back(p);
2473 static map<docstring, FileName> bibfileCache;
2475 FileName Buffer::getBibfilePath(docstring const & bibid) const
2477 map<docstring, FileName>::const_iterator it =
2478 bibfileCache.find(bibid);
2479 if (it != bibfileCache.end()) {
2480 // i.e., return bibfileCache[bibid];
2484 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2485 string const texfile = changeExtension(to_utf8(bibid), "bib");
2486 // we need to check first if this file exists where it's said to be.
2487 // there's a weird bug that occurs otherwise: if the file is in the
2488 // Buffer's directory but has the same name as some file that would be
2489 // found by kpsewhich, then we find the latter, not the former.
2490 FileName const local_file = makeAbsPath(texfile, filePath());
2491 FileName file = local_file;
2492 if (!file.exists()) {
2493 // there's no need now to check whether the file can be found
2495 file = findtexfile(texfile, "bib", true);
2499 LYXERR(Debug::FILES, "Found at: " << file);
2501 bibfileCache[bibid] = file;
2502 return bibfileCache[bibid];
2506 void Buffer::checkIfBibInfoCacheIsValid() const
2508 // use the master's cache
2509 Buffer const * const tmp = masterBuffer();
2511 tmp->checkIfBibInfoCacheIsValid();
2515 // If we already know the cache is invalid, stop here.
2516 // This is important in the case when the bibliography
2517 // environment (rather than Bib[la]TeX) is used.
2518 // In that case, the timestamp check below gives no
2519 // sensible result. Rather than that, the cache will
2520 // be invalidated explicitly via invalidateBibInfoCache()
2521 // by the Bibitem inset.
2522 // Same applies for bib encoding changes, which trigger
2523 // invalidateBibInfoCache() by InsetBibtex.
2524 if (!d->bibinfo_cache_valid_)
2527 if (d->have_bibitems_) {
2528 // We have a bibliography environment.
2529 // Invalidate the bibinfo cache unconditionally.
2530 // Cite labels will get invalidated by the inset if needed.
2531 d->bibinfo_cache_valid_ = false;
2535 // OK. This is with Bib(la)tex. We'll assume the cache
2536 // is valid and change this if we find changes in the bibs.
2537 d->bibinfo_cache_valid_ = true;
2538 d->cite_labels_valid_ = true;
2540 // compare the cached timestamps with the actual ones.
2541 docstring_list const & bibfiles_cache = getBibfiles();
2542 for (auto const & bf : bibfiles_cache) {
2543 FileName const fn = getBibfilePath(bf);
2544 time_t lastw = fn.lastModified();
2545 time_t prevw = d->bibfile_status_[fn];
2546 if (lastw != prevw) {
2547 d->bibinfo_cache_valid_ = false;
2548 d->cite_labels_valid_ = false;
2549 d->bibfile_status_[fn] = lastw;
2555 void Buffer::clearBibFileCache() const
2557 bibfileCache.clear();
2561 void Buffer::reloadBibInfoCache(bool const force) const
2563 // we should not need to do this for internal buffers
2567 // use the master's cache
2568 Buffer const * const tmp = masterBuffer();
2570 tmp->reloadBibInfoCache(force);
2575 checkIfBibInfoCacheIsValid();
2576 if (d->bibinfo_cache_valid_)
2580 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2581 // re-read file locations when this info changes
2582 // FIXME Is this sufficient? Or should we also force that
2583 // in some other cases? If so, then it is easy enough to
2584 // add the following line in some other places.
2585 clearBibFileCache();
2586 d->bibinfo_.clear();
2587 FileNameList checkedFiles;
2588 d->have_bibitems_ = false;
2589 collectBibKeys(checkedFiles);
2590 d->bibinfo_cache_valid_ = true;
2594 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2599 for (InsetIterator it = begin(inset()); it; ++it) {
2600 it->collectBibKeys(it, checkedFiles);
2601 if (it->lyxCode() == BIBITEM_CODE) {
2602 if (parent() != nullptr)
2603 parent()->d->have_bibitems_ = true;
2605 d->have_bibitems_ = true;
2611 void Buffer::addBiblioInfo(BiblioInfo const & bi_in) const
2613 // We add the biblio info to the parent buffer,
2614 // if there is one, but also to this buffer, in case
2615 // it is compiled alone.
2616 BiblioInfo & our_bi = d->bibinfo_;
2617 our_bi.mergeBiblioInfo(bi_in);
2620 parent()->addBiblioInfo(bi_in);
2624 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2626 // We add the bibtex info to the master buffer,
2627 // if there is one, but also to every single buffer,
2628 // in case a child is compiled alone.
2629 BiblioInfo & bi = d->bibinfo_;
2632 if (parent() != nullptr) {
2633 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2634 masterbi[key] = bin;
2639 void Buffer::makeCitationLabels() const
2641 Buffer const * const master = masterBuffer();
2642 return d->bibinfo_.makeCitationLabels(*master);
2646 void Buffer::invalidateCiteLabels() const
2648 masterBuffer()->d->cite_labels_valid_ = false;
2651 bool Buffer::citeLabelsValid() const
2653 return masterBuffer()->d->cite_labels_valid_;
2657 void Buffer::removeBiblioTempFiles() const
2659 // We remove files that contain LaTeX commands specific to the
2660 // particular bibliographic style being used, in order to avoid
2661 // LaTeX errors when we switch style.
2662 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2663 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2664 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2665 aux_file.removeFile();
2666 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2667 bbl_file.removeFile();
2668 // Also for the parent buffer
2669 Buffer const * const pbuf = parent();
2671 pbuf->removeBiblioTempFiles();
2675 bool Buffer::isDepClean(string const & name) const
2677 DepClean::const_iterator const it = d->dep_clean.find(name);
2678 if (it == d->dep_clean.end())
2684 void Buffer::markDepClean(string const & name)
2686 d->dep_clean[name] = true;
2690 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2693 // FIXME? if there is an Buffer LFUN that can be dispatched even
2694 // if internal, put a switch '(cmd.action)' here.
2700 switch (cmd.action()) {
2702 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2703 flag.setOnOff(hasReadonlyFlag());
2706 // FIXME: There is need for a command-line import.
2707 //case LFUN_BUFFER_IMPORT:
2709 case LFUN_BUFFER_AUTO_SAVE:
2712 case LFUN_BUFFER_EXPORT_CUSTOM:
2713 // FIXME: Nothing to check here?
2716 case LFUN_BUFFER_EXPORT: {
2717 docstring const & arg = cmd.argument();
2718 if (arg == "custom") {
2722 string format = (arg.empty() || arg == "default") ?
2723 params().getDefaultOutputFormat() : to_utf8(arg);
2724 size_t pos = format.find(' ');
2725 if (pos != string::npos)
2726 format = format.substr(0, pos);
2727 enable = params().isExportable(format, false);
2729 flag.message(bformat(
2730 _("Don't know how to export to format: %1$s"), arg));
2734 case LFUN_BUILD_PROGRAM:
2735 enable = params().isExportable("program", false);
2738 case LFUN_BRANCH_ACTIVATE:
2739 case LFUN_BRANCH_DEACTIVATE:
2740 case LFUN_BRANCH_MASTER_ACTIVATE:
2741 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2742 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2743 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2744 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2745 : params().branchlist();
2746 docstring const & branchName = cmd.argument();
2747 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2751 case LFUN_BRANCH_ADD:
2752 case LFUN_BRANCHES_RENAME:
2753 // if no Buffer is present, then of course we won't be called!
2756 case LFUN_BUFFER_LANGUAGE:
2757 enable = !isReadonly();
2760 case LFUN_BUFFER_VIEW_CACHE:
2761 (d->preview_file_).refresh();
2762 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2765 case LFUN_CHANGES_TRACK:
2766 flag.setEnabled(true);
2767 flag.setOnOff(params().track_changes);
2770 case LFUN_CHANGES_OUTPUT:
2771 flag.setEnabled(true);
2772 flag.setOnOff(params().output_changes);
2775 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2776 flag.setOnOff(params().compressed);
2779 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2780 flag.setOnOff(params().output_sync);
2783 case LFUN_BUFFER_ANONYMIZE:
2789 flag.setEnabled(enable);
2794 void Buffer::dispatch(string const & command, DispatchResult & result)
2796 return dispatch(lyxaction.lookupFunc(command), result);
2800 // NOTE We can end up here even if we have no GUI, because we are called
2801 // by LyX::exec to handled command-line requests. So we may need to check
2802 // whether we have a GUI or not. The boolean use_gui holds this information.
2803 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2806 // FIXME? if there is an Buffer LFUN that can be dispatched even
2807 // if internal, put a switch '(cmd.action())' here.
2808 dr.dispatched(false);
2811 string const argument = to_utf8(func.argument());
2812 // We'll set this back to false if need be.
2813 bool dispatched = true;
2814 // This handles undo groups automagically
2815 UndoGroupHelper ugh(this);
2817 switch (func.action()) {
2818 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2819 if (lyxvc().inUse()) {
2820 string log = lyxvc().toggleReadOnly();
2825 setReadonly(!hasReadonlyFlag());
2828 case LFUN_BUFFER_EXPORT: {
2829 string const format = (argument.empty() || argument == "default") ?
2830 params().getDefaultOutputFormat() : argument;
2831 ExportStatus const status = doExport(format, false);
2832 dr.setError(status != ExportSuccess);
2833 if (status != ExportSuccess)
2834 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2835 from_utf8(format)));
2839 case LFUN_BUILD_PROGRAM: {
2840 ExportStatus const status = doExport("program", true);
2841 dr.setError(status != ExportSuccess);
2842 if (status != ExportSuccess)
2843 dr.setMessage(_("Error generating literate programming code."));
2847 case LFUN_BUFFER_EXPORT_CUSTOM: {
2849 string command = split(argument, format_name, ' ');
2850 Format const * format = theFormats().getFormat(format_name);
2852 lyxerr << "Format \"" << format_name
2853 << "\" not recognized!"
2858 // The name of the file created by the conversion process
2861 // Output to filename
2862 if (format->name() == "lyx") {
2863 string const latexname = latexName(false);
2864 filename = changeExtension(latexname,
2865 format->extension());
2866 filename = addName(temppath(), filename);
2868 if (!writeFile(FileName(filename)))
2872 doExport(format_name, true, filename);
2875 // Substitute $$FName for filename
2876 if (!contains(command, "$$FName"))
2877 command = "( " + command + " ) < $$FName";
2878 command = subst(command, "$$FName", filename);
2880 // Execute the command in the background
2882 call.startscript(Systemcall::DontWait, command,
2883 filePath(), layoutPos());
2887 // FIXME: There is need for a command-line import.
2889 case LFUN_BUFFER_IMPORT:
2894 case LFUN_BUFFER_AUTO_SAVE:
2896 resetAutosaveTimers();
2899 case LFUN_BRANCH_ACTIVATE:
2900 case LFUN_BRANCH_DEACTIVATE:
2901 case LFUN_BRANCH_MASTER_ACTIVATE:
2902 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2903 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2904 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2905 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2908 docstring const & branch_name = func.argument();
2909 // the case without a branch name is handled elsewhere
2910 if (branch_name.empty()) {
2914 Branch * branch = buf->params().branchlist().find(branch_name);
2916 LYXERR0("Branch " << branch_name << " does not exist.");
2918 docstring const msg =
2919 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2923 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2924 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2925 if (branch->isSelected() != activate) {
2926 buf->undo().recordUndoBufferParams(CursorData());
2927 branch->setSelected(activate);
2929 dr.screenUpdate(Update::Force);
2930 dr.forceBufferUpdate();
2935 case LFUN_BRANCH_ADD: {
2936 docstring const & branchnames = func.argument();
2937 if (branchnames.empty()) {
2941 BranchList & branch_list = params().branchlist();
2942 vector<docstring> const branches =
2943 getVectorFromString(branchnames, branch_list.separator());
2945 for (docstring const & branch_name : branches) {
2946 Branch * branch = branch_list.find(branch_name);
2948 LYXERR0("Branch " << branch_name << " already exists.");
2952 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2954 undo().recordUndoBufferParams(CursorData());
2955 branch_list.add(branch_name);
2956 branch = branch_list.find(branch_name);
2958 // needed to update the color table for dark mode
2959 branch->setColors("background", "background");
2961 dr.screenUpdate(Update::Force);
2969 case LFUN_BRANCHES_RENAME: {
2970 if (func.argument().empty())
2973 docstring const oldname = from_utf8(func.getArg(0));
2974 docstring const newname = from_utf8(func.getArg(1));
2975 InsetIterator it = begin(inset());
2976 InsetIterator const itend = end(inset());
2977 bool success = false;
2978 for (; it != itend; ++it) {
2979 if (it->lyxCode() == BRANCH_CODE) {
2980 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2981 if (ins.branch() == oldname) {
2982 undo().recordUndo(CursorData(it));
2983 ins.rename(newname);
2988 if (it->lyxCode() == INCLUDE_CODE) {
2989 // get buffer of external file
2990 InsetInclude const & ins =
2991 static_cast<InsetInclude const &>(*it);
2992 Buffer * child = ins.loadIfNeeded();
2995 child->dispatch(func, dr);
3000 dr.screenUpdate(Update::Force);
3001 dr.forceBufferUpdate();
3006 case LFUN_BUFFER_VIEW_CACHE:
3007 if (!theFormats().view(*this, d->preview_file_,
3008 d->preview_format_))
3009 dr.setMessage(_("Error viewing the output file."));
3012 case LFUN_CHANGES_TRACK:
3013 if (params().save_transient_properties)
3014 undo().recordUndoBufferParams(CursorData());
3015 params().track_changes = !params().track_changes;
3018 case LFUN_CHANGES_OUTPUT:
3019 if (params().save_transient_properties)
3020 undo().recordUndoBufferParams(CursorData());
3021 params().output_changes = !params().output_changes;
3022 if (params().output_changes) {
3023 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3024 LaTeXFeatures::isAvailable("xcolor");
3027 Alert::warning(_("Changes not shown in LaTeX output"),
3028 _("Changes will not be highlighted in LaTeX output, "
3029 "because xcolor and ulem are not installed.\n"
3030 "Please install both packages or redefine "
3031 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3036 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3037 // turn compression on/off
3038 undo().recordUndoBufferParams(CursorData());
3039 params().compressed = !params().compressed;
3042 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3043 undo().recordUndoBufferParams(CursorData());
3044 params().output_sync = !params().output_sync;
3047 case LFUN_BUFFER_ANONYMIZE: {
3048 undo().recordUndoFullBuffer(CursorData());
3049 CursorData cur(doc_iterator_begin(this));
3050 for ( ; cur ; cur.forwardPar())
3051 cur.paragraph().anonymize();
3052 dr.forceBufferUpdate();
3053 dr.screenUpdate(Update::Force);
3061 dr.dispatched(dispatched);
3065 void Buffer::changeLanguage(Language const * from, Language const * to)
3067 LASSERT(from, return);
3068 LASSERT(to, return);
3070 ParIterator it = par_iterator_begin();
3071 ParIterator eit = par_iterator_end();
3072 for (; it != eit; ++it)
3073 it->changeLanguage(params(), from, to);
3077 bool Buffer::isMultiLingual() const
3079 ParConstIterator end = par_iterator_end();
3080 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3081 if (it->isMultiLingual(params()))
3088 std::set<Language const *> Buffer::getLanguages() const
3090 std::set<Language const *> langs;
3091 getLanguages(langs);
3096 void Buffer::getLanguages(std::set<Language const *> & langs) const
3098 ParConstIterator end = par_iterator_end();
3099 // add the buffer language, even if it's not actively used
3100 langs.insert(language());
3101 // iterate over the paragraphs
3102 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3103 it->getLanguages(langs);
3105 ListOfBuffers clist = getDescendants();
3106 for (auto const & cit : clist)
3107 cit->getLanguages(langs);
3111 DocIterator Buffer::getParFromID(int const id) const
3113 Buffer * buf = const_cast<Buffer *>(this);
3115 // This means non-existent
3116 return doc_iterator_end(buf);
3118 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3119 if (it.paragraph().id() == id)
3122 return doc_iterator_end(buf);
3126 bool Buffer::hasParWithID(int const id) const
3128 return !getParFromID(id).atEnd();
3132 ParIterator Buffer::par_iterator_begin()
3134 return ParIterator(doc_iterator_begin(this));
3138 ParIterator Buffer::par_iterator_end()
3140 return ParIterator(doc_iterator_end(this));
3144 ParConstIterator Buffer::par_iterator_begin() const
3146 return ParConstIterator(doc_iterator_begin(this));
3150 ParConstIterator Buffer::par_iterator_end() const
3152 return ParConstIterator(doc_iterator_end(this));
3155 bool Buffer::empty() const
3157 return paragraphs().size() == 1 && paragraphs().front().empty();
3161 Language const * Buffer::language() const
3163 return params().language;
3167 docstring Buffer::B_(string const & l10n) const
3169 return params().B_(l10n);
3173 bool Buffer::isClean() const
3175 return d->lyx_clean;
3179 bool Buffer::isChecksumModified() const
3181 LASSERT(d->filename.exists(), return false);
3182 return d->checksum_ != d->filename.checksum();
3186 void Buffer::saveCheckSum() const
3188 FileName const & file = d->filename;
3190 d->checksum_ = file.exists() ? file.checksum()
3191 : 0; // in the case of save to a new file.
3195 void Buffer::markClean() const
3197 if (!d->lyx_clean) {
3198 d->lyx_clean = true;
3201 // if the .lyx file has been saved, we don't need an
3203 d->bak_clean = true;
3204 d->undo_.markDirty();
3205 clearExternalModification();
3209 void Buffer::setUnnamed(bool flag)
3215 bool Buffer::isUnnamed() const
3222 /// Don't check unnamed, here: isInternal() is used in
3223 /// newBuffer(), where the unnamed flag has not been set by anyone
3224 /// yet. Also, for an internal buffer, there should be no need for
3225 /// retrieving fileName() nor for checking if it is unnamed or not.
3226 bool Buffer::isInternal() const
3228 return d->internal_buffer;
3232 void Buffer::setInternal(bool flag)
3234 d->internal_buffer = flag;
3238 void Buffer::markDirty()
3241 d->lyx_clean = false;
3244 d->bak_clean = false;
3246 for (auto & depit : d->dep_clean)
3247 depit.second = false;
3251 FileName Buffer::fileName() const
3257 string Buffer::absFileName() const
3259 return d->filename.absFileName();
3263 string Buffer::filePath() const
3265 string const abs = d->filename.onlyPath().absFileName();
3268 int last = abs.length() - 1;
3270 return abs[last] == '/' ? abs : abs + '/';
3274 DocFileName Buffer::getReferencedFileName(string const & fn) const
3277 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3278 result.set(fn, filePath());
3280 // filePath() ends with a path separator
3281 FileName const test(filePath() + fn);
3283 result.set(fn, filePath());
3285 result.set(fn, params().origin);
3292 string const Buffer::prepareFileNameForLaTeX(string const & name,
3293 string const & ext, bool nice) const
3295 string const fname = makeAbsPath(name, filePath()).absFileName();
3296 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3302 return to_utf8(makeRelPath(from_utf8(fname),
3303 from_utf8(masterBuffer()->filePath())));
3307 vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3308 docstring_list const & bibfilelist,
3309 bool const add_extension) const
3311 // If we are processing the LaTeX file in a temp directory then
3312 // copy the .bib databases to this temp directory, mangling their
3313 // names in the process. Store this mangled name in the list of
3315 // (We need to do all this because BibTeX *really*, *really*
3316 // can't handle "files with spaces" and Windows users tend to
3317 // use such filenames.)
3318 // Otherwise, store the (maybe absolute) path to the original,
3319 // unmangled database name.
3321 vector<pair<docstring, string>> res;
3323 // determine the export format
3324 string const tex_format = flavor2format(runparams.flavor);
3326 // check for spaces in paths
3327 bool found_space = false;
3329 for (auto const & bit : bibfilelist) {
3330 string utf8input = to_utf8(bit);
3332 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3333 FileName try_in_file =
3334 makeAbsPath(database + ".bib", filePath());
3335 bool not_from_texmf = try_in_file.isReadableFile();
3336 // If the file has not been found, try with the real file name
3337 // (it might come from a child in a sub-directory)
3338 if (!not_from_texmf) {
3339 try_in_file = getBibfilePath(bit);
3340 if (try_in_file.isReadableFile()) {
3341 // Check if the file is in texmf
3342 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3343 not_from_texmf = kpsefile.empty()
3344 || kpsefile.absFileName() != try_in_file.absFileName();
3346 // If this exists, make path relative to the master
3349 removeExtension(prepareFileNameForLaTeX(
3350 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3351 from_utf8(filePath()))),
3352 ".bib", runparams.nice));
3356 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3358 // mangledFileName() needs the extension
3359 DocFileName const in_file = DocFileName(try_in_file);
3360 database = removeExtension(in_file.mangledFileName());
3361 FileName const out_file = makeAbsPath(database + ".bib",
3362 masterBuffer()->temppath());
3363 bool const success = in_file.copyTo(out_file);
3365 LYXERR0("Failed to copy '" << in_file
3366 << "' to '" << out_file << "'");
3368 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3369 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3370 if (!isValidLaTeXFileName(database)) {
3371 frontend::Alert::warning(_("Invalid filename"),
3372 _("The following filename will cause troubles "
3373 "when running the exported file through LaTeX: ") +
3374 from_utf8(database));
3376 if (!isValidDVIFileName(database)) {
3377 frontend::Alert::warning(_("Problematic filename for DVI"),
3378 _("The following filename can cause troubles "
3379 "when running the exported file through LaTeX "
3380 "and opening the resulting DVI: ") +
3381 from_utf8(database), true);
3389 docstring const path = from_utf8(latex_path(database));
3391 if (contains(path, ' '))
3394 if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
3395 enc = params().bibFileEncoding(utf8input);
3397 bool recorded = false;
3398 for (auto const & pe : res) {
3399 if (pe.first == path) {
3406 res.push_back(make_pair(path, enc));
3409 // Check if there are spaces in the path and warn BibTeX users, if so.
3410 // (biber can cope with such paths)
3411 if (!prefixIs(runparams.bibtex_command, "biber")) {
3412 // Post this warning only once.
3413 static bool warned_about_spaces = false;
3414 if (!warned_about_spaces &&
3415 runparams.nice && found_space) {
3416 warned_about_spaces = true;
3417 Alert::warning(_("Export Warning!"),
3418 _("There are spaces in the paths to your BibTeX databases.\n"
3419 "BibTeX will be unable to find them."));
3428 string Buffer::layoutPos() const
3430 return d->layout_position;
3434 void Buffer::setLayoutPos(string const & path)
3437 d->layout_position.clear();
3441 LATTEST(FileName::isAbsolute(path));
3443 d->layout_position =
3444 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3446 if (d->layout_position.empty())
3447 d->layout_position = ".";
3451 bool Buffer::hasReadonlyFlag() const
3453 return d->read_only;
3457 bool Buffer::isReadonly() const
3459 return hasReadonlyFlag() || notifiesExternalModification();
3463 void Buffer::setParent(Buffer const * buffer)
3465 // We need to do some work here to avoid recursive parent structures.
3466 // This is the easy case.
3467 if (buffer == this) {
3468 LYXERR0("Ignoring attempt to set self as parent in\n" << fileName());
3471 // Now we check parents going upward, to make sure that IF we set the
3472 // parent as requested, we would not generate a recursive include.
3473 set<Buffer const *> sb;
3474 Buffer const * b = buffer;
3475 bool found_recursion = false;
3477 if (sb.find(b) != sb.end()) {
3478 found_recursion = true;
3485 if (found_recursion) {
3486 LYXERR0("Ignoring attempt to set parent of\n" <<
3489 buffer->fileName() <<
3490 "\nbecause that would create a recursive inclusion.");
3494 // We should be safe now.
3495 d->setParent(buffer);
3500 Buffer const * Buffer::parent() const
3506 ListOfBuffers Buffer::allRelatives() const
3508 ListOfBuffers lb = masterBuffer()->getDescendants();
3509 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3514 Buffer const * Buffer::masterBuffer() const
3516 Buffer const * const pbuf = d->parent();
3520 return pbuf->masterBuffer();
3524 bool Buffer::isChild(Buffer * child) const
3526 return d->children_positions.find(child) != d->children_positions.end();
3530 DocIterator Buffer::firstChildPosition(Buffer const * child)
3532 Impl::BufferPositionMap::iterator it;
3533 it = d->children_positions.find(child);
3534 if (it == d->children_positions.end())
3535 return DocIterator(this);
3540 bool Buffer::hasChildren() const
3542 return !d->children_positions.empty();
3546 void Buffer::collectChildren(ListOfBuffers & children, bool grand_children) const
3548 // loop over children
3549 for (auto const & p : d->children_positions) {
3550 Buffer * child = const_cast<Buffer *>(p.first);
3551 // This can happen when called during GUI operations
3552 if (!theBufferList().isLoaded(child))
3555 ListOfBuffers::const_iterator bit = find(children.begin(), children.end(), child);
3556 if (bit != children.end())
3558 children.push_back(child);
3560 // there might be grandchildren
3561 child->collectChildren(children, true);
3566 ListOfBuffers Buffer::getChildren() const
3569 collectChildren(v, false);
3570 // Make sure we have not included ourselves.
3571 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3572 if (bit != v.end()) {
3573 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3580 ListOfBuffers Buffer::getDescendants() const
3583 collectChildren(v, true);
3584 // Make sure we have not included ourselves.
3585 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3586 if (bit != v.end()) {
3587 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3594 template<typename M>
3595 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3600 typename M::const_iterator it = m.lower_bound(x);
3601 if (it == m.begin())
3609 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3610 DocIterator const & pos) const
3612 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3614 // if paragraphs have no macro context set, pos will be empty
3618 // we haven't found anything yet
3619 DocIterator bestPos = owner_->par_iterator_begin();
3620 MacroData const * bestData = nullptr;
3622 // find macro definitions for name
3623 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3624 if (nameIt != macros.end()) {
3625 // find last definition in front of pos or at pos itself
3626 PositionScopeMacroMap::const_iterator it
3627 = greatest_below(nameIt->second, pos);
3628 if (it != nameIt->second.end()) {
3630 // scope ends behind pos?
3631 if (pos < it->second.scope) {
3632 // Looks good, remember this. If there
3633 // is no external macro behind this,
3634 // we found the right one already.
3635 bestPos = it->first;
3636 bestData = &it->second.macro;
3640 // try previous macro if there is one
3641 if (it == nameIt->second.begin())
3648 // find macros in included files
3649 PositionScopeBufferMap::const_iterator it
3650 = greatest_below(position_to_children, pos);
3651 if (it == position_to_children.end())
3652 // no children before
3656 // do we know something better (i.e. later) already?
3657 if (it->first < bestPos )
3660 // scope ends behind pos?
3661 if (pos < it->second.scope
3662 && (cloned_buffer_ ||
3663 theBufferList().isLoaded(it->second.buffer))) {
3664 // look for macro in external file
3666 MacroData const * data
3667 = it->second.buffer->getMacro(name, false);
3670 bestPos = it->first;
3676 // try previous file if there is one
3677 if (it == position_to_children.begin())
3682 // return the best macro we have found
3687 MacroData const * Buffer::getMacro(docstring const & name,
3688 DocIterator const & pos, bool global) const
3693 // query buffer macros
3694 MacroData const * data = d->getBufferMacro(name, pos);
3695 if (data != nullptr)
3698 // If there is a master buffer, query that
3699 Buffer const * const pbuf = d->parent();
3701 d->macro_lock = true;
3702 MacroData const * macro = pbuf->getMacro(
3703 name, *this, false);
3704 d->macro_lock = false;
3710 data = MacroTable::globalMacros().get(name);
3711 if (data != nullptr)
3719 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3721 // set scope end behind the last paragraph
3722 DocIterator scope = par_iterator_begin();
3723 scope.pit() = scope.lastpit() + 1;
3725 return getMacro(name, scope, global);
3729 MacroData const * Buffer::getMacro(docstring const & name,
3730 Buffer const & child, bool global) const
3732 // look where the child buffer is included first
3733 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3734 if (it == d->children_positions.end())
3737 // check for macros at the inclusion position
3738 return getMacro(name, it->second, global);
3742 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3744 pit_type const lastpit = it.lastpit();
3746 // look for macros in each paragraph
3747 while (it.pit() <= lastpit) {
3748 Paragraph & par = it.paragraph();
3750 // iterate over the insets of the current paragraph
3751 for (auto const & insit : par.insetList()) {
3752 it.pos() = insit.pos;
3754 // is it a nested text inset?
3755 if (insit.inset->asInsetText()) {
3756 // Inset needs its own scope?
3757 InsetText const * itext = insit.inset->asInsetText();
3758 bool newScope = itext->isMacroScope();
3760 // scope which ends just behind the inset
3761 DocIterator insetScope = it;
3764 // collect macros in inset
3765 it.push_back(CursorSlice(*insit.inset));
3766 updateMacros(it, newScope ? insetScope : scope);
3771 if (insit.inset->asInsetTabular()) {
3772 CursorSlice slice(*insit.inset);
3773 size_t const numcells = slice.nargs();
3774 for (; slice.idx() < numcells; slice.forwardIdx()) {
3775 it.push_back(slice);
3776 updateMacros(it, scope);
3782 // is it an external file?
3783 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3784 // get buffer of external file
3785 InsetInclude const & incinset =
3786 static_cast<InsetInclude const &>(*insit.inset);
3788 Buffer * child = incinset.loadIfNeeded();
3793 // register its position, but only when it is
3794 // included first in the buffer
3795 children_positions.insert({child, it});
3797 // register child with its scope
3798 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3802 InsetMath * im = insit.inset->asInsetMath();
3803 if (doing_export && im) {
3804 InsetMathHull * hull = im->asHullInset();
3806 hull->recordLocation(it);
3809 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3813 InsetMathMacroTemplate & macroTemplate =
3814 *insit.inset->asInsetMath()->asMacroTemplate();
3815 MacroContext mc(owner_, it);
3816 macroTemplate.updateToContext(mc);
3819 bool valid = macroTemplate.validMacro();
3820 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3821 // then the BufferView's cursor will be invalid in
3822 // some cases which leads to crashes.
3827 // FIXME (Abdel), I don't understand why we pass 'it' here
3828 // instead of 'macroTemplate' defined above... is this correct?
3829 macros[macroTemplate.name()][it] =
3830 Impl::ScopeMacro(scope, MacroData(owner_, it));
3840 void Buffer::updateMacros() const
3845 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3847 // start with empty table
3849 d->children_positions.clear();
3850 d->position_to_children.clear();
3852 // Iterate over buffer, starting with first paragraph
3853 // The scope must be bigger than any lookup DocIterator
3854 // later. For the global lookup, lastpit+1 is used, hence
3855 // we use lastpit+2 here.
3856 DocIterator it = par_iterator_begin();
3857 DocIterator outerScope = it;
3858 outerScope.pit() = outerScope.lastpit() + 2;
3859 d->updateMacros(it, outerScope);
3863 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3865 for (Inset const & it : inset()) {
3866 if (it.lyxCode() == BRANCH_CODE) {
3867 InsetBranch const & br = static_cast<InsetBranch const &>(it);
3868 docstring const name = br.branch();
3869 if (!from_master && !params().branchlist().find(name))
3870 result.push_back(name);
3871 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3872 result.push_back(name);
3875 if (it.lyxCode() == INCLUDE_CODE) {
3876 // get buffer of external file
3877 InsetInclude const & ins =
3878 static_cast<InsetInclude const &>(it);
3879 Buffer * child = ins.loadIfNeeded();
3882 child->getUsedBranches(result, true);
3885 // remove duplicates
3890 void Buffer::updateMacroInstances(UpdateType utype) const
3892 LYXERR(Debug::MACROS, "updateMacroInstances for "
3893 << d->filename.onlyFileName());
3894 DocIterator it = doc_iterator_begin(this);
3896 DocIterator const end = doc_iterator_end(this);
3897 for (; it != end; it.forwardInset()) {
3898 // look for MathData cells in InsetMathNest insets
3899 InsetMath * minset = it.nextInset()->asInsetMath();
3903 // update macro in all cells of the InsetMathNest
3904 idx_type n = minset->nargs();
3905 MacroContext mc = MacroContext(this, it);
3906 for (idx_type i = 0; i < n; ++i) {
3907 MathData & data = minset->cell(i);
3908 data.updateMacros(nullptr, mc, utype, 0);
3914 void Buffer::listMacroNames(MacroNameSet & macros) const
3919 d->macro_lock = true;
3921 // loop over macro names
3922 for (auto const & nameit : d->macros)
3923 macros.insert(nameit.first);
3925 // loop over children
3926 for (auto const & p : d->children_positions) {
3927 Buffer * child = const_cast<Buffer *>(p.first);
3928 // The buffer might have been closed (see #10766).
3929 if (theBufferList().isLoaded(child))
3930 child->listMacroNames(macros);
3934 Buffer const * const pbuf = d->parent();
3936 pbuf->listMacroNames(macros);
3938 d->macro_lock = false;
3942 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3944 Buffer const * const pbuf = d->parent();
3949 pbuf->listMacroNames(names);
3952 for (auto const & mit : names) {
3954 MacroData const * data = pbuf->getMacro(mit, *this, false);
3956 macros.insert(data);
3958 // we cannot access the original InsetMathMacroTemplate anymore
3959 // here to calls validate method. So we do its work here manually.
3960 // FIXME: somehow make the template accessible here.
3961 if (data->optionals() > 0)
3962 features.require("xargs");
3968 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3971 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3973 RefCache::iterator it = d->ref_cache_.find(label);
3974 if (it != d->ref_cache_.end())
3977 static References const dummy_refs = References();
3978 it = d->ref_cache_.insert(
3979 make_pair(label, dummy_refs)).first;
3984 Buffer::References const & Buffer::references(docstring const & label) const
3986 return const_cast<Buffer *>(this)->getReferenceCache(label);
3990 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3992 References & refs = getReferenceCache(label);
3993 refs.push_back(make_pair(inset, it));
3997 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
4001 linfo.label = label;
4003 linfo.active = active;
4004 masterBuffer()->d->label_cache_.push_back(linfo);
4008 InsetLabel const * Buffer::insetLabel(docstring const & label,
4009 bool const active) const
4011 for (auto const & rc : masterBuffer()->d->label_cache_) {
4012 if (rc.label == label && (rc.active || !active))
4019 bool Buffer::activeLabel(docstring const & label) const
4021 return insetLabel(label, true) != nullptr;
4025 void Buffer::clearReferenceCache() const
4028 d->ref_cache_.clear();
4029 d->label_cache_.clear();
4034 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
4036 //FIXME: This does not work for child documents yet.
4037 reloadBibInfoCache();
4039 // Check if the label 'from' appears more than once
4040 vector<docstring> labels;
4041 for (auto const & bibit : masterBibInfo())
4042 labels.push_back(bibit.first);
4044 if (count(labels.begin(), labels.end(), from) > 1)
4047 string const paramName = "key";
4048 UndoGroupHelper ugh(this);
4049 InsetIterator it = begin(inset());
4051 if (it->lyxCode() != CITE_CODE)
4053 InsetCommand * inset = it->asInsetCommand();
4054 docstring const oldValue = inset->getParam(paramName);
4055 if (oldValue == from) {
4056 undo().recordUndo(CursorData(it));
4057 inset->setParam(paramName, to);
4062 // returns NULL if id-to-row conversion is unsupported
4063 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4064 pit_type par_begin, pit_type par_end,
4065 OutputWhat output, bool master) const
4067 unique_ptr<TexRow> texrow;
4068 OutputParams runparams(¶ms().encoding());
4069 runparams.nice = true;
4070 runparams.flavor = params().getOutputFlavor(format);
4071 runparams.linelen = lyxrc.plaintext_linelen;
4072 // No side effect of file copying and image conversion
4073 runparams.dryrun = true;
4075 // Some macros rely on font encoding
4076 runparams.main_fontenc = params().main_font_encoding();
4078 // Use the right wrapping for the comment at the beginning of the generated
4079 // snippet, so that it is either valid LaTeX or valid XML (including HTML and DocBook).
4080 docstring comment_start = from_ascii("% ");
4081 docstring comment_end = from_ascii("");
4082 if (runparams.flavor == Flavor::Html || runparams.flavor == Flavor::DocBook5) {
4083 comment_start = from_ascii("<!-- ");
4084 comment_end = from_ascii(" -->");
4087 if (output == CurrentParagraph) {
4088 runparams.par_begin = par_begin;
4089 runparams.par_end = par_end;
4090 if (par_begin + 1 == par_end) {
4092 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4097 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4098 convert<docstring>(par_begin),
4099 convert<docstring>(par_end - 1))
4103 // output paragraphs
4104 if (runparams.flavor == Flavor::LyX) {
4105 Paragraph const & par = text().paragraphs()[par_begin];
4107 depth_type dt = par.getDepth();
4108 par.write(ods, params(), dt);
4109 os << from_utf8(ods.str());
4110 } else if (runparams.flavor == Flavor::Html) {
4112 setMathFlavor(runparams);
4113 xhtmlParagraphs(text(), *this, xs, runparams);
4114 } else if (runparams.flavor == Flavor::Text) {
4116 // FIXME Handles only one paragraph, unlike the others.
4117 // Probably should have some routine with a signature like them.
4118 writePlaintextParagraph(*this,
4119 text().paragraphs()[par_begin], os, runparams, dummy);
4120 } else if (runparams.flavor == Flavor::DocBook5) {
4122 docbookParagraphs(text(), *this, xs, runparams);
4124 // If we are previewing a paragraph, even if this is the
4125 // child of some other buffer, let's cut the link here,
4126 // so that no concurring settings from the master
4127 // (e.g. branch state) interfere (see #8101).
4129 d->ignore_parent = true;
4130 // We need to validate the Buffer params' features here
4131 // in order to know if we should output polyglossia
4132 // macros (instead of babel macros)
4133 LaTeXFeatures features(*this, params(), runparams);
4135 runparams.use_polyglossia = features.usePolyglossia();
4136 runparams.use_hyperref = features.isRequired("hyperref");
4137 // latex or literate
4140 ots.texrow().newlines(2);
4142 latexParagraphs(*this, text(), ots, runparams);
4143 texrow = ots.releaseTexRow();
4145 // Restore the parenthood
4147 d->ignore_parent = false;
4150 os << comment_start;
4151 if (output == FullSource)
4152 os << _("Preview source code");
4153 else if (output == OnlyPreamble)
4154 os << _("Preview preamble");
4155 else if (output == OnlyBody)
4156 os << _("Preview body");
4159 if (runparams.flavor == Flavor::LyX) {
4161 if (output == FullSource)
4163 else if (output == OnlyPreamble)
4164 params().writeFile(ods, this);
4165 else if (output == OnlyBody)
4167 os << from_utf8(ods.str());
4168 } else if (runparams.flavor == Flavor::Html) {
4169 writeLyXHTMLSource(os, runparams, output);
4170 } else if (runparams.flavor == Flavor::Text) {
4171 if (output == OnlyPreamble)
4172 os << "% "<< _("Plain text does not have a preamble.");
4174 writePlaintextFile(*this, os, runparams);
4175 } else if (runparams.flavor == Flavor::DocBook5) {
4176 writeDocBookSource(os, runparams, output);
4178 // latex or literate
4181 ots.texrow().newlines(2);
4183 runparams.is_child = true;
4185 writeLaTeXSource(ots, string(), runparams, output);
4186 texrow = ots.releaseTexRow();
4193 ErrorList & Buffer::errorList(string const & type) const
4195 return d->errorLists[type];
4199 void Buffer::updateTocItem(std::string const & type,
4200 DocIterator const & dit) const
4203 d->gui_->updateTocItem(type, dit);
4207 void Buffer::structureChanged() const
4210 d->gui_->structureChanged();
4214 void Buffer::errors(string const & err, bool from_master) const
4217 d->gui_->errors(err, from_master);
4221 void Buffer::message(docstring const & msg) const
4224 d->gui_->message(msg);
4228 void Buffer::setBusy(bool on) const
4231 d->gui_->setBusy(on);
4235 void Buffer::updateTitles() const
4238 d->wa_->updateTitles();
4242 void Buffer::resetAutosaveTimers() const
4245 d->gui_->resetAutosaveTimers();
4249 bool Buffer::hasGuiDelegate() const
4255 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4261 FileName Buffer::getEmergencyFileName() const
4263 return FileName(d->filename.absFileName() + ".emergency");
4267 FileName Buffer::getAutosaveFileName() const
4269 // if the document is unnamed try to save in the backup dir, else
4270 // in the default document path, and as a last try in the filePath,
4271 // which will most often be the temporary directory
4274 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4275 : lyxrc.backupdir_path;
4276 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4279 string const fname = "#" + d->filename.onlyFileName() + "#";
4281 return makeAbsPath(fname, fpath);
4285 void Buffer::removeAutosaveFile() const
4287 FileName const f = getAutosaveFileName();
4293 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4295 FileName const newauto = getAutosaveFileName();
4297 if (newauto != oldauto && oldauto.exists())
4298 if (!oldauto.moveTo(newauto))
4299 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4303 bool Buffer::autoSave() const
4305 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4306 if (buf->d->bak_clean || hasReadonlyFlag())
4309 message(_("Autosaving current document..."));
4310 buf->d->bak_clean = true;
4312 FileName const fname = getAutosaveFileName();
4313 LASSERT(d->cloned_buffer_, return false);
4315 // If this buffer is cloned, we assume that
4316 // we are running in a separate thread already.
4317 TempFile tempfile("lyxautoXXXXXX.lyx");
4318 tempfile.setAutoRemove(false);
4319 FileName const tmp_ret = tempfile.name();
4320 if (!tmp_ret.empty()) {
4322 // assume successful write of tmp_ret
4323 if (tmp_ret.moveTo(fname))
4326 // failed to write/rename tmp_ret so try writing direct
4327 return writeFile(fname);
4331 void Buffer::setExportStatus(bool e) const
4333 d->doing_export = e;
4334 ListOfBuffers clist = getDescendants();
4335 for (auto const & bit : clist)
4336 bit->d->doing_export = e;
4340 bool Buffer::isExporting() const
4342 return d->doing_export;
4346 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4350 return doExport(target, put_in_tempdir, result_file);
4353 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4354 string & result_file) const
4356 bool const update_unincluded =
4357 params().maintain_unincluded_children != BufferParams::CM_None
4358 && !params().getIncludedChildren().empty();
4360 // (1) export with all included children (omit \includeonly)
4361 if (update_unincluded) {
4362 ExportStatus const status =
4363 doExport(target, put_in_tempdir, true, result_file);
4364 if (status != ExportSuccess)
4367 // (2) export with included children only
4368 return doExport(target, put_in_tempdir, false, result_file);
4372 void Buffer::setMathFlavor(OutputParams & op) const
4374 switch (params().html_math_output) {
4375 case BufferParams::MathML:
4376 op.math_flavor = OutputParams::MathAsMathML;
4378 case BufferParams::HTML:
4379 op.math_flavor = OutputParams::MathAsHTML;
4381 case BufferParams::Images:
4382 op.math_flavor = OutputParams::MathAsImages;
4384 case BufferParams::LaTeX:
4385 op.math_flavor = OutputParams::MathAsLaTeX;
4391 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4392 bool includeall, string & result_file) const
4394 LYXERR(Debug::FILES, "target=" << target);
4395 OutputParams runparams(¶ms().encoding());
4396 string format = target;
4397 string dest_filename;
4398 size_t pos = target.find(' ');
4399 if (pos != string::npos) {
4400 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4401 format = target.substr(0, pos);
4402 if (format == "default")
4403 format = params().getDefaultOutputFormat();
4404 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4405 FileName(dest_filename).onlyPath().createPath();
4406 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4408 MarkAsExporting exporting(this);
4409 string backend_format;
4410 runparams.flavor = Flavor::LaTeX;
4411 runparams.linelen = lyxrc.plaintext_linelen;
4412 runparams.includeall = includeall;
4413 vector<string> backs = params().backends();
4414 Converters converters = theConverters();
4415 bool need_nice_file = false;
4416 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4417 // Get shortest path to format
4418 converters.buildGraph();
4419 Graph::EdgePath path;
4420 for (string const & sit : backs) {
4421 Graph::EdgePath p = converters.getPath(sit, format);
4422 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4423 backend_format = sit;
4428 if (!put_in_tempdir) {
4429 // Only show this alert if this is an export to a non-temporary
4430 // file (not for previewing).
4431 docstring s = bformat(_("No information for exporting the format %1$s."),
4432 translateIfPossible(theFormats().prettyName(format)));
4433 if (format == "pdf4")
4435 + bformat(_("Hint: use non-TeX fonts or set input encoding "
4436 " to '%1$s'"), from_utf8(encodings.fromLyXName("ascii")->guiName()));
4437 Alert::error(_("Couldn't export file"), s);
4439 return ExportNoPathToFormat;
4441 runparams.flavor = converters.getFlavor(path, this);
4442 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4443 for (auto const & edge : path)
4444 if (theConverters().get(edge).nice()) {
4445 need_nice_file = true;
4450 backend_format = format;
4451 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4452 // FIXME: Don't hardcode format names here, but use a flag
4453 if (backend_format == "pdflatex")
4454 runparams.flavor = Flavor::PdfLaTeX;
4455 else if (backend_format == "luatex")
4456 runparams.flavor = Flavor::LuaTeX;
4457 else if (backend_format == "dviluatex")
4458 runparams.flavor = Flavor::DviLuaTeX;
4459 else if (backend_format == "xetex")
4460 runparams.flavor = Flavor::XeTeX;
4463 string filename = latexName(false);
4464 filename = addName(temppath(), filename);
4465 filename = changeExtension(filename,
4466 theFormats().extension(backend_format));
4467 LYXERR(Debug::FILES, "filename=" << filename);
4469 // Plain text backend
4470 if (backend_format == "text") {
4471 runparams.flavor = Flavor::Text;
4473 writePlaintextFile(*this, FileName(filename), runparams);
4475 catch (ConversionException const &) { return ExportCancel; }
4478 else if (backend_format == "xhtml") {
4479 runparams.flavor = Flavor::Html;
4480 setMathFlavor(runparams);
4481 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4482 return ExportKilled;
4483 } else if (backend_format == "lyx")
4484 writeFile(FileName(filename));
4486 else if (backend_format == "docbook5") {
4487 runparams.flavor = Flavor::DocBook5;
4488 runparams.nice = false;
4489 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4490 return ExportKilled;
4493 else if (backend_format == format || need_nice_file) {
4494 runparams.nice = true;
4495 ExportStatus const retval =
4496 makeLaTeXFile(FileName(filename), string(), runparams);
4497 if (retval == ExportKilled)
4498 return ExportKilled;
4499 if (d->cloned_buffer_)
4500 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4501 if (retval != ExportSuccess)
4503 } else if (!lyxrc.tex_allows_spaces
4504 && contains(filePath(), ' ')) {
4505 Alert::error(_("File name error"),
4506 bformat(_("The directory path to the document\n%1$s\n"
4507 "contains spaces, but your TeX installation does "
4508 "not allow them. You should save the file to a directory "
4509 "whose name does not contain spaces."), from_utf8(filePath())));
4510 return ExportTexPathHasSpaces;
4512 runparams.nice = false;
4513 ExportStatus const retval =
4514 makeLaTeXFile(FileName(filename), filePath(), runparams);
4515 if (retval == ExportKilled)
4516 return ExportKilled;
4517 if (d->cloned_buffer_)
4518 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4519 if (retval != ExportSuccess)
4523 string const error_type = (format == "program")
4524 ? "Build" : params().bufferFormat();
4525 ErrorList & error_list = d->errorLists[error_type];
4526 string const ext = theFormats().extension(format);
4527 FileName const tmp_result_file(changeExtension(filename, ext));
4528 Converters::RetVal const retval =
4529 converters.convert(this, FileName(filename), tmp_result_file,
4530 FileName(absFileName()), backend_format, format,
4531 error_list, Converters::none, includeall);
4532 if (retval == Converters::KILLED)
4533 return ExportCancel;
4534 bool success = (retval == Converters::SUCCESS);
4536 // Emit the signal to show the error list or copy it back to the
4537 // cloned Buffer so that it can be emitted afterwards.
4538 if (format != backend_format) {
4539 if (runparams.silent)
4541 else if (d->cloned_buffer_)
4542 d->cloned_buffer_->d->errorLists[error_type] =
4543 d->errorLists[error_type];
4546 // also to the children, in case of master-buffer-view
4547 ListOfBuffers clist = getDescendants();
4548 for (auto const & bit : clist) {
4549 if (runparams.silent)
4550 bit->d->errorLists[error_type].clear();
4551 else if (d->cloned_buffer_) {
4552 // Enable reverse search by copying back the
4553 // texrow object to the cloned buffer.
4554 // FIXME: this is not thread safe.
4555 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4556 bit->d->cloned_buffer_->d->errorLists[error_type] =
4557 bit->d->errorLists[error_type];
4559 bit->errors(error_type, true);
4563 if (d->cloned_buffer_) {
4564 // Enable reverse dvi or pdf to work by copying back the texrow
4565 // object to the cloned buffer.
4566 // FIXME: There is a possibility of concurrent access to texrow
4567 // here from the main GUI thread that should be securized.
4568 d->cloned_buffer_->d->texrow = d->texrow;
4569 string const err_type = params().bufferFormat();
4570 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4574 if (put_in_tempdir) {
4575 result_file = tmp_result_file.absFileName();
4576 return success ? ExportSuccess : ExportConverterError;
4579 if (dest_filename.empty())
4580 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4582 result_file = dest_filename;
4583 // We need to copy referenced files (e. g. included graphics
4584 // if format == "dvi") to the result dir.
4585 vector<ExportedFile> const extfiles =
4586 runparams.exportdata->externalFiles(format);
4587 string const dest = runparams.export_folder.empty() ?
4588 onlyPath(result_file) : runparams.export_folder;
4589 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4590 : force_overwrite == ALL_FILES;
4591 CopyStatus status = use_force ? FORCE : SUCCESS;
4593 for (ExportedFile const & exp : extfiles) {
4594 if (status == CANCEL) {
4595 message(_("Document export cancelled."));
4596 return ExportCancel;
4598 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4599 string fixedName = exp.exportName;
4600 if (!runparams.export_folder.empty()) {
4601 // Relative pathnames starting with ../ will be sanitized
4602 // if exporting to a different folder
4603 while (fixedName.substr(0, 3) == "../")
4604 fixedName = fixedName.substr(3, fixedName.length() - 3);
4606 FileName fixedFileName = makeAbsPath(fixedName, dest);
4607 fixedFileName.onlyPath().createPath();
4608 status = copyFile(fmt, exp.sourceName,
4610 exp.exportName, status == FORCE,
4611 runparams.export_folder.empty());
4615 if (tmp_result_file.exists()) {
4616 // Finally copy the main file
4617 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4618 : force_overwrite != NO_FILES;
4619 if (status == SUCCESS && use_force)
4621 status = copyFile(format, tmp_result_file,
4622 FileName(result_file), result_file,
4624 if (status == CANCEL) {
4625 message(_("Document export cancelled."));
4626 return ExportCancel;
4628 message(bformat(_("Document exported as %1$s "
4630 translateIfPossible(theFormats().prettyName(format)),
4631 makeDisplayPath(result_file)));
4634 // This must be a dummy converter like fax (bug 1888)
4635 message(bformat(_("Document exported as %1$s"),
4636 translateIfPossible(theFormats().prettyName(format))));
4639 return success ? ExportSuccess : ExportConverterError;
4643 Buffer::ExportStatus Buffer::preview(string const & format) const
4645 bool const update_unincluded =
4646 params().maintain_unincluded_children != BufferParams::CM_None
4647 && !params().getIncludedChildren().empty();
4648 return preview(format, update_unincluded);
4652 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4654 MarkAsExporting exporting(this);
4656 // (1) export with all included children (omit \includeonly)
4658 ExportStatus const status = doExport(format, true, true, result_file);
4659 if (status != ExportSuccess)
4662 // (2) export with included children only
4663 ExportStatus const status = doExport(format, true, false, result_file);
4664 FileName const previewFile(result_file);
4666 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4667 theimpl->preview_file_ = previewFile;
4668 theimpl->preview_format_ = format;
4669 theimpl->require_fresh_start_ = (status != ExportSuccess);
4671 if (status != ExportSuccess)
4674 if (previewFile.exists())
4675 return theFormats().view(*this, previewFile, format) ?
4676 PreviewSuccess : PreviewError;
4678 // Successful export but no output file?
4679 // Probably a bug in error detection.
4680 LATTEST(status != ExportSuccess);
4685 Buffer::ReadStatus Buffer::extractFromVC()
4687 bool const found = LyXVC::file_not_found_hook(d->filename);
4689 return ReadFileNotFound;
4690 if (!d->filename.isReadableFile())
4696 Buffer::ReadStatus Buffer::loadEmergency()
4698 FileName const emergencyFile = getEmergencyFileName();
4699 if (!emergencyFile.exists()
4700 || emergencyFile.lastModified() <= d->filename.lastModified())
4701 return ReadFileNotFound;
4703 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4704 docstring const text = bformat(_("An emergency save of the document "
4705 "%1$s exists.\n\nRecover emergency save?"), file);
4707 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4708 0, 3, _("&Recover"), _("&Load Original"), _("&Only show difference"), _("&Cancel"));
4714 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4715 bool const success = (ret_llf == ReadSuccess);
4717 if (hasReadonlyFlag()) {
4718 Alert::warning(_("File is read-only"),
4719 bformat(_("An emergency file is successfully loaded, "
4720 "but the original file %1$s is marked read-only. "
4721 "Please make sure to save the document as a different "
4722 "file."), from_utf8(d->filename.absFileName())));
4725 lyxvc().file_found_hook(d->filename);
4726 str = _("Document was successfully recovered.");
4728 str = _("Document was NOT successfully recovered.");
4729 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4730 makeDisplayPath(emergencyFile.absFileName()));
4732 int const del_emerg =
4733 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4734 _("&Remove"), _("&Keep"));
4735 if (del_emerg == 0) {
4736 emergencyFile.removeFile();
4738 Alert::warning(_("Emergency file deleted"),
4739 _("Do not forget to save your file now!"), true);
4741 return success ? ReadSuccess : ReadEmergencyFailure;
4744 int const del_emerg =
4745 Alert::prompt(_("Delete emergency file?"),
4746 _("Remove emergency file now?"), 1, 1,
4747 _("&Remove"), _("&Keep"));
4749 emergencyFile.removeFile();
4753 string const ename = emergencyFile.absFileName();
4755 // Surely we can find one in 100 tries?
4756 for (int i = 1; i < 100; ++i) {
4757 newname.set(ename + to_string(i) + ".lyx");
4758 if (!newname.exists()) {
4764 // renameTo returns true on success. So inverting that
4765 // will give us true if we fail.
4766 noname = !emergencyFile.renameTo(newname);
4769 Alert::warning(_("Can't rename emergency file!"),
4770 _("LyX was unable to rename the emergency file. "
4771 "You should do so manually. Otherwise, you will be "
4772 "asked about it again the next time you try to load "
4773 "this file, and may over-write your own work."));
4775 Alert::warning(_("Emergency File Renames"),
4776 bformat(_("Emergency file renamed as:\n %1$s"),
4777 from_utf8(newname.onlyFileName())));
4780 return ReadOriginal;
4784 string const f1 = d->filename.absFileName();
4785 string const f2 = emergencyFile.absFileName();
4786 if (loadThisLyXFile(d->filename) != ReadSuccess)
4788 string const par = "compare run-blocking " + quoteName(f1) + " " + quoteName(f2);
4789 LYXERR(Debug::FILES, par << "\n");
4790 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, par));
4792 //release the emergency buffer loaded by compare
4793 Buffer * emerBuffer = theBufferList().getBuffer(emergencyFile);
4795 theBufferList().release(emerBuffer);
4797 return ReadCancel; //Release the buffer of Original immediatelly
4806 Buffer::ReadStatus Buffer::loadAutosave()
4808 // Now check if autosave file is newer.
4809 FileName const autosaveFile = getAutosaveFileName();
4810 if (!autosaveFile.exists()
4811 || autosaveFile.lastModified() <= d->filename.lastModified())
4812 return ReadFileNotFound;
4814 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4815 docstring const text = bformat(_("The backup of the document %1$s "
4816 "is newer.\n\nLoad the backup instead?"), file);
4817 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4818 _("&Load backup"), _("Load &original"), _("&Cancel"));
4823 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4824 // the file is not saved if we load the autosave file.
4825 if (ret_llf == ReadSuccess) {
4826 if (hasReadonlyFlag()) {
4827 Alert::warning(_("File is read-only"),
4828 bformat(_("A backup file is successfully loaded, "
4829 "but the original file %1$s is marked read-only. "
4830 "Please make sure to save the document as a "
4832 from_utf8(d->filename.absFileName())));
4835 lyxvc().file_found_hook(d->filename);
4838 return ReadAutosaveFailure;
4841 // Here we delete the autosave
4842 autosaveFile.removeFile();
4843 return ReadOriginal;
4851 Buffer::ReadStatus Buffer::loadLyXFile()
4853 if (!d->filename.isReadableFile()) {
4854 ReadStatus const ret_rvc = extractFromVC();
4855 if (ret_rvc != ReadSuccess)
4859 ReadStatus const ret_re = loadEmergency();
4860 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4863 ReadStatus const ret_ra = loadAutosave();
4864 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4867 return loadThisLyXFile(d->filename);
4871 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4873 return readFile(fn);
4877 void Buffer::Impl::traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const
4879 for (; err != end; ++err) {
4880 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4881 int errorRow = err->error_in_line;
4882 Buffer const * buf = nullptr;
4883 Impl const * p = this;
4884 if (err->child_name.empty())
4885 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4887 // The error occurred in a child
4888 for (Buffer const * child : owner_->getDescendants()) {
4889 string const child_name =
4890 DocFileName(changeExtension(child->absFileName(), "tex")).
4892 if (err->child_name != child_name)
4894 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4895 if (!TexRow::isNone(start)) {
4896 buf = this->cloned_buffer_
4897 ? child->d->cloned_buffer_->d->owner_
4904 errorList.push_back(ErrorItem(err->error_desc, err->error_text,
4910 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4912 TeXErrors::Errors::const_iterator err = terr.begin();
4913 TeXErrors::Errors::const_iterator end = terr.end();
4915 d->traverseErrors(err, end, errorList);
4919 void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const
4921 TeXErrors::Errors::const_iterator err = terr.begin_ref();
4922 TeXErrors::Errors::const_iterator end = terr.end_ref();
4924 d->traverseErrors(err, end, errorList);
4928 void Buffer::updateBuffer() const
4930 updateBuffer(UpdateMaster, InternalUpdate);
4931 d->need_update = false;
4935 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4937 LBUFERR(!text().paragraphs().empty());
4939 // Use the master text class also for child documents
4940 Buffer const * const master = masterBuffer();
4941 DocumentClass const & textclass = master->params().documentClass();
4943 docstring_list old_bibfiles;
4944 // Do this only if we are the top-level Buffer. We also need to account
4945 // for the case of a previewed child with ignored parent here.
4946 if (master == this && !d->ignore_parent) {
4947 textclass.counters().reset(from_ascii("bibitem"));
4948 reloadBibInfoCache();
4949 // we will re-read this cache as we go through, but we need
4950 // to know whether it's changed to know whether we need to
4951 // update the bibinfo cache.
4952 old_bibfiles = d->bibfiles_cache_;
4953 d->bibfiles_cache_.clear();
4956 // keep the buffers to be children in this set. If the call from the
4957 // master comes back we can see which of them were actually seen (i.e.
4958 // via an InsetInclude). The remaining ones in the set need still be updated.
4959 static std::set<Buffer const *> bufToUpdate;
4960 if (scope == UpdateMaster) {
4961 // If this is a child document start with the master
4962 if (master != this) {
4963 bufToUpdate.insert(this);
4964 master->updateBuffer(UpdateMaster, utype);
4965 // If the master buffer has no gui associated with it, then the TocModel is
4966 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4967 // (bug 5699). The same happens if the master buffer is open in a different
4968 // window. This test catches both possibilities.
4969 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
4970 // There remains a problem here: If there is another child open in yet a third
4971 // window, that TOC is not updated. So some more general solution is needed at
4973 if (master->d->gui_ != d->gui_)
4976 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4977 if (bufToUpdate.find(this) == bufToUpdate.end())
4981 // start over the counters in the master
4982 textclass.counters().reset();
4985 // update will be done below for this buffer
4986 bufToUpdate.erase(this);
4988 // update all caches
4989 clearReferenceCache();
4992 Buffer & cbuf = const_cast<Buffer &>(*this);
4993 // if we are reloading, then we could have a dangling TOC,
4994 // in effect. so we need to go ahead and reset, even though
4995 // we will do so again when we rebuild the TOC later.
4996 cbuf.tocBackend().reset();
4999 ParIterator parit = cbuf.par_iterator_begin();
5000 if (scope == UpdateMaster)
5002 updateBuffer(parit, utype);
5004 // If this document has siblings, then update the TocBackend later. The
5005 // reason is to ensure that later siblings are up to date when e.g. the
5006 // broken or not status of references is computed. The update is called
5007 // in InsetInclude::addToToc.
5011 // if the bibfiles changed, the cache of bibinfo is invalid
5012 docstring_list new_bibfiles = d->bibfiles_cache_;
5013 // this is a trick to determine whether the two vectors have
5014 // the same elements.
5015 sort(new_bibfiles.begin(), new_bibfiles.end());
5016 sort(old_bibfiles.begin(), old_bibfiles.end());
5017 if (old_bibfiles != new_bibfiles) {
5018 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
5019 invalidateBibinfoCache();
5020 reloadBibInfoCache();
5021 // We relied upon the bibinfo cache when recalculating labels. But that
5022 // cache was invalid, although we didn't find that out until now. So we
5023 // have to do it all again.
5024 // That said, the only thing we really need to do is update the citation
5025 // labels. Nothing else will have changed. So we could create a new
5026 // UpdateType that would signal that fact, if we needed to do so.
5027 parit = cbuf.par_iterator_begin();
5028 // we will be re-doing the counters and references and such.
5029 textclass.counters().reset();
5030 clearReferenceCache();
5031 // we should not need to do this again?
5033 updateBuffer(parit, utype);
5034 // this will already have been done by reloadBibInfoCache();
5035 // d->bibinfo_cache_valid_ = true;
5038 LYXERR(Debug::FILES, "Bibfiles unchanged.");
5039 // this is also set to true on the other path, by reloadBibInfoCache.
5040 d->bibinfo_cache_valid_ = true;
5042 d->cite_labels_valid_ = true;
5045 cbuf.tocBackend().update(true, utype);
5046 if (scope == UpdateMaster)
5047 cbuf.structureChanged();
5049 d->need_update = false;
5053 static depth_type getDepth(DocIterator const & it)
5055 depth_type depth = 0;
5056 for (size_t i = 0 ; i < it.depth() ; ++i)
5057 if (!it[i].inset().inMathed())
5058 depth += it[i].paragraph().getDepth() + 1;
5059 // remove 1 since the outer inset does not count
5060 // we should have at least one non-math inset, so
5061 // depth should nevery be 0. but maybe it is worth
5062 // marking this, just in case.
5064 // coverity[INTEGER_OVERFLOW]
5068 static depth_type getItemDepth(ParIterator const & it)
5070 Paragraph const & par = *it;
5071 LabelType const labeltype = par.layout().labeltype;
5073 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5076 // this will hold the lowest depth encountered up to now.
5077 depth_type min_depth = getDepth(it);
5078 ParIterator prev_it = it;
5081 --prev_it.top().pit();
5083 // start of nested inset: go to outer par
5085 if (prev_it.empty()) {
5086 // start of document: nothing to do
5091 // We search for the first paragraph with same label
5092 // that is not more deeply nested.
5093 Paragraph & prev_par = *prev_it;
5094 depth_type const prev_depth = getDepth(prev_it);
5095 if (labeltype == prev_par.layout().labeltype) {
5096 if (prev_depth < min_depth)
5097 return prev_par.itemdepth + 1;
5098 if (prev_depth == min_depth)
5099 return prev_par.itemdepth;
5101 min_depth = min(min_depth, prev_depth);
5102 // small optimization: if we are at depth 0, we won't
5103 // find anything else
5104 if (prev_depth == 0)
5110 static bool needEnumCounterReset(ParIterator const & it)
5112 Paragraph const & par = *it;
5113 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5114 depth_type const cur_depth = par.getDepth();
5115 ParIterator prev_it = it;
5116 while (prev_it.pit()) {
5117 --prev_it.top().pit();
5118 Paragraph const & prev_par = *prev_it;
5119 if (prev_par.getDepth() <= cur_depth)
5120 return prev_par.layout().name() != par.layout().name();
5122 // start of nested inset: reset
5127 // set the label of a paragraph. This includes the counters.
5128 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5130 BufferParams const & bp = owner_->masterBuffer()->params();
5131 DocumentClass const & textclass = bp.documentClass();
5132 Paragraph & par = it.paragraph();
5133 Layout const & layout = par.layout();
5134 Counters & counters = textclass.counters();
5136 if (par.params().startOfAppendix()) {
5137 // We want to reset the counter corresponding to toplevel sectioning
5138 Layout const & lay = textclass.getTOCLayout();
5139 docstring const cnt = lay.counter;
5141 counters.reset(cnt);
5142 counters.appendix(true);
5144 par.params().appendix(counters.appendix());
5146 // Compute the item depth of the paragraph
5147 par.itemdepth = getItemDepth(it);
5149 if (layout.margintype == MARGIN_MANUAL) {
5150 if (par.params().labelWidthString().empty())
5151 par.params().labelWidthString(par.expandLabel(layout, bp));
5152 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5153 // we do not need to do anything here, since the empty case is
5154 // handled during export.
5156 par.params().labelWidthString(docstring());
5159 switch(layout.labeltype) {
5160 case LABEL_ITEMIZE: {
5161 // At some point of time we should do something more
5162 // clever here, like:
5163 // par.params().labelString(
5164 // bp.user_defined_bullet(par.itemdepth).getText());
5165 // for now, use a simple hardcoded label
5166 docstring itemlabel;
5167 switch (par.itemdepth) {
5170 itemlabel = char_type(0x2022);
5174 itemlabel = char_type(0x2013);
5177 // ∗ U+2217 ASTERISK OPERATOR
5178 itemlabel = char_type(0x2217);
5181 // · U+00B7 MIDDLE DOT
5182 itemlabel = char_type(0x00b7);
5185 par.params().labelString(itemlabel);
5189 case LABEL_ENUMERATE: {
5190 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5192 switch (par.itemdepth) {
5203 enumcounter += "iv";
5206 // not a valid enumdepth...
5210 if (needEnumCounterReset(it)) {
5211 // Increase the parent counter?
5212 if (layout.stepparentcounter)
5213 counters.stepParent(enumcounter, utype);
5214 // Maybe we have to reset the enumeration counter.
5215 if (!layout.resumecounter)
5216 counters.reset(enumcounter);
5218 counters.step(enumcounter, utype);
5220 string const & lang = par.getParLanguage(bp)->code();
5221 par.params().labelString(counters.theCounter(enumcounter, lang));
5226 case LABEL_SENSITIVE: {
5227 string const & type = counters.current_float();
5228 docstring full_label;
5230 full_label = owner_->B_("Senseless!!! ");
5232 docstring name = owner_->B_(textclass.floats().getType(type).name());
5233 if (counters.hasCounter(from_utf8(type))) {
5234 string const & lang = par.getParLanguage(bp)->code();
5235 counters.step(from_utf8(type), utype);
5236 full_label = bformat(from_ascii("%1$s %2$s:"),
5238 counters.theCounter(from_utf8(type), lang));
5240 full_label = bformat(from_ascii("%1$s #:"), name);
5242 par.params().labelString(full_label);
5246 case LABEL_NO_LABEL:
5247 par.params().labelString(docstring());
5251 case LABEL_CENTERED:
5252 case LABEL_STATIC: {
5253 docstring const & lcounter = layout.counter;
5254 if (!lcounter.empty()) {
5255 if (layout.toclevel <= bp.secnumdepth
5256 && (layout.latextype != LATEX_ENVIRONMENT
5257 || it.text()->isFirstInSequence(it.pit()))) {
5258 if (counters.hasCounter(lcounter))
5259 counters.step(lcounter, utype);
5260 par.params().labelString(par.expandLabel(layout, bp));
5262 par.params().labelString(docstring());
5264 par.params().labelString(par.expandLabel(layout, bp));
5270 par.params().labelString(par.expandLabel(layout, bp));
5275 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype, bool const deleted) const
5277 pushIncludedBuffer(this);
5278 // LASSERT: Is it safe to continue here, or should we just return?
5279 LASSERT(parit.pit() == 0, /**/);
5281 // Set the position of the text in the buffer to be able
5282 // to resolve macros in it.
5283 parit.text()->setMacrocontextPosition(parit);
5285 depth_type maxdepth = 0;
5286 pit_type const lastpit = parit.lastpit();
5287 bool changed = false;
5288 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5289 // reduce depth if necessary
5290 if (parit->params().depth() > maxdepth) {
5291 /** FIXME: this function is const, but
5292 * nevertheless it modifies the buffer. To be
5293 * cleaner, one should modify the buffer in
5294 * another function, which is actually
5295 * non-const. This would however be costly in
5296 * terms of code duplication.
5298 CursorData(parit).recordUndo();
5299 parit->params().depth(maxdepth);
5301 maxdepth = parit->getMaxDepthAfter();
5303 if (utype == OutputUpdate) {
5304 // track the active counters
5305 // we have to do this for the master buffer, since the local
5306 // buffer isn't tracking anything.
5307 masterBuffer()->params().documentClass().counters().
5308 setActiveLayout(parit->layout());
5311 // set the counter for this paragraph
5312 d->setLabel(parit, utype);
5315 for (auto const & insit : parit->insetList()) {
5316 parit.pos() = insit.pos;
5317 insit.inset->updateBuffer(parit, utype, deleted || parit->isDeleted(insit.pos));
5318 changed |= insit.inset->isChanged();
5321 // are there changes in this paragraph?
5322 changed |= parit->isChanged();
5325 // set change indicator for the inset (or the cell that the iterator
5326 // points to, if applicable).
5327 parit.text()->inset().isChanged(changed);
5328 popIncludedBuffer();
5332 void Buffer::forceUpdate() const
5334 d->need_update = true;
5338 bool Buffer::needUpdate() const
5340 return d->need_update;
5344 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5345 WordLangTuple & word_lang, docstring_list & suggestions) const
5349 suggestions.clear();
5350 word_lang = WordLangTuple();
5351 bool const to_end = to.empty();
5352 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5353 // OK, we start from here.
5354 for (; from != end; from.forwardPos()) {
5355 // This skips all insets with spell check disabled.
5356 while (!from.allowSpellCheck()) {
5360 // If from is at the end of the document (which is possible
5361 // when "from" was changed above) LyX will crash later otherwise.
5362 if (from.atEnd() || (!to_end && from >= end))
5365 from.paragraph().spellCheck();
5366 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5367 if (SpellChecker::misspelled(res)) {
5371 // Do not increase progress when from == to, otherwise the word
5372 // count will be wrong.
5382 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5384 bool inword = false;
5389 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5390 if (!dit.inTexted()) {
5395 Paragraph const & par = dit.paragraph();
5396 pos_type const pos = dit.pos();
5398 // Copied and adapted from isWordSeparator() in Paragraph
5399 if (pos == dit.lastpos()) {
5402 Inset const * ins = par.getInset(pos);
5403 if (ins && skipNoOutput && !ins->producesOutput()) {
5406 // stop if end of range was skipped
5407 if (!to.atEnd() && dit >= to)
5410 } else if (!par.isDeleted(pos)) {
5411 if (par.isWordSeparator(pos))
5417 if (ins && ins->isLetter()) {
5418 odocstringstream os;
5420 char_count_ += os.str().length();
5422 else if (ins && ins->isSpace())
5425 pair<int, int> words = ins->isWords();
5426 char_count_ += words.first;
5427 word_count_ += words.second;
5431 char_type const c = par.getChar(pos);
5432 if (isPrintableNonspace(c))
5434 else if (isSpace(c))
5444 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5446 d->updateStatistics(from, to, skipNoOutput);
5450 int Buffer::wordCount() const
5452 return d->wordCount();
5456 int Buffer::charCount(bool with_blanks) const
5458 return d->charCount(with_blanks);
5462 bool Buffer::areChangesPresent() const
5464 return inset().isChanged();
5468 Buffer::ReadStatus Buffer::reload()
5471 // c.f. bug https://www.lyx.org/trac/ticket/6587
5472 removeAutosaveFile();
5473 // e.g., read-only status could have changed due to version control
5474 d->filename.refresh();
5475 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5477 // clear parent. this will get reset if need be.
5478 d->setParent(nullptr);
5479 ReadStatus const status = loadLyXFile();
5480 if (status == ReadSuccess) {
5485 message(bformat(_("Document %1$s reloaded."), disp_fn));
5488 message(bformat(_("Could not reload document %1$s."), disp_fn));
5498 bool Buffer::saveAs(FileName const & fn)
5500 FileName const old_name = fileName();
5501 FileName const old_auto = getAutosaveFileName();
5502 bool const old_unnamed = isUnnamed();
5503 bool success = true;
5504 d->old_position = filePath();
5511 // bring the autosave file with us, just in case.
5512 moveAutosaveFile(old_auto);
5513 // validate version control data and
5514 // correct buffer title
5515 lyxvc().file_found_hook(fileName());
5517 // the file has now been saved to the new location.
5518 // we need to check that the locations of child buffers
5520 checkChildBuffers();
5521 checkMasterBuffer();
5524 // reset the old filename and unnamed state
5525 setFileName(old_name);
5526 setUnnamed(old_unnamed);
5530 d->old_position.clear();
5535 void Buffer::checkChildBuffers()
5537 for (auto const & bit : d->children_positions) {
5538 DocIterator dit = bit.second;
5539 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5540 if (!cbuf || !theBufferList().isLoaded(cbuf))
5542 Inset * inset = dit.nextInset();
5543 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5544 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5545 docstring const & incfile = inset_inc->getParam("filename");
5546 string oldloc = cbuf->absFileName();
5547 string newloc = makeAbsPath(to_utf8(incfile),
5548 onlyPath(absFileName())).absFileName();
5549 if (oldloc == newloc)
5551 // the location of the child file is incorrect.
5552 cbuf->setParent(nullptr);
5553 inset_inc->setChildBuffer(nullptr);
5555 // invalidate cache of children
5556 d->children_positions.clear();
5557 d->position_to_children.clear();
5561 // If a child has been saved under a different name/path, it might have been
5562 // orphaned. Therefore the master needs to be reset (bug 8161).
5563 void Buffer::checkMasterBuffer()
5565 Buffer const * const master = masterBuffer();
5569 // necessary to re-register the child (bug 5873)
5570 // FIXME: clean up updateMacros (here, only
5571 // child registering is needed).
5572 master->updateMacros();
5573 // (re)set master as master buffer, but only
5574 // if we are a real child
5575 if (master->isChild(this))
5582 string Buffer::includedFilePath(string const & name, string const & ext) const
5584 if (d->old_position.empty() ||
5585 equivalent(FileName(d->old_position), FileName(filePath())))
5588 bool isabsolute = FileName::isAbsolute(name);
5589 // both old_position and filePath() end with a path separator
5590 string absname = isabsolute ? name : d->old_position + name;
5592 // if old_position is set to origin, we need to do the equivalent of
5593 // getReferencedFileName() (see readDocument())
5594 if (!isabsolute && d->old_position == params().origin) {
5595 FileName const test(addExtension(filePath() + name, ext));
5597 absname = filePath() + name;
5600 if (!FileName(addExtension(absname, ext)).exists())
5604 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5606 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5607 from_utf8(filePath())));
5611 void Buffer::Impl::refreshFileMonitor()
5613 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5614 file_monitor_->refresh();
5618 // The previous file monitor is invalid
5619 // This also destroys the previous file monitor and all its connections
5620 file_monitor_ = FileSystemWatcher::monitor(filename);
5621 // file_monitor_ will be destroyed with *this, so it is not going to call a
5622 // destroyed object method.
5623 file_monitor_->connect([this](bool exists) {
5624 fileExternallyModified(exists);
5629 void Buffer::Impl::fileExternallyModified(bool const exists)
5631 // ignore notifications after our own saving operations
5632 if (checksum_ == filename.checksum()) {
5633 LYXERR(Debug::FILES, "External modification but "
5634 "checksum unchanged: " << filename);
5637 // If the file has been deleted, only mark the file as dirty since it is
5638 // pointless to prompt for reloading. If later a file is moved into this
5639 // location, then the externally modified warning will appear then.
5641 externally_modified_ = true;
5642 // Update external modification notification.
5643 // Dirty buffers must be visible at all times.
5644 if (wa_ && wa_->unhide(owner_))
5645 wa_->updateTitles();
5647 // Unable to unhide the buffer (e.g. no GUI or not current View)
5652 bool Buffer::notifiesExternalModification() const
5654 return d->externally_modified_;
5658 void Buffer::clearExternalModification() const
5660 d->externally_modified_ = false;
5662 d->wa_->updateTitles();
5666 void Buffer::pushIncludedBuffer(Buffer const * buf) const
5668 masterBuffer()->d->include_list_.push_back(buf);
5669 if (lyxerr.debugging(Debug::FILES)) {
5670 LYXERR0("Pushed. Stack now:");
5671 if (masterBuffer()->d->include_list_.empty())
5674 for (auto const & b : masterBuffer()->d->include_list_)
5675 LYXERR0(b->fileName());
5680 void Buffer::popIncludedBuffer() const
5682 masterBuffer()->d->include_list_.pop_back();
5683 if (lyxerr.debugging(Debug::FILES)) {
5684 LYXERR0("Popped. Stack now:");
5685 if (masterBuffer()->d->include_list_.empty())
5688 for (auto const & b : masterBuffer()->d->include_list_)
5689 LYXERR0(b->fileName());
5694 bool Buffer::isBufferIncluded(Buffer const * buf) const
5698 if (lyxerr.debugging(Debug::FILES)) {
5699 LYXERR0("Checking for " << buf->fileName() << ". Stack now:");
5700 if (masterBuffer()->d->include_list_.empty())
5703 for (auto const & b : masterBuffer()->d->include_list_)
5704 LYXERR0(b->fileName());
5706 list<Buffer const *> const & blist = masterBuffer()->d->include_list_;
5707 return find(blist.begin(), blist.end(), buf) != blist.end();
5711 void Buffer::clearIncludeList() const
5713 LYXERR(Debug::FILES, "Clearing include list for " << fileName());
5714 d->include_list_.clear();