3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Stefan Schimanski
9 * Full author contact details are available in file CREDITS.
17 #include "BiblioInfo.h"
18 #include "BranchList.h"
19 #include "buffer_funcs.h"
20 #include "BufferList.h"
21 #include "BufferParams.h"
25 #include "Converter.h"
28 #include "CutAndPaste.h"
29 #include "DispatchResult.h"
30 #include "DocIterator.h"
31 #include "BufferEncodings.h"
32 #include "ErrorList.h"
35 #include "FuncRequest.h"
36 #include "FuncStatus.h"
37 #include "IndicesList.h"
38 #include "InsetIterator.h"
39 #include "InsetList.h"
41 #include "LaTeXFeatures.h"
45 #include "LyXAction.h"
50 #include "output_latex.h"
51 #include "output_docbook.h"
52 #include "output_plaintext.h"
53 #include "output_xhtml.h"
54 #include "Paragraph.h"
55 #include "ParagraphParameters.h"
56 #include "ParIterator.h"
57 #include "PDFOptions.h"
59 #include "SpellChecker.h"
61 #include "texstream.h"
64 #include "TextClass.h"
65 #include "TocBackend.h"
67 #include "VCBackend.h"
69 #include "WordLangTuple.h"
71 #include "insets/InsetBranch.h"
72 #include "insets/InsetInclude.h"
73 #include "insets/InsetText.h"
75 #include "mathed/InsetMathHull.h"
76 #include "mathed/MacroTable.h"
77 #include "mathed/InsetMathMacroTemplate.h"
78 #include "mathed/MathSupport.h"
80 #include "graphics/PreviewLoader.h"
82 #include "frontends/Application.h"
83 #include "frontends/alert.h"
84 #include "frontends/Delegates.h"
85 #include "frontends/WorkAreaManager.h"
87 #include "support/lassert.h"
88 #include "support/convert.h"
89 #include "support/debug.h"
90 #include "support/docstring_list.h"
91 #include "support/ExceptionMessage.h"
92 #include "support/FileMonitor.h"
93 #include "support/FileName.h"
94 #include "support/FileNameList.h"
95 #include "support/filetools.h"
96 #include "support/gettext.h"
97 #include "support/gzstream.h"
98 #include "support/lstrings.h"
99 #include "support/mutex.h"
100 #include "support/os.h"
101 #include "support/Package.h"
102 #include "support/PathChanger.h"
103 #include "support/Systemcall.h"
104 #include "support/TempFile.h"
105 #include "support/textutils.h"
106 #include "support/types.h"
118 using namespace lyx::support;
119 using namespace lyx::graphics;
123 namespace Alert = frontend::Alert;
124 namespace os = support::os;
128 int const LYX_FORMAT = LYX_FORMAT_LYX;
130 typedef map<string, bool> DepClean;
132 // Information about labels and their associated refs
137 InsetLabel const * inset;
138 /// associated references cache
139 Buffer::References references;
140 /// whether this label is active (i.e., not deleted)
144 typedef vector<LabelInfo> LabelCache;
146 typedef map<docstring, Buffer::References> RefCache;
148 // A storehouse for the cloned buffers.
149 typedef list<CloneList_ptr> CloneStore;
150 CloneStore cloned_buffers;
159 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
163 delete preview_loader_;
171 /// search for macro in local (buffer) table or in children
172 MacroData const * getBufferMacro(docstring const & name,
173 DocIterator const & pos) const;
175 /// Update macro table starting with position of it \param it in some
177 void updateMacros(DocIterator & it, DocIterator & scope);
179 void setLabel(ParIterator & it, UpdateType utype) const;
181 /** If we have branches that use the file suffix
182 feature, return the file name with suffix appended.
184 FileName exportFileName() const;
191 mutable TexRow texrow;
193 /// need to regenerate .tex?
196 /// name of the file the buffer is associated with.
200 mutable TocBackend toc_backend;
205 ScopeMacro(DocIterator const & s, MacroData const & m)
206 : scope(s), macro(m) {}
210 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
211 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
212 /// map from the macro name to the position map,
213 /// which maps the macro definition position to the scope and the MacroData.
214 NamePositionScopeMacroMap macros;
216 /// positions of child buffers in the buffer
217 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
219 ScopeBuffer() : buffer(nullptr) {}
220 ScopeBuffer(DocIterator const & s, Buffer const * b)
221 : scope(s), buffer(b) {}
223 Buffer const * buffer;
225 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
226 /// position of children buffers in this buffer
227 BufferPositionMap children_positions;
228 /// map from children inclusion positions to their scope and their buffer
229 PositionScopeBufferMap position_to_children;
231 /// Contains the old buffer filePath() while saving-as, or the
232 /// directory where the document was last saved while loading.
235 /** Keeps track of the path of local layout files.
236 * If possible, it is always relative to the buffer path.
237 * Empty for layouts in system or user directory.
239 string layout_position;
241 /// Container for all sort of Buffer dependant errors.
242 map<string, ErrorList> errorLists;
244 /// checksum used to test if the file has been externally modified. Used to
245 /// double check whether the file had been externally modified when saving.
246 unsigned long checksum_;
249 frontend::WorkAreaManager * wa_;
251 frontend::GuiBufferDelegate * gui_;
256 /// A cache for the bibfiles (including bibfiles of loaded child
257 /// documents), needed for appropriate update of natbib labels.
258 mutable docstring_list bibfiles_cache_;
260 // FIXME The caching mechanism could be improved. At present, we have a
261 // cache for each Buffer, that caches all the bibliography info for that
262 // Buffer. A more efficient solution would be to have a global cache per
263 // file, and then to construct the Buffer's bibinfo from that.
264 /// A cache for bibliography info
265 mutable BiblioInfo bibinfo_;
266 /// Cache of timestamps of .bib files
267 map<FileName, time_t> bibfile_status_;
269 /// These two hold the file name and format, written to by
270 /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
271 FileName preview_file_;
272 string preview_format_;
274 /// Cache the references associated to a label and their positions
276 mutable RefCache ref_cache_;
277 /// Cache the label insets and their activity status.
278 mutable LabelCache label_cache_;
280 /// our Text that should be wrapped in an InsetText
284 PreviewLoader * preview_loader_;
286 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
287 /// This one is useful for preview detached in a thread.
288 Buffer const * cloned_buffer_;
290 CloneList_ptr clone_list_;
293 std::list<Buffer const *> include_list_;
295 /// So we can force access via the accessors.
296 mutable Buffer const * parent_buffer;
298 FileMonitorPtr file_monitor_;
300 /// ints and bools are all listed last so as to avoid alignment issues
302 /// original format of loaded file
305 /// are we in the process of exporting this buffer?
306 mutable bool doing_export;
308 /// If there was an error when previewing, on the next preview we do
309 /// a fresh compile (e.g. in case the user installed a package that
311 bool require_fresh_start_;
313 /// Indicates whether the bibinfo has changed since the last time
314 /// we ran updateBuffer(), i.e., whether citation labels may need
316 mutable bool cite_labels_valid_;
317 /// Do we have a bibliography environment?
318 mutable bool have_bibitems_;
321 mutable bool lyx_clean;
323 /// is autosave needed?
324 mutable bool bak_clean;
326 /// is this an unnamed file (New...)?
329 /// is this an internal bufffer?
330 bool internal_buffer;
335 /** Set to true only when the file is fully loaded.
336 * Used to prevent the premature generation of previews
337 * and by the citation inset.
339 bool file_fully_loaded;
341 /// if the file was originally loaded from an older format, do
342 /// we need to back it up still?
343 bool need_format_backup;
345 /// Ignore the parent (e.g. when exporting a child standalone)?
348 /// This seem to change the way Buffer::getMacro() works
349 mutable bool macro_lock;
351 /// has been externally modified? Can be reset by the user.
352 mutable bool externally_modified_;
354 /// whether the bibinfo cache is valid
355 mutable bool bibinfo_cache_valid_;
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().isnotefontcolor = false;
950 params().boxbgcolor = RGBColor(0xFF, 0, 0);
951 params().isboxbgcolor = false;
952 params().html_latex_start.clear();
953 params().html_latex_end.clear();
954 params().html_math_img_scale = 1.0;
955 params().output_sync_macro.erase();
956 params().setLocalLayout(docstring(), false);
957 params().setLocalLayout(docstring(), true);
958 params().biblio_opts.erase();
959 params().biblatex_bibstyle.erase();
960 params().biblatex_citestyle.erase();
961 params().multibib.erase();
962 params().lineno_opts.clear();
964 for (int i = 0; i < 4; ++i) {
965 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
966 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
969 ErrorList & errorList = d->errorLists["Parse"];
978 if (token == "\\end_header")
982 if (token == "\\begin_header") {
983 begin_header_line = line;
987 LYXERR(Debug::PARSER, "Handling document header token: `"
990 string const result =
991 params().readToken(lex, token, d->filename);
992 if (!result.empty()) {
993 if (token == "\\textclass") {
994 d->layout_position = result;
997 docstring const s = bformat(_("Unknown token: "
1000 lex.getDocString());
1001 errorList.push_back(ErrorItem(_("Document header error"), s));
1005 if (begin_header_line) {
1006 docstring const s = _("\\begin_header is missing");
1007 errorList.push_back(ErrorItem(_("Document header error"), s));
1010 params().shell_escape = theSession().shellescapeFiles().find(absFileName());
1012 params().makeDocumentClass(isClone(), isInternal());
1014 return unknown_tokens;
1019 // changed to be public and have one parameter
1020 // Returns true if "\end_document" is not read (Asger)
1021 bool Buffer::readDocument(Lexer & lex)
1023 ErrorList & errorList = d->errorLists["Parse"];
1026 // remove dummy empty par
1027 paragraphs().clear();
1029 if (!lex.checkFor("\\begin_document")) {
1030 docstring const s = _("\\begin_document is missing");
1031 errorList.push_back(ErrorItem(_("Document header error"), s));
1036 if (params().output_changes) {
1037 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1038 LaTeXFeatures::isAvailable("xcolor");
1041 Alert::warning(_("Changes not shown in LaTeX output"),
1042 _("Changes will not be highlighted in LaTeX output, "
1043 "because xcolor and ulem are not installed.\n"
1044 "Please install both packages or redefine "
1045 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1049 if (!parent() && !params().master.empty()) {
1050 FileName const master_file = makeAbsPath(params().master,
1051 onlyPath(absFileName()));
1052 if (isLyXFileName(master_file.absFileName())) {
1054 checkAndLoadLyXFile(master_file, true);
1056 // necessary e.g. after a reload
1057 // to re-register the child (bug 5873)
1058 // FIXME: clean up updateMacros (here, only
1059 // child registering is needed).
1060 master->updateMacros();
1061 // set master as master buffer, but only
1062 // if we are a real child
1063 if (master->isChild(this))
1065 // if the master is not fully loaded
1066 // it is probably just loading this
1067 // child. No warning needed then.
1068 else if (master->isFullyLoaded())
1069 LYXERR0("The master '"
1071 << "' assigned to this document ("
1073 << ") does not include "
1074 "this document. Ignoring the master assignment.");
1075 // If the master has just been created, un-hide it (#11162)
1076 if (!master->fileName().exists())
1077 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
1078 master->absFileName()));
1083 // assure we have a default index
1084 params().indiceslist().addDefault(B_("Index"));
1087 if (FileName::isAbsolute(params().origin))
1088 d->old_position = params().origin;
1090 d->old_position = filePath();
1095 bool const res = text().read(lex, errorList, d->inset);
1096 d->old_position.clear();
1098 // inform parent buffer about local macros
1100 Buffer const * pbuf = parent();
1101 for (auto const & m : usermacros)
1102 pbuf->usermacros.insert(m);
1106 updateMacroInstances(InternalUpdate);
1111 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1113 Format const * fmt = theFormats().getFormat(format);
1116 // It is important to use the correct extension here, since some
1117 // converters create a wrong output file otherwise (e.g. html2latex)
1118 FileName const name = tempFileName("Buffer_importStringXXXXXX." + fmt->extension());
1119 ofdocstream os(name.toFilesystemEncoding().c_str());
1120 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1121 bool const success = !(os << contents).fail();
1124 bool converted = false;
1126 params().compressed = false;
1128 // remove dummy empty par
1129 paragraphs().clear();
1131 converted = importFile(format, name, errorList);
1134 removeTempFile(name);
1139 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1141 if (!theConverters().isReachable(format, "lyx"))
1144 FileName const lyx = tempFileName("Buffer_importFileXXXXXX.lyx");
1145 Converters::RetVal const retval =
1146 theConverters().convert(nullptr, name, lyx, name, format, "lyx", errorList);
1147 if (retval == Converters::SUCCESS) {
1148 bool const success = readFile(lyx) == ReadSuccess;
1149 removeTempFile(lyx);
1157 bool Buffer::readString(string const & s)
1159 params().compressed = false;
1162 istringstream is(s);
1164 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1165 FileName const fn = tempfile.name();
1168 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1170 if (success && file_format != LYX_FORMAT) {
1171 // We need to call lyx2lyx, so write the input to a file
1172 ofstream os(fn.toFilesystemEncoding().c_str());
1175 // lyxvc in readFile
1176 if (readFile(fn) != ReadSuccess)
1180 if (readDocument(lex))
1186 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1189 if (!lex.setFile(fn)) {
1190 Alert::error(_("File Not Found"),
1191 bformat(_("Unable to open file `%1$s'."),
1192 from_utf8(fn.absFileName())));
1193 return ReadFileNotFound;
1197 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1198 if (ret_plf != ReadSuccess)
1201 if (file_format != LYX_FORMAT) {
1203 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1204 if (ret_clf != ReadSuccess)
1206 ret_clf = readFile(tmpFile);
1207 if (ret_clf == ReadSuccess) {
1208 d->file_format = file_format;
1209 d->need_format_backup = true;
1214 // FIXME: InsetInfo needs to know whether the file is under VCS
1215 // during the parse process, so this has to be done before.
1216 lyxvc().file_found_hook(d->filename);
1218 if (readDocument(lex)) {
1219 Alert::error(_("Document format failure"),
1220 bformat(_("%1$s ended unexpectedly, which means"
1221 " that it is probably corrupted."),
1222 from_utf8(fn.absFileName())));
1223 return ReadDocumentFailure;
1226 d->file_fully_loaded = true;
1227 d->read_only = !d->filename.isWritable();
1228 params().compressed = theFormats().isZippedFile(d->filename);
1234 bool Buffer::isFullyLoaded() const
1236 return d->file_fully_loaded;
1240 void Buffer::setFullyLoaded(bool value)
1242 d->file_fully_loaded = value;
1246 bool Buffer::freshStartRequired() const
1248 return d->require_fresh_start_;
1251 void Buffer::requireFreshStart(bool const b) const
1253 d->require_fresh_start_ = b;
1257 PreviewLoader * Buffer::loader() const
1259 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1261 if (!d->preview_loader_)
1262 d->preview_loader_ = new PreviewLoader(*this);
1263 return d->preview_loader_;
1267 void Buffer::removePreviews() const
1269 delete d->preview_loader_;
1270 d->preview_loader_ = nullptr;
1274 void Buffer::updatePreviews() const
1276 PreviewLoader * ploader = loader();
1280 InsetIterator it = begin(*d->inset);
1281 InsetIterator const itend = end(*d->inset);
1282 for (; it != itend; ++it)
1283 it->addPreview(it, *ploader);
1285 ploader->startLoading();
1289 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1290 FileName const & fn, int & file_format) const
1292 if(!lex.checkFor("\\lyxformat")) {
1293 Alert::error(_("Document format failure"),
1294 bformat(_("%1$s is not a readable LyX document."),
1295 from_utf8(fn.absFileName())));
1296 return ReadNoLyXFormat;
1302 // LyX formats 217 and earlier were written as 2.17. This corresponds
1303 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1304 // these cases. See also: www.lyx.org/trac/changeset/1313.
1305 size_t dot = tmp_format.find_first_of(".,");
1306 if (dot != string::npos)
1307 tmp_format.erase(dot, 1);
1309 file_format = convert<int>(tmp_format);
1314 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1315 FileName & tmpfile, int from_format)
1317 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1318 tempfile.setAutoRemove(false);
1319 tmpfile = tempfile.name();
1320 if(tmpfile.empty()) {
1321 Alert::error(_("Conversion failed"),
1322 bformat(_("%1$s is from a different"
1323 " version of LyX, but a temporary"
1324 " file for converting it could"
1325 " not be created."),
1326 from_utf8(fn.absFileName())));
1327 return LyX2LyXNoTempFile;
1330 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1331 if (lyx2lyx.empty()) {
1332 Alert::error(_("Conversion script not found"),
1333 bformat(_("%1$s is from a different"
1334 " version of LyX, but the"
1335 " conversion script lyx2lyx"
1336 " could not be found."),
1337 from_utf8(fn.absFileName())));
1338 return LyX2LyXNotFound;
1342 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1343 ostringstream command;
1344 command << os::python()
1345 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1346 << " -t " << convert<string>(LYX_FORMAT)
1347 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1348 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1349 string const command_str = command.str();
1351 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1353 cmd_ret const ret = runCommand(command_str);
1355 if (from_format < LYX_FORMAT) {
1356 Alert::error(_("Conversion script failed"),
1357 bformat(_("%1$s is from an older version"
1358 " of LyX and the lyx2lyx script"
1359 " failed to convert it."),
1360 from_utf8(fn.absFileName())));
1361 return LyX2LyXOlderFormat;
1363 Alert::error(_("Conversion script failed"),
1364 bformat(_("%1$s is from a newer version"
1365 " of LyX and the lyx2lyx script"
1366 " failed to convert it."),
1367 from_utf8(fn.absFileName())));
1368 return LyX2LyXNewerFormat;
1375 FileName Buffer::getBackupName() const {
1376 map<int, string> const file_formats = {
1393 FileName const & fn = fileName();
1394 string const fname = fn.onlyFileNameWithoutExt();
1395 string const fext = fn.extension() + "~";
1396 string const fpath = lyxrc.backupdir_path.empty() ?
1397 fn.onlyPath().absFileName() :
1398 lyxrc.backupdir_path;
1399 string backup_suffix;
1400 // If file format is from a stable series use version instead of file format
1401 auto const it = file_formats.find(d->file_format);
1402 if (it != file_formats.end())
1403 backup_suffix = "-lyx" + it->second;
1405 backup_suffix = "-lyxformat-" + convert<string>(d->file_format);
1406 string const backname = fname + backup_suffix;
1407 FileName backup(addName(fpath, addExtension(backname, fext)));
1409 // limit recursion, just in case
1411 unsigned long orig_checksum = 0;
1412 while (backup.exists() && v < 100) {
1413 if (orig_checksum == 0)
1414 orig_checksum = fn.checksum();
1415 unsigned long new_checksum = backup.checksum();
1416 if (orig_checksum == new_checksum) {
1417 LYXERR(Debug::FILES, "Not backing up " << fn <<
1418 "since " << backup << "has the same checksum.");
1419 // a bit of a hack, but we have to check this anyway
1420 // below, and setting this is simpler than introducing
1421 // a special boolean for this purpose.
1425 string const newbackname = backname + "-" + convert<string>(v);
1426 backup.set(addName(fpath, addExtension(newbackname, fext)));
1429 return v < 100 ? backup : FileName();
1433 // Should probably be moved to somewhere else: BufferView? GuiView?
1434 bool Buffer::save() const
1436 docstring const file = makeDisplayPath(absFileName(), 20);
1437 d->filename.refresh();
1439 // check the read-only status before moving the file as a backup
1440 if (d->filename.exists()) {
1441 bool const read_only = !d->filename.isWritable();
1443 Alert::warning(_("File is read-only"),
1444 bformat(_("The file %1$s cannot be written because it "
1445 "is marked as read-only."), file));
1450 // ask if the disk file has been externally modified (use checksum method)
1451 if (fileName().exists() && isChecksumModified()) {
1453 bformat(_("Document %1$s has been externally modified. "
1454 "Are you sure you want to overwrite this file?"), file);
1455 int const ret = Alert::prompt(_("Overwrite modified file?"),
1456 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1461 // We don't need autosaves in the immediate future. (Asger)
1462 resetAutosaveTimers();
1464 // if the file does not yet exist, none of the backup activity
1465 // that follows is necessary
1466 if (!fileName().exists()) {
1467 if (!writeFile(fileName()))
1473 // we first write the file to a new name, then move it to its
1474 // proper location once that has been done successfully. that
1475 // way we preserve the original file if something goes wrong.
1476 string const justname = fileName().onlyFileNameWithoutExt();
1477 auto tempfile = lyx::make_unique<TempFile>(fileName().onlyPath(),
1478 justname + "-XXXXXX.lyx");
1479 bool const symlink = fileName().isSymLink();
1481 tempfile->setAutoRemove(false);
1483 FileName savefile(tempfile->name());
1484 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1485 if (!savefile.clonePermissions(fileName()))
1486 LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
1488 if (!writeFile(savefile))
1491 // we will set this to false if we fail
1492 bool made_backup = true;
1494 FileName backupName;
1495 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1497 if (d->need_format_backup)
1498 backupName = getBackupName();
1500 // If we for some reason failed to find a backup name in case of
1501 // a format change, this will still set one. It's the best we can
1503 if (backupName.empty()) {
1504 backupName.set(fileName().absFileName() + "~");
1505 if (!lyxrc.backupdir_path.empty()) {
1506 string const mangledName =
1507 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1508 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1512 LYXERR(Debug::FILES, "Backing up original file to " <<
1513 backupName.absFileName());
1514 // Except file is symlink do not copy because of #6587.
1515 // Hard links have bad luck.
1516 made_backup = symlink ?
1517 fileName().copyTo(backupName):
1518 fileName().moveTo(backupName);
1521 Alert::error(_("Backup failure"),
1522 bformat(_("Cannot create backup file %1$s.\n"
1523 "Please check whether the directory exists and is writable."),
1524 from_utf8(backupName.absFileName())));
1525 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1526 } else if (d->need_format_backup) {
1527 // the original file has been backed up successfully, so we
1528 // will not need to do that again
1529 d->need_format_backup = false;
1533 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1534 // Only do this if tempfile is not in autoremove mode
1537 // If we have no symlink, we can simply rename the temp file.
1538 // Otherwise, we need to copy it so the symlink stays intact.
1539 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1540 savefile.moveTo(fileName()))
1542 // saveCheckSum() was already called by writeFile(), but the
1543 // time stamp is invalidated by copying/moving
1546 // the file associated with this buffer is now in the current format
1547 d->file_format = LYX_FORMAT;
1550 // else we saved the file, but failed to move it to the right location.
1552 if (needBackup && made_backup && !symlink) {
1553 // the original file was moved to some new location, so it will look
1554 // to the user as if it was deleted. (see bug #9234.) we could try
1555 // to restore it, but that would basically mean trying to do again
1556 // what we just failed to do. better to leave things as they are.
1557 Alert::error(_("Write failure"),
1558 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1559 "But LyX could not move it to:\n %2$s.\n"
1560 "Your original file has been backed up to:\n %3$s"),
1561 from_utf8(savefile.absFileName()),
1562 from_utf8(fileName().absFileName()),
1563 from_utf8(backupName.absFileName())));
1565 // either we did not try to make a backup, or else we tried and failed,
1566 // or else the original file was a symlink, in which case it was copied,
1567 // not moved. so the original file is intact.
1568 Alert::error(_("Write failure"),
1569 bformat(_("Cannot move saved file to:\n %1$s.\n"
1570 "But the file has successfully been saved as:\n %2$s."),
1571 from_utf8(fileName().absFileName()),
1572 from_utf8(savefile.absFileName())));
1578 bool Buffer::writeFile(FileName const & fname) const
1580 if (d->read_only && fname == d->filename)
1583 bool retval = false;
1585 docstring const str = bformat(_("Saving document %1$s..."),
1586 makeDisplayPath(fname.absFileName()));
1589 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1591 if (params().compressed) {
1592 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1593 retval = ofs && write(ofs);
1595 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1596 retval = ofs && write(ofs);
1600 message(str + _(" could not write file!"));
1605 // removeAutosaveFile();
1608 message(str + _(" done."));
1614 docstring Buffer::emergencyWrite() const
1616 // No need to save if the buffer has not changed.
1620 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1622 docstring user_message = bformat(
1623 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1625 // We try to save three places:
1626 // 1) Same place as document. Unless it is an unnamed doc.
1628 string s = absFileName();
1631 if (writeFile(FileName(s))) {
1633 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1634 return user_message;
1636 user_message += " " + _("Save failed! Trying again...\n");
1640 // 2) In HOME directory.
1641 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1643 lyxerr << ' ' << s << endl;
1644 if (writeFile(FileName(s))) {
1646 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1647 return user_message;
1650 user_message += " " + _("Save failed! Trying yet again...\n");
1652 // 3) In "/tmp" directory.
1653 // MakeAbsPath to prepend the current
1654 // drive letter on OS/2
1655 s = addName(package().temp_dir().absFileName(), absFileName());
1657 lyxerr << ' ' << s << endl;
1658 if (writeFile(FileName(s))) {
1660 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1661 return user_message;
1664 user_message += " " + _("Save failed! Document is lost.");
1667 return user_message;
1671 bool Buffer::write(ostream & ofs) const
1674 // Use the standard "C" locale for file output.
1675 ofs.imbue(locale::classic());
1678 // The top of the file should not be written by params().
1680 // write out a comment in the top of the file
1681 // Important: Keep the version formatting in sync with lyx2lyx and
1682 // tex2lyx (bug 7951)
1683 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1684 << " created this file. For more info see https://www.lyx.org/\n"
1685 << "\\lyxformat " << LYX_FORMAT << "\n"
1686 << "\\begin_document\n";
1688 /// For each author, set 'used' to true if there is a change
1689 /// by this author in the document; otherwise set it to 'false'.
1690 for (Author const & a : params().authors())
1693 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1694 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1695 for ( ; it != end; ++it)
1696 it->checkAuthors(params().authors());
1698 // now write out the buffer parameters.
1699 ofs << "\\begin_header\n";
1700 params().writeFile(ofs, this);
1701 ofs << "\\end_header\n";
1704 ofs << "\n\\begin_body\n";
1706 ofs << "\n\\end_body\n";
1708 // Write marker that shows file is complete
1709 ofs << "\\end_document" << endl;
1711 // Shouldn't really be needed....
1714 // how to check if close went ok?
1715 // Following is an attempt... (BE 20001011)
1717 // good() returns false if any error occurred, including some
1718 // formatting error.
1719 // bad() returns true if something bad happened in the buffer,
1720 // which should include file system full errors.
1725 lyxerr << "File was not closed properly." << endl;
1732 Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
1733 string const & original_path,
1734 OutputParams const & runparams_in,
1735 OutputWhat output) const
1737 OutputParams runparams = runparams_in;
1739 string const encoding = runparams.encoding->iconvName();
1740 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1743 try { ofs.reset(encoding); }
1744 catch (iconv_codecvt_facet_exception const & e) {
1745 lyxerr << "Caught iconv exception: " << e.what() << endl;
1746 Alert::error(_("Iconv software exception Detected"),
1747 bformat(_("Please verify that the `iconv' support software is"
1748 " properly installed and supports the selected encoding"
1749 " (%1$s), or change the encoding in"
1750 " Document>Settings>Language."), from_ascii(encoding)));
1753 if (!openFileWrite(ofs, fname))
1756 ErrorList & errorList = d->errorLists["Export"];
1758 ExportStatus status = ExportSuccess;
1761 // make sure we are ready to export
1762 // this needs to be done before we validate
1763 // FIXME Do we need to do this all the time? I.e., in children
1764 // of a master we are exporting?
1766 updateMacroInstances(OutputUpdate);
1768 ExportStatus retval;
1770 retval = writeLaTeXSource(os, original_path, runparams, output);
1771 if (retval == ExportKilled)
1772 return ExportKilled;
1774 catch (EncodingException const & e) {
1775 docstring const failed(1, e.failed_char);
1777 oss << "0x" << hex << static_cast<uint32_t>(e.failed_char) << dec;
1778 if (getParFromID(e.par_id).paragraph().layout().pass_thru) {
1779 docstring msg = bformat(_("Uncodable character '%1$s'"
1780 " (code point %2$s)"),
1781 failed, from_utf8(oss.str()));
1782 errorList.push_back(ErrorItem(msg, _("Some characters of your document are not "
1783 "representable in specific verbatim contexts.\n"
1784 "Changing the document encoding to utf8 could help."),
1785 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1787 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1788 " (code point %2$s)"),
1789 failed, from_utf8(oss.str()));
1790 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1791 "representable in the chosen encoding.\n"
1792 "Changing the document encoding to utf8 could help."),
1793 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1795 status = ExportError;
1797 catch (iconv_codecvt_facet_exception const & e) {
1798 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1800 status = ExportError;
1802 catch (exception const & e) {
1803 errorList.push_back(ErrorItem(_("conversion failed"),
1805 lyxerr << e.what() << endl;
1806 status = ExportError;
1809 lyxerr << "Caught some really weird exception..." << endl;
1813 d->texrow = move(os.texrow());
1817 status = ExportError;
1818 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1821 if (runparams_in.silent)
1829 Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
1830 string const & original_path,
1831 OutputParams const & runparams_in,
1832 OutputWhat output) const
1834 // The child documents, if any, shall be already loaded at this point.
1836 OutputParams runparams = runparams_in;
1838 // Some macros rely on font encoding
1839 runparams.main_fontenc = params().main_font_encoding();
1841 // If we are compiling a file standalone, even if this is the
1842 // child of some other buffer, let's cut the link here, so the
1843 // file is really independent and no concurring settings from
1844 // the master (e.g. branch state) interfere (see #8100).
1845 if (!runparams.is_child)
1846 d->ignore_parent = true;
1848 // Classify the unicode characters appearing in math insets
1849 BufferEncodings::initUnicodeMath(*this);
1851 // validate the buffer.
1852 LYXERR(Debug::LATEX, " Validating buffer...");
1853 LaTeXFeatures features(*this, params(), runparams);
1855 // This is only set once per document (in master)
1856 if (!runparams.is_child) {
1857 runparams.use_polyglossia = features.usePolyglossia();
1858 runparams.use_hyperref = features.isRequired("hyperref");
1859 runparams.use_CJK = features.mustProvide("CJK");
1861 LYXERR(Debug::LATEX, " Buffer validation done.");
1863 bool const output_preamble =
1864 output == FullSource || output == OnlyPreamble;
1865 bool const output_body =
1866 output == FullSource || output == OnlyBody;
1868 // The starting paragraph of the coming rows is the
1869 // first paragraph of the document. (Asger)
1870 if (output_preamble && runparams.nice) {
1871 os << "%% LyX " << lyx_version << " created this file. "
1872 "For more info, see https://www.lyx.org/.\n"
1873 "%% Do not edit unless you really know what "
1876 LYXERR(Debug::INFO, "lyx document header finished");
1878 // There are a few differences between nice LaTeX and usual files:
1879 // usual files have \batchmode and special input@path to allow
1880 // inclusion of figures specified by an explicitly relative path
1881 // (i.e., a path starting with './' or '../') with either \input or
1882 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1883 // input@path is set when the actual parameter original_path is set.
1884 // This is done for usual tex-file, but not for nice-latex-file.
1885 // (Matthias 250696)
1886 // Note that input@path is only needed for something the user does
1887 // in the preamble, included .tex files or ERT, files included by
1888 // LyX work without it.
1889 if (output_preamble) {
1890 if (!runparams.nice) {
1891 // code for usual, NOT nice-latex-file
1892 os << "\\batchmode\n"; // changed from \nonstopmode
1894 if (!original_path.empty()) {
1896 // We don't know the encoding of inputpath
1897 docstring const inputpath = from_utf8(original_path);
1898 docstring uncodable_glyphs;
1899 Encoding const * const enc = runparams.encoding;
1901 for (char_type n : inputpath) {
1902 if (!enc->encodable(n)) {
1903 docstring const glyph(1, n);
1904 LYXERR0("Uncodable character '"
1906 << "' in input path!");
1907 uncodable_glyphs += glyph;
1912 // warn user if we found uncodable glyphs.
1913 if (!uncodable_glyphs.empty()) {
1914 frontend::Alert::warning(
1915 _("Uncodable character in file path"),
1917 _("The path of your document\n"
1919 "contains glyphs that are unknown "
1920 "in the current document encoding "
1921 "(namely %2$s). This may result in "
1922 "incomplete output, unless "
1923 "TEXINPUTS contains the document "
1924 "directory and you don't use "
1925 "explicitly relative paths (i.e., "
1926 "paths starting with './' or "
1927 "'../') in the preamble or in ERT."
1928 "\n\nIn case of problems, choose "
1929 "an appropriate document encoding\n"
1930 "(such as utf8) or change the "
1932 inputpath, uncodable_glyphs));
1934 string docdir = os::latex_path(original_path);
1935 if (contains(docdir, '#')) {
1936 docdir = subst(docdir, "#", "\\#");
1937 os << "\\catcode`\\#=11"
1938 "\\def\\#{#}\\catcode`\\#=6\n";
1940 if (contains(docdir, '%')) {
1941 docdir = subst(docdir, "%", "\\%");
1942 os << "\\catcode`\\%=11"
1943 "\\def\\%{%}\\catcode`\\%=14\n";
1945 if (contains(docdir, '~'))
1946 docdir = subst(docdir, "~", "\\string~");
1947 bool const nonascii = !isAscii(from_utf8(docdir));
1948 // LaTeX 2019/10/01 handles non-ascii path without detokenize
1949 bool const utfpathlatex = features.isAvailable("LaTeX-2019/10/01");
1950 bool const detokenize = !utfpathlatex && nonascii;
1951 bool const quote = contains(docdir, ' ');
1952 if (utfpathlatex && nonascii)
1953 os << "\\UseRawInputEncoding\n";
1954 os << "\\makeatletter\n"
1955 << "\\def\\input@path{{";
1957 os << "\\detokenize{";
1966 << "\\makeatother\n";
1970 // get parent macros (if this buffer has a parent) which will be
1971 // written at the document begin further down.
1972 MacroSet parentMacros;
1973 listParentMacros(parentMacros, features);
1975 // Write the preamble
1976 runparams.use_babel = params().writeLaTeX(os, features,
1977 d->filename.onlyPath());
1979 // Active characters
1980 runparams.active_chars = features.getActiveChars();
1982 // Biblatex bibliographies are loaded here
1983 if (params().useBiblatex()) {
1984 vector<pair<docstring, string>> const bibfiles =
1985 prepareBibFilePaths(runparams, getBibfiles(), true);
1986 for (pair<docstring, string> const & file: bibfiles) {
1987 os << "\\addbibresource";
1988 if (!file.second.empty())
1989 os << "[bibencoding=" << file.second << "]";
1990 os << "{" << file.first << "}\n";
1994 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1995 && !features.hasOnlyPolyglossiaLanguages()) {
1998 vector<string> bll = features.getBabelExclusiveLanguages();
1999 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
2002 for (string const & sit : bll) {
2007 blangs = bll.size() > 1 ?
2008 bformat(_("The languages %1$s are only supported by Babel."), langs)
2009 : bformat(_("The language %1$s is only supported by Babel."), langs);
2013 for (string const & pit : pll) {
2018 plangs = pll.size() > 1 ?
2019 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
2020 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
2021 if (!blangs.empty())
2025 frontend::Alert::warning(
2026 _("Incompatible Languages!"),
2028 _("You cannot use the following languages "
2029 "together in one LaTeX document because "
2030 "they require conflicting language packages:\n"
2035 // Japanese might be required only in some children of a document,
2036 // but once required, we must keep use_japanese true.
2037 runparams.use_japanese |= features.isRequired("japanese");
2040 // Restore the parenthood if needed
2041 if (!runparams.is_child)
2042 d->ignore_parent = false;
2043 return ExportSuccess;
2047 // mark the beginning of the body to separate it from InPreamble insets
2048 os.texrow().start(TexRow::beginDocument());
2049 os << "\\begin{document}\n";
2051 // mark the start of a new paragraph by simulating a newline,
2052 // so that os.afterParbreak() returns true at document start
2055 // output the parent macros
2056 for (auto const & mac : parentMacros) {
2057 int num_lines = mac->write(os.os(), true);
2058 os.texrow().newlines(num_lines);
2061 } // output_preamble
2063 LYXERR(Debug::INFO, "preamble finished, now the body.");
2067 latexParagraphs(*this, text(), os, runparams);
2069 catch (ConversionException const &) { return ExportKilled; }
2071 // Restore the parenthood if needed
2072 if (!runparams.is_child)
2073 d->ignore_parent = false;
2075 // add this just in case after all the paragraphs
2078 if (output_preamble) {
2079 os << "\\end{document}\n";
2080 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
2082 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
2084 runparams_in.encoding = runparams.encoding;
2086 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2087 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2088 return ExportSuccess;
2092 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2093 OutputParams const & runparams,
2094 OutputWhat output) const
2096 LYXERR(Debug::LATEX, "makeDocBookFile...");
2099 if (!openFileWrite(ofs, fname))
2102 // make sure we are ready to export
2103 // this needs to be done before we validate
2105 updateMacroInstances(OutputUpdate);
2107 ExportStatus const retval =
2108 writeDocBookSource(ofs, runparams, output);
2109 if (retval == ExportKilled)
2110 return ExportKilled;
2114 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2115 return ExportSuccess;
2119 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os,
2120 OutputParams const & runparams,
2121 OutputWhat output) const
2123 LaTeXFeatures features(*this, params(), runparams);
2125 d->bibinfo_.makeCitationLabels(*this);
2129 DocumentClass const & tclass = params().documentClass();
2131 bool const output_preamble =
2132 output == FullSource || output == OnlyPreamble;
2133 bool const output_body =
2134 output == FullSource || output == OnlyBody || output == IncludedFile;
2136 if (output_preamble) {
2137 // XML preamble, no doctype needed.
2138 // Not using XMLStream for this, as the root tag would be in the tag stack and make troubles with the error
2139 // detection mechanisms (these are called before the end tag is output, and thus interact with the canary
2140 // parsep in output_docbook.cpp).
2141 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2142 << "<!-- This DocBook file was created by LyX " << lyx_version
2143 << "\n See https://www.lyx.org/ for more information -->\n";
2145 // Directly output the root tag, based on the current type of document.
2146 string languageCode = params().language->code();
2147 string params = "xml:lang=\"" + languageCode + '"'
2148 + " xmlns=\"http://docbook.org/ns/docbook\""
2149 + " xmlns:xlink=\"http://www.w3.org/1999/xlink\""
2150 + " xmlns:m=\"http://www.w3.org/1998/Math/MathML\""
2151 + " xmlns:xi=\"http://www.w3.org/2001/XInclude\""
2152 + " version=\"5.2\"";
2154 os << "<" << from_ascii(tclass.docbookroot()) << " " << from_ascii(params) << ">\n";
2158 // Start to output the document.
2160 docbookParagraphs(text(), *this, xs, runparams);
2163 if (output_preamble) {
2164 // Close the root element. No need for a line break, as free text is never allowed
2165 // in a root element, it must always be wrapped in some container.
2166 os << "</" << from_ascii(tclass.docbookroot()) << ">";
2169 return ExportSuccess;
2173 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2174 OutputParams const & runparams) const
2176 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2179 if (!openFileWrite(ofs, fname))
2182 // make sure we are ready to export
2183 // this has to be done before we validate
2184 updateBuffer(UpdateMaster, OutputUpdate);
2185 updateMacroInstances(OutputUpdate);
2187 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2188 if (retval == ExportKilled)
2193 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2198 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2199 OutputParams const & runparams,
2200 OutputWhat output) const
2202 LaTeXFeatures features(*this, params(), runparams);
2204 d->bibinfo_.makeCitationLabels(*this);
2206 bool const output_preamble =
2207 output == FullSource || output == OnlyPreamble;
2208 bool const output_body =
2209 output == FullSource || output == OnlyBody || output == IncludedFile;
2211 if (output_preamble) {
2212 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2213 << "<!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"
2214 // FIXME Language should be set properly.
2215 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2217 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2218 // FIXME Presumably need to set this right
2219 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2221 docstring const & doctitle = features.htmlTitle();
2223 << (doctitle.empty() ?
2224 from_ascii("LyX Document") :
2225 xml::escapeString(doctitle, XMLStream::ESCAPE_ALL))
2228 docstring styles = features.getTClassHTMLPreamble();
2229 if (!styles.empty())
2230 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2232 // we will collect CSS information in a stream, and then output it
2233 // either here, as part of the header, or else in a separate file.
2234 odocstringstream css;
2235 styles = features.getCSSSnippets();
2236 if (!styles.empty())
2237 css << "/* LyX Provided Styles */\n" << styles << '\n';
2239 styles = features.getTClassHTMLStyles();
2240 if (!styles.empty())
2241 css << "/* Layout-provided Styles */\n" << styles << '\n';
2243 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2244 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2245 if (needfg || needbg) {
2246 css << "\nbody {\n";
2249 << from_ascii(X11hexname(params().fontcolor))
2252 css << " background-color: "
2253 << from_ascii(X11hexname(params().backgroundcolor))
2258 docstring const dstyles = css.str();
2259 if (!dstyles.empty()) {
2260 bool written = false;
2261 if (params().html_css_as_file) {
2262 // open a file for CSS info
2264 string const fcssname = addName(temppath(), "docstyle.css");
2265 FileName const fcssfile = FileName(fcssname);
2266 if (openFileWrite(ocss, fcssfile)) {
2270 // write link to header
2271 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2273 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2276 // we are here if the CSS is supposed to be written to the header
2277 // or if we failed to write it to an external file.
2279 os << "<style type='text/css'>\n"
2288 bool const output_body_tag = (output != IncludedFile);
2289 if (output_body_tag)
2290 os << "<body dir=\"auto\">\n";
2292 if (output != IncludedFile)
2293 // if we're an included file, the counters are in the master.
2294 params().documentClass().counters().reset();
2296 xhtmlParagraphs(text(), *this, xs, runparams);
2298 catch (ConversionException const &) { return ExportKilled; }
2299 if (output_body_tag)
2303 if (output_preamble)
2306 return ExportSuccess;
2310 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2311 // Other flags: -wall -v0 -x
2312 int Buffer::runChktex()
2316 // get LaTeX-Filename
2317 FileName const path(temppath());
2318 string const name = addName(path.absFileName(), latexName());
2319 string const org_path = filePath();
2321 PathChanger p(path); // path to LaTeX file
2322 message(_("Running chktex..."));
2324 // Generate the LaTeX file if neccessary
2325 OutputParams runparams(¶ms().encoding());
2326 runparams.flavor = Flavor::LaTeX;
2327 runparams.nice = false;
2328 runparams.linelen = lyxrc.plaintext_linelen;
2329 ExportStatus const retval =
2330 makeLaTeXFile(FileName(name), org_path, runparams);
2331 if (retval != ExportSuccess) {
2332 // error code on failure
2337 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2338 int const res = chktex.run(terr); // run chktex
2341 Alert::error(_("chktex failure"),
2342 _("Could not run chktex successfully."));
2344 ErrorList & errlist = d->errorLists["ChkTeX"];
2346 bufferErrors(terr, errlist);
2351 if (runparams.silent)
2352 d->errorLists["ChkTeX"].clear();
2360 void Buffer::validate(LaTeXFeatures & features) const
2362 // Validate the buffer params, but not for included
2363 // files, since they also use the parent buffer's
2365 if (!features.runparams().is_child)
2366 params().validate(features);
2371 for (Paragraph const & p : paragraphs())
2372 p.validate(features);
2374 if (lyxerr.debugging(Debug::LATEX)) {
2375 features.showStruct();
2380 void Buffer::getLabelList(vector<docstring> & list) const
2382 // If this is a child document, use the master's list instead.
2384 masterBuffer()->getLabelList(list);
2389 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2390 for (auto const & tocit : *toc) {
2391 if (tocit.depth() == 0)
2392 list.push_back(tocit.str());
2397 void Buffer::invalidateBibinfoCache() const
2399 d->bibinfo_cache_valid_ = false;
2400 d->cite_labels_valid_ = false;
2401 removeBiblioTempFiles();
2402 // also invalidate the cache for the parent buffer
2403 Buffer const * const pbuf = d->parent();
2405 pbuf->invalidateBibinfoCache();
2409 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2411 // FIXME This is probably unnecessary, given where we call this.
2412 // If this is a child document, use the master instead.
2413 Buffer const * const pbuf = masterBuffer();
2414 if (pbuf != this && scope != UpdateChildOnly)
2415 return pbuf->getBibfiles();
2417 // In 2.3.x, we have:
2418 //if (!d->bibfile_cache_valid_)
2419 // this->updateBibfilesCache(scope);
2420 // I think that is a leftover, but there have been so many back-
2421 // and-forths with this, due to Windows issues, that I am not sure.
2423 return d->bibfiles_cache_;
2427 BiblioInfo const & Buffer::masterBibInfo() const
2429 Buffer const * const tmp = masterBuffer();
2431 return tmp->masterBibInfo();
2436 BiblioInfo const & Buffer::bibInfo() const
2442 void Buffer::registerBibfiles(const docstring_list & bf) const
2444 // We register the bib files in the master buffer,
2445 // if there is one, but also in every single buffer,
2446 // in case a child is compiled alone.
2447 Buffer const * const tmp = masterBuffer();
2449 tmp->registerBibfiles(bf);
2451 for (auto const & p : bf) {
2452 docstring_list::const_iterator temp =
2453 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2454 if (temp == d->bibfiles_cache_.end())
2455 d->bibfiles_cache_.push_back(p);
2460 static map<docstring, FileName> bibfileCache;
2462 FileName Buffer::getBibfilePath(docstring const & bibid) const
2464 map<docstring, FileName>::const_iterator it =
2465 bibfileCache.find(bibid);
2466 if (it != bibfileCache.end()) {
2467 // i.e., return bibfileCache[bibid];
2471 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2472 string const texfile = changeExtension(to_utf8(bibid), "bib");
2473 // we need to check first if this file exists where it's said to be.
2474 // there's a weird bug that occurs otherwise: if the file is in the
2475 // Buffer's directory but has the same name as some file that would be
2476 // found by kpsewhich, then we find the latter, not the former.
2477 FileName const local_file = makeAbsPath(texfile, filePath());
2478 FileName file = local_file;
2479 if (!file.exists()) {
2480 // there's no need now to check whether the file can be found
2482 file = findtexfile(texfile, "bib", true);
2486 LYXERR(Debug::FILES, "Found at: " << file);
2488 bibfileCache[bibid] = file;
2489 return bibfileCache[bibid];
2493 void Buffer::checkIfBibInfoCacheIsValid() const
2495 // use the master's cache
2496 Buffer const * const tmp = masterBuffer();
2498 tmp->checkIfBibInfoCacheIsValid();
2502 // If we already know the cache is invalid, stop here.
2503 // This is important in the case when the bibliography
2504 // environment (rather than Bib[la]TeX) is used.
2505 // In that case, the timestamp check below gives no
2506 // sensible result. Rather than that, the cache will
2507 // be invalidated explicitly via invalidateBibInfoCache()
2508 // by the Bibitem inset.
2509 // Same applies for bib encoding changes, which trigger
2510 // invalidateBibInfoCache() by InsetBibtex.
2511 if (!d->bibinfo_cache_valid_)
2514 if (d->have_bibitems_) {
2515 // We have a bibliography environment.
2516 // Invalidate the bibinfo cache unconditionally.
2517 // Cite labels will get invalidated by the inset if needed.
2518 d->bibinfo_cache_valid_ = false;
2522 // OK. This is with Bib(la)tex. We'll assume the cache
2523 // is valid and change this if we find changes in the bibs.
2524 d->bibinfo_cache_valid_ = true;
2525 d->cite_labels_valid_ = true;
2527 // compare the cached timestamps with the actual ones.
2528 docstring_list const & bibfiles_cache = getBibfiles();
2529 for (auto const & bf : bibfiles_cache) {
2530 FileName const fn = getBibfilePath(bf);
2531 time_t lastw = fn.lastModified();
2532 time_t prevw = d->bibfile_status_[fn];
2533 if (lastw != prevw) {
2534 d->bibinfo_cache_valid_ = false;
2535 d->cite_labels_valid_ = false;
2536 d->bibfile_status_[fn] = lastw;
2542 void Buffer::clearBibFileCache() const
2544 bibfileCache.clear();
2548 void Buffer::reloadBibInfoCache(bool const force) const
2550 // we should not need to do this for internal buffers
2554 // use the master's cache
2555 Buffer const * const tmp = masterBuffer();
2557 tmp->reloadBibInfoCache(force);
2562 checkIfBibInfoCacheIsValid();
2563 if (d->bibinfo_cache_valid_)
2567 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2568 // re-read file locations when this info changes
2569 // FIXME Is this sufficient? Or should we also force that
2570 // in some other cases? If so, then it is easy enough to
2571 // add the following line in some other places.
2572 clearBibFileCache();
2573 d->bibinfo_.clear();
2574 FileNameList checkedFiles;
2575 d->have_bibitems_ = false;
2576 collectBibKeys(checkedFiles);
2577 d->bibinfo_cache_valid_ = true;
2581 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2586 for (InsetIterator it = begin(inset()); it; ++it) {
2587 it->collectBibKeys(it, checkedFiles);
2588 if (it->lyxCode() == BIBITEM_CODE) {
2589 if (parent() != nullptr)
2590 parent()->d->have_bibitems_ = true;
2592 d->have_bibitems_ = true;
2598 void Buffer::addBiblioInfo(BiblioInfo const & bi_in) const
2600 // We add the biblio info to the parent buffer,
2601 // if there is one, but also to this buffer, in case
2602 // it is compiled alone.
2603 BiblioInfo & our_bi = d->bibinfo_;
2604 our_bi.mergeBiblioInfo(bi_in);
2607 parent()->addBiblioInfo(bi_in);
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 branch->setColors("background", "background");
2946 dr.screenUpdate(Update::Force);
2954 case LFUN_BRANCHES_RENAME: {
2955 if (func.argument().empty())
2958 docstring const oldname = from_utf8(func.getArg(0));
2959 docstring const newname = from_utf8(func.getArg(1));
2960 InsetIterator it = begin(inset());
2961 InsetIterator const itend = end(inset());
2962 bool success = false;
2963 for (; it != itend; ++it) {
2964 if (it->lyxCode() == BRANCH_CODE) {
2965 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2966 if (ins.branch() == oldname) {
2967 undo().recordUndo(CursorData(it));
2968 ins.rename(newname);
2973 if (it->lyxCode() == INCLUDE_CODE) {
2974 // get buffer of external file
2975 InsetInclude const & ins =
2976 static_cast<InsetInclude const &>(*it);
2977 Buffer * child = ins.loadIfNeeded();
2980 child->dispatch(func, dr);
2985 dr.screenUpdate(Update::Force);
2986 dr.forceBufferUpdate();
2991 case LFUN_BUFFER_VIEW_CACHE:
2992 if (!theFormats().view(*this, d->preview_file_,
2993 d->preview_format_))
2994 dr.setMessage(_("Error viewing the output file."));
2997 case LFUN_CHANGES_TRACK:
2998 if (params().save_transient_properties)
2999 undo().recordUndoBufferParams(CursorData());
3000 params().track_changes = !params().track_changes;
3003 case LFUN_CHANGES_OUTPUT:
3004 if (params().save_transient_properties)
3005 undo().recordUndoBufferParams(CursorData());
3006 params().output_changes = !params().output_changes;
3007 if (params().output_changes) {
3008 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3009 LaTeXFeatures::isAvailable("xcolor");
3012 Alert::warning(_("Changes not shown in LaTeX output"),
3013 _("Changes will not be highlighted in LaTeX output, "
3014 "because xcolor and ulem are not installed.\n"
3015 "Please install both packages or redefine "
3016 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3021 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3022 // turn compression on/off
3023 undo().recordUndoBufferParams(CursorData());
3024 params().compressed = !params().compressed;
3027 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3028 undo().recordUndoBufferParams(CursorData());
3029 params().output_sync = !params().output_sync;
3032 case LFUN_BUFFER_ANONYMIZE: {
3033 undo().recordUndoFullBuffer(CursorData());
3034 CursorData cur(doc_iterator_begin(this));
3035 for ( ; cur ; cur.forwardPar())
3036 cur.paragraph().anonymize();
3037 dr.forceBufferUpdate();
3038 dr.screenUpdate(Update::Force);
3046 dr.dispatched(dispatched);
3050 void Buffer::changeLanguage(Language const * from, Language const * to)
3052 LASSERT(from, return);
3053 LASSERT(to, return);
3055 ParIterator it = par_iterator_begin();
3056 ParIterator eit = par_iterator_end();
3057 for (; it != eit; ++it)
3058 it->changeLanguage(params(), from, to);
3062 bool Buffer::isMultiLingual() const
3064 ParConstIterator end = par_iterator_end();
3065 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3066 if (it->isMultiLingual(params()))
3073 std::set<Language const *> Buffer::getLanguages() const
3075 std::set<Language const *> langs;
3076 getLanguages(langs);
3081 void Buffer::getLanguages(std::set<Language const *> & langs) const
3083 ParConstIterator end = par_iterator_end();
3084 // add the buffer language, even if it's not actively used
3085 langs.insert(language());
3086 // iterate over the paragraphs
3087 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3088 it->getLanguages(langs);
3090 ListOfBuffers clist = getDescendants();
3091 for (auto const & cit : clist)
3092 cit->getLanguages(langs);
3096 DocIterator Buffer::getParFromID(int const id) const
3098 Buffer * buf = const_cast<Buffer *>(this);
3100 // This means non-existent
3101 return doc_iterator_end(buf);
3103 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3104 if (it.paragraph().id() == id)
3107 return doc_iterator_end(buf);
3111 bool Buffer::hasParWithID(int const id) const
3113 return !getParFromID(id).atEnd();
3117 ParIterator Buffer::par_iterator_begin()
3119 return ParIterator(doc_iterator_begin(this));
3123 ParIterator Buffer::par_iterator_end()
3125 return ParIterator(doc_iterator_end(this));
3129 ParConstIterator Buffer::par_iterator_begin() const
3131 return ParConstIterator(doc_iterator_begin(this));
3135 ParConstIterator Buffer::par_iterator_end() const
3137 return ParConstIterator(doc_iterator_end(this));
3140 bool Buffer::empty() const
3142 return paragraphs().size() == 1 && paragraphs().front().empty();
3146 Language const * Buffer::language() const
3148 return params().language;
3152 docstring Buffer::B_(string const & l10n) const
3154 return params().B_(l10n);
3158 bool Buffer::isClean() const
3160 return d->lyx_clean;
3164 bool Buffer::isChecksumModified() const
3166 LASSERT(d->filename.exists(), return false);
3167 return d->checksum_ != d->filename.checksum();
3171 void Buffer::saveCheckSum() const
3173 FileName const & file = d->filename;
3175 d->checksum_ = file.exists() ? file.checksum()
3176 : 0; // in the case of save to a new file.
3180 void Buffer::markClean() const
3182 if (!d->lyx_clean) {
3183 d->lyx_clean = true;
3186 // if the .lyx file has been saved, we don't need an
3188 d->bak_clean = true;
3189 d->undo_.markDirty();
3190 clearExternalModification();
3194 void Buffer::setUnnamed(bool flag)
3200 bool Buffer::isUnnamed() const
3207 /// Don't check unnamed, here: isInternal() is used in
3208 /// newBuffer(), where the unnamed flag has not been set by anyone
3209 /// yet. Also, for an internal buffer, there should be no need for
3210 /// retrieving fileName() nor for checking if it is unnamed or not.
3211 bool Buffer::isInternal() const
3213 return d->internal_buffer;
3217 void Buffer::setInternal(bool flag)
3219 d->internal_buffer = flag;
3223 void Buffer::markDirty()
3226 d->lyx_clean = false;
3229 d->bak_clean = false;
3231 for (auto & depit : d->dep_clean)
3232 depit.second = false;
3236 FileName Buffer::fileName() const
3242 string Buffer::absFileName() const
3244 return d->filename.absFileName();
3248 string Buffer::filePath() const
3250 string const abs = d->filename.onlyPath().absFileName();
3253 int last = abs.length() - 1;
3255 return abs[last] == '/' ? abs : abs + '/';
3259 DocFileName Buffer::getReferencedFileName(string const & fn) const
3262 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3263 result.set(fn, filePath());
3265 // filePath() ends with a path separator
3266 FileName const test(filePath() + fn);
3268 result.set(fn, filePath());
3270 result.set(fn, params().origin);
3277 string const Buffer::prepareFileNameForLaTeX(string const & name,
3278 string const & ext, bool nice) const
3280 string const fname = makeAbsPath(name, filePath()).absFileName();
3281 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3287 return to_utf8(makeRelPath(from_utf8(fname),
3288 from_utf8(masterBuffer()->filePath())));
3292 vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3293 docstring_list const & bibfilelist,
3294 bool const add_extension) const
3296 // If we are processing the LaTeX file in a temp directory then
3297 // copy the .bib databases to this temp directory, mangling their
3298 // names in the process. Store this mangled name in the list of
3300 // (We need to do all this because BibTeX *really*, *really*
3301 // can't handle "files with spaces" and Windows users tend to
3302 // use such filenames.)
3303 // Otherwise, store the (maybe absolute) path to the original,
3304 // unmangled database name.
3306 vector<pair<docstring, string>> res;
3308 // determine the export format
3309 string const tex_format = flavor2format(runparams.flavor);
3311 // check for spaces in paths
3312 bool found_space = false;
3314 for (auto const & bit : bibfilelist) {
3315 string utf8input = to_utf8(bit);
3317 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3318 FileName try_in_file =
3319 makeAbsPath(database + ".bib", filePath());
3320 bool not_from_texmf = try_in_file.isReadableFile();
3321 // If the file has not been found, try with the real file name
3322 // (it might come from a child in a sub-directory)
3323 if (!not_from_texmf) {
3324 try_in_file = getBibfilePath(bit);
3325 if (try_in_file.isReadableFile()) {
3326 // Check if the file is in texmf
3327 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3328 not_from_texmf = kpsefile.empty()
3329 || kpsefile.absFileName() != try_in_file.absFileName();
3331 // If this exists, make path relative to the master
3334 removeExtension(prepareFileNameForLaTeX(
3335 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3336 from_utf8(filePath()))),
3337 ".bib", runparams.nice));
3341 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3343 // mangledFileName() needs the extension
3344 DocFileName const in_file = DocFileName(try_in_file);
3345 database = removeExtension(in_file.mangledFileName());
3346 FileName const out_file = makeAbsPath(database + ".bib",
3347 masterBuffer()->temppath());
3348 bool const success = in_file.copyTo(out_file);
3350 LYXERR0("Failed to copy '" << in_file
3351 << "' to '" << out_file << "'");
3353 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3354 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3355 if (!isValidLaTeXFileName(database)) {
3356 frontend::Alert::warning(_("Invalid filename"),
3357 _("The following filename will cause troubles "
3358 "when running the exported file through LaTeX: ") +
3359 from_utf8(database));
3361 if (!isValidDVIFileName(database)) {
3362 frontend::Alert::warning(_("Problematic filename for DVI"),
3363 _("The following filename can cause troubles "
3364 "when running the exported file through LaTeX "
3365 "and opening the resulting DVI: ") +
3366 from_utf8(database), true);
3374 docstring const path = from_utf8(latex_path(database));
3376 if (contains(path, ' '))
3379 if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
3380 enc = params().bibFileEncoding(utf8input);
3382 bool recorded = false;
3383 for (auto const & pe : res) {
3384 if (pe.first == path) {
3391 res.push_back(make_pair(path, enc));
3394 // Check if there are spaces in the path and warn BibTeX users, if so.
3395 // (biber can cope with such paths)
3396 if (!prefixIs(runparams.bibtex_command, "biber")) {
3397 // Post this warning only once.
3398 static bool warned_about_spaces = false;
3399 if (!warned_about_spaces &&
3400 runparams.nice && found_space) {
3401 warned_about_spaces = true;
3402 Alert::warning(_("Export Warning!"),
3403 _("There are spaces in the paths to your BibTeX databases.\n"
3404 "BibTeX will be unable to find them."));
3413 string Buffer::layoutPos() const
3415 return d->layout_position;
3419 void Buffer::setLayoutPos(string const & path)
3422 d->layout_position.clear();
3426 LATTEST(FileName::isAbsolute(path));
3428 d->layout_position =
3429 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3431 if (d->layout_position.empty())
3432 d->layout_position = ".";
3436 bool Buffer::hasReadonlyFlag() const
3438 return d->read_only;
3442 bool Buffer::isReadonly() const
3444 return hasReadonlyFlag() || notifiesExternalModification();
3448 void Buffer::setParent(Buffer const * buffer)
3450 // We need to do some work here to avoid recursive parent structures.
3451 // This is the easy case.
3452 if (buffer == this) {
3453 LYXERR0("Ignoring attempt to set self as parent in\n" << fileName());
3456 // Now we check parents going upward, to make sure that IF we set the
3457 // parent as requested, we would not generate a recursive include.
3458 set<Buffer const *> sb;
3459 Buffer const * b = buffer;
3460 bool found_recursion = false;
3462 if (sb.find(b) != sb.end()) {
3463 found_recursion = true;
3470 if (found_recursion) {
3471 LYXERR0("Ignoring attempt to set parent of\n" <<
3474 buffer->fileName() <<
3475 "\nbecause that would create a recursive inclusion.");
3479 // We should be safe now.
3480 d->setParent(buffer);
3485 Buffer const * Buffer::parent() const
3491 ListOfBuffers Buffer::allRelatives() const
3493 ListOfBuffers lb = masterBuffer()->getDescendants();
3494 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3499 Buffer const * Buffer::masterBuffer() const
3501 Buffer const * const pbuf = d->parent();
3505 return pbuf->masterBuffer();
3509 bool Buffer::isChild(Buffer * child) const
3511 return d->children_positions.find(child) != d->children_positions.end();
3515 DocIterator Buffer::firstChildPosition(Buffer const * child)
3517 Impl::BufferPositionMap::iterator it;
3518 it = d->children_positions.find(child);
3519 if (it == d->children_positions.end())
3520 return DocIterator(this);
3525 bool Buffer::hasChildren() const
3527 return !d->children_positions.empty();
3531 void Buffer::collectChildren(ListOfBuffers & children, bool grand_children) const
3533 // loop over children
3534 for (auto const & p : d->children_positions) {
3535 Buffer * child = const_cast<Buffer *>(p.first);
3537 ListOfBuffers::const_iterator bit = find(children.begin(), children.end(), child);
3538 if (bit != children.end())
3540 children.push_back(child);
3542 // there might be grandchildren
3543 child->collectChildren(children, true);
3548 ListOfBuffers Buffer::getChildren() const
3551 collectChildren(v, false);
3552 // Make sure we have not included ourselves.
3553 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3554 if (bit != v.end()) {
3555 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3562 ListOfBuffers Buffer::getDescendants() const
3565 collectChildren(v, true);
3566 // Make sure we have not included ourselves.
3567 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3568 if (bit != v.end()) {
3569 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3576 template<typename M>
3577 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3582 typename M::const_iterator it = m.lower_bound(x);
3583 if (it == m.begin())
3591 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3592 DocIterator const & pos) const
3594 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3596 // if paragraphs have no macro context set, pos will be empty
3600 // we haven't found anything yet
3601 DocIterator bestPos = owner_->par_iterator_begin();
3602 MacroData const * bestData = nullptr;
3604 // find macro definitions for name
3605 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3606 if (nameIt != macros.end()) {
3607 // find last definition in front of pos or at pos itself
3608 PositionScopeMacroMap::const_iterator it
3609 = greatest_below(nameIt->second, pos);
3610 if (it != nameIt->second.end()) {
3612 // scope ends behind pos?
3613 if (pos < it->second.scope) {
3614 // Looks good, remember this. If there
3615 // is no external macro behind this,
3616 // we found the right one already.
3617 bestPos = it->first;
3618 bestData = &it->second.macro;
3622 // try previous macro if there is one
3623 if (it == nameIt->second.begin())
3630 // find macros in included files
3631 PositionScopeBufferMap::const_iterator it
3632 = greatest_below(position_to_children, pos);
3633 if (it == position_to_children.end())
3634 // no children before
3638 // do we know something better (i.e. later) already?
3639 if (it->first < bestPos )
3642 // scope ends behind pos?
3643 if (pos < it->second.scope
3644 && (cloned_buffer_ ||
3645 theBufferList().isLoaded(it->second.buffer))) {
3646 // look for macro in external file
3648 MacroData const * data
3649 = it->second.buffer->getMacro(name, false);
3652 bestPos = it->first;
3658 // try previous file if there is one
3659 if (it == position_to_children.begin())
3664 // return the best macro we have found
3669 MacroData const * Buffer::getMacro(docstring const & name,
3670 DocIterator const & pos, bool global) const
3675 // query buffer macros
3676 MacroData const * data = d->getBufferMacro(name, pos);
3677 if (data != nullptr)
3680 // If there is a master buffer, query that
3681 Buffer const * const pbuf = d->parent();
3683 d->macro_lock = true;
3684 MacroData const * macro = pbuf->getMacro(
3685 name, *this, false);
3686 d->macro_lock = false;
3692 data = MacroTable::globalMacros().get(name);
3693 if (data != nullptr)
3701 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3703 // set scope end behind the last paragraph
3704 DocIterator scope = par_iterator_begin();
3705 scope.pit() = scope.lastpit() + 1;
3707 return getMacro(name, scope, global);
3711 MacroData const * Buffer::getMacro(docstring const & name,
3712 Buffer const & child, bool global) const
3714 // look where the child buffer is included first
3715 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3716 if (it == d->children_positions.end())
3719 // check for macros at the inclusion position
3720 return getMacro(name, it->second, global);
3724 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3726 pit_type const lastpit = it.lastpit();
3728 // look for macros in each paragraph
3729 while (it.pit() <= lastpit) {
3730 Paragraph & par = it.paragraph();
3732 // iterate over the insets of the current paragraph
3733 for (auto const & insit : par.insetList()) {
3734 it.pos() = insit.pos;
3736 // is it a nested text inset?
3737 if (insit.inset->asInsetText()) {
3738 // Inset needs its own scope?
3739 InsetText const * itext = insit.inset->asInsetText();
3740 bool newScope = itext->isMacroScope();
3742 // scope which ends just behind the inset
3743 DocIterator insetScope = it;
3746 // collect macros in inset
3747 it.push_back(CursorSlice(*insit.inset));
3748 updateMacros(it, newScope ? insetScope : scope);
3753 if (insit.inset->asInsetTabular()) {
3754 CursorSlice slice(*insit.inset);
3755 size_t const numcells = slice.nargs();
3756 for (; slice.idx() < numcells; slice.forwardIdx()) {
3757 it.push_back(slice);
3758 updateMacros(it, scope);
3764 // is it an external file?
3765 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3766 // get buffer of external file
3767 InsetInclude const & incinset =
3768 static_cast<InsetInclude const &>(*insit.inset);
3770 Buffer * child = incinset.loadIfNeeded();
3775 // register its position, but only when it is
3776 // included first in the buffer
3777 children_positions.insert({child, it});
3779 // register child with its scope
3780 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3784 InsetMath * im = insit.inset->asInsetMath();
3785 if (doing_export && im) {
3786 InsetMathHull * hull = im->asHullInset();
3788 hull->recordLocation(it);
3791 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3795 InsetMathMacroTemplate & macroTemplate =
3796 *insit.inset->asInsetMath()->asMacroTemplate();
3797 MacroContext mc(owner_, it);
3798 macroTemplate.updateToContext(mc);
3801 bool valid = macroTemplate.validMacro();
3802 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3803 // then the BufferView's cursor will be invalid in
3804 // some cases which leads to crashes.
3809 // FIXME (Abdel), I don't understand why we pass 'it' here
3810 // instead of 'macroTemplate' defined above... is this correct?
3811 macros[macroTemplate.name()][it] =
3812 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3822 void Buffer::updateMacros() const
3827 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3829 // start with empty table
3831 d->children_positions.clear();
3832 d->position_to_children.clear();
3834 // Iterate over buffer, starting with first paragraph
3835 // The scope must be bigger than any lookup DocIterator
3836 // later. For the global lookup, lastpit+1 is used, hence
3837 // we use lastpit+2 here.
3838 DocIterator it = par_iterator_begin();
3839 DocIterator outerScope = it;
3840 outerScope.pit() = outerScope.lastpit() + 2;
3841 d->updateMacros(it, outerScope);
3845 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3847 for (Inset const & it : inset()) {
3848 if (it.lyxCode() == BRANCH_CODE) {
3849 InsetBranch const & br = static_cast<InsetBranch const &>(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 idx_type n = minset->nargs();
3887 MacroContext mc = MacroContext(this, it);
3888 for (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 = 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 // Use the right wrapping for the comment at the beginning of the generated
4061 // snippet, so that it is either valid LaTeX or valid XML (including HTML and DocBook).
4062 docstring comment_start = from_ascii("% ");
4063 docstring comment_end = from_ascii("");
4064 if (runparams.flavor == Flavor::Html || runparams.flavor == Flavor::DocBook5) {
4065 comment_start = from_ascii("<!-- ");
4066 comment_end = from_ascii(" -->");
4069 if (output == CurrentParagraph) {
4070 runparams.par_begin = par_begin;
4071 runparams.par_end = par_end;
4072 if (par_begin + 1 == par_end) {
4074 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4079 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4080 convert<docstring>(par_begin),
4081 convert<docstring>(par_end - 1))
4085 // output paragraphs
4086 if (runparams.flavor == Flavor::LyX) {
4087 Paragraph const & par = text().paragraphs()[par_begin];
4089 depth_type dt = par.getDepth();
4090 par.write(ods, params(), dt);
4091 os << from_utf8(ods.str());
4092 } else if (runparams.flavor == Flavor::Html) {
4094 setMathFlavor(runparams);
4095 xhtmlParagraphs(text(), *this, xs, runparams);
4096 } else if (runparams.flavor == Flavor::Text) {
4098 // FIXME Handles only one paragraph, unlike the others.
4099 // Probably should have some routine with a signature like them.
4100 writePlaintextParagraph(*this,
4101 text().paragraphs()[par_begin], os, runparams, dummy);
4102 } else if (runparams.flavor == Flavor::DocBook5) {
4104 docbookParagraphs(text(), *this, xs, runparams);
4106 // If we are previewing a paragraph, even if this is the
4107 // child of some other buffer, let's cut the link here,
4108 // so that no concurring settings from the master
4109 // (e.g. branch state) interfere (see #8101).
4111 d->ignore_parent = true;
4112 // We need to validate the Buffer params' features here
4113 // in order to know if we should output polyglossia
4114 // macros (instead of babel macros)
4115 LaTeXFeatures features(*this, params(), runparams);
4117 runparams.use_polyglossia = features.usePolyglossia();
4118 runparams.use_hyperref = features.isRequired("hyperref");
4119 // latex or literate
4122 ots.texrow().newlines(2);
4124 latexParagraphs(*this, text(), ots, runparams);
4125 texrow = ots.releaseTexRow();
4127 // Restore the parenthood
4129 d->ignore_parent = false;
4132 os << comment_start;
4133 if (output == FullSource)
4134 os << _("Preview source code");
4135 else if (output == OnlyPreamble)
4136 os << _("Preview preamble");
4137 else if (output == OnlyBody)
4138 os << _("Preview body");
4141 if (runparams.flavor == Flavor::LyX) {
4143 if (output == FullSource)
4145 else if (output == OnlyPreamble)
4146 params().writeFile(ods, this);
4147 else if (output == OnlyBody)
4149 os << from_utf8(ods.str());
4150 } else if (runparams.flavor == Flavor::Html) {
4151 writeLyXHTMLSource(os, runparams, output);
4152 } else if (runparams.flavor == Flavor::Text) {
4153 if (output == OnlyPreamble)
4154 os << "% "<< _("Plain text does not have a preamble.");
4156 writePlaintextFile(*this, os, runparams);
4157 } else if (runparams.flavor == Flavor::DocBook5) {
4158 writeDocBookSource(os, runparams, output);
4160 // latex or literate
4163 ots.texrow().newlines(2);
4165 runparams.is_child = true;
4167 writeLaTeXSource(ots, string(), runparams, output);
4168 texrow = ots.releaseTexRow();
4175 ErrorList & Buffer::errorList(string const & type) const
4177 return d->errorLists[type];
4181 void Buffer::updateTocItem(std::string const & type,
4182 DocIterator const & dit) const
4185 d->gui_->updateTocItem(type, dit);
4189 void Buffer::structureChanged() const
4192 d->gui_->structureChanged();
4196 void Buffer::errors(string const & err, bool from_master) const
4199 d->gui_->errors(err, from_master);
4203 void Buffer::message(docstring const & msg) const
4206 d->gui_->message(msg);
4210 void Buffer::setBusy(bool on) const
4213 d->gui_->setBusy(on);
4217 void Buffer::updateTitles() const
4220 d->wa_->updateTitles();
4224 void Buffer::resetAutosaveTimers() const
4227 d->gui_->resetAutosaveTimers();
4231 bool Buffer::hasGuiDelegate() const
4237 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4243 FileName Buffer::getEmergencyFileName() const
4245 return FileName(d->filename.absFileName() + ".emergency");
4249 FileName Buffer::getAutosaveFileName() const
4251 // if the document is unnamed try to save in the backup dir, else
4252 // in the default document path, and as a last try in the filePath,
4253 // which will most often be the temporary directory
4256 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4257 : lyxrc.backupdir_path;
4258 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4261 string const fname = "#" + d->filename.onlyFileName() + "#";
4263 return makeAbsPath(fname, fpath);
4267 void Buffer::removeAutosaveFile() const
4269 FileName const f = getAutosaveFileName();
4275 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4277 FileName const newauto = getAutosaveFileName();
4279 if (newauto != oldauto && oldauto.exists())
4280 if (!oldauto.moveTo(newauto))
4281 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4285 bool Buffer::autoSave() const
4287 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4288 if (buf->d->bak_clean || hasReadonlyFlag())
4291 message(_("Autosaving current document..."));
4292 buf->d->bak_clean = true;
4294 FileName const fname = getAutosaveFileName();
4295 LASSERT(d->cloned_buffer_, return false);
4297 // If this buffer is cloned, we assume that
4298 // we are running in a separate thread already.
4299 TempFile tempfile("lyxautoXXXXXX.lyx");
4300 tempfile.setAutoRemove(false);
4301 FileName const tmp_ret = tempfile.name();
4302 if (!tmp_ret.empty()) {
4304 // assume successful write of tmp_ret
4305 if (tmp_ret.moveTo(fname))
4308 // failed to write/rename tmp_ret so try writing direct
4309 return writeFile(fname);
4313 void Buffer::setExportStatus(bool e) const
4315 d->doing_export = e;
4316 ListOfBuffers clist = getDescendants();
4317 for (auto const & bit : clist)
4318 bit->d->doing_export = e;
4322 bool Buffer::isExporting() const
4324 return d->doing_export;
4328 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4332 return doExport(target, put_in_tempdir, result_file);
4335 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4336 string & result_file) const
4338 bool const update_unincluded =
4339 params().maintain_unincluded_children != BufferParams::CM_None
4340 && !params().getIncludedChildren().empty();
4342 // (1) export with all included children (omit \includeonly)
4343 if (update_unincluded) {
4344 ExportStatus const status =
4345 doExport(target, put_in_tempdir, true, result_file);
4346 if (status != ExportSuccess)
4349 // (2) export with included children only
4350 return doExport(target, put_in_tempdir, false, result_file);
4354 void Buffer::setMathFlavor(OutputParams & op) const
4356 switch (params().html_math_output) {
4357 case BufferParams::MathML:
4358 op.math_flavor = OutputParams::MathAsMathML;
4360 case BufferParams::HTML:
4361 op.math_flavor = OutputParams::MathAsHTML;
4363 case BufferParams::Images:
4364 op.math_flavor = OutputParams::MathAsImages;
4366 case BufferParams::LaTeX:
4367 op.math_flavor = OutputParams::MathAsLaTeX;
4373 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4374 bool includeall, string & result_file) const
4376 LYXERR(Debug::FILES, "target=" << target);
4377 OutputParams runparams(¶ms().encoding());
4378 string format = target;
4379 string dest_filename;
4380 size_t pos = target.find(' ');
4381 if (pos != string::npos) {
4382 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4383 format = target.substr(0, pos);
4384 if (format == "default")
4385 format = params().getDefaultOutputFormat();
4386 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4387 FileName(dest_filename).onlyPath().createPath();
4388 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4390 MarkAsExporting exporting(this);
4391 string backend_format;
4392 runparams.flavor = Flavor::LaTeX;
4393 runparams.linelen = lyxrc.plaintext_linelen;
4394 runparams.includeall = includeall;
4395 vector<string> backs = params().backends();
4396 Converters converters = theConverters();
4397 bool need_nice_file = false;
4398 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4399 // Get shortest path to format
4400 converters.buildGraph();
4401 Graph::EdgePath path;
4402 for (string const & sit : backs) {
4403 Graph::EdgePath p = converters.getPath(sit, format);
4404 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4405 backend_format = sit;
4410 if (!put_in_tempdir) {
4411 // Only show this alert if this is an export to a non-temporary
4412 // file (not for previewing).
4413 docstring s = bformat(_("No information for exporting the format %1$s."),
4414 translateIfPossible(theFormats().prettyName(format)));
4415 if (format == "pdf4")
4417 + bformat(_("Hint: use non-TeX fonts or set input encoding "
4418 " to '%1$s'"), from_utf8(encodings.fromLyXName("ascii")->guiName()));
4419 Alert::error(_("Couldn't export file"), s);
4421 return ExportNoPathToFormat;
4423 runparams.flavor = converters.getFlavor(path, this);
4424 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4425 for (auto const & edge : path)
4426 if (theConverters().get(edge).nice()) {
4427 need_nice_file = true;
4432 backend_format = format;
4433 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4434 // FIXME: Don't hardcode format names here, but use a flag
4435 if (backend_format == "pdflatex")
4436 runparams.flavor = Flavor::PdfLaTeX;
4437 else if (backend_format == "luatex")
4438 runparams.flavor = Flavor::LuaTeX;
4439 else if (backend_format == "dviluatex")
4440 runparams.flavor = Flavor::DviLuaTeX;
4441 else if (backend_format == "xetex")
4442 runparams.flavor = Flavor::XeTeX;
4445 string filename = latexName(false);
4446 filename = addName(temppath(), filename);
4447 filename = changeExtension(filename,
4448 theFormats().extension(backend_format));
4449 LYXERR(Debug::FILES, "filename=" << filename);
4451 // Plain text backend
4452 if (backend_format == "text") {
4453 runparams.flavor = Flavor::Text;
4455 writePlaintextFile(*this, FileName(filename), runparams);
4457 catch (ConversionException const &) { return ExportCancel; }
4460 else if (backend_format == "xhtml") {
4461 runparams.flavor = Flavor::Html;
4462 setMathFlavor(runparams);
4463 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4464 return ExportKilled;
4465 } else if (backend_format == "lyx")
4466 writeFile(FileName(filename));
4468 else if (backend_format == "docbook5") {
4469 runparams.flavor = Flavor::DocBook5;
4470 runparams.nice = false;
4471 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4472 return ExportKilled;
4475 else if (backend_format == format || need_nice_file) {
4476 runparams.nice = true;
4477 ExportStatus const retval =
4478 makeLaTeXFile(FileName(filename), string(), runparams);
4479 if (retval == ExportKilled)
4480 return ExportKilled;
4481 if (d->cloned_buffer_)
4482 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4483 if (retval != ExportSuccess)
4485 } else if (!lyxrc.tex_allows_spaces
4486 && contains(filePath(), ' ')) {
4487 Alert::error(_("File name error"),
4488 bformat(_("The directory path to the document\n%1$s\n"
4489 "contains spaces, but your TeX installation does "
4490 "not allow them. You should save the file to a directory "
4491 "whose name does not contain spaces."), from_utf8(filePath())));
4492 return ExportTexPathHasSpaces;
4494 runparams.nice = false;
4495 ExportStatus const retval =
4496 makeLaTeXFile(FileName(filename), filePath(), runparams);
4497 if (retval == ExportKilled)
4498 return ExportKilled;
4499 if (d->cloned_buffer_)
4500 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4501 if (retval != ExportSuccess)
4505 string const error_type = (format == "program")
4506 ? "Build" : params().bufferFormat();
4507 ErrorList & error_list = d->errorLists[error_type];
4508 string const ext = theFormats().extension(format);
4509 FileName const tmp_result_file(changeExtension(filename, ext));
4510 Converters::RetVal const retval =
4511 converters.convert(this, FileName(filename), tmp_result_file,
4512 FileName(absFileName()), backend_format, format,
4513 error_list, Converters::none, includeall);
4514 if (retval == Converters::KILLED)
4515 return ExportCancel;
4516 bool success = (retval == Converters::SUCCESS);
4518 // Emit the signal to show the error list or copy it back to the
4519 // cloned Buffer so that it can be emitted afterwards.
4520 if (format != backend_format) {
4521 if (runparams.silent)
4523 else if (d->cloned_buffer_)
4524 d->cloned_buffer_->d->errorLists[error_type] =
4525 d->errorLists[error_type];
4528 // also to the children, in case of master-buffer-view
4529 ListOfBuffers clist = getDescendants();
4530 for (auto const & bit : clist) {
4531 if (runparams.silent)
4532 bit->d->errorLists[error_type].clear();
4533 else if (d->cloned_buffer_) {
4534 // Enable reverse search by copying back the
4535 // texrow object to the cloned buffer.
4536 // FIXME: this is not thread safe.
4537 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4538 bit->d->cloned_buffer_->d->errorLists[error_type] =
4539 bit->d->errorLists[error_type];
4541 bit->errors(error_type, true);
4545 if (d->cloned_buffer_) {
4546 // Enable reverse dvi or pdf to work by copying back the texrow
4547 // object to the cloned buffer.
4548 // FIXME: There is a possibility of concurrent access to texrow
4549 // here from the main GUI thread that should be securized.
4550 d->cloned_buffer_->d->texrow = d->texrow;
4551 string const err_type = params().bufferFormat();
4552 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4556 if (put_in_tempdir) {
4557 result_file = tmp_result_file.absFileName();
4558 return success ? ExportSuccess : ExportConverterError;
4561 if (dest_filename.empty())
4562 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4564 result_file = dest_filename;
4565 // We need to copy referenced files (e. g. included graphics
4566 // if format == "dvi") to the result dir.
4567 vector<ExportedFile> const extfiles =
4568 runparams.exportdata->externalFiles(format);
4569 string const dest = runparams.export_folder.empty() ?
4570 onlyPath(result_file) : runparams.export_folder;
4571 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4572 : force_overwrite == ALL_FILES;
4573 CopyStatus status = use_force ? FORCE : SUCCESS;
4575 for (ExportedFile const & exp : extfiles) {
4576 if (status == CANCEL) {
4577 message(_("Document export cancelled."));
4578 return ExportCancel;
4580 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4581 string fixedName = exp.exportName;
4582 if (!runparams.export_folder.empty()) {
4583 // Relative pathnames starting with ../ will be sanitized
4584 // if exporting to a different folder
4585 while (fixedName.substr(0, 3) == "../")
4586 fixedName = fixedName.substr(3, fixedName.length() - 3);
4588 FileName fixedFileName = makeAbsPath(fixedName, dest);
4589 fixedFileName.onlyPath().createPath();
4590 status = copyFile(fmt, exp.sourceName,
4592 exp.exportName, status == FORCE,
4593 runparams.export_folder.empty());
4597 if (tmp_result_file.exists()) {
4598 // Finally copy the main file
4599 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4600 : force_overwrite != NO_FILES;
4601 if (status == SUCCESS && use_force)
4603 status = copyFile(format, tmp_result_file,
4604 FileName(result_file), result_file,
4606 if (status == CANCEL) {
4607 message(_("Document export cancelled."));
4608 return ExportCancel;
4610 message(bformat(_("Document exported as %1$s "
4612 translateIfPossible(theFormats().prettyName(format)),
4613 makeDisplayPath(result_file)));
4616 // This must be a dummy converter like fax (bug 1888)
4617 message(bformat(_("Document exported as %1$s"),
4618 translateIfPossible(theFormats().prettyName(format))));
4621 return success ? ExportSuccess : ExportConverterError;
4625 Buffer::ExportStatus Buffer::preview(string const & format) const
4627 bool const update_unincluded =
4628 params().maintain_unincluded_children != BufferParams::CM_None
4629 && !params().getIncludedChildren().empty();
4630 return preview(format, update_unincluded);
4634 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4636 MarkAsExporting exporting(this);
4638 // (1) export with all included children (omit \includeonly)
4640 ExportStatus const status = doExport(format, true, true, result_file);
4641 if (status != ExportSuccess)
4644 // (2) export with included children only
4645 ExportStatus const status = doExport(format, true, false, result_file);
4646 FileName const previewFile(result_file);
4648 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4649 theimpl->preview_file_ = previewFile;
4650 theimpl->preview_format_ = format;
4651 theimpl->require_fresh_start_ = (status != ExportSuccess);
4653 if (status != ExportSuccess)
4656 if (previewFile.exists())
4657 return theFormats().view(*this, previewFile, format) ?
4658 PreviewSuccess : PreviewError;
4660 // Successful export but no output file?
4661 // Probably a bug in error detection.
4662 LATTEST(status != ExportSuccess);
4667 Buffer::ReadStatus Buffer::extractFromVC()
4669 bool const found = LyXVC::file_not_found_hook(d->filename);
4671 return ReadFileNotFound;
4672 if (!d->filename.isReadableFile())
4678 Buffer::ReadStatus Buffer::loadEmergency()
4680 FileName const emergencyFile = getEmergencyFileName();
4681 if (!emergencyFile.exists()
4682 || emergencyFile.lastModified() <= d->filename.lastModified())
4683 return ReadFileNotFound;
4685 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4686 docstring const text = bformat(_("An emergency save of the document "
4687 "%1$s exists.\n\nRecover emergency save?"), file);
4689 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4690 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4696 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4697 bool const success = (ret_llf == ReadSuccess);
4699 if (hasReadonlyFlag()) {
4700 Alert::warning(_("File is read-only"),
4701 bformat(_("An emergency file is successfully loaded, "
4702 "but the original file %1$s is marked read-only. "
4703 "Please make sure to save the document as a different "
4704 "file."), from_utf8(d->filename.absFileName())));
4707 lyxvc().file_found_hook(d->filename);
4708 str = _("Document was successfully recovered.");
4710 str = _("Document was NOT successfully recovered.");
4711 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4712 makeDisplayPath(emergencyFile.absFileName()));
4714 int const del_emerg =
4715 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4716 _("&Remove"), _("&Keep"));
4717 if (del_emerg == 0) {
4718 emergencyFile.removeFile();
4720 Alert::warning(_("Emergency file deleted"),
4721 _("Do not forget to save your file now!"), true);
4723 return success ? ReadSuccess : ReadEmergencyFailure;
4726 int const del_emerg =
4727 Alert::prompt(_("Delete emergency file?"),
4728 _("Remove emergency file now?"), 1, 1,
4729 _("&Remove"), _("&Keep"));
4731 emergencyFile.removeFile();
4735 string const ename = emergencyFile.absFileName();
4737 // Surely we can find one in 100 tries?
4738 for (int i = 1; i < 100; ++i) {
4739 newname.set(ename + to_string(i) + ".lyx");
4740 if (!newname.exists()) {
4746 // renameTo returns true on success. So inverting that
4747 // will give us true if we fail.
4748 noname = !emergencyFile.renameTo(newname);
4751 Alert::warning(_("Can't rename emergency file!"),
4752 _("LyX was unable to rename the emergency file. "
4753 "You should do so manually. Otherwise, you will be "
4754 "asked about it again the next time you try to load "
4755 "this file, and may over-write your own work."));
4757 Alert::warning(_("Emergency File Renames"),
4758 bformat(_("Emergency file renamed as:\n %1$s"),
4759 from_utf8(newname.onlyFileName())));
4762 return ReadOriginal;
4772 Buffer::ReadStatus Buffer::loadAutosave()
4774 // Now check if autosave file is newer.
4775 FileName const autosaveFile = getAutosaveFileName();
4776 if (!autosaveFile.exists()
4777 || autosaveFile.lastModified() <= d->filename.lastModified())
4778 return ReadFileNotFound;
4780 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4781 docstring const text = bformat(_("The backup of the document %1$s "
4782 "is newer.\n\nLoad the backup instead?"), file);
4783 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4784 _("&Load backup"), _("Load &original"), _("&Cancel"));
4789 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4790 // the file is not saved if we load the autosave file.
4791 if (ret_llf == ReadSuccess) {
4792 if (hasReadonlyFlag()) {
4793 Alert::warning(_("File is read-only"),
4794 bformat(_("A backup file is successfully loaded, "
4795 "but the original file %1$s is marked read-only. "
4796 "Please make sure to save the document as a "
4798 from_utf8(d->filename.absFileName())));
4801 lyxvc().file_found_hook(d->filename);
4804 return ReadAutosaveFailure;
4807 // Here we delete the autosave
4808 autosaveFile.removeFile();
4809 return ReadOriginal;
4817 Buffer::ReadStatus Buffer::loadLyXFile()
4819 if (!d->filename.isReadableFile()) {
4820 ReadStatus const ret_rvc = extractFromVC();
4821 if (ret_rvc != ReadSuccess)
4825 ReadStatus const ret_re = loadEmergency();
4826 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4829 ReadStatus const ret_ra = loadAutosave();
4830 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4833 return loadThisLyXFile(d->filename);
4837 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4839 return readFile(fn);
4843 void Buffer::Impl::traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const
4845 for (; err != end; ++err) {
4846 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4847 int errorRow = err->error_in_line;
4848 Buffer const * buf = nullptr;
4849 Impl const * p = this;
4850 if (err->child_name.empty())
4851 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4853 // The error occurred in a child
4854 for (Buffer const * child : owner_->getDescendants()) {
4855 string const child_name =
4856 DocFileName(changeExtension(child->absFileName(), "tex")).
4858 if (err->child_name != child_name)
4860 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4861 if (!TexRow::isNone(start)) {
4862 buf = this->cloned_buffer_
4863 ? child->d->cloned_buffer_->d->owner_
4870 errorList.push_back(ErrorItem(err->error_desc, err->error_text,
4876 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4878 TeXErrors::Errors::const_iterator err = terr.begin();
4879 TeXErrors::Errors::const_iterator end = terr.end();
4881 d->traverseErrors(err, end, errorList);
4885 void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const
4887 TeXErrors::Errors::const_iterator err = terr.begin_ref();
4888 TeXErrors::Errors::const_iterator end = terr.end_ref();
4890 d->traverseErrors(err, end, errorList);
4894 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4896 LBUFERR(!text().paragraphs().empty());
4898 // Use the master text class also for child documents
4899 Buffer const * const master = masterBuffer();
4900 DocumentClass const & textclass = master->params().documentClass();
4902 docstring_list old_bibfiles;
4903 // Do this only if we are the top-level Buffer. We also need to account
4904 // for the case of a previewed child with ignored parent here.
4905 if (master == this && !d->ignore_parent) {
4906 textclass.counters().reset(from_ascii("bibitem"));
4907 reloadBibInfoCache();
4908 // we will re-read this cache as we go through, but we need
4909 // to know whether it's changed to know whether we need to
4910 // update the bibinfo cache.
4911 old_bibfiles = d->bibfiles_cache_;
4912 d->bibfiles_cache_.clear();
4915 // keep the buffers to be children in this set. If the call from the
4916 // master comes back we can see which of them were actually seen (i.e.
4917 // via an InsetInclude). The remaining ones in the set need still be updated.
4918 static std::set<Buffer const *> bufToUpdate;
4919 if (scope == UpdateMaster) {
4920 // If this is a child document start with the master
4921 if (master != this) {
4922 bufToUpdate.insert(this);
4923 master->updateBuffer(UpdateMaster, utype);
4924 // If the master buffer has no gui associated with it, then the TocModel is
4925 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4926 // (bug 5699). The same happens if the master buffer is open in a different
4927 // window. This test catches both possibilities.
4928 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
4929 // There remains a problem here: If there is another child open in yet a third
4930 // window, that TOC is not updated. So some more general solution is needed at
4932 if (master->d->gui_ != d->gui_)
4935 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4936 if (bufToUpdate.find(this) == bufToUpdate.end())
4940 // start over the counters in the master
4941 textclass.counters().reset();
4944 // update will be done below for this buffer
4945 bufToUpdate.erase(this);
4947 // update all caches
4948 clearReferenceCache();
4951 Buffer & cbuf = const_cast<Buffer &>(*this);
4952 // if we are reloading, then we could have a dangling TOC,
4953 // in effect. so we need to go ahead and reset, even though
4954 // we will do so again when we rebuild the TOC later.
4955 cbuf.tocBackend().reset();
4958 ParIterator parit = cbuf.par_iterator_begin();
4959 if (scope == UpdateMaster)
4961 updateBuffer(parit, utype);
4963 // If this document has siblings, then update the TocBackend later. The
4964 // reason is to ensure that later siblings are up to date when e.g. the
4965 // broken or not status of references is computed. The update is called
4966 // in InsetInclude::addToToc.
4970 // if the bibfiles changed, the cache of bibinfo is invalid
4971 docstring_list new_bibfiles = d->bibfiles_cache_;
4972 // this is a trick to determine whether the two vectors have
4973 // the same elements.
4974 sort(new_bibfiles.begin(), new_bibfiles.end());
4975 sort(old_bibfiles.begin(), old_bibfiles.end());
4976 if (old_bibfiles != new_bibfiles) {
4977 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
4978 invalidateBibinfoCache();
4979 reloadBibInfoCache();
4980 // We relied upon the bibinfo cache when recalculating labels. But that
4981 // cache was invalid, although we didn't find that out until now. So we
4982 // have to do it all again.
4983 // That said, the only thing we really need to do is update the citation
4984 // labels. Nothing else will have changed. So we could create a new
4985 // UpdateType that would signal that fact, if we needed to do so.
4986 parit = cbuf.par_iterator_begin();
4987 // we will be re-doing the counters and references and such.
4988 textclass.counters().reset();
4989 clearReferenceCache();
4990 // we should not need to do this again?
4992 updateBuffer(parit, utype);
4993 // this will already have been done by reloadBibInfoCache();
4994 // d->bibinfo_cache_valid_ = true;
4997 LYXERR(Debug::FILES, "Bibfiles unchanged.");
4998 // this is also set to true on the other path, by reloadBibInfoCache.
4999 d->bibinfo_cache_valid_ = true;
5001 d->cite_labels_valid_ = true;
5004 cbuf.tocBackend().update(true, utype);
5005 if (scope == UpdateMaster)
5006 cbuf.structureChanged();
5010 static depth_type getDepth(DocIterator const & it)
5012 depth_type depth = 0;
5013 for (size_t i = 0 ; i < it.depth() ; ++i)
5014 if (!it[i].inset().inMathed())
5015 depth += it[i].paragraph().getDepth() + 1;
5016 // remove 1 since the outer inset does not count
5017 // we should have at least one non-math inset, so
5018 // depth should nevery be 0. but maybe it is worth
5019 // marking this, just in case.
5021 // coverity[INTEGER_OVERFLOW]
5025 static depth_type getItemDepth(ParIterator const & it)
5027 Paragraph const & par = *it;
5028 LabelType const labeltype = par.layout().labeltype;
5030 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5033 // this will hold the lowest depth encountered up to now.
5034 depth_type min_depth = getDepth(it);
5035 ParIterator prev_it = it;
5038 --prev_it.top().pit();
5040 // start of nested inset: go to outer par
5042 if (prev_it.empty()) {
5043 // start of document: nothing to do
5048 // We search for the first paragraph with same label
5049 // that is not more deeply nested.
5050 Paragraph & prev_par = *prev_it;
5051 depth_type const prev_depth = getDepth(prev_it);
5052 if (labeltype == prev_par.layout().labeltype) {
5053 if (prev_depth < min_depth)
5054 return prev_par.itemdepth + 1;
5055 if (prev_depth == min_depth)
5056 return prev_par.itemdepth;
5058 min_depth = min(min_depth, prev_depth);
5059 // small optimization: if we are at depth 0, we won't
5060 // find anything else
5061 if (prev_depth == 0)
5067 static bool needEnumCounterReset(ParIterator const & it)
5069 Paragraph const & par = *it;
5070 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5071 depth_type const cur_depth = par.getDepth();
5072 ParIterator prev_it = it;
5073 while (prev_it.pit()) {
5074 --prev_it.top().pit();
5075 Paragraph const & prev_par = *prev_it;
5076 if (prev_par.getDepth() <= cur_depth)
5077 return prev_par.layout().name() != par.layout().name();
5079 // start of nested inset: reset
5084 // set the label of a paragraph. This includes the counters.
5085 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5087 BufferParams const & bp = owner_->masterBuffer()->params();
5088 DocumentClass const & textclass = bp.documentClass();
5089 Paragraph & par = it.paragraph();
5090 Layout const & layout = par.layout();
5091 Counters & counters = textclass.counters();
5093 if (par.params().startOfAppendix()) {
5094 // We want to reset the counter corresponding to toplevel sectioning
5095 Layout const & lay = textclass.getTOCLayout();
5096 docstring const cnt = lay.counter;
5098 counters.reset(cnt);
5099 counters.appendix(true);
5101 par.params().appendix(counters.appendix());
5103 // Compute the item depth of the paragraph
5104 par.itemdepth = getItemDepth(it);
5106 if (layout.margintype == MARGIN_MANUAL) {
5107 if (par.params().labelWidthString().empty())
5108 par.params().labelWidthString(par.expandLabel(layout, bp));
5109 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5110 // we do not need to do anything here, since the empty case is
5111 // handled during export.
5113 par.params().labelWidthString(docstring());
5116 switch(layout.labeltype) {
5117 case LABEL_ITEMIZE: {
5118 // At some point of time we should do something more
5119 // clever here, like:
5120 // par.params().labelString(
5121 // bp.user_defined_bullet(par.itemdepth).getText());
5122 // for now, use a simple hardcoded label
5123 docstring itemlabel;
5124 switch (par.itemdepth) {
5127 itemlabel = char_type(0x2022);
5131 itemlabel = char_type(0x2013);
5134 // ∗ U+2217 ASTERISK OPERATOR
5135 itemlabel = char_type(0x2217);
5138 // · U+00B7 MIDDLE DOT
5139 itemlabel = char_type(0x00b7);
5142 par.params().labelString(itemlabel);
5146 case LABEL_ENUMERATE: {
5147 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5149 switch (par.itemdepth) {
5160 enumcounter += "iv";
5163 // not a valid enumdepth...
5167 if (needEnumCounterReset(it)) {
5168 // Increase the parent counter?
5169 if (layout.stepparentcounter)
5170 counters.stepParent(enumcounter, utype);
5171 // Maybe we have to reset the enumeration counter.
5172 if (!layout.resumecounter)
5173 counters.reset(enumcounter);
5175 counters.step(enumcounter, utype);
5177 string const & lang = par.getParLanguage(bp)->code();
5178 par.params().labelString(counters.theCounter(enumcounter, lang));
5183 case LABEL_SENSITIVE: {
5184 string const & type = counters.current_float();
5185 docstring full_label;
5187 full_label = owner_->B_("Senseless!!! ");
5189 docstring name = owner_->B_(textclass.floats().getType(type).name());
5190 if (counters.hasCounter(from_utf8(type))) {
5191 string const & lang = par.getParLanguage(bp)->code();
5192 counters.step(from_utf8(type), utype);
5193 full_label = bformat(from_ascii("%1$s %2$s:"),
5195 counters.theCounter(from_utf8(type), lang));
5197 full_label = bformat(from_ascii("%1$s #:"), name);
5199 par.params().labelString(full_label);
5203 case LABEL_NO_LABEL:
5204 par.params().labelString(docstring());
5208 case LABEL_CENTERED:
5209 case LABEL_STATIC: {
5210 docstring const & lcounter = layout.counter;
5211 if (!lcounter.empty()) {
5212 if (layout.toclevel <= bp.secnumdepth
5213 && (layout.latextype != LATEX_ENVIRONMENT
5214 || it.text()->isFirstInSequence(it.pit()))) {
5215 if (counters.hasCounter(lcounter))
5216 counters.step(lcounter, utype);
5217 par.params().labelString(par.expandLabel(layout, bp));
5219 par.params().labelString(docstring());
5221 par.params().labelString(par.expandLabel(layout, bp));
5227 par.params().labelString(par.expandLabel(layout, bp));
5232 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype, bool const deleted) const
5234 pushIncludedBuffer(this);
5235 // LASSERT: Is it safe to continue here, or should we just return?
5236 LASSERT(parit.pit() == 0, /**/);
5238 // Set the position of the text in the buffer to be able
5239 // to resolve macros in it.
5240 parit.text()->setMacrocontextPosition(parit);
5242 depth_type maxdepth = 0;
5243 pit_type const lastpit = parit.lastpit();
5244 bool changed = false;
5245 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5246 // reduce depth if necessary
5247 if (parit->params().depth() > maxdepth) {
5248 /** FIXME: this function is const, but
5249 * nevertheless it modifies the buffer. To be
5250 * cleaner, one should modify the buffer in
5251 * another function, which is actually
5252 * non-const. This would however be costly in
5253 * terms of code duplication.
5255 CursorData(parit).recordUndo();
5256 parit->params().depth(maxdepth);
5258 maxdepth = parit->getMaxDepthAfter();
5260 if (utype == OutputUpdate) {
5261 // track the active counters
5262 // we have to do this for the master buffer, since the local
5263 // buffer isn't tracking anything.
5264 masterBuffer()->params().documentClass().counters().
5265 setActiveLayout(parit->layout());
5268 // set the counter for this paragraph
5269 d->setLabel(parit, utype);
5272 for (auto const & insit : parit->insetList()) {
5273 parit.pos() = insit.pos;
5274 insit.inset->updateBuffer(parit, utype, deleted || parit->isDeleted(insit.pos));
5275 changed |= insit.inset->isChanged();
5278 // are there changes in this paragraph?
5279 changed |= parit->isChanged();
5282 // set change indicator for the inset (or the cell that the iterator
5283 // points to, if applicable).
5284 parit.text()->inset().isChanged(changed);
5285 popIncludedBuffer();
5289 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5290 WordLangTuple & word_lang, docstring_list & suggestions) const
5294 suggestions.clear();
5295 word_lang = WordLangTuple();
5296 bool const to_end = to.empty();
5297 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5298 // OK, we start from here.
5299 for (; from != end; from.forwardPos()) {
5300 // This skips all insets with spell check disabled.
5301 while (!from.allowSpellCheck()) {
5305 // If from is at the end of the document (which is possible
5306 // when "from" was changed above) LyX will crash later otherwise.
5307 if (from.atEnd() || (!to_end && from >= end))
5310 from.paragraph().spellCheck();
5311 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5312 if (SpellChecker::misspelled(res)) {
5316 // Do not increase progress when from == to, otherwise the word
5317 // count will be wrong.
5327 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5329 bool inword = false;
5334 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5335 if (!dit.inTexted()) {
5340 Paragraph const & par = dit.paragraph();
5341 pos_type const pos = dit.pos();
5343 // Copied and adapted from isWordSeparator() in Paragraph
5344 if (pos == dit.lastpos()) {
5347 Inset const * ins = par.getInset(pos);
5348 if (ins && skipNoOutput && !ins->producesOutput()) {
5351 // stop if end of range was skipped
5352 if (!to.atEnd() && dit >= to)
5355 } else if (!par.isDeleted(pos)) {
5356 if (par.isWordSeparator(pos))
5362 if (ins && ins->isLetter()) {
5363 odocstringstream os;
5365 char_count_ += os.str().length();
5367 else if (ins && ins->isSpace())
5370 pair<int, int> words = ins->isWords();
5371 char_count_ += words.first;
5372 word_count_ += words.second;
5376 char_type const c = par.getChar(pos);
5377 if (isPrintableNonspace(c))
5379 else if (isSpace(c))
5389 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5391 d->updateStatistics(from, to, skipNoOutput);
5395 int Buffer::wordCount() const
5397 return d->wordCount();
5401 int Buffer::charCount(bool with_blanks) const
5403 return d->charCount(with_blanks);
5407 bool Buffer::areChangesPresent() const
5409 return inset().isChanged();
5413 Buffer::ReadStatus Buffer::reload()
5416 // c.f. bug https://www.lyx.org/trac/ticket/6587
5417 removeAutosaveFile();
5418 // e.g., read-only status could have changed due to version control
5419 d->filename.refresh();
5420 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5422 // clear parent. this will get reset if need be.
5423 d->setParent(nullptr);
5424 ReadStatus const status = loadLyXFile();
5425 if (status == ReadSuccess) {
5430 message(bformat(_("Document %1$s reloaded."), disp_fn));
5433 message(bformat(_("Could not reload document %1$s."), disp_fn));
5443 bool Buffer::saveAs(FileName const & fn)
5445 FileName const old_name = fileName();
5446 FileName const old_auto = getAutosaveFileName();
5447 bool const old_unnamed = isUnnamed();
5448 bool success = true;
5449 d->old_position = filePath();
5456 // bring the autosave file with us, just in case.
5457 moveAutosaveFile(old_auto);
5458 // validate version control data and
5459 // correct buffer title
5460 lyxvc().file_found_hook(fileName());
5462 // the file has now been saved to the new location.
5463 // we need to check that the locations of child buffers
5465 checkChildBuffers();
5466 checkMasterBuffer();
5469 // reset the old filename and unnamed state
5470 setFileName(old_name);
5471 setUnnamed(old_unnamed);
5475 d->old_position.clear();
5480 void Buffer::checkChildBuffers()
5482 for (auto const & bit : d->children_positions) {
5483 DocIterator dit = bit.second;
5484 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5485 if (!cbuf || !theBufferList().isLoaded(cbuf))
5487 Inset * inset = dit.nextInset();
5488 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5489 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5490 docstring const & incfile = inset_inc->getParam("filename");
5491 string oldloc = cbuf->absFileName();
5492 string newloc = makeAbsPath(to_utf8(incfile),
5493 onlyPath(absFileName())).absFileName();
5494 if (oldloc == newloc)
5496 // the location of the child file is incorrect.
5497 cbuf->setParent(nullptr);
5498 inset_inc->setChildBuffer(nullptr);
5500 // invalidate cache of children
5501 d->children_positions.clear();
5502 d->position_to_children.clear();
5506 // If a child has been saved under a different name/path, it might have been
5507 // orphaned. Therefore the master needs to be reset (bug 8161).
5508 void Buffer::checkMasterBuffer()
5510 Buffer const * const master = masterBuffer();
5514 // necessary to re-register the child (bug 5873)
5515 // FIXME: clean up updateMacros (here, only
5516 // child registering is needed).
5517 master->updateMacros();
5518 // (re)set master as master buffer, but only
5519 // if we are a real child
5520 if (master->isChild(this))
5527 string Buffer::includedFilePath(string const & name, string const & ext) const
5529 if (d->old_position.empty() ||
5530 equivalent(FileName(d->old_position), FileName(filePath())))
5533 bool isabsolute = FileName::isAbsolute(name);
5534 // both old_position and filePath() end with a path separator
5535 string absname = isabsolute ? name : d->old_position + name;
5537 // if old_position is set to origin, we need to do the equivalent of
5538 // getReferencedFileName() (see readDocument())
5539 if (!isabsolute && d->old_position == params().origin) {
5540 FileName const test(addExtension(filePath() + name, ext));
5542 absname = filePath() + name;
5545 if (!FileName(addExtension(absname, ext)).exists())
5549 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5551 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5552 from_utf8(filePath())));
5556 void Buffer::Impl::refreshFileMonitor()
5558 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5559 file_monitor_->refresh();
5563 // The previous file monitor is invalid
5564 // This also destroys the previous file monitor and all its connections
5565 file_monitor_ = FileSystemWatcher::monitor(filename);
5566 // file_monitor_ will be destroyed with *this, so it is not going to call a
5567 // destroyed object method.
5568 file_monitor_->connect([this](bool exists) {
5569 fileExternallyModified(exists);
5574 void Buffer::Impl::fileExternallyModified(bool const exists)
5576 // ignore notifications after our own saving operations
5577 if (checksum_ == filename.checksum()) {
5578 LYXERR(Debug::FILES, "External modification but "
5579 "checksum unchanged: " << filename);
5582 // If the file has been deleted, only mark the file as dirty since it is
5583 // pointless to prompt for reloading. If later a file is moved into this
5584 // location, then the externally modified warning will appear then.
5586 externally_modified_ = true;
5587 // Update external modification notification.
5588 // Dirty buffers must be visible at all times.
5589 if (wa_ && wa_->unhide(owner_))
5590 wa_->updateTitles();
5592 // Unable to unhide the buffer (e.g. no GUI or not current View)
5597 bool Buffer::notifiesExternalModification() const
5599 return d->externally_modified_;
5603 void Buffer::clearExternalModification() const
5605 d->externally_modified_ = false;
5607 d->wa_->updateTitles();
5611 void Buffer::pushIncludedBuffer(Buffer const * buf) const
5613 masterBuffer()->d->include_list_.push_back(buf);
5614 if (lyxerr.debugging(Debug::FILES)) {
5615 LYXERR0("Pushed. Stack now:");
5616 if (masterBuffer()->d->include_list_.empty())
5619 for (auto const & b : masterBuffer()->d->include_list_)
5620 LYXERR0(b->fileName());
5625 void Buffer::popIncludedBuffer() const
5627 masterBuffer()->d->include_list_.pop_back();
5628 if (lyxerr.debugging(Debug::FILES)) {
5629 LYXERR0("Popped. Stack now:");
5630 if (masterBuffer()->d->include_list_.empty())
5633 for (auto const & b : masterBuffer()->d->include_list_)
5634 LYXERR0(b->fileName());
5639 bool Buffer::isBufferIncluded(Buffer const * buf) const
5643 if (lyxerr.debugging(Debug::FILES)) {
5644 LYXERR0("Checking for " << buf->fileName() << ". Stack now:");
5645 if (masterBuffer()->d->include_list_.empty())
5648 for (auto const & b : masterBuffer()->d->include_list_)
5649 LYXERR0(b->fileName());
5651 list<Buffer const *> const & blist = masterBuffer()->d->include_list_;
5652 return find(blist.begin(), blist.end(), buf) != blist.end();
5656 void Buffer::clearIncludeList() const
5658 LYXERR(Debug::FILES, "Clearing include list for " << fileName());
5659 d->include_list_.clear();