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"
24 #include "Converter.h"
27 #include "CutAndPaste.h"
28 #include "DispatchResult.h"
29 #include "DocIterator.h"
30 #include "BufferEncodings.h"
31 #include "ErrorList.h"
34 #include "FuncRequest.h"
35 #include "FuncStatus.h"
36 #include "IndicesList.h"
37 #include "InsetIterator.h"
38 #include "InsetList.h"
40 #include "LaTeXFeatures.h"
44 #include "LyXAction.h"
49 #include "output_latex.h"
50 #include "output_docbook.h"
51 #include "output_plaintext.h"
52 #include "output_xhtml.h"
53 #include "Paragraph.h"
54 #include "ParagraphParameters.h"
55 #include "ParIterator.h"
56 #include "PDFOptions.h"
58 #include "SpellChecker.h"
60 #include "texstream.h"
63 #include "TextClass.h"
64 #include "TocBackend.h"
66 #include "VCBackend.h"
68 #include "WordLangTuple.h"
70 #include "insets/InsetBranch.h"
71 #include "insets/InsetInclude.h"
72 #include "insets/InsetTabular.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_;
363 /// This is here to force the test to be done whenever parent_buffer
365 Buffer const * parent() const
367 // ignore_parent temporarily "orphans" a buffer
368 // (e.g. if a child is compiled standalone)
371 // if parent_buffer is not loaded, then it has been unloaded,
372 // which means that parent_buffer is an invalid pointer. So we
373 // set it to null in that case.
374 // however, the BufferList doesn't know about cloned buffers, so
375 // they will always be regarded as unloaded. in that case, we hope
377 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
378 parent_buffer = nullptr;
379 return parent_buffer;
383 void setParent(Buffer const * pb)
385 if (parent_buffer == pb)
388 if (!cloned_buffer_ && parent_buffer && pb)
389 LYXERR0("Warning: a buffer should not have two parents!");
391 if (!cloned_buffer_ && parent_buffer)
392 parent_buffer->invalidateBibinfoCache();
395 /// compute statistics
396 /// \p from initial position
397 /// \p to points to the end position
398 void updateStatistics(DocIterator & from, DocIterator & to,
399 bool skipNoOutput = true);
400 /// statistics accessor functions
401 int wordCount() const
405 int charCount(bool with_blanks) const
408 + (with_blanks ? blank_count_ : 0);
411 // Make sure the file monitor monitors the good file.
412 void refreshFileMonitor();
414 /// Notify or clear of external modification
415 void fileExternallyModified(bool exists);
417 ///Binding LaTeX lines with buffer positions.
418 //Common routine for LaTeX and Reference errors listing.
419 void traverseErrors(TeXErrors::Errors::const_iterator err,
420 TeXErrors::Errors::const_iterator end,
421 ErrorList & errorList) const;
425 /// Creates the per buffer temporary directory
426 static FileName createBufferTmpDir()
428 // FIXME This would be the ideal application for a TempDir class (like
429 // TempFile but for directories)
434 Mutex::Locker locker(&mutex);
435 counter = convert<string>(count++);
437 // We are in our own directory. Why bother to mangle name?
438 // In fact I wrote this code to circumvent a problematic behaviour
439 // (bug?) of EMX mkstemp().
440 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
443 if (!tmpfl.createDirectory(0777)) {
444 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
445 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
446 from_utf8(tmpfl.absFileName())));
452 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
453 Buffer const * cloned_buffer)
454 : owner_(owner), filename(file), toc_backend(owner), checksum_(0),
455 wa_(nullptr), gui_(nullptr), undo_(*owner), inset(nullptr),
456 preview_loader_(nullptr), cloned_buffer_(cloned_buffer),
457 clone_list_(nullptr), parent_buffer(nullptr), file_format(LYX_FORMAT),
458 doing_export(false), require_fresh_start_(false), cite_labels_valid_(false),
459 have_bibitems_(false), lyx_clean(true), bak_clean(true), unnamed(false),
460 internal_buffer(false), read_only(readonly_), file_fully_loaded(false),
461 need_format_backup(false), ignore_parent(false), macro_lock(false),
462 externally_modified_(false), bibinfo_cache_valid_(false),
463 word_count_(0), char_count_(0), blank_count_(0)
465 refreshFileMonitor();
466 if (!cloned_buffer_) {
467 temppath = createBufferTmpDir();
468 lyxvc.setBuffer(owner_);
469 Language const * inplang = theApp() ?
470 languages.getFromCode(theApp()->inputLanguageCode())
473 params.language = inplang;
475 wa_ = new frontend::WorkAreaManager;
478 temppath = cloned_buffer_->d->temppath;
479 file_fully_loaded = true;
480 params = cloned_buffer_->d->params;
481 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
482 bibinfo_ = cloned_buffer_->d->bibinfo_;
483 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
484 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
485 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
486 have_bibitems_ = cloned_buffer_->d->have_bibitems_;
487 unnamed = cloned_buffer_->d->unnamed;
488 internal_buffer = cloned_buffer_->d->internal_buffer;
489 layout_position = cloned_buffer_->d->layout_position;
490 preview_file_ = cloned_buffer_->d->preview_file_;
491 preview_format_ = cloned_buffer_->d->preview_format_;
492 require_fresh_start_ = cloned_buffer_->d->require_fresh_start_;
496 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
497 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
499 LYXERR(Debug::INFO, "Buffer::Buffer()");
501 d->inset = new InsetText(*cloned_buffer->d->inset);
502 d->inset->setBuffer(*this);
503 // FIXME: optimize this loop somewhat, maybe by creating a new
504 // general recursive Inset::setId().
505 DocIterator it = doc_iterator_begin(this);
506 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
507 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
508 it.paragraph().setId(cloned_it.paragraph().id());
510 d->inset = new InsetText(this);
511 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
517 LYXERR(Debug::INFO, "Buffer::~Buffer()");
518 // here the buffer should take care that it is
519 // saved properly, before it goes into the void.
521 // GuiView already destroyed
525 // No need to do additional cleanups for internal buffer.
531 // this is in case of recursive includes: we won't try to delete
532 // ourselves as a child.
533 d->clone_list_->erase(this);
534 // loop over children
535 for (auto const & p : d->children_positions) {
536 Buffer * child = const_cast<Buffer *>(p.first);
537 if (d->clone_list_->erase(child))
540 // if we're the master buffer, then we should get rid of the list
543 // If this is not empty, we have leaked something. Worse, one of the
544 // children still has a reference to this list. But we will try to
545 // continue, rather than shut down.
546 LATTEST(d->clone_list_->empty());
547 // The clone list itself is empty, but it's still referenced in our list
548 // of clones. So let's find it and remove it.
549 CloneStore::iterator it =
550 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
551 if (it == cloned_buffers.end()) {
552 // We will leak in this case, but it is safe to continue.
555 cloned_buffers.erase(it);
557 // FIXME Do we really need to do this right before we delete d?
558 // clear references to children in macro tables
559 d->children_positions.clear();
560 d->position_to_children.clear();
562 // loop over children
563 for (auto const & p : d->children_positions) {
564 Buffer * child = const_cast<Buffer *>(p.first);
565 if (theBufferList().isLoaded(child)) {
566 if (theBufferList().isOthersChild(this, child))
567 child->setParent(nullptr);
569 theBufferList().release(child);
574 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
576 msg += emergencyWrite();
578 msg += " " + _("Save failed! Document is lost.");
580 Alert::warning(_("Attempting to close changed document!"), msg);
583 // FIXME Do we really need to do this right before we delete d?
584 // clear references to children in macro tables
585 d->children_positions.clear();
586 d->position_to_children.clear();
588 if (!d->temppath.destroyDirectory()) {
589 LYXERR0(bformat(_("Could not remove the temporary directory %1$s"),
590 from_utf8(d->temppath.absFileName())));
599 Buffer * Buffer::cloneWithChildren() const
602 cloned_buffers.emplace_back(new CloneList);
603 CloneList_ptr clones = cloned_buffers.back();
605 cloneWithChildren(bufmap, clones);
607 // make sure we got cloned
608 BufferMap::const_iterator bit = bufmap.find(this);
609 LASSERT(bit != bufmap.end(), return nullptr);
610 Buffer * cloned_buffer = bit->second;
612 return cloned_buffer;
616 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList_ptr clones) const
618 // have we already been cloned?
619 if (bufmap.find(this) != bufmap.end())
622 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
624 // The clone needs its own DocumentClass, since running updateBuffer() will
625 // modify it, and we would otherwise be sharing it with the original Buffer.
626 buffer_clone->params().makeDocumentClass(true);
628 cap::switchBetweenClasses(
629 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
630 static_cast<InsetText &>(buffer_clone->inset()), el);
632 bufmap[this] = buffer_clone;
633 clones->insert(buffer_clone);
634 buffer_clone->d->clone_list_ = clones;
635 buffer_clone->d->macro_lock = true;
636 buffer_clone->d->children_positions.clear();
638 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
639 // math macro caches need to be rethought and simplified.
640 // I am not sure wether we should handle Buffer cloning here or in BufferList.
641 // Right now BufferList knows nothing about buffer clones.
642 for (auto const & p : d->position_to_children) {
643 DocIterator dit = p.first.clone(buffer_clone);
644 dit.setBuffer(buffer_clone);
645 Buffer * child = const_cast<Buffer *>(p.second.buffer);
647 child->cloneWithChildren(bufmap, clones);
648 BufferMap::iterator const bit = bufmap.find(child);
649 LASSERT(bit != bufmap.end(), continue);
650 Buffer * child_clone = bit->second;
652 Inset * inset = dit.nextInset();
653 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
654 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
655 inset_inc->setChildBuffer(child_clone);
656 child_clone->d->setParent(buffer_clone);
657 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
658 buffer_clone->setChild(dit, child_clone);
660 buffer_clone->d->macro_lock = false;
664 Buffer * Buffer::cloneBufferOnly() const {
665 cloned_buffers.emplace_back(new CloneList);
666 CloneList_ptr clones = cloned_buffers.back();
667 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
669 // The clone needs its own DocumentClass, since running updateBuffer() will
670 // modify it, and we would otherwise be sharing it with the original Buffer.
671 buffer_clone->params().makeDocumentClass(true);
673 cap::switchBetweenClasses(
674 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
675 static_cast<InsetText &>(buffer_clone->inset()), el);
677 clones->insert(buffer_clone);
678 buffer_clone->d->clone_list_ = clones;
680 // we won't be cloning the children
681 buffer_clone->d->children_positions.clear();
686 bool Buffer::isClone() const
688 return d->cloned_buffer_;
692 void Buffer::changed(bool update_metrics) const
695 d->wa_->redrawAll(update_metrics);
699 frontend::WorkAreaManager & Buffer::workAreaManager() const
706 Text & Buffer::text() const
708 return d->inset->text();
712 Inset & Buffer::inset() const
718 BufferParams & Buffer::params()
724 BufferParams const & Buffer::params() const
730 BufferParams const & Buffer::masterParams() const
732 if (masterBuffer() == this)
735 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
736 // Copy child authors to the params. We need those pointers.
737 for (Author const & a : params().authors())
738 mparams.authors().record(a);
743 double Buffer::fontScalingFactor() const
745 return isExporting() ? 75.0 * params().html_math_img_scale
746 : 0.01 * lyxrc.dpi * lyxrc.currentZoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
750 ParagraphList & Buffer::paragraphs()
752 return text().paragraphs();
756 ParagraphList const & Buffer::paragraphs() const
758 return text().paragraphs();
762 LyXVC & Buffer::lyxvc()
768 LyXVC const & Buffer::lyxvc() const
774 string const Buffer::temppath() const
776 return d->temppath.absFileName();
780 TexRow & Buffer::texrow()
786 TexRow const & Buffer::texrow() const
792 TocBackend & Buffer::tocBackend() const
794 return d->toc_backend;
798 Undo & Buffer::undo()
804 void Buffer::setChild(DocIterator const & dit, Buffer * child)
806 d->children_positions[child] = dit;
810 string Buffer::latexName(bool const no_path) const
812 FileName latex_name =
813 makeLatexName(d->exportFileName());
814 return no_path ? latex_name.onlyFileName()
815 : latex_name.absFileName();
819 FileName Buffer::Impl::exportFileName() const
821 docstring const branch_suffix =
822 params.branchlist().getFileNameSuffix();
823 if (branch_suffix.empty())
826 string const name = addExtension(filename.onlyFileNameWithoutExt()
827 + to_utf8(branch_suffix), filename.extension());
828 FileName res(filename.onlyPath().absFileName() + "/" + name);
834 string Buffer::logName(LogType * type) const
836 string const filename = latexName(false);
838 if (filename.empty()) {
844 string const path = temppath();
846 FileName const fname(addName(temppath(),
847 onlyFileName(changeExtension(filename,
850 // FIXME: how do we know this is the name of the build log?
851 FileName const bname(
852 addName(path, onlyFileName(
853 changeExtension(filename,
854 theFormats().extension(params().bufferFormat()) + ".out"))));
856 // Also consider the master buffer log file
857 FileName masterfname = fname;
858 LogType mtype = latexlog;
859 if (masterBuffer() != this) {
860 string const mlogfile = masterBuffer()->logName(&mtype);
861 masterfname = FileName(mlogfile);
864 // If no Latex log or Build log is newer, show Build log
865 if (bname.exists() &&
866 ((!fname.exists() && !masterfname.exists())
867 || (fname.lastModified() < bname.lastModified()
868 && masterfname.lastModified() < bname.lastModified()))) {
869 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
872 return bname.absFileName();
873 // If we have a newer master file log or only a master log, show this
874 } else if (fname != masterfname
875 && (!fname.exists() && (masterfname.exists()
876 || fname.lastModified() < masterfname.lastModified()))) {
877 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
880 return masterfname.absFileName();
882 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
885 return fname.absFileName();
889 void Buffer::setReadonly(bool const flag)
891 if (d->read_only != flag) {
898 void Buffer::setFileName(FileName const & fname)
900 bool const changed = fname != d->filename;
902 d->refreshFileMonitor();
904 lyxvc().file_found_hook(fname);
905 setReadonly(d->filename.isReadOnly());
911 int Buffer::readHeader(Lexer & lex)
913 int unknown_tokens = 0;
915 int begin_header_line = -1;
917 // Initialize parameters that may be/go lacking in header:
918 params().branchlist().clear();
919 params().preamble.erase();
920 params().options.erase();
921 params().master.erase();
922 params().float_placement.erase();
923 params().float_alignment.erase();
924 params().paperwidth.erase();
925 params().paperheight.erase();
926 params().leftmargin.erase();
927 params().rightmargin.erase();
928 params().topmargin.erase();
929 params().bottommargin.erase();
930 params().headheight.erase();
931 params().headsep.erase();
932 params().footskip.erase();
933 params().columnsep.erase();
934 params().font_roman_opts.erase();
935 params().font_sans_opts.erase();
936 params().font_typewriter_opts.erase();
937 params().fonts_cjk.erase();
938 params().listings_params.clear();
939 params().clearLayoutModules();
940 params().clearRemovedModules();
941 params().clearIncludedChildren();
942 params().pdfoptions().clear();
943 params().indiceslist().clear();
944 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
945 params().isbackgroundcolor = false;
946 params().fontcolor = RGBColor(0, 0, 0);
947 params().isfontcolor = false;
948 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
949 params().boxbgcolor = RGBColor(0xFF, 0, 0);
950 params().html_latex_start.clear();
951 params().html_latex_end.clear();
952 params().html_math_img_scale = 1.0;
953 params().output_sync_macro.erase();
954 params().setLocalLayout(docstring(), false);
955 params().setLocalLayout(docstring(), true);
956 params().biblio_opts.erase();
957 params().biblatex_bibstyle.erase();
958 params().biblatex_citestyle.erase();
959 params().multibib.erase();
960 params().lineno_opts.clear();
962 for (int i = 0; i < 4; ++i) {
963 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
964 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
967 ErrorList & errorList = d->errorLists["Parse"];
976 if (token == "\\end_header")
980 if (token == "\\begin_header") {
981 begin_header_line = line;
985 LYXERR(Debug::PARSER, "Handling document header token: `"
988 string const result =
989 params().readToken(lex, token, d->filename.onlyPath());
990 if (!result.empty()) {
991 if (token == "\\textclass") {
992 d->layout_position = result;
995 docstring const s = bformat(_("Unknown token: "
999 errorList.push_back(ErrorItem(_("Document header error"), s));
1003 if (begin_header_line) {
1004 docstring const s = _("\\begin_header is missing");
1005 errorList.push_back(ErrorItem(_("Document header error"), s));
1008 params().shell_escape = theSession().shellescapeFiles().find(absFileName());
1010 params().makeDocumentClass();
1012 return unknown_tokens;
1017 // changed to be public and have one parameter
1018 // Returns true if "\end_document" is not read (Asger)
1019 bool Buffer::readDocument(Lexer & lex)
1021 ErrorList & errorList = d->errorLists["Parse"];
1024 // remove dummy empty par
1025 paragraphs().clear();
1027 if (!lex.checkFor("\\begin_document")) {
1028 docstring const s = _("\\begin_document is missing");
1029 errorList.push_back(ErrorItem(_("Document header error"), s));
1034 if (params().output_changes) {
1035 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1036 LaTeXFeatures::isAvailable("xcolor");
1039 Alert::warning(_("Changes not shown in LaTeX output"),
1040 _("Changes will not be highlighted in LaTeX output, "
1041 "because xcolor and ulem are not installed.\n"
1042 "Please install both packages or redefine "
1043 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1047 if (!parent() && !params().master.empty()) {
1048 FileName const master_file = makeAbsPath(params().master,
1049 onlyPath(absFileName()));
1050 if (isLyXFileName(master_file.absFileName())) {
1052 checkAndLoadLyXFile(master_file, true);
1054 // necessary e.g. after a reload
1055 // to re-register the child (bug 5873)
1056 // FIXME: clean up updateMacros (here, only
1057 // child registering is needed).
1058 master->updateMacros();
1059 // set master as master buffer, but only
1060 // if we are a real child
1061 if (master->isChild(this))
1063 // if the master is not fully loaded
1064 // it is probably just loading this
1065 // child. No warning needed then.
1066 else if (master->isFullyLoaded())
1067 LYXERR0("The master '"
1069 << "' assigned to this document ("
1071 << ") does not include "
1072 "this document. Ignoring the master assignment.");
1073 // If the master has just been created, un-hide it (#11162)
1074 if (!master->fileName().exists())
1075 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
1076 master->absFileName()));
1081 // assure we have a default index
1082 params().indiceslist().addDefault(B_("Index"));
1085 if (FileName::isAbsolute(params().origin))
1086 d->old_position = params().origin;
1088 d->old_position = filePath();
1093 bool const res = text().read(lex, errorList, d->inset);
1094 d->old_position.clear();
1096 // inform parent buffer about local macros
1098 Buffer const * pbuf = parent();
1099 for (auto const & m : usermacros)
1100 pbuf->usermacros.insert(m);
1104 updateMacroInstances(InternalUpdate);
1109 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1111 Format const * fmt = theFormats().getFormat(format);
1114 // It is important to use the correct extension here, since some
1115 // converters create a wrong output file otherwise (e.g. html2latex)
1116 FileName const name = tempFileName("Buffer_importStringXXXXXX." + fmt->extension());
1117 ofdocstream os(name.toFilesystemEncoding().c_str());
1118 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1119 bool const success = !(os << contents).fail();
1122 bool converted = false;
1124 params().compressed = false;
1126 // remove dummy empty par
1127 paragraphs().clear();
1129 converted = importFile(format, name, errorList);
1132 removeTempFile(name);
1137 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1139 if (!theConverters().isReachable(format, "lyx"))
1142 FileName const lyx = tempFileName("Buffer_importFileXXXXXX.lyx");
1143 Converters::RetVal const retval =
1144 theConverters().convert(nullptr, name, lyx, name, format, "lyx", errorList);
1145 if (retval == Converters::SUCCESS) {
1146 bool const success = readFile(lyx) == ReadSuccess;
1147 removeTempFile(lyx);
1155 bool Buffer::readString(string const & s)
1157 params().compressed = false;
1160 istringstream is(s);
1162 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1163 FileName const fn = tempfile.name();
1166 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1168 if (success && file_format != LYX_FORMAT) {
1169 // We need to call lyx2lyx, so write the input to a file
1170 ofstream os(fn.toFilesystemEncoding().c_str());
1173 // lyxvc in readFile
1174 if (readFile(fn) != ReadSuccess)
1178 if (readDocument(lex))
1184 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1187 if (!lex.setFile(fn)) {
1188 Alert::error(_("File Not Found"),
1189 bformat(_("Unable to open file `%1$s'."),
1190 from_utf8(fn.absFileName())));
1191 return ReadFileNotFound;
1195 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1196 if (ret_plf != ReadSuccess)
1199 if (file_format != LYX_FORMAT) {
1201 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1202 if (ret_clf != ReadSuccess)
1204 ret_clf = readFile(tmpFile);
1205 if (ret_clf == ReadSuccess) {
1206 d->file_format = file_format;
1207 d->need_format_backup = true;
1212 // FIXME: InsetInfo needs to know whether the file is under VCS
1213 // during the parse process, so this has to be done before.
1214 lyxvc().file_found_hook(d->filename);
1216 if (readDocument(lex)) {
1217 Alert::error(_("Document format failure"),
1218 bformat(_("%1$s ended unexpectedly, which means"
1219 " that it is probably corrupted."),
1220 from_utf8(fn.absFileName())));
1221 return ReadDocumentFailure;
1224 d->file_fully_loaded = true;
1225 d->read_only = !d->filename.isWritable();
1226 params().compressed = theFormats().isZippedFile(d->filename);
1232 bool Buffer::isFullyLoaded() const
1234 return d->file_fully_loaded;
1238 void Buffer::setFullyLoaded(bool value)
1240 d->file_fully_loaded = value;
1244 bool Buffer::freshStartRequired() const
1246 return d->require_fresh_start_;
1249 void Buffer::requireFreshStart(bool const b) const
1251 d->require_fresh_start_ = b;
1255 PreviewLoader * Buffer::loader() const
1257 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1259 if (!d->preview_loader_)
1260 d->preview_loader_ = new PreviewLoader(*this);
1261 return d->preview_loader_;
1265 void Buffer::removePreviews() const
1267 delete d->preview_loader_;
1268 d->preview_loader_ = nullptr;
1272 void Buffer::updatePreviews() const
1274 PreviewLoader * ploader = loader();
1278 InsetIterator it = inset_iterator_begin(*d->inset);
1279 InsetIterator const end = inset_iterator_end(*d->inset);
1280 for (; it != end; ++it)
1281 it->addPreview(it, *ploader);
1283 ploader->startLoading();
1287 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1288 FileName const & fn, int & file_format) const
1290 if(!lex.checkFor("\\lyxformat")) {
1291 Alert::error(_("Document format failure"),
1292 bformat(_("%1$s is not a readable LyX document."),
1293 from_utf8(fn.absFileName())));
1294 return ReadNoLyXFormat;
1300 // LyX formats 217 and earlier were written as 2.17. This corresponds
1301 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1302 // these cases. See also: www.lyx.org/trac/changeset/1313.
1303 size_t dot = tmp_format.find_first_of(".,");
1304 if (dot != string::npos)
1305 tmp_format.erase(dot, 1);
1307 file_format = convert<int>(tmp_format);
1312 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1313 FileName & tmpfile, int from_format)
1315 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1316 tempfile.setAutoRemove(false);
1317 tmpfile = tempfile.name();
1318 if(tmpfile.empty()) {
1319 Alert::error(_("Conversion failed"),
1320 bformat(_("%1$s is from a different"
1321 " version of LyX, but a temporary"
1322 " file for converting it could"
1323 " not be created."),
1324 from_utf8(fn.absFileName())));
1325 return LyX2LyXNoTempFile;
1328 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1329 if (lyx2lyx.empty()) {
1330 Alert::error(_("Conversion script not found"),
1331 bformat(_("%1$s is from a different"
1332 " version of LyX, but the"
1333 " conversion script lyx2lyx"
1334 " could not be found."),
1335 from_utf8(fn.absFileName())));
1336 return LyX2LyXNotFound;
1340 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1341 ostringstream command;
1342 command << os::python()
1343 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1344 << " -t " << convert<string>(LYX_FORMAT)
1345 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1346 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1347 string const command_str = command.str();
1349 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1351 cmd_ret const ret = runCommand(command_str);
1353 if (from_format < LYX_FORMAT) {
1354 Alert::error(_("Conversion script failed"),
1355 bformat(_("%1$s is from an older version"
1356 " of LyX and the lyx2lyx script"
1357 " failed to convert it."),
1358 from_utf8(fn.absFileName())));
1359 return LyX2LyXOlderFormat;
1361 Alert::error(_("Conversion script failed"),
1362 bformat(_("%1$s is from a newer version"
1363 " of LyX and the lyx2lyx script"
1364 " failed to convert it."),
1365 from_utf8(fn.absFileName())));
1366 return LyX2LyXNewerFormat;
1373 FileName Buffer::getBackupName() const {
1374 map<int, string> const file_formats = {
1391 FileName const & fn = fileName();
1392 string const fname = fn.onlyFileNameWithoutExt();
1393 string const fext = fn.extension() + "~";
1394 string const fpath = lyxrc.backupdir_path.empty() ?
1395 fn.onlyPath().absFileName() :
1396 lyxrc.backupdir_path;
1397 string backup_suffix;
1398 // If file format is from a stable series use version instead of file format
1399 auto const it = file_formats.find(d->file_format);
1400 if (it != file_formats.end())
1401 backup_suffix = "-lyx" + it->second;
1403 backup_suffix = "-lyxformat-" + convert<string>(d->file_format);
1404 string const backname = fname + backup_suffix;
1405 FileName backup(addName(fpath, addExtension(backname, fext)));
1407 // limit recursion, just in case
1409 unsigned long orig_checksum = 0;
1410 while (backup.exists() && v < 100) {
1411 if (orig_checksum == 0)
1412 orig_checksum = fn.checksum();
1413 unsigned long new_checksum = backup.checksum();
1414 if (orig_checksum == new_checksum) {
1415 LYXERR(Debug::FILES, "Not backing up " << fn <<
1416 "since " << backup << "has the same checksum.");
1417 // a bit of a hack, but we have to check this anyway
1418 // below, and setting this is simpler than introducing
1419 // a special boolean for this purpose.
1423 string const newbackname = backname + "-" + convert<string>(v);
1424 backup.set(addName(fpath, addExtension(newbackname, fext)));
1427 return v < 100 ? backup : FileName();
1431 // Should probably be moved to somewhere else: BufferView? GuiView?
1432 bool Buffer::save() const
1434 docstring const file = makeDisplayPath(absFileName(), 20);
1435 d->filename.refresh();
1437 // check the read-only status before moving the file as a backup
1438 if (d->filename.exists()) {
1439 bool const read_only = !d->filename.isWritable();
1441 Alert::warning(_("File is read-only"),
1442 bformat(_("The file %1$s cannot be written because it "
1443 "is marked as read-only."), file));
1448 // ask if the disk file has been externally modified (use checksum method)
1449 if (fileName().exists() && isChecksumModified()) {
1451 bformat(_("Document %1$s has been externally modified. "
1452 "Are you sure you want to overwrite this file?"), file);
1453 int const ret = Alert::prompt(_("Overwrite modified file?"),
1454 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1459 // We don't need autosaves in the immediate future. (Asger)
1460 resetAutosaveTimers();
1462 // if the file does not yet exist, none of the backup activity
1463 // that follows is necessary
1464 if (!fileName().exists()) {
1465 if (!writeFile(fileName()))
1471 // we first write the file to a new name, then move it to its
1472 // proper location once that has been done successfully. that
1473 // way we preserve the original file if something goes wrong.
1474 string const justname = fileName().onlyFileNameWithoutExt();
1475 auto tempfile = make_unique<TempFile>(fileName().onlyPath(),
1476 justname + "-XXXXXX.lyx");
1477 bool const symlink = fileName().isSymLink();
1479 tempfile->setAutoRemove(false);
1481 FileName savefile(tempfile->name());
1482 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1483 if (!savefile.clonePermissions(fileName()))
1484 LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
1486 if (!writeFile(savefile))
1489 // we will set this to false if we fail
1490 bool made_backup = true;
1492 FileName backupName;
1493 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1495 if (d->need_format_backup)
1496 backupName = getBackupName();
1498 // If we for some reason failed to find a backup name in case of
1499 // a format change, this will still set one. It's the best we can
1501 if (backupName.empty()) {
1502 backupName.set(fileName().absFileName() + "~");
1503 if (!lyxrc.backupdir_path.empty()) {
1504 string const mangledName =
1505 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1506 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1510 LYXERR(Debug::FILES, "Backing up original file to " <<
1511 backupName.absFileName());
1512 // Except file is symlink do not copy because of #6587.
1513 // Hard links have bad luck.
1514 made_backup = symlink ?
1515 fileName().copyTo(backupName):
1516 fileName().moveTo(backupName);
1519 Alert::error(_("Backup failure"),
1520 bformat(_("Cannot create backup file %1$s.\n"
1521 "Please check whether the directory exists and is writable."),
1522 from_utf8(backupName.absFileName())));
1523 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1524 } else if (d->need_format_backup) {
1525 // the original file has been backed up successfully, so we
1526 // will not need to do that again
1527 d->need_format_backup = false;
1531 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1532 // Only do this if tempfile is not in autoremove mode
1535 // If we have no symlink, we can simply rename the temp file.
1536 // Otherwise, we need to copy it so the symlink stays intact.
1537 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1538 savefile.moveTo(fileName()))
1540 // saveCheckSum() was already called by writeFile(), but the
1541 // time stamp is invalidated by copying/moving
1544 // the file associated with this buffer is now in the current format
1545 d->file_format = LYX_FORMAT;
1548 // else we saved the file, but failed to move it to the right location.
1550 if (needBackup && made_backup && !symlink) {
1551 // the original file was moved to some new location, so it will look
1552 // to the user as if it was deleted. (see bug #9234.) we could try
1553 // to restore it, but that would basically mean trying to do again
1554 // what we just failed to do. better to leave things as they are.
1555 Alert::error(_("Write failure"),
1556 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1557 "But LyX could not move it to:\n %2$s.\n"
1558 "Your original file has been backed up to:\n %3$s"),
1559 from_utf8(savefile.absFileName()),
1560 from_utf8(fileName().absFileName()),
1561 from_utf8(backupName.absFileName())));
1563 // either we did not try to make a backup, or else we tried and failed,
1564 // or else the original file was a symlink, in which case it was copied,
1565 // not moved. so the original file is intact.
1566 Alert::error(_("Write failure"),
1567 bformat(_("Cannot move saved file to:\n %1$s.\n"
1568 "But the file has successfully been saved as:\n %2$s."),
1569 from_utf8(fileName().absFileName()),
1570 from_utf8(savefile.absFileName())));
1576 bool Buffer::writeFile(FileName const & fname) const
1578 if (d->read_only && fname == d->filename)
1581 bool retval = false;
1583 docstring const str = bformat(_("Saving document %1$s..."),
1584 makeDisplayPath(fname.absFileName()));
1587 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1589 if (params().compressed) {
1590 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1591 retval = ofs && write(ofs);
1593 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1594 retval = ofs && write(ofs);
1598 message(str + _(" could not write file!"));
1603 // removeAutosaveFile();
1606 message(str + _(" done."));
1612 docstring Buffer::emergencyWrite() const
1614 // No need to save if the buffer has not changed.
1618 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1620 docstring user_message = bformat(
1621 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1623 // We try to save three places:
1624 // 1) Same place as document. Unless it is an unnamed doc.
1626 string s = absFileName();
1629 if (writeFile(FileName(s))) {
1631 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1632 return user_message;
1634 user_message += " " + _("Save failed! Trying again...\n");
1638 // 2) In HOME directory.
1639 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1641 lyxerr << ' ' << s << endl;
1642 if (writeFile(FileName(s))) {
1644 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1645 return user_message;
1648 user_message += " " + _("Save failed! Trying yet again...\n");
1650 // 3) In "/tmp" directory.
1651 // MakeAbsPath to prepend the current
1652 // drive letter on OS/2
1653 s = addName(package().temp_dir().absFileName(), absFileName());
1655 lyxerr << ' ' << s << endl;
1656 if (writeFile(FileName(s))) {
1658 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1659 return user_message;
1662 user_message += " " + _("Save failed! Document is lost.");
1665 return user_message;
1669 bool Buffer::write(ostream & ofs) const
1672 // Use the standard "C" locale for file output.
1673 ofs.imbue(locale::classic());
1676 // The top of the file should not be written by params().
1678 // write out a comment in the top of the file
1679 // Important: Keep the version formatting in sync with lyx2lyx and
1680 // tex2lyx (bug 7951)
1681 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1682 << " created this file. For more info see https://www.lyx.org/\n"
1683 << "\\lyxformat " << LYX_FORMAT << "\n"
1684 << "\\begin_document\n";
1686 /// For each author, set 'used' to true if there is a change
1687 /// by this author in the document; otherwise set it to 'false'.
1688 for (Author const & a : params().authors())
1691 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1692 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1693 for ( ; it != end; ++it)
1694 it->checkAuthors(params().authors());
1696 // now write out the buffer parameters.
1697 ofs << "\\begin_header\n";
1698 params().writeFile(ofs, this);
1699 ofs << "\\end_header\n";
1702 ofs << "\n\\begin_body\n";
1704 ofs << "\n\\end_body\n";
1706 // Write marker that shows file is complete
1707 ofs << "\\end_document" << endl;
1709 // Shouldn't really be needed....
1712 // how to check if close went ok?
1713 // Following is an attempt... (BE 20001011)
1715 // good() returns false if any error occurred, including some
1716 // formatting error.
1717 // bad() returns true if something bad happened in the buffer,
1718 // which should include file system full errors.
1723 lyxerr << "File was not closed properly." << endl;
1730 Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
1731 string const & original_path,
1732 OutputParams const & runparams_in,
1733 OutputWhat output) const
1735 OutputParams runparams = runparams_in;
1737 string const encoding = runparams.encoding->iconvName();
1738 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1741 try { ofs.reset(encoding); }
1742 catch (iconv_codecvt_facet_exception const & e) {
1743 lyxerr << "Caught iconv exception: " << e.what() << endl;
1744 Alert::error(_("Iconv software exception Detected"),
1745 bformat(_("Please verify that the `iconv' support software is"
1746 " properly installed and supports the selected encoding"
1747 " (%1$s), or change the encoding in"
1748 " Document>Settings>Language."), from_ascii(encoding)));
1751 if (!openFileWrite(ofs, fname))
1754 ErrorList & errorList = d->errorLists["Export"];
1756 ExportStatus status = ExportSuccess;
1759 // make sure we are ready to export
1760 // this needs to be done before we validate
1761 // FIXME Do we need to do this all the time? I.e., in children
1762 // of a master we are exporting?
1764 updateMacroInstances(OutputUpdate);
1766 ExportStatus retval;
1768 retval = writeLaTeXSource(os, original_path, runparams, output);
1769 if (retval == ExportKilled)
1770 return ExportKilled;
1772 catch (EncodingException const & e) {
1773 docstring const failed(1, e.failed_char);
1775 oss << "0x" << hex << e.failed_char << dec;
1776 if (getParFromID(e.par_id).paragraph().layout().pass_thru) {
1777 docstring msg = bformat(_("Uncodable character '%1$s'"
1778 " (code point %2$s)"),
1779 failed, from_utf8(oss.str()));
1780 errorList.push_back(ErrorItem(msg, _("Some characters of your document are not "
1781 "representable in specific verbatim contexts.\n"
1782 "Changing the document encoding to utf8 could help."),
1783 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1785 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1786 " (code point %2$s)"),
1787 failed, from_utf8(oss.str()));
1788 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1789 "representable in the chosen encoding.\n"
1790 "Changing the document encoding to utf8 could help."),
1791 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1793 status = ExportError;
1795 catch (iconv_codecvt_facet_exception const & e) {
1796 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1798 status = ExportError;
1800 catch (exception const & e) {
1801 errorList.push_back(ErrorItem(_("conversion failed"),
1803 lyxerr << e.what() << endl;
1804 status = ExportError;
1807 lyxerr << "Caught some really weird exception..." << endl;
1811 d->texrow = move(os.texrow());
1815 status = ExportError;
1816 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1819 if (runparams_in.silent)
1827 Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
1828 string const & original_path,
1829 OutputParams const & runparams_in,
1830 OutputWhat output) const
1832 // The child documents, if any, shall be already loaded at this point.
1834 OutputParams runparams = runparams_in;
1836 // Some macros rely on font encoding
1837 runparams.main_fontenc = params().main_font_encoding();
1839 // If we are compiling a file standalone, even if this is the
1840 // child of some other buffer, let's cut the link here, so the
1841 // file is really independent and no concurring settings from
1842 // the master (e.g. branch state) interfere (see #8100).
1843 if (!runparams.is_child)
1844 d->ignore_parent = true;
1846 // Classify the unicode characters appearing in math insets
1847 BufferEncodings::initUnicodeMath(*this);
1849 // validate the buffer.
1850 LYXERR(Debug::LATEX, " Validating buffer...");
1851 LaTeXFeatures features(*this, params(), runparams);
1853 // This is only set once per document (in master)
1854 if (!runparams.is_child) {
1855 runparams.use_polyglossia = features.usePolyglossia();
1856 runparams.use_hyperref = features.isRequired("hyperref");
1857 runparams.use_CJK = features.mustProvide("CJK");
1859 LYXERR(Debug::LATEX, " Buffer validation done.");
1861 bool const output_preamble =
1862 output == FullSource || output == OnlyPreamble;
1863 bool const output_body =
1864 output == FullSource || output == OnlyBody;
1866 // The starting paragraph of the coming rows is the
1867 // first paragraph of the document. (Asger)
1868 if (output_preamble && runparams.nice) {
1869 os << "%% LyX " << lyx_version << " created this file. "
1870 "For more info, see https://www.lyx.org/.\n"
1871 "%% Do not edit unless you really know what "
1874 LYXERR(Debug::INFO, "lyx document header finished");
1876 // There are a few differences between nice LaTeX and usual files:
1877 // usual files have \batchmode and special input@path to allow
1878 // inclusion of figures specified by an explicitly relative path
1879 // (i.e., a path starting with './' or '../') with either \input or
1880 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1881 // input@path is set when the actual parameter original_path is set.
1882 // This is done for usual tex-file, but not for nice-latex-file.
1883 // (Matthias 250696)
1884 // Note that input@path is only needed for something the user does
1885 // in the preamble, included .tex files or ERT, files included by
1886 // LyX work without it.
1887 if (output_preamble) {
1888 if (!runparams.nice) {
1889 // code for usual, NOT nice-latex-file
1890 os << "\\batchmode\n"; // changed from \nonstopmode
1892 if (!original_path.empty()) {
1894 // We don't know the encoding of inputpath
1895 docstring const inputpath = from_utf8(original_path);
1896 docstring uncodable_glyphs;
1897 Encoding const * const enc = runparams.encoding;
1899 for (char_type n : inputpath) {
1900 if (!enc->encodable(n)) {
1901 docstring const glyph(1, n);
1902 LYXERR0("Uncodable character '"
1904 << "' in input path!");
1905 uncodable_glyphs += glyph;
1910 // warn user if we found uncodable glyphs.
1911 if (!uncodable_glyphs.empty()) {
1912 frontend::Alert::warning(
1913 _("Uncodable character in file path"),
1915 _("The path of your document\n"
1917 "contains glyphs that are unknown "
1918 "in the current document encoding "
1919 "(namely %2$s). This may result in "
1920 "incomplete output, unless "
1921 "TEXINPUTS contains the document "
1922 "directory and you don't use "
1923 "explicitly relative paths (i.e., "
1924 "paths starting with './' or "
1925 "'../') in the preamble or in ERT."
1926 "\n\nIn case of problems, choose "
1927 "an appropriate document encoding\n"
1928 "(such as utf8) or change the "
1930 inputpath, uncodable_glyphs));
1932 string docdir = os::latex_path(original_path);
1933 if (contains(docdir, '#')) {
1934 docdir = subst(docdir, "#", "\\#");
1935 os << "\\catcode`\\#=11"
1936 "\\def\\#{#}\\catcode`\\#=6\n";
1938 if (contains(docdir, '%')) {
1939 docdir = subst(docdir, "%", "\\%");
1940 os << "\\catcode`\\%=11"
1941 "\\def\\%{%}\\catcode`\\%=14\n";
1943 if (contains(docdir, '~'))
1944 docdir = subst(docdir, "~", "\\string~");
1945 bool const nonascii = !isAscii(from_utf8(docdir));
1946 // LaTeX 2019/10/01 handles non-ascii path without detokenize
1947 bool const utfpathlatex = features.isAvailable("LaTeX-2019/10/01");
1948 bool const detokenize = !utfpathlatex && nonascii;
1949 bool const quote = contains(docdir, ' ');
1950 if (utfpathlatex && nonascii)
1951 os << "\\UseRawInputEncoding\n";
1952 os << "\\makeatletter\n"
1953 << "\\def\\input@path{{";
1955 os << "\\detokenize{";
1964 << "\\makeatother\n";
1968 // get parent macros (if this buffer has a parent) which will be
1969 // written at the document begin further down.
1970 MacroSet parentMacros;
1971 listParentMacros(parentMacros, features);
1973 // Write the preamble
1974 runparams.use_babel = params().writeLaTeX(os, features,
1975 d->filename.onlyPath());
1977 // Active characters
1978 runparams.active_chars = features.getActiveChars();
1980 // Biblatex bibliographies are loaded here
1981 if (params().useBiblatex()) {
1982 vector<pair<docstring, string>> const bibfiles =
1983 prepareBibFilePaths(runparams, getBibfiles(), true);
1984 for (pair<docstring, string> const & file: bibfiles) {
1985 os << "\\addbibresource";
1986 if (!file.second.empty())
1987 os << "[bibencoding=" << file.second << "]";
1988 os << "{" << file.first << "}\n";
1992 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1993 && !features.hasOnlyPolyglossiaLanguages()) {
1996 vector<string> bll = features.getBabelExclusiveLanguages();
1997 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
2000 for (string const & sit : bll) {
2005 blangs = bll.size() > 1 ?
2006 bformat(_("The languages %1$s are only supported by Babel."), langs)
2007 : bformat(_("The language %1$s is only supported by Babel."), langs);
2011 for (string const & pit : pll) {
2016 plangs = pll.size() > 1 ?
2017 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
2018 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
2019 if (!blangs.empty())
2023 frontend::Alert::warning(
2024 _("Incompatible Languages!"),
2026 _("You cannot use the following languages "
2027 "together in one LaTeX document because "
2028 "they require conflicting language packages:\n"
2033 // Japanese might be required only in some children of a document,
2034 // but once required, we must keep use_japanese true.
2035 runparams.use_japanese |= features.isRequired("japanese");
2038 // Restore the parenthood if needed
2039 if (!runparams.is_child)
2040 d->ignore_parent = false;
2041 return ExportSuccess;
2045 // mark the beginning of the body to separate it from InPreamble insets
2046 os.texrow().start(TexRow::beginDocument());
2047 os << "\\begin{document}\n";
2049 // mark the start of a new paragraph by simulating a newline,
2050 // so that os.afterParbreak() returns true at document start
2053 // output the parent macros
2054 for (auto const & mac : parentMacros) {
2055 int num_lines = mac->write(os.os(), true);
2056 os.texrow().newlines(num_lines);
2059 } // output_preamble
2061 LYXERR(Debug::INFO, "preamble finished, now the body.");
2065 latexParagraphs(*this, text(), os, runparams);
2067 catch (ConversionException const &) { return ExportKilled; }
2069 // Restore the parenthood if needed
2070 if (!runparams.is_child)
2071 d->ignore_parent = false;
2073 // add this just in case after all the paragraphs
2076 if (output_preamble) {
2077 os << "\\end{document}\n";
2078 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
2080 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
2082 runparams_in.encoding = runparams.encoding;
2084 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2085 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2086 return ExportSuccess;
2090 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2091 OutputParams const & runparams,
2092 OutputWhat output) const
2094 LYXERR(Debug::LATEX, "makeDocBookFile...");
2097 if (!openFileWrite(ofs, fname))
2100 // make sure we are ready to export
2101 // this needs to be done before we validate
2103 updateMacroInstances(OutputUpdate);
2105 ExportStatus const retval =
2106 writeDocBookSource(ofs, runparams, output);
2107 if (retval == ExportKilled)
2108 return ExportKilled;
2112 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2113 return ExportSuccess;
2117 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os,
2118 OutputParams const & runparams,
2119 OutputWhat output) const
2121 LaTeXFeatures features(*this, params(), runparams);
2123 d->bibinfo_.makeCitationLabels(*this);
2127 DocumentClass const & tclass = params().documentClass();
2129 bool const output_preamble =
2130 output == FullSource || output == OnlyPreamble;
2131 bool const output_body =
2132 output == FullSource || output == OnlyBody || output == IncludedFile;
2134 if (output_preamble) {
2135 // XML preamble, no doctype needed.
2136 // Not using XMLStream for this, as the root tag would be in the tag stack and make troubles with the error
2137 // detection mechanisms (these are called before the end tag is output, and thus interact with the canary
2138 // parsep in output_docbook.cpp).
2139 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2140 << "<!-- This DocBook file was created by LyX " << lyx_version
2141 << "\n See http://www.lyx.org/ for more information -->\n";
2143 // Directly output the root tag, based on the current type of document.
2144 string languageCode = params().language->code();
2145 string params = "xml:lang=\"" + languageCode + '"'
2146 + " xmlns=\"http://docbook.org/ns/docbook\""
2147 + " xmlns:xlink=\"http://www.w3.org/1999/xlink\""
2148 + " xmlns:m=\"http://www.w3.org/1998/Math/MathML\""
2149 + " xmlns:xi=\"http://www.w3.org/2001/XInclude\""
2150 + " version=\"5.2\"";
2152 os << "<" << from_ascii(tclass.docbookroot()) << " " << from_ascii(params) << ">\n";
2156 // Start to output the document.
2158 docbookParagraphs(text(), *this, xs, runparams);
2161 if (output_preamble) {
2162 // Close the root element. No need for a line break, as free text is never allowed
2163 // in a root element, it must always be wrapped in some container.
2164 os << "</" << from_ascii(tclass.docbookroot()) << ">";
2167 return ExportSuccess;
2171 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2172 OutputParams const & runparams) const
2174 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2177 if (!openFileWrite(ofs, fname))
2180 // make sure we are ready to export
2181 // this has to be done before we validate
2182 updateBuffer(UpdateMaster, OutputUpdate);
2183 updateMacroInstances(OutputUpdate);
2185 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2186 if (retval == ExportKilled)
2191 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2196 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2197 OutputParams const & runparams,
2198 OutputWhat output) const
2200 LaTeXFeatures features(*this, params(), runparams);
2202 d->bibinfo_.makeCitationLabels(*this);
2204 bool const output_preamble =
2205 output == FullSource || output == OnlyPreamble;
2206 bool const output_body =
2207 output == FullSource || output == OnlyBody || output == IncludedFile;
2209 if (output_preamble) {
2210 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2211 << "<!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"
2212 // FIXME Language should be set properly.
2213 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2215 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2216 // FIXME Presumably need to set this right
2217 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2219 docstring const & doctitle = features.htmlTitle();
2221 << (doctitle.empty() ?
2222 from_ascii("LyX Document") :
2223 xml::escapeString(doctitle, XMLStream::ESCAPE_ALL))
2226 docstring styles = features.getTClassHTMLPreamble();
2227 if (!styles.empty())
2228 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2230 // we will collect CSS information in a stream, and then output it
2231 // either here, as part of the header, or else in a separate file.
2232 odocstringstream css;
2233 styles = features.getCSSSnippets();
2234 if (!styles.empty())
2235 css << "/* LyX Provided Styles */\n" << styles << '\n';
2237 styles = features.getTClassHTMLStyles();
2238 if (!styles.empty())
2239 css << "/* Layout-provided Styles */\n" << styles << '\n';
2241 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2242 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2243 if (needfg || needbg) {
2244 css << "\nbody {\n";
2247 << from_ascii(X11hexname(params().fontcolor))
2250 css << " background-color: "
2251 << from_ascii(X11hexname(params().backgroundcolor))
2256 docstring const dstyles = css.str();
2257 if (!dstyles.empty()) {
2258 bool written = false;
2259 if (params().html_css_as_file) {
2260 // open a file for CSS info
2262 string const fcssname = addName(temppath(), "docstyle.css");
2263 FileName const fcssfile = FileName(fcssname);
2264 if (openFileWrite(ocss, fcssfile)) {
2268 // write link to header
2269 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2271 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2274 // we are here if the CSS is supposed to be written to the header
2275 // or if we failed to write it to an external file.
2277 os << "<style type='text/css'>\n"
2286 bool const output_body_tag = (output != IncludedFile);
2287 if (output_body_tag)
2288 os << "<body dir=\"auto\">\n";
2290 if (output != IncludedFile)
2291 // if we're an included file, the counters are in the master.
2292 params().documentClass().counters().reset();
2294 xhtmlParagraphs(text(), *this, xs, runparams);
2296 catch (ConversionException const &) { return ExportKilled; }
2297 if (output_body_tag)
2301 if (output_preamble)
2304 return ExportSuccess;
2308 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2309 // Other flags: -wall -v0 -x
2310 int Buffer::runChktex()
2314 // get LaTeX-Filename
2315 FileName const path(temppath());
2316 string const name = addName(path.absFileName(), latexName());
2317 string const org_path = filePath();
2319 PathChanger p(path); // path to LaTeX file
2320 message(_("Running chktex..."));
2322 // Generate the LaTeX file if neccessary
2323 OutputParams runparams(¶ms().encoding());
2324 runparams.flavor = OutputParams::LATEX;
2325 runparams.nice = false;
2326 runparams.linelen = lyxrc.plaintext_linelen;
2327 ExportStatus const retval =
2328 makeLaTeXFile(FileName(name), org_path, runparams);
2329 if (retval != ExportSuccess) {
2330 // error code on failure
2335 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2336 int const res = chktex.run(terr); // run chktex
2339 Alert::error(_("chktex failure"),
2340 _("Could not run chktex successfully."));
2342 ErrorList & errlist = d->errorLists["ChkTeX"];
2344 bufferErrors(terr, errlist);
2349 if (runparams.silent)
2350 d->errorLists["ChkTeX"].clear();
2358 void Buffer::validate(LaTeXFeatures & features) const
2360 // Validate the buffer params, but not for included
2361 // files, since they also use the parent buffer's
2363 if (!features.runparams().is_child)
2364 params().validate(features);
2369 for (Paragraph const & p : paragraphs())
2370 p.validate(features);
2372 if (lyxerr.debugging(Debug::LATEX)) {
2373 features.showStruct();
2378 void Buffer::getLabelList(vector<docstring> & list) const
2380 // If this is a child document, use the master's list instead.
2382 masterBuffer()->getLabelList(list);
2387 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2388 for (auto const & tocit : *toc) {
2389 if (tocit.depth() == 0)
2390 list.push_back(tocit.str());
2395 void Buffer::invalidateBibinfoCache() const
2397 d->bibinfo_cache_valid_ = false;
2398 d->cite_labels_valid_ = false;
2399 removeBiblioTempFiles();
2400 // also invalidate the cache for the parent buffer
2401 Buffer const * const pbuf = d->parent();
2403 pbuf->invalidateBibinfoCache();
2407 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2409 // FIXME This is probably unnecessary, given where we call this.
2410 // If this is a child document, use the master instead.
2411 Buffer const * const pbuf = masterBuffer();
2412 if (pbuf != this && scope != UpdateChildOnly)
2413 return pbuf->getBibfiles();
2415 // In 2.3.x, we have:
2416 //if (!d->bibfile_cache_valid_)
2417 // this->updateBibfilesCache(scope);
2418 // I think that is a leftover, but there have been so many back-
2419 // and-forths with this, due to Windows issues, that I am not sure.
2421 return d->bibfiles_cache_;
2425 BiblioInfo const & Buffer::masterBibInfo() const
2427 Buffer const * const tmp = masterBuffer();
2429 return tmp->masterBibInfo();
2434 BiblioInfo const & Buffer::bibInfo() const
2440 void Buffer::registerBibfiles(const docstring_list & bf) const
2442 // We register the bib files in the master buffer,
2443 // if there is one, but also in every single buffer,
2444 // in case a child is compiled alone.
2445 Buffer const * const tmp = masterBuffer();
2447 tmp->registerBibfiles(bf);
2449 for (auto const & p : bf) {
2450 docstring_list::const_iterator temp =
2451 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2452 if (temp == d->bibfiles_cache_.end())
2453 d->bibfiles_cache_.push_back(p);
2458 static map<docstring, FileName> bibfileCache;
2460 FileName Buffer::getBibfilePath(docstring const & bibid) const
2462 map<docstring, FileName>::const_iterator it =
2463 bibfileCache.find(bibid);
2464 if (it != bibfileCache.end()) {
2465 // i.e., return bibfileCache[bibid];
2469 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2470 string const texfile = changeExtension(to_utf8(bibid), "bib");
2471 // we need to check first if this file exists where it's said to be.
2472 // there's a weird bug that occurs otherwise: if the file is in the
2473 // Buffer's directory but has the same name as some file that would be
2474 // found by kpsewhich, then we find the latter, not the former.
2475 FileName const local_file = makeAbsPath(texfile, filePath());
2476 FileName file = local_file;
2477 if (!file.exists()) {
2478 // there's no need now to check whether the file can be found
2480 file = findtexfile(texfile, "bib", true);
2484 LYXERR(Debug::FILES, "Found at: " << file);
2486 bibfileCache[bibid] = file;
2487 return bibfileCache[bibid];
2491 void Buffer::checkIfBibInfoCacheIsValid() const
2493 // use the master's cache
2494 Buffer const * const tmp = masterBuffer();
2496 tmp->checkIfBibInfoCacheIsValid();
2500 // If we already know the cache is invalid, stop here.
2501 // This is important in the case when the bibliography
2502 // environment (rather than Bib[la]TeX) is used.
2503 // In that case, the timestamp check below gives no
2504 // sensible result. Rather than that, the cache will
2505 // be invalidated explicitly via invalidateBibInfoCache()
2506 // by the Bibitem inset.
2507 // Same applies for bib encoding changes, which trigger
2508 // invalidateBibInfoCache() by InsetBibtex.
2509 if (!d->bibinfo_cache_valid_)
2512 if (d->have_bibitems_) {
2513 // We have a bibliography environment.
2514 // Invalidate the bibinfo cache unconditionally.
2515 // Cite labels will get invalidated by the inset if needed.
2516 d->bibinfo_cache_valid_ = false;
2520 // OK. This is with Bib(la)tex. We'll assume the cache
2521 // is valid and change this if we find changes in the bibs.
2522 d->bibinfo_cache_valid_ = true;
2523 d->cite_labels_valid_ = true;
2525 // compare the cached timestamps with the actual ones.
2526 docstring_list const & bibfiles_cache = getBibfiles();
2527 for (auto const & bf : bibfiles_cache) {
2528 FileName const fn = getBibfilePath(bf);
2529 time_t lastw = fn.lastModified();
2530 time_t prevw = d->bibfile_status_[fn];
2531 if (lastw != prevw) {
2532 d->bibinfo_cache_valid_ = false;
2533 d->cite_labels_valid_ = false;
2534 d->bibfile_status_[fn] = lastw;
2540 void Buffer::clearBibFileCache() const
2542 bibfileCache.clear();
2546 void Buffer::reloadBibInfoCache(bool const force) const
2548 // we should not need to do this for internal buffers
2552 // use the master's cache
2553 Buffer const * const tmp = masterBuffer();
2555 tmp->reloadBibInfoCache(force);
2560 checkIfBibInfoCacheIsValid();
2561 if (d->bibinfo_cache_valid_)
2565 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2566 // re-read file locations when this info changes
2567 // FIXME Is this sufficient? Or should we also force that
2568 // in some other cases? If so, then it is easy enough to
2569 // add the following line in some other places.
2570 clearBibFileCache();
2571 d->bibinfo_.clear();
2572 FileNameList checkedFiles;
2573 d->have_bibitems_ = false;
2574 collectBibKeys(checkedFiles);
2575 d->bibinfo_cache_valid_ = true;
2579 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2584 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2585 it->collectBibKeys(it, checkedFiles);
2586 if (it->lyxCode() == BIBITEM_CODE) {
2587 if (parent() != nullptr)
2588 parent()->d->have_bibitems_ = true;
2590 d->have_bibitems_ = true;
2596 void Buffer::addBiblioInfo(BiblioInfo const & bin) const
2598 // We add the biblio info to the master buffer,
2599 // if there is one, but also to every single buffer,
2600 // in case a child is compiled alone.
2601 BiblioInfo & bi = d->bibinfo_;
2602 bi.mergeBiblioInfo(bin);
2604 if (parent() != nullptr) {
2605 BiblioInfo & masterbi = parent()->d->bibinfo_;
2606 masterbi.mergeBiblioInfo(bin);
2611 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2613 // We add the bibtex info to the master buffer,
2614 // if there is one, but also to every single buffer,
2615 // in case a child is compiled alone.
2616 BiblioInfo & bi = d->bibinfo_;
2619 if (parent() != nullptr) {
2620 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2621 masterbi[key] = bin;
2626 void Buffer::makeCitationLabels() const
2628 Buffer const * const master = masterBuffer();
2629 return d->bibinfo_.makeCitationLabels(*master);
2633 void Buffer::invalidateCiteLabels() const
2635 masterBuffer()->d->cite_labels_valid_ = false;
2638 bool Buffer::citeLabelsValid() const
2640 return masterBuffer()->d->cite_labels_valid_;
2644 void Buffer::removeBiblioTempFiles() const
2646 // We remove files that contain LaTeX commands specific to the
2647 // particular bibliographic style being used, in order to avoid
2648 // LaTeX errors when we switch style.
2649 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2650 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2651 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2652 aux_file.removeFile();
2653 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2654 bbl_file.removeFile();
2655 // Also for the parent buffer
2656 Buffer const * const pbuf = parent();
2658 pbuf->removeBiblioTempFiles();
2662 bool Buffer::isDepClean(string const & name) const
2664 DepClean::const_iterator const it = d->dep_clean.find(name);
2665 if (it == d->dep_clean.end())
2671 void Buffer::markDepClean(string const & name)
2673 d->dep_clean[name] = true;
2677 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2680 // FIXME? if there is an Buffer LFUN that can be dispatched even
2681 // if internal, put a switch '(cmd.action)' here.
2687 switch (cmd.action()) {
2689 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2690 flag.setOnOff(hasReadonlyFlag());
2693 // FIXME: There is need for a command-line import.
2694 //case LFUN_BUFFER_IMPORT:
2696 case LFUN_BUFFER_AUTO_SAVE:
2699 case LFUN_BUFFER_EXPORT_CUSTOM:
2700 // FIXME: Nothing to check here?
2703 case LFUN_BUFFER_EXPORT: {
2704 docstring const & arg = cmd.argument();
2705 if (arg == "custom") {
2709 string format = (arg.empty() || arg == "default") ?
2710 params().getDefaultOutputFormat() : to_utf8(arg);
2711 size_t pos = format.find(' ');
2712 if (pos != string::npos)
2713 format = format.substr(0, pos);
2714 enable = params().isExportable(format, false);
2716 flag.message(bformat(
2717 _("Don't know how to export to format: %1$s"), arg));
2721 case LFUN_BUILD_PROGRAM:
2722 enable = params().isExportable("program", false);
2725 case LFUN_BRANCH_ACTIVATE:
2726 case LFUN_BRANCH_DEACTIVATE:
2727 case LFUN_BRANCH_MASTER_ACTIVATE:
2728 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2729 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2730 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2731 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2732 : params().branchlist();
2733 docstring const & branchName = cmd.argument();
2734 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2738 case LFUN_BRANCH_ADD:
2739 case LFUN_BRANCHES_RENAME:
2740 // if no Buffer is present, then of course we won't be called!
2743 case LFUN_BUFFER_LANGUAGE:
2744 enable = !isReadonly();
2747 case LFUN_BUFFER_VIEW_CACHE:
2748 (d->preview_file_).refresh();
2749 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2752 case LFUN_CHANGES_TRACK:
2753 flag.setEnabled(true);
2754 flag.setOnOff(params().track_changes);
2757 case LFUN_CHANGES_OUTPUT:
2758 flag.setEnabled(true);
2759 flag.setOnOff(params().output_changes);
2762 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2763 flag.setOnOff(params().compressed);
2766 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2767 flag.setOnOff(params().output_sync);
2770 case LFUN_BUFFER_ANONYMIZE:
2776 flag.setEnabled(enable);
2781 void Buffer::dispatch(string const & command, DispatchResult & result)
2783 return dispatch(lyxaction.lookupFunc(command), result);
2787 // NOTE We can end up here even if we have no GUI, because we are called
2788 // by LyX::exec to handled command-line requests. So we may need to check
2789 // whether we have a GUI or not. The boolean use_gui holds this information.
2790 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2793 // FIXME? if there is an Buffer LFUN that can be dispatched even
2794 // if internal, put a switch '(cmd.action())' here.
2795 dr.dispatched(false);
2798 string const argument = to_utf8(func.argument());
2799 // We'll set this back to false if need be.
2800 bool dispatched = true;
2801 // This handles undo groups automagically
2802 UndoGroupHelper ugh(this);
2804 switch (func.action()) {
2805 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2806 if (lyxvc().inUse()) {
2807 string log = lyxvc().toggleReadOnly();
2812 setReadonly(!hasReadonlyFlag());
2815 case LFUN_BUFFER_EXPORT: {
2816 string const format = (argument.empty() || argument == "default") ?
2817 params().getDefaultOutputFormat() : argument;
2818 ExportStatus const status = doExport(format, false);
2819 dr.setError(status != ExportSuccess);
2820 if (status != ExportSuccess)
2821 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2822 from_utf8(format)));
2826 case LFUN_BUILD_PROGRAM: {
2827 ExportStatus const status = doExport("program", true);
2828 dr.setError(status != ExportSuccess);
2829 if (status != ExportSuccess)
2830 dr.setMessage(_("Error generating literate programming code."));
2834 case LFUN_BUFFER_EXPORT_CUSTOM: {
2836 string command = split(argument, format_name, ' ');
2837 Format const * format = theFormats().getFormat(format_name);
2839 lyxerr << "Format \"" << format_name
2840 << "\" not recognized!"
2845 // The name of the file created by the conversion process
2848 // Output to filename
2849 if (format->name() == "lyx") {
2850 string const latexname = latexName(false);
2851 filename = changeExtension(latexname,
2852 format->extension());
2853 filename = addName(temppath(), filename);
2855 if (!writeFile(FileName(filename)))
2859 doExport(format_name, true, filename);
2862 // Substitute $$FName for filename
2863 if (!contains(command, "$$FName"))
2864 command = "( " + command + " ) < $$FName";
2865 command = subst(command, "$$FName", filename);
2867 // Execute the command in the background
2869 call.startscript(Systemcall::DontWait, command,
2870 filePath(), layoutPos());
2874 // FIXME: There is need for a command-line import.
2876 case LFUN_BUFFER_IMPORT:
2881 case LFUN_BUFFER_AUTO_SAVE:
2883 resetAutosaveTimers();
2886 case LFUN_BRANCH_ACTIVATE:
2887 case LFUN_BRANCH_DEACTIVATE:
2888 case LFUN_BRANCH_MASTER_ACTIVATE:
2889 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2890 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2891 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2892 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2895 docstring const & branch_name = func.argument();
2896 // the case without a branch name is handled elsewhere
2897 if (branch_name.empty()) {
2901 Branch * branch = buf->params().branchlist().find(branch_name);
2903 LYXERR0("Branch " << branch_name << " does not exist.");
2905 docstring const msg =
2906 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2910 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2911 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2912 if (branch->isSelected() != activate) {
2913 buf->undo().recordUndoBufferParams(CursorData());
2914 branch->setSelected(activate);
2916 dr.screenUpdate(Update::Force);
2917 dr.forceBufferUpdate();
2922 case LFUN_BRANCH_ADD: {
2923 docstring const & branchnames = func.argument();
2924 if (branchnames.empty()) {
2928 BranchList & branch_list = params().branchlist();
2929 vector<docstring> const branches =
2930 getVectorFromString(branchnames, branch_list.separator());
2932 for (docstring const & branch_name : branches) {
2933 Branch * branch = branch_list.find(branch_name);
2935 LYXERR0("Branch " << branch_name << " already exists.");
2939 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2941 undo().recordUndoBufferParams(CursorData());
2942 branch_list.add(branch_name);
2943 branch = branch_list.find(branch_name);
2944 string const x11hexname = X11hexname(branch->color());
2945 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2946 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2948 dr.screenUpdate(Update::Force);
2956 case LFUN_BRANCHES_RENAME: {
2957 if (func.argument().empty())
2960 docstring const oldname = from_utf8(func.getArg(0));
2961 docstring const newname = from_utf8(func.getArg(1));
2962 InsetIterator it = inset_iterator_begin(inset());
2963 InsetIterator const end = inset_iterator_end(inset());
2964 bool success = false;
2965 for (; it != end; ++it) {
2966 if (it->lyxCode() == BRANCH_CODE) {
2967 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2968 if (ins.branch() == oldname) {
2969 undo().recordUndo(CursorData(it));
2970 ins.rename(newname);
2975 if (it->lyxCode() == INCLUDE_CODE) {
2976 // get buffer of external file
2977 InsetInclude const & ins =
2978 static_cast<InsetInclude const &>(*it);
2979 Buffer * child = ins.loadIfNeeded();
2982 child->dispatch(func, dr);
2987 dr.screenUpdate(Update::Force);
2988 dr.forceBufferUpdate();
2993 case LFUN_BUFFER_VIEW_CACHE:
2994 if (!theFormats().view(*this, d->preview_file_,
2995 d->preview_format_))
2996 dr.setMessage(_("Error viewing the output file."));
2999 case LFUN_CHANGES_TRACK:
3000 if (params().save_transient_properties)
3001 undo().recordUndoBufferParams(CursorData());
3002 params().track_changes = !params().track_changes;
3005 case LFUN_CHANGES_OUTPUT:
3006 if (params().save_transient_properties)
3007 undo().recordUndoBufferParams(CursorData());
3008 params().output_changes = !params().output_changes;
3009 if (params().output_changes) {
3010 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3011 LaTeXFeatures::isAvailable("xcolor");
3014 Alert::warning(_("Changes not shown in LaTeX output"),
3015 _("Changes will not be highlighted in LaTeX output, "
3016 "because xcolor and ulem are not installed.\n"
3017 "Please install both packages or redefine "
3018 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3023 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3024 // turn compression on/off
3025 undo().recordUndoBufferParams(CursorData());
3026 params().compressed = !params().compressed;
3029 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3030 undo().recordUndoBufferParams(CursorData());
3031 params().output_sync = !params().output_sync;
3034 case LFUN_BUFFER_ANONYMIZE: {
3035 undo().recordUndoFullBuffer(CursorData());
3036 CursorData cur(doc_iterator_begin(this));
3037 for ( ; cur ; cur.forwardPar())
3038 cur.paragraph().anonymize();
3039 dr.forceBufferUpdate();
3040 dr.screenUpdate(Update::Force);
3048 dr.dispatched(dispatched);
3052 void Buffer::changeLanguage(Language const * from, Language const * to)
3054 LASSERT(from, return);
3055 LASSERT(to, return);
3057 ParIterator it = par_iterator_begin();
3058 ParIterator eit = par_iterator_end();
3059 for (; it != eit; ++it)
3060 it->changeLanguage(params(), from, to);
3064 bool Buffer::isMultiLingual() const
3066 ParConstIterator end = par_iterator_end();
3067 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3068 if (it->isMultiLingual(params()))
3075 std::set<Language const *> Buffer::getLanguages() const
3077 std::set<Language const *> langs;
3078 getLanguages(langs);
3083 void Buffer::getLanguages(std::set<Language const *> & langs) const
3085 ParConstIterator end = par_iterator_end();
3086 // add the buffer language, even if it's not actively used
3087 langs.insert(language());
3088 // iterate over the paragraphs
3089 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3090 it->getLanguages(langs);
3092 ListOfBuffers clist = getDescendants();
3093 for (auto const & cit : clist)
3094 cit->getLanguages(langs);
3098 DocIterator Buffer::getParFromID(int const id) const
3100 Buffer * buf = const_cast<Buffer *>(this);
3102 // This means non-existent
3103 return doc_iterator_end(buf);
3105 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3106 if (it.paragraph().id() == id)
3109 return doc_iterator_end(buf);
3113 bool Buffer::hasParWithID(int const id) const
3115 return !getParFromID(id).atEnd();
3119 ParIterator Buffer::par_iterator_begin()
3121 return ParIterator(doc_iterator_begin(this));
3125 ParIterator Buffer::par_iterator_end()
3127 return ParIterator(doc_iterator_end(this));
3131 ParConstIterator Buffer::par_iterator_begin() const
3133 return ParConstIterator(doc_iterator_begin(this));
3137 ParConstIterator Buffer::par_iterator_end() const
3139 return ParConstIterator(doc_iterator_end(this));
3143 Language const * Buffer::language() const
3145 return params().language;
3149 docstring Buffer::B_(string const & l10n) const
3151 return params().B_(l10n);
3155 bool Buffer::isClean() const
3157 return d->lyx_clean;
3161 bool Buffer::isChecksumModified() const
3163 LASSERT(d->filename.exists(), return false);
3164 return d->checksum_ != d->filename.checksum();
3168 void Buffer::saveCheckSum() const
3170 FileName const & file = d->filename;
3172 d->checksum_ = file.exists() ? file.checksum()
3173 : 0; // in the case of save to a new file.
3177 void Buffer::markClean() const
3179 if (!d->lyx_clean) {
3180 d->lyx_clean = true;
3183 // if the .lyx file has been saved, we don't need an
3185 d->bak_clean = true;
3186 d->undo_.markDirty();
3187 clearExternalModification();
3191 void Buffer::setUnnamed(bool flag)
3197 bool Buffer::isUnnamed() const
3204 /// Don't check unnamed, here: isInternal() is used in
3205 /// newBuffer(), where the unnamed flag has not been set by anyone
3206 /// yet. Also, for an internal buffer, there should be no need for
3207 /// retrieving fileName() nor for checking if it is unnamed or not.
3208 bool Buffer::isInternal() const
3210 return d->internal_buffer;
3214 void Buffer::setInternal(bool flag)
3216 d->internal_buffer = flag;
3220 void Buffer::markDirty()
3223 d->lyx_clean = false;
3226 d->bak_clean = false;
3228 for (auto & depit : d->dep_clean)
3229 depit.second = false;
3233 FileName Buffer::fileName() const
3239 string Buffer::absFileName() const
3241 return d->filename.absFileName();
3245 string Buffer::filePath() const
3247 string const abs = d->filename.onlyPath().absFileName();
3250 int last = abs.length() - 1;
3252 return abs[last] == '/' ? abs : abs + '/';
3256 DocFileName Buffer::getReferencedFileName(string const & fn) const
3259 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3260 result.set(fn, filePath());
3262 // filePath() ends with a path separator
3263 FileName const test(filePath() + fn);
3265 result.set(fn, filePath());
3267 result.set(fn, params().origin);
3274 string const Buffer::prepareFileNameForLaTeX(string const & name,
3275 string const & ext, bool nice) const
3277 string const fname = makeAbsPath(name, filePath()).absFileName();
3278 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3284 return to_utf8(makeRelPath(from_utf8(fname),
3285 from_utf8(masterBuffer()->filePath())));
3289 vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3290 docstring_list const & bibfilelist,
3291 bool const add_extension) const
3293 // If we are processing the LaTeX file in a temp directory then
3294 // copy the .bib databases to this temp directory, mangling their
3295 // names in the process. Store this mangled name in the list of
3297 // (We need to do all this because BibTeX *really*, *really*
3298 // can't handle "files with spaces" and Windows users tend to
3299 // use such filenames.)
3300 // Otherwise, store the (maybe absolute) path to the original,
3301 // unmangled database name.
3303 vector<pair<docstring, string>> res;
3305 // determine the export format
3306 string const tex_format = flavor2format(runparams.flavor);
3308 // check for spaces in paths
3309 bool found_space = false;
3311 for (auto const & bit : bibfilelist) {
3312 string utf8input = to_utf8(bit);
3314 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3315 FileName try_in_file =
3316 makeAbsPath(database + ".bib", filePath());
3317 bool not_from_texmf = try_in_file.isReadableFile();
3318 // If the file has not been found, try with the real file name
3319 // (it might come from a child in a sub-directory)
3320 if (!not_from_texmf) {
3321 try_in_file = getBibfilePath(bit);
3322 if (try_in_file.isReadableFile()) {
3323 // Check if the file is in texmf
3324 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3325 not_from_texmf = kpsefile.empty()
3326 || kpsefile.absFileName() != try_in_file.absFileName();
3328 // If this exists, make path relative to the master
3331 removeExtension(prepareFileNameForLaTeX(
3332 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3333 from_utf8(filePath()))),
3334 ".bib", runparams.nice));
3338 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3340 // mangledFileName() needs the extension
3341 DocFileName const in_file = DocFileName(try_in_file);
3342 database = removeExtension(in_file.mangledFileName());
3343 FileName const out_file = makeAbsPath(database + ".bib",
3344 masterBuffer()->temppath());
3345 bool const success = in_file.copyTo(out_file);
3347 LYXERR0("Failed to copy '" << in_file
3348 << "' to '" << out_file << "'");
3350 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3351 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3352 if (!isValidLaTeXFileName(database)) {
3353 frontend::Alert::warning(_("Invalid filename"),
3354 _("The following filename will cause troubles "
3355 "when running the exported file through LaTeX: ") +
3356 from_utf8(database));
3358 if (!isValidDVIFileName(database)) {
3359 frontend::Alert::warning(_("Problematic filename for DVI"),
3360 _("The following filename can cause troubles "
3361 "when running the exported file through LaTeX "
3362 "and opening the resulting DVI: ") +
3363 from_utf8(database), true);
3371 docstring const path = from_utf8(latex_path(database));
3373 if (contains(path, ' '))
3376 if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
3377 enc = params().bibFileEncoding(utf8input);
3379 bool recorded = false;
3380 for (auto const & pe : res) {
3381 if (pe.first == path) {
3388 res.push_back(make_pair(path, enc));
3391 // Check if there are spaces in the path and warn BibTeX users, if so.
3392 // (biber can cope with such paths)
3393 if (!prefixIs(runparams.bibtex_command, "biber")) {
3394 // Post this warning only once.
3395 static bool warned_about_spaces = false;
3396 if (!warned_about_spaces &&
3397 runparams.nice && found_space) {
3398 warned_about_spaces = true;
3399 Alert::warning(_("Export Warning!"),
3400 _("There are spaces in the paths to your BibTeX databases.\n"
3401 "BibTeX will be unable to find them."));
3410 string Buffer::layoutPos() const
3412 return d->layout_position;
3416 void Buffer::setLayoutPos(string const & path)
3419 d->layout_position.clear();
3423 LATTEST(FileName::isAbsolute(path));
3425 d->layout_position =
3426 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3428 if (d->layout_position.empty())
3429 d->layout_position = ".";
3433 bool Buffer::hasReadonlyFlag() const
3435 return d->read_only;
3439 bool Buffer::isReadonly() const
3441 return hasReadonlyFlag() || notifiesExternalModification();
3445 void Buffer::setParent(Buffer const * buffer)
3447 // We need to do some work here to avoid recursive parent structures.
3448 // This is the easy case.
3449 if (buffer == this) {
3450 LYXERR0("Ignoring attempt to set self as parent in\n" << fileName());
3453 // Now we check parents going upward, to make sure that IF we set the
3454 // parent as requested, we would not generate a recursive include.
3455 set<Buffer const *> sb;
3456 Buffer const * b = buffer;
3457 bool found_recursion = false;
3459 if (sb.find(b) != sb.end()) {
3460 found_recursion = true;
3467 if (found_recursion) {
3468 LYXERR0("Ignoring attempt to set parent of\n" <<
3471 buffer->fileName() <<
3472 "\nbecause that would create a recursive inclusion.");
3476 // We should be safe now.
3477 d->setParent(buffer);
3482 Buffer const * Buffer::parent() const
3488 ListOfBuffers Buffer::allRelatives() const
3490 ListOfBuffers lb = masterBuffer()->getDescendants();
3491 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3496 Buffer const * Buffer::masterBuffer() const
3498 Buffer const * const pbuf = d->parent();
3502 return pbuf->masterBuffer();
3506 bool Buffer::isChild(Buffer * child) const
3508 return d->children_positions.find(child) != d->children_positions.end();
3512 DocIterator Buffer::firstChildPosition(Buffer const * child)
3514 Impl::BufferPositionMap::iterator it;
3515 it = d->children_positions.find(child);
3516 if (it == d->children_positions.end())
3517 return DocIterator(this);
3522 bool Buffer::hasChildren() const
3524 return !d->children_positions.empty();
3528 void Buffer::collectChildren(ListOfBuffers & children, bool grand_children) const
3530 // loop over children
3531 for (auto const & p : d->children_positions) {
3532 Buffer * child = const_cast<Buffer *>(p.first);
3534 ListOfBuffers::const_iterator bit = find(children.begin(), children.end(), child);
3535 if (bit != children.end())
3537 children.push_back(child);
3539 // there might be grandchildren
3540 child->collectChildren(children, true);
3545 ListOfBuffers Buffer::getChildren() const
3548 collectChildren(v, false);
3549 // Make sure we have not included ourselves.
3550 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3551 if (bit != v.end()) {
3552 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3559 ListOfBuffers Buffer::getDescendants() const
3562 collectChildren(v, true);
3563 // Make sure we have not included ourselves.
3564 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3565 if (bit != v.end()) {
3566 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3573 template<typename M>
3574 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3579 typename M::const_iterator it = m.lower_bound(x);
3580 if (it == m.begin())
3588 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3589 DocIterator const & pos) const
3591 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3593 // if paragraphs have no macro context set, pos will be empty
3597 // we haven't found anything yet
3598 DocIterator bestPos = owner_->par_iterator_begin();
3599 MacroData const * bestData = nullptr;
3601 // find macro definitions for name
3602 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3603 if (nameIt != macros.end()) {
3604 // find last definition in front of pos or at pos itself
3605 PositionScopeMacroMap::const_iterator it
3606 = greatest_below(nameIt->second, pos);
3607 if (it != nameIt->second.end()) {
3609 // scope ends behind pos?
3610 if (pos < it->second.scope) {
3611 // Looks good, remember this. If there
3612 // is no external macro behind this,
3613 // we found the right one already.
3614 bestPos = it->first;
3615 bestData = &it->second.macro;
3619 // try previous macro if there is one
3620 if (it == nameIt->second.begin())
3627 // find macros in included files
3628 PositionScopeBufferMap::const_iterator it
3629 = greatest_below(position_to_children, pos);
3630 if (it == position_to_children.end())
3631 // no children before
3635 // do we know something better (i.e. later) already?
3636 if (it->first < bestPos )
3639 // scope ends behind pos?
3640 if (pos < it->second.scope
3641 && (cloned_buffer_ ||
3642 theBufferList().isLoaded(it->second.buffer))) {
3643 // look for macro in external file
3645 MacroData const * data
3646 = it->second.buffer->getMacro(name, false);
3649 bestPos = it->first;
3655 // try previous file if there is one
3656 if (it == position_to_children.begin())
3661 // return the best macro we have found
3666 MacroData const * Buffer::getMacro(docstring const & name,
3667 DocIterator const & pos, bool global) const
3672 // query buffer macros
3673 MacroData const * data = d->getBufferMacro(name, pos);
3674 if (data != nullptr)
3677 // If there is a master buffer, query that
3678 Buffer const * const pbuf = d->parent();
3680 d->macro_lock = true;
3681 MacroData const * macro = pbuf->getMacro(
3682 name, *this, false);
3683 d->macro_lock = false;
3689 data = MacroTable::globalMacros().get(name);
3690 if (data != nullptr)
3698 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3700 // set scope end behind the last paragraph
3701 DocIterator scope = par_iterator_begin();
3702 scope.pit() = scope.lastpit() + 1;
3704 return getMacro(name, scope, global);
3708 MacroData const * Buffer::getMacro(docstring const & name,
3709 Buffer const & child, bool global) const
3711 // look where the child buffer is included first
3712 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3713 if (it == d->children_positions.end())
3716 // check for macros at the inclusion position
3717 return getMacro(name, it->second, global);
3721 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3723 pit_type const lastpit = it.lastpit();
3725 // look for macros in each paragraph
3726 while (it.pit() <= lastpit) {
3727 Paragraph & par = it.paragraph();
3729 // FIXME Can this be done with the new-style iterators?
3730 // iterate over the insets of the current paragraph
3731 for (auto const & insit : par.insetList()) {
3732 it.pos() = insit.pos;
3734 // is it a nested text inset?
3735 if (insit.inset->asInsetText()) {
3736 // Inset needs its own scope?
3737 InsetText const * itext = insit.inset->asInsetText();
3738 bool newScope = itext->isMacroScope();
3740 // scope which ends just behind the inset
3741 DocIterator insetScope = it;
3744 // collect macros in inset
3745 it.push_back(CursorSlice(*insit.inset));
3746 updateMacros(it, newScope ? insetScope : scope);
3751 if (insit.inset->asInsetTabular()) {
3752 CursorSlice slice(*insit.inset);
3753 size_t const numcells = slice.nargs();
3754 for (; slice.idx() < numcells; slice.forwardIdx()) {
3755 it.push_back(slice);
3756 updateMacros(it, scope);
3762 // is it an external file?
3763 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3764 // get buffer of external file
3765 InsetInclude const & incinset =
3766 static_cast<InsetInclude const &>(*insit.inset);
3768 Buffer * child = incinset.loadIfNeeded();
3773 // register its position, but only when it is
3774 // included first in the buffer
3775 children_positions.insert({child, it});
3777 // register child with its scope
3778 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3782 InsetMath * im = insit.inset->asInsetMath();
3783 if (doing_export && im) {
3784 InsetMathHull * hull = im->asHullInset();
3786 hull->recordLocation(it);
3789 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3793 InsetMathMacroTemplate & macroTemplate =
3794 *insit.inset->asInsetMath()->asMacroTemplate();
3795 MacroContext mc(owner_, it);
3796 macroTemplate.updateToContext(mc);
3799 bool valid = macroTemplate.validMacro();
3800 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3801 // then the BufferView's cursor will be invalid in
3802 // some cases which leads to crashes.
3807 // FIXME (Abdel), I don't understand why we pass 'it' here
3808 // instead of 'macroTemplate' defined above... is this correct?
3809 macros[macroTemplate.name()][it] =
3810 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3820 void Buffer::updateMacros() const
3825 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3827 // start with empty table
3829 d->children_positions.clear();
3830 d->position_to_children.clear();
3832 // Iterate over buffer, starting with first paragraph
3833 // The scope must be bigger than any lookup DocIterator
3834 // later. For the global lookup, lastpit+1 is used, hence
3835 // we use lastpit+2 here.
3836 DocIterator it = par_iterator_begin();
3837 DocIterator outerScope = it;
3838 outerScope.pit() = outerScope.lastpit() + 2;
3839 d->updateMacros(it, outerScope);
3843 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3845 InsetIterator it = inset_iterator_begin(inset());
3846 InsetIterator const end = inset_iterator_end(inset());
3847 for (; it != end; ++it) {
3848 if (it->lyxCode() == BRANCH_CODE) {
3849 InsetBranch & br = static_cast<InsetBranch &>(*it);
3850 docstring const name = br.branch();
3851 if (!from_master && !params().branchlist().find(name))
3852 result.push_back(name);
3853 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3854 result.push_back(name);
3857 if (it->lyxCode() == INCLUDE_CODE) {
3858 // get buffer of external file
3859 InsetInclude const & ins =
3860 static_cast<InsetInclude const &>(*it);
3861 Buffer * child = ins.loadIfNeeded();
3864 child->getUsedBranches(result, true);
3867 // remove duplicates
3872 void Buffer::updateMacroInstances(UpdateType utype) const
3874 LYXERR(Debug::MACROS, "updateMacroInstances for "
3875 << d->filename.onlyFileName());
3876 DocIterator it = doc_iterator_begin(this);
3878 DocIterator const end = doc_iterator_end(this);
3879 for (; it != end; it.forwardInset()) {
3880 // look for MathData cells in InsetMathNest insets
3881 InsetMath * minset = it.nextInset()->asInsetMath();
3885 // update macro in all cells of the InsetMathNest
3886 DocIterator::idx_type n = minset->nargs();
3887 MacroContext mc = MacroContext(this, it);
3888 for (DocIterator::idx_type i = 0; i < n; ++i) {
3889 MathData & data = minset->cell(i);
3890 data.updateMacros(nullptr, mc, utype, 0);
3896 void Buffer::listMacroNames(MacroNameSet & macros) const
3901 d->macro_lock = true;
3903 // loop over macro names
3904 for (auto const & nameit : d->macros)
3905 macros.insert(nameit.first);
3907 // loop over children
3908 for (auto const & p : d->children_positions) {
3909 Buffer * child = const_cast<Buffer *>(p.first);
3910 // The buffer might have been closed (see #10766).
3911 if (theBufferList().isLoaded(child))
3912 child->listMacroNames(macros);
3916 Buffer const * const pbuf = d->parent();
3918 pbuf->listMacroNames(macros);
3920 d->macro_lock = false;
3924 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3926 Buffer const * const pbuf = d->parent();
3931 pbuf->listMacroNames(names);
3934 for (auto const & mit : names) {
3936 MacroData const * data = pbuf->getMacro(mit, *this, false);
3938 macros.insert(data);
3940 // we cannot access the original InsetMathMacroTemplate anymore
3941 // here to calls validate method. So we do its work here manually.
3942 // FIXME: somehow make the template accessible here.
3943 if (data->optionals() > 0)
3944 features.require("xargs");
3950 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3953 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3955 RefCache::iterator it = d->ref_cache_.find(label);
3956 if (it != d->ref_cache_.end())
3959 static References const dummy_refs = References();
3960 it = d->ref_cache_.insert(
3961 make_pair(label, dummy_refs)).first;
3966 Buffer::References const & Buffer::references(docstring const & label) const
3968 return const_cast<Buffer *>(this)->getReferenceCache(label);
3972 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3974 References & refs = getReferenceCache(label);
3975 refs.push_back(make_pair(inset, it));
3979 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
3983 linfo.label = label;
3985 linfo.active = active;
3986 masterBuffer()->d->label_cache_.push_back(linfo);
3990 InsetLabel const * Buffer::insetLabel(docstring const & label,
3991 bool const active) const
3993 for (auto const & rc : masterBuffer()->d->label_cache_) {
3994 if (rc.label == label && (rc.active || !active))
4001 bool Buffer::activeLabel(docstring const & label) const
4003 return insetLabel(label, true) != nullptr;
4007 void Buffer::clearReferenceCache() const
4010 d->ref_cache_.clear();
4011 d->label_cache_.clear();
4016 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
4018 //FIXME: This does not work for child documents yet.
4019 reloadBibInfoCache();
4021 // Check if the label 'from' appears more than once
4022 vector<docstring> labels;
4023 for (auto const & bibit : masterBibInfo())
4024 labels.push_back(bibit.first);
4026 if (count(labels.begin(), labels.end(), from) > 1)
4029 string const paramName = "key";
4030 UndoGroupHelper ugh(this);
4031 InsetIterator it = inset_iterator_begin(inset());
4033 if (it->lyxCode() != CITE_CODE)
4035 InsetCommand * inset = it->asInsetCommand();
4036 docstring const oldValue = inset->getParam(paramName);
4037 if (oldValue == from) {
4038 undo().recordUndo(CursorData(it));
4039 inset->setParam(paramName, to);
4044 // returns NULL if id-to-row conversion is unsupported
4045 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4046 pit_type par_begin, pit_type par_end,
4047 OutputWhat output, bool master) const
4049 unique_ptr<TexRow> texrow;
4050 OutputParams runparams(¶ms().encoding());
4051 runparams.nice = true;
4052 runparams.flavor = params().getOutputFlavor(format);
4053 runparams.linelen = lyxrc.plaintext_linelen;
4054 // No side effect of file copying and image conversion
4055 runparams.dryrun = true;
4057 // Some macros rely on font encoding
4058 runparams.main_fontenc = params().main_font_encoding();
4060 if (output == CurrentParagraph) {
4061 runparams.par_begin = par_begin;
4062 runparams.par_end = par_end;
4063 if (par_begin + 1 == par_end) {
4065 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4069 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4070 convert<docstring>(par_begin),
4071 convert<docstring>(par_end - 1))
4074 // output paragraphs
4075 if (runparams.flavor == OutputParams::LYX) {
4076 Paragraph const & par = text().paragraphs()[par_begin];
4078 depth_type dt = par.getDepth();
4079 par.write(ods, params(), dt);
4080 os << from_utf8(ods.str());
4081 } else if (runparams.flavor == OutputParams::HTML) {
4083 setMathFlavor(runparams);
4084 xhtmlParagraphs(text(), *this, xs, runparams);
4085 } else if (runparams.flavor == OutputParams::TEXT) {
4087 // FIXME Handles only one paragraph, unlike the others.
4088 // Probably should have some routine with a signature like them.
4089 writePlaintextParagraph(*this,
4090 text().paragraphs()[par_begin], os, runparams, dummy);
4091 } else if (runparams.flavor == OutputParams::DOCBOOK5) {
4093 docbookParagraphs(text(), *this, xs, runparams);
4095 // If we are previewing a paragraph, even if this is the
4096 // child of some other buffer, let's cut the link here,
4097 // so that no concurring settings from the master
4098 // (e.g. branch state) interfere (see #8101).
4100 d->ignore_parent = true;
4101 // We need to validate the Buffer params' features here
4102 // in order to know if we should output polyglossia
4103 // macros (instead of babel macros)
4104 LaTeXFeatures features(*this, params(), runparams);
4106 runparams.use_polyglossia = features.usePolyglossia();
4107 runparams.use_hyperref = features.isRequired("hyperref");
4108 // latex or literate
4111 ots.texrow().newlines(2);
4113 latexParagraphs(*this, text(), ots, runparams);
4114 texrow = ots.releaseTexRow();
4116 // Restore the parenthood
4118 d->ignore_parent = false;
4122 if (output == FullSource)
4123 os << _("Preview source code");
4124 else if (output == OnlyPreamble)
4125 os << _("Preview preamble");
4126 else if (output == OnlyBody)
4127 os << _("Preview body");
4129 if (runparams.flavor == OutputParams::LYX) {
4131 if (output == FullSource)
4133 else if (output == OnlyPreamble)
4134 params().writeFile(ods, this);
4135 else if (output == OnlyBody)
4137 os << from_utf8(ods.str());
4138 } else if (runparams.flavor == OutputParams::HTML) {
4139 writeLyXHTMLSource(os, runparams, output);
4140 } else if (runparams.flavor == OutputParams::TEXT) {
4141 if (output == OnlyPreamble) {
4142 os << "% "<< _("Plain text does not have a preamble.");
4144 writePlaintextFile(*this, os, runparams);
4145 } else if (runparams.flavor == OutputParams::DOCBOOK5) {
4146 writeDocBookSource(os, runparams, output);
4148 // latex or literate
4151 ots.texrow().newlines(2);
4153 runparams.is_child = true;
4155 writeLaTeXSource(ots, string(), runparams, output);
4156 texrow = ots.releaseTexRow();
4163 ErrorList & Buffer::errorList(string const & type) const
4165 return d->errorLists[type];
4169 void Buffer::updateTocItem(std::string const & type,
4170 DocIterator const & dit) const
4173 d->gui_->updateTocItem(type, dit);
4177 void Buffer::structureChanged() const
4180 d->gui_->structureChanged();
4184 void Buffer::errors(string const & err, bool from_master) const
4187 d->gui_->errors(err, from_master);
4191 void Buffer::message(docstring const & msg) const
4194 d->gui_->message(msg);
4198 void Buffer::setBusy(bool on) const
4201 d->gui_->setBusy(on);
4205 void Buffer::updateTitles() const
4208 d->wa_->updateTitles();
4212 void Buffer::resetAutosaveTimers() const
4215 d->gui_->resetAutosaveTimers();
4219 bool Buffer::hasGuiDelegate() const
4225 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4231 FileName Buffer::getEmergencyFileName() const
4233 return FileName(d->filename.absFileName() + ".emergency");
4237 FileName Buffer::getAutosaveFileName() const
4239 // if the document is unnamed try to save in the backup dir, else
4240 // in the default document path, and as a last try in the filePath,
4241 // which will most often be the temporary directory
4244 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4245 : lyxrc.backupdir_path;
4246 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4249 string const fname = "#" + d->filename.onlyFileName() + "#";
4251 return makeAbsPath(fname, fpath);
4255 void Buffer::removeAutosaveFile() const
4257 FileName const f = getAutosaveFileName();
4263 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4265 FileName const newauto = getAutosaveFileName();
4267 if (newauto != oldauto && oldauto.exists())
4268 if (!oldauto.moveTo(newauto))
4269 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4273 bool Buffer::autoSave() const
4275 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4276 if (buf->d->bak_clean || hasReadonlyFlag())
4279 message(_("Autosaving current document..."));
4280 buf->d->bak_clean = true;
4282 FileName const fname = getAutosaveFileName();
4283 LASSERT(d->cloned_buffer_, return false);
4285 // If this buffer is cloned, we assume that
4286 // we are running in a separate thread already.
4287 TempFile tempfile("lyxautoXXXXXX.lyx");
4288 tempfile.setAutoRemove(false);
4289 FileName const tmp_ret = tempfile.name();
4290 if (!tmp_ret.empty()) {
4292 // assume successful write of tmp_ret
4293 if (tmp_ret.moveTo(fname))
4296 // failed to write/rename tmp_ret so try writing direct
4297 return writeFile(fname);
4301 void Buffer::setExportStatus(bool e) const
4303 d->doing_export = e;
4304 ListOfBuffers clist = getDescendants();
4305 for (auto const & bit : clist)
4306 bit->d->doing_export = e;
4310 bool Buffer::isExporting() const
4312 return d->doing_export;
4316 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4320 return doExport(target, put_in_tempdir, result_file);
4323 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4324 string & result_file) const
4326 bool const update_unincluded =
4327 params().maintain_unincluded_children != BufferParams::CM_None
4328 && !params().getIncludedChildren().empty();
4330 // (1) export with all included children (omit \includeonly)
4331 if (update_unincluded) {
4332 ExportStatus const status =
4333 doExport(target, put_in_tempdir, true, result_file);
4334 if (status != ExportSuccess)
4337 // (2) export with included children only
4338 return doExport(target, put_in_tempdir, false, result_file);
4342 void Buffer::setMathFlavor(OutputParams & op) const
4344 switch (params().html_math_output) {
4345 case BufferParams::MathML:
4346 op.math_flavor = OutputParams::MathAsMathML;
4348 case BufferParams::HTML:
4349 op.math_flavor = OutputParams::MathAsHTML;
4351 case BufferParams::Images:
4352 op.math_flavor = OutputParams::MathAsImages;
4354 case BufferParams::LaTeX:
4355 op.math_flavor = OutputParams::MathAsLaTeX;
4361 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4362 bool includeall, string & result_file) const
4364 LYXERR(Debug::FILES, "target=" << target);
4365 OutputParams runparams(¶ms().encoding());
4366 string format = target;
4367 string dest_filename;
4368 size_t pos = target.find(' ');
4369 if (pos != string::npos) {
4370 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4371 format = target.substr(0, pos);
4372 if (format == "default")
4373 format = params().getDefaultOutputFormat();
4374 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4375 FileName(dest_filename).onlyPath().createPath();
4376 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4378 MarkAsExporting exporting(this);
4379 string backend_format;
4380 runparams.flavor = OutputParams::LATEX;
4381 runparams.linelen = lyxrc.plaintext_linelen;
4382 runparams.includeall = includeall;
4383 vector<string> backs = params().backends();
4384 Converters converters = theConverters();
4385 bool need_nice_file = false;
4386 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4387 // Get shortest path to format
4388 converters.buildGraph();
4389 Graph::EdgePath path;
4390 for (string const & sit : backs) {
4391 Graph::EdgePath p = converters.getPath(sit, format);
4392 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4393 backend_format = sit;
4398 if (!put_in_tempdir) {
4399 // Only show this alert if this is an export to a non-temporary
4400 // file (not for previewing).
4401 docstring s = bformat(_("No information for exporting the format %1$s."),
4402 translateIfPossible(theFormats().prettyName(format)));
4403 if (format == "pdf4")
4405 + bformat(_("Hint: use non-TeX fonts or set input encoding "
4406 " to '%1$s'"), from_utf8(encodings.fromLyXName("ascii")->guiName()));
4407 Alert::error(_("Couldn't export file"), s);
4409 return ExportNoPathToFormat;
4411 runparams.flavor = converters.getFlavor(path, this);
4412 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4413 for (auto const & edge : path)
4414 if (theConverters().get(edge).nice()) {
4415 need_nice_file = true;
4420 backend_format = format;
4421 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4422 // FIXME: Don't hardcode format names here, but use a flag
4423 if (backend_format == "pdflatex")
4424 runparams.flavor = OutputParams::PDFLATEX;
4425 else if (backend_format == "luatex")
4426 runparams.flavor = OutputParams::LUATEX;
4427 else if (backend_format == "dviluatex")
4428 runparams.flavor = OutputParams::DVILUATEX;
4429 else if (backend_format == "xetex")
4430 runparams.flavor = OutputParams::XETEX;
4433 string filename = latexName(false);
4434 filename = addName(temppath(), filename);
4435 filename = changeExtension(filename,
4436 theFormats().extension(backend_format));
4437 LYXERR(Debug::FILES, "filename=" << filename);
4439 // Plain text backend
4440 if (backend_format == "text") {
4441 runparams.flavor = OutputParams::TEXT;
4443 writePlaintextFile(*this, FileName(filename), runparams);
4445 catch (ConversionException const &) { return ExportCancel; }
4448 else if (backend_format == "xhtml") {
4449 runparams.flavor = OutputParams::HTML;
4450 setMathFlavor(runparams);
4451 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4452 return ExportKilled;
4453 } else if (backend_format == "lyx")
4454 writeFile(FileName(filename));
4456 else if (backend_format == "docbook5") {
4457 runparams.flavor = OutputParams::DOCBOOK5;
4458 runparams.nice = false;
4459 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4460 return ExportKilled;
4463 else if (backend_format == format || need_nice_file) {
4464 runparams.nice = true;
4465 ExportStatus const retval =
4466 makeLaTeXFile(FileName(filename), string(), runparams);
4467 if (retval == ExportKilled)
4468 return ExportKilled;
4469 if (d->cloned_buffer_)
4470 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4471 if (retval != ExportSuccess)
4473 } else if (!lyxrc.tex_allows_spaces
4474 && contains(filePath(), ' ')) {
4475 Alert::error(_("File name error"),
4476 bformat(_("The directory path to the document\n%1$s\n"
4477 "contains spaces, but your TeX installation does "
4478 "not allow them. You should save the file to a directory "
4479 "whose name does not contain spaces."), from_utf8(filePath())));
4480 return ExportTexPathHasSpaces;
4482 runparams.nice = false;
4483 ExportStatus const retval =
4484 makeLaTeXFile(FileName(filename), filePath(), runparams);
4485 if (retval == ExportKilled)
4486 return ExportKilled;
4487 if (d->cloned_buffer_)
4488 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4489 if (retval != ExportSuccess)
4493 string const error_type = (format == "program")
4494 ? "Build" : params().bufferFormat();
4495 ErrorList & error_list = d->errorLists[error_type];
4496 string const ext = theFormats().extension(format);
4497 FileName const tmp_result_file(changeExtension(filename, ext));
4498 Converters::RetVal const retval =
4499 converters.convert(this, FileName(filename), tmp_result_file,
4500 FileName(absFileName()), backend_format, format,
4501 error_list, Converters::none, includeall);
4502 if (retval == Converters::KILLED)
4503 return ExportCancel;
4504 bool success = (retval == Converters::SUCCESS);
4506 // Emit the signal to show the error list or copy it back to the
4507 // cloned Buffer so that it can be emitted afterwards.
4508 if (format != backend_format) {
4509 if (runparams.silent)
4511 else if (d->cloned_buffer_)
4512 d->cloned_buffer_->d->errorLists[error_type] =
4513 d->errorLists[error_type];
4516 // also to the children, in case of master-buffer-view
4517 ListOfBuffers clist = getDescendants();
4518 for (auto const & bit : clist) {
4519 if (runparams.silent)
4520 bit->d->errorLists[error_type].clear();
4521 else if (d->cloned_buffer_) {
4522 // Enable reverse search by copying back the
4523 // texrow object to the cloned buffer.
4524 // FIXME: this is not thread safe.
4525 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4526 bit->d->cloned_buffer_->d->errorLists[error_type] =
4527 bit->d->errorLists[error_type];
4529 bit->errors(error_type, true);
4533 if (d->cloned_buffer_) {
4534 // Enable reverse dvi or pdf to work by copying back the texrow
4535 // object to the cloned buffer.
4536 // FIXME: There is a possibility of concurrent access to texrow
4537 // here from the main GUI thread that should be securized.
4538 d->cloned_buffer_->d->texrow = d->texrow;
4539 string const err_type = params().bufferFormat();
4540 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4544 if (put_in_tempdir) {
4545 result_file = tmp_result_file.absFileName();
4546 return success ? ExportSuccess : ExportConverterError;
4549 if (dest_filename.empty())
4550 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4552 result_file = dest_filename;
4553 // We need to copy referenced files (e. g. included graphics
4554 // if format == "dvi") to the result dir.
4555 vector<ExportedFile> const extfiles =
4556 runparams.exportdata->externalFiles(format);
4557 string const dest = runparams.export_folder.empty() ?
4558 onlyPath(result_file) : runparams.export_folder;
4559 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4560 : force_overwrite == ALL_FILES;
4561 CopyStatus status = use_force ? FORCE : SUCCESS;
4563 for (ExportedFile const & exp : extfiles) {
4564 if (status == CANCEL) {
4565 message(_("Document export cancelled."));
4566 return ExportCancel;
4568 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4569 string fixedName = exp.exportName;
4570 if (!runparams.export_folder.empty()) {
4571 // Relative pathnames starting with ../ will be sanitized
4572 // if exporting to a different folder
4573 while (fixedName.substr(0, 3) == "../")
4574 fixedName = fixedName.substr(3, fixedName.length() - 3);
4576 FileName fixedFileName = makeAbsPath(fixedName, dest);
4577 fixedFileName.onlyPath().createPath();
4578 status = copyFile(fmt, exp.sourceName,
4580 exp.exportName, status == FORCE,
4581 runparams.export_folder.empty());
4585 if (tmp_result_file.exists()) {
4586 // Finally copy the main file
4587 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4588 : force_overwrite != NO_FILES;
4589 if (status == SUCCESS && use_force)
4591 status = copyFile(format, tmp_result_file,
4592 FileName(result_file), result_file,
4594 if (status == CANCEL) {
4595 message(_("Document export cancelled."));
4596 return ExportCancel;
4598 message(bformat(_("Document exported as %1$s "
4600 translateIfPossible(theFormats().prettyName(format)),
4601 makeDisplayPath(result_file)));
4604 // This must be a dummy converter like fax (bug 1888)
4605 message(bformat(_("Document exported as %1$s"),
4606 translateIfPossible(theFormats().prettyName(format))));
4609 return success ? ExportSuccess : ExportConverterError;
4613 Buffer::ExportStatus Buffer::preview(string const & format) const
4615 bool const update_unincluded =
4616 params().maintain_unincluded_children != BufferParams::CM_None
4617 && !params().getIncludedChildren().empty();
4618 return preview(format, update_unincluded);
4622 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4624 MarkAsExporting exporting(this);
4626 // (1) export with all included children (omit \includeonly)
4628 ExportStatus const status = doExport(format, true, true, result_file);
4629 if (status != ExportSuccess)
4632 // (2) export with included children only
4633 ExportStatus const status = doExport(format, true, false, result_file);
4634 FileName const previewFile(result_file);
4636 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4637 theimpl->preview_file_ = previewFile;
4638 theimpl->preview_format_ = format;
4639 theimpl->require_fresh_start_ = (status != ExportSuccess);
4641 if (status != ExportSuccess)
4644 if (previewFile.exists())
4645 return theFormats().view(*this, previewFile, format) ?
4646 PreviewSuccess : PreviewError;
4648 // Successful export but no output file?
4649 // Probably a bug in error detection.
4650 LATTEST(status != ExportSuccess);
4655 Buffer::ReadStatus Buffer::extractFromVC()
4657 bool const found = LyXVC::file_not_found_hook(d->filename);
4659 return ReadFileNotFound;
4660 if (!d->filename.isReadableFile())
4666 Buffer::ReadStatus Buffer::loadEmergency()
4668 FileName const emergencyFile = getEmergencyFileName();
4669 if (!emergencyFile.exists()
4670 || emergencyFile.lastModified() <= d->filename.lastModified())
4671 return ReadFileNotFound;
4673 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4674 docstring const text = bformat(_("An emergency save of the document "
4675 "%1$s exists.\n\nRecover emergency save?"), file);
4677 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4678 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4684 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4685 bool const success = (ret_llf == ReadSuccess);
4687 if (hasReadonlyFlag()) {
4688 Alert::warning(_("File is read-only"),
4689 bformat(_("An emergency file is successfully loaded, "
4690 "but the original file %1$s is marked read-only. "
4691 "Please make sure to save the document as a different "
4692 "file."), from_utf8(d->filename.absFileName())));
4695 lyxvc().file_found_hook(d->filename);
4696 str = _("Document was successfully recovered.");
4698 str = _("Document was NOT successfully recovered.");
4699 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4700 makeDisplayPath(emergencyFile.absFileName()));
4702 int const del_emerg =
4703 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4704 _("&Remove"), _("&Keep"));
4705 if (del_emerg == 0) {
4706 emergencyFile.removeFile();
4708 Alert::warning(_("Emergency file deleted"),
4709 _("Do not forget to save your file now!"), true);
4711 return success ? ReadSuccess : ReadEmergencyFailure;
4714 int const del_emerg =
4715 Alert::prompt(_("Delete emergency file?"),
4716 _("Remove emergency file now?"), 1, 1,
4717 _("&Remove"), _("&Keep"));
4719 emergencyFile.removeFile();
4723 string const ename = emergencyFile.absFileName();
4725 // Surely we can find one in 100 tries?
4726 for (int i = 1; i < 100; ++i) {
4727 newname.set(ename + to_string(i) + ".lyx");
4728 if (!newname.exists()) {
4734 // renameTo returns true on success. So inverting that
4735 // will give us true if we fail.
4736 noname = !emergencyFile.renameTo(newname);
4739 Alert::warning(_("Can't rename emergency file!"),
4740 _("LyX was unable to rename the emergency file. "
4741 "You should do so manually. Otherwise, you will be "
4742 "asked about it again the next time you try to load "
4743 "this file, and may over-write your own work."));
4745 Alert::warning(_("Emergency File Renames"),
4746 bformat(_("Emergency file renamed as:\n %1$s"),
4747 from_utf8(newname.onlyFileName())));
4750 return ReadOriginal;
4760 Buffer::ReadStatus Buffer::loadAutosave()
4762 // Now check if autosave file is newer.
4763 FileName const autosaveFile = getAutosaveFileName();
4764 if (!autosaveFile.exists()
4765 || autosaveFile.lastModified() <= d->filename.lastModified())
4766 return ReadFileNotFound;
4768 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4769 docstring const text = bformat(_("The backup of the document %1$s "
4770 "is newer.\n\nLoad the backup instead?"), file);
4771 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4772 _("&Load backup"), _("Load &original"), _("&Cancel"));
4777 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4778 // the file is not saved if we load the autosave file.
4779 if (ret_llf == ReadSuccess) {
4780 if (hasReadonlyFlag()) {
4781 Alert::warning(_("File is read-only"),
4782 bformat(_("A backup file is successfully loaded, "
4783 "but the original file %1$s is marked read-only. "
4784 "Please make sure to save the document as a "
4786 from_utf8(d->filename.absFileName())));
4789 lyxvc().file_found_hook(d->filename);
4792 return ReadAutosaveFailure;
4795 // Here we delete the autosave
4796 autosaveFile.removeFile();
4797 return ReadOriginal;
4805 Buffer::ReadStatus Buffer::loadLyXFile()
4807 if (!d->filename.isReadableFile()) {
4808 ReadStatus const ret_rvc = extractFromVC();
4809 if (ret_rvc != ReadSuccess)
4813 ReadStatus const ret_re = loadEmergency();
4814 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4817 ReadStatus const ret_ra = loadAutosave();
4818 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4821 return loadThisLyXFile(d->filename);
4825 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4827 return readFile(fn);
4831 void Buffer::Impl::traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const
4833 for (; err != end; ++err) {
4834 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4835 int errorRow = err->error_in_line;
4836 Buffer const * buf = nullptr;
4837 Impl const * p = this;
4838 if (err->child_name.empty())
4839 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4841 // The error occurred in a child
4842 for (Buffer const * child : owner_->getDescendants()) {
4843 string const child_name =
4844 DocFileName(changeExtension(child->absFileName(), "tex")).
4846 if (err->child_name != child_name)
4848 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4849 if (!TexRow::isNone(start)) {
4850 buf = this->cloned_buffer_
4851 ? child->d->cloned_buffer_->d->owner_
4858 errorList.push_back(ErrorItem(err->error_desc, err->error_text,
4864 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4866 TeXErrors::Errors::const_iterator err = terr.begin();
4867 TeXErrors::Errors::const_iterator end = terr.end();
4869 d->traverseErrors(err, end, errorList);
4873 void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const
4875 TeXErrors::Errors::const_iterator err = terr.begin_ref();
4876 TeXErrors::Errors::const_iterator end = terr.end_ref();
4878 d->traverseErrors(err, end, errorList);
4882 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4884 LBUFERR(!text().paragraphs().empty());
4886 // Use the master text class also for child documents
4887 Buffer const * const master = masterBuffer();
4888 DocumentClass const & textclass = master->params().documentClass();
4890 docstring_list old_bibfiles;
4891 // Do this only if we are the top-level Buffer. We also need to account
4892 // for the case of a previewed child with ignored parent here.
4893 if (master == this && !d->ignore_parent) {
4894 textclass.counters().reset(from_ascii("bibitem"));
4895 reloadBibInfoCache();
4896 // we will re-read this cache as we go through, but we need
4897 // to know whether it's changed to know whether we need to
4898 // update the bibinfo cache.
4899 old_bibfiles = d->bibfiles_cache_;
4900 d->bibfiles_cache_.clear();
4903 // keep the buffers to be children in this set. If the call from the
4904 // master comes back we can see which of them were actually seen (i.e.
4905 // via an InsetInclude). The remaining ones in the set need still be updated.
4906 static std::set<Buffer const *> bufToUpdate;
4907 if (scope == UpdateMaster) {
4908 // If this is a child document start with the master
4909 if (master != this) {
4910 bufToUpdate.insert(this);
4911 master->updateBuffer(UpdateMaster, utype);
4912 // If the master buffer has no gui associated with it, then the TocModel is
4913 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4914 // (bug 5699). The same happens if the master buffer is open in a different
4915 // window. This test catches both possibilities.
4916 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
4917 // There remains a problem here: If there is another child open in yet a third
4918 // window, that TOC is not updated. So some more general solution is needed at
4920 if (master->d->gui_ != d->gui_)
4923 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4924 if (bufToUpdate.find(this) == bufToUpdate.end())
4928 // start over the counters in the master
4929 textclass.counters().reset();
4932 // update will be done below for this buffer
4933 bufToUpdate.erase(this);
4935 // update all caches
4936 clearReferenceCache();
4939 Buffer & cbuf = const_cast<Buffer &>(*this);
4940 // if we are reloading, then we could have a dangling TOC,
4941 // in effect. so we need to go ahead and reset, even though
4942 // we will do so again when we rebuild the TOC later.
4943 cbuf.tocBackend().reset();
4946 ParIterator parit = cbuf.par_iterator_begin();
4947 if (scope == UpdateMaster)
4949 updateBuffer(parit, utype);
4951 // If this document has siblings, then update the TocBackend later. The
4952 // reason is to ensure that later siblings are up to date when e.g. the
4953 // broken or not status of references is computed. The update is called
4954 // in InsetInclude::addToToc.
4958 // if the bibfiles changed, the cache of bibinfo is invalid
4959 docstring_list new_bibfiles = d->bibfiles_cache_;
4960 // this is a trick to determine whether the two vectors have
4961 // the same elements.
4962 sort(new_bibfiles.begin(), new_bibfiles.end());
4963 sort(old_bibfiles.begin(), old_bibfiles.end());
4964 if (old_bibfiles != new_bibfiles) {
4965 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
4966 invalidateBibinfoCache();
4967 reloadBibInfoCache();
4968 // We relied upon the bibinfo cache when recalculating labels. But that
4969 // cache was invalid, although we didn't find that out until now. So we
4970 // have to do it all again.
4971 // That said, the only thing we really need to do is update the citation
4972 // labels. Nothing else will have changed. So we could create a new
4973 // UpdateType that would signal that fact, if we needed to do so.
4974 parit = cbuf.par_iterator_begin();
4975 // we will be re-doing the counters and references and such.
4976 textclass.counters().reset();
4977 clearReferenceCache();
4978 // we should not need to do this again?
4980 updateBuffer(parit, utype);
4981 // this will already have been done by reloadBibInfoCache();
4982 // d->bibinfo_cache_valid_ = true;
4985 LYXERR(Debug::FILES, "Bibfiles unchanged.");
4986 // this is also set to true on the other path, by reloadBibInfoCache.
4987 d->bibinfo_cache_valid_ = true;
4989 d->cite_labels_valid_ = true;
4992 cbuf.tocBackend().update(true, utype);
4993 if (scope == UpdateMaster)
4994 cbuf.structureChanged();
4998 static depth_type getDepth(DocIterator const & it)
5000 depth_type depth = 0;
5001 for (size_t i = 0 ; i < it.depth() ; ++i)
5002 if (!it[i].inset().inMathed())
5003 depth += it[i].paragraph().getDepth() + 1;
5004 // remove 1 since the outer inset does not count
5005 // we should have at least one non-math inset, so
5006 // depth should nevery be 0. but maybe it is worth
5007 // marking this, just in case.
5009 // coverity[INTEGER_OVERFLOW]
5013 static depth_type getItemDepth(ParIterator const & it)
5015 Paragraph const & par = *it;
5016 LabelType const labeltype = par.layout().labeltype;
5018 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5021 // this will hold the lowest depth encountered up to now.
5022 depth_type min_depth = getDepth(it);
5023 ParIterator prev_it = it;
5026 --prev_it.top().pit();
5028 // start of nested inset: go to outer par
5030 if (prev_it.empty()) {
5031 // start of document: nothing to do
5036 // We search for the first paragraph with same label
5037 // that is not more deeply nested.
5038 Paragraph & prev_par = *prev_it;
5039 depth_type const prev_depth = getDepth(prev_it);
5040 if (labeltype == prev_par.layout().labeltype) {
5041 if (prev_depth < min_depth)
5042 return prev_par.itemdepth + 1;
5043 if (prev_depth == min_depth)
5044 return prev_par.itemdepth;
5046 min_depth = min(min_depth, prev_depth);
5047 // small optimization: if we are at depth 0, we won't
5048 // find anything else
5049 if (prev_depth == 0)
5055 static bool needEnumCounterReset(ParIterator const & it)
5057 Paragraph const & par = *it;
5058 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5059 depth_type const cur_depth = par.getDepth();
5060 ParIterator prev_it = it;
5061 while (prev_it.pit()) {
5062 --prev_it.top().pit();
5063 Paragraph const & prev_par = *prev_it;
5064 if (prev_par.getDepth() <= cur_depth)
5065 return prev_par.layout().name() != par.layout().name();
5067 // start of nested inset: reset
5072 // set the label of a paragraph. This includes the counters.
5073 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5075 BufferParams const & bp = owner_->masterBuffer()->params();
5076 DocumentClass const & textclass = bp.documentClass();
5077 Paragraph & par = it.paragraph();
5078 Layout const & layout = par.layout();
5079 Counters & counters = textclass.counters();
5081 if (par.params().startOfAppendix()) {
5082 // We want to reset the counter corresponding to toplevel sectioning
5083 Layout const & lay = textclass.getTOCLayout();
5084 docstring const cnt = lay.counter;
5086 counters.reset(cnt);
5087 counters.appendix(true);
5089 par.params().appendix(counters.appendix());
5091 // Compute the item depth of the paragraph
5092 par.itemdepth = getItemDepth(it);
5094 if (layout.margintype == MARGIN_MANUAL) {
5095 if (par.params().labelWidthString().empty())
5096 par.params().labelWidthString(par.expandLabel(layout, bp));
5097 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5098 // we do not need to do anything here, since the empty case is
5099 // handled during export.
5101 par.params().labelWidthString(docstring());
5104 switch(layout.labeltype) {
5105 case LABEL_ITEMIZE: {
5106 // At some point of time we should do something more
5107 // clever here, like:
5108 // par.params().labelString(
5109 // bp.user_defined_bullet(par.itemdepth).getText());
5110 // for now, use a simple hardcoded label
5111 docstring itemlabel;
5112 switch (par.itemdepth) {
5115 itemlabel = char_type(0x2022);
5119 itemlabel = char_type(0x2013);
5122 // ∗ U+2217 ASTERISK OPERATOR
5123 itemlabel = char_type(0x2217);
5126 // · U+00B7 MIDDLE DOT
5127 itemlabel = char_type(0x00b7);
5130 par.params().labelString(itemlabel);
5134 case LABEL_ENUMERATE: {
5135 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5137 switch (par.itemdepth) {
5148 enumcounter += "iv";
5151 // not a valid enumdepth...
5155 if (needEnumCounterReset(it)) {
5156 // Increase the parent counter?
5157 if (layout.stepparentcounter)
5158 counters.stepParent(enumcounter, utype);
5159 // Maybe we have to reset the enumeration counter.
5160 if (!layout.resumecounter)
5161 counters.reset(enumcounter);
5163 counters.step(enumcounter, utype);
5165 string const & lang = par.getParLanguage(bp)->code();
5166 par.params().labelString(counters.theCounter(enumcounter, lang));
5171 case LABEL_SENSITIVE: {
5172 string const & type = counters.current_float();
5173 docstring full_label;
5175 full_label = owner_->B_("Senseless!!! ");
5177 docstring name = owner_->B_(textclass.floats().getType(type).name());
5178 if (counters.hasCounter(from_utf8(type))) {
5179 string const & lang = par.getParLanguage(bp)->code();
5180 counters.step(from_utf8(type), utype);
5181 full_label = bformat(from_ascii("%1$s %2$s:"),
5183 counters.theCounter(from_utf8(type), lang));
5185 full_label = bformat(from_ascii("%1$s #:"), name);
5187 par.params().labelString(full_label);
5191 case LABEL_NO_LABEL:
5192 par.params().labelString(docstring());
5196 case LABEL_CENTERED:
5197 case LABEL_STATIC: {
5198 docstring const & lcounter = layout.counter;
5199 if (!lcounter.empty()) {
5200 if (layout.toclevel <= bp.secnumdepth
5201 && (layout.latextype != LATEX_ENVIRONMENT
5202 || it.text()->isFirstInSequence(it.pit()))) {
5203 if (counters.hasCounter(lcounter))
5204 counters.step(lcounter, utype);
5205 par.params().labelString(par.expandLabel(layout, bp));
5207 par.params().labelString(docstring());
5209 par.params().labelString(par.expandLabel(layout, bp));
5215 par.params().labelString(par.expandLabel(layout, bp));
5220 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype, bool const deleted) const
5222 pushIncludedBuffer(this);
5223 // LASSERT: Is it safe to continue here, or should we just return?
5224 LASSERT(parit.pit() == 0, /**/);
5226 // Set the position of the text in the buffer to be able
5227 // to resolve macros in it.
5228 parit.text()->setMacrocontextPosition(parit);
5230 depth_type maxdepth = 0;
5231 pit_type const lastpit = parit.lastpit();
5232 bool changed = false;
5233 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5234 // reduce depth if necessary
5235 if (parit->params().depth() > maxdepth) {
5236 /** FIXME: this function is const, but
5237 * nevertheless it modifies the buffer. To be
5238 * cleaner, one should modify the buffer in
5239 * another function, which is actually
5240 * non-const. This would however be costly in
5241 * terms of code duplication.
5243 CursorData(parit).recordUndo();
5244 parit->params().depth(maxdepth);
5246 maxdepth = parit->getMaxDepthAfter();
5248 if (utype == OutputUpdate) {
5249 // track the active counters
5250 // we have to do this for the master buffer, since the local
5251 // buffer isn't tracking anything.
5252 masterBuffer()->params().documentClass().counters().
5253 setActiveLayout(parit->layout());
5256 // set the counter for this paragraph
5257 d->setLabel(parit, utype);
5260 for (auto const & insit : parit->insetList()) {
5261 parit.pos() = insit.pos;
5262 insit.inset->updateBuffer(parit, utype, deleted || parit->isDeleted(insit.pos));
5263 changed |= insit.inset->isChanged();
5266 // are there changes in this paragraph?
5267 changed |= parit->isChanged();
5270 // set change indicator for the inset (or the cell that the iterator
5271 // points to, if applicable).
5272 parit.text()->inset().isChanged(changed);
5273 popIncludedBuffer();
5277 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5278 WordLangTuple & word_lang, docstring_list & suggestions) const
5282 suggestions.clear();
5283 word_lang = WordLangTuple();
5284 bool const to_end = to.empty();
5285 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5286 // OK, we start from here.
5287 for (; from != end; from.forwardPos()) {
5288 // This skips all insets with spell check disabled.
5289 while (!from.allowSpellCheck()) {
5293 // If from is at the end of the document (which is possible
5294 // when "from" was changed above) LyX will crash later otherwise.
5295 if (from.atEnd() || (!to_end && from >= end))
5298 from.paragraph().spellCheck();
5299 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5300 if (SpellChecker::misspelled(res)) {
5304 // Do not increase progress when from == to, otherwise the word
5305 // count will be wrong.
5315 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5317 bool inword = false;
5322 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5323 if (!dit.inTexted()) {
5328 Paragraph const & par = dit.paragraph();
5329 pos_type const pos = dit.pos();
5331 // Copied and adapted from isWordSeparator() in Paragraph
5332 if (pos == dit.lastpos()) {
5335 Inset const * ins = par.getInset(pos);
5336 if (ins && skipNoOutput && !ins->producesOutput()) {
5339 // stop if end of range was skipped
5340 if (!to.atEnd() && dit >= to)
5343 } else if (!par.isDeleted(pos)) {
5344 if (par.isWordSeparator(pos))
5350 if (ins && ins->isLetter()) {
5351 odocstringstream os;
5353 char_count_ += os.str().length();
5355 else if (ins && ins->isSpace())
5358 char_type const c = par.getChar(pos);
5359 if (isPrintableNonspace(c))
5361 else if (isSpace(c))
5371 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5373 d->updateStatistics(from, to, skipNoOutput);
5377 int Buffer::wordCount() const
5379 return d->wordCount();
5383 int Buffer::charCount(bool with_blanks) const
5385 return d->charCount(with_blanks);
5389 bool Buffer::areChangesPresent() const
5391 return inset().isChanged();
5395 Buffer::ReadStatus Buffer::reload()
5398 // c.f. bug https://www.lyx.org/trac/ticket/6587
5399 removeAutosaveFile();
5400 // e.g., read-only status could have changed due to version control
5401 d->filename.refresh();
5402 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5404 // clear parent. this will get reset if need be.
5405 d->setParent(nullptr);
5406 ReadStatus const status = loadLyXFile();
5407 if (status == ReadSuccess) {
5412 message(bformat(_("Document %1$s reloaded."), disp_fn));
5415 message(bformat(_("Could not reload document %1$s."), disp_fn));
5425 bool Buffer::saveAs(FileName const & fn)
5427 FileName const old_name = fileName();
5428 FileName const old_auto = getAutosaveFileName();
5429 bool const old_unnamed = isUnnamed();
5430 bool success = true;
5431 d->old_position = filePath();
5438 // bring the autosave file with us, just in case.
5439 moveAutosaveFile(old_auto);
5440 // validate version control data and
5441 // correct buffer title
5442 lyxvc().file_found_hook(fileName());
5444 // the file has now been saved to the new location.
5445 // we need to check that the locations of child buffers
5447 checkChildBuffers();
5448 checkMasterBuffer();
5451 // reset the old filename and unnamed state
5452 setFileName(old_name);
5453 setUnnamed(old_unnamed);
5457 d->old_position.clear();
5462 void Buffer::checkChildBuffers()
5464 for (auto const & bit : d->children_positions) {
5465 DocIterator dit = bit.second;
5466 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5467 if (!cbuf || !theBufferList().isLoaded(cbuf))
5469 Inset * inset = dit.nextInset();
5470 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5471 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5472 docstring const & incfile = inset_inc->getParam("filename");
5473 string oldloc = cbuf->absFileName();
5474 string newloc = makeAbsPath(to_utf8(incfile),
5475 onlyPath(absFileName())).absFileName();
5476 if (oldloc == newloc)
5478 // the location of the child file is incorrect.
5479 cbuf->setParent(nullptr);
5480 inset_inc->setChildBuffer(nullptr);
5482 // invalidate cache of children
5483 d->children_positions.clear();
5484 d->position_to_children.clear();
5488 // If a child has been saved under a different name/path, it might have been
5489 // orphaned. Therefore the master needs to be reset (bug 8161).
5490 void Buffer::checkMasterBuffer()
5492 Buffer const * const master = masterBuffer();
5496 // necessary to re-register the child (bug 5873)
5497 // FIXME: clean up updateMacros (here, only
5498 // child registering is needed).
5499 master->updateMacros();
5500 // (re)set master as master buffer, but only
5501 // if we are a real child
5502 if (master->isChild(this))
5509 string Buffer::includedFilePath(string const & name, string const & ext) const
5511 if (d->old_position.empty() ||
5512 equivalent(FileName(d->old_position), FileName(filePath())))
5515 bool isabsolute = FileName::isAbsolute(name);
5516 // both old_position and filePath() end with a path separator
5517 string absname = isabsolute ? name : d->old_position + name;
5519 // if old_position is set to origin, we need to do the equivalent of
5520 // getReferencedFileName() (see readDocument())
5521 if (!isabsolute && d->old_position == params().origin) {
5522 FileName const test(addExtension(filePath() + name, ext));
5524 absname = filePath() + name;
5527 if (!FileName(addExtension(absname, ext)).exists())
5531 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5533 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5534 from_utf8(filePath())));
5538 void Buffer::Impl::refreshFileMonitor()
5540 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5541 file_monitor_->refresh();
5545 // The previous file monitor is invalid
5546 // This also destroys the previous file monitor and all its connections
5547 file_monitor_ = FileSystemWatcher::monitor(filename);
5548 // file_monitor_ will be destroyed with *this, so it is not going to call a
5549 // destroyed object method.
5550 file_monitor_->connect([this](bool exists) {
5551 fileExternallyModified(exists);
5556 void Buffer::Impl::fileExternallyModified(bool const exists)
5558 // ignore notifications after our own saving operations
5559 if (checksum_ == filename.checksum()) {
5560 LYXERR(Debug::FILES, "External modification but "
5561 "checksum unchanged: " << filename);
5564 // If the file has been deleted, only mark the file as dirty since it is
5565 // pointless to prompt for reloading. If later a file is moved into this
5566 // location, then the externally modified warning will appear then.
5568 externally_modified_ = true;
5569 // Update external modification notification.
5570 // Dirty buffers must be visible at all times.
5571 if (wa_ && wa_->unhide(owner_))
5572 wa_->updateTitles();
5574 // Unable to unhide the buffer (e.g. no GUI or not current View)
5579 bool Buffer::notifiesExternalModification() const
5581 return d->externally_modified_;
5585 void Buffer::clearExternalModification() const
5587 d->externally_modified_ = false;
5589 d->wa_->updateTitles();
5593 void Buffer::pushIncludedBuffer(Buffer const * buf) const
5595 masterBuffer()->d->include_list_.push_back(buf);
5596 if (lyxerr.debugging(Debug::FILES)) {
5597 LYXERR0("Pushed. Stack now:");
5598 if (masterBuffer()->d->include_list_.empty())
5601 for (auto const & b : masterBuffer()->d->include_list_)
5602 LYXERR0(b->fileName());
5607 void Buffer::popIncludedBuffer() const
5609 masterBuffer()->d->include_list_.pop_back();
5610 if (lyxerr.debugging(Debug::FILES)) {
5611 LYXERR0("Popped. Stack now:");
5612 if (masterBuffer()->d->include_list_.empty())
5615 for (auto const & b : masterBuffer()->d->include_list_)
5616 LYXERR0(b->fileName());
5621 bool Buffer::isBufferIncluded(Buffer const * buf) const
5625 if (lyxerr.debugging(Debug::FILES)) {
5626 LYXERR0("Checking for " << buf->fileName() << ". Stack now:");
5627 if (masterBuffer()->d->include_list_.empty())
5630 for (auto const & b : masterBuffer()->d->include_list_)
5631 LYXERR0(b->fileName());
5633 list<Buffer const *> const & blist = masterBuffer()->d->include_list_;
5634 return find(blist.begin(), blist.end(), buf) != blist.end();
5638 void Buffer::clearIncludeList() const
5640 LYXERR(Debug::FILES, "Clearing include list for " << fileName());
5641 d->include_list_.clear();