3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Stefan Schimanski
9 * Full author contact details are available in file CREDITS.
17 #include "BiblioInfo.h"
18 #include "BranchList.h"
19 #include "buffer_funcs.h"
20 #include "BufferList.h"
21 #include "BufferParams.h"
25 #include "Converter.h"
28 #include "CutAndPaste.h"
29 #include "DispatchResult.h"
30 #include "DocIterator.h"
31 #include "BufferEncodings.h"
32 #include "ErrorList.h"
35 #include "FuncRequest.h"
36 #include "FuncStatus.h"
37 #include "IndicesList.h"
38 #include "InsetIterator.h"
39 #include "InsetList.h"
41 #include "LaTeXFeatures.h"
45 #include "LyXAction.h"
50 #include "output_latex.h"
51 #include "output_docbook.h"
52 #include "output_plaintext.h"
53 #include "output_xhtml.h"
54 #include "Paragraph.h"
55 #include "ParagraphParameters.h"
56 #include "ParIterator.h"
57 #include "PDFOptions.h"
59 #include "SpellChecker.h"
61 #include "texstream.h"
64 #include "TextClass.h"
65 #include "TocBackend.h"
67 #include "VCBackend.h"
69 #include "WordLangTuple.h"
71 #include "insets/InsetBranch.h"
72 #include "insets/InsetInclude.h"
73 #include "insets/InsetText.h"
75 #include "mathed/InsetMathHull.h"
76 #include "mathed/MacroTable.h"
77 #include "mathed/InsetMathMacroTemplate.h"
78 #include "mathed/MathSupport.h"
80 #include "graphics/PreviewLoader.h"
82 #include "frontends/Application.h"
83 #include "frontends/alert.h"
84 #include "frontends/Delegates.h"
85 #include "frontends/WorkAreaManager.h"
87 #include "support/lassert.h"
88 #include "support/convert.h"
89 #include "support/debug.h"
90 #include "support/docstring_list.h"
91 #include "support/ExceptionMessage.h"
92 #include "support/FileMonitor.h"
93 #include "support/FileName.h"
94 #include "support/FileNameList.h"
95 #include "support/filetools.h"
96 #include "support/gettext.h"
97 #include "support/gzstream.h"
98 #include "support/lstrings.h"
99 #include "support/mutex.h"
100 #include "support/os.h"
101 #include "support/Package.h"
102 #include "support/PathChanger.h"
103 #include "support/Systemcall.h"
104 #include "support/TempFile.h"
105 #include "support/textutils.h"
106 #include "support/types.h"
118 using namespace lyx::support;
119 using namespace lyx::graphics;
123 namespace Alert = frontend::Alert;
124 namespace os = support::os;
128 int const LYX_FORMAT = LYX_FORMAT_LYX;
130 typedef map<string, bool> DepClean;
132 // Information about labels and their associated refs
137 InsetLabel const * inset;
138 /// associated references cache
139 Buffer::References references;
140 /// whether this label is active (i.e., not deleted)
144 typedef vector<LabelInfo> LabelCache;
146 typedef map<docstring, Buffer::References> RefCache;
148 // A storehouse for the cloned buffers.
149 typedef list<CloneList_ptr> CloneStore;
150 CloneStore cloned_buffers;
159 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
163 delete preview_loader_;
171 /// search for macro in local (buffer) table or in children
172 MacroData const * getBufferMacro(docstring const & name,
173 DocIterator const & pos) const;
175 /// Update macro table starting with position of it \param it in some
177 void updateMacros(DocIterator & it, DocIterator & scope);
179 void setLabel(ParIterator & it, UpdateType utype) const;
181 /** If we have branches that use the file suffix
182 feature, return the file name with suffix appended.
184 FileName exportFileName() const;
191 mutable TexRow texrow;
193 /// need to regenerate .tex?
196 /// name of the file the buffer is associated with.
200 mutable TocBackend toc_backend;
205 ScopeMacro(DocIterator const & s, MacroData const & m)
206 : scope(s), macro(m) {}
210 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
211 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
212 /// map from the macro name to the position map,
213 /// which maps the macro definition position to the scope and the MacroData.
214 NamePositionScopeMacroMap macros;
216 /// positions of child buffers in the buffer
217 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
219 ScopeBuffer() : buffer(nullptr) {}
220 ScopeBuffer(DocIterator const & s, Buffer const * b)
221 : scope(s), buffer(b) {}
223 Buffer const * buffer;
225 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
226 /// position of children buffers in this buffer
227 BufferPositionMap children_positions;
228 /// map from children inclusion positions to their scope and their buffer
229 PositionScopeBufferMap position_to_children;
231 /// Contains the old buffer filePath() while saving-as, or the
232 /// directory where the document was last saved while loading.
235 /** Keeps track of the path of local layout files.
236 * If possible, it is always relative to the buffer path.
237 * Empty for layouts in system or user directory.
239 string layout_position;
241 /// Container for all sort of Buffer dependant errors.
242 map<string, ErrorList> errorLists;
244 /// checksum used to test if the file has been externally modified. Used to
245 /// double check whether the file had been externally modified when saving.
246 unsigned long checksum_;
249 frontend::WorkAreaManager * wa_;
251 frontend::GuiBufferDelegate * gui_;
256 /// A cache for the bibfiles (including bibfiles of loaded child
257 /// documents), needed for appropriate update of natbib labels.
258 mutable docstring_list bibfiles_cache_;
260 // FIXME The caching mechanism could be improved. At present, we have a
261 // cache for each Buffer, that caches all the bibliography info for that
262 // Buffer. A more efficient solution would be to have a global cache per
263 // file, and then to construct the Buffer's bibinfo from that.
264 /// A cache for bibliography info
265 mutable BiblioInfo bibinfo_;
266 /// Cache of timestamps of .bib files
267 map<FileName, time_t> bibfile_status_;
269 /// These two hold the file name and format, written to by
270 /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
271 FileName preview_file_;
272 string preview_format_;
274 /// Cache the references associated to a label and their positions
276 mutable RefCache ref_cache_;
277 /// Cache the label insets and their activity status.
278 mutable LabelCache label_cache_;
280 /// our Text that should be wrapped in an InsetText
284 PreviewLoader * preview_loader_;
286 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
287 /// This one is useful for preview detached in a thread.
288 Buffer const * cloned_buffer_;
290 CloneList_ptr clone_list_;
293 std::list<Buffer const *> include_list_;
295 /// So we can force access via the accessors.
296 mutable Buffer const * parent_buffer;
298 FileMonitorPtr file_monitor_;
300 /// ints and bools are all listed last so as to avoid alignment issues
302 /// original format of loaded file
305 /// are we in the process of exporting this buffer?
306 mutable bool doing_export;
308 /// If there was an error when previewing, on the next preview we do
309 /// a fresh compile (e.g. in case the user installed a package that
311 bool require_fresh_start_;
313 /// Indicates whether the bibinfo has changed since the last time
314 /// we ran updateBuffer(), i.e., whether citation labels may need
316 mutable bool cite_labels_valid_;
317 /// Do we have a bibliography environment?
318 mutable bool have_bibitems_;
321 mutable bool lyx_clean;
323 /// is autosave needed?
324 mutable bool bak_clean;
326 /// is this an unnamed file (New...)?
329 /// is this an internal bufffer?
330 bool internal_buffer;
335 /** Set to true only when the file is fully loaded.
336 * Used to prevent the premature generation of previews
337 * and by the citation inset.
339 bool file_fully_loaded;
341 /// if the file was originally loaded from an older format, do
342 /// we need to back it up still?
343 bool need_format_backup;
345 /// Ignore the parent (e.g. when exporting a child standalone)?
348 /// This seem to change the way Buffer::getMacro() works
349 mutable bool macro_lock;
351 /// has been externally modified? Can be reset by the user.
352 mutable bool externally_modified_;
354 /// whether the bibinfo cache is valid
355 mutable bool bibinfo_cache_valid_;
358 mutable bool need_update;
366 /// This is here to force the test to be done whenever parent_buffer
368 Buffer const * parent() const
370 // ignore_parent temporarily "orphans" a buffer
371 // (e.g. if a child is compiled standalone)
374 // if parent_buffer is not loaded, then it has been unloaded,
375 // which means that parent_buffer is an invalid pointer. So we
376 // set it to null in that case.
377 // however, the BufferList doesn't know about cloned buffers, so
378 // they will always be regarded as unloaded. in that case, we hope
380 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
381 parent_buffer = nullptr;
382 return parent_buffer;
386 void setParent(Buffer const * pb)
388 if (parent_buffer == pb)
391 if (!cloned_buffer_ && parent_buffer && pb)
392 LYXERR0("Warning: a buffer should not have two parents!");
394 if (!cloned_buffer_ && parent_buffer)
395 parent_buffer->invalidateBibinfoCache();
398 /// compute statistics
399 /// \p from initial position
400 /// \p to points to the end position
401 void updateStatistics(DocIterator & from, DocIterator & to,
402 bool skipNoOutput = true);
403 /// statistics accessor functions
404 int wordCount() const
408 int charCount(bool with_blanks) const
411 + (with_blanks ? blank_count_ : 0);
414 // Make sure the file monitor monitors the good file.
415 void refreshFileMonitor();
417 /// Notify or clear of external modification
418 void fileExternallyModified(bool exists);
420 ///Binding LaTeX lines with buffer positions.
421 //Common routine for LaTeX and Reference errors listing.
422 void traverseErrors(TeXErrors::Errors::const_iterator err,
423 TeXErrors::Errors::const_iterator end,
424 ErrorList & errorList) const;
428 /// Creates the per buffer temporary directory
429 static FileName createBufferTmpDir()
431 // FIXME This would be the ideal application for a TempDir class (like
432 // TempFile but for directories)
437 Mutex::Locker locker(&mutex);
438 counter = convert<string>(count++);
440 // We are in our own directory. Why bother to mangle name?
441 // In fact I wrote this code to circumvent a problematic behaviour
442 // (bug?) of EMX mkstemp().
443 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
446 if (!tmpfl.createDirectory(0777)) {
447 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
448 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
449 from_utf8(tmpfl.absFileName())));
455 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
456 Buffer const * cloned_buffer)
457 : owner_(owner), filename(file), toc_backend(owner), checksum_(0),
458 wa_(nullptr), gui_(nullptr), undo_(*owner), inset(nullptr),
459 preview_loader_(nullptr), cloned_buffer_(cloned_buffer),
460 clone_list_(nullptr), parent_buffer(nullptr), file_format(LYX_FORMAT),
461 doing_export(false), require_fresh_start_(false), cite_labels_valid_(false),
462 have_bibitems_(false), lyx_clean(true), bak_clean(true), unnamed(false),
463 internal_buffer(false), read_only(readonly_), file_fully_loaded(false),
464 need_format_backup(false), ignore_parent(false), macro_lock(false),
465 externally_modified_(false), bibinfo_cache_valid_(false),
466 need_update(false), word_count_(0), char_count_(0), blank_count_(0)
468 refreshFileMonitor();
469 if (!cloned_buffer_) {
470 temppath = createBufferTmpDir();
471 lyxvc.setBuffer(owner_);
472 Language const * inplang = theApp() ?
473 languages.getFromCode(theApp()->inputLanguageCode())
476 params.language = inplang;
478 wa_ = new frontend::WorkAreaManager;
481 temppath = cloned_buffer_->d->temppath;
482 file_fully_loaded = true;
483 params = cloned_buffer_->d->params;
484 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
485 bibinfo_ = cloned_buffer_->d->bibinfo_;
486 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
487 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
488 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
489 have_bibitems_ = cloned_buffer_->d->have_bibitems_;
490 unnamed = cloned_buffer_->d->unnamed;
491 internal_buffer = cloned_buffer_->d->internal_buffer;
492 layout_position = cloned_buffer_->d->layout_position;
493 preview_file_ = cloned_buffer_->d->preview_file_;
494 preview_format_ = cloned_buffer_->d->preview_format_;
495 require_fresh_start_ = cloned_buffer_->d->require_fresh_start_;
499 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
500 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
502 LYXERR(Debug::INFO, "Buffer::Buffer()");
504 d->inset = new InsetText(*cloned_buffer->d->inset);
505 d->inset->setBuffer(*this);
506 // FIXME: optimize this loop somewhat, maybe by creating a new
507 // general recursive Inset::setId().
508 DocIterator it = doc_iterator_begin(this);
509 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
510 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
511 it.paragraph().setId(cloned_it.paragraph().id());
513 d->inset = new InsetText(this);
514 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
520 LYXERR(Debug::INFO, "Buffer::~Buffer()");
521 // here the buffer should take care that it is
522 // saved properly, before it goes into the void.
524 // GuiView already destroyed
528 // No need to do additional cleanups for internal buffer.
534 // this is in case of recursive includes: we won't try to delete
535 // ourselves as a child.
536 d->clone_list_->erase(this);
537 // loop over children
538 for (auto const & p : d->children_positions) {
539 Buffer * child = const_cast<Buffer *>(p.first);
540 if (d->clone_list_->erase(child))
543 // if we're the master buffer, then we should get rid of the list
546 // If this is not empty, we have leaked something. Worse, one of the
547 // children still has a reference to this list. But we will try to
548 // continue, rather than shut down.
549 LATTEST(d->clone_list_->empty());
550 // The clone list itself is empty, but it's still referenced in our list
551 // of clones. So let's find it and remove it.
552 CloneStore::iterator it =
553 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
554 if (it == cloned_buffers.end()) {
555 // We will leak in this case, but it is safe to continue.
558 cloned_buffers.erase(it);
560 // FIXME Do we really need to do this right before we delete d?
561 // clear references to children in macro tables
562 d->children_positions.clear();
563 d->position_to_children.clear();
565 // loop over children
566 for (auto const & p : d->children_positions) {
567 Buffer * child = const_cast<Buffer *>(p.first);
568 if (theBufferList().isLoaded(child)) {
569 if (theBufferList().isOthersChild(this, child))
570 child->setParent(nullptr);
572 theBufferList().release(child);
577 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
579 msg += emergencyWrite();
581 msg += " " + _("Save failed! Document is lost.");
583 Alert::warning(_("Attempting to close changed document!"), msg);
586 // FIXME Do we really need to do this right before we delete d?
587 // clear references to children in macro tables
588 d->children_positions.clear();
589 d->position_to_children.clear();
591 if (!d->temppath.destroyDirectory()) {
592 LYXERR0(bformat(_("Could not remove the temporary directory %1$s"),
593 from_utf8(d->temppath.absFileName())));
602 Buffer * Buffer::cloneWithChildren() const
605 cloned_buffers.emplace_back(new CloneList);
606 CloneList_ptr clones = cloned_buffers.back();
608 cloneWithChildren(bufmap, clones);
610 // make sure we got cloned
611 BufferMap::const_iterator bit = bufmap.find(this);
612 LASSERT(bit != bufmap.end(), return nullptr);
613 Buffer * cloned_buffer = bit->second;
615 return cloned_buffer;
619 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList_ptr clones) const
621 // have we already been cloned?
622 if (bufmap.find(this) != bufmap.end())
625 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
627 // The clone needs its own DocumentClass, since running updateBuffer() will
628 // modify it, and we would otherwise be sharing it with the original Buffer.
629 buffer_clone->params().makeDocumentClass(true);
631 cap::switchBetweenClasses(
632 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
633 static_cast<InsetText &>(buffer_clone->inset()), el);
635 bufmap[this] = buffer_clone;
636 clones->insert(buffer_clone);
637 buffer_clone->d->clone_list_ = clones;
638 buffer_clone->d->macro_lock = true;
639 buffer_clone->d->children_positions.clear();
641 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
642 // math macro caches need to be rethought and simplified.
643 // I am not sure wether we should handle Buffer cloning here or in BufferList.
644 // Right now BufferList knows nothing about buffer clones.
645 for (auto const & p : d->position_to_children) {
646 DocIterator dit = p.first.clone(buffer_clone);
647 dit.setBuffer(buffer_clone);
648 Buffer * child = const_cast<Buffer *>(p.second.buffer);
650 child->cloneWithChildren(bufmap, clones);
651 BufferMap::iterator const bit = bufmap.find(child);
652 LASSERT(bit != bufmap.end(), continue);
653 Buffer * child_clone = bit->second;
655 Inset * inset = dit.nextInset();
656 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
657 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
658 inset_inc->setChildBuffer(child_clone);
659 child_clone->d->setParent(buffer_clone);
660 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
661 buffer_clone->setChild(dit, child_clone);
663 buffer_clone->d->macro_lock = false;
667 Buffer * Buffer::cloneBufferOnly() const {
668 cloned_buffers.emplace_back(new CloneList);
669 CloneList_ptr clones = cloned_buffers.back();
670 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
672 // The clone needs its own DocumentClass, since running updateBuffer() will
673 // modify it, and we would otherwise be sharing it with the original Buffer.
674 buffer_clone->params().makeDocumentClass(true);
676 cap::switchBetweenClasses(
677 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
678 static_cast<InsetText &>(buffer_clone->inset()), el);
680 clones->insert(buffer_clone);
681 buffer_clone->d->clone_list_ = clones;
683 // we won't be cloning the children
684 buffer_clone->d->children_positions.clear();
689 bool Buffer::isClone() const
691 return d->cloned_buffer_;
695 void Buffer::changed(bool update_metrics) const
698 d->wa_->redrawAll(update_metrics);
702 frontend::WorkAreaManager & Buffer::workAreaManager() const
709 Text & Buffer::text() const
711 return d->inset->text();
715 Inset & Buffer::inset() const
721 BufferParams & Buffer::params()
727 BufferParams const & Buffer::params() const
733 BufferParams const & Buffer::masterParams() const
735 if (masterBuffer() == this)
738 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
739 // Copy child authors to the params. We need those pointers.
740 for (Author const & a : params().authors())
741 mparams.authors().record(a);
746 double Buffer::fontScalingFactor() const
748 return isExporting() ? 75.0 * params().html_math_img_scale
749 : 0.01 * lyxrc.dpi * lyxrc.currentZoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
753 ParagraphList & Buffer::paragraphs()
755 return text().paragraphs();
759 ParagraphList const & Buffer::paragraphs() const
761 return text().paragraphs();
765 LyXVC & Buffer::lyxvc()
771 LyXVC const & Buffer::lyxvc() const
777 string const Buffer::temppath() const
779 return d->temppath.absFileName();
783 TexRow & Buffer::texrow()
789 TexRow const & Buffer::texrow() const
795 TocBackend & Buffer::tocBackend() const
797 return d->toc_backend;
801 Undo & Buffer::undo()
807 void Buffer::setChild(DocIterator const & dit, Buffer * child)
809 d->children_positions[child] = dit;
813 string Buffer::latexName(bool const no_path) const
815 FileName latex_name =
816 makeLatexName(d->exportFileName());
817 return no_path ? latex_name.onlyFileName()
818 : latex_name.absFileName();
822 FileName Buffer::Impl::exportFileName() const
824 docstring const branch_suffix =
825 params.branchlist().getFileNameSuffix();
826 if (branch_suffix.empty())
829 string const name = addExtension(filename.onlyFileNameWithoutExt()
830 + to_utf8(branch_suffix), filename.extension());
831 FileName res(filename.onlyPath().absFileName() + "/" + name);
837 string Buffer::logName(LogType * type) const
839 string const filename = latexName(false);
841 if (filename.empty()) {
847 string const path = temppath();
849 FileName const fname(addName(temppath(),
850 onlyFileName(changeExtension(filename,
853 // FIXME: how do we know this is the name of the build log?
854 FileName const bname(
855 addName(path, onlyFileName(
856 changeExtension(filename,
857 theFormats().extension(params().bufferFormat()) + ".out"))));
859 // Also consider the master buffer log file
860 FileName masterfname = fname;
861 LogType mtype = latexlog;
862 if (masterBuffer() != this) {
863 string const mlogfile = masterBuffer()->logName(&mtype);
864 masterfname = FileName(mlogfile);
867 // If no Latex log or Build log is newer, show Build log
868 if (bname.exists() &&
869 ((!fname.exists() && !masterfname.exists())
870 || (fname.lastModified() < bname.lastModified()
871 && masterfname.lastModified() < bname.lastModified()))) {
872 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
875 return bname.absFileName();
876 // If we have a newer master file log or only a master log, show this
877 } else if (fname != masterfname
878 && (!fname.exists() && (masterfname.exists()
879 || fname.lastModified() < masterfname.lastModified()))) {
880 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
883 return masterfname.absFileName();
885 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
888 return fname.absFileName();
892 void Buffer::setReadonly(bool const flag)
894 if (d->read_only != flag) {
901 void Buffer::setFileName(FileName const & fname)
903 bool const changed = fname != d->filename;
905 d->refreshFileMonitor();
907 lyxvc().file_found_hook(fname);
908 setReadonly(d->filename.isReadOnly());
914 int Buffer::readHeader(Lexer & lex)
916 int unknown_tokens = 0;
918 int begin_header_line = -1;
920 // Initialize parameters that may be/go lacking in header:
921 params().branchlist().clear();
922 params().preamble.erase();
923 params().options.erase();
924 params().master.erase();
925 params().float_placement.erase();
926 params().float_alignment.erase();
927 params().paperwidth.erase();
928 params().paperheight.erase();
929 params().leftmargin.erase();
930 params().rightmargin.erase();
931 params().topmargin.erase();
932 params().bottommargin.erase();
933 params().headheight.erase();
934 params().headsep.erase();
935 params().footskip.erase();
936 params().columnsep.erase();
937 params().font_roman_opts.erase();
938 params().font_sans_opts.erase();
939 params().font_typewriter_opts.erase();
940 params().fonts_cjk.erase();
941 params().listings_params.clear();
942 params().clearLayoutModules();
943 params().clearRemovedModules();
944 params().clearIncludedChildren();
945 params().pdfoptions().clear();
946 params().indiceslist().clear();
947 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
948 params().isbackgroundcolor = false;
949 params().fontcolor = RGBColor(0, 0, 0);
950 params().isfontcolor = false;
951 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
952 params().isnotefontcolor = false;
953 params().boxbgcolor = RGBColor(0xFF, 0, 0);
954 params().isboxbgcolor = false;
955 params().html_latex_start.clear();
956 params().html_latex_end.clear();
957 params().html_math_img_scale = 1.0;
958 params().output_sync_macro.erase();
959 params().setLocalLayout(docstring(), false);
960 params().setLocalLayout(docstring(), true);
961 params().biblio_opts.erase();
962 params().biblatex_bibstyle.erase();
963 params().biblatex_citestyle.erase();
964 params().multibib.erase();
965 params().lineno_opts.clear();
967 for (int i = 0; i < 4; ++i) {
968 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
969 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
972 ErrorList & errorList = d->errorLists["Parse"];
981 if (token == "\\end_header")
985 if (token == "\\begin_header") {
986 begin_header_line = line;
990 LYXERR(Debug::PARSER, "Handling document header token: `"
993 string const result =
994 params().readToken(lex, token, d->filename);
995 if (!result.empty()) {
996 if (token == "\\textclass") {
997 d->layout_position = result;
1000 docstring const s = bformat(_("Unknown token: "
1003 lex.getDocString());
1004 errorList.push_back(ErrorItem(_("Document header error"), s));
1008 if (begin_header_line) {
1009 docstring const s = _("\\begin_header is missing");
1010 errorList.push_back(ErrorItem(_("Document header error"), s));
1013 params().shell_escape = theSession().shellescapeFiles().find(absFileName());
1015 params().makeDocumentClass(isClone(), isInternal());
1017 return unknown_tokens;
1022 // changed to be public and have one parameter
1023 // Returns true if "\end_document" is not read (Asger)
1024 bool Buffer::readDocument(Lexer & lex)
1026 ErrorList & errorList = d->errorLists["Parse"];
1029 // remove dummy empty par
1030 paragraphs().clear();
1032 if (!lex.checkFor("\\begin_document")) {
1033 docstring const s = _("\\begin_document is missing");
1034 errorList.push_back(ErrorItem(_("Document header error"), s));
1039 if (params().output_changes) {
1040 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1041 LaTeXFeatures::isAvailable("xcolor");
1044 Alert::warning(_("Changes not shown in LaTeX output"),
1045 _("Changes will not be highlighted in LaTeX output, "
1046 "because xcolor and ulem are not installed.\n"
1047 "Please install both packages or redefine "
1048 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1052 if (!parent() && !params().master.empty()) {
1053 FileName const master_file = makeAbsPath(params().master,
1054 onlyPath(absFileName()));
1055 if (isLyXFileName(master_file.absFileName())) {
1057 checkAndLoadLyXFile(master_file, true);
1059 // necessary e.g. after a reload
1060 // to re-register the child (bug 5873)
1061 // FIXME: clean up updateMacros (here, only
1062 // child registering is needed).
1063 master->updateMacros();
1064 // set master as master buffer, but only
1065 // if we are a real child
1066 if (master->isChild(this))
1068 // if the master is not fully loaded
1069 // it is probably just loading this
1070 // child. No warning needed then.
1071 else if (master->isFullyLoaded())
1072 LYXERR0("The master '"
1074 << "' assigned to this document ("
1076 << ") does not include "
1077 "this document. Ignoring the master assignment.");
1078 // If the master has just been created, un-hide it (#11162)
1079 if (!master->fileName().exists())
1080 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
1081 master->absFileName()));
1086 // assure we have a default index
1087 params().indiceslist().addDefault(B_("Index"));
1090 if (FileName::isAbsolute(params().origin))
1091 d->old_position = params().origin;
1093 d->old_position = filePath();
1098 bool const res = text().read(lex, errorList, d->inset);
1099 d->old_position.clear();
1101 // inform parent buffer about local macros
1103 Buffer const * pbuf = parent();
1104 for (auto const & m : usermacros)
1105 pbuf->usermacros.insert(m);
1109 updateMacroInstances(InternalUpdate);
1114 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1116 Format const * fmt = theFormats().getFormat(format);
1119 // It is important to use the correct extension here, since some
1120 // converters create a wrong output file otherwise (e.g. html2latex)
1121 FileName const name = tempFileName("Buffer_importStringXXXXXX." + fmt->extension());
1122 ofdocstream os(name.toFilesystemEncoding().c_str());
1123 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1124 bool const success = !(os << contents).fail();
1127 bool converted = false;
1129 params().compressed = false;
1131 // remove dummy empty par
1132 paragraphs().clear();
1134 converted = importFile(format, name, errorList);
1137 removeTempFile(name);
1142 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1144 if (!theConverters().isReachable(format, "lyx"))
1147 FileName const lyx = tempFileName("Buffer_importFileXXXXXX.lyx");
1148 Converters::RetVal const retval =
1149 theConverters().convert(nullptr, name, lyx, name, format, "lyx", errorList);
1150 if (retval == Converters::SUCCESS) {
1151 bool const success = readFile(lyx) == ReadSuccess;
1152 removeTempFile(lyx);
1160 bool Buffer::readString(string const & s)
1162 params().compressed = false;
1165 istringstream is(s);
1167 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1168 FileName const fn = tempfile.name();
1171 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1173 if (success && file_format != LYX_FORMAT) {
1174 // We need to call lyx2lyx, so write the input to a file
1175 ofstream os(fn.toFilesystemEncoding().c_str());
1178 // lyxvc in readFile
1179 if (readFile(fn) != ReadSuccess)
1183 if (readDocument(lex))
1189 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1192 if (!lex.setFile(fn)) {
1193 Alert::error(_("File Not Found"),
1194 bformat(_("Unable to open file `%1$s'."),
1195 from_utf8(fn.absFileName())));
1196 return ReadFileNotFound;
1200 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1201 if (ret_plf != ReadSuccess)
1204 if (file_format != LYX_FORMAT) {
1206 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1207 if (ret_clf != ReadSuccess)
1209 ret_clf = readFile(tmpFile);
1210 if (ret_clf == ReadSuccess) {
1211 d->file_format = file_format;
1212 d->need_format_backup = true;
1217 // FIXME: InsetInfo needs to know whether the file is under VCS
1218 // during the parse process, so this has to be done before.
1219 lyxvc().file_found_hook(d->filename);
1221 if (readDocument(lex)) {
1222 Alert::error(_("Document format failure"),
1223 bformat(_("%1$s ended unexpectedly, which means"
1224 " that it is probably corrupted."),
1225 from_utf8(fn.absFileName())));
1226 return ReadDocumentFailure;
1229 d->file_fully_loaded = true;
1230 d->read_only = !d->filename.isWritable();
1231 params().compressed = theFormats().isZippedFile(d->filename);
1237 bool Buffer::isFullyLoaded() const
1239 return d->file_fully_loaded;
1243 void Buffer::setFullyLoaded(bool value)
1245 d->file_fully_loaded = value;
1249 bool Buffer::freshStartRequired() const
1251 return d->require_fresh_start_;
1254 void Buffer::requireFreshStart(bool const b) const
1256 d->require_fresh_start_ = b;
1260 PreviewLoader * Buffer::loader() const
1262 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1264 if (!d->preview_loader_)
1265 d->preview_loader_ = new PreviewLoader(*this);
1266 return d->preview_loader_;
1270 void Buffer::removePreviews() const
1272 delete d->preview_loader_;
1273 d->preview_loader_ = nullptr;
1277 void Buffer::updatePreviews() const
1279 PreviewLoader * ploader = loader();
1283 InsetIterator it = begin(*d->inset);
1284 InsetIterator const itend = end(*d->inset);
1285 for (; it != itend; ++it)
1286 it->addPreview(it, *ploader);
1288 ploader->startLoading();
1292 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1293 FileName const & fn, int & file_format) const
1295 if(!lex.checkFor("\\lyxformat")) {
1296 Alert::error(_("Document format failure"),
1297 bformat(_("%1$s is not a readable LyX document."),
1298 from_utf8(fn.absFileName())));
1299 return ReadNoLyXFormat;
1305 // LyX formats 217 and earlier were written as 2.17. This corresponds
1306 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1307 // these cases. See also: www.lyx.org/trac/changeset/1313.
1308 size_t dot = tmp_format.find_first_of(".,");
1309 if (dot != string::npos)
1310 tmp_format.erase(dot, 1);
1312 file_format = convert<int>(tmp_format);
1317 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1318 FileName & tmpfile, int from_format)
1320 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1321 tempfile.setAutoRemove(false);
1322 tmpfile = tempfile.name();
1323 if(tmpfile.empty()) {
1324 Alert::error(_("Conversion failed"),
1325 bformat(_("%1$s is from a different"
1326 " version of LyX, but a temporary"
1327 " file for converting it could"
1328 " not be created."),
1329 from_utf8(fn.absFileName())));
1330 return LyX2LyXNoTempFile;
1333 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1334 if (lyx2lyx.empty()) {
1335 Alert::error(_("Conversion script not found"),
1336 bformat(_("%1$s is from a different"
1337 " version of LyX, but the"
1338 " conversion script lyx2lyx"
1339 " could not be found."),
1340 from_utf8(fn.absFileName())));
1341 return LyX2LyXNotFound;
1345 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1346 ostringstream command;
1347 command << os::python()
1348 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1349 << " -t " << convert<string>(LYX_FORMAT)
1350 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1351 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1352 string const command_str = command.str();
1354 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1356 cmd_ret const ret = runCommand(command_str);
1358 if (from_format < LYX_FORMAT) {
1359 Alert::error(_("Conversion script failed"),
1360 bformat(_("%1$s is from an older version"
1361 " of LyX and the lyx2lyx script"
1362 " failed to convert it."),
1363 from_utf8(fn.absFileName())));
1364 return LyX2LyXOlderFormat;
1366 Alert::error(_("Conversion script failed"),
1367 bformat(_("%1$s is from a newer version"
1368 " of LyX and the lyx2lyx script"
1369 " failed to convert it."),
1370 from_utf8(fn.absFileName())));
1371 return LyX2LyXNewerFormat;
1378 FileName Buffer::getBackupName() const {
1379 map<int, string> const file_formats = {
1396 FileName const & fn = fileName();
1397 string const fname = fn.onlyFileNameWithoutExt();
1398 string const fext = fn.extension() + "~";
1399 string const fpath = lyxrc.backupdir_path.empty() ?
1400 fn.onlyPath().absFileName() :
1401 lyxrc.backupdir_path;
1402 string backup_suffix;
1403 // If file format is from a stable series use version instead of file format
1404 auto const it = file_formats.find(d->file_format);
1405 if (it != file_formats.end())
1406 backup_suffix = "-lyx" + it->second;
1408 backup_suffix = "-lyxformat-" + convert<string>(d->file_format);
1409 string const backname = fname + backup_suffix;
1410 FileName backup(addName(fpath, addExtension(backname, fext)));
1412 // limit recursion, just in case
1414 unsigned long orig_checksum = 0;
1415 while (backup.exists() && v < 100) {
1416 if (orig_checksum == 0)
1417 orig_checksum = fn.checksum();
1418 unsigned long new_checksum = backup.checksum();
1419 if (orig_checksum == new_checksum) {
1420 LYXERR(Debug::FILES, "Not backing up " << fn <<
1421 "since " << backup << "has the same checksum.");
1422 // a bit of a hack, but we have to check this anyway
1423 // below, and setting this is simpler than introducing
1424 // a special boolean for this purpose.
1428 string const newbackname = backname + "-" + convert<string>(v);
1429 backup.set(addName(fpath, addExtension(newbackname, fext)));
1432 return v < 100 ? backup : FileName();
1436 // Should probably be moved to somewhere else: BufferView? GuiView?
1437 bool Buffer::save() const
1439 docstring const file = makeDisplayPath(absFileName(), 20);
1440 d->filename.refresh();
1442 // check the read-only status before moving the file as a backup
1443 if (d->filename.exists()) {
1444 bool const read_only = !d->filename.isWritable();
1446 Alert::warning(_("File is read-only"),
1447 bformat(_("The file %1$s cannot be written because it "
1448 "is marked as read-only."), file));
1453 // ask if the disk file has been externally modified (use checksum method)
1454 if (fileName().exists() && isChecksumModified()) {
1456 bformat(_("Document %1$s has been externally modified. "
1457 "Are you sure you want to overwrite this file?"), file);
1458 int const ret = Alert::prompt(_("Overwrite modified file?"),
1459 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1464 // We don't need autosaves in the immediate future. (Asger)
1465 resetAutosaveTimers();
1467 // if the file does not yet exist, none of the backup activity
1468 // that follows is necessary
1469 if (!fileName().exists()) {
1470 if (!writeFile(fileName()))
1476 // we first write the file to a new name, then move it to its
1477 // proper location once that has been done successfully. that
1478 // way we preserve the original file if something goes wrong.
1479 string const justname = fileName().onlyFileNameWithoutExt();
1480 auto tempfile = lyx::make_unique<TempFile>(fileName().onlyPath(),
1481 justname + "-XXXXXX.lyx");
1482 bool const symlink = fileName().isSymLink();
1484 tempfile->setAutoRemove(false);
1486 FileName savefile(tempfile->name());
1487 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1488 if (!savefile.clonePermissions(fileName()))
1489 LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
1491 if (!writeFile(savefile))
1494 // we will set this to false if we fail
1495 bool made_backup = true;
1497 FileName backupName;
1498 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1500 if (d->need_format_backup)
1501 backupName = getBackupName();
1503 // If we for some reason failed to find a backup name in case of
1504 // a format change, this will still set one. It's the best we can
1506 if (backupName.empty()) {
1507 backupName.set(fileName().absFileName() + "~");
1508 if (!lyxrc.backupdir_path.empty()) {
1509 string const mangledName =
1510 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1511 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1515 LYXERR(Debug::FILES, "Backing up original file to " <<
1516 backupName.absFileName());
1517 // Except file is symlink do not copy because of #6587.
1518 // Hard links have bad luck.
1519 made_backup = symlink ?
1520 fileName().copyTo(backupName):
1521 fileName().moveTo(backupName);
1524 Alert::error(_("Backup failure"),
1525 bformat(_("Cannot create backup file %1$s.\n"
1526 "Please check whether the directory exists and is writable."),
1527 from_utf8(backupName.absFileName())));
1528 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1529 } else if (d->need_format_backup) {
1530 // the original file has been backed up successfully, so we
1531 // will not need to do that again
1532 d->need_format_backup = false;
1536 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1537 // Only do this if tempfile is not in autoremove mode
1540 // If we have no symlink, we can simply rename the temp file.
1541 // Otherwise, we need to copy it so the symlink stays intact.
1542 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1543 savefile.moveTo(fileName()))
1545 // saveCheckSum() was already called by writeFile(), but the
1546 // time stamp is invalidated by copying/moving
1549 // the file associated with this buffer is now in the current format
1550 d->file_format = LYX_FORMAT;
1553 // else we saved the file, but failed to move it to the right location.
1555 if (needBackup && made_backup && !symlink) {
1556 // the original file was moved to some new location, so it will look
1557 // to the user as if it was deleted. (see bug #9234.) we could try
1558 // to restore it, but that would basically mean trying to do again
1559 // what we just failed to do. better to leave things as they are.
1560 Alert::error(_("Write failure"),
1561 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1562 "But LyX could not move it to:\n %2$s.\n"
1563 "Your original file has been backed up to:\n %3$s"),
1564 from_utf8(savefile.absFileName()),
1565 from_utf8(fileName().absFileName()),
1566 from_utf8(backupName.absFileName())));
1568 // either we did not try to make a backup, or else we tried and failed,
1569 // or else the original file was a symlink, in which case it was copied,
1570 // not moved. so the original file is intact.
1571 Alert::error(_("Write failure"),
1572 bformat(_("Cannot move saved file to:\n %1$s.\n"
1573 "But the file has successfully been saved as:\n %2$s."),
1574 from_utf8(fileName().absFileName()),
1575 from_utf8(savefile.absFileName())));
1581 bool Buffer::writeFile(FileName const & fname) const
1583 if (d->read_only && fname == d->filename)
1586 bool retval = false;
1588 docstring const str = bformat(_("Saving document %1$s..."),
1589 makeDisplayPath(fname.absFileName()));
1592 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1594 if (params().compressed) {
1595 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1596 retval = ofs && write(ofs);
1598 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1599 retval = ofs && write(ofs);
1603 message(str + _(" could not write file!"));
1608 // removeAutosaveFile();
1611 message(str + _(" done."));
1617 docstring Buffer::emergencyWrite() const
1619 // No need to save if the buffer has not changed.
1623 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1625 docstring user_message = bformat(
1626 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1628 // We try to save three places:
1629 // 1) Same place as document. Unless it is an unnamed doc.
1631 string s = absFileName();
1634 if (writeFile(FileName(s))) {
1636 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1637 return user_message;
1639 user_message += " " + _("Save failed! Trying again...\n");
1643 // 2) In HOME directory.
1644 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1646 lyxerr << ' ' << s << endl;
1647 if (writeFile(FileName(s))) {
1649 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1650 return user_message;
1653 user_message += " " + _("Save failed! Trying yet again...\n");
1655 // 3) In "/tmp" directory.
1656 // MakeAbsPath to prepend the current
1657 // drive letter on OS/2
1658 s = addName(package().temp_dir().absFileName(), absFileName());
1660 lyxerr << ' ' << s << endl;
1661 if (writeFile(FileName(s))) {
1663 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1664 return user_message;
1667 user_message += " " + _("Save failed! Document is lost.");
1670 return user_message;
1674 bool Buffer::write(ostream & ofs) const
1677 // Use the standard "C" locale for file output.
1678 ofs.imbue(locale::classic());
1681 // The top of the file should not be written by params().
1683 // write out a comment in the top of the file
1684 // Important: Keep the version formatting in sync with lyx2lyx and
1685 // tex2lyx (bug 7951)
1686 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1687 << " created this file. For more info see https://www.lyx.org/\n"
1688 << "\\lyxformat " << LYX_FORMAT << "\n"
1689 << "\\begin_document\n";
1691 /// For each author, set 'used' to true if there is a change
1692 /// by this author in the document; otherwise set it to 'false'.
1693 for (Author const & a : params().authors())
1696 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1697 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1698 for ( ; it != end; ++it)
1699 it->checkAuthors(params().authors());
1701 // now write out the buffer parameters.
1702 ofs << "\\begin_header\n";
1703 params().writeFile(ofs, this);
1704 ofs << "\\end_header\n";
1707 ofs << "\n\\begin_body\n";
1709 ofs << "\n\\end_body\n";
1711 // Write marker that shows file is complete
1712 ofs << "\\end_document" << endl;
1714 // Shouldn't really be needed....
1717 // how to check if close went ok?
1718 // Following is an attempt... (BE 20001011)
1720 // good() returns false if any error occurred, including some
1721 // formatting error.
1722 // bad() returns true if something bad happened in the buffer,
1723 // which should include file system full errors.
1728 lyxerr << "File was not closed properly." << endl;
1735 Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
1736 string const & original_path,
1737 OutputParams const & runparams_in,
1738 OutputWhat output) const
1740 OutputParams runparams = runparams_in;
1742 string const encoding = runparams.encoding->iconvName();
1743 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1746 try { ofs.reset(encoding); }
1747 catch (iconv_codecvt_facet_exception const & e) {
1748 lyxerr << "Caught iconv exception: " << e.what() << endl;
1749 Alert::error(_("Iconv software exception Detected"),
1750 bformat(_("Please verify that the `iconv' support software is"
1751 " properly installed and supports the selected encoding"
1752 " (%1$s), or change the encoding in"
1753 " Document>Settings>Language."), from_ascii(encoding)));
1756 if (!openFileWrite(ofs, fname))
1759 ErrorList & errorList = d->errorLists["Export"];
1761 ExportStatus status = ExportSuccess;
1764 // make sure we are ready to export
1765 // this needs to be done before we validate
1766 // FIXME Do we need to do this all the time? I.e., in children
1767 // of a master we are exporting?
1769 updateMacroInstances(OutputUpdate);
1771 ExportStatus retval;
1773 retval = writeLaTeXSource(os, original_path, runparams, output);
1774 if (retval == ExportKilled)
1775 return ExportKilled;
1777 catch (EncodingException const & e) {
1778 docstring const failed(1, e.failed_char);
1780 oss << "0x" << hex << static_cast<uint32_t>(e.failed_char) << dec;
1781 if (getParFromID(e.par_id).paragraph().layout().pass_thru) {
1782 docstring msg = bformat(_("Uncodable character '%1$s'"
1783 " (code point %2$s)"),
1784 failed, from_utf8(oss.str()));
1785 errorList.push_back(ErrorItem(msg, _("Some characters of your document are not "
1786 "representable in specific verbatim contexts.\n"
1787 "Changing the document encoding to utf8 could help."),
1788 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1790 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1791 " (code point %2$s)"),
1792 failed, from_utf8(oss.str()));
1793 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1794 "representable in the chosen encoding.\n"
1795 "Changing the document encoding to utf8 could help."),
1796 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1798 status = ExportError;
1800 catch (iconv_codecvt_facet_exception const & e) {
1801 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1803 status = ExportError;
1805 catch (exception const & e) {
1806 errorList.push_back(ErrorItem(_("conversion failed"),
1808 lyxerr << e.what() << endl;
1809 status = ExportError;
1812 lyxerr << "Caught some really weird exception..." << endl;
1816 d->texrow = move(os.texrow());
1820 status = ExportError;
1821 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1824 if (runparams_in.silent)
1832 Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
1833 string const & original_path,
1834 OutputParams const & runparams_in,
1835 OutputWhat output) const
1837 // The child documents, if any, shall be already loaded at this point.
1839 OutputParams runparams = runparams_in;
1841 // Some macros rely on font encoding
1842 runparams.main_fontenc = params().main_font_encoding();
1844 // If we are compiling a file standalone, even if this is the
1845 // child of some other buffer, let's cut the link here, so the
1846 // file is really independent and no concurring settings from
1847 // the master (e.g. branch state) interfere (see #8100).
1848 if (!runparams.is_child)
1849 d->ignore_parent = true;
1851 // Classify the unicode characters appearing in math insets
1852 BufferEncodings::initUnicodeMath(*this);
1854 // validate the buffer.
1855 LYXERR(Debug::LATEX, " Validating buffer...");
1856 LaTeXFeatures features(*this, params(), runparams);
1858 // This is only set once per document (in master)
1859 if (!runparams.is_child) {
1860 runparams.use_polyglossia = features.usePolyglossia();
1861 runparams.use_hyperref = features.isRequired("hyperref");
1862 runparams.use_CJK = features.mustProvide("CJK");
1864 LYXERR(Debug::LATEX, " Buffer validation done.");
1866 bool const output_preamble =
1867 output == FullSource || output == OnlyPreamble;
1868 bool const output_body =
1869 output == FullSource || output == OnlyBody;
1871 // The starting paragraph of the coming rows is the
1872 // first paragraph of the document. (Asger)
1873 if (output_preamble && runparams.nice) {
1874 os << "%% LyX " << lyx_version << " created this file. "
1875 "For more info, see https://www.lyx.org/.\n"
1876 "%% Do not edit unless you really know what "
1879 LYXERR(Debug::INFO, "lyx document header finished");
1881 // There are a few differences between nice LaTeX and usual files:
1882 // usual files have \batchmode and special input@path to allow
1883 // inclusion of figures specified by an explicitly relative path
1884 // (i.e., a path starting with './' or '../') with either \input or
1885 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1886 // input@path is set when the actual parameter original_path is set.
1887 // This is done for usual tex-file, but not for nice-latex-file.
1888 // (Matthias 250696)
1889 // Note that input@path is only needed for something the user does
1890 // in the preamble, included .tex files or ERT, files included by
1891 // LyX work without it.
1892 if (output_preamble) {
1893 if (!runparams.nice) {
1894 // code for usual, NOT nice-latex-file
1895 os << "\\batchmode\n"; // changed from \nonstopmode
1897 if (!original_path.empty()) {
1899 // We don't know the encoding of inputpath
1900 docstring const inputpath = from_utf8(original_path);
1901 docstring uncodable_glyphs;
1902 Encoding const * const enc = runparams.encoding;
1904 for (char_type n : inputpath) {
1905 if (!enc->encodable(n)) {
1906 docstring const glyph(1, n);
1907 LYXERR0("Uncodable character '"
1909 << "' in input path!");
1910 uncodable_glyphs += glyph;
1915 // warn user if we found uncodable glyphs.
1916 if (!uncodable_glyphs.empty()) {
1917 frontend::Alert::warning(
1918 _("Uncodable character in file path"),
1920 _("The path of your document\n"
1922 "contains glyphs that are unknown "
1923 "in the current document encoding "
1924 "(namely %2$s). This may result in "
1925 "incomplete output, unless "
1926 "TEXINPUTS contains the document "
1927 "directory and you don't use "
1928 "explicitly relative paths (i.e., "
1929 "paths starting with './' or "
1930 "'../') in the preamble or in ERT."
1931 "\n\nIn case of problems, choose "
1932 "an appropriate document encoding\n"
1933 "(such as utf8) or change the "
1935 inputpath, uncodable_glyphs));
1937 string docdir = os::latex_path(original_path);
1938 if (contains(docdir, '#')) {
1939 docdir = subst(docdir, "#", "\\#");
1940 os << "\\catcode`\\#=11"
1941 "\\def\\#{#}\\catcode`\\#=6\n";
1943 if (contains(docdir, '%')) {
1944 docdir = subst(docdir, "%", "\\%");
1945 os << "\\catcode`\\%=11"
1946 "\\def\\%{%}\\catcode`\\%=14\n";
1948 if (contains(docdir, '~'))
1949 docdir = subst(docdir, "~", "\\string~");
1950 bool const nonascii = !isAscii(from_utf8(docdir));
1951 // LaTeX 2019/10/01 handles non-ascii path without detokenize
1952 bool const utfpathlatex = features.isAvailable("LaTeX-2019/10/01");
1953 bool const detokenize = !utfpathlatex && nonascii;
1954 bool const quote = contains(docdir, ' ');
1955 if (utfpathlatex && nonascii)
1956 os << "\\UseRawInputEncoding\n";
1957 os << "\\makeatletter\n"
1958 << "\\def\\input@path{{";
1960 os << "\\detokenize{";
1969 << "\\makeatother\n";
1973 // get parent macros (if this buffer has a parent) which will be
1974 // written at the document begin further down.
1975 MacroSet parentMacros;
1976 listParentMacros(parentMacros, features);
1978 // Write the preamble
1979 runparams.use_babel = params().writeLaTeX(os, features,
1980 d->filename.onlyPath());
1982 // Active characters
1983 runparams.active_chars = features.getActiveChars();
1985 // Biblatex bibliographies are loaded here
1986 if (params().useBiblatex()) {
1987 vector<pair<docstring, string>> const bibfiles =
1988 prepareBibFilePaths(runparams, getBibfiles(), true);
1989 for (pair<docstring, string> const & file: bibfiles) {
1990 os << "\\addbibresource";
1991 if (!file.second.empty())
1992 os << "[bibencoding=" << file.second << "]";
1993 os << "{" << file.first << "}\n";
1997 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1998 && !features.hasOnlyPolyglossiaLanguages()) {
2001 vector<string> bll = features.getBabelExclusiveLanguages();
2002 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
2005 for (string const & sit : bll) {
2010 blangs = bll.size() > 1 ?
2011 bformat(_("The languages %1$s are only supported by Babel."), langs)
2012 : bformat(_("The language %1$s is only supported by Babel."), langs);
2016 for (string const & pit : pll) {
2021 plangs = pll.size() > 1 ?
2022 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
2023 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
2024 if (!blangs.empty())
2028 frontend::Alert::warning(
2029 _("Incompatible Languages!"),
2031 _("You cannot use the following languages "
2032 "together in one LaTeX document because "
2033 "they require conflicting language packages:\n"
2038 // Japanese might be required only in some children of a document,
2039 // but once required, we must keep use_japanese true.
2040 runparams.use_japanese |= features.isRequired("japanese");
2043 // Restore the parenthood if needed
2044 if (!runparams.is_child)
2045 d->ignore_parent = false;
2046 return ExportSuccess;
2050 // mark the beginning of the body to separate it from InPreamble insets
2051 os.texrow().start(TexRow::beginDocument());
2052 os << "\\begin{document}\n";
2054 // mark the start of a new paragraph by simulating a newline,
2055 // so that os.afterParbreak() returns true at document start
2058 // output the parent macros
2059 for (auto const & mac : parentMacros) {
2060 int num_lines = mac->write(os.os(), true);
2061 os.texrow().newlines(num_lines);
2064 } // output_preamble
2066 LYXERR(Debug::INFO, "preamble finished, now the body.");
2070 latexParagraphs(*this, text(), os, runparams);
2072 catch (ConversionException const &) { return ExportKilled; }
2074 // Restore the parenthood if needed
2075 if (!runparams.is_child)
2076 d->ignore_parent = false;
2078 // add this just in case after all the paragraphs
2081 if (output_preamble) {
2082 os << "\\end{document}\n";
2083 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
2085 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
2087 runparams_in.encoding = runparams.encoding;
2089 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2090 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2091 return ExportSuccess;
2095 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2096 OutputParams const & runparams,
2097 OutputWhat output) const
2099 LYXERR(Debug::LATEX, "makeDocBookFile...");
2102 if (!openFileWrite(ofs, fname))
2105 // make sure we are ready to export
2106 // this needs to be done before we validate
2108 updateMacroInstances(OutputUpdate);
2110 ExportStatus const retval =
2111 writeDocBookSource(ofs, runparams, output);
2112 if (retval == ExportKilled)
2113 return ExportKilled;
2117 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2118 return ExportSuccess;
2122 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os,
2123 OutputParams const & runparams,
2124 OutputWhat output) const
2126 LaTeXFeatures features(*this, params(), runparams);
2128 d->bibinfo_.makeCitationLabels(*this);
2132 DocumentClass const & tclass = params().documentClass();
2134 bool const output_preamble =
2135 output == FullSource || output == OnlyPreamble;
2136 bool const output_body =
2137 output == FullSource || output == OnlyBody || output == IncludedFile;
2139 if (output_preamble) {
2140 // XML preamble, no doctype needed.
2141 // Not using XMLStream for this, as the root tag would be in the tag stack and make troubles with the error
2142 // detection mechanisms (these are called before the end tag is output, and thus interact with the canary
2143 // parsep in output_docbook.cpp).
2144 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2145 << "<!-- This DocBook file was created by LyX " << lyx_version
2146 << "\n See https://www.lyx.org/ for more information -->\n";
2148 // Directly output the root tag, based on the current type of document.
2149 string languageCode = params().language->code();
2150 string params = "xml:lang=\"" + languageCode + '"'
2151 + " xmlns=\"http://docbook.org/ns/docbook\""
2152 + " xmlns:xlink=\"http://www.w3.org/1999/xlink\""
2153 + " xmlns:m=\"http://www.w3.org/1998/Math/MathML\""
2154 + " xmlns:xi=\"http://www.w3.org/2001/XInclude\""
2155 + " version=\"5.2\"";
2157 os << "<" << from_ascii(tclass.docbookroot()) << " " << from_ascii(params) << ">\n";
2161 // Start to output the document.
2163 docbookParagraphs(text(), *this, xs, runparams);
2166 if (output_preamble) {
2167 // Close the root element. No need for a line break, as free text is never allowed
2168 // in a root element, it must always be wrapped in some container.
2169 os << "</" << from_ascii(tclass.docbookroot()) << ">";
2172 return ExportSuccess;
2176 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2177 OutputParams const & runparams) const
2179 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2182 if (!openFileWrite(ofs, fname))
2185 // make sure we are ready to export
2186 // this has to be done before we validate
2187 updateBuffer(UpdateMaster, OutputUpdate);
2188 updateMacroInstances(OutputUpdate);
2190 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2191 if (retval == ExportKilled)
2196 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2201 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2202 OutputParams const & runparams,
2203 OutputWhat output) const
2205 LaTeXFeatures features(*this, params(), runparams);
2207 d->bibinfo_.makeCitationLabels(*this);
2209 bool const output_preamble =
2210 output == FullSource || output == OnlyPreamble;
2211 bool const output_body =
2212 output == FullSource || output == OnlyBody || output == IncludedFile;
2214 if (output_preamble) {
2215 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2216 << "<!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"
2217 // FIXME Language should be set properly.
2218 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2220 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2221 // FIXME Presumably need to set this right
2222 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2224 docstring const & doctitle = features.htmlTitle();
2226 << (doctitle.empty() ?
2227 from_ascii("LyX Document") :
2228 xml::escapeString(doctitle, XMLStream::ESCAPE_ALL))
2231 docstring styles = features.getTClassHTMLPreamble();
2232 if (!styles.empty())
2233 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2235 // we will collect CSS information in a stream, and then output it
2236 // either here, as part of the header, or else in a separate file.
2237 odocstringstream css;
2238 styles = features.getCSSSnippets();
2239 if (!styles.empty())
2240 css << "/* LyX Provided Styles */\n" << styles << '\n';
2242 styles = features.getTClassHTMLStyles();
2243 if (!styles.empty())
2244 css << "/* Layout-provided Styles */\n" << styles << '\n';
2246 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2247 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2248 if (needfg || needbg) {
2249 css << "\nbody {\n";
2252 << from_ascii(X11hexname(params().fontcolor))
2255 css << " background-color: "
2256 << from_ascii(X11hexname(params().backgroundcolor))
2261 docstring const dstyles = css.str();
2262 if (!dstyles.empty()) {
2263 bool written = false;
2264 if (params().html_css_as_file) {
2265 // open a file for CSS info
2267 string const fcssname = addName(temppath(), "docstyle.css");
2268 FileName const fcssfile = FileName(fcssname);
2269 if (openFileWrite(ocss, fcssfile)) {
2273 // write link to header
2274 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2276 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2279 // we are here if the CSS is supposed to be written to the header
2280 // or if we failed to write it to an external file.
2282 os << "<style type='text/css'>\n"
2291 bool const output_body_tag = (output != IncludedFile);
2292 if (output_body_tag)
2293 os << "<body dir=\"auto\">\n";
2295 if (output != IncludedFile)
2296 // if we're an included file, the counters are in the master.
2297 params().documentClass().counters().reset();
2299 xhtmlParagraphs(text(), *this, xs, runparams);
2301 catch (ConversionException const &) { return ExportKilled; }
2302 if (output_body_tag)
2306 if (output_preamble)
2309 return ExportSuccess;
2313 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2314 // Other flags: -wall -v0 -x
2315 int Buffer::runChktex()
2319 // get LaTeX-Filename
2320 FileName const path(temppath());
2321 string const name = addName(path.absFileName(), latexName());
2322 string const org_path = filePath();
2324 PathChanger p(path); // path to LaTeX file
2325 message(_("Running chktex..."));
2327 // Generate the LaTeX file if neccessary
2328 OutputParams runparams(¶ms().encoding());
2329 runparams.flavor = Flavor::LaTeX;
2330 runparams.nice = false;
2331 runparams.linelen = lyxrc.plaintext_linelen;
2332 ExportStatus const retval =
2333 makeLaTeXFile(FileName(name), org_path, runparams);
2334 if (retval != ExportSuccess) {
2335 // error code on failure
2340 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2341 int const res = chktex.run(terr); // run chktex
2344 Alert::error(_("chktex failure"),
2345 _("Could not run chktex successfully."));
2347 ErrorList & errlist = d->errorLists["ChkTeX"];
2349 bufferErrors(terr, errlist);
2354 if (runparams.silent)
2355 d->errorLists["ChkTeX"].clear();
2363 void Buffer::validate(LaTeXFeatures & features) const
2365 // Validate the buffer params, but not for included
2366 // files, since they also use the parent buffer's
2368 if (!features.runparams().is_child)
2369 params().validate(features);
2374 for (Paragraph const & p : paragraphs())
2375 p.validate(features);
2377 if (lyxerr.debugging(Debug::LATEX)) {
2378 features.showStruct();
2383 void Buffer::getLabelList(vector<docstring> & list) const
2385 // If this is a child document, use the master's list instead.
2387 masterBuffer()->getLabelList(list);
2392 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2393 for (auto const & tocit : *toc) {
2394 if (tocit.depth() == 0)
2395 list.push_back(tocit.str());
2400 void Buffer::invalidateBibinfoCache() const
2402 d->bibinfo_cache_valid_ = false;
2403 d->cite_labels_valid_ = false;
2404 removeBiblioTempFiles();
2405 // also invalidate the cache for the parent buffer
2406 Buffer const * const pbuf = d->parent();
2408 pbuf->invalidateBibinfoCache();
2412 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2414 // FIXME This is probably unnecessary, given where we call this.
2415 // If this is a child document, use the master instead.
2416 Buffer const * const pbuf = masterBuffer();
2417 if (pbuf != this && scope != UpdateChildOnly)
2418 return pbuf->getBibfiles();
2420 // In 2.3.x, we have:
2421 //if (!d->bibfile_cache_valid_)
2422 // this->updateBibfilesCache(scope);
2423 // I think that is a leftover, but there have been so many back-
2424 // and-forths with this, due to Windows issues, that I am not sure.
2426 return d->bibfiles_cache_;
2430 BiblioInfo const & Buffer::masterBibInfo() const
2432 Buffer const * const tmp = masterBuffer();
2434 return tmp->masterBibInfo();
2439 BiblioInfo const & Buffer::bibInfo() const
2445 void Buffer::registerBibfiles(const docstring_list & bf) const
2447 // We register the bib files in the master buffer,
2448 // if there is one, but also in every single buffer,
2449 // in case a child is compiled alone.
2450 Buffer const * const tmp = masterBuffer();
2452 tmp->registerBibfiles(bf);
2454 for (auto const & p : bf) {
2455 docstring_list::const_iterator temp =
2456 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2457 if (temp == d->bibfiles_cache_.end())
2458 d->bibfiles_cache_.push_back(p);
2463 static map<docstring, FileName> bibfileCache;
2465 FileName Buffer::getBibfilePath(docstring const & bibid) const
2467 map<docstring, FileName>::const_iterator it =
2468 bibfileCache.find(bibid);
2469 if (it != bibfileCache.end()) {
2470 // i.e., return bibfileCache[bibid];
2474 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2475 string const texfile = changeExtension(to_utf8(bibid), "bib");
2476 // we need to check first if this file exists where it's said to be.
2477 // there's a weird bug that occurs otherwise: if the file is in the
2478 // Buffer's directory but has the same name as some file that would be
2479 // found by kpsewhich, then we find the latter, not the former.
2480 FileName const local_file = makeAbsPath(texfile, filePath());
2481 FileName file = local_file;
2482 if (!file.exists()) {
2483 // there's no need now to check whether the file can be found
2485 file = findtexfile(texfile, "bib", true);
2489 LYXERR(Debug::FILES, "Found at: " << file);
2491 bibfileCache[bibid] = file;
2492 return bibfileCache[bibid];
2496 void Buffer::checkIfBibInfoCacheIsValid() const
2498 // use the master's cache
2499 Buffer const * const tmp = masterBuffer();
2501 tmp->checkIfBibInfoCacheIsValid();
2505 // If we already know the cache is invalid, stop here.
2506 // This is important in the case when the bibliography
2507 // environment (rather than Bib[la]TeX) is used.
2508 // In that case, the timestamp check below gives no
2509 // sensible result. Rather than that, the cache will
2510 // be invalidated explicitly via invalidateBibInfoCache()
2511 // by the Bibitem inset.
2512 // Same applies for bib encoding changes, which trigger
2513 // invalidateBibInfoCache() by InsetBibtex.
2514 if (!d->bibinfo_cache_valid_)
2517 if (d->have_bibitems_) {
2518 // We have a bibliography environment.
2519 // Invalidate the bibinfo cache unconditionally.
2520 // Cite labels will get invalidated by the inset if needed.
2521 d->bibinfo_cache_valid_ = false;
2525 // OK. This is with Bib(la)tex. We'll assume the cache
2526 // is valid and change this if we find changes in the bibs.
2527 d->bibinfo_cache_valid_ = true;
2528 d->cite_labels_valid_ = true;
2530 // compare the cached timestamps with the actual ones.
2531 docstring_list const & bibfiles_cache = getBibfiles();
2532 for (auto const & bf : bibfiles_cache) {
2533 FileName const fn = getBibfilePath(bf);
2534 time_t lastw = fn.lastModified();
2535 time_t prevw = d->bibfile_status_[fn];
2536 if (lastw != prevw) {
2537 d->bibinfo_cache_valid_ = false;
2538 d->cite_labels_valid_ = false;
2539 d->bibfile_status_[fn] = lastw;
2545 void Buffer::clearBibFileCache() const
2547 bibfileCache.clear();
2551 void Buffer::reloadBibInfoCache(bool const force) const
2553 // we should not need to do this for internal buffers
2557 // use the master's cache
2558 Buffer const * const tmp = masterBuffer();
2560 tmp->reloadBibInfoCache(force);
2565 checkIfBibInfoCacheIsValid();
2566 if (d->bibinfo_cache_valid_)
2570 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2571 // re-read file locations when this info changes
2572 // FIXME Is this sufficient? Or should we also force that
2573 // in some other cases? If so, then it is easy enough to
2574 // add the following line in some other places.
2575 clearBibFileCache();
2576 d->bibinfo_.clear();
2577 FileNameList checkedFiles;
2578 d->have_bibitems_ = false;
2579 collectBibKeys(checkedFiles);
2580 d->bibinfo_cache_valid_ = true;
2584 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2589 for (InsetIterator it = begin(inset()); it; ++it) {
2590 it->collectBibKeys(it, checkedFiles);
2591 if (it->lyxCode() == BIBITEM_CODE) {
2592 if (parent() != nullptr)
2593 parent()->d->have_bibitems_ = true;
2595 d->have_bibitems_ = true;
2601 void Buffer::addBiblioInfo(BiblioInfo const & bi_in) const
2603 // We add the biblio info to the parent buffer,
2604 // if there is one, but also to this buffer, in case
2605 // it is compiled alone.
2606 BiblioInfo & our_bi = d->bibinfo_;
2607 our_bi.mergeBiblioInfo(bi_in);
2610 parent()->addBiblioInfo(bi_in);
2614 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2616 // We add the bibtex info to the master buffer,
2617 // if there is one, but also to every single buffer,
2618 // in case a child is compiled alone.
2619 BiblioInfo & bi = d->bibinfo_;
2622 if (parent() != nullptr) {
2623 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2624 masterbi[key] = bin;
2629 void Buffer::makeCitationLabels() const
2631 Buffer const * const master = masterBuffer();
2632 return d->bibinfo_.makeCitationLabels(*master);
2636 void Buffer::invalidateCiteLabels() const
2638 masterBuffer()->d->cite_labels_valid_ = false;
2641 bool Buffer::citeLabelsValid() const
2643 return masterBuffer()->d->cite_labels_valid_;
2647 void Buffer::removeBiblioTempFiles() const
2649 // We remove files that contain LaTeX commands specific to the
2650 // particular bibliographic style being used, in order to avoid
2651 // LaTeX errors when we switch style.
2652 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2653 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2654 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2655 aux_file.removeFile();
2656 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2657 bbl_file.removeFile();
2658 // Also for the parent buffer
2659 Buffer const * const pbuf = parent();
2661 pbuf->removeBiblioTempFiles();
2665 bool Buffer::isDepClean(string const & name) const
2667 DepClean::const_iterator const it = d->dep_clean.find(name);
2668 if (it == d->dep_clean.end())
2674 void Buffer::markDepClean(string const & name)
2676 d->dep_clean[name] = true;
2680 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2683 // FIXME? if there is an Buffer LFUN that can be dispatched even
2684 // if internal, put a switch '(cmd.action)' here.
2690 switch (cmd.action()) {
2692 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2693 flag.setOnOff(hasReadonlyFlag());
2696 // FIXME: There is need for a command-line import.
2697 //case LFUN_BUFFER_IMPORT:
2699 case LFUN_BUFFER_AUTO_SAVE:
2702 case LFUN_BUFFER_EXPORT_CUSTOM:
2703 // FIXME: Nothing to check here?
2706 case LFUN_BUFFER_EXPORT: {
2707 docstring const & arg = cmd.argument();
2708 if (arg == "custom") {
2712 string format = (arg.empty() || arg == "default") ?
2713 params().getDefaultOutputFormat() : to_utf8(arg);
2714 size_t pos = format.find(' ');
2715 if (pos != string::npos)
2716 format = format.substr(0, pos);
2717 enable = params().isExportable(format, false);
2719 flag.message(bformat(
2720 _("Don't know how to export to format: %1$s"), arg));
2724 case LFUN_BUILD_PROGRAM:
2725 enable = params().isExportable("program", false);
2728 case LFUN_BRANCH_ACTIVATE:
2729 case LFUN_BRANCH_DEACTIVATE:
2730 case LFUN_BRANCH_MASTER_ACTIVATE:
2731 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2732 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2733 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2734 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2735 : params().branchlist();
2736 docstring const & branchName = cmd.argument();
2737 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2741 case LFUN_BRANCH_ADD:
2742 case LFUN_BRANCHES_RENAME:
2743 // if no Buffer is present, then of course we won't be called!
2746 case LFUN_BUFFER_LANGUAGE:
2747 enable = !isReadonly();
2750 case LFUN_BUFFER_VIEW_CACHE:
2751 (d->preview_file_).refresh();
2752 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2755 case LFUN_CHANGES_TRACK:
2756 flag.setEnabled(true);
2757 flag.setOnOff(params().track_changes);
2760 case LFUN_CHANGES_OUTPUT:
2761 flag.setEnabled(true);
2762 flag.setOnOff(params().output_changes);
2765 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2766 flag.setOnOff(params().compressed);
2769 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2770 flag.setOnOff(params().output_sync);
2773 case LFUN_BUFFER_ANONYMIZE:
2779 flag.setEnabled(enable);
2784 void Buffer::dispatch(string const & command, DispatchResult & result)
2786 return dispatch(lyxaction.lookupFunc(command), result);
2790 // NOTE We can end up here even if we have no GUI, because we are called
2791 // by LyX::exec to handled command-line requests. So we may need to check
2792 // whether we have a GUI or not. The boolean use_gui holds this information.
2793 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2796 // FIXME? if there is an Buffer LFUN that can be dispatched even
2797 // if internal, put a switch '(cmd.action())' here.
2798 dr.dispatched(false);
2801 string const argument = to_utf8(func.argument());
2802 // We'll set this back to false if need be.
2803 bool dispatched = true;
2804 // This handles undo groups automagically
2805 UndoGroupHelper ugh(this);
2807 switch (func.action()) {
2808 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2809 if (lyxvc().inUse()) {
2810 string log = lyxvc().toggleReadOnly();
2815 setReadonly(!hasReadonlyFlag());
2818 case LFUN_BUFFER_EXPORT: {
2819 string const format = (argument.empty() || argument == "default") ?
2820 params().getDefaultOutputFormat() : argument;
2821 ExportStatus const status = doExport(format, false);
2822 dr.setError(status != ExportSuccess);
2823 if (status != ExportSuccess)
2824 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2825 from_utf8(format)));
2829 case LFUN_BUILD_PROGRAM: {
2830 ExportStatus const status = doExport("program", true);
2831 dr.setError(status != ExportSuccess);
2832 if (status != ExportSuccess)
2833 dr.setMessage(_("Error generating literate programming code."));
2837 case LFUN_BUFFER_EXPORT_CUSTOM: {
2839 string command = split(argument, format_name, ' ');
2840 Format const * format = theFormats().getFormat(format_name);
2842 lyxerr << "Format \"" << format_name
2843 << "\" not recognized!"
2848 // The name of the file created by the conversion process
2851 // Output to filename
2852 if (format->name() == "lyx") {
2853 string const latexname = latexName(false);
2854 filename = changeExtension(latexname,
2855 format->extension());
2856 filename = addName(temppath(), filename);
2858 if (!writeFile(FileName(filename)))
2862 doExport(format_name, true, filename);
2865 // Substitute $$FName for filename
2866 if (!contains(command, "$$FName"))
2867 command = "( " + command + " ) < $$FName";
2868 command = subst(command, "$$FName", filename);
2870 // Execute the command in the background
2872 call.startscript(Systemcall::DontWait, command,
2873 filePath(), layoutPos());
2877 // FIXME: There is need for a command-line import.
2879 case LFUN_BUFFER_IMPORT:
2884 case LFUN_BUFFER_AUTO_SAVE:
2886 resetAutosaveTimers();
2889 case LFUN_BRANCH_ACTIVATE:
2890 case LFUN_BRANCH_DEACTIVATE:
2891 case LFUN_BRANCH_MASTER_ACTIVATE:
2892 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2893 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2894 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2895 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2898 docstring const & branch_name = func.argument();
2899 // the case without a branch name is handled elsewhere
2900 if (branch_name.empty()) {
2904 Branch * branch = buf->params().branchlist().find(branch_name);
2906 LYXERR0("Branch " << branch_name << " does not exist.");
2908 docstring const msg =
2909 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2913 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2914 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2915 if (branch->isSelected() != activate) {
2916 buf->undo().recordUndoBufferParams(CursorData());
2917 branch->setSelected(activate);
2919 dr.screenUpdate(Update::Force);
2920 dr.forceBufferUpdate();
2925 case LFUN_BRANCH_ADD: {
2926 docstring const & branchnames = func.argument();
2927 if (branchnames.empty()) {
2931 BranchList & branch_list = params().branchlist();
2932 vector<docstring> const branches =
2933 getVectorFromString(branchnames, branch_list.separator());
2935 for (docstring const & branch_name : branches) {
2936 Branch * branch = branch_list.find(branch_name);
2938 LYXERR0("Branch " << branch_name << " already exists.");
2942 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2944 undo().recordUndoBufferParams(CursorData());
2945 branch_list.add(branch_name);
2946 branch = branch_list.find(branch_name);
2948 // needed to update the color table for dark mode
2949 branch->setColors("background", "background");
2951 dr.screenUpdate(Update::Force);
2959 case LFUN_BRANCHES_RENAME: {
2960 if (func.argument().empty())
2963 docstring const oldname = from_utf8(func.getArg(0));
2964 docstring const newname = from_utf8(func.getArg(1));
2965 InsetIterator it = begin(inset());
2966 InsetIterator const itend = end(inset());
2967 bool success = false;
2968 for (; it != itend; ++it) {
2969 if (it->lyxCode() == BRANCH_CODE) {
2970 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2971 if (ins.branch() == oldname) {
2972 undo().recordUndo(CursorData(it));
2973 ins.rename(newname);
2978 if (it->lyxCode() == INCLUDE_CODE) {
2979 // get buffer of external file
2980 InsetInclude const & ins =
2981 static_cast<InsetInclude const &>(*it);
2982 Buffer * child = ins.loadIfNeeded();
2985 child->dispatch(func, dr);
2990 dr.screenUpdate(Update::Force);
2991 dr.forceBufferUpdate();
2996 case LFUN_BUFFER_VIEW_CACHE:
2997 if (!theFormats().view(*this, d->preview_file_,
2998 d->preview_format_))
2999 dr.setMessage(_("Error viewing the output file."));
3002 case LFUN_CHANGES_TRACK:
3003 if (params().save_transient_properties)
3004 undo().recordUndoBufferParams(CursorData());
3005 params().track_changes = !params().track_changes;
3008 case LFUN_CHANGES_OUTPUT:
3009 if (params().save_transient_properties)
3010 undo().recordUndoBufferParams(CursorData());
3011 params().output_changes = !params().output_changes;
3012 if (params().output_changes) {
3013 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3014 LaTeXFeatures::isAvailable("xcolor");
3017 Alert::warning(_("Changes not shown in LaTeX output"),
3018 _("Changes will not be highlighted in LaTeX output, "
3019 "because xcolor and ulem are not installed.\n"
3020 "Please install both packages or redefine "
3021 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3026 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3027 // turn compression on/off
3028 undo().recordUndoBufferParams(CursorData());
3029 params().compressed = !params().compressed;
3032 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3033 undo().recordUndoBufferParams(CursorData());
3034 params().output_sync = !params().output_sync;
3037 case LFUN_BUFFER_ANONYMIZE: {
3038 undo().recordUndoFullBuffer(CursorData());
3039 CursorData cur(doc_iterator_begin(this));
3040 for ( ; cur ; cur.forwardPar())
3041 cur.paragraph().anonymize();
3042 dr.forceBufferUpdate();
3043 dr.screenUpdate(Update::Force);
3051 dr.dispatched(dispatched);
3055 void Buffer::changeLanguage(Language const * from, Language const * to)
3057 LASSERT(from, return);
3058 LASSERT(to, return);
3060 ParIterator it = par_iterator_begin();
3061 ParIterator eit = par_iterator_end();
3062 for (; it != eit; ++it)
3063 it->changeLanguage(params(), from, to);
3067 bool Buffer::isMultiLingual() const
3069 ParConstIterator end = par_iterator_end();
3070 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3071 if (it->isMultiLingual(params()))
3078 std::set<Language const *> Buffer::getLanguages() const
3080 std::set<Language const *> langs;
3081 getLanguages(langs);
3086 void Buffer::getLanguages(std::set<Language const *> & langs) const
3088 ParConstIterator end = par_iterator_end();
3089 // add the buffer language, even if it's not actively used
3090 langs.insert(language());
3091 // iterate over the paragraphs
3092 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3093 it->getLanguages(langs);
3095 ListOfBuffers clist = getDescendants();
3096 for (auto const & cit : clist)
3097 cit->getLanguages(langs);
3101 DocIterator Buffer::getParFromID(int const id) const
3103 Buffer * buf = const_cast<Buffer *>(this);
3105 // This means non-existent
3106 return doc_iterator_end(buf);
3108 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3109 if (it.paragraph().id() == id)
3112 return doc_iterator_end(buf);
3116 bool Buffer::hasParWithID(int const id) const
3118 return !getParFromID(id).atEnd();
3122 ParIterator Buffer::par_iterator_begin()
3124 return ParIterator(doc_iterator_begin(this));
3128 ParIterator Buffer::par_iterator_end()
3130 return ParIterator(doc_iterator_end(this));
3134 ParConstIterator Buffer::par_iterator_begin() const
3136 return ParConstIterator(doc_iterator_begin(this));
3140 ParConstIterator Buffer::par_iterator_end() const
3142 return ParConstIterator(doc_iterator_end(this));
3145 bool Buffer::empty() const
3147 return paragraphs().size() == 1 && paragraphs().front().empty();
3151 Language const * Buffer::language() const
3153 return params().language;
3157 docstring Buffer::B_(string const & l10n) const
3159 return params().B_(l10n);
3163 bool Buffer::isClean() const
3165 return d->lyx_clean;
3169 bool Buffer::isChecksumModified() const
3171 LASSERT(d->filename.exists(), return false);
3172 return d->checksum_ != d->filename.checksum();
3176 void Buffer::saveCheckSum() const
3178 FileName const & file = d->filename;
3180 d->checksum_ = file.exists() ? file.checksum()
3181 : 0; // in the case of save to a new file.
3185 void Buffer::markClean() const
3187 if (!d->lyx_clean) {
3188 d->lyx_clean = true;
3191 // if the .lyx file has been saved, we don't need an
3193 d->bak_clean = true;
3194 d->undo_.markDirty();
3195 clearExternalModification();
3199 void Buffer::setUnnamed(bool flag)
3205 bool Buffer::isUnnamed() const
3212 /// Don't check unnamed, here: isInternal() is used in
3213 /// newBuffer(), where the unnamed flag has not been set by anyone
3214 /// yet. Also, for an internal buffer, there should be no need for
3215 /// retrieving fileName() nor for checking if it is unnamed or not.
3216 bool Buffer::isInternal() const
3218 return d->internal_buffer;
3222 void Buffer::setInternal(bool flag)
3224 d->internal_buffer = flag;
3228 void Buffer::markDirty()
3231 d->lyx_clean = false;
3234 d->bak_clean = false;
3236 for (auto & depit : d->dep_clean)
3237 depit.second = false;
3241 FileName Buffer::fileName() const
3247 string Buffer::absFileName() const
3249 return d->filename.absFileName();
3253 string Buffer::filePath() const
3255 string const abs = d->filename.onlyPath().absFileName();
3258 int last = abs.length() - 1;
3260 return abs[last] == '/' ? abs : abs + '/';
3264 DocFileName Buffer::getReferencedFileName(string const & fn) const
3267 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3268 result.set(fn, filePath());
3270 // filePath() ends with a path separator
3271 FileName const test(filePath() + fn);
3273 result.set(fn, filePath());
3275 result.set(fn, params().origin);
3282 string const Buffer::prepareFileNameForLaTeX(string const & name,
3283 string const & ext, bool nice) const
3285 string const fname = makeAbsPath(name, filePath()).absFileName();
3286 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3292 return to_utf8(makeRelPath(from_utf8(fname),
3293 from_utf8(masterBuffer()->filePath())));
3297 vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3298 docstring_list const & bibfilelist,
3299 bool const add_extension) const
3301 // If we are processing the LaTeX file in a temp directory then
3302 // copy the .bib databases to this temp directory, mangling their
3303 // names in the process. Store this mangled name in the list of
3305 // (We need to do all this because BibTeX *really*, *really*
3306 // can't handle "files with spaces" and Windows users tend to
3307 // use such filenames.)
3308 // Otherwise, store the (maybe absolute) path to the original,
3309 // unmangled database name.
3311 vector<pair<docstring, string>> res;
3313 // determine the export format
3314 string const tex_format = flavor2format(runparams.flavor);
3316 // check for spaces in paths
3317 bool found_space = false;
3319 for (auto const & bit : bibfilelist) {
3320 string utf8input = to_utf8(bit);
3322 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3323 FileName try_in_file =
3324 makeAbsPath(database + ".bib", filePath());
3325 bool not_from_texmf = try_in_file.isReadableFile();
3326 // If the file has not been found, try with the real file name
3327 // (it might come from a child in a sub-directory)
3328 if (!not_from_texmf) {
3329 try_in_file = getBibfilePath(bit);
3330 if (try_in_file.isReadableFile()) {
3331 // Check if the file is in texmf
3332 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3333 not_from_texmf = kpsefile.empty()
3334 || kpsefile.absFileName() != try_in_file.absFileName();
3336 // If this exists, make path relative to the master
3339 removeExtension(prepareFileNameForLaTeX(
3340 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3341 from_utf8(filePath()))),
3342 ".bib", runparams.nice));
3346 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3348 // mangledFileName() needs the extension
3349 DocFileName const in_file = DocFileName(try_in_file);
3350 database = removeExtension(in_file.mangledFileName());
3351 FileName const out_file = makeAbsPath(database + ".bib",
3352 masterBuffer()->temppath());
3353 bool const success = in_file.copyTo(out_file);
3355 LYXERR0("Failed to copy '" << in_file
3356 << "' to '" << out_file << "'");
3358 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3359 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3360 if (!isValidLaTeXFileName(database)) {
3361 frontend::Alert::warning(_("Invalid filename"),
3362 _("The following filename will cause troubles "
3363 "when running the exported file through LaTeX: ") +
3364 from_utf8(database));
3366 if (!isValidDVIFileName(database)) {
3367 frontend::Alert::warning(_("Problematic filename for DVI"),
3368 _("The following filename can cause troubles "
3369 "when running the exported file through LaTeX "
3370 "and opening the resulting DVI: ") +
3371 from_utf8(database), true);
3379 docstring const path = from_utf8(latex_path(database));
3381 if (contains(path, ' '))
3384 if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
3385 enc = params().bibFileEncoding(utf8input);
3387 bool recorded = false;
3388 for (auto const & pe : res) {
3389 if (pe.first == path) {
3396 res.push_back(make_pair(path, enc));
3399 // Check if there are spaces in the path and warn BibTeX users, if so.
3400 // (biber can cope with such paths)
3401 if (!prefixIs(runparams.bibtex_command, "biber")) {
3402 // Post this warning only once.
3403 static bool warned_about_spaces = false;
3404 if (!warned_about_spaces &&
3405 runparams.nice && found_space) {
3406 warned_about_spaces = true;
3407 Alert::warning(_("Export Warning!"),
3408 _("There are spaces in the paths to your BibTeX databases.\n"
3409 "BibTeX will be unable to find them."));
3418 string Buffer::layoutPos() const
3420 return d->layout_position;
3424 void Buffer::setLayoutPos(string const & path)
3427 d->layout_position.clear();
3431 LATTEST(FileName::isAbsolute(path));
3433 d->layout_position =
3434 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3436 if (d->layout_position.empty())
3437 d->layout_position = ".";
3441 bool Buffer::hasReadonlyFlag() const
3443 return d->read_only;
3447 bool Buffer::isReadonly() const
3449 return hasReadonlyFlag() || notifiesExternalModification();
3453 void Buffer::setParent(Buffer const * buffer)
3455 // We need to do some work here to avoid recursive parent structures.
3456 // This is the easy case.
3457 if (buffer == this) {
3458 LYXERR0("Ignoring attempt to set self as parent in\n" << fileName());
3461 // Now we check parents going upward, to make sure that IF we set the
3462 // parent as requested, we would not generate a recursive include.
3463 set<Buffer const *> sb;
3464 Buffer const * b = buffer;
3465 bool found_recursion = false;
3467 if (sb.find(b) != sb.end()) {
3468 found_recursion = true;
3475 if (found_recursion) {
3476 LYXERR0("Ignoring attempt to set parent of\n" <<
3479 buffer->fileName() <<
3480 "\nbecause that would create a recursive inclusion.");
3484 // We should be safe now.
3485 d->setParent(buffer);
3490 Buffer const * Buffer::parent() const
3496 ListOfBuffers Buffer::allRelatives() const
3498 ListOfBuffers lb = masterBuffer()->getDescendants();
3499 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3504 Buffer const * Buffer::masterBuffer() const
3506 Buffer const * const pbuf = d->parent();
3510 return pbuf->masterBuffer();
3514 bool Buffer::isChild(Buffer * child) const
3516 return d->children_positions.find(child) != d->children_positions.end();
3520 DocIterator Buffer::firstChildPosition(Buffer const * child)
3522 Impl::BufferPositionMap::iterator it;
3523 it = d->children_positions.find(child);
3524 if (it == d->children_positions.end())
3525 return DocIterator(this);
3530 bool Buffer::hasChildren() const
3532 return !d->children_positions.empty();
3536 void Buffer::collectChildren(ListOfBuffers & children, bool grand_children) const
3538 // loop over children
3539 for (auto const & p : d->children_positions) {
3540 Buffer * child = const_cast<Buffer *>(p.first);
3541 // This can happen when called during GUI operations
3542 if (!theBufferList().isLoaded(child))
3545 ListOfBuffers::const_iterator bit = find(children.begin(), children.end(), child);
3546 if (bit != children.end())
3548 children.push_back(child);
3550 // there might be grandchildren
3551 child->collectChildren(children, true);
3556 ListOfBuffers Buffer::getChildren() const
3559 collectChildren(v, false);
3560 // Make sure we have not included ourselves.
3561 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3562 if (bit != v.end()) {
3563 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3570 ListOfBuffers Buffer::getDescendants() const
3573 collectChildren(v, true);
3574 // Make sure we have not included ourselves.
3575 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3576 if (bit != v.end()) {
3577 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3584 template<typename M>
3585 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3590 typename M::const_iterator it = m.lower_bound(x);
3591 if (it == m.begin())
3599 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3600 DocIterator const & pos) const
3602 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3604 // if paragraphs have no macro context set, pos will be empty
3608 // we haven't found anything yet
3609 DocIterator bestPos = owner_->par_iterator_begin();
3610 MacroData const * bestData = nullptr;
3612 // find macro definitions for name
3613 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3614 if (nameIt != macros.end()) {
3615 // find last definition in front of pos or at pos itself
3616 PositionScopeMacroMap::const_iterator it
3617 = greatest_below(nameIt->second, pos);
3618 if (it != nameIt->second.end()) {
3620 // scope ends behind pos?
3621 if (pos < it->second.scope) {
3622 // Looks good, remember this. If there
3623 // is no external macro behind this,
3624 // we found the right one already.
3625 bestPos = it->first;
3626 bestData = &it->second.macro;
3630 // try previous macro if there is one
3631 if (it == nameIt->second.begin())
3638 // find macros in included files
3639 PositionScopeBufferMap::const_iterator it
3640 = greatest_below(position_to_children, pos);
3641 if (it == position_to_children.end())
3642 // no children before
3646 // do we know something better (i.e. later) already?
3647 if (it->first < bestPos )
3650 // scope ends behind pos?
3651 if (pos < it->second.scope
3652 && (cloned_buffer_ ||
3653 theBufferList().isLoaded(it->second.buffer))) {
3654 // look for macro in external file
3656 MacroData const * data
3657 = it->second.buffer->getMacro(name, false);
3660 bestPos = it->first;
3666 // try previous file if there is one
3667 if (it == position_to_children.begin())
3672 // return the best macro we have found
3677 MacroData const * Buffer::getMacro(docstring const & name,
3678 DocIterator const & pos, bool global) const
3683 // query buffer macros
3684 MacroData const * data = d->getBufferMacro(name, pos);
3685 if (data != nullptr)
3688 // If there is a master buffer, query that
3689 Buffer const * const pbuf = d->parent();
3691 d->macro_lock = true;
3692 MacroData const * macro = pbuf->getMacro(
3693 name, *this, false);
3694 d->macro_lock = false;
3700 data = MacroTable::globalMacros().get(name);
3701 if (data != nullptr)
3709 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3711 // set scope end behind the last paragraph
3712 DocIterator scope = par_iterator_begin();
3713 scope.pit() = scope.lastpit() + 1;
3715 return getMacro(name, scope, global);
3719 MacroData const * Buffer::getMacro(docstring const & name,
3720 Buffer const & child, bool global) const
3722 // look where the child buffer is included first
3723 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3724 if (it == d->children_positions.end())
3727 // check for macros at the inclusion position
3728 return getMacro(name, it->second, global);
3732 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3734 pit_type const lastpit = it.lastpit();
3736 // look for macros in each paragraph
3737 while (it.pit() <= lastpit) {
3738 Paragraph & par = it.paragraph();
3740 // iterate over the insets of the current paragraph
3741 for (auto const & insit : par.insetList()) {
3742 it.pos() = insit.pos;
3744 // is it a nested text inset?
3745 if (insit.inset->asInsetText()) {
3746 // Inset needs its own scope?
3747 InsetText const * itext = insit.inset->asInsetText();
3748 bool newScope = itext->isMacroScope();
3750 // scope which ends just behind the inset
3751 DocIterator insetScope = it;
3754 // collect macros in inset
3755 it.push_back(CursorSlice(*insit.inset));
3756 updateMacros(it, newScope ? insetScope : scope);
3761 if (insit.inset->asInsetTabular()) {
3762 CursorSlice slice(*insit.inset);
3763 size_t const numcells = slice.nargs();
3764 for (; slice.idx() < numcells; slice.forwardIdx()) {
3765 it.push_back(slice);
3766 updateMacros(it, scope);
3772 // is it an external file?
3773 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3774 // get buffer of external file
3775 InsetInclude const & incinset =
3776 static_cast<InsetInclude const &>(*insit.inset);
3778 Buffer * child = incinset.loadIfNeeded();
3783 // register its position, but only when it is
3784 // included first in the buffer
3785 children_positions.insert({child, it});
3787 // register child with its scope
3788 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3792 InsetMath * im = insit.inset->asInsetMath();
3793 if (doing_export && im) {
3794 InsetMathHull * hull = im->asHullInset();
3796 hull->recordLocation(it);
3799 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3803 InsetMathMacroTemplate & macroTemplate =
3804 *insit.inset->asInsetMath()->asMacroTemplate();
3805 MacroContext mc(owner_, it);
3806 macroTemplate.updateToContext(mc);
3809 bool valid = macroTemplate.validMacro();
3810 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3811 // then the BufferView's cursor will be invalid in
3812 // some cases which leads to crashes.
3817 // FIXME (Abdel), I don't understand why we pass 'it' here
3818 // instead of 'macroTemplate' defined above... is this correct?
3819 macros[macroTemplate.name()][it] =
3820 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3830 void Buffer::updateMacros() const
3835 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3837 // start with empty table
3839 d->children_positions.clear();
3840 d->position_to_children.clear();
3842 // Iterate over buffer, starting with first paragraph
3843 // The scope must be bigger than any lookup DocIterator
3844 // later. For the global lookup, lastpit+1 is used, hence
3845 // we use lastpit+2 here.
3846 DocIterator it = par_iterator_begin();
3847 DocIterator outerScope = it;
3848 outerScope.pit() = outerScope.lastpit() + 2;
3849 d->updateMacros(it, outerScope);
3853 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3855 for (Inset const & it : inset()) {
3856 if (it.lyxCode() == BRANCH_CODE) {
3857 InsetBranch const & br = static_cast<InsetBranch const &>(it);
3858 docstring const name = br.branch();
3859 if (!from_master && !params().branchlist().find(name))
3860 result.push_back(name);
3861 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3862 result.push_back(name);
3865 if (it.lyxCode() == INCLUDE_CODE) {
3866 // get buffer of external file
3867 InsetInclude const & ins =
3868 static_cast<InsetInclude const &>(it);
3869 Buffer * child = ins.loadIfNeeded();
3872 child->getUsedBranches(result, true);
3875 // remove duplicates
3880 void Buffer::updateMacroInstances(UpdateType utype) const
3882 LYXERR(Debug::MACROS, "updateMacroInstances for "
3883 << d->filename.onlyFileName());
3884 DocIterator it = doc_iterator_begin(this);
3886 DocIterator const end = doc_iterator_end(this);
3887 for (; it != end; it.forwardInset()) {
3888 // look for MathData cells in InsetMathNest insets
3889 InsetMath * minset = it.nextInset()->asInsetMath();
3893 // update macro in all cells of the InsetMathNest
3894 idx_type n = minset->nargs();
3895 MacroContext mc = MacroContext(this, it);
3896 for (idx_type i = 0; i < n; ++i) {
3897 MathData & data = minset->cell(i);
3898 data.updateMacros(nullptr, mc, utype, 0);
3904 void Buffer::listMacroNames(MacroNameSet & macros) const
3909 d->macro_lock = true;
3911 // loop over macro names
3912 for (auto const & nameit : d->macros)
3913 macros.insert(nameit.first);
3915 // loop over children
3916 for (auto const & p : d->children_positions) {
3917 Buffer * child = const_cast<Buffer *>(p.first);
3918 // The buffer might have been closed (see #10766).
3919 if (theBufferList().isLoaded(child))
3920 child->listMacroNames(macros);
3924 Buffer const * const pbuf = d->parent();
3926 pbuf->listMacroNames(macros);
3928 d->macro_lock = false;
3932 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3934 Buffer const * const pbuf = d->parent();
3939 pbuf->listMacroNames(names);
3942 for (auto const & mit : names) {
3944 MacroData const * data = pbuf->getMacro(mit, *this, false);
3946 macros.insert(data);
3948 // we cannot access the original InsetMathMacroTemplate anymore
3949 // here to calls validate method. So we do its work here manually.
3950 // FIXME: somehow make the template accessible here.
3951 if (data->optionals() > 0)
3952 features.require("xargs");
3958 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3961 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3963 RefCache::iterator it = d->ref_cache_.find(label);
3964 if (it != d->ref_cache_.end())
3967 static References const dummy_refs = References();
3968 it = d->ref_cache_.insert(
3969 make_pair(label, dummy_refs)).first;
3974 Buffer::References const & Buffer::references(docstring const & label) const
3976 return const_cast<Buffer *>(this)->getReferenceCache(label);
3980 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3982 References & refs = getReferenceCache(label);
3983 refs.push_back(make_pair(inset, it));
3987 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
3991 linfo.label = label;
3993 linfo.active = active;
3994 masterBuffer()->d->label_cache_.push_back(linfo);
3998 InsetLabel const * Buffer::insetLabel(docstring const & label,
3999 bool const active) const
4001 for (auto const & rc : masterBuffer()->d->label_cache_) {
4002 if (rc.label == label && (rc.active || !active))
4009 bool Buffer::activeLabel(docstring const & label) const
4011 return insetLabel(label, true) != nullptr;
4015 void Buffer::clearReferenceCache() const
4018 d->ref_cache_.clear();
4019 d->label_cache_.clear();
4024 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
4026 //FIXME: This does not work for child documents yet.
4027 reloadBibInfoCache();
4029 // Check if the label 'from' appears more than once
4030 vector<docstring> labels;
4031 for (auto const & bibit : masterBibInfo())
4032 labels.push_back(bibit.first);
4034 if (count(labels.begin(), labels.end(), from) > 1)
4037 string const paramName = "key";
4038 UndoGroupHelper ugh(this);
4039 InsetIterator it = begin(inset());
4041 if (it->lyxCode() != CITE_CODE)
4043 InsetCommand * inset = it->asInsetCommand();
4044 docstring const oldValue = inset->getParam(paramName);
4045 if (oldValue == from) {
4046 undo().recordUndo(CursorData(it));
4047 inset->setParam(paramName, to);
4052 // returns NULL if id-to-row conversion is unsupported
4053 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4054 pit_type par_begin, pit_type par_end,
4055 OutputWhat output, bool master) const
4057 unique_ptr<TexRow> texrow;
4058 OutputParams runparams(¶ms().encoding());
4059 runparams.nice = true;
4060 runparams.flavor = params().getOutputFlavor(format);
4061 runparams.linelen = lyxrc.plaintext_linelen;
4062 // No side effect of file copying and image conversion
4063 runparams.dryrun = true;
4065 // Some macros rely on font encoding
4066 runparams.main_fontenc = params().main_font_encoding();
4068 // Use the right wrapping for the comment at the beginning of the generated
4069 // snippet, so that it is either valid LaTeX or valid XML (including HTML and DocBook).
4070 docstring comment_start = from_ascii("% ");
4071 docstring comment_end = from_ascii("");
4072 if (runparams.flavor == Flavor::Html || runparams.flavor == Flavor::DocBook5) {
4073 comment_start = from_ascii("<!-- ");
4074 comment_end = from_ascii(" -->");
4077 if (output == CurrentParagraph) {
4078 runparams.par_begin = par_begin;
4079 runparams.par_end = par_end;
4080 if (par_begin + 1 == par_end) {
4082 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4087 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4088 convert<docstring>(par_begin),
4089 convert<docstring>(par_end - 1))
4093 // output paragraphs
4094 if (runparams.flavor == Flavor::LyX) {
4095 Paragraph const & par = text().paragraphs()[par_begin];
4097 depth_type dt = par.getDepth();
4098 par.write(ods, params(), dt);
4099 os << from_utf8(ods.str());
4100 } else if (runparams.flavor == Flavor::Html) {
4102 setMathFlavor(runparams);
4103 xhtmlParagraphs(text(), *this, xs, runparams);
4104 } else if (runparams.flavor == Flavor::Text) {
4106 // FIXME Handles only one paragraph, unlike the others.
4107 // Probably should have some routine with a signature like them.
4108 writePlaintextParagraph(*this,
4109 text().paragraphs()[par_begin], os, runparams, dummy);
4110 } else if (runparams.flavor == Flavor::DocBook5) {
4112 docbookParagraphs(text(), *this, xs, runparams);
4114 // If we are previewing a paragraph, even if this is the
4115 // child of some other buffer, let's cut the link here,
4116 // so that no concurring settings from the master
4117 // (e.g. branch state) interfere (see #8101).
4119 d->ignore_parent = true;
4120 // We need to validate the Buffer params' features here
4121 // in order to know if we should output polyglossia
4122 // macros (instead of babel macros)
4123 LaTeXFeatures features(*this, params(), runparams);
4125 runparams.use_polyglossia = features.usePolyglossia();
4126 runparams.use_hyperref = features.isRequired("hyperref");
4127 // latex or literate
4130 ots.texrow().newlines(2);
4132 latexParagraphs(*this, text(), ots, runparams);
4133 texrow = ots.releaseTexRow();
4135 // Restore the parenthood
4137 d->ignore_parent = false;
4140 os << comment_start;
4141 if (output == FullSource)
4142 os << _("Preview source code");
4143 else if (output == OnlyPreamble)
4144 os << _("Preview preamble");
4145 else if (output == OnlyBody)
4146 os << _("Preview body");
4149 if (runparams.flavor == Flavor::LyX) {
4151 if (output == FullSource)
4153 else if (output == OnlyPreamble)
4154 params().writeFile(ods, this);
4155 else if (output == OnlyBody)
4157 os << from_utf8(ods.str());
4158 } else if (runparams.flavor == Flavor::Html) {
4159 writeLyXHTMLSource(os, runparams, output);
4160 } else if (runparams.flavor == Flavor::Text) {
4161 if (output == OnlyPreamble)
4162 os << "% "<< _("Plain text does not have a preamble.");
4164 writePlaintextFile(*this, os, runparams);
4165 } else if (runparams.flavor == Flavor::DocBook5) {
4166 writeDocBookSource(os, runparams, output);
4168 // latex or literate
4171 ots.texrow().newlines(2);
4173 runparams.is_child = true;
4175 writeLaTeXSource(ots, string(), runparams, output);
4176 texrow = ots.releaseTexRow();
4183 ErrorList & Buffer::errorList(string const & type) const
4185 return d->errorLists[type];
4189 void Buffer::updateTocItem(std::string const & type,
4190 DocIterator const & dit) const
4193 d->gui_->updateTocItem(type, dit);
4197 void Buffer::structureChanged() const
4200 d->gui_->structureChanged();
4204 void Buffer::errors(string const & err, bool from_master) const
4207 d->gui_->errors(err, from_master);
4211 void Buffer::message(docstring const & msg) const
4214 d->gui_->message(msg);
4218 void Buffer::setBusy(bool on) const
4221 d->gui_->setBusy(on);
4225 void Buffer::updateTitles() const
4228 d->wa_->updateTitles();
4232 void Buffer::resetAutosaveTimers() const
4235 d->gui_->resetAutosaveTimers();
4239 bool Buffer::hasGuiDelegate() const
4245 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4251 FileName Buffer::getEmergencyFileName() const
4253 return FileName(d->filename.absFileName() + ".emergency");
4257 FileName Buffer::getAutosaveFileName() const
4259 // if the document is unnamed try to save in the backup dir, else
4260 // in the default document path, and as a last try in the filePath,
4261 // which will most often be the temporary directory
4264 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4265 : lyxrc.backupdir_path;
4266 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4269 string const fname = "#" + d->filename.onlyFileName() + "#";
4271 return makeAbsPath(fname, fpath);
4275 void Buffer::removeAutosaveFile() const
4277 FileName const f = getAutosaveFileName();
4283 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4285 FileName const newauto = getAutosaveFileName();
4287 if (newauto != oldauto && oldauto.exists())
4288 if (!oldauto.moveTo(newauto))
4289 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4293 bool Buffer::autoSave() const
4295 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4296 if (buf->d->bak_clean || hasReadonlyFlag())
4299 message(_("Autosaving current document..."));
4300 buf->d->bak_clean = true;
4302 FileName const fname = getAutosaveFileName();
4303 LASSERT(d->cloned_buffer_, return false);
4305 // If this buffer is cloned, we assume that
4306 // we are running in a separate thread already.
4307 TempFile tempfile("lyxautoXXXXXX.lyx");
4308 tempfile.setAutoRemove(false);
4309 FileName const tmp_ret = tempfile.name();
4310 if (!tmp_ret.empty()) {
4312 // assume successful write of tmp_ret
4313 if (tmp_ret.moveTo(fname))
4316 // failed to write/rename tmp_ret so try writing direct
4317 return writeFile(fname);
4321 void Buffer::setExportStatus(bool e) const
4323 d->doing_export = e;
4324 ListOfBuffers clist = getDescendants();
4325 for (auto const & bit : clist)
4326 bit->d->doing_export = e;
4330 bool Buffer::isExporting() const
4332 return d->doing_export;
4336 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4340 return doExport(target, put_in_tempdir, result_file);
4343 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4344 string & result_file) const
4346 bool const update_unincluded =
4347 params().maintain_unincluded_children != BufferParams::CM_None
4348 && !params().getIncludedChildren().empty();
4350 // (1) export with all included children (omit \includeonly)
4351 if (update_unincluded) {
4352 ExportStatus const status =
4353 doExport(target, put_in_tempdir, true, result_file);
4354 if (status != ExportSuccess)
4357 // (2) export with included children only
4358 return doExport(target, put_in_tempdir, false, result_file);
4362 void Buffer::setMathFlavor(OutputParams & op) const
4364 switch (params().html_math_output) {
4365 case BufferParams::MathML:
4366 op.math_flavor = OutputParams::MathAsMathML;
4368 case BufferParams::HTML:
4369 op.math_flavor = OutputParams::MathAsHTML;
4371 case BufferParams::Images:
4372 op.math_flavor = OutputParams::MathAsImages;
4374 case BufferParams::LaTeX:
4375 op.math_flavor = OutputParams::MathAsLaTeX;
4381 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4382 bool includeall, string & result_file) const
4384 LYXERR(Debug::FILES, "target=" << target);
4385 OutputParams runparams(¶ms().encoding());
4386 string format = target;
4387 string dest_filename;
4388 size_t pos = target.find(' ');
4389 if (pos != string::npos) {
4390 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4391 format = target.substr(0, pos);
4392 if (format == "default")
4393 format = params().getDefaultOutputFormat();
4394 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4395 FileName(dest_filename).onlyPath().createPath();
4396 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4398 MarkAsExporting exporting(this);
4399 string backend_format;
4400 runparams.flavor = Flavor::LaTeX;
4401 runparams.linelen = lyxrc.plaintext_linelen;
4402 runparams.includeall = includeall;
4403 vector<string> backs = params().backends();
4404 Converters converters = theConverters();
4405 bool need_nice_file = false;
4406 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4407 // Get shortest path to format
4408 converters.buildGraph();
4409 Graph::EdgePath path;
4410 for (string const & sit : backs) {
4411 Graph::EdgePath p = converters.getPath(sit, format);
4412 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4413 backend_format = sit;
4418 if (!put_in_tempdir) {
4419 // Only show this alert if this is an export to a non-temporary
4420 // file (not for previewing).
4421 docstring s = bformat(_("No information for exporting the format %1$s."),
4422 translateIfPossible(theFormats().prettyName(format)));
4423 if (format == "pdf4")
4425 + bformat(_("Hint: use non-TeX fonts or set input encoding "
4426 " to '%1$s'"), from_utf8(encodings.fromLyXName("ascii")->guiName()));
4427 Alert::error(_("Couldn't export file"), s);
4429 return ExportNoPathToFormat;
4431 runparams.flavor = converters.getFlavor(path, this);
4432 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4433 for (auto const & edge : path)
4434 if (theConverters().get(edge).nice()) {
4435 need_nice_file = true;
4440 backend_format = format;
4441 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4442 // FIXME: Don't hardcode format names here, but use a flag
4443 if (backend_format == "pdflatex")
4444 runparams.flavor = Flavor::PdfLaTeX;
4445 else if (backend_format == "luatex")
4446 runparams.flavor = Flavor::LuaTeX;
4447 else if (backend_format == "dviluatex")
4448 runparams.flavor = Flavor::DviLuaTeX;
4449 else if (backend_format == "xetex")
4450 runparams.flavor = Flavor::XeTeX;
4453 string filename = latexName(false);
4454 filename = addName(temppath(), filename);
4455 filename = changeExtension(filename,
4456 theFormats().extension(backend_format));
4457 LYXERR(Debug::FILES, "filename=" << filename);
4459 // Plain text backend
4460 if (backend_format == "text") {
4461 runparams.flavor = Flavor::Text;
4463 writePlaintextFile(*this, FileName(filename), runparams);
4465 catch (ConversionException const &) { return ExportCancel; }
4468 else if (backend_format == "xhtml") {
4469 runparams.flavor = Flavor::Html;
4470 setMathFlavor(runparams);
4471 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4472 return ExportKilled;
4473 } else if (backend_format == "lyx")
4474 writeFile(FileName(filename));
4476 else if (backend_format == "docbook5") {
4477 runparams.flavor = Flavor::DocBook5;
4478 runparams.nice = false;
4479 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4480 return ExportKilled;
4483 else if (backend_format == format || need_nice_file) {
4484 runparams.nice = true;
4485 ExportStatus const retval =
4486 makeLaTeXFile(FileName(filename), string(), runparams);
4487 if (retval == ExportKilled)
4488 return ExportKilled;
4489 if (d->cloned_buffer_)
4490 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4491 if (retval != ExportSuccess)
4493 } else if (!lyxrc.tex_allows_spaces
4494 && contains(filePath(), ' ')) {
4495 Alert::error(_("File name error"),
4496 bformat(_("The directory path to the document\n%1$s\n"
4497 "contains spaces, but your TeX installation does "
4498 "not allow them. You should save the file to a directory "
4499 "whose name does not contain spaces."), from_utf8(filePath())));
4500 return ExportTexPathHasSpaces;
4502 runparams.nice = false;
4503 ExportStatus const retval =
4504 makeLaTeXFile(FileName(filename), filePath(), runparams);
4505 if (retval == ExportKilled)
4506 return ExportKilled;
4507 if (d->cloned_buffer_)
4508 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4509 if (retval != ExportSuccess)
4513 string const error_type = (format == "program")
4514 ? "Build" : params().bufferFormat();
4515 ErrorList & error_list = d->errorLists[error_type];
4516 string const ext = theFormats().extension(format);
4517 FileName const tmp_result_file(changeExtension(filename, ext));
4518 Converters::RetVal const retval =
4519 converters.convert(this, FileName(filename), tmp_result_file,
4520 FileName(absFileName()), backend_format, format,
4521 error_list, Converters::none, includeall);
4522 if (retval == Converters::KILLED)
4523 return ExportCancel;
4524 bool success = (retval == Converters::SUCCESS);
4526 // Emit the signal to show the error list or copy it back to the
4527 // cloned Buffer so that it can be emitted afterwards.
4528 if (format != backend_format) {
4529 if (runparams.silent)
4531 else if (d->cloned_buffer_)
4532 d->cloned_buffer_->d->errorLists[error_type] =
4533 d->errorLists[error_type];
4536 // also to the children, in case of master-buffer-view
4537 ListOfBuffers clist = getDescendants();
4538 for (auto const & bit : clist) {
4539 if (runparams.silent)
4540 bit->d->errorLists[error_type].clear();
4541 else if (d->cloned_buffer_) {
4542 // Enable reverse search by copying back the
4543 // texrow object to the cloned buffer.
4544 // FIXME: this is not thread safe.
4545 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4546 bit->d->cloned_buffer_->d->errorLists[error_type] =
4547 bit->d->errorLists[error_type];
4549 bit->errors(error_type, true);
4553 if (d->cloned_buffer_) {
4554 // Enable reverse dvi or pdf to work by copying back the texrow
4555 // object to the cloned buffer.
4556 // FIXME: There is a possibility of concurrent access to texrow
4557 // here from the main GUI thread that should be securized.
4558 d->cloned_buffer_->d->texrow = d->texrow;
4559 string const err_type = params().bufferFormat();
4560 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4564 if (put_in_tempdir) {
4565 result_file = tmp_result_file.absFileName();
4566 return success ? ExportSuccess : ExportConverterError;
4569 if (dest_filename.empty())
4570 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4572 result_file = dest_filename;
4573 // We need to copy referenced files (e. g. included graphics
4574 // if format == "dvi") to the result dir.
4575 vector<ExportedFile> const extfiles =
4576 runparams.exportdata->externalFiles(format);
4577 string const dest = runparams.export_folder.empty() ?
4578 onlyPath(result_file) : runparams.export_folder;
4579 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4580 : force_overwrite == ALL_FILES;
4581 CopyStatus status = use_force ? FORCE : SUCCESS;
4583 for (ExportedFile const & exp : extfiles) {
4584 if (status == CANCEL) {
4585 message(_("Document export cancelled."));
4586 return ExportCancel;
4588 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4589 string fixedName = exp.exportName;
4590 if (!runparams.export_folder.empty()) {
4591 // Relative pathnames starting with ../ will be sanitized
4592 // if exporting to a different folder
4593 while (fixedName.substr(0, 3) == "../")
4594 fixedName = fixedName.substr(3, fixedName.length() - 3);
4596 FileName fixedFileName = makeAbsPath(fixedName, dest);
4597 fixedFileName.onlyPath().createPath();
4598 status = copyFile(fmt, exp.sourceName,
4600 exp.exportName, status == FORCE,
4601 runparams.export_folder.empty());
4605 if (tmp_result_file.exists()) {
4606 // Finally copy the main file
4607 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4608 : force_overwrite != NO_FILES;
4609 if (status == SUCCESS && use_force)
4611 status = copyFile(format, tmp_result_file,
4612 FileName(result_file), result_file,
4614 if (status == CANCEL) {
4615 message(_("Document export cancelled."));
4616 return ExportCancel;
4618 message(bformat(_("Document exported as %1$s "
4620 translateIfPossible(theFormats().prettyName(format)),
4621 makeDisplayPath(result_file)));
4624 // This must be a dummy converter like fax (bug 1888)
4625 message(bformat(_("Document exported as %1$s"),
4626 translateIfPossible(theFormats().prettyName(format))));
4629 return success ? ExportSuccess : ExportConverterError;
4633 Buffer::ExportStatus Buffer::preview(string const & format) const
4635 bool const update_unincluded =
4636 params().maintain_unincluded_children != BufferParams::CM_None
4637 && !params().getIncludedChildren().empty();
4638 return preview(format, update_unincluded);
4642 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4644 MarkAsExporting exporting(this);
4646 // (1) export with all included children (omit \includeonly)
4648 ExportStatus const status = doExport(format, true, true, result_file);
4649 if (status != ExportSuccess)
4652 // (2) export with included children only
4653 ExportStatus const status = doExport(format, true, false, result_file);
4654 FileName const previewFile(result_file);
4656 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4657 theimpl->preview_file_ = previewFile;
4658 theimpl->preview_format_ = format;
4659 theimpl->require_fresh_start_ = (status != ExportSuccess);
4661 if (status != ExportSuccess)
4664 if (previewFile.exists())
4665 return theFormats().view(*this, previewFile, format) ?
4666 PreviewSuccess : PreviewError;
4668 // Successful export but no output file?
4669 // Probably a bug in error detection.
4670 LATTEST(status != ExportSuccess);
4675 Buffer::ReadStatus Buffer::extractFromVC()
4677 bool const found = LyXVC::file_not_found_hook(d->filename);
4679 return ReadFileNotFound;
4680 if (!d->filename.isReadableFile())
4686 Buffer::ReadStatus Buffer::loadEmergency()
4688 FileName const emergencyFile = getEmergencyFileName();
4689 if (!emergencyFile.exists()
4690 || emergencyFile.lastModified() <= d->filename.lastModified())
4691 return ReadFileNotFound;
4693 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4694 docstring const text = bformat(_("An emergency save of the document "
4695 "%1$s exists.\n\nRecover emergency save?"), file);
4697 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4698 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4704 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4705 bool const success = (ret_llf == ReadSuccess);
4707 if (hasReadonlyFlag()) {
4708 Alert::warning(_("File is read-only"),
4709 bformat(_("An emergency file is successfully loaded, "
4710 "but the original file %1$s is marked read-only. "
4711 "Please make sure to save the document as a different "
4712 "file."), from_utf8(d->filename.absFileName())));
4715 lyxvc().file_found_hook(d->filename);
4716 str = _("Document was successfully recovered.");
4718 str = _("Document was NOT successfully recovered.");
4719 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4720 makeDisplayPath(emergencyFile.absFileName()));
4722 int const del_emerg =
4723 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4724 _("&Remove"), _("&Keep"));
4725 if (del_emerg == 0) {
4726 emergencyFile.removeFile();
4728 Alert::warning(_("Emergency file deleted"),
4729 _("Do not forget to save your file now!"), true);
4731 return success ? ReadSuccess : ReadEmergencyFailure;
4734 int const del_emerg =
4735 Alert::prompt(_("Delete emergency file?"),
4736 _("Remove emergency file now?"), 1, 1,
4737 _("&Remove"), _("&Keep"));
4739 emergencyFile.removeFile();
4743 string const ename = emergencyFile.absFileName();
4745 // Surely we can find one in 100 tries?
4746 for (int i = 1; i < 100; ++i) {
4747 newname.set(ename + to_string(i) + ".lyx");
4748 if (!newname.exists()) {
4754 // renameTo returns true on success. So inverting that
4755 // will give us true if we fail.
4756 noname = !emergencyFile.renameTo(newname);
4759 Alert::warning(_("Can't rename emergency file!"),
4760 _("LyX was unable to rename the emergency file. "
4761 "You should do so manually. Otherwise, you will be "
4762 "asked about it again the next time you try to load "
4763 "this file, and may over-write your own work."));
4765 Alert::warning(_("Emergency File Renames"),
4766 bformat(_("Emergency file renamed as:\n %1$s"),
4767 from_utf8(newname.onlyFileName())));
4770 return ReadOriginal;
4780 Buffer::ReadStatus Buffer::loadAutosave()
4782 // Now check if autosave file is newer.
4783 FileName const autosaveFile = getAutosaveFileName();
4784 if (!autosaveFile.exists()
4785 || autosaveFile.lastModified() <= d->filename.lastModified())
4786 return ReadFileNotFound;
4788 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4789 docstring const text = bformat(_("The backup of the document %1$s "
4790 "is newer.\n\nLoad the backup instead?"), file);
4791 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4792 _("&Load backup"), _("Load &original"), _("&Cancel"));
4797 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4798 // the file is not saved if we load the autosave file.
4799 if (ret_llf == ReadSuccess) {
4800 if (hasReadonlyFlag()) {
4801 Alert::warning(_("File is read-only"),
4802 bformat(_("A backup file is successfully loaded, "
4803 "but the original file %1$s is marked read-only. "
4804 "Please make sure to save the document as a "
4806 from_utf8(d->filename.absFileName())));
4809 lyxvc().file_found_hook(d->filename);
4812 return ReadAutosaveFailure;
4815 // Here we delete the autosave
4816 autosaveFile.removeFile();
4817 return ReadOriginal;
4825 Buffer::ReadStatus Buffer::loadLyXFile()
4827 if (!d->filename.isReadableFile()) {
4828 ReadStatus const ret_rvc = extractFromVC();
4829 if (ret_rvc != ReadSuccess)
4833 ReadStatus const ret_re = loadEmergency();
4834 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4837 ReadStatus const ret_ra = loadAutosave();
4838 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4841 return loadThisLyXFile(d->filename);
4845 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4847 return readFile(fn);
4851 void Buffer::Impl::traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const
4853 for (; err != end; ++err) {
4854 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4855 int errorRow = err->error_in_line;
4856 Buffer const * buf = nullptr;
4857 Impl const * p = this;
4858 if (err->child_name.empty())
4859 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4861 // The error occurred in a child
4862 for (Buffer const * child : owner_->getDescendants()) {
4863 string const child_name =
4864 DocFileName(changeExtension(child->absFileName(), "tex")).
4866 if (err->child_name != child_name)
4868 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4869 if (!TexRow::isNone(start)) {
4870 buf = this->cloned_buffer_
4871 ? child->d->cloned_buffer_->d->owner_
4878 errorList.push_back(ErrorItem(err->error_desc, err->error_text,
4884 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4886 TeXErrors::Errors::const_iterator err = terr.begin();
4887 TeXErrors::Errors::const_iterator end = terr.end();
4889 d->traverseErrors(err, end, errorList);
4893 void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const
4895 TeXErrors::Errors::const_iterator err = terr.begin_ref();
4896 TeXErrors::Errors::const_iterator end = terr.end_ref();
4898 d->traverseErrors(err, end, errorList);
4902 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4904 LBUFERR(!text().paragraphs().empty());
4906 // Use the master text class also for child documents
4907 Buffer const * const master = masterBuffer();
4908 DocumentClass const & textclass = master->params().documentClass();
4910 docstring_list old_bibfiles;
4911 // Do this only if we are the top-level Buffer. We also need to account
4912 // for the case of a previewed child with ignored parent here.
4913 if (master == this && !d->ignore_parent) {
4914 textclass.counters().reset(from_ascii("bibitem"));
4915 reloadBibInfoCache();
4916 // we will re-read this cache as we go through, but we need
4917 // to know whether it's changed to know whether we need to
4918 // update the bibinfo cache.
4919 old_bibfiles = d->bibfiles_cache_;
4920 d->bibfiles_cache_.clear();
4923 // keep the buffers to be children in this set. If the call from the
4924 // master comes back we can see which of them were actually seen (i.e.
4925 // via an InsetInclude). The remaining ones in the set need still be updated.
4926 static std::set<Buffer const *> bufToUpdate;
4927 if (scope == UpdateMaster) {
4928 // If this is a child document start with the master
4929 if (master != this) {
4930 bufToUpdate.insert(this);
4931 master->updateBuffer(UpdateMaster, utype);
4932 // If the master buffer has no gui associated with it, then the TocModel is
4933 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4934 // (bug 5699). The same happens if the master buffer is open in a different
4935 // window. This test catches both possibilities.
4936 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
4937 // There remains a problem here: If there is another child open in yet a third
4938 // window, that TOC is not updated. So some more general solution is needed at
4940 if (master->d->gui_ != d->gui_)
4943 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4944 if (bufToUpdate.find(this) == bufToUpdate.end())
4948 // start over the counters in the master
4949 textclass.counters().reset();
4952 // update will be done below for this buffer
4953 bufToUpdate.erase(this);
4955 // update all caches
4956 clearReferenceCache();
4959 Buffer & cbuf = const_cast<Buffer &>(*this);
4960 // if we are reloading, then we could have a dangling TOC,
4961 // in effect. so we need to go ahead and reset, even though
4962 // we will do so again when we rebuild the TOC later.
4963 cbuf.tocBackend().reset();
4966 ParIterator parit = cbuf.par_iterator_begin();
4967 if (scope == UpdateMaster)
4969 updateBuffer(parit, utype);
4971 // If this document has siblings, then update the TocBackend later. The
4972 // reason is to ensure that later siblings are up to date when e.g. the
4973 // broken or not status of references is computed. The update is called
4974 // in InsetInclude::addToToc.
4978 // if the bibfiles changed, the cache of bibinfo is invalid
4979 docstring_list new_bibfiles = d->bibfiles_cache_;
4980 // this is a trick to determine whether the two vectors have
4981 // the same elements.
4982 sort(new_bibfiles.begin(), new_bibfiles.end());
4983 sort(old_bibfiles.begin(), old_bibfiles.end());
4984 if (old_bibfiles != new_bibfiles) {
4985 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
4986 invalidateBibinfoCache();
4987 reloadBibInfoCache();
4988 // We relied upon the bibinfo cache when recalculating labels. But that
4989 // cache was invalid, although we didn't find that out until now. So we
4990 // have to do it all again.
4991 // That said, the only thing we really need to do is update the citation
4992 // labels. Nothing else will have changed. So we could create a new
4993 // UpdateType that would signal that fact, if we needed to do so.
4994 parit = cbuf.par_iterator_begin();
4995 // we will be re-doing the counters and references and such.
4996 textclass.counters().reset();
4997 clearReferenceCache();
4998 // we should not need to do this again?
5000 updateBuffer(parit, utype);
5001 // this will already have been done by reloadBibInfoCache();
5002 // d->bibinfo_cache_valid_ = true;
5005 LYXERR(Debug::FILES, "Bibfiles unchanged.");
5006 // this is also set to true on the other path, by reloadBibInfoCache.
5007 d->bibinfo_cache_valid_ = true;
5009 d->cite_labels_valid_ = true;
5012 cbuf.tocBackend().update(true, utype);
5013 if (scope == UpdateMaster)
5014 cbuf.structureChanged();
5016 d->need_update = false;
5020 static depth_type getDepth(DocIterator const & it)
5022 depth_type depth = 0;
5023 for (size_t i = 0 ; i < it.depth() ; ++i)
5024 if (!it[i].inset().inMathed())
5025 depth += it[i].paragraph().getDepth() + 1;
5026 // remove 1 since the outer inset does not count
5027 // we should have at least one non-math inset, so
5028 // depth should nevery be 0. but maybe it is worth
5029 // marking this, just in case.
5031 // coverity[INTEGER_OVERFLOW]
5035 static depth_type getItemDepth(ParIterator const & it)
5037 Paragraph const & par = *it;
5038 LabelType const labeltype = par.layout().labeltype;
5040 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5043 // this will hold the lowest depth encountered up to now.
5044 depth_type min_depth = getDepth(it);
5045 ParIterator prev_it = it;
5048 --prev_it.top().pit();
5050 // start of nested inset: go to outer par
5052 if (prev_it.empty()) {
5053 // start of document: nothing to do
5058 // We search for the first paragraph with same label
5059 // that is not more deeply nested.
5060 Paragraph & prev_par = *prev_it;
5061 depth_type const prev_depth = getDepth(prev_it);
5062 if (labeltype == prev_par.layout().labeltype) {
5063 if (prev_depth < min_depth)
5064 return prev_par.itemdepth + 1;
5065 if (prev_depth == min_depth)
5066 return prev_par.itemdepth;
5068 min_depth = min(min_depth, prev_depth);
5069 // small optimization: if we are at depth 0, we won't
5070 // find anything else
5071 if (prev_depth == 0)
5077 static bool needEnumCounterReset(ParIterator const & it)
5079 Paragraph const & par = *it;
5080 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5081 depth_type const cur_depth = par.getDepth();
5082 ParIterator prev_it = it;
5083 while (prev_it.pit()) {
5084 --prev_it.top().pit();
5085 Paragraph const & prev_par = *prev_it;
5086 if (prev_par.getDepth() <= cur_depth)
5087 return prev_par.layout().name() != par.layout().name();
5089 // start of nested inset: reset
5094 // set the label of a paragraph. This includes the counters.
5095 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5097 BufferParams const & bp = owner_->masterBuffer()->params();
5098 DocumentClass const & textclass = bp.documentClass();
5099 Paragraph & par = it.paragraph();
5100 Layout const & layout = par.layout();
5101 Counters & counters = textclass.counters();
5103 if (par.params().startOfAppendix()) {
5104 // We want to reset the counter corresponding to toplevel sectioning
5105 Layout const & lay = textclass.getTOCLayout();
5106 docstring const cnt = lay.counter;
5108 counters.reset(cnt);
5109 counters.appendix(true);
5111 par.params().appendix(counters.appendix());
5113 // Compute the item depth of the paragraph
5114 par.itemdepth = getItemDepth(it);
5116 if (layout.margintype == MARGIN_MANUAL) {
5117 if (par.params().labelWidthString().empty())
5118 par.params().labelWidthString(par.expandLabel(layout, bp));
5119 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5120 // we do not need to do anything here, since the empty case is
5121 // handled during export.
5123 par.params().labelWidthString(docstring());
5126 switch(layout.labeltype) {
5127 case LABEL_ITEMIZE: {
5128 // At some point of time we should do something more
5129 // clever here, like:
5130 // par.params().labelString(
5131 // bp.user_defined_bullet(par.itemdepth).getText());
5132 // for now, use a simple hardcoded label
5133 docstring itemlabel;
5134 switch (par.itemdepth) {
5137 itemlabel = char_type(0x2022);
5141 itemlabel = char_type(0x2013);
5144 // ∗ U+2217 ASTERISK OPERATOR
5145 itemlabel = char_type(0x2217);
5148 // · U+00B7 MIDDLE DOT
5149 itemlabel = char_type(0x00b7);
5152 par.params().labelString(itemlabel);
5156 case LABEL_ENUMERATE: {
5157 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5159 switch (par.itemdepth) {
5170 enumcounter += "iv";
5173 // not a valid enumdepth...
5177 if (needEnumCounterReset(it)) {
5178 // Increase the parent counter?
5179 if (layout.stepparentcounter)
5180 counters.stepParent(enumcounter, utype);
5181 // Maybe we have to reset the enumeration counter.
5182 if (!layout.resumecounter)
5183 counters.reset(enumcounter);
5185 counters.step(enumcounter, utype);
5187 string const & lang = par.getParLanguage(bp)->code();
5188 par.params().labelString(counters.theCounter(enumcounter, lang));
5193 case LABEL_SENSITIVE: {
5194 string const & type = counters.current_float();
5195 docstring full_label;
5197 full_label = owner_->B_("Senseless!!! ");
5199 docstring name = owner_->B_(textclass.floats().getType(type).name());
5200 if (counters.hasCounter(from_utf8(type))) {
5201 string const & lang = par.getParLanguage(bp)->code();
5202 counters.step(from_utf8(type), utype);
5203 full_label = bformat(from_ascii("%1$s %2$s:"),
5205 counters.theCounter(from_utf8(type), lang));
5207 full_label = bformat(from_ascii("%1$s #:"), name);
5209 par.params().labelString(full_label);
5213 case LABEL_NO_LABEL:
5214 par.params().labelString(docstring());
5218 case LABEL_CENTERED:
5219 case LABEL_STATIC: {
5220 docstring const & lcounter = layout.counter;
5221 if (!lcounter.empty()) {
5222 if (layout.toclevel <= bp.secnumdepth
5223 && (layout.latextype != LATEX_ENVIRONMENT
5224 || it.text()->isFirstInSequence(it.pit()))) {
5225 if (counters.hasCounter(lcounter))
5226 counters.step(lcounter, utype);
5227 par.params().labelString(par.expandLabel(layout, bp));
5229 par.params().labelString(docstring());
5231 par.params().labelString(par.expandLabel(layout, bp));
5237 par.params().labelString(par.expandLabel(layout, bp));
5242 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype, bool const deleted) const
5244 pushIncludedBuffer(this);
5245 // LASSERT: Is it safe to continue here, or should we just return?
5246 LASSERT(parit.pit() == 0, /**/);
5248 // Set the position of the text in the buffer to be able
5249 // to resolve macros in it.
5250 parit.text()->setMacrocontextPosition(parit);
5252 depth_type maxdepth = 0;
5253 pit_type const lastpit = parit.lastpit();
5254 bool changed = false;
5255 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5256 // reduce depth if necessary
5257 if (parit->params().depth() > maxdepth) {
5258 /** FIXME: this function is const, but
5259 * nevertheless it modifies the buffer. To be
5260 * cleaner, one should modify the buffer in
5261 * another function, which is actually
5262 * non-const. This would however be costly in
5263 * terms of code duplication.
5265 CursorData(parit).recordUndo();
5266 parit->params().depth(maxdepth);
5268 maxdepth = parit->getMaxDepthAfter();
5270 if (utype == OutputUpdate) {
5271 // track the active counters
5272 // we have to do this for the master buffer, since the local
5273 // buffer isn't tracking anything.
5274 masterBuffer()->params().documentClass().counters().
5275 setActiveLayout(parit->layout());
5278 // set the counter for this paragraph
5279 d->setLabel(parit, utype);
5282 for (auto const & insit : parit->insetList()) {
5283 parit.pos() = insit.pos;
5284 insit.inset->updateBuffer(parit, utype, deleted || parit->isDeleted(insit.pos));
5285 changed |= insit.inset->isChanged();
5288 // are there changes in this paragraph?
5289 changed |= parit->isChanged();
5292 // set change indicator for the inset (or the cell that the iterator
5293 // points to, if applicable).
5294 parit.text()->inset().isChanged(changed);
5295 popIncludedBuffer();
5299 void Buffer::forceUpdate() const
5301 d->need_update = true;
5305 bool Buffer::needUpdate() const
5307 return d->need_update;
5311 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5312 WordLangTuple & word_lang, docstring_list & suggestions) const
5316 suggestions.clear();
5317 word_lang = WordLangTuple();
5318 bool const to_end = to.empty();
5319 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5320 // OK, we start from here.
5321 for (; from != end; from.forwardPos()) {
5322 // This skips all insets with spell check disabled.
5323 while (!from.allowSpellCheck()) {
5327 // If from is at the end of the document (which is possible
5328 // when "from" was changed above) LyX will crash later otherwise.
5329 if (from.atEnd() || (!to_end && from >= end))
5332 from.paragraph().spellCheck();
5333 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5334 if (SpellChecker::misspelled(res)) {
5338 // Do not increase progress when from == to, otherwise the word
5339 // count will be wrong.
5349 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5351 bool inword = false;
5356 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5357 if (!dit.inTexted()) {
5362 Paragraph const & par = dit.paragraph();
5363 pos_type const pos = dit.pos();
5365 // Copied and adapted from isWordSeparator() in Paragraph
5366 if (pos == dit.lastpos()) {
5369 Inset const * ins = par.getInset(pos);
5370 if (ins && skipNoOutput && !ins->producesOutput()) {
5373 // stop if end of range was skipped
5374 if (!to.atEnd() && dit >= to)
5377 } else if (!par.isDeleted(pos)) {
5378 if (par.isWordSeparator(pos))
5384 if (ins && ins->isLetter()) {
5385 odocstringstream os;
5387 char_count_ += os.str().length();
5389 else if (ins && ins->isSpace())
5392 pair<int, int> words = ins->isWords();
5393 char_count_ += words.first;
5394 word_count_ += words.second;
5398 char_type const c = par.getChar(pos);
5399 if (isPrintableNonspace(c))
5401 else if (isSpace(c))
5411 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5413 d->updateStatistics(from, to, skipNoOutput);
5417 int Buffer::wordCount() const
5419 return d->wordCount();
5423 int Buffer::charCount(bool with_blanks) const
5425 return d->charCount(with_blanks);
5429 bool Buffer::areChangesPresent() const
5431 return inset().isChanged();
5435 Buffer::ReadStatus Buffer::reload()
5438 // c.f. bug https://www.lyx.org/trac/ticket/6587
5439 removeAutosaveFile();
5440 // e.g., read-only status could have changed due to version control
5441 d->filename.refresh();
5442 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5444 // clear parent. this will get reset if need be.
5445 d->setParent(nullptr);
5446 ReadStatus const status = loadLyXFile();
5447 if (status == ReadSuccess) {
5452 message(bformat(_("Document %1$s reloaded."), disp_fn));
5455 message(bformat(_("Could not reload document %1$s."), disp_fn));
5465 bool Buffer::saveAs(FileName const & fn)
5467 FileName const old_name = fileName();
5468 FileName const old_auto = getAutosaveFileName();
5469 bool const old_unnamed = isUnnamed();
5470 bool success = true;
5471 d->old_position = filePath();
5478 // bring the autosave file with us, just in case.
5479 moveAutosaveFile(old_auto);
5480 // validate version control data and
5481 // correct buffer title
5482 lyxvc().file_found_hook(fileName());
5484 // the file has now been saved to the new location.
5485 // we need to check that the locations of child buffers
5487 checkChildBuffers();
5488 checkMasterBuffer();
5491 // reset the old filename and unnamed state
5492 setFileName(old_name);
5493 setUnnamed(old_unnamed);
5497 d->old_position.clear();
5502 void Buffer::checkChildBuffers()
5504 for (auto const & bit : d->children_positions) {
5505 DocIterator dit = bit.second;
5506 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5507 if (!cbuf || !theBufferList().isLoaded(cbuf))
5509 Inset * inset = dit.nextInset();
5510 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5511 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5512 docstring const & incfile = inset_inc->getParam("filename");
5513 string oldloc = cbuf->absFileName();
5514 string newloc = makeAbsPath(to_utf8(incfile),
5515 onlyPath(absFileName())).absFileName();
5516 if (oldloc == newloc)
5518 // the location of the child file is incorrect.
5519 cbuf->setParent(nullptr);
5520 inset_inc->setChildBuffer(nullptr);
5522 // invalidate cache of children
5523 d->children_positions.clear();
5524 d->position_to_children.clear();
5528 // If a child has been saved under a different name/path, it might have been
5529 // orphaned. Therefore the master needs to be reset (bug 8161).
5530 void Buffer::checkMasterBuffer()
5532 Buffer const * const master = masterBuffer();
5536 // necessary to re-register the child (bug 5873)
5537 // FIXME: clean up updateMacros (here, only
5538 // child registering is needed).
5539 master->updateMacros();
5540 // (re)set master as master buffer, but only
5541 // if we are a real child
5542 if (master->isChild(this))
5549 string Buffer::includedFilePath(string const & name, string const & ext) const
5551 if (d->old_position.empty() ||
5552 equivalent(FileName(d->old_position), FileName(filePath())))
5555 bool isabsolute = FileName::isAbsolute(name);
5556 // both old_position and filePath() end with a path separator
5557 string absname = isabsolute ? name : d->old_position + name;
5559 // if old_position is set to origin, we need to do the equivalent of
5560 // getReferencedFileName() (see readDocument())
5561 if (!isabsolute && d->old_position == params().origin) {
5562 FileName const test(addExtension(filePath() + name, ext));
5564 absname = filePath() + name;
5567 if (!FileName(addExtension(absname, ext)).exists())
5571 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5573 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5574 from_utf8(filePath())));
5578 void Buffer::Impl::refreshFileMonitor()
5580 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5581 file_monitor_->refresh();
5585 // The previous file monitor is invalid
5586 // This also destroys the previous file monitor and all its connections
5587 file_monitor_ = FileSystemWatcher::monitor(filename);
5588 // file_monitor_ will be destroyed with *this, so it is not going to call a
5589 // destroyed object method.
5590 file_monitor_->connect([this](bool exists) {
5591 fileExternallyModified(exists);
5596 void Buffer::Impl::fileExternallyModified(bool const exists)
5598 // ignore notifications after our own saving operations
5599 if (checksum_ == filename.checksum()) {
5600 LYXERR(Debug::FILES, "External modification but "
5601 "checksum unchanged: " << filename);
5604 // If the file has been deleted, only mark the file as dirty since it is
5605 // pointless to prompt for reloading. If later a file is moved into this
5606 // location, then the externally modified warning will appear then.
5608 externally_modified_ = true;
5609 // Update external modification notification.
5610 // Dirty buffers must be visible at all times.
5611 if (wa_ && wa_->unhide(owner_))
5612 wa_->updateTitles();
5614 // Unable to unhide the buffer (e.g. no GUI or not current View)
5619 bool Buffer::notifiesExternalModification() const
5621 return d->externally_modified_;
5625 void Buffer::clearExternalModification() const
5627 d->externally_modified_ = false;
5629 d->wa_->updateTitles();
5633 void Buffer::pushIncludedBuffer(Buffer const * buf) const
5635 masterBuffer()->d->include_list_.push_back(buf);
5636 if (lyxerr.debugging(Debug::FILES)) {
5637 LYXERR0("Pushed. Stack now:");
5638 if (masterBuffer()->d->include_list_.empty())
5641 for (auto const & b : masterBuffer()->d->include_list_)
5642 LYXERR0(b->fileName());
5647 void Buffer::popIncludedBuffer() const
5649 masterBuffer()->d->include_list_.pop_back();
5650 if (lyxerr.debugging(Debug::FILES)) {
5651 LYXERR0("Popped. Stack now:");
5652 if (masterBuffer()->d->include_list_.empty())
5655 for (auto const & b : masterBuffer()->d->include_list_)
5656 LYXERR0(b->fileName());
5661 bool Buffer::isBufferIncluded(Buffer const * buf) const
5665 if (lyxerr.debugging(Debug::FILES)) {
5666 LYXERR0("Checking for " << buf->fileName() << ". Stack now:");
5667 if (masterBuffer()->d->include_list_.empty())
5670 for (auto const & b : masterBuffer()->d->include_list_)
5671 LYXERR0(b->fileName());
5673 list<Buffer const *> const & blist = masterBuffer()->d->include_list_;
5674 return find(blist.begin(), blist.end(), buf) != blist.end();
5678 void Buffer::clearIncludeList() const
5680 LYXERR(Debug::FILES, "Clearing include list for " << fileName());
5681 d->include_list_.clear();