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::isSyncTeXenabled() const
1115 bool enabled = params().output_sync;
1118 for (auto const & c : theConverters()) {
1119 const string dest = c.to().substr(0,3);
1120 if (dest == "dvi" || dest == "pdf") {
1121 const string cmd = c.command();
1122 enabled |= cmd.find("--synctex=1") != string::npos;
1129 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1131 Format const * fmt = theFormats().getFormat(format);
1134 // It is important to use the correct extension here, since some
1135 // converters create a wrong output file otherwise (e.g. html2latex)
1136 FileName const name = tempFileName("Buffer_importStringXXXXXX." + fmt->extension());
1137 ofdocstream os(name.toFilesystemEncoding().c_str());
1138 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1139 bool const success = !(os << contents).fail();
1142 bool converted = false;
1144 params().compressed = false;
1146 // remove dummy empty par
1147 paragraphs().clear();
1149 converted = importFile(format, name, errorList);
1152 removeTempFile(name);
1157 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1159 if (!theConverters().isReachable(format, "lyx"))
1162 FileName const lyx = tempFileName("Buffer_importFileXXXXXX.lyx");
1163 Converters::RetVal const retval =
1164 theConverters().convert(this, name, lyx, name, format, "lyx", errorList);
1165 if (retval == Converters::SUCCESS) {
1166 bool const success = readFile(lyx) == ReadSuccess;
1167 removeTempFile(lyx);
1175 bool Buffer::readString(string const & s)
1177 params().compressed = false;
1180 istringstream is(s);
1182 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1183 FileName const fn = tempfile.name();
1186 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1188 if (success && file_format != LYX_FORMAT) {
1189 // We need to call lyx2lyx, so write the input to a file
1190 ofstream os(fn.toFilesystemEncoding().c_str());
1193 // lyxvc in readFile
1194 if (readFile(fn) != ReadSuccess)
1198 if (readDocument(lex))
1204 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1207 if (!lex.setFile(fn)) {
1208 Alert::error(_("File Not Found"),
1209 bformat(_("Unable to open file `%1$s'."),
1210 from_utf8(fn.absFileName())));
1211 return ReadFileNotFound;
1215 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1216 if (ret_plf != ReadSuccess)
1219 if (file_format != LYX_FORMAT) {
1221 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1222 if (ret_clf != ReadSuccess)
1224 ret_clf = readFile(tmpFile);
1225 if (ret_clf == ReadSuccess) {
1226 d->file_format = file_format;
1227 d->need_format_backup = true;
1232 // FIXME: InsetInfo needs to know whether the file is under VCS
1233 // during the parse process, so this has to be done before.
1234 lyxvc().file_found_hook(d->filename);
1236 if (readDocument(lex)) {
1237 Alert::error(_("Document format failure"),
1238 bformat(_("%1$s ended unexpectedly, which means"
1239 " that it is probably corrupted."),
1240 from_utf8(fn.absFileName())));
1241 return ReadDocumentFailure;
1244 d->file_fully_loaded = true;
1245 d->read_only = !d->filename.isWritable();
1246 params().compressed = theFormats().isZippedFile(d->filename);
1252 bool Buffer::isFullyLoaded() const
1254 return d->file_fully_loaded;
1258 void Buffer::setFullyLoaded(bool value)
1260 d->file_fully_loaded = value;
1264 bool Buffer::freshStartRequired() const
1266 return d->require_fresh_start_;
1269 void Buffer::requireFreshStart(bool const b) const
1271 d->require_fresh_start_ = b;
1275 PreviewLoader * Buffer::loader() const
1277 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1279 if (!d->preview_loader_)
1280 d->preview_loader_ = new PreviewLoader(*this);
1281 return d->preview_loader_;
1285 void Buffer::removePreviews() const
1287 delete d->preview_loader_;
1288 d->preview_loader_ = nullptr;
1292 void Buffer::updatePreviews() const
1294 PreviewLoader * ploader = loader();
1298 InsetIterator it = begin(*d->inset);
1299 InsetIterator const itend = end(*d->inset);
1300 for (; it != itend; ++it)
1301 it->addPreview(it, *ploader);
1303 ploader->startLoading();
1307 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1308 FileName const & fn, int & file_format) const
1310 if(!lex.checkFor("\\lyxformat")) {
1311 Alert::error(_("Document format failure"),
1312 bformat(_("%1$s is not a readable LyX document."),
1313 from_utf8(fn.absFileName())));
1314 return ReadNoLyXFormat;
1320 // LyX formats 217 and earlier were written as 2.17. This corresponds
1321 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1322 // these cases. See also: www.lyx.org/trac/changeset/1313.
1323 size_t dot = tmp_format.find_first_of(".,");
1324 if (dot != string::npos)
1325 tmp_format.erase(dot, 1);
1327 file_format = convert<int>(tmp_format);
1332 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1333 FileName & tmpfile, int from_format)
1335 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1336 tempfile.setAutoRemove(false);
1337 tmpfile = tempfile.name();
1338 if(tmpfile.empty()) {
1339 Alert::error(_("Conversion failed"),
1340 bformat(_("%1$s is from a different"
1341 " version of LyX, but a temporary"
1342 " file for converting it could"
1343 " not be created."),
1344 from_utf8(fn.absFileName())));
1345 return LyX2LyXNoTempFile;
1348 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1349 if (lyx2lyx.empty()) {
1350 Alert::error(_("Conversion script not found"),
1351 bformat(_("%1$s is from a different"
1352 " version of LyX, but the"
1353 " conversion script lyx2lyx"
1354 " could not be found."),
1355 from_utf8(fn.absFileName())));
1356 return LyX2LyXNotFound;
1360 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1361 ostringstream command;
1362 command << os::python()
1363 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1364 << " -t " << convert<string>(LYX_FORMAT)
1365 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1366 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1367 string const command_str = command.str();
1369 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1371 cmd_ret const ret = runCommand(command_str);
1373 if (from_format < LYX_FORMAT) {
1374 Alert::error(_("Conversion script failed"),
1375 bformat(_("%1$s is from an older version"
1376 " of LyX and the lyx2lyx script"
1377 " failed to convert it."),
1378 from_utf8(fn.absFileName())));
1379 return LyX2LyXOlderFormat;
1381 Alert::error(_("Conversion script failed"),
1382 bformat(_("%1$s is from a newer version"
1383 " of LyX and the lyx2lyx script"
1384 " failed to convert it."),
1385 from_utf8(fn.absFileName())));
1386 return LyX2LyXNewerFormat;
1393 FileName Buffer::getBackupName() const {
1394 map<int, string> const file_formats = {
1411 FileName const & fn = fileName();
1412 string const fname = fn.onlyFileNameWithoutExt();
1413 string const fext = fn.extension() + "~";
1414 string const fpath = lyxrc.backupdir_path.empty() ?
1415 fn.onlyPath().absFileName() :
1416 lyxrc.backupdir_path;
1417 string backup_suffix;
1418 // If file format is from a stable series use version instead of file format
1419 auto const it = file_formats.find(d->file_format);
1420 if (it != file_formats.end())
1421 backup_suffix = "-lyx" + it->second;
1423 backup_suffix = "-lyxformat-" + convert<string>(d->file_format);
1424 string const backname = fname + backup_suffix;
1425 FileName backup(addName(fpath, addExtension(backname, fext)));
1427 // limit recursion, just in case
1429 unsigned long orig_checksum = 0;
1430 while (backup.exists() && v < 100) {
1431 if (orig_checksum == 0)
1432 orig_checksum = fn.checksum();
1433 unsigned long new_checksum = backup.checksum();
1434 if (orig_checksum == new_checksum) {
1435 LYXERR(Debug::FILES, "Not backing up " << fn <<
1436 "since " << backup << "has the same checksum.");
1437 // a bit of a hack, but we have to check this anyway
1438 // below, and setting this is simpler than introducing
1439 // a special boolean for this purpose.
1443 string const newbackname = backname + "-" + convert<string>(v);
1444 backup.set(addName(fpath, addExtension(newbackname, fext)));
1447 return v < 100 ? backup : FileName();
1451 // Should probably be moved to somewhere else: BufferView? GuiView?
1452 bool Buffer::save() const
1454 docstring const file = makeDisplayPath(absFileName(), 20);
1455 d->filename.refresh();
1457 // check the read-only status before moving the file as a backup
1458 if (d->filename.exists()) {
1459 bool const read_only = !d->filename.isWritable();
1461 Alert::warning(_("File is read-only"),
1462 bformat(_("The file %1$s cannot be written because it "
1463 "is marked as read-only."), file));
1468 // ask if the disk file has been externally modified (use checksum method)
1469 if (fileName().exists() && isChecksumModified()) {
1471 bformat(_("Document %1$s has been externally modified. "
1472 "Are you sure you want to overwrite this file?"), file);
1473 int const ret = Alert::prompt(_("Overwrite modified file?"),
1474 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1479 // We don't need autosaves in the immediate future. (Asger)
1480 resetAutosaveTimers();
1482 // if the file does not yet exist, none of the backup activity
1483 // that follows is necessary
1484 if (!fileName().exists()) {
1485 if (!writeFile(fileName()))
1491 // we first write the file to a new name, then move it to its
1492 // proper location once that has been done successfully. that
1493 // way we preserve the original file if something goes wrong.
1494 string const justname = fileName().onlyFileNameWithoutExt();
1495 auto tempfile = lyx::make_unique<TempFile>(fileName().onlyPath(),
1496 justname + "-XXXXXX.lyx");
1497 bool const symlink = fileName().isSymLink();
1499 tempfile->setAutoRemove(false);
1501 FileName savefile(tempfile->name());
1502 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1503 if (!savefile.clonePermissions(fileName()))
1504 LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
1506 if (!writeFile(savefile))
1509 // we will set this to false if we fail
1510 bool made_backup = true;
1512 FileName backupName;
1513 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1515 if (d->need_format_backup)
1516 backupName = getBackupName();
1518 // If we for some reason failed to find a backup name in case of
1519 // a format change, this will still set one. It's the best we can
1521 if (backupName.empty()) {
1522 backupName.set(fileName().absFileName() + "~");
1523 if (!lyxrc.backupdir_path.empty()) {
1524 string const mangledName =
1525 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1526 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1530 LYXERR(Debug::FILES, "Backing up original file to " <<
1531 backupName.absFileName());
1532 // Except file is symlink do not copy because of #6587.
1533 // Hard links have bad luck.
1534 made_backup = symlink ?
1535 fileName().copyTo(backupName):
1536 fileName().moveTo(backupName);
1539 Alert::error(_("Backup failure"),
1540 bformat(_("Cannot create backup file %1$s.\n"
1541 "Please check whether the directory exists and is writable."),
1542 from_utf8(backupName.absFileName())));
1543 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1544 } else if (d->need_format_backup) {
1545 // the original file has been backed up successfully, so we
1546 // will not need to do that again
1547 d->need_format_backup = false;
1551 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1552 // Only do this if tempfile is not in autoremove mode
1555 // If we have no symlink, we can simply rename the temp file.
1556 // Otherwise, we need to copy it so the symlink stays intact.
1557 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1558 savefile.moveTo(fileName()))
1560 // saveCheckSum() was already called by writeFile(), but the
1561 // time stamp is invalidated by copying/moving
1564 // the file associated with this buffer is now in the current format
1565 d->file_format = LYX_FORMAT;
1568 // else we saved the file, but failed to move it to the right location.
1570 if (needBackup && made_backup && !symlink) {
1571 // the original file was moved to some new location, so it will look
1572 // to the user as if it was deleted. (see bug #9234.) we could try
1573 // to restore it, but that would basically mean trying to do again
1574 // what we just failed to do. better to leave things as they are.
1575 Alert::error(_("Write failure"),
1576 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1577 "But LyX could not move it to:\n %2$s.\n"
1578 "Your original file has been backed up to:\n %3$s"),
1579 from_utf8(savefile.absFileName()),
1580 from_utf8(fileName().absFileName()),
1581 from_utf8(backupName.absFileName())));
1583 // either we did not try to make a backup, or else we tried and failed,
1584 // or else the original file was a symlink, in which case it was copied,
1585 // not moved. so the original file is intact.
1586 Alert::error(_("Write failure"),
1587 bformat(_("Cannot move saved file to:\n %1$s.\n"
1588 "But the file has successfully been saved as:\n %2$s."),
1589 from_utf8(fileName().absFileName()),
1590 from_utf8(savefile.absFileName())));
1596 bool Buffer::writeFile(FileName const & fname) const
1598 if (d->read_only && fname == d->filename)
1601 bool retval = false;
1603 docstring const str = bformat(_("Saving document %1$s..."),
1604 makeDisplayPath(fname.absFileName()));
1607 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1609 if (params().compressed) {
1610 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1611 retval = ofs && write(ofs);
1613 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1614 retval = ofs && write(ofs);
1618 message(str + _(" could not write file!"));
1623 // removeAutosaveFile();
1626 message(str + _(" done."));
1632 docstring Buffer::emergencyWrite() const
1634 // No need to save if the buffer has not changed.
1638 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1640 docstring user_message = bformat(
1641 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1643 // We try to save three places:
1644 // 1) Same place as document. Unless it is an unnamed doc.
1646 string s = absFileName();
1649 if (writeFile(FileName(s))) {
1651 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1652 return user_message;
1654 user_message += " " + _("Save failed! Trying again...\n");
1658 // 2) In HOME directory.
1659 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1661 lyxerr << ' ' << s << endl;
1662 if (writeFile(FileName(s))) {
1664 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1665 return user_message;
1668 user_message += " " + _("Save failed! Trying yet again...\n");
1670 // 3) In "/tmp" directory.
1671 // MakeAbsPath to prepend the current
1672 // drive letter on OS/2
1673 s = addName(package().temp_dir().absFileName(), absFileName());
1675 lyxerr << ' ' << s << endl;
1676 if (writeFile(FileName(s))) {
1678 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1679 return user_message;
1682 user_message += " " + _("Save failed! Document is lost.");
1685 return user_message;
1689 bool Buffer::write(ostream & ofs) const
1692 // Use the standard "C" locale for file output.
1693 ofs.imbue(locale::classic());
1696 // The top of the file should not be written by params().
1698 // write out a comment in the top of the file
1699 // Important: Keep the version formatting in sync with lyx2lyx and
1700 // tex2lyx (bug 7951)
1701 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1702 << " created this file. For more info see https://www.lyx.org/\n"
1703 << "\\lyxformat " << LYX_FORMAT << "\n"
1704 << "\\begin_document\n";
1706 /// For each author, set 'used' to true if there is a change
1707 /// by this author in the document; otherwise set it to 'false'.
1708 for (Author const & a : params().authors())
1711 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1712 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1713 for ( ; it != end; ++it)
1714 it->checkAuthors(params().authors());
1716 // now write out the buffer parameters.
1717 ofs << "\\begin_header\n";
1718 params().writeFile(ofs, this);
1719 ofs << "\\end_header\n";
1722 ofs << "\n\\begin_body\n";
1724 ofs << "\n\\end_body\n";
1726 // Write marker that shows file is complete
1727 ofs << "\\end_document" << endl;
1729 // Shouldn't really be needed....
1732 // how to check if close went ok?
1733 // Following is an attempt... (BE 20001011)
1735 // good() returns false if any error occurred, including some
1736 // formatting error.
1737 // bad() returns true if something bad happened in the buffer,
1738 // which should include file system full errors.
1743 lyxerr << "File was not closed properly." << endl;
1750 Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
1751 string const & original_path,
1752 OutputParams const & runparams_in,
1753 OutputWhat output) const
1755 OutputParams runparams = runparams_in;
1757 string const encoding = runparams.encoding->iconvName();
1758 LYXERR(Debug::OUTFILE, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1761 try { ofs.reset(encoding); }
1762 catch (iconv_codecvt_facet_exception const & e) {
1763 lyxerr << "Caught iconv exception: " << e.what() << endl;
1764 Alert::error(_("Iconv software exception Detected"),
1765 bformat(_("Please verify that the `iconv' support software is"
1766 " properly installed and supports the selected encoding"
1767 " (%1$s), or change the encoding in"
1768 " Document>Settings>Language."), from_ascii(encoding)));
1771 if (!openFileWrite(ofs, fname))
1774 ErrorList & errorList = d->errorLists["Export"];
1776 ExportStatus status = ExportSuccess;
1779 // make sure we are ready to export
1780 // this needs to be done before we validate
1781 // FIXME Do we need to do this all the time? I.e., in children
1782 // of a master we are exporting?
1784 updateMacroInstances(OutputUpdate);
1786 ExportStatus retval;
1788 retval = writeLaTeXSource(os, original_path, runparams, output);
1789 if (retval == ExportKilled)
1790 return ExportKilled;
1792 catch (EncodingException const & e) {
1793 docstring const failed(1, e.failed_char);
1795 oss << "0x" << hex << static_cast<uint32_t>(e.failed_char) << dec;
1796 if (getParFromID(e.par_id).paragraph().layout().pass_thru) {
1797 docstring msg = bformat(_("Uncodable character '%1$s'"
1798 " (code point %2$s)"),
1799 failed, from_utf8(oss.str()));
1800 errorList.push_back(ErrorItem(msg, _("Some characters of your document are not "
1801 "representable in specific verbatim contexts.\n"
1802 "Changing the document encoding to utf8 could help."),
1803 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1805 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1806 " (code point %2$s)"),
1807 failed, from_utf8(oss.str()));
1808 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1809 "representable in the chosen encoding.\n"
1810 "Changing the document encoding to utf8 could help."),
1811 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1813 status = ExportError;
1815 catch (iconv_codecvt_facet_exception const & e) {
1816 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1818 status = ExportError;
1820 catch (exception const & e) {
1821 errorList.push_back(ErrorItem(_("conversion failed"),
1823 lyxerr << e.what() << endl;
1824 status = ExportError;
1827 lyxerr << "Caught some really weird exception..." << endl;
1831 d->texrow = move(os.texrow());
1835 status = ExportError;
1836 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1839 if (runparams_in.silent)
1847 Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
1848 string const & original_path,
1849 OutputParams const & runparams_in,
1850 OutputWhat output) const
1852 // The child documents, if any, shall be already loaded at this point.
1854 OutputParams runparams = runparams_in;
1856 // Some macros rely on font encoding
1857 runparams.main_fontenc = params().main_font_encoding();
1859 // If we are compiling a file standalone, even if this is the
1860 // child of some other buffer, let's cut the link here, so the
1861 // file is really independent and no concurring settings from
1862 // the master (e.g. branch state) interfere (see #8100).
1863 if (!runparams.is_child)
1864 d->ignore_parent = true;
1866 // Classify the unicode characters appearing in math insets
1867 BufferEncodings::initUnicodeMath(*this);
1869 // validate the buffer.
1870 LYXERR(Debug::OUTFILE, " Validating buffer...");
1871 LaTeXFeatures features(*this, params(), runparams);
1873 // This is only set once per document (in master)
1874 if (!runparams.is_child) {
1875 runparams.use_polyglossia = features.usePolyglossia();
1876 runparams.use_hyperref = features.isRequired("hyperref");
1877 runparams.use_CJK = features.mustProvide("CJK");
1879 LYXERR(Debug::OUTFILE, " Buffer validation done.");
1881 bool const output_preamble =
1882 output == FullSource || output == OnlyPreamble;
1883 bool const output_body =
1884 output == FullSource || output == OnlyBody;
1886 // The starting paragraph of the coming rows is the
1887 // first paragraph of the document. (Asger)
1888 if (output_preamble && runparams.nice) {
1889 os << "%% LyX " << lyx_version << " created this file. "
1890 "For more info, see https://www.lyx.org/.\n"
1891 "%% Do not edit unless you really know what "
1894 LYXERR(Debug::INFO, "lyx document header finished");
1896 // There are a few differences between nice LaTeX and usual files:
1897 // usual files have \batchmode and special input@path to allow
1898 // inclusion of figures specified by an explicitly relative path
1899 // (i.e., a path starting with './' or '../') with either \input or
1900 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1901 // input@path is set when the actual parameter original_path is set.
1902 // This is done for usual tex-file, but not for nice-latex-file.
1903 // (Matthias 250696)
1904 // Note that input@path is only needed for something the user does
1905 // in the preamble, included .tex files or ERT, files included by
1906 // LyX work without it.
1907 if (output_preamble) {
1908 if (!runparams.nice) {
1909 // code for usual, NOT nice-latex-file
1910 os << "\\batchmode\n"; // changed from \nonstopmode
1912 if (!original_path.empty()) {
1914 // We don't know the encoding of inputpath
1915 docstring const inputpath = from_utf8(original_path);
1916 docstring uncodable_glyphs;
1917 Encoding const * const enc = runparams.encoding;
1919 for (char_type n : inputpath) {
1920 if (!enc->encodable(n)) {
1921 docstring const glyph(1, n);
1922 LYXERR0("Uncodable character '"
1924 << "' in input path!");
1925 uncodable_glyphs += glyph;
1930 // warn user if we found uncodable glyphs.
1931 if (!uncodable_glyphs.empty()) {
1932 frontend::Alert::warning(
1933 _("Uncodable character in file path"),
1935 _("The path of your document\n"
1937 "contains glyphs that are unknown "
1938 "in the current document encoding "
1939 "(namely %2$s). This may result in "
1940 "incomplete output, unless "
1941 "TEXINPUTS contains the document "
1942 "directory and you don't use "
1943 "explicitly relative paths (i.e., "
1944 "paths starting with './' or "
1945 "'../') in the preamble or in ERT."
1946 "\n\nIn case of problems, choose "
1947 "an appropriate document encoding\n"
1948 "(such as utf8) or change the "
1950 inputpath, uncodable_glyphs));
1952 string docdir = os::latex_path(original_path);
1953 if (contains(docdir, '#')) {
1954 docdir = subst(docdir, "#", "\\#");
1955 os << "\\catcode`\\#=11"
1956 "\\def\\#{#}\\catcode`\\#=6\n";
1958 if (contains(docdir, '%')) {
1959 docdir = subst(docdir, "%", "\\%");
1960 os << "\\catcode`\\%=11"
1961 "\\def\\%{%}\\catcode`\\%=14\n";
1963 if (contains(docdir, '~'))
1964 docdir = subst(docdir, "~", "\\string~");
1965 bool const nonascii = !isAscii(from_utf8(docdir));
1966 // LaTeX 2019/10/01 handles non-ascii path without detokenize
1967 bool const utfpathlatex = features.isAvailable("LaTeX-2019/10/01");
1968 bool const detokenize = !utfpathlatex && nonascii;
1969 bool const quote = contains(docdir, ' ');
1970 if (utfpathlatex && nonascii)
1971 os << "\\UseRawInputEncoding\n";
1972 os << "\\makeatletter\n"
1973 << "\\def\\input@path{{";
1975 os << "\\detokenize{";
1984 << "\\makeatother\n";
1988 // get parent macros (if this buffer has a parent) which will be
1989 // written at the document begin further down.
1990 MacroSet parentMacros;
1991 listParentMacros(parentMacros, features);
1993 // Write the preamble
1994 runparams.use_babel = params().writeLaTeX(os, features,
1995 d->filename.onlyPath());
1997 // Active characters
1998 runparams.active_chars = features.getActiveChars();
2000 // Biblatex bibliographies are loaded here
2001 if (params().useBiblatex()) {
2002 vector<pair<docstring, string>> const bibfiles =
2003 prepareBibFilePaths(runparams, getBibfiles(), true);
2004 for (pair<docstring, string> const & file: bibfiles) {
2005 os << "\\addbibresource";
2006 if (!file.second.empty())
2007 os << "[bibencoding=" << file.second << "]";
2008 os << "{" << file.first << "}\n";
2012 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
2013 && !features.hasOnlyPolyglossiaLanguages()) {
2016 vector<string> bll = features.getBabelExclusiveLanguages();
2017 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
2020 for (string const & sit : bll) {
2025 blangs = bll.size() > 1 ?
2026 bformat(_("The languages %1$s are only supported by Babel."), langs)
2027 : bformat(_("The language %1$s is only supported by Babel."), langs);
2031 for (string const & pit : pll) {
2036 plangs = pll.size() > 1 ?
2037 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
2038 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
2039 if (!blangs.empty())
2043 frontend::Alert::warning(
2044 _("Incompatible Languages!"),
2046 _("You cannot use the following languages "
2047 "together in one LaTeX document because "
2048 "they require conflicting language packages:\n"
2053 // Japanese might be required only in some children of a document,
2054 // but once required, we must keep use_japanese true.
2055 runparams.use_japanese |= features.isRequired("japanese");
2058 // Restore the parenthood if needed
2059 if (!runparams.is_child)
2060 d->ignore_parent = false;
2061 return ExportSuccess;
2065 // mark the beginning of the body to separate it from InPreamble insets
2066 os.texrow().start(TexRow::beginDocument());
2067 os << "\\begin{document}\n";
2069 // mark the start of a new paragraph by simulating a newline,
2070 // so that os.afterParbreak() returns true at document start
2073 // output the parent macros
2074 for (auto const & mac : parentMacros) {
2075 int num_lines = mac->write(os.os(), true);
2076 os.texrow().newlines(num_lines);
2079 } // output_preamble
2081 LYXERR(Debug::INFO, "preamble finished, now the body.");
2085 latexParagraphs(*this, text(), os, runparams);
2087 catch (ConversionException const &) { return ExportKilled; }
2089 // Restore the parenthood if needed
2090 if (!runparams.is_child)
2091 d->ignore_parent = false;
2093 // add this just in case after all the paragraphs
2096 if (output_preamble) {
2097 os << "\\end{document}\n";
2098 LYXERR(Debug::OUTFILE, "makeLaTeXFile...done");
2100 LYXERR(Debug::OUTFILE, "LaTeXFile for inclusion made.");
2102 runparams_in.encoding = runparams.encoding;
2104 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2105 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2106 return ExportSuccess;
2110 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2111 OutputParams const & runparams,
2112 OutputWhat output) const
2114 LYXERR(Debug::OUTFILE, "makeDocBookFile...");
2117 if (!openFileWrite(ofs, fname))
2120 // make sure we are ready to export
2121 // this needs to be done before we validate
2123 updateMacroInstances(OutputUpdate);
2125 ExportStatus const retval = writeDocBookSource(ofs, runparams, output);
2126 if (retval == ExportKilled)
2127 return ExportKilled;
2131 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2132 return ExportSuccess;
2136 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os,
2137 OutputParams const & runparams,
2138 OutputWhat output) const
2140 LaTeXFeatures features(*this, params(), runparams);
2142 d->bibinfo_.makeCitationLabels(*this);
2146 DocumentClass const & tclass = params().documentClass();
2148 bool const output_preamble =
2149 output == FullSource || output == OnlyPreamble;
2150 bool const output_body =
2151 output == FullSource || output == OnlyBody || output == IncludedFile;
2153 if (output_preamble) {
2154 // XML preamble, no doctype needed.
2155 // Not using XMLStream for this, as the root tag would be in the tag stack and make troubles with the error
2156 // detection mechanisms (these are called before the end tag is output, and thus interact with the canary
2157 // parsep in output_docbook.cpp).
2158 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2159 << "<!-- This DocBook file was created by LyX " << lyx_version
2160 << "\n See https://www.lyx.org/ for more information -->\n";
2162 // Prepare the name space declaration for MathML depending on document preferences.
2163 string mathmlNamespace;
2164 if (params().docbook_mathml_prefix != BufferParams::NoPrefix) {
2165 string mathmlPrefix;
2166 if (params().docbook_mathml_prefix == BufferParams::MPrefix)
2168 else if (params().docbook_mathml_prefix == BufferParams::MMLPrefix)
2169 mathmlPrefix = "mml";
2170 mathmlNamespace = + " xmlns:" + mathmlPrefix + "=\"http://www.w3.org/1998/Math/MathML\"";
2173 // Directly output the root tag, based on the current type of document.
2174 string languageCode = params().language->code();
2175 string params = "xml:lang=\"" + languageCode + '"'
2176 + " xmlns=\"http://docbook.org/ns/docbook\""
2177 + " xmlns:xlink=\"http://www.w3.org/1999/xlink\""
2179 + " xmlns:xi=\"http://www.w3.org/2001/XInclude\""
2180 + " version=\"5.2\"";
2182 os << "<" << from_ascii(tclass.docbookroot()) << " " << from_ascii(params) << ">\n";
2186 // Start to output the document.
2188 docbookParagraphs(text(), *this, xs, runparams);
2191 if (output_preamble) {
2192 // Close the root element. No need for a line break, as free text is never allowed
2193 // in a root element, it must always be wrapped in some container.
2194 os << "</" << from_ascii(tclass.docbookroot()) << ">";
2197 return ExportSuccess;
2201 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2202 OutputParams const & runparams) const
2204 LYXERR(Debug::OUTFILE, "makeLyXHTMLFile...");
2207 if (!openFileWrite(ofs, fname))
2210 // make sure we are ready to export
2211 // this has to be done before we validate
2212 updateBuffer(UpdateMaster, OutputUpdate);
2213 updateMacroInstances(OutputUpdate);
2215 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2216 if (retval == ExportKilled)
2221 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2226 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2227 OutputParams const & runparams,
2228 OutputWhat output) const
2230 LaTeXFeatures features(*this, params(), runparams);
2232 d->bibinfo_.makeCitationLabels(*this);
2234 bool const output_preamble =
2235 output == FullSource || output == OnlyPreamble;
2236 bool const output_body =
2237 output == FullSource || output == OnlyBody || output == IncludedFile;
2239 if (output_preamble) {
2240 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2241 << "<!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"
2242 // FIXME Language should be set properly.
2243 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2245 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2246 // FIXME Presumably need to set this right
2247 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2249 docstring const & doctitle = features.htmlTitle();
2251 << (doctitle.empty() ?
2252 from_ascii("LyX Document") :
2253 xml::escapeString(doctitle, XMLStream::ESCAPE_ALL))
2256 docstring styles = features.getTClassHTMLPreamble();
2257 if (!styles.empty())
2258 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2260 // we will collect CSS information in a stream, and then output it
2261 // either here, as part of the header, or else in a separate file.
2262 odocstringstream css;
2263 styles = features.getCSSSnippets();
2264 if (!styles.empty())
2265 css << "/* LyX Provided Styles */\n" << styles << '\n';
2267 styles = features.getTClassHTMLStyles();
2268 if (!styles.empty())
2269 css << "/* Layout-provided Styles */\n" << styles << '\n';
2271 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2272 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2273 if (needfg || needbg) {
2274 css << "\nbody {\n";
2277 << from_ascii(X11hexname(params().fontcolor))
2280 css << " background-color: "
2281 << from_ascii(X11hexname(params().backgroundcolor))
2286 docstring const dstyles = css.str();
2287 if (!dstyles.empty()) {
2288 bool written = false;
2289 if (params().html_css_as_file) {
2290 // open a file for CSS info
2292 string const fcssname = addName(temppath(), "docstyle.css");
2293 FileName const fcssfile = FileName(fcssname);
2294 if (openFileWrite(ocss, fcssfile)) {
2298 // write link to header
2299 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2301 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2304 // we are here if the CSS is supposed to be written to the header
2305 // or if we failed to write it to an external file.
2307 os << "<style type='text/css'>\n"
2316 bool const output_body_tag = (output != IncludedFile);
2317 if (output_body_tag)
2318 os << "<body dir=\"auto\">\n";
2320 if (output != IncludedFile)
2321 // if we're an included file, the counters are in the master.
2322 params().documentClass().counters().reset();
2324 xhtmlParagraphs(text(), *this, xs, runparams);
2326 catch (ConversionException const &) { return ExportKilled; }
2327 if (output_body_tag)
2331 if (output_preamble)
2334 return ExportSuccess;
2338 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2339 // Other flags: -wall -v0 -x
2340 int Buffer::runChktex()
2344 // get LaTeX-Filename
2345 FileName const path(temppath());
2346 string const name = addName(path.absFileName(), latexName());
2347 string const org_path = filePath();
2349 PathChanger p(path); // path to LaTeX file
2350 message(_("Running chktex..."));
2352 // Generate the LaTeX file if neccessary
2353 OutputParams runparams(¶ms().encoding());
2354 runparams.flavor = Flavor::LaTeX;
2355 runparams.nice = false;
2356 runparams.linelen = lyxrc.plaintext_linelen;
2357 ExportStatus const retval =
2358 makeLaTeXFile(FileName(name), org_path, runparams);
2359 if (retval != ExportSuccess) {
2360 // error code on failure
2365 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2366 int const res = chktex.run(terr); // run chktex
2369 Alert::error(_("chktex failure"),
2370 _("Could not run chktex successfully."));
2372 ErrorList & errlist = d->errorLists["ChkTeX"];
2374 bufferErrors(terr, errlist);
2379 if (runparams.silent)
2380 d->errorLists["ChkTeX"].clear();
2388 void Buffer::validate(LaTeXFeatures & features) const
2390 // Validate the buffer params, but not for included
2391 // files, since they also use the parent buffer's
2393 if (!features.runparams().is_child)
2394 params().validate(features);
2399 for (Paragraph const & p : paragraphs())
2400 p.validate(features);
2402 if (lyxerr.debugging(Debug::OUTFILE)) {
2403 features.showStruct();
2408 void Buffer::getLabelList(vector<std::pair<docstring, docstring>> & list) const
2410 // If this is a child document, use the master's list instead.
2412 masterBuffer()->getLabelList(list);
2417 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2418 for (auto const & tocit : *toc) {
2419 if (tocit.depth() == 0)
2420 list.push_back(make_pair(tocit.str(), tocit.asString()));
2425 void Buffer::invalidateBibinfoCache() const
2427 d->bibinfo_cache_valid_ = false;
2428 d->cite_labels_valid_ = false;
2429 removeBiblioTempFiles();
2430 // also invalidate the cache for the parent buffer
2431 Buffer const * const pbuf = d->parent();
2433 pbuf->invalidateBibinfoCache();
2437 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2439 // FIXME This is probably unnecessary, given where we call this.
2440 // If this is a child document, use the master instead.
2441 Buffer const * const pbuf = masterBuffer();
2442 if (pbuf != this && scope != UpdateChildOnly)
2443 return pbuf->getBibfiles();
2445 // In 2.3.x, we have:
2446 //if (!d->bibfile_cache_valid_)
2447 // this->updateBibfilesCache(scope);
2448 // I think that is a leftover, but there have been so many back-
2449 // and-forths with this, due to Windows issues, that I am not sure.
2451 return d->bibfiles_cache_;
2455 BiblioInfo const & Buffer::masterBibInfo() const
2457 Buffer const * const tmp = masterBuffer();
2459 return tmp->masterBibInfo();
2464 BiblioInfo const & Buffer::bibInfo() const
2470 void Buffer::registerBibfiles(const docstring_list & bf) const
2472 // We register the bib files in the master buffer,
2473 // if there is one, but also in every single buffer,
2474 // in case a child is compiled alone.
2475 Buffer const * const tmp = masterBuffer();
2477 tmp->registerBibfiles(bf);
2479 for (auto const & p : bf) {
2480 docstring_list::const_iterator temp =
2481 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2482 if (temp == d->bibfiles_cache_.end())
2483 d->bibfiles_cache_.push_back(p);
2488 static map<docstring, FileName> bibfileCache;
2490 FileName Buffer::getBibfilePath(docstring const & bibid) const
2492 map<docstring, FileName>::const_iterator it =
2493 bibfileCache.find(bibid);
2494 if (it != bibfileCache.end()) {
2495 // i.e., return bibfileCache[bibid];
2499 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2500 string const texfile = changeExtension(to_utf8(bibid), "bib");
2501 // we need to check first if this file exists where it's said to be.
2502 // there's a weird bug that occurs otherwise: if the file is in the
2503 // Buffer's directory but has the same name as some file that would be
2504 // found by kpsewhich, then we find the latter, not the former.
2505 FileName const local_file = makeAbsPath(texfile, filePath());
2506 FileName file = local_file;
2507 if (!file.exists()) {
2508 // there's no need now to check whether the file can be found
2510 file = findtexfile(texfile, "bib", true);
2514 LYXERR(Debug::FILES, "Found at: " << file);
2516 bibfileCache[bibid] = file;
2517 return bibfileCache[bibid];
2521 void Buffer::checkIfBibInfoCacheIsValid() const
2523 // use the master's cache
2524 Buffer const * const tmp = masterBuffer();
2526 tmp->checkIfBibInfoCacheIsValid();
2530 // If we already know the cache is invalid, stop here.
2531 // This is important in the case when the bibliography
2532 // environment (rather than Bib[la]TeX) is used.
2533 // In that case, the timestamp check below gives no
2534 // sensible result. Rather than that, the cache will
2535 // be invalidated explicitly via invalidateBibInfoCache()
2536 // by the Bibitem inset.
2537 // Same applies for bib encoding changes, which trigger
2538 // invalidateBibInfoCache() by InsetBibtex.
2539 if (!d->bibinfo_cache_valid_)
2542 if (d->have_bibitems_) {
2543 // We have a bibliography environment.
2544 // Invalidate the bibinfo cache unconditionally.
2545 // Cite labels will get invalidated by the inset if needed.
2546 d->bibinfo_cache_valid_ = false;
2550 // OK. This is with Bib(la)tex. We'll assume the cache
2551 // is valid and change this if we find changes in the bibs.
2552 d->bibinfo_cache_valid_ = true;
2553 d->cite_labels_valid_ = true;
2555 // compare the cached timestamps with the actual ones.
2556 docstring_list const & bibfiles_cache = getBibfiles();
2557 for (auto const & bf : bibfiles_cache) {
2558 FileName const fn = getBibfilePath(bf);
2559 time_t lastw = fn.lastModified();
2560 time_t prevw = d->bibfile_status_[fn];
2561 if (lastw != prevw) {
2562 d->bibinfo_cache_valid_ = false;
2563 d->cite_labels_valid_ = false;
2564 d->bibfile_status_[fn] = lastw;
2570 void Buffer::clearBibFileCache() const
2572 bibfileCache.clear();
2576 void Buffer::reloadBibInfoCache(bool const force) const
2578 // we should not need to do this for internal buffers
2582 // use the master's cache
2583 Buffer const * const tmp = masterBuffer();
2585 tmp->reloadBibInfoCache(force);
2590 checkIfBibInfoCacheIsValid();
2591 if (d->bibinfo_cache_valid_)
2595 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2596 // re-read file locations when this info changes
2597 // FIXME Is this sufficient? Or should we also force that
2598 // in some other cases? If so, then it is easy enough to
2599 // add the following line in some other places.
2600 clearBibFileCache();
2601 d->bibinfo_.clear();
2602 FileNameList checkedFiles;
2603 d->have_bibitems_ = false;
2604 collectBibKeys(checkedFiles);
2605 d->bibinfo_cache_valid_ = true;
2609 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2614 for (InsetIterator it = begin(inset()); it; ++it) {
2615 it->collectBibKeys(it, checkedFiles);
2616 if (it->lyxCode() == BIBITEM_CODE) {
2617 if (parent() != nullptr)
2618 parent()->d->have_bibitems_ = true;
2620 d->have_bibitems_ = true;
2626 void Buffer::addBiblioInfo(BiblioInfo const & bi_in) const
2628 // We add the biblio info to the parent buffer,
2629 // if there is one, but also to this buffer, in case
2630 // it is compiled alone.
2631 BiblioInfo & our_bi = d->bibinfo_;
2632 our_bi.mergeBiblioInfo(bi_in);
2635 parent()->addBiblioInfo(bi_in);
2639 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2641 // We add the bibtex info to the master buffer,
2642 // if there is one, but also to every single buffer,
2643 // in case a child is compiled alone.
2644 BiblioInfo & bi = d->bibinfo_;
2647 if (parent() != nullptr) {
2648 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2649 masterbi[key] = bin;
2654 void Buffer::makeCitationLabels() const
2656 Buffer const * const master = masterBuffer();
2657 return d->bibinfo_.makeCitationLabels(*master);
2661 void Buffer::invalidateCiteLabels() const
2663 masterBuffer()->d->cite_labels_valid_ = false;
2666 bool Buffer::citeLabelsValid() const
2668 return masterBuffer()->d->cite_labels_valid_;
2672 void Buffer::removeBiblioTempFiles() const
2674 // We remove files that contain LaTeX commands specific to the
2675 // particular bibliographic style being used, in order to avoid
2676 // LaTeX errors when we switch style.
2677 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2678 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2679 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2680 aux_file.removeFile();
2681 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2682 bbl_file.removeFile();
2683 // Also for the parent buffer
2684 Buffer const * const pbuf = parent();
2686 pbuf->removeBiblioTempFiles();
2690 bool Buffer::isDepClean(string const & name) const
2692 DepClean::const_iterator const it = d->dep_clean.find(name);
2693 if (it == d->dep_clean.end())
2699 void Buffer::markDepClean(string const & name)
2701 d->dep_clean[name] = true;
2705 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2708 // FIXME? if there is an Buffer LFUN that can be dispatched even
2709 // if internal, put a switch '(cmd.action)' here.
2715 switch (cmd.action()) {
2717 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2718 flag.setOnOff(hasReadonlyFlag());
2721 // FIXME: There is need for a command-line import.
2722 //case LFUN_BUFFER_IMPORT:
2724 case LFUN_BUFFER_AUTO_SAVE:
2727 case LFUN_BUFFER_EXPORT_CUSTOM:
2728 // FIXME: Nothing to check here?
2731 case LFUN_BUFFER_EXPORT: {
2732 docstring const & arg = cmd.argument();
2733 if (arg == "custom") {
2737 string format = (arg.empty() || arg == "default") ?
2738 params().getDefaultOutputFormat() : to_utf8(arg);
2739 size_t pos = format.find(' ');
2740 if (pos != string::npos)
2741 format = format.substr(0, pos);
2742 enable = params().isExportable(format, false);
2744 flag.message(bformat(
2745 _("Don't know how to export to format: %1$s"), arg));
2749 case LFUN_BUILD_PROGRAM:
2750 enable = params().isExportable("program", false);
2753 case LFUN_BRANCH_ACTIVATE:
2754 case LFUN_BRANCH_DEACTIVATE:
2755 case LFUN_BRANCH_MASTER_ACTIVATE:
2756 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2757 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2758 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2759 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2760 : params().branchlist();
2761 docstring const & branchName = cmd.argument();
2762 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2766 case LFUN_BRANCH_ADD:
2767 case LFUN_BRANCHES_RENAME:
2768 // if no Buffer is present, then of course we won't be called!
2771 case LFUN_BUFFER_LANGUAGE:
2772 enable = !isReadonly();
2775 case LFUN_BUFFER_VIEW_CACHE:
2776 (d->preview_file_).refresh();
2777 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2780 case LFUN_CHANGES_TRACK:
2781 flag.setEnabled(true);
2782 flag.setOnOff(params().track_changes);
2785 case LFUN_CHANGES_OUTPUT:
2786 flag.setEnabled(true);
2787 flag.setOnOff(params().output_changes);
2790 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2791 flag.setOnOff(params().compressed);
2794 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2795 flag.setOnOff(params().output_sync);
2798 case LFUN_BUFFER_ANONYMIZE:
2804 flag.setEnabled(enable);
2809 void Buffer::dispatch(string const & command, DispatchResult & result)
2811 return dispatch(lyxaction.lookupFunc(command), result);
2815 // NOTE We can end up here even if we have no GUI, because we are called
2816 // by LyX::exec to handled command-line requests. So we may need to check
2817 // whether we have a GUI or not. The boolean use_gui holds this information.
2818 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2821 // FIXME? if there is an Buffer LFUN that can be dispatched even
2822 // if internal, put a switch '(cmd.action())' here.
2823 dr.dispatched(false);
2826 string const argument = to_utf8(func.argument());
2827 // We'll set this back to false if need be.
2828 bool dispatched = true;
2829 // This handles undo groups automagically
2830 UndoGroupHelper ugh(this);
2832 switch (func.action()) {
2833 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2834 if (lyxvc().inUse()) {
2835 string log = lyxvc().toggleReadOnly();
2840 setReadonly(!hasReadonlyFlag());
2843 case LFUN_BUFFER_EXPORT: {
2844 string const format = (argument.empty() || argument == "default") ?
2845 params().getDefaultOutputFormat() : argument;
2846 ExportStatus const status = doExport(format, false);
2847 dr.setError(status != ExportSuccess);
2848 if (status != ExportSuccess)
2849 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2850 from_utf8(format)));
2854 case LFUN_BUILD_PROGRAM: {
2855 ExportStatus const status = doExport("program", true);
2856 dr.setError(status != ExportSuccess);
2857 if (status != ExportSuccess)
2858 dr.setMessage(_("Error generating literate programming code."));
2862 case LFUN_BUFFER_EXPORT_CUSTOM: {
2864 string command = split(argument, format_name, ' ');
2865 Format const * format = theFormats().getFormat(format_name);
2867 lyxerr << "Format \"" << format_name
2868 << "\" not recognized!"
2873 // The name of the file created by the conversion process
2876 // Output to filename
2877 if (format->name() == "lyx") {
2878 string const latexname = latexName(false);
2879 filename = changeExtension(latexname,
2880 format->extension());
2881 filename = addName(temppath(), filename);
2883 if (!writeFile(FileName(filename)))
2887 doExport(format_name, true, filename);
2890 // Substitute $$FName for filename
2891 if (!contains(command, "$$FName"))
2892 command = "( " + command + " ) < $$FName";
2893 command = subst(command, "$$FName", filename);
2895 // Execute the command in the background
2897 call.startscript(Systemcall::DontWait, command,
2898 filePath(), layoutPos());
2902 // FIXME: There is need for a command-line import.
2904 case LFUN_BUFFER_IMPORT:
2909 case LFUN_BUFFER_AUTO_SAVE:
2911 resetAutosaveTimers();
2914 case LFUN_BRANCH_ACTIVATE:
2915 case LFUN_BRANCH_DEACTIVATE:
2916 case LFUN_BRANCH_MASTER_ACTIVATE:
2917 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2918 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2919 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2920 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2923 docstring const & branch_name = func.argument();
2924 // the case without a branch name is handled elsewhere
2925 if (branch_name.empty()) {
2929 Branch * branch = buf->params().branchlist().find(branch_name);
2931 LYXERR0("Branch " << branch_name << " does not exist.");
2933 docstring const msg =
2934 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2938 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2939 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2940 if (branch->isSelected() != activate) {
2941 buf->undo().recordUndoBufferParams(CursorData());
2942 branch->setSelected(activate);
2944 dr.screenUpdate(Update::Force);
2945 dr.forceBufferUpdate();
2950 case LFUN_BRANCH_ADD: {
2951 docstring const & branchnames = func.argument();
2952 if (branchnames.empty()) {
2956 BranchList & branch_list = params().branchlist();
2957 vector<docstring> const branches =
2958 getVectorFromString(branchnames, branch_list.separator());
2960 for (docstring const & branch_name : branches) {
2961 Branch * branch = branch_list.find(branch_name);
2963 LYXERR0("Branch " << branch_name << " already exists.");
2967 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2969 undo().recordUndoBufferParams(CursorData());
2970 branch_list.add(branch_name);
2971 branch = branch_list.find(branch_name);
2973 // needed to update the color table for dark mode
2974 branch->setColors("background", "background");
2976 dr.screenUpdate(Update::Force);
2984 case LFUN_BRANCHES_RENAME: {
2985 if (func.argument().empty())
2988 docstring const oldname = from_utf8(func.getArg(0));
2989 docstring const newname = from_utf8(func.getArg(1));
2990 InsetIterator it = begin(inset());
2991 InsetIterator const itend = end(inset());
2992 bool success = false;
2993 for (; it != itend; ++it) {
2994 if (it->lyxCode() == BRANCH_CODE) {
2995 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2996 if (ins.branch() == oldname) {
2997 undo().recordUndo(CursorData(it));
2998 ins.rename(newname);
3003 if (it->lyxCode() == INCLUDE_CODE) {
3004 // get buffer of external file
3005 InsetInclude const & ins =
3006 static_cast<InsetInclude const &>(*it);
3007 Buffer * child = ins.loadIfNeeded();
3010 child->dispatch(func, dr);
3015 dr.screenUpdate(Update::Force);
3016 dr.forceBufferUpdate();
3021 case LFUN_BUFFER_VIEW_CACHE:
3022 if (!theFormats().view(*this, d->preview_file_,
3023 d->preview_format_))
3024 dr.setMessage(_("Error viewing the output file."));
3027 case LFUN_CHANGES_TRACK:
3028 if (params().save_transient_properties)
3029 undo().recordUndoBufferParams(CursorData());
3030 params().track_changes = !params().track_changes;
3033 case LFUN_CHANGES_OUTPUT:
3034 if (params().save_transient_properties)
3035 undo().recordUndoBufferParams(CursorData());
3036 params().output_changes = !params().output_changes;
3037 if (params().output_changes) {
3038 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3039 LaTeXFeatures::isAvailable("xcolor");
3042 Alert::warning(_("Changes not shown in LaTeX output"),
3043 _("Changes will not be highlighted in LaTeX output, "
3044 "because xcolor and ulem are not installed.\n"
3045 "Please install both packages or redefine "
3046 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3051 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3052 // turn compression on/off
3053 undo().recordUndoBufferParams(CursorData());
3054 params().compressed = !params().compressed;
3057 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3058 undo().recordUndoBufferParams(CursorData());
3059 params().output_sync = !params().output_sync;
3062 case LFUN_BUFFER_ANONYMIZE: {
3063 undo().recordUndoFullBuffer(CursorData());
3064 CursorData cur(doc_iterator_begin(this));
3065 for ( ; cur ; cur.forwardPar())
3066 cur.paragraph().anonymize();
3067 dr.forceBufferUpdate();
3068 dr.screenUpdate(Update::Force);
3076 dr.dispatched(dispatched);
3080 void Buffer::changeLanguage(Language const * from, Language const * to)
3082 LASSERT(from, return);
3083 LASSERT(to, return);
3085 ParIterator it = par_iterator_begin();
3086 ParIterator eit = par_iterator_end();
3087 for (; it != eit; ++it)
3088 it->changeLanguage(params(), from, to);
3092 bool Buffer::isMultiLingual() const
3094 ParConstIterator end = par_iterator_end();
3095 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3096 if (it->isMultiLingual(params()))
3103 std::set<Language const *> Buffer::getLanguages() const
3105 std::set<Language const *> langs;
3106 getLanguages(langs);
3111 void Buffer::getLanguages(std::set<Language const *> & langs) const
3113 ParConstIterator end = par_iterator_end();
3114 // add the buffer language, even if it's not actively used
3115 langs.insert(language());
3116 // iterate over the paragraphs
3117 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3118 it->getLanguages(langs);
3120 ListOfBuffers clist = getDescendants();
3121 for (auto const & cit : clist)
3122 cit->getLanguages(langs);
3126 DocIterator Buffer::getParFromID(int const id) const
3128 Buffer * buf = const_cast<Buffer *>(this);
3130 // This means non-existent
3131 return doc_iterator_end(buf);
3133 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3134 if (it.paragraph().id() == id)
3137 return doc_iterator_end(buf);
3141 bool Buffer::hasParWithID(int const id) const
3143 return !getParFromID(id).atEnd();
3147 ParIterator Buffer::par_iterator_begin()
3149 return ParIterator(doc_iterator_begin(this));
3153 ParIterator Buffer::par_iterator_end()
3155 return ParIterator(doc_iterator_end(this));
3159 ParConstIterator Buffer::par_iterator_begin() const
3161 return ParConstIterator(doc_iterator_begin(this));
3165 ParConstIterator Buffer::par_iterator_end() const
3167 return ParConstIterator(doc_iterator_end(this));
3170 bool Buffer::empty() const
3172 return paragraphs().size() == 1 && paragraphs().front().empty();
3176 Language const * Buffer::language() const
3178 return params().language;
3182 docstring Buffer::B_(string const & l10n) const
3184 return params().B_(l10n);
3188 bool Buffer::isClean() const
3190 return d->lyx_clean;
3194 bool Buffer::isChecksumModified() const
3196 LASSERT(d->filename.exists(), return false);
3197 return d->checksum_ != d->filename.checksum();
3201 void Buffer::saveCheckSum() const
3203 FileName const & file = d->filename;
3205 d->checksum_ = file.exists() ? file.checksum()
3206 : 0; // in the case of save to a new file.
3210 void Buffer::markClean() const
3212 if (!d->lyx_clean) {
3213 d->lyx_clean = true;
3216 // if the .lyx file has been saved, we don't need an
3218 d->bak_clean = true;
3219 d->undo_.markDirty();
3220 clearExternalModification();
3224 void Buffer::setUnnamed(bool flag)
3230 bool Buffer::isUnnamed() const
3237 /// Don't check unnamed, here: isInternal() is used in
3238 /// newBuffer(), where the unnamed flag has not been set by anyone
3239 /// yet. Also, for an internal buffer, there should be no need for
3240 /// retrieving fileName() nor for checking if it is unnamed or not.
3241 bool Buffer::isInternal() const
3243 return d->internal_buffer;
3247 void Buffer::setInternal(bool flag)
3249 d->internal_buffer = flag;
3253 void Buffer::markDirty()
3256 d->lyx_clean = false;
3259 d->bak_clean = false;
3261 for (auto & depit : d->dep_clean)
3262 depit.second = false;
3266 FileName Buffer::fileName() const
3272 string Buffer::absFileName() const
3274 return d->filename.absFileName();
3278 string Buffer::filePath() const
3280 string const abs = d->filename.onlyPath().absFileName();
3283 int last = abs.length() - 1;
3285 return abs[last] == '/' ? abs : abs + '/';
3289 DocFileName Buffer::getReferencedFileName(string const & fn) const
3292 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3293 result.set(fn, filePath());
3295 // filePath() ends with a path separator
3296 FileName const test(filePath() + fn);
3298 result.set(fn, filePath());
3300 result.set(fn, params().origin);
3307 string const Buffer::prepareFileNameForLaTeX(string const & name,
3308 string const & ext, bool nice) const
3310 string const fname = makeAbsPath(name, filePath()).absFileName();
3311 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3317 return to_utf8(makeRelPath(from_utf8(fname),
3318 from_utf8(masterBuffer()->filePath())));
3322 vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3323 docstring_list const & bibfilelist,
3324 bool const add_extension) const
3326 // If we are processing the LaTeX file in a temp directory then
3327 // copy the .bib databases to this temp directory, mangling their
3328 // names in the process. Store this mangled name in the list of
3330 // (We need to do all this because BibTeX *really*, *really*
3331 // can't handle "files with spaces" and Windows users tend to
3332 // use such filenames.)
3333 // Otherwise, store the (maybe absolute) path to the original,
3334 // unmangled database name.
3336 vector<pair<docstring, string>> res;
3338 // determine the export format
3339 string const tex_format = flavor2format(runparams.flavor);
3341 // check for spaces in paths
3342 bool found_space = false;
3344 for (auto const & bit : bibfilelist) {
3345 string utf8input = to_utf8(bit);
3347 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3348 FileName try_in_file =
3349 makeAbsPath(database + ".bib", filePath());
3350 bool not_from_texmf = try_in_file.isReadableFile();
3351 // If the file has not been found, try with the real file name
3352 // (it might come from a child in a sub-directory)
3353 if (!not_from_texmf) {
3354 try_in_file = getBibfilePath(bit);
3355 if (try_in_file.isReadableFile()) {
3356 // Check if the file is in texmf
3357 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3358 not_from_texmf = kpsefile.empty()
3359 || kpsefile.absFileName() != try_in_file.absFileName();
3361 // If this exists, make path relative to the master
3364 removeExtension(prepareFileNameForLaTeX(
3365 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3366 from_utf8(filePath()))),
3367 ".bib", runparams.nice));
3371 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3373 // mangledFileName() needs the extension
3374 DocFileName const in_file = DocFileName(try_in_file);
3375 database = removeExtension(in_file.mangledFileName());
3376 FileName const out_file = makeAbsPath(database + ".bib",
3377 masterBuffer()->temppath());
3378 bool const success = in_file.copyTo(out_file);
3380 LYXERR0("Failed to copy '" << in_file
3381 << "' to '" << out_file << "'");
3383 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3384 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3385 if (!isValidLaTeXFileName(database)) {
3386 frontend::Alert::warning(_("Invalid filename"),
3387 _("The following filename will cause troubles "
3388 "when running the exported file through LaTeX: ") +
3389 from_utf8(database));
3391 if (!isValidDVIFileName(database)) {
3392 frontend::Alert::warning(_("Problematic filename for DVI"),
3393 _("The following filename can cause troubles "
3394 "when running the exported file through LaTeX "
3395 "and opening the resulting DVI: ") +
3396 from_utf8(database), true);
3404 docstring const path = from_utf8(latex_path(database));
3406 if (contains(path, ' '))
3409 if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
3410 enc = params().bibFileEncoding(utf8input);
3412 bool recorded = false;
3413 for (auto const & pe : res) {
3414 if (pe.first == path) {
3421 res.push_back(make_pair(path, enc));
3424 // Check if there are spaces in the path and warn BibTeX users, if so.
3425 // (biber can cope with such paths)
3426 if (!prefixIs(runparams.bibtex_command, "biber")) {
3427 // Post this warning only once.
3428 static bool warned_about_spaces = false;
3429 if (!warned_about_spaces &&
3430 runparams.nice && found_space) {
3431 warned_about_spaces = true;
3432 Alert::warning(_("Export Warning!"),
3433 _("There are spaces in the paths to your BibTeX databases.\n"
3434 "BibTeX will be unable to find them."));
3443 string Buffer::layoutPos() const
3445 return d->layout_position;
3449 void Buffer::setLayoutPos(string const & path)
3452 d->layout_position.clear();
3456 LATTEST(FileName::isAbsolute(path));
3458 d->layout_position =
3459 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3461 if (d->layout_position.empty())
3462 d->layout_position = ".";
3466 bool Buffer::hasReadonlyFlag() const
3468 return d->read_only;
3472 bool Buffer::isReadonly() const
3474 return hasReadonlyFlag() || notifiesExternalModification();
3478 void Buffer::setParent(Buffer const * buffer)
3480 // We need to do some work here to avoid recursive parent structures.
3481 // This is the easy case.
3482 if (buffer == this) {
3483 LYXERR0("Ignoring attempt to set self as parent in\n" << fileName());
3486 // Now we check parents going upward, to make sure that IF we set the
3487 // parent as requested, we would not generate a recursive include.
3488 set<Buffer const *> sb;
3489 Buffer const * b = buffer;
3490 bool found_recursion = false;
3492 if (sb.find(b) != sb.end()) {
3493 found_recursion = true;
3500 if (found_recursion) {
3501 LYXERR0("Ignoring attempt to set parent of\n" <<
3504 buffer->fileName() <<
3505 "\nbecause that would create a recursive inclusion.");
3509 // We should be safe now.
3510 d->setParent(buffer);
3515 Buffer const * Buffer::parent() const
3521 ListOfBuffers Buffer::allRelatives() const
3523 ListOfBuffers lb = masterBuffer()->getDescendants();
3524 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3529 Buffer const * Buffer::masterBuffer() const
3531 Buffer const * const pbuf = d->parent();
3535 return pbuf->masterBuffer();
3539 bool Buffer::isChild(Buffer * child) const
3541 return d->children_positions.find(child) != d->children_positions.end();
3545 DocIterator Buffer::firstChildPosition(Buffer const * child)
3547 Impl::BufferPositionMap::iterator it;
3548 it = d->children_positions.find(child);
3549 if (it == d->children_positions.end())
3550 return DocIterator(this);
3555 bool Buffer::hasChildren() const
3557 return !d->children_positions.empty();
3561 void Buffer::collectChildren(ListOfBuffers & children, bool grand_children) const
3563 // loop over children
3564 for (auto const & p : d->children_positions) {
3565 Buffer * child = const_cast<Buffer *>(p.first);
3567 ListOfBuffers::const_iterator bit = find(children.begin(), children.end(), child);
3568 if (bit != children.end())
3570 children.push_back(child);
3572 // there might be grandchildren
3573 child->collectChildren(children, true);
3578 ListOfBuffers Buffer::getChildren() const
3581 collectChildren(v, false);
3582 // Make sure we have not included ourselves.
3583 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3584 if (bit != v.end()) {
3585 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3592 ListOfBuffers Buffer::getDescendants() const
3595 collectChildren(v, true);
3596 // Make sure we have not included ourselves.
3597 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3598 if (bit != v.end()) {
3599 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3606 template<typename M>
3607 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3612 typename M::const_iterator it = m.lower_bound(x);
3613 if (it == m.begin())
3621 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3622 DocIterator const & pos) const
3624 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3626 // if paragraphs have no macro context set, pos will be empty
3630 // we haven't found anything yet
3631 DocIterator bestPos = owner_->par_iterator_begin();
3632 MacroData const * bestData = nullptr;
3634 // find macro definitions for name
3635 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3636 if (nameIt != macros.end()) {
3637 // find last definition in front of pos or at pos itself
3638 PositionScopeMacroMap::const_iterator it
3639 = greatest_below(nameIt->second, pos);
3640 if (it != nameIt->second.end()) {
3642 // scope ends behind pos?
3643 if (pos < it->second.scope) {
3644 // Looks good, remember this. If there
3645 // is no external macro behind this,
3646 // we found the right one already.
3647 bestPos = it->first;
3648 bestData = &it->second.macro;
3652 // try previous macro if there is one
3653 if (it == nameIt->second.begin())
3660 // find macros in included files
3661 PositionScopeBufferMap::const_iterator it
3662 = greatest_below(position_to_children, pos);
3663 if (it == position_to_children.end())
3664 // no children before
3668 // do we know something better (i.e. later) already?
3669 if (it->first < bestPos )
3672 // scope ends behind pos?
3673 if (pos < it->second.scope
3674 && (cloned_buffer_ ||
3675 theBufferList().isLoaded(it->second.buffer))) {
3676 // look for macro in external file
3678 MacroData const * data
3679 = it->second.buffer->getMacro(name, false);
3682 bestPos = it->first;
3688 // try previous file if there is one
3689 if (it == position_to_children.begin())
3694 // return the best macro we have found
3699 MacroData const * Buffer::getMacro(docstring const & name,
3700 DocIterator const & pos, bool global) const
3705 // query buffer macros
3706 MacroData const * data = d->getBufferMacro(name, pos);
3707 if (data != nullptr)
3710 // If there is a master buffer, query that
3711 Buffer const * const pbuf = d->parent();
3713 d->macro_lock = true;
3714 MacroData const * macro = pbuf->getMacro(
3715 name, *this, false);
3716 d->macro_lock = false;
3722 data = MacroTable::globalMacros().get(name);
3723 if (data != nullptr)
3731 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3733 // set scope end behind the last paragraph
3734 DocIterator scope = par_iterator_begin();
3735 scope.pit() = scope.lastpit() + 1;
3737 return getMacro(name, scope, global);
3741 MacroData const * Buffer::getMacro(docstring const & name,
3742 Buffer const & child, bool global) const
3744 // look where the child buffer is included first
3745 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3746 if (it == d->children_positions.end())
3749 // check for macros at the inclusion position
3750 return getMacro(name, it->second, global);
3754 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3756 pit_type const lastpit = it.lastpit();
3758 // look for macros in each paragraph
3759 while (it.pit() <= lastpit) {
3760 Paragraph & par = it.paragraph();
3762 // iterate over the insets of the current paragraph
3763 for (auto const & insit : par.insetList()) {
3764 it.pos() = insit.pos;
3766 // is it a nested text inset?
3767 if (insit.inset->asInsetText()) {
3768 // Inset needs its own scope?
3769 InsetText const * itext = insit.inset->asInsetText();
3770 bool newScope = itext->isMacroScope();
3772 // scope which ends just behind the inset
3773 DocIterator insetScope = it;
3776 // collect macros in inset
3777 it.push_back(CursorSlice(*insit.inset));
3778 updateMacros(it, newScope ? insetScope : scope);
3783 if (insit.inset->asInsetTabular()) {
3784 CursorSlice slice(*insit.inset);
3785 size_t const numcells = slice.nargs();
3786 for (; slice.idx() < numcells; slice.forwardIdx()) {
3787 it.push_back(slice);
3788 updateMacros(it, scope);
3794 // is it an external file?
3795 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3796 // get buffer of external file
3797 InsetInclude const & incinset =
3798 static_cast<InsetInclude const &>(*insit.inset);
3800 Buffer * child = incinset.loadIfNeeded();
3805 // register its position, but only when it is
3806 // included first in the buffer
3807 children_positions.insert({child, it});
3809 // register child with its scope
3810 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3814 InsetMath * im = insit.inset->asInsetMath();
3815 if (doing_export && im) {
3816 InsetMathHull * hull = im->asHullInset();
3818 hull->recordLocation(it);
3821 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3825 InsetMathMacroTemplate & macroTemplate =
3826 *insit.inset->asInsetMath()->asMacroTemplate();
3827 MacroContext mc(owner_, it);
3828 macroTemplate.updateToContext(mc);
3831 bool valid = macroTemplate.validMacro();
3832 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3833 // then the BufferView's cursor will be invalid in
3834 // some cases which leads to crashes.
3839 // FIXME (Abdel), I don't understand why we pass 'it' here
3840 // instead of 'macroTemplate' defined above... is this correct?
3841 macros[macroTemplate.name()][it] =
3842 Impl::ScopeMacro(scope, MacroData(owner_, it));
3852 void Buffer::updateMacros() const
3857 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3859 // start with empty table
3861 d->children_positions.clear();
3862 d->position_to_children.clear();
3864 // Iterate over buffer, starting with first paragraph
3865 // The scope must be bigger than any lookup DocIterator
3866 // later. For the global lookup, lastpit+1 is used, hence
3867 // we use lastpit+2 here.
3868 DocIterator it = par_iterator_begin();
3869 DocIterator outerScope = it;
3870 outerScope.pit() = outerScope.lastpit() + 2;
3871 d->updateMacros(it, outerScope);
3875 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3877 for (Inset const & it : inset()) {
3878 if (it.lyxCode() == BRANCH_CODE) {
3879 InsetBranch const & br = static_cast<InsetBranch const &>(it);
3880 docstring const name = br.branch();
3881 if (!from_master && !params().branchlist().find(name))
3882 result.push_back(name);
3883 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3884 result.push_back(name);
3887 if (it.lyxCode() == INCLUDE_CODE) {
3888 // get buffer of external file
3889 InsetInclude const & ins =
3890 static_cast<InsetInclude const &>(it);
3891 Buffer * child = ins.loadIfNeeded();
3894 child->getUsedBranches(result, true);
3897 // remove duplicates
3902 void Buffer::updateMacroInstances(UpdateType utype) const
3904 LYXERR(Debug::MACROS, "updateMacroInstances for "
3905 << d->filename.onlyFileName());
3906 DocIterator it = doc_iterator_begin(this);
3908 DocIterator const end = doc_iterator_end(this);
3909 for (; it != end; it.forwardInset()) {
3910 // look for MathData cells in InsetMathNest insets
3911 InsetMath * minset = it.nextInset()->asInsetMath();
3915 // update macro in all cells of the InsetMathNest
3916 idx_type n = minset->nargs();
3917 MacroContext mc = MacroContext(this, it);
3918 for (idx_type i = 0; i < n; ++i) {
3919 MathData & data = minset->cell(i);
3920 data.updateMacros(nullptr, mc, utype, 0);
3926 void Buffer::listMacroNames(MacroNameSet & macros) const
3931 d->macro_lock = true;
3933 // loop over macro names
3934 for (auto const & nameit : d->macros)
3935 macros.insert(nameit.first);
3937 // loop over children
3938 for (auto const & p : d->children_positions) {
3939 Buffer * child = const_cast<Buffer *>(p.first);
3940 // The buffer might have been closed (see #10766).
3941 if (theBufferList().isLoaded(child))
3942 child->listMacroNames(macros);
3946 Buffer const * const pbuf = d->parent();
3948 pbuf->listMacroNames(macros);
3950 d->macro_lock = false;
3954 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3956 Buffer const * const pbuf = d->parent();
3961 pbuf->listMacroNames(names);
3964 for (auto const & mit : names) {
3966 MacroData const * data = pbuf->getMacro(mit, *this, false);
3968 macros.insert(data);
3970 // we cannot access the original InsetMathMacroTemplate anymore
3971 // here to calls validate method. So we do its work here manually.
3972 // FIXME: somehow make the template accessible here.
3973 if (data->optionals() > 0)
3974 features.require("xargs");
3980 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3983 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3985 RefCache::iterator it = d->ref_cache_.find(label);
3986 if (it != d->ref_cache_.end())
3989 static References const dummy_refs = References();
3990 it = d->ref_cache_.insert(
3991 make_pair(label, dummy_refs)).first;
3996 Buffer::References const & Buffer::references(docstring const & label) const
3998 return const_cast<Buffer *>(this)->getReferenceCache(label);
4002 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
4004 References & refs = getReferenceCache(label);
4005 refs.push_back(make_pair(inset, it));
4009 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
4013 linfo.label = label;
4015 linfo.active = active;
4016 masterBuffer()->d->label_cache_.push_back(linfo);
4020 InsetLabel const * Buffer::insetLabel(docstring const & label,
4021 bool const active) const
4023 for (auto const & rc : masterBuffer()->d->label_cache_) {
4024 if (rc.label == label && (rc.active || !active))
4031 bool Buffer::activeLabel(docstring const & label) const
4033 return insetLabel(label, true) != nullptr;
4037 void Buffer::clearReferenceCache() const
4040 d->ref_cache_.clear();
4041 d->label_cache_.clear();
4046 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
4048 //FIXME: This does not work for child documents yet.
4049 reloadBibInfoCache();
4051 // Check if the label 'from' appears more than once
4052 vector<docstring> labels;
4053 for (auto const & bibit : masterBibInfo())
4054 labels.push_back(bibit.first);
4056 if (count(labels.begin(), labels.end(), from) > 1)
4059 string const paramName = "key";
4060 UndoGroupHelper ugh(this);
4061 InsetIterator it = begin(inset());
4063 if (it->lyxCode() != CITE_CODE)
4065 InsetCommand * inset = it->asInsetCommand();
4066 docstring const oldValue = inset->getParam(paramName);
4067 if (oldValue == from) {
4068 undo().recordUndo(CursorData(it));
4069 inset->setParam(paramName, to);
4074 // returns NULL if id-to-row conversion is unsupported
4075 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4076 pit_type par_begin, pit_type par_end,
4077 OutputWhat output, bool master) const
4079 unique_ptr<TexRow> texrow;
4080 OutputParams runparams(¶ms().encoding());
4081 runparams.nice = true;
4082 runparams.flavor = params().getOutputFlavor(format);
4083 runparams.linelen = lyxrc.plaintext_linelen;
4084 // No side effect of file copying and image conversion
4085 runparams.dryrun = true;
4087 // Some macros rely on font encoding
4088 runparams.main_fontenc = params().main_font_encoding();
4090 // Use the right wrapping for the comment at the beginning of the generated
4091 // snippet, so that it is either valid LaTeX or valid XML (including HTML and DocBook).
4092 docstring comment_start = from_ascii("% ");
4093 docstring comment_end = from_ascii("");
4094 if (runparams.flavor == Flavor::Html || runparams.flavor == Flavor::DocBook5) {
4095 comment_start = from_ascii("<!-- ");
4096 comment_end = from_ascii(" -->");
4099 if (output == CurrentParagraph) {
4100 runparams.par_begin = par_begin;
4101 runparams.par_end = par_end;
4102 if (par_begin + 1 == par_end) {
4104 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4109 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4110 convert<docstring>(par_begin),
4111 convert<docstring>(par_end - 1))
4115 // output paragraphs
4116 if (runparams.flavor == Flavor::LyX) {
4117 Paragraph const & par = text().paragraphs()[par_begin];
4119 depth_type dt = par.getDepth();
4120 par.write(ods, params(), dt);
4121 os << from_utf8(ods.str());
4122 } else if (runparams.flavor == Flavor::Html) {
4124 setMathFlavor(runparams);
4125 xhtmlParagraphs(text(), *this, xs, runparams);
4126 } else if (runparams.flavor == Flavor::Text) {
4128 // FIXME Handles only one paragraph, unlike the others.
4129 // Probably should have some routine with a signature like them.
4130 writePlaintextParagraph(*this,
4131 text().paragraphs()[par_begin], os, runparams, dummy);
4132 } else if (runparams.flavor == Flavor::DocBook5) {
4134 docbookParagraphs(text(), *this, xs, runparams);
4136 // If we are previewing a paragraph, even if this is the
4137 // child of some other buffer, let's cut the link here,
4138 // so that no concurring settings from the master
4139 // (e.g. branch state) interfere (see #8101).
4141 d->ignore_parent = true;
4142 // We need to validate the Buffer params' features here
4143 // in order to know if we should output polyglossia
4144 // macros (instead of babel macros)
4145 LaTeXFeatures features(*this, params(), runparams);
4147 runparams.use_polyglossia = features.usePolyglossia();
4148 runparams.use_hyperref = features.isRequired("hyperref");
4149 // latex or literate
4152 ots.texrow().newlines(2);
4154 latexParagraphs(*this, text(), ots, runparams);
4155 texrow = ots.releaseTexRow();
4157 // Restore the parenthood
4159 d->ignore_parent = false;
4162 os << comment_start;
4163 if (output == FullSource)
4164 os << _("Preview source code");
4165 else if (output == OnlyPreamble)
4166 os << _("Preview preamble");
4167 else if (output == OnlyBody)
4168 os << _("Preview body");
4171 if (runparams.flavor == Flavor::LyX) {
4173 if (output == FullSource)
4175 else if (output == OnlyPreamble)
4176 params().writeFile(ods, this);
4177 else if (output == OnlyBody)
4179 os << from_utf8(ods.str());
4180 } else if (runparams.flavor == Flavor::Html) {
4181 writeLyXHTMLSource(os, runparams, output);
4182 } else if (runparams.flavor == Flavor::Text) {
4183 if (output == OnlyPreamble)
4184 os << "% "<< _("Plain text does not have a preamble.");
4186 writePlaintextFile(*this, os, runparams);
4187 } else if (runparams.flavor == Flavor::DocBook5) {
4188 writeDocBookSource(os, runparams, output);
4190 // latex or literate
4193 ots.texrow().newlines(2);
4195 runparams.is_child = true;
4197 writeLaTeXSource(ots, string(), runparams, output);
4198 texrow = ots.releaseTexRow();
4205 ErrorList & Buffer::errorList(string const & type) const
4207 return d->errorLists[type];
4211 void Buffer::updateTocItem(std::string const & type,
4212 DocIterator const & dit) const
4215 d->gui_->updateTocItem(type, dit);
4219 void Buffer::structureChanged() const
4222 d->gui_->structureChanged();
4226 void Buffer::errors(string const & err, bool from_master) const
4229 d->gui_->errors(err, from_master);
4233 void Buffer::message(docstring const & msg) const
4236 d->gui_->message(msg);
4240 void Buffer::setBusy(bool on) const
4243 d->gui_->setBusy(on);
4247 void Buffer::updateTitles() const
4250 d->wa_->updateTitles();
4254 void Buffer::resetAutosaveTimers() const
4257 d->gui_->resetAutosaveTimers();
4261 bool Buffer::hasGuiDelegate() const
4267 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4273 FileName Buffer::getEmergencyFileName() const
4275 return FileName(d->filename.absFileName() + ".emergency");
4279 FileName Buffer::getAutosaveFileName() const
4281 // if the document is unnamed try to save in the backup dir, else
4282 // in the default document path, and as a last try in the filePath,
4283 // which will most often be the temporary directory
4286 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4287 : lyxrc.backupdir_path;
4288 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4291 string const fname = "#" + d->filename.onlyFileName() + "#";
4293 return makeAbsPath(fname, fpath);
4297 void Buffer::removeAutosaveFile() const
4299 FileName const f = getAutosaveFileName();
4305 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4307 FileName const newauto = getAutosaveFileName();
4309 if (newauto != oldauto && oldauto.exists())
4310 if (!oldauto.moveTo(newauto))
4311 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4315 bool Buffer::autoSave() const
4317 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4318 if (buf->d->bak_clean || hasReadonlyFlag())
4321 message(_("Autosaving current document..."));
4322 buf->d->bak_clean = true;
4324 FileName const fname = getAutosaveFileName();
4325 LASSERT(d->cloned_buffer_, return false);
4327 // If this buffer is cloned, we assume that
4328 // we are running in a separate thread already.
4329 TempFile tempfile("lyxautoXXXXXX.lyx");
4330 tempfile.setAutoRemove(false);
4331 FileName const tmp_ret = tempfile.name();
4332 if (!tmp_ret.empty()) {
4334 // assume successful write of tmp_ret
4335 if (tmp_ret.moveTo(fname))
4338 // failed to write/rename tmp_ret so try writing direct
4339 return writeFile(fname);
4343 void Buffer::setExportStatus(bool e) const
4345 d->doing_export = e;
4346 ListOfBuffers clist = getDescendants();
4347 for (auto const & bit : clist)
4348 bit->d->doing_export = e;
4352 bool Buffer::isExporting() const
4354 return d->doing_export;
4358 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4362 return doExport(target, put_in_tempdir, result_file);
4365 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4366 string & result_file) const
4368 bool const update_unincluded =
4369 params().maintain_unincluded_children != BufferParams::CM_None
4370 && !params().getIncludedChildren().empty();
4372 // (1) export with all included children (omit \includeonly)
4373 if (update_unincluded) {
4374 ExportStatus const status =
4375 doExport(target, put_in_tempdir, true, result_file);
4376 if (status != ExportSuccess)
4379 // (2) export with included children only
4380 return doExport(target, put_in_tempdir, false, result_file);
4384 void Buffer::setMathFlavor(OutputParams & op) const
4386 // Passes the way to generate formulae to the XHTML output code.
4387 // In particular, this function has no impact on the DocBook code, as it
4388 // uses another mechanism to handle math flavours.
4389 switch (params().html_math_output) {
4390 case BufferParams::MathML:
4391 op.math_flavor = OutputParams::MathAsMathML;
4393 case BufferParams::HTML:
4394 op.math_flavor = OutputParams::MathAsHTML;
4396 case BufferParams::Images:
4397 op.math_flavor = OutputParams::MathAsImages;
4399 case BufferParams::LaTeX:
4400 op.math_flavor = OutputParams::MathAsLaTeX;
4406 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4407 bool includeall, string & result_file) const
4409 LYXERR(Debug::FILES, "target=" << target);
4410 OutputParams runparams(¶ms().encoding());
4411 string format = target;
4412 string dest_filename;
4413 size_t pos = target.find(' ');
4414 if (pos != string::npos) {
4415 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4416 format = target.substr(0, pos);
4417 if (format == "default")
4418 format = params().getDefaultOutputFormat();
4419 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4420 FileName(dest_filename).onlyPath().createPath();
4421 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4423 MarkAsExporting exporting(this);
4424 string backend_format;
4425 runparams.flavor = Flavor::LaTeX;
4426 runparams.linelen = lyxrc.plaintext_linelen;
4427 runparams.includeall = includeall;
4428 vector<string> backs = params().backends();
4429 Converters converters = theConverters();
4430 bool need_nice_file = false;
4431 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4432 // Get the shortest path to format
4433 converters.buildGraph();
4434 Graph::EdgePath path;
4435 for (string const & sit : backs) {
4436 Graph::EdgePath p = converters.getPath(sit, format);
4437 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4438 backend_format = sit;
4443 if (!put_in_tempdir) {
4444 // Only show this alert if this is an export to a non-temporary
4445 // file (not for previewing).
4446 docstring s = bformat(_("No information for exporting the format %1$s."),
4447 translateIfPossible(theFormats().prettyName(format)));
4448 if (format == "pdf4")
4450 + bformat(_("Hint: use non-TeX fonts or set input encoding "
4451 " to '%1$s'"), from_utf8(encodings.fromLyXName("ascii")->guiName()));
4452 Alert::error(_("Couldn't export file"), s);
4454 return ExportNoPathToFormat;
4456 runparams.flavor = converters.getFlavor(path, this);
4457 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4458 for (auto const & edge : path)
4459 if (theConverters().get(edge).nice()) {
4460 need_nice_file = true;
4465 backend_format = format;
4466 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4467 // FIXME: Don't hardcode format names here, but use a flag
4468 if (backend_format == "pdflatex")
4469 runparams.flavor = Flavor::PdfLaTeX;
4470 else if (backend_format == "luatex")
4471 runparams.flavor = Flavor::LuaTeX;
4472 else if (backend_format == "dviluatex")
4473 runparams.flavor = Flavor::DviLuaTeX;
4474 else if (backend_format == "xetex")
4475 runparams.flavor = Flavor::XeTeX;
4478 string filename = latexName(false);
4479 filename = addName(temppath(), filename);
4480 filename = changeExtension(filename,
4481 theFormats().extension(backend_format));
4482 LYXERR(Debug::FILES, "filename=" << filename);
4484 // Plain text backend
4485 if (backend_format == "text") {
4486 runparams.flavor = Flavor::Text;
4488 writePlaintextFile(*this, FileName(filename), runparams);
4490 catch (ConversionException const &) { return ExportCancel; }
4493 else if (backend_format == "xhtml") {
4494 runparams.flavor = Flavor::Html;
4495 setMathFlavor(runparams);
4496 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4497 return ExportKilled;
4498 } else if (backend_format == "lyx")
4499 writeFile(FileName(filename));
4501 else if (backend_format == "docbook5") {
4502 runparams.flavor = Flavor::DocBook5;
4503 runparams.nice = false;
4504 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4505 return ExportKilled;
4508 else if (backend_format == format || need_nice_file) {
4509 runparams.nice = true;
4510 ExportStatus const retval =
4511 makeLaTeXFile(FileName(filename), string(), runparams);
4512 if (retval == ExportKilled)
4513 return ExportKilled;
4514 if (d->cloned_buffer_)
4515 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4516 if (retval != ExportSuccess)
4518 } else if (!lyxrc.tex_allows_spaces
4519 && contains(filePath(), ' ')) {
4520 Alert::error(_("File name error"),
4521 bformat(_("The directory path to the document\n%1$s\n"
4522 "contains spaces, but your TeX installation does "
4523 "not allow them. You should save the file to a directory "
4524 "whose name does not contain spaces."), from_utf8(filePath())));
4525 return ExportTexPathHasSpaces;
4527 runparams.nice = false;
4528 ExportStatus const retval =
4529 makeLaTeXFile(FileName(filename), filePath(), runparams);
4530 if (retval == ExportKilled)
4531 return ExportKilled;
4532 if (d->cloned_buffer_)
4533 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4534 if (retval != ExportSuccess)
4538 string const error_type = (format == "program")
4539 ? "Build" : params().bufferFormat();
4540 ErrorList & error_list = d->errorLists[error_type];
4541 string const ext = theFormats().extension(format);
4542 FileName const tmp_result_file(changeExtension(filename, ext));
4543 Converters::RetVal const retval =
4544 converters.convert(this, FileName(filename), tmp_result_file,
4545 FileName(absFileName()), backend_format, format,
4546 error_list, Converters::none, includeall);
4547 if (retval == Converters::KILLED)
4548 return ExportCancel;
4549 bool success = (retval == Converters::SUCCESS);
4551 // Emit the signal to show the error list or copy it back to the
4552 // cloned Buffer so that it can be emitted afterwards.
4553 if (format != backend_format) {
4554 if (runparams.silent)
4556 else if (d->cloned_buffer_)
4557 d->cloned_buffer_->d->errorLists[error_type] =
4558 d->errorLists[error_type];
4561 // also to the children, in case of master-buffer-view
4562 ListOfBuffers clist = getDescendants();
4563 for (auto const & bit : clist) {
4564 if (runparams.silent)
4565 bit->d->errorLists[error_type].clear();
4566 else if (d->cloned_buffer_) {
4567 // Enable reverse search by copying back the
4568 // texrow object to the cloned buffer.
4569 // FIXME: this is not thread safe.
4570 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4571 bit->d->cloned_buffer_->d->errorLists[error_type] =
4572 bit->d->errorLists[error_type];
4574 bit->errors(error_type, true);
4578 if (d->cloned_buffer_) {
4579 // Enable reverse dvi or pdf to work by copying back the texrow
4580 // object to the cloned buffer.
4581 // FIXME: There is a possibility of concurrent access to texrow
4582 // here from the main GUI thread that should be securized.
4583 d->cloned_buffer_->d->texrow = d->texrow;
4584 string const err_type = params().bufferFormat();
4585 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4589 if (put_in_tempdir) {
4590 result_file = tmp_result_file.absFileName();
4591 return success ? ExportSuccess : ExportConverterError;
4594 if (dest_filename.empty())
4595 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4597 result_file = dest_filename;
4598 // We need to copy referenced files (e.g. included graphics
4599 // if format == "dvi") to the result dir.
4600 vector<ExportedFile> const extfiles =
4601 runparams.exportdata->externalFiles(format);
4602 string const dest = runparams.export_folder.empty() ?
4603 onlyPath(result_file) : runparams.export_folder;
4604 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4605 : force_overwrite == ALL_FILES;
4606 CopyStatus status = use_force ? FORCE : SUCCESS;
4608 for (ExportedFile const & exp : extfiles) {
4609 if (status == CANCEL) {
4610 message(_("Document export cancelled."));
4611 return ExportCancel;
4613 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4614 string fixedName = exp.exportName;
4615 if (!runparams.export_folder.empty()) {
4616 // Relative pathnames starting with ../ will be sanitized
4617 // if exporting to a different folder
4618 while (fixedName.substr(0, 3) == "../")
4619 fixedName = fixedName.substr(3, fixedName.length() - 3);
4621 FileName fixedFileName = makeAbsPath(fixedName, dest);
4622 fixedFileName.onlyPath().createPath();
4623 status = copyFile(fmt, exp.sourceName,
4625 exp.exportName, status == FORCE,
4626 runparams.export_folder.empty());
4630 if (tmp_result_file.exists()) {
4631 // Finally copy the main file
4632 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4633 : force_overwrite != NO_FILES;
4634 if (status == SUCCESS && use_force)
4636 status = copyFile(format, tmp_result_file,
4637 FileName(result_file), result_file,
4639 if (status == CANCEL) {
4640 message(_("Document export cancelled."));
4641 return ExportCancel;
4643 message(bformat(_("Document exported as %1$s "
4645 translateIfPossible(theFormats().prettyName(format)),
4646 makeDisplayPath(result_file)));
4649 // This must be a dummy converter like fax (bug 1888)
4650 message(bformat(_("Document exported as %1$s"),
4651 translateIfPossible(theFormats().prettyName(format))));
4654 return success ? ExportSuccess : ExportConverterError;
4658 Buffer::ExportStatus Buffer::preview(string const & format) const
4660 bool const update_unincluded =
4661 params().maintain_unincluded_children != BufferParams::CM_None
4662 && !params().getIncludedChildren().empty();
4663 return preview(format, update_unincluded);
4667 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4669 MarkAsExporting exporting(this);
4671 // (1) export with all included children (omit \includeonly)
4673 ExportStatus const status = doExport(format, true, true, result_file);
4674 if (status != ExportSuccess)
4677 // (2) export with included children only
4678 ExportStatus const status = doExport(format, true, false, result_file);
4679 FileName const previewFile(result_file);
4681 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4682 theimpl->preview_file_ = previewFile;
4683 theimpl->preview_format_ = format;
4684 theimpl->require_fresh_start_ = (status != ExportSuccess);
4686 if (status != ExportSuccess)
4689 if (previewFile.exists())
4690 return theFormats().view(*this, previewFile, format) ?
4691 PreviewSuccess : PreviewError;
4693 // Successful export but no output file?
4694 // Probably a bug in error detection.
4695 LATTEST(status != ExportSuccess);
4700 Buffer::ReadStatus Buffer::extractFromVC()
4702 bool const found = LyXVC::file_not_found_hook(d->filename);
4704 return ReadFileNotFound;
4705 if (!d->filename.isReadableFile())
4711 Buffer::ReadStatus Buffer::loadEmergency()
4713 FileName const emergencyFile = getEmergencyFileName();
4714 if (!emergencyFile.exists()
4715 || emergencyFile.lastModified() <= d->filename.lastModified())
4716 return ReadFileNotFound;
4718 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4719 docstring const text = bformat(_("An emergency save of the document "
4720 "%1$s exists.\n\nRecover emergency save?"), file);
4722 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4723 0, 3, _("&Recover"), _("&Load Original"), _("&Only show difference"), _("&Cancel"));
4729 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4730 bool const success = (ret_llf == ReadSuccess);
4732 if (hasReadonlyFlag()) {
4733 Alert::warning(_("File is read-only"),
4734 bformat(_("An emergency file is successfully loaded, "
4735 "but the original file %1$s is marked read-only. "
4736 "Please make sure to save the document as a different "
4737 "file."), from_utf8(d->filename.absFileName())));
4740 lyxvc().file_found_hook(d->filename);
4741 str = _("Document was successfully recovered.");
4743 str = _("Document was NOT successfully recovered.");
4744 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4745 makeDisplayPath(emergencyFile.absFileName()));
4747 int const del_emerg =
4748 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4749 _("&Remove"), _("&Keep"));
4750 if (del_emerg == 0) {
4751 emergencyFile.removeFile();
4753 Alert::warning(_("Emergency file deleted"),
4754 _("Do not forget to save your file now!"), true);
4756 return success ? ReadSuccess : ReadEmergencyFailure;
4759 int const del_emerg =
4760 Alert::prompt(_("Delete emergency file?"),
4761 _("Remove emergency file now?"), 1, 1,
4762 _("&Remove"), _("&Keep"));
4764 emergencyFile.removeFile();
4768 string const ename = emergencyFile.absFileName();
4770 // Surely we can find one in 100 tries?
4771 for (int i = 1; i < 100; ++i) {
4772 newname.set(ename + to_string(i) + ".lyx");
4773 if (!newname.exists()) {
4779 // renameTo returns true on success. So inverting that
4780 // will give us true if we fail.
4781 noname = !emergencyFile.renameTo(newname);
4784 Alert::warning(_("Can't rename emergency file!"),
4785 _("LyX was unable to rename the emergency file. "
4786 "You should do so manually. Otherwise, you will be "
4787 "asked about it again the next time you try to load "
4788 "this file, and may over-write your own work."));
4790 Alert::warning(_("Emergency File Renames"),
4791 bformat(_("Emergency file renamed as:\n %1$s"),
4792 from_utf8(newname.onlyFileName())));
4795 return ReadOriginal;
4799 string const f1 = d->filename.absFileName();
4800 string const f2 = emergencyFile.absFileName();
4801 if (loadThisLyXFile(d->filename) != ReadSuccess)
4803 string const par = "compare run-blocking " + quoteName(f1) + " " + quoteName(f2);
4804 LYXERR(Debug::FILES, par << "\n");
4805 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, par));
4807 //release the emergency buffer loaded by compare
4808 Buffer * emerBuffer = theBufferList().getBuffer(emergencyFile);
4810 theBufferList().release(emerBuffer);
4812 return ReadCancel; //Release the buffer of Original immediatelly
4821 Buffer::ReadStatus Buffer::loadAutosave()
4823 // Now check if autosave file is newer.
4824 FileName const autosaveFile = getAutosaveFileName();
4825 if (!autosaveFile.exists()
4826 || autosaveFile.lastModified() <= d->filename.lastModified())
4827 return ReadFileNotFound;
4829 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4830 docstring const text = bformat(_("The backup of the document %1$s "
4831 "is newer.\n\nLoad the backup instead?"), file);
4832 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4833 _("&Load backup"), _("Load &original"), _("&Cancel"));
4838 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4839 // the file is not saved if we load the autosave file.
4840 if (ret_llf == ReadSuccess) {
4841 if (hasReadonlyFlag()) {
4842 Alert::warning(_("File is read-only"),
4843 bformat(_("A backup file is successfully loaded, "
4844 "but the original file %1$s is marked read-only. "
4845 "Please make sure to save the document as a "
4847 from_utf8(d->filename.absFileName())));
4850 lyxvc().file_found_hook(d->filename);
4853 return ReadAutosaveFailure;
4856 // Here we delete the autosave
4857 autosaveFile.removeFile();
4858 return ReadOriginal;
4866 Buffer::ReadStatus Buffer::loadLyXFile()
4868 if (!d->filename.isReadableFile()) {
4869 ReadStatus const ret_rvc = extractFromVC();
4870 if (ret_rvc != ReadSuccess)
4874 ReadStatus const ret_re = loadEmergency();
4875 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4878 ReadStatus const ret_ra = loadAutosave();
4879 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4882 return loadThisLyXFile(d->filename);
4886 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4888 return readFile(fn);
4892 void Buffer::Impl::traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const
4894 for (; err != end; ++err) {
4895 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4896 int errorRow = err->error_in_line;
4897 Buffer const * buf = nullptr;
4898 Impl const * p = this;
4899 if (err->child_name.empty())
4900 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4902 // The error occurred in a child
4903 for (Buffer const * child : owner_->getDescendants()) {
4904 string const child_name =
4905 DocFileName(changeExtension(child->absFileName(), "tex")).
4907 if (err->child_name != child_name)
4909 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4910 if (!TexRow::isNone(start)) {
4911 buf = this->cloned_buffer_
4912 ? child->d->cloned_buffer_->d->owner_
4919 errorList.push_back(ErrorItem(err->error_desc, err->error_text,
4925 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4927 TeXErrors::Errors::const_iterator err = terr.begin();
4928 TeXErrors::Errors::const_iterator end = terr.end();
4930 d->traverseErrors(err, end, errorList);
4934 void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const
4936 TeXErrors::Errors::const_iterator err = terr.begin_ref();
4937 TeXErrors::Errors::const_iterator end = terr.end_ref();
4939 d->traverseErrors(err, end, errorList);
4943 void Buffer::updateBuffer() const
4945 updateBuffer(UpdateMaster, InternalUpdate);
4946 d->need_update = false;
4950 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4952 LBUFERR(!text().paragraphs().empty());
4954 // This can be called when loading a file, so that there be no
4956 UndoGroupHelper ugh(const_cast<Buffer *>(this));
4958 // Use the master text class also for child documents
4959 Buffer const * const master = masterBuffer();
4960 DocumentClass const & textclass = master->params().documentClass();
4962 docstring_list old_bibfiles;
4963 // Do this only if we are the top-level Buffer. We also need to account
4964 // for the case of a previewed child with ignored parent here.
4965 if (master == this && !d->ignore_parent) {
4966 textclass.counters().reset(from_ascii("bibitem"));
4967 reloadBibInfoCache();
4968 // we will re-read this cache as we go through, but we need
4969 // to know whether it's changed to know whether we need to
4970 // update the bibinfo cache.
4971 old_bibfiles = d->bibfiles_cache_;
4972 d->bibfiles_cache_.clear();
4975 // keep the buffers to be children in this set. If the call from the
4976 // master comes back we can see which of them were actually seen (i.e.
4977 // via an InsetInclude). The remaining ones in the set need still be updated.
4978 static std::set<Buffer const *> bufToUpdate;
4979 if (scope == UpdateMaster) {
4980 // If this is a child document start with the master
4981 if (master != this) {
4982 bufToUpdate.insert(this);
4983 master->updateBuffer(UpdateMaster, utype);
4984 // If the master buffer has no gui associated with it, then the TocModel is
4985 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4986 // (bug 5699). The same happens if the master buffer is open in a different
4987 // window. This test catches both possibilities.
4988 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
4989 // There remains a problem here: If there is another child open in yet a third
4990 // window, that TOC is not updated. So some more general solution is needed at
4992 if (master->d->gui_ != d->gui_)
4995 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4996 if (bufToUpdate.find(this) == bufToUpdate.end())
5000 // start over the counters in the master
5001 textclass.counters().reset();
5004 // update will be done below for this buffer
5005 bufToUpdate.erase(this);
5007 // update all caches
5008 clearReferenceCache();
5011 Buffer & cbuf = const_cast<Buffer &>(*this);
5012 // if we are reloading, then we could have a dangling TOC,
5013 // in effect. so we need to go ahead and reset, even though
5014 // we will do so again when we rebuild the TOC later.
5015 cbuf.tocBackend().reset();
5018 ParIterator parit = cbuf.par_iterator_begin();
5019 if (scope == UpdateMaster)
5021 updateBuffer(parit, utype);
5023 // If this document has siblings, then update the TocBackend later. The
5024 // reason is to ensure that later siblings are up to date when e.g. the
5025 // broken or not status of references is computed. The update is called
5026 // in InsetInclude::addToToc.
5030 // if the bibfiles changed, the cache of bibinfo is invalid
5031 docstring_list new_bibfiles = d->bibfiles_cache_;
5032 // this is a trick to determine whether the two vectors have
5033 // the same elements.
5034 sort(new_bibfiles.begin(), new_bibfiles.end());
5035 sort(old_bibfiles.begin(), old_bibfiles.end());
5036 if (old_bibfiles != new_bibfiles) {
5037 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
5038 invalidateBibinfoCache();
5039 reloadBibInfoCache();
5040 // We relied upon the bibinfo cache when recalculating labels. But that
5041 // cache was invalid, although we didn't find that out until now. So we
5042 // have to do it all again.
5043 // That said, the only thing we really need to do is update the citation
5044 // labels. Nothing else will have changed. So we could create a new
5045 // UpdateType that would signal that fact, if we needed to do so.
5046 parit = cbuf.par_iterator_begin();
5047 // we will be re-doing the counters and references and such.
5048 textclass.counters().reset();
5049 clearReferenceCache();
5050 // we should not need to do this again?
5052 updateBuffer(parit, utype);
5053 // this will already have been done by reloadBibInfoCache();
5054 // d->bibinfo_cache_valid_ = true;
5057 LYXERR(Debug::FILES, "Bibfiles unchanged.");
5058 // this is also set to true on the other path, by reloadBibInfoCache.
5059 d->bibinfo_cache_valid_ = true;
5061 d->cite_labels_valid_ = true;
5064 cbuf.tocBackend().update(true, utype);
5065 if (scope == UpdateMaster)
5066 cbuf.structureChanged();
5068 d->need_update = false;
5072 static depth_type getDepth(DocIterator const & it)
5074 depth_type depth = 0;
5075 for (size_t i = 0 ; i < it.depth() ; ++i)
5076 if (!it[i].inset().inMathed())
5077 depth += it[i].paragraph().getDepth() + 1;
5078 // remove 1 since the outer inset does not count
5079 // we should have at least one non-math inset, so
5080 // depth should nevery be 0. but maybe it is worth
5081 // marking this, just in case.
5083 // coverity[INTEGER_OVERFLOW]
5087 static depth_type getItemDepth(ParIterator const & it)
5089 Paragraph const & par = *it;
5090 LabelType const labeltype = par.layout().labeltype;
5092 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5095 // this will hold the lowest depth encountered up to now.
5096 depth_type min_depth = getDepth(it);
5097 ParIterator prev_it = it;
5100 --prev_it.top().pit();
5102 // start of nested inset: go to outer par
5104 if (prev_it.empty()) {
5105 // start of document: nothing to do
5110 // We search for the first paragraph with same label
5111 // that is not more deeply nested.
5112 Paragraph & prev_par = *prev_it;
5113 depth_type const prev_depth = getDepth(prev_it);
5114 if (labeltype == prev_par.layout().labeltype) {
5115 if (prev_depth < min_depth)
5116 return prev_par.itemdepth + 1;
5117 if (prev_depth == min_depth)
5118 return prev_par.itemdepth;
5120 min_depth = min(min_depth, prev_depth);
5121 // small optimization: if we are at depth 0, we won't
5122 // find anything else
5123 if (prev_depth == 0)
5129 static bool needEnumCounterReset(ParIterator const & it)
5131 Paragraph const & par = *it;
5132 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5133 depth_type const cur_depth = par.getDepth();
5134 ParIterator prev_it = it;
5135 while (prev_it.pit()) {
5136 --prev_it.top().pit();
5137 Paragraph const & prev_par = *prev_it;
5138 if (prev_par.getDepth() <= cur_depth)
5139 return prev_par.layout().name() != par.layout().name();
5141 // start of nested inset: reset
5146 // set the label of a paragraph. This includes the counters.
5147 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5149 BufferParams const & bp = owner_->masterBuffer()->params();
5150 DocumentClass const & textclass = bp.documentClass();
5151 Paragraph & par = it.paragraph();
5152 Layout const & layout = par.layout();
5153 Counters & counters = textclass.counters();
5155 if (par.params().startOfAppendix()) {
5156 // We want to reset the counter corresponding to toplevel sectioning
5157 Layout const & lay = textclass.getTOCLayout();
5158 docstring const cnt = lay.counter;
5160 counters.reset(cnt);
5161 counters.appendix(true);
5163 par.params().appendix(counters.appendix());
5165 // Compute the item depth of the paragraph
5166 par.itemdepth = getItemDepth(it);
5168 if (layout.margintype == MARGIN_MANUAL) {
5169 if (par.params().labelWidthString().empty())
5170 par.params().labelWidthString(par.expandLabel(layout, bp));
5171 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5172 // we do not need to do anything here, since the empty case is
5173 // handled during export.
5175 par.params().labelWidthString(docstring());
5178 switch(layout.labeltype) {
5179 case LABEL_ITEMIZE: {
5180 par.params().labelString(
5182 ? bp.user_defined_bullet(par.itemdepth).getLabel()
5183 // Display fallback for too deeply nested items
5184 : bformat(from_ascii("[?%1$d]"), int(par.itemdepth + 1)));
5188 case LABEL_ENUMERATE: {
5189 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5191 switch (par.itemdepth) {
5202 enumcounter += "iv";
5205 // not a valid enumdepth...
5209 if (needEnumCounterReset(it)) {
5210 // Increase the parent counter?
5211 if (layout.stepparentcounter)
5212 counters.stepParent(enumcounter, utype);
5213 // Maybe we have to reset the enumeration counter.
5214 if (!layout.resumecounter)
5215 counters.reset(enumcounter);
5217 counters.step(enumcounter, utype);
5219 string const & lang = par.getParLanguage(bp)->code();
5220 par.params().labelString(counters.theCounter(enumcounter, lang));
5225 case LABEL_SENSITIVE: {
5226 string const & type = counters.current_float();
5227 docstring full_label;
5229 full_label = owner_->B_("Senseless!!! ");
5231 docstring name = owner_->B_(textclass.floats().getType(type).name());
5232 if (counters.hasCounter(from_utf8(type))) {
5233 string const & lang = par.getParLanguage(bp)->code();
5234 counters.step(from_utf8(type), utype);
5235 full_label = bformat(from_ascii("%1$s %2$s:"),
5237 counters.theCounter(from_utf8(type), lang));
5239 full_label = bformat(from_ascii("%1$s #:"), name);
5241 par.params().labelString(full_label);
5245 case LABEL_NO_LABEL:
5246 par.params().labelString(docstring());
5250 case LABEL_CENTERED:
5251 case LABEL_STATIC: {
5252 docstring const & lcounter = layout.counter;
5253 if (!lcounter.empty()) {
5254 if (layout.toclevel <= bp.secnumdepth
5255 && (layout.latextype != LATEX_ENVIRONMENT
5256 || it.text()->isFirstInSequence(it.pit()))) {
5257 if (counters.hasCounter(lcounter))
5258 counters.step(lcounter, utype);
5259 par.params().labelString(par.expandLabel(layout, bp));
5261 par.params().labelString(docstring());
5263 par.params().labelString(par.expandLabel(layout, bp));
5269 par.params().labelString(par.expandLabel(layout, bp));
5274 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype, bool const deleted) const
5276 pushIncludedBuffer(this);
5277 // LASSERT: Is it safe to continue here, or should we just return?
5278 LASSERT(parit.pit() == 0, /**/);
5280 // Set the position of the text in the buffer to be able
5281 // to resolve macros in it.
5282 parit.text()->setMacrocontextPosition(parit);
5284 depth_type maxdepth = 0;
5285 pit_type const lastpit = parit.lastpit();
5286 bool changed = false;
5287 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5288 // reduce depth if necessary
5289 if (parit->params().depth() > maxdepth) {
5290 /** FIXME: this function is const, but
5291 * nevertheless it modifies the buffer. To be
5292 * cleaner, one should modify the buffer in
5293 * another function, which is actually
5294 * non-const. This would however be costly in
5295 * terms of code duplication.
5297 CursorData(parit).recordUndo();
5298 parit->params().depth(maxdepth);
5300 maxdepth = parit->getMaxDepthAfter();
5302 if (utype == OutputUpdate) {
5303 // track the active counters
5304 // we have to do this for the master buffer, since the local
5305 // buffer isn't tracking anything.
5306 masterBuffer()->params().documentClass().counters().
5307 setActiveLayout(parit->layout());
5310 // set the counter for this paragraph
5311 d->setLabel(parit, utype);
5314 for (auto const & insit : parit->insetList()) {
5315 parit.pos() = insit.pos;
5316 insit.inset->updateBuffer(parit, utype, deleted || parit->isDeleted(insit.pos));
5317 changed |= insit.inset->isChanged();
5320 // are there changes in this paragraph?
5321 changed |= parit->isChanged();
5324 // set change indicator for the inset (or the cell that the iterator
5325 // points to, if applicable).
5326 parit.text()->inset().isChanged(changed);
5327 popIncludedBuffer();
5331 void Buffer::forceUpdate() const
5333 d->need_update = true;
5337 bool Buffer::needUpdate() const
5339 return d->need_update;
5343 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5344 WordLangTuple & word_lang, docstring_list & suggestions) const
5348 suggestions.clear();
5349 word_lang = WordLangTuple();
5350 bool const to_end = to.empty();
5351 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5352 // OK, we start from here.
5353 for (; from != end; from.forwardPos()) {
5354 // This skips all insets with spell check disabled.
5355 while (!from.allowSpellCheck()) {
5359 // If from is at the end of the document (which is possible
5360 // when "from" was changed above) LyX will crash later otherwise.
5361 if (from.atEnd() || (!to_end && from >= end))
5364 from.paragraph().spellCheck();
5365 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5366 if (SpellChecker::misspelled(res)) {
5370 // Do not increase progress when from == to, otherwise the word
5371 // count will be wrong.
5381 void Buffer::requestSpellcheck()
5383 ParagraphList::iterator pit = paragraphs().begin();
5384 ParagraphList::iterator pend = paragraphs().end();
5385 for (; pit != pend; ++pit)
5386 pit->requestSpellCheck();
5390 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5392 bool inword = false;
5397 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5398 if (!dit.inTexted()) {
5403 Paragraph const & par = dit.paragraph();
5404 pos_type const pos = dit.pos();
5406 // Copied and adapted from isWordSeparator() in Paragraph
5407 if (pos == dit.lastpos()) {
5410 Inset const * ins = par.getInset(pos);
5411 if (ins && skipNoOutput && !ins->producesOutput()) {
5414 // stop if end of range was skipped
5415 if (!to.atEnd() && dit >= to)
5418 } else if (!par.isDeleted(pos)) {
5419 if (par.isWordSeparator(pos))
5425 if (ins && ins->isLetter()) {
5426 odocstringstream os;
5428 char_count_ += os.str().length();
5430 else if (ins && ins->isSpace())
5433 pair<int, int> words = ins->isWords();
5434 char_count_ += words.first;
5435 word_count_ += words.second;
5439 char_type const c = par.getChar(pos);
5440 if (isPrintableNonspace(c))
5442 else if (isSpace(c))
5452 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5454 d->updateStatistics(from, to, skipNoOutput);
5458 int Buffer::wordCount() const
5460 return d->wordCount();
5464 int Buffer::charCount(bool with_blanks) const
5466 return d->charCount(with_blanks);
5470 bool Buffer::areChangesPresent() const
5472 return inset().isChanged();
5476 Buffer::ReadStatus Buffer::reload()
5479 // c.f. bug https://www.lyx.org/trac/ticket/6587
5480 removeAutosaveFile();
5481 // e.g., read-only status could have changed due to version control
5482 d->filename.refresh();
5483 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5485 // clear parent. this will get reset if need be.
5486 d->setParent(nullptr);
5487 ReadStatus const status = loadLyXFile();
5488 if (status == ReadSuccess) {
5493 message(bformat(_("Document %1$s reloaded."), disp_fn));
5496 message(bformat(_("Could not reload document %1$s."), disp_fn));
5506 bool Buffer::saveAs(FileName const & fn)
5508 FileName const old_name = fileName();
5509 FileName const old_auto = getAutosaveFileName();
5510 bool const old_unnamed = isUnnamed();
5511 bool success = true;
5512 d->old_position = filePath();
5519 // bring the autosave file with us, just in case.
5520 moveAutosaveFile(old_auto);
5521 // validate version control data and
5522 // correct buffer title
5523 lyxvc().file_found_hook(fileName());
5525 // the file has now been saved to the new location.
5526 // we need to check that the locations of child buffers
5528 checkChildBuffers();
5529 checkMasterBuffer();
5532 // reset the old filename and unnamed state
5533 setFileName(old_name);
5534 setUnnamed(old_unnamed);
5538 d->old_position.clear();
5543 void Buffer::checkChildBuffers()
5545 for (auto const & bit : d->children_positions) {
5546 DocIterator dit = bit.second;
5547 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5548 if (!cbuf || !theBufferList().isLoaded(cbuf))
5550 Inset * inset = dit.nextInset();
5551 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5552 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5553 docstring const & incfile = inset_inc->getParam("filename");
5554 string oldloc = cbuf->absFileName();
5555 string newloc = makeAbsPath(to_utf8(incfile),
5556 onlyPath(absFileName())).absFileName();
5557 if (oldloc == newloc)
5559 // the location of the child file is incorrect.
5560 cbuf->setParent(nullptr);
5561 inset_inc->setChildBuffer(nullptr);
5563 // invalidate cache of children
5564 d->children_positions.clear();
5565 d->position_to_children.clear();
5569 // If a child has been saved under a different name/path, it might have been
5570 // orphaned. Therefore the master needs to be reset (bug 8161).
5571 void Buffer::checkMasterBuffer()
5573 Buffer const * const master = masterBuffer();
5577 // necessary to re-register the child (bug 5873)
5578 // FIXME: clean up updateMacros (here, only
5579 // child registering is needed).
5580 master->updateMacros();
5581 // (re)set master as master buffer, but only
5582 // if we are a real child
5583 if (master->isChild(this))
5590 string Buffer::includedFilePath(string const & name, string const & ext) const
5592 if (d->old_position.empty() ||
5593 equivalent(FileName(d->old_position), FileName(filePath())))
5596 bool isabsolute = FileName::isAbsolute(name);
5597 // both old_position and filePath() end with a path separator
5598 string absname = isabsolute ? name : d->old_position + name;
5600 // if old_position is set to origin, we need to do the equivalent of
5601 // getReferencedFileName() (see readDocument())
5602 if (!isabsolute && d->old_position == params().origin) {
5603 FileName const test(addExtension(filePath() + name, ext));
5605 absname = filePath() + name;
5608 if (!FileName(addExtension(absname, ext)).exists())
5612 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5614 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5615 from_utf8(filePath())));
5619 void Buffer::Impl::refreshFileMonitor()
5621 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5622 file_monitor_->refresh();
5626 // The previous file monitor is invalid
5627 // This also destroys the previous file monitor and all its connections
5628 file_monitor_ = FileSystemWatcher::monitor(filename);
5629 // file_monitor_ will be destroyed with *this, so it is not going to call a
5630 // destroyed object method.
5631 file_monitor_->connect([this](bool exists) {
5632 fileExternallyModified(exists);
5637 void Buffer::Impl::fileExternallyModified(bool const exists)
5639 // ignore notifications after our own saving operations
5640 if (checksum_ == filename.checksum()) {
5641 LYXERR(Debug::FILES, "External modification but "
5642 "checksum unchanged: " << filename);
5645 // If the file has been deleted, only mark the file as dirty since it is
5646 // pointless to prompt for reloading. If later a file is moved into this
5647 // location, then the externally modified warning will appear then.
5649 externally_modified_ = true;
5650 // Update external modification notification.
5651 // Dirty buffers must be visible at all times.
5652 if (wa_ && wa_->unhide(owner_))
5653 wa_->updateTitles();
5655 // Unable to unhide the buffer (e.g. no GUI or not current View)
5660 bool Buffer::notifiesExternalModification() const
5662 return d->externally_modified_;
5666 void Buffer::clearExternalModification() const
5668 d->externally_modified_ = false;
5670 d->wa_->updateTitles();
5674 void Buffer::pushIncludedBuffer(Buffer const * buf) const
5676 masterBuffer()->d->include_list_.push_back(buf);
5677 if (lyxerr.debugging(Debug::FILES)) {
5678 LYXERR0("Pushed. Stack now:");
5679 if (masterBuffer()->d->include_list_.empty())
5682 for (auto const & b : masterBuffer()->d->include_list_)
5683 LYXERR0(b->fileName());
5688 void Buffer::popIncludedBuffer() const
5690 masterBuffer()->d->include_list_.pop_back();
5691 if (lyxerr.debugging(Debug::FILES)) {
5692 LYXERR0("Popped. Stack now:");
5693 if (masterBuffer()->d->include_list_.empty())
5696 for (auto const & b : masterBuffer()->d->include_list_)
5697 LYXERR0(b->fileName());
5702 bool Buffer::isBufferIncluded(Buffer const * buf) const
5706 if (lyxerr.debugging(Debug::FILES)) {
5707 LYXERR0("Checking for " << buf->fileName() << ". Stack now:");
5708 if (masterBuffer()->d->include_list_.empty())
5711 for (auto const & b : masterBuffer()->d->include_list_)
5712 LYXERR0(b->fileName());
5714 list<Buffer const *> const & blist = masterBuffer()->d->include_list_;
5715 return find(blist.begin(), blist.end(), buf) != blist.end();
5719 void Buffer::clearIncludeList() const
5721 LYXERR(Debug::FILES, "Clearing include list for " << fileName());
5722 d->include_list_.clear();