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 Undo const & Buffer::undo() const
811 void Buffer::setChild(DocIterator const & dit, Buffer * child)
813 d->children_positions[child] = dit;
817 string Buffer::latexName(bool const no_path) const
819 FileName latex_name =
820 makeLatexName(d->exportFileName());
821 return no_path ? latex_name.onlyFileName()
822 : latex_name.absFileName();
826 FileName Buffer::Impl::exportFileName() const
828 docstring const branch_suffix =
829 params.branchlist().getFileNameSuffix();
830 if (branch_suffix.empty())
833 string const name = addExtension(filename.onlyFileNameWithoutExt()
834 + to_utf8(branch_suffix), filename.extension());
835 FileName res(filename.onlyPath().absFileName() + "/" + name);
841 string Buffer::logName(LogType * type) const
843 string const filename = latexName(false);
845 if (filename.empty()) {
851 string const path = temppath();
853 FileName const fname(addName(temppath(),
854 onlyFileName(changeExtension(filename,
857 // FIXME: how do we know this is the name of the build log?
858 FileName const bname(
859 addName(path, onlyFileName(
860 changeExtension(filename,
861 theFormats().extension(params().bufferFormat()) + ".out"))));
863 // Also consider the master buffer log file
864 FileName masterfname = fname;
865 LogType mtype = latexlog;
866 if (masterBuffer() != this) {
867 string const mlogfile = masterBuffer()->logName(&mtype);
868 masterfname = FileName(mlogfile);
871 // If no Latex log or Build log is newer, show Build log
872 if (bname.exists() &&
873 ((!fname.exists() && !masterfname.exists())
874 || (fname.lastModified() < bname.lastModified()
875 && masterfname.lastModified() < bname.lastModified()))) {
876 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
879 return bname.absFileName();
880 // If we have a newer master file log or only a master log, show this
881 } else if (fname != masterfname
882 && (!fname.exists() && (masterfname.exists()
883 || fname.lastModified() < masterfname.lastModified()))) {
884 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
887 return masterfname.absFileName();
889 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
892 return fname.absFileName();
896 void Buffer::setReadonly(bool const flag)
898 if (d->read_only != flag) {
905 void Buffer::setFileName(FileName const & fname)
907 bool const changed = fname != d->filename;
909 d->refreshFileMonitor();
911 lyxvc().file_found_hook(fname);
912 setReadonly(d->filename.isReadOnly());
918 int Buffer::readHeader(Lexer & lex)
920 int unknown_tokens = 0;
922 int begin_header_line = -1;
924 // Initialize parameters that may be/go lacking in header:
925 params().branchlist().clear();
926 params().preamble.erase();
927 params().options.erase();
928 params().master.erase();
929 params().float_placement.erase();
930 params().float_alignment.erase();
931 params().paperwidth.erase();
932 params().paperheight.erase();
933 params().leftmargin.erase();
934 params().rightmargin.erase();
935 params().topmargin.erase();
936 params().bottommargin.erase();
937 params().headheight.erase();
938 params().headsep.erase();
939 params().footskip.erase();
940 params().columnsep.erase();
941 params().font_roman_opts.erase();
942 params().font_sans_opts.erase();
943 params().font_typewriter_opts.erase();
944 params().fonts_cjk.erase();
945 params().listings_params.clear();
946 params().clearLayoutModules();
947 params().clearRemovedModules();
948 params().clearIncludedChildren();
949 params().pdfoptions().clear();
950 params().document_metadata.clear();
951 params().indiceslist().clear();
952 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
953 params().isbackgroundcolor = false;
954 params().fontcolor = RGBColor(0, 0, 0);
955 params().isfontcolor = false;
956 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
957 params().isnotefontcolor = false;
958 params().boxbgcolor = RGBColor(0xFF, 0, 0);
959 params().isboxbgcolor = false;
960 params().html_latex_start.clear();
961 params().html_latex_end.clear();
962 params().html_math_img_scale = 1.0;
963 params().output_sync_macro.erase();
964 params().setLocalLayout(docstring(), false);
965 params().setLocalLayout(docstring(), true);
966 params().biblio_opts.erase();
967 params().biblatex_bibstyle.erase();
968 params().biblatex_citestyle.erase();
969 params().multibib.erase();
970 params().lineno_opts.clear();
971 params().spellignore().clear();
973 for (int i = 0; i < 4; ++i) {
974 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
975 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
978 ErrorList & errorList = d->errorLists["Parse"];
987 if (token == "\\end_header")
991 if (token == "\\begin_header") {
992 begin_header_line = line;
996 LYXERR(Debug::PARSER, "Handling document header token: `"
999 string const result =
1000 params().readToken(lex, token, d->filename);
1001 if (!result.empty()) {
1002 if (token == "\\textclass") {
1003 d->layout_position = result;
1006 docstring const s = bformat(_("Unknown token: "
1009 lex.getDocString());
1010 errorList.push_back(ErrorItem(_("Document header error"), s));
1014 if (begin_header_line) {
1015 docstring const s = _("\\begin_header is missing");
1016 errorList.push_back(ErrorItem(_("Document header error"), s));
1019 params().shell_escape = theSession().shellescapeFiles().find(absFileName());
1021 params().makeDocumentClass(isClone(), isInternal());
1023 return unknown_tokens;
1028 // changed to be public and have one parameter
1029 // Returns true if "\end_document" is not read (Asger)
1030 bool Buffer::readDocument(Lexer & lex)
1032 ErrorList & errorList = d->errorLists["Parse"];
1035 // remove dummy empty par
1036 paragraphs().clear();
1038 if (!lex.checkFor("\\begin_document")) {
1039 docstring const s = _("\\begin_document is missing");
1040 errorList.push_back(ErrorItem(_("Document header error"), s));
1045 if (params().output_changes) {
1046 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1047 LaTeXFeatures::isAvailable("xcolor");
1050 Alert::warning(_("Changes not shown in LaTeX output"),
1051 _("Changes will not be highlighted in LaTeX output, "
1052 "because xcolor and ulem are not installed.\n"
1053 "Please install both packages or redefine "
1054 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1058 if (!parent() && !params().master.empty()) {
1059 FileName const master_file = makeAbsPath(params().master,
1060 onlyPath(absFileName()));
1061 if (isLyXFileName(master_file.absFileName())) {
1063 checkAndLoadLyXFile(master_file, true);
1065 // necessary e.g. after a reload
1066 // to re-register the child (bug 5873)
1067 // FIXME: clean up updateMacros (here, only
1068 // child registering is needed).
1069 master->updateMacros();
1070 // set master as master buffer, but only
1071 // if we are a real child
1072 if (master->isChild(this))
1074 // if the master is not fully loaded
1075 // it is probably just loading this
1076 // child. No warning needed then.
1077 else if (master->isFullyLoaded())
1078 LYXERR0("The master '"
1080 << "' assigned to this document ("
1082 << ") does not include "
1083 "this document. Ignoring the master assignment.");
1084 // If the master has just been created, un-hide it (#11162)
1085 if (!master->fileName().exists())
1086 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
1087 master->absFileName()));
1092 // assure we have a default index
1093 params().indiceslist().addDefault(B_("Index"));
1096 if (FileName::isAbsolute(params().origin))
1097 d->old_position = params().origin;
1099 d->old_position = filePath();
1104 bool const res = text().read(lex, errorList, d->inset);
1105 d->old_position.clear();
1107 // inform parent buffer about local macros
1109 Buffer const * pbuf = parent();
1110 for (auto const & m : usermacros)
1111 pbuf->usermacros.insert(m);
1115 updateMacroInstances(InternalUpdate);
1120 bool Buffer::isSyncTeXenabled() const
1122 bool enabled = params().output_sync;
1125 for (auto const & c : theConverters()) {
1126 const string dest = c.to().substr(0,3);
1127 if (dest == "dvi" || dest == "pdf") {
1128 const string cmd = c.command();
1129 enabled |= cmd.find("-synctex=") != string::npos
1130 && cmd.find("-synctex=0") == string::npos;
1138 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1140 Format const * fmt = theFormats().getFormat(format);
1143 // It is important to use the correct extension here, since some
1144 // converters create a wrong output file otherwise (e.g. html2latex)
1145 FileName const name = tempFileName("Buffer_importStringXXXXXX." + fmt->extension());
1146 ofdocstream os(name.toFilesystemEncoding().c_str());
1147 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1148 bool const success = !(os << contents).fail();
1151 bool converted = false;
1153 params().compressed = false;
1155 // remove dummy empty par
1156 paragraphs().clear();
1158 converted = importFile(format, name, errorList);
1161 removeTempFile(name);
1166 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1168 if (!theConverters().isReachable(format, "lyx"))
1171 FileName const lyx = tempFileName("Buffer_importFileXXXXXX.lyx");
1172 Converters::RetVal const retval =
1173 theConverters().convert(this, name, lyx, name, format, "lyx", errorList);
1174 if (retval == Converters::SUCCESS) {
1175 bool const success = readFile(lyx) == ReadSuccess;
1176 removeTempFile(lyx);
1184 bool Buffer::readString(string const & s)
1186 params().compressed = false;
1189 istringstream is(s);
1191 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1192 FileName const fn = tempfile.name();
1195 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1197 if (success && file_format != LYX_FORMAT) {
1198 // We need to call lyx2lyx, so write the input to a file
1199 ofstream os(fn.toFilesystemEncoding().c_str());
1202 // lyxvc in readFile
1203 if (readFile(fn) != ReadSuccess)
1207 if (readDocument(lex))
1213 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1216 if (!lex.setFile(fn)) {
1217 Alert::error(_("File Not Found"),
1218 bformat(_("Unable to open file `%1$s'."),
1219 from_utf8(fn.absFileName())));
1220 return ReadFileNotFound;
1224 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1225 if (ret_plf != ReadSuccess)
1228 if (file_format != LYX_FORMAT) {
1230 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1231 if (ret_clf != ReadSuccess)
1233 ret_clf = readFile(tmpFile);
1234 if (ret_clf == ReadSuccess) {
1235 d->file_format = file_format;
1236 d->need_format_backup = true;
1241 // FIXME: InsetInfo needs to know whether the file is under VCS
1242 // during the parse process, so this has to be done before.
1243 lyxvc().file_found_hook(d->filename);
1245 if (readDocument(lex)) {
1246 Alert::error(_("Document format failure"),
1247 bformat(_("%1$s ended unexpectedly, which means"
1248 " that it is probably corrupted."),
1249 from_utf8(fn.absFileName())));
1250 return ReadDocumentFailure;
1253 d->file_fully_loaded = true;
1254 d->read_only = !d->filename.isWritable();
1255 params().compressed = theFormats().isZippedFile(d->filename);
1261 bool Buffer::isFullyLoaded() const
1263 return d->file_fully_loaded;
1267 void Buffer::setFullyLoaded(bool value)
1269 d->file_fully_loaded = value;
1273 bool Buffer::freshStartRequired() const
1275 return d->require_fresh_start_;
1278 void Buffer::requireFreshStart(bool const b) const
1280 d->require_fresh_start_ = b;
1284 PreviewLoader * Buffer::loader() const
1286 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1288 if (!d->preview_loader_)
1289 d->preview_loader_ = new PreviewLoader(*this);
1290 return d->preview_loader_;
1294 void Buffer::removePreviews() const
1296 delete d->preview_loader_;
1297 d->preview_loader_ = nullptr;
1301 void Buffer::updatePreviews() const
1303 PreviewLoader * ploader = loader();
1307 InsetIterator it = begin(*d->inset);
1308 InsetIterator const itend = end(*d->inset);
1309 for (; it != itend; ++it)
1310 it->addPreview(it, *ploader);
1312 ploader->startLoading();
1316 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1317 FileName const & fn, int & file_format) const
1319 if(!lex.checkFor("\\lyxformat")) {
1320 Alert::error(_("Document format failure"),
1321 bformat(_("%1$s is not a readable LyX document."),
1322 from_utf8(fn.absFileName())));
1323 return ReadNoLyXFormat;
1329 // LyX formats 217 and earlier were written as 2.17. This corresponds
1330 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1331 // these cases. See also: www.lyx.org/trac/changeset/1313.
1332 size_t dot = tmp_format.find_first_of(".,");
1333 if (dot != string::npos)
1334 tmp_format.erase(dot, 1);
1336 file_format = convert<int>(tmp_format);
1341 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1342 FileName & tmpfile, int from_format)
1344 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1345 tempfile.setAutoRemove(false);
1346 tmpfile = tempfile.name();
1347 if(tmpfile.empty()) {
1348 Alert::error(_("Conversion failed"),
1349 bformat(_("%1$s is from a different"
1350 " version of LyX, but a temporary"
1351 " file for converting it could"
1352 " not be created."),
1353 from_utf8(fn.absFileName())));
1354 return LyX2LyXNoTempFile;
1357 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1358 if (lyx2lyx.empty()) {
1359 Alert::error(_("Conversion script not found"),
1360 bformat(_("%1$s is from a different"
1361 " version of LyX, but the"
1362 " conversion script lyx2lyx"
1363 " could not be found."),
1364 from_utf8(fn.absFileName())));
1365 return LyX2LyXNotFound;
1369 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1370 ostringstream command;
1371 command << os::python()
1372 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1373 << " -t " << convert<string>(LYX_FORMAT)
1374 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1375 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1376 string const command_str = command.str();
1378 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1380 cmd_ret const ret = runCommand(command_str);
1382 if (from_format < LYX_FORMAT) {
1383 Alert::error(_("Conversion script failed"),
1384 bformat(_("%1$s is from an older version"
1385 " of LyX and the lyx2lyx script"
1386 " failed to convert it."),
1387 from_utf8(fn.absFileName())));
1388 return LyX2LyXOlderFormat;
1390 Alert::error(_("Conversion script failed"),
1391 bformat(_("%1$s is from a newer version"
1392 " of LyX and the lyx2lyx script"
1393 " failed to convert it."),
1394 from_utf8(fn.absFileName())));
1395 return LyX2LyXNewerFormat;
1402 FileName Buffer::getBackupName() const {
1403 map<int, string> const file_formats = {
1420 FileName const & fn = fileName();
1421 string const fname = fn.onlyFileNameWithoutExt();
1422 string const fext = fn.extension() + "~";
1423 string const fpath = lyxrc.backupdir_path.empty() ?
1424 fn.onlyPath().absFileName() :
1425 lyxrc.backupdir_path;
1426 string backup_suffix;
1427 // If file format is from a stable series use version instead of file format
1428 auto const it = file_formats.find(d->file_format);
1429 if (it != file_formats.end())
1430 backup_suffix = "-lyx" + it->second;
1432 backup_suffix = "-lyxformat-" + convert<string>(d->file_format);
1433 string const backname = fname + backup_suffix;
1434 FileName backup(addName(fpath, addExtension(backname, fext)));
1436 // limit recursion, just in case
1438 unsigned long orig_checksum = 0;
1439 while (backup.exists() && v < 100) {
1440 if (orig_checksum == 0)
1441 orig_checksum = fn.checksum();
1442 unsigned long new_checksum = backup.checksum();
1443 if (orig_checksum == new_checksum) {
1444 LYXERR(Debug::FILES, "Not backing up " << fn <<
1445 "since " << backup << "has the same checksum.");
1446 // a bit of a hack, but we have to check this anyway
1447 // below, and setting this is simpler than introducing
1448 // a special boolean for this purpose.
1452 string const newbackname = backname + "-" + convert<string>(v);
1453 backup.set(addName(fpath, addExtension(newbackname, fext)));
1456 return v < 100 ? backup : FileName();
1460 // Should probably be moved to somewhere else: BufferView? GuiView?
1461 bool Buffer::save() const
1463 docstring const file = makeDisplayPath(absFileName(), 20);
1464 d->filename.refresh();
1466 // check the read-only status before moving the file as a backup
1467 if (d->filename.exists()) {
1468 bool const read_only = !d->filename.isWritable();
1470 Alert::warning(_("File is read-only"),
1471 bformat(_("The file %1$s cannot be written because it "
1472 "is marked as read-only."), file));
1477 // ask if the disk file has been externally modified (use checksum method)
1478 if (fileName().exists() && isChecksumModified()) {
1480 bformat(_("Document %1$s has been externally modified. "
1481 "Are you sure you want to overwrite this file?"), file);
1482 int const ret = Alert::prompt(_("Overwrite modified file?"),
1483 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1488 // We don't need autosaves in the immediate future. (Asger)
1489 resetAutosaveTimers();
1491 // if the file does not yet exist, none of the backup activity
1492 // that follows is necessary
1493 if (!fileName().exists()) {
1494 if (!writeFile(fileName()))
1500 // we first write the file to a new name, then move it to its
1501 // proper location once that has been done successfully. that
1502 // way we preserve the original file if something goes wrong.
1503 string const justname = fileName().onlyFileNameWithoutExt();
1504 auto tempfile = lyx::make_unique<TempFile>(fileName().onlyPath(),
1505 justname + "-XXXXXX.lyx");
1506 bool const symlink = fileName().isSymLink();
1508 tempfile->setAutoRemove(false);
1510 FileName savefile(tempfile->name());
1511 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1512 if (!savefile.clonePermissions(fileName()))
1513 LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
1515 if (!writeFile(savefile))
1518 // we will set this to false if we fail
1519 bool made_backup = true;
1521 FileName backupName;
1522 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1524 if (d->need_format_backup)
1525 backupName = getBackupName();
1527 // If we for some reason failed to find a backup name in case of
1528 // a format change, this will still set one. It's the best we can
1530 if (backupName.empty()) {
1531 backupName.set(fileName().absFileName() + "~");
1532 if (!lyxrc.backupdir_path.empty()) {
1533 string const mangledName =
1534 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1535 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1539 LYXERR(Debug::FILES, "Backing up original file to " <<
1540 backupName.absFileName());
1541 // Except file is symlink do not copy because of #6587.
1542 // Hard links have bad luck.
1543 made_backup = symlink ?
1544 fileName().copyTo(backupName):
1545 fileName().moveTo(backupName);
1548 Alert::error(_("Backup failure"),
1549 bformat(_("Cannot create backup file %1$s.\n"
1550 "Please check whether the directory exists and is writable."),
1551 from_utf8(backupName.absFileName())));
1552 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1553 } else if (d->need_format_backup) {
1554 // the original file has been backed up successfully, so we
1555 // will not need to do that again
1556 d->need_format_backup = false;
1560 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1561 // Only do this if tempfile is not in autoremove mode
1564 // If we have no symlink, we can simply rename the temp file.
1565 // Otherwise, we need to copy it so the symlink stays intact.
1566 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1567 savefile.moveTo(fileName()))
1569 // saveCheckSum() was already called by writeFile(), but the
1570 // time stamp is invalidated by copying/moving
1573 // the file associated with this buffer is now in the current format
1574 d->file_format = LYX_FORMAT;
1577 // else we saved the file, but failed to move it to the right location.
1579 if (needBackup && made_backup && !symlink) {
1580 // the original file was moved to some new location, so it will look
1581 // to the user as if it was deleted. (see bug #9234.) we could try
1582 // to restore it, but that would basically mean trying to do again
1583 // what we just failed to do. better to leave things as they are.
1584 Alert::error(_("Write failure"),
1585 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1586 "But LyX could not move it to:\n %2$s.\n"
1587 "Your original file has been backed up to:\n %3$s"),
1588 from_utf8(savefile.absFileName()),
1589 from_utf8(fileName().absFileName()),
1590 from_utf8(backupName.absFileName())));
1592 // either we did not try to make a backup, or else we tried and failed,
1593 // or else the original file was a symlink, in which case it was copied,
1594 // not moved. so the original file is intact.
1595 Alert::error(_("Write failure"),
1596 bformat(_("Cannot move saved file to:\n %1$s.\n"
1597 "But the file has successfully been saved as:\n %2$s."),
1598 from_utf8(fileName().absFileName()),
1599 from_utf8(savefile.absFileName())));
1605 bool Buffer::writeFile(FileName const & fname) const
1607 if (d->read_only && fname == d->filename)
1610 bool retval = false;
1612 docstring const str = bformat(_("Saving document %1$s..."),
1613 makeDisplayPath(fname.absFileName()));
1616 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1618 if (params().compressed) {
1619 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1620 retval = ofs && write(ofs);
1622 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1623 retval = ofs && write(ofs);
1627 message(str + _(" could not write file!"));
1632 // removeAutosaveFile();
1635 message(str + _(" done."));
1641 docstring Buffer::emergencyWrite() const
1643 // No need to save if the buffer has not changed.
1647 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1649 docstring user_message = bformat(
1650 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1652 // We try to save three places:
1653 // 1) Same place as document. Unless it is an unnamed doc.
1655 string s = absFileName();
1658 if (writeFile(FileName(s))) {
1660 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1661 return user_message;
1663 user_message += " " + _("Save failed! Trying again...\n");
1667 // 2) In HOME directory.
1668 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1670 lyxerr << ' ' << s << endl;
1671 if (writeFile(FileName(s))) {
1673 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1674 return user_message;
1677 user_message += " " + _("Save failed! Trying yet again...\n");
1679 // 3) In "/tmp" directory.
1680 // MakeAbsPath to prepend the current
1681 // drive letter on OS/2
1682 s = addName(package().temp_dir().absFileName(), absFileName());
1684 lyxerr << ' ' << s << endl;
1685 if (writeFile(FileName(s))) {
1687 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1688 return user_message;
1691 user_message += " " + _("Save failed! Document is lost.");
1694 return user_message;
1698 bool Buffer::write(ostream & ofs) const
1701 // Use the standard "C" locale for file output.
1702 ofs.imbue(locale::classic());
1705 // The top of the file should not be written by params().
1707 // write out a comment in the top of the file
1708 // Important: Keep the version formatting in sync with lyx2lyx and
1709 // tex2lyx (bug 7951)
1710 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1711 << " created this file. For more info see https://www.lyx.org/\n"
1712 << "\\lyxformat " << LYX_FORMAT << "\n"
1713 << "\\begin_document\n";
1715 /// For each author, set 'used' to true if there is a change
1716 /// by this author in the document; otherwise set it to 'false'.
1717 for (Author const & a : params().authors())
1720 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1721 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1722 for ( ; it != end; ++it)
1723 it->checkAuthors(params().authors());
1725 // now write out the buffer parameters.
1726 ofs << "\\begin_header\n";
1727 params().writeFile(ofs, this);
1728 ofs << "\\end_header\n";
1731 ofs << "\n\\begin_body\n";
1733 ofs << "\n\\end_body\n";
1735 // Write marker that shows file is complete
1736 ofs << "\\end_document" << endl;
1738 // Shouldn't really be needed....
1741 // how to check if close went ok?
1742 // Following is an attempt... (BE 20001011)
1744 // good() returns false if any error occurred, including some
1745 // formatting error.
1746 // bad() returns true if something bad happened in the buffer,
1747 // which should include file system full errors.
1752 lyxerr << "File was not closed properly." << endl;
1759 Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
1760 string const & original_path,
1761 OutputParams const & runparams_in,
1762 OutputWhat output) const
1764 OutputParams runparams = runparams_in;
1766 string const encoding = runparams.encoding->iconvName();
1767 LYXERR(Debug::OUTFILE, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1770 try { ofs.reset(encoding); }
1771 catch (iconv_codecvt_facet_exception const & e) {
1772 lyxerr << "Caught iconv exception: " << e.what() << endl;
1773 Alert::error(_("Iconv software exception Detected"),
1774 bformat(_("Please verify that the `iconv' support software is"
1775 " properly installed and supports the selected encoding"
1776 " (%1$s), or change the encoding in"
1777 " Document>Settings>Language."), from_ascii(encoding)));
1780 if (!openFileWrite(ofs, fname))
1783 ErrorList & errorList = d->errorLists["Export"];
1785 ExportStatus status = ExportSuccess;
1788 // make sure we are ready to export
1789 // this needs to be done before we validate
1790 // FIXME Do we need to do this all the time? I.e., in children
1791 // of a master we are exporting?
1793 updateMacroInstances(OutputUpdate);
1795 ExportStatus retval;
1797 retval = writeLaTeXSource(os, original_path, runparams, output);
1798 if (retval == ExportKilled)
1799 return ExportKilled;
1801 catch (EncodingException const & e) {
1802 docstring const failed(1, e.failed_char);
1804 oss << "0x" << hex << static_cast<uint32_t>(e.failed_char) << dec;
1805 if (getParFromID(e.par_id).paragraph().layout().pass_thru) {
1806 docstring msg = bformat(_("Uncodable character '%1$s'"
1807 " (code point %2$s)"),
1808 failed, from_utf8(oss.str()));
1809 errorList.push_back(ErrorItem(msg, _("Some characters of your document are not "
1810 "representable in specific verbatim contexts.\n"
1811 "Changing the document encoding to utf8 could help."),
1812 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1814 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1815 " (code point %2$s)"),
1816 failed, from_utf8(oss.str()));
1817 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1818 "representable in the chosen encoding.\n"
1819 "Changing the document encoding to utf8 could help."),
1820 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1822 status = ExportError;
1824 catch (iconv_codecvt_facet_exception const & e) {
1825 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1827 status = ExportError;
1829 catch (exception const & e) {
1830 errorList.push_back(ErrorItem(_("conversion failed"),
1832 lyxerr << e.what() << endl;
1833 status = ExportError;
1836 lyxerr << "Caught some really weird exception..." << endl;
1840 d->texrow = std::move(os.texrow());
1844 status = ExportError;
1845 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1848 if (runparams_in.silent)
1856 Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
1857 string const & original_path,
1858 OutputParams const & runparams_in,
1859 OutputWhat output) const
1861 // The child documents, if any, shall be already loaded at this point.
1863 OutputParams runparams = runparams_in;
1865 // Some macros rely on font encoding
1866 runparams.main_fontenc = params().main_font_encoding();
1868 // If we are compiling a file standalone, even if this is the
1869 // child of some other buffer, let's cut the link here, so the
1870 // file is really independent and no concurring settings from
1871 // the master (e.g. branch state) interfere (see #8100).
1872 if (!runparams.is_child)
1873 d->ignore_parent = true;
1875 // Classify the unicode characters appearing in math insets
1876 BufferEncodings::initUnicodeMath(*this);
1878 // validate the buffer.
1879 LYXERR(Debug::OUTFILE, " Validating buffer...");
1880 LaTeXFeatures features(*this, params(), runparams);
1882 // This is only set once per document (in master)
1883 if (!runparams.is_child) {
1884 runparams.use_polyglossia = features.usePolyglossia();
1885 runparams.use_hyperref = features.isRequired("hyperref");
1886 runparams.use_CJK = features.mustProvide("CJK");
1888 LYXERR(Debug::OUTFILE, " Buffer validation done.");
1890 bool const output_preamble =
1891 output == FullSource || output == OnlyPreamble;
1892 bool const output_body =
1893 output == FullSource || output == OnlyBody;
1895 // The starting paragraph of the coming rows is the
1896 // first paragraph of the document. (Asger)
1897 if (output_preamble && runparams.nice) {
1898 os << "%% LyX " << lyx_version << " created this file. "
1899 "For more info, see https://www.lyx.org/.\n"
1900 "%% Do not edit unless you really know what "
1903 LYXERR(Debug::INFO, "lyx document header finished");
1905 // There are a few differences between nice LaTeX and usual files:
1906 // usual files have \batchmode and special input@path to allow
1907 // inclusion of figures specified by an explicitly relative path
1908 // (i.e., a path starting with './' or '../') with either \input or
1909 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1910 // input@path is set when the actual parameter original_path is set.
1911 // This is done for usual tex-file, but not for nice-latex-file.
1912 // (Matthias 250696)
1913 // Note that input@path is only needed for something the user does
1914 // in the preamble, included .tex files or ERT, files included by
1915 // LyX work without it.
1916 if (output_preamble) {
1917 if (!runparams.nice) {
1918 // code for usual, NOT nice-latex-file
1919 os << "\\batchmode\n"; // changed from \nonstopmode
1921 if (!original_path.empty()) {
1923 // We don't know the encoding of inputpath
1924 docstring const inputpath = from_utf8(original_path);
1925 docstring uncodable_glyphs;
1926 Encoding const * const enc = runparams.encoding;
1928 for (char_type n : inputpath) {
1929 if (!enc->encodable(n)) {
1930 docstring const glyph(1, n);
1931 LYXERR0("Uncodable character '"
1933 << "' in input path!");
1934 uncodable_glyphs += glyph;
1939 // warn user if we found uncodable glyphs.
1940 if (!uncodable_glyphs.empty()) {
1941 frontend::Alert::warning(
1942 _("Uncodable character in file path"),
1944 _("The path of your document\n"
1946 "contains glyphs that are unknown "
1947 "in the current document encoding "
1948 "(namely %2$s). This may result in "
1949 "incomplete output, unless "
1950 "TEXINPUTS contains the document "
1951 "directory and you don't use "
1952 "explicitly relative paths (i.e., "
1953 "paths starting with './' or "
1954 "'../') in the preamble or in ERT."
1955 "\n\nIn case of problems, choose "
1956 "an appropriate document encoding\n"
1957 "(such as utf8) or change the "
1959 inputpath, uncodable_glyphs));
1961 string docdir = os::latex_path(original_path);
1962 if (contains(docdir, '#')) {
1963 docdir = subst(docdir, "#", "\\#");
1964 os << "\\catcode`\\#=11"
1965 "\\def\\#{#}\\catcode`\\#=6\n";
1967 if (contains(docdir, '%')) {
1968 docdir = subst(docdir, "%", "\\%");
1969 os << "\\catcode`\\%=11"
1970 "\\def\\%{%}\\catcode`\\%=14\n";
1972 if (contains(docdir, '~'))
1973 docdir = subst(docdir, "~", "\\string~");
1974 bool const nonascii = !isAscii(from_utf8(docdir));
1975 // LaTeX 2019/10/01 handles non-ascii path without detokenize
1976 bool const utfpathlatex = features.isAvailableAtLeastFrom("LaTeX", 2019, 10);
1977 bool const detokenize = !utfpathlatex && nonascii;
1978 bool const quote = contains(docdir, ' ');
1979 if (utfpathlatex && nonascii)
1980 os << "\\UseRawInputEncoding\n";
1981 os << "\\makeatletter\n"
1982 << "\\def\\input@path{{";
1984 os << "\\detokenize{";
1993 << "\\makeatother\n";
1997 // get parent macros (if this buffer has a parent) which will be
1998 // written at the document begin further down.
1999 MacroSet parentMacros;
2000 listParentMacros(parentMacros, features);
2002 // Write the preamble
2003 runparams.use_babel = params().writeLaTeX(os, features,
2004 d->filename.onlyPath());
2006 // Active characters
2007 runparams.active_chars = features.getActiveChars();
2009 // Biblatex bibliographies are loaded here
2010 if (params().useBiblatex()) {
2011 vector<pair<docstring, string>> const bibfiles =
2012 prepareBibFilePaths(runparams, getBibfiles(), true);
2013 for (pair<docstring, string> const & file: bibfiles) {
2014 os << "\\addbibresource";
2015 if (!file.second.empty())
2016 os << "[bibencoding=" << file.second << "]";
2017 os << "{" << file.first << "}\n";
2021 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
2022 && !features.hasOnlyPolyglossiaLanguages()) {
2025 vector<string> bll = features.getBabelExclusiveLanguages();
2026 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
2029 for (string const & sit : bll) {
2034 blangs = bll.size() > 1 ?
2035 bformat(_("The languages %1$s are only supported by Babel."), langs)
2036 : bformat(_("The language %1$s is only supported by Babel."), langs);
2040 for (string const & pit : pll) {
2045 plangs = pll.size() > 1 ?
2046 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
2047 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
2048 if (!blangs.empty())
2052 frontend::Alert::warning(
2053 _("Incompatible Languages!"),
2055 _("You cannot use the following languages "
2056 "together in one LaTeX document because "
2057 "they require conflicting language packages:\n"
2062 // Japanese might be required only in some children of a document,
2063 // but once required, we must keep use_japanese true.
2064 runparams.use_japanese |= features.isRequired("japanese");
2067 // Restore the parenthood if needed
2068 if (!runparams.is_child)
2069 d->ignore_parent = false;
2070 return ExportSuccess;
2074 // mark the beginning of the body to separate it from InPreamble insets
2075 os.texrow().start(TexRow::beginDocument());
2076 os << "\\begin{document}\n";
2078 // mark the start of a new paragraph by simulating a newline,
2079 // so that os.afterParbreak() returns true at document start
2082 // output the parent macros
2083 for (auto const & mac : parentMacros) {
2084 int num_lines = mac->write(os.os(), true);
2085 os.texrow().newlines(num_lines);
2088 } // output_preamble
2090 LYXERR(Debug::INFO, "preamble finished, now the body.");
2094 latexParagraphs(*this, text(), os, runparams);
2096 catch (ConversionException const &) { return ExportKilled; }
2098 // Restore the parenthood if needed
2099 if (!runparams.is_child)
2100 d->ignore_parent = false;
2102 // add this just in case after all the paragraphs
2105 if (output_preamble) {
2106 os << "\\end{document}\n";
2107 LYXERR(Debug::OUTFILE, "makeLaTeXFile...done");
2109 LYXERR(Debug::OUTFILE, "LaTeXFile for inclusion made.");
2111 runparams_in.encoding = runparams.encoding;
2113 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2114 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2115 return ExportSuccess;
2119 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2120 OutputParams const & runparams,
2121 OutputWhat output) const
2123 LYXERR(Debug::OUTFILE, "makeDocBookFile...");
2126 if (!openFileWrite(ofs, fname))
2129 // make sure we are ready to export
2130 // this needs to be done before we validate
2132 updateMacroInstances(OutputUpdate);
2134 ExportStatus const retval = writeDocBookSource(ofs, runparams, output);
2135 if (retval == ExportKilled)
2136 return ExportKilled;
2140 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2141 return ExportSuccess;
2145 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os,
2146 OutputParams const & runparams,
2147 OutputWhat output) const
2149 LaTeXFeatures features(*this, params(), runparams);
2151 d->bibinfo_.makeCitationLabels(*this);
2155 DocumentClass const & tclass = params().documentClass();
2157 bool const output_preamble =
2158 output == FullSource || output == OnlyPreamble;
2159 bool const output_body =
2160 output == FullSource || output == OnlyBody || output == IncludedFile;
2162 if (output_preamble) {
2163 // XML preamble, no doctype needed.
2164 // Not using XMLStream for this, as the root tag would be in the tag stack and make troubles with the error
2165 // detection mechanisms (these are called before the end tag is output, and thus interact with the canary
2166 // parsep in output_docbook.cpp).
2167 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2168 << "<!-- This DocBook file was created by LyX " << lyx_version
2169 << "\n See https://www.lyx.org/ for more information -->\n";
2171 // Prepare the name space declaration for MathML depending on document preferences.
2172 string mathmlNamespace;
2173 if (params().docbook_mathml_prefix != BufferParams::NoPrefix) {
2174 string mathmlPrefix;
2175 if (params().docbook_mathml_prefix == BufferParams::MPrefix)
2177 else if (params().docbook_mathml_prefix == BufferParams::MMLPrefix)
2178 mathmlPrefix = "mml";
2179 mathmlNamespace = + " xmlns:" + mathmlPrefix + "=\"http://www.w3.org/1998/Math/MathML\"";
2182 // XML-compatible language code: in lib/languages, language codes are
2183 // given as dictionary file names; HTML5 expects to follow BCP47. This
2184 // function implements a simple heuristic that does the conversion.
2185 std::string htmlCode = params().language->code();
2186 std::replace(htmlCode.begin(), htmlCode.end(), '_', '-');
2188 // Directly output the root tag, based on the current type of document.
2189 string attributes = "xml:lang=\"" + htmlCode + '"'
2190 + " xmlns=\"http://docbook.org/ns/docbook\""
2191 + " xmlns:xlink=\"http://www.w3.org/1999/xlink\""
2193 + " xmlns:xi=\"http://www.w3.org/2001/XInclude\""
2194 + " version=\"5.2\"";
2195 // Version 5.2 is required for formalgroup.
2197 os << "<" << from_ascii(tclass.docbookroot()) << " " << from_ascii(attributes) << ">\n";
2201 // Start to output the document.
2203 docbookParagraphs(text(), *this, xs, runparams);
2206 if (output_preamble) {
2207 // Close the root element. No need for a line break, as free text is never allowed
2208 // in a root element, it must always be wrapped in some container.
2209 os << "</" << from_ascii(tclass.docbookroot()) << ">";
2212 return ExportSuccess;
2216 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2217 OutputParams const & runparams) const
2219 LYXERR(Debug::OUTFILE, "makeLyXHTMLFile...");
2222 if (!openFileWrite(ofs, fname))
2225 // make sure we are ready to export
2226 // this has to be done before we validate
2227 updateBuffer(UpdateMaster, OutputUpdate);
2228 updateMacroInstances(OutputUpdate);
2230 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2231 if (retval == ExportKilled)
2236 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2241 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2242 OutputParams const & runparams,
2243 OutputWhat output) const
2245 LaTeXFeatures features(*this, params(), runparams);
2247 d->bibinfo_.makeCitationLabels(*this);
2249 bool const output_preamble =
2250 output == FullSource || output == OnlyPreamble;
2251 bool const output_body =
2252 output == FullSource || output == OnlyBody || output == IncludedFile;
2254 if (output_preamble) {
2255 // HTML5-compatible language code: in lib/languages, language codes are
2256 // given as dictionary file names; HTML5 expects to follow BCP47. This
2257 // function implements a simple heuristic that does the conversion.
2258 std::string htmlCode = params().language->code();
2259 std::replace(htmlCode.begin(), htmlCode.end(), '_', '-');
2261 os << "<!DOCTYPE html>\n"
2262 << "<html xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"" << from_ascii(htmlCode) << "\">\n"
2264 << "<meta name=\"generator\" content=\"" << PACKAGE_STRING << "\" />\n";
2266 docstring const & doctitle = features.htmlTitle();
2268 << (doctitle.empty() ?
2269 from_ascii("LyX Document") :
2270 xml::escapeString(doctitle, XMLStream::ESCAPE_ALL))
2273 docstring styles = features.getTClassHTMLPreamble();
2274 if (!styles.empty())
2275 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2277 // we will collect CSS information in a stream, and then output it
2278 // either here, as part of the header, or else in a separate file.
2279 odocstringstream css;
2280 styles = features.getCSSSnippets();
2281 if (!styles.empty())
2282 css << "/* LyX Provided Styles */\n" << styles << '\n';
2284 styles = features.getTClassHTMLStyles();
2285 if (!styles.empty())
2286 css << "/* Layout-provided Styles */\n" << styles << '\n';
2288 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2289 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2290 if (needfg || needbg) {
2291 css << "\nbody {\n";
2294 << from_ascii(X11hexname(params().fontcolor))
2297 css << " background-color: "
2298 << from_ascii(X11hexname(params().backgroundcolor))
2303 docstring const dstyles = css.str();
2304 if (!dstyles.empty()) {
2305 bool written = false;
2306 if (params().html_css_as_file) {
2307 // open a file for CSS info
2309 string const fcssname = addName(temppath(), "docstyle.css");
2310 FileName const fcssfile = FileName(fcssname);
2311 if (openFileWrite(ocss, fcssfile)) {
2315 // write link to header
2316 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2318 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2321 // we are here if the CSS is supposed to be written to the header
2322 // or if we failed to write it to an external file.
2333 bool const output_body_tag = (output != IncludedFile);
2334 if (output_body_tag)
2335 os << "<body dir=\"auto\">\n";
2337 if (output != IncludedFile)
2338 // if we're an included file, the counters are in the master.
2339 params().documentClass().counters().reset();
2341 xhtmlParagraphs(text(), *this, xs, runparams);
2343 catch (ConversionException const &) { return ExportKilled; }
2344 if (output_body_tag)
2348 if (output_preamble)
2351 return ExportSuccess;
2355 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2356 // Other flags: -wall -v0 -x
2357 int Buffer::runChktex()
2361 // get LaTeX-Filename
2362 FileName const path(temppath());
2363 string const name = addName(path.absFileName(), latexName());
2364 string const org_path = filePath();
2366 PathChanger p(path); // path to LaTeX file
2367 message(_("Running chktex..."));
2369 // Generate the LaTeX file if neccessary
2370 OutputParams runparams(¶ms().encoding());
2371 runparams.flavor = Flavor::LaTeX;
2372 runparams.nice = false;
2373 runparams.linelen = lyxrc.plaintext_linelen;
2374 ExportStatus const retval =
2375 makeLaTeXFile(FileName(name), org_path, runparams);
2376 if (retval != ExportSuccess) {
2377 // error code on failure
2382 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2383 int const res = chktex.run(terr); // run chktex
2386 Alert::error(_("chktex failure"),
2387 _("Could not run chktex successfully."));
2389 ErrorList & errlist = d->errorLists["ChkTeX"];
2391 bufferErrors(terr, errlist);
2396 if (runparams.silent)
2397 d->errorLists["ChkTeX"].clear();
2405 void Buffer::validate(LaTeXFeatures & features) const
2407 // Validate the buffer params, but not for included
2408 // files, since they also use the parent buffer's
2410 if (!features.runparams().is_child)
2411 params().validate(features);
2416 for (Paragraph const & p : paragraphs())
2417 p.validate(features);
2419 if (lyxerr.debugging(Debug::OUTFILE)) {
2420 features.showStruct();
2425 void Buffer::getLabelList(vector<std::tuple<docstring, docstring, docstring>> & list) const
2427 // If this is a child document, use the master's list instead.
2429 masterBuffer()->getLabelList(list);
2434 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2435 for (auto const & tocit : *toc) {
2436 if (tocit.depth() == 0) {
2437 list.push_back(make_tuple(tocit.str(), tocit.asString(),tocit.prettyStr()));
2443 void Buffer::invalidateBibinfoCache() const
2445 d->bibinfo_cache_valid_ = false;
2446 d->cite_labels_valid_ = false;
2447 removeBiblioTempFiles();
2448 // also invalidate the cache for the parent buffer
2449 Buffer const * const pbuf = d->parent();
2451 pbuf->invalidateBibinfoCache();
2455 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2457 // FIXME This is probably unnecessary, given where we call this.
2458 // If this is a child document, use the master instead.
2459 Buffer const * const pbuf = masterBuffer();
2460 if (pbuf != this && scope != UpdateChildOnly)
2461 return pbuf->getBibfiles();
2463 // In 2.3.x, we have:
2464 //if (!d->bibfile_cache_valid_)
2465 // this->updateBibfilesCache(scope);
2466 // I think that is a leftover, but there have been so many back-
2467 // and-forths with this, due to Windows issues, that I am not sure.
2469 return d->bibfiles_cache_;
2473 BiblioInfo const & Buffer::masterBibInfo() const
2475 Buffer const * const tmp = masterBuffer();
2477 return tmp->masterBibInfo();
2482 BiblioInfo const & Buffer::bibInfo() const
2488 void Buffer::registerBibfiles(const docstring_list & bf) const
2490 // We register the bib files in the master buffer,
2491 // if there is one, but also in every single buffer,
2492 // in case a child is compiled alone.
2493 Buffer const * const tmp = masterBuffer();
2495 tmp->registerBibfiles(bf);
2497 for (auto const & p : bf) {
2498 docstring_list::const_iterator temp =
2499 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2500 if (temp == d->bibfiles_cache_.end())
2501 d->bibfiles_cache_.push_back(p);
2506 static map<docstring, FileName> bibfileCache;
2508 FileName Buffer::getBibfilePath(docstring const & bibid) const
2510 map<docstring, FileName>::const_iterator it =
2511 bibfileCache.find(bibid);
2512 if (it != bibfileCache.end()) {
2513 // i.e., return bibfileCache[bibid];
2517 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2518 string const texfile = changeExtension(to_utf8(bibid), "bib");
2519 // we need to check first if this file exists where it's said to be.
2520 // there's a weird bug that occurs otherwise: if the file is in the
2521 // Buffer's directory but has the same name as some file that would be
2522 // found by kpsewhich, then we find the latter, not the former.
2523 FileName const local_file = makeAbsPath(texfile, filePath());
2524 FileName file = local_file;
2525 if (!file.exists()) {
2526 // there's no need now to check whether the file can be found
2528 file = findtexfile(texfile, "bib", true);
2532 LYXERR(Debug::FILES, "Found at: " << file);
2534 bibfileCache[bibid] = file;
2535 return bibfileCache[bibid];
2539 void Buffer::checkIfBibInfoCacheIsValid() const
2541 // use the master's cache
2542 Buffer const * const tmp = masterBuffer();
2544 tmp->checkIfBibInfoCacheIsValid();
2548 // If we already know the cache is invalid, stop here.
2549 // This is important in the case when the bibliography
2550 // environment (rather than Bib[la]TeX) is used.
2551 // In that case, the timestamp check below gives no
2552 // sensible result. Rather than that, the cache will
2553 // be invalidated explicitly via invalidateBibInfoCache()
2554 // by the Bibitem inset.
2555 // Same applies for bib encoding changes, which trigger
2556 // invalidateBibInfoCache() by InsetBibtex.
2557 if (!d->bibinfo_cache_valid_)
2560 if (d->have_bibitems_) {
2561 // We have a bibliography environment.
2562 // Invalidate the bibinfo cache unconditionally.
2563 // Cite labels will get invalidated by the inset if needed.
2564 d->bibinfo_cache_valid_ = false;
2568 // OK. This is with Bib(la)tex. We'll assume the cache
2569 // is valid and change this if we find changes in the bibs.
2570 d->bibinfo_cache_valid_ = true;
2571 d->cite_labels_valid_ = true;
2573 // compare the cached timestamps with the actual ones.
2574 docstring_list const & bibfiles_cache = getBibfiles();
2575 for (auto const & bf : bibfiles_cache) {
2576 FileName const fn = getBibfilePath(bf);
2577 time_t lastw = fn.lastModified();
2578 time_t prevw = d->bibfile_status_[fn];
2579 if (lastw != prevw) {
2580 d->bibinfo_cache_valid_ = false;
2581 d->cite_labels_valid_ = false;
2582 d->bibfile_status_[fn] = lastw;
2588 void Buffer::clearBibFileCache() const
2590 bibfileCache.clear();
2594 void Buffer::reloadBibInfoCache(bool const force) const
2596 // we should not need to do this for internal buffers
2600 // use the master's cache
2601 Buffer const * const tmp = masterBuffer();
2603 tmp->reloadBibInfoCache(force);
2608 checkIfBibInfoCacheIsValid();
2609 if (d->bibinfo_cache_valid_)
2613 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2614 // re-read file locations when this info changes
2615 // FIXME Is this sufficient? Or should we also force that
2616 // in some other cases? If so, then it is easy enough to
2617 // add the following line in some other places.
2618 clearBibFileCache();
2619 d->bibinfo_.clear();
2620 FileNameList checkedFiles;
2621 d->have_bibitems_ = false;
2622 collectBibKeys(checkedFiles);
2623 d->bibinfo_cache_valid_ = true;
2627 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2632 for (InsetIterator it = begin(inset()); it; ++it) {
2633 it->collectBibKeys(it, checkedFiles);
2634 if (it->lyxCode() == BIBITEM_CODE) {
2635 if (parent() != nullptr)
2636 parent()->d->have_bibitems_ = true;
2638 d->have_bibitems_ = true;
2644 void Buffer::addBiblioInfo(BiblioInfo const & bi_in) const
2646 // We add the biblio info to the parent buffer,
2647 // if there is one, but also to this buffer, in case
2648 // it is compiled alone.
2649 BiblioInfo & our_bi = d->bibinfo_;
2650 our_bi.mergeBiblioInfo(bi_in);
2653 parent()->addBiblioInfo(bi_in);
2657 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2659 // We add the bibtex info to the master buffer,
2660 // if there is one, but also to every single buffer,
2661 // in case a child is compiled alone.
2662 BiblioInfo & bi = d->bibinfo_;
2665 if (parent() != nullptr) {
2666 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2667 masterbi[key] = bin;
2672 void Buffer::makeCitationLabels() const
2674 Buffer const * const master = masterBuffer();
2675 return d->bibinfo_.makeCitationLabels(*master);
2679 void Buffer::invalidateCiteLabels() const
2681 masterBuffer()->d->cite_labels_valid_ = false;
2684 bool Buffer::citeLabelsValid() const
2686 return masterBuffer()->d->cite_labels_valid_;
2690 void Buffer::removeBiblioTempFiles() const
2692 // We remove files that contain LaTeX commands specific to the
2693 // particular bibliographic style being used, in order to avoid
2694 // LaTeX errors when we switch style.
2695 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2696 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2697 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2698 aux_file.removeFile();
2699 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2700 bbl_file.removeFile();
2701 // Also for the parent buffer
2702 Buffer const * const pbuf = parent();
2704 pbuf->removeBiblioTempFiles();
2708 bool Buffer::isDepClean(string const & name) const
2710 DepClean::const_iterator const it = d->dep_clean.find(name);
2711 if (it == d->dep_clean.end())
2717 void Buffer::markDepClean(string const & name)
2719 d->dep_clean[name] = true;
2723 bool Buffer::branchActivationEnabled(FuncCode act, docstring const & branch) const
2725 bool const master = act == LFUN_BRANCH_MASTER_ACTIVATE
2726 || act == LFUN_BRANCH_MASTER_DEACTIVATE;
2727 bool const activate = act == LFUN_BRANCH_ACTIVATE
2728 || act == LFUN_BRANCH_MASTER_ACTIVATE;
2729 Buffer const * buf = master ? masterBuffer() : this;
2730 Branch const * our_branch = buf->params().branchlist().find(branch);
2731 // Can be disabled if
2732 // - this is a _MASTER_ command and there is no master
2733 // - the relevant buffer does not know the branch
2734 // - the branch is already in the desired state
2735 return ((!master || parent() != nullptr)
2736 && !branch.empty() && our_branch
2737 && our_branch->isSelected() != activate);
2741 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag) const
2744 // FIXME? if there is an Buffer LFUN that can be dispatched even
2745 // if internal, put a switch '(cmd.action)' here.
2751 switch (cmd.action()) {
2753 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2754 flag.setOnOff(hasReadonlyFlag());
2757 // FIXME: There is need for a command-line import.
2758 //case LFUN_BUFFER_IMPORT:
2760 case LFUN_BUFFER_AUTO_SAVE:
2763 case LFUN_BUFFER_EXPORT_CUSTOM:
2764 // FIXME: Nothing to check here?
2767 case LFUN_BUFFER_EXPORT: {
2768 docstring const & arg = cmd.argument();
2769 if (arg == "custom") {
2773 string format = (arg.empty() || arg == "default") ?
2774 params().getDefaultOutputFormat() : to_utf8(arg);
2775 size_t pos = format.find(' ');
2776 if (pos != string::npos)
2777 format = format.substr(0, pos);
2778 enable = params().isExportable(format, false);
2780 flag.message(bformat(
2781 _("Don't know how to export to format: %1$s"), arg));
2785 case LFUN_BUILD_PROGRAM:
2786 enable = params().isExportable("program", false);
2789 case LFUN_BRANCH_ACTIVATE:
2790 case LFUN_BRANCH_DEACTIVATE:
2791 case LFUN_BRANCH_MASTER_ACTIVATE:
2792 case LFUN_BRANCH_MASTER_DEACTIVATE:
2793 // Let a branch inset handle that
2794 if (cmd.argument().empty())
2796 flag.setEnabled(branchActivationEnabled(cmd.action(), cmd.argument()));
2799 case LFUN_BRANCH_ADD:
2800 case LFUN_BRANCHES_RENAME:
2801 // if no Buffer is present, then of course we won't be called!
2804 case LFUN_BUFFER_LANGUAGE:
2805 enable = !isReadonly();
2808 case LFUN_BUFFER_VIEW_CACHE:
2809 (d->preview_file_).refresh();
2810 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2813 case LFUN_CHANGES_TRACK:
2814 flag.setEnabled(true);
2815 flag.setOnOff(params().track_changes);
2818 case LFUN_CHANGES_OUTPUT:
2819 flag.setEnabled(true);
2820 flag.setOnOff(params().output_changes);
2823 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2824 flag.setOnOff(params().compressed);
2827 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2828 flag.setOnOff(params().output_sync);
2831 case LFUN_BUFFER_ANONYMIZE:
2837 flag.setEnabled(enable);
2842 bool Buffer::branchActivationDispatch(FuncCode act, docstring const & branch)
2844 bool const master = (act == LFUN_BRANCH_MASTER_ACTIVATE
2845 || act == LFUN_BRANCH_MASTER_DEACTIVATE);
2846 bool const activate = (act == LFUN_BRANCH_ACTIVATE
2847 || act == LFUN_BRANCH_MASTER_ACTIVATE);
2848 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer()) : this;
2849 Branch * our_branch = buf->params().branchlist().find(branch);
2851 // See comment in branchActivationStatus
2852 if ((master && parent() == nullptr)
2854 || our_branch->isSelected() == activate)
2857 if (master && !buf->hasGuiDelegate()
2858 && (!theApp() || !theApp()->unhide(buf)))
2859 // at least issue a warning for now (ugly, but better than dataloss).
2860 frontend::Alert::warning(_("Branch state changes in master document"),
2861 lyx::support::bformat(_("The state of the branch '%1$s' "
2862 "was changed in the master file. "
2863 "Please make sure to save the master."), branch), true);
2865 UndoGroupHelper ugh(buf);
2866 buf->undo().recordUndoBufferParams(CursorData());
2867 our_branch->setSelected(activate);
2868 // cur.forceBufferUpdate() is not enough)
2869 buf->updateBuffer();
2871 // if branch exists in a descendant, update previews.
2872 // TODO: only needed if "Show preview" is enabled in the included inset.
2873 bool exists_in_desc = false;
2874 for (auto const & it : buf->getDescendants()) {
2875 if (it->params().branchlist().find(branch))
2876 exists_in_desc = true;
2878 if (exists_in_desc) {
2879 // TODO: ideally we would only update the previews of the
2880 // specific children that have this branch directly or
2881 // in one of their descendants
2882 buf->removePreviews();
2883 buf->updatePreviews();
2889 void Buffer::dispatch(string const & command, DispatchResult & result)
2891 return dispatch(lyxaction.lookupFunc(command), result);
2895 // NOTE We can end up here even if we have no GUI, because we are called
2896 // by LyX::exec to handled command-line requests. So we may need to check
2897 // whether we have a GUI or not. The boolean use_gui holds this information.
2898 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2900 LYXERR(Debug::ACTION, "Buffer::dispatch: cmd: " << func);
2902 // FIXME? if there is an Buffer LFUN that can be dispatched even
2903 // if internal, put a switch '(cmd.action())' here.
2904 dr.dispatched(false);
2907 string const argument = to_utf8(func.argument());
2908 // We'll set this back to false if need be.
2909 bool dispatched = true;
2910 // This handles undo groups automagically
2911 UndoGroupHelper ugh(this);
2913 switch (func.action()) {
2914 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2915 if (lyxvc().inUse()) {
2916 string log = lyxvc().toggleReadOnly();
2921 setReadonly(!hasReadonlyFlag());
2924 case LFUN_BUFFER_EXPORT: {
2925 string const format = (argument.empty() || argument == "default") ?
2926 params().getDefaultOutputFormat() : argument;
2927 ExportStatus const status = doExport(format, false);
2928 dr.setError(status != ExportSuccess);
2929 if (status != ExportSuccess)
2930 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2931 from_utf8(format)));
2935 case LFUN_BUILD_PROGRAM: {
2936 ExportStatus const status = doExport("program", true);
2937 dr.setError(status != ExportSuccess);
2938 if (status != ExportSuccess)
2939 dr.setMessage(_("Error generating literate programming code."));
2943 case LFUN_BUFFER_EXPORT_CUSTOM: {
2945 string command = split(argument, format_name, ' ');
2946 Format const * format = theFormats().getFormat(format_name);
2948 lyxerr << "Format \"" << format_name
2949 << "\" not recognized!"
2954 // The name of the file created by the conversion process
2957 // Output to filename
2958 if (format->name() == "lyx") {
2959 string const latexname = latexName(false);
2960 filename = changeExtension(latexname,
2961 format->extension());
2962 filename = addName(temppath(), filename);
2964 if (!writeFile(FileName(filename)))
2968 doExport(format_name, true, filename);
2971 // Substitute $$FName for filename
2972 if (!contains(command, "$$FName"))
2973 command = "( " + command + " ) < $$FName";
2974 command = subst(command, "$$FName", filename);
2976 // Execute the command in the background
2978 call.startscript(Systemcall::DontWait, command,
2979 filePath(), layoutPos());
2983 // FIXME: There is need for a command-line import.
2985 case LFUN_BUFFER_IMPORT:
2990 case LFUN_BUFFER_AUTO_SAVE:
2992 resetAutosaveTimers();
2995 case LFUN_BRANCH_ACTIVATE:
2996 case LFUN_BRANCH_DEACTIVATE:
2997 case LFUN_BRANCH_MASTER_ACTIVATE:
2998 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2999 // Let a branch inset handle that
3000 if (func.argument().empty()) {
3001 dr.dispatched(false);
3004 bool const res = branchActivationDispatch(func.action(), func.argument());
3007 dr.screenUpdate(Update::Force);
3011 case LFUN_BRANCH_ADD: {
3012 docstring const & branchnames = func.argument();
3013 if (branchnames.empty()) {
3017 BranchList & branch_list = params().branchlist();
3018 vector<docstring> const branches =
3019 getVectorFromString(branchnames, branch_list.separator());
3021 for (docstring const & branch_name : branches) {
3022 Branch * branch = branch_list.find(branch_name);
3024 LYXERR0("Branch " << branch_name << " already exists.");
3028 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
3030 undo().recordUndoBufferParams(CursorData());
3031 branch_list.add(branch_name);
3032 branch = branch_list.find(branch_name);
3034 // needed to update the color table for dark mode
3035 branch->setColors("background", "background");
3037 dr.screenUpdate(Update::Force);
3045 case LFUN_BRANCHES_RENAME: {
3046 if (func.argument().empty())
3049 docstring const oldname = from_utf8(func.getArg(0));
3050 docstring const newname = from_utf8(func.getArg(1));
3051 InsetIterator it = begin(inset());
3052 InsetIterator const itend = end(inset());
3053 bool success = false;
3054 for (; it != itend; ++it) {
3055 if (it->lyxCode() == BRANCH_CODE) {
3056 InsetBranch & ins = static_cast<InsetBranch &>(*it);
3057 if (ins.branch() == oldname) {
3058 undo().recordUndo(CursorData(it));
3059 ins.rename(newname);
3064 if (it->lyxCode() == INCLUDE_CODE) {
3065 // get buffer of external file
3066 InsetInclude const & ins =
3067 static_cast<InsetInclude const &>(*it);
3068 Buffer * child = ins.loadIfNeeded();
3071 child->dispatch(func, dr);
3076 dr.screenUpdate(Update::Force);
3077 dr.forceBufferUpdate();
3082 case LFUN_BUFFER_VIEW_CACHE:
3083 if (!theFormats().view(*this, d->preview_file_,
3084 d->preview_format_))
3085 dr.setMessage(_("Error viewing the output file."));
3088 case LFUN_CHANGES_TRACK:
3089 if (params().save_transient_properties)
3090 undo().recordUndoBufferParams(CursorData());
3091 params().track_changes = !params().track_changes;
3094 case LFUN_CHANGES_OUTPUT:
3095 if (params().save_transient_properties)
3096 undo().recordUndoBufferParams(CursorData());
3097 params().output_changes = !params().output_changes;
3098 if (params().output_changes) {
3099 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3100 LaTeXFeatures::isAvailable("xcolor");
3103 Alert::warning(_("Changes not shown in LaTeX output"),
3104 _("Changes will not be highlighted in LaTeX output, "
3105 "because xcolor and ulem are not installed.\n"
3106 "Please install both packages or redefine "
3107 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3112 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3113 // turn compression on/off
3114 undo().recordUndoBufferParams(CursorData());
3115 params().compressed = !params().compressed;
3118 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3119 undo().recordUndoBufferParams(CursorData());
3120 params().output_sync = !params().output_sync;
3123 case LFUN_BUFFER_ANONYMIZE: {
3124 undo().recordUndoFullBuffer(CursorData());
3125 CursorData cur(doc_iterator_begin(this));
3126 for ( ; cur ; cur.forwardPar())
3127 cur.paragraph().anonymize();
3128 dr.forceBufferUpdate();
3129 dr.screenUpdate(Update::Force);
3137 dr.dispatched(dispatched);
3141 void Buffer::changeLanguage(Language const * from, Language const * to)
3143 LASSERT(from, return);
3144 LASSERT(to, return);
3146 ParIterator it = par_iterator_begin();
3147 ParIterator eit = par_iterator_end();
3148 for (; it != eit; ++it)
3149 it->changeLanguage(params(), from, to);
3153 bool Buffer::isMultiLingual() const
3155 ParConstIterator end = par_iterator_end();
3156 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3157 if (it->isMultiLingual(params()))
3164 std::set<Language const *> Buffer::getLanguages() const
3166 std::set<Language const *> langs;
3167 getLanguages(langs);
3172 void Buffer::getLanguages(std::set<Language const *> & langs) const
3174 ParConstIterator end = par_iterator_end();
3175 // add the buffer language, even if it's not actively used
3176 langs.insert(language());
3177 // iterate over the paragraphs
3178 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3179 it->getLanguages(langs);
3181 ListOfBuffers clist = getDescendants();
3182 for (auto const & cit : clist)
3183 cit->getLanguages(langs);
3187 DocIterator Buffer::getParFromID(int const id) const
3189 Buffer * buf = const_cast<Buffer *>(this);
3191 // This means non-existent
3192 return doc_iterator_end(buf);
3194 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3195 if (it.paragraph().id() == id)
3198 return doc_iterator_end(buf);
3202 bool Buffer::hasParWithID(int const id) const
3204 return !getParFromID(id).atEnd();
3208 ParIterator Buffer::par_iterator_begin()
3210 return ParIterator(doc_iterator_begin(this));
3214 ParIterator Buffer::par_iterator_end()
3216 return ParIterator(doc_iterator_end(this));
3220 ParConstIterator Buffer::par_iterator_begin() const
3222 return ParConstIterator(doc_iterator_begin(this));
3226 ParConstIterator Buffer::par_iterator_end() const
3228 return ParConstIterator(doc_iterator_end(this));
3231 bool Buffer::empty() const
3233 return paragraphs().size() == 1 && paragraphs().front().empty();
3237 Language const * Buffer::language() const
3239 return params().language;
3243 docstring Buffer::B_(string const & l10n) const
3245 return params().B_(l10n);
3249 bool Buffer::isClean() const
3251 return d->lyx_clean;
3255 bool Buffer::isChecksumModified() const
3257 LASSERT(d->filename.exists(), return false);
3258 return d->checksum_ != d->filename.checksum();
3262 void Buffer::saveCheckSum() const
3264 FileName const & file = d->filename;
3266 d->checksum_ = file.exists() ? file.checksum()
3267 : 0; // in the case of save to a new file.
3271 void Buffer::markClean() const
3273 if (!d->lyx_clean) {
3274 d->lyx_clean = true;
3277 // if the .lyx file has been saved, we don't need an
3279 d->bak_clean = true;
3280 d->undo_.markDirty();
3281 clearExternalModification();
3285 void Buffer::setUnnamed(bool flag)
3291 bool Buffer::isUnnamed() const
3298 /// Don't check unnamed, here: isInternal() is used in
3299 /// newBuffer(), where the unnamed flag has not been set by anyone
3300 /// yet. Also, for an internal buffer, there should be no need for
3301 /// retrieving fileName() nor for checking if it is unnamed or not.
3302 bool Buffer::isInternal() const
3304 return d->internal_buffer;
3308 void Buffer::setInternal(bool flag)
3310 d->internal_buffer = flag;
3314 void Buffer::markDirty()
3317 d->lyx_clean = false;
3320 d->bak_clean = false;
3322 for (auto & depit : d->dep_clean)
3323 depit.second = false;
3327 FileName Buffer::fileName() const
3333 string Buffer::absFileName() const
3335 return d->filename.absFileName();
3339 string Buffer::filePath() const
3341 string const abs = d->filename.onlyPath().absFileName();
3344 int last = abs.length() - 1;
3346 return abs[last] == '/' ? abs : abs + '/';
3350 DocFileName Buffer::getReferencedFileName(string const & fn) const
3353 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3354 result.set(fn, filePath());
3356 // filePath() ends with a path separator
3357 FileName const test(filePath() + fn);
3359 result.set(fn, filePath());
3361 result.set(fn, params().origin);
3368 string const Buffer::prepareFileNameForLaTeX(string const & name,
3369 string const & ext, bool nice) const
3371 string const fname = makeAbsPath(name, filePath()).absFileName();
3372 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3378 return to_utf8(makeRelPath(from_utf8(fname),
3379 from_utf8(masterBuffer()->filePath())));
3383 vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3384 docstring_list const & bibfilelist,
3385 bool const add_extension) const
3387 // If we are processing the LaTeX file in a temp directory then
3388 // copy the .bib databases to this temp directory, mangling their
3389 // names in the process. Store this mangled name in the list of
3391 // (We need to do all this because BibTeX *really*, *really*
3392 // can't handle "files with spaces" and Windows users tend to
3393 // use such filenames.)
3394 // Otherwise, store the (maybe absolute) path to the original,
3395 // unmangled database name.
3397 vector<pair<docstring, string>> res;
3399 // determine the export format
3400 string const tex_format = flavor2format(runparams.flavor);
3402 // check for spaces in paths
3403 bool found_space = false;
3405 for (auto const & bit : bibfilelist) {
3406 string utf8input = to_utf8(bit);
3408 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3409 FileName try_in_file =
3410 makeAbsPath(database + ".bib", filePath());
3411 bool not_from_texmf = try_in_file.isReadableFile();
3412 // If the file has not been found, try with the real file name
3413 // (it might come from a child in a sub-directory)
3414 if (!not_from_texmf) {
3415 try_in_file = getBibfilePath(bit);
3416 if (try_in_file.isReadableFile()) {
3417 // Check if the file is in texmf
3418 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3419 not_from_texmf = kpsefile.empty()
3420 || kpsefile.absFileName() != try_in_file.absFileName();
3422 // If this exists, make path relative to the master
3425 removeExtension(prepareFileNameForLaTeX(
3426 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3427 from_utf8(filePath()))),
3428 ".bib", runparams.nice));
3432 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3434 // mangledFileName() needs the extension
3435 DocFileName const in_file = DocFileName(try_in_file);
3436 database = removeExtension(in_file.mangledFileName());
3437 FileName const out_file = makeAbsPath(database + ".bib",
3438 masterBuffer()->temppath());
3439 bool const success = in_file.copyTo(out_file);
3441 LYXERR0("Failed to copy '" << in_file
3442 << "' to '" << out_file << "'");
3444 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3445 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3446 if (!isValidLaTeXFileName(database)) {
3447 frontend::Alert::warning(_("Invalid filename"),
3448 _("The following filename will cause troubles "
3449 "when running the exported file through LaTeX: ") +
3450 from_utf8(database));
3452 if (!isValidDVIFileName(database)) {
3453 frontend::Alert::warning(_("Problematic filename for DVI"),
3454 _("The following filename can cause troubles "
3455 "when running the exported file through LaTeX "
3456 "and opening the resulting DVI: ") +
3457 from_utf8(database), true);
3465 docstring const path = from_utf8(latex_path(database));
3467 if (contains(path, ' '))
3470 if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
3471 enc = params().bibFileEncoding(utf8input);
3473 bool recorded = false;
3474 for (auto const & pe : res) {
3475 if (pe.first == path) {
3482 res.push_back(make_pair(path, enc));
3485 // Check if there are spaces in the path and warn BibTeX users, if so.
3486 // (biber can cope with such paths)
3487 if (!prefixIs(runparams.bibtex_command, "biber")) {
3488 // Post this warning only once.
3489 static bool warned_about_spaces = false;
3490 if (!warned_about_spaces &&
3491 runparams.nice && found_space) {
3492 warned_about_spaces = true;
3493 Alert::warning(_("Export Warning!"),
3494 _("There are spaces in the paths to your BibTeX databases.\n"
3495 "BibTeX will be unable to find them."));
3504 string Buffer::layoutPos() const
3506 return d->layout_position;
3510 void Buffer::setLayoutPos(string const & path)
3513 d->layout_position.clear();
3517 LATTEST(FileName::isAbsolute(path));
3519 d->layout_position =
3520 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3522 if (d->layout_position.empty())
3523 d->layout_position = ".";
3527 bool Buffer::hasReadonlyFlag() const
3529 return d->read_only;
3533 bool Buffer::isReadonly() const
3535 return hasReadonlyFlag() || notifiesExternalModification();
3539 void Buffer::setParent(Buffer const * buffer)
3541 // We need to do some work here to avoid recursive parent structures.
3542 // This is the easy case.
3543 if (buffer == this) {
3544 LYXERR0("Ignoring attempt to set self as parent in\n" << fileName());
3547 // Now we check parents going upward, to make sure that IF we set the
3548 // parent as requested, we would not generate a recursive include.
3549 set<Buffer const *> sb;
3550 Buffer const * b = buffer;
3551 bool found_recursion = false;
3553 if (sb.find(b) != sb.end()) {
3554 found_recursion = true;
3561 if (found_recursion) {
3562 LYXERR0("Ignoring attempt to set parent of\n" <<
3565 buffer->fileName() <<
3566 "\nbecause that would create a recursive inclusion.");
3570 // We should be safe now.
3571 d->setParent(buffer);
3576 Buffer const * Buffer::parent() const
3582 ListOfBuffers Buffer::allRelatives() const
3584 ListOfBuffers lb = masterBuffer()->getDescendants();
3585 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3590 Buffer const * Buffer::masterBuffer() const
3592 Buffer const * const pbuf = d->parent();
3596 return pbuf->masterBuffer();
3600 bool Buffer::isChild(Buffer * child) const
3602 return d->children_positions.find(child) != d->children_positions.end();
3606 DocIterator Buffer::firstChildPosition(Buffer const * child)
3608 Impl::BufferPositionMap::iterator it;
3609 it = d->children_positions.find(child);
3610 if (it == d->children_positions.end())
3611 return DocIterator(this);
3616 bool Buffer::hasChildren() const
3618 return !d->children_positions.empty();
3622 void Buffer::collectChildren(ListOfBuffers & children, bool grand_children) const
3624 // loop over children
3625 for (auto const & p : d->children_positions) {
3626 Buffer * child = const_cast<Buffer *>(p.first);
3628 ListOfBuffers::const_iterator bit = find(children.begin(), children.end(), child);
3629 if (bit != children.end())
3631 children.push_back(child);
3633 // there might be grandchildren
3634 child->collectChildren(children, true);
3639 ListOfBuffers Buffer::getChildren() const
3642 collectChildren(v, false);
3643 // Make sure we have not included ourselves.
3644 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3645 if (bit != v.end()) {
3646 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3653 ListOfBuffers Buffer::getDescendants() const
3656 collectChildren(v, true);
3657 // Make sure we have not included ourselves.
3658 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3659 if (bit != v.end()) {
3660 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3667 template<typename M>
3668 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3673 typename M::const_iterator it = m.lower_bound(x);
3674 if (it == m.begin())
3682 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3683 DocIterator const & pos) const
3685 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3687 // if paragraphs have no macro context set, pos will be empty
3691 // we haven't found anything yet
3692 DocIterator bestPos = owner_->par_iterator_begin();
3693 MacroData const * bestData = nullptr;
3695 // find macro definitions for name
3696 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3697 if (nameIt != macros.end()) {
3698 // find last definition in front of pos or at pos itself
3699 PositionScopeMacroMap::const_iterator it
3700 = greatest_below(nameIt->second, pos);
3701 if (it != nameIt->second.end()) {
3703 // scope ends behind pos?
3704 if (pos < it->second.scope) {
3705 // Looks good, remember this. If there
3706 // is no external macro behind this,
3707 // we found the right one already.
3708 bestPos = it->first;
3709 bestData = &it->second.macro;
3713 // try previous macro if there is one
3714 if (it == nameIt->second.begin())
3721 // find macros in included files
3722 PositionScopeBufferMap::const_iterator it
3723 = greatest_below(position_to_children, pos);
3724 if (it == position_to_children.end())
3725 // no children before
3729 // do we know something better (i.e. later) already?
3730 if (it->first < bestPos )
3733 // scope ends behind pos?
3734 if (pos < it->second.scope
3735 && (cloned_buffer_ ||
3736 theBufferList().isLoaded(it->second.buffer))) {
3737 // look for macro in external file
3739 MacroData const * data
3740 = it->second.buffer->getMacro(name, false);
3743 bestPos = it->first;
3749 // try previous file if there is one
3750 if (it == position_to_children.begin())
3755 // return the best macro we have found
3760 MacroData const * Buffer::getMacro(docstring const & name,
3761 DocIterator const & pos, bool global) const
3766 // query buffer macros
3767 MacroData const * data = d->getBufferMacro(name, pos);
3768 if (data != nullptr)
3771 // If there is a master buffer, query that
3772 Buffer const * const pbuf = d->parent();
3774 d->macro_lock = true;
3775 MacroData const * macro = pbuf->getMacro(
3776 name, *this, false);
3777 d->macro_lock = false;
3783 data = MacroTable::globalMacros().get(name);
3784 if (data != nullptr)
3792 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3794 // set scope end behind the last paragraph
3795 DocIterator scope = par_iterator_begin();
3796 scope.pit() = scope.lastpit() + 1;
3798 return getMacro(name, scope, global);
3802 MacroData const * Buffer::getMacro(docstring const & name,
3803 Buffer const & child, bool global) const
3805 // look where the child buffer is included first
3806 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3807 if (it == d->children_positions.end())
3810 // check for macros at the inclusion position
3811 return getMacro(name, it->second, global);
3815 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3817 pit_type const lastpit = it.lastpit();
3819 // look for macros in each paragraph
3820 while (it.pit() <= lastpit) {
3821 Paragraph & par = it.paragraph();
3823 // iterate over the insets of the current paragraph
3824 for (auto const & insit : par.insetList()) {
3825 it.pos() = insit.pos;
3827 // is it a nested text inset?
3828 if (insit.inset->asInsetText()) {
3829 // Inset needs its own scope?
3830 InsetText const * itext = insit.inset->asInsetText();
3831 bool newScope = itext->isMacroScope();
3833 // scope which ends just behind the inset
3834 DocIterator insetScope = it;
3837 // collect macros in inset
3838 it.push_back(CursorSlice(*insit.inset));
3839 updateMacros(it, newScope ? insetScope : scope);
3844 if (insit.inset->asInsetTabular()) {
3845 CursorSlice slice(*insit.inset);
3846 size_t const numcells = slice.nargs();
3847 for (; slice.idx() < numcells; slice.forwardIdx()) {
3848 it.push_back(slice);
3849 updateMacros(it, scope);
3855 // is it an external file?
3856 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3857 // get buffer of external file
3858 InsetInclude const & incinset =
3859 static_cast<InsetInclude const &>(*insit.inset);
3861 Buffer * child = incinset.loadIfNeeded();
3866 // register its position, but only when it is
3867 // included first in the buffer
3868 children_positions.insert({child, it});
3870 // register child with its scope
3871 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3875 InsetMath * im = insit.inset->asInsetMath();
3876 if (doing_export && im) {
3877 InsetMathHull * hull = im->asHullInset();
3879 hull->recordLocation(it);
3882 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3886 InsetMathMacroTemplate & macroTemplate =
3887 *insit.inset->asInsetMath()->asMacroTemplate();
3888 MacroContext mc(owner_, it);
3889 macroTemplate.updateToContext(mc);
3892 bool valid = macroTemplate.validMacro();
3893 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3894 // then the BufferView's cursor will be invalid in
3895 // some cases which leads to crashes.
3900 // FIXME (Abdel), I don't understand why we pass 'it' here
3901 // instead of 'macroTemplate' defined above... is this correct?
3902 macros[macroTemplate.name()][it] =
3903 Impl::ScopeMacro(scope, MacroData(owner_, it));
3913 void Buffer::updateMacros() const
3918 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3920 // start with empty table
3922 d->children_positions.clear();
3923 d->position_to_children.clear();
3925 // Iterate over buffer, starting with first paragraph
3926 // The scope must be bigger than any lookup DocIterator
3927 // later. For the global lookup, lastpit+1 is used, hence
3928 // we use lastpit+2 here.
3929 DocIterator it = par_iterator_begin();
3930 DocIterator outerScope = it;
3931 outerScope.pit() = outerScope.lastpit() + 2;
3932 d->updateMacros(it, outerScope);
3936 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3938 for (Inset const & it : inset()) {
3939 if (it.lyxCode() == BRANCH_CODE) {
3940 InsetBranch const & br = static_cast<InsetBranch const &>(it);
3941 docstring const name = br.branch();
3942 if (!from_master && !params().branchlist().find(name))
3943 result.push_back(name);
3944 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3945 result.push_back(name);
3948 if (it.lyxCode() == INCLUDE_CODE) {
3949 // get buffer of external file
3950 InsetInclude const & ins =
3951 static_cast<InsetInclude const &>(it);
3952 Buffer * child = ins.loadIfNeeded();
3955 child->getUsedBranches(result, true);
3958 // remove duplicates
3963 void Buffer::updateMacroInstances(UpdateType utype) const
3965 LYXERR(Debug::MACROS, "updateMacroInstances for "
3966 << d->filename.onlyFileName());
3967 DocIterator it = doc_iterator_begin(this);
3969 DocIterator const end = doc_iterator_end(this);
3970 for (; it != end; it.forwardInset()) {
3971 // look for MathData cells in InsetMathNest insets
3972 InsetMath * minset = it.nextInset()->asInsetMath();
3976 // update macro in all cells of the InsetMathNest
3977 idx_type n = minset->nargs();
3978 MacroContext mc = MacroContext(this, it);
3979 for (idx_type i = 0; i < n; ++i) {
3980 MathData & data = minset->cell(i);
3981 data.updateMacros(nullptr, mc, utype, 0);
3987 void Buffer::listMacroNames(MacroNameSet & macros) const
3992 d->macro_lock = true;
3994 // loop over macro names
3995 for (auto const & nameit : d->macros)
3996 macros.insert(nameit.first);
3998 // loop over children
3999 for (auto const & p : d->children_positions) {
4000 Buffer * child = const_cast<Buffer *>(p.first);
4001 // The buffer might have been closed (see #10766).
4002 if (theBufferList().isLoaded(child))
4003 child->listMacroNames(macros);
4007 Buffer const * const pbuf = d->parent();
4009 pbuf->listMacroNames(macros);
4011 d->macro_lock = false;
4015 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
4017 Buffer const * const pbuf = d->parent();
4022 pbuf->listMacroNames(names);
4025 for (auto const & mit : names) {
4027 MacroData const * data = pbuf->getMacro(mit, *this, false);
4029 macros.insert(data);
4031 // we cannot access the original InsetMathMacroTemplate anymore
4032 // here to calls validate method. So we do its work here manually.
4033 // FIXME: somehow make the template accessible here.
4034 if (data->optionals() > 0)
4035 features.require("xargs");
4041 Buffer::References & Buffer::getReferenceCache(docstring const & label)
4044 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
4046 RefCache::iterator it = d->ref_cache_.find(label);
4047 if (it != d->ref_cache_.end())
4050 static References const dummy_refs = References();
4051 it = d->ref_cache_.insert(
4052 make_pair(label, dummy_refs)).first;
4057 Buffer::References const & Buffer::references(docstring const & label) const
4059 return const_cast<Buffer *>(this)->getReferenceCache(label);
4063 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
4065 References & refs = getReferenceCache(label);
4066 refs.push_back(make_pair(inset, it));
4070 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
4074 linfo.label = label;
4076 linfo.active = active;
4077 masterBuffer()->d->label_cache_.push_back(linfo);
4081 InsetLabel const * Buffer::insetLabel(docstring const & label,
4082 bool const active) const
4084 for (auto const & rc : masterBuffer()->d->label_cache_) {
4085 if (rc.label == label && (rc.active || !active))
4092 bool Buffer::activeLabel(docstring const & label) const
4094 return insetLabel(label, true) != nullptr;
4098 void Buffer::clearReferenceCache() const
4101 d->ref_cache_.clear();
4102 d->label_cache_.clear();
4107 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
4109 //FIXME: This does not work for child documents yet.
4110 reloadBibInfoCache();
4112 // Check if the label 'from' appears more than once
4113 vector<docstring> labels;
4114 for (auto const & bibit : masterBibInfo())
4115 labels.push_back(bibit.first);
4117 if (count(labels.begin(), labels.end(), from) > 1)
4120 string const paramName = "key";
4121 UndoGroupHelper ugh(this);
4122 InsetIterator it = begin(inset());
4124 if (it->lyxCode() != CITE_CODE)
4126 InsetCommand * inset = it->asInsetCommand();
4127 docstring const oldValue = inset->getParam(paramName);
4128 if (oldValue == from) {
4129 undo().recordUndo(CursorData(it));
4130 inset->setParam(paramName, to);
4135 // returns NULL if id-to-row conversion is unsupported
4136 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4137 pit_type par_begin, pit_type par_end,
4138 OutputWhat output, bool master) const
4140 unique_ptr<TexRow> texrow;
4141 OutputParams runparams(¶ms().encoding());
4142 runparams.nice = true;
4143 runparams.flavor = params().getOutputFlavor(format);
4144 runparams.linelen = lyxrc.plaintext_linelen;
4145 // No side effect of file copying and image conversion
4146 runparams.dryrun = true;
4148 // Some macros rely on font encoding
4149 runparams.main_fontenc = params().main_font_encoding();
4151 // Use the right wrapping for the comment at the beginning of the generated
4152 // snippet, so that it is either valid LaTeX or valid XML (including HTML and DocBook).
4153 docstring comment_start = from_ascii("% ");
4154 docstring comment_end = from_ascii("");
4155 if (runparams.flavor == Flavor::Html || runparams.flavor == Flavor::DocBook5) {
4156 comment_start = from_ascii("<!-- ");
4157 comment_end = from_ascii(" -->");
4160 if (output == CurrentParagraph) {
4161 runparams.par_begin = par_begin;
4162 runparams.par_end = par_end;
4163 if (par_begin + 1 == par_end) {
4165 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4170 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4171 convert<docstring>(par_begin),
4172 convert<docstring>(par_end - 1))
4176 // output paragraphs
4177 if (runparams.flavor == Flavor::LyX) {
4178 Paragraph const & par = text().paragraphs()[par_begin];
4180 depth_type dt = par.getDepth();
4181 par.write(ods, params(), dt);
4182 os << from_utf8(ods.str());
4183 } else if (runparams.flavor == Flavor::Html) {
4185 setMathFlavor(runparams);
4186 xhtmlParagraphs(text(), *this, xs, runparams);
4187 } else if (runparams.flavor == Flavor::Text) {
4189 // FIXME Handles only one paragraph, unlike the others.
4190 // Probably should have some routine with a signature like them.
4191 writePlaintextParagraph(*this,
4192 text().paragraphs()[par_begin], os, runparams, dummy);
4193 } else if (runparams.flavor == Flavor::DocBook5) {
4195 docbookParagraphs(text(), *this, xs, runparams);
4197 // If we are previewing a paragraph, even if this is the
4198 // child of some other buffer, let's cut the link here,
4199 // so that no concurring settings from the master
4200 // (e.g. branch state) interfere (see #8101).
4202 d->ignore_parent = true;
4203 // We need to validate the Buffer params' features here
4204 // in order to know if we should output polyglossia
4205 // macros (instead of babel macros)
4206 LaTeXFeatures features(*this, params(), runparams);
4208 runparams.use_polyglossia = features.usePolyglossia();
4209 runparams.use_babel = features.useBabel();
4210 runparams.use_hyperref = features.isRequired("hyperref");
4211 // latex or literate
4214 ots.texrow().newlines(2);
4216 latexParagraphs(*this, text(), ots, runparams);
4217 texrow = ots.releaseTexRow();
4219 // Restore the parenthood
4221 d->ignore_parent = false;
4224 os << comment_start;
4225 if (output == FullSource)
4226 os << _("Preview source code");
4227 else if (output == OnlyPreamble)
4228 os << _("Preview preamble");
4229 else if (output == OnlyBody)
4230 os << _("Preview body");
4233 if (runparams.flavor == Flavor::LyX) {
4235 if (output == FullSource)
4237 else if (output == OnlyPreamble)
4238 params().writeFile(ods, this);
4239 else if (output == OnlyBody)
4241 os << from_utf8(ods.str());
4242 } else if (runparams.flavor == Flavor::Html) {
4243 writeLyXHTMLSource(os, runparams, output);
4244 } else if (runparams.flavor == Flavor::Text) {
4245 if (output == OnlyPreamble)
4246 os << "% "<< _("Plain text does not have a preamble.");
4248 writePlaintextFile(*this, os, runparams);
4249 } else if (runparams.flavor == Flavor::DocBook5) {
4250 writeDocBookSource(os, runparams, output);
4252 // latex or literate
4255 ots.texrow().newlines(2);
4257 runparams.is_child = true;
4259 writeLaTeXSource(ots, string(), runparams, output);
4260 texrow = ots.releaseTexRow();
4267 ErrorList & Buffer::errorList(string const & type) const
4269 return d->errorLists[type];
4273 void Buffer::updateTocItem(std::string const & type,
4274 DocIterator const & dit) const
4277 d->gui_->updateTocItem(type, dit);
4281 void Buffer::structureChanged() const
4284 d->gui_->structureChanged();
4288 void Buffer::errors(string const & err, bool from_master) const
4291 d->gui_->errors(err, from_master);
4295 void Buffer::message(docstring const & msg) const
4298 d->gui_->message(msg);
4302 void Buffer::setBusy(bool on) const
4305 d->gui_->setBusy(on);
4309 void Buffer::updateTitles() const
4312 d->wa_->updateTitles();
4316 void Buffer::scheduleRedrawWorkAreas() const
4319 d->wa_->scheduleRedraw();
4323 void Buffer::resetAutosaveTimers() const
4326 d->gui_->resetAutosaveTimers();
4330 bool Buffer::hasGuiDelegate() const
4336 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4342 FileName Buffer::getEmergencyFileName() const
4344 return FileName(d->filename.absFileName() + ".emergency");
4348 FileName Buffer::getAutosaveFileName() const
4350 // if the document is unnamed try to save in the backup dir, else
4351 // in the default document path, and as a last try in the filePath,
4352 // which will most often be the temporary directory
4355 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4356 : lyxrc.backupdir_path;
4357 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4360 string const fname = "#" + d->filename.onlyFileName() + "#";
4362 return makeAbsPath(fname, fpath);
4366 void Buffer::removeAutosaveFile() const
4368 FileName const f = getAutosaveFileName();
4374 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4376 FileName const newauto = getAutosaveFileName();
4378 if (newauto != oldauto && oldauto.exists())
4379 if (!oldauto.moveTo(newauto))
4380 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4384 bool Buffer::autoSave() const
4386 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4387 if (buf->d->bak_clean || hasReadonlyFlag())
4390 message(_("Autosaving current document..."));
4391 buf->d->bak_clean = true;
4393 FileName const fname = getAutosaveFileName();
4394 LASSERT(d->cloned_buffer_, return false);
4396 // If this buffer is cloned, we assume that
4397 // we are running in a separate thread already.
4398 TempFile tempfile("lyxautoXXXXXX.lyx");
4399 tempfile.setAutoRemove(false);
4400 FileName const tmp_ret = tempfile.name();
4401 if (!tmp_ret.empty()) {
4403 // assume successful write of tmp_ret
4404 if (tmp_ret.moveTo(fname))
4407 // failed to write/rename tmp_ret so try writing direct
4408 return writeFile(fname);
4412 void Buffer::setExportStatus(bool e) const
4414 d->doing_export = e;
4415 ListOfBuffers clist = getDescendants();
4416 for (auto const & bit : clist)
4417 bit->d->doing_export = e;
4421 bool Buffer::isExporting() const
4423 return d->doing_export;
4427 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4431 return doExport(target, put_in_tempdir, result_file);
4434 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4435 string & result_file) const
4437 bool const update_unincluded =
4438 params().maintain_unincluded_children != BufferParams::CM_None
4439 && !params().getIncludedChildren().empty();
4441 // (1) export with all included children (omit \includeonly)
4442 if (update_unincluded) {
4443 ExportStatus const status =
4444 doExport(target, put_in_tempdir, true, result_file);
4445 if (status != ExportSuccess)
4448 // (2) export with included children only
4449 return doExport(target, put_in_tempdir, false, result_file);
4453 void Buffer::setMathFlavor(OutputParams & op) const
4455 // Passes the way to generate formulae to the XHTML output code.
4456 // In particular, this function has no impact on the DocBook code, as it
4457 // uses another mechanism to handle math flavours.
4458 switch (params().html_math_output) {
4459 case BufferParams::MathML:
4460 op.math_flavor = OutputParams::MathAsMathML;
4462 case BufferParams::HTML:
4463 op.math_flavor = OutputParams::MathAsHTML;
4465 case BufferParams::Images:
4466 op.math_flavor = OutputParams::MathAsImages;
4468 case BufferParams::LaTeX:
4469 op.math_flavor = OutputParams::MathAsLaTeX;
4475 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4476 bool includeall, string & result_file) const
4478 LYXERR(Debug::FILES, "target=" << target);
4479 OutputParams runparams(¶ms().encoding());
4480 string format = target;
4481 string dest_filename;
4482 size_t pos = target.find(' ');
4483 if (pos != string::npos) {
4484 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4485 format = target.substr(0, pos);
4486 if (format == "default")
4487 format = params().getDefaultOutputFormat();
4488 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4489 FileName(dest_filename).onlyPath().createPath();
4490 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4492 MarkAsExporting exporting(this);
4493 string backend_format;
4494 runparams.flavor = Flavor::LaTeX;
4495 runparams.linelen = lyxrc.plaintext_linelen;
4496 runparams.includeall = includeall;
4497 vector<string> backs = params().backends();
4498 Converters converters = theConverters();
4499 bool need_nice_file = false;
4500 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4501 // Get the shortest path to format
4502 converters.buildGraph();
4503 Graph::EdgePath path;
4504 for (string const & sit : backs) {
4505 Graph::EdgePath p = converters.getPath(sit, format);
4506 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4507 backend_format = sit;
4512 if (!put_in_tempdir) {
4513 // Only show this alert if this is an export to a non-temporary
4514 // file (not for previewing).
4515 docstring s = bformat(_("No information for exporting the format %1$s."),
4516 translateIfPossible(theFormats().prettyName(format)));
4517 if (format == "pdf4")
4519 + bformat(_("Hint: use non-TeX fonts or set input encoding"
4520 " to '%1$s'"), from_utf8(encodings.fromLyXName("ascii")->guiName()));
4521 Alert::error(_("Couldn't export file"), s);
4523 return ExportNoPathToFormat;
4525 runparams.flavor = converters.getFlavor(path, this);
4526 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4527 for (auto const & edge : path)
4528 if (theConverters().get(edge).nice()) {
4529 need_nice_file = true;
4534 backend_format = format;
4535 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4536 // FIXME: Don't hardcode format names here, but use a flag
4537 if (backend_format == "pdflatex")
4538 runparams.flavor = Flavor::PdfLaTeX;
4539 else if (backend_format == "luatex")
4540 runparams.flavor = Flavor::LuaTeX;
4541 else if (backend_format == "dviluatex")
4542 runparams.flavor = Flavor::DviLuaTeX;
4543 else if (backend_format == "xetex")
4544 runparams.flavor = Flavor::XeTeX;
4547 string filename = latexName(false);
4548 filename = addName(temppath(), filename);
4549 filename = changeExtension(filename,
4550 theFormats().extension(backend_format));
4551 LYXERR(Debug::FILES, "filename=" << filename);
4553 // Plain text backend
4554 if (backend_format == "text") {
4555 runparams.flavor = Flavor::Text;
4557 writePlaintextFile(*this, FileName(filename), runparams);
4559 catch (ConversionException const &) { return ExportCancel; }
4562 else if (backend_format == "xhtml") {
4563 runparams.flavor = Flavor::Html;
4564 setMathFlavor(runparams);
4565 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4566 return ExportKilled;
4567 } else if (backend_format == "lyx")
4568 writeFile(FileName(filename));
4570 else if (backend_format == "docbook5") {
4571 runparams.flavor = Flavor::DocBook5;
4572 runparams.nice = false;
4573 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4574 return ExportKilled;
4577 else if (backend_format == format || need_nice_file) {
4578 runparams.nice = true;
4579 ExportStatus const retval =
4580 makeLaTeXFile(FileName(filename), string(), runparams);
4581 if (retval == ExportKilled)
4582 return ExportKilled;
4583 if (d->cloned_buffer_)
4584 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4585 if (retval != ExportSuccess)
4587 } else if (!lyxrc.tex_allows_spaces
4588 && contains(filePath(), ' ')) {
4589 Alert::error(_("File name error"),
4590 bformat(_("The directory path to the document\n%1$s\n"
4591 "contains spaces, but your TeX installation does "
4592 "not allow them. You should save the file to a directory "
4593 "whose name does not contain spaces."), from_utf8(filePath())));
4594 return ExportTexPathHasSpaces;
4596 runparams.nice = false;
4597 ExportStatus const retval =
4598 makeLaTeXFile(FileName(filename), filePath(), runparams);
4599 if (retval == ExportKilled)
4600 return ExportKilled;
4601 if (d->cloned_buffer_)
4602 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4603 if (retval != ExportSuccess)
4607 string const error_type = (format == "program")
4608 ? "Build" : params().bufferFormat();
4609 ErrorList & error_list = d->errorLists[error_type];
4610 string const ext = theFormats().extension(format);
4611 FileName const tmp_result_file(changeExtension(filename, ext));
4612 Converters::RetVal const retval =
4613 converters.convert(this, FileName(filename), tmp_result_file,
4614 FileName(absFileName()), backend_format, format,
4615 error_list, Converters::none, includeall);
4616 if (retval == Converters::KILLED)
4617 return ExportCancel;
4618 bool success = (retval == Converters::SUCCESS);
4620 // Emit the signal to show the error list or copy it back to the
4621 // cloned Buffer so that it can be emitted afterwards.
4622 if (format != backend_format) {
4623 if (runparams.silent)
4625 else if (d->cloned_buffer_)
4626 d->cloned_buffer_->d->errorLists[error_type] =
4627 d->errorLists[error_type];
4630 // also to the children, in case of master-buffer-view
4631 ListOfBuffers clist = getDescendants();
4632 for (auto const & bit : clist) {
4633 if (runparams.silent)
4634 bit->d->errorLists[error_type].clear();
4635 else if (d->cloned_buffer_) {
4636 // Enable reverse search by copying back the
4637 // texrow object to the cloned buffer.
4638 // FIXME: this is not thread safe.
4639 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4640 bit->d->cloned_buffer_->d->errorLists[error_type] =
4641 bit->d->errorLists[error_type];
4643 bit->errors(error_type, true);
4647 if (d->cloned_buffer_) {
4648 // Enable reverse dvi or pdf to work by copying back the texrow
4649 // object to the cloned buffer.
4650 // FIXME: There is a possibility of concurrent access to texrow
4651 // here from the main GUI thread that should be securized.
4652 d->cloned_buffer_->d->texrow = d->texrow;
4653 string const err_type = params().bufferFormat();
4654 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4658 if (put_in_tempdir) {
4659 result_file = tmp_result_file.absFileName();
4660 return success ? ExportSuccess : ExportConverterError;
4663 if (dest_filename.empty())
4664 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4666 result_file = dest_filename;
4667 // We need to copy referenced files (e.g. included graphics
4668 // if format == "dvi") to the result dir.
4669 vector<ExportedFile> const extfiles =
4670 runparams.exportdata->externalFiles(format);
4671 string const dest = runparams.export_folder.empty() ?
4672 onlyPath(result_file) : runparams.export_folder;
4673 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4674 : force_overwrite == ALL_FILES;
4675 CopyStatus status = use_force ? FORCE : SUCCESS;
4677 for (ExportedFile const & exp : extfiles) {
4678 if (status == CANCEL) {
4679 message(_("Document export cancelled."));
4680 return ExportCancel;
4682 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4683 string fixedName = exp.exportName;
4684 if (!runparams.export_folder.empty()) {
4685 // Relative pathnames starting with ../ will be sanitized
4686 // if exporting to a different folder
4687 while (fixedName.substr(0, 3) == "../")
4688 fixedName = fixedName.substr(3, fixedName.length() - 3);
4690 FileName fixedFileName = makeAbsPath(fixedName, dest);
4691 fixedFileName.onlyPath().createPath();
4692 status = copyFile(fmt, exp.sourceName,
4694 exp.exportName, status == FORCE,
4695 runparams.export_folder.empty());
4699 if (tmp_result_file.exists()) {
4700 // Finally copy the main file
4701 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4702 : force_overwrite != NO_FILES;
4703 if (status == SUCCESS && use_force)
4705 status = copyFile(format, tmp_result_file,
4706 FileName(result_file), result_file,
4708 if (status == CANCEL) {
4709 message(_("Document export cancelled."));
4710 return ExportCancel;
4712 message(bformat(_("Document exported as %1$s "
4714 translateIfPossible(theFormats().prettyName(format)),
4715 makeDisplayPath(result_file)));
4718 // This must be a dummy converter like fax (bug 1888)
4719 message(bformat(_("Document exported as %1$s"),
4720 translateIfPossible(theFormats().prettyName(format))));
4723 return success ? ExportSuccess : ExportConverterError;
4727 Buffer::ExportStatus Buffer::preview(string const & format) const
4729 bool const update_unincluded =
4730 params().maintain_unincluded_children != BufferParams::CM_None
4731 && !params().getIncludedChildren().empty();
4732 return preview(format, update_unincluded);
4736 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4738 MarkAsExporting exporting(this);
4740 // (1) export with all included children (omit \includeonly)
4742 ExportStatus const status = doExport(format, true, true, result_file);
4743 if (status != ExportSuccess)
4746 // (2) export with included children only
4747 ExportStatus const status = doExport(format, true, false, result_file);
4748 FileName const previewFile(result_file);
4750 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4751 theimpl->preview_file_ = previewFile;
4752 theimpl->preview_format_ = format;
4753 theimpl->require_fresh_start_ = (status != ExportSuccess);
4755 if (status != ExportSuccess)
4758 if (previewFile.exists())
4759 return theFormats().view(*this, previewFile, format) ?
4760 PreviewSuccess : PreviewError;
4762 // Successful export but no output file?
4763 // Probably a bug in error detection.
4764 LATTEST(status != ExportSuccess);
4769 Buffer::ReadStatus Buffer::extractFromVC()
4771 bool const found = LyXVC::file_not_found_hook(d->filename);
4773 return ReadFileNotFound;
4774 if (!d->filename.isReadableFile())
4780 Buffer::ReadStatus Buffer::loadEmergency()
4782 FileName const emergencyFile = getEmergencyFileName();
4783 if (!emergencyFile.exists()
4784 || emergencyFile.lastModified() <= d->filename.lastModified())
4785 return ReadFileNotFound;
4787 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4788 docstring const text = bformat(_("An emergency save of the document "
4789 "%1$s exists.\n\nRecover emergency save?"), file);
4791 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4792 0, 3, _("&Recover"), _("&Load Original"), _("&Only show difference"), _("&Cancel"));
4798 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4799 bool const success = (ret_llf == ReadSuccess);
4801 if (hasReadonlyFlag()) {
4802 Alert::warning(_("File is read-only"),
4803 bformat(_("An emergency file is successfully loaded, "
4804 "but the original file %1$s is marked read-only. "
4805 "Please make sure to save the document as a different "
4806 "file."), from_utf8(d->filename.absFileName())));
4809 lyxvc().file_found_hook(d->filename);
4810 str = _("Document was successfully recovered.");
4812 str = _("Document was NOT successfully recovered.");
4813 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4814 makeDisplayPath(emergencyFile.absFileName()));
4816 int const del_emerg =
4817 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4818 _("&Remove"), _("&Keep"));
4819 if (del_emerg == 0) {
4820 emergencyFile.removeFile();
4822 Alert::warning(_("Emergency file deleted"),
4823 _("Do not forget to save your file now!"), true);
4825 return success ? ReadSuccess : ReadEmergencyFailure;
4828 int const del_emerg =
4829 Alert::prompt(_("Delete emergency file?"),
4830 _("Remove emergency file now?"), 1, 1,
4831 _("&Remove"), _("&Keep"));
4833 emergencyFile.removeFile();
4837 string const ename = emergencyFile.absFileName();
4839 // Surely we can find one in 100 tries?
4840 for (int i = 1; i < 100; ++i) {
4841 newname.set(ename + to_string(i) + ".lyx");
4842 if (!newname.exists()) {
4848 // renameTo returns true on success. So inverting that
4849 // will give us true if we fail.
4850 noname = !emergencyFile.renameTo(newname);
4853 Alert::warning(_("Can't rename emergency file!"),
4854 _("LyX was unable to rename the emergency file. "
4855 "You should do so manually. Otherwise, you will be "
4856 "asked about it again the next time you try to load "
4857 "this file, and may over-write your own work."));
4859 Alert::warning(_("Emergency File Renamed"),
4860 bformat(_("Emergency file renamed as:\n %1$s"),
4861 from_utf8(newname.onlyFileName())));
4864 return ReadOriginal;
4868 string const f1 = d->filename.absFileName();
4869 string const f2 = emergencyFile.absFileName();
4870 if (loadThisLyXFile(d->filename) != ReadSuccess)
4872 string const par = "compare run-blocking " + quoteName(f1) + " " + quoteName(f2);
4873 LYXERR(Debug::FILES, par << "\n");
4874 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, par));
4876 //release the emergency buffer loaded by compare
4877 Buffer * emerBuffer = theBufferList().getBuffer(emergencyFile);
4879 theBufferList().release(emerBuffer);
4881 return ReadCancel; //Release the buffer of Original immediatelly
4890 Buffer::ReadStatus Buffer::loadAutosave()
4892 // Now check if autosave file is newer.
4893 FileName const autosaveFile = getAutosaveFileName();
4894 if (!autosaveFile.exists()
4895 || autosaveFile.lastModified() <= d->filename.lastModified())
4896 return ReadFileNotFound;
4898 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4899 docstring const text = bformat(_("The backup of the document %1$s "
4900 "is newer.\n\nLoad the backup instead?"), file);
4901 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4902 _("&Load backup"), _("Load &original"), _("&Cancel"));
4907 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4908 // the file is not saved if we load the autosave file.
4909 if (ret_llf == ReadSuccess) {
4910 if (hasReadonlyFlag()) {
4911 Alert::warning(_("File is read-only"),
4912 bformat(_("A backup file is successfully loaded, "
4913 "but the original file %1$s is marked read-only. "
4914 "Please make sure to save the document as a "
4916 from_utf8(d->filename.absFileName())));
4919 lyxvc().file_found_hook(d->filename);
4922 return ReadAutosaveFailure;
4925 // Here we delete the autosave
4926 autosaveFile.removeFile();
4927 return ReadOriginal;
4935 Buffer::ReadStatus Buffer::loadLyXFile()
4937 if (!d->filename.isReadableFile()) {
4938 ReadStatus const ret_rvc = extractFromVC();
4939 if (ret_rvc != ReadSuccess)
4943 ReadStatus const ret_re = loadEmergency();
4944 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4947 ReadStatus const ret_ra = loadAutosave();
4948 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4951 return loadThisLyXFile(d->filename);
4955 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4957 return readFile(fn);
4961 void Buffer::Impl::traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const
4963 for (; err != end; ++err) {
4964 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4965 int errorRow = err->error_in_line;
4966 Buffer const * buf = nullptr;
4967 Impl const * p = this;
4968 if (err->child_name.empty())
4969 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4971 // The error occurred in a child
4972 for (Buffer const * child : owner_->getDescendants()) {
4973 string const child_name =
4974 DocFileName(changeExtension(child->absFileName(), "tex")).
4976 if (err->child_name != child_name)
4978 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4979 if (!TexRow::isNone(start)) {
4980 buf = this->cloned_buffer_
4981 ? child->d->cloned_buffer_->d->owner_
4988 errorList.push_back(ErrorItem(err->error_desc, err->error_text,
4994 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4996 TeXErrors::Errors::const_iterator err = terr.begin();
4997 TeXErrors::Errors::const_iterator end = terr.end();
4999 d->traverseErrors(err, end, errorList);
5003 void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const
5005 TeXErrors::Errors::const_iterator err = terr.begin_ref();
5006 TeXErrors::Errors::const_iterator end = terr.end_ref();
5008 d->traverseErrors(err, end, errorList);
5012 void Buffer::updateBuffer() const
5014 updateBuffer(UpdateMaster, InternalUpdate);
5015 d->need_update = false;
5019 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
5021 LBUFERR(!text().paragraphs().empty());
5023 // This can be called when loading a file, so that there be no
5025 UndoGroupHelper ugh(const_cast<Buffer *>(this));
5027 // Use the master text class also for child documents
5028 Buffer const * const master = masterBuffer();
5029 DocumentClass const & textclass = master->params().documentClass();
5031 docstring_list old_bibfiles;
5032 // Do this only if we are the top-level Buffer. We also need to account
5033 // for the case of a previewed child with ignored parent here.
5034 if (master == this && !d->ignore_parent) {
5035 textclass.counters().reset(from_ascii("bibitem"));
5036 reloadBibInfoCache();
5037 // we will re-read this cache as we go through, but we need
5038 // to know whether it's changed to know whether we need to
5039 // update the bibinfo cache.
5040 old_bibfiles = d->bibfiles_cache_;
5041 d->bibfiles_cache_.clear();
5044 // keep the buffers to be children in this set. If the call from the
5045 // master comes back we can see which of them were actually seen (i.e.
5046 // via an InsetInclude). The remaining ones in the set need still be updated.
5047 static std::set<Buffer const *> bufToUpdate;
5048 if (scope == UpdateMaster) {
5049 // If this is a child document start with the master
5050 if (master != this) {
5051 bufToUpdate.insert(this);
5052 master->updateBuffer(UpdateMaster, utype);
5053 // If the master buffer has no gui associated with it, then the TocModel is
5054 // not updated during the updateBuffer call and TocModel::toc_ is invalid
5055 // (bug 5699). The same happens if the master buffer is open in a different
5056 // window. This test catches both possibilities.
5057 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
5058 // There remains a problem here: If there is another child open in yet a third
5059 // window, that TOC is not updated. So some more general solution is needed at
5061 if (master->d->gui_ != d->gui_)
5064 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
5065 if (bufToUpdate.find(this) == bufToUpdate.end())
5069 // start over the counters in the master
5070 textclass.counters().reset();
5073 // update will be done below for this buffer
5074 bufToUpdate.erase(this);
5076 // update all caches
5077 clearReferenceCache();
5080 Buffer & cbuf = const_cast<Buffer &>(*this);
5081 // if we are reloading, then we could have a dangling TOC,
5082 // in effect. so we need to go ahead and reset, even though
5083 // we will do so again when we rebuild the TOC later.
5084 cbuf.tocBackend().reset();
5087 ParIterator parit = cbuf.par_iterator_begin();
5088 if (scope == UpdateMaster)
5090 updateBuffer(parit, utype);
5092 // If this document has siblings, then update the TocBackend later. The
5093 // reason is to ensure that later siblings are up to date when e.g. the
5094 // broken or not status of references is computed. The update is called
5095 // in InsetInclude::addToToc.
5099 // if the bibfiles changed, the cache of bibinfo is invalid
5100 docstring_list new_bibfiles = d->bibfiles_cache_;
5101 // this is a trick to determine whether the two vectors have
5102 // the same elements.
5103 sort(new_bibfiles.begin(), new_bibfiles.end());
5104 sort(old_bibfiles.begin(), old_bibfiles.end());
5105 if (old_bibfiles != new_bibfiles) {
5106 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
5107 invalidateBibinfoCache();
5108 reloadBibInfoCache();
5109 // We relied upon the bibinfo cache when recalculating labels. But that
5110 // cache was invalid, although we didn't find that out until now. So we
5111 // have to do it all again.
5112 // That said, the only thing we really need to do is update the citation
5113 // labels. Nothing else will have changed. So we could create a new
5114 // UpdateType that would signal that fact, if we needed to do so.
5115 parit = cbuf.par_iterator_begin();
5116 // we will be re-doing the counters and references and such.
5117 textclass.counters().reset();
5118 clearReferenceCache();
5119 // we should not need to do this again?
5121 updateBuffer(parit, utype);
5122 // this will already have been done by reloadBibInfoCache();
5123 // d->bibinfo_cache_valid_ = true;
5126 LYXERR(Debug::FILES, "Bibfiles unchanged.");
5127 // this is also set to true on the other path, by reloadBibInfoCache.
5128 d->bibinfo_cache_valid_ = true;
5130 d->cite_labels_valid_ = true;
5133 cbuf.tocBackend().update(true, utype);
5134 if (scope == UpdateMaster)
5135 cbuf.structureChanged();
5137 d->need_update = false;
5141 static depth_type getDepth(DocIterator const & it)
5143 depth_type depth = 0;
5144 for (size_t i = 0 ; i < it.depth() ; ++i)
5145 if (!it[i].inset().inMathed())
5146 depth += it[i].paragraph().getDepth() + 1;
5147 // remove 1 since the outer inset does not count
5148 // we should have at least one non-math inset, so
5149 // depth should nevery be 0. but maybe it is worth
5150 // marking this, just in case.
5152 // coverity[INTEGER_OVERFLOW]
5156 static depth_type getItemDepth(ParIterator const & it)
5158 Paragraph const & par = *it;
5159 LabelType const labeltype = par.layout().labeltype;
5161 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5164 // this will hold the lowest depth encountered up to now.
5165 depth_type min_depth = getDepth(it);
5166 ParIterator prev_it = it;
5169 --prev_it.top().pit();
5171 // start of nested inset: go to outer par
5173 if (prev_it.empty()) {
5174 // start of document: nothing to do
5179 // We search for the first paragraph with same label
5180 // that is not more deeply nested.
5181 Paragraph & prev_par = *prev_it;
5182 depth_type const prev_depth = getDepth(prev_it);
5183 if (labeltype == prev_par.layout().labeltype) {
5184 if (prev_depth < min_depth)
5185 return prev_par.itemdepth + 1;
5186 if (prev_depth == min_depth)
5187 return prev_par.itemdepth;
5189 min_depth = min(min_depth, prev_depth);
5190 // small optimization: if we are at depth 0, we won't
5191 // find anything else
5192 if (prev_depth == 0)
5198 static bool needEnumCounterReset(ParIterator const & it)
5200 Paragraph const & par = *it;
5201 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5202 depth_type const cur_depth = par.getDepth();
5203 ParIterator prev_it = it;
5204 while (prev_it.pit()) {
5205 --prev_it.top().pit();
5206 Paragraph const & prev_par = *prev_it;
5207 if (prev_par.getDepth() <= cur_depth)
5208 return prev_par.layout().name() != par.layout().name();
5210 // start of nested inset: reset
5215 // set the label of a paragraph. This includes the counters.
5216 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5218 BufferParams const & bp = owner_->masterBuffer()->params();
5219 DocumentClass const & textclass = bp.documentClass();
5220 Paragraph & par = it.paragraph();
5221 Layout const & layout = par.layout();
5222 Counters & counters = textclass.counters();
5224 if (par.params().startOfAppendix()) {
5225 // We want to reset the counter corresponding to toplevel sectioning
5226 Layout const & lay = textclass.getTOCLayout();
5227 docstring const cnt = lay.counter;
5229 counters.reset(cnt);
5230 counters.appendix(true);
5232 par.params().appendix(counters.appendix());
5234 // Compute the item depth of the paragraph
5235 par.itemdepth = getItemDepth(it);
5237 if (layout.margintype == MARGIN_MANUAL) {
5238 if (par.params().labelWidthString().empty())
5239 par.params().labelWidthString(par.expandLabel(layout, bp));
5240 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5241 // we do not need to do anything here, since the empty case is
5242 // handled during export.
5244 par.params().labelWidthString(docstring());
5247 switch(layout.labeltype) {
5248 case LABEL_ITEMIZE: {
5249 par.params().labelString(
5251 ? bp.user_defined_bullet(par.itemdepth).getLabel()
5252 // Display fallback for too deeply nested items
5253 : bformat(from_ascii("[?%1$d]"), int(par.itemdepth + 1)));
5257 case LABEL_ENUMERATE: {
5258 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5260 switch (par.itemdepth) {
5271 enumcounter += "iv";
5274 // not a valid enumdepth...
5278 if (needEnumCounterReset(it)) {
5279 // Increase the parent counter?
5280 if (layout.stepparentcounter)
5281 counters.stepParent(enumcounter, utype);
5282 // Maybe we have to reset the enumeration counter.
5283 if (!layout.resumecounter)
5284 counters.reset(enumcounter);
5286 counters.step(enumcounter, utype);
5288 string const & lang = par.getParLanguage(bp)->code();
5289 par.params().labelString(counters.theCounter(enumcounter, lang));
5294 case LABEL_SENSITIVE: {
5295 string const & type = counters.current_float();
5296 docstring full_label;
5298 full_label = owner_->B_("Senseless!!! ");
5300 docstring name = owner_->B_(textclass.floats().getType(type).name());
5301 if (counters.hasCounter(from_utf8(type))) {
5302 string const & lang = par.getParLanguage(bp)->code();
5303 counters.step(from_utf8(type), utype);
5304 full_label = bformat(from_ascii("%1$s %2$s:"),
5306 counters.theCounter(from_utf8(type), lang));
5308 full_label = bformat(from_ascii("%1$s #:"), name);
5310 par.params().labelString(full_label);
5314 case LABEL_NO_LABEL:
5315 par.params().labelString(docstring());
5319 case LABEL_CENTERED:
5320 case LABEL_STATIC: {
5321 docstring const & lcounter = layout.counter;
5322 if (!lcounter.empty()) {
5323 if (layout.toclevel <= bp.secnumdepth
5324 && (layout.latextype != LATEX_ENVIRONMENT
5325 || it.text()->isFirstInSequence(it.pit()))) {
5326 if (counters.hasCounter(lcounter))
5327 counters.step(lcounter, utype);
5328 par.params().labelString(par.expandLabel(layout, bp));
5330 par.params().labelString(docstring());
5332 par.params().labelString(par.expandLabel(layout, bp));
5338 par.params().labelString(par.expandLabel(layout, bp));
5343 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype, bool const deleted) const
5345 pushIncludedBuffer(this);
5346 // LASSERT: Is it safe to continue here, or should we just return?
5347 LASSERT(parit.pit() == 0, /**/);
5349 // Set the position of the text in the buffer to be able
5350 // to resolve macros in it.
5351 parit.text()->setMacrocontextPosition(parit);
5353 depth_type maxdepth = 0;
5354 pit_type const lastpit = parit.lastpit();
5355 bool changed = false;
5356 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5357 // reduce depth if necessary
5358 if (parit->params().depth() > maxdepth) {
5359 /** FIXME: this function is const, but
5360 * nevertheless it modifies the buffer. To be
5361 * cleaner, one should modify the buffer in
5362 * another function, which is actually
5363 * non-const. This would however be costly in
5364 * terms of code duplication.
5366 CursorData(parit).recordUndo();
5367 parit->params().depth(maxdepth);
5369 maxdepth = parit->getMaxDepthAfter();
5371 if (utype == OutputUpdate) {
5372 // track the active counters
5373 // we have to do this for the master buffer, since the local
5374 // buffer isn't tracking anything.
5375 masterBuffer()->params().documentClass().counters().
5376 setActiveLayout(parit->layout());
5379 // set the counter for this paragraph
5380 d->setLabel(parit, utype);
5383 for (auto const & insit : parit->insetList()) {
5384 parit.pos() = insit.pos;
5385 insit.inset->updateBuffer(parit, utype, deleted || parit->isDeleted(insit.pos));
5386 changed |= insit.inset->isChanged();
5389 // are there changes in this paragraph?
5390 changed |= parit->isChanged();
5393 // set change indicator for the inset (or the cell that the iterator
5394 // points to, if applicable).
5395 parit.text()->inset().isChanged(changed);
5396 popIncludedBuffer();
5400 void Buffer::forceUpdate() const
5402 d->need_update = true;
5406 bool Buffer::needUpdate() const
5408 return d->need_update;
5412 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5413 WordLangTuple & word_lang, docstring_list & suggestions) const
5417 suggestions.clear();
5418 word_lang = WordLangTuple();
5419 bool const to_end = to.empty();
5420 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5421 // OK, we start from here.
5422 for (; from != end; from.forwardPos()) {
5423 // This skips all insets with spell check disabled.
5424 while (!from.allowSpellCheck()) {
5428 // If from is at the end of the document (which is possible
5429 // when "from" was changed above) LyX will crash later otherwise.
5430 if (from.atEnd() || (!to_end && from >= end))
5433 from.paragraph().spellCheck();
5434 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5435 if (SpellChecker::misspelled(res)) {
5439 // Do not increase progress when from == to, otherwise the word
5440 // count will be wrong.
5450 void Buffer::requestSpellcheck()
5452 ParagraphList::iterator pit = paragraphs().begin();
5453 ParagraphList::iterator pend = paragraphs().end();
5454 for (; pit != pend; ++pit)
5455 pit->requestSpellCheck();
5459 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5461 bool inword = false;
5466 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5467 if (!dit.inTexted()) {
5472 Paragraph const & par = dit.paragraph();
5473 pos_type const pos = dit.pos();
5475 // Copied and adapted from isWordSeparator() in Paragraph
5476 if (pos == dit.lastpos()) {
5479 Inset const * ins = par.getInset(pos);
5480 if (ins && skipNoOutput && !ins->producesOutput()) {
5483 // stop if end of range was skipped
5484 if (!to.atEnd() && dit >= to)
5487 } else if (!par.isDeleted(pos)) {
5488 if (par.isWordSeparator(pos))
5494 if (ins && ins->isLetter()) {
5495 odocstringstream os;
5497 char_count_ += os.str().length();
5499 else if (ins && ins->isSpace())
5502 pair<int, int> words = ins->isWords();
5503 char_count_ += words.first;
5504 word_count_ += words.second;
5508 char_type const c = par.getChar(pos);
5509 if (isPrintableNonspace(c))
5511 else if (isSpace(c))
5521 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5523 d->updateStatistics(from, to, skipNoOutput);
5527 int Buffer::wordCount() const
5529 return d->wordCount();
5533 int Buffer::charCount(bool with_blanks) const
5535 return d->charCount(with_blanks);
5539 bool Buffer::areChangesPresent() const
5541 return inset().isChanged();
5545 Buffer::ReadStatus Buffer::reload()
5548 // c.f. bug https://www.lyx.org/trac/ticket/6587
5549 removeAutosaveFile();
5550 // e.g., read-only status could have changed due to version control
5551 d->filename.refresh();
5552 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5554 // clear parent. this will get reset if need be.
5555 d->setParent(nullptr);
5556 ReadStatus const status = loadLyXFile();
5557 if (status == ReadSuccess) {
5562 message(bformat(_("Document %1$s reloaded."), disp_fn));
5565 message(bformat(_("Could not reload document %1$s."), disp_fn));
5575 bool Buffer::saveAs(FileName const & fn)
5577 FileName const old_name = fileName();
5578 FileName const old_auto = getAutosaveFileName();
5579 bool const old_unnamed = isUnnamed();
5580 bool success = true;
5581 d->old_position = filePath();
5588 // bring the autosave file with us, just in case.
5589 moveAutosaveFile(old_auto);
5590 // validate version control data and
5591 // correct buffer title
5592 lyxvc().file_found_hook(fileName());
5594 // the file has now been saved to the new location.
5595 // we need to check that the locations of child buffers
5597 checkChildBuffers();
5598 checkMasterBuffer();
5601 // reset the old filename and unnamed state
5602 setFileName(old_name);
5603 setUnnamed(old_unnamed);
5607 d->old_position.clear();
5612 void Buffer::checkChildBuffers()
5614 for (auto const & bit : d->children_positions) {
5615 DocIterator dit = bit.second;
5616 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5617 if (!cbuf || !theBufferList().isLoaded(cbuf))
5619 Inset * inset = dit.nextInset();
5620 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5621 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5622 docstring const & incfile = inset_inc->getParam("filename");
5623 string oldloc = cbuf->absFileName();
5624 string newloc = makeAbsPath(to_utf8(incfile),
5625 onlyPath(absFileName())).absFileName();
5626 if (oldloc == newloc)
5628 // the location of the child file is incorrect.
5629 cbuf->setParent(nullptr);
5630 inset_inc->setChildBuffer(nullptr);
5632 // invalidate cache of children
5633 d->children_positions.clear();
5634 d->position_to_children.clear();
5638 // If a child has been saved under a different name/path, it might have been
5639 // orphaned. Therefore the master needs to be reset (bug 8161).
5640 void Buffer::checkMasterBuffer()
5642 Buffer const * const master = masterBuffer();
5646 // necessary to re-register the child (bug 5873)
5647 // FIXME: clean up updateMacros (here, only
5648 // child registering is needed).
5649 master->updateMacros();
5650 // (re)set master as master buffer, but only
5651 // if we are a real child
5652 if (master->isChild(this))
5659 string Buffer::includedFilePath(string const & name, string const & ext) const
5661 if (d->old_position.empty() ||
5662 equivalent(FileName(d->old_position), FileName(filePath())))
5665 bool isabsolute = FileName::isAbsolute(name);
5666 // both old_position and filePath() end with a path separator
5667 string absname = isabsolute ? name : d->old_position + name;
5669 // if old_position is set to origin, we need to do the equivalent of
5670 // getReferencedFileName() (see readDocument())
5671 if (!isabsolute && d->old_position == params().origin) {
5672 FileName const test(addExtension(filePath() + name, ext));
5674 absname = filePath() + name;
5677 if (!FileName(addExtension(absname, ext)).exists())
5681 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5683 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5684 from_utf8(filePath())));
5688 void Buffer::Impl::refreshFileMonitor()
5690 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5691 file_monitor_->refresh();
5695 // The previous file monitor is invalid
5696 // This also destroys the previous file monitor and all its connections
5697 file_monitor_ = FileSystemWatcher::monitor(filename);
5698 // file_monitor_ will be destroyed with *this, so it is not going to call a
5699 // destroyed object method.
5700 file_monitor_->connect([this](bool exists) {
5701 fileExternallyModified(exists);
5706 void Buffer::Impl::fileExternallyModified(bool const exists)
5708 // ignore notifications after our own saving operations
5709 if (checksum_ == filename.checksum()) {
5710 LYXERR(Debug::FILES, "External modification but "
5711 "checksum unchanged: " << filename);
5714 // If the file has been deleted, only mark the file as dirty since it is
5715 // pointless to prompt for reloading. If later a file is moved into this
5716 // location, then the externally modified warning will appear then.
5718 externally_modified_ = true;
5719 // Update external modification notification.
5720 // Dirty buffers must be visible at all times.
5721 if (wa_ && wa_->unhide(owner_))
5722 wa_->updateTitles();
5724 // Unable to unhide the buffer (e.g. no GUI or not current View)
5729 bool Buffer::notifiesExternalModification() const
5731 return d->externally_modified_;
5735 void Buffer::clearExternalModification() const
5737 d->externally_modified_ = false;
5739 d->wa_->updateTitles();
5743 void Buffer::pushIncludedBuffer(Buffer const * buf) const
5745 masterBuffer()->d->include_list_.push_back(buf);
5746 if (lyxerr.debugging(Debug::FILES)) {
5747 LYXERR0("Pushed. Stack now:");
5748 if (masterBuffer()->d->include_list_.empty())
5751 for (auto const & b : masterBuffer()->d->include_list_)
5752 LYXERR0(b->fileName());
5757 void Buffer::popIncludedBuffer() const
5759 masterBuffer()->d->include_list_.pop_back();
5760 if (lyxerr.debugging(Debug::FILES)) {
5761 LYXERR0("Popped. Stack now:");
5762 if (masterBuffer()->d->include_list_.empty())
5765 for (auto const & b : masterBuffer()->d->include_list_)
5766 LYXERR0(b->fileName());
5771 bool Buffer::isBufferIncluded(Buffer const * buf) const
5775 if (lyxerr.debugging(Debug::FILES)) {
5776 LYXERR0("Checking for " << buf->fileName() << ". Stack now:");
5777 if (masterBuffer()->d->include_list_.empty())
5780 for (auto const & b : masterBuffer()->d->include_list_)
5781 LYXERR0(b->fileName());
5783 list<Buffer const *> const & blist = masterBuffer()->d->include_list_;
5784 return find(blist.begin(), blist.end(), buf) != blist.end();
5788 void Buffer::clearIncludeList() const
5790 LYXERR(Debug::FILES, "Clearing include list for " << fileName());
5791 d->include_list_.clear();