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().document_metadata.clear();
945 params().indiceslist().clear();
946 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
947 params().isbackgroundcolor = false;
948 params().fontcolor = RGBColor(0, 0, 0);
949 params().isfontcolor = false;
950 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
951 params().isnotefontcolor = false;
952 params().boxbgcolor = RGBColor(0xFF, 0, 0);
953 params().isboxbgcolor = false;
954 params().html_latex_start.clear();
955 params().html_latex_end.clear();
956 params().html_math_img_scale = 1.0;
957 params().output_sync_macro.erase();
958 params().setLocalLayout(docstring(), false);
959 params().setLocalLayout(docstring(), true);
960 params().biblio_opts.erase();
961 params().biblatex_bibstyle.erase();
962 params().biblatex_citestyle.erase();
963 params().multibib.erase();
964 params().lineno_opts.clear();
965 params().spellignore().clear();
967 for (int i = 0; i < 4; ++i) {
968 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
969 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
972 ErrorList & errorList = d->errorLists["Parse"];
981 if (token == "\\end_header")
985 if (token == "\\begin_header") {
986 begin_header_line = line;
990 LYXERR(Debug::PARSER, "Handling document header token: `"
993 string const result =
994 params().readToken(lex, token, d->filename);
995 if (!result.empty()) {
996 if (token == "\\textclass") {
997 d->layout_position = result;
1000 docstring const s = bformat(_("Unknown token: "
1003 lex.getDocString());
1004 errorList.push_back(ErrorItem(_("Document header error"), s));
1008 if (begin_header_line) {
1009 docstring const s = _("\\begin_header is missing");
1010 errorList.push_back(ErrorItem(_("Document header error"), s));
1013 params().shell_escape = theSession().shellescapeFiles().find(absFileName());
1015 params().makeDocumentClass(isClone(), isInternal());
1017 return unknown_tokens;
1022 // changed to be public and have one parameter
1023 // Returns true if "\end_document" is not read (Asger)
1024 bool Buffer::readDocument(Lexer & lex)
1026 ErrorList & errorList = d->errorLists["Parse"];
1029 // remove dummy empty par
1030 paragraphs().clear();
1032 if (!lex.checkFor("\\begin_document")) {
1033 docstring const s = _("\\begin_document is missing");
1034 errorList.push_back(ErrorItem(_("Document header error"), s));
1039 if (params().output_changes) {
1040 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1041 LaTeXFeatures::isAvailable("xcolor");
1044 Alert::warning(_("Changes not shown in LaTeX output"),
1045 _("Changes will not be highlighted in LaTeX output, "
1046 "because xcolor and ulem are not installed.\n"
1047 "Please install both packages or redefine "
1048 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1052 if (!parent() && !params().master.empty()) {
1053 FileName const master_file = makeAbsPath(params().master,
1054 onlyPath(absFileName()));
1055 if (isLyXFileName(master_file.absFileName())) {
1057 checkAndLoadLyXFile(master_file, true);
1059 // necessary e.g. after a reload
1060 // to re-register the child (bug 5873)
1061 // FIXME: clean up updateMacros (here, only
1062 // child registering is needed).
1063 master->updateMacros();
1064 // set master as master buffer, but only
1065 // if we are a real child
1066 if (master->isChild(this))
1068 // if the master is not fully loaded
1069 // it is probably just loading this
1070 // child. No warning needed then.
1071 else if (master->isFullyLoaded())
1072 LYXERR0("The master '"
1074 << "' assigned to this document ("
1076 << ") does not include "
1077 "this document. Ignoring the master assignment.");
1078 // If the master has just been created, un-hide it (#11162)
1079 if (!master->fileName().exists())
1080 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
1081 master->absFileName()));
1086 // assure we have a default index
1087 params().indiceslist().addDefault(B_("Index"));
1090 if (FileName::isAbsolute(params().origin))
1091 d->old_position = params().origin;
1093 d->old_position = filePath();
1098 bool const res = text().read(lex, errorList, d->inset);
1099 d->old_position.clear();
1101 // inform parent buffer about local macros
1103 Buffer const * pbuf = parent();
1104 for (auto const & m : usermacros)
1105 pbuf->usermacros.insert(m);
1109 updateMacroInstances(InternalUpdate);
1114 bool Buffer::isSyncTeXenabled() const
1116 bool enabled = params().output_sync;
1119 for (auto const & c : theConverters()) {
1120 const string dest = c.to().substr(0,3);
1121 if (dest == "dvi" || dest == "pdf") {
1122 const string cmd = c.command();
1123 enabled |= cmd.find("-synctex=") != string::npos
1124 && cmd.find("-synctex=0") == string::npos;
1132 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1134 Format const * fmt = theFormats().getFormat(format);
1137 // It is important to use the correct extension here, since some
1138 // converters create a wrong output file otherwise (e.g. html2latex)
1139 FileName const name = tempFileName("Buffer_importStringXXXXXX." + fmt->extension());
1140 ofdocstream os(name.toFilesystemEncoding().c_str());
1141 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1142 bool const success = !(os << contents).fail();
1145 bool converted = false;
1147 params().compressed = false;
1149 // remove dummy empty par
1150 paragraphs().clear();
1152 converted = importFile(format, name, errorList);
1155 removeTempFile(name);
1160 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1162 if (!theConverters().isReachable(format, "lyx"))
1165 FileName const lyx = tempFileName("Buffer_importFileXXXXXX.lyx");
1166 Converters::RetVal const retval =
1167 theConverters().convert(this, name, lyx, name, format, "lyx", errorList);
1168 if (retval == Converters::SUCCESS) {
1169 bool const success = readFile(lyx) == ReadSuccess;
1170 removeTempFile(lyx);
1178 bool Buffer::readString(string const & s)
1180 params().compressed = false;
1183 istringstream is(s);
1185 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1186 FileName const fn = tempfile.name();
1189 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1191 if (success && file_format != LYX_FORMAT) {
1192 // We need to call lyx2lyx, so write the input to a file
1193 ofstream os(fn.toFilesystemEncoding().c_str());
1196 // lyxvc in readFile
1197 if (readFile(fn) != ReadSuccess)
1201 if (readDocument(lex))
1207 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1210 if (!lex.setFile(fn)) {
1211 Alert::error(_("File Not Found"),
1212 bformat(_("Unable to open file `%1$s'."),
1213 from_utf8(fn.absFileName())));
1214 return ReadFileNotFound;
1218 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1219 if (ret_plf != ReadSuccess)
1222 if (file_format != LYX_FORMAT) {
1224 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1225 if (ret_clf != ReadSuccess)
1227 ret_clf = readFile(tmpFile);
1228 if (ret_clf == ReadSuccess) {
1229 d->file_format = file_format;
1230 d->need_format_backup = true;
1235 // FIXME: InsetInfo needs to know whether the file is under VCS
1236 // during the parse process, so this has to be done before.
1237 lyxvc().file_found_hook(d->filename);
1239 if (readDocument(lex)) {
1240 Alert::error(_("Document format failure"),
1241 bformat(_("%1$s ended unexpectedly, which means"
1242 " that it is probably corrupted."),
1243 from_utf8(fn.absFileName())));
1244 return ReadDocumentFailure;
1247 d->file_fully_loaded = true;
1248 d->read_only = !d->filename.isWritable();
1249 params().compressed = theFormats().isZippedFile(d->filename);
1255 bool Buffer::isFullyLoaded() const
1257 return d->file_fully_loaded;
1261 void Buffer::setFullyLoaded(bool value)
1263 d->file_fully_loaded = value;
1267 bool Buffer::freshStartRequired() const
1269 return d->require_fresh_start_;
1272 void Buffer::requireFreshStart(bool const b) const
1274 d->require_fresh_start_ = b;
1278 PreviewLoader * Buffer::loader() const
1280 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1282 if (!d->preview_loader_)
1283 d->preview_loader_ = new PreviewLoader(*this);
1284 return d->preview_loader_;
1288 void Buffer::removePreviews() const
1290 delete d->preview_loader_;
1291 d->preview_loader_ = nullptr;
1295 void Buffer::updatePreviews() const
1297 PreviewLoader * ploader = loader();
1301 InsetIterator it = begin(*d->inset);
1302 InsetIterator const itend = end(*d->inset);
1303 for (; it != itend; ++it)
1304 it->addPreview(it, *ploader);
1306 ploader->startLoading();
1310 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1311 FileName const & fn, int & file_format) const
1313 if(!lex.checkFor("\\lyxformat")) {
1314 Alert::error(_("Document format failure"),
1315 bformat(_("%1$s is not a readable LyX document."),
1316 from_utf8(fn.absFileName())));
1317 return ReadNoLyXFormat;
1323 // LyX formats 217 and earlier were written as 2.17. This corresponds
1324 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1325 // these cases. See also: www.lyx.org/trac/changeset/1313.
1326 size_t dot = tmp_format.find_first_of(".,");
1327 if (dot != string::npos)
1328 tmp_format.erase(dot, 1);
1330 file_format = convert<int>(tmp_format);
1335 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1336 FileName & tmpfile, int from_format)
1338 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1339 tempfile.setAutoRemove(false);
1340 tmpfile = tempfile.name();
1341 if(tmpfile.empty()) {
1342 Alert::error(_("Conversion failed"),
1343 bformat(_("%1$s is from a different"
1344 " version of LyX, but a temporary"
1345 " file for converting it could"
1346 " not be created."),
1347 from_utf8(fn.absFileName())));
1348 return LyX2LyXNoTempFile;
1351 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1352 if (lyx2lyx.empty()) {
1353 Alert::error(_("Conversion script not found"),
1354 bformat(_("%1$s is from a different"
1355 " version of LyX, but the"
1356 " conversion script lyx2lyx"
1357 " could not be found."),
1358 from_utf8(fn.absFileName())));
1359 return LyX2LyXNotFound;
1363 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1364 ostringstream command;
1365 command << os::python()
1366 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1367 << " -t " << convert<string>(LYX_FORMAT)
1368 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1369 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1370 string const command_str = command.str();
1372 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1374 cmd_ret const ret = runCommand(command_str);
1376 if (from_format < LYX_FORMAT) {
1377 Alert::error(_("Conversion script failed"),
1378 bformat(_("%1$s is from an older version"
1379 " of LyX and the lyx2lyx script"
1380 " failed to convert it."),
1381 from_utf8(fn.absFileName())));
1382 return LyX2LyXOlderFormat;
1384 Alert::error(_("Conversion script failed"),
1385 bformat(_("%1$s is from a newer version"
1386 " of LyX and the lyx2lyx script"
1387 " failed to convert it."),
1388 from_utf8(fn.absFileName())));
1389 return LyX2LyXNewerFormat;
1396 FileName Buffer::getBackupName() const {
1397 map<int, string> const file_formats = {
1414 FileName const & fn = fileName();
1415 string const fname = fn.onlyFileNameWithoutExt();
1416 string const fext = fn.extension() + "~";
1417 string const fpath = lyxrc.backupdir_path.empty() ?
1418 fn.onlyPath().absFileName() :
1419 lyxrc.backupdir_path;
1420 string backup_suffix;
1421 // If file format is from a stable series use version instead of file format
1422 auto const it = file_formats.find(d->file_format);
1423 if (it != file_formats.end())
1424 backup_suffix = "-lyx" + it->second;
1426 backup_suffix = "-lyxformat-" + convert<string>(d->file_format);
1427 string const backname = fname + backup_suffix;
1428 FileName backup(addName(fpath, addExtension(backname, fext)));
1430 // limit recursion, just in case
1432 unsigned long orig_checksum = 0;
1433 while (backup.exists() && v < 100) {
1434 if (orig_checksum == 0)
1435 orig_checksum = fn.checksum();
1436 unsigned long new_checksum = backup.checksum();
1437 if (orig_checksum == new_checksum) {
1438 LYXERR(Debug::FILES, "Not backing up " << fn <<
1439 "since " << backup << "has the same checksum.");
1440 // a bit of a hack, but we have to check this anyway
1441 // below, and setting this is simpler than introducing
1442 // a special boolean for this purpose.
1446 string const newbackname = backname + "-" + convert<string>(v);
1447 backup.set(addName(fpath, addExtension(newbackname, fext)));
1450 return v < 100 ? backup : FileName();
1454 // Should probably be moved to somewhere else: BufferView? GuiView?
1455 bool Buffer::save() const
1457 docstring const file = makeDisplayPath(absFileName(), 20);
1458 d->filename.refresh();
1460 // check the read-only status before moving the file as a backup
1461 if (d->filename.exists()) {
1462 bool const read_only = !d->filename.isWritable();
1464 Alert::warning(_("File is read-only"),
1465 bformat(_("The file %1$s cannot be written because it "
1466 "is marked as read-only."), file));
1471 // ask if the disk file has been externally modified (use checksum method)
1472 if (fileName().exists() && isChecksumModified()) {
1474 bformat(_("Document %1$s has been externally modified. "
1475 "Are you sure you want to overwrite this file?"), file);
1476 int const ret = Alert::prompt(_("Overwrite modified file?"),
1477 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1482 // We don't need autosaves in the immediate future. (Asger)
1483 resetAutosaveTimers();
1485 // if the file does not yet exist, none of the backup activity
1486 // that follows is necessary
1487 if (!fileName().exists()) {
1488 if (!writeFile(fileName()))
1494 // we first write the file to a new name, then move it to its
1495 // proper location once that has been done successfully. that
1496 // way we preserve the original file if something goes wrong.
1497 string const justname = fileName().onlyFileNameWithoutExt();
1498 auto tempfile = lyx::make_unique<TempFile>(fileName().onlyPath(),
1499 justname + "-XXXXXX.lyx");
1500 bool const symlink = fileName().isSymLink();
1502 tempfile->setAutoRemove(false);
1504 FileName savefile(tempfile->name());
1505 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1506 if (!savefile.clonePermissions(fileName()))
1507 LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
1509 if (!writeFile(savefile))
1512 // we will set this to false if we fail
1513 bool made_backup = true;
1515 FileName backupName;
1516 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1518 if (d->need_format_backup)
1519 backupName = getBackupName();
1521 // If we for some reason failed to find a backup name in case of
1522 // a format change, this will still set one. It's the best we can
1524 if (backupName.empty()) {
1525 backupName.set(fileName().absFileName() + "~");
1526 if (!lyxrc.backupdir_path.empty()) {
1527 string const mangledName =
1528 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1529 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1533 LYXERR(Debug::FILES, "Backing up original file to " <<
1534 backupName.absFileName());
1535 // Except file is symlink do not copy because of #6587.
1536 // Hard links have bad luck.
1537 made_backup = symlink ?
1538 fileName().copyTo(backupName):
1539 fileName().moveTo(backupName);
1542 Alert::error(_("Backup failure"),
1543 bformat(_("Cannot create backup file %1$s.\n"
1544 "Please check whether the directory exists and is writable."),
1545 from_utf8(backupName.absFileName())));
1546 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1547 } else if (d->need_format_backup) {
1548 // the original file has been backed up successfully, so we
1549 // will not need to do that again
1550 d->need_format_backup = false;
1554 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1555 // Only do this if tempfile is not in autoremove mode
1558 // If we have no symlink, we can simply rename the temp file.
1559 // Otherwise, we need to copy it so the symlink stays intact.
1560 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1561 savefile.moveTo(fileName()))
1563 // saveCheckSum() was already called by writeFile(), but the
1564 // time stamp is invalidated by copying/moving
1567 // the file associated with this buffer is now in the current format
1568 d->file_format = LYX_FORMAT;
1571 // else we saved the file, but failed to move it to the right location.
1573 if (needBackup && made_backup && !symlink) {
1574 // the original file was moved to some new location, so it will look
1575 // to the user as if it was deleted. (see bug #9234.) we could try
1576 // to restore it, but that would basically mean trying to do again
1577 // what we just failed to do. better to leave things as they are.
1578 Alert::error(_("Write failure"),
1579 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1580 "But LyX could not move it to:\n %2$s.\n"
1581 "Your original file has been backed up to:\n %3$s"),
1582 from_utf8(savefile.absFileName()),
1583 from_utf8(fileName().absFileName()),
1584 from_utf8(backupName.absFileName())));
1586 // either we did not try to make a backup, or else we tried and failed,
1587 // or else the original file was a symlink, in which case it was copied,
1588 // not moved. so the original file is intact.
1589 Alert::error(_("Write failure"),
1590 bformat(_("Cannot move saved file to:\n %1$s.\n"
1591 "But the file has successfully been saved as:\n %2$s."),
1592 from_utf8(fileName().absFileName()),
1593 from_utf8(savefile.absFileName())));
1599 bool Buffer::writeFile(FileName const & fname) const
1601 if (d->read_only && fname == d->filename)
1604 bool retval = false;
1606 docstring const str = bformat(_("Saving document %1$s..."),
1607 makeDisplayPath(fname.absFileName()));
1610 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1612 if (params().compressed) {
1613 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1614 retval = ofs && write(ofs);
1616 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1617 retval = ofs && write(ofs);
1621 message(str + _(" could not write file!"));
1626 // removeAutosaveFile();
1629 message(str + _(" done."));
1635 docstring Buffer::emergencyWrite() const
1637 // No need to save if the buffer has not changed.
1641 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1643 docstring user_message = bformat(
1644 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1646 // We try to save three places:
1647 // 1) Same place as document. Unless it is an unnamed doc.
1649 string s = absFileName();
1652 if (writeFile(FileName(s))) {
1654 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1655 return user_message;
1657 user_message += " " + _("Save failed! Trying again...\n");
1661 // 2) In HOME directory.
1662 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1664 lyxerr << ' ' << s << endl;
1665 if (writeFile(FileName(s))) {
1667 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1668 return user_message;
1671 user_message += " " + _("Save failed! Trying yet again...\n");
1673 // 3) In "/tmp" directory.
1674 // MakeAbsPath to prepend the current
1675 // drive letter on OS/2
1676 s = addName(package().temp_dir().absFileName(), absFileName());
1678 lyxerr << ' ' << s << endl;
1679 if (writeFile(FileName(s))) {
1681 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1682 return user_message;
1685 user_message += " " + _("Save failed! Document is lost.");
1688 return user_message;
1692 bool Buffer::write(ostream & ofs) const
1695 // Use the standard "C" locale for file output.
1696 ofs.imbue(locale::classic());
1699 // The top of the file should not be written by params().
1701 // write out a comment in the top of the file
1702 // Important: Keep the version formatting in sync with lyx2lyx and
1703 // tex2lyx (bug 7951)
1704 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1705 << " created this file. For more info see https://www.lyx.org/\n"
1706 << "\\lyxformat " << LYX_FORMAT << "\n"
1707 << "\\begin_document\n";
1709 /// For each author, set 'used' to true if there is a change
1710 /// by this author in the document; otherwise set it to 'false'.
1711 for (Author const & a : params().authors())
1714 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1715 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1716 for ( ; it != end; ++it)
1717 it->checkAuthors(params().authors());
1719 // now write out the buffer parameters.
1720 ofs << "\\begin_header\n";
1721 params().writeFile(ofs, this);
1722 ofs << "\\end_header\n";
1725 ofs << "\n\\begin_body\n";
1727 ofs << "\n\\end_body\n";
1729 // Write marker that shows file is complete
1730 ofs << "\\end_document" << endl;
1732 // Shouldn't really be needed....
1735 // how to check if close went ok?
1736 // Following is an attempt... (BE 20001011)
1738 // good() returns false if any error occurred, including some
1739 // formatting error.
1740 // bad() returns true if something bad happened in the buffer,
1741 // which should include file system full errors.
1746 lyxerr << "File was not closed properly." << endl;
1753 Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
1754 string const & original_path,
1755 OutputParams const & runparams_in,
1756 OutputWhat output) const
1758 OutputParams runparams = runparams_in;
1760 string const encoding = runparams.encoding->iconvName();
1761 LYXERR(Debug::OUTFILE, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1764 try { ofs.reset(encoding); }
1765 catch (iconv_codecvt_facet_exception const & e) {
1766 lyxerr << "Caught iconv exception: " << e.what() << endl;
1767 Alert::error(_("Iconv software exception Detected"),
1768 bformat(_("Please verify that the `iconv' support software is"
1769 " properly installed and supports the selected encoding"
1770 " (%1$s), or change the encoding in"
1771 " Document>Settings>Language."), from_ascii(encoding)));
1774 if (!openFileWrite(ofs, fname))
1777 ErrorList & errorList = d->errorLists["Export"];
1779 ExportStatus status = ExportSuccess;
1782 // make sure we are ready to export
1783 // this needs to be done before we validate
1784 // FIXME Do we need to do this all the time? I.e., in children
1785 // of a master we are exporting?
1787 updateMacroInstances(OutputUpdate);
1789 ExportStatus retval;
1791 retval = writeLaTeXSource(os, original_path, runparams, output);
1792 if (retval == ExportKilled)
1793 return ExportKilled;
1795 catch (EncodingException const & e) {
1796 docstring const failed(1, e.failed_char);
1798 oss << "0x" << hex << static_cast<uint32_t>(e.failed_char) << dec;
1799 if (getParFromID(e.par_id).paragraph().layout().pass_thru) {
1800 docstring msg = bformat(_("Uncodable character '%1$s'"
1801 " (code point %2$s)"),
1802 failed, from_utf8(oss.str()));
1803 errorList.push_back(ErrorItem(msg, _("Some characters of your document are not "
1804 "representable in specific verbatim contexts.\n"
1805 "Changing the document encoding to utf8 could help."),
1806 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1808 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1809 " (code point %2$s)"),
1810 failed, from_utf8(oss.str()));
1811 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1812 "representable in the chosen encoding.\n"
1813 "Changing the document encoding to utf8 could help."),
1814 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1816 status = ExportError;
1818 catch (iconv_codecvt_facet_exception const & e) {
1819 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1821 status = ExportError;
1823 catch (exception const & e) {
1824 errorList.push_back(ErrorItem(_("conversion failed"),
1826 lyxerr << e.what() << endl;
1827 status = ExportError;
1830 lyxerr << "Caught some really weird exception..." << endl;
1834 d->texrow = std::move(os.texrow());
1838 status = ExportError;
1839 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1842 if (runparams_in.silent)
1850 Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
1851 string const & original_path,
1852 OutputParams const & runparams_in,
1853 OutputWhat output) const
1855 // The child documents, if any, shall be already loaded at this point.
1857 OutputParams runparams = runparams_in;
1859 // Some macros rely on font encoding
1860 runparams.main_fontenc = params().main_font_encoding();
1862 // If we are compiling a file standalone, even if this is the
1863 // child of some other buffer, let's cut the link here, so the
1864 // file is really independent and no concurring settings from
1865 // the master (e.g. branch state) interfere (see #8100).
1866 if (!runparams.is_child)
1867 d->ignore_parent = true;
1869 // Classify the unicode characters appearing in math insets
1870 BufferEncodings::initUnicodeMath(*this);
1872 // validate the buffer.
1873 LYXERR(Debug::OUTFILE, " Validating buffer...");
1874 LaTeXFeatures features(*this, params(), runparams);
1876 // This is only set once per document (in master)
1877 if (!runparams.is_child) {
1878 runparams.use_polyglossia = features.usePolyglossia();
1879 runparams.use_hyperref = features.isRequired("hyperref");
1880 runparams.use_CJK = features.mustProvide("CJK");
1882 LYXERR(Debug::OUTFILE, " Buffer validation done.");
1884 bool const output_preamble =
1885 output == FullSource || output == OnlyPreamble;
1886 bool const output_body =
1887 output == FullSource || output == OnlyBody;
1889 // The starting paragraph of the coming rows is the
1890 // first paragraph of the document. (Asger)
1891 if (output_preamble && runparams.nice) {
1892 os << "%% LyX " << lyx_version << " created this file. "
1893 "For more info, see https://www.lyx.org/.\n"
1894 "%% Do not edit unless you really know what "
1897 LYXERR(Debug::INFO, "lyx document header finished");
1899 // There are a few differences between nice LaTeX and usual files:
1900 // usual files have \batchmode and special input@path to allow
1901 // inclusion of figures specified by an explicitly relative path
1902 // (i.e., a path starting with './' or '../') with either \input or
1903 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1904 // input@path is set when the actual parameter original_path is set.
1905 // This is done for usual tex-file, but not for nice-latex-file.
1906 // (Matthias 250696)
1907 // Note that input@path is only needed for something the user does
1908 // in the preamble, included .tex files or ERT, files included by
1909 // LyX work without it.
1910 if (output_preamble) {
1911 if (!runparams.nice) {
1912 // code for usual, NOT nice-latex-file
1913 os << "\\batchmode\n"; // changed from \nonstopmode
1915 if (!original_path.empty()) {
1917 // We don't know the encoding of inputpath
1918 docstring const inputpath = from_utf8(original_path);
1919 docstring uncodable_glyphs;
1920 Encoding const * const enc = runparams.encoding;
1922 for (char_type n : inputpath) {
1923 if (!enc->encodable(n)) {
1924 docstring const glyph(1, n);
1925 LYXERR0("Uncodable character '"
1927 << "' in input path!");
1928 uncodable_glyphs += glyph;
1933 // warn user if we found uncodable glyphs.
1934 if (!uncodable_glyphs.empty()) {
1935 frontend::Alert::warning(
1936 _("Uncodable character in file path"),
1938 _("The path of your document\n"
1940 "contains glyphs that are unknown "
1941 "in the current document encoding "
1942 "(namely %2$s). This may result in "
1943 "incomplete output, unless "
1944 "TEXINPUTS contains the document "
1945 "directory and you don't use "
1946 "explicitly relative paths (i.e., "
1947 "paths starting with './' or "
1948 "'../') in the preamble or in ERT."
1949 "\n\nIn case of problems, choose "
1950 "an appropriate document encoding\n"
1951 "(such as utf8) or change the "
1953 inputpath, uncodable_glyphs));
1955 string docdir = os::latex_path(original_path);
1956 if (contains(docdir, '#')) {
1957 docdir = subst(docdir, "#", "\\#");
1958 os << "\\catcode`\\#=11"
1959 "\\def\\#{#}\\catcode`\\#=6\n";
1961 if (contains(docdir, '%')) {
1962 docdir = subst(docdir, "%", "\\%");
1963 os << "\\catcode`\\%=11"
1964 "\\def\\%{%}\\catcode`\\%=14\n";
1966 if (contains(docdir, '~'))
1967 docdir = subst(docdir, "~", "\\string~");
1968 bool const nonascii = !isAscii(from_utf8(docdir));
1969 // LaTeX 2019/10/01 handles non-ascii path without detokenize
1970 bool const utfpathlatex = features.isAvailableAtLeastFrom("LaTeX", 2019, 10);
1971 bool const detokenize = !utfpathlatex && nonascii;
1972 bool const quote = contains(docdir, ' ');
1973 if (utfpathlatex && nonascii)
1974 os << "\\UseRawInputEncoding\n";
1975 os << "\\makeatletter\n"
1976 << "\\def\\input@path{{";
1978 os << "\\detokenize{";
1987 << "\\makeatother\n";
1991 // get parent macros (if this buffer has a parent) which will be
1992 // written at the document begin further down.
1993 MacroSet parentMacros;
1994 listParentMacros(parentMacros, features);
1996 // Write the preamble
1997 runparams.use_babel = params().writeLaTeX(os, features,
1998 d->filename.onlyPath());
2000 // Active characters
2001 runparams.active_chars = features.getActiveChars();
2003 // Biblatex bibliographies are loaded here
2004 if (params().useBiblatex()) {
2005 vector<pair<docstring, string>> const bibfiles =
2006 prepareBibFilePaths(runparams, getBibfiles(), true);
2007 for (pair<docstring, string> const & file: bibfiles) {
2008 os << "\\addbibresource";
2009 if (!file.second.empty())
2010 os << "[bibencoding=" << file.second << "]";
2011 os << "{" << file.first << "}\n";
2015 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
2016 && !features.hasOnlyPolyglossiaLanguages()) {
2019 vector<string> bll = features.getBabelExclusiveLanguages();
2020 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
2023 for (string const & sit : bll) {
2028 blangs = bll.size() > 1 ?
2029 bformat(_("The languages %1$s are only supported by Babel."), langs)
2030 : bformat(_("The language %1$s is only supported by Babel."), langs);
2034 for (string const & pit : pll) {
2039 plangs = pll.size() > 1 ?
2040 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
2041 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
2042 if (!blangs.empty())
2046 frontend::Alert::warning(
2047 _("Incompatible Languages!"),
2049 _("You cannot use the following languages "
2050 "together in one LaTeX document because "
2051 "they require conflicting language packages:\n"
2056 // Japanese might be required only in some children of a document,
2057 // but once required, we must keep use_japanese true.
2058 runparams.use_japanese |= features.isRequired("japanese");
2061 // Restore the parenthood if needed
2062 if (!runparams.is_child)
2063 d->ignore_parent = false;
2064 return ExportSuccess;
2068 // mark the beginning of the body to separate it from InPreamble insets
2069 os.texrow().start(TexRow::beginDocument());
2070 os << "\\begin{document}\n";
2072 // mark the start of a new paragraph by simulating a newline,
2073 // so that os.afterParbreak() returns true at document start
2076 // output the parent macros
2077 for (auto const & mac : parentMacros) {
2078 int num_lines = mac->write(os.os(), true);
2079 os.texrow().newlines(num_lines);
2082 } // output_preamble
2084 LYXERR(Debug::INFO, "preamble finished, now the body.");
2088 latexParagraphs(*this, text(), os, runparams);
2090 catch (ConversionException const &) { return ExportKilled; }
2092 // Restore the parenthood if needed
2093 if (!runparams.is_child)
2094 d->ignore_parent = false;
2096 // add this just in case after all the paragraphs
2099 if (output_preamble) {
2100 os << "\\end{document}\n";
2101 LYXERR(Debug::OUTFILE, "makeLaTeXFile...done");
2103 LYXERR(Debug::OUTFILE, "LaTeXFile for inclusion made.");
2105 runparams_in.encoding = runparams.encoding;
2107 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2108 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2109 return ExportSuccess;
2113 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2114 OutputParams const & runparams,
2115 OutputWhat output) const
2117 LYXERR(Debug::OUTFILE, "makeDocBookFile...");
2120 if (!openFileWrite(ofs, fname))
2123 // make sure we are ready to export
2124 // this needs to be done before we validate
2126 updateMacroInstances(OutputUpdate);
2128 ExportStatus const retval = writeDocBookSource(ofs, runparams, output);
2129 if (retval == ExportKilled)
2130 return ExportKilled;
2134 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2135 return ExportSuccess;
2139 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os,
2140 OutputParams const & runparams,
2141 OutputWhat output) const
2143 LaTeXFeatures features(*this, params(), runparams);
2145 d->bibinfo_.makeCitationLabels(*this);
2149 DocumentClass const & tclass = params().documentClass();
2151 bool const output_preamble =
2152 output == FullSource || output == OnlyPreamble;
2153 bool const output_body =
2154 output == FullSource || output == OnlyBody || output == IncludedFile;
2156 if (output_preamble) {
2157 // XML preamble, no doctype needed.
2158 // Not using XMLStream for this, as the root tag would be in the tag stack and make troubles with the error
2159 // detection mechanisms (these are called before the end tag is output, and thus interact with the canary
2160 // parsep in output_docbook.cpp).
2161 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2162 << "<!-- This DocBook file was created by LyX " << lyx_version
2163 << "\n See https://www.lyx.org/ for more information -->\n";
2165 // Prepare the name space declaration for MathML depending on document preferences.
2166 string mathmlNamespace;
2167 if (params().docbook_mathml_prefix != BufferParams::NoPrefix) {
2168 string mathmlPrefix;
2169 if (params().docbook_mathml_prefix == BufferParams::MPrefix)
2171 else if (params().docbook_mathml_prefix == BufferParams::MMLPrefix)
2172 mathmlPrefix = "mml";
2173 mathmlNamespace = + " xmlns:" + mathmlPrefix + "=\"http://www.w3.org/1998/Math/MathML\"";
2176 // XML-compatible language code: in lib/languages, language codes are
2177 // given as dictionary file names; HTML5 expects to follow BCP47. This
2178 // function implements a simple heuristic that does the conversion.
2179 std::string htmlCode = params().language->code();
2180 std::replace(htmlCode.begin(), htmlCode.end(), '_', '-');
2182 // Directly output the root tag, based on the current type of document.
2183 string attributes = "xml:lang=\"" + htmlCode + '"'
2184 + " xmlns=\"http://docbook.org/ns/docbook\""
2185 + " xmlns:xlink=\"http://www.w3.org/1999/xlink\""
2187 + " xmlns:xi=\"http://www.w3.org/2001/XInclude\""
2188 + " version=\"5.2\"";
2189 // Version 5.2 is required for formalgroup.
2191 os << "<" << from_ascii(tclass.docbookroot()) << " " << from_ascii(attributes) << ">\n";
2195 // Start to output the document.
2197 docbookParagraphs(text(), *this, xs, runparams);
2200 if (output_preamble) {
2201 // Close the root element. No need for a line break, as free text is never allowed
2202 // in a root element, it must always be wrapped in some container.
2203 os << "</" << from_ascii(tclass.docbookroot()) << ">";
2206 return ExportSuccess;
2210 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2211 OutputParams const & runparams) const
2213 LYXERR(Debug::OUTFILE, "makeLyXHTMLFile...");
2216 if (!openFileWrite(ofs, fname))
2219 // make sure we are ready to export
2220 // this has to be done before we validate
2221 updateBuffer(UpdateMaster, OutputUpdate);
2222 updateMacroInstances(OutputUpdate);
2224 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2225 if (retval == ExportKilled)
2230 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2235 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2236 OutputParams const & runparams,
2237 OutputWhat output) const
2239 LaTeXFeatures features(*this, params(), runparams);
2241 d->bibinfo_.makeCitationLabels(*this);
2243 bool const output_preamble =
2244 output == FullSource || output == OnlyPreamble;
2245 bool const output_body =
2246 output == FullSource || output == OnlyBody || output == IncludedFile;
2248 if (output_preamble) {
2249 // HTML5-compatible language code: in lib/languages, language codes are
2250 // given as dictionary file names; HTML5 expects to follow BCP47. This
2251 // function implements a simple heuristic that does the conversion.
2252 std::string htmlCode = params().language->code();
2253 std::replace(htmlCode.begin(), htmlCode.end(), '_', '-');
2255 os << "<!DOCTYPE html>\n"
2256 << "<html xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"" << from_ascii(htmlCode) << "\">\n"
2258 << "<meta name=\"generator\" content=\"" << PACKAGE_STRING << "\" />\n";
2260 docstring const & doctitle = features.htmlTitle();
2262 << (doctitle.empty() ?
2263 from_ascii("LyX Document") :
2264 xml::escapeString(doctitle, XMLStream::ESCAPE_ALL))
2267 docstring styles = features.getTClassHTMLPreamble();
2268 if (!styles.empty())
2269 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2271 // we will collect CSS information in a stream, and then output it
2272 // either here, as part of the header, or else in a separate file.
2273 odocstringstream css;
2274 styles = features.getCSSSnippets();
2275 if (!styles.empty())
2276 css << "/* LyX Provided Styles */\n" << styles << '\n';
2278 styles = features.getTClassHTMLStyles();
2279 if (!styles.empty())
2280 css << "/* Layout-provided Styles */\n" << styles << '\n';
2282 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2283 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2284 if (needfg || needbg) {
2285 css << "\nbody {\n";
2288 << from_ascii(X11hexname(params().fontcolor))
2291 css << " background-color: "
2292 << from_ascii(X11hexname(params().backgroundcolor))
2297 docstring const dstyles = css.str();
2298 if (!dstyles.empty()) {
2299 bool written = false;
2300 if (params().html_css_as_file) {
2301 // open a file for CSS info
2303 string const fcssname = addName(temppath(), "docstyle.css");
2304 FileName const fcssfile = FileName(fcssname);
2305 if (openFileWrite(ocss, fcssfile)) {
2309 // write link to header
2310 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2312 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2315 // we are here if the CSS is supposed to be written to the header
2316 // or if we failed to write it to an external file.
2327 bool const output_body_tag = (output != IncludedFile);
2328 if (output_body_tag)
2329 os << "<body dir=\"auto\">\n";
2331 if (output != IncludedFile)
2332 // if we're an included file, the counters are in the master.
2333 params().documentClass().counters().reset();
2335 xhtmlParagraphs(text(), *this, xs, runparams);
2337 catch (ConversionException const &) { return ExportKilled; }
2338 if (output_body_tag)
2342 if (output_preamble)
2345 return ExportSuccess;
2349 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2350 // Other flags: -wall -v0 -x
2351 int Buffer::runChktex()
2355 // get LaTeX-Filename
2356 FileName const path(temppath());
2357 string const name = addName(path.absFileName(), latexName());
2358 string const org_path = filePath();
2360 PathChanger p(path); // path to LaTeX file
2361 message(_("Running chktex..."));
2363 // Generate the LaTeX file if neccessary
2364 OutputParams runparams(¶ms().encoding());
2365 runparams.flavor = Flavor::LaTeX;
2366 runparams.nice = false;
2367 runparams.linelen = lyxrc.plaintext_linelen;
2368 ExportStatus const retval =
2369 makeLaTeXFile(FileName(name), org_path, runparams);
2370 if (retval != ExportSuccess) {
2371 // error code on failure
2376 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2377 int const res = chktex.run(terr); // run chktex
2380 Alert::error(_("chktex failure"),
2381 _("Could not run chktex successfully."));
2383 ErrorList & errlist = d->errorLists["ChkTeX"];
2385 bufferErrors(terr, errlist);
2390 if (runparams.silent)
2391 d->errorLists["ChkTeX"].clear();
2399 void Buffer::validate(LaTeXFeatures & features) const
2401 // Validate the buffer params, but not for included
2402 // files, since they also use the parent buffer's
2404 if (!features.runparams().is_child)
2405 params().validate(features);
2410 for (Paragraph const & p : paragraphs())
2411 p.validate(features);
2413 if (lyxerr.debugging(Debug::OUTFILE)) {
2414 features.showStruct();
2419 void Buffer::getLabelList(vector<std::pair<docstring, docstring>> & list) const
2421 // If this is a child document, use the master's list instead.
2423 masterBuffer()->getLabelList(list);
2428 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2429 for (auto const & tocit : *toc) {
2430 if (tocit.depth() == 0)
2431 list.push_back(make_pair(tocit.str(), tocit.asString()));
2436 void Buffer::invalidateBibinfoCache() const
2438 d->bibinfo_cache_valid_ = false;
2439 d->cite_labels_valid_ = false;
2440 removeBiblioTempFiles();
2441 // also invalidate the cache for the parent buffer
2442 Buffer const * const pbuf = d->parent();
2444 pbuf->invalidateBibinfoCache();
2448 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2450 // FIXME This is probably unnecessary, given where we call this.
2451 // If this is a child document, use the master instead.
2452 Buffer const * const pbuf = masterBuffer();
2453 if (pbuf != this && scope != UpdateChildOnly)
2454 return pbuf->getBibfiles();
2456 // In 2.3.x, we have:
2457 //if (!d->bibfile_cache_valid_)
2458 // this->updateBibfilesCache(scope);
2459 // I think that is a leftover, but there have been so many back-
2460 // and-forths with this, due to Windows issues, that I am not sure.
2462 return d->bibfiles_cache_;
2466 BiblioInfo const & Buffer::masterBibInfo() const
2468 Buffer const * const tmp = masterBuffer();
2470 return tmp->masterBibInfo();
2475 BiblioInfo const & Buffer::bibInfo() const
2481 void Buffer::registerBibfiles(const docstring_list & bf) const
2483 // We register the bib files in the master buffer,
2484 // if there is one, but also in every single buffer,
2485 // in case a child is compiled alone.
2486 Buffer const * const tmp = masterBuffer();
2488 tmp->registerBibfiles(bf);
2490 for (auto const & p : bf) {
2491 docstring_list::const_iterator temp =
2492 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2493 if (temp == d->bibfiles_cache_.end())
2494 d->bibfiles_cache_.push_back(p);
2499 static map<docstring, FileName> bibfileCache;
2501 FileName Buffer::getBibfilePath(docstring const & bibid) const
2503 map<docstring, FileName>::const_iterator it =
2504 bibfileCache.find(bibid);
2505 if (it != bibfileCache.end()) {
2506 // i.e., return bibfileCache[bibid];
2510 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2511 string const texfile = changeExtension(to_utf8(bibid), "bib");
2512 // we need to check first if this file exists where it's said to be.
2513 // there's a weird bug that occurs otherwise: if the file is in the
2514 // Buffer's directory but has the same name as some file that would be
2515 // found by kpsewhich, then we find the latter, not the former.
2516 FileName const local_file = makeAbsPath(texfile, filePath());
2517 FileName file = local_file;
2518 if (!file.exists()) {
2519 // there's no need now to check whether the file can be found
2521 file = findtexfile(texfile, "bib", true);
2525 LYXERR(Debug::FILES, "Found at: " << file);
2527 bibfileCache[bibid] = file;
2528 return bibfileCache[bibid];
2532 void Buffer::checkIfBibInfoCacheIsValid() const
2534 // use the master's cache
2535 Buffer const * const tmp = masterBuffer();
2537 tmp->checkIfBibInfoCacheIsValid();
2541 // If we already know the cache is invalid, stop here.
2542 // This is important in the case when the bibliography
2543 // environment (rather than Bib[la]TeX) is used.
2544 // In that case, the timestamp check below gives no
2545 // sensible result. Rather than that, the cache will
2546 // be invalidated explicitly via invalidateBibInfoCache()
2547 // by the Bibitem inset.
2548 // Same applies for bib encoding changes, which trigger
2549 // invalidateBibInfoCache() by InsetBibtex.
2550 if (!d->bibinfo_cache_valid_)
2553 if (d->have_bibitems_) {
2554 // We have a bibliography environment.
2555 // Invalidate the bibinfo cache unconditionally.
2556 // Cite labels will get invalidated by the inset if needed.
2557 d->bibinfo_cache_valid_ = false;
2561 // OK. This is with Bib(la)tex. We'll assume the cache
2562 // is valid and change this if we find changes in the bibs.
2563 d->bibinfo_cache_valid_ = true;
2564 d->cite_labels_valid_ = true;
2566 // compare the cached timestamps with the actual ones.
2567 docstring_list const & bibfiles_cache = getBibfiles();
2568 for (auto const & bf : bibfiles_cache) {
2569 FileName const fn = getBibfilePath(bf);
2570 time_t lastw = fn.lastModified();
2571 time_t prevw = d->bibfile_status_[fn];
2572 if (lastw != prevw) {
2573 d->bibinfo_cache_valid_ = false;
2574 d->cite_labels_valid_ = false;
2575 d->bibfile_status_[fn] = lastw;
2581 void Buffer::clearBibFileCache() const
2583 bibfileCache.clear();
2587 void Buffer::reloadBibInfoCache(bool const force) const
2589 // we should not need to do this for internal buffers
2593 // use the master's cache
2594 Buffer const * const tmp = masterBuffer();
2596 tmp->reloadBibInfoCache(force);
2601 checkIfBibInfoCacheIsValid();
2602 if (d->bibinfo_cache_valid_)
2606 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2607 // re-read file locations when this info changes
2608 // FIXME Is this sufficient? Or should we also force that
2609 // in some other cases? If so, then it is easy enough to
2610 // add the following line in some other places.
2611 clearBibFileCache();
2612 d->bibinfo_.clear();
2613 FileNameList checkedFiles;
2614 d->have_bibitems_ = false;
2615 collectBibKeys(checkedFiles);
2616 d->bibinfo_cache_valid_ = true;
2620 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2625 for (InsetIterator it = begin(inset()); it; ++it) {
2626 it->collectBibKeys(it, checkedFiles);
2627 if (it->lyxCode() == BIBITEM_CODE) {
2628 if (parent() != nullptr)
2629 parent()->d->have_bibitems_ = true;
2631 d->have_bibitems_ = true;
2637 void Buffer::addBiblioInfo(BiblioInfo const & bi_in) const
2639 // We add the biblio info to the parent buffer,
2640 // if there is one, but also to this buffer, in case
2641 // it is compiled alone.
2642 BiblioInfo & our_bi = d->bibinfo_;
2643 our_bi.mergeBiblioInfo(bi_in);
2646 parent()->addBiblioInfo(bi_in);
2650 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2652 // We add the bibtex info to the master buffer,
2653 // if there is one, but also to every single buffer,
2654 // in case a child is compiled alone.
2655 BiblioInfo & bi = d->bibinfo_;
2658 if (parent() != nullptr) {
2659 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2660 masterbi[key] = bin;
2665 void Buffer::makeCitationLabels() const
2667 Buffer const * const master = masterBuffer();
2668 return d->bibinfo_.makeCitationLabels(*master);
2672 void Buffer::invalidateCiteLabels() const
2674 masterBuffer()->d->cite_labels_valid_ = false;
2677 bool Buffer::citeLabelsValid() const
2679 return masterBuffer()->d->cite_labels_valid_;
2683 void Buffer::removeBiblioTempFiles() const
2685 // We remove files that contain LaTeX commands specific to the
2686 // particular bibliographic style being used, in order to avoid
2687 // LaTeX errors when we switch style.
2688 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2689 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2690 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2691 aux_file.removeFile();
2692 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2693 bbl_file.removeFile();
2694 // Also for the parent buffer
2695 Buffer const * const pbuf = parent();
2697 pbuf->removeBiblioTempFiles();
2701 bool Buffer::isDepClean(string const & name) const
2703 DepClean::const_iterator const it = d->dep_clean.find(name);
2704 if (it == d->dep_clean.end())
2710 void Buffer::markDepClean(string const & name)
2712 d->dep_clean[name] = true;
2716 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag) const
2719 // FIXME? if there is an Buffer LFUN that can be dispatched even
2720 // if internal, put a switch '(cmd.action)' here.
2726 switch (cmd.action()) {
2728 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2729 flag.setOnOff(hasReadonlyFlag());
2732 // FIXME: There is need for a command-line import.
2733 //case LFUN_BUFFER_IMPORT:
2735 case LFUN_BUFFER_AUTO_SAVE:
2738 case LFUN_BUFFER_EXPORT_CUSTOM:
2739 // FIXME: Nothing to check here?
2742 case LFUN_BUFFER_EXPORT: {
2743 docstring const & arg = cmd.argument();
2744 if (arg == "custom") {
2748 string format = (arg.empty() || arg == "default") ?
2749 params().getDefaultOutputFormat() : to_utf8(arg);
2750 size_t pos = format.find(' ');
2751 if (pos != string::npos)
2752 format = format.substr(0, pos);
2753 enable = params().isExportable(format, false);
2755 flag.message(bformat(
2756 _("Don't know how to export to format: %1$s"), arg));
2760 case LFUN_BUILD_PROGRAM:
2761 enable = params().isExportable("program", false);
2764 case LFUN_BRANCH_ACTIVATE:
2765 case LFUN_BRANCH_DEACTIVATE:
2766 case LFUN_BRANCH_MASTER_ACTIVATE:
2767 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2768 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2769 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2770 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2771 : params().branchlist();
2772 docstring const & branchName = cmd.argument();
2773 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2777 case LFUN_BRANCH_ADD:
2778 case LFUN_BRANCHES_RENAME:
2779 // if no Buffer is present, then of course we won't be called!
2782 case LFUN_BUFFER_LANGUAGE:
2783 enable = !isReadonly();
2786 case LFUN_BUFFER_VIEW_CACHE:
2787 (d->preview_file_).refresh();
2788 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2791 case LFUN_CHANGES_TRACK:
2792 flag.setEnabled(true);
2793 flag.setOnOff(params().track_changes);
2796 case LFUN_CHANGES_OUTPUT:
2797 flag.setEnabled(true);
2798 flag.setOnOff(params().output_changes);
2801 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2802 flag.setOnOff(params().compressed);
2805 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2806 flag.setOnOff(params().output_sync);
2809 case LFUN_BUFFER_ANONYMIZE:
2815 flag.setEnabled(enable);
2820 void Buffer::dispatch(string const & command, DispatchResult & result)
2822 return dispatch(lyxaction.lookupFunc(command), result);
2826 // NOTE We can end up here even if we have no GUI, because we are called
2827 // by LyX::exec to handled command-line requests. So we may need to check
2828 // whether we have a GUI or not. The boolean use_gui holds this information.
2829 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2832 // FIXME? if there is an Buffer LFUN that can be dispatched even
2833 // if internal, put a switch '(cmd.action())' here.
2834 dr.dispatched(false);
2837 string const argument = to_utf8(func.argument());
2838 // We'll set this back to false if need be.
2839 bool dispatched = true;
2840 // This handles undo groups automagically
2841 UndoGroupHelper ugh(this);
2843 switch (func.action()) {
2844 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2845 if (lyxvc().inUse()) {
2846 string log = lyxvc().toggleReadOnly();
2851 setReadonly(!hasReadonlyFlag());
2854 case LFUN_BUFFER_EXPORT: {
2855 string const format = (argument.empty() || argument == "default") ?
2856 params().getDefaultOutputFormat() : argument;
2857 ExportStatus const status = doExport(format, false);
2858 dr.setError(status != ExportSuccess);
2859 if (status != ExportSuccess)
2860 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2861 from_utf8(format)));
2865 case LFUN_BUILD_PROGRAM: {
2866 ExportStatus const status = doExport("program", true);
2867 dr.setError(status != ExportSuccess);
2868 if (status != ExportSuccess)
2869 dr.setMessage(_("Error generating literate programming code."));
2873 case LFUN_BUFFER_EXPORT_CUSTOM: {
2875 string command = split(argument, format_name, ' ');
2876 Format const * format = theFormats().getFormat(format_name);
2878 lyxerr << "Format \"" << format_name
2879 << "\" not recognized!"
2884 // The name of the file created by the conversion process
2887 // Output to filename
2888 if (format->name() == "lyx") {
2889 string const latexname = latexName(false);
2890 filename = changeExtension(latexname,
2891 format->extension());
2892 filename = addName(temppath(), filename);
2894 if (!writeFile(FileName(filename)))
2898 doExport(format_name, true, filename);
2901 // Substitute $$FName for filename
2902 if (!contains(command, "$$FName"))
2903 command = "( " + command + " ) < $$FName";
2904 command = subst(command, "$$FName", filename);
2906 // Execute the command in the background
2908 call.startscript(Systemcall::DontWait, command,
2909 filePath(), layoutPos());
2913 // FIXME: There is need for a command-line import.
2915 case LFUN_BUFFER_IMPORT:
2920 case LFUN_BUFFER_AUTO_SAVE:
2922 resetAutosaveTimers();
2925 case LFUN_BRANCH_ACTIVATE:
2926 case LFUN_BRANCH_DEACTIVATE:
2927 case LFUN_BRANCH_MASTER_ACTIVATE:
2928 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2929 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2930 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2931 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2934 docstring const & branch_name = func.argument();
2935 // the case without a branch name is handled elsewhere
2936 if (branch_name.empty()) {
2940 Branch * branch = buf->params().branchlist().find(branch_name);
2942 LYXERR0("Branch " << branch_name << " does not exist.");
2944 docstring const msg =
2945 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2949 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2950 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2951 if (branch->isSelected() != activate) {
2952 buf->undo().recordUndoBufferParams(CursorData());
2953 branch->setSelected(activate);
2955 dr.screenUpdate(Update::Force);
2956 dr.forceBufferUpdate();
2961 case LFUN_BRANCH_ADD: {
2962 docstring const & branchnames = func.argument();
2963 if (branchnames.empty()) {
2967 BranchList & branch_list = params().branchlist();
2968 vector<docstring> const branches =
2969 getVectorFromString(branchnames, branch_list.separator());
2971 for (docstring const & branch_name : branches) {
2972 Branch * branch = branch_list.find(branch_name);
2974 LYXERR0("Branch " << branch_name << " already exists.");
2978 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2980 undo().recordUndoBufferParams(CursorData());
2981 branch_list.add(branch_name);
2982 branch = branch_list.find(branch_name);
2984 // needed to update the color table for dark mode
2985 branch->setColors("background", "background");
2987 dr.screenUpdate(Update::Force);
2995 case LFUN_BRANCHES_RENAME: {
2996 if (func.argument().empty())
2999 docstring const oldname = from_utf8(func.getArg(0));
3000 docstring const newname = from_utf8(func.getArg(1));
3001 InsetIterator it = begin(inset());
3002 InsetIterator const itend = end(inset());
3003 bool success = false;
3004 for (; it != itend; ++it) {
3005 if (it->lyxCode() == BRANCH_CODE) {
3006 InsetBranch & ins = static_cast<InsetBranch &>(*it);
3007 if (ins.branch() == oldname) {
3008 undo().recordUndo(CursorData(it));
3009 ins.rename(newname);
3014 if (it->lyxCode() == INCLUDE_CODE) {
3015 // get buffer of external file
3016 InsetInclude const & ins =
3017 static_cast<InsetInclude const &>(*it);
3018 Buffer * child = ins.loadIfNeeded();
3021 child->dispatch(func, dr);
3026 dr.screenUpdate(Update::Force);
3027 dr.forceBufferUpdate();
3032 case LFUN_BUFFER_VIEW_CACHE:
3033 if (!theFormats().view(*this, d->preview_file_,
3034 d->preview_format_))
3035 dr.setMessage(_("Error viewing the output file."));
3038 case LFUN_CHANGES_TRACK:
3039 if (params().save_transient_properties)
3040 undo().recordUndoBufferParams(CursorData());
3041 params().track_changes = !params().track_changes;
3044 case LFUN_CHANGES_OUTPUT:
3045 if (params().save_transient_properties)
3046 undo().recordUndoBufferParams(CursorData());
3047 params().output_changes = !params().output_changes;
3048 if (params().output_changes) {
3049 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3050 LaTeXFeatures::isAvailable("xcolor");
3053 Alert::warning(_("Changes not shown in LaTeX output"),
3054 _("Changes will not be highlighted in LaTeX output, "
3055 "because xcolor and ulem are not installed.\n"
3056 "Please install both packages or redefine "
3057 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3062 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3063 // turn compression on/off
3064 undo().recordUndoBufferParams(CursorData());
3065 params().compressed = !params().compressed;
3068 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3069 undo().recordUndoBufferParams(CursorData());
3070 params().output_sync = !params().output_sync;
3073 case LFUN_BUFFER_ANONYMIZE: {
3074 undo().recordUndoFullBuffer(CursorData());
3075 CursorData cur(doc_iterator_begin(this));
3076 for ( ; cur ; cur.forwardPar())
3077 cur.paragraph().anonymize();
3078 dr.forceBufferUpdate();
3079 dr.screenUpdate(Update::Force);
3087 dr.dispatched(dispatched);
3091 void Buffer::changeLanguage(Language const * from, Language const * to)
3093 LASSERT(from, return);
3094 LASSERT(to, return);
3096 ParIterator it = par_iterator_begin();
3097 ParIterator eit = par_iterator_end();
3098 for (; it != eit; ++it)
3099 it->changeLanguage(params(), from, to);
3103 bool Buffer::isMultiLingual() const
3105 ParConstIterator end = par_iterator_end();
3106 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3107 if (it->isMultiLingual(params()))
3114 std::set<Language const *> Buffer::getLanguages() const
3116 std::set<Language const *> langs;
3117 getLanguages(langs);
3122 void Buffer::getLanguages(std::set<Language const *> & langs) const
3124 ParConstIterator end = par_iterator_end();
3125 // add the buffer language, even if it's not actively used
3126 langs.insert(language());
3127 // iterate over the paragraphs
3128 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3129 it->getLanguages(langs);
3131 ListOfBuffers clist = getDescendants();
3132 for (auto const & cit : clist)
3133 cit->getLanguages(langs);
3137 DocIterator Buffer::getParFromID(int const id) const
3139 Buffer * buf = const_cast<Buffer *>(this);
3141 // This means non-existent
3142 return doc_iterator_end(buf);
3144 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3145 if (it.paragraph().id() == id)
3148 return doc_iterator_end(buf);
3152 bool Buffer::hasParWithID(int const id) const
3154 return !getParFromID(id).atEnd();
3158 ParIterator Buffer::par_iterator_begin()
3160 return ParIterator(doc_iterator_begin(this));
3164 ParIterator Buffer::par_iterator_end()
3166 return ParIterator(doc_iterator_end(this));
3170 ParConstIterator Buffer::par_iterator_begin() const
3172 return ParConstIterator(doc_iterator_begin(this));
3176 ParConstIterator Buffer::par_iterator_end() const
3178 return ParConstIterator(doc_iterator_end(this));
3181 bool Buffer::empty() const
3183 return paragraphs().size() == 1 && paragraphs().front().empty();
3187 Language const * Buffer::language() const
3189 return params().language;
3193 docstring Buffer::B_(string const & l10n) const
3195 return params().B_(l10n);
3199 bool Buffer::isClean() const
3201 return d->lyx_clean;
3205 bool Buffer::isChecksumModified() const
3207 LASSERT(d->filename.exists(), return false);
3208 return d->checksum_ != d->filename.checksum();
3212 void Buffer::saveCheckSum() const
3214 FileName const & file = d->filename;
3216 d->checksum_ = file.exists() ? file.checksum()
3217 : 0; // in the case of save to a new file.
3221 void Buffer::markClean() const
3223 if (!d->lyx_clean) {
3224 d->lyx_clean = true;
3227 // if the .lyx file has been saved, we don't need an
3229 d->bak_clean = true;
3230 d->undo_.markDirty();
3231 clearExternalModification();
3235 void Buffer::setUnnamed(bool flag)
3241 bool Buffer::isUnnamed() const
3248 /// Don't check unnamed, here: isInternal() is used in
3249 /// newBuffer(), where the unnamed flag has not been set by anyone
3250 /// yet. Also, for an internal buffer, there should be no need for
3251 /// retrieving fileName() nor for checking if it is unnamed or not.
3252 bool Buffer::isInternal() const
3254 return d->internal_buffer;
3258 void Buffer::setInternal(bool flag)
3260 d->internal_buffer = flag;
3264 void Buffer::markDirty()
3267 d->lyx_clean = false;
3270 d->bak_clean = false;
3272 for (auto & depit : d->dep_clean)
3273 depit.second = false;
3277 FileName Buffer::fileName() const
3283 string Buffer::absFileName() const
3285 return d->filename.absFileName();
3289 string Buffer::filePath() const
3291 string const abs = d->filename.onlyPath().absFileName();
3294 int last = abs.length() - 1;
3296 return abs[last] == '/' ? abs : abs + '/';
3300 DocFileName Buffer::getReferencedFileName(string const & fn) const
3303 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3304 result.set(fn, filePath());
3306 // filePath() ends with a path separator
3307 FileName const test(filePath() + fn);
3309 result.set(fn, filePath());
3311 result.set(fn, params().origin);
3318 string const Buffer::prepareFileNameForLaTeX(string const & name,
3319 string const & ext, bool nice) const
3321 string const fname = makeAbsPath(name, filePath()).absFileName();
3322 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3328 return to_utf8(makeRelPath(from_utf8(fname),
3329 from_utf8(masterBuffer()->filePath())));
3333 vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3334 docstring_list const & bibfilelist,
3335 bool const add_extension) const
3337 // If we are processing the LaTeX file in a temp directory then
3338 // copy the .bib databases to this temp directory, mangling their
3339 // names in the process. Store this mangled name in the list of
3341 // (We need to do all this because BibTeX *really*, *really*
3342 // can't handle "files with spaces" and Windows users tend to
3343 // use such filenames.)
3344 // Otherwise, store the (maybe absolute) path to the original,
3345 // unmangled database name.
3347 vector<pair<docstring, string>> res;
3349 // determine the export format
3350 string const tex_format = flavor2format(runparams.flavor);
3352 // check for spaces in paths
3353 bool found_space = false;
3355 for (auto const & bit : bibfilelist) {
3356 string utf8input = to_utf8(bit);
3358 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3359 FileName try_in_file =
3360 makeAbsPath(database + ".bib", filePath());
3361 bool not_from_texmf = try_in_file.isReadableFile();
3362 // If the file has not been found, try with the real file name
3363 // (it might come from a child in a sub-directory)
3364 if (!not_from_texmf) {
3365 try_in_file = getBibfilePath(bit);
3366 if (try_in_file.isReadableFile()) {
3367 // Check if the file is in texmf
3368 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3369 not_from_texmf = kpsefile.empty()
3370 || kpsefile.absFileName() != try_in_file.absFileName();
3372 // If this exists, make path relative to the master
3375 removeExtension(prepareFileNameForLaTeX(
3376 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3377 from_utf8(filePath()))),
3378 ".bib", runparams.nice));
3382 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3384 // mangledFileName() needs the extension
3385 DocFileName const in_file = DocFileName(try_in_file);
3386 database = removeExtension(in_file.mangledFileName());
3387 FileName const out_file = makeAbsPath(database + ".bib",
3388 masterBuffer()->temppath());
3389 bool const success = in_file.copyTo(out_file);
3391 LYXERR0("Failed to copy '" << in_file
3392 << "' to '" << out_file << "'");
3394 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3395 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3396 if (!isValidLaTeXFileName(database)) {
3397 frontend::Alert::warning(_("Invalid filename"),
3398 _("The following filename will cause troubles "
3399 "when running the exported file through LaTeX: ") +
3400 from_utf8(database));
3402 if (!isValidDVIFileName(database)) {
3403 frontend::Alert::warning(_("Problematic filename for DVI"),
3404 _("The following filename can cause troubles "
3405 "when running the exported file through LaTeX "
3406 "and opening the resulting DVI: ") +
3407 from_utf8(database), true);
3415 docstring const path = from_utf8(latex_path(database));
3417 if (contains(path, ' '))
3420 if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
3421 enc = params().bibFileEncoding(utf8input);
3423 bool recorded = false;
3424 for (auto const & pe : res) {
3425 if (pe.first == path) {
3432 res.push_back(make_pair(path, enc));
3435 // Check if there are spaces in the path and warn BibTeX users, if so.
3436 // (biber can cope with such paths)
3437 if (!prefixIs(runparams.bibtex_command, "biber")) {
3438 // Post this warning only once.
3439 static bool warned_about_spaces = false;
3440 if (!warned_about_spaces &&
3441 runparams.nice && found_space) {
3442 warned_about_spaces = true;
3443 Alert::warning(_("Export Warning!"),
3444 _("There are spaces in the paths to your BibTeX databases.\n"
3445 "BibTeX will be unable to find them."));
3454 string Buffer::layoutPos() const
3456 return d->layout_position;
3460 void Buffer::setLayoutPos(string const & path)
3463 d->layout_position.clear();
3467 LATTEST(FileName::isAbsolute(path));
3469 d->layout_position =
3470 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3472 if (d->layout_position.empty())
3473 d->layout_position = ".";
3477 bool Buffer::hasReadonlyFlag() const
3479 return d->read_only;
3483 bool Buffer::isReadonly() const
3485 return hasReadonlyFlag() || notifiesExternalModification();
3489 void Buffer::setParent(Buffer const * buffer)
3491 // We need to do some work here to avoid recursive parent structures.
3492 // This is the easy case.
3493 if (buffer == this) {
3494 LYXERR0("Ignoring attempt to set self as parent in\n" << fileName());
3497 // Now we check parents going upward, to make sure that IF we set the
3498 // parent as requested, we would not generate a recursive include.
3499 set<Buffer const *> sb;
3500 Buffer const * b = buffer;
3501 bool found_recursion = false;
3503 if (sb.find(b) != sb.end()) {
3504 found_recursion = true;
3511 if (found_recursion) {
3512 LYXERR0("Ignoring attempt to set parent of\n" <<
3515 buffer->fileName() <<
3516 "\nbecause that would create a recursive inclusion.");
3520 // We should be safe now.
3521 d->setParent(buffer);
3526 Buffer const * Buffer::parent() const
3532 ListOfBuffers Buffer::allRelatives() const
3534 ListOfBuffers lb = masterBuffer()->getDescendants();
3535 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3540 Buffer const * Buffer::masterBuffer() const
3542 Buffer const * const pbuf = d->parent();
3546 return pbuf->masterBuffer();
3550 bool Buffer::isChild(Buffer * child) const
3552 return d->children_positions.find(child) != d->children_positions.end();
3556 DocIterator Buffer::firstChildPosition(Buffer const * child)
3558 Impl::BufferPositionMap::iterator it;
3559 it = d->children_positions.find(child);
3560 if (it == d->children_positions.end())
3561 return DocIterator(this);
3566 bool Buffer::hasChildren() const
3568 return !d->children_positions.empty();
3572 void Buffer::collectChildren(ListOfBuffers & children, bool grand_children) const
3574 // loop over children
3575 for (auto const & p : d->children_positions) {
3576 Buffer * child = const_cast<Buffer *>(p.first);
3578 ListOfBuffers::const_iterator bit = find(children.begin(), children.end(), child);
3579 if (bit != children.end())
3581 children.push_back(child);
3583 // there might be grandchildren
3584 child->collectChildren(children, true);
3589 ListOfBuffers Buffer::getChildren() const
3592 collectChildren(v, false);
3593 // Make sure we have not included ourselves.
3594 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3595 if (bit != v.end()) {
3596 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3603 ListOfBuffers Buffer::getDescendants() const
3606 collectChildren(v, true);
3607 // Make sure we have not included ourselves.
3608 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3609 if (bit != v.end()) {
3610 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3617 template<typename M>
3618 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3623 typename M::const_iterator it = m.lower_bound(x);
3624 if (it == m.begin())
3632 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3633 DocIterator const & pos) const
3635 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3637 // if paragraphs have no macro context set, pos will be empty
3641 // we haven't found anything yet
3642 DocIterator bestPos = owner_->par_iterator_begin();
3643 MacroData const * bestData = nullptr;
3645 // find macro definitions for name
3646 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3647 if (nameIt != macros.end()) {
3648 // find last definition in front of pos or at pos itself
3649 PositionScopeMacroMap::const_iterator it
3650 = greatest_below(nameIt->second, pos);
3651 if (it != nameIt->second.end()) {
3653 // scope ends behind pos?
3654 if (pos < it->second.scope) {
3655 // Looks good, remember this. If there
3656 // is no external macro behind this,
3657 // we found the right one already.
3658 bestPos = it->first;
3659 bestData = &it->second.macro;
3663 // try previous macro if there is one
3664 if (it == nameIt->second.begin())
3671 // find macros in included files
3672 PositionScopeBufferMap::const_iterator it
3673 = greatest_below(position_to_children, pos);
3674 if (it == position_to_children.end())
3675 // no children before
3679 // do we know something better (i.e. later) already?
3680 if (it->first < bestPos )
3683 // scope ends behind pos?
3684 if (pos < it->second.scope
3685 && (cloned_buffer_ ||
3686 theBufferList().isLoaded(it->second.buffer))) {
3687 // look for macro in external file
3689 MacroData const * data
3690 = it->second.buffer->getMacro(name, false);
3693 bestPos = it->first;
3699 // try previous file if there is one
3700 if (it == position_to_children.begin())
3705 // return the best macro we have found
3710 MacroData const * Buffer::getMacro(docstring const & name,
3711 DocIterator const & pos, bool global) const
3716 // query buffer macros
3717 MacroData const * data = d->getBufferMacro(name, pos);
3718 if (data != nullptr)
3721 // If there is a master buffer, query that
3722 Buffer const * const pbuf = d->parent();
3724 d->macro_lock = true;
3725 MacroData const * macro = pbuf->getMacro(
3726 name, *this, false);
3727 d->macro_lock = false;
3733 data = MacroTable::globalMacros().get(name);
3734 if (data != nullptr)
3742 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3744 // set scope end behind the last paragraph
3745 DocIterator scope = par_iterator_begin();
3746 scope.pit() = scope.lastpit() + 1;
3748 return getMacro(name, scope, global);
3752 MacroData const * Buffer::getMacro(docstring const & name,
3753 Buffer const & child, bool global) const
3755 // look where the child buffer is included first
3756 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3757 if (it == d->children_positions.end())
3760 // check for macros at the inclusion position
3761 return getMacro(name, it->second, global);
3765 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3767 pit_type const lastpit = it.lastpit();
3769 // look for macros in each paragraph
3770 while (it.pit() <= lastpit) {
3771 Paragraph & par = it.paragraph();
3773 // iterate over the insets of the current paragraph
3774 for (auto const & insit : par.insetList()) {
3775 it.pos() = insit.pos;
3777 // is it a nested text inset?
3778 if (insit.inset->asInsetText()) {
3779 // Inset needs its own scope?
3780 InsetText const * itext = insit.inset->asInsetText();
3781 bool newScope = itext->isMacroScope();
3783 // scope which ends just behind the inset
3784 DocIterator insetScope = it;
3787 // collect macros in inset
3788 it.push_back(CursorSlice(*insit.inset));
3789 updateMacros(it, newScope ? insetScope : scope);
3794 if (insit.inset->asInsetTabular()) {
3795 CursorSlice slice(*insit.inset);
3796 size_t const numcells = slice.nargs();
3797 for (; slice.idx() < numcells; slice.forwardIdx()) {
3798 it.push_back(slice);
3799 updateMacros(it, scope);
3805 // is it an external file?
3806 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3807 // get buffer of external file
3808 InsetInclude const & incinset =
3809 static_cast<InsetInclude const &>(*insit.inset);
3811 Buffer * child = incinset.loadIfNeeded();
3816 // register its position, but only when it is
3817 // included first in the buffer
3818 children_positions.insert({child, it});
3820 // register child with its scope
3821 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3825 InsetMath * im = insit.inset->asInsetMath();
3826 if (doing_export && im) {
3827 InsetMathHull * hull = im->asHullInset();
3829 hull->recordLocation(it);
3832 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3836 InsetMathMacroTemplate & macroTemplate =
3837 *insit.inset->asInsetMath()->asMacroTemplate();
3838 MacroContext mc(owner_, it);
3839 macroTemplate.updateToContext(mc);
3842 bool valid = macroTemplate.validMacro();
3843 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3844 // then the BufferView's cursor will be invalid in
3845 // some cases which leads to crashes.
3850 // FIXME (Abdel), I don't understand why we pass 'it' here
3851 // instead of 'macroTemplate' defined above... is this correct?
3852 macros[macroTemplate.name()][it] =
3853 Impl::ScopeMacro(scope, MacroData(owner_, it));
3863 void Buffer::updateMacros() const
3868 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3870 // start with empty table
3872 d->children_positions.clear();
3873 d->position_to_children.clear();
3875 // Iterate over buffer, starting with first paragraph
3876 // The scope must be bigger than any lookup DocIterator
3877 // later. For the global lookup, lastpit+1 is used, hence
3878 // we use lastpit+2 here.
3879 DocIterator it = par_iterator_begin();
3880 DocIterator outerScope = it;
3881 outerScope.pit() = outerScope.lastpit() + 2;
3882 d->updateMacros(it, outerScope);
3886 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3888 for (Inset const & it : inset()) {
3889 if (it.lyxCode() == BRANCH_CODE) {
3890 InsetBranch const & br = static_cast<InsetBranch const &>(it);
3891 docstring const name = br.branch();
3892 if (!from_master && !params().branchlist().find(name))
3893 result.push_back(name);
3894 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3895 result.push_back(name);
3898 if (it.lyxCode() == INCLUDE_CODE) {
3899 // get buffer of external file
3900 InsetInclude const & ins =
3901 static_cast<InsetInclude const &>(it);
3902 Buffer * child = ins.loadIfNeeded();
3905 child->getUsedBranches(result, true);
3908 // remove duplicates
3913 void Buffer::updateMacroInstances(UpdateType utype) const
3915 LYXERR(Debug::MACROS, "updateMacroInstances for "
3916 << d->filename.onlyFileName());
3917 DocIterator it = doc_iterator_begin(this);
3919 DocIterator const end = doc_iterator_end(this);
3920 for (; it != end; it.forwardInset()) {
3921 // look for MathData cells in InsetMathNest insets
3922 InsetMath * minset = it.nextInset()->asInsetMath();
3926 // update macro in all cells of the InsetMathNest
3927 idx_type n = minset->nargs();
3928 MacroContext mc = MacroContext(this, it);
3929 for (idx_type i = 0; i < n; ++i) {
3930 MathData & data = minset->cell(i);
3931 data.updateMacros(nullptr, mc, utype, 0);
3937 void Buffer::listMacroNames(MacroNameSet & macros) const
3942 d->macro_lock = true;
3944 // loop over macro names
3945 for (auto const & nameit : d->macros)
3946 macros.insert(nameit.first);
3948 // loop over children
3949 for (auto const & p : d->children_positions) {
3950 Buffer * child = const_cast<Buffer *>(p.first);
3951 // The buffer might have been closed (see #10766).
3952 if (theBufferList().isLoaded(child))
3953 child->listMacroNames(macros);
3957 Buffer const * const pbuf = d->parent();
3959 pbuf->listMacroNames(macros);
3961 d->macro_lock = false;
3965 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3967 Buffer const * const pbuf = d->parent();
3972 pbuf->listMacroNames(names);
3975 for (auto const & mit : names) {
3977 MacroData const * data = pbuf->getMacro(mit, *this, false);
3979 macros.insert(data);
3981 // we cannot access the original InsetMathMacroTemplate anymore
3982 // here to calls validate method. So we do its work here manually.
3983 // FIXME: somehow make the template accessible here.
3984 if (data->optionals() > 0)
3985 features.require("xargs");
3991 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3994 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3996 RefCache::iterator it = d->ref_cache_.find(label);
3997 if (it != d->ref_cache_.end())
4000 static References const dummy_refs = References();
4001 it = d->ref_cache_.insert(
4002 make_pair(label, dummy_refs)).first;
4007 Buffer::References const & Buffer::references(docstring const & label) const
4009 return const_cast<Buffer *>(this)->getReferenceCache(label);
4013 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
4015 References & refs = getReferenceCache(label);
4016 refs.push_back(make_pair(inset, it));
4020 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
4024 linfo.label = label;
4026 linfo.active = active;
4027 masterBuffer()->d->label_cache_.push_back(linfo);
4031 InsetLabel const * Buffer::insetLabel(docstring const & label,
4032 bool const active) const
4034 for (auto const & rc : masterBuffer()->d->label_cache_) {
4035 if (rc.label == label && (rc.active || !active))
4042 bool Buffer::activeLabel(docstring const & label) const
4044 return insetLabel(label, true) != nullptr;
4048 void Buffer::clearReferenceCache() const
4051 d->ref_cache_.clear();
4052 d->label_cache_.clear();
4057 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
4059 //FIXME: This does not work for child documents yet.
4060 reloadBibInfoCache();
4062 // Check if the label 'from' appears more than once
4063 vector<docstring> labels;
4064 for (auto const & bibit : masterBibInfo())
4065 labels.push_back(bibit.first);
4067 if (count(labels.begin(), labels.end(), from) > 1)
4070 string const paramName = "key";
4071 UndoGroupHelper ugh(this);
4072 InsetIterator it = begin(inset());
4074 if (it->lyxCode() != CITE_CODE)
4076 InsetCommand * inset = it->asInsetCommand();
4077 docstring const oldValue = inset->getParam(paramName);
4078 if (oldValue == from) {
4079 undo().recordUndo(CursorData(it));
4080 inset->setParam(paramName, to);
4085 // returns NULL if id-to-row conversion is unsupported
4086 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4087 pit_type par_begin, pit_type par_end,
4088 OutputWhat output, bool master) const
4090 unique_ptr<TexRow> texrow;
4091 OutputParams runparams(¶ms().encoding());
4092 runparams.nice = true;
4093 runparams.flavor = params().getOutputFlavor(format);
4094 runparams.linelen = lyxrc.plaintext_linelen;
4095 // No side effect of file copying and image conversion
4096 runparams.dryrun = true;
4098 // Some macros rely on font encoding
4099 runparams.main_fontenc = params().main_font_encoding();
4101 // Use the right wrapping for the comment at the beginning of the generated
4102 // snippet, so that it is either valid LaTeX or valid XML (including HTML and DocBook).
4103 docstring comment_start = from_ascii("% ");
4104 docstring comment_end = from_ascii("");
4105 if (runparams.flavor == Flavor::Html || runparams.flavor == Flavor::DocBook5) {
4106 comment_start = from_ascii("<!-- ");
4107 comment_end = from_ascii(" -->");
4110 if (output == CurrentParagraph) {
4111 runparams.par_begin = par_begin;
4112 runparams.par_end = par_end;
4113 if (par_begin + 1 == par_end) {
4115 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4120 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4121 convert<docstring>(par_begin),
4122 convert<docstring>(par_end - 1))
4126 // output paragraphs
4127 if (runparams.flavor == Flavor::LyX) {
4128 Paragraph const & par = text().paragraphs()[par_begin];
4130 depth_type dt = par.getDepth();
4131 par.write(ods, params(), dt);
4132 os << from_utf8(ods.str());
4133 } else if (runparams.flavor == Flavor::Html) {
4135 setMathFlavor(runparams);
4136 xhtmlParagraphs(text(), *this, xs, runparams);
4137 } else if (runparams.flavor == Flavor::Text) {
4139 // FIXME Handles only one paragraph, unlike the others.
4140 // Probably should have some routine with a signature like them.
4141 writePlaintextParagraph(*this,
4142 text().paragraphs()[par_begin], os, runparams, dummy);
4143 } else if (runparams.flavor == Flavor::DocBook5) {
4145 docbookParagraphs(text(), *this, xs, runparams);
4147 // If we are previewing a paragraph, even if this is the
4148 // child of some other buffer, let's cut the link here,
4149 // so that no concurring settings from the master
4150 // (e.g. branch state) interfere (see #8101).
4152 d->ignore_parent = true;
4153 // We need to validate the Buffer params' features here
4154 // in order to know if we should output polyglossia
4155 // macros (instead of babel macros)
4156 LaTeXFeatures features(*this, params(), runparams);
4158 runparams.use_polyglossia = features.usePolyglossia();
4159 runparams.use_hyperref = features.isRequired("hyperref");
4160 // latex or literate
4163 ots.texrow().newlines(2);
4165 latexParagraphs(*this, text(), ots, runparams);
4166 texrow = ots.releaseTexRow();
4168 // Restore the parenthood
4170 d->ignore_parent = false;
4173 os << comment_start;
4174 if (output == FullSource)
4175 os << _("Preview source code");
4176 else if (output == OnlyPreamble)
4177 os << _("Preview preamble");
4178 else if (output == OnlyBody)
4179 os << _("Preview body");
4182 if (runparams.flavor == Flavor::LyX) {
4184 if (output == FullSource)
4186 else if (output == OnlyPreamble)
4187 params().writeFile(ods, this);
4188 else if (output == OnlyBody)
4190 os << from_utf8(ods.str());
4191 } else if (runparams.flavor == Flavor::Html) {
4192 writeLyXHTMLSource(os, runparams, output);
4193 } else if (runparams.flavor == Flavor::Text) {
4194 if (output == OnlyPreamble)
4195 os << "% "<< _("Plain text does not have a preamble.");
4197 writePlaintextFile(*this, os, runparams);
4198 } else if (runparams.flavor == Flavor::DocBook5) {
4199 writeDocBookSource(os, runparams, output);
4201 // latex or literate
4204 ots.texrow().newlines(2);
4206 runparams.is_child = true;
4208 writeLaTeXSource(ots, string(), runparams, output);
4209 texrow = ots.releaseTexRow();
4216 ErrorList & Buffer::errorList(string const & type) const
4218 return d->errorLists[type];
4222 void Buffer::updateTocItem(std::string const & type,
4223 DocIterator const & dit) const
4226 d->gui_->updateTocItem(type, dit);
4230 void Buffer::structureChanged() const
4233 d->gui_->structureChanged();
4237 void Buffer::errors(string const & err, bool from_master) const
4240 d->gui_->errors(err, from_master);
4244 void Buffer::message(docstring const & msg) const
4247 d->gui_->message(msg);
4251 void Buffer::setBusy(bool on) const
4254 d->gui_->setBusy(on);
4258 void Buffer::updateTitles() const
4261 d->wa_->updateTitles();
4265 void Buffer::scheduleRedrawWorkAreas() const
4268 d->wa_->scheduleRedraw();
4272 void Buffer::resetAutosaveTimers() const
4275 d->gui_->resetAutosaveTimers();
4279 bool Buffer::hasGuiDelegate() const
4285 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4291 FileName Buffer::getEmergencyFileName() const
4293 return FileName(d->filename.absFileName() + ".emergency");
4297 FileName Buffer::getAutosaveFileName() const
4299 // if the document is unnamed try to save in the backup dir, else
4300 // in the default document path, and as a last try in the filePath,
4301 // which will most often be the temporary directory
4304 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4305 : lyxrc.backupdir_path;
4306 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4309 string const fname = "#" + d->filename.onlyFileName() + "#";
4311 return makeAbsPath(fname, fpath);
4315 void Buffer::removeAutosaveFile() const
4317 FileName const f = getAutosaveFileName();
4323 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4325 FileName const newauto = getAutosaveFileName();
4327 if (newauto != oldauto && oldauto.exists())
4328 if (!oldauto.moveTo(newauto))
4329 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4333 bool Buffer::autoSave() const
4335 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4336 if (buf->d->bak_clean || hasReadonlyFlag())
4339 message(_("Autosaving current document..."));
4340 buf->d->bak_clean = true;
4342 FileName const fname = getAutosaveFileName();
4343 LASSERT(d->cloned_buffer_, return false);
4345 // If this buffer is cloned, we assume that
4346 // we are running in a separate thread already.
4347 TempFile tempfile("lyxautoXXXXXX.lyx");
4348 tempfile.setAutoRemove(false);
4349 FileName const tmp_ret = tempfile.name();
4350 if (!tmp_ret.empty()) {
4352 // assume successful write of tmp_ret
4353 if (tmp_ret.moveTo(fname))
4356 // failed to write/rename tmp_ret so try writing direct
4357 return writeFile(fname);
4361 void Buffer::setExportStatus(bool e) const
4363 d->doing_export = e;
4364 ListOfBuffers clist = getDescendants();
4365 for (auto const & bit : clist)
4366 bit->d->doing_export = e;
4370 bool Buffer::isExporting() const
4372 return d->doing_export;
4376 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4380 return doExport(target, put_in_tempdir, result_file);
4383 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4384 string & result_file) const
4386 bool const update_unincluded =
4387 params().maintain_unincluded_children != BufferParams::CM_None
4388 && !params().getIncludedChildren().empty();
4390 // (1) export with all included children (omit \includeonly)
4391 if (update_unincluded) {
4392 ExportStatus const status =
4393 doExport(target, put_in_tempdir, true, result_file);
4394 if (status != ExportSuccess)
4397 // (2) export with included children only
4398 return doExport(target, put_in_tempdir, false, result_file);
4402 void Buffer::setMathFlavor(OutputParams & op) const
4404 // Passes the way to generate formulae to the XHTML output code.
4405 // In particular, this function has no impact on the DocBook code, as it
4406 // uses another mechanism to handle math flavours.
4407 switch (params().html_math_output) {
4408 case BufferParams::MathML:
4409 op.math_flavor = OutputParams::MathAsMathML;
4411 case BufferParams::HTML:
4412 op.math_flavor = OutputParams::MathAsHTML;
4414 case BufferParams::Images:
4415 op.math_flavor = OutputParams::MathAsImages;
4417 case BufferParams::LaTeX:
4418 op.math_flavor = OutputParams::MathAsLaTeX;
4424 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4425 bool includeall, string & result_file) const
4427 LYXERR(Debug::FILES, "target=" << target);
4428 OutputParams runparams(¶ms().encoding());
4429 string format = target;
4430 string dest_filename;
4431 size_t pos = target.find(' ');
4432 if (pos != string::npos) {
4433 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4434 format = target.substr(0, pos);
4435 if (format == "default")
4436 format = params().getDefaultOutputFormat();
4437 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4438 FileName(dest_filename).onlyPath().createPath();
4439 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4441 MarkAsExporting exporting(this);
4442 string backend_format;
4443 runparams.flavor = Flavor::LaTeX;
4444 runparams.linelen = lyxrc.plaintext_linelen;
4445 runparams.includeall = includeall;
4446 vector<string> backs = params().backends();
4447 Converters converters = theConverters();
4448 bool need_nice_file = false;
4449 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4450 // Get the shortest path to format
4451 converters.buildGraph();
4452 Graph::EdgePath path;
4453 for (string const & sit : backs) {
4454 Graph::EdgePath p = converters.getPath(sit, format);
4455 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4456 backend_format = sit;
4461 if (!put_in_tempdir) {
4462 // Only show this alert if this is an export to a non-temporary
4463 // file (not for previewing).
4464 docstring s = bformat(_("No information for exporting the format %1$s."),
4465 translateIfPossible(theFormats().prettyName(format)));
4466 if (format == "pdf4")
4468 + bformat(_("Hint: use non-TeX fonts or set input encoding "
4469 " to '%1$s'"), from_utf8(encodings.fromLyXName("ascii")->guiName()));
4470 Alert::error(_("Couldn't export file"), s);
4472 return ExportNoPathToFormat;
4474 runparams.flavor = converters.getFlavor(path, this);
4475 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4476 for (auto const & edge : path)
4477 if (theConverters().get(edge).nice()) {
4478 need_nice_file = true;
4483 backend_format = format;
4484 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4485 // FIXME: Don't hardcode format names here, but use a flag
4486 if (backend_format == "pdflatex")
4487 runparams.flavor = Flavor::PdfLaTeX;
4488 else if (backend_format == "luatex")
4489 runparams.flavor = Flavor::LuaTeX;
4490 else if (backend_format == "dviluatex")
4491 runparams.flavor = Flavor::DviLuaTeX;
4492 else if (backend_format == "xetex")
4493 runparams.flavor = Flavor::XeTeX;
4496 string filename = latexName(false);
4497 filename = addName(temppath(), filename);
4498 filename = changeExtension(filename,
4499 theFormats().extension(backend_format));
4500 LYXERR(Debug::FILES, "filename=" << filename);
4502 // Plain text backend
4503 if (backend_format == "text") {
4504 runparams.flavor = Flavor::Text;
4506 writePlaintextFile(*this, FileName(filename), runparams);
4508 catch (ConversionException const &) { return ExportCancel; }
4511 else if (backend_format == "xhtml") {
4512 runparams.flavor = Flavor::Html;
4513 setMathFlavor(runparams);
4514 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4515 return ExportKilled;
4516 } else if (backend_format == "lyx")
4517 writeFile(FileName(filename));
4519 else if (backend_format == "docbook5") {
4520 runparams.flavor = Flavor::DocBook5;
4521 runparams.nice = false;
4522 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4523 return ExportKilled;
4526 else if (backend_format == format || need_nice_file) {
4527 runparams.nice = true;
4528 ExportStatus const retval =
4529 makeLaTeXFile(FileName(filename), string(), runparams);
4530 if (retval == ExportKilled)
4531 return ExportKilled;
4532 if (d->cloned_buffer_)
4533 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4534 if (retval != ExportSuccess)
4536 } else if (!lyxrc.tex_allows_spaces
4537 && contains(filePath(), ' ')) {
4538 Alert::error(_("File name error"),
4539 bformat(_("The directory path to the document\n%1$s\n"
4540 "contains spaces, but your TeX installation does "
4541 "not allow them. You should save the file to a directory "
4542 "whose name does not contain spaces."), from_utf8(filePath())));
4543 return ExportTexPathHasSpaces;
4545 runparams.nice = false;
4546 ExportStatus const retval =
4547 makeLaTeXFile(FileName(filename), filePath(), runparams);
4548 if (retval == ExportKilled)
4549 return ExportKilled;
4550 if (d->cloned_buffer_)
4551 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4552 if (retval != ExportSuccess)
4556 string const error_type = (format == "program")
4557 ? "Build" : params().bufferFormat();
4558 ErrorList & error_list = d->errorLists[error_type];
4559 string const ext = theFormats().extension(format);
4560 FileName const tmp_result_file(changeExtension(filename, ext));
4561 Converters::RetVal const retval =
4562 converters.convert(this, FileName(filename), tmp_result_file,
4563 FileName(absFileName()), backend_format, format,
4564 error_list, Converters::none, includeall);
4565 if (retval == Converters::KILLED)
4566 return ExportCancel;
4567 bool success = (retval == Converters::SUCCESS);
4569 // Emit the signal to show the error list or copy it back to the
4570 // cloned Buffer so that it can be emitted afterwards.
4571 if (format != backend_format) {
4572 if (runparams.silent)
4574 else if (d->cloned_buffer_)
4575 d->cloned_buffer_->d->errorLists[error_type] =
4576 d->errorLists[error_type];
4579 // also to the children, in case of master-buffer-view
4580 ListOfBuffers clist = getDescendants();
4581 for (auto const & bit : clist) {
4582 if (runparams.silent)
4583 bit->d->errorLists[error_type].clear();
4584 else if (d->cloned_buffer_) {
4585 // Enable reverse search by copying back the
4586 // texrow object to the cloned buffer.
4587 // FIXME: this is not thread safe.
4588 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4589 bit->d->cloned_buffer_->d->errorLists[error_type] =
4590 bit->d->errorLists[error_type];
4592 bit->errors(error_type, true);
4596 if (d->cloned_buffer_) {
4597 // Enable reverse dvi or pdf to work by copying back the texrow
4598 // object to the cloned buffer.
4599 // FIXME: There is a possibility of concurrent access to texrow
4600 // here from the main GUI thread that should be securized.
4601 d->cloned_buffer_->d->texrow = d->texrow;
4602 string const err_type = params().bufferFormat();
4603 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4607 if (put_in_tempdir) {
4608 result_file = tmp_result_file.absFileName();
4609 return success ? ExportSuccess : ExportConverterError;
4612 if (dest_filename.empty())
4613 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4615 result_file = dest_filename;
4616 // We need to copy referenced files (e.g. included graphics
4617 // if format == "dvi") to the result dir.
4618 vector<ExportedFile> const extfiles =
4619 runparams.exportdata->externalFiles(format);
4620 string const dest = runparams.export_folder.empty() ?
4621 onlyPath(result_file) : runparams.export_folder;
4622 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4623 : force_overwrite == ALL_FILES;
4624 CopyStatus status = use_force ? FORCE : SUCCESS;
4626 for (ExportedFile const & exp : extfiles) {
4627 if (status == CANCEL) {
4628 message(_("Document export cancelled."));
4629 return ExportCancel;
4631 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4632 string fixedName = exp.exportName;
4633 if (!runparams.export_folder.empty()) {
4634 // Relative pathnames starting with ../ will be sanitized
4635 // if exporting to a different folder
4636 while (fixedName.substr(0, 3) == "../")
4637 fixedName = fixedName.substr(3, fixedName.length() - 3);
4639 FileName fixedFileName = makeAbsPath(fixedName, dest);
4640 fixedFileName.onlyPath().createPath();
4641 status = copyFile(fmt, exp.sourceName,
4643 exp.exportName, status == FORCE,
4644 runparams.export_folder.empty());
4648 if (tmp_result_file.exists()) {
4649 // Finally copy the main file
4650 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4651 : force_overwrite != NO_FILES;
4652 if (status == SUCCESS && use_force)
4654 status = copyFile(format, tmp_result_file,
4655 FileName(result_file), result_file,
4657 if (status == CANCEL) {
4658 message(_("Document export cancelled."));
4659 return ExportCancel;
4661 message(bformat(_("Document exported as %1$s "
4663 translateIfPossible(theFormats().prettyName(format)),
4664 makeDisplayPath(result_file)));
4667 // This must be a dummy converter like fax (bug 1888)
4668 message(bformat(_("Document exported as %1$s"),
4669 translateIfPossible(theFormats().prettyName(format))));
4672 return success ? ExportSuccess : ExportConverterError;
4676 Buffer::ExportStatus Buffer::preview(string const & format) const
4678 bool const update_unincluded =
4679 params().maintain_unincluded_children != BufferParams::CM_None
4680 && !params().getIncludedChildren().empty();
4681 return preview(format, update_unincluded);
4685 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4687 MarkAsExporting exporting(this);
4689 // (1) export with all included children (omit \includeonly)
4691 ExportStatus const status = doExport(format, true, true, result_file);
4692 if (status != ExportSuccess)
4695 // (2) export with included children only
4696 ExportStatus const status = doExport(format, true, false, result_file);
4697 FileName const previewFile(result_file);
4699 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4700 theimpl->preview_file_ = previewFile;
4701 theimpl->preview_format_ = format;
4702 theimpl->require_fresh_start_ = (status != ExportSuccess);
4704 if (status != ExportSuccess)
4707 if (previewFile.exists())
4708 return theFormats().view(*this, previewFile, format) ?
4709 PreviewSuccess : PreviewError;
4711 // Successful export but no output file?
4712 // Probably a bug in error detection.
4713 LATTEST(status != ExportSuccess);
4718 Buffer::ReadStatus Buffer::extractFromVC()
4720 bool const found = LyXVC::file_not_found_hook(d->filename);
4722 return ReadFileNotFound;
4723 if (!d->filename.isReadableFile())
4729 Buffer::ReadStatus Buffer::loadEmergency()
4731 FileName const emergencyFile = getEmergencyFileName();
4732 if (!emergencyFile.exists()
4733 || emergencyFile.lastModified() <= d->filename.lastModified())
4734 return ReadFileNotFound;
4736 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4737 docstring const text = bformat(_("An emergency save of the document "
4738 "%1$s exists.\n\nRecover emergency save?"), file);
4740 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4741 0, 3, _("&Recover"), _("&Load Original"), _("&Only show difference"), _("&Cancel"));
4747 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4748 bool const success = (ret_llf == ReadSuccess);
4750 if (hasReadonlyFlag()) {
4751 Alert::warning(_("File is read-only"),
4752 bformat(_("An emergency file is successfully loaded, "
4753 "but the original file %1$s is marked read-only. "
4754 "Please make sure to save the document as a different "
4755 "file."), from_utf8(d->filename.absFileName())));
4758 lyxvc().file_found_hook(d->filename);
4759 str = _("Document was successfully recovered.");
4761 str = _("Document was NOT successfully recovered.");
4762 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4763 makeDisplayPath(emergencyFile.absFileName()));
4765 int const del_emerg =
4766 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4767 _("&Remove"), _("&Keep"));
4768 if (del_emerg == 0) {
4769 emergencyFile.removeFile();
4771 Alert::warning(_("Emergency file deleted"),
4772 _("Do not forget to save your file now!"), true);
4774 return success ? ReadSuccess : ReadEmergencyFailure;
4777 int const del_emerg =
4778 Alert::prompt(_("Delete emergency file?"),
4779 _("Remove emergency file now?"), 1, 1,
4780 _("&Remove"), _("&Keep"));
4782 emergencyFile.removeFile();
4786 string const ename = emergencyFile.absFileName();
4788 // Surely we can find one in 100 tries?
4789 for (int i = 1; i < 100; ++i) {
4790 newname.set(ename + to_string(i) + ".lyx");
4791 if (!newname.exists()) {
4797 // renameTo returns true on success. So inverting that
4798 // will give us true if we fail.
4799 noname = !emergencyFile.renameTo(newname);
4802 Alert::warning(_("Can't rename emergency file!"),
4803 _("LyX was unable to rename the emergency file. "
4804 "You should do so manually. Otherwise, you will be "
4805 "asked about it again the next time you try to load "
4806 "this file, and may over-write your own work."));
4808 Alert::warning(_("Emergency File Renames"),
4809 bformat(_("Emergency file renamed as:\n %1$s"),
4810 from_utf8(newname.onlyFileName())));
4813 return ReadOriginal;
4817 string const f1 = d->filename.absFileName();
4818 string const f2 = emergencyFile.absFileName();
4819 if (loadThisLyXFile(d->filename) != ReadSuccess)
4821 string const par = "compare run-blocking " + quoteName(f1) + " " + quoteName(f2);
4822 LYXERR(Debug::FILES, par << "\n");
4823 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, par));
4825 //release the emergency buffer loaded by compare
4826 Buffer * emerBuffer = theBufferList().getBuffer(emergencyFile);
4828 theBufferList().release(emerBuffer);
4830 return ReadCancel; //Release the buffer of Original immediatelly
4839 Buffer::ReadStatus Buffer::loadAutosave()
4841 // Now check if autosave file is newer.
4842 FileName const autosaveFile = getAutosaveFileName();
4843 if (!autosaveFile.exists()
4844 || autosaveFile.lastModified() <= d->filename.lastModified())
4845 return ReadFileNotFound;
4847 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4848 docstring const text = bformat(_("The backup of the document %1$s "
4849 "is newer.\n\nLoad the backup instead?"), file);
4850 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4851 _("&Load backup"), _("Load &original"), _("&Cancel"));
4856 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4857 // the file is not saved if we load the autosave file.
4858 if (ret_llf == ReadSuccess) {
4859 if (hasReadonlyFlag()) {
4860 Alert::warning(_("File is read-only"),
4861 bformat(_("A backup file is successfully loaded, "
4862 "but the original file %1$s is marked read-only. "
4863 "Please make sure to save the document as a "
4865 from_utf8(d->filename.absFileName())));
4868 lyxvc().file_found_hook(d->filename);
4871 return ReadAutosaveFailure;
4874 // Here we delete the autosave
4875 autosaveFile.removeFile();
4876 return ReadOriginal;
4884 Buffer::ReadStatus Buffer::loadLyXFile()
4886 if (!d->filename.isReadableFile()) {
4887 ReadStatus const ret_rvc = extractFromVC();
4888 if (ret_rvc != ReadSuccess)
4892 ReadStatus const ret_re = loadEmergency();
4893 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4896 ReadStatus const ret_ra = loadAutosave();
4897 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4900 return loadThisLyXFile(d->filename);
4904 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4906 return readFile(fn);
4910 void Buffer::Impl::traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const
4912 for (; err != end; ++err) {
4913 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4914 int errorRow = err->error_in_line;
4915 Buffer const * buf = nullptr;
4916 Impl const * p = this;
4917 if (err->child_name.empty())
4918 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4920 // The error occurred in a child
4921 for (Buffer const * child : owner_->getDescendants()) {
4922 string const child_name =
4923 DocFileName(changeExtension(child->absFileName(), "tex")).
4925 if (err->child_name != child_name)
4927 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4928 if (!TexRow::isNone(start)) {
4929 buf = this->cloned_buffer_
4930 ? child->d->cloned_buffer_->d->owner_
4937 errorList.push_back(ErrorItem(err->error_desc, err->error_text,
4943 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4945 TeXErrors::Errors::const_iterator err = terr.begin();
4946 TeXErrors::Errors::const_iterator end = terr.end();
4948 d->traverseErrors(err, end, errorList);
4952 void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const
4954 TeXErrors::Errors::const_iterator err = terr.begin_ref();
4955 TeXErrors::Errors::const_iterator end = terr.end_ref();
4957 d->traverseErrors(err, end, errorList);
4961 void Buffer::updateBuffer() const
4963 updateBuffer(UpdateMaster, InternalUpdate);
4964 d->need_update = false;
4968 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4970 LBUFERR(!text().paragraphs().empty());
4972 // This can be called when loading a file, so that there be no
4974 UndoGroupHelper ugh(const_cast<Buffer *>(this));
4976 // Use the master text class also for child documents
4977 Buffer const * const master = masterBuffer();
4978 DocumentClass const & textclass = master->params().documentClass();
4980 docstring_list old_bibfiles;
4981 // Do this only if we are the top-level Buffer. We also need to account
4982 // for the case of a previewed child with ignored parent here.
4983 if (master == this && !d->ignore_parent) {
4984 textclass.counters().reset(from_ascii("bibitem"));
4985 reloadBibInfoCache();
4986 // we will re-read this cache as we go through, but we need
4987 // to know whether it's changed to know whether we need to
4988 // update the bibinfo cache.
4989 old_bibfiles = d->bibfiles_cache_;
4990 d->bibfiles_cache_.clear();
4993 // keep the buffers to be children in this set. If the call from the
4994 // master comes back we can see which of them were actually seen (i.e.
4995 // via an InsetInclude). The remaining ones in the set need still be updated.
4996 static std::set<Buffer const *> bufToUpdate;
4997 if (scope == UpdateMaster) {
4998 // If this is a child document start with the master
4999 if (master != this) {
5000 bufToUpdate.insert(this);
5001 master->updateBuffer(UpdateMaster, utype);
5002 // If the master buffer has no gui associated with it, then the TocModel is
5003 // not updated during the updateBuffer call and TocModel::toc_ is invalid
5004 // (bug 5699). The same happens if the master buffer is open in a different
5005 // window. This test catches both possibilities.
5006 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
5007 // There remains a problem here: If there is another child open in yet a third
5008 // window, that TOC is not updated. So some more general solution is needed at
5010 if (master->d->gui_ != d->gui_)
5013 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
5014 if (bufToUpdate.find(this) == bufToUpdate.end())
5018 // start over the counters in the master
5019 textclass.counters().reset();
5022 // update will be done below for this buffer
5023 bufToUpdate.erase(this);
5025 // update all caches
5026 clearReferenceCache();
5029 Buffer & cbuf = const_cast<Buffer &>(*this);
5030 // if we are reloading, then we could have a dangling TOC,
5031 // in effect. so we need to go ahead and reset, even though
5032 // we will do so again when we rebuild the TOC later.
5033 cbuf.tocBackend().reset();
5036 ParIterator parit = cbuf.par_iterator_begin();
5037 if (scope == UpdateMaster)
5039 updateBuffer(parit, utype);
5041 // If this document has siblings, then update the TocBackend later. The
5042 // reason is to ensure that later siblings are up to date when e.g. the
5043 // broken or not status of references is computed. The update is called
5044 // in InsetInclude::addToToc.
5048 // if the bibfiles changed, the cache of bibinfo is invalid
5049 docstring_list new_bibfiles = d->bibfiles_cache_;
5050 // this is a trick to determine whether the two vectors have
5051 // the same elements.
5052 sort(new_bibfiles.begin(), new_bibfiles.end());
5053 sort(old_bibfiles.begin(), old_bibfiles.end());
5054 if (old_bibfiles != new_bibfiles) {
5055 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
5056 invalidateBibinfoCache();
5057 reloadBibInfoCache();
5058 // We relied upon the bibinfo cache when recalculating labels. But that
5059 // cache was invalid, although we didn't find that out until now. So we
5060 // have to do it all again.
5061 // That said, the only thing we really need to do is update the citation
5062 // labels. Nothing else will have changed. So we could create a new
5063 // UpdateType that would signal that fact, if we needed to do so.
5064 parit = cbuf.par_iterator_begin();
5065 // we will be re-doing the counters and references and such.
5066 textclass.counters().reset();
5067 clearReferenceCache();
5068 // we should not need to do this again?
5070 updateBuffer(parit, utype);
5071 // this will already have been done by reloadBibInfoCache();
5072 // d->bibinfo_cache_valid_ = true;
5075 LYXERR(Debug::FILES, "Bibfiles unchanged.");
5076 // this is also set to true on the other path, by reloadBibInfoCache.
5077 d->bibinfo_cache_valid_ = true;
5079 d->cite_labels_valid_ = true;
5082 cbuf.tocBackend().update(true, utype);
5083 if (scope == UpdateMaster)
5084 cbuf.structureChanged();
5086 d->need_update = false;
5090 static depth_type getDepth(DocIterator const & it)
5092 depth_type depth = 0;
5093 for (size_t i = 0 ; i < it.depth() ; ++i)
5094 if (!it[i].inset().inMathed())
5095 depth += it[i].paragraph().getDepth() + 1;
5096 // remove 1 since the outer inset does not count
5097 // we should have at least one non-math inset, so
5098 // depth should nevery be 0. but maybe it is worth
5099 // marking this, just in case.
5101 // coverity[INTEGER_OVERFLOW]
5105 static depth_type getItemDepth(ParIterator const & it)
5107 Paragraph const & par = *it;
5108 LabelType const labeltype = par.layout().labeltype;
5110 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5113 // this will hold the lowest depth encountered up to now.
5114 depth_type min_depth = getDepth(it);
5115 ParIterator prev_it = it;
5118 --prev_it.top().pit();
5120 // start of nested inset: go to outer par
5122 if (prev_it.empty()) {
5123 // start of document: nothing to do
5128 // We search for the first paragraph with same label
5129 // that is not more deeply nested.
5130 Paragraph & prev_par = *prev_it;
5131 depth_type const prev_depth = getDepth(prev_it);
5132 if (labeltype == prev_par.layout().labeltype) {
5133 if (prev_depth < min_depth)
5134 return prev_par.itemdepth + 1;
5135 if (prev_depth == min_depth)
5136 return prev_par.itemdepth;
5138 min_depth = min(min_depth, prev_depth);
5139 // small optimization: if we are at depth 0, we won't
5140 // find anything else
5141 if (prev_depth == 0)
5147 static bool needEnumCounterReset(ParIterator const & it)
5149 Paragraph const & par = *it;
5150 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5151 depth_type const cur_depth = par.getDepth();
5152 ParIterator prev_it = it;
5153 while (prev_it.pit()) {
5154 --prev_it.top().pit();
5155 Paragraph const & prev_par = *prev_it;
5156 if (prev_par.getDepth() <= cur_depth)
5157 return prev_par.layout().name() != par.layout().name();
5159 // start of nested inset: reset
5164 // set the label of a paragraph. This includes the counters.
5165 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5167 BufferParams const & bp = owner_->masterBuffer()->params();
5168 DocumentClass const & textclass = bp.documentClass();
5169 Paragraph & par = it.paragraph();
5170 Layout const & layout = par.layout();
5171 Counters & counters = textclass.counters();
5173 if (par.params().startOfAppendix()) {
5174 // We want to reset the counter corresponding to toplevel sectioning
5175 Layout const & lay = textclass.getTOCLayout();
5176 docstring const cnt = lay.counter;
5178 counters.reset(cnt);
5179 counters.appendix(true);
5181 par.params().appendix(counters.appendix());
5183 // Compute the item depth of the paragraph
5184 par.itemdepth = getItemDepth(it);
5186 if (layout.margintype == MARGIN_MANUAL) {
5187 if (par.params().labelWidthString().empty())
5188 par.params().labelWidthString(par.expandLabel(layout, bp));
5189 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5190 // we do not need to do anything here, since the empty case is
5191 // handled during export.
5193 par.params().labelWidthString(docstring());
5196 switch(layout.labeltype) {
5197 case LABEL_ITEMIZE: {
5198 par.params().labelString(
5200 ? bp.user_defined_bullet(par.itemdepth).getLabel()
5201 // Display fallback for too deeply nested items
5202 : bformat(from_ascii("[?%1$d]"), int(par.itemdepth + 1)));
5206 case LABEL_ENUMERATE: {
5207 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5209 switch (par.itemdepth) {
5220 enumcounter += "iv";
5223 // not a valid enumdepth...
5227 if (needEnumCounterReset(it)) {
5228 // Increase the parent counter?
5229 if (layout.stepparentcounter)
5230 counters.stepParent(enumcounter, utype);
5231 // Maybe we have to reset the enumeration counter.
5232 if (!layout.resumecounter)
5233 counters.reset(enumcounter);
5235 counters.step(enumcounter, utype);
5237 string const & lang = par.getParLanguage(bp)->code();
5238 par.params().labelString(counters.theCounter(enumcounter, lang));
5243 case LABEL_SENSITIVE: {
5244 string const & type = counters.current_float();
5245 docstring full_label;
5247 full_label = owner_->B_("Senseless!!! ");
5249 docstring name = owner_->B_(textclass.floats().getType(type).name());
5250 if (counters.hasCounter(from_utf8(type))) {
5251 string const & lang = par.getParLanguage(bp)->code();
5252 counters.step(from_utf8(type), utype);
5253 full_label = bformat(from_ascii("%1$s %2$s:"),
5255 counters.theCounter(from_utf8(type), lang));
5257 full_label = bformat(from_ascii("%1$s #:"), name);
5259 par.params().labelString(full_label);
5263 case LABEL_NO_LABEL:
5264 par.params().labelString(docstring());
5268 case LABEL_CENTERED:
5269 case LABEL_STATIC: {
5270 docstring const & lcounter = layout.counter;
5271 if (!lcounter.empty()) {
5272 if (layout.toclevel <= bp.secnumdepth
5273 && (layout.latextype != LATEX_ENVIRONMENT
5274 || it.text()->isFirstInSequence(it.pit()))) {
5275 if (counters.hasCounter(lcounter))
5276 counters.step(lcounter, utype);
5277 par.params().labelString(par.expandLabel(layout, bp));
5279 par.params().labelString(docstring());
5281 par.params().labelString(par.expandLabel(layout, bp));
5287 par.params().labelString(par.expandLabel(layout, bp));
5292 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype, bool const deleted) const
5294 pushIncludedBuffer(this);
5295 // LASSERT: Is it safe to continue here, or should we just return?
5296 LASSERT(parit.pit() == 0, /**/);
5298 // Set the position of the text in the buffer to be able
5299 // to resolve macros in it.
5300 parit.text()->setMacrocontextPosition(parit);
5302 depth_type maxdepth = 0;
5303 pit_type const lastpit = parit.lastpit();
5304 bool changed = false;
5305 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5306 // reduce depth if necessary
5307 if (parit->params().depth() > maxdepth) {
5308 /** FIXME: this function is const, but
5309 * nevertheless it modifies the buffer. To be
5310 * cleaner, one should modify the buffer in
5311 * another function, which is actually
5312 * non-const. This would however be costly in
5313 * terms of code duplication.
5315 CursorData(parit).recordUndo();
5316 parit->params().depth(maxdepth);
5318 maxdepth = parit->getMaxDepthAfter();
5320 if (utype == OutputUpdate) {
5321 // track the active counters
5322 // we have to do this for the master buffer, since the local
5323 // buffer isn't tracking anything.
5324 masterBuffer()->params().documentClass().counters().
5325 setActiveLayout(parit->layout());
5328 // set the counter for this paragraph
5329 d->setLabel(parit, utype);
5332 for (auto const & insit : parit->insetList()) {
5333 parit.pos() = insit.pos;
5334 insit.inset->updateBuffer(parit, utype, deleted || parit->isDeleted(insit.pos));
5335 changed |= insit.inset->isChanged();
5338 // are there changes in this paragraph?
5339 changed |= parit->isChanged();
5342 // set change indicator for the inset (or the cell that the iterator
5343 // points to, if applicable).
5344 parit.text()->inset().isChanged(changed);
5345 popIncludedBuffer();
5349 void Buffer::forceUpdate() const
5351 d->need_update = true;
5355 bool Buffer::needUpdate() const
5357 return d->need_update;
5361 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5362 WordLangTuple & word_lang, docstring_list & suggestions) const
5366 suggestions.clear();
5367 word_lang = WordLangTuple();
5368 bool const to_end = to.empty();
5369 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5370 // OK, we start from here.
5371 for (; from != end; from.forwardPos()) {
5372 // This skips all insets with spell check disabled.
5373 while (!from.allowSpellCheck()) {
5377 // If from is at the end of the document (which is possible
5378 // when "from" was changed above) LyX will crash later otherwise.
5379 if (from.atEnd() || (!to_end && from >= end))
5382 from.paragraph().spellCheck();
5383 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5384 if (SpellChecker::misspelled(res)) {
5388 // Do not increase progress when from == to, otherwise the word
5389 // count will be wrong.
5399 void Buffer::requestSpellcheck()
5401 ParagraphList::iterator pit = paragraphs().begin();
5402 ParagraphList::iterator pend = paragraphs().end();
5403 for (; pit != pend; ++pit)
5404 pit->requestSpellCheck();
5408 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5410 bool inword = false;
5415 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5416 if (!dit.inTexted()) {
5421 Paragraph const & par = dit.paragraph();
5422 pos_type const pos = dit.pos();
5424 // Copied and adapted from isWordSeparator() in Paragraph
5425 if (pos == dit.lastpos()) {
5428 Inset const * ins = par.getInset(pos);
5429 if (ins && skipNoOutput && !ins->producesOutput()) {
5432 // stop if end of range was skipped
5433 if (!to.atEnd() && dit >= to)
5436 } else if (!par.isDeleted(pos)) {
5437 if (par.isWordSeparator(pos))
5443 if (ins && ins->isLetter()) {
5444 odocstringstream os;
5446 char_count_ += os.str().length();
5448 else if (ins && ins->isSpace())
5451 pair<int, int> words = ins->isWords();
5452 char_count_ += words.first;
5453 word_count_ += words.second;
5457 char_type const c = par.getChar(pos);
5458 if (isPrintableNonspace(c))
5460 else if (isSpace(c))
5470 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5472 d->updateStatistics(from, to, skipNoOutput);
5476 int Buffer::wordCount() const
5478 return d->wordCount();
5482 int Buffer::charCount(bool with_blanks) const
5484 return d->charCount(with_blanks);
5488 bool Buffer::areChangesPresent() const
5490 return inset().isChanged();
5494 Buffer::ReadStatus Buffer::reload()
5497 // c.f. bug https://www.lyx.org/trac/ticket/6587
5498 removeAutosaveFile();
5499 // e.g., read-only status could have changed due to version control
5500 d->filename.refresh();
5501 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5503 // clear parent. this will get reset if need be.
5504 d->setParent(nullptr);
5505 ReadStatus const status = loadLyXFile();
5506 if (status == ReadSuccess) {
5511 message(bformat(_("Document %1$s reloaded."), disp_fn));
5514 message(bformat(_("Could not reload document %1$s."), disp_fn));
5524 bool Buffer::saveAs(FileName const & fn)
5526 FileName const old_name = fileName();
5527 FileName const old_auto = getAutosaveFileName();
5528 bool const old_unnamed = isUnnamed();
5529 bool success = true;
5530 d->old_position = filePath();
5537 // bring the autosave file with us, just in case.
5538 moveAutosaveFile(old_auto);
5539 // validate version control data and
5540 // correct buffer title
5541 lyxvc().file_found_hook(fileName());
5543 // the file has now been saved to the new location.
5544 // we need to check that the locations of child buffers
5546 checkChildBuffers();
5547 checkMasterBuffer();
5550 // reset the old filename and unnamed state
5551 setFileName(old_name);
5552 setUnnamed(old_unnamed);
5556 d->old_position.clear();
5561 void Buffer::checkChildBuffers()
5563 for (auto const & bit : d->children_positions) {
5564 DocIterator dit = bit.second;
5565 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5566 if (!cbuf || !theBufferList().isLoaded(cbuf))
5568 Inset * inset = dit.nextInset();
5569 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5570 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5571 docstring const & incfile = inset_inc->getParam("filename");
5572 string oldloc = cbuf->absFileName();
5573 string newloc = makeAbsPath(to_utf8(incfile),
5574 onlyPath(absFileName())).absFileName();
5575 if (oldloc == newloc)
5577 // the location of the child file is incorrect.
5578 cbuf->setParent(nullptr);
5579 inset_inc->setChildBuffer(nullptr);
5581 // invalidate cache of children
5582 d->children_positions.clear();
5583 d->position_to_children.clear();
5587 // If a child has been saved under a different name/path, it might have been
5588 // orphaned. Therefore the master needs to be reset (bug 8161).
5589 void Buffer::checkMasterBuffer()
5591 Buffer const * const master = masterBuffer();
5595 // necessary to re-register the child (bug 5873)
5596 // FIXME: clean up updateMacros (here, only
5597 // child registering is needed).
5598 master->updateMacros();
5599 // (re)set master as master buffer, but only
5600 // if we are a real child
5601 if (master->isChild(this))
5608 string Buffer::includedFilePath(string const & name, string const & ext) const
5610 if (d->old_position.empty() ||
5611 equivalent(FileName(d->old_position), FileName(filePath())))
5614 bool isabsolute = FileName::isAbsolute(name);
5615 // both old_position and filePath() end with a path separator
5616 string absname = isabsolute ? name : d->old_position + name;
5618 // if old_position is set to origin, we need to do the equivalent of
5619 // getReferencedFileName() (see readDocument())
5620 if (!isabsolute && d->old_position == params().origin) {
5621 FileName const test(addExtension(filePath() + name, ext));
5623 absname = filePath() + name;
5626 if (!FileName(addExtension(absname, ext)).exists())
5630 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5632 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5633 from_utf8(filePath())));
5637 void Buffer::Impl::refreshFileMonitor()
5639 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5640 file_monitor_->refresh();
5644 // The previous file monitor is invalid
5645 // This also destroys the previous file monitor and all its connections
5646 file_monitor_ = FileSystemWatcher::monitor(filename);
5647 // file_monitor_ will be destroyed with *this, so it is not going to call a
5648 // destroyed object method.
5649 file_monitor_->connect([this](bool exists) {
5650 fileExternallyModified(exists);
5655 void Buffer::Impl::fileExternallyModified(bool const exists)
5657 // ignore notifications after our own saving operations
5658 if (checksum_ == filename.checksum()) {
5659 LYXERR(Debug::FILES, "External modification but "
5660 "checksum unchanged: " << filename);
5663 // If the file has been deleted, only mark the file as dirty since it is
5664 // pointless to prompt for reloading. If later a file is moved into this
5665 // location, then the externally modified warning will appear then.
5667 externally_modified_ = true;
5668 // Update external modification notification.
5669 // Dirty buffers must be visible at all times.
5670 if (wa_ && wa_->unhide(owner_))
5671 wa_->updateTitles();
5673 // Unable to unhide the buffer (e.g. no GUI or not current View)
5678 bool Buffer::notifiesExternalModification() const
5680 return d->externally_modified_;
5684 void Buffer::clearExternalModification() const
5686 d->externally_modified_ = false;
5688 d->wa_->updateTitles();
5692 void Buffer::pushIncludedBuffer(Buffer const * buf) const
5694 masterBuffer()->d->include_list_.push_back(buf);
5695 if (lyxerr.debugging(Debug::FILES)) {
5696 LYXERR0("Pushed. Stack now:");
5697 if (masterBuffer()->d->include_list_.empty())
5700 for (auto const & b : masterBuffer()->d->include_list_)
5701 LYXERR0(b->fileName());
5706 void Buffer::popIncludedBuffer() const
5708 masterBuffer()->d->include_list_.pop_back();
5709 if (lyxerr.debugging(Debug::FILES)) {
5710 LYXERR0("Popped. Stack now:");
5711 if (masterBuffer()->d->include_list_.empty())
5714 for (auto const & b : masterBuffer()->d->include_list_)
5715 LYXERR0(b->fileName());
5720 bool Buffer::isBufferIncluded(Buffer const * buf) const
5724 if (lyxerr.debugging(Debug::FILES)) {
5725 LYXERR0("Checking for " << buf->fileName() << ". Stack now:");
5726 if (masterBuffer()->d->include_list_.empty())
5729 for (auto const & b : masterBuffer()->d->include_list_)
5730 LYXERR0(b->fileName());
5732 list<Buffer const *> const & blist = masterBuffer()->d->include_list_;
5733 return find(blist.begin(), blist.end(), buf) != blist.end();
5737 void Buffer::clearIncludeList() const
5739 LYXERR(Debug::FILES, "Clearing include list for " << fileName());
5740 d->include_list_.clear();