3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Stefan Schimanski
9 * Full author contact details are available in file CREDITS.
17 #include "BiblioInfo.h"
18 #include "BranchList.h"
19 #include "buffer_funcs.h"
20 #include "BufferList.h"
21 #include "BufferParams.h"
25 #include "Converter.h"
28 #include "CutAndPaste.h"
29 #include "DispatchResult.h"
30 #include "DocIterator.h"
31 #include "BufferEncodings.h"
32 #include "ErrorList.h"
35 #include "FuncRequest.h"
36 #include "FuncStatus.h"
37 #include "IndicesList.h"
38 #include "InsetIterator.h"
39 #include "InsetList.h"
41 #include "LaTeXFeatures.h"
45 #include "LyXAction.h"
50 #include "output_latex.h"
51 #include "output_docbook.h"
52 #include "output_plaintext.h"
53 #include "output_xhtml.h"
54 #include "Paragraph.h"
55 #include "ParagraphParameters.h"
56 #include "ParIterator.h"
57 #include "PDFOptions.h"
59 #include "SpellChecker.h"
61 #include "texstream.h"
64 #include "TextClass.h"
65 #include "TocBackend.h"
67 #include "VCBackend.h"
69 #include "WordLangTuple.h"
71 #include "insets/InsetBranch.h"
72 #include "insets/InsetInclude.h"
73 #include "insets/InsetText.h"
75 #include "mathed/InsetMathHull.h"
76 #include "mathed/MacroTable.h"
77 #include "mathed/InsetMathMacroTemplate.h"
78 #include "mathed/MathSupport.h"
80 #include "graphics/PreviewLoader.h"
82 #include "frontends/Application.h"
83 #include "frontends/alert.h"
84 #include "frontends/Delegates.h"
85 #include "frontends/WorkAreaManager.h"
87 #include "support/lassert.h"
88 #include "support/convert.h"
89 #include "support/debug.h"
90 #include "support/docstring_list.h"
91 #include "support/ExceptionMessage.h"
92 #include "support/FileMonitor.h"
93 #include "support/FileName.h"
94 #include "support/FileNameList.h"
95 #include "support/filetools.h"
96 #include "support/gettext.h"
97 #include "support/gzstream.h"
98 #include "support/lstrings.h"
99 #include "support/mutex.h"
100 #include "support/os.h"
101 #include "support/Package.h"
102 #include "support/PathChanger.h"
103 #include "support/Systemcall.h"
104 #include "support/TempFile.h"
105 #include "support/textutils.h"
106 #include "support/types.h"
118 using namespace lyx::support;
119 using namespace lyx::graphics;
123 namespace Alert = frontend::Alert;
124 namespace os = support::os;
128 int const LYX_FORMAT = LYX_FORMAT_LYX;
130 typedef map<string, bool> DepClean;
132 // Information about labels and their associated refs
137 InsetLabel const * inset;
138 /// associated references cache
139 Buffer::References references;
140 /// whether this label is active (i.e., not deleted)
144 typedef vector<LabelInfo> LabelCache;
146 typedef map<docstring, Buffer::References> RefCache;
148 // A storehouse for the cloned buffers.
149 typedef list<CloneList_ptr> CloneStore;
150 CloneStore cloned_buffers;
159 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
163 delete preview_loader_;
171 /// search for macro in local (buffer) table or in children
172 MacroData const * getBufferMacro(docstring const & name,
173 DocIterator const & pos) const;
175 /// Update macro table starting with position of it \param it in some
177 void updateMacros(DocIterator & it, DocIterator & scope);
179 void setLabel(ParIterator & it, UpdateType utype) const;
181 /** If we have branches that use the file suffix
182 feature, return the file name with suffix appended.
184 FileName exportFileName() const;
191 mutable TexRow texrow;
193 /// need to regenerate .tex?
196 /// name of the file the buffer is associated with.
200 mutable TocBackend toc_backend;
205 ScopeMacro(DocIterator const & s, MacroData const & m)
206 : scope(s), macro(m) {}
210 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
211 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
212 /// map from the macro name to the position map,
213 /// which maps the macro definition position to the scope and the MacroData.
214 NamePositionScopeMacroMap macros;
216 /// positions of child buffers in the buffer
217 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
219 ScopeBuffer() : buffer(nullptr) {}
220 ScopeBuffer(DocIterator const & s, Buffer const * b)
221 : scope(s), buffer(b) {}
223 Buffer const * buffer;
225 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
226 /// position of children buffers in this buffer
227 BufferPositionMap children_positions;
228 /// map from children inclusion positions to their scope and their buffer
229 PositionScopeBufferMap position_to_children;
231 /// Contains the old buffer filePath() while saving-as, or the
232 /// directory where the document was last saved while loading.
235 /** Keeps track of the path of local layout files.
236 * If possible, it is always relative to the buffer path.
237 * Empty for layouts in system or user directory.
239 string layout_position;
241 /// Container for all sort of Buffer dependant errors.
242 map<string, ErrorList> errorLists;
244 /// checksum used to test if the file has been externally modified. Used to
245 /// double check whether the file had been externally modified when saving.
246 unsigned long checksum_;
249 frontend::WorkAreaManager * wa_;
251 frontend::GuiBufferDelegate * gui_;
256 /// A cache for the bibfiles (including bibfiles of loaded child
257 /// documents), needed for appropriate update of natbib labels.
258 mutable docstring_list bibfiles_cache_;
260 // FIXME The caching mechanism could be improved. At present, we have a
261 // cache for each Buffer, that caches all the bibliography info for that
262 // Buffer. A more efficient solution would be to have a global cache per
263 // file, and then to construct the Buffer's bibinfo from that.
264 /// A cache for bibliography info
265 mutable BiblioInfo bibinfo_;
266 /// Cache of timestamps of .bib files
267 map<FileName, time_t> bibfile_status_;
269 /// These two hold the file name and format, written to by
270 /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
271 FileName preview_file_;
272 string preview_format_;
274 /// Cache the references associated to a label and their positions
276 mutable RefCache ref_cache_;
277 /// Cache the label insets and their activity status.
278 mutable LabelCache label_cache_;
280 /// our Text that should be wrapped in an InsetText
284 PreviewLoader * preview_loader_;
286 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
287 /// This one is useful for preview detached in a thread.
288 Buffer const * cloned_buffer_;
290 CloneList_ptr clone_list_;
293 std::list<Buffer const *> include_list_;
295 /// So we can force access via the accessors.
296 mutable Buffer const * parent_buffer;
298 FileMonitorPtr file_monitor_;
300 /// ints and bools are all listed last so as to avoid alignment issues
302 /// original format of loaded file
305 /// are we in the process of exporting this buffer?
306 mutable bool doing_export;
308 /// If there was an error when previewing, on the next preview we do
309 /// a fresh compile (e.g. in case the user installed a package that
311 bool require_fresh_start_;
313 /// Indicates whether the bibinfo has changed since the last time
314 /// we ran updateBuffer(), i.e., whether citation labels may need
316 mutable bool cite_labels_valid_;
317 /// Do we have a bibliography environment?
318 mutable bool have_bibitems_;
321 mutable bool lyx_clean;
323 /// is autosave needed?
324 mutable bool bak_clean;
326 /// is this an unnamed file (New...)?
329 /// is this an internal bufffer?
330 bool internal_buffer;
335 /** Set to true only when the file is fully loaded.
336 * Used to prevent the premature generation of previews
337 * and by the citation inset.
339 bool file_fully_loaded;
341 /// if the file was originally loaded from an older format, do
342 /// we need to back it up still?
343 bool need_format_backup;
345 /// Ignore the parent (e.g. when exporting a child standalone)?
348 /// This seem to change the way Buffer::getMacro() works
349 mutable bool macro_lock;
351 /// has been externally modified? Can be reset by the user.
352 mutable bool externally_modified_;
354 /// whether the bibinfo cache is valid
355 mutable bool bibinfo_cache_valid_;
358 mutable bool need_update;
366 /// This is here to force the test to be done whenever parent_buffer
368 Buffer const * parent() const
370 // ignore_parent temporarily "orphans" a buffer
371 // (e.g. if a child is compiled standalone)
374 // if parent_buffer is not loaded, then it has been unloaded,
375 // which means that parent_buffer is an invalid pointer. So we
376 // set it to null in that case.
377 // however, the BufferList doesn't know about cloned buffers, so
378 // they will always be regarded as unloaded. in that case, we hope
380 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
381 parent_buffer = nullptr;
382 return parent_buffer;
386 void setParent(Buffer const * pb)
388 if (parent_buffer == pb)
391 if (!cloned_buffer_ && parent_buffer && pb)
392 LYXERR0("Warning: a buffer should not have two parents!");
394 if (!cloned_buffer_ && parent_buffer)
395 parent_buffer->invalidateBibinfoCache();
398 /// compute statistics
399 /// \p from initial position
400 /// \p to points to the end position
401 void updateStatistics(DocIterator & from, DocIterator & to,
402 bool skipNoOutput = true);
403 /// statistics accessor functions
404 int wordCount() const
408 int charCount(bool with_blanks) const
411 + (with_blanks ? blank_count_ : 0);
414 // Make sure the file monitor monitors the good file.
415 void refreshFileMonitor();
417 /// Notify or clear of external modification
418 void fileExternallyModified(bool exists);
420 ///Binding LaTeX lines with buffer positions.
421 //Common routine for LaTeX and Reference errors listing.
422 void traverseErrors(TeXErrors::Errors::const_iterator err,
423 TeXErrors::Errors::const_iterator end,
424 ErrorList & errorList) const;
428 /// Creates the per buffer temporary directory
429 static FileName createBufferTmpDir()
431 // FIXME This would be the ideal application for a TempDir class (like
432 // TempFile but for directories)
437 Mutex::Locker locker(&mutex);
438 counter = convert<string>(count++);
440 // We are in our own directory. Why bother to mangle name?
441 // In fact I wrote this code to circumvent a problematic behaviour
442 // (bug?) of EMX mkstemp().
443 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
446 if (!tmpfl.createDirectory(0777)) {
447 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
448 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
449 from_utf8(tmpfl.absFileName())));
455 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
456 Buffer const * cloned_buffer)
457 : owner_(owner), filename(file), toc_backend(owner), checksum_(0),
458 wa_(nullptr), gui_(nullptr), undo_(*owner), inset(nullptr),
459 preview_loader_(nullptr), cloned_buffer_(cloned_buffer),
460 clone_list_(nullptr), parent_buffer(nullptr), file_format(LYX_FORMAT),
461 doing_export(false), require_fresh_start_(false), cite_labels_valid_(false),
462 have_bibitems_(false), lyx_clean(true), bak_clean(true), unnamed(false),
463 internal_buffer(false), read_only(readonly_), file_fully_loaded(false),
464 need_format_backup(false), ignore_parent(false), macro_lock(false),
465 externally_modified_(false), bibinfo_cache_valid_(false),
466 need_update(false), word_count_(0), char_count_(0), blank_count_(0)
468 refreshFileMonitor();
469 if (!cloned_buffer_) {
470 temppath = createBufferTmpDir();
471 lyxvc.setBuffer(owner_);
472 Language const * inplang = theApp() ?
473 languages.getFromCode(theApp()->inputLanguageCode())
476 params.language = inplang;
478 wa_ = new frontend::WorkAreaManager;
481 temppath = cloned_buffer_->d->temppath;
482 file_fully_loaded = true;
483 params = cloned_buffer_->d->params;
484 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
485 bibinfo_ = cloned_buffer_->d->bibinfo_;
486 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
487 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
488 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
489 have_bibitems_ = cloned_buffer_->d->have_bibitems_;
490 unnamed = cloned_buffer_->d->unnamed;
491 internal_buffer = cloned_buffer_->d->internal_buffer;
492 layout_position = cloned_buffer_->d->layout_position;
493 preview_file_ = cloned_buffer_->d->preview_file_;
494 preview_format_ = cloned_buffer_->d->preview_format_;
495 require_fresh_start_ = cloned_buffer_->d->require_fresh_start_;
499 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
500 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
502 LYXERR(Debug::INFO, "Buffer::Buffer()");
504 d->inset = new InsetText(*cloned_buffer->d->inset);
505 d->inset->setBuffer(*this);
506 // FIXME: optimize this loop somewhat, maybe by creating a new
507 // general recursive Inset::setId().
508 DocIterator it = doc_iterator_begin(this);
509 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
510 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
511 it.paragraph().setId(cloned_it.paragraph().id());
513 d->inset = new InsetText(this);
514 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
520 LYXERR(Debug::INFO, "Buffer::~Buffer()");
521 // here the buffer should take care that it is
522 // saved properly, before it goes into the void.
524 // GuiView already destroyed
528 // No need to do additional cleanups for internal buffer.
534 // this is in case of recursive includes: we won't try to delete
535 // ourselves as a child.
536 d->clone_list_->erase(this);
537 // loop over children
538 for (auto const & p : d->children_positions) {
539 Buffer * child = const_cast<Buffer *>(p.first);
540 if (d->clone_list_->erase(child))
543 // if we're the master buffer, then we should get rid of the list
546 // If this is not empty, we have leaked something. Worse, one of the
547 // children still has a reference to this list. But we will try to
548 // continue, rather than shut down.
549 LATTEST(d->clone_list_->empty());
550 // The clone list itself is empty, but it's still referenced in our list
551 // of clones. So let's find it and remove it.
552 CloneStore::iterator it =
553 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
554 if (it == cloned_buffers.end()) {
555 // We will leak in this case, but it is safe to continue.
558 cloned_buffers.erase(it);
560 // FIXME Do we really need to do this right before we delete d?
561 // clear references to children in macro tables
562 d->children_positions.clear();
563 d->position_to_children.clear();
565 // loop over children
566 for (auto const & p : d->children_positions) {
567 Buffer * child = const_cast<Buffer *>(p.first);
568 if (theBufferList().isLoaded(child)) {
569 if (theBufferList().isOthersChild(this, child))
570 child->setParent(nullptr);
572 theBufferList().release(child);
577 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
579 msg += emergencyWrite();
581 msg += " " + _("Save failed! Document is lost.");
583 Alert::warning(_("Attempting to close changed document!"), msg);
586 // FIXME Do we really need to do this right before we delete d?
587 // clear references to children in macro tables
588 d->children_positions.clear();
589 d->position_to_children.clear();
591 if (!d->temppath.destroyDirectory()) {
592 LYXERR0(bformat(_("Could not remove the temporary directory %1$s"),
593 from_utf8(d->temppath.absFileName())));
602 Buffer * Buffer::cloneWithChildren() const
605 cloned_buffers.emplace_back(new CloneList);
606 CloneList_ptr clones = cloned_buffers.back();
608 cloneWithChildren(bufmap, clones);
610 // make sure we got cloned
611 BufferMap::const_iterator bit = bufmap.find(this);
612 LASSERT(bit != bufmap.end(), return nullptr);
613 Buffer * cloned_buffer = bit->second;
615 return cloned_buffer;
619 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList_ptr clones) const
621 // have we already been cloned?
622 if (bufmap.find(this) != bufmap.end())
625 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
627 // The clone needs its own DocumentClass, since running updateBuffer() will
628 // modify it, and we would otherwise be sharing it with the original Buffer.
629 buffer_clone->params().makeDocumentClass(true);
630 cap::switchBetweenClasses(
631 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
632 static_cast<InsetText &>(buffer_clone->inset()));
634 bufmap[this] = buffer_clone;
635 clones->insert(buffer_clone);
636 buffer_clone->d->clone_list_ = clones;
637 buffer_clone->d->macro_lock = true;
638 buffer_clone->d->children_positions.clear();
640 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
641 // math macro caches need to be rethought and simplified.
642 // I am not sure wether we should handle Buffer cloning here or in BufferList.
643 // Right now BufferList knows nothing about buffer clones.
644 for (auto const & p : d->position_to_children) {
645 DocIterator dit = p.first.clone(buffer_clone);
646 dit.setBuffer(buffer_clone);
647 Buffer * child = const_cast<Buffer *>(p.second.buffer);
649 child->cloneWithChildren(bufmap, clones);
650 BufferMap::iterator const bit = bufmap.find(child);
651 LASSERT(bit != bufmap.end(), continue);
652 Buffer * child_clone = bit->second;
654 Inset * inset = dit.nextInset();
655 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
656 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
657 inset_inc->setChildBuffer(child_clone);
658 child_clone->d->setParent(buffer_clone);
659 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
660 buffer_clone->setChild(dit, child_clone);
662 buffer_clone->d->macro_lock = false;
666 Buffer * Buffer::cloneBufferOnly() const {
667 cloned_buffers.emplace_back(new CloneList);
668 CloneList_ptr clones = cloned_buffers.back();
669 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
671 // The clone needs its own DocumentClass, since running updateBuffer() will
672 // modify it, and we would otherwise be sharing it with the original Buffer.
673 buffer_clone->params().makeDocumentClass(true);
674 cap::switchBetweenClasses(
675 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
676 static_cast<InsetText &>(buffer_clone->inset()));
678 clones->insert(buffer_clone);
679 buffer_clone->d->clone_list_ = clones;
681 // we won't be cloning the children
682 buffer_clone->d->children_positions.clear();
687 bool Buffer::isClone() const
689 return d->cloned_buffer_;
693 void Buffer::changed(bool update_metrics) const
696 d->wa_->redrawAll(update_metrics);
700 frontend::WorkAreaManager & Buffer::workAreaManager() const
707 Text & Buffer::text() const
709 return d->inset->text();
713 Inset & Buffer::inset() const
719 BufferParams & Buffer::params()
725 BufferParams const & Buffer::params() const
731 BufferParams const & Buffer::masterParams() const
733 if (masterBuffer() == this)
736 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
737 // Copy child authors to the params. We need those pointers.
738 for (Author const & a : params().authors())
739 mparams.authors().record(a);
744 double Buffer::fontScalingFactor() const
746 return isExporting() ? 75.0 * params().html_math_img_scale
747 : 0.01 * lyxrc.dpi * lyxrc.currentZoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
751 ParagraphList & Buffer::paragraphs()
753 return text().paragraphs();
757 ParagraphList const & Buffer::paragraphs() const
759 return text().paragraphs();
763 LyXVC & Buffer::lyxvc()
769 LyXVC const & Buffer::lyxvc() const
775 string const Buffer::temppath() const
777 return d->temppath.absFileName();
781 TexRow & Buffer::texrow()
787 TexRow const & Buffer::texrow() const
793 TocBackend & Buffer::tocBackend() const
795 return d->toc_backend;
799 Undo & Buffer::undo()
805 void Buffer::setChild(DocIterator const & dit, Buffer * child)
807 d->children_positions[child] = dit;
811 string Buffer::latexName(bool const no_path) const
813 FileName latex_name =
814 makeLatexName(d->exportFileName());
815 return no_path ? latex_name.onlyFileName()
816 : latex_name.absFileName();
820 FileName Buffer::Impl::exportFileName() const
822 docstring const branch_suffix =
823 params.branchlist().getFileNameSuffix();
824 if (branch_suffix.empty())
827 string const name = addExtension(filename.onlyFileNameWithoutExt()
828 + to_utf8(branch_suffix), filename.extension());
829 FileName res(filename.onlyPath().absFileName() + "/" + name);
835 string Buffer::logName(LogType * type) const
837 string const filename = latexName(false);
839 if (filename.empty()) {
845 string const path = temppath();
847 FileName const fname(addName(temppath(),
848 onlyFileName(changeExtension(filename,
851 // FIXME: how do we know this is the name of the build log?
852 FileName const bname(
853 addName(path, onlyFileName(
854 changeExtension(filename,
855 theFormats().extension(params().bufferFormat()) + ".out"))));
857 // Also consider the master buffer log file
858 FileName masterfname = fname;
859 LogType mtype = latexlog;
860 if (masterBuffer() != this) {
861 string const mlogfile = masterBuffer()->logName(&mtype);
862 masterfname = FileName(mlogfile);
865 // If no Latex log or Build log is newer, show Build log
866 if (bname.exists() &&
867 ((!fname.exists() && !masterfname.exists())
868 || (fname.lastModified() < bname.lastModified()
869 && masterfname.lastModified() < bname.lastModified()))) {
870 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
873 return bname.absFileName();
874 // If we have a newer master file log or only a master log, show this
875 } else if (fname != masterfname
876 && (!fname.exists() && (masterfname.exists()
877 || fname.lastModified() < masterfname.lastModified()))) {
878 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
881 return masterfname.absFileName();
883 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
886 return fname.absFileName();
890 void Buffer::setReadonly(bool const flag)
892 if (d->read_only != flag) {
899 void Buffer::setFileName(FileName const & fname)
901 bool const changed = fname != d->filename;
903 d->refreshFileMonitor();
905 lyxvc().file_found_hook(fname);
906 setReadonly(d->filename.isReadOnly());
912 int Buffer::readHeader(Lexer & lex)
914 int unknown_tokens = 0;
916 int begin_header_line = -1;
918 // Initialize parameters that may be/go lacking in header:
919 params().branchlist().clear();
920 params().preamble.erase();
921 params().options.erase();
922 params().master.erase();
923 params().float_placement.erase();
924 params().float_alignment.erase();
925 params().paperwidth.erase();
926 params().paperheight.erase();
927 params().leftmargin.erase();
928 params().rightmargin.erase();
929 params().topmargin.erase();
930 params().bottommargin.erase();
931 params().headheight.erase();
932 params().headsep.erase();
933 params().footskip.erase();
934 params().columnsep.erase();
935 params().font_roman_opts.erase();
936 params().font_sans_opts.erase();
937 params().font_typewriter_opts.erase();
938 params().fonts_cjk.erase();
939 params().listings_params.clear();
940 params().clearLayoutModules();
941 params().clearRemovedModules();
942 params().clearIncludedChildren();
943 params().pdfoptions().clear();
944 params().indiceslist().clear();
945 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
946 params().isbackgroundcolor = false;
947 params().fontcolor = RGBColor(0, 0, 0);
948 params().isfontcolor = false;
949 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
950 params().isnotefontcolor = false;
951 params().boxbgcolor = RGBColor(0xFF, 0, 0);
952 params().isboxbgcolor = false;
953 params().html_latex_start.clear();
954 params().html_latex_end.clear();
955 params().html_math_img_scale = 1.0;
956 params().output_sync_macro.erase();
957 params().setLocalLayout(docstring(), false);
958 params().setLocalLayout(docstring(), true);
959 params().biblio_opts.erase();
960 params().biblatex_bibstyle.erase();
961 params().biblatex_citestyle.erase();
962 params().multibib.erase();
963 params().lineno_opts.clear();
964 params().spellignore().clear();
966 for (int i = 0; i < 4; ++i) {
967 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
968 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
971 ErrorList & errorList = d->errorLists["Parse"];
980 if (token == "\\end_header")
984 if (token == "\\begin_header") {
985 begin_header_line = line;
989 LYXERR(Debug::PARSER, "Handling document header token: `"
992 string const result =
993 params().readToken(lex, token, d->filename);
994 if (!result.empty()) {
995 if (token == "\\textclass") {
996 d->layout_position = result;
999 docstring const s = bformat(_("Unknown token: "
1002 lex.getDocString());
1003 errorList.push_back(ErrorItem(_("Document header error"), s));
1007 if (begin_header_line) {
1008 docstring const s = _("\\begin_header is missing");
1009 errorList.push_back(ErrorItem(_("Document header error"), s));
1012 params().shell_escape = theSession().shellescapeFiles().find(absFileName());
1014 params().makeDocumentClass(isClone(), isInternal());
1016 return unknown_tokens;
1021 // changed to be public and have one parameter
1022 // Returns true if "\end_document" is not read (Asger)
1023 bool Buffer::readDocument(Lexer & lex)
1025 ErrorList & errorList = d->errorLists["Parse"];
1028 // remove dummy empty par
1029 paragraphs().clear();
1031 if (!lex.checkFor("\\begin_document")) {
1032 docstring const s = _("\\begin_document is missing");
1033 errorList.push_back(ErrorItem(_("Document header error"), s));
1038 if (params().output_changes) {
1039 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1040 LaTeXFeatures::isAvailable("xcolor");
1043 Alert::warning(_("Changes not shown in LaTeX output"),
1044 _("Changes will not be highlighted in LaTeX output, "
1045 "because xcolor and ulem are not installed.\n"
1046 "Please install both packages or redefine "
1047 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1051 if (!parent() && !params().master.empty()) {
1052 FileName const master_file = makeAbsPath(params().master,
1053 onlyPath(absFileName()));
1054 if (isLyXFileName(master_file.absFileName())) {
1056 checkAndLoadLyXFile(master_file, true);
1058 // necessary e.g. after a reload
1059 // to re-register the child (bug 5873)
1060 // FIXME: clean up updateMacros (here, only
1061 // child registering is needed).
1062 master->updateMacros();
1063 // set master as master buffer, but only
1064 // if we are a real child
1065 if (master->isChild(this))
1067 // if the master is not fully loaded
1068 // it is probably just loading this
1069 // child. No warning needed then.
1070 else if (master->isFullyLoaded())
1071 LYXERR0("The master '"
1073 << "' assigned to this document ("
1075 << ") does not include "
1076 "this document. Ignoring the master assignment.");
1077 // If the master has just been created, un-hide it (#11162)
1078 if (!master->fileName().exists())
1079 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
1080 master->absFileName()));
1085 // assure we have a default index
1086 params().indiceslist().addDefault(B_("Index"));
1089 if (FileName::isAbsolute(params().origin))
1090 d->old_position = params().origin;
1092 d->old_position = filePath();
1097 bool const res = text().read(lex, errorList, d->inset);
1098 d->old_position.clear();
1100 // inform parent buffer about local macros
1102 Buffer const * pbuf = parent();
1103 for (auto const & m : usermacros)
1104 pbuf->usermacros.insert(m);
1108 updateMacroInstances(InternalUpdate);
1113 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1115 Format const * fmt = theFormats().getFormat(format);
1118 // It is important to use the correct extension here, since some
1119 // converters create a wrong output file otherwise (e.g. html2latex)
1120 FileName const name = tempFileName("Buffer_importStringXXXXXX." + fmt->extension());
1121 ofdocstream os(name.toFilesystemEncoding().c_str());
1122 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1123 bool const success = !(os << contents).fail();
1126 bool converted = false;
1128 params().compressed = false;
1130 // remove dummy empty par
1131 paragraphs().clear();
1133 converted = importFile(format, name, errorList);
1136 removeTempFile(name);
1141 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1143 if (!theConverters().isReachable(format, "lyx"))
1146 FileName const lyx = tempFileName("Buffer_importFileXXXXXX.lyx");
1147 Converters::RetVal const retval =
1148 theConverters().convert(nullptr, name, lyx, name, format, "lyx", errorList);
1149 if (retval == Converters::SUCCESS) {
1150 bool const success = readFile(lyx) == ReadSuccess;
1151 removeTempFile(lyx);
1159 bool Buffer::readString(string const & s)
1161 params().compressed = false;
1164 istringstream is(s);
1166 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1167 FileName const fn = tempfile.name();
1170 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1172 if (success && file_format != LYX_FORMAT) {
1173 // We need to call lyx2lyx, so write the input to a file
1174 ofstream os(fn.toFilesystemEncoding().c_str());
1177 // lyxvc in readFile
1178 if (readFile(fn) != ReadSuccess)
1182 if (readDocument(lex))
1188 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1191 if (!lex.setFile(fn)) {
1192 Alert::error(_("File Not Found"),
1193 bformat(_("Unable to open file `%1$s'."),
1194 from_utf8(fn.absFileName())));
1195 return ReadFileNotFound;
1199 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1200 if (ret_plf != ReadSuccess)
1203 if (file_format != LYX_FORMAT) {
1205 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1206 if (ret_clf != ReadSuccess)
1208 ret_clf = readFile(tmpFile);
1209 if (ret_clf == ReadSuccess) {
1210 d->file_format = file_format;
1211 d->need_format_backup = true;
1216 // FIXME: InsetInfo needs to know whether the file is under VCS
1217 // during the parse process, so this has to be done before.
1218 lyxvc().file_found_hook(d->filename);
1220 if (readDocument(lex)) {
1221 Alert::error(_("Document format failure"),
1222 bformat(_("%1$s ended unexpectedly, which means"
1223 " that it is probably corrupted."),
1224 from_utf8(fn.absFileName())));
1225 return ReadDocumentFailure;
1228 d->file_fully_loaded = true;
1229 d->read_only = !d->filename.isWritable();
1230 params().compressed = theFormats().isZippedFile(d->filename);
1236 bool Buffer::isFullyLoaded() const
1238 return d->file_fully_loaded;
1242 void Buffer::setFullyLoaded(bool value)
1244 d->file_fully_loaded = value;
1248 bool Buffer::freshStartRequired() const
1250 return d->require_fresh_start_;
1253 void Buffer::requireFreshStart(bool const b) const
1255 d->require_fresh_start_ = b;
1259 PreviewLoader * Buffer::loader() const
1261 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1263 if (!d->preview_loader_)
1264 d->preview_loader_ = new PreviewLoader(*this);
1265 return d->preview_loader_;
1269 void Buffer::removePreviews() const
1271 delete d->preview_loader_;
1272 d->preview_loader_ = nullptr;
1276 void Buffer::updatePreviews() const
1278 PreviewLoader * ploader = loader();
1282 InsetIterator it = begin(*d->inset);
1283 InsetIterator const itend = end(*d->inset);
1284 for (; it != itend; ++it)
1285 it->addPreview(it, *ploader);
1287 ploader->startLoading();
1291 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1292 FileName const & fn, int & file_format) const
1294 if(!lex.checkFor("\\lyxformat")) {
1295 Alert::error(_("Document format failure"),
1296 bformat(_("%1$s is not a readable LyX document."),
1297 from_utf8(fn.absFileName())));
1298 return ReadNoLyXFormat;
1304 // LyX formats 217 and earlier were written as 2.17. This corresponds
1305 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1306 // these cases. See also: www.lyx.org/trac/changeset/1313.
1307 size_t dot = tmp_format.find_first_of(".,");
1308 if (dot != string::npos)
1309 tmp_format.erase(dot, 1);
1311 file_format = convert<int>(tmp_format);
1316 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1317 FileName & tmpfile, int from_format)
1319 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1320 tempfile.setAutoRemove(false);
1321 tmpfile = tempfile.name();
1322 if(tmpfile.empty()) {
1323 Alert::error(_("Conversion failed"),
1324 bformat(_("%1$s is from a different"
1325 " version of LyX, but a temporary"
1326 " file for converting it could"
1327 " not be created."),
1328 from_utf8(fn.absFileName())));
1329 return LyX2LyXNoTempFile;
1332 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1333 if (lyx2lyx.empty()) {
1334 Alert::error(_("Conversion script not found"),
1335 bformat(_("%1$s is from a different"
1336 " version of LyX, but the"
1337 " conversion script lyx2lyx"
1338 " could not be found."),
1339 from_utf8(fn.absFileName())));
1340 return LyX2LyXNotFound;
1344 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1345 ostringstream command;
1346 command << os::python()
1347 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1348 << " -t " << convert<string>(LYX_FORMAT)
1349 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1350 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1351 string const command_str = command.str();
1353 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1355 cmd_ret const ret = runCommand(command_str);
1357 if (from_format < LYX_FORMAT) {
1358 Alert::error(_("Conversion script failed"),
1359 bformat(_("%1$s is from an older version"
1360 " of LyX and the lyx2lyx script"
1361 " failed to convert it."),
1362 from_utf8(fn.absFileName())));
1363 return LyX2LyXOlderFormat;
1365 Alert::error(_("Conversion script failed"),
1366 bformat(_("%1$s is from a newer version"
1367 " of LyX and the lyx2lyx script"
1368 " failed to convert it."),
1369 from_utf8(fn.absFileName())));
1370 return LyX2LyXNewerFormat;
1377 FileName Buffer::getBackupName() const {
1378 map<int, string> const file_formats = {
1395 FileName const & fn = fileName();
1396 string const fname = fn.onlyFileNameWithoutExt();
1397 string const fext = fn.extension() + "~";
1398 string const fpath = lyxrc.backupdir_path.empty() ?
1399 fn.onlyPath().absFileName() :
1400 lyxrc.backupdir_path;
1401 string backup_suffix;
1402 // If file format is from a stable series use version instead of file format
1403 auto const it = file_formats.find(d->file_format);
1404 if (it != file_formats.end())
1405 backup_suffix = "-lyx" + it->second;
1407 backup_suffix = "-lyxformat-" + convert<string>(d->file_format);
1408 string const backname = fname + backup_suffix;
1409 FileName backup(addName(fpath, addExtension(backname, fext)));
1411 // limit recursion, just in case
1413 unsigned long orig_checksum = 0;
1414 while (backup.exists() && v < 100) {
1415 if (orig_checksum == 0)
1416 orig_checksum = fn.checksum();
1417 unsigned long new_checksum = backup.checksum();
1418 if (orig_checksum == new_checksum) {
1419 LYXERR(Debug::FILES, "Not backing up " << fn <<
1420 "since " << backup << "has the same checksum.");
1421 // a bit of a hack, but we have to check this anyway
1422 // below, and setting this is simpler than introducing
1423 // a special boolean for this purpose.
1427 string const newbackname = backname + "-" + convert<string>(v);
1428 backup.set(addName(fpath, addExtension(newbackname, fext)));
1431 return v < 100 ? backup : FileName();
1435 // Should probably be moved to somewhere else: BufferView? GuiView?
1436 bool Buffer::save() const
1438 docstring const file = makeDisplayPath(absFileName(), 20);
1439 d->filename.refresh();
1441 // check the read-only status before moving the file as a backup
1442 if (d->filename.exists()) {
1443 bool const read_only = !d->filename.isWritable();
1445 Alert::warning(_("File is read-only"),
1446 bformat(_("The file %1$s cannot be written because it "
1447 "is marked as read-only."), file));
1452 // ask if the disk file has been externally modified (use checksum method)
1453 if (fileName().exists() && isChecksumModified()) {
1455 bformat(_("Document %1$s has been externally modified. "
1456 "Are you sure you want to overwrite this file?"), file);
1457 int const ret = Alert::prompt(_("Overwrite modified file?"),
1458 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1463 // We don't need autosaves in the immediate future. (Asger)
1464 resetAutosaveTimers();
1466 // if the file does not yet exist, none of the backup activity
1467 // that follows is necessary
1468 if (!fileName().exists()) {
1469 if (!writeFile(fileName()))
1475 // we first write the file to a new name, then move it to its
1476 // proper location once that has been done successfully. that
1477 // way we preserve the original file if something goes wrong.
1478 string const justname = fileName().onlyFileNameWithoutExt();
1479 auto tempfile = lyx::make_unique<TempFile>(fileName().onlyPath(),
1480 justname + "-XXXXXX.lyx");
1481 bool const symlink = fileName().isSymLink();
1483 tempfile->setAutoRemove(false);
1485 FileName savefile(tempfile->name());
1486 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1487 if (!savefile.clonePermissions(fileName()))
1488 LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
1490 if (!writeFile(savefile))
1493 // we will set this to false if we fail
1494 bool made_backup = true;
1496 FileName backupName;
1497 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1499 if (d->need_format_backup)
1500 backupName = getBackupName();
1502 // If we for some reason failed to find a backup name in case of
1503 // a format change, this will still set one. It's the best we can
1505 if (backupName.empty()) {
1506 backupName.set(fileName().absFileName() + "~");
1507 if (!lyxrc.backupdir_path.empty()) {
1508 string const mangledName =
1509 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1510 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1514 LYXERR(Debug::FILES, "Backing up original file to " <<
1515 backupName.absFileName());
1516 // Except file is symlink do not copy because of #6587.
1517 // Hard links have bad luck.
1518 made_backup = symlink ?
1519 fileName().copyTo(backupName):
1520 fileName().moveTo(backupName);
1523 Alert::error(_("Backup failure"),
1524 bformat(_("Cannot create backup file %1$s.\n"
1525 "Please check whether the directory exists and is writable."),
1526 from_utf8(backupName.absFileName())));
1527 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1528 } else if (d->need_format_backup) {
1529 // the original file has been backed up successfully, so we
1530 // will not need to do that again
1531 d->need_format_backup = false;
1535 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1536 // Only do this if tempfile is not in autoremove mode
1539 // If we have no symlink, we can simply rename the temp file.
1540 // Otherwise, we need to copy it so the symlink stays intact.
1541 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1542 savefile.moveTo(fileName()))
1544 // saveCheckSum() was already called by writeFile(), but the
1545 // time stamp is invalidated by copying/moving
1548 // the file associated with this buffer is now in the current format
1549 d->file_format = LYX_FORMAT;
1552 // else we saved the file, but failed to move it to the right location.
1554 if (needBackup && made_backup && !symlink) {
1555 // the original file was moved to some new location, so it will look
1556 // to the user as if it was deleted. (see bug #9234.) we could try
1557 // to restore it, but that would basically mean trying to do again
1558 // what we just failed to do. better to leave things as they are.
1559 Alert::error(_("Write failure"),
1560 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1561 "But LyX could not move it to:\n %2$s.\n"
1562 "Your original file has been backed up to:\n %3$s"),
1563 from_utf8(savefile.absFileName()),
1564 from_utf8(fileName().absFileName()),
1565 from_utf8(backupName.absFileName())));
1567 // either we did not try to make a backup, or else we tried and failed,
1568 // or else the original file was a symlink, in which case it was copied,
1569 // not moved. so the original file is intact.
1570 Alert::error(_("Write failure"),
1571 bformat(_("Cannot move saved file to:\n %1$s.\n"
1572 "But the file has successfully been saved as:\n %2$s."),
1573 from_utf8(fileName().absFileName()),
1574 from_utf8(savefile.absFileName())));
1580 bool Buffer::writeFile(FileName const & fname) const
1582 if (d->read_only && fname == d->filename)
1585 bool retval = false;
1587 docstring const str = bformat(_("Saving document %1$s..."),
1588 makeDisplayPath(fname.absFileName()));
1591 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1593 if (params().compressed) {
1594 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1595 retval = ofs && write(ofs);
1597 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1598 retval = ofs && write(ofs);
1602 message(str + _(" could not write file!"));
1607 // removeAutosaveFile();
1610 message(str + _(" done."));
1616 docstring Buffer::emergencyWrite() const
1618 // No need to save if the buffer has not changed.
1622 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1624 docstring user_message = bformat(
1625 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1627 // We try to save three places:
1628 // 1) Same place as document. Unless it is an unnamed doc.
1630 string s = absFileName();
1633 if (writeFile(FileName(s))) {
1635 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1636 return user_message;
1638 user_message += " " + _("Save failed! Trying again...\n");
1642 // 2) In HOME directory.
1643 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1645 lyxerr << ' ' << s << endl;
1646 if (writeFile(FileName(s))) {
1648 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1649 return user_message;
1652 user_message += " " + _("Save failed! Trying yet again...\n");
1654 // 3) In "/tmp" directory.
1655 // MakeAbsPath to prepend the current
1656 // drive letter on OS/2
1657 s = addName(package().temp_dir().absFileName(), absFileName());
1659 lyxerr << ' ' << s << endl;
1660 if (writeFile(FileName(s))) {
1662 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1663 return user_message;
1666 user_message += " " + _("Save failed! Document is lost.");
1669 return user_message;
1673 bool Buffer::write(ostream & ofs) const
1676 // Use the standard "C" locale for file output.
1677 ofs.imbue(locale::classic());
1680 // The top of the file should not be written by params().
1682 // write out a comment in the top of the file
1683 // Important: Keep the version formatting in sync with lyx2lyx and
1684 // tex2lyx (bug 7951)
1685 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1686 << " created this file. For more info see https://www.lyx.org/\n"
1687 << "\\lyxformat " << LYX_FORMAT << "\n"
1688 << "\\begin_document\n";
1690 /// For each author, set 'used' to true if there is a change
1691 /// by this author in the document; otherwise set it to 'false'.
1692 for (Author const & a : params().authors())
1695 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1696 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1697 for ( ; it != end; ++it)
1698 it->checkAuthors(params().authors());
1700 // now write out the buffer parameters.
1701 ofs << "\\begin_header\n";
1702 params().writeFile(ofs, this);
1703 ofs << "\\end_header\n";
1706 ofs << "\n\\begin_body\n";
1708 ofs << "\n\\end_body\n";
1710 // Write marker that shows file is complete
1711 ofs << "\\end_document" << endl;
1713 // Shouldn't really be needed....
1716 // how to check if close went ok?
1717 // Following is an attempt... (BE 20001011)
1719 // good() returns false if any error occurred, including some
1720 // formatting error.
1721 // bad() returns true if something bad happened in the buffer,
1722 // which should include file system full errors.
1727 lyxerr << "File was not closed properly." << endl;
1734 Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
1735 string const & original_path,
1736 OutputParams const & runparams_in,
1737 OutputWhat output) const
1739 OutputParams runparams = runparams_in;
1741 string const encoding = runparams.encoding->iconvName();
1742 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1745 try { ofs.reset(encoding); }
1746 catch (iconv_codecvt_facet_exception const & e) {
1747 lyxerr << "Caught iconv exception: " << e.what() << endl;
1748 Alert::error(_("Iconv software exception Detected"),
1749 bformat(_("Please verify that the `iconv' support software is"
1750 " properly installed and supports the selected encoding"
1751 " (%1$s), or change the encoding in"
1752 " Document>Settings>Language."), from_ascii(encoding)));
1755 if (!openFileWrite(ofs, fname))
1758 ErrorList & errorList = d->errorLists["Export"];
1760 ExportStatus status = ExportSuccess;
1763 // make sure we are ready to export
1764 // this needs to be done before we validate
1765 // FIXME Do we need to do this all the time? I.e., in children
1766 // of a master we are exporting?
1768 updateMacroInstances(OutputUpdate);
1770 ExportStatus retval;
1772 retval = writeLaTeXSource(os, original_path, runparams, output);
1773 if (retval == ExportKilled)
1774 return ExportKilled;
1776 catch (EncodingException const & e) {
1777 docstring const failed(1, e.failed_char);
1779 oss << "0x" << hex << static_cast<uint32_t>(e.failed_char) << dec;
1780 if (getParFromID(e.par_id).paragraph().layout().pass_thru) {
1781 docstring msg = bformat(_("Uncodable character '%1$s'"
1782 " (code point %2$s)"),
1783 failed, from_utf8(oss.str()));
1784 errorList.push_back(ErrorItem(msg, _("Some characters of your document are not "
1785 "representable in specific verbatim contexts.\n"
1786 "Changing the document encoding to utf8 could help."),
1787 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1789 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1790 " (code point %2$s)"),
1791 failed, from_utf8(oss.str()));
1792 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1793 "representable in the chosen encoding.\n"
1794 "Changing the document encoding to utf8 could help."),
1795 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1797 status = ExportError;
1799 catch (iconv_codecvt_facet_exception const & e) {
1800 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1802 status = ExportError;
1804 catch (exception const & e) {
1805 errorList.push_back(ErrorItem(_("conversion failed"),
1807 lyxerr << e.what() << endl;
1808 status = ExportError;
1811 lyxerr << "Caught some really weird exception..." << endl;
1815 d->texrow = move(os.texrow());
1819 status = ExportError;
1820 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1823 if (runparams_in.silent)
1831 Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
1832 string const & original_path,
1833 OutputParams const & runparams_in,
1834 OutputWhat output) const
1836 // The child documents, if any, shall be already loaded at this point.
1838 OutputParams runparams = runparams_in;
1840 // Some macros rely on font encoding
1841 runparams.main_fontenc = params().main_font_encoding();
1843 // If we are compiling a file standalone, even if this is the
1844 // child of some other buffer, let's cut the link here, so the
1845 // file is really independent and no concurring settings from
1846 // the master (e.g. branch state) interfere (see #8100).
1847 if (!runparams.is_child)
1848 d->ignore_parent = true;
1850 // Classify the unicode characters appearing in math insets
1851 BufferEncodings::initUnicodeMath(*this);
1853 // validate the buffer.
1854 LYXERR(Debug::LATEX, " Validating buffer...");
1855 LaTeXFeatures features(*this, params(), runparams);
1857 // This is only set once per document (in master)
1858 if (!runparams.is_child) {
1859 runparams.use_polyglossia = features.usePolyglossia();
1860 runparams.use_hyperref = features.isRequired("hyperref");
1861 runparams.use_CJK = features.mustProvide("CJK");
1863 LYXERR(Debug::LATEX, " Buffer validation done.");
1865 bool const output_preamble =
1866 output == FullSource || output == OnlyPreamble;
1867 bool const output_body =
1868 output == FullSource || output == OnlyBody;
1870 // The starting paragraph of the coming rows is the
1871 // first paragraph of the document. (Asger)
1872 if (output_preamble && runparams.nice) {
1873 os << "%% LyX " << lyx_version << " created this file. "
1874 "For more info, see https://www.lyx.org/.\n"
1875 "%% Do not edit unless you really know what "
1878 LYXERR(Debug::INFO, "lyx document header finished");
1880 // There are a few differences between nice LaTeX and usual files:
1881 // usual files have \batchmode and special input@path to allow
1882 // inclusion of figures specified by an explicitly relative path
1883 // (i.e., a path starting with './' or '../') with either \input or
1884 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1885 // input@path is set when the actual parameter original_path is set.
1886 // This is done for usual tex-file, but not for nice-latex-file.
1887 // (Matthias 250696)
1888 // Note that input@path is only needed for something the user does
1889 // in the preamble, included .tex files or ERT, files included by
1890 // LyX work without it.
1891 if (output_preamble) {
1892 if (!runparams.nice) {
1893 // code for usual, NOT nice-latex-file
1894 os << "\\batchmode\n"; // changed from \nonstopmode
1896 if (!original_path.empty()) {
1898 // We don't know the encoding of inputpath
1899 docstring const inputpath = from_utf8(original_path);
1900 docstring uncodable_glyphs;
1901 Encoding const * const enc = runparams.encoding;
1903 for (char_type n : inputpath) {
1904 if (!enc->encodable(n)) {
1905 docstring const glyph(1, n);
1906 LYXERR0("Uncodable character '"
1908 << "' in input path!");
1909 uncodable_glyphs += glyph;
1914 // warn user if we found uncodable glyphs.
1915 if (!uncodable_glyphs.empty()) {
1916 frontend::Alert::warning(
1917 _("Uncodable character in file path"),
1919 _("The path of your document\n"
1921 "contains glyphs that are unknown "
1922 "in the current document encoding "
1923 "(namely %2$s). This may result in "
1924 "incomplete output, unless "
1925 "TEXINPUTS contains the document "
1926 "directory and you don't use "
1927 "explicitly relative paths (i.e., "
1928 "paths starting with './' or "
1929 "'../') in the preamble or in ERT."
1930 "\n\nIn case of problems, choose "
1931 "an appropriate document encoding\n"
1932 "(such as utf8) or change the "
1934 inputpath, uncodable_glyphs));
1936 string docdir = os::latex_path(original_path);
1937 if (contains(docdir, '#')) {
1938 docdir = subst(docdir, "#", "\\#");
1939 os << "\\catcode`\\#=11"
1940 "\\def\\#{#}\\catcode`\\#=6\n";
1942 if (contains(docdir, '%')) {
1943 docdir = subst(docdir, "%", "\\%");
1944 os << "\\catcode`\\%=11"
1945 "\\def\\%{%}\\catcode`\\%=14\n";
1947 if (contains(docdir, '~'))
1948 docdir = subst(docdir, "~", "\\string~");
1949 bool const nonascii = !isAscii(from_utf8(docdir));
1950 // LaTeX 2019/10/01 handles non-ascii path without detokenize
1951 bool const utfpathlatex = features.isAvailable("LaTeX-2019/10/01");
1952 bool const detokenize = !utfpathlatex && nonascii;
1953 bool const quote = contains(docdir, ' ');
1954 if (utfpathlatex && nonascii)
1955 os << "\\UseRawInputEncoding\n";
1956 os << "\\makeatletter\n"
1957 << "\\def\\input@path{{";
1959 os << "\\detokenize{";
1968 << "\\makeatother\n";
1972 // get parent macros (if this buffer has a parent) which will be
1973 // written at the document begin further down.
1974 MacroSet parentMacros;
1975 listParentMacros(parentMacros, features);
1977 // Write the preamble
1978 runparams.use_babel = params().writeLaTeX(os, features,
1979 d->filename.onlyPath());
1981 // Active characters
1982 runparams.active_chars = features.getActiveChars();
1984 // Biblatex bibliographies are loaded here
1985 if (params().useBiblatex()) {
1986 vector<pair<docstring, string>> const bibfiles =
1987 prepareBibFilePaths(runparams, getBibfiles(), true);
1988 for (pair<docstring, string> const & file: bibfiles) {
1989 os << "\\addbibresource";
1990 if (!file.second.empty())
1991 os << "[bibencoding=" << file.second << "]";
1992 os << "{" << file.first << "}\n";
1996 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1997 && !features.hasOnlyPolyglossiaLanguages()) {
2000 vector<string> bll = features.getBabelExclusiveLanguages();
2001 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
2004 for (string const & sit : bll) {
2009 blangs = bll.size() > 1 ?
2010 bformat(_("The languages %1$s are only supported by Babel."), langs)
2011 : bformat(_("The language %1$s is only supported by Babel."), langs);
2015 for (string const & pit : pll) {
2020 plangs = pll.size() > 1 ?
2021 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
2022 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
2023 if (!blangs.empty())
2027 frontend::Alert::warning(
2028 _("Incompatible Languages!"),
2030 _("You cannot use the following languages "
2031 "together in one LaTeX document because "
2032 "they require conflicting language packages:\n"
2037 // Japanese might be required only in some children of a document,
2038 // but once required, we must keep use_japanese true.
2039 runparams.use_japanese |= features.isRequired("japanese");
2042 // Restore the parenthood if needed
2043 if (!runparams.is_child)
2044 d->ignore_parent = false;
2045 return ExportSuccess;
2049 // mark the beginning of the body to separate it from InPreamble insets
2050 os.texrow().start(TexRow::beginDocument());
2051 os << "\\begin{document}\n";
2053 // mark the start of a new paragraph by simulating a newline,
2054 // so that os.afterParbreak() returns true at document start
2057 // output the parent macros
2058 for (auto const & mac : parentMacros) {
2059 int num_lines = mac->write(os.os(), true);
2060 os.texrow().newlines(num_lines);
2063 } // output_preamble
2065 LYXERR(Debug::INFO, "preamble finished, now the body.");
2069 latexParagraphs(*this, text(), os, runparams);
2071 catch (ConversionException const &) { return ExportKilled; }
2073 // Restore the parenthood if needed
2074 if (!runparams.is_child)
2075 d->ignore_parent = false;
2077 // add this just in case after all the paragraphs
2080 if (output_preamble) {
2081 os << "\\end{document}\n";
2082 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
2084 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
2086 runparams_in.encoding = runparams.encoding;
2088 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2089 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2090 return ExportSuccess;
2094 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2095 OutputParams const & runparams,
2096 OutputWhat output) const
2098 LYXERR(Debug::LATEX, "makeDocBookFile...");
2101 if (!openFileWrite(ofs, fname))
2104 // make sure we are ready to export
2105 // this needs to be done before we validate
2107 updateMacroInstances(OutputUpdate);
2109 ExportStatus const retval =
2110 writeDocBookSource(ofs, runparams, output);
2111 if (retval == ExportKilled)
2112 return ExportKilled;
2116 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2117 return ExportSuccess;
2121 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os,
2122 OutputParams const & runparams,
2123 OutputWhat output) const
2125 LaTeXFeatures features(*this, params(), runparams);
2127 d->bibinfo_.makeCitationLabels(*this);
2131 DocumentClass const & tclass = params().documentClass();
2133 bool const output_preamble =
2134 output == FullSource || output == OnlyPreamble;
2135 bool const output_body =
2136 output == FullSource || output == OnlyBody || output == IncludedFile;
2138 if (output_preamble) {
2139 // XML preamble, no doctype needed.
2140 // Not using XMLStream for this, as the root tag would be in the tag stack and make troubles with the error
2141 // detection mechanisms (these are called before the end tag is output, and thus interact with the canary
2142 // parsep in output_docbook.cpp).
2143 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2144 << "<!-- This DocBook file was created by LyX " << lyx_version
2145 << "\n See https://www.lyx.org/ for more information -->\n";
2147 // Directly output the root tag, based on the current type of document.
2148 string languageCode = params().language->code();
2149 string params = "xml:lang=\"" + languageCode + '"'
2150 + " xmlns=\"http://docbook.org/ns/docbook\""
2151 + " xmlns:xlink=\"http://www.w3.org/1999/xlink\""
2152 + " xmlns:m=\"http://www.w3.org/1998/Math/MathML\""
2153 + " xmlns:xi=\"http://www.w3.org/2001/XInclude\""
2154 + " version=\"5.2\"";
2156 os << "<" << from_ascii(tclass.docbookroot()) << " " << from_ascii(params) << ">\n";
2160 // Start to output the document.
2162 docbookParagraphs(text(), *this, xs, runparams);
2165 if (output_preamble) {
2166 // Close the root element. No need for a line break, as free text is never allowed
2167 // in a root element, it must always be wrapped in some container.
2168 os << "</" << from_ascii(tclass.docbookroot()) << ">";
2171 return ExportSuccess;
2175 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2176 OutputParams const & runparams) const
2178 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2181 if (!openFileWrite(ofs, fname))
2184 // make sure we are ready to export
2185 // this has to be done before we validate
2186 updateBuffer(UpdateMaster, OutputUpdate);
2187 updateMacroInstances(OutputUpdate);
2189 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2190 if (retval == ExportKilled)
2195 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2200 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2201 OutputParams const & runparams,
2202 OutputWhat output) const
2204 LaTeXFeatures features(*this, params(), runparams);
2206 d->bibinfo_.makeCitationLabels(*this);
2208 bool const output_preamble =
2209 output == FullSource || output == OnlyPreamble;
2210 bool const output_body =
2211 output == FullSource || output == OnlyBody || output == IncludedFile;
2213 if (output_preamble) {
2214 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2215 << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN\" \"http://www.w3.org/Math/DTD/mathml2/xhtml-math11-f.dtd\">\n"
2216 // FIXME Language should be set properly.
2217 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2219 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2220 // FIXME Presumably need to set this right
2221 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2223 docstring const & doctitle = features.htmlTitle();
2225 << (doctitle.empty() ?
2226 from_ascii("LyX Document") :
2227 xml::escapeString(doctitle, XMLStream::ESCAPE_ALL))
2230 docstring styles = features.getTClassHTMLPreamble();
2231 if (!styles.empty())
2232 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2234 // we will collect CSS information in a stream, and then output it
2235 // either here, as part of the header, or else in a separate file.
2236 odocstringstream css;
2237 styles = features.getCSSSnippets();
2238 if (!styles.empty())
2239 css << "/* LyX Provided Styles */\n" << styles << '\n';
2241 styles = features.getTClassHTMLStyles();
2242 if (!styles.empty())
2243 css << "/* Layout-provided Styles */\n" << styles << '\n';
2245 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2246 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2247 if (needfg || needbg) {
2248 css << "\nbody {\n";
2251 << from_ascii(X11hexname(params().fontcolor))
2254 css << " background-color: "
2255 << from_ascii(X11hexname(params().backgroundcolor))
2260 docstring const dstyles = css.str();
2261 if (!dstyles.empty()) {
2262 bool written = false;
2263 if (params().html_css_as_file) {
2264 // open a file for CSS info
2266 string const fcssname = addName(temppath(), "docstyle.css");
2267 FileName const fcssfile = FileName(fcssname);
2268 if (openFileWrite(ocss, fcssfile)) {
2272 // write link to header
2273 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2275 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2278 // we are here if the CSS is supposed to be written to the header
2279 // or if we failed to write it to an external file.
2281 os << "<style type='text/css'>\n"
2290 bool const output_body_tag = (output != IncludedFile);
2291 if (output_body_tag)
2292 os << "<body dir=\"auto\">\n";
2294 if (output != IncludedFile)
2295 // if we're an included file, the counters are in the master.
2296 params().documentClass().counters().reset();
2298 xhtmlParagraphs(text(), *this, xs, runparams);
2300 catch (ConversionException const &) { return ExportKilled; }
2301 if (output_body_tag)
2305 if (output_preamble)
2308 return ExportSuccess;
2312 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2313 // Other flags: -wall -v0 -x
2314 int Buffer::runChktex()
2318 // get LaTeX-Filename
2319 FileName const path(temppath());
2320 string const name = addName(path.absFileName(), latexName());
2321 string const org_path = filePath();
2323 PathChanger p(path); // path to LaTeX file
2324 message(_("Running chktex..."));
2326 // Generate the LaTeX file if neccessary
2327 OutputParams runparams(¶ms().encoding());
2328 runparams.flavor = Flavor::LaTeX;
2329 runparams.nice = false;
2330 runparams.linelen = lyxrc.plaintext_linelen;
2331 ExportStatus const retval =
2332 makeLaTeXFile(FileName(name), org_path, runparams);
2333 if (retval != ExportSuccess) {
2334 // error code on failure
2339 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2340 int const res = chktex.run(terr); // run chktex
2343 Alert::error(_("chktex failure"),
2344 _("Could not run chktex successfully."));
2346 ErrorList & errlist = d->errorLists["ChkTeX"];
2348 bufferErrors(terr, errlist);
2353 if (runparams.silent)
2354 d->errorLists["ChkTeX"].clear();
2362 void Buffer::validate(LaTeXFeatures & features) const
2364 // Validate the buffer params, but not for included
2365 // files, since they also use the parent buffer's
2367 if (!features.runparams().is_child)
2368 params().validate(features);
2373 for (Paragraph const & p : paragraphs())
2374 p.validate(features);
2376 if (lyxerr.debugging(Debug::LATEX)) {
2377 features.showStruct();
2382 void Buffer::getLabelList(vector<docstring> & list) const
2384 // If this is a child document, use the master's list instead.
2386 masterBuffer()->getLabelList(list);
2391 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2392 for (auto const & tocit : *toc) {
2393 if (tocit.depth() == 0)
2394 list.push_back(tocit.str());
2399 void Buffer::invalidateBibinfoCache() const
2401 d->bibinfo_cache_valid_ = false;
2402 d->cite_labels_valid_ = false;
2403 removeBiblioTempFiles();
2404 // also invalidate the cache for the parent buffer
2405 Buffer const * const pbuf = d->parent();
2407 pbuf->invalidateBibinfoCache();
2411 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2413 // FIXME This is probably unnecessary, given where we call this.
2414 // If this is a child document, use the master instead.
2415 Buffer const * const pbuf = masterBuffer();
2416 if (pbuf != this && scope != UpdateChildOnly)
2417 return pbuf->getBibfiles();
2419 // In 2.3.x, we have:
2420 //if (!d->bibfile_cache_valid_)
2421 // this->updateBibfilesCache(scope);
2422 // I think that is a leftover, but there have been so many back-
2423 // and-forths with this, due to Windows issues, that I am not sure.
2425 return d->bibfiles_cache_;
2429 BiblioInfo const & Buffer::masterBibInfo() const
2431 Buffer const * const tmp = masterBuffer();
2433 return tmp->masterBibInfo();
2438 BiblioInfo const & Buffer::bibInfo() const
2444 void Buffer::registerBibfiles(const docstring_list & bf) const
2446 // We register the bib files in the master buffer,
2447 // if there is one, but also in every single buffer,
2448 // in case a child is compiled alone.
2449 Buffer const * const tmp = masterBuffer();
2451 tmp->registerBibfiles(bf);
2453 for (auto const & p : bf) {
2454 docstring_list::const_iterator temp =
2455 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2456 if (temp == d->bibfiles_cache_.end())
2457 d->bibfiles_cache_.push_back(p);
2462 static map<docstring, FileName> bibfileCache;
2464 FileName Buffer::getBibfilePath(docstring const & bibid) const
2466 map<docstring, FileName>::const_iterator it =
2467 bibfileCache.find(bibid);
2468 if (it != bibfileCache.end()) {
2469 // i.e., return bibfileCache[bibid];
2473 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2474 string const texfile = changeExtension(to_utf8(bibid), "bib");
2475 // we need to check first if this file exists where it's said to be.
2476 // there's a weird bug that occurs otherwise: if the file is in the
2477 // Buffer's directory but has the same name as some file that would be
2478 // found by kpsewhich, then we find the latter, not the former.
2479 FileName const local_file = makeAbsPath(texfile, filePath());
2480 FileName file = local_file;
2481 if (!file.exists()) {
2482 // there's no need now to check whether the file can be found
2484 file = findtexfile(texfile, "bib", true);
2488 LYXERR(Debug::FILES, "Found at: " << file);
2490 bibfileCache[bibid] = file;
2491 return bibfileCache[bibid];
2495 void Buffer::checkIfBibInfoCacheIsValid() const
2497 // use the master's cache
2498 Buffer const * const tmp = masterBuffer();
2500 tmp->checkIfBibInfoCacheIsValid();
2504 // If we already know the cache is invalid, stop here.
2505 // This is important in the case when the bibliography
2506 // environment (rather than Bib[la]TeX) is used.
2507 // In that case, the timestamp check below gives no
2508 // sensible result. Rather than that, the cache will
2509 // be invalidated explicitly via invalidateBibInfoCache()
2510 // by the Bibitem inset.
2511 // Same applies for bib encoding changes, which trigger
2512 // invalidateBibInfoCache() by InsetBibtex.
2513 if (!d->bibinfo_cache_valid_)
2516 if (d->have_bibitems_) {
2517 // We have a bibliography environment.
2518 // Invalidate the bibinfo cache unconditionally.
2519 // Cite labels will get invalidated by the inset if needed.
2520 d->bibinfo_cache_valid_ = false;
2524 // OK. This is with Bib(la)tex. We'll assume the cache
2525 // is valid and change this if we find changes in the bibs.
2526 d->bibinfo_cache_valid_ = true;
2527 d->cite_labels_valid_ = true;
2529 // compare the cached timestamps with the actual ones.
2530 docstring_list const & bibfiles_cache = getBibfiles();
2531 for (auto const & bf : bibfiles_cache) {
2532 FileName const fn = getBibfilePath(bf);
2533 time_t lastw = fn.lastModified();
2534 time_t prevw = d->bibfile_status_[fn];
2535 if (lastw != prevw) {
2536 d->bibinfo_cache_valid_ = false;
2537 d->cite_labels_valid_ = false;
2538 d->bibfile_status_[fn] = lastw;
2544 void Buffer::clearBibFileCache() const
2546 bibfileCache.clear();
2550 void Buffer::reloadBibInfoCache(bool const force) const
2552 // we should not need to do this for internal buffers
2556 // use the master's cache
2557 Buffer const * const tmp = masterBuffer();
2559 tmp->reloadBibInfoCache(force);
2564 checkIfBibInfoCacheIsValid();
2565 if (d->bibinfo_cache_valid_)
2569 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2570 // re-read file locations when this info changes
2571 // FIXME Is this sufficient? Or should we also force that
2572 // in some other cases? If so, then it is easy enough to
2573 // add the following line in some other places.
2574 clearBibFileCache();
2575 d->bibinfo_.clear();
2576 FileNameList checkedFiles;
2577 d->have_bibitems_ = false;
2578 collectBibKeys(checkedFiles);
2579 d->bibinfo_cache_valid_ = true;
2583 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2588 for (InsetIterator it = begin(inset()); it; ++it) {
2589 it->collectBibKeys(it, checkedFiles);
2590 if (it->lyxCode() == BIBITEM_CODE) {
2591 if (parent() != nullptr)
2592 parent()->d->have_bibitems_ = true;
2594 d->have_bibitems_ = true;
2600 void Buffer::addBiblioInfo(BiblioInfo const & bi_in) const
2602 // We add the biblio info to the parent buffer,
2603 // if there is one, but also to this buffer, in case
2604 // it is compiled alone.
2605 BiblioInfo & our_bi = d->bibinfo_;
2606 our_bi.mergeBiblioInfo(bi_in);
2609 parent()->addBiblioInfo(bi_in);
2613 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2615 // We add the bibtex info to the master buffer,
2616 // if there is one, but also to every single buffer,
2617 // in case a child is compiled alone.
2618 BiblioInfo & bi = d->bibinfo_;
2621 if (parent() != nullptr) {
2622 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2623 masterbi[key] = bin;
2628 void Buffer::makeCitationLabels() const
2630 Buffer const * const master = masterBuffer();
2631 return d->bibinfo_.makeCitationLabels(*master);
2635 void Buffer::invalidateCiteLabels() const
2637 masterBuffer()->d->cite_labels_valid_ = false;
2640 bool Buffer::citeLabelsValid() const
2642 return masterBuffer()->d->cite_labels_valid_;
2646 void Buffer::removeBiblioTempFiles() const
2648 // We remove files that contain LaTeX commands specific to the
2649 // particular bibliographic style being used, in order to avoid
2650 // LaTeX errors when we switch style.
2651 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2652 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2653 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2654 aux_file.removeFile();
2655 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2656 bbl_file.removeFile();
2657 // Also for the parent buffer
2658 Buffer const * const pbuf = parent();
2660 pbuf->removeBiblioTempFiles();
2664 bool Buffer::isDepClean(string const & name) const
2666 DepClean::const_iterator const it = d->dep_clean.find(name);
2667 if (it == d->dep_clean.end())
2673 void Buffer::markDepClean(string const & name)
2675 d->dep_clean[name] = true;
2679 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2682 // FIXME? if there is an Buffer LFUN that can be dispatched even
2683 // if internal, put a switch '(cmd.action)' here.
2689 switch (cmd.action()) {
2691 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2692 flag.setOnOff(hasReadonlyFlag());
2695 // FIXME: There is need for a command-line import.
2696 //case LFUN_BUFFER_IMPORT:
2698 case LFUN_BUFFER_AUTO_SAVE:
2701 case LFUN_BUFFER_EXPORT_CUSTOM:
2702 // FIXME: Nothing to check here?
2705 case LFUN_BUFFER_EXPORT: {
2706 docstring const & arg = cmd.argument();
2707 if (arg == "custom") {
2711 string format = (arg.empty() || arg == "default") ?
2712 params().getDefaultOutputFormat() : to_utf8(arg);
2713 size_t pos = format.find(' ');
2714 if (pos != string::npos)
2715 format = format.substr(0, pos);
2716 enable = params().isExportable(format, false);
2718 flag.message(bformat(
2719 _("Don't know how to export to format: %1$s"), arg));
2723 case LFUN_BUILD_PROGRAM:
2724 enable = params().isExportable("program", false);
2727 case LFUN_BRANCH_ACTIVATE:
2728 case LFUN_BRANCH_DEACTIVATE:
2729 case LFUN_BRANCH_MASTER_ACTIVATE:
2730 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2731 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2732 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2733 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2734 : params().branchlist();
2735 docstring const & branchName = cmd.argument();
2736 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2740 case LFUN_BRANCH_ADD:
2741 case LFUN_BRANCHES_RENAME:
2742 // if no Buffer is present, then of course we won't be called!
2745 case LFUN_BUFFER_LANGUAGE:
2746 enable = !isReadonly();
2749 case LFUN_BUFFER_VIEW_CACHE:
2750 (d->preview_file_).refresh();
2751 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2754 case LFUN_CHANGES_TRACK:
2755 flag.setEnabled(true);
2756 flag.setOnOff(params().track_changes);
2759 case LFUN_CHANGES_OUTPUT:
2760 flag.setEnabled(true);
2761 flag.setOnOff(params().output_changes);
2764 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2765 flag.setOnOff(params().compressed);
2768 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2769 flag.setOnOff(params().output_sync);
2772 case LFUN_BUFFER_ANONYMIZE:
2778 flag.setEnabled(enable);
2783 void Buffer::dispatch(string const & command, DispatchResult & result)
2785 return dispatch(lyxaction.lookupFunc(command), result);
2789 // NOTE We can end up here even if we have no GUI, because we are called
2790 // by LyX::exec to handled command-line requests. So we may need to check
2791 // whether we have a GUI or not. The boolean use_gui holds this information.
2792 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2795 // FIXME? if there is an Buffer LFUN that can be dispatched even
2796 // if internal, put a switch '(cmd.action())' here.
2797 dr.dispatched(false);
2800 string const argument = to_utf8(func.argument());
2801 // We'll set this back to false if need be.
2802 bool dispatched = true;
2803 // This handles undo groups automagically
2804 UndoGroupHelper ugh(this);
2806 switch (func.action()) {
2807 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2808 if (lyxvc().inUse()) {
2809 string log = lyxvc().toggleReadOnly();
2814 setReadonly(!hasReadonlyFlag());
2817 case LFUN_BUFFER_EXPORT: {
2818 string const format = (argument.empty() || argument == "default") ?
2819 params().getDefaultOutputFormat() : argument;
2820 ExportStatus const status = doExport(format, false);
2821 dr.setError(status != ExportSuccess);
2822 if (status != ExportSuccess)
2823 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2824 from_utf8(format)));
2828 case LFUN_BUILD_PROGRAM: {
2829 ExportStatus const status = doExport("program", true);
2830 dr.setError(status != ExportSuccess);
2831 if (status != ExportSuccess)
2832 dr.setMessage(_("Error generating literate programming code."));
2836 case LFUN_BUFFER_EXPORT_CUSTOM: {
2838 string command = split(argument, format_name, ' ');
2839 Format const * format = theFormats().getFormat(format_name);
2841 lyxerr << "Format \"" << format_name
2842 << "\" not recognized!"
2847 // The name of the file created by the conversion process
2850 // Output to filename
2851 if (format->name() == "lyx") {
2852 string const latexname = latexName(false);
2853 filename = changeExtension(latexname,
2854 format->extension());
2855 filename = addName(temppath(), filename);
2857 if (!writeFile(FileName(filename)))
2861 doExport(format_name, true, filename);
2864 // Substitute $$FName for filename
2865 if (!contains(command, "$$FName"))
2866 command = "( " + command + " ) < $$FName";
2867 command = subst(command, "$$FName", filename);
2869 // Execute the command in the background
2871 call.startscript(Systemcall::DontWait, command,
2872 filePath(), layoutPos());
2876 // FIXME: There is need for a command-line import.
2878 case LFUN_BUFFER_IMPORT:
2883 case LFUN_BUFFER_AUTO_SAVE:
2885 resetAutosaveTimers();
2888 case LFUN_BRANCH_ACTIVATE:
2889 case LFUN_BRANCH_DEACTIVATE:
2890 case LFUN_BRANCH_MASTER_ACTIVATE:
2891 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2892 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2893 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2894 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2897 docstring const & branch_name = func.argument();
2898 // the case without a branch name is handled elsewhere
2899 if (branch_name.empty()) {
2903 Branch * branch = buf->params().branchlist().find(branch_name);
2905 LYXERR0("Branch " << branch_name << " does not exist.");
2907 docstring const msg =
2908 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2912 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2913 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2914 if (branch->isSelected() != activate) {
2915 buf->undo().recordUndoBufferParams(CursorData());
2916 branch->setSelected(activate);
2918 dr.screenUpdate(Update::Force);
2919 dr.forceBufferUpdate();
2924 case LFUN_BRANCH_ADD: {
2925 docstring const & branchnames = func.argument();
2926 if (branchnames.empty()) {
2930 BranchList & branch_list = params().branchlist();
2931 vector<docstring> const branches =
2932 getVectorFromString(branchnames, branch_list.separator());
2934 for (docstring const & branch_name : branches) {
2935 Branch * branch = branch_list.find(branch_name);
2937 LYXERR0("Branch " << branch_name << " already exists.");
2941 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2943 undo().recordUndoBufferParams(CursorData());
2944 branch_list.add(branch_name);
2945 branch = branch_list.find(branch_name);
2947 // needed to update the color table for dark mode
2948 branch->setColors("background", "background");
2950 dr.screenUpdate(Update::Force);
2958 case LFUN_BRANCHES_RENAME: {
2959 if (func.argument().empty())
2962 docstring const oldname = from_utf8(func.getArg(0));
2963 docstring const newname = from_utf8(func.getArg(1));
2964 InsetIterator it = begin(inset());
2965 InsetIterator const itend = end(inset());
2966 bool success = false;
2967 for (; it != itend; ++it) {
2968 if (it->lyxCode() == BRANCH_CODE) {
2969 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2970 if (ins.branch() == oldname) {
2971 undo().recordUndo(CursorData(it));
2972 ins.rename(newname);
2977 if (it->lyxCode() == INCLUDE_CODE) {
2978 // get buffer of external file
2979 InsetInclude const & ins =
2980 static_cast<InsetInclude const &>(*it);
2981 Buffer * child = ins.loadIfNeeded();
2984 child->dispatch(func, dr);
2989 dr.screenUpdate(Update::Force);
2990 dr.forceBufferUpdate();
2995 case LFUN_BUFFER_VIEW_CACHE:
2996 if (!theFormats().view(*this, d->preview_file_,
2997 d->preview_format_))
2998 dr.setMessage(_("Error viewing the output file."));
3001 case LFUN_CHANGES_TRACK:
3002 if (params().save_transient_properties)
3003 undo().recordUndoBufferParams(CursorData());
3004 params().track_changes = !params().track_changes;
3007 case LFUN_CHANGES_OUTPUT:
3008 if (params().save_transient_properties)
3009 undo().recordUndoBufferParams(CursorData());
3010 params().output_changes = !params().output_changes;
3011 if (params().output_changes) {
3012 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3013 LaTeXFeatures::isAvailable("xcolor");
3016 Alert::warning(_("Changes not shown in LaTeX output"),
3017 _("Changes will not be highlighted in LaTeX output, "
3018 "because xcolor and ulem are not installed.\n"
3019 "Please install both packages or redefine "
3020 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3025 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3026 // turn compression on/off
3027 undo().recordUndoBufferParams(CursorData());
3028 params().compressed = !params().compressed;
3031 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3032 undo().recordUndoBufferParams(CursorData());
3033 params().output_sync = !params().output_sync;
3036 case LFUN_BUFFER_ANONYMIZE: {
3037 undo().recordUndoFullBuffer(CursorData());
3038 CursorData cur(doc_iterator_begin(this));
3039 for ( ; cur ; cur.forwardPar())
3040 cur.paragraph().anonymize();
3041 dr.forceBufferUpdate();
3042 dr.screenUpdate(Update::Force);
3050 dr.dispatched(dispatched);
3054 void Buffer::changeLanguage(Language const * from, Language const * to)
3056 LASSERT(from, return);
3057 LASSERT(to, return);
3059 ParIterator it = par_iterator_begin();
3060 ParIterator eit = par_iterator_end();
3061 for (; it != eit; ++it)
3062 it->changeLanguage(params(), from, to);
3066 bool Buffer::isMultiLingual() const
3068 ParConstIterator end = par_iterator_end();
3069 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3070 if (it->isMultiLingual(params()))
3077 std::set<Language const *> Buffer::getLanguages() const
3079 std::set<Language const *> langs;
3080 getLanguages(langs);
3085 void Buffer::getLanguages(std::set<Language const *> & langs) const
3087 ParConstIterator end = par_iterator_end();
3088 // add the buffer language, even if it's not actively used
3089 langs.insert(language());
3090 // iterate over the paragraphs
3091 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3092 it->getLanguages(langs);
3094 ListOfBuffers clist = getDescendants();
3095 for (auto const & cit : clist)
3096 cit->getLanguages(langs);
3100 DocIterator Buffer::getParFromID(int const id) const
3102 Buffer * buf = const_cast<Buffer *>(this);
3104 // This means non-existent
3105 return doc_iterator_end(buf);
3107 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3108 if (it.paragraph().id() == id)
3111 return doc_iterator_end(buf);
3115 bool Buffer::hasParWithID(int const id) const
3117 return !getParFromID(id).atEnd();
3121 ParIterator Buffer::par_iterator_begin()
3123 return ParIterator(doc_iterator_begin(this));
3127 ParIterator Buffer::par_iterator_end()
3129 return ParIterator(doc_iterator_end(this));
3133 ParConstIterator Buffer::par_iterator_begin() const
3135 return ParConstIterator(doc_iterator_begin(this));
3139 ParConstIterator Buffer::par_iterator_end() const
3141 return ParConstIterator(doc_iterator_end(this));
3144 bool Buffer::empty() const
3146 return paragraphs().size() == 1 && paragraphs().front().empty();
3150 Language const * Buffer::language() const
3152 return params().language;
3156 docstring Buffer::B_(string const & l10n) const
3158 return params().B_(l10n);
3162 bool Buffer::isClean() const
3164 return d->lyx_clean;
3168 bool Buffer::isChecksumModified() const
3170 LASSERT(d->filename.exists(), return false);
3171 return d->checksum_ != d->filename.checksum();
3175 void Buffer::saveCheckSum() const
3177 FileName const & file = d->filename;
3179 d->checksum_ = file.exists() ? file.checksum()
3180 : 0; // in the case of save to a new file.
3184 void Buffer::markClean() const
3186 if (!d->lyx_clean) {
3187 d->lyx_clean = true;
3190 // if the .lyx file has been saved, we don't need an
3192 d->bak_clean = true;
3193 d->undo_.markDirty();
3194 clearExternalModification();
3198 void Buffer::setUnnamed(bool flag)
3204 bool Buffer::isUnnamed() const
3211 /// Don't check unnamed, here: isInternal() is used in
3212 /// newBuffer(), where the unnamed flag has not been set by anyone
3213 /// yet. Also, for an internal buffer, there should be no need for
3214 /// retrieving fileName() nor for checking if it is unnamed or not.
3215 bool Buffer::isInternal() const
3217 return d->internal_buffer;
3221 void Buffer::setInternal(bool flag)
3223 d->internal_buffer = flag;
3227 void Buffer::markDirty()
3230 d->lyx_clean = false;
3233 d->bak_clean = false;
3235 for (auto & depit : d->dep_clean)
3236 depit.second = false;
3240 FileName Buffer::fileName() const
3246 string Buffer::absFileName() const
3248 return d->filename.absFileName();
3252 string Buffer::filePath() const
3254 string const abs = d->filename.onlyPath().absFileName();
3257 int last = abs.length() - 1;
3259 return abs[last] == '/' ? abs : abs + '/';
3263 DocFileName Buffer::getReferencedFileName(string const & fn) const
3266 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3267 result.set(fn, filePath());
3269 // filePath() ends with a path separator
3270 FileName const test(filePath() + fn);
3272 result.set(fn, filePath());
3274 result.set(fn, params().origin);
3281 string const Buffer::prepareFileNameForLaTeX(string const & name,
3282 string const & ext, bool nice) const
3284 string const fname = makeAbsPath(name, filePath()).absFileName();
3285 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3291 return to_utf8(makeRelPath(from_utf8(fname),
3292 from_utf8(masterBuffer()->filePath())));
3296 vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3297 docstring_list const & bibfilelist,
3298 bool const add_extension) const
3300 // If we are processing the LaTeX file in a temp directory then
3301 // copy the .bib databases to this temp directory, mangling their
3302 // names in the process. Store this mangled name in the list of
3304 // (We need to do all this because BibTeX *really*, *really*
3305 // can't handle "files with spaces" and Windows users tend to
3306 // use such filenames.)
3307 // Otherwise, store the (maybe absolute) path to the original,
3308 // unmangled database name.
3310 vector<pair<docstring, string>> res;
3312 // determine the export format
3313 string const tex_format = flavor2format(runparams.flavor);
3315 // check for spaces in paths
3316 bool found_space = false;
3318 for (auto const & bit : bibfilelist) {
3319 string utf8input = to_utf8(bit);
3321 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3322 FileName try_in_file =
3323 makeAbsPath(database + ".bib", filePath());
3324 bool not_from_texmf = try_in_file.isReadableFile();
3325 // If the file has not been found, try with the real file name
3326 // (it might come from a child in a sub-directory)
3327 if (!not_from_texmf) {
3328 try_in_file = getBibfilePath(bit);
3329 if (try_in_file.isReadableFile()) {
3330 // Check if the file is in texmf
3331 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3332 not_from_texmf = kpsefile.empty()
3333 || kpsefile.absFileName() != try_in_file.absFileName();
3335 // If this exists, make path relative to the master
3338 removeExtension(prepareFileNameForLaTeX(
3339 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3340 from_utf8(filePath()))),
3341 ".bib", runparams.nice));
3345 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3347 // mangledFileName() needs the extension
3348 DocFileName const in_file = DocFileName(try_in_file);
3349 database = removeExtension(in_file.mangledFileName());
3350 FileName const out_file = makeAbsPath(database + ".bib",
3351 masterBuffer()->temppath());
3352 bool const success = in_file.copyTo(out_file);
3354 LYXERR0("Failed to copy '" << in_file
3355 << "' to '" << out_file << "'");
3357 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3358 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3359 if (!isValidLaTeXFileName(database)) {
3360 frontend::Alert::warning(_("Invalid filename"),
3361 _("The following filename will cause troubles "
3362 "when running the exported file through LaTeX: ") +
3363 from_utf8(database));
3365 if (!isValidDVIFileName(database)) {
3366 frontend::Alert::warning(_("Problematic filename for DVI"),
3367 _("The following filename can cause troubles "
3368 "when running the exported file through LaTeX "
3369 "and opening the resulting DVI: ") +
3370 from_utf8(database), true);
3378 docstring const path = from_utf8(latex_path(database));
3380 if (contains(path, ' '))
3383 if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
3384 enc = params().bibFileEncoding(utf8input);
3386 bool recorded = false;
3387 for (auto const & pe : res) {
3388 if (pe.first == path) {
3395 res.push_back(make_pair(path, enc));
3398 // Check if there are spaces in the path and warn BibTeX users, if so.
3399 // (biber can cope with such paths)
3400 if (!prefixIs(runparams.bibtex_command, "biber")) {
3401 // Post this warning only once.
3402 static bool warned_about_spaces = false;
3403 if (!warned_about_spaces &&
3404 runparams.nice && found_space) {
3405 warned_about_spaces = true;
3406 Alert::warning(_("Export Warning!"),
3407 _("There are spaces in the paths to your BibTeX databases.\n"
3408 "BibTeX will be unable to find them."));
3417 string Buffer::layoutPos() const
3419 return d->layout_position;
3423 void Buffer::setLayoutPos(string const & path)
3426 d->layout_position.clear();
3430 LATTEST(FileName::isAbsolute(path));
3432 d->layout_position =
3433 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3435 if (d->layout_position.empty())
3436 d->layout_position = ".";
3440 bool Buffer::hasReadonlyFlag() const
3442 return d->read_only;
3446 bool Buffer::isReadonly() const
3448 return hasReadonlyFlag() || notifiesExternalModification();
3452 void Buffer::setParent(Buffer const * buffer)
3454 // We need to do some work here to avoid recursive parent structures.
3455 // This is the easy case.
3456 if (buffer == this) {
3457 LYXERR0("Ignoring attempt to set self as parent in\n" << fileName());
3460 // Now we check parents going upward, to make sure that IF we set the
3461 // parent as requested, we would not generate a recursive include.
3462 set<Buffer const *> sb;
3463 Buffer const * b = buffer;
3464 bool found_recursion = false;
3466 if (sb.find(b) != sb.end()) {
3467 found_recursion = true;
3474 if (found_recursion) {
3475 LYXERR0("Ignoring attempt to set parent of\n" <<
3478 buffer->fileName() <<
3479 "\nbecause that would create a recursive inclusion.");
3483 // We should be safe now.
3484 d->setParent(buffer);
3489 Buffer const * Buffer::parent() const
3495 ListOfBuffers Buffer::allRelatives() const
3497 ListOfBuffers lb = masterBuffer()->getDescendants();
3498 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3503 Buffer const * Buffer::masterBuffer() const
3505 Buffer const * const pbuf = d->parent();
3509 return pbuf->masterBuffer();
3513 bool Buffer::isChild(Buffer * child) const
3515 return d->children_positions.find(child) != d->children_positions.end();
3519 DocIterator Buffer::firstChildPosition(Buffer const * child)
3521 Impl::BufferPositionMap::iterator it;
3522 it = d->children_positions.find(child);
3523 if (it == d->children_positions.end())
3524 return DocIterator(this);
3529 bool Buffer::hasChildren() const
3531 return !d->children_positions.empty();
3535 void Buffer::collectChildren(ListOfBuffers & children, bool grand_children) const
3537 // loop over children
3538 for (auto const & p : d->children_positions) {
3539 Buffer * child = const_cast<Buffer *>(p.first);
3540 // This can happen when called during GUI operations
3541 if (!theBufferList().isLoaded(child))
3544 ListOfBuffers::const_iterator bit = find(children.begin(), children.end(), child);
3545 if (bit != children.end())
3547 children.push_back(child);
3549 // there might be grandchildren
3550 child->collectChildren(children, true);
3555 ListOfBuffers Buffer::getChildren() const
3558 collectChildren(v, false);
3559 // Make sure we have not included ourselves.
3560 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3561 if (bit != v.end()) {
3562 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3569 ListOfBuffers Buffer::getDescendants() const
3572 collectChildren(v, true);
3573 // Make sure we have not included ourselves.
3574 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3575 if (bit != v.end()) {
3576 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3583 template<typename M>
3584 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3589 typename M::const_iterator it = m.lower_bound(x);
3590 if (it == m.begin())
3598 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3599 DocIterator const & pos) const
3601 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3603 // if paragraphs have no macro context set, pos will be empty
3607 // we haven't found anything yet
3608 DocIterator bestPos = owner_->par_iterator_begin();
3609 MacroData const * bestData = nullptr;
3611 // find macro definitions for name
3612 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3613 if (nameIt != macros.end()) {
3614 // find last definition in front of pos or at pos itself
3615 PositionScopeMacroMap::const_iterator it
3616 = greatest_below(nameIt->second, pos);
3617 if (it != nameIt->second.end()) {
3619 // scope ends behind pos?
3620 if (pos < it->second.scope) {
3621 // Looks good, remember this. If there
3622 // is no external macro behind this,
3623 // we found the right one already.
3624 bestPos = it->first;
3625 bestData = &it->second.macro;
3629 // try previous macro if there is one
3630 if (it == nameIt->second.begin())
3637 // find macros in included files
3638 PositionScopeBufferMap::const_iterator it
3639 = greatest_below(position_to_children, pos);
3640 if (it == position_to_children.end())
3641 // no children before
3645 // do we know something better (i.e. later) already?
3646 if (it->first < bestPos )
3649 // scope ends behind pos?
3650 if (pos < it->second.scope
3651 && (cloned_buffer_ ||
3652 theBufferList().isLoaded(it->second.buffer))) {
3653 // look for macro in external file
3655 MacroData const * data
3656 = it->second.buffer->getMacro(name, false);
3659 bestPos = it->first;
3665 // try previous file if there is one
3666 if (it == position_to_children.begin())
3671 // return the best macro we have found
3676 MacroData const * Buffer::getMacro(docstring const & name,
3677 DocIterator const & pos, bool global) const
3682 // query buffer macros
3683 MacroData const * data = d->getBufferMacro(name, pos);
3684 if (data != nullptr)
3687 // If there is a master buffer, query that
3688 Buffer const * const pbuf = d->parent();
3690 d->macro_lock = true;
3691 MacroData const * macro = pbuf->getMacro(
3692 name, *this, false);
3693 d->macro_lock = false;
3699 data = MacroTable::globalMacros().get(name);
3700 if (data != nullptr)
3708 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3710 // set scope end behind the last paragraph
3711 DocIterator scope = par_iterator_begin();
3712 scope.pit() = scope.lastpit() + 1;
3714 return getMacro(name, scope, global);
3718 MacroData const * Buffer::getMacro(docstring const & name,
3719 Buffer const & child, bool global) const
3721 // look where the child buffer is included first
3722 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3723 if (it == d->children_positions.end())
3726 // check for macros at the inclusion position
3727 return getMacro(name, it->second, global);
3731 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3733 pit_type const lastpit = it.lastpit();
3735 // look for macros in each paragraph
3736 while (it.pit() <= lastpit) {
3737 Paragraph & par = it.paragraph();
3739 // iterate over the insets of the current paragraph
3740 for (auto const & insit : par.insetList()) {
3741 it.pos() = insit.pos;
3743 // is it a nested text inset?
3744 if (insit.inset->asInsetText()) {
3745 // Inset needs its own scope?
3746 InsetText const * itext = insit.inset->asInsetText();
3747 bool newScope = itext->isMacroScope();
3749 // scope which ends just behind the inset
3750 DocIterator insetScope = it;
3753 // collect macros in inset
3754 it.push_back(CursorSlice(*insit.inset));
3755 updateMacros(it, newScope ? insetScope : scope);
3760 if (insit.inset->asInsetTabular()) {
3761 CursorSlice slice(*insit.inset);
3762 size_t const numcells = slice.nargs();
3763 for (; slice.idx() < numcells; slice.forwardIdx()) {
3764 it.push_back(slice);
3765 updateMacros(it, scope);
3771 // is it an external file?
3772 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3773 // get buffer of external file
3774 InsetInclude const & incinset =
3775 static_cast<InsetInclude const &>(*insit.inset);
3777 Buffer * child = incinset.loadIfNeeded();
3782 // register its position, but only when it is
3783 // included first in the buffer
3784 children_positions.insert({child, it});
3786 // register child with its scope
3787 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3791 InsetMath * im = insit.inset->asInsetMath();
3792 if (doing_export && im) {
3793 InsetMathHull * hull = im->asHullInset();
3795 hull->recordLocation(it);
3798 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3802 InsetMathMacroTemplate & macroTemplate =
3803 *insit.inset->asInsetMath()->asMacroTemplate();
3804 MacroContext mc(owner_, it);
3805 macroTemplate.updateToContext(mc);
3808 bool valid = macroTemplate.validMacro();
3809 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3810 // then the BufferView's cursor will be invalid in
3811 // some cases which leads to crashes.
3816 // FIXME (Abdel), I don't understand why we pass 'it' here
3817 // instead of 'macroTemplate' defined above... is this correct?
3818 macros[macroTemplate.name()][it] =
3819 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3829 void Buffer::updateMacros() const
3834 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3836 // start with empty table
3838 d->children_positions.clear();
3839 d->position_to_children.clear();
3841 // Iterate over buffer, starting with first paragraph
3842 // The scope must be bigger than any lookup DocIterator
3843 // later. For the global lookup, lastpit+1 is used, hence
3844 // we use lastpit+2 here.
3845 DocIterator it = par_iterator_begin();
3846 DocIterator outerScope = it;
3847 outerScope.pit() = outerScope.lastpit() + 2;
3848 d->updateMacros(it, outerScope);
3852 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3854 for (Inset const & it : inset()) {
3855 if (it.lyxCode() == BRANCH_CODE) {
3856 InsetBranch const & br = static_cast<InsetBranch const &>(it);
3857 docstring const name = br.branch();
3858 if (!from_master && !params().branchlist().find(name))
3859 result.push_back(name);
3860 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3861 result.push_back(name);
3864 if (it.lyxCode() == INCLUDE_CODE) {
3865 // get buffer of external file
3866 InsetInclude const & ins =
3867 static_cast<InsetInclude const &>(it);
3868 Buffer * child = ins.loadIfNeeded();
3871 child->getUsedBranches(result, true);
3874 // remove duplicates
3879 void Buffer::updateMacroInstances(UpdateType utype) const
3881 LYXERR(Debug::MACROS, "updateMacroInstances for "
3882 << d->filename.onlyFileName());
3883 DocIterator it = doc_iterator_begin(this);
3885 DocIterator const end = doc_iterator_end(this);
3886 for (; it != end; it.forwardInset()) {
3887 // look for MathData cells in InsetMathNest insets
3888 InsetMath * minset = it.nextInset()->asInsetMath();
3892 // update macro in all cells of the InsetMathNest
3893 idx_type n = minset->nargs();
3894 MacroContext mc = MacroContext(this, it);
3895 for (idx_type i = 0; i < n; ++i) {
3896 MathData & data = minset->cell(i);
3897 data.updateMacros(nullptr, mc, utype, 0);
3903 void Buffer::listMacroNames(MacroNameSet & macros) const
3908 d->macro_lock = true;
3910 // loop over macro names
3911 for (auto const & nameit : d->macros)
3912 macros.insert(nameit.first);
3914 // loop over children
3915 for (auto const & p : d->children_positions) {
3916 Buffer * child = const_cast<Buffer *>(p.first);
3917 // The buffer might have been closed (see #10766).
3918 if (theBufferList().isLoaded(child))
3919 child->listMacroNames(macros);
3923 Buffer const * const pbuf = d->parent();
3925 pbuf->listMacroNames(macros);
3927 d->macro_lock = false;
3931 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3933 Buffer const * const pbuf = d->parent();
3938 pbuf->listMacroNames(names);
3941 for (auto const & mit : names) {
3943 MacroData const * data = pbuf->getMacro(mit, *this, false);
3945 macros.insert(data);
3947 // we cannot access the original InsetMathMacroTemplate anymore
3948 // here to calls validate method. So we do its work here manually.
3949 // FIXME: somehow make the template accessible here.
3950 if (data->optionals() > 0)
3951 features.require("xargs");
3957 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3960 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3962 RefCache::iterator it = d->ref_cache_.find(label);
3963 if (it != d->ref_cache_.end())
3966 static References const dummy_refs = References();
3967 it = d->ref_cache_.insert(
3968 make_pair(label, dummy_refs)).first;
3973 Buffer::References const & Buffer::references(docstring const & label) const
3975 return const_cast<Buffer *>(this)->getReferenceCache(label);
3979 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3981 References & refs = getReferenceCache(label);
3982 refs.push_back(make_pair(inset, it));
3986 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
3990 linfo.label = label;
3992 linfo.active = active;
3993 masterBuffer()->d->label_cache_.push_back(linfo);
3997 InsetLabel const * Buffer::insetLabel(docstring const & label,
3998 bool const active) const
4000 for (auto const & rc : masterBuffer()->d->label_cache_) {
4001 if (rc.label == label && (rc.active || !active))
4008 bool Buffer::activeLabel(docstring const & label) const
4010 return insetLabel(label, true) != nullptr;
4014 void Buffer::clearReferenceCache() const
4017 d->ref_cache_.clear();
4018 d->label_cache_.clear();
4023 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
4025 //FIXME: This does not work for child documents yet.
4026 reloadBibInfoCache();
4028 // Check if the label 'from' appears more than once
4029 vector<docstring> labels;
4030 for (auto const & bibit : masterBibInfo())
4031 labels.push_back(bibit.first);
4033 if (count(labels.begin(), labels.end(), from) > 1)
4036 string const paramName = "key";
4037 UndoGroupHelper ugh(this);
4038 InsetIterator it = begin(inset());
4040 if (it->lyxCode() != CITE_CODE)
4042 InsetCommand * inset = it->asInsetCommand();
4043 docstring const oldValue = inset->getParam(paramName);
4044 if (oldValue == from) {
4045 undo().recordUndo(CursorData(it));
4046 inset->setParam(paramName, to);
4051 // returns NULL if id-to-row conversion is unsupported
4052 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4053 pit_type par_begin, pit_type par_end,
4054 OutputWhat output, bool master) const
4056 unique_ptr<TexRow> texrow;
4057 OutputParams runparams(¶ms().encoding());
4058 runparams.nice = true;
4059 runparams.flavor = params().getOutputFlavor(format);
4060 runparams.linelen = lyxrc.plaintext_linelen;
4061 // No side effect of file copying and image conversion
4062 runparams.dryrun = true;
4064 // Some macros rely on font encoding
4065 runparams.main_fontenc = params().main_font_encoding();
4067 // Use the right wrapping for the comment at the beginning of the generated
4068 // snippet, so that it is either valid LaTeX or valid XML (including HTML and DocBook).
4069 docstring comment_start = from_ascii("% ");
4070 docstring comment_end = from_ascii("");
4071 if (runparams.flavor == Flavor::Html || runparams.flavor == Flavor::DocBook5) {
4072 comment_start = from_ascii("<!-- ");
4073 comment_end = from_ascii(" -->");
4076 if (output == CurrentParagraph) {
4077 runparams.par_begin = par_begin;
4078 runparams.par_end = par_end;
4079 if (par_begin + 1 == par_end) {
4081 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4086 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4087 convert<docstring>(par_begin),
4088 convert<docstring>(par_end - 1))
4092 // output paragraphs
4093 if (runparams.flavor == Flavor::LyX) {
4094 Paragraph const & par = text().paragraphs()[par_begin];
4096 depth_type dt = par.getDepth();
4097 par.write(ods, params(), dt);
4098 os << from_utf8(ods.str());
4099 } else if (runparams.flavor == Flavor::Html) {
4101 setMathFlavor(runparams);
4102 xhtmlParagraphs(text(), *this, xs, runparams);
4103 } else if (runparams.flavor == Flavor::Text) {
4105 // FIXME Handles only one paragraph, unlike the others.
4106 // Probably should have some routine with a signature like them.
4107 writePlaintextParagraph(*this,
4108 text().paragraphs()[par_begin], os, runparams, dummy);
4109 } else if (runparams.flavor == Flavor::DocBook5) {
4111 docbookParagraphs(text(), *this, xs, runparams);
4113 // If we are previewing a paragraph, even if this is the
4114 // child of some other buffer, let's cut the link here,
4115 // so that no concurring settings from the master
4116 // (e.g. branch state) interfere (see #8101).
4118 d->ignore_parent = true;
4119 // We need to validate the Buffer params' features here
4120 // in order to know if we should output polyglossia
4121 // macros (instead of babel macros)
4122 LaTeXFeatures features(*this, params(), runparams);
4124 runparams.use_polyglossia = features.usePolyglossia();
4125 runparams.use_hyperref = features.isRequired("hyperref");
4126 // latex or literate
4129 ots.texrow().newlines(2);
4131 latexParagraphs(*this, text(), ots, runparams);
4132 texrow = ots.releaseTexRow();
4134 // Restore the parenthood
4136 d->ignore_parent = false;
4139 os << comment_start;
4140 if (output == FullSource)
4141 os << _("Preview source code");
4142 else if (output == OnlyPreamble)
4143 os << _("Preview preamble");
4144 else if (output == OnlyBody)
4145 os << _("Preview body");
4148 if (runparams.flavor == Flavor::LyX) {
4150 if (output == FullSource)
4152 else if (output == OnlyPreamble)
4153 params().writeFile(ods, this);
4154 else if (output == OnlyBody)
4156 os << from_utf8(ods.str());
4157 } else if (runparams.flavor == Flavor::Html) {
4158 writeLyXHTMLSource(os, runparams, output);
4159 } else if (runparams.flavor == Flavor::Text) {
4160 if (output == OnlyPreamble)
4161 os << "% "<< _("Plain text does not have a preamble.");
4163 writePlaintextFile(*this, os, runparams);
4164 } else if (runparams.flavor == Flavor::DocBook5) {
4165 writeDocBookSource(os, runparams, output);
4167 // latex or literate
4170 ots.texrow().newlines(2);
4172 runparams.is_child = true;
4174 writeLaTeXSource(ots, string(), runparams, output);
4175 texrow = ots.releaseTexRow();
4182 ErrorList & Buffer::errorList(string const & type) const
4184 return d->errorLists[type];
4188 void Buffer::updateTocItem(std::string const & type,
4189 DocIterator const & dit) const
4192 d->gui_->updateTocItem(type, dit);
4196 void Buffer::structureChanged() const
4199 d->gui_->structureChanged();
4203 void Buffer::errors(string const & err, bool from_master) const
4206 d->gui_->errors(err, from_master);
4210 void Buffer::message(docstring const & msg) const
4213 d->gui_->message(msg);
4217 void Buffer::setBusy(bool on) const
4220 d->gui_->setBusy(on);
4224 void Buffer::updateTitles() const
4227 d->wa_->updateTitles();
4231 void Buffer::resetAutosaveTimers() const
4234 d->gui_->resetAutosaveTimers();
4238 bool Buffer::hasGuiDelegate() const
4244 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4250 FileName Buffer::getEmergencyFileName() const
4252 return FileName(d->filename.absFileName() + ".emergency");
4256 FileName Buffer::getAutosaveFileName() const
4258 // if the document is unnamed try to save in the backup dir, else
4259 // in the default document path, and as a last try in the filePath,
4260 // which will most often be the temporary directory
4263 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4264 : lyxrc.backupdir_path;
4265 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4268 string const fname = "#" + d->filename.onlyFileName() + "#";
4270 return makeAbsPath(fname, fpath);
4274 void Buffer::removeAutosaveFile() const
4276 FileName const f = getAutosaveFileName();
4282 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4284 FileName const newauto = getAutosaveFileName();
4286 if (newauto != oldauto && oldauto.exists())
4287 if (!oldauto.moveTo(newauto))
4288 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4292 bool Buffer::autoSave() const
4294 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4295 if (buf->d->bak_clean || hasReadonlyFlag())
4298 message(_("Autosaving current document..."));
4299 buf->d->bak_clean = true;
4301 FileName const fname = getAutosaveFileName();
4302 LASSERT(d->cloned_buffer_, return false);
4304 // If this buffer is cloned, we assume that
4305 // we are running in a separate thread already.
4306 TempFile tempfile("lyxautoXXXXXX.lyx");
4307 tempfile.setAutoRemove(false);
4308 FileName const tmp_ret = tempfile.name();
4309 if (!tmp_ret.empty()) {
4311 // assume successful write of tmp_ret
4312 if (tmp_ret.moveTo(fname))
4315 // failed to write/rename tmp_ret so try writing direct
4316 return writeFile(fname);
4320 void Buffer::setExportStatus(bool e) const
4322 d->doing_export = e;
4323 ListOfBuffers clist = getDescendants();
4324 for (auto const & bit : clist)
4325 bit->d->doing_export = e;
4329 bool Buffer::isExporting() const
4331 return d->doing_export;
4335 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4339 return doExport(target, put_in_tempdir, result_file);
4342 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4343 string & result_file) const
4345 bool const update_unincluded =
4346 params().maintain_unincluded_children != BufferParams::CM_None
4347 && !params().getIncludedChildren().empty();
4349 // (1) export with all included children (omit \includeonly)
4350 if (update_unincluded) {
4351 ExportStatus const status =
4352 doExport(target, put_in_tempdir, true, result_file);
4353 if (status != ExportSuccess)
4356 // (2) export with included children only
4357 return doExport(target, put_in_tempdir, false, result_file);
4361 void Buffer::setMathFlavor(OutputParams & op) const
4363 switch (params().html_math_output) {
4364 case BufferParams::MathML:
4365 op.math_flavor = OutputParams::MathAsMathML;
4367 case BufferParams::HTML:
4368 op.math_flavor = OutputParams::MathAsHTML;
4370 case BufferParams::Images:
4371 op.math_flavor = OutputParams::MathAsImages;
4373 case BufferParams::LaTeX:
4374 op.math_flavor = OutputParams::MathAsLaTeX;
4380 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4381 bool includeall, string & result_file) const
4383 LYXERR(Debug::FILES, "target=" << target);
4384 OutputParams runparams(¶ms().encoding());
4385 string format = target;
4386 string dest_filename;
4387 size_t pos = target.find(' ');
4388 if (pos != string::npos) {
4389 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4390 format = target.substr(0, pos);
4391 if (format == "default")
4392 format = params().getDefaultOutputFormat();
4393 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4394 FileName(dest_filename).onlyPath().createPath();
4395 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4397 MarkAsExporting exporting(this);
4398 string backend_format;
4399 runparams.flavor = Flavor::LaTeX;
4400 runparams.linelen = lyxrc.plaintext_linelen;
4401 runparams.includeall = includeall;
4402 vector<string> backs = params().backends();
4403 Converters converters = theConverters();
4404 bool need_nice_file = false;
4405 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4406 // Get shortest path to format
4407 converters.buildGraph();
4408 Graph::EdgePath path;
4409 for (string const & sit : backs) {
4410 Graph::EdgePath p = converters.getPath(sit, format);
4411 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4412 backend_format = sit;
4417 if (!put_in_tempdir) {
4418 // Only show this alert if this is an export to a non-temporary
4419 // file (not for previewing).
4420 docstring s = bformat(_("No information for exporting the format %1$s."),
4421 translateIfPossible(theFormats().prettyName(format)));
4422 if (format == "pdf4")
4424 + bformat(_("Hint: use non-TeX fonts or set input encoding "
4425 " to '%1$s'"), from_utf8(encodings.fromLyXName("ascii")->guiName()));
4426 Alert::error(_("Couldn't export file"), s);
4428 return ExportNoPathToFormat;
4430 runparams.flavor = converters.getFlavor(path, this);
4431 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4432 for (auto const & edge : path)
4433 if (theConverters().get(edge).nice()) {
4434 need_nice_file = true;
4439 backend_format = format;
4440 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4441 // FIXME: Don't hardcode format names here, but use a flag
4442 if (backend_format == "pdflatex")
4443 runparams.flavor = Flavor::PdfLaTeX;
4444 else if (backend_format == "luatex")
4445 runparams.flavor = Flavor::LuaTeX;
4446 else if (backend_format == "dviluatex")
4447 runparams.flavor = Flavor::DviLuaTeX;
4448 else if (backend_format == "xetex")
4449 runparams.flavor = Flavor::XeTeX;
4452 string filename = latexName(false);
4453 filename = addName(temppath(), filename);
4454 filename = changeExtension(filename,
4455 theFormats().extension(backend_format));
4456 LYXERR(Debug::FILES, "filename=" << filename);
4458 // Plain text backend
4459 if (backend_format == "text") {
4460 runparams.flavor = Flavor::Text;
4462 writePlaintextFile(*this, FileName(filename), runparams);
4464 catch (ConversionException const &) { return ExportCancel; }
4467 else if (backend_format == "xhtml") {
4468 runparams.flavor = Flavor::Html;
4469 setMathFlavor(runparams);
4470 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4471 return ExportKilled;
4472 } else if (backend_format == "lyx")
4473 writeFile(FileName(filename));
4475 else if (backend_format == "docbook5") {
4476 runparams.flavor = Flavor::DocBook5;
4477 runparams.nice = false;
4478 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4479 return ExportKilled;
4482 else if (backend_format == format || need_nice_file) {
4483 runparams.nice = true;
4484 ExportStatus const retval =
4485 makeLaTeXFile(FileName(filename), string(), runparams);
4486 if (retval == ExportKilled)
4487 return ExportKilled;
4488 if (d->cloned_buffer_)
4489 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4490 if (retval != ExportSuccess)
4492 } else if (!lyxrc.tex_allows_spaces
4493 && contains(filePath(), ' ')) {
4494 Alert::error(_("File name error"),
4495 bformat(_("The directory path to the document\n%1$s\n"
4496 "contains spaces, but your TeX installation does "
4497 "not allow them. You should save the file to a directory "
4498 "whose name does not contain spaces."), from_utf8(filePath())));
4499 return ExportTexPathHasSpaces;
4501 runparams.nice = false;
4502 ExportStatus const retval =
4503 makeLaTeXFile(FileName(filename), filePath(), runparams);
4504 if (retval == ExportKilled)
4505 return ExportKilled;
4506 if (d->cloned_buffer_)
4507 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4508 if (retval != ExportSuccess)
4512 string const error_type = (format == "program")
4513 ? "Build" : params().bufferFormat();
4514 ErrorList & error_list = d->errorLists[error_type];
4515 string const ext = theFormats().extension(format);
4516 FileName const tmp_result_file(changeExtension(filename, ext));
4517 Converters::RetVal const retval =
4518 converters.convert(this, FileName(filename), tmp_result_file,
4519 FileName(absFileName()), backend_format, format,
4520 error_list, Converters::none, includeall);
4521 if (retval == Converters::KILLED)
4522 return ExportCancel;
4523 bool success = (retval == Converters::SUCCESS);
4525 // Emit the signal to show the error list or copy it back to the
4526 // cloned Buffer so that it can be emitted afterwards.
4527 if (format != backend_format) {
4528 if (runparams.silent)
4530 else if (d->cloned_buffer_)
4531 d->cloned_buffer_->d->errorLists[error_type] =
4532 d->errorLists[error_type];
4535 // also to the children, in case of master-buffer-view
4536 ListOfBuffers clist = getDescendants();
4537 for (auto const & bit : clist) {
4538 if (runparams.silent)
4539 bit->d->errorLists[error_type].clear();
4540 else if (d->cloned_buffer_) {
4541 // Enable reverse search by copying back the
4542 // texrow object to the cloned buffer.
4543 // FIXME: this is not thread safe.
4544 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4545 bit->d->cloned_buffer_->d->errorLists[error_type] =
4546 bit->d->errorLists[error_type];
4548 bit->errors(error_type, true);
4552 if (d->cloned_buffer_) {
4553 // Enable reverse dvi or pdf to work by copying back the texrow
4554 // object to the cloned buffer.
4555 // FIXME: There is a possibility of concurrent access to texrow
4556 // here from the main GUI thread that should be securized.
4557 d->cloned_buffer_->d->texrow = d->texrow;
4558 string const err_type = params().bufferFormat();
4559 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4563 if (put_in_tempdir) {
4564 result_file = tmp_result_file.absFileName();
4565 return success ? ExportSuccess : ExportConverterError;
4568 if (dest_filename.empty())
4569 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4571 result_file = dest_filename;
4572 // We need to copy referenced files (e. g. included graphics
4573 // if format == "dvi") to the result dir.
4574 vector<ExportedFile> const extfiles =
4575 runparams.exportdata->externalFiles(format);
4576 string const dest = runparams.export_folder.empty() ?
4577 onlyPath(result_file) : runparams.export_folder;
4578 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4579 : force_overwrite == ALL_FILES;
4580 CopyStatus status = use_force ? FORCE : SUCCESS;
4582 for (ExportedFile const & exp : extfiles) {
4583 if (status == CANCEL) {
4584 message(_("Document export cancelled."));
4585 return ExportCancel;
4587 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4588 string fixedName = exp.exportName;
4589 if (!runparams.export_folder.empty()) {
4590 // Relative pathnames starting with ../ will be sanitized
4591 // if exporting to a different folder
4592 while (fixedName.substr(0, 3) == "../")
4593 fixedName = fixedName.substr(3, fixedName.length() - 3);
4595 FileName fixedFileName = makeAbsPath(fixedName, dest);
4596 fixedFileName.onlyPath().createPath();
4597 status = copyFile(fmt, exp.sourceName,
4599 exp.exportName, status == FORCE,
4600 runparams.export_folder.empty());
4604 if (tmp_result_file.exists()) {
4605 // Finally copy the main file
4606 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4607 : force_overwrite != NO_FILES;
4608 if (status == SUCCESS && use_force)
4610 status = copyFile(format, tmp_result_file,
4611 FileName(result_file), result_file,
4613 if (status == CANCEL) {
4614 message(_("Document export cancelled."));
4615 return ExportCancel;
4617 message(bformat(_("Document exported as %1$s "
4619 translateIfPossible(theFormats().prettyName(format)),
4620 makeDisplayPath(result_file)));
4623 // This must be a dummy converter like fax (bug 1888)
4624 message(bformat(_("Document exported as %1$s"),
4625 translateIfPossible(theFormats().prettyName(format))));
4628 return success ? ExportSuccess : ExportConverterError;
4632 Buffer::ExportStatus Buffer::preview(string const & format) const
4634 bool const update_unincluded =
4635 params().maintain_unincluded_children != BufferParams::CM_None
4636 && !params().getIncludedChildren().empty();
4637 return preview(format, update_unincluded);
4641 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4643 MarkAsExporting exporting(this);
4645 // (1) export with all included children (omit \includeonly)
4647 ExportStatus const status = doExport(format, true, true, result_file);
4648 if (status != ExportSuccess)
4651 // (2) export with included children only
4652 ExportStatus const status = doExport(format, true, false, result_file);
4653 FileName const previewFile(result_file);
4655 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4656 theimpl->preview_file_ = previewFile;
4657 theimpl->preview_format_ = format;
4658 theimpl->require_fresh_start_ = (status != ExportSuccess);
4660 if (status != ExportSuccess)
4663 if (previewFile.exists())
4664 return theFormats().view(*this, previewFile, format) ?
4665 PreviewSuccess : PreviewError;
4667 // Successful export but no output file?
4668 // Probably a bug in error detection.
4669 LATTEST(status != ExportSuccess);
4674 Buffer::ReadStatus Buffer::extractFromVC()
4676 bool const found = LyXVC::file_not_found_hook(d->filename);
4678 return ReadFileNotFound;
4679 if (!d->filename.isReadableFile())
4685 Buffer::ReadStatus Buffer::loadEmergency()
4687 FileName const emergencyFile = getEmergencyFileName();
4688 if (!emergencyFile.exists()
4689 || emergencyFile.lastModified() <= d->filename.lastModified())
4690 return ReadFileNotFound;
4692 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4693 docstring const text = bformat(_("An emergency save of the document "
4694 "%1$s exists.\n\nRecover emergency save?"), file);
4696 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4697 0, 3, _("&Recover"), _("&Load Original"), _("&Only show difference"), _("&Cancel"));
4703 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4704 bool const success = (ret_llf == ReadSuccess);
4706 if (hasReadonlyFlag()) {
4707 Alert::warning(_("File is read-only"),
4708 bformat(_("An emergency file is successfully loaded, "
4709 "but the original file %1$s is marked read-only. "
4710 "Please make sure to save the document as a different "
4711 "file."), from_utf8(d->filename.absFileName())));
4714 lyxvc().file_found_hook(d->filename);
4715 str = _("Document was successfully recovered.");
4717 str = _("Document was NOT successfully recovered.");
4718 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4719 makeDisplayPath(emergencyFile.absFileName()));
4721 int const del_emerg =
4722 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4723 _("&Remove"), _("&Keep"));
4724 if (del_emerg == 0) {
4725 emergencyFile.removeFile();
4727 Alert::warning(_("Emergency file deleted"),
4728 _("Do not forget to save your file now!"), true);
4730 return success ? ReadSuccess : ReadEmergencyFailure;
4733 int const del_emerg =
4734 Alert::prompt(_("Delete emergency file?"),
4735 _("Remove emergency file now?"), 1, 1,
4736 _("&Remove"), _("&Keep"));
4738 emergencyFile.removeFile();
4742 string const ename = emergencyFile.absFileName();
4744 // Surely we can find one in 100 tries?
4745 for (int i = 1; i < 100; ++i) {
4746 newname.set(ename + to_string(i) + ".lyx");
4747 if (!newname.exists()) {
4753 // renameTo returns true on success. So inverting that
4754 // will give us true if we fail.
4755 noname = !emergencyFile.renameTo(newname);
4758 Alert::warning(_("Can't rename emergency file!"),
4759 _("LyX was unable to rename the emergency file. "
4760 "You should do so manually. Otherwise, you will be "
4761 "asked about it again the next time you try to load "
4762 "this file, and may over-write your own work."));
4764 Alert::warning(_("Emergency File Renames"),
4765 bformat(_("Emergency file renamed as:\n %1$s"),
4766 from_utf8(newname.onlyFileName())));
4769 return ReadOriginal;
4773 string f1 = d->filename.absFileName();
4774 string f2 = emergencyFile.absFileName();
4775 if (loadThisLyXFile(d->filename) != ReadSuccess)
4777 string par = "compare run-blocking " + quoteName(f1) + " " + quoteName(f2);
4778 LYXERR(Debug::FILES, par << "\n");
4779 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, par));
4781 //release the emergency buffer loaded by compare
4782 Buffer * emerBuffer = theBufferList().getBuffer(emergencyFile);
4783 if (emerBuffer) theBufferList().release(emerBuffer);
4785 return ReadCancel; //Release the buffer of Original immediatelly
4794 Buffer::ReadStatus Buffer::loadAutosave()
4796 // Now check if autosave file is newer.
4797 FileName const autosaveFile = getAutosaveFileName();
4798 if (!autosaveFile.exists()
4799 || autosaveFile.lastModified() <= d->filename.lastModified())
4800 return ReadFileNotFound;
4802 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4803 docstring const text = bformat(_("The backup of the document %1$s "
4804 "is newer.\n\nLoad the backup instead?"), file);
4805 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4806 _("&Load backup"), _("Load &original"), _("&Cancel"));
4811 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4812 // the file is not saved if we load the autosave file.
4813 if (ret_llf == ReadSuccess) {
4814 if (hasReadonlyFlag()) {
4815 Alert::warning(_("File is read-only"),
4816 bformat(_("A backup file is successfully loaded, "
4817 "but the original file %1$s is marked read-only. "
4818 "Please make sure to save the document as a "
4820 from_utf8(d->filename.absFileName())));
4823 lyxvc().file_found_hook(d->filename);
4826 return ReadAutosaveFailure;
4829 // Here we delete the autosave
4830 autosaveFile.removeFile();
4831 return ReadOriginal;
4839 Buffer::ReadStatus Buffer::loadLyXFile()
4841 if (!d->filename.isReadableFile()) {
4842 ReadStatus const ret_rvc = extractFromVC();
4843 if (ret_rvc != ReadSuccess)
4847 ReadStatus const ret_re = loadEmergency();
4848 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4851 ReadStatus const ret_ra = loadAutosave();
4852 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4855 return loadThisLyXFile(d->filename);
4859 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4861 return readFile(fn);
4865 void Buffer::Impl::traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const
4867 for (; err != end; ++err) {
4868 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4869 int errorRow = err->error_in_line;
4870 Buffer const * buf = nullptr;
4871 Impl const * p = this;
4872 if (err->child_name.empty())
4873 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4875 // The error occurred in a child
4876 for (Buffer const * child : owner_->getDescendants()) {
4877 string const child_name =
4878 DocFileName(changeExtension(child->absFileName(), "tex")).
4880 if (err->child_name != child_name)
4882 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4883 if (!TexRow::isNone(start)) {
4884 buf = this->cloned_buffer_
4885 ? child->d->cloned_buffer_->d->owner_
4892 errorList.push_back(ErrorItem(err->error_desc, err->error_text,
4898 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4900 TeXErrors::Errors::const_iterator err = terr.begin();
4901 TeXErrors::Errors::const_iterator end = terr.end();
4903 d->traverseErrors(err, end, errorList);
4907 void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const
4909 TeXErrors::Errors::const_iterator err = terr.begin_ref();
4910 TeXErrors::Errors::const_iterator end = terr.end_ref();
4912 d->traverseErrors(err, end, errorList);
4916 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4918 LBUFERR(!text().paragraphs().empty());
4920 // Use the master text class also for child documents
4921 Buffer const * const master = masterBuffer();
4922 DocumentClass const & textclass = master->params().documentClass();
4924 docstring_list old_bibfiles;
4925 // Do this only if we are the top-level Buffer. We also need to account
4926 // for the case of a previewed child with ignored parent here.
4927 if (master == this && !d->ignore_parent) {
4928 textclass.counters().reset(from_ascii("bibitem"));
4929 reloadBibInfoCache();
4930 // we will re-read this cache as we go through, but we need
4931 // to know whether it's changed to know whether we need to
4932 // update the bibinfo cache.
4933 old_bibfiles = d->bibfiles_cache_;
4934 d->bibfiles_cache_.clear();
4937 // keep the buffers to be children in this set. If the call from the
4938 // master comes back we can see which of them were actually seen (i.e.
4939 // via an InsetInclude). The remaining ones in the set need still be updated.
4940 static std::set<Buffer const *> bufToUpdate;
4941 if (scope == UpdateMaster) {
4942 // If this is a child document start with the master
4943 if (master != this) {
4944 bufToUpdate.insert(this);
4945 master->updateBuffer(UpdateMaster, utype);
4946 // If the master buffer has no gui associated with it, then the TocModel is
4947 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4948 // (bug 5699). The same happens if the master buffer is open in a different
4949 // window. This test catches both possibilities.
4950 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
4951 // There remains a problem here: If there is another child open in yet a third
4952 // window, that TOC is not updated. So some more general solution is needed at
4954 if (master->d->gui_ != d->gui_)
4957 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4958 if (bufToUpdate.find(this) == bufToUpdate.end())
4962 // start over the counters in the master
4963 textclass.counters().reset();
4966 // update will be done below for this buffer
4967 bufToUpdate.erase(this);
4969 // update all caches
4970 clearReferenceCache();
4973 Buffer & cbuf = const_cast<Buffer &>(*this);
4974 // if we are reloading, then we could have a dangling TOC,
4975 // in effect. so we need to go ahead and reset, even though
4976 // we will do so again when we rebuild the TOC later.
4977 cbuf.tocBackend().reset();
4980 ParIterator parit = cbuf.par_iterator_begin();
4981 if (scope == UpdateMaster)
4983 updateBuffer(parit, utype);
4985 // If this document has siblings, then update the TocBackend later. The
4986 // reason is to ensure that later siblings are up to date when e.g. the
4987 // broken or not status of references is computed. The update is called
4988 // in InsetInclude::addToToc.
4992 // if the bibfiles changed, the cache of bibinfo is invalid
4993 docstring_list new_bibfiles = d->bibfiles_cache_;
4994 // this is a trick to determine whether the two vectors have
4995 // the same elements.
4996 sort(new_bibfiles.begin(), new_bibfiles.end());
4997 sort(old_bibfiles.begin(), old_bibfiles.end());
4998 if (old_bibfiles != new_bibfiles) {
4999 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
5000 invalidateBibinfoCache();
5001 reloadBibInfoCache();
5002 // We relied upon the bibinfo cache when recalculating labels. But that
5003 // cache was invalid, although we didn't find that out until now. So we
5004 // have to do it all again.
5005 // That said, the only thing we really need to do is update the citation
5006 // labels. Nothing else will have changed. So we could create a new
5007 // UpdateType that would signal that fact, if we needed to do so.
5008 parit = cbuf.par_iterator_begin();
5009 // we will be re-doing the counters and references and such.
5010 textclass.counters().reset();
5011 clearReferenceCache();
5012 // we should not need to do this again?
5014 updateBuffer(parit, utype);
5015 // this will already have been done by reloadBibInfoCache();
5016 // d->bibinfo_cache_valid_ = true;
5019 LYXERR(Debug::FILES, "Bibfiles unchanged.");
5020 // this is also set to true on the other path, by reloadBibInfoCache.
5021 d->bibinfo_cache_valid_ = true;
5023 d->cite_labels_valid_ = true;
5026 cbuf.tocBackend().update(true, utype);
5027 if (scope == UpdateMaster)
5028 cbuf.structureChanged();
5030 d->need_update = false;
5034 static depth_type getDepth(DocIterator const & it)
5036 depth_type depth = 0;
5037 for (size_t i = 0 ; i < it.depth() ; ++i)
5038 if (!it[i].inset().inMathed())
5039 depth += it[i].paragraph().getDepth() + 1;
5040 // remove 1 since the outer inset does not count
5041 // we should have at least one non-math inset, so
5042 // depth should nevery be 0. but maybe it is worth
5043 // marking this, just in case.
5045 // coverity[INTEGER_OVERFLOW]
5049 static depth_type getItemDepth(ParIterator const & it)
5051 Paragraph const & par = *it;
5052 LabelType const labeltype = par.layout().labeltype;
5054 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5057 // this will hold the lowest depth encountered up to now.
5058 depth_type min_depth = getDepth(it);
5059 ParIterator prev_it = it;
5062 --prev_it.top().pit();
5064 // start of nested inset: go to outer par
5066 if (prev_it.empty()) {
5067 // start of document: nothing to do
5072 // We search for the first paragraph with same label
5073 // that is not more deeply nested.
5074 Paragraph & prev_par = *prev_it;
5075 depth_type const prev_depth = getDepth(prev_it);
5076 if (labeltype == prev_par.layout().labeltype) {
5077 if (prev_depth < min_depth)
5078 return prev_par.itemdepth + 1;
5079 if (prev_depth == min_depth)
5080 return prev_par.itemdepth;
5082 min_depth = min(min_depth, prev_depth);
5083 // small optimization: if we are at depth 0, we won't
5084 // find anything else
5085 if (prev_depth == 0)
5091 static bool needEnumCounterReset(ParIterator const & it)
5093 Paragraph const & par = *it;
5094 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5095 depth_type const cur_depth = par.getDepth();
5096 ParIterator prev_it = it;
5097 while (prev_it.pit()) {
5098 --prev_it.top().pit();
5099 Paragraph const & prev_par = *prev_it;
5100 if (prev_par.getDepth() <= cur_depth)
5101 return prev_par.layout().name() != par.layout().name();
5103 // start of nested inset: reset
5108 // set the label of a paragraph. This includes the counters.
5109 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5111 BufferParams const & bp = owner_->masterBuffer()->params();
5112 DocumentClass const & textclass = bp.documentClass();
5113 Paragraph & par = it.paragraph();
5114 Layout const & layout = par.layout();
5115 Counters & counters = textclass.counters();
5117 if (par.params().startOfAppendix()) {
5118 // We want to reset the counter corresponding to toplevel sectioning
5119 Layout const & lay = textclass.getTOCLayout();
5120 docstring const cnt = lay.counter;
5122 counters.reset(cnt);
5123 counters.appendix(true);
5125 par.params().appendix(counters.appendix());
5127 // Compute the item depth of the paragraph
5128 par.itemdepth = getItemDepth(it);
5130 if (layout.margintype == MARGIN_MANUAL) {
5131 if (par.params().labelWidthString().empty())
5132 par.params().labelWidthString(par.expandLabel(layout, bp));
5133 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5134 // we do not need to do anything here, since the empty case is
5135 // handled during export.
5137 par.params().labelWidthString(docstring());
5140 switch(layout.labeltype) {
5141 case LABEL_ITEMIZE: {
5142 // At some point of time we should do something more
5143 // clever here, like:
5144 // par.params().labelString(
5145 // bp.user_defined_bullet(par.itemdepth).getText());
5146 // for now, use a simple hardcoded label
5147 docstring itemlabel;
5148 switch (par.itemdepth) {
5151 itemlabel = char_type(0x2022);
5155 itemlabel = char_type(0x2013);
5158 // ∗ U+2217 ASTERISK OPERATOR
5159 itemlabel = char_type(0x2217);
5162 // · U+00B7 MIDDLE DOT
5163 itemlabel = char_type(0x00b7);
5166 par.params().labelString(itemlabel);
5170 case LABEL_ENUMERATE: {
5171 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5173 switch (par.itemdepth) {
5184 enumcounter += "iv";
5187 // not a valid enumdepth...
5191 if (needEnumCounterReset(it)) {
5192 // Increase the parent counter?
5193 if (layout.stepparentcounter)
5194 counters.stepParent(enumcounter, utype);
5195 // Maybe we have to reset the enumeration counter.
5196 if (!layout.resumecounter)
5197 counters.reset(enumcounter);
5199 counters.step(enumcounter, utype);
5201 string const & lang = par.getParLanguage(bp)->code();
5202 par.params().labelString(counters.theCounter(enumcounter, lang));
5207 case LABEL_SENSITIVE: {
5208 string const & type = counters.current_float();
5209 docstring full_label;
5211 full_label = owner_->B_("Senseless!!! ");
5213 docstring name = owner_->B_(textclass.floats().getType(type).name());
5214 if (counters.hasCounter(from_utf8(type))) {
5215 string const & lang = par.getParLanguage(bp)->code();
5216 counters.step(from_utf8(type), utype);
5217 full_label = bformat(from_ascii("%1$s %2$s:"),
5219 counters.theCounter(from_utf8(type), lang));
5221 full_label = bformat(from_ascii("%1$s #:"), name);
5223 par.params().labelString(full_label);
5227 case LABEL_NO_LABEL:
5228 par.params().labelString(docstring());
5232 case LABEL_CENTERED:
5233 case LABEL_STATIC: {
5234 docstring const & lcounter = layout.counter;
5235 if (!lcounter.empty()) {
5236 if (layout.toclevel <= bp.secnumdepth
5237 && (layout.latextype != LATEX_ENVIRONMENT
5238 || it.text()->isFirstInSequence(it.pit()))) {
5239 if (counters.hasCounter(lcounter))
5240 counters.step(lcounter, utype);
5241 par.params().labelString(par.expandLabel(layout, bp));
5243 par.params().labelString(docstring());
5245 par.params().labelString(par.expandLabel(layout, bp));
5251 par.params().labelString(par.expandLabel(layout, bp));
5256 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype, bool const deleted) const
5258 pushIncludedBuffer(this);
5259 // LASSERT: Is it safe to continue here, or should we just return?
5260 LASSERT(parit.pit() == 0, /**/);
5262 // Set the position of the text in the buffer to be able
5263 // to resolve macros in it.
5264 parit.text()->setMacrocontextPosition(parit);
5266 depth_type maxdepth = 0;
5267 pit_type const lastpit = parit.lastpit();
5268 bool changed = false;
5269 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5270 // reduce depth if necessary
5271 if (parit->params().depth() > maxdepth) {
5272 /** FIXME: this function is const, but
5273 * nevertheless it modifies the buffer. To be
5274 * cleaner, one should modify the buffer in
5275 * another function, which is actually
5276 * non-const. This would however be costly in
5277 * terms of code duplication.
5279 CursorData(parit).recordUndo();
5280 parit->params().depth(maxdepth);
5282 maxdepth = parit->getMaxDepthAfter();
5284 if (utype == OutputUpdate) {
5285 // track the active counters
5286 // we have to do this for the master buffer, since the local
5287 // buffer isn't tracking anything.
5288 masterBuffer()->params().documentClass().counters().
5289 setActiveLayout(parit->layout());
5292 // set the counter for this paragraph
5293 d->setLabel(parit, utype);
5296 for (auto const & insit : parit->insetList()) {
5297 parit.pos() = insit.pos;
5298 insit.inset->updateBuffer(parit, utype, deleted || parit->isDeleted(insit.pos));
5299 changed |= insit.inset->isChanged();
5302 // are there changes in this paragraph?
5303 changed |= parit->isChanged();
5306 // set change indicator for the inset (or the cell that the iterator
5307 // points to, if applicable).
5308 parit.text()->inset().isChanged(changed);
5309 popIncludedBuffer();
5313 void Buffer::forceUpdate() const
5315 d->need_update = true;
5319 bool Buffer::needUpdate() const
5321 return d->need_update;
5325 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5326 WordLangTuple & word_lang, docstring_list & suggestions) const
5330 suggestions.clear();
5331 word_lang = WordLangTuple();
5332 bool const to_end = to.empty();
5333 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5334 // OK, we start from here.
5335 for (; from != end; from.forwardPos()) {
5336 // This skips all insets with spell check disabled.
5337 while (!from.allowSpellCheck()) {
5341 // If from is at the end of the document (which is possible
5342 // when "from" was changed above) LyX will crash later otherwise.
5343 if (from.atEnd() || (!to_end && from >= end))
5346 from.paragraph().spellCheck();
5347 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5348 if (SpellChecker::misspelled(res)) {
5352 // Do not increase progress when from == to, otherwise the word
5353 // count will be wrong.
5363 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5365 bool inword = false;
5370 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5371 if (!dit.inTexted()) {
5376 Paragraph const & par = dit.paragraph();
5377 pos_type const pos = dit.pos();
5379 // Copied and adapted from isWordSeparator() in Paragraph
5380 if (pos == dit.lastpos()) {
5383 Inset const * ins = par.getInset(pos);
5384 if (ins && skipNoOutput && !ins->producesOutput()) {
5387 // stop if end of range was skipped
5388 if (!to.atEnd() && dit >= to)
5391 } else if (!par.isDeleted(pos)) {
5392 if (par.isWordSeparator(pos))
5398 if (ins && ins->isLetter()) {
5399 odocstringstream os;
5401 char_count_ += os.str().length();
5403 else if (ins && ins->isSpace())
5406 pair<int, int> words = ins->isWords();
5407 char_count_ += words.first;
5408 word_count_ += words.second;
5412 char_type const c = par.getChar(pos);
5413 if (isPrintableNonspace(c))
5415 else if (isSpace(c))
5425 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5427 d->updateStatistics(from, to, skipNoOutput);
5431 int Buffer::wordCount() const
5433 return d->wordCount();
5437 int Buffer::charCount(bool with_blanks) const
5439 return d->charCount(with_blanks);
5443 bool Buffer::areChangesPresent() const
5445 return inset().isChanged();
5449 Buffer::ReadStatus Buffer::reload()
5452 // c.f. bug https://www.lyx.org/trac/ticket/6587
5453 removeAutosaveFile();
5454 // e.g., read-only status could have changed due to version control
5455 d->filename.refresh();
5456 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5458 // clear parent. this will get reset if need be.
5459 d->setParent(nullptr);
5460 ReadStatus const status = loadLyXFile();
5461 if (status == ReadSuccess) {
5466 message(bformat(_("Document %1$s reloaded."), disp_fn));
5469 message(bformat(_("Could not reload document %1$s."), disp_fn));
5479 bool Buffer::saveAs(FileName const & fn)
5481 FileName const old_name = fileName();
5482 FileName const old_auto = getAutosaveFileName();
5483 bool const old_unnamed = isUnnamed();
5484 bool success = true;
5485 d->old_position = filePath();
5492 // bring the autosave file with us, just in case.
5493 moveAutosaveFile(old_auto);
5494 // validate version control data and
5495 // correct buffer title
5496 lyxvc().file_found_hook(fileName());
5498 // the file has now been saved to the new location.
5499 // we need to check that the locations of child buffers
5501 checkChildBuffers();
5502 checkMasterBuffer();
5505 // reset the old filename and unnamed state
5506 setFileName(old_name);
5507 setUnnamed(old_unnamed);
5511 d->old_position.clear();
5516 void Buffer::checkChildBuffers()
5518 for (auto const & bit : d->children_positions) {
5519 DocIterator dit = bit.second;
5520 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5521 if (!cbuf || !theBufferList().isLoaded(cbuf))
5523 Inset * inset = dit.nextInset();
5524 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5525 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5526 docstring const & incfile = inset_inc->getParam("filename");
5527 string oldloc = cbuf->absFileName();
5528 string newloc = makeAbsPath(to_utf8(incfile),
5529 onlyPath(absFileName())).absFileName();
5530 if (oldloc == newloc)
5532 // the location of the child file is incorrect.
5533 cbuf->setParent(nullptr);
5534 inset_inc->setChildBuffer(nullptr);
5536 // invalidate cache of children
5537 d->children_positions.clear();
5538 d->position_to_children.clear();
5542 // If a child has been saved under a different name/path, it might have been
5543 // orphaned. Therefore the master needs to be reset (bug 8161).
5544 void Buffer::checkMasterBuffer()
5546 Buffer const * const master = masterBuffer();
5550 // necessary to re-register the child (bug 5873)
5551 // FIXME: clean up updateMacros (here, only
5552 // child registering is needed).
5553 master->updateMacros();
5554 // (re)set master as master buffer, but only
5555 // if we are a real child
5556 if (master->isChild(this))
5563 string Buffer::includedFilePath(string const & name, string const & ext) const
5565 if (d->old_position.empty() ||
5566 equivalent(FileName(d->old_position), FileName(filePath())))
5569 bool isabsolute = FileName::isAbsolute(name);
5570 // both old_position and filePath() end with a path separator
5571 string absname = isabsolute ? name : d->old_position + name;
5573 // if old_position is set to origin, we need to do the equivalent of
5574 // getReferencedFileName() (see readDocument())
5575 if (!isabsolute && d->old_position == params().origin) {
5576 FileName const test(addExtension(filePath() + name, ext));
5578 absname = filePath() + name;
5581 if (!FileName(addExtension(absname, ext)).exists())
5585 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5587 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5588 from_utf8(filePath())));
5592 void Buffer::Impl::refreshFileMonitor()
5594 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5595 file_monitor_->refresh();
5599 // The previous file monitor is invalid
5600 // This also destroys the previous file monitor and all its connections
5601 file_monitor_ = FileSystemWatcher::monitor(filename);
5602 // file_monitor_ will be destroyed with *this, so it is not going to call a
5603 // destroyed object method.
5604 file_monitor_->connect([this](bool exists) {
5605 fileExternallyModified(exists);
5610 void Buffer::Impl::fileExternallyModified(bool const exists)
5612 // ignore notifications after our own saving operations
5613 if (checksum_ == filename.checksum()) {
5614 LYXERR(Debug::FILES, "External modification but "
5615 "checksum unchanged: " << filename);
5618 // If the file has been deleted, only mark the file as dirty since it is
5619 // pointless to prompt for reloading. If later a file is moved into this
5620 // location, then the externally modified warning will appear then.
5622 externally_modified_ = true;
5623 // Update external modification notification.
5624 // Dirty buffers must be visible at all times.
5625 if (wa_ && wa_->unhide(owner_))
5626 wa_->updateTitles();
5628 // Unable to unhide the buffer (e.g. no GUI or not current View)
5633 bool Buffer::notifiesExternalModification() const
5635 return d->externally_modified_;
5639 void Buffer::clearExternalModification() const
5641 d->externally_modified_ = false;
5643 d->wa_->updateTitles();
5647 void Buffer::pushIncludedBuffer(Buffer const * buf) const
5649 masterBuffer()->d->include_list_.push_back(buf);
5650 if (lyxerr.debugging(Debug::FILES)) {
5651 LYXERR0("Pushed. Stack now:");
5652 if (masterBuffer()->d->include_list_.empty())
5655 for (auto const & b : masterBuffer()->d->include_list_)
5656 LYXERR0(b->fileName());
5661 void Buffer::popIncludedBuffer() const
5663 masterBuffer()->d->include_list_.pop_back();
5664 if (lyxerr.debugging(Debug::FILES)) {
5665 LYXERR0("Popped. Stack now:");
5666 if (masterBuffer()->d->include_list_.empty())
5669 for (auto const & b : masterBuffer()->d->include_list_)
5670 LYXERR0(b->fileName());
5675 bool Buffer::isBufferIncluded(Buffer const * buf) const
5679 if (lyxerr.debugging(Debug::FILES)) {
5680 LYXERR0("Checking for " << buf->fileName() << ". Stack now:");
5681 if (masterBuffer()->d->include_list_.empty())
5684 for (auto const & b : masterBuffer()->d->include_list_)
5685 LYXERR0(b->fileName());
5687 list<Buffer const *> const & blist = masterBuffer()->d->include_list_;
5688 return find(blist.begin(), blist.end(), buf) != blist.end();
5692 void Buffer::clearIncludeList() const
5694 LYXERR(Debug::FILES, "Clearing include list for " << fileName());
5695 d->include_list_.clear();