3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Stefan Schimanski
9 * Full author contact details are available in file CREDITS.
17 #include "BiblioInfo.h"
18 #include "BranchList.h"
19 #include "buffer_funcs.h"
20 #include "BufferList.h"
21 #include "BufferParams.h"
25 #include "Converter.h"
28 #include "CutAndPaste.h"
29 #include "DispatchResult.h"
30 #include "DocIterator.h"
31 #include "BufferEncodings.h"
32 #include "ErrorList.h"
35 #include "FuncRequest.h"
36 #include "FuncStatus.h"
37 #include "IndicesList.h"
38 #include "InsetIterator.h"
39 #include "InsetList.h"
41 #include "LaTeXFeatures.h"
45 #include "LyXAction.h"
50 #include "output_latex.h"
51 #include "output_docbook.h"
52 #include "output_plaintext.h"
53 #include "output_xhtml.h"
54 #include "Paragraph.h"
55 #include "ParagraphParameters.h"
56 #include "ParIterator.h"
57 #include "PDFOptions.h"
59 #include "SpellChecker.h"
61 #include "texstream.h"
64 #include "TextClass.h"
65 #include "TocBackend.h"
67 #include "VCBackend.h"
69 #include "WordLangTuple.h"
71 #include "insets/InsetBranch.h"
72 #include "insets/InsetInclude.h"
73 #include "insets/InsetText.h"
75 #include "mathed/InsetMathHull.h"
76 #include "mathed/MacroTable.h"
77 #include "mathed/InsetMathMacroTemplate.h"
78 #include "mathed/MathSupport.h"
80 #include "graphics/PreviewLoader.h"
82 #include "frontends/Application.h"
83 #include "frontends/alert.h"
84 #include "frontends/Delegates.h"
85 #include "frontends/WorkAreaManager.h"
87 #include "support/lassert.h"
88 #include "support/convert.h"
89 #include "support/debug.h"
90 #include "support/docstring_list.h"
91 #include "support/ExceptionMessage.h"
92 #include "support/FileMonitor.h"
93 #include "support/FileName.h"
94 #include "support/FileNameList.h"
95 #include "support/filetools.h"
96 #include "support/gettext.h"
97 #include "support/gzstream.h"
98 #include "support/lstrings.h"
99 #include "support/mutex.h"
100 #include "support/os.h"
101 #include "support/Package.h"
102 #include "support/PathChanger.h"
103 #include "support/Systemcall.h"
104 #include "support/TempFile.h"
105 #include "support/textutils.h"
106 #include "support/types.h"
118 using namespace lyx::support;
119 using namespace lyx::graphics;
123 namespace Alert = frontend::Alert;
124 namespace os = support::os;
128 int const LYX_FORMAT = LYX_FORMAT_LYX;
130 typedef map<string, bool> DepClean;
132 // Information about labels and their associated refs
137 InsetLabel const * inset;
138 /// associated references cache
139 Buffer::References references;
140 /// whether this label is active (i.e., not deleted)
144 typedef vector<LabelInfo> LabelCache;
146 typedef map<docstring, Buffer::References> RefCache;
148 // A storehouse for the cloned buffers.
149 typedef list<CloneList_ptr> CloneStore;
150 CloneStore cloned_buffers;
159 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
163 delete preview_loader_;
171 /// search for macro in local (buffer) table or in children
172 MacroData const * getBufferMacro(docstring const & name,
173 DocIterator const & pos) const;
175 /// Update macro table starting with position of it \param it in some
177 void updateMacros(DocIterator & it, DocIterator & scope);
179 void setLabel(ParIterator & it, UpdateType utype) const;
181 /** If we have branches that use the file suffix
182 feature, return the file name with suffix appended.
184 FileName exportFileName() const;
191 mutable TexRow texrow;
193 /// need to regenerate .tex?
196 /// name of the file the buffer is associated with.
200 mutable TocBackend toc_backend;
205 ScopeMacro(DocIterator const & s, MacroData const & m)
206 : scope(s), macro(m) {}
210 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
211 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
212 /// map from the macro name to the position map,
213 /// which maps the macro definition position to the scope and the MacroData.
214 NamePositionScopeMacroMap macros;
216 /// positions of child buffers in the buffer
217 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
219 ScopeBuffer() : buffer(nullptr) {}
220 ScopeBuffer(DocIterator const & s, Buffer const * b)
221 : scope(s), buffer(b) {}
223 Buffer const * buffer;
225 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
226 /// position of children buffers in this buffer
227 BufferPositionMap children_positions;
228 /// map from children inclusion positions to their scope and their buffer
229 PositionScopeBufferMap position_to_children;
231 /// Contains the old buffer filePath() while saving-as, or the
232 /// directory where the document was last saved while loading.
235 /** Keeps track of the path of local layout files.
236 * If possible, it is always relative to the buffer path.
237 * Empty for layouts in system or user directory.
239 string layout_position;
241 /// Container for all sort of Buffer dependant errors.
242 map<string, ErrorList> errorLists;
244 /// checksum used to test if the file has been externally modified. Used to
245 /// double check whether the file had been externally modified when saving.
246 unsigned long checksum_;
249 frontend::WorkAreaManager * wa_;
251 frontend::GuiBufferDelegate * gui_;
256 /// A cache for the bibfiles (including bibfiles of loaded child
257 /// documents), needed for appropriate update of natbib labels.
258 mutable docstring_list bibfiles_cache_;
260 // FIXME The caching mechanism could be improved. At present, we have a
261 // cache for each Buffer, that caches all the bibliography info for that
262 // Buffer. A more efficient solution would be to have a global cache per
263 // file, and then to construct the Buffer's bibinfo from that.
264 /// A cache for bibliography info
265 mutable BiblioInfo bibinfo_;
266 /// Cache of timestamps of .bib files
267 map<FileName, time_t> bibfile_status_;
269 /// These two hold the file name and format, written to by
270 /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
271 FileName preview_file_;
272 string preview_format_;
274 /// Cache the references associated to a label and their positions
276 mutable RefCache ref_cache_;
277 /// Cache the label insets and their activity status.
278 mutable LabelCache label_cache_;
280 /// our Text that should be wrapped in an InsetText
284 PreviewLoader * preview_loader_;
286 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
287 /// This one is useful for preview detached in a thread.
288 Buffer const * cloned_buffer_;
290 CloneList_ptr clone_list_;
293 std::list<Buffer const *> include_list_;
295 /// So we can force access via the accessors.
296 mutable Buffer const * parent_buffer;
298 FileMonitorPtr file_monitor_;
300 /// ints and bools are all listed last so as to avoid alignment issues
302 /// original format of loaded file
305 /// are we in the process of exporting this buffer?
306 mutable bool doing_export;
308 /// If there was an error when previewing, on the next preview we do
309 /// a fresh compile (e.g. in case the user installed a package that
311 bool require_fresh_start_;
313 /// Indicates whether the bibinfo has changed since the last time
314 /// we ran updateBuffer(), i.e., whether citation labels may need
316 mutable bool cite_labels_valid_;
317 /// Do we have a bibliography environment?
318 mutable bool have_bibitems_;
321 mutable bool lyx_clean;
323 /// is autosave needed?
324 mutable bool bak_clean;
326 /// is this an unnamed file (New...)?
329 /// is this an internal bufffer?
330 bool internal_buffer;
335 /** Set to true only when the file is fully loaded.
336 * Used to prevent the premature generation of previews
337 * and by the citation inset.
339 bool file_fully_loaded;
341 /// if the file was originally loaded from an older format, do
342 /// we need to back it up still?
343 bool need_format_backup;
345 /// Ignore the parent (e.g. when exporting a child standalone)?
348 /// This seem to change the way Buffer::getMacro() works
349 mutable bool macro_lock;
351 /// has been externally modified? Can be reset by the user.
352 mutable bool externally_modified_;
354 /// whether the bibinfo cache is valid
355 mutable bool bibinfo_cache_valid_;
358 mutable bool need_update;
366 /// This is here to force the test to be done whenever parent_buffer
368 Buffer const * parent() const
370 // ignore_parent temporarily "orphans" a buffer
371 // (e.g. if a child is compiled standalone)
374 // if parent_buffer is not loaded, then it has been unloaded,
375 // which means that parent_buffer is an invalid pointer. So we
376 // set it to null in that case.
377 // however, the BufferList doesn't know about cloned buffers, so
378 // they will always be regarded as unloaded. in that case, we hope
380 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
381 parent_buffer = nullptr;
382 return parent_buffer;
386 void setParent(Buffer const * pb)
388 if (parent_buffer == pb)
391 if (!cloned_buffer_ && parent_buffer && pb)
392 LYXERR0("Warning: a buffer should not have two parents!");
394 if (!cloned_buffer_ && parent_buffer)
395 parent_buffer->invalidateBibinfoCache();
398 /// compute statistics
399 /// \p from initial position
400 /// \p to points to the end position
401 void updateStatistics(DocIterator & from, DocIterator & to,
402 bool skipNoOutput = true);
403 /// statistics accessor functions
404 int wordCount() const
408 int charCount(bool with_blanks) const
411 + (with_blanks ? blank_count_ : 0);
414 // Make sure the file monitor monitors the good file.
415 void refreshFileMonitor();
417 /// Notify or clear of external modification
418 void fileExternallyModified(bool exists);
420 ///Binding LaTeX lines with buffer positions.
421 //Common routine for LaTeX and Reference errors listing.
422 void traverseErrors(TeXErrors::Errors::const_iterator err,
423 TeXErrors::Errors::const_iterator end,
424 ErrorList & errorList) const;
428 /// Creates the per buffer temporary directory
429 static FileName createBufferTmpDir()
431 // FIXME This would be the ideal application for a TempDir class (like
432 // TempFile but for directories)
437 Mutex::Locker locker(&mutex);
438 counter = convert<string>(count++);
440 // We are in our own directory. Why bother to mangle name?
441 // In fact I wrote this code to circumvent a problematic behaviour
442 // (bug?) of EMX mkstemp().
443 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
446 if (!tmpfl.createDirectory(0777)) {
447 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
448 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
449 from_utf8(tmpfl.absFileName())));
455 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
456 Buffer const * cloned_buffer)
457 : owner_(owner), filename(file), toc_backend(owner), checksum_(0),
458 wa_(nullptr), gui_(nullptr), undo_(*owner), inset(nullptr),
459 preview_loader_(nullptr), cloned_buffer_(cloned_buffer),
460 clone_list_(nullptr), parent_buffer(nullptr), file_format(LYX_FORMAT),
461 doing_export(false), require_fresh_start_(false), cite_labels_valid_(false),
462 have_bibitems_(false), lyx_clean(true), bak_clean(true), unnamed(false),
463 internal_buffer(false), read_only(readonly_), file_fully_loaded(false),
464 need_format_backup(false), ignore_parent(false), macro_lock(false),
465 externally_modified_(false), bibinfo_cache_valid_(false),
466 need_update(false), word_count_(0), char_count_(0), blank_count_(0)
468 refreshFileMonitor();
469 if (!cloned_buffer_) {
470 temppath = createBufferTmpDir();
471 lyxvc.setBuffer(owner_);
472 Language const * inplang = theApp() ?
473 languages.getFromCode(theApp()->inputLanguageCode())
476 params.language = inplang;
478 wa_ = new frontend::WorkAreaManager;
481 temppath = cloned_buffer_->d->temppath;
482 file_fully_loaded = true;
483 params = cloned_buffer_->d->params;
484 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
485 bibinfo_ = cloned_buffer_->d->bibinfo_;
486 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
487 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
488 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
489 have_bibitems_ = cloned_buffer_->d->have_bibitems_;
490 unnamed = cloned_buffer_->d->unnamed;
491 internal_buffer = cloned_buffer_->d->internal_buffer;
492 layout_position = cloned_buffer_->d->layout_position;
493 preview_file_ = cloned_buffer_->d->preview_file_;
494 preview_format_ = cloned_buffer_->d->preview_format_;
495 require_fresh_start_ = cloned_buffer_->d->require_fresh_start_;
499 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
500 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
502 LYXERR(Debug::INFO, "Buffer::Buffer()");
504 d->inset = new InsetText(*cloned_buffer->d->inset);
505 d->inset->setBuffer(*this);
506 // FIXME: optimize this loop somewhat, maybe by creating a new
507 // general recursive Inset::setId().
508 DocIterator it = doc_iterator_begin(this);
509 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
510 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
511 it.paragraph().setId(cloned_it.paragraph().id());
513 d->inset = new InsetText(this);
514 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
520 LYXERR(Debug::INFO, "Buffer::~Buffer()");
521 // here the buffer should take care that it is
522 // saved properly, before it goes into the void.
524 // GuiView already destroyed
528 // No need to do additional cleanups for internal buffer.
534 // this is in case of recursive includes: we won't try to delete
535 // ourselves as a child.
536 d->clone_list_->erase(this);
537 // loop over children
538 for (auto const & p : d->children_positions) {
539 Buffer * child = const_cast<Buffer *>(p.first);
540 if (d->clone_list_->erase(child))
543 // if we're the master buffer, then we should get rid of the list
546 // If this is not empty, we have leaked something. Worse, one of the
547 // children still has a reference to this list. But we will try to
548 // continue, rather than shut down.
549 LATTEST(d->clone_list_->empty());
550 // The clone list itself is empty, but it's still referenced in our list
551 // of clones. So let's find it and remove it.
552 CloneStore::iterator it =
553 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
554 if (it == cloned_buffers.end()) {
555 // We will leak in this case, but it is safe to continue.
558 cloned_buffers.erase(it);
560 // FIXME Do we really need to do this right before we delete d?
561 // clear references to children in macro tables
562 d->children_positions.clear();
563 d->position_to_children.clear();
565 // loop over children
566 for (auto const & p : d->children_positions) {
567 Buffer * child = const_cast<Buffer *>(p.first);
568 if (theBufferList().isLoaded(child)) {
569 if (theBufferList().isOthersChild(this, child))
570 child->setParent(nullptr);
572 theBufferList().release(child);
577 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
579 msg += emergencyWrite();
581 msg += " " + _("Save failed! Document is lost.");
583 Alert::warning(_("Attempting to close changed document!"), msg);
586 // FIXME Do we really need to do this right before we delete d?
587 // clear references to children in macro tables
588 d->children_positions.clear();
589 d->position_to_children.clear();
591 if (!d->temppath.destroyDirectory()) {
592 LYXERR0(bformat(_("Could not remove the temporary directory %1$s"),
593 from_utf8(d->temppath.absFileName())));
602 Buffer * Buffer::cloneWithChildren() const
605 cloned_buffers.emplace_back(new CloneList);
606 CloneList_ptr clones = cloned_buffers.back();
608 cloneWithChildren(bufmap, clones);
610 // make sure we got cloned
611 BufferMap::const_iterator bit = bufmap.find(this);
612 LASSERT(bit != bufmap.end(), return nullptr);
613 Buffer * cloned_buffer = bit->second;
615 return cloned_buffer;
619 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList_ptr clones) const
621 // have we already been cloned?
622 if (bufmap.find(this) != bufmap.end())
625 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
627 // The clone needs its own DocumentClass, since running updateBuffer() will
628 // modify it, and we would otherwise be sharing it with the original Buffer.
629 buffer_clone->params().makeDocumentClass(true);
630 cap::switchBetweenClasses(
631 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
632 static_cast<InsetText &>(buffer_clone->inset()));
634 bufmap[this] = buffer_clone;
635 clones->insert(buffer_clone);
636 buffer_clone->d->clone_list_ = clones;
637 buffer_clone->d->macro_lock = true;
638 buffer_clone->d->children_positions.clear();
640 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
641 // math macro caches need to be rethought and simplified.
642 // I am not sure wether we should handle Buffer cloning here or in BufferList.
643 // Right now BufferList knows nothing about buffer clones.
644 for (auto const & p : d->position_to_children) {
645 DocIterator dit = p.first.clone(buffer_clone);
646 dit.setBuffer(buffer_clone);
647 Buffer * child = const_cast<Buffer *>(p.second.buffer);
649 child->cloneWithChildren(bufmap, clones);
650 BufferMap::iterator const bit = bufmap.find(child);
651 LASSERT(bit != bufmap.end(), continue);
652 Buffer * child_clone = bit->second;
654 Inset * inset = dit.nextInset();
655 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
656 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
657 inset_inc->setChildBuffer(child_clone);
658 child_clone->d->setParent(buffer_clone);
659 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
660 buffer_clone->setChild(dit, child_clone);
662 buffer_clone->d->macro_lock = false;
666 Buffer * Buffer::cloneBufferOnly() const {
667 cloned_buffers.emplace_back(new CloneList);
668 CloneList_ptr clones = cloned_buffers.back();
669 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
671 // The clone needs its own DocumentClass, since running updateBuffer() will
672 // modify it, and we would otherwise be sharing it with the original Buffer.
673 buffer_clone->params().makeDocumentClass(true);
674 cap::switchBetweenClasses(
675 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
676 static_cast<InsetText &>(buffer_clone->inset()));
678 clones->insert(buffer_clone);
679 buffer_clone->d->clone_list_ = clones;
681 // we won't be cloning the children
682 buffer_clone->d->children_positions.clear();
687 bool Buffer::isClone() const
689 return d->cloned_buffer_;
693 void Buffer::changed(bool update_metrics) const
696 d->wa_->redrawAll(update_metrics);
700 frontend::WorkAreaManager & Buffer::workAreaManager() const
707 Text & Buffer::text() const
709 return d->inset->text();
713 Inset & Buffer::inset() const
719 BufferParams & Buffer::params()
725 BufferParams const & Buffer::params() const
731 BufferParams const & Buffer::masterParams() const
733 if (masterBuffer() == this)
736 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
737 // Copy child authors to the params. We need those pointers.
738 for (Author const & a : params().authors())
739 mparams.authors().record(a);
744 double Buffer::fontScalingFactor() const
746 return isExporting() ? 75.0 * params().html_math_img_scale
747 : 0.01 * lyxrc.dpi * lyxrc.currentZoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
751 ParagraphList & Buffer::paragraphs()
753 return text().paragraphs();
757 ParagraphList const & Buffer::paragraphs() const
759 return text().paragraphs();
763 LyXVC & Buffer::lyxvc()
769 LyXVC const & Buffer::lyxvc() const
775 string const Buffer::temppath() const
777 return d->temppath.absFileName();
781 TexRow & Buffer::texrow()
787 TexRow const & Buffer::texrow() const
793 TocBackend & Buffer::tocBackend() const
795 return d->toc_backend;
799 Undo & Buffer::undo()
805 void Buffer::setChild(DocIterator const & dit, Buffer * child)
807 d->children_positions[child] = dit;
811 string Buffer::latexName(bool const no_path) const
813 FileName latex_name =
814 makeLatexName(d->exportFileName());
815 return no_path ? latex_name.onlyFileName()
816 : latex_name.absFileName();
820 FileName Buffer::Impl::exportFileName() const
822 docstring const branch_suffix =
823 params.branchlist().getFileNameSuffix();
824 if (branch_suffix.empty())
827 string const name = addExtension(filename.onlyFileNameWithoutExt()
828 + to_utf8(branch_suffix), filename.extension());
829 FileName res(filename.onlyPath().absFileName() + "/" + name);
835 string Buffer::logName(LogType * type) const
837 string const filename = latexName(false);
839 if (filename.empty()) {
845 string const path = temppath();
847 FileName const fname(addName(temppath(),
848 onlyFileName(changeExtension(filename,
851 // FIXME: how do we know this is the name of the build log?
852 FileName const bname(
853 addName(path, onlyFileName(
854 changeExtension(filename,
855 theFormats().extension(params().bufferFormat()) + ".out"))));
857 // Also consider the master buffer log file
858 FileName masterfname = fname;
859 LogType mtype = latexlog;
860 if (masterBuffer() != this) {
861 string const mlogfile = masterBuffer()->logName(&mtype);
862 masterfname = FileName(mlogfile);
865 // If no Latex log or Build log is newer, show Build log
866 if (bname.exists() &&
867 ((!fname.exists() && !masterfname.exists())
868 || (fname.lastModified() < bname.lastModified()
869 && masterfname.lastModified() < bname.lastModified()))) {
870 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
873 return bname.absFileName();
874 // If we have a newer master file log or only a master log, show this
875 } else if (fname != masterfname
876 && (!fname.exists() && (masterfname.exists()
877 || fname.lastModified() < masterfname.lastModified()))) {
878 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
881 return masterfname.absFileName();
883 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
886 return fname.absFileName();
890 void Buffer::setReadonly(bool const flag)
892 if (d->read_only != flag) {
899 void Buffer::setFileName(FileName const & fname)
901 bool const changed = fname != d->filename;
903 d->refreshFileMonitor();
905 lyxvc().file_found_hook(fname);
906 setReadonly(d->filename.isReadOnly());
912 int Buffer::readHeader(Lexer & lex)
914 int unknown_tokens = 0;
916 int begin_header_line = -1;
918 // Initialize parameters that may be/go lacking in header:
919 params().branchlist().clear();
920 params().preamble.erase();
921 params().options.erase();
922 params().master.erase();
923 params().float_placement.erase();
924 params().float_alignment.erase();
925 params().paperwidth.erase();
926 params().paperheight.erase();
927 params().leftmargin.erase();
928 params().rightmargin.erase();
929 params().topmargin.erase();
930 params().bottommargin.erase();
931 params().headheight.erase();
932 params().headsep.erase();
933 params().footskip.erase();
934 params().columnsep.erase();
935 params().font_roman_opts.erase();
936 params().font_sans_opts.erase();
937 params().font_typewriter_opts.erase();
938 params().fonts_cjk.erase();
939 params().listings_params.clear();
940 params().clearLayoutModules();
941 params().clearRemovedModules();
942 params().clearIncludedChildren();
943 params().pdfoptions().clear();
944 params().indiceslist().clear();
945 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
946 params().isbackgroundcolor = false;
947 params().fontcolor = RGBColor(0, 0, 0);
948 params().isfontcolor = false;
949 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
950 params().isnotefontcolor = false;
951 params().boxbgcolor = RGBColor(0xFF, 0, 0);
952 params().isboxbgcolor = false;
953 params().html_latex_start.clear();
954 params().html_latex_end.clear();
955 params().html_math_img_scale = 1.0;
956 params().output_sync_macro.erase();
957 params().setLocalLayout(docstring(), false);
958 params().setLocalLayout(docstring(), true);
959 params().biblio_opts.erase();
960 params().biblatex_bibstyle.erase();
961 params().biblatex_citestyle.erase();
962 params().multibib.erase();
963 params().lineno_opts.clear();
965 for (int i = 0; i < 4; ++i) {
966 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
967 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
970 ErrorList & errorList = d->errorLists["Parse"];
979 if (token == "\\end_header")
983 if (token == "\\begin_header") {
984 begin_header_line = line;
988 LYXERR(Debug::PARSER, "Handling document header token: `"
991 string const result =
992 params().readToken(lex, token, d->filename);
993 if (!result.empty()) {
994 if (token == "\\textclass") {
995 d->layout_position = result;
998 docstring const s = bformat(_("Unknown token: "
1001 lex.getDocString());
1002 errorList.push_back(ErrorItem(_("Document header error"), s));
1006 if (begin_header_line) {
1007 docstring const s = _("\\begin_header is missing");
1008 errorList.push_back(ErrorItem(_("Document header error"), s));
1011 params().shell_escape = theSession().shellescapeFiles().find(absFileName());
1013 params().makeDocumentClass(isClone(), isInternal());
1015 return unknown_tokens;
1020 // changed to be public and have one parameter
1021 // Returns true if "\end_document" is not read (Asger)
1022 bool Buffer::readDocument(Lexer & lex)
1024 ErrorList & errorList = d->errorLists["Parse"];
1027 // remove dummy empty par
1028 paragraphs().clear();
1030 if (!lex.checkFor("\\begin_document")) {
1031 docstring const s = _("\\begin_document is missing");
1032 errorList.push_back(ErrorItem(_("Document header error"), s));
1037 if (params().output_changes) {
1038 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1039 LaTeXFeatures::isAvailable("xcolor");
1042 Alert::warning(_("Changes not shown in LaTeX output"),
1043 _("Changes will not be highlighted in LaTeX output, "
1044 "because xcolor and ulem are not installed.\n"
1045 "Please install both packages or redefine "
1046 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1050 if (!parent() && !params().master.empty()) {
1051 FileName const master_file = makeAbsPath(params().master,
1052 onlyPath(absFileName()));
1053 if (isLyXFileName(master_file.absFileName())) {
1055 checkAndLoadLyXFile(master_file, true);
1057 // necessary e.g. after a reload
1058 // to re-register the child (bug 5873)
1059 // FIXME: clean up updateMacros (here, only
1060 // child registering is needed).
1061 master->updateMacros();
1062 // set master as master buffer, but only
1063 // if we are a real child
1064 if (master->isChild(this))
1066 // if the master is not fully loaded
1067 // it is probably just loading this
1068 // child. No warning needed then.
1069 else if (master->isFullyLoaded())
1070 LYXERR0("The master '"
1072 << "' assigned to this document ("
1074 << ") does not include "
1075 "this document. Ignoring the master assignment.");
1076 // If the master has just been created, un-hide it (#11162)
1077 if (!master->fileName().exists())
1078 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
1079 master->absFileName()));
1084 // assure we have a default index
1085 params().indiceslist().addDefault(B_("Index"));
1088 if (FileName::isAbsolute(params().origin))
1089 d->old_position = params().origin;
1091 d->old_position = filePath();
1096 bool const res = text().read(lex, errorList, d->inset);
1097 d->old_position.clear();
1099 // inform parent buffer about local macros
1101 Buffer const * pbuf = parent();
1102 for (auto const & m : usermacros)
1103 pbuf->usermacros.insert(m);
1107 updateMacroInstances(InternalUpdate);
1112 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1114 Format const * fmt = theFormats().getFormat(format);
1117 // It is important to use the correct extension here, since some
1118 // converters create a wrong output file otherwise (e.g. html2latex)
1119 FileName const name = tempFileName("Buffer_importStringXXXXXX." + fmt->extension());
1120 ofdocstream os(name.toFilesystemEncoding().c_str());
1121 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1122 bool const success = !(os << contents).fail();
1125 bool converted = false;
1127 params().compressed = false;
1129 // remove dummy empty par
1130 paragraphs().clear();
1132 converted = importFile(format, name, errorList);
1135 removeTempFile(name);
1140 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1142 if (!theConverters().isReachable(format, "lyx"))
1145 FileName const lyx = tempFileName("Buffer_importFileXXXXXX.lyx");
1146 Converters::RetVal const retval =
1147 theConverters().convert(nullptr, name, lyx, name, format, "lyx", errorList);
1148 if (retval == Converters::SUCCESS) {
1149 bool const success = readFile(lyx) == ReadSuccess;
1150 removeTempFile(lyx);
1158 bool Buffer::readString(string const & s)
1160 params().compressed = false;
1163 istringstream is(s);
1165 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1166 FileName const fn = tempfile.name();
1169 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1171 if (success && file_format != LYX_FORMAT) {
1172 // We need to call lyx2lyx, so write the input to a file
1173 ofstream os(fn.toFilesystemEncoding().c_str());
1176 // lyxvc in readFile
1177 if (readFile(fn) != ReadSuccess)
1181 if (readDocument(lex))
1187 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1190 if (!lex.setFile(fn)) {
1191 Alert::error(_("File Not Found"),
1192 bformat(_("Unable to open file `%1$s'."),
1193 from_utf8(fn.absFileName())));
1194 return ReadFileNotFound;
1198 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1199 if (ret_plf != ReadSuccess)
1202 if (file_format != LYX_FORMAT) {
1204 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1205 if (ret_clf != ReadSuccess)
1207 ret_clf = readFile(tmpFile);
1208 if (ret_clf == ReadSuccess) {
1209 d->file_format = file_format;
1210 d->need_format_backup = true;
1215 // FIXME: InsetInfo needs to know whether the file is under VCS
1216 // during the parse process, so this has to be done before.
1217 lyxvc().file_found_hook(d->filename);
1219 if (readDocument(lex)) {
1220 Alert::error(_("Document format failure"),
1221 bformat(_("%1$s ended unexpectedly, which means"
1222 " that it is probably corrupted."),
1223 from_utf8(fn.absFileName())));
1224 return ReadDocumentFailure;
1227 d->file_fully_loaded = true;
1228 d->read_only = !d->filename.isWritable();
1229 params().compressed = theFormats().isZippedFile(d->filename);
1235 bool Buffer::isFullyLoaded() const
1237 return d->file_fully_loaded;
1241 void Buffer::setFullyLoaded(bool value)
1243 d->file_fully_loaded = value;
1247 bool Buffer::freshStartRequired() const
1249 return d->require_fresh_start_;
1252 void Buffer::requireFreshStart(bool const b) const
1254 d->require_fresh_start_ = b;
1258 PreviewLoader * Buffer::loader() const
1260 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1262 if (!d->preview_loader_)
1263 d->preview_loader_ = new PreviewLoader(*this);
1264 return d->preview_loader_;
1268 void Buffer::removePreviews() const
1270 delete d->preview_loader_;
1271 d->preview_loader_ = nullptr;
1275 void Buffer::updatePreviews() const
1277 PreviewLoader * ploader = loader();
1281 InsetIterator it = begin(*d->inset);
1282 InsetIterator const itend = end(*d->inset);
1283 for (; it != itend; ++it)
1284 it->addPreview(it, *ploader);
1286 ploader->startLoading();
1290 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1291 FileName const & fn, int & file_format) const
1293 if(!lex.checkFor("\\lyxformat")) {
1294 Alert::error(_("Document format failure"),
1295 bformat(_("%1$s is not a readable LyX document."),
1296 from_utf8(fn.absFileName())));
1297 return ReadNoLyXFormat;
1303 // LyX formats 217 and earlier were written as 2.17. This corresponds
1304 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1305 // these cases. See also: www.lyx.org/trac/changeset/1313.
1306 size_t dot = tmp_format.find_first_of(".,");
1307 if (dot != string::npos)
1308 tmp_format.erase(dot, 1);
1310 file_format = convert<int>(tmp_format);
1315 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1316 FileName & tmpfile, int from_format)
1318 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1319 tempfile.setAutoRemove(false);
1320 tmpfile = tempfile.name();
1321 if(tmpfile.empty()) {
1322 Alert::error(_("Conversion failed"),
1323 bformat(_("%1$s is from a different"
1324 " version of LyX, but a temporary"
1325 " file for converting it could"
1326 " not be created."),
1327 from_utf8(fn.absFileName())));
1328 return LyX2LyXNoTempFile;
1331 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1332 if (lyx2lyx.empty()) {
1333 Alert::error(_("Conversion script not found"),
1334 bformat(_("%1$s is from a different"
1335 " version of LyX, but the"
1336 " conversion script lyx2lyx"
1337 " could not be found."),
1338 from_utf8(fn.absFileName())));
1339 return LyX2LyXNotFound;
1343 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1344 ostringstream command;
1345 command << os::python()
1346 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1347 << " -t " << convert<string>(LYX_FORMAT)
1348 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1349 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1350 string const command_str = command.str();
1352 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1354 cmd_ret const ret = runCommand(command_str);
1356 if (from_format < LYX_FORMAT) {
1357 Alert::error(_("Conversion script failed"),
1358 bformat(_("%1$s is from an older version"
1359 " of LyX and the lyx2lyx script"
1360 " failed to convert it."),
1361 from_utf8(fn.absFileName())));
1362 return LyX2LyXOlderFormat;
1364 Alert::error(_("Conversion script failed"),
1365 bformat(_("%1$s is from a newer version"
1366 " of LyX and the lyx2lyx script"
1367 " failed to convert it."),
1368 from_utf8(fn.absFileName())));
1369 return LyX2LyXNewerFormat;
1376 FileName Buffer::getBackupName() const {
1377 map<int, string> const file_formats = {
1394 FileName const & fn = fileName();
1395 string const fname = fn.onlyFileNameWithoutExt();
1396 string const fext = fn.extension() + "~";
1397 string const fpath = lyxrc.backupdir_path.empty() ?
1398 fn.onlyPath().absFileName() :
1399 lyxrc.backupdir_path;
1400 string backup_suffix;
1401 // If file format is from a stable series use version instead of file format
1402 auto const it = file_formats.find(d->file_format);
1403 if (it != file_formats.end())
1404 backup_suffix = "-lyx" + it->second;
1406 backup_suffix = "-lyxformat-" + convert<string>(d->file_format);
1407 string const backname = fname + backup_suffix;
1408 FileName backup(addName(fpath, addExtension(backname, fext)));
1410 // limit recursion, just in case
1412 unsigned long orig_checksum = 0;
1413 while (backup.exists() && v < 100) {
1414 if (orig_checksum == 0)
1415 orig_checksum = fn.checksum();
1416 unsigned long new_checksum = backup.checksum();
1417 if (orig_checksum == new_checksum) {
1418 LYXERR(Debug::FILES, "Not backing up " << fn <<
1419 "since " << backup << "has the same checksum.");
1420 // a bit of a hack, but we have to check this anyway
1421 // below, and setting this is simpler than introducing
1422 // a special boolean for this purpose.
1426 string const newbackname = backname + "-" + convert<string>(v);
1427 backup.set(addName(fpath, addExtension(newbackname, fext)));
1430 return v < 100 ? backup : FileName();
1434 // Should probably be moved to somewhere else: BufferView? GuiView?
1435 bool Buffer::save() const
1437 docstring const file = makeDisplayPath(absFileName(), 20);
1438 d->filename.refresh();
1440 // check the read-only status before moving the file as a backup
1441 if (d->filename.exists()) {
1442 bool const read_only = !d->filename.isWritable();
1444 Alert::warning(_("File is read-only"),
1445 bformat(_("The file %1$s cannot be written because it "
1446 "is marked as read-only."), file));
1451 // ask if the disk file has been externally modified (use checksum method)
1452 if (fileName().exists() && isChecksumModified()) {
1454 bformat(_("Document %1$s has been externally modified. "
1455 "Are you sure you want to overwrite this file?"), file);
1456 int const ret = Alert::prompt(_("Overwrite modified file?"),
1457 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1462 // We don't need autosaves in the immediate future. (Asger)
1463 resetAutosaveTimers();
1465 // if the file does not yet exist, none of the backup activity
1466 // that follows is necessary
1467 if (!fileName().exists()) {
1468 if (!writeFile(fileName()))
1474 // we first write the file to a new name, then move it to its
1475 // proper location once that has been done successfully. that
1476 // way we preserve the original file if something goes wrong.
1477 string const justname = fileName().onlyFileNameWithoutExt();
1478 auto tempfile = lyx::make_unique<TempFile>(fileName().onlyPath(),
1479 justname + "-XXXXXX.lyx");
1480 bool const symlink = fileName().isSymLink();
1482 tempfile->setAutoRemove(false);
1484 FileName savefile(tempfile->name());
1485 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1486 if (!savefile.clonePermissions(fileName()))
1487 LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
1489 if (!writeFile(savefile))
1492 // we will set this to false if we fail
1493 bool made_backup = true;
1495 FileName backupName;
1496 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1498 if (d->need_format_backup)
1499 backupName = getBackupName();
1501 // If we for some reason failed to find a backup name in case of
1502 // a format change, this will still set one. It's the best we can
1504 if (backupName.empty()) {
1505 backupName.set(fileName().absFileName() + "~");
1506 if (!lyxrc.backupdir_path.empty()) {
1507 string const mangledName =
1508 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1509 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1513 LYXERR(Debug::FILES, "Backing up original file to " <<
1514 backupName.absFileName());
1515 // Except file is symlink do not copy because of #6587.
1516 // Hard links have bad luck.
1517 made_backup = symlink ?
1518 fileName().copyTo(backupName):
1519 fileName().moveTo(backupName);
1522 Alert::error(_("Backup failure"),
1523 bformat(_("Cannot create backup file %1$s.\n"
1524 "Please check whether the directory exists and is writable."),
1525 from_utf8(backupName.absFileName())));
1526 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1527 } else if (d->need_format_backup) {
1528 // the original file has been backed up successfully, so we
1529 // will not need to do that again
1530 d->need_format_backup = false;
1534 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1535 // Only do this if tempfile is not in autoremove mode
1538 // If we have no symlink, we can simply rename the temp file.
1539 // Otherwise, we need to copy it so the symlink stays intact.
1540 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1541 savefile.moveTo(fileName()))
1543 // saveCheckSum() was already called by writeFile(), but the
1544 // time stamp is invalidated by copying/moving
1547 // the file associated with this buffer is now in the current format
1548 d->file_format = LYX_FORMAT;
1551 // else we saved the file, but failed to move it to the right location.
1553 if (needBackup && made_backup && !symlink) {
1554 // the original file was moved to some new location, so it will look
1555 // to the user as if it was deleted. (see bug #9234.) we could try
1556 // to restore it, but that would basically mean trying to do again
1557 // what we just failed to do. better to leave things as they are.
1558 Alert::error(_("Write failure"),
1559 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1560 "But LyX could not move it to:\n %2$s.\n"
1561 "Your original file has been backed up to:\n %3$s"),
1562 from_utf8(savefile.absFileName()),
1563 from_utf8(fileName().absFileName()),
1564 from_utf8(backupName.absFileName())));
1566 // either we did not try to make a backup, or else we tried and failed,
1567 // or else the original file was a symlink, in which case it was copied,
1568 // not moved. so the original file is intact.
1569 Alert::error(_("Write failure"),
1570 bformat(_("Cannot move saved file to:\n %1$s.\n"
1571 "But the file has successfully been saved as:\n %2$s."),
1572 from_utf8(fileName().absFileName()),
1573 from_utf8(savefile.absFileName())));
1579 bool Buffer::writeFile(FileName const & fname) const
1581 if (d->read_only && fname == d->filename)
1584 bool retval = false;
1586 docstring const str = bformat(_("Saving document %1$s..."),
1587 makeDisplayPath(fname.absFileName()));
1590 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1592 if (params().compressed) {
1593 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1594 retval = ofs && write(ofs);
1596 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1597 retval = ofs && write(ofs);
1601 message(str + _(" could not write file!"));
1606 // removeAutosaveFile();
1609 message(str + _(" done."));
1615 docstring Buffer::emergencyWrite() const
1617 // No need to save if the buffer has not changed.
1621 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1623 docstring user_message = bformat(
1624 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1626 // We try to save three places:
1627 // 1) Same place as document. Unless it is an unnamed doc.
1629 string s = absFileName();
1632 if (writeFile(FileName(s))) {
1634 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1635 return user_message;
1637 user_message += " " + _("Save failed! Trying again...\n");
1641 // 2) In HOME directory.
1642 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1644 lyxerr << ' ' << s << endl;
1645 if (writeFile(FileName(s))) {
1647 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1648 return user_message;
1651 user_message += " " + _("Save failed! Trying yet again...\n");
1653 // 3) In "/tmp" directory.
1654 // MakeAbsPath to prepend the current
1655 // drive letter on OS/2
1656 s = addName(package().temp_dir().absFileName(), absFileName());
1658 lyxerr << ' ' << s << endl;
1659 if (writeFile(FileName(s))) {
1661 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1662 return user_message;
1665 user_message += " " + _("Save failed! Document is lost.");
1668 return user_message;
1672 bool Buffer::write(ostream & ofs) const
1675 // Use the standard "C" locale for file output.
1676 ofs.imbue(locale::classic());
1679 // The top of the file should not be written by params().
1681 // write out a comment in the top of the file
1682 // Important: Keep the version formatting in sync with lyx2lyx and
1683 // tex2lyx (bug 7951)
1684 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1685 << " created this file. For more info see https://www.lyx.org/\n"
1686 << "\\lyxformat " << LYX_FORMAT << "\n"
1687 << "\\begin_document\n";
1689 /// For each author, set 'used' to true if there is a change
1690 /// by this author in the document; otherwise set it to 'false'.
1691 for (Author const & a : params().authors())
1694 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1695 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1696 for ( ; it != end; ++it)
1697 it->checkAuthors(params().authors());
1699 // now write out the buffer parameters.
1700 ofs << "\\begin_header\n";
1701 params().writeFile(ofs, this);
1702 ofs << "\\end_header\n";
1705 ofs << "\n\\begin_body\n";
1707 ofs << "\n\\end_body\n";
1709 // Write marker that shows file is complete
1710 ofs << "\\end_document" << endl;
1712 // Shouldn't really be needed....
1715 // how to check if close went ok?
1716 // Following is an attempt... (BE 20001011)
1718 // good() returns false if any error occurred, including some
1719 // formatting error.
1720 // bad() returns true if something bad happened in the buffer,
1721 // which should include file system full errors.
1726 lyxerr << "File was not closed properly." << endl;
1733 Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
1734 string const & original_path,
1735 OutputParams const & runparams_in,
1736 OutputWhat output) const
1738 OutputParams runparams = runparams_in;
1740 string const encoding = runparams.encoding->iconvName();
1741 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1744 try { ofs.reset(encoding); }
1745 catch (iconv_codecvt_facet_exception const & e) {
1746 lyxerr << "Caught iconv exception: " << e.what() << endl;
1747 Alert::error(_("Iconv software exception Detected"),
1748 bformat(_("Please verify that the `iconv' support software is"
1749 " properly installed and supports the selected encoding"
1750 " (%1$s), or change the encoding in"
1751 " Document>Settings>Language."), from_ascii(encoding)));
1754 if (!openFileWrite(ofs, fname))
1757 ErrorList & errorList = d->errorLists["Export"];
1759 ExportStatus status = ExportSuccess;
1762 // make sure we are ready to export
1763 // this needs to be done before we validate
1764 // FIXME Do we need to do this all the time? I.e., in children
1765 // of a master we are exporting?
1767 updateMacroInstances(OutputUpdate);
1769 ExportStatus retval;
1771 retval = writeLaTeXSource(os, original_path, runparams, output);
1772 if (retval == ExportKilled)
1773 return ExportKilled;
1775 catch (EncodingException const & e) {
1776 docstring const failed(1, e.failed_char);
1778 oss << "0x" << hex << static_cast<uint32_t>(e.failed_char) << dec;
1779 if (getParFromID(e.par_id).paragraph().layout().pass_thru) {
1780 docstring msg = bformat(_("Uncodable character '%1$s'"
1781 " (code point %2$s)"),
1782 failed, from_utf8(oss.str()));
1783 errorList.push_back(ErrorItem(msg, _("Some characters of your document are not "
1784 "representable in specific verbatim contexts.\n"
1785 "Changing the document encoding to utf8 could help."),
1786 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1788 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1789 " (code point %2$s)"),
1790 failed, from_utf8(oss.str()));
1791 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1792 "representable in the chosen encoding.\n"
1793 "Changing the document encoding to utf8 could help."),
1794 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1796 status = ExportError;
1798 catch (iconv_codecvt_facet_exception const & e) {
1799 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1801 status = ExportError;
1803 catch (exception const & e) {
1804 errorList.push_back(ErrorItem(_("conversion failed"),
1806 lyxerr << e.what() << endl;
1807 status = ExportError;
1810 lyxerr << "Caught some really weird exception..." << endl;
1814 d->texrow = move(os.texrow());
1818 status = ExportError;
1819 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1822 if (runparams_in.silent)
1830 Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
1831 string const & original_path,
1832 OutputParams const & runparams_in,
1833 OutputWhat output) const
1835 // The child documents, if any, shall be already loaded at this point.
1837 OutputParams runparams = runparams_in;
1839 // Some macros rely on font encoding
1840 runparams.main_fontenc = params().main_font_encoding();
1842 // If we are compiling a file standalone, even if this is the
1843 // child of some other buffer, let's cut the link here, so the
1844 // file is really independent and no concurring settings from
1845 // the master (e.g. branch state) interfere (see #8100).
1846 if (!runparams.is_child)
1847 d->ignore_parent = true;
1849 // Classify the unicode characters appearing in math insets
1850 BufferEncodings::initUnicodeMath(*this);
1852 // validate the buffer.
1853 LYXERR(Debug::LATEX, " Validating buffer...");
1854 LaTeXFeatures features(*this, params(), runparams);
1856 // This is only set once per document (in master)
1857 if (!runparams.is_child) {
1858 runparams.use_polyglossia = features.usePolyglossia();
1859 runparams.use_hyperref = features.isRequired("hyperref");
1860 runparams.use_CJK = features.mustProvide("CJK");
1862 LYXERR(Debug::LATEX, " Buffer validation done.");
1864 bool const output_preamble =
1865 output == FullSource || output == OnlyPreamble;
1866 bool const output_body =
1867 output == FullSource || output == OnlyBody;
1869 // The starting paragraph of the coming rows is the
1870 // first paragraph of the document. (Asger)
1871 if (output_preamble && runparams.nice) {
1872 os << "%% LyX " << lyx_version << " created this file. "
1873 "For more info, see https://www.lyx.org/.\n"
1874 "%% Do not edit unless you really know what "
1877 LYXERR(Debug::INFO, "lyx document header finished");
1879 // There are a few differences between nice LaTeX and usual files:
1880 // usual files have \batchmode and special input@path to allow
1881 // inclusion of figures specified by an explicitly relative path
1882 // (i.e., a path starting with './' or '../') with either \input or
1883 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1884 // input@path is set when the actual parameter original_path is set.
1885 // This is done for usual tex-file, but not for nice-latex-file.
1886 // (Matthias 250696)
1887 // Note that input@path is only needed for something the user does
1888 // in the preamble, included .tex files or ERT, files included by
1889 // LyX work without it.
1890 if (output_preamble) {
1891 if (!runparams.nice) {
1892 // code for usual, NOT nice-latex-file
1893 os << "\\batchmode\n"; // changed from \nonstopmode
1895 if (!original_path.empty()) {
1897 // We don't know the encoding of inputpath
1898 docstring const inputpath = from_utf8(original_path);
1899 docstring uncodable_glyphs;
1900 Encoding const * const enc = runparams.encoding;
1902 for (char_type n : inputpath) {
1903 if (!enc->encodable(n)) {
1904 docstring const glyph(1, n);
1905 LYXERR0("Uncodable character '"
1907 << "' in input path!");
1908 uncodable_glyphs += glyph;
1913 // warn user if we found uncodable glyphs.
1914 if (!uncodable_glyphs.empty()) {
1915 frontend::Alert::warning(
1916 _("Uncodable character in file path"),
1918 _("The path of your document\n"
1920 "contains glyphs that are unknown "
1921 "in the current document encoding "
1922 "(namely %2$s). This may result in "
1923 "incomplete output, unless "
1924 "TEXINPUTS contains the document "
1925 "directory and you don't use "
1926 "explicitly relative paths (i.e., "
1927 "paths starting with './' or "
1928 "'../') in the preamble or in ERT."
1929 "\n\nIn case of problems, choose "
1930 "an appropriate document encoding\n"
1931 "(such as utf8) or change the "
1933 inputpath, uncodable_glyphs));
1935 string docdir = os::latex_path(original_path);
1936 if (contains(docdir, '#')) {
1937 docdir = subst(docdir, "#", "\\#");
1938 os << "\\catcode`\\#=11"
1939 "\\def\\#{#}\\catcode`\\#=6\n";
1941 if (contains(docdir, '%')) {
1942 docdir = subst(docdir, "%", "\\%");
1943 os << "\\catcode`\\%=11"
1944 "\\def\\%{%}\\catcode`\\%=14\n";
1946 if (contains(docdir, '~'))
1947 docdir = subst(docdir, "~", "\\string~");
1948 bool const nonascii = !isAscii(from_utf8(docdir));
1949 // LaTeX 2019/10/01 handles non-ascii path without detokenize
1950 bool const utfpathlatex = features.isAvailable("LaTeX-2019/10/01");
1951 bool const detokenize = !utfpathlatex && nonascii;
1952 bool const quote = contains(docdir, ' ');
1953 if (utfpathlatex && nonascii)
1954 os << "\\UseRawInputEncoding\n";
1955 os << "\\makeatletter\n"
1956 << "\\def\\input@path{{";
1958 os << "\\detokenize{";
1967 << "\\makeatother\n";
1971 // get parent macros (if this buffer has a parent) which will be
1972 // written at the document begin further down.
1973 MacroSet parentMacros;
1974 listParentMacros(parentMacros, features);
1976 // Write the preamble
1977 runparams.use_babel = params().writeLaTeX(os, features,
1978 d->filename.onlyPath());
1980 // Active characters
1981 runparams.active_chars = features.getActiveChars();
1983 // Biblatex bibliographies are loaded here
1984 if (params().useBiblatex()) {
1985 vector<pair<docstring, string>> const bibfiles =
1986 prepareBibFilePaths(runparams, getBibfiles(), true);
1987 for (pair<docstring, string> const & file: bibfiles) {
1988 os << "\\addbibresource";
1989 if (!file.second.empty())
1990 os << "[bibencoding=" << file.second << "]";
1991 os << "{" << file.first << "}\n";
1995 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1996 && !features.hasOnlyPolyglossiaLanguages()) {
1999 vector<string> bll = features.getBabelExclusiveLanguages();
2000 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
2003 for (string const & sit : bll) {
2008 blangs = bll.size() > 1 ?
2009 bformat(_("The languages %1$s are only supported by Babel."), langs)
2010 : bformat(_("The language %1$s is only supported by Babel."), langs);
2014 for (string const & pit : pll) {
2019 plangs = pll.size() > 1 ?
2020 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
2021 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
2022 if (!blangs.empty())
2026 frontend::Alert::warning(
2027 _("Incompatible Languages!"),
2029 _("You cannot use the following languages "
2030 "together in one LaTeX document because "
2031 "they require conflicting language packages:\n"
2036 // Japanese might be required only in some children of a document,
2037 // but once required, we must keep use_japanese true.
2038 runparams.use_japanese |= features.isRequired("japanese");
2041 // Restore the parenthood if needed
2042 if (!runparams.is_child)
2043 d->ignore_parent = false;
2044 return ExportSuccess;
2048 // mark the beginning of the body to separate it from InPreamble insets
2049 os.texrow().start(TexRow::beginDocument());
2050 os << "\\begin{document}\n";
2052 // mark the start of a new paragraph by simulating a newline,
2053 // so that os.afterParbreak() returns true at document start
2056 // output the parent macros
2057 for (auto const & mac : parentMacros) {
2058 int num_lines = mac->write(os.os(), true);
2059 os.texrow().newlines(num_lines);
2062 } // output_preamble
2064 LYXERR(Debug::INFO, "preamble finished, now the body.");
2068 latexParagraphs(*this, text(), os, runparams);
2070 catch (ConversionException const &) { return ExportKilled; }
2072 // Restore the parenthood if needed
2073 if (!runparams.is_child)
2074 d->ignore_parent = false;
2076 // add this just in case after all the paragraphs
2079 if (output_preamble) {
2080 os << "\\end{document}\n";
2081 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
2083 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
2085 runparams_in.encoding = runparams.encoding;
2087 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2088 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2089 return ExportSuccess;
2093 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2094 OutputParams const & runparams,
2095 OutputWhat output) const
2097 LYXERR(Debug::LATEX, "makeDocBookFile...");
2100 if (!openFileWrite(ofs, fname))
2103 // make sure we are ready to export
2104 // this needs to be done before we validate
2106 updateMacroInstances(OutputUpdate);
2108 ExportStatus const retval =
2109 writeDocBookSource(ofs, runparams, output);
2110 if (retval == ExportKilled)
2111 return ExportKilled;
2115 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2116 return ExportSuccess;
2120 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os,
2121 OutputParams const & runparams,
2122 OutputWhat output) const
2124 LaTeXFeatures features(*this, params(), runparams);
2126 d->bibinfo_.makeCitationLabels(*this);
2130 DocumentClass const & tclass = params().documentClass();
2132 bool const output_preamble =
2133 output == FullSource || output == OnlyPreamble;
2134 bool const output_body =
2135 output == FullSource || output == OnlyBody || output == IncludedFile;
2137 if (output_preamble) {
2138 // XML preamble, no doctype needed.
2139 // Not using XMLStream for this, as the root tag would be in the tag stack and make troubles with the error
2140 // detection mechanisms (these are called before the end tag is output, and thus interact with the canary
2141 // parsep in output_docbook.cpp).
2142 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2143 << "<!-- This DocBook file was created by LyX " << lyx_version
2144 << "\n See https://www.lyx.org/ for more information -->\n";
2146 // Directly output the root tag, based on the current type of document.
2147 string languageCode = params().language->code();
2148 string params = "xml:lang=\"" + languageCode + '"'
2149 + " xmlns=\"http://docbook.org/ns/docbook\""
2150 + " xmlns:xlink=\"http://www.w3.org/1999/xlink\""
2151 + " xmlns:m=\"http://www.w3.org/1998/Math/MathML\""
2152 + " xmlns:xi=\"http://www.w3.org/2001/XInclude\""
2153 + " version=\"5.2\"";
2155 os << "<" << from_ascii(tclass.docbookroot()) << " " << from_ascii(params) << ">\n";
2159 // Start to output the document.
2161 docbookParagraphs(text(), *this, xs, runparams);
2164 if (output_preamble) {
2165 // Close the root element. No need for a line break, as free text is never allowed
2166 // in a root element, it must always be wrapped in some container.
2167 os << "</" << from_ascii(tclass.docbookroot()) << ">";
2170 return ExportSuccess;
2174 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2175 OutputParams const & runparams) const
2177 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2180 if (!openFileWrite(ofs, fname))
2183 // make sure we are ready to export
2184 // this has to be done before we validate
2185 updateBuffer(UpdateMaster, OutputUpdate);
2186 updateMacroInstances(OutputUpdate);
2188 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2189 if (retval == ExportKilled)
2194 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2199 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2200 OutputParams const & runparams,
2201 OutputWhat output) const
2203 LaTeXFeatures features(*this, params(), runparams);
2205 d->bibinfo_.makeCitationLabels(*this);
2207 bool const output_preamble =
2208 output == FullSource || output == OnlyPreamble;
2209 bool const output_body =
2210 output == FullSource || output == OnlyBody || output == IncludedFile;
2212 if (output_preamble) {
2213 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2214 << "<!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"
2215 // FIXME Language should be set properly.
2216 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2218 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2219 // FIXME Presumably need to set this right
2220 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2222 docstring const & doctitle = features.htmlTitle();
2224 << (doctitle.empty() ?
2225 from_ascii("LyX Document") :
2226 xml::escapeString(doctitle, XMLStream::ESCAPE_ALL))
2229 docstring styles = features.getTClassHTMLPreamble();
2230 if (!styles.empty())
2231 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2233 // we will collect CSS information in a stream, and then output it
2234 // either here, as part of the header, or else in a separate file.
2235 odocstringstream css;
2236 styles = features.getCSSSnippets();
2237 if (!styles.empty())
2238 css << "/* LyX Provided Styles */\n" << styles << '\n';
2240 styles = features.getTClassHTMLStyles();
2241 if (!styles.empty())
2242 css << "/* Layout-provided Styles */\n" << styles << '\n';
2244 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2245 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2246 if (needfg || needbg) {
2247 css << "\nbody {\n";
2250 << from_ascii(X11hexname(params().fontcolor))
2253 css << " background-color: "
2254 << from_ascii(X11hexname(params().backgroundcolor))
2259 docstring const dstyles = css.str();
2260 if (!dstyles.empty()) {
2261 bool written = false;
2262 if (params().html_css_as_file) {
2263 // open a file for CSS info
2265 string const fcssname = addName(temppath(), "docstyle.css");
2266 FileName const fcssfile = FileName(fcssname);
2267 if (openFileWrite(ocss, fcssfile)) {
2271 // write link to header
2272 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2274 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2277 // we are here if the CSS is supposed to be written to the header
2278 // or if we failed to write it to an external file.
2280 os << "<style type='text/css'>\n"
2289 bool const output_body_tag = (output != IncludedFile);
2290 if (output_body_tag)
2291 os << "<body dir=\"auto\">\n";
2293 if (output != IncludedFile)
2294 // if we're an included file, the counters are in the master.
2295 params().documentClass().counters().reset();
2297 xhtmlParagraphs(text(), *this, xs, runparams);
2299 catch (ConversionException const &) { return ExportKilled; }
2300 if (output_body_tag)
2304 if (output_preamble)
2307 return ExportSuccess;
2311 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2312 // Other flags: -wall -v0 -x
2313 int Buffer::runChktex()
2317 // get LaTeX-Filename
2318 FileName const path(temppath());
2319 string const name = addName(path.absFileName(), latexName());
2320 string const org_path = filePath();
2322 PathChanger p(path); // path to LaTeX file
2323 message(_("Running chktex..."));
2325 // Generate the LaTeX file if neccessary
2326 OutputParams runparams(¶ms().encoding());
2327 runparams.flavor = Flavor::LaTeX;
2328 runparams.nice = false;
2329 runparams.linelen = lyxrc.plaintext_linelen;
2330 ExportStatus const retval =
2331 makeLaTeXFile(FileName(name), org_path, runparams);
2332 if (retval != ExportSuccess) {
2333 // error code on failure
2338 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2339 int const res = chktex.run(terr); // run chktex
2342 Alert::error(_("chktex failure"),
2343 _("Could not run chktex successfully."));
2345 ErrorList & errlist = d->errorLists["ChkTeX"];
2347 bufferErrors(terr, errlist);
2352 if (runparams.silent)
2353 d->errorLists["ChkTeX"].clear();
2361 void Buffer::validate(LaTeXFeatures & features) const
2363 // Validate the buffer params, but not for included
2364 // files, since they also use the parent buffer's
2366 if (!features.runparams().is_child)
2367 params().validate(features);
2372 for (Paragraph const & p : paragraphs())
2373 p.validate(features);
2375 if (lyxerr.debugging(Debug::LATEX)) {
2376 features.showStruct();
2381 void Buffer::getLabelList(vector<docstring> & list) const
2383 // If this is a child document, use the master's list instead.
2385 masterBuffer()->getLabelList(list);
2390 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2391 for (auto const & tocit : *toc) {
2392 if (tocit.depth() == 0)
2393 list.push_back(tocit.str());
2398 void Buffer::invalidateBibinfoCache() const
2400 d->bibinfo_cache_valid_ = false;
2401 d->cite_labels_valid_ = false;
2402 removeBiblioTempFiles();
2403 // also invalidate the cache for the parent buffer
2404 Buffer const * const pbuf = d->parent();
2406 pbuf->invalidateBibinfoCache();
2410 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2412 // FIXME This is probably unnecessary, given where we call this.
2413 // If this is a child document, use the master instead.
2414 Buffer const * const pbuf = masterBuffer();
2415 if (pbuf != this && scope != UpdateChildOnly)
2416 return pbuf->getBibfiles();
2418 // In 2.3.x, we have:
2419 //if (!d->bibfile_cache_valid_)
2420 // this->updateBibfilesCache(scope);
2421 // I think that is a leftover, but there have been so many back-
2422 // and-forths with this, due to Windows issues, that I am not sure.
2424 return d->bibfiles_cache_;
2428 BiblioInfo const & Buffer::masterBibInfo() const
2430 Buffer const * const tmp = masterBuffer();
2432 return tmp->masterBibInfo();
2437 BiblioInfo const & Buffer::bibInfo() const
2443 void Buffer::registerBibfiles(const docstring_list & bf) const
2445 // We register the bib files in the master buffer,
2446 // if there is one, but also in every single buffer,
2447 // in case a child is compiled alone.
2448 Buffer const * const tmp = masterBuffer();
2450 tmp->registerBibfiles(bf);
2452 for (auto const & p : bf) {
2453 docstring_list::const_iterator temp =
2454 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2455 if (temp == d->bibfiles_cache_.end())
2456 d->bibfiles_cache_.push_back(p);
2461 static map<docstring, FileName> bibfileCache;
2463 FileName Buffer::getBibfilePath(docstring const & bibid) const
2465 map<docstring, FileName>::const_iterator it =
2466 bibfileCache.find(bibid);
2467 if (it != bibfileCache.end()) {
2468 // i.e., return bibfileCache[bibid];
2472 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2473 string const texfile = changeExtension(to_utf8(bibid), "bib");
2474 // we need to check first if this file exists where it's said to be.
2475 // there's a weird bug that occurs otherwise: if the file is in the
2476 // Buffer's directory but has the same name as some file that would be
2477 // found by kpsewhich, then we find the latter, not the former.
2478 FileName const local_file = makeAbsPath(texfile, filePath());
2479 FileName file = local_file;
2480 if (!file.exists()) {
2481 // there's no need now to check whether the file can be found
2483 file = findtexfile(texfile, "bib", true);
2487 LYXERR(Debug::FILES, "Found at: " << file);
2489 bibfileCache[bibid] = file;
2490 return bibfileCache[bibid];
2494 void Buffer::checkIfBibInfoCacheIsValid() const
2496 // use the master's cache
2497 Buffer const * const tmp = masterBuffer();
2499 tmp->checkIfBibInfoCacheIsValid();
2503 // If we already know the cache is invalid, stop here.
2504 // This is important in the case when the bibliography
2505 // environment (rather than Bib[la]TeX) is used.
2506 // In that case, the timestamp check below gives no
2507 // sensible result. Rather than that, the cache will
2508 // be invalidated explicitly via invalidateBibInfoCache()
2509 // by the Bibitem inset.
2510 // Same applies for bib encoding changes, which trigger
2511 // invalidateBibInfoCache() by InsetBibtex.
2512 if (!d->bibinfo_cache_valid_)
2515 if (d->have_bibitems_) {
2516 // We have a bibliography environment.
2517 // Invalidate the bibinfo cache unconditionally.
2518 // Cite labels will get invalidated by the inset if needed.
2519 d->bibinfo_cache_valid_ = false;
2523 // OK. This is with Bib(la)tex. We'll assume the cache
2524 // is valid and change this if we find changes in the bibs.
2525 d->bibinfo_cache_valid_ = true;
2526 d->cite_labels_valid_ = true;
2528 // compare the cached timestamps with the actual ones.
2529 docstring_list const & bibfiles_cache = getBibfiles();
2530 for (auto const & bf : bibfiles_cache) {
2531 FileName const fn = getBibfilePath(bf);
2532 time_t lastw = fn.lastModified();
2533 time_t prevw = d->bibfile_status_[fn];
2534 if (lastw != prevw) {
2535 d->bibinfo_cache_valid_ = false;
2536 d->cite_labels_valid_ = false;
2537 d->bibfile_status_[fn] = lastw;
2543 void Buffer::clearBibFileCache() const
2545 bibfileCache.clear();
2549 void Buffer::reloadBibInfoCache(bool const force) const
2551 // we should not need to do this for internal buffers
2555 // use the master's cache
2556 Buffer const * const tmp = masterBuffer();
2558 tmp->reloadBibInfoCache(force);
2563 checkIfBibInfoCacheIsValid();
2564 if (d->bibinfo_cache_valid_)
2568 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2569 // re-read file locations when this info changes
2570 // FIXME Is this sufficient? Or should we also force that
2571 // in some other cases? If so, then it is easy enough to
2572 // add the following line in some other places.
2573 clearBibFileCache();
2574 d->bibinfo_.clear();
2575 FileNameList checkedFiles;
2576 d->have_bibitems_ = false;
2577 collectBibKeys(checkedFiles);
2578 d->bibinfo_cache_valid_ = true;
2582 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2587 for (InsetIterator it = begin(inset()); it; ++it) {
2588 it->collectBibKeys(it, checkedFiles);
2589 if (it->lyxCode() == BIBITEM_CODE) {
2590 if (parent() != nullptr)
2591 parent()->d->have_bibitems_ = true;
2593 d->have_bibitems_ = true;
2599 void Buffer::addBiblioInfo(BiblioInfo const & bi_in) const
2601 // We add the biblio info to the parent buffer,
2602 // if there is one, but also to this buffer, in case
2603 // it is compiled alone.
2604 BiblioInfo & our_bi = d->bibinfo_;
2605 our_bi.mergeBiblioInfo(bi_in);
2608 parent()->addBiblioInfo(bi_in);
2612 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2614 // We add the bibtex info to the master buffer,
2615 // if there is one, but also to every single buffer,
2616 // in case a child is compiled alone.
2617 BiblioInfo & bi = d->bibinfo_;
2620 if (parent() != nullptr) {
2621 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2622 masterbi[key] = bin;
2627 void Buffer::makeCitationLabels() const
2629 Buffer const * const master = masterBuffer();
2630 return d->bibinfo_.makeCitationLabels(*master);
2634 void Buffer::invalidateCiteLabels() const
2636 masterBuffer()->d->cite_labels_valid_ = false;
2639 bool Buffer::citeLabelsValid() const
2641 return masterBuffer()->d->cite_labels_valid_;
2645 void Buffer::removeBiblioTempFiles() const
2647 // We remove files that contain LaTeX commands specific to the
2648 // particular bibliographic style being used, in order to avoid
2649 // LaTeX errors when we switch style.
2650 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2651 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2652 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2653 aux_file.removeFile();
2654 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2655 bbl_file.removeFile();
2656 // Also for the parent buffer
2657 Buffer const * const pbuf = parent();
2659 pbuf->removeBiblioTempFiles();
2663 bool Buffer::isDepClean(string const & name) const
2665 DepClean::const_iterator const it = d->dep_clean.find(name);
2666 if (it == d->dep_clean.end())
2672 void Buffer::markDepClean(string const & name)
2674 d->dep_clean[name] = true;
2678 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2681 // FIXME? if there is an Buffer LFUN that can be dispatched even
2682 // if internal, put a switch '(cmd.action)' here.
2688 switch (cmd.action()) {
2690 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2691 flag.setOnOff(hasReadonlyFlag());
2694 // FIXME: There is need for a command-line import.
2695 //case LFUN_BUFFER_IMPORT:
2697 case LFUN_BUFFER_AUTO_SAVE:
2700 case LFUN_BUFFER_EXPORT_CUSTOM:
2701 // FIXME: Nothing to check here?
2704 case LFUN_BUFFER_EXPORT: {
2705 docstring const & arg = cmd.argument();
2706 if (arg == "custom") {
2710 string format = (arg.empty() || arg == "default") ?
2711 params().getDefaultOutputFormat() : to_utf8(arg);
2712 size_t pos = format.find(' ');
2713 if (pos != string::npos)
2714 format = format.substr(0, pos);
2715 enable = params().isExportable(format, false);
2717 flag.message(bformat(
2718 _("Don't know how to export to format: %1$s"), arg));
2722 case LFUN_BUILD_PROGRAM:
2723 enable = params().isExportable("program", false);
2726 case LFUN_BRANCH_ACTIVATE:
2727 case LFUN_BRANCH_DEACTIVATE:
2728 case LFUN_BRANCH_MASTER_ACTIVATE:
2729 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2730 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2731 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2732 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2733 : params().branchlist();
2734 docstring const & branchName = cmd.argument();
2735 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2739 case LFUN_BRANCH_ADD:
2740 case LFUN_BRANCHES_RENAME:
2741 // if no Buffer is present, then of course we won't be called!
2744 case LFUN_BUFFER_LANGUAGE:
2745 enable = !isReadonly();
2748 case LFUN_BUFFER_VIEW_CACHE:
2749 (d->preview_file_).refresh();
2750 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2753 case LFUN_CHANGES_TRACK:
2754 flag.setEnabled(true);
2755 flag.setOnOff(params().track_changes);
2758 case LFUN_CHANGES_OUTPUT:
2759 flag.setEnabled(true);
2760 flag.setOnOff(params().output_changes);
2763 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2764 flag.setOnOff(params().compressed);
2767 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2768 flag.setOnOff(params().output_sync);
2771 case LFUN_BUFFER_ANONYMIZE:
2777 flag.setEnabled(enable);
2782 void Buffer::dispatch(string const & command, DispatchResult & result)
2784 return dispatch(lyxaction.lookupFunc(command), result);
2788 // NOTE We can end up here even if we have no GUI, because we are called
2789 // by LyX::exec to handled command-line requests. So we may need to check
2790 // whether we have a GUI or not. The boolean use_gui holds this information.
2791 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2794 // FIXME? if there is an Buffer LFUN that can be dispatched even
2795 // if internal, put a switch '(cmd.action())' here.
2796 dr.dispatched(false);
2799 string const argument = to_utf8(func.argument());
2800 // We'll set this back to false if need be.
2801 bool dispatched = true;
2802 // This handles undo groups automagically
2803 UndoGroupHelper ugh(this);
2805 switch (func.action()) {
2806 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2807 if (lyxvc().inUse()) {
2808 string log = lyxvc().toggleReadOnly();
2813 setReadonly(!hasReadonlyFlag());
2816 case LFUN_BUFFER_EXPORT: {
2817 string const format = (argument.empty() || argument == "default") ?
2818 params().getDefaultOutputFormat() : argument;
2819 ExportStatus const status = doExport(format, false);
2820 dr.setError(status != ExportSuccess);
2821 if (status != ExportSuccess)
2822 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2823 from_utf8(format)));
2827 case LFUN_BUILD_PROGRAM: {
2828 ExportStatus const status = doExport("program", true);
2829 dr.setError(status != ExportSuccess);
2830 if (status != ExportSuccess)
2831 dr.setMessage(_("Error generating literate programming code."));
2835 case LFUN_BUFFER_EXPORT_CUSTOM: {
2837 string command = split(argument, format_name, ' ');
2838 Format const * format = theFormats().getFormat(format_name);
2840 lyxerr << "Format \"" << format_name
2841 << "\" not recognized!"
2846 // The name of the file created by the conversion process
2849 // Output to filename
2850 if (format->name() == "lyx") {
2851 string const latexname = latexName(false);
2852 filename = changeExtension(latexname,
2853 format->extension());
2854 filename = addName(temppath(), filename);
2856 if (!writeFile(FileName(filename)))
2860 doExport(format_name, true, filename);
2863 // Substitute $$FName for filename
2864 if (!contains(command, "$$FName"))
2865 command = "( " + command + " ) < $$FName";
2866 command = subst(command, "$$FName", filename);
2868 // Execute the command in the background
2870 call.startscript(Systemcall::DontWait, command,
2871 filePath(), layoutPos());
2875 // FIXME: There is need for a command-line import.
2877 case LFUN_BUFFER_IMPORT:
2882 case LFUN_BUFFER_AUTO_SAVE:
2884 resetAutosaveTimers();
2887 case LFUN_BRANCH_ACTIVATE:
2888 case LFUN_BRANCH_DEACTIVATE:
2889 case LFUN_BRANCH_MASTER_ACTIVATE:
2890 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2891 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2892 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2893 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2896 docstring const & branch_name = func.argument();
2897 // the case without a branch name is handled elsewhere
2898 if (branch_name.empty()) {
2902 Branch * branch = buf->params().branchlist().find(branch_name);
2904 LYXERR0("Branch " << branch_name << " does not exist.");
2906 docstring const msg =
2907 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2911 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2912 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2913 if (branch->isSelected() != activate) {
2914 buf->undo().recordUndoBufferParams(CursorData());
2915 branch->setSelected(activate);
2917 dr.screenUpdate(Update::Force);
2918 dr.forceBufferUpdate();
2923 case LFUN_BRANCH_ADD: {
2924 docstring const & branchnames = func.argument();
2925 if (branchnames.empty()) {
2929 BranchList & branch_list = params().branchlist();
2930 vector<docstring> const branches =
2931 getVectorFromString(branchnames, branch_list.separator());
2933 for (docstring const & branch_name : branches) {
2934 Branch * branch = branch_list.find(branch_name);
2936 LYXERR0("Branch " << branch_name << " already exists.");
2940 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2942 undo().recordUndoBufferParams(CursorData());
2943 branch_list.add(branch_name);
2944 branch = branch_list.find(branch_name);
2946 // needed to update the color table for dark mode
2947 branch->setColors("background", "background");
2949 dr.screenUpdate(Update::Force);
2957 case LFUN_BRANCHES_RENAME: {
2958 if (func.argument().empty())
2961 docstring const oldname = from_utf8(func.getArg(0));
2962 docstring const newname = from_utf8(func.getArg(1));
2963 InsetIterator it = begin(inset());
2964 InsetIterator const itend = end(inset());
2965 bool success = false;
2966 for (; it != itend; ++it) {
2967 if (it->lyxCode() == BRANCH_CODE) {
2968 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2969 if (ins.branch() == oldname) {
2970 undo().recordUndo(CursorData(it));
2971 ins.rename(newname);
2976 if (it->lyxCode() == INCLUDE_CODE) {
2977 // get buffer of external file
2978 InsetInclude const & ins =
2979 static_cast<InsetInclude const &>(*it);
2980 Buffer * child = ins.loadIfNeeded();
2983 child->dispatch(func, dr);
2988 dr.screenUpdate(Update::Force);
2989 dr.forceBufferUpdate();
2994 case LFUN_BUFFER_VIEW_CACHE:
2995 if (!theFormats().view(*this, d->preview_file_,
2996 d->preview_format_))
2997 dr.setMessage(_("Error viewing the output file."));
3000 case LFUN_CHANGES_TRACK:
3001 if (params().save_transient_properties)
3002 undo().recordUndoBufferParams(CursorData());
3003 params().track_changes = !params().track_changes;
3006 case LFUN_CHANGES_OUTPUT:
3007 if (params().save_transient_properties)
3008 undo().recordUndoBufferParams(CursorData());
3009 params().output_changes = !params().output_changes;
3010 if (params().output_changes) {
3011 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3012 LaTeXFeatures::isAvailable("xcolor");
3015 Alert::warning(_("Changes not shown in LaTeX output"),
3016 _("Changes will not be highlighted in LaTeX output, "
3017 "because xcolor and ulem are not installed.\n"
3018 "Please install both packages or redefine "
3019 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3024 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3025 // turn compression on/off
3026 undo().recordUndoBufferParams(CursorData());
3027 params().compressed = !params().compressed;
3030 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3031 undo().recordUndoBufferParams(CursorData());
3032 params().output_sync = !params().output_sync;
3035 case LFUN_BUFFER_ANONYMIZE: {
3036 undo().recordUndoFullBuffer(CursorData());
3037 CursorData cur(doc_iterator_begin(this));
3038 for ( ; cur ; cur.forwardPar())
3039 cur.paragraph().anonymize();
3040 dr.forceBufferUpdate();
3041 dr.screenUpdate(Update::Force);
3049 dr.dispatched(dispatched);
3053 void Buffer::changeLanguage(Language const * from, Language const * to)
3055 LASSERT(from, return);
3056 LASSERT(to, return);
3058 ParIterator it = par_iterator_begin();
3059 ParIterator eit = par_iterator_end();
3060 for (; it != eit; ++it)
3061 it->changeLanguage(params(), from, to);
3065 bool Buffer::isMultiLingual() const
3067 ParConstIterator end = par_iterator_end();
3068 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3069 if (it->isMultiLingual(params()))
3076 std::set<Language const *> Buffer::getLanguages() const
3078 std::set<Language const *> langs;
3079 getLanguages(langs);
3084 void Buffer::getLanguages(std::set<Language const *> & langs) const
3086 ParConstIterator end = par_iterator_end();
3087 // add the buffer language, even if it's not actively used
3088 langs.insert(language());
3089 // iterate over the paragraphs
3090 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3091 it->getLanguages(langs);
3093 ListOfBuffers clist = getDescendants();
3094 for (auto const & cit : clist)
3095 cit->getLanguages(langs);
3099 DocIterator Buffer::getParFromID(int const id) const
3101 Buffer * buf = const_cast<Buffer *>(this);
3103 // This means non-existent
3104 return doc_iterator_end(buf);
3106 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3107 if (it.paragraph().id() == id)
3110 return doc_iterator_end(buf);
3114 bool Buffer::hasParWithID(int const id) const
3116 return !getParFromID(id).atEnd();
3120 ParIterator Buffer::par_iterator_begin()
3122 return ParIterator(doc_iterator_begin(this));
3126 ParIterator Buffer::par_iterator_end()
3128 return ParIterator(doc_iterator_end(this));
3132 ParConstIterator Buffer::par_iterator_begin() const
3134 return ParConstIterator(doc_iterator_begin(this));
3138 ParConstIterator Buffer::par_iterator_end() const
3140 return ParConstIterator(doc_iterator_end(this));
3143 bool Buffer::empty() const
3145 return paragraphs().size() == 1 && paragraphs().front().empty();
3149 Language const * Buffer::language() const
3151 return params().language;
3155 docstring Buffer::B_(string const & l10n) const
3157 return params().B_(l10n);
3161 bool Buffer::isClean() const
3163 return d->lyx_clean;
3167 bool Buffer::isChecksumModified() const
3169 LASSERT(d->filename.exists(), return false);
3170 return d->checksum_ != d->filename.checksum();
3174 void Buffer::saveCheckSum() const
3176 FileName const & file = d->filename;
3178 d->checksum_ = file.exists() ? file.checksum()
3179 : 0; // in the case of save to a new file.
3183 void Buffer::markClean() const
3185 if (!d->lyx_clean) {
3186 d->lyx_clean = true;
3189 // if the .lyx file has been saved, we don't need an
3191 d->bak_clean = true;
3192 d->undo_.markDirty();
3193 clearExternalModification();
3197 void Buffer::setUnnamed(bool flag)
3203 bool Buffer::isUnnamed() const
3210 /// Don't check unnamed, here: isInternal() is used in
3211 /// newBuffer(), where the unnamed flag has not been set by anyone
3212 /// yet. Also, for an internal buffer, there should be no need for
3213 /// retrieving fileName() nor for checking if it is unnamed or not.
3214 bool Buffer::isInternal() const
3216 return d->internal_buffer;
3220 void Buffer::setInternal(bool flag)
3222 d->internal_buffer = flag;
3226 void Buffer::markDirty()
3229 d->lyx_clean = false;
3232 d->bak_clean = false;
3234 for (auto & depit : d->dep_clean)
3235 depit.second = false;
3239 FileName Buffer::fileName() const
3245 string Buffer::absFileName() const
3247 return d->filename.absFileName();
3251 string Buffer::filePath() const
3253 string const abs = d->filename.onlyPath().absFileName();
3256 int last = abs.length() - 1;
3258 return abs[last] == '/' ? abs : abs + '/';
3262 DocFileName Buffer::getReferencedFileName(string const & fn) const
3265 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3266 result.set(fn, filePath());
3268 // filePath() ends with a path separator
3269 FileName const test(filePath() + fn);
3271 result.set(fn, filePath());
3273 result.set(fn, params().origin);
3280 string const Buffer::prepareFileNameForLaTeX(string const & name,
3281 string const & ext, bool nice) const
3283 string const fname = makeAbsPath(name, filePath()).absFileName();
3284 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3290 return to_utf8(makeRelPath(from_utf8(fname),
3291 from_utf8(masterBuffer()->filePath())));
3295 vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3296 docstring_list const & bibfilelist,
3297 bool const add_extension) const
3299 // If we are processing the LaTeX file in a temp directory then
3300 // copy the .bib databases to this temp directory, mangling their
3301 // names in the process. Store this mangled name in the list of
3303 // (We need to do all this because BibTeX *really*, *really*
3304 // can't handle "files with spaces" and Windows users tend to
3305 // use such filenames.)
3306 // Otherwise, store the (maybe absolute) path to the original,
3307 // unmangled database name.
3309 vector<pair<docstring, string>> res;
3311 // determine the export format
3312 string const tex_format = flavor2format(runparams.flavor);
3314 // check for spaces in paths
3315 bool found_space = false;
3317 for (auto const & bit : bibfilelist) {
3318 string utf8input = to_utf8(bit);
3320 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3321 FileName try_in_file =
3322 makeAbsPath(database + ".bib", filePath());
3323 bool not_from_texmf = try_in_file.isReadableFile();
3324 // If the file has not been found, try with the real file name
3325 // (it might come from a child in a sub-directory)
3326 if (!not_from_texmf) {
3327 try_in_file = getBibfilePath(bit);
3328 if (try_in_file.isReadableFile()) {
3329 // Check if the file is in texmf
3330 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3331 not_from_texmf = kpsefile.empty()
3332 || kpsefile.absFileName() != try_in_file.absFileName();
3334 // If this exists, make path relative to the master
3337 removeExtension(prepareFileNameForLaTeX(
3338 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3339 from_utf8(filePath()))),
3340 ".bib", runparams.nice));
3344 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3346 // mangledFileName() needs the extension
3347 DocFileName const in_file = DocFileName(try_in_file);
3348 database = removeExtension(in_file.mangledFileName());
3349 FileName const out_file = makeAbsPath(database + ".bib",
3350 masterBuffer()->temppath());
3351 bool const success = in_file.copyTo(out_file);
3353 LYXERR0("Failed to copy '" << in_file
3354 << "' to '" << out_file << "'");
3356 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3357 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3358 if (!isValidLaTeXFileName(database)) {
3359 frontend::Alert::warning(_("Invalid filename"),
3360 _("The following filename will cause troubles "
3361 "when running the exported file through LaTeX: ") +
3362 from_utf8(database));
3364 if (!isValidDVIFileName(database)) {
3365 frontend::Alert::warning(_("Problematic filename for DVI"),
3366 _("The following filename can cause troubles "
3367 "when running the exported file through LaTeX "
3368 "and opening the resulting DVI: ") +
3369 from_utf8(database), true);
3377 docstring const path = from_utf8(latex_path(database));
3379 if (contains(path, ' '))
3382 if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
3383 enc = params().bibFileEncoding(utf8input);
3385 bool recorded = false;
3386 for (auto const & pe : res) {
3387 if (pe.first == path) {
3394 res.push_back(make_pair(path, enc));
3397 // Check if there are spaces in the path and warn BibTeX users, if so.
3398 // (biber can cope with such paths)
3399 if (!prefixIs(runparams.bibtex_command, "biber")) {
3400 // Post this warning only once.
3401 static bool warned_about_spaces = false;
3402 if (!warned_about_spaces &&
3403 runparams.nice && found_space) {
3404 warned_about_spaces = true;
3405 Alert::warning(_("Export Warning!"),
3406 _("There are spaces in the paths to your BibTeX databases.\n"
3407 "BibTeX will be unable to find them."));
3416 string Buffer::layoutPos() const
3418 return d->layout_position;
3422 void Buffer::setLayoutPos(string const & path)
3425 d->layout_position.clear();
3429 LATTEST(FileName::isAbsolute(path));
3431 d->layout_position =
3432 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3434 if (d->layout_position.empty())
3435 d->layout_position = ".";
3439 bool Buffer::hasReadonlyFlag() const
3441 return d->read_only;
3445 bool Buffer::isReadonly() const
3447 return hasReadonlyFlag() || notifiesExternalModification();
3451 void Buffer::setParent(Buffer const * buffer)
3453 // We need to do some work here to avoid recursive parent structures.
3454 // This is the easy case.
3455 if (buffer == this) {
3456 LYXERR0("Ignoring attempt to set self as parent in\n" << fileName());
3459 // Now we check parents going upward, to make sure that IF we set the
3460 // parent as requested, we would not generate a recursive include.
3461 set<Buffer const *> sb;
3462 Buffer const * b = buffer;
3463 bool found_recursion = false;
3465 if (sb.find(b) != sb.end()) {
3466 found_recursion = true;
3473 if (found_recursion) {
3474 LYXERR0("Ignoring attempt to set parent of\n" <<
3477 buffer->fileName() <<
3478 "\nbecause that would create a recursive inclusion.");
3482 // We should be safe now.
3483 d->setParent(buffer);
3488 Buffer const * Buffer::parent() const
3494 ListOfBuffers Buffer::allRelatives() const
3496 ListOfBuffers lb = masterBuffer()->getDescendants();
3497 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3502 Buffer const * Buffer::masterBuffer() const
3504 Buffer const * const pbuf = d->parent();
3508 return pbuf->masterBuffer();
3512 bool Buffer::isChild(Buffer * child) const
3514 return d->children_positions.find(child) != d->children_positions.end();
3518 DocIterator Buffer::firstChildPosition(Buffer const * child)
3520 Impl::BufferPositionMap::iterator it;
3521 it = d->children_positions.find(child);
3522 if (it == d->children_positions.end())
3523 return DocIterator(this);
3528 bool Buffer::hasChildren() const
3530 return !d->children_positions.empty();
3534 void Buffer::collectChildren(ListOfBuffers & children, bool grand_children) const
3536 // loop over children
3537 for (auto const & p : d->children_positions) {
3538 Buffer * child = const_cast<Buffer *>(p.first);
3539 // This can happen when called during GUI operations
3540 if (!theBufferList().isLoaded(child))
3543 ListOfBuffers::const_iterator bit = find(children.begin(), children.end(), child);
3544 if (bit != children.end())
3546 children.push_back(child);
3548 // there might be grandchildren
3549 child->collectChildren(children, true);
3554 ListOfBuffers Buffer::getChildren() const
3557 collectChildren(v, false);
3558 // Make sure we have not included ourselves.
3559 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3560 if (bit != v.end()) {
3561 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3568 ListOfBuffers Buffer::getDescendants() const
3571 collectChildren(v, true);
3572 // Make sure we have not included ourselves.
3573 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3574 if (bit != v.end()) {
3575 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3582 template<typename M>
3583 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3588 typename M::const_iterator it = m.lower_bound(x);
3589 if (it == m.begin())
3597 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3598 DocIterator const & pos) const
3600 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3602 // if paragraphs have no macro context set, pos will be empty
3606 // we haven't found anything yet
3607 DocIterator bestPos = owner_->par_iterator_begin();
3608 MacroData const * bestData = nullptr;
3610 // find macro definitions for name
3611 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3612 if (nameIt != macros.end()) {
3613 // find last definition in front of pos or at pos itself
3614 PositionScopeMacroMap::const_iterator it
3615 = greatest_below(nameIt->second, pos);
3616 if (it != nameIt->second.end()) {
3618 // scope ends behind pos?
3619 if (pos < it->second.scope) {
3620 // Looks good, remember this. If there
3621 // is no external macro behind this,
3622 // we found the right one already.
3623 bestPos = it->first;
3624 bestData = &it->second.macro;
3628 // try previous macro if there is one
3629 if (it == nameIt->second.begin())
3636 // find macros in included files
3637 PositionScopeBufferMap::const_iterator it
3638 = greatest_below(position_to_children, pos);
3639 if (it == position_to_children.end())
3640 // no children before
3644 // do we know something better (i.e. later) already?
3645 if (it->first < bestPos )
3648 // scope ends behind pos?
3649 if (pos < it->second.scope
3650 && (cloned_buffer_ ||
3651 theBufferList().isLoaded(it->second.buffer))) {
3652 // look for macro in external file
3654 MacroData const * data
3655 = it->second.buffer->getMacro(name, false);
3658 bestPos = it->first;
3664 // try previous file if there is one
3665 if (it == position_to_children.begin())
3670 // return the best macro we have found
3675 MacroData const * Buffer::getMacro(docstring const & name,
3676 DocIterator const & pos, bool global) const
3681 // query buffer macros
3682 MacroData const * data = d->getBufferMacro(name, pos);
3683 if (data != nullptr)
3686 // If there is a master buffer, query that
3687 Buffer const * const pbuf = d->parent();
3689 d->macro_lock = true;
3690 MacroData const * macro = pbuf->getMacro(
3691 name, *this, false);
3692 d->macro_lock = false;
3698 data = MacroTable::globalMacros().get(name);
3699 if (data != nullptr)
3707 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3709 // set scope end behind the last paragraph
3710 DocIterator scope = par_iterator_begin();
3711 scope.pit() = scope.lastpit() + 1;
3713 return getMacro(name, scope, global);
3717 MacroData const * Buffer::getMacro(docstring const & name,
3718 Buffer const & child, bool global) const
3720 // look where the child buffer is included first
3721 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3722 if (it == d->children_positions.end())
3725 // check for macros at the inclusion position
3726 return getMacro(name, it->second, global);
3730 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3732 pit_type const lastpit = it.lastpit();
3734 // look for macros in each paragraph
3735 while (it.pit() <= lastpit) {
3736 Paragraph & par = it.paragraph();
3738 // iterate over the insets of the current paragraph
3739 for (auto const & insit : par.insetList()) {
3740 it.pos() = insit.pos;
3742 // is it a nested text inset?
3743 if (insit.inset->asInsetText()) {
3744 // Inset needs its own scope?
3745 InsetText const * itext = insit.inset->asInsetText();
3746 bool newScope = itext->isMacroScope();
3748 // scope which ends just behind the inset
3749 DocIterator insetScope = it;
3752 // collect macros in inset
3753 it.push_back(CursorSlice(*insit.inset));
3754 updateMacros(it, newScope ? insetScope : scope);
3759 if (insit.inset->asInsetTabular()) {
3760 CursorSlice slice(*insit.inset);
3761 size_t const numcells = slice.nargs();
3762 for (; slice.idx() < numcells; slice.forwardIdx()) {
3763 it.push_back(slice);
3764 updateMacros(it, scope);
3770 // is it an external file?
3771 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3772 // get buffer of external file
3773 InsetInclude const & incinset =
3774 static_cast<InsetInclude const &>(*insit.inset);
3776 Buffer * child = incinset.loadIfNeeded();
3781 // register its position, but only when it is
3782 // included first in the buffer
3783 children_positions.insert({child, it});
3785 // register child with its scope
3786 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3790 InsetMath * im = insit.inset->asInsetMath();
3791 if (doing_export && im) {
3792 InsetMathHull * hull = im->asHullInset();
3794 hull->recordLocation(it);
3797 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3801 InsetMathMacroTemplate & macroTemplate =
3802 *insit.inset->asInsetMath()->asMacroTemplate();
3803 MacroContext mc(owner_, it);
3804 macroTemplate.updateToContext(mc);
3807 bool valid = macroTemplate.validMacro();
3808 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3809 // then the BufferView's cursor will be invalid in
3810 // some cases which leads to crashes.
3815 // FIXME (Abdel), I don't understand why we pass 'it' here
3816 // instead of 'macroTemplate' defined above... is this correct?
3817 macros[macroTemplate.name()][it] =
3818 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3828 void Buffer::updateMacros() const
3833 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3835 // start with empty table
3837 d->children_positions.clear();
3838 d->position_to_children.clear();
3840 // Iterate over buffer, starting with first paragraph
3841 // The scope must be bigger than any lookup DocIterator
3842 // later. For the global lookup, lastpit+1 is used, hence
3843 // we use lastpit+2 here.
3844 DocIterator it = par_iterator_begin();
3845 DocIterator outerScope = it;
3846 outerScope.pit() = outerScope.lastpit() + 2;
3847 d->updateMacros(it, outerScope);
3851 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3853 for (Inset const & it : inset()) {
3854 if (it.lyxCode() == BRANCH_CODE) {
3855 InsetBranch const & br = static_cast<InsetBranch const &>(it);
3856 docstring const name = br.branch();
3857 if (!from_master && !params().branchlist().find(name))
3858 result.push_back(name);
3859 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3860 result.push_back(name);
3863 if (it.lyxCode() == INCLUDE_CODE) {
3864 // get buffer of external file
3865 InsetInclude const & ins =
3866 static_cast<InsetInclude const &>(it);
3867 Buffer * child = ins.loadIfNeeded();
3870 child->getUsedBranches(result, true);
3873 // remove duplicates
3878 void Buffer::updateMacroInstances(UpdateType utype) const
3880 LYXERR(Debug::MACROS, "updateMacroInstances for "
3881 << d->filename.onlyFileName());
3882 DocIterator it = doc_iterator_begin(this);
3884 DocIterator const end = doc_iterator_end(this);
3885 for (; it != end; it.forwardInset()) {
3886 // look for MathData cells in InsetMathNest insets
3887 InsetMath * minset = it.nextInset()->asInsetMath();
3891 // update macro in all cells of the InsetMathNest
3892 idx_type n = minset->nargs();
3893 MacroContext mc = MacroContext(this, it);
3894 for (idx_type i = 0; i < n; ++i) {
3895 MathData & data = minset->cell(i);
3896 data.updateMacros(nullptr, mc, utype, 0);
3902 void Buffer::listMacroNames(MacroNameSet & macros) const
3907 d->macro_lock = true;
3909 // loop over macro names
3910 for (auto const & nameit : d->macros)
3911 macros.insert(nameit.first);
3913 // loop over children
3914 for (auto const & p : d->children_positions) {
3915 Buffer * child = const_cast<Buffer *>(p.first);
3916 // The buffer might have been closed (see #10766).
3917 if (theBufferList().isLoaded(child))
3918 child->listMacroNames(macros);
3922 Buffer const * const pbuf = d->parent();
3924 pbuf->listMacroNames(macros);
3926 d->macro_lock = false;
3930 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3932 Buffer const * const pbuf = d->parent();
3937 pbuf->listMacroNames(names);
3940 for (auto const & mit : names) {
3942 MacroData const * data = pbuf->getMacro(mit, *this, false);
3944 macros.insert(data);
3946 // we cannot access the original InsetMathMacroTemplate anymore
3947 // here to calls validate method. So we do its work here manually.
3948 // FIXME: somehow make the template accessible here.
3949 if (data->optionals() > 0)
3950 features.require("xargs");
3956 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3959 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3961 RefCache::iterator it = d->ref_cache_.find(label);
3962 if (it != d->ref_cache_.end())
3965 static References const dummy_refs = References();
3966 it = d->ref_cache_.insert(
3967 make_pair(label, dummy_refs)).first;
3972 Buffer::References const & Buffer::references(docstring const & label) const
3974 return const_cast<Buffer *>(this)->getReferenceCache(label);
3978 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3980 References & refs = getReferenceCache(label);
3981 refs.push_back(make_pair(inset, it));
3985 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
3989 linfo.label = label;
3991 linfo.active = active;
3992 masterBuffer()->d->label_cache_.push_back(linfo);
3996 InsetLabel const * Buffer::insetLabel(docstring const & label,
3997 bool const active) const
3999 for (auto const & rc : masterBuffer()->d->label_cache_) {
4000 if (rc.label == label && (rc.active || !active))
4007 bool Buffer::activeLabel(docstring const & label) const
4009 return insetLabel(label, true) != nullptr;
4013 void Buffer::clearReferenceCache() const
4016 d->ref_cache_.clear();
4017 d->label_cache_.clear();
4022 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
4024 //FIXME: This does not work for child documents yet.
4025 reloadBibInfoCache();
4027 // Check if the label 'from' appears more than once
4028 vector<docstring> labels;
4029 for (auto const & bibit : masterBibInfo())
4030 labels.push_back(bibit.first);
4032 if (count(labels.begin(), labels.end(), from) > 1)
4035 string const paramName = "key";
4036 UndoGroupHelper ugh(this);
4037 InsetIterator it = begin(inset());
4039 if (it->lyxCode() != CITE_CODE)
4041 InsetCommand * inset = it->asInsetCommand();
4042 docstring const oldValue = inset->getParam(paramName);
4043 if (oldValue == from) {
4044 undo().recordUndo(CursorData(it));
4045 inset->setParam(paramName, to);
4050 // returns NULL if id-to-row conversion is unsupported
4051 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4052 pit_type par_begin, pit_type par_end,
4053 OutputWhat output, bool master) const
4055 unique_ptr<TexRow> texrow;
4056 OutputParams runparams(¶ms().encoding());
4057 runparams.nice = true;
4058 runparams.flavor = params().getOutputFlavor(format);
4059 runparams.linelen = lyxrc.plaintext_linelen;
4060 // No side effect of file copying and image conversion
4061 runparams.dryrun = true;
4063 // Some macros rely on font encoding
4064 runparams.main_fontenc = params().main_font_encoding();
4066 // Use the right wrapping for the comment at the beginning of the generated
4067 // snippet, so that it is either valid LaTeX or valid XML (including HTML and DocBook).
4068 docstring comment_start = from_ascii("% ");
4069 docstring comment_end = from_ascii("");
4070 if (runparams.flavor == Flavor::Html || runparams.flavor == Flavor::DocBook5) {
4071 comment_start = from_ascii("<!-- ");
4072 comment_end = from_ascii(" -->");
4075 if (output == CurrentParagraph) {
4076 runparams.par_begin = par_begin;
4077 runparams.par_end = par_end;
4078 if (par_begin + 1 == par_end) {
4080 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4085 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4086 convert<docstring>(par_begin),
4087 convert<docstring>(par_end - 1))
4091 // output paragraphs
4092 if (runparams.flavor == Flavor::LyX) {
4093 Paragraph const & par = text().paragraphs()[par_begin];
4095 depth_type dt = par.getDepth();
4096 par.write(ods, params(), dt);
4097 os << from_utf8(ods.str());
4098 } else if (runparams.flavor == Flavor::Html) {
4100 setMathFlavor(runparams);
4101 xhtmlParagraphs(text(), *this, xs, runparams);
4102 } else if (runparams.flavor == Flavor::Text) {
4104 // FIXME Handles only one paragraph, unlike the others.
4105 // Probably should have some routine with a signature like them.
4106 writePlaintextParagraph(*this,
4107 text().paragraphs()[par_begin], os, runparams, dummy);
4108 } else if (runparams.flavor == Flavor::DocBook5) {
4110 docbookParagraphs(text(), *this, xs, runparams);
4112 // If we are previewing a paragraph, even if this is the
4113 // child of some other buffer, let's cut the link here,
4114 // so that no concurring settings from the master
4115 // (e.g. branch state) interfere (see #8101).
4117 d->ignore_parent = true;
4118 // We need to validate the Buffer params' features here
4119 // in order to know if we should output polyglossia
4120 // macros (instead of babel macros)
4121 LaTeXFeatures features(*this, params(), runparams);
4123 runparams.use_polyglossia = features.usePolyglossia();
4124 runparams.use_hyperref = features.isRequired("hyperref");
4125 // latex or literate
4128 ots.texrow().newlines(2);
4130 latexParagraphs(*this, text(), ots, runparams);
4131 texrow = ots.releaseTexRow();
4133 // Restore the parenthood
4135 d->ignore_parent = false;
4138 os << comment_start;
4139 if (output == FullSource)
4140 os << _("Preview source code");
4141 else if (output == OnlyPreamble)
4142 os << _("Preview preamble");
4143 else if (output == OnlyBody)
4144 os << _("Preview body");
4147 if (runparams.flavor == Flavor::LyX) {
4149 if (output == FullSource)
4151 else if (output == OnlyPreamble)
4152 params().writeFile(ods, this);
4153 else if (output == OnlyBody)
4155 os << from_utf8(ods.str());
4156 } else if (runparams.flavor == Flavor::Html) {
4157 writeLyXHTMLSource(os, runparams, output);
4158 } else if (runparams.flavor == Flavor::Text) {
4159 if (output == OnlyPreamble)
4160 os << "% "<< _("Plain text does not have a preamble.");
4162 writePlaintextFile(*this, os, runparams);
4163 } else if (runparams.flavor == Flavor::DocBook5) {
4164 writeDocBookSource(os, runparams, output);
4166 // latex or literate
4169 ots.texrow().newlines(2);
4171 runparams.is_child = true;
4173 writeLaTeXSource(ots, string(), runparams, output);
4174 texrow = ots.releaseTexRow();
4181 ErrorList & Buffer::errorList(string const & type) const
4183 return d->errorLists[type];
4187 void Buffer::updateTocItem(std::string const & type,
4188 DocIterator const & dit) const
4191 d->gui_->updateTocItem(type, dit);
4195 void Buffer::structureChanged() const
4198 d->gui_->structureChanged();
4202 void Buffer::errors(string const & err, bool from_master) const
4205 d->gui_->errors(err, from_master);
4209 void Buffer::message(docstring const & msg) const
4212 d->gui_->message(msg);
4216 void Buffer::setBusy(bool on) const
4219 d->gui_->setBusy(on);
4223 void Buffer::updateTitles() const
4226 d->wa_->updateTitles();
4230 void Buffer::resetAutosaveTimers() const
4233 d->gui_->resetAutosaveTimers();
4237 bool Buffer::hasGuiDelegate() const
4243 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4249 FileName Buffer::getEmergencyFileName() const
4251 return FileName(d->filename.absFileName() + ".emergency");
4255 FileName Buffer::getAutosaveFileName() const
4257 // if the document is unnamed try to save in the backup dir, else
4258 // in the default document path, and as a last try in the filePath,
4259 // which will most often be the temporary directory
4262 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4263 : lyxrc.backupdir_path;
4264 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4267 string const fname = "#" + d->filename.onlyFileName() + "#";
4269 return makeAbsPath(fname, fpath);
4273 void Buffer::removeAutosaveFile() const
4275 FileName const f = getAutosaveFileName();
4281 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4283 FileName const newauto = getAutosaveFileName();
4285 if (newauto != oldauto && oldauto.exists())
4286 if (!oldauto.moveTo(newauto))
4287 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4291 bool Buffer::autoSave() const
4293 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4294 if (buf->d->bak_clean || hasReadonlyFlag())
4297 message(_("Autosaving current document..."));
4298 buf->d->bak_clean = true;
4300 FileName const fname = getAutosaveFileName();
4301 LASSERT(d->cloned_buffer_, return false);
4303 // If this buffer is cloned, we assume that
4304 // we are running in a separate thread already.
4305 TempFile tempfile("lyxautoXXXXXX.lyx");
4306 tempfile.setAutoRemove(false);
4307 FileName const tmp_ret = tempfile.name();
4308 if (!tmp_ret.empty()) {
4310 // assume successful write of tmp_ret
4311 if (tmp_ret.moveTo(fname))
4314 // failed to write/rename tmp_ret so try writing direct
4315 return writeFile(fname);
4319 void Buffer::setExportStatus(bool e) const
4321 d->doing_export = e;
4322 ListOfBuffers clist = getDescendants();
4323 for (auto const & bit : clist)
4324 bit->d->doing_export = e;
4328 bool Buffer::isExporting() const
4330 return d->doing_export;
4334 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4338 return doExport(target, put_in_tempdir, result_file);
4341 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4342 string & result_file) const
4344 bool const update_unincluded =
4345 params().maintain_unincluded_children != BufferParams::CM_None
4346 && !params().getIncludedChildren().empty();
4348 // (1) export with all included children (omit \includeonly)
4349 if (update_unincluded) {
4350 ExportStatus const status =
4351 doExport(target, put_in_tempdir, true, result_file);
4352 if (status != ExportSuccess)
4355 // (2) export with included children only
4356 return doExport(target, put_in_tempdir, false, result_file);
4360 void Buffer::setMathFlavor(OutputParams & op) const
4362 switch (params().html_math_output) {
4363 case BufferParams::MathML:
4364 op.math_flavor = OutputParams::MathAsMathML;
4366 case BufferParams::HTML:
4367 op.math_flavor = OutputParams::MathAsHTML;
4369 case BufferParams::Images:
4370 op.math_flavor = OutputParams::MathAsImages;
4372 case BufferParams::LaTeX:
4373 op.math_flavor = OutputParams::MathAsLaTeX;
4379 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4380 bool includeall, string & result_file) const
4382 LYXERR(Debug::FILES, "target=" << target);
4383 OutputParams runparams(¶ms().encoding());
4384 string format = target;
4385 string dest_filename;
4386 size_t pos = target.find(' ');
4387 if (pos != string::npos) {
4388 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4389 format = target.substr(0, pos);
4390 if (format == "default")
4391 format = params().getDefaultOutputFormat();
4392 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4393 FileName(dest_filename).onlyPath().createPath();
4394 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4396 MarkAsExporting exporting(this);
4397 string backend_format;
4398 runparams.flavor = Flavor::LaTeX;
4399 runparams.linelen = lyxrc.plaintext_linelen;
4400 runparams.includeall = includeall;
4401 vector<string> backs = params().backends();
4402 Converters converters = theConverters();
4403 bool need_nice_file = false;
4404 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4405 // Get shortest path to format
4406 converters.buildGraph();
4407 Graph::EdgePath path;
4408 for (string const & sit : backs) {
4409 Graph::EdgePath p = converters.getPath(sit, format);
4410 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4411 backend_format = sit;
4416 if (!put_in_tempdir) {
4417 // Only show this alert if this is an export to a non-temporary
4418 // file (not for previewing).
4419 docstring s = bformat(_("No information for exporting the format %1$s."),
4420 translateIfPossible(theFormats().prettyName(format)));
4421 if (format == "pdf4")
4423 + bformat(_("Hint: use non-TeX fonts or set input encoding "
4424 " to '%1$s'"), from_utf8(encodings.fromLyXName("ascii")->guiName()));
4425 Alert::error(_("Couldn't export file"), s);
4427 return ExportNoPathToFormat;
4429 runparams.flavor = converters.getFlavor(path, this);
4430 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4431 for (auto const & edge : path)
4432 if (theConverters().get(edge).nice()) {
4433 need_nice_file = true;
4438 backend_format = format;
4439 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4440 // FIXME: Don't hardcode format names here, but use a flag
4441 if (backend_format == "pdflatex")
4442 runparams.flavor = Flavor::PdfLaTeX;
4443 else if (backend_format == "luatex")
4444 runparams.flavor = Flavor::LuaTeX;
4445 else if (backend_format == "dviluatex")
4446 runparams.flavor = Flavor::DviLuaTeX;
4447 else if (backend_format == "xetex")
4448 runparams.flavor = Flavor::XeTeX;
4451 string filename = latexName(false);
4452 filename = addName(temppath(), filename);
4453 filename = changeExtension(filename,
4454 theFormats().extension(backend_format));
4455 LYXERR(Debug::FILES, "filename=" << filename);
4457 // Plain text backend
4458 if (backend_format == "text") {
4459 runparams.flavor = Flavor::Text;
4461 writePlaintextFile(*this, FileName(filename), runparams);
4463 catch (ConversionException const &) { return ExportCancel; }
4466 else if (backend_format == "xhtml") {
4467 runparams.flavor = Flavor::Html;
4468 setMathFlavor(runparams);
4469 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4470 return ExportKilled;
4471 } else if (backend_format == "lyx")
4472 writeFile(FileName(filename));
4474 else if (backend_format == "docbook5") {
4475 runparams.flavor = Flavor::DocBook5;
4476 runparams.nice = false;
4477 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4478 return ExportKilled;
4481 else if (backend_format == format || need_nice_file) {
4482 runparams.nice = true;
4483 ExportStatus const retval =
4484 makeLaTeXFile(FileName(filename), string(), runparams);
4485 if (retval == ExportKilled)
4486 return ExportKilled;
4487 if (d->cloned_buffer_)
4488 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4489 if (retval != ExportSuccess)
4491 } else if (!lyxrc.tex_allows_spaces
4492 && contains(filePath(), ' ')) {
4493 Alert::error(_("File name error"),
4494 bformat(_("The directory path to the document\n%1$s\n"
4495 "contains spaces, but your TeX installation does "
4496 "not allow them. You should save the file to a directory "
4497 "whose name does not contain spaces."), from_utf8(filePath())));
4498 return ExportTexPathHasSpaces;
4500 runparams.nice = false;
4501 ExportStatus const retval =
4502 makeLaTeXFile(FileName(filename), filePath(), runparams);
4503 if (retval == ExportKilled)
4504 return ExportKilled;
4505 if (d->cloned_buffer_)
4506 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4507 if (retval != ExportSuccess)
4511 string const error_type = (format == "program")
4512 ? "Build" : params().bufferFormat();
4513 ErrorList & error_list = d->errorLists[error_type];
4514 string const ext = theFormats().extension(format);
4515 FileName const tmp_result_file(changeExtension(filename, ext));
4516 Converters::RetVal const retval =
4517 converters.convert(this, FileName(filename), tmp_result_file,
4518 FileName(absFileName()), backend_format, format,
4519 error_list, Converters::none, includeall);
4520 if (retval == Converters::KILLED)
4521 return ExportCancel;
4522 bool success = (retval == Converters::SUCCESS);
4524 // Emit the signal to show the error list or copy it back to the
4525 // cloned Buffer so that it can be emitted afterwards.
4526 if (format != backend_format) {
4527 if (runparams.silent)
4529 else if (d->cloned_buffer_)
4530 d->cloned_buffer_->d->errorLists[error_type] =
4531 d->errorLists[error_type];
4534 // also to the children, in case of master-buffer-view
4535 ListOfBuffers clist = getDescendants();
4536 for (auto const & bit : clist) {
4537 if (runparams.silent)
4538 bit->d->errorLists[error_type].clear();
4539 else if (d->cloned_buffer_) {
4540 // Enable reverse search by copying back the
4541 // texrow object to the cloned buffer.
4542 // FIXME: this is not thread safe.
4543 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4544 bit->d->cloned_buffer_->d->errorLists[error_type] =
4545 bit->d->errorLists[error_type];
4547 bit->errors(error_type, true);
4551 if (d->cloned_buffer_) {
4552 // Enable reverse dvi or pdf to work by copying back the texrow
4553 // object to the cloned buffer.
4554 // FIXME: There is a possibility of concurrent access to texrow
4555 // here from the main GUI thread that should be securized.
4556 d->cloned_buffer_->d->texrow = d->texrow;
4557 string const err_type = params().bufferFormat();
4558 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4562 if (put_in_tempdir) {
4563 result_file = tmp_result_file.absFileName();
4564 return success ? ExportSuccess : ExportConverterError;
4567 if (dest_filename.empty())
4568 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4570 result_file = dest_filename;
4571 // We need to copy referenced files (e. g. included graphics
4572 // if format == "dvi") to the result dir.
4573 vector<ExportedFile> const extfiles =
4574 runparams.exportdata->externalFiles(format);
4575 string const dest = runparams.export_folder.empty() ?
4576 onlyPath(result_file) : runparams.export_folder;
4577 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4578 : force_overwrite == ALL_FILES;
4579 CopyStatus status = use_force ? FORCE : SUCCESS;
4581 for (ExportedFile const & exp : extfiles) {
4582 if (status == CANCEL) {
4583 message(_("Document export cancelled."));
4584 return ExportCancel;
4586 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4587 string fixedName = exp.exportName;
4588 if (!runparams.export_folder.empty()) {
4589 // Relative pathnames starting with ../ will be sanitized
4590 // if exporting to a different folder
4591 while (fixedName.substr(0, 3) == "../")
4592 fixedName = fixedName.substr(3, fixedName.length() - 3);
4594 FileName fixedFileName = makeAbsPath(fixedName, dest);
4595 fixedFileName.onlyPath().createPath();
4596 status = copyFile(fmt, exp.sourceName,
4598 exp.exportName, status == FORCE,
4599 runparams.export_folder.empty());
4603 if (tmp_result_file.exists()) {
4604 // Finally copy the main file
4605 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4606 : force_overwrite != NO_FILES;
4607 if (status == SUCCESS && use_force)
4609 status = copyFile(format, tmp_result_file,
4610 FileName(result_file), result_file,
4612 if (status == CANCEL) {
4613 message(_("Document export cancelled."));
4614 return ExportCancel;
4616 message(bformat(_("Document exported as %1$s "
4618 translateIfPossible(theFormats().prettyName(format)),
4619 makeDisplayPath(result_file)));
4622 // This must be a dummy converter like fax (bug 1888)
4623 message(bformat(_("Document exported as %1$s"),
4624 translateIfPossible(theFormats().prettyName(format))));
4627 return success ? ExportSuccess : ExportConverterError;
4631 Buffer::ExportStatus Buffer::preview(string const & format) const
4633 bool const update_unincluded =
4634 params().maintain_unincluded_children != BufferParams::CM_None
4635 && !params().getIncludedChildren().empty();
4636 return preview(format, update_unincluded);
4640 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4642 MarkAsExporting exporting(this);
4644 // (1) export with all included children (omit \includeonly)
4646 ExportStatus const status = doExport(format, true, true, result_file);
4647 if (status != ExportSuccess)
4650 // (2) export with included children only
4651 ExportStatus const status = doExport(format, true, false, result_file);
4652 FileName const previewFile(result_file);
4654 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4655 theimpl->preview_file_ = previewFile;
4656 theimpl->preview_format_ = format;
4657 theimpl->require_fresh_start_ = (status != ExportSuccess);
4659 if (status != ExportSuccess)
4662 if (previewFile.exists())
4663 return theFormats().view(*this, previewFile, format) ?
4664 PreviewSuccess : PreviewError;
4666 // Successful export but no output file?
4667 // Probably a bug in error detection.
4668 LATTEST(status != ExportSuccess);
4673 Buffer::ReadStatus Buffer::extractFromVC()
4675 bool const found = LyXVC::file_not_found_hook(d->filename);
4677 return ReadFileNotFound;
4678 if (!d->filename.isReadableFile())
4684 Buffer::ReadStatus Buffer::loadEmergency()
4686 FileName const emergencyFile = getEmergencyFileName();
4687 if (!emergencyFile.exists()
4688 || emergencyFile.lastModified() <= d->filename.lastModified())
4689 return ReadFileNotFound;
4691 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4692 docstring const text = bformat(_("An emergency save of the document "
4693 "%1$s exists.\n\nRecover emergency save?"), file);
4695 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4696 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4702 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4703 bool const success = (ret_llf == ReadSuccess);
4705 if (hasReadonlyFlag()) {
4706 Alert::warning(_("File is read-only"),
4707 bformat(_("An emergency file is successfully loaded, "
4708 "but the original file %1$s is marked read-only. "
4709 "Please make sure to save the document as a different "
4710 "file."), from_utf8(d->filename.absFileName())));
4713 lyxvc().file_found_hook(d->filename);
4714 str = _("Document was successfully recovered.");
4716 str = _("Document was NOT successfully recovered.");
4717 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4718 makeDisplayPath(emergencyFile.absFileName()));
4720 int const del_emerg =
4721 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4722 _("&Remove"), _("&Keep"));
4723 if (del_emerg == 0) {
4724 emergencyFile.removeFile();
4726 Alert::warning(_("Emergency file deleted"),
4727 _("Do not forget to save your file now!"), true);
4729 return success ? ReadSuccess : ReadEmergencyFailure;
4732 int const del_emerg =
4733 Alert::prompt(_("Delete emergency file?"),
4734 _("Remove emergency file now?"), 1, 1,
4735 _("&Remove"), _("&Keep"));
4737 emergencyFile.removeFile();
4741 string const ename = emergencyFile.absFileName();
4743 // Surely we can find one in 100 tries?
4744 for (int i = 1; i < 100; ++i) {
4745 newname.set(ename + to_string(i) + ".lyx");
4746 if (!newname.exists()) {
4752 // renameTo returns true on success. So inverting that
4753 // will give us true if we fail.
4754 noname = !emergencyFile.renameTo(newname);
4757 Alert::warning(_("Can't rename emergency file!"),
4758 _("LyX was unable to rename the emergency file. "
4759 "You should do so manually. Otherwise, you will be "
4760 "asked about it again the next time you try to load "
4761 "this file, and may over-write your own work."));
4763 Alert::warning(_("Emergency File Renames"),
4764 bformat(_("Emergency file renamed as:\n %1$s"),
4765 from_utf8(newname.onlyFileName())));
4768 return ReadOriginal;
4778 Buffer::ReadStatus Buffer::loadAutosave()
4780 // Now check if autosave file is newer.
4781 FileName const autosaveFile = getAutosaveFileName();
4782 if (!autosaveFile.exists()
4783 || autosaveFile.lastModified() <= d->filename.lastModified())
4784 return ReadFileNotFound;
4786 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4787 docstring const text = bformat(_("The backup of the document %1$s "
4788 "is newer.\n\nLoad the backup instead?"), file);
4789 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4790 _("&Load backup"), _("Load &original"), _("&Cancel"));
4795 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4796 // the file is not saved if we load the autosave file.
4797 if (ret_llf == ReadSuccess) {
4798 if (hasReadonlyFlag()) {
4799 Alert::warning(_("File is read-only"),
4800 bformat(_("A backup file is successfully loaded, "
4801 "but the original file %1$s is marked read-only. "
4802 "Please make sure to save the document as a "
4804 from_utf8(d->filename.absFileName())));
4807 lyxvc().file_found_hook(d->filename);
4810 return ReadAutosaveFailure;
4813 // Here we delete the autosave
4814 autosaveFile.removeFile();
4815 return ReadOriginal;
4823 Buffer::ReadStatus Buffer::loadLyXFile()
4825 if (!d->filename.isReadableFile()) {
4826 ReadStatus const ret_rvc = extractFromVC();
4827 if (ret_rvc != ReadSuccess)
4831 ReadStatus const ret_re = loadEmergency();
4832 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4835 ReadStatus const ret_ra = loadAutosave();
4836 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4839 return loadThisLyXFile(d->filename);
4843 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4845 return readFile(fn);
4849 void Buffer::Impl::traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const
4851 for (; err != end; ++err) {
4852 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4853 int errorRow = err->error_in_line;
4854 Buffer const * buf = nullptr;
4855 Impl const * p = this;
4856 if (err->child_name.empty())
4857 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4859 // The error occurred in a child
4860 for (Buffer const * child : owner_->getDescendants()) {
4861 string const child_name =
4862 DocFileName(changeExtension(child->absFileName(), "tex")).
4864 if (err->child_name != child_name)
4866 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4867 if (!TexRow::isNone(start)) {
4868 buf = this->cloned_buffer_
4869 ? child->d->cloned_buffer_->d->owner_
4876 errorList.push_back(ErrorItem(err->error_desc, err->error_text,
4882 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4884 TeXErrors::Errors::const_iterator err = terr.begin();
4885 TeXErrors::Errors::const_iterator end = terr.end();
4887 d->traverseErrors(err, end, errorList);
4891 void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const
4893 TeXErrors::Errors::const_iterator err = terr.begin_ref();
4894 TeXErrors::Errors::const_iterator end = terr.end_ref();
4896 d->traverseErrors(err, end, errorList);
4900 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4902 LBUFERR(!text().paragraphs().empty());
4904 // Use the master text class also for child documents
4905 Buffer const * const master = masterBuffer();
4906 DocumentClass const & textclass = master->params().documentClass();
4908 docstring_list old_bibfiles;
4909 // Do this only if we are the top-level Buffer. We also need to account
4910 // for the case of a previewed child with ignored parent here.
4911 if (master == this && !d->ignore_parent) {
4912 textclass.counters().reset(from_ascii("bibitem"));
4913 reloadBibInfoCache();
4914 // we will re-read this cache as we go through, but we need
4915 // to know whether it's changed to know whether we need to
4916 // update the bibinfo cache.
4917 old_bibfiles = d->bibfiles_cache_;
4918 d->bibfiles_cache_.clear();
4921 // keep the buffers to be children in this set. If the call from the
4922 // master comes back we can see which of them were actually seen (i.e.
4923 // via an InsetInclude). The remaining ones in the set need still be updated.
4924 static std::set<Buffer const *> bufToUpdate;
4925 if (scope == UpdateMaster) {
4926 // If this is a child document start with the master
4927 if (master != this) {
4928 bufToUpdate.insert(this);
4929 master->updateBuffer(UpdateMaster, utype);
4930 // If the master buffer has no gui associated with it, then the TocModel is
4931 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4932 // (bug 5699). The same happens if the master buffer is open in a different
4933 // window. This test catches both possibilities.
4934 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
4935 // There remains a problem here: If there is another child open in yet a third
4936 // window, that TOC is not updated. So some more general solution is needed at
4938 if (master->d->gui_ != d->gui_)
4941 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4942 if (bufToUpdate.find(this) == bufToUpdate.end())
4946 // start over the counters in the master
4947 textclass.counters().reset();
4950 // update will be done below for this buffer
4951 bufToUpdate.erase(this);
4953 // update all caches
4954 clearReferenceCache();
4957 Buffer & cbuf = const_cast<Buffer &>(*this);
4958 // if we are reloading, then we could have a dangling TOC,
4959 // in effect. so we need to go ahead and reset, even though
4960 // we will do so again when we rebuild the TOC later.
4961 cbuf.tocBackend().reset();
4964 ParIterator parit = cbuf.par_iterator_begin();
4965 if (scope == UpdateMaster)
4967 updateBuffer(parit, utype);
4969 // If this document has siblings, then update the TocBackend later. The
4970 // reason is to ensure that later siblings are up to date when e.g. the
4971 // broken or not status of references is computed. The update is called
4972 // in InsetInclude::addToToc.
4976 // if the bibfiles changed, the cache of bibinfo is invalid
4977 docstring_list new_bibfiles = d->bibfiles_cache_;
4978 // this is a trick to determine whether the two vectors have
4979 // the same elements.
4980 sort(new_bibfiles.begin(), new_bibfiles.end());
4981 sort(old_bibfiles.begin(), old_bibfiles.end());
4982 if (old_bibfiles != new_bibfiles) {
4983 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
4984 invalidateBibinfoCache();
4985 reloadBibInfoCache();
4986 // We relied upon the bibinfo cache when recalculating labels. But that
4987 // cache was invalid, although we didn't find that out until now. So we
4988 // have to do it all again.
4989 // That said, the only thing we really need to do is update the citation
4990 // labels. Nothing else will have changed. So we could create a new
4991 // UpdateType that would signal that fact, if we needed to do so.
4992 parit = cbuf.par_iterator_begin();
4993 // we will be re-doing the counters and references and such.
4994 textclass.counters().reset();
4995 clearReferenceCache();
4996 // we should not need to do this again?
4998 updateBuffer(parit, utype);
4999 // this will already have been done by reloadBibInfoCache();
5000 // d->bibinfo_cache_valid_ = true;
5003 LYXERR(Debug::FILES, "Bibfiles unchanged.");
5004 // this is also set to true on the other path, by reloadBibInfoCache.
5005 d->bibinfo_cache_valid_ = true;
5007 d->cite_labels_valid_ = true;
5010 cbuf.tocBackend().update(true, utype);
5011 if (scope == UpdateMaster)
5012 cbuf.structureChanged();
5014 d->need_update = false;
5018 static depth_type getDepth(DocIterator const & it)
5020 depth_type depth = 0;
5021 for (size_t i = 0 ; i < it.depth() ; ++i)
5022 if (!it[i].inset().inMathed())
5023 depth += it[i].paragraph().getDepth() + 1;
5024 // remove 1 since the outer inset does not count
5025 // we should have at least one non-math inset, so
5026 // depth should nevery be 0. but maybe it is worth
5027 // marking this, just in case.
5029 // coverity[INTEGER_OVERFLOW]
5033 static depth_type getItemDepth(ParIterator const & it)
5035 Paragraph const & par = *it;
5036 LabelType const labeltype = par.layout().labeltype;
5038 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5041 // this will hold the lowest depth encountered up to now.
5042 depth_type min_depth = getDepth(it);
5043 ParIterator prev_it = it;
5046 --prev_it.top().pit();
5048 // start of nested inset: go to outer par
5050 if (prev_it.empty()) {
5051 // start of document: nothing to do
5056 // We search for the first paragraph with same label
5057 // that is not more deeply nested.
5058 Paragraph & prev_par = *prev_it;
5059 depth_type const prev_depth = getDepth(prev_it);
5060 if (labeltype == prev_par.layout().labeltype) {
5061 if (prev_depth < min_depth)
5062 return prev_par.itemdepth + 1;
5063 if (prev_depth == min_depth)
5064 return prev_par.itemdepth;
5066 min_depth = min(min_depth, prev_depth);
5067 // small optimization: if we are at depth 0, we won't
5068 // find anything else
5069 if (prev_depth == 0)
5075 static bool needEnumCounterReset(ParIterator const & it)
5077 Paragraph const & par = *it;
5078 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5079 depth_type const cur_depth = par.getDepth();
5080 ParIterator prev_it = it;
5081 while (prev_it.pit()) {
5082 --prev_it.top().pit();
5083 Paragraph const & prev_par = *prev_it;
5084 if (prev_par.getDepth() <= cur_depth)
5085 return prev_par.layout().name() != par.layout().name();
5087 // start of nested inset: reset
5092 // set the label of a paragraph. This includes the counters.
5093 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5095 BufferParams const & bp = owner_->masterBuffer()->params();
5096 DocumentClass const & textclass = bp.documentClass();
5097 Paragraph & par = it.paragraph();
5098 Layout const & layout = par.layout();
5099 Counters & counters = textclass.counters();
5101 if (par.params().startOfAppendix()) {
5102 // We want to reset the counter corresponding to toplevel sectioning
5103 Layout const & lay = textclass.getTOCLayout();
5104 docstring const cnt = lay.counter;
5106 counters.reset(cnt);
5107 counters.appendix(true);
5109 par.params().appendix(counters.appendix());
5111 // Compute the item depth of the paragraph
5112 par.itemdepth = getItemDepth(it);
5114 if (layout.margintype == MARGIN_MANUAL) {
5115 if (par.params().labelWidthString().empty())
5116 par.params().labelWidthString(par.expandLabel(layout, bp));
5117 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5118 // we do not need to do anything here, since the empty case is
5119 // handled during export.
5121 par.params().labelWidthString(docstring());
5124 switch(layout.labeltype) {
5125 case LABEL_ITEMIZE: {
5126 // At some point of time we should do something more
5127 // clever here, like:
5128 // par.params().labelString(
5129 // bp.user_defined_bullet(par.itemdepth).getText());
5130 // for now, use a simple hardcoded label
5131 docstring itemlabel;
5132 switch (par.itemdepth) {
5135 itemlabel = char_type(0x2022);
5139 itemlabel = char_type(0x2013);
5142 // ∗ U+2217 ASTERISK OPERATOR
5143 itemlabel = char_type(0x2217);
5146 // · U+00B7 MIDDLE DOT
5147 itemlabel = char_type(0x00b7);
5150 par.params().labelString(itemlabel);
5154 case LABEL_ENUMERATE: {
5155 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5157 switch (par.itemdepth) {
5168 enumcounter += "iv";
5171 // not a valid enumdepth...
5175 if (needEnumCounterReset(it)) {
5176 // Increase the parent counter?
5177 if (layout.stepparentcounter)
5178 counters.stepParent(enumcounter, utype);
5179 // Maybe we have to reset the enumeration counter.
5180 if (!layout.resumecounter)
5181 counters.reset(enumcounter);
5183 counters.step(enumcounter, utype);
5185 string const & lang = par.getParLanguage(bp)->code();
5186 par.params().labelString(counters.theCounter(enumcounter, lang));
5191 case LABEL_SENSITIVE: {
5192 string const & type = counters.current_float();
5193 docstring full_label;
5195 full_label = owner_->B_("Senseless!!! ");
5197 docstring name = owner_->B_(textclass.floats().getType(type).name());
5198 if (counters.hasCounter(from_utf8(type))) {
5199 string const & lang = par.getParLanguage(bp)->code();
5200 counters.step(from_utf8(type), utype);
5201 full_label = bformat(from_ascii("%1$s %2$s:"),
5203 counters.theCounter(from_utf8(type), lang));
5205 full_label = bformat(from_ascii("%1$s #:"), name);
5207 par.params().labelString(full_label);
5211 case LABEL_NO_LABEL:
5212 par.params().labelString(docstring());
5216 case LABEL_CENTERED:
5217 case LABEL_STATIC: {
5218 docstring const & lcounter = layout.counter;
5219 if (!lcounter.empty()) {
5220 if (layout.toclevel <= bp.secnumdepth
5221 && (layout.latextype != LATEX_ENVIRONMENT
5222 || it.text()->isFirstInSequence(it.pit()))) {
5223 if (counters.hasCounter(lcounter))
5224 counters.step(lcounter, utype);
5225 par.params().labelString(par.expandLabel(layout, bp));
5227 par.params().labelString(docstring());
5229 par.params().labelString(par.expandLabel(layout, bp));
5235 par.params().labelString(par.expandLabel(layout, bp));
5240 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype, bool const deleted) const
5242 pushIncludedBuffer(this);
5243 // LASSERT: Is it safe to continue here, or should we just return?
5244 LASSERT(parit.pit() == 0, /**/);
5246 // Set the position of the text in the buffer to be able
5247 // to resolve macros in it.
5248 parit.text()->setMacrocontextPosition(parit);
5250 depth_type maxdepth = 0;
5251 pit_type const lastpit = parit.lastpit();
5252 bool changed = false;
5253 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5254 // reduce depth if necessary
5255 if (parit->params().depth() > maxdepth) {
5256 /** FIXME: this function is const, but
5257 * nevertheless it modifies the buffer. To be
5258 * cleaner, one should modify the buffer in
5259 * another function, which is actually
5260 * non-const. This would however be costly in
5261 * terms of code duplication.
5263 CursorData(parit).recordUndo();
5264 parit->params().depth(maxdepth);
5266 maxdepth = parit->getMaxDepthAfter();
5268 if (utype == OutputUpdate) {
5269 // track the active counters
5270 // we have to do this for the master buffer, since the local
5271 // buffer isn't tracking anything.
5272 masterBuffer()->params().documentClass().counters().
5273 setActiveLayout(parit->layout());
5276 // set the counter for this paragraph
5277 d->setLabel(parit, utype);
5280 for (auto const & insit : parit->insetList()) {
5281 parit.pos() = insit.pos;
5282 insit.inset->updateBuffer(parit, utype, deleted || parit->isDeleted(insit.pos));
5283 changed |= insit.inset->isChanged();
5286 // are there changes in this paragraph?
5287 changed |= parit->isChanged();
5290 // set change indicator for the inset (or the cell that the iterator
5291 // points to, if applicable).
5292 parit.text()->inset().isChanged(changed);
5293 popIncludedBuffer();
5297 void Buffer::forceUpdate() const
5299 d->need_update = true;
5303 bool Buffer::needUpdate() const
5305 return d->need_update;
5309 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5310 WordLangTuple & word_lang, docstring_list & suggestions) const
5314 suggestions.clear();
5315 word_lang = WordLangTuple();
5316 bool const to_end = to.empty();
5317 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5318 // OK, we start from here.
5319 for (; from != end; from.forwardPos()) {
5320 // This skips all insets with spell check disabled.
5321 while (!from.allowSpellCheck()) {
5325 // If from is at the end of the document (which is possible
5326 // when "from" was changed above) LyX will crash later otherwise.
5327 if (from.atEnd() || (!to_end && from >= end))
5330 from.paragraph().spellCheck();
5331 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5332 if (SpellChecker::misspelled(res)) {
5336 // Do not increase progress when from == to, otherwise the word
5337 // count will be wrong.
5347 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5349 bool inword = false;
5354 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5355 if (!dit.inTexted()) {
5360 Paragraph const & par = dit.paragraph();
5361 pos_type const pos = dit.pos();
5363 // Copied and adapted from isWordSeparator() in Paragraph
5364 if (pos == dit.lastpos()) {
5367 Inset const * ins = par.getInset(pos);
5368 if (ins && skipNoOutput && !ins->producesOutput()) {
5371 // stop if end of range was skipped
5372 if (!to.atEnd() && dit >= to)
5375 } else if (!par.isDeleted(pos)) {
5376 if (par.isWordSeparator(pos))
5382 if (ins && ins->isLetter()) {
5383 odocstringstream os;
5385 char_count_ += os.str().length();
5387 else if (ins && ins->isSpace())
5390 pair<int, int> words = ins->isWords();
5391 char_count_ += words.first;
5392 word_count_ += words.second;
5396 char_type const c = par.getChar(pos);
5397 if (isPrintableNonspace(c))
5399 else if (isSpace(c))
5409 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5411 d->updateStatistics(from, to, skipNoOutput);
5415 int Buffer::wordCount() const
5417 return d->wordCount();
5421 int Buffer::charCount(bool with_blanks) const
5423 return d->charCount(with_blanks);
5427 bool Buffer::areChangesPresent() const
5429 return inset().isChanged();
5433 Buffer::ReadStatus Buffer::reload()
5436 // c.f. bug https://www.lyx.org/trac/ticket/6587
5437 removeAutosaveFile();
5438 // e.g., read-only status could have changed due to version control
5439 d->filename.refresh();
5440 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5442 // clear parent. this will get reset if need be.
5443 d->setParent(nullptr);
5444 ReadStatus const status = loadLyXFile();
5445 if (status == ReadSuccess) {
5450 message(bformat(_("Document %1$s reloaded."), disp_fn));
5453 message(bformat(_("Could not reload document %1$s."), disp_fn));
5463 bool Buffer::saveAs(FileName const & fn)
5465 FileName const old_name = fileName();
5466 FileName const old_auto = getAutosaveFileName();
5467 bool const old_unnamed = isUnnamed();
5468 bool success = true;
5469 d->old_position = filePath();
5476 // bring the autosave file with us, just in case.
5477 moveAutosaveFile(old_auto);
5478 // validate version control data and
5479 // correct buffer title
5480 lyxvc().file_found_hook(fileName());
5482 // the file has now been saved to the new location.
5483 // we need to check that the locations of child buffers
5485 checkChildBuffers();
5486 checkMasterBuffer();
5489 // reset the old filename and unnamed state
5490 setFileName(old_name);
5491 setUnnamed(old_unnamed);
5495 d->old_position.clear();
5500 void Buffer::checkChildBuffers()
5502 for (auto const & bit : d->children_positions) {
5503 DocIterator dit = bit.second;
5504 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5505 if (!cbuf || !theBufferList().isLoaded(cbuf))
5507 Inset * inset = dit.nextInset();
5508 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5509 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5510 docstring const & incfile = inset_inc->getParam("filename");
5511 string oldloc = cbuf->absFileName();
5512 string newloc = makeAbsPath(to_utf8(incfile),
5513 onlyPath(absFileName())).absFileName();
5514 if (oldloc == newloc)
5516 // the location of the child file is incorrect.
5517 cbuf->setParent(nullptr);
5518 inset_inc->setChildBuffer(nullptr);
5520 // invalidate cache of children
5521 d->children_positions.clear();
5522 d->position_to_children.clear();
5526 // If a child has been saved under a different name/path, it might have been
5527 // orphaned. Therefore the master needs to be reset (bug 8161).
5528 void Buffer::checkMasterBuffer()
5530 Buffer const * const master = masterBuffer();
5534 // necessary to re-register the child (bug 5873)
5535 // FIXME: clean up updateMacros (here, only
5536 // child registering is needed).
5537 master->updateMacros();
5538 // (re)set master as master buffer, but only
5539 // if we are a real child
5540 if (master->isChild(this))
5547 string Buffer::includedFilePath(string const & name, string const & ext) const
5549 if (d->old_position.empty() ||
5550 equivalent(FileName(d->old_position), FileName(filePath())))
5553 bool isabsolute = FileName::isAbsolute(name);
5554 // both old_position and filePath() end with a path separator
5555 string absname = isabsolute ? name : d->old_position + name;
5557 // if old_position is set to origin, we need to do the equivalent of
5558 // getReferencedFileName() (see readDocument())
5559 if (!isabsolute && d->old_position == params().origin) {
5560 FileName const test(addExtension(filePath() + name, ext));
5562 absname = filePath() + name;
5565 if (!FileName(addExtension(absname, ext)).exists())
5569 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5571 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5572 from_utf8(filePath())));
5576 void Buffer::Impl::refreshFileMonitor()
5578 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5579 file_monitor_->refresh();
5583 // The previous file monitor is invalid
5584 // This also destroys the previous file monitor and all its connections
5585 file_monitor_ = FileSystemWatcher::monitor(filename);
5586 // file_monitor_ will be destroyed with *this, so it is not going to call a
5587 // destroyed object method.
5588 file_monitor_->connect([this](bool exists) {
5589 fileExternallyModified(exists);
5594 void Buffer::Impl::fileExternallyModified(bool const exists)
5596 // ignore notifications after our own saving operations
5597 if (checksum_ == filename.checksum()) {
5598 LYXERR(Debug::FILES, "External modification but "
5599 "checksum unchanged: " << filename);
5602 // If the file has been deleted, only mark the file as dirty since it is
5603 // pointless to prompt for reloading. If later a file is moved into this
5604 // location, then the externally modified warning will appear then.
5606 externally_modified_ = true;
5607 // Update external modification notification.
5608 // Dirty buffers must be visible at all times.
5609 if (wa_ && wa_->unhide(owner_))
5610 wa_->updateTitles();
5612 // Unable to unhide the buffer (e.g. no GUI or not current View)
5617 bool Buffer::notifiesExternalModification() const
5619 return d->externally_modified_;
5623 void Buffer::clearExternalModification() const
5625 d->externally_modified_ = false;
5627 d->wa_->updateTitles();
5631 void Buffer::pushIncludedBuffer(Buffer const * buf) const
5633 masterBuffer()->d->include_list_.push_back(buf);
5634 if (lyxerr.debugging(Debug::FILES)) {
5635 LYXERR0("Pushed. Stack now:");
5636 if (masterBuffer()->d->include_list_.empty())
5639 for (auto const & b : masterBuffer()->d->include_list_)
5640 LYXERR0(b->fileName());
5645 void Buffer::popIncludedBuffer() const
5647 masterBuffer()->d->include_list_.pop_back();
5648 if (lyxerr.debugging(Debug::FILES)) {
5649 LYXERR0("Popped. Stack now:");
5650 if (masterBuffer()->d->include_list_.empty())
5653 for (auto const & b : masterBuffer()->d->include_list_)
5654 LYXERR0(b->fileName());
5659 bool Buffer::isBufferIncluded(Buffer const * buf) const
5663 if (lyxerr.debugging(Debug::FILES)) {
5664 LYXERR0("Checking for " << buf->fileName() << ". Stack now:");
5665 if (masterBuffer()->d->include_list_.empty())
5668 for (auto const & b : masterBuffer()->d->include_list_)
5669 LYXERR0(b->fileName());
5671 list<Buffer const *> const & blist = masterBuffer()->d->include_list_;
5672 return find(blist.begin(), blist.end(), buf) != blist.end();
5676 void Buffer::clearIncludeList() const
5678 LYXERR(Debug::FILES, "Clearing include list for " << fileName());
5679 d->include_list_.clear();